@nestia/sdk 2.5.0-dev.20240130 → 2.5.0-dev.20240130-3

package/src/generates/internal/SdkTypeProgrammer.ts

@@ -174,7 +174,11 @@ export namespace SdkTypeProgrammer {
                   decode(config)(importer)(elem.rest),
                 ),
               )
-            : decode(config)(importer)(elem),
+            : elem.optional
+              ? ts.factory.createOptionalTypeNode(
+                  decode(config)(importer)(elem),
+                )
+              : decode(config)(importer)(elem),
         ),
       );
 

package/src/structures/ISwagger.ts

@@ -1,91 +1,91 @@
-import { ISwaggerComponents } from "./ISwaggerComponents";
-import { ISwaggerInfo } from "./ISwaggerInfo";
-import { ISwaggerRoute } from "./ISwaggerRoute";
-
-/**
- * Swagger Document.
- *
- * `ISwagger` is a data structure representing content of `swagger.json` file
- * generated by Nestia. Note that, this is not an universal structure, but a dedicated
- * structure only for Nestia.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface ISwagger {
-  /**
-   * The version of the OpenAPI document.
-   *
-   * Nestia always generate OpenAPI 3.0.x document.
-   */
-  openapi: `3.${0 | 1}.${number}`;
-
-  /**
-   * List of servers that provide the API.
-   */
-  servers: ISwagger.IServer[];
-
-  /**
-   * Information about the API.
-   */
-  info: ISwaggerInfo;
-
-  /**
-   * The available paths and operations for the API.
-   *
-   * The 1st key is the path, and the 2nd key is the HTTP method.
-   */
-  paths: Record<string, Record<string, ISwaggerRoute>>;
-
-  /**
-   * An object to hold reusable data structures.
-   *
-   * It stores both DTO schemas and security schemes.
-   *
-   * For reference, `nestia` defines every object and alias types as reusable DTO
-   * schemas. The alias type means that defined by `type` keyword in TypeScript.
-   */
-  components: ISwaggerComponents;
-
-  // /**
-  //  * A declaration of which security mechanisms can be used across the API.
-  //  *
-  //  * When this property be configured, it would be overwritten in every API routes.
-  //  *
-  //  * For reference, key means the name of security scheme and value means the `scopes`.
-  //  * The `scopes` can be used only when target security scheme is `oauth2` type,
-  //  * especially for {@link ISwaggerSecurityScheme.IOAuth2.IFlow.scopes} property.
-  //  */
-  // security?: Record<string, string[]>[];
-}
-export namespace ISwagger {
-  /**
-   * Remote server definition.
-   */
-  export interface IServer {
-    /**
-     * A URL to the target host.
-     *
-     * @format uri
-     */
-    url: string;
-
-    /**
-     * An optional string describing the target server.
-     */
-    description?: string;
-  }
-
-  export interface IExternalDocs {
-    /**
-     * The URL for target documentation.
-     *
-     * @format uri
-     */
-    url: string;
-
-    /**
-     * A short description of the target documentation.
-     */
-    description?: string;
-  }
-}
+import { ISwaggerComponents } from "./ISwaggerComponents";
+import { ISwaggerInfo } from "./ISwaggerInfo";
+import { ISwaggerRoute } from "./ISwaggerRoute";
+
+/**
+ * Swagger Document.
+ *
+ * `ISwagger` is a data structure representing content of `swagger.json` file
+ * generated by Nestia. Note that, this is not an universal structure, but a dedicated
+ * structure only for Nestia.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface ISwagger {
+  /**
+   * The version of the OpenAPI document.
+   *
+   * Nestia always generate OpenAPI 3.0.x document.
+   */
+  openapi: `3.0.${number}`;
+
+  /**
+   * List of servers that provide the API.
+   */
+  servers: ISwagger.IServer[];
+
+  /**
+   * Information about the API.
+   */
+  info: ISwaggerInfo;
+
+  /**
+   * The available paths and operations for the API.
+   *
+   * The 1st key is the path, and the 2nd key is the HTTP method.
+   */
+  paths: Record<string, Record<string, ISwaggerRoute>>;
+
+  /**
+   * An object to hold reusable data structures.
+   *
+   * It stores both DTO schemas and security schemes.
+   *
+   * For reference, `nestia` defines every object and alias types as reusable DTO
+   * schemas. The alias type means that defined by `type` keyword in TypeScript.
+   */
+  components: ISwaggerComponents;
+
+  // /**
+  //  * A declaration of which security mechanisms can be used across the API.
+  //  *
+  //  * When this property be configured, it would be overwritten in every API routes.
+  //  *
+  //  * For reference, key means the name of security scheme and value means the `scopes`.
+  //  * The `scopes` can be used only when target security scheme is `oauth2` type,
+  //  * especially for {@link ISwaggerSecurityScheme.IOAuth2.IFlow.scopes} property.
+  //  */
+  // security?: Record<string, string[]>[];
+}
+export namespace ISwagger {
+  /**
+   * Remote server definition.
+   */
+  export interface IServer {
+    /**
+     * A URL to the target host.
+     *
+     * @format uri
+     */
+    url: string;
+
+    /**
+     * An optional string describing the target server.
+     */
+    description?: string;
+  }
+
+  export interface IExternalDocs {
+    /**
+     * The URL for target documentation.
+     *
+     * @format uri
+     */
+    url: string;
+
+    /**
+     * A short description of the target documentation.
+     */
+    description?: string;
+  }
+}

package/src/utils/FormatUtil.ts

@@ -1,31 +1,31 @@
-import { format } from "prettier";
-import ts from "typescript";
-
-export namespace FormatUtil {
-  export const description = <Node extends ts.Node>(
-    node: Node,
-    comment: string,
-  ): Node => {
-    if (comment.length === 0) return node;
-    ts.addSyntheticLeadingComment(
-      node,
-      ts.SyntaxKind.MultiLineCommentTrivia,
-      ["*", ...comment.split("\n").map((str) => ` * ${str}`), ""].join("\n"),
-      true,
-    );
-    return node;
-  };
-
-  export const enter = () =>
-    ts.factory.createExpressionStatement(ts.factory.createIdentifier("\n"));
-
-  export const beautify = async (script: string): Promise<string> => {
-    try {
-      return await format(script, {
-        parser: "typescript",
-      });
-    } catch {
-      return script;
-    }
-  };
-}
+import { format } from "prettier";
+import ts from "typescript";
+
+export namespace FormatUtil {
+  export const description = <Node extends ts.Node>(
+    node: Node,
+    comment: string,
+  ): Node => {
+    if (comment.length === 0) return node;
+    ts.addSyntheticLeadingComment(
+      node,
+      ts.SyntaxKind.MultiLineCommentTrivia,
+      ["*", ...comment.split("\n").map((str) => ` * ${str}`), ""].join("\n"),
+      true,
+    );
+    return node;
+  };
+
+  export const enter = () =>
+    ts.factory.createExpressionStatement(ts.factory.createIdentifier("\n"));
+
+  export const beautify = async (script: string): Promise<string> => {
+    try {
+      return await format(script, {
+        parser: "typescript",
+      });
+    } catch {
+      return script;
+    }
+  };
+}

package/src/utils/ImportDictionary.ts

@@ -1,197 +1,197 @@
-import path from "path";
-import { HashMap } from "tstl/container/HashMap";
-import { HashSet } from "tstl/container/HashSet";
-import { Pair } from "tstl/utility/Pair";
-import ts from "typescript";
-
-import { FormatUtil } from "./FormatUtil";
-
-export class ImportDictionary {
-  private readonly components_: HashMap<Pair<string, boolean>, IComposition> =
-    new HashMap();
-
-  public constructor(public readonly file: string) {}
-
-  public empty(): boolean {
-    return this.components_.empty();
-  }
-
-  public external(props: ImportDictionary.IExternalProps): string {
-    const composition: IComposition = this.components_.take(
-      new Pair(props.library, props.type),
-      () => ({
-        location: `node_modules/${props.library}`,
-        elements: new HashSet(),
-        default: false,
-        type: props.type,
-      }),
-    );
-    if (props.instance === null) composition.default = true;
-    else composition.elements.insert(props.instance);
-    return props.instance ?? props.library;
-  }
-
-  public internal(props: ImportDictionary.IInternalProps): string {
-    const file: string = (() => {
-      if (props.file.substring(props.file.length - 5) === ".d.ts")
-        return props.file.substring(0, props.file.length - 5);
-      else if (props.file.substring(props.file.length - 3) === ".ts")
-        return props.file.substring(0, props.file.length - 3);
-      return props.file;
-    })();
-    const composition: IComposition = this.components_.take(
-      new Pair(file, props.type),
-      () => ({
-        location: file,
-        elements: new HashSet(),
-        default: false,
-        type: props.type,
-      }),
-    );
-    if (props.instance === null) {
-      composition.default = true;
-      if (props.name) composition.name = props.name;
-    } else composition.elements.insert(props.instance);
-    return props.instance ?? file;
-  }
-
-  public toStatements(outDir: string): ts.Statement[] {
-    const external: ts.ImportDeclaration[] = [];
-    const internal: ts.ImportDeclaration[] = [];
-
-    const locator = (str: string) => {
-      const location: string = path.relative(outDir, str).split("\\").join("/");
-      const index: number = location.lastIndexOf(NODE_MODULES);
-      return index === -1
-        ? location.startsWith("..")
-          ? location
-          : `./${location}`
-        : location.substring(index + NODE_MODULES.length);
-    };
-    const enroll =
-      (filter: (str: string) => boolean) =>
-      (container: ts.ImportDeclaration[]) => {
-        const compositions: IComposition[] = this.components_
-          .toJSON()
-          .filter((c) => filter(c.second.location))
-          .map((e) => ({
-            ...e.second,
-            location: locator(e.second.location),
-          }))
-          .sort((a, b) => a.location.localeCompare(b.location));
-        for (const c of compositions) {
-          const brackets: string[] = [];
-          if (c.default) brackets.push(c.name ?? c.location);
-          if (c.elements.empty() === false)
-            brackets.push(
-              `{ ${c.elements
-                .toJSON()
-                .sort((a, b) => a.localeCompare(b))
-                .join(", ")} }`,
-            );
-          container.push(
-            ts.factory.createImportDeclaration(
-              undefined,
-              ts.factory.createImportClause(
-                c.type,
-                c.default
-                  ? ts.factory.createIdentifier(c.name ?? c.location)
-                  : undefined,
-                c.elements.empty() === false
-                  ? ts.factory.createNamedImports(
-                      [...c.elements].map((elem) =>
-                        ts.factory.createImportSpecifier(
-                          false,
-                          undefined,
-                          ts.factory.createIdentifier(elem),
-                        ),
-                      ),
-                    )
-                  : undefined,
-              ),
-              ts.factory.createStringLiteral(c.location),
-            ),
-          );
-        }
-      };
-
-    enroll((str) => str.indexOf(NODE_MODULES) !== -1)(external);
-    enroll((str) => str.indexOf(NODE_MODULES) === -1)(internal);
-    return [
-      ...external,
-      ...(external.length && internal.length ? [FormatUtil.enter()] : []),
-      ...internal,
-    ];
-  }
-
-  public toScript(outDir: string): string {
-    const external: string[] = [];
-    const internal: string[] = [];
-
-    const locator = (str: string) => {
-      const location: string = path.relative(outDir, str).split("\\").join("/");
-      const index: number = location.lastIndexOf(NODE_MODULES);
-      return index === -1
-        ? location.startsWith("..")
-          ? location
-          : `./${location}`
-        : location.substring(index + NODE_MODULES.length);
-    };
-    const enroll =
-      (filter: (str: string) => boolean) => (container: string[]) => {
-        const compositions: IComposition[] = this.components_
-          .toJSON()
-          .filter((c) => filter(c.second.location))
-          .map((e) => ({
-            ...e.second,
-            location: locator(e.second.location),
-          }))
-          .sort((a, b) => a.location.localeCompare(b.location));
-        for (const c of compositions) {
-          const brackets: string[] = [];
-          if (c.default) brackets.push(c.name ?? c.location);
-          if (c.elements.empty() === false)
-            brackets.push(
-              `{ ${c.elements
-                .toJSON()
-                .sort((a, b) => a.localeCompare(b))
-                .join(", ")} }`,
-            );
-          container.push(
-            `import ${c.type ? "type " : ""}${brackets.join(", ")} from "${
-              c.location
-            }";`,
-          );
-        }
-      };
-
-    enroll((str) => str.indexOf(NODE_MODULES) !== -1)(external);
-    enroll((str) => str.indexOf(NODE_MODULES) === -1)(internal);
-
-    if (external.length && internal.length) external.push("");
-    return [...external, ...internal].join("\n");
-  }
-}
-export namespace ImportDictionary {
-  export interface IExternalProps {
-    type: boolean;
-    library: string;
-    instance: string | null;
-  }
-  export interface IInternalProps {
-    type: boolean;
-    file: string;
-    instance: string | null;
-    name?: string | null;
-  }
-}
-
-interface IComposition {
-  location: string;
-  type: boolean;
-  default: boolean;
-  name?: string;
-  elements: HashSet<string>;
-}
-
-const NODE_MODULES = "node_modules/";
+import path from "path";
+import { HashMap } from "tstl/container/HashMap";
+import { HashSet } from "tstl/container/HashSet";
+import { Pair } from "tstl/utility/Pair";
+import ts from "typescript";
+
+import { FormatUtil } from "./FormatUtil";
+
+export class ImportDictionary {
+  private readonly components_: HashMap<Pair<string, boolean>, IComposition> =
+    new HashMap();
+
+  public constructor(public readonly file: string) {}
+
+  public empty(): boolean {
+    return this.components_.empty();
+  }
+
+  public external(props: ImportDictionary.IExternalProps): string {
+    const composition: IComposition = this.components_.take(
+      new Pair(props.library, props.type),
+      () => ({
+        location: `node_modules/${props.library}`,
+        elements: new HashSet(),
+        default: false,
+        type: props.type,
+      }),
+    );
+    if (props.instance === null) composition.default = true;
+    else composition.elements.insert(props.instance);
+    return props.instance ?? props.library;
+  }
+
+  public internal(props: ImportDictionary.IInternalProps): string {
+    const file: string = (() => {
+      if (props.file.substring(props.file.length - 5) === ".d.ts")
+        return props.file.substring(0, props.file.length - 5);
+      else if (props.file.substring(props.file.length - 3) === ".ts")
+        return props.file.substring(0, props.file.length - 3);
+      return props.file;
+    })();
+    const composition: IComposition = this.components_.take(
+      new Pair(file, props.type),
+      () => ({
+        location: file,
+        elements: new HashSet(),
+        default: false,
+        type: props.type,
+      }),
+    );
+    if (props.instance === null) {
+      composition.default = true;
+      if (props.name) composition.name = props.name;
+    } else composition.elements.insert(props.instance);
+    return props.instance ?? file;
+  }
+
+  public toStatements(outDir: string): ts.Statement[] {
+    const external: ts.ImportDeclaration[] = [];
+    const internal: ts.ImportDeclaration[] = [];
+
+    const locator = (str: string) => {
+      const location: string = path.relative(outDir, str).split("\\").join("/");
+      const index: number = location.lastIndexOf(NODE_MODULES);
+      return index === -1
+        ? location.startsWith("..")
+          ? location
+          : `./${location}`
+        : location.substring(index + NODE_MODULES.length);
+    };
+    const enroll =
+      (filter: (str: string) => boolean) =>
+      (container: ts.ImportDeclaration[]) => {
+        const compositions: IComposition[] = this.components_
+          .toJSON()
+          .filter((c) => filter(c.second.location))
+          .map((e) => ({
+            ...e.second,
+            location: locator(e.second.location),
+          }))
+          .sort((a, b) => a.location.localeCompare(b.location));
+        for (const c of compositions) {
+          const brackets: string[] = [];
+          if (c.default) brackets.push(c.name ?? c.location);
+          if (c.elements.empty() === false)
+            brackets.push(
+              `{ ${c.elements
+                .toJSON()
+                .sort((a, b) => a.localeCompare(b))
+                .join(", ")} }`,
+            );
+          container.push(
+            ts.factory.createImportDeclaration(
+              undefined,
+              ts.factory.createImportClause(
+                c.type,
+                c.default
+                  ? ts.factory.createIdentifier(c.name ?? c.location)
+                  : undefined,
+                c.elements.empty() === false
+                  ? ts.factory.createNamedImports(
+                      [...c.elements].map((elem) =>
+                        ts.factory.createImportSpecifier(
+                          false,
+                          undefined,
+                          ts.factory.createIdentifier(elem),
+                        ),
+                      ),
+                    )
+                  : undefined,
+              ),
+              ts.factory.createStringLiteral(c.location),
+            ),
+          );
+        }
+      };
+
+    enroll((str) => str.indexOf(NODE_MODULES) !== -1)(external);
+    enroll((str) => str.indexOf(NODE_MODULES) === -1)(internal);
+    return [
+      ...external,
+      ...(external.length && internal.length ? [FormatUtil.enter()] : []),
+      ...internal,
+    ];
+  }
+
+  public toScript(outDir: string): string {
+    const external: string[] = [];
+    const internal: string[] = [];
+
+    const locator = (str: string) => {
+      const location: string = path.relative(outDir, str).split("\\").join("/");
+      const index: number = location.lastIndexOf(NODE_MODULES);
+      return index === -1
+        ? location.startsWith("..")
+          ? location
+          : `./${location}`
+        : location.substring(index + NODE_MODULES.length);
+    };
+    const enroll =
+      (filter: (str: string) => boolean) => (container: string[]) => {
+        const compositions: IComposition[] = this.components_
+          .toJSON()
+          .filter((c) => filter(c.second.location))
+          .map((e) => ({
+            ...e.second,
+            location: locator(e.second.location),
+          }))
+          .sort((a, b) => a.location.localeCompare(b.location));
+        for (const c of compositions) {
+          const brackets: string[] = [];
+          if (c.default) brackets.push(c.name ?? c.location);
+          if (c.elements.empty() === false)
+            brackets.push(
+              `{ ${c.elements
+                .toJSON()
+                .sort((a, b) => a.localeCompare(b))
+                .join(", ")} }`,
+            );
+          container.push(
+            `import ${c.type ? "type " : ""}${brackets.join(", ")} from "${
+              c.location
+            }";`,
+          );
+        }
+      };
+
+    enroll((str) => str.indexOf(NODE_MODULES) !== -1)(external);
+    enroll((str) => str.indexOf(NODE_MODULES) === -1)(internal);
+
+    if (external.length && internal.length) external.push("");
+    return [...external, ...internal].join("\n");
+  }
+}
+export namespace ImportDictionary {
+  export interface IExternalProps {
+    type: boolean;
+    library: string;
+    instance: string | null;
+  }
+  export interface IInternalProps {
+    type: boolean;
+    file: string;
+    instance: string | null;
+    name?: string | null;
+  }
+}
+
+interface IComposition {
+  location: string;
+  type: boolean;
+  default: boolean;
+  name?: string;
+  elements: HashSet<string>;
+}
+
+const NODE_MODULES = "node_modules/";