@nestia/sdk 3.0.0-dev.20231209 → 3.0.0-dev.20240412

package/src/generates/internal/FilePrinter.ts

@@ -0,0 +1,53 @@
+import fs from "fs";
+import { format } from "prettier";
+import ts from "typescript";
+
+export namespace FilePrinter {
+  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 write = async (props: {
+    location: string;
+    statements: ts.Statement[];
+    top?: string;
+  }): Promise<void> => {
+    const script: string = ts
+      .createPrinter()
+      .printFile(
+        ts.factory.createSourceFile(
+          props.statements,
+          ts.factory.createToken(ts.SyntaxKind.EndOfFileToken),
+          ts.NodeFlags.None,
+        ),
+      );
+    await fs.promises.writeFile(
+      props.location,
+      await beautify((props.top ?? "") + script),
+      "utf8",
+    );
+  };
+
+  const beautify = async (script: string): Promise<string> => {
+    try {
+      return await format(script, {
+        parser: "typescript",
+      });
+    } catch {
+      return script;
+    }
+  };
+}

package/src/{utils → generates/internal}/ImportDictionary.ts

@@ -1,7 +1,8 @@
 import path from "path";
-import { HashMap } from "tstl/container/HashMap";
-import { HashSet } from "tstl/container/HashSet";
-import { Pair } from "tstl/utility/Pair";
+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> =
@@ -52,9 +53,9 @@ export class ImportDictionary {
     return props.instance ?? file;
   }
 
-  public toScript(outDir: string): string {
-    const external: string[] = [];
-    const internal: string[] = [];
+  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("/");
@@ -66,7 +67,8 @@ export class ImportDictionary {
         : location.substring(index + NODE_MODULES.length);
     };
     const enroll =
-      (filter: (str: string) => boolean) => (container: string[]) => {
+      (filter: (str: string) => boolean) =>
+      (container: ts.ImportDeclaration[]) => {
         const compositions: IComposition[] = this.components_
           .toJSON()
           .filter((c) => filter(c.second.location))
@@ -86,18 +88,38 @@ export class ImportDictionary {
                 .join(", ")} }`,
             );
           container.push(
-            `import ${c.type ? "type " : ""}${brackets.join(", ")} from "${
-              c.location
-            }";`,
+            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);
-
-    if (external.length && internal.length) external.push("");
-    return [...external, ...internal].join("\n");
+    return [
+      ...external,
+      ...(external.length && internal.length ? [FilePrinter.enter()] : []),
+      ...internal,
+    ];
   }
 }
 export namespace ImportDictionary {

package/src/generates/internal/SdkAliasCollection.ts

@@ -0,0 +1,152 @@
+import ts from "typescript";
+import typia from "typia";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { IController } from "../../structures/IController";
+import { IRoute } from "../../structures/IRoute";
+import { ImportDictionary } from "./ImportDictionary";
+import { SdkTypeProgrammer } from "./SdkTypeProgrammer";
+
+export namespace SdkAliasCollection {
+  export const name =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (p: IRoute.IParameter | IRoute.IOutput): ts.TypeNode =>
+      p.metadata
+        ? SdkTypeProgrammer.write(config)(importer)(p.metadata)
+        : ts.factory.createTypeReferenceNode(p.typeName);
+
+  export const headers =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (param: IRoute.IParameter): ts.TypeNode => {
+      const type: ts.TypeNode = name(config)(importer)(param);
+      if (config.primitive === false) return type;
+      return ts.factory.createTypeReferenceNode(
+        importer.external({
+          type: true,
+          library: "@nestia/fetcher",
+          instance: "Resolved",
+        }),
+        [type],
+      );
+    };
+
+  export const query =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (param: IRoute.IParameter): ts.TypeNode => {
+      const type: ts.TypeNode = name(config)(importer)(param);
+      if (config.primitive === false) return type;
+      return ts.factory.createTypeReferenceNode(
+        importer.external({
+          type: true,
+          library: "@nestia/fetcher",
+          instance: "Resolved",
+        }),
+        [type],
+      );
+    };
+
+  export const input =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (param: IRoute.IParameter): ts.TypeNode => {
+      const type: ts.TypeNode = name(config)(importer)(param);
+      if (config.clone === true || config.primitive === false) return type;
+      return ts.factory.createTypeReferenceNode(
+        importer.external({
+          type: true,
+          library: "@nestia/fetcher",
+          instance:
+            typia.is<IController.IBodyParameter>(param) &&
+            param.contentType === "multipart/form-data"
+              ? "Resolved"
+              : "Primitive",
+        }),
+        [type],
+      );
+    };
+
+  export const output =
+    (checker: ts.TypeChecker) =>
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (route: IRoute): ts.TypeNode => {
+      if (config.propagate !== true) {
+        const node: ts.TypeNode = name(config)(importer)(route.output);
+        const type = checker.getTypeAtLocation(node);
+        const filter = (flag: ts.TypeFlags) => (type.getFlags() & flag) !== 0;
+
+        if (
+          config.clone === true ||
+          config.primitive === false ||
+          filter(ts.TypeFlags.Undefined) ||
+          filter(ts.TypeFlags.Never) ||
+          filter(ts.TypeFlags.Void) ||
+          filter(ts.TypeFlags.VoidLike)
+        )
+          return node;
+        return ts.factory.createTypeReferenceNode(
+          importer.external({
+            type: true,
+            library: "@nestia/fetcher",
+            instance:
+              route.output.contentType === "application/x-www-form-urlencoded"
+                ? "Resolved"
+                : "Primitive",
+          }),
+          [node],
+        );
+      }
+
+      const branches: IBranch[] = [
+        {
+          status: String(route.status ?? (route.method === "POST" ? 201 : 200)),
+          type: name(config)(importer)(route.output),
+        },
+        ...Object.entries(route.exceptions).map(([status, value]) => ({
+          status,
+          type: name(config)(importer)(value),
+        })),
+      ];
+      return ts.factory.createTypeReferenceNode(
+        importer.external({
+          type: true,
+          library: "@nestia/fetcher",
+          instance: "IPropagation",
+        }),
+        [
+          ts.factory.createTypeLiteralNode(
+            branches.map((b) =>
+              ts.factory.createPropertySignature(
+                undefined,
+                ts.factory.createNumericLiteral(b.status),
+                undefined,
+                b.type,
+              ),
+            ),
+          ),
+          ...(route.status
+            ? [
+                ts.factory.createLiteralTypeNode(
+                  ts.factory.createNumericLiteral(route.status),
+                ),
+              ]
+            : []),
+        ],
+      );
+    };
+
+  export const responseBody =
+    (checker: ts.TypeChecker) =>
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (route: IRoute): ts.TypeNode =>
+      output(checker)({ ...config, propagate: false })(importer)(route);
+}
+
+interface IBranch {
+  status: string;
+  type: ts.TypeNode;
+}

package/src/generates/internal/SdkCloneProgrammer.ts

@@ -0,0 +1,155 @@
+import { IPointer } from "tstl";
+import ts from "typescript";
+import { IJsDocTagInfo } from "typia";
+import { MetadataCollection } from "typia/lib/factories/MetadataCollection";
+import { MetadataFactory } from "typia/lib/factories/MetadataFactory";
+import { MetadataAlias } from "typia/lib/schemas/metadata/MetadataAlias";
+import { MetadataAtomic } from "typia/lib/schemas/metadata/MetadataAtomic";
+import { MetadataObject } from "typia/lib/schemas/metadata/MetadataObject";
+
+import { INestiaConfig } from "../../INestiaConfig";
+import { IRoute } from "../../structures/IRoute";
+import { MapUtil } from "../../utils/MapUtil";
+import { FilePrinter } from "./FilePrinter";
+import { ImportDictionary } from "./ImportDictionary";
+import { SdkTypeProgrammer } from "./SdkTypeProgrammer";
+
+export namespace SdkCloneProgrammer {
+  export interface IModule {
+    name: string;
+    children: Map<string, IModule>;
+    programmer:
+      | null
+      | ((importer: ImportDictionary) => ts.TypeAliasDeclaration);
+  }
+
+  export const write =
+    (checker: ts.TypeChecker) =>
+    (config: INestiaConfig) =>
+    (routes: IRoute[]): Map<string, IModule> => {
+      const collection = new MetadataCollection({
+        replace: MetadataCollection.replace,
+      });
+      for (const r of routes) {
+        for (const p of r.parameters) {
+          const res = MetadataFactory.analyze(checker)({
+            escape: false,
+            constant: true,
+            absorb: false,
+          })(collection)(p.type);
+          if (res.success) p.metadata = res.data;
+        }
+        for (const e of Object.values(r.exceptions)) {
+          const res = MetadataFactory.analyze(checker)({
+            escape: true,
+            constant: true,
+            absorb: false,
+          })(collection)(e.type);
+          if (res.success) e.metadata = res.data;
+        }
+        const res = MetadataFactory.analyze(checker)({
+          escape: true,
+          constant: true,
+          absorb: false,
+        })(collection)(r.output.type);
+        if (res.success) r.output.metadata = res.data;
+      }
+
+      const dict: Map<string, IModule> = new Map();
+      for (const alias of collection.aliases())
+        if (isNamedDeclaration(alias.name))
+          prepare(dict)(alias.name)((importer) =>
+            write_alias(config)(importer)(alias),
+          );
+      for (const object of collection.objects())
+        if (isNamedDeclaration(object.name))
+          prepare(dict)(object.name)((importer) =>
+            write_object(config)(importer)(object),
+          );
+      return dict;
+    };
+
+  const prepare =
+    (dict: Map<string, IModule>) =>
+    (name: string) =>
+    (programmer: (importer: ImportDictionary) => ts.TypeAliasDeclaration) => {
+      const accessors: string[] = name.split(".");
+      const modulo: IPointer<IModule> = { value: null! };
+
+      accessors.forEach((acc, i) => {
+        modulo.value = MapUtil.take(dict, acc, () => ({
+          name: acc,
+          children: new Map(),
+          programmer: null,
+        }));
+        if (i === accessors.length - 1) modulo.value.programmer = programmer;
+        dict = modulo.value.children;
+      });
+      return modulo!;
+    };
+
+  const write_alias =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (alias: MetadataAlias): ts.TypeAliasDeclaration =>
+      FilePrinter.description(
+        ts.factory.createTypeAliasDeclaration(
+          [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
+          alias.name.split(".").at(-1)!,
+          [],
+          SdkTypeProgrammer.write(config)(importer)(alias.value),
+        ),
+        writeComment([])(alias.description, alias.jsDocTags),
+      );
+
+  const write_object =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (object: MetadataObject): ts.TypeAliasDeclaration => {
+      return FilePrinter.description(
+        ts.factory.createTypeAliasDeclaration(
+          [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
+          object.name.split(".").at(-1)!,
+          [],
+          SdkTypeProgrammer.write_object(config)(importer)(object),
+        ),
+        writeComment([])(object.description ?? null, object.jsDocTags),
+      );
+    };
+}
+
+const isNamedDeclaration = (name: string) =>
+  name !== "object" &&
+  name !== "__type" &&
+  !name.startsWith("__type.") &&
+  name !== "__object" &&
+  !name.startsWith("__object.");
+
+const writeComment =
+  (atomics: MetadataAtomic[]) =>
+  (description: string | null, jsDocTags: IJsDocTagInfo[]): string => {
+    const lines: string[] = [];
+    if (description?.length)
+      lines.push(...description.split("\n").map((s) => `${s}`));
+
+    const filtered: IJsDocTagInfo[] =
+      !!atomics.length && !!jsDocTags?.length
+        ? jsDocTags.filter(
+            (tag) =>
+              !atomics.some((a) =>
+                a.tags.some((r) => r.some((t) => t.kind === tag.name)),
+              ),
+          )
+        : jsDocTags ?? [];
+
+    if (description?.length && filtered.length) lines.push("");
+    if (filtered.length)
+      lines.push(
+        ...filtered.map((t) =>
+          t.text?.length
+            ? `@${t.name} ${t.text.map((e) => e.text).join("")}`
+            : `@${t.name}`,
+        ),
+      );
+    return lines.join("\n");
+  };

package/src/generates/internal/SdkDistributionComposer.ts

@@ -1,91 +1,91 @@
-import cp from "child_process";
-import fs from "fs";
-import path from "path";
-
-import { INestiaConfig } from "../../INestiaConfig";
-
-export namespace SdkDistributionComposer {
-  export const compose = async (config: INestiaConfig) => {
-    if (!fs.existsSync(config.distribute!))
-      await fs.promises.mkdir(config.distribute!);
-
-    const root: string = process.cwd();
-    const output: string = path.resolve(config.output!);
-    process.chdir(config.distribute!);
-
-    const exit = () => process.chdir(root);
-    if (await configured()) return exit();
-
-    // COPY FILES
-    console.log("Composing SDK distribution environments...");
-    for (const file of await fs.promises.readdir(BUNDLE))
-      await fs.promises.copyFile(`${BUNDLE}/${file}`, file);
-
-    // CONFIGURE PATHS
-    for (const file of ["package.json", "tsconfig.json"])
-      await replace({ root, output })(file);
-
-    // INSTALL PACKAGES
-    const versions: IDependencies = await dependencies();
-    execute("npm install --save-dev rimraf");
-    execute(
-      `npm install --save @nestia/fetcher@${versions["@nestia/fetcher"]}`,
-    );
-    execute(`npm install --save typia@${versions["typia"]}`);
-    execute("npx typia setup --manager npm");
-
-    exit();
-  };
-
-  const configured = async (): Promise<boolean> =>
-    ["package.json", "tsconfig.json"].every(fs.existsSync) &&
-    (await (async () => {
-      const content = JSON.parse(
-        await fs.promises.readFile("package.json", "utf8"),
-      );
-      return !!content.dependencies?.["@nestia/fetcher"];
-    })());
-
-  const execute = (command: string) => {
-    console.log(`  - ${command}`);
-    cp.execSync(command, { stdio: "ignore" });
-  };
-
-  const replace =
-    (props: { root: string; output: string }) =>
-    async (file: string): Promise<void> => {
-      const relative = (from: string) => (to: string) =>
-        path.relative(from, to).split("\\").join("/");
-      const root: string = relative(process.cwd())(props.root);
-      const output: string = relative(process.cwd())(props.output);
-      const current: string = relative(props.root)(process.cwd());
-
-      const content: string = await fs.promises.readFile(file, "utf8");
-      await fs.promises.writeFile(
-        file,
-        content
-          .split("${root}")
-          .join(root)
-          .split("${output}")
-          .join(output)
-          .split("${current}")
-          .join(current),
-        "utf8",
-      );
-    };
-
-  const dependencies = async () => {
-    const content: string = await fs.promises.readFile(
-      __dirname + "/../../../package.json",
-      "utf8",
-    );
-    const json: { dependencies: IDependencies } = JSON.parse(content);
-    return json.dependencies;
-  };
-}
-
-interface IDependencies {
-  "@nestia/fetcher": string;
-  typia: string;
-}
-const BUNDLE = __dirname + "/../../../assets/bundle/distribute";
+import cp from "child_process";
+import fs from "fs";
+import path from "path";
+
+import { INestiaConfig } from "../../INestiaConfig";
+
+export namespace SdkDistributionComposer {
+  export const compose = async (config: INestiaConfig) => {
+    if (!fs.existsSync(config.distribute!))
+      await fs.promises.mkdir(config.distribute!);
+
+    const root: string = process.cwd();
+    const output: string = path.resolve(config.output!);
+    process.chdir(config.distribute!);
+
+    const exit = () => process.chdir(root);
+    if (await configured()) return exit();
+
+    // COPY FILES
+    console.log("Composing SDK distribution environments...");
+    for (const file of await fs.promises.readdir(BUNDLE))
+      await fs.promises.copyFile(`${BUNDLE}/${file}`, file);
+
+    // CONFIGURE PATHS
+    for (const file of ["package.json", "tsconfig.json"])
+      await replace({ root, output })(file);
+
+    // INSTALL PACKAGES
+    const versions: IDependencies = await dependencies();
+    execute("npm install --save-dev rimraf");
+    execute(
+      `npm install --save @nestia/fetcher@${versions["@nestia/fetcher"]}`,
+    );
+    execute(`npm install --save typia@${versions["typia"]}`);
+    execute("npx typia setup --manager npm");
+
+    exit();
+  };
+
+  const configured = async (): Promise<boolean> =>
+    ["package.json", "tsconfig.json"].every(fs.existsSync) &&
+    (await (async () => {
+      const content = JSON.parse(
+        await fs.promises.readFile("package.json", "utf8"),
+      );
+      return !!content.dependencies?.["@nestia/fetcher"];
+    })());
+
+  const execute = (command: string) => {
+    console.log(`  - ${command}`);
+    cp.execSync(command, { stdio: "ignore" });
+  };
+
+  const replace =
+    (props: { root: string; output: string }) =>
+    async (file: string): Promise<void> => {
+      const relative = (from: string) => (to: string) =>
+        path.relative(from, to).split("\\").join("/");
+      const root: string = relative(process.cwd())(props.root);
+      const output: string = relative(process.cwd())(props.output);
+      const current: string = relative(props.root)(process.cwd());
+
+      const content: string = await fs.promises.readFile(file, "utf8");
+      await fs.promises.writeFile(
+        file,
+        content
+          .split("${root}")
+          .join(root)
+          .split("${output}")
+          .join(output)
+          .split("${current}")
+          .join(current),
+        "utf8",
+      );
+    };
+
+  const dependencies = async () => {
+    const content: string = await fs.promises.readFile(
+      __dirname + "/../../../package.json",
+      "utf8",
+    );
+    const json: { dependencies: IDependencies } = JSON.parse(content);
+    return json.dependencies;
+  };
+}
+
+interface IDependencies {
+  "@nestia/fetcher": string;
+  typia: string;
+}
+const BUNDLE = __dirname + "/../../../assets/bundle/distribute";