Feature/cache module

packages/nestjs-cache/README.md

@@ -0,0 +1,54 @@
+# Rockets NestJS Cache
+
+A module for managing a basic Cache entity, including controller with full CRUD, DTOs, sample data factory and seeder.
+
+## Project
+
+[![NPM Latest](https://img.shields.io/npm/v/@concepta/nestjs-user)](https://www.npmjs.com/package/@concepta/nestjs-user)
+[![NPM Downloads](https://img.shields.io/npm/dw/@conceptadev/nestjs-user)](https://www.npmjs.com/package/@concepta/nestjs-user)
+[![GH Last Commit](https://img.shields.io/github/last-commit/conceptadev/rockets?logo=github)](https://github.com/conceptadev/rockets)
+[![GH Contrib](https://img.shields.io/github/contributors/conceptadev/rockets?logo=github)](https://github.com/conceptadev/rockets/graphs/contributors)
+[![NestJS Dep](https://img.shields.io/github/package-json/dependency-version/conceptadev/rockets/@nestjs/common?label=NestJS&logo=nestjs&filename=packages%2Fnestjs-core%2Fpackage.json)](https://www.npmjs.com/package/@nestjs/common)
+
+## Installation
+
+`yarn add @concepta/nestjs-cache`
+
+## Usage
+
+```ts
+// ...
+import { TypeOrmExtModule } from '@concepta/nestjs-typeorm-ext';
+import { CacheModule } from '@concepta/nestjs-user';
+import { CrudModule } from '@concepta/nestjs-crud';
+
+@Module({
+  imports: [
+    TypeOrmExtModule.forRoot({
+      type: 'postgres',
+      url: 'postgres://user:pass@localhost:5432/postgres',
+    }),
+    CrudModule.forRoot({}),
+    CacheModule.forRoot({}),
+  ],
+})
+export class AppModule {}
+```
+
+## Configuration
+
+- [Seeding](#seeding)
+  - [ENV](#env)
+
+### Seeding
+
+Configurations specific to (optional) database seeding.
+
+#### ENV
+
+Configurations available via environment.
+
+| Variable                   | Type       | Default |                                      |
+| -------------------------- | ---------- | ------- | ------------------------------------ |
+| `CACHE_MODULE_SEEDER_AMOUNT` | `<number>` | `50`    | number of additional users to create |
+| `CACHE_EXPIRE_IN` | `<string>` | `1d`    | string for the amount of time to expire the cache |

packages/nestjs-cache/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@concepta/nestjs-cache",
+  "version": "4.0.0-alpha.42",
+  "description": "Rockets NestJS User",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "BSD-3-Clause",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/!(*.spec|*.e2e-spec|*.fixture).{js,d.ts}"
+  ],
+  "dependencies": {
+    "@concepta/nestjs-access-control": "^4.0.0-alpha.42",
+    "@concepta/nestjs-common": "^4.0.0-alpha.42",
+    "@concepta/nestjs-core": "^4.0.0-alpha.42",
+    "@concepta/nestjs-crud": "^4.0.0-alpha.42",
+    "@concepta/nestjs-typeorm-ext": "^4.0.0-alpha.42",
+    "@concepta/ts-common": "^4.0.0-alpha.42",
+    "@concepta/ts-core": "^4.0.0-alpha.42",
+    "@concepta/typeorm-common": "^4.0.0-alpha.42",
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/config": "^2.2.0",
+    "@nestjs/swagger": "^6.0.0",
+    "ms": "^2.1.3"
+  },
+  "devDependencies": {
+    "@concepta/typeorm-seeding": "^4.0.0-beta.0",
+    "@faker-js/faker": "^6.0.0-alpha.6",
+    "@nestjs/testing": "^9.0.0",
+    "@nestjs/typeorm": "^9.0.0",
+    "@types/ms": "^0.7.31",
+    "@types/supertest": "^2.0.11",
+    "jest-mock-extended": "^2.0.4",
+    "supertest": "^6.1.3"
+  },
+  "peerDependencies": {
+    "class-transformer": "*",
+    "class-validator": "*",
+    "typeorm": "^0.3.0"
+  }
+}

packages/nestjs-cache/src/__fixtures__/app.module.fixture.ts

@@ -0,0 +1,33 @@
+import { TypeOrmExtModule } from '@concepta/nestjs-typeorm-ext';
+import { Module } from '@nestjs/common';
+
+import { CacheModule } from '../cache.module';
+import { UserEntityFixture } from './entities/user-entity.fixture';
+import { UserCacheEntityFixture } from './entities/user-cache-entity.fixture';
+import { CrudModule } from '@concepta/nestjs-crud';
+
+@Module({
+  imports: [
+    TypeOrmExtModule.forRoot({
+      type: 'sqlite',
+      database: ':memory:',
+      synchronize: true,
+      entities: [UserEntityFixture, UserCacheEntityFixture],
+    }),
+    CacheModule.register({
+      settings: {
+        assignments: {
+          user: { entityKey: 'userCache' },
+        },
+      },
+      entities: {
+        userCache: {
+          entity: UserCacheEntityFixture,
+        },
+      },
+    }),
+    CrudModule.forRoot({}),
+  ],
+})
+export class AppModuleFixture { }
+

packages/nestjs-cache/src/__fixtures__/entities/user-cache-entity.fixture.ts

@@ -0,0 +1,13 @@
+import { Entity, ManyToOne } from 'typeorm';
+import { ReferenceIdInterface } from '@concepta/ts-core';
+import { UserEntityFixture } from './user-entity.fixture';
+import { CacheSqliteEntity } from '../../entities/cache-sqlite.entity';
+
+/**
+ * Cache Entity Fixture
+ */
+@Entity()
+export class UserCacheEntityFixture extends CacheSqliteEntity {
+  @ManyToOne(() => UserEntityFixture, (user) => user.userCaches)
+  assignee!: ReferenceIdInterface;
+}

packages/nestjs-cache/src/__fixtures__/entities/user-entity.fixture.ts

@@ -0,0 +1,18 @@
+import { Column, Entity, OneToMany, PrimaryGeneratedColumn } from 'typeorm';
+import { ReferenceIdInterface } from '@concepta/ts-core';
+import { UserCacheEntityFixture } from './user-cache-entity.fixture';
+
+/**
+ * User Entity Fixture
+ */
+@Entity()
+export class UserEntityFixture implements ReferenceIdInterface {
+  @PrimaryGeneratedColumn('uuid')
+  id!: string;
+
+  @Column({ default: false })
+  isActive!: boolean;
+
+  @OneToMany(() => UserCacheEntityFixture, (userCache) => userCache.assignee)
+  userCaches!: UserCacheEntityFixture[];
+}

packages/nestjs-cache/src/__fixtures__/factories/user-cache.factory.fixture.ts

@@ -0,0 +1,21 @@
+
+import { Factory } from '@concepta/typeorm-seeding';
+import { UserCacheEntityFixture } from '../entities/user-cache-entity.fixture';
+import Faker from '@faker-js/faker';
+
+export class UserCacheFactoryFixture extends Factory<UserCacheEntityFixture> {
+  protected options = {
+    entity: UserCacheEntityFixture,
+  };
+
+  protected async entity(
+    userCache: UserCacheEntityFixture,
+  ): Promise<UserCacheEntityFixture> {
+    userCache.key = Faker.name.jobArea();
+    userCache.type = 'filter';
+    userCache.data = JSON.stringify({ sortBy: 'name' });
+    userCache.expirationDate = new Date();
+
+    return userCache;
+  }
+}

packages/nestjs-cache/src/__fixtures__/factories/user.factory.fixture.ts

@@ -0,0 +1,8 @@
+import { Factory } from '@concepta/typeorm-seeding';
+import { UserEntityFixture } from '../entities/user-entity.fixture';
+
+export class UserFactoryFixture extends Factory<UserEntityFixture> {
+  options = {
+    entity: UserEntityFixture,
+  };
+}

packages/nestjs-cache/src/cache.constants.ts

@@ -0,0 +1,8 @@
+export const CACHE_MODULE_SETTINGS_TOKEN = 'CACHE_MODULE_SETTINGS_TOKEN';
+export const CACHE_MODULE_REPOSITORIES_TOKEN =
+  'CACHE_MODULE_REPOSITORIES_TOKEN';
+export const CACHE_MODULE_CRUD_SERVICES_TOKEN =
+  'CACHE_MODULE_CRUD_SERVICES_TOKEN';
+export const CACHE_MODULE_DEFAULT_SETTINGS_TOKEN =
+  'CACHE_MODULE_DEFAULT_SETTINGS_TOKEN';
+export const CACHE_MODULE_CACHE_ENTITY_KEY = 'cache';

packages/nestjs-cache/src/cache.factory.ts

@@ -0,0 +1,43 @@
+import { randomUUID } from 'crypto';
+import Faker from '@faker-js/faker';
+import { Factory } from '@concepta/typeorm-seeding';
+import { CacheInterface } from '@concepta/ts-common';
+/**
+ * Cache factory
+ */
+export class CacheFactory extends Factory<CacheInterface> {
+  /**
+   * List of used names.
+   */
+  keys: string[] = ['filter', 'sort', 'list'];
+
+  /**
+   * Factory callback function.
+   */
+  protected async entity(cache: CacheInterface): Promise<CacheInterface> {
+    const fakeFilter = {
+      name: Faker.name.firstName,
+      orderBy: 'name',
+    };
+
+    // set the name
+    cache.key = randomUUID();
+    cache.type = this.randomKey();
+    cache.data = JSON.stringify(fakeFilter);
+    cache.expirationDate = new Date();
+
+    // return the new cache
+    return cache;
+  }
+
+  /**
+   * Get a random category.
+   */
+  protected randomKey(): string {
+    // random index
+    const randomIdx = Math.floor(Math.random() * this.keys.length);
+
+    // return it
+    return this.keys[randomIdx];
+  }
+}