@nestia/sdk 3.10.0 → 3.11.0-dev.20240813

package/src/generates/internal/SdkWebSocketRouteProgrammer.ts

@@ -2,24 +2,22 @@ import ts from "typescript";
 import { IJsDocTagInfo } from "typia";
 import { IdentifierFactory } from "typia/lib/factories/IdentifierFactory";
 
-import { INestiaProject } from "../../structures/INestiaProject";
 import { ITypedWebSocketRoute } from "../../structures/ITypedWebSocketRoute";
 import { FilePrinter } from "./FilePrinter";
 import { ImportDictionary } from "./ImportDictionary";
+import { SdkAliasCollection } from "./SdkAliasCollection";
 import { SdkImportWizard } from "./SdkImportWizard";
-import { SdkTypeProgrammer } from "./SdkTypeProgrammer";
 import { SdkWebSocketNamespaceProgrammer } from "./SdkWebSocketNamespaceProgrammer";
 
 export namespace SdkWebSocketRouteProgrammer {
   export const write =
-    (project: INestiaProject) =>
     (importer: ImportDictionary) =>
     (route: ITypedWebSocketRoute): ts.Statement[] => [
       FilePrinter.description(
-        writeFunction(project)(importer)(route),
+        writeFunction(importer)(route),
         writeDescription(route),
       ),
-      SdkWebSocketNamespaceProgrammer.write(project)(importer)(route),
+      SdkWebSocketNamespaceProgrammer.write(importer)(route),
     ];
 
   const writeDescription = (route: ITypedWebSocketRoute): string => {
@@ -48,7 +46,7 @@ export namespace SdkWebSocketRouteProgrammer {
     // POSTFIX
     if (!!comments.length) comments.push("");
     comments.push(
-      `@controller ${route.controller.name}.${route.name}`,
+      `@controller ${route.controller.class.name}.${route.name}`,
       `@path ${route.path}`,
       `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
     );
@@ -56,7 +54,6 @@ export namespace SdkWebSocketRouteProgrammer {
   };
 
   const writeFunction =
-    (project: INestiaProject) =>
     (importer: ImportDictionary) =>
     (route: ITypedWebSocketRoute): ts.FunctionDeclaration =>
       ts.factory.createFunctionDeclaration(
@@ -81,7 +78,7 @@ export namespace SdkWebSocketRouteProgrammer {
               IdentifierFactory.parameter(
                 p.name,
                 p.category === "param"
-                  ? getPathParameterType(project)(importer)(p)
+                  ? SdkAliasCollection.name(p.type)
                   : ts.factory.createTypeReferenceNode(`${route.name}.Query`),
               ),
             ),
@@ -268,10 +265,3 @@ const joinPath = (caller: ts.Expression) =>
       ts.factory.createTemplateTail("", ""),
     ),
   ]);
-const getPathParameterType =
-  (project: INestiaProject) =>
-  (importer: ImportDictionary) =>
-  (p: ITypedWebSocketRoute.IPathParameter) =>
-    p.metadata
-      ? SdkTypeProgrammer.write(project)(importer)(p.metadata)
-      : ts.factory.createTypeReferenceNode(p.typeName);

package/src/generates/internal/{SwaggerDescriptionGenerator.ts → SwaggerDescriptionComposer.ts}

@@ -1,8 +1,8 @@
 import { IJsDocTagInfo } from "typia";
 
-export namespace SwaggerDescriptionGenerator {
-  export const generate = <Kind extends "summary" | "title">(props: {
-    description?: string;
+export namespace SwaggerDescriptionComposer {
+  export const compose = <Kind extends "summary" | "title">(props: {
+    description: string | null;
     jsDocTags: IJsDocTagInfo[];
     kind: Kind;
   }): Kind extends "summary"
@@ -14,7 +14,7 @@ export namespace SwaggerDescriptionGenerator {
         name: props.kind,
       });
       if (explicit?.length) return explicit;
-      else if (props.description === undefined) return undefined;
+      else if (!props.description?.length) return undefined;
 
       const index: number = props.description.indexOf("\n");
       const top: string = (
@@ -28,7 +28,27 @@ export namespace SwaggerDescriptionGenerator {
     } as any;
   };
 
-  const getJsDocTexts = (props: {
+  export const descriptionFromJsDocTag = (props: {
+    jsDocTags: IJsDocTagInfo[];
+    tag: string;
+    parameter?: string;
+  }): string | undefined => {
+    const parametric: (elem: IJsDocTagInfo) => boolean = props.parameter
+      ? (tag) =>
+          tag.text!.find(
+            (elem) =>
+              elem.kind === "parameterName" && elem.text === props.parameter,
+          ) !== undefined
+      : () => true;
+    const tag: IJsDocTagInfo | undefined = props.jsDocTags.find(
+      (tag) => tag.name === props.tag && tag.text && parametric(tag),
+    );
+    return tag && tag.text
+      ? tag.text.find((elem) => elem.kind === "text")?.text
+      : undefined;
+  };
+
+  export const getJsDocTexts = (props: {
     jsDocTags: IJsDocTagInfo[];
     name: string;
   }): string[] =>

package/src/generates/internal/SwaggerOperationComposer.ts

@@ -0,0 +1,90 @@
+import { OpenApi } from "@samchon/openapi";
+import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { ITypedHttpRouteParameter } from "../../structures/ITypedHttpRouteParameter";
+import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
+import { SwaggerOperationParameterComposer } from "./SwaggerOperationParameterComposer";
+import { SwaggerOperationResponseComposer } from "./SwaggerOperationResponseComposer";
+
+export namespace SwaggerOperationComposer {
+  export const compose = (props: {
+    config: INestiaConfig.ISwaggerConfig;
+    document: OpenApi.IDocument;
+    schema: (metadata: Metadata) => OpenApi.IJsonSchema | undefined;
+    route: ITypedHttpRoute;
+  }): OpenApi.IOperation => {
+    // FIND REQUEST BODY
+    const body: ITypedHttpRouteParameter.IBody | undefined =
+      props.route.parameters.find((param) => param.category === "body");
+
+    // COMPOSE TAGS
+    const tags: Set<string> = new Set([
+      ...props.route.tags,
+      ...SwaggerDescriptionComposer.getJsDocTexts({
+        jsDocTags: props.route.jsDocTags,
+        name: "tag",
+      }).map((t) => t.split(" ")[0]),
+    ]);
+    if (tags.size) {
+      props.document.tags ??= [];
+      for (const t of tags)
+        if (props.document.tags.find((elem) => elem.name === t) === undefined)
+          props.document.tags.push({ name: t });
+      for (const texts of SwaggerDescriptionComposer.getJsDocTexts({
+        jsDocTags: props.route.jsDocTags,
+        name: "tag",
+      })) {
+        const [name, ...description] = texts.split(" ");
+        if (description.length)
+          props.document.tags.find(
+            (elem) => elem.name === name,
+          )!.description ??= description.join(" ");
+      }
+    }
+
+    // FINALIZE
+    return {
+      ...SwaggerDescriptionComposer.compose({
+        description: props.route.description,
+        jsDocTags: props.route.jsDocTags,
+        kind: "summary",
+      }),
+      deprecated: props.route.jsDocTags.some((tag) => tag.name === "deprecated")
+        ? true
+        : undefined,
+      tags: Array.from(tags),
+      operationId:
+        props.route.operationId ??
+        props.config.operationId?.({
+          class: props.route.controller.class.name,
+          function: props.route.name,
+          method: props.route.method as "GET",
+          path: props.route.path,
+        }),
+      parameters: props.route.parameters
+        .map((p) =>
+          SwaggerOperationParameterComposer.compose({
+            config: props.config,
+            document: props.document,
+            schema: props.schema(p.metadata)!,
+            parameter: p,
+            jsDocTags: props.route.jsDocTags,
+          }),
+        )
+        .flat(),
+      requestBody: body
+        ? SwaggerOperationParameterComposer.body({
+            schema: props.schema(body.metadata)!,
+            jsDocTags: props.route.jsDocTags,
+            parameter: body,
+          })
+        : undefined,
+      responses: SwaggerOperationResponseComposer.compose({
+        schema: props.schema,
+        route: props.route,
+      }),
+    };
+  };
+}

package/src/generates/internal/SwaggerOperationParameterComposer.ts

@@ -0,0 +1,173 @@
+import { OpenApi } from "@samchon/openapi";
+import { VariadicSingleton } from "tstl";
+import { IJsDocTagInfo, IJsonApplication } from "typia";
+import { JsonApplicationProgrammer } from "typia/lib/programmers/json/JsonApplicationProgrammer";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { ITypedHttpRouteParameter } from "../../structures/ITypedHttpRouteParameter";
+import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
+
+export namespace SwaggerOperationParameterComposer {
+  export interface IProps<Parameter extends ITypedHttpRouteParameter> {
+    config: INestiaConfig.ISwaggerConfig;
+    document: OpenApi.IDocument;
+    schema: OpenApi.IJsonSchema;
+    jsDocTags: IJsDocTagInfo[];
+    parameter: Parameter;
+  }
+
+  export const compose = (
+    props: IProps<ITypedHttpRouteParameter>,
+  ): OpenApi.IOperation.IParameter[] =>
+    props.parameter.category === "body"
+      ? []
+      : props.parameter.category === "param"
+        ? [path({ ...props, parameter: props.parameter })]
+        : props.parameter.category === "query"
+          ? query({ ...props, parameter: props.parameter })
+          : header({ ...props, parameter: props.parameter });
+
+  export const body = (
+    props: Omit<IProps<ITypedHttpRouteParameter.IBody>, "config" | "document">,
+  ): OpenApi.IOperation.IRequestBody => {
+    const description: string | undefined =
+      SwaggerDescriptionComposer.descriptionFromJsDocTag({
+        jsDocTags: props.jsDocTags,
+        tag: "param",
+        parameter: props.parameter.name,
+      });
+    return {
+      description: props.parameter.encrypted
+        ? `${warning.get(!!description)}${description ?? ""}`
+        : description,
+      content: {
+        [props.parameter.contentType]: {
+          schema: props.schema,
+          example: props.parameter.example,
+          examples: props.parameter.examples,
+        },
+      },
+      required: props.parameter.metadata.isRequired(),
+      ...(props.parameter.encrypted ? { "x-nestia-encrypted": true } : {}),
+    };
+  };
+
+  export const path = (
+    props: Omit<IProps<ITypedHttpRouteParameter.IParam>, "config" | "document">,
+  ): OpenApi.IOperation.IParameter => ({
+    name: props.parameter.field,
+    in: "path",
+    schema: props.schema,
+    required: props.parameter.metadata.isRequired(),
+    ...SwaggerDescriptionComposer.compose({
+      description:
+        props.parameter.description ??
+        props.parameter.jsDocTags.find((tag) => tag.name === "description")
+          ?.text?.[0].text ??
+        props.jsDocTags
+          .find(
+            (tag) =>
+              tag.name === "param" &&
+              tag.text?.[0].text === props.parameter.name,
+          )
+          ?.text?.map((e) => e.text)
+          .join("")
+          .substring(props.parameter.name.length) ??
+        null,
+      jsDocTags: props.parameter.jsDocTags,
+      kind: "title",
+    }),
+  });
+
+  export const query = (
+    props: IProps<ITypedHttpRouteParameter.IQuery>,
+  ): OpenApi.IOperation.IParameter[] => decomposible(props);
+
+  export const header = (
+    props: IProps<ITypedHttpRouteParameter.IHeaders>,
+  ): OpenApi.IOperation.IParameter[] => decomposible(props);
+
+  const decomposible = (
+    props: IProps<
+      ITypedHttpRouteParameter.IHeaders | ITypedHttpRouteParameter.IQuery
+    >,
+  ): OpenApi.IOperation.IParameter[] => {
+    const param: OpenApi.IOperation.IParameter = {
+      name: props.parameter.field ?? props.parameter.name,
+      in: props.parameter.category === "query" ? "query" : "header",
+      schema: props.schema,
+      ...SwaggerDescriptionComposer.compose({
+        description:
+          props.parameter.description ??
+          props.parameter.jsDocTags.find((tag) => tag.name === "description")
+            ?.text?.[0].text ??
+          props.jsDocTags
+            .find(
+              (tag) =>
+                tag.name === "param" &&
+                tag.text?.[0].text === props.parameter.name,
+            )
+            ?.text?.map((e) => e.text)
+            .join("")
+            .substring(props.parameter.name.length) ??
+          null,
+        jsDocTags: props.jsDocTags,
+        kind: "title",
+      }),
+      example: props.parameter.example,
+      examples: props.parameter.examples,
+    };
+    if (
+      props.config.decompose === false ||
+      props.parameter.metadata.objects.length === 0
+    )
+      return [param];
+    return props.parameter.metadata.objects[0].properties
+      .filter((p) =>
+        p.jsDocTags.every(
+          (tag) => tag.name !== "hidden" && tag.name !== "ignore",
+        ),
+      )
+      .map((p) => {
+        const json: IJsonApplication = JsonApplicationProgrammer.write("3.1")([
+          p.value,
+        ]) as IJsonApplication;
+        if (Object.keys(json.components.schemas ?? {}).length !== 0) {
+          props.document.components ??= {};
+          props.document.components.schemas ??= {};
+          Object.assign(
+            props.document.components.schemas,
+            json.components.schemas,
+          );
+        }
+        return {
+          name: p.key.constants[0].values[0].value as string,
+          in: props.parameter.category === "query" ? "query" : "header",
+          schema: json.schemas[0],
+          required: p.value.isRequired(),
+          ...SwaggerDescriptionComposer.compose({
+            description: p.description ?? null,
+            jsDocTags: p.jsDocTags,
+            kind: "title",
+          }),
+        };
+      });
+  };
+}
+
+const warning = new VariadicSingleton((described: boolean): string => {
+  const summary = "Request body must be encrypted.";
+  const component =
+    "[EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody)";
+  const content: string[] = [
+    "## Warning",
+    "",
+    summary,
+    "",
+    `The request body data would be encrypted as "AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding", through the ${component} component.`,
+    "",
+    `Therefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.`,
+  ];
+  if (described === true) content.push("", "----------------", "", "");
+  return content.join("\n");
+});

package/src/generates/internal/SwaggerOperationResponseComposer.ts

@@ -0,0 +1,110 @@
+import { OpenApi } from "@samchon/openapi";
+import { VariadicSingleton } from "tstl";
+import { Metadata } from "typia/lib/schemas/metadata/Metadata";
+
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { StringUtil } from "../../utils/StringUtil";
+import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
+
+export namespace SwaggerOperationResponseComposer {
+  export const compose = (props: {
+    schema: (metadata: Metadata) => OpenApi.IJsonSchema | undefined;
+    route: ITypedHttpRoute;
+  }): Record<string, OpenApi.IOperation.IResponse> => {
+    const output: Record<string, OpenApi.IOperation.IResponse> = {};
+    // FROM DECORATOR
+    for (const [status, error] of Object.entries(props.route.exceptions))
+      output[status] = {
+        description: error.description ?? undefined,
+        content: {
+          "application/json": {
+            schema: props.schema(error.metadata),
+            example: error.example,
+            examples: error.examples,
+          },
+        },
+      };
+
+    // FROM COMMENTS
+    for (const tag of props.route.jsDocTags) {
+      if (tag.name !== "throw" && tag.name !== "throws") continue;
+      const text: string | undefined = tag.text?.find(
+        (elem) => elem.kind === "text",
+      )?.text;
+      if (text === undefined) continue;
+
+      const elements: string[] = text.split(" ").map((str) => str.trim());
+      const status: string = elements[0];
+      if (
+        isNaN(Number(status)) &&
+        status !== "2XX" &&
+        status !== "3XX" &&
+        status !== "4XX" &&
+        status !== "5XX"
+      )
+        continue;
+
+      const description: string | undefined =
+        elements.length === 1 ? undefined : elements.slice(1).join(" ");
+      const oldbie = output[status];
+      if (description && oldbie !== undefined)
+        oldbie.description ??= description;
+      else if (oldbie === undefined)
+        output[status] = {
+          description,
+          content: {
+            "application/json": {
+              schema: {},
+            },
+          },
+        };
+    }
+
+    // SUCESS
+    const description: string | undefined =
+      SwaggerDescriptionComposer.descriptionFromJsDocTag({
+        jsDocTags: props.route.jsDocTags,
+        tag: "returns",
+      }) ??
+      SwaggerDescriptionComposer.descriptionFromJsDocTag({
+        jsDocTags: props.route.jsDocTags,
+        tag: "return",
+      });
+    output[
+      props.route.success.status ??
+        (props.route.method.toLowerCase() === "post" ? 201 : 200)
+    ] = {
+      description: props.route.success.encrypted
+        ? `${warning.get(!!description, props.route.method)}${description ?? ""}`
+        : description,
+      content: props.route.success.contentType
+        ? {
+            [props.route.success.contentType]: {
+              schema: props.schema(props.route.success.metadata),
+              example: props.route.success.example,
+              examples: props.route.success.examples,
+            },
+          }
+        : undefined,
+      ...(props.route.success.encrypted ? { "x-nestia-encrypted": true } : {}),
+    };
+    return output;
+  };
+}
+
+const warning = new VariadicSingleton((described: boolean, method: string) => {
+  const summary: string = "Response data have been encrypted.";
+  const component: string = `[EncryptedRoute.${StringUtil.capitalize(method)}](https://github.com/samchon/@nestia/core#encryptedroute)`;
+
+  const content: string[] = [
+    "## Warning",
+    "",
+    summary,
+    "",
+    `The response body data would be encrypted as "AES-128(256) / CBC mode / PKCS#5 Padding / Base64 Encoding", through the ${component} component.`,
+    "",
+    `Therefore, just utilize this swagger editor only for referencing. If you need to call the real API, using [SDK](https://github.com/samchon/nestia#software-development-kit) would be much better.`,
+  ];
+  if (described === true) content.push("", "----------------", "", "");
+  return content.join("\n");
+});

package/src/structures/INestiaProject.ts

@@ -1,13 +1,13 @@
 import ts from "typescript";
 
 import { INestiaConfig } from "../INestiaConfig";
-import { IErrorReport } from "./IErrorReport";
-import { INormalizedInput } from "./INormalizedInput";
+import { INestiaSdkInput } from "./INestiaSdkInput";
+import { IReflectOperationError } from "./IReflectOperationError";
 
 export interface INestiaProject {
   config: INestiaConfig;
-  input: INormalizedInput;
+  input: INestiaSdkInput;
   checker: ts.TypeChecker;
-  errors: IErrorReport[];
-  warnings: IErrorReport[];
+  errors: IReflectOperationError[];
+  warnings: IReflectOperationError[];
 }

package/src/structures/INestiaSdkInput.ts

@@ -0,0 +1,25 @@
+import {
+  INestApplication,
+  RouteInfo,
+  VersionValue,
+} from "@nestjs/common/interfaces";
+
+export interface INestiaSdkInput {
+  application: INestApplication;
+  controllers: INestiaSdkInput.IController[];
+  globalPrefix?: {
+    prefix: string;
+    exclude?: Array<string | RouteInfo>;
+  };
+  versioning?: {
+    prefix: string;
+    defaultVersion?: VersionValue;
+  };
+}
+export namespace INestiaSdkInput {
+  export interface IController {
+    class: Function;
+    location: string;
+    prefixes: string[];
+  }
+}

package/src/structures/IReflectApplication.ts

@@ -0,0 +1,8 @@
+import { INestApplication } from "@nestjs/common";
+
+import { IReflectController } from "./IReflectController";
+
+export interface IReflectApplication {
+  application: INestApplication;
+  controllers: IReflectController[];
+}

package/src/structures/IReflectController.ts

@@ -4,14 +4,12 @@ import { IReflectHttpOperation } from "./IReflectHttpOperation";
 import { IReflectWebSocketOperation } from "./IReflectWebSocketOperation";
 
 export interface IReflectController {
-  constructor: Function;
-  prototype: any;
-  file: string;
-  name: string;
+  class: Function;
   prefixes: string[];
   paths: string[];
+  file: string;
   versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
   operations: Array<IReflectHttpOperation | IReflectWebSocketOperation>;
   security: Record<string, string[]>[];
-  swaggerTgas: string[];
+  tags: string[];
 }

package/src/structures/IReflectHttpOperation.ts

@@ -1,6 +1,10 @@
 import { VERSION_NEUTRAL } from "@nestjs/common/interfaces";
+import { IJsDocTagInfo } from "typia";
 
-import { ParamCategory } from "./ParamCategory";
+import { IReflectHttpOperationException } from "./IReflectHttpOperationException";
+import { IReflectHttpOperationParameter } from "./IReflectHttpOperationParameter";
+import { IReflectHttpOperationSuccess } from "./IReflectHttpOperationSuccess";
+import { IReflectTypeImport } from "./IReflectTypeImport";
 
 export interface IReflectHttpOperation {
   protocol: "http";
@@ -9,82 +13,16 @@ export interface IReflectHttpOperation {
   method: string;
   paths: string[];
   versions: Array<string | typeof VERSION_NEUTRAL> | undefined;
-  encrypted: boolean;
-  parameters: IReflectHttpOperation.IParameter[];
-  status?: number;
-  type?: string;
-  contentType: "application/json" | "text/plain";
-  security: Record<string, string[]>[];
+  parameters: IReflectHttpOperationParameter[];
+  success: IReflectHttpOperationSuccess;
   exceptions: Record<
     number | "2XX" | "3XX" | "4XX" | "5XX",
-    IReflectHttpOperation.IException
+    IReflectHttpOperationException
   >;
-  example?: any;
-  examples?: Record<string, any>;
-  swaggerTags: string[];
-}
-export namespace IReflectHttpOperation {
-  export type IParameter =
-    | ICommonParameter
-    | IQueryParameter
-    | IHeadersParameter
-    | IBodyParameter
-    | IPathParameter;
-  export interface ICommonParameter {
-    custom: false;
-    category: ParamCategory;
-    index: number;
-    name: string;
-    field: string | undefined;
-    example?: any;
-    examples?: Record<string, any>;
-  }
-  export interface IHeadersParameter {
-    custom: true;
-    category: "headers";
-    index: number;
-    name: string;
-    field: string | undefined;
-    example?: any;
-    examples?: Record<string, any>;
-  }
-  export interface IQueryParameter {
-    custom: true;
-    category: "query";
-    index: number;
-    name: string;
-    field: string | undefined;
-    example?: any;
-    examples?: Record<string, any>;
-  }
-  export interface IBodyParameter {
-    custom: true;
-    category: "body";
-    index: number;
-    name: string;
-    field: string | undefined;
-    encrypted: boolean;
-    contentType:
-      | "application/json"
-      | "application/x-www-form-urlencoded"
-      | "multipart/form-data"
-      | "text/plain";
-    example?: any;
-    examples?: Record<string, any>;
-  }
-  export interface IPathParameter {
-    custom: true;
-    category: "param";
-    index: number;
-    name: string;
-    field: string | undefined;
-    example?: any;
-    examples?: Record<string, any>;
-  }
-
-  export interface IException {
-    type: string;
-    status: number | "2XX" | "3XX" | "4XX" | "5XX";
-    description: string | undefined;
-  }
+  security: Record<string, string[]>[];
+  tags: string[];
+  imports: IReflectTypeImport[];
+  operationId: string | undefined;
+  description: string | null;
+  jsDocTags: IJsDocTagInfo[];
 }

package/src/structures/IReflectHttpOperationException.ts

@@ -0,0 +1,19 @@
+import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+import { IMetadata } from "typia/lib/schemas/metadata/IMetadata";
+import { IMetadataComponents } from "typia/lib/schemas/metadata/IMetadataComponents";
+
+import { IReflectType } from "./IReflectType";
+
+export interface IReflectHttpOperationException {
+  // BASIC PROPERTIES
+  status: number | "2XX" | "3XX" | "4XX" | "5XX";
+  description: string | null;
+  example: any;
+  examples: Record<string, any>;
+
+  // REFLECTED PROPERTIES
+  type: IReflectType;
+  metadata: IMetadata;
+  components: IMetadataComponents;
+  validate: MetadataFactory.Validator;
+}