@nestia/sdk 10.0.2 → 11.0.0-dev.20260305

package/src/generates/internal/SdkHttpParameterProgrammer.ts

@@ -1,178 +1,178 @@
-import ts from "typescript";
-
-import { INestiaProject } from "../../structures/INestiaProject";
-import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
-import { ITypedHttpRouteParameter } from "../../structures/ITypedHttpRouteParameter";
-import { ImportDictionary } from "./ImportDictionary";
-import { SdkAliasCollection } from "./SdkAliasCollection";
-
-export namespace SdkHttpParameterProgrammer {
-  export interface IEntry {
-    key: string;
-    required: boolean;
-    type: ts.TypeNode;
-    parameter: ITypedHttpRouteParameter;
-  }
-
-  export const getAll = (
-    route: ITypedHttpRoute,
-  ): ITypedHttpRouteParameter[] => [
-    ...route.pathParameters,
-    ...route.queryParameters,
-    ...route.headerParameters,
-    ...(route.queryObject ? [route.queryObject] : []),
-    ...(route.body ? [route.body] : []),
-    ...(route.headerObject ? [route.headerObject] : []),
-  ];
-
-  export const getSignificant = (route: ITypedHttpRoute, body: boolean) => [
-    ...route.pathParameters,
-    ...route.queryParameters,
-    ...(route.queryObject ? [route.queryObject] : []),
-    ...(body && route.body ? [route.body] : []),
-  ];
-
-  export const getEntries = (props: {
-    project: INestiaProject;
-    importer: ImportDictionary;
-    route: ITypedHttpRoute;
-    body: boolean;
-    prefix: boolean | string;
-    e2e?: boolean;
-  }): IEntry[] => {
-    if (
-      props.route.pathParameters.length === 0 &&
-      props.route.queryParameters.length === 0 &&
-      props.route.queryObject === null &&
-      (props.body === false || props.route.body === null)
-    )
-      return [];
-    const prefix =
-      typeof props.prefix === "string"
-        ? props.prefix
-        : props.prefix === true
-          ? `${props.route.name}.`
-          : "";
-    return [
-      ...[...props.route.pathParameters, ...props.route.queryParameters].map(
-        (p) => ({
-          key: p.name,
-          required: p.metadata.isRequired(),
-          type:
-            props.project.config.clone === true
-              ? SdkAliasCollection.from(props.project)(props.importer)(
-                  p.metadata,
-                )
-              : SdkAliasCollection.name(p),
-          parameter: p,
-        }),
-      ),
-      ...(props.route.queryObject
-        ? [
-            {
-              key: props.route.queryObject.name,
-              required: props.route.queryObject.metadata.isRequired(),
-              type:
-                props.e2e === true
-                  ? props.project.config.clone === true
-                    ? SdkAliasCollection.from(props.project)(props.importer)(
-                        props.route.queryObject.metadata,
-                      )
-                    : SdkAliasCollection.name(props.route.queryObject)
-                  : ts.factory.createTypeReferenceNode(`${prefix}Query`),
-              parameter: props.route.queryObject,
-            },
-          ]
-        : []),
-      ...(props.body && props.route.body
-        ? [
-            {
-              key: props.route.body.name,
-              required: props.route.body.metadata.isRequired(),
-              type:
-                props.e2e === true
-                  ? props.project.config.clone === true
-                    ? SdkAliasCollection.from(props.project)(props.importer)(
-                        props.route.body.metadata,
-                      )
-                    : SdkAliasCollection.name(props.route.body)
-                  : ts.factory.createTypeReferenceNode(`${prefix}Body`),
-              parameter: props.route.body,
-            },
-          ]
-        : []),
-    ];
-  };
-
-  export const getParameterDeclarations = (props: {
-    project: INestiaProject;
-    importer: ImportDictionary;
-    route: ITypedHttpRoute;
-    body: boolean;
-    prefix: boolean;
-  }): ts.ParameterDeclaration[] => {
-    const entries: IEntry[] = getEntries(props);
-    if (entries.length === 0) return [];
-    else if (props.project.config.keyword === true) {
-      const typeName: string = props.prefix
-        ? `${props.route.name}.Props`
-        : "Props";
-      const node: ts.TypeReferenceNode =
-        props.body === false && props.route.body !== null
-          ? ts.factory.createTypeReferenceNode("Omit", [
-              ts.factory.createTypeReferenceNode(typeName),
-              ts.factory.createLiteralTypeNode(
-                ts.factory.createStringLiteral(props.route.body.name),
-              ),
-            ])
-          : ts.factory.createTypeReferenceNode(typeName);
-      return [
-        ts.factory.createParameterDeclaration(
-          undefined,
-          undefined,
-          "props",
-          undefined,
-          node,
-          undefined,
-        ),
-      ];
-    }
-    return entries.map((e) =>
-      ts.factory.createParameterDeclaration(
-        undefined,
-        undefined,
-        e.key,
-        e.required
-          ? undefined
-          : ts.factory.createToken(ts.SyntaxKind.QuestionToken),
-        e.type,
-        undefined,
-      ),
-    );
-  };
-
-  export const getArguments = (props: {
-    project: INestiaProject;
-    route: ITypedHttpRoute;
-    body: boolean;
-  }): ts.Expression[] => {
-    const parameters = getSignificant(props.route, props.body);
-    if (parameters.length === 0) return [];
-    else if (props.project.config.keyword === true)
-      return [ts.factory.createIdentifier("props")];
-    return parameters.map((p) => ts.factory.createIdentifier(p.name));
-  };
-
-  export const getAccessors = (props: {
-    project: INestiaProject;
-    importer: ImportDictionary;
-    route: ITypedHttpRoute;
-    body: boolean;
-  }): ts.Expression[] => {
-    const prefix: string =
-      props.project.config.keyword === true ? "props." : "";
-    return getSignificant(props.route, props.body).map((p) =>
-      ts.factory.createIdentifier(`${prefix}${p.name}`),
-    );
-  };
-}
+import ts from "typescript";
+
+import { INestiaProject } from "../../structures/INestiaProject";
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { ITypedHttpRouteParameter } from "../../structures/ITypedHttpRouteParameter";
+import { ImportDictionary } from "./ImportDictionary";
+import { SdkAliasCollection } from "./SdkAliasCollection";
+
+export namespace SdkHttpParameterProgrammer {
+  export interface IEntry {
+    key: string;
+    required: boolean;
+    type: ts.TypeNode;
+    parameter: ITypedHttpRouteParameter;
+  }
+
+  export const getAll = (
+    route: ITypedHttpRoute,
+  ): ITypedHttpRouteParameter[] => [
+    ...route.pathParameters,
+    ...route.queryParameters,
+    ...route.headerParameters,
+    ...(route.queryObject ? [route.queryObject] : []),
+    ...(route.body ? [route.body] : []),
+    ...(route.headerObject ? [route.headerObject] : []),
+  ];
+
+  export const getSignificant = (route: ITypedHttpRoute, body: boolean) => [
+    ...route.pathParameters,
+    ...route.queryParameters,
+    ...(route.queryObject ? [route.queryObject] : []),
+    ...(body && route.body ? [route.body] : []),
+  ];
+
+  export const getEntries = (props: {
+    project: INestiaProject;
+    importer: ImportDictionary;
+    route: ITypedHttpRoute;
+    body: boolean;
+    prefix: boolean | string;
+    e2e?: boolean;
+  }): IEntry[] => {
+    if (
+      props.route.pathParameters.length === 0 &&
+      props.route.queryParameters.length === 0 &&
+      props.route.queryObject === null &&
+      (props.body === false || props.route.body === null)
+    )
+      return [];
+    const prefix =
+      typeof props.prefix === "string"
+        ? props.prefix
+        : props.prefix === true
+          ? `${props.route.name}.`
+          : "";
+    return [
+      ...[...props.route.pathParameters, ...props.route.queryParameters].map(
+        (p) => ({
+          key: p.name,
+          required: p.metadata.isRequired(),
+          type:
+            props.project.config.clone === true
+              ? SdkAliasCollection.from(props.project)(props.importer)(
+                  p.metadata,
+                )
+              : SdkAliasCollection.name(p),
+          parameter: p,
+        }),
+      ),
+      ...(props.route.queryObject
+        ? [
+            {
+              key: props.route.queryObject.name,
+              required: props.route.queryObject.metadata.isRequired(),
+              type:
+                props.e2e === true
+                  ? props.project.config.clone === true
+                    ? SdkAliasCollection.from(props.project)(props.importer)(
+                        props.route.queryObject.metadata,
+                      )
+                    : SdkAliasCollection.name(props.route.queryObject)
+                  : ts.factory.createTypeReferenceNode(`${prefix}Query`),
+              parameter: props.route.queryObject,
+            },
+          ]
+        : []),
+      ...(props.body && props.route.body
+        ? [
+            {
+              key: props.route.body.name,
+              required: props.route.body.metadata.isRequired(),
+              type:
+                props.e2e === true
+                  ? props.project.config.clone === true
+                    ? SdkAliasCollection.from(props.project)(props.importer)(
+                        props.route.body.metadata,
+                      )
+                    : SdkAliasCollection.name(props.route.body)
+                  : ts.factory.createTypeReferenceNode(`${prefix}Body`),
+              parameter: props.route.body,
+            },
+          ]
+        : []),
+    ];
+  };
+
+  export const getParameterDeclarations = (props: {
+    project: INestiaProject;
+    importer: ImportDictionary;
+    route: ITypedHttpRoute;
+    body: boolean;
+    prefix: boolean;
+  }): ts.ParameterDeclaration[] => {
+    const entries: IEntry[] = getEntries(props);
+    if (entries.length === 0) return [];
+    else if (props.project.config.keyword === true) {
+      const typeName: string = props.prefix
+        ? `${props.route.name}.Props`
+        : "Props";
+      const node: ts.TypeReferenceNode =
+        props.body === false && props.route.body !== null
+          ? ts.factory.createTypeReferenceNode("Omit", [
+              ts.factory.createTypeReferenceNode(typeName),
+              ts.factory.createLiteralTypeNode(
+                ts.factory.createStringLiteral(props.route.body.name),
+              ),
+            ])
+          : ts.factory.createTypeReferenceNode(typeName);
+      return [
+        ts.factory.createParameterDeclaration(
+          undefined,
+          undefined,
+          "props",
+          undefined,
+          node,
+          undefined,
+        ),
+      ];
+    }
+    return entries.map((e) =>
+      ts.factory.createParameterDeclaration(
+        undefined,
+        undefined,
+        e.key,
+        e.required
+          ? undefined
+          : ts.factory.createToken(ts.SyntaxKind.QuestionToken),
+        e.type,
+        undefined,
+      ),
+    );
+  };
+
+  export const getArguments = (props: {
+    project: INestiaProject;
+    route: ITypedHttpRoute;
+    body: boolean;
+  }): ts.Expression[] => {
+    const parameters = getSignificant(props.route, props.body);
+    if (parameters.length === 0) return [];
+    else if (props.project.config.keyword === true)
+      return [ts.factory.createIdentifier("props")];
+    return parameters.map((p) => ts.factory.createIdentifier(p.name));
+  };
+
+  export const getAccessors = (props: {
+    project: INestiaProject;
+    importer: ImportDictionary;
+    route: ITypedHttpRoute;
+    body: boolean;
+  }): ts.Expression[] => {
+    const prefix: string =
+      props.project.config.keyword === true ? "props." : "";
+    return getSignificant(props.route, props.body).map((p) =>
+      ts.factory.createIdentifier(`${prefix}${p.name}`),
+    );
+  };
+}

package/src/generates/internal/SdkHttpRouteProgrammer.ts

@@ -1,108 +1,109 @@
-import ts from "typescript";
-import { IJsDocTagInfo } from "typia";
-
-import { INestiaConfig } from "../../INestiaConfig";
-import { INestiaProject } from "../../structures/INestiaProject";
-import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
-import { FilePrinter } from "./FilePrinter";
-import { ImportDictionary } from "./ImportDictionary";
-import { SdkHttpFunctionProgrammer } from "./SdkHttpFunctionProgrammer";
-import { SdkHttpNamespaceProgrammer } from "./SdkHttpNamespaceProgrammer";
-import { SdkHttpParameterProgrammer } from "./SdkHttpParameterProgrammer";
-
-export namespace SdkHttpRouteProgrammer {
-  export const write =
-    (project: INestiaProject) =>
-    (importer: ImportDictionary) =>
-    (route: ITypedHttpRoute): ts.Statement[] => [
-      FilePrinter.description(
-        SdkHttpFunctionProgrammer.write(project)(importer)(route),
-        describe(project.config, route),
-      ),
-      SdkHttpNamespaceProgrammer.write(project)(importer)(route),
-    ];
-
-  const describe = (config: INestiaConfig, route: ITypedHttpRoute): string => {
-    // MAIN DESCRIPTION
-    const descriptionComments: string[] = route.description
-      ? route.description.split("\n")
-      : [];
-    const tagComments: string[] = [];
-
-    // PARAMETERS
-    for (const p of SdkHttpParameterProgrammer.getSignificant(route, true)) {
-      const description: string | undefined =
-        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);
-      if (!description?.length) continue;
-
-      const name: string = config.keyword === true ? `props.${p.name}` : p.name;
-      tagComments.push(
-        `@param ${name} ${description
-          .split("\n")
-          .map((str) => str.trim())
-          .map((str, i) => {
-            if (i === 0) return str;
-            const rpad: number = p.name.length + 8;
-            return `${" ".repeat(rpad)}${str}`;
-          })
-          .join("\n")}`,
-      );
-    }
-
-    // COMMENT TAGS
-    const tags: IJsDocTagInfo[] = route.jsDocTags.filter(
-      (tag) => tag.name !== "param",
-    );
-    if (tags.length !== 0) {
-      const content: string[] = tags.map((t) =>
-        t.text?.length
-          ? `@${t.name} ${t.text
-              .map((e) => e.text)
-              .join("")
-              .split("\n")
-              .map((str) => str.trim())
-              .map((str, i) => {
-                if (i === 0) return str;
-                return `${" ".repeat(t.name.length + 1)} ${str}`;
-              })
-              .join("\n")}`
-          : `@${t.name}`,
-      );
-      tagComments.push(...new Set(content));
-    }
-
-    // EXCEPTIONS
-    for (const [key, value] of Object.entries(route.exceptions)) {
-      if (
-        tagComments.some(
-          (str) =>
-            str.startsWith(`@throw ${key}`) || str.startsWith(`@throws ${key}`),
-        )
-      )
-        continue;
-      tagComments.push(
-        value.description?.length
-          ? `@throws ${key} ${value.description.split("\n")[0]}`
-          : `@throws ${key}`,
-      );
-    }
-
-    // POSTFIX
-    return [
-      ...descriptionComments,
-      ...(descriptionComments.length && tagComments.length ? [""] : []),
-      ...tagComments,
-      ...(descriptionComments.length && tagComments.length ? [""] : []),
-      `@controller ${route.controller.class.name}.${route.name}`,
-      `@path ${route.method} ${route.path}`,
-      `@accessor api.functional.${route.accessor.join(".")}`,
-      `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
-    ].join("\n");
-  };
-}
+import ts from "typescript";
+import { IJsDocTagInfo } from "typia";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { INestiaProject } from "../../structures/INestiaProject";
+import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
+import { FilePrinter } from "./FilePrinter";
+import { ImportDictionary } from "./ImportDictionary";
+import { SdkHttpFunctionProgrammer } from "./SdkHttpFunctionProgrammer";
+import { SdkHttpNamespaceProgrammer } from "./SdkHttpNamespaceProgrammer";
+import { SdkHttpParameterProgrammer } from "./SdkHttpParameterProgrammer";
+
+export namespace SdkHttpRouteProgrammer {
+  export const write =
+    (project: INestiaProject) =>
+    (importer: ImportDictionary) =>
+    (route: ITypedHttpRoute): ts.Statement[] => [
+      FilePrinter.description(
+        SdkHttpFunctionProgrammer.write(project)(importer)(route),
+        describe(project.config, route),
+      ),
+      SdkHttpNamespaceProgrammer.write(project)(importer)(route),
+    ];
+
+  const describe = (config: INestiaConfig, route: ITypedHttpRoute): string => {
+    // MAIN DESCRIPTION
+    const descriptionComments: string[] = route.description
+      ? route.description.split("\n")
+      : [];
+    const tagComments: string[] = [];
+
+    // PARAMETERS
+    for (const p of SdkHttpParameterProgrammer.getSignificant(route, true)) {
+      const description: string | undefined =
+        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);
+      if (!description?.length) continue;
+
+      const name: string = config.keyword === true ? `props.${p.name}` : p.name;
+      tagComments.push(
+        `@param ${name} ${description
+          .split("\n")
+          .map((str) => str.trim())
+          .map((str, i) => {
+            if (i === 0) return str;
+            const rpad: number = p.name.length + 8;
+            return `${" ".repeat(rpad)}${str}`;
+          })
+          .join("\n")}`,
+      );
+    }
+
+    // COMMENT TAGS
+    const tags: IJsDocTagInfo[] = route.jsDocTags.filter(
+      (tag) => tag.name !== "param",
+    );
+    if (tags.length !== 0) {
+      const content: string[] = tags.map((t) =>
+        t.text?.length
+          ? `@${t.name} ${t.text
+              .map((e) => e.text)
+              .join("")
+              .split("\n")
+              .map((str) => str.trim())
+              .map((str, i) => {
+                if (i === 0) return str;
+                return `${" ".repeat(t.name.length + 1)} ${str}`;
+              })
+              .join("\n")}`
+          : `@${t.name}`,
+      );
+      tagComments.push(...new Set(content));
+    }
+
+    // EXCEPTIONS
+    for (const [key, value] of Object.entries(route.exceptions)) {
+      if (
+        tagComments.some(
+          (str) =>
+            str.startsWith(`@throw ${key}`) || str.startsWith(`@throws ${key}`),
+        )
+      )
+        continue;
+      tagComments.push(
+        value.description?.length
+          ? `@throws ${key} ${value.description.split("\n")[0]}`
+          : `@throws ${key}`,
+      );
+    }
+
+    // POSTFIX
+    return [
+      ...descriptionComments,
+      ...(descriptionComments.length && tagComments.length ? [""] : []),
+      ...tagComments,
+      ...(descriptionComments.length && tagComments.length ? [""] : []),
+      `@controller ${route.controller.class.name}.${route.name}`,
+      `@path ${route.method} ${route.path}`,
+      `@accessor api.functional.${route.accessor.join(".")}`,
+      `@nestia Generated by Nestia - https://github.com/samchon/nestia`,
+    ].join("\n");
+  };
+}