@nestia/sdk 3.10.0 → 3.11.0-dev.20240813

package/src/generates/internal/SwaggerSchemaGenerator.ts

@@ -1,473 +0,0 @@
-import { OpenApi } from "@samchon/openapi";
-import { Singleton, VariadicSingleton } from "tstl";
-import ts from "typescript";
-import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
-import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-import { JsonApplicationProgrammer } from "typia/lib/programmers/json/JsonApplicationProgrammer";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-import { ValidationPipe } from "typia/lib/typings/ValidationPipe";
-
-import { INestiaConfig } from "../../INestiaConfig";
-import { ISwaggerError } from "../../structures/ISwaggerError";
-import { ISwaggerLazyProperty } from "../../structures/ISwaggerLazyProperty";
-import { ISwaggerLazySchema } from "../../structures/ISwaggerLazySchema";
-import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
-import { SwaggerDescriptionGenerator } from "./SwaggerDescriptionGenerator";
-import { SwaggerSchemaValidator } from "./SwaggerSchemaValidator";
-
-export namespace SwaggerSchemaGenerator {
-  export interface IProps {
-    config: INestiaConfig.ISwaggerConfig;
-    checker: ts.TypeChecker;
-    collection: MetadataCollection;
-    lazySchemas: Array<ISwaggerLazySchema>;
-    lazyProperties: Array<ISwaggerLazyProperty>;
-    errors: ISwaggerError[];
-  }
-
-  export const response =
-    (props: IProps) =>
-    (route: ITypedHttpRoute): Record<string, OpenApi.IOperation.IResponse> => {
-      const output: Record<string, OpenApi.IOperation.IResponse> = {};
-
-      //----
-      // EXCEPTION STATUSES
-      //----
-      // FROM DECORATOR
-      for (const [status, exp] of Object.entries(route.exceptions)) {
-        const result = MetadataFactory.analyze(props.checker)({
-          escape: true,
-          constant: true,
-          absorb: false,
-          validate: JsonApplicationProgrammer.validate,
-        })(props.collection)(exp.type);
-        if (result.success === false)
-          props.errors.push(
-            ...result.errors.map((e) => ({
-              ...e,
-              route,
-              from: `response(status: ${status})`,
-            })),
-          );
-
-        output[status] = {
-          description: exp.description ?? "",
-          content: {
-            "application/json": {
-              schema: coalesce(props)(result),
-            },
-          },
-        };
-      }
-
-      // FROM COMMENT TAGS -> ANY
-      for (const tag of 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: description ?? "",
-            content: {
-              "application/json": {
-                schema: {},
-              },
-            },
-          };
-      }
-
-      //----
-      // SUCCESS
-      //----
-      // STATUS
-      const status: string =
-        route.status !== undefined
-          ? String(route.status)
-          : route.method === "POST"
-            ? "201"
-            : "200";
-
-      // SCHEMA
-      const result = MetadataFactory.analyze(props.checker)({
-        escape: true,
-        constant: true,
-        absorb: false,
-        validate: (meta) => {
-          const bigint: boolean =
-            meta.atomics.some((a) => a.type === "bigint") ||
-            meta.constants.some((a) => a.type === "bigint");
-          return bigint ? ["bigint type is not allowed."] : [];
-        },
-      })(props.collection)(route.output.type);
-      if (result.success === false)
-        props.errors.push(
-          ...result.errors.map((e) => ({
-            ...e,
-            route,
-            from: "response",
-          })),
-        );
-
-      // DO ASSIGN
-      const description =
-        describe(route, "return") ?? describe(route, "returns");
-      output[status] = {
-        description: route.encrypted
-          ? `${warning.get(!!description, "response", route.method)}${
-              description ?? ""
-            }`
-          : description ?? "",
-        content:
-          route.output.typeName === "void"
-            ? undefined
-            : {
-                [route.output.contentType]: {
-                  schema: coalesce(props)(result),
-                  ...{
-                    example: route.example,
-                    examples: route.examples,
-                  },
-                },
-              },
-        ...(props.config.additional === true
-          ? {
-              "x-nestia-encrypted": route.encrypted,
-            }
-          : route.encrypted === true
-            ? {
-                "x-nestia-encrypted": true,
-              }
-            : {}),
-      };
-      return output;
-    };
-
-  export const body =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (param: ITypedHttpRoute.IParameter): OpenApi.IOperation.IRequestBody => {
-      // ANALZE TYPE WITH VALIDATION
-      const result = MetadataFactory.analyze(props.checker)({
-        escape: true,
-        constant: true,
-        absorb: true,
-        validate: (meta) => {
-          const bigint: boolean =
-            meta.atomics.some((a) => a.type === "bigint") ||
-            meta.constants.some((a) => a.type === "bigint");
-          return bigint ? ["bigint type is not allowed."] : [];
-        },
-      })(props.collection)(param.type);
-      if (result.success === false)
-        props.errors.push(
-          ...result.errors.map((e) => ({
-            ...e,
-            route,
-            from: param.name,
-          })),
-        );
-
-      // LIST UP PROPERTIES
-      const contentType =
-        param.custom && param.category === "body"
-          ? param.contentType
-          : "application/json";
-      const encrypted: boolean =
-        param.custom && param.category === "body" && param.encrypted;
-      const description: string | undefined = describe(
-        route,
-        "param",
-        param.name,
-      );
-
-      // RETURNS WITH LAZY CONSTRUCTION
-      const schema: OpenApi.IJsonSchema = coalesce(props)(result);
-      return {
-        description: encrypted
-          ? `${warning.get(!!description, "request")}${description ?? ""}`
-          : description,
-        content: {
-          [contentType]: {
-            schema,
-            ...{
-              example: param.example,
-              examples: param.examples,
-            },
-          },
-        },
-        required: true,
-        ...(props.config.additional === true
-          ? {
-              "x-nestia-encrypted": encrypted,
-            }
-          : encrypted === true
-            ? {
-                "x-nestia-encrypted": true,
-              }
-            : {}),
-      };
-    };
-
-  export const parameter =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (param: ITypedHttpRoute.IParameter): OpenApi.IOperation.IParameter[] =>
-      param.category === "headers"
-        ? headers(props)(route)(param)
-        : param.category === "param"
-          ? [path(props)(route)(param)]
-          : query(props)(route)(param);
-
-  const path =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (param: ITypedHttpRoute.IParameter): OpenApi.IOperation.IParameter => {
-      // ANALZE TYPE WITH VALIDATION
-      const result = MetadataFactory.analyze(props.checker)({
-        escape: false,
-        constant: true,
-        absorb: true,
-        validate: SwaggerSchemaValidator.path,
-      })(props.collection)(param.type);
-      if (result.success === false)
-        props.errors.push(
-          ...result.errors.map((e) => ({
-            ...e,
-            route,
-            from: param.name,
-          })),
-        );
-
-      // RETURNS WITH LAZY CONSTRUCTION
-      return lazy(props)(route)(param, result);
-    };
-
-  const headers =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (param: ITypedHttpRoute.IParameter): OpenApi.IOperation.IParameter[] =>
-      decomposible(props)(route)(param)(
-        MetadataFactory.analyze(props.checker)({
-          escape: false,
-          constant: true,
-          absorb: true,
-          validate: param.custom ? SwaggerSchemaValidator.headers : undefined,
-        })(props.collection)(param.type),
-      );
-
-  const query =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (param: ITypedHttpRoute.IParameter): OpenApi.IOperation.IParameter[] =>
-      decomposible(props)(route)(param)(
-        MetadataFactory.analyze(props.checker)({
-          escape: false,
-          constant: true,
-          absorb: true,
-          validate: param.custom ? SwaggerSchemaValidator.query : undefined,
-        })(props.collection)(param.type),
-      );
-
-  const decomposible =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (param: ITypedHttpRoute.IParameter) =>
-    (
-      result: ValidationPipe<Metadata, MetadataFactory.IError>,
-    ): OpenApi.IOperation.IParameter[] => {
-      const decoded: OpenApi.IOperation.IParameter = lazy(props)(route)(
-        param,
-        result,
-      );
-      if (result.success === false) {
-        props.errors.push(
-          ...result.errors.map((e) => ({
-            ...e,
-            route,
-            from: param.name,
-          })),
-        );
-        return [decoded];
-      } else if (
-        props.config.decompose === false ||
-        result.data.objects.length === 0
-      )
-        return [decoded];
-
-      return result.data.objects[0].properties
-        .filter((p) => p.jsDocTags.every((tag) => tag.name !== "hidden"))
-        .map((p) => {
-          const schema: OpenApi.IJsonSchema = {};
-          props.lazyProperties.push({
-            schema,
-            object: result.data.objects[0].name,
-            property: p.key.constants[0].values[0].value as string,
-          });
-          return {
-            name: p.key.constants[0].values[0].value as string,
-            in:
-              param.category === "headers"
-                ? "header"
-                : (param.category as "path"),
-            schema,
-            required: p.value.isRequired(),
-            ...SwaggerDescriptionGenerator.generate({
-              description: p.description ?? undefined,
-              jsDocTags: p.jsDocTags,
-              kind: "title",
-            }),
-          } satisfies OpenApi.IOperation.IParameter;
-        });
-    };
-
-  const lazy =
-    (props: IProps) =>
-    (route: ITypedHttpRoute) =>
-    (
-      p: ITypedHttpRoute.IParameter,
-      result: ValidationPipe<Metadata, MetadataFactory.IError>,
-    ): OpenApi.IOperation.IParameter => {
-      const schema: OpenApi.IJsonSchema = coalesce(props)(result);
-      return {
-        name: p.field ?? p.name,
-        in:
-          p.category === "headers"
-            ? "header"
-            : p.category === "param"
-              ? "path"
-              : "query",
-        schema,
-        required: result.success ? result.data.isRequired() : true,
-        ...SwaggerDescriptionGenerator.generate({
-          description:
-            p.description ??
-            p.jsDocTags.find((tag) => tag.name === "description")?.text?.[0]
-              .text ??
-            route.jsDocTags
-              .find(
-                (tag) => tag.name === "param" && tag.text?.[0].text === p.name,
-              )
-              ?.text?.map((e) => e.text)
-              .join("")
-              .substring(p.name.length),
-          jsDocTags: p.jsDocTags,
-          kind: "title",
-        }),
-        ...{
-          example: p.example,
-          examples: p.examples,
-        },
-      };
-    };
-
-  const coalesce =
-    (props: IProps) =>
-    (
-      result: ValidationPipe<Metadata, MetadataFactory.IError>,
-    ): OpenApi.IJsonSchema => {
-      const schema: OpenApi.IJsonSchema = {} as any;
-      props.lazySchemas.push({
-        metadata: result.success ? result.data : any.get(),
-        schema,
-      });
-      return schema;
-    };
-
-  const describe = (
-    route: ITypedHttpRoute,
-    tagName: string,
-    parameterName?: string,
-  ): string | undefined => {
-    const parametric: (elem: ts.JSDocTagInfo) => boolean = parameterName
-      ? (tag) =>
-          tag.text!.find(
-            (elem) =>
-              elem.kind === "parameterName" && elem.text === parameterName,
-          ) !== undefined
-      : () => true;
-
-    const tag: ts.JSDocTagInfo | undefined = route.jsDocTags.find(
-      (tag) => tag.name === tagName && tag.text && parametric(tag),
-    );
-    return tag && tag.text
-      ? tag.text.find((elem) => elem.kind === "text")?.text
-      : undefined;
-  };
-}
-
-const warning = new VariadicSingleton(
-  (described: boolean, type: "request" | "response", method?: string) => {
-    const summary =
-      type === "request"
-        ? "Request body must be encrypted."
-        : "Response data have been encrypted.";
-    const component =
-      type === "request"
-        ? "[EncryptedBody](https://github.com/samchon/@nestia/core#encryptedbody)"
-        : `[EncryptedRoute.${method![0].toUpperCase()}.${method!
-            .substring(1)
-            .toLowerCase()}](https://github.com/samchon/@nestia/core#encryptedroute)`;
-
-    const content: string[] = [
-      "## Warning",
-      "",
-      summary,
-      "",
-      `The ${type} 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");
-  },
-);
-
-const any = new Singleton(() =>
-  Metadata.from(
-    {
-      any: true,
-      required: true,
-      optional: false,
-      nullable: false,
-      functional: false,
-      atomics: [],
-      constants: [],
-      templates: [],
-      escaped: null,
-      rest: null,
-      arrays: [],
-      tuples: [],
-      objects: [],
-      aliases: [],
-      natives: [],
-      sets: [],
-      maps: [],
-    },
-    {
-      aliases: new Map(),
-      arrays: new Map(),
-      tuples: new Map(),
-      objects: new Map(),
-    },
-  ),
-);

package/src/generates/internal/SwaggerSchemaValidator.ts

@@ -1,206 +0,0 @@
-import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
-import { Metadata } from "typia/lib/schemas/metadata/Metadata";
-import { MetadataArray } from "typia/lib/schemas/metadata/MetadataArray";
-
-export namespace SwaggerSchemaValidator {
-  export const path = (meta: Metadata): string[] => {
-    const errors: string[] = [];
-    const insert = (msg: string) => errors.push(msg);
-
-    if (meta.any) insert("do not allow any type");
-    if (meta.isRequired() === false) insert("do not allow undefindable type");
-
-    const atomics = CoreMetadataUtil.atomics(meta);
-    const expected: number =
-      meta.atomics.length +
-      meta.templates.length +
-      meta.constants.map((c) => c.values.length).reduce((a, b) => a + b, 0);
-    if (meta.size() !== expected || atomics.size === 0)
-      insert("only atomic or constant types are allowed");
-    if (atomics.size > 1) insert("do not allow union type");
-
-    return errors;
-  };
-
-  export const query = (
-    meta: Metadata,
-    explore: MetadataFactory.IExplore,
-  ): string[] => {
-    const errors: string[] = [];
-    const insert = (msg: string) => errors.push(msg);
-
-    if (explore.top === true) {
-      // TOP MUST BE ONLY OBJECT
-      if (meta.objects.length !== 1 || meta.bucket() !== 1)
-        insert("only one object type is allowed.");
-      if (meta.nullable === true) insert("query parameters cannot be null.");
-      if (meta.isRequired() === false) {
-        const everyPropertiesAreOptional: boolean =
-          meta.size() === 1 &&
-          meta.objects.length === 1 &&
-          meta.objects[0].properties.every((p) => p.value.optional);
-        if (everyPropertiesAreOptional === false)
-          insert(
-            "query parameters can be optional only when every properties are optional.",
-          );
-      }
-    } else if (
-      explore.nested !== null &&
-      explore.nested instanceof MetadataArray
-    ) {
-      const atomics = CoreMetadataUtil.atomics(meta);
-      const expected: number =
-        meta.atomics.length +
-        meta.templates.length +
-        meta.constants.map((c) => c.values.length).reduce((a, b) => a + b, 0);
-      if (atomics.size > 1) insert("union type is not allowed in array.");
-      if (meta.nullable) insert("nullable type is not allowed in array.");
-      if (meta.isRequired() === false)
-        insert("optional type is not allowed in array.");
-      if (meta.size() !== expected)
-        insert("only atomic or constant types are allowed in array.");
-    } else if (explore.object && explore.property !== null) {
-      //----
-      // COMMON
-      //----
-      // PROPERTY MUST BE SOLE
-      if (typeof explore.property === "object")
-        insert("dynamic property is not allowed.");
-      // DO NOT ALLOW TUPLE TYPE
-      if (meta.tuples.length) insert("tuple type is not allowed.");
-      // DO NOT ALLOW UNION TYPE
-      if (CoreMetadataUtil.isUnion(meta)) insert("union type is not allowed.");
-      // DO NOT ALLOW NESTED OBJECT
-      if (
-        meta.objects.length ||
-        meta.sets.length ||
-        meta.maps.length ||
-        meta.natives.length
-      )
-        insert("nested object type is not allowed.");
-
-      //----
-      // ARRAY CASES
-      //----
-      const isArray: boolean = meta.arrays.length > 1 || meta.tuples.length > 1;
-      // ARRAY TYPE MUST BE REQUIRED
-      if (isArray && meta.isRequired() === false)
-        insert("optional type is not allowed when array.");
-      // SET-COOKIE MUST BE ARRAY
-      if (explore.property === "set-cookie" && !isArray)
-        insert("set-cookie property must be array.");
-    }
-    return errors;
-  };
-
-  export const headers = (
-    meta: Metadata,
-    explore: MetadataFactory.IExplore,
-  ): string[] => {
-    const errors: string[] = [];
-    const insert = (msg: string) => errors.push(msg);
-
-    if (explore.top === true) {
-      // TOP MUST BE ONLY OBJECT
-      if (meta.objects.length !== 1 || meta.bucket() !== 1)
-        insert("only one object type is allowed.");
-      if (meta.nullable === true) insert("headers cannot be null.");
-      if (meta.isRequired() === false) insert("headers cannot be null.");
-    } else if (
-      explore.nested !== null &&
-      explore.nested instanceof MetadataArray
-    ) {
-      const atomics = CoreMetadataUtil.atomics(meta);
-      const expected: number =
-        meta.atomics.length +
-        meta.templates.length +
-        meta.constants.map((c) => c.values.length).reduce((a, b) => a + b, 0);
-      if (atomics.size > 1) insert("union type is not allowed in array.");
-      if (meta.nullable) insert("nullable type is not allowed in array.");
-      if (meta.isRequired() === false) insert("optional type is not allowed.");
-      if (meta.size() !== expected)
-        insert("only atomic or constant types are allowed in array.");
-    } else if (explore.object && explore.property !== null) {
-      //----
-      // COMMON
-      //----
-      // PROPERTY MUST BE SOLE
-      if (typeof explore.property === "object")
-        insert("dynamic property is not allowed.");
-      // DO NOT ALLOW TUPLE TYPE
-      if (meta.tuples.length) insert("tuple type is not allowed.");
-      // DO NOT ALLOW UNION TYPE
-      if (CoreMetadataUtil.isUnion(meta)) insert("union type is not allowed.");
-      // DO NOT ALLOW NESTED OBJECT
-      if (
-        meta.objects.length ||
-        meta.sets.length ||
-        meta.maps.length ||
-        meta.natives.length
-      )
-        insert("nested object type is not allowed.");
-      // DO NOT ALLOW NULLABLE
-      if (meta.nullable) insert("nullable type is not allowed.");
-
-      //----
-      // ARRAY CASES
-      //----
-      const isArray: boolean = meta.arrays.length > 1;
-      // ARRAY TYPE MUST BE REQUIRED
-      if (isArray && meta.isRequired() === false)
-        insert("optional type is not allowed when array.");
-      // SET-COOKIE MUST BE ARRAY
-      if (explore.property === "set-cookie" && !isArray)
-        insert("set-cookie property must be array.");
-      // MUST BE SINGULAR CASE
-      if (
-        typeof explore.property === "string" &&
-        SINGULAR.has(explore.property) &&
-        isArray
-      )
-        insert("property cannot be array.");
-    }
-    return errors;
-  };
-}
-
-namespace CoreMetadataUtil {
-  export const atomics = (
-    meta: Metadata,
-  ): Set<"boolean" | "bigint" | "number" | "string"> =>
-    new Set([
-      ...meta.atomics.map((a) => a.type),
-      ...meta.constants.map((c) => c.type),
-      ...(meta.templates.length ? (["string"] as const) : []),
-    ]);
-
-  export const isUnion = (meta: Metadata): boolean =>
-    atomics(meta).size +
-      meta.arrays.length +
-      meta.tuples.length +
-      meta.natives.length +
-      meta.maps.length +
-      meta.objects.length >
-    1;
-}
-
-const SINGULAR: Set<string> = new Set([
-  "age",
-  "authorization",
-  "content-length",
-  "content-type",
-  "etag",
-  "expires",
-  "from",
-  "host",
-  "if-modified-since",
-  "if-unmodified-since",
-  "last-modified",
-  "location",
-  "max-forwards",
-  "proxy-authorization",
-  "referer",
-  "retry-after",
-  "server",
-  "user-agent",
-]);

package/src/structures/IErrorReport.ts

@@ -1,6 +0,0 @@
-export interface IErrorReport {
-  file: string;
-  controller: string;
-  function: string | null;
-  message: string;
-}

package/src/structures/INormalizedInput.ts

@@ -1,20 +0,0 @@
-import { RouteInfo, VersionValue } from "@nestjs/common/interfaces";
-
-export interface INormalizedInput {
-  include: INormalizedInput.IInput[];
-  globalPrefix?: {
-    prefix: string;
-    exclude?: Array<string | RouteInfo>;
-  };
-  versioning?: {
-    prefix: string;
-    defaultVersion?: VersionValue;
-  };
-}
-export namespace INormalizedInput {
-  export interface IInput {
-    paths: string[];
-    file: string;
-    controller?: Function;
-  }
-}