@nestia/sdk 2.6.3 → 2.6.4-dev.20240401

package/src/generates/internal/ImportDictionary.ts

@@ -1,147 +1,147 @@
-import path from "path";
-import { HashMap, HashSet, Pair } from "tstl";
-import ts from "typescript";
-
-import { FilePrinter } from "./FilePrinter";
-
-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 ? [FilePrinter.enter()] : []),
-      ...internal,
-    ];
-  }
-}
-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, HashSet, Pair } from "tstl";
+import ts from "typescript";
+
+import { FilePrinter } from "./FilePrinter";
+
+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 ? [FilePrinter.enter()] : []),
+      ...internal,
+    ];
+  }
+}
+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/";

package/src/structures/ISwagger.ts

@@ -1,6 +1,8 @@
 import { ISwaggerComponents } from "./ISwaggerComponents";
 import { ISwaggerInfo } from "./ISwaggerInfo";
 import { ISwaggerRoute } from "./ISwaggerRoute";
+import { ISwaggerServer } from "./ISwaggerServer";
+import { ISwaggerTag } from "./ISwaggerTag";
 
 /**
  * Swagger Document.
@@ -22,7 +24,7 @@ export interface ISwagger {
   /**
    * List of servers that provide the API.
    */
-  servers: ISwagger.IServer[];
+  servers: ISwaggerServer[];
 
   /**
    * Information about the API.
@@ -46,6 +48,11 @@ export interface ISwagger {
    */
   components: ISwaggerComponents;
 
+  /**
+   * List of tags.
+   */
+  tags: ISwaggerTag[];
+
   // /**
   //  * A declaration of which security mechanisms can be used across the API.
   //  *
@@ -57,35 +64,3 @@ export interface ISwagger {
   //  */
   // 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/structures/ISwaggerServer.ts

@@ -0,0 +1,16 @@
+/**
+ * Remote server definition.
+ */
+export interface ISwaggerServer {
+  /**
+   * A URL to the target host.
+   *
+   * @format uri
+   */
+  url: string;
+
+  /**
+   * An optional string describing the target server.
+   */
+  description?: string;
+}

package/src/structures/ISwaggerTag.ts

@@ -0,0 +1,9 @@
+/**
+ * Tag name and description.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface ISwaggerTag {
+  name: string;
+  description?: string;
+}

package/src/structures/TypeEntry.ts

@@ -1,22 +1,22 @@
-import { hash } from "tstl";
-import ts from "typescript";
-
-export class TypeEntry {
-  public constructor(
-    public readonly type: ts.Type,
-    public readonly nullable: boolean,
-    public readonly required: boolean,
-  ) {}
-
-  public equals(obj: TypeEntry): boolean {
-    return (
-      this.type === obj.type &&
-      this.nullable === obj.nullable &&
-      this.required === obj.required
-    );
-  }
-
-  public hashCode(): number {
-    return hash(this.type, this.nullable, this.required);
-  }
-}
+import { hash } from "tstl";
+import ts from "typescript";
+
+export class TypeEntry {
+  public constructor(
+    public readonly type: ts.Type,
+    public readonly nullable: boolean,
+    public readonly required: boolean,
+  ) {}
+
+  public equals(obj: TypeEntry): boolean {
+    return (
+      this.type === obj.type &&
+      this.nullable === obj.nullable &&
+      this.required === obj.required
+    );
+  }
+
+  public hashCode(): number {
+    return hash(this.type, this.nullable, this.required);
+  }
+}