@nestia/core 3.7.0-dev.20240711 → 3.7.0-dev.20240712

package/lib/decorators/SwaggerExample.d.ts

@@ -0,0 +1,11 @@
+export declare namespace SwaggerExample {
+    function Response<T>(value: T): MethodDecorator;
+    function Response<T>(key: string, value: T): MethodDecorator;
+    function Parameter<T>(value: T): ParameterDecorator;
+    function Parameter<T>(key: string, value: T): ParameterDecorator;
+    interface IData<T> {
+        examples?: Record<string, T>;
+        example?: T;
+        index?: number;
+    }
+}

package/lib/decorators/SwaggerExample.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerExample = void 0;
+var SwaggerExample;
+(function (SwaggerExample) {
+    function Response(...args) {
+        return function SwaggerExampleResponse(_target, _propertyKey, descriptor) {
+            emplaceValue(emplaceOfResponse(descriptor))(args);
+            return descriptor;
+        };
+    }
+    SwaggerExample.Response = Response;
+    function Parameter(...args) {
+        return function SwaggerExampleParameter(target, propertyKey, index) {
+            emplaceValue(emplaceOfParameter(target, propertyKey !== null && propertyKey !== void 0 ? propertyKey : "", index))(args);
+        };
+    }
+    SwaggerExample.Parameter = Parameter;
+})(SwaggerExample || (exports.SwaggerExample = SwaggerExample = {}));
+const emplaceValue = (data) => (args) => {
+    var _a;
+    if (args.length === 1)
+        data.example = args[0];
+    else {
+        const key = args[0];
+        const value = args[1];
+        (_a = data.examples) !== null && _a !== void 0 ? _a : (data.examples = {});
+        data.examples[key] = value;
+    }
+};
+const emplaceOfResponse = (descriptor) => {
+    const oldbie = Reflect.getMetadata("nestia/SwaggerExample/Response", descriptor.value);
+    if (oldbie !== undefined)
+        return oldbie;
+    const newbie = {};
+    Reflect.defineMetadata("nestia/SwaggerExample/Response", newbie, descriptor.value);
+    return newbie;
+};
+const emplaceOfParameter = (target, propertyKey, index) => {
+    const array = emplaceArrayOfParameters(target, propertyKey);
+    const oldibe = array.find((e) => e.index === index);
+    if (oldibe !== undefined)
+        return oldibe;
+    const data = { index };
+    array.push(data);
+    return data;
+};
+const emplaceArrayOfParameters = (target, propertyKey) => {
+    const array = Reflect.getMetadata("nestia/SwaggerExample/Parameters", target, propertyKey);
+    if (array !== undefined)
+        return array;
+    const newbie = [];
+    Reflect.defineMetadata("nestia/SwaggerExample/Parameters", newbie, target, propertyKey);
+    return newbie;
+};
+//# sourceMappingURL=SwaggerExample.js.map

package/lib/decorators/SwaggerExample.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwaggerExample.js","sourceRoot":"","sources":["../../src/decorators/SwaggerExample.ts"],"names":[],"mappings":";;;AAAA,IAAiB,cAAc,CA+B9B;AA/BD,WAAiB,cAAc;IAG7B,SAAgB,QAAQ,CAAC,GAAG,IAAW;QACrC,OAAO,SAAS,sBAAsB,CACpC,OAAe,EACf,YAA6B,EAC7B,UAAwC;YAExC,YAAY,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAClD,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC;IATe,uBAAQ,WASvB,CAAA;IAID,SAAgB,SAAS,CAAC,GAAG,IAAW;QACtC,OAAO,SAAS,uBAAuB,CACrC,MAAc,EACd,WAAwC,EACxC,KAAa;YAEb,YAAY,CAAC,kBAAkB,CAAC,MAAM,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3E,CAAC,CAAC;IACJ,CAAC;IARe,wBAAS,YAQxB,CAAA;AAOH,CAAC,EA/BgB,cAAc,8BAAd,cAAc,QA+B9B;AAED,MAAM,YAAY,GAChB,CAAI,IAA6B,EAAE,EAAE,CACrC,CAAC,IAAW,EAAE,EAAE;;IACd,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;SACzC,CAAC;QACJ,MAAM,GAAG,GAAW,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,KAAK,GAAM,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,MAAA,IAAI,CAAC,QAAQ,oCAAb,IAAI,CAAC,QAAQ,GAAK,EAAE,EAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC7B,CAAC;AACH,CAAC,CAAC;AAEJ,MAAM,iBAAiB,GAAG,CACxB,UAAwC,EACf,EAAE;IAC3B,MAAM,MAAM,GAAwC,OAAO,CAAC,WAAW,CACrE,gCAAgC,EAChC,UAAU,CAAC,KAAK,CACjB,CAAC;IACF,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACxC,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,OAAO,CAAC,cAAc,CACpB,gCAAgC,EAChC,MAAM,EACN,UAAU,CAAC,KAAK,CACjB,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACzB,MAAc,EACd,WAA4B,EAC5B,KAAa,EACc,EAAE;IAC7B,MAAM,KAAK,GAAgC,wBAAwB,CACjE,MAAM,EACN,WAAW,CACZ,CAAC;IACF,MAAM,MAAM,GAA0C,KAAK,CAAC,IAAI,CAC9D,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CACzB,CAAC;IACF,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAExC,MAAM,IAAI,GAA8B,EAAE,KAAK,EAAE,CAAC;IAClD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAC/B,MAAc,EACd,WAA4B,EACC,EAAE;IAC/B,MAAM,KAAK,GAA4C,OAAO,CAAC,WAAW,CACxE,kCAAkC,EAClC,MAAM,EACN,WAAW,CACZ,CAAC;IACF,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtC,MAAM,MAAM,GAAgC,EAAE,CAAC;IAC/C,OAAO,CAAC,cAAc,CACpB,kCAAkC,EAClC,MAAM,EACN,MAAM,EACN,WAAW,CACZ,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/module.d.ts

@@ -13,5 +13,6 @@ export * from "./decorators/EncryptedBody";
 export * from "./decorators/EncryptedModule";
 export * from "./decorators/PlainBody";
 export * from "./decorators/SwaggerCustomizer";
+export * from "./decorators/SwaggerExample";
 export * from "./adaptors/WebSocketAdaptor";
 export * from "./decorators/WebSocketRoute";

package/lib/module.js

@@ -29,6 +29,7 @@ __exportStar(require("./decorators/EncryptedBody"), exports);
 __exportStar(require("./decorators/EncryptedModule"), exports);
 __exportStar(require("./decorators/PlainBody"), exports);
 __exportStar(require("./decorators/SwaggerCustomizer"), exports);
+__exportStar(require("./decorators/SwaggerExample"), exports);
 __exportStar(require("./adaptors/WebSocketAdaptor"), exports);
 __exportStar(require("./decorators/WebSocketRoute"), exports);
 //# sourceMappingURL=module.js.map

package/lib/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,2DAAyC;AAEzC,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AACxC,8DAA4C;AAC5C,4DAA0C;AAC1C,6DAA2C;AAC3C,0DAAwC;AAExC,mEAAiD;AACjD,8DAA4C;AAC5C,6DAA2C;AAC3C,+DAA6C;AAC7C,yDAAuC;AACvC,iEAA+C;AAE/C,8DAA4C;AAC5C,8DAA4C"}
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,2DAAyC;AAEzC,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AACxC,8DAA4C;AAC5C,4DAA0C;AAC1C,6DAA2C;AAC3C,0DAAwC;AAExC,mEAAiD;AACjD,8DAA4C;AAC5C,6DAA2C;AAC3C,+DAA6C;AAC7C,yDAAuC;AACvC,iEAA+C;AAC/C,8DAA4C;AAE5C,8DAA4C;AAC5C,8DAA4C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/core",
-  "version": "3.7.0-dev.20240711",
+  "version": "3.7.0-dev.20240712",
   "description": "Super-fast validation decorators of NestJS",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -36,7 +36,7 @@
   },
   "homepage": "https://nestia.io",
   "dependencies": {
-    "@nestia/fetcher": "^3.7.0-dev.20240711",
+    "@nestia/fetcher": "^3.7.0-dev.20240712",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "@samchon/openapi": "^0.3.4",
@@ -53,7 +53,7 @@
     "ws": "^7.5.3"
   },
   "peerDependencies": {
-    "@nestia/fetcher": ">=3.7.0-dev.20240711",
+    "@nestia/fetcher": ">=3.7.0-dev.20240712",
     "@nestjs/common": ">=7.0.1",
     "@nestjs/core": ">=7.0.1",
     "reflect-metadata": ">=0.1.12",

package/src/decorators/SwaggerExample.ts

@@ -0,0 +1,100 @@
+export namespace SwaggerExample {
+  export function Response<T>(value: T): MethodDecorator;
+  export function Response<T>(key: string, value: T): MethodDecorator;
+  export function Response(...args: any[]): MethodDecorator {
+    return function SwaggerExampleResponse(
+      _target: Object,
+      _propertyKey: string | symbol,
+      descriptor: TypedPropertyDescriptor<any>,
+    ): TypedPropertyDescriptor<any> {
+      emplaceValue(emplaceOfResponse(descriptor))(args);
+      return descriptor;
+    };
+  }
+
+  export function Parameter<T>(value: T): ParameterDecorator;
+  export function Parameter<T>(key: string, value: T): ParameterDecorator;
+  export function Parameter(...args: any[]): ParameterDecorator {
+    return function SwaggerExampleParameter(
+      target: Object,
+      propertyKey: string | symbol | undefined,
+      index: number,
+    ): void {
+      emplaceValue(emplaceOfParameter(target, propertyKey ?? "", index))(args);
+    };
+  }
+
+  export interface IData<T> {
+    examples?: Record<string, T>;
+    example?: T;
+    index?: number;
+  }
+}
+
+const emplaceValue =
+  <T>(data: SwaggerExample.IData<T>) =>
+  (args: any[]) => {
+    if (args.length === 1) data.example = args[0];
+    else {
+      const key: string = args[0];
+      const value: T = args[1];
+      data.examples ??= {};
+      data.examples[key] = value;
+    }
+  };
+
+const emplaceOfResponse = <T>(
+  descriptor: TypedPropertyDescriptor<any>,
+): SwaggerExample.IData<T> => {
+  const oldbie: SwaggerExample.IData<T> | undefined = Reflect.getMetadata(
+    "nestia/SwaggerExample/Response",
+    descriptor.value,
+  );
+  if (oldbie !== undefined) return oldbie;
+  const newbie: SwaggerExample.IData<T> = {};
+  Reflect.defineMetadata(
+    "nestia/SwaggerExample/Response",
+    newbie,
+    descriptor.value,
+  );
+  return newbie;
+};
+
+const emplaceOfParameter = (
+  target: Object,
+  propertyKey: string | symbol,
+  index: number,
+): SwaggerExample.IData<any> => {
+  const array: SwaggerExample.IData<any>[] = emplaceArrayOfParameters(
+    target,
+    propertyKey,
+  );
+  const oldibe: SwaggerExample.IData<any> | undefined = array.find(
+    (e) => e.index === index,
+  );
+  if (oldibe !== undefined) return oldibe;
+
+  const data: SwaggerExample.IData<any> = { index };
+  array.push(data);
+  return data;
+};
+
+const emplaceArrayOfParameters = (
+  target: Object,
+  propertyKey: string | symbol,
+): SwaggerExample.IData<any>[] => {
+  const array: SwaggerExample.IData<any>[] | undefined = Reflect.getMetadata(
+    "nestia/SwaggerExample/Parameters",
+    target,
+    propertyKey,
+  );
+  if (array !== undefined) return array;
+  const newbie: SwaggerExample.IData<any>[] = [];
+  Reflect.defineMetadata(
+    "nestia/SwaggerExample/Parameters",
+    newbie,
+    target,
+    propertyKey,
+  );
+  return newbie;
+};

package/src/decorators/WebSocketRoute.ts

@@ -48,7 +48,7 @@ export function WebSocketRoute(
     _target: Object,
     _propertyKey: string | symbol,
     descriptor: TypedPropertyDescriptor<any>,
-  ) {
+  ): TypedPropertyDescriptor<any> {
     Reflect.defineMetadata(
       "nestia/WebSocketRoute",
       {

package/src/module.ts

@@ -15,6 +15,7 @@ export * from "./decorators/EncryptedBody";
 export * from "./decorators/EncryptedModule";
 export * from "./decorators/PlainBody";
 export * from "./decorators/SwaggerCustomizer";
+export * from "./decorators/SwaggerExample";
 
 export * from "./adaptors/WebSocketAdaptor";
 export * from "./decorators/WebSocketRoute";