@iamnnort/nestjs-serializer 1.0.2 → 1.0.4

package/README.md

@@ -11,32 +11,125 @@ yarn install @iamnnort/nestjs-serializer
 ## Usage
 
 ```javascript
-// app.controller.ts
-import { Controller, Get } from '@nestjs/common';
-import { RequestService } from '@iamnnort/nestjs-serializer';
 
-@Controller('demo')
-export class AppController {
-  constructor(private requestService: RequestService<{ id: number }>) {}
+// types.ts
+
+export enum Scopes {
+  BASE = 'BASE',
+  FULL = 'FULL',
+}
+
+// model.ts
+
+import { SerializeField } from '@iamnnort/nestjs-serializer';
+import { Scopes } from './types';
+
+export class Model {
+  @SerializeField([{ scopes: [Scopes.BASE] }])
+  id: number;
+
+  constructor(dto: { id: number }) {
+    this.id = dto.id;
+  }
+}
+
+// city.ts
+
+import { SerializeField } from '@iamnnort/nestjs-serializer';
+import { Model } from './model';
+import { Scopes } from './types';
+
+export class City extends Model {
+  @SerializeField([{ scopes: [Scopes.FULL] }])
+  name: string;
+
+  constructor(dto: { id: number; name: string }) {
+    super(dto);
+
+    this.name = dto.name;
+  }
+}
 
+// user.ts
+
+import { SerializeField, SerializeRelation } from '@iamnnort/nestjs-serializer';
+import { City } from './city';
+import { Model } from './model';
+import { Scopes } from './types';
+
+export class User extends Model {
+  @SerializeField([{ scopes: [Scopes.FULL] }])
+  name: string;
+
+  @SerializeRelation([{ scopes: [Scopes.FULL], relationScopes: [Scopes.BASE, Scopes.FULL] }])
+  city: City;
+
+  constructor(dto: { id: number; name: string; city: City }) {
+    super(dto);
+
+    this.name = dto.name;
+    this.city = dto.city;
+  }
+}
+
+// controller.ts
+
+import { Controller, Get, UseInterceptors } from '@nestjs/common';
+import { SerializerInterceptor } from '@iamnnort/nestjs-serializer';
+import { User } from './user';
+import { Scopes } from './types';
+import { City } from './city';
+
+@Controller()
+export class AppController {
   @Get()
-  demo() {
-    return this.requestService.get(1);
+  @UseInterceptors(SerializerInterceptor([Scopes.BASE]))
+  search() {
+    const city = new City({
+      id: 1,
+      name: 'London',
+    });
+
+    const user = new User({
+      id: 1,
+      name: 'John',
+      city,
+    });
+
+    return [user];
+  }
+
+  @Get(':id')
+  @UseInterceptors(SerializerInterceptor([Scopes.BASE, Scopes.FULL]))
+  get() {
+    const city = new City({
+      id: 1,
+      name: 'London',
+    });
+
+    const user = new User({
+      id: 1,
+      name: 'John',
+      city,
+    });
+
+    return user;
   }
 }
 
-// app.ts
+// module.ts
+
 import { Module } from '@nestjs/common';
-import { RequestModule } from '@iamnnort/nestjs-serializer';
-import { AppController } from './app.controller';
+import { LoggerModule } from '@iamnnort/nestjs-logger';
+import { SerializerModule } from '@iamnnort/nestjs-serializer';
+import { Model } from './model';
+import { AppController } from './controller';
 
 @Module({
   imports: [
-    RequestModule.register({
-      name: 'Demo Api',
-      baseUrl: 'https://jsonplaceholder.typicode.com',
-      url: '/todos',
-      logger: true,
+    LoggerModule,
+    SerializerModule.register({
+      globalEntityNames: [Model.name],
     }),
   ],
   controllers: [AppController],
@@ -44,9 +137,10 @@ import { AppController } from './app.controller';
 export class AppModule {}
 
 // index.ts
+
 import { NestFactory } from '@nestjs/core';
 import { LoggerService } from '@iamnnort/nestjs-logger';
-import { AppModule } from './app';
+import { AppModule } from './module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule, {
@@ -66,10 +160,10 @@ bootstrap();
 ```bash
 [System] Application is starting...
 [System] Application started.
-[System] [Request] GET /demo
-[Demo Api] [Request] GET /todos/1
-[Demo Api] [Response] GET /todos/1 200 OK {"userId":1,"id":1,"title":"delectus aut autem","completed":false}
-[System] [Response] GET /demo 200 OK
+[System] [Request] GET /
+[System] [Response] GET / 200 OK [{ id: 1 }]
+[System] [Request] GET /1
+[System] [Response] GET /1 200 OK [{ id: 1, name: "John", city: { id: 1, name: "London" } }]
 ```
 
 ## License

package/dist/index.d.mts

@@ -1,17 +1,53 @@
+import * as rxjs from 'rxjs';
 import * as _nestjs_common from '@nestjs/common';
+import { ExecutionContext, CallHandler } from '@nestjs/common';
 
-type SerializerConfig = {
-    local: boolean;
-};
-
-declare const ConfigurableModuleClass: _nestjs_common.ConfigurableModuleCls<SerializerConfig, "register", "create", {}>;
+declare const SerializeField: (configs: {
+    scopes: string[];
+    fieldName?: string;
+}[]) => (target: object, name: string) => void;
+declare const SerializeRelation: (configs: {
+    scopes: string[];
+    relationScopes: string[];
+    fieldName?: string;
+    fieldTransform?: (entity: any) => Promise<any>;
+}[]) => (target: object, name: string) => void;
 
-declare class SerializerModule extends ConfigurableModuleClass {
+declare global {
+    var transformFieldConfigs: {
+        scopes: string[];
+        relationScopes?: string[];
+        target: Function;
+        name: string;
+        fieldName?: string;
+        fieldTransform?: (entity: any) => Promise<any>;
+    }[];
 }
+type SerializerConfig = {
+    globalEntityNames?: string[];
+};
 
 declare class SerializerService {
     config: SerializerConfig;
+    globalEntityNames: string[];
     constructor(config: SerializerConfig);
+    transform(response: any, scopes: string[]): Promise<any>;
+    transformEntity(entity: any, scopes?: string[]): Promise<any>;
+    getRelations(scopes: string[], relationMap: Record<string, string[]>): string[];
+    makeRelations(relationField: string, relationRelations: string[]): string[];
+}
+
+declare const SerializerInterceptor: (scopes: string[], extendedScopes?: string[]) => {
+    new (serializerService: SerializerService): {
+        serializerService: SerializerService;
+        intercept(ctx: ExecutionContext, next: CallHandler<Promise<any>>): rxjs.Observable<Promise<any>>;
+        getScopes(ctx: ExecutionContext): string[];
+    };
+};
+
+declare const ConfigurableModuleClass: _nestjs_common.ConfigurableModuleCls<SerializerConfig, "register", "create", {}>;
+
+declare class SerializerModule extends ConfigurableModuleClass {
 }
 
-export { type SerializerConfig, SerializerModule, SerializerService };
+export { SerializeField, SerializeRelation, type SerializerConfig, SerializerInterceptor, SerializerModule, SerializerService };

package/dist/index.d.ts

@@ -1,17 +1,53 @@
+import * as rxjs from 'rxjs';
 import * as _nestjs_common from '@nestjs/common';
+import { ExecutionContext, CallHandler } from '@nestjs/common';
 
-type SerializerConfig = {
-    local: boolean;
-};
-
-declare const ConfigurableModuleClass: _nestjs_common.ConfigurableModuleCls<SerializerConfig, "register", "create", {}>;
+declare const SerializeField: (configs: {
+    scopes: string[];
+    fieldName?: string;
+}[]) => (target: object, name: string) => void;
+declare const SerializeRelation: (configs: {
+    scopes: string[];
+    relationScopes: string[];
+    fieldName?: string;
+    fieldTransform?: (entity: any) => Promise<any>;
+}[]) => (target: object, name: string) => void;
 
-declare class SerializerModule extends ConfigurableModuleClass {
+declare global {
+    var transformFieldConfigs: {
+        scopes: string[];
+        relationScopes?: string[];
+        target: Function;
+        name: string;
+        fieldName?: string;
+        fieldTransform?: (entity: any) => Promise<any>;
+    }[];
 }
+type SerializerConfig = {
+    globalEntityNames?: string[];
+};
 
 declare class SerializerService {
     config: SerializerConfig;
+    globalEntityNames: string[];
     constructor(config: SerializerConfig);
+    transform(response: any, scopes: string[]): Promise<any>;
+    transformEntity(entity: any, scopes?: string[]): Promise<any>;
+    getRelations(scopes: string[], relationMap: Record<string, string[]>): string[];
+    makeRelations(relationField: string, relationRelations: string[]): string[];
+}
+
+declare const SerializerInterceptor: (scopes: string[], extendedScopes?: string[]) => {
+    new (serializerService: SerializerService): {
+        serializerService: SerializerService;
+        intercept(ctx: ExecutionContext, next: CallHandler<Promise<any>>): rxjs.Observable<Promise<any>>;
+        getScopes(ctx: ExecutionContext): string[];
+    };
+};
+
+declare const ConfigurableModuleClass: _nestjs_common.ConfigurableModuleCls<SerializerConfig, "register", "create", {}>;
+
+declare class SerializerModule extends ConfigurableModuleClass {
 }
 
-export { type SerializerConfig, SerializerModule, SerializerService };
+export { SerializeField, SerializeRelation, type SerializerConfig, SerializerInterceptor, SerializerModule, SerializerService };