mm-share-lib 0.0.5 → 0.0.6

package/src/lib/typesense/metadata/typesense.metadata-explorer.spec.ts

@@ -0,0 +1,56 @@
+/* eslint-disable max-classes-per-file */
+
+import 'reflect-metadata';
+
+import { Module } from '@nestjs/common';
+import { DiscoveryModule } from '@nestjs/core';
+import { Test } from '@nestjs/testing';
+
+import { Schema } from '../decorators';
+import { Field } from '../decorators';
+import { TypesenseMetadataAccessor } from './typesense.metadata-accessor';
+import { TypesenseMetadataExplorer } from './typesense.metadata-explorer';
+import { TypesenseMetadataRegistry } from './typesense.metadata-registry';
+
+describe('typesense', () => {
+  describe('metadata', () => {
+    describe('explorer', () => {
+      let module;
+
+      @Module({
+        imports: [DiscoveryModule],
+        providers: [
+          TypesenseMetadataAccessor,
+          TypesenseMetadataExplorer,
+          TypesenseMetadataRegistry,
+        ],
+      })
+      class TestMetadataModule {}
+
+      @Schema()
+      class TestSchema {
+        @Field('string')
+        field!: string;
+      }
+
+      beforeEach(async () => {
+        module = await Test.createTestingModule({
+          imports: [TestMetadataModule],
+          providers: [TestSchema],
+        }).compile();
+
+        await module.init();
+      });
+
+      afterEach(async () => {
+        await module.close();
+      });
+
+      it('should store schema metadata', () => {
+        expect(
+          module.get(TypesenseMetadataRegistry).getSchemaByTarget(TestSchema),
+        ).toBeDefined();
+      });
+    });
+  });
+});

package/src/lib/typesense/metadata/typesense.metadata-explorer.ts

@@ -0,0 +1,41 @@
+import { Injectable, Logger, OnModuleInit } from '@nestjs/common';
+import { DiscoveryService } from '@nestjs/core';
+import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
+
+import { TypesenseMetadataAccessor } from './typesense.metadata-accessor';
+import { TypesenseMetadataRegistry } from './typesense.metadata-registry';
+
+@Injectable()
+export class TypesenseMetadataExplorer implements OnModuleInit {
+  private readonly logger = new Logger(TypesenseMetadataExplorer.name);
+
+  constructor(
+    private readonly discoveryService: DiscoveryService,
+    private readonly metadataAccessor: TypesenseMetadataAccessor,
+    private readonly metadataRegistry: TypesenseMetadataRegistry,
+  ) {}
+
+  onModuleInit() {
+    this.explore();
+  }
+
+  explore() {
+    this.discoveryService.getProviders().forEach((wrapper: InstanceWrapper) => {
+      const { instance } = wrapper;
+
+      if (!instance || !Object.getPrototypeOf(instance)) {
+        return;
+      }
+
+      this.lookupSchema(instance);
+    });
+  }
+
+  lookupSchema(instance) {
+    const metadata = this.metadataAccessor.getTypesenseMetadata(instance);
+
+    if (metadata) {
+      this.metadataRegistry.addSchema(instance.constructor, metadata);
+    }
+  }
+}

package/src/lib/typesense/metadata/typesense.metadata-registry.ts

@@ -0,0 +1,28 @@
+import { Injectable, Logger } from '@nestjs/common';
+
+import { Schema } from './schema.metadata';
+
+type Constructor = new (...args: any[]) => unknown;
+
+@Injectable()
+export class TypesenseMetadataRegistry {
+  private logger = new Logger(TypesenseMetadataRegistry.name);
+
+  private schemas: Map<Constructor, Schema> = new Map();
+
+  addSchema(target: Constructor, schema: Schema) {
+    if (this.schemas.has(target)) {
+      this.logger.warn(`Schema ${target} already exists`);
+    }
+
+    this.schemas.set(target, schema);
+  }
+
+  getSchemaByTarget(target: Constructor) {
+    return this.schemas.get(target);
+  }
+
+  getTargets() {
+    return this.schemas.keys();
+  }
+}

package/src/lib/typesense/module/index.ts

@@ -0,0 +1,4 @@
+export * from './interface.module';
+export * from './typesense.module';
+export * from './typesense.constant';
+export * from './typesense.provider';

package/src/lib/typesense/module/interface.module.ts

@@ -0,0 +1,34 @@
+import { ModuleMetadata } from '@nestjs/common/interfaces';
+import { Type } from '@nestjs/common/interfaces';
+
+export interface TypesenseNodeOptions {
+  host: string;
+  port: string;
+  protocol: string;
+}
+
+export interface TypesenseModuleOptions {
+  nodes?: Array<TypesenseNodeOptions>;
+  numRetries?: number;
+  apiKey?: string;
+  connectionTimeoutSeconds?: number;
+  retryIntervalSeconds?: number;
+  healthcheckIntervalSeconds?: number;
+  logLevel?: string;
+}
+
+export interface TypesenseOptionsFactory {
+  createTypesenseOptions():
+    | Promise<TypesenseModuleOptions>
+    | TypesenseModuleOptions;
+}
+
+export interface TypesenseModuleAsyncOptions
+  extends Pick<ModuleMetadata, 'imports'> {
+  useExisting?: Type<TypesenseOptionsFactory>;
+  useClass?: Type<TypesenseOptionsFactory>;
+  useFactory?: (
+    ...args: any[]
+  ) => Promise<TypesenseModuleOptions> | TypesenseModuleOptions;
+  inject?: any[];
+}

package/src/lib/typesense/module/typesense.constant.ts

@@ -0,0 +1 @@
+export const TYPESENSE_MODULE_OPTIONS = 'TYPESENSE_MODULE_OPTIONS';

package/src/lib/typesense/module/typesense.module.spec.ts

@@ -0,0 +1,94 @@
+/* eslint-disable max-classes-per-file */
+
+import { Module } from '@nestjs/common';
+import { Test } from '@nestjs/testing';
+
+import { TypesenseModuleOptions } from './interface.module';
+import { TYPESENSE_MODULE_OPTIONS } from './typesense.constant';
+import { TypesenseModule } from './';
+
+describe('typesense', () => {
+  describe('module', () => {
+    let module;
+
+    afterEach(async () => {
+      await module.close();
+    });
+
+    it(`register`, async () => {
+      module = await Test.createTestingModule({
+        imports: [
+          TypesenseModule.register({
+            apiKey: 'test',
+          }),
+        ],
+      }).compile();
+
+      expect(module.get(TYPESENSE_MODULE_OPTIONS)).toBeDefined();
+    });
+
+    it(`register async use factory`, async () => {
+      module = await Test.createTestingModule({
+        imports: [
+          TypesenseModule.registerAsync({
+            useFactory: () => ({
+              apiKey: 'test',
+            }),
+          }),
+        ],
+      }).compile();
+
+      expect(module.get(TYPESENSE_MODULE_OPTIONS)).toBeDefined();
+    });
+
+    it(`register async use class`, async () => {
+      class TestTypesenseModuleOptions {
+        createTypesenseOptions(): TypesenseModuleOptions {
+          return {
+            apiKey: 'test',
+          };
+        }
+      }
+
+      module = await Test.createTestingModule({
+        imports: [
+          TypesenseModule.registerAsync({
+            useClass: TestTypesenseModuleOptions,
+          }),
+        ],
+      }).compile();
+
+      expect(module.get(TYPESENSE_MODULE_OPTIONS)).toBeDefined();
+    });
+
+    it(`register async use exists`, async () => {
+      class TestTypesenseModuleOptions {
+        createTypesenseOptions(): TypesenseModuleOptions {
+          return {
+            apiKey: 'test',
+          };
+        }
+      }
+
+      @Module({})
+      class TestTypesenseModule {}
+
+      module = await Test.createTestingModule({
+        imports: [
+          TypesenseModule.registerAsync({
+            imports: [
+              {
+                module: TestTypesenseModule,
+                providers: [TestTypesenseModuleOptions],
+                exports: [TestTypesenseModuleOptions],
+              },
+            ],
+            useExisting: TestTypesenseModuleOptions,
+          }),
+        ],
+      }).compile();
+
+      expect(module.get(TYPESENSE_MODULE_OPTIONS)).toBeDefined();
+    });
+  });
+});

package/src/lib/typesense/module/typesense.module.ts

@@ -0,0 +1,87 @@
+import { DynamicModule, Provider, Module } from '@nestjs/common';
+import { DiscoveryModule } from '@nestjs/core';
+
+import {
+  TypesenseModuleAsyncOptions,
+  TypesenseOptionsFactory,
+  TypesenseModuleOptions,
+} from './interface.module';
+import { TYPESENSE_MODULE_OPTIONS } from './typesense.constant';
+import {
+  createTypesenseExportsProvider,
+  createTypesenseProvider,
+  createTypesenseOptionsProvider,
+} from './typesense.provider';
+
+@Module({
+  imports: [DiscoveryModule],
+})
+export class TypesenseModule {
+  static register(options: TypesenseModuleOptions = {}): DynamicModule {
+    const optionsProviders = createTypesenseOptionsProvider(options);
+    const exportsProviders = createTypesenseExportsProvider();
+    const providers = createTypesenseProvider();
+
+    return {
+      global: true,
+      module: TypesenseModule,
+      providers: [...optionsProviders, ...providers, ...exportsProviders],
+      exports: exportsProviders,
+    };
+  }
+
+  static registerAsync(options: TypesenseModuleAsyncOptions): DynamicModule {
+    const exportsProviders = createTypesenseExportsProvider();
+    const providers = createTypesenseProvider();
+
+    return {
+      global: true,
+      module: TypesenseModule,
+      imports: options.imports || [],
+      providers: [
+        ...this.createAsyncProviders(options),
+        ...providers,
+        ...exportsProviders,
+      ],
+      exports: exportsProviders,
+    };
+  }
+
+  private static createAsyncProviders(
+    options: TypesenseModuleAsyncOptions,
+  ): Provider[] {
+    if (options.useExisting || options.useFactory) {
+      return [this.createAsyncOptionsProvider(options)];
+    }
+
+    return [
+      this.createAsyncOptionsProvider(options),
+      {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        provide: options.useClass!,
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        useClass: options.useClass!,
+      },
+    ];
+  }
+
+  private static createAsyncOptionsProvider(
+    options: TypesenseModuleAsyncOptions,
+  ): Provider {
+    if (options.useFactory) {
+      return {
+        provide: TYPESENSE_MODULE_OPTIONS,
+        useFactory: options.useFactory,
+        inject: options.inject || [],
+      };
+    }
+
+    return {
+      provide: TYPESENSE_MODULE_OPTIONS,
+      useFactory: (optionsFactory: TypesenseOptionsFactory) =>
+        optionsFactory.createTypesenseOptions(),
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      inject: [options.useExisting! || options.useClass!],
+    };
+  }
+}

package/src/lib/typesense/module/typesense.provider.ts

@@ -0,0 +1,54 @@
+import { Provider } from '@nestjs/common';
+
+import { Client } from 'typesense';
+
+import { TypesenseCollectionsCreator } from '../collections';
+import { TypesenseMetadataAccessor } from '../metadata';
+import { TypesenseMetadataExplorer } from '../metadata';
+import { TypesenseMetadataRegistry } from '../metadata';
+import { TypesenseModuleOptions } from './typesense-module.interface';
+import { TYPESENSE_MODULE_OPTIONS } from './typesense.constants';
+
+export const createTypesenseOptionsProvider = (
+  options: TypesenseModuleOptions = {},
+): Provider[] => [
+  {
+    provide: TYPESENSE_MODULE_OPTIONS,
+    useValue: options,
+  },
+];
+
+export const createTypesenseProvider = (): Provider[] => [
+  TypesenseMetadataAccessor,
+  TypesenseMetadataExplorer,
+  TypesenseMetadataRegistry,
+  TypesenseCollectionsCreator,
+];
+
+export const createTypesenseExportsProvider = (): Provider[] => [
+  TypesenseMetadataRegistry,
+  {
+    provide: Client,
+    useFactory: (options: TypesenseModuleOptions) =>
+      new Client({
+        nodes: options.nodes || [
+          {
+            host:
+              process.env.TYPESENSE_HOST ||
+              process.env.NODE_ENV === 'production'
+                ? 'ts.typesense.svc.cluster.local'
+                : 'localhost',
+            port: 8108,
+            protocol: 'http',
+          },
+        ],
+        numRetries: options.numRetries || 10,
+        apiKey: options.apiKey || process.env.TYPESENSE_API_KEY,
+        connectionTimeoutSeconds: options.connectionTimeoutSeconds || 10,
+        retryIntervalSeconds: options.retryIntervalSeconds || 0.1,
+        healthcheckIntervalSeconds: options.healthcheckIntervalSeconds || 2,
+        logLevel: options.logLevel || 'info',
+      }),
+    inject: [TYPESENSE_MODULE_OPTIONS],
+  },
+];

package/src/response/base-entity.response.ts

@@ -0,0 +1,8 @@
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+
+export class BaseEntityResponse {
+  @ApiPropertyOptional()
+  @Type(() => Number)
+  id?: number;
+}

package/src/response/index.ts

@@ -1 +1,2 @@
-export * from './pagination.response';
+export * from './base-entity.response';
+export * from './pagination.response';

package/src/response/pagination.response.ts

@@ -1,37 +1,52 @@
-export class PaginationResponse<T> {
-  data: T[];
-  total?: number;
-  offset?: number;
-  limit?: number;
-  hasNext?: boolean;
-
-  constructor(
-    data: T[],
-    total: number = data?.length || 0,
-    limit?: number,
-    offset?: number,
-  ) {
-    this.data = data;
-    this.total = total;
-    this.offset = offset;
-    this.limit = limit;
-    this.hasNext = this.offset + this.limit < this.total;
-  }
-
-  toJSON() {
-    return {
-      data: this.data,
-      total: this.total,
-      count: this.data.length,
-      offset: this.offset,
-      limit: this.limit,
-      hasNext: this.hasNext,
-    };
-  }
-
-  promise(): Promise<PaginationResponse<T>> {
-    return new Promise((resolve, reject) => {
-      resolve(this);
-    });
-  }
-}
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+export class PaginationResponse<TData> {
+  @ApiPropertyOptional()
+  data: TData[];
+
+  @ApiPropertyOptional()
+  @Type(() => Number)
+  total?: number = 0;
+
+  @ApiPropertyOptional()
+  @Type(() => Number)
+  offset?: number = 0;
+
+  @ApiPropertyOptional()
+  @Type(() => Number)
+  limit?: number = 25;
+
+  @ApiPropertyOptional()
+  @Type(() => Boolean)
+  hasNext?: boolean = false;
+
+  constructor(
+    data: TData[],
+    total: number = data?.length || 0,
+    limit?: number,
+    offset?: number,
+  ) {
+    this.data = data;
+    this.total = total;
+    this.offset = offset;
+    this.limit = limit;
+    this.hasNext = this.offset + this.limit < this.total;
+  }
+
+  toJSON() {
+    return {
+      data: this.data,
+      total: this.total,
+      count: this.data.length,
+      offset: this.offset,
+      limit: this.limit,
+      hasNext: this.hasNext,
+    };
+  }
+
+  promise(): Promise<PaginationResponse<TData>> {
+    return new Promise((resolve, reject) => {
+      resolve(this);
+    });
+  }
+}

package/src/setup/index.ts

@@ -1 +1 @@
-export * from './microservice.setup';
+export * from './microservice.setup';

package/src/util/date.util.spec.ts

@@ -1,49 +1,49 @@
-import dayjs from 'dayjs';
-import { addSecond, isExpired } from './date.util';
-
-describe('Utility Functions', () => {
-  test('addSecond should return a Date object with the specified duration added', () => {
-    // Arrange
-    const duration = 10;
-
-    // Act
-    const result = addSecond(duration);
-
-    // Assert
-    const expectedDate = dayjs().add(duration, 'seconds').toDate();
-    expect(result).toEqual(expectedDate);
-  });
-
-  test('isExpired should return true for a past date', () => {
-    // Arrange
-    const pastDate = dayjs().subtract(1, 'day').toDate();
-
-    // Act
-    const result = isExpired(pastDate);
-
-    // Assert
-    expect(result).toBe(true);
-  });
-
-  test('isExpired should return false for a future date', () => {
-    // Arrange
-    const futureDate = dayjs().add(1, 'day').toDate();
-
-    // Act
-    const result = isExpired(futureDate);
-
-    // Assert
-    expect(result).toBe(false);
-  });
-
-  test('isExpired should return false for the current date', () => {
-    // Arrange
-    const currentDate = dayjs().toDate();
-
-    // Act
-    const result = isExpired(currentDate);
-
-    // Assert
-    expect(result).toBe(false);
-  });
-});
+import dayjs from 'dayjs';
+import { addSecond, isExpired } from './date.util';
+
+describe('Utility Functions', () => {
+  test('addSecond should return a Date object with the specified duration added', () => {
+    // Arrange
+    const duration = 10;
+
+    // Act
+    const result = addSecond(duration);
+
+    // Assert
+    const expectedDate = dayjs().add(duration, 'seconds').toDate();
+    expect(result).toEqual(expectedDate);
+  });
+
+  test('isExpired should return true for a past date', () => {
+    // Arrange
+    const pastDate = dayjs().subtract(1, 'day').toDate();
+
+    // Act
+    const result = isExpired(pastDate);
+
+    // Assert
+    expect(result).toBe(true);
+  });
+
+  test('isExpired should return false for a future date', () => {
+    // Arrange
+    const futureDate = dayjs().add(1, 'day').toDate();
+
+    // Act
+    const result = isExpired(futureDate);
+
+    // Assert
+    expect(result).toBe(false);
+  });
+
+  test('isExpired should return false for the current date', () => {
+    // Arrange
+    const currentDate = dayjs().toDate();
+
+    // Act
+    const result = isExpired(currentDate);
+
+    // Assert
+    expect(result).toBe(false);
+  });
+});

package/src/util/date.util.ts

@@ -1,10 +1,10 @@
-import dayjs from 'dayjs';
-
-export const addSecond = (duration: number): Date => {
-  return dayjs().add(duration, 'seconds').toDate();
-};
-
-export const isExpired = (date: Date): boolean => {
-  const currentDate = dayjs();
-  return dayjs(date).isBefore(currentDate);
-};
+import dayjs from 'dayjs';
+
+export const addSecond = (duration: number): Date => {
+  return dayjs().add(duration, 'seconds').toDate();
+};
+
+export const isExpired = (date: Date): boolean => {
+  const currentDate = dayjs();
+  return dayjs(date).isBefore(currentDate);
+};