@iamnnort/nestjs-serializer 1.0.4 → 1.1.1

package/README.md

@@ -74,8 +74,8 @@ export class User extends Model {
 
 // controller.ts
 
-import { Controller, Get, UseInterceptors } from '@nestjs/common';
-import { SerializerInterceptor } from '@iamnnort/nestjs-serializer';
+import { Controller, Get, Post, UseInterceptors } from '@nestjs/common';
+import { SerializerIdInterceptor, SerializerInterceptor } from '@iamnnort/nestjs-serializer';
 import { User } from './user';
 import { Scopes } from './types';
 import { City } from './city';
@@ -83,7 +83,7 @@ import { City } from './city';
 @Controller()
 export class AppController {
   @Get()
-  @UseInterceptors(SerializerInterceptor([Scopes.BASE]))
+  @UseInterceptors(SerializerInterceptor({ scopes: [Scopes.BASE] }))
   search() {
     const city = new City({
       id: 1,
@@ -100,7 +100,7 @@ export class AppController {
   }
 
   @Get(':id')
-  @UseInterceptors(SerializerInterceptor([Scopes.BASE, Scopes.FULL]))
+  @UseInterceptors(SerializerInterceptor({ scopes: [Scopes.BASE, Scopes.FULL] }))
   get() {
     const city = new City({
       id: 1,
@@ -115,6 +115,23 @@ export class AppController {
 
     return user;
   }
+
+  @Post()
+  @UseInterceptors(SerializerIdInterceptor)
+  create() {
+    const city = new City({
+      id: 1,
+      name: 'London',
+    });
+
+    const user = new User({
+      id: 1,
+      name: 'John',
+      city,
+    });
+
+    return user;
+  }
 }
 
 // module.ts
@@ -164,6 +181,8 @@ bootstrap();
 [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" } }]
+[System] [Request] POST /1
+[System] [Response] POST /1 201 Created { id: 1 }
 ```
 
 ## License

package/dist/index.d.mts

@@ -14,7 +14,7 @@ declare const SerializeRelation: (configs: {
 }[]) => (target: object, name: string) => void;
 
 declare global {
-    var transformFieldConfigs: {
+    var serializerFieldConfigs: {
         scopes: string[];
         relationScopes?: string[];
         target: Function;
@@ -31,23 +31,36 @@ declare class SerializerService {
     config: SerializerConfig;
     globalEntityNames: string[];
     constructor(config: SerializerConfig);
-    transform(response: any, scopes: string[]): Promise<any>;
+    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[]) => {
+declare const SerializerInterceptor: (config: {
+    scopes?: string[];
+    extendedScopes?: string[];
+    fields?: string[];
+}) => {
     new (serializerService: SerializerService): {
         serializerService: SerializerService;
         intercept(ctx: ExecutionContext, next: CallHandler<Promise<any>>): rxjs.Observable<Promise<any>>;
-        getScopes(ctx: ExecutionContext): string[];
+        getScopes(ctx: ExecutionContext): string[] | undefined;
     };
 };
+declare const SerializerIdInterceptor_base: {
+    new (serializerService: SerializerService): {
+        serializerService: SerializerService;
+        intercept(ctx: ExecutionContext, next: CallHandler<Promise<any>>): rxjs.Observable<Promise<any>>;
+        getScopes(ctx: ExecutionContext): string[] | undefined;
+    };
+};
+declare class SerializerIdInterceptor extends SerializerIdInterceptor_base {
+}
 
 declare const ConfigurableModuleClass: _nestjs_common.ConfigurableModuleCls<SerializerConfig, "register", "create", {}>;
 
 declare class SerializerModule extends ConfigurableModuleClass {
 }
 
-export { SerializeField, SerializeRelation, type SerializerConfig, SerializerInterceptor, SerializerModule, SerializerService };
+export { SerializeField, SerializeRelation, type SerializerConfig, SerializerIdInterceptor, SerializerInterceptor, SerializerModule, SerializerService };

package/dist/index.d.ts

@@ -14,7 +14,7 @@ declare const SerializeRelation: (configs: {
 }[]) => (target: object, name: string) => void;
 
 declare global {
-    var transformFieldConfigs: {
+    var serializerFieldConfigs: {
         scopes: string[];
         relationScopes?: string[];
         target: Function;
@@ -31,23 +31,36 @@ declare class SerializerService {
     config: SerializerConfig;
     globalEntityNames: string[];
     constructor(config: SerializerConfig);
-    transform(response: any, scopes: string[]): Promise<any>;
+    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[]) => {
+declare const SerializerInterceptor: (config: {
+    scopes?: string[];
+    extendedScopes?: string[];
+    fields?: string[];
+}) => {
     new (serializerService: SerializerService): {
         serializerService: SerializerService;
         intercept(ctx: ExecutionContext, next: CallHandler<Promise<any>>): rxjs.Observable<Promise<any>>;
-        getScopes(ctx: ExecutionContext): string[];
+        getScopes(ctx: ExecutionContext): string[] | undefined;
     };
 };
+declare const SerializerIdInterceptor_base: {
+    new (serializerService: SerializerService): {
+        serializerService: SerializerService;
+        intercept(ctx: ExecutionContext, next: CallHandler<Promise<any>>): rxjs.Observable<Promise<any>>;
+        getScopes(ctx: ExecutionContext): string[] | undefined;
+    };
+};
+declare class SerializerIdInterceptor extends SerializerIdInterceptor_base {
+}
 
 declare const ConfigurableModuleClass: _nestjs_common.ConfigurableModuleCls<SerializerConfig, "register", "create", {}>;
 
 declare class SerializerModule extends ConfigurableModuleClass {
 }
 
-export { SerializeField, SerializeRelation, type SerializerConfig, SerializerInterceptor, SerializerModule, SerializerService };
+export { SerializeField, SerializeRelation, type SerializerConfig, SerializerIdInterceptor, SerializerInterceptor, SerializerModule, SerializerService };

package/dist/index.js

@@ -8993,11 +8993,11 @@ var require_operators = __commonJS({
 });
 
 // src/decorator.ts
-global.transformFieldConfigs = [];
+global.serializerFieldConfigs = [];
 var SerializeField = /* @__PURE__ */ __name((configs) => {
   return (target, name) => {
     configs.forEach((config) => {
-      global.transformFieldConfigs.push({
+      global.serializerFieldConfigs.push({
         scopes: config.scopes,
         target: target.constructor,
         name,
@@ -9009,7 +9009,7 @@ var SerializeField = /* @__PURE__ */ __name((configs) => {
 var SerializeRelation = /* @__PURE__ */ __name((configs) => {
   return (target, name) => {
     configs.forEach((config) => {
-      global.transformFieldConfigs.push({
+      global.serializerFieldConfigs.push({
         scopes: config.scopes,
         relationScopes: config.relationScopes,
         target: target.constructor,
@@ -9085,7 +9085,7 @@ var SerializerService = class {
     if (!entity) {
       return entity;
     }
-    const transformFieldConfigs = global.transformFieldConfigs.filter((fieldConfig) => {
+    const serializerFieldConfigs = global.serializerFieldConfigs.filter((fieldConfig) => {
       const isTarget = fieldConfig.target === entity.constructor;
       if (!isTarget) {
         const isGlobalTarget = this.globalEntityNames.includes(fieldConfig.target.name);
@@ -9099,7 +9099,7 @@ var SerializerService = class {
       return isScope;
     });
     let transformedEntity = {};
-    await Promise.all(transformFieldConfigs.map(async (fieldConfig) => {
+    await Promise.all(serializerFieldConfigs.map(async (fieldConfig) => {
       const fieldName = fieldConfig.fieldName || fieldConfig.name;
       let fieldValue = await entity[fieldConfig.name];
       if (!_lodash.isNil.call(void 0, fieldConfig.relationScopes)) {
@@ -9164,6 +9164,7 @@ SerializerService = exports.SerializerService = _ts_decorate([
 ], SerializerService);
 
 // src/interceptor.ts
+
 function _ts_decorate2(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -9175,7 +9176,7 @@ function _ts_metadata2(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
 __name(_ts_metadata2, "_ts_metadata");
-var SerializerInterceptor = /* @__PURE__ */ __name((scopes, extendedScopes) => {
+var SerializerInterceptor = /* @__PURE__ */ __name((config) => {
   let SerializerInterceptor2 = class SerializerInterceptor {
     static {
       __name(this, "SerializerInterceptor");
@@ -9185,21 +9186,24 @@ var SerializerInterceptor = /* @__PURE__ */ __name((scopes, extendedScopes) => {
       this.serializerService = serializerService;
     }
     intercept(ctx, next) {
-      const actualScopes = this.getScopes(ctx);
+      const scopes = this.getScopes(ctx);
       return next.handle().pipe((0, import_operators.map)(async (responsePromise) => {
-        if (!actualScopes) {
-          return responsePromise;
-        }
         const response = await responsePromise;
-        return this.serializerService.transform(response, actualScopes);
+        if (config.fields) {
+          return _lodash.pick.call(void 0, response, config.fields);
+        }
+        if (scopes) {
+          return this.serializerService.transform(response, scopes);
+        }
+        return response;
       }));
     }
     getScopes(ctx) {
       const request = ctx.switchToHttp().getRequest();
       if (request.query.extended) {
-        return extendedScopes || scopes;
+        return config.extendedScopes || config.scopes;
       }
-      return scopes;
+      return config.scopes;
     }
   };
   SerializerInterceptor2 = _ts_decorate2([
@@ -9211,6 +9215,18 @@ var SerializerInterceptor = /* @__PURE__ */ __name((scopes, extendedScopes) => {
   ], SerializerInterceptor2);
   return SerializerInterceptor2;
 }, "SerializerInterceptor");
+var SerializerIdInterceptor = class extends SerializerInterceptor({
+  fields: [
+    "id"
+  ]
+}) {
+  static {
+    __name(this, "SerializerIdInterceptor");
+  }
+};
+SerializerIdInterceptor = exports.SerializerIdInterceptor = _ts_decorate2([
+  _common.Injectable.call(void 0, )
+], SerializerIdInterceptor);
 
 // src/module.ts
 
@@ -9242,5 +9258,6 @@ SerializerModule = exports.SerializerModule = _ts_decorate3([
 
 
 
-exports.SerializeField = SerializeField; exports.SerializeRelation = SerializeRelation; exports.SerializerInterceptor = SerializerInterceptor; exports.SerializerModule = SerializerModule; exports.SerializerService = SerializerService;
+
+exports.SerializeField = SerializeField; exports.SerializeRelation = SerializeRelation; exports.SerializerIdInterceptor = SerializerIdInterceptor; exports.SerializerInterceptor = SerializerInterceptor; exports.SerializerModule = SerializerModule; exports.SerializerService = SerializerService;
 //# sourceMappingURL=index.js.map