@nestia/sdk 2.5.0-dev.20240130-4 → 2.5.0-dev.20240130-6

package/src/generates/internal/SdkRouteProgrammer.ts

@@ -3,10 +3,10 @@ import { IJsDocTagInfo } from "typia";
 
 import { INestiaConfig } from "../../INestiaConfig";
 import { IRoute } from "../../structures/IRoute";
-import { FormatUtil } from "../../utils/FormatUtil";
-import { ImportDictionary } from "../../utils/ImportDictionary";
+import { ImportDictionary } from "./ImportDictionary";
 import { SdkFunctionProgrammer } from "./SdkFunctionProgrammer";
 import { SdkNamespaceProgrammer } from "./SdkNamespaceProgrammer";
+import { FilePrinter } from "./FilePrinter";
 
 export namespace SdkRouteProgrammer {
   export const generate =
@@ -24,7 +24,7 @@ export namespace SdkRouteProgrammer {
         input: route.parameters.find((p) => p.category === "body"),
       };
       return [
-        FormatUtil.description(
+        FilePrinter.description(
           SdkFunctionProgrammer.generate(config)(importer)(route, props),
           describe(route),
         ),

package/src/generates/internal/SdkSimulationProgrammer.ts

@@ -7,7 +7,7 @@ import { TypeFactory } from "typia/lib/factories/TypeFactory";
 
 import { INestiaConfig } from "../../INestiaConfig";
 import { IRoute } from "../../structures/IRoute";
-import { ImportDictionary } from "../../utils/ImportDictionary";
+import { ImportDictionary } from "./ImportDictionary";
 import { SdkAliasCollection } from "./SdkAliasCollection";
 import { SdkImportWizard } from "./SdkImportWizard";
 import { SdkTypeProgrammer } from "./SdkTypeProgrammer";

package/src/generates/internal/SdkTypeProgrammer.ts

@@ -1,4 +1,5 @@
 import ts from "typescript";
+import { IJsDocTagInfo } from "typia";
 import { ExpressionFactory } from "typia/lib/factories/ExpressionFactory";
 import { TypeFactory } from "typia/lib/factories/TypeFactory";
 import { IMetadataTypeTag } from "typia/lib/schemas/metadata/IMetadataTypeTag";
@@ -8,12 +9,18 @@ import { MetadataArray } from "typia/lib/schemas/metadata/MetadataArray";
 import { MetadataAtomic } from "typia/lib/schemas/metadata/MetadataAtomic";
 import { MetadataEscaped } from "typia/lib/schemas/metadata/MetadataEscaped";
 import { MetadataObject } from "typia/lib/schemas/metadata/MetadataObject";
+import { MetadataProperty } from "typia/lib/schemas/metadata/MetadataProperty";
 import { MetadataTuple } from "typia/lib/schemas/metadata/MetadataTuple";
+import { Escaper } from "typia/lib/utils/Escaper";
 
 import { INestiaConfig } from "../../INestiaConfig";
-import { ImportDictionary } from "../../utils/ImportDictionary";
+import { FilePrinter } from "./FilePrinter";
+import { ImportDictionary } from "./ImportDictionary";
 
 export namespace SdkTypeProgrammer {
+  /* -----------------------------------------------------------
+    FACADE
+  ----------------------------------------------------------- */
   export const write =
     (config: INestiaConfig) =>
     (importer: ImportDictionary) =>
@@ -22,8 +29,8 @@ export namespace SdkTypeProgrammer {
 
       // COALESCES
       if (meta.any) union.push(TypeFactory.keyword("any"));
-      if (meta.nullable) union.push(node("null"));
-      if (meta.isRequired() === false) union.push(node("undefined"));
+      if (meta.nullable) union.push(writeNode("null"));
+      if (meta.isRequired() === false) union.push(writeNode("undefined"));
       if (parentEscaped === false && meta.escaped)
         union.push(write_escaped(config)(importer)(meta.escaped));
 
@@ -40,7 +47,9 @@ export namespace SdkTypeProgrammer {
       for (const array of meta.arrays)
         union.push(write_array(config)(importer)(array));
       for (const object of meta.objects)
-        union.push(write_alias(config)(importer)(object));
+        if (object.name === "__type" || object.name.startsWith("__type."))
+          union.push(write_object(config)(importer)(object));
+        else union.push(write_alias(config)(importer)(object));
       for (const alias of meta.aliases)
         union.push(write_alias(config)(importer)(alias));
 
@@ -49,6 +58,27 @@ export namespace SdkTypeProgrammer {
         : ts.factory.createUnionTypeNode(union);
     };
 
+  export const write_object =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (object: MetadataObject): ts.TypeNode => {
+      const regular = object.properties.filter((p) => p.key.isSoleLiteral());
+      const dynamic = object.properties.filter((p) => !p.key.isSoleLiteral());
+      return FilePrinter.description(
+        regular.length && dynamic.length
+          ? ts.factory.createIntersectionTypeNode([
+              write_regular_property(config)(importer)(regular),
+              ...dynamic.map(write_dynamic_property(config)(importer)),
+            ])
+          : dynamic.length
+            ? ts.factory.createIntersectionTypeNode(
+                dynamic.map(write_dynamic_property(config)(importer)),
+              )
+            : write_regular_property(config)(importer)(regular),
+        writeComment([])(object.description ?? null, object.jsDocTags),
+      );
+    };
+
   const write_escaped =
     (config: INestiaConfig) =>
     (importer: ImportDictionary) =>
@@ -68,6 +98,9 @@ export namespace SdkTypeProgrammer {
       return write(config)(importer)(meta.returns, true);
     };
 
+  /* -----------------------------------------------------------
+    ATOMICS
+  ----------------------------------------------------------- */
   const write_constant = (value: boolean | bigint | number | string) => {
     if (typeof value === "boolean")
       return ts.factory.createLiteralTypeNode(
@@ -150,6 +183,9 @@ export namespace SdkTypeProgrammer {
         meta.tags,
       );
 
+  /* -----------------------------------------------------------
+    INSTANCES
+  ----------------------------------------------------------- */
   const write_array =
     (config: INestiaConfig) =>
     (importer: ImportDictionary) =>
@@ -179,6 +215,58 @@ export namespace SdkTypeProgrammer {
         ),
       );
 
+  const write_regular_property =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (properties: MetadataProperty[]): ts.TypeLiteralNode =>
+      ts.factory.createTypeLiteralNode(
+        properties.map((p) =>
+          FilePrinter.description(
+            ts.factory.createPropertySignature(
+              undefined,
+              Escaper.variable(String(p.key.constants[0].values[0]))
+                ? ts.factory.createIdentifier(
+                    String(p.key.constants[0].values[0]),
+                  )
+                : ts.factory.createStringLiteral(
+                    String(p.key.constants[0].values[0]),
+                  ),
+              p.value.isRequired() === false
+                ? ts.factory.createToken(ts.SyntaxKind.QuestionToken)
+                : undefined,
+              SdkTypeProgrammer.write(config)(importer)(p.value),
+            ),
+            writeComment(p.value.atomics)(p.description, p.jsDocTags),
+          ),
+        ),
+      );
+
+  const write_dynamic_property =
+    (config: INestiaConfig) =>
+    (importer: ImportDictionary) =>
+    (property: MetadataProperty): ts.TypeLiteralNode =>
+      ts.factory.createTypeLiteralNode([
+        FilePrinter.description(
+          ts.factory.createIndexSignature(
+            undefined,
+            [
+              ts.factory.createParameterDeclaration(
+                undefined,
+                undefined,
+                ts.factory.createIdentifier("key"),
+                undefined,
+                SdkTypeProgrammer.write(config)(importer)(property.key),
+              ),
+            ],
+            SdkTypeProgrammer.write(config)(importer)(property.value),
+          ),
+          writeComment(property.value.atomics)(
+            property.description,
+            property.jsDocTags,
+          ),
+        ),
+      ]);
+
   const write_alias =
     (config: INestiaConfig) =>
     (importer: ImportDictionary) =>
@@ -187,6 +275,9 @@ export namespace SdkTypeProgrammer {
       return ts.factory.createTypeReferenceNode(meta.name);
     };
 
+  /* -----------------------------------------------------------
+    MISCELLANEOUS
+  ----------------------------------------------------------- */
   const write_type_tag_matrix =
     (importer: ImportDictionary) =>
     (base: ts.TypeNode, matrix: IMetadataTypeTag[][]): ts.TypeNode => {
@@ -212,7 +303,7 @@ export namespace SdkTypeProgrammer {
     };
 }
 
-const node = (text: string) => ts.factory.createTypeReferenceNode(text);
+const writeNode = (text: string) => ts.factory.createTypeReferenceNode(text);
 const writeTag = (importer: ImportDictionary) => (tag: IMetadataTypeTag) => {
   const instance: string = tag.name.split("<")[0];
   return ts.factory.createTypeReferenceNode(
@@ -241,6 +332,35 @@ const writeTag = (importer: ImportDictionary) => (tag: IMetadataTypeTag) => {
     ],
   );
 };
+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");
+  };
+
 const importInternalFile =
   (config: INestiaConfig) => (importer: ImportDictionary) => (name: string) => {
     const top = name.split(".")[0];

package/lib/utils/FormatUtil.d.ts

@@ -1,6 +0,0 @@
-import ts from "typescript";
-export declare namespace FormatUtil {
-    const description: <Node_1 extends ts.Node>(node: Node_1, comment: string) => Node_1;
-    const enter: () => ts.ExpressionStatement;
-    const beautify: (script: string) => Promise<string>;
-}

package/lib/utils/FormatUtil.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FormatUtil.js","sourceRoot":"","sources":["../../src/utils/FormatUtil.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCAAkC;AAClC,4DAA4B;AAE5B,IAAiB,UAAU,CA2B1B;AA3BD,WAAiB,UAAU;IACZ,sBAAW,GAAG,CACzB,IAAU,EACV,OAAe,EACT,EAAE;QACR,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACtC,oBAAE,CAAC,0BAA0B,CAC3B,IAAI,EACJ,oBAAE,CAAC,UAAU,CAAC,sBAAsB,EACpC,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EACtE,IAAI,CACL,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEW,gBAAK,GAAG,GAAG,EAAE,CACxB,oBAAE,CAAC,OAAO,CAAC,yBAAyB,CAAC,oBAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE7D,mBAAQ,GAAG,CAAO,MAAc,EAAmB,EAAE;QAChE,IAAI,CAAC;YACH,OAAO,MAAM,IAAA,iBAAM,EAAC,MAAM,EAAE;gBAC1B,MAAM,EAAE,YAAY;aACrB,CAAC,CAAC;QACL,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC,CAAA,CAAC;AACJ,CAAC,EA3BgB,UAAU,0BAAV,UAAU,QA2B1B"}

package/lib/utils/ImportDictionary.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ImportDictionary.js","sourceRoot":"","sources":["../../src/utils/ImportDictionary.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,oDAAiD;AACjD,oDAAiD;AACjD,4CAAyC;AACzC,4DAA4B;AAE5B,6CAA0C;AAE1C,MAAa,gBAAgB;IAI3B,YAAmC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;QAH9B,gBAAW,GAC1B,IAAI,iBAAO,EAAE,CAAC;IAEkC,CAAC;IAE5C,KAAK;QACV,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEM,QAAQ,CAAC,KAAsC;;QACpD,MAAM,WAAW,GAAiB,IAAI,CAAC,WAAW,CAAC,IAAI,CACrD,IAAI,WAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EACnC,GAAG,EAAE,CAAC,CAAC;YACL,QAAQ,EAAE,gBAAgB,KAAK,CAAC,OAAO,EAAE;YACzC,QAAQ,EAAE,IAAI,iBAAO,EAAE;YACvB,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC,CACH,CAAC;QACF,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI;YAAE,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;;YACnD,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,OAAO,MAAA,KAAK,CAAC,QAAQ,mCAAI,KAAK,CAAC,OAAO,CAAC;IACzC,CAAC;IAEM,QAAQ,CAAC,KAAsC;;QACpD,MAAM,IAAI,GAAW,CAAC,GAAG,EAAE;YACzB,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,OAAO;gBACzD,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;iBACnD,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK;gBAC5D,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACxD,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC,CAAC,EAAE,CAAC;QACL,MAAM,WAAW,GAAiB,IAAI,CAAC,WAAW,CAAC,IAAI,CACrD,IAAI,WAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAC1B,GAAG,EAAE,CAAC,CAAC;YACL,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI,iBAAO,EAAE;YACvB,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC,CACH,CAAC;QACF,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC5B,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;YAC3B,IAAI,KAAK,CAAC,IAAI;gBAAE,WAAW,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAChD,CAAC;;YAAM,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnD,OAAO,MAAA,KAAK,CAAC,QAAQ,mCAAI,IAAI,CAAC;IAChC,CAAC;IAEM,YAAY,CAAC,MAAc;QAChC,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAE5C,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,EAAE;YAC9B,MAAM,QAAQ,GAAW,cAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC1E,MAAM,KAAK,GAAW,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACzD,OAAO,KAAK,KAAK,CAAC,CAAC;gBACjB,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;oBACzB,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,KAAK,QAAQ,EAAE;gBACnB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC,CAAC;QACF,MAAM,MAAM,GACV,CAAC,MAAgC,EAAE,EAAE,CACrC,CAAC,SAAiC,EAAE,EAAE;;YACpC,MAAM,YAAY,GAAmB,IAAI,CAAC,WAAW;iBAClD,MAAM,EAAE;iBACR,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;iBACxC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iCACP,CAAC,CAAC,MAAM,KACX,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IACpC,CAAC;iBACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxD,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;gBAC9B,IAAI,CAAC,CAAC,OAAO;oBAAE,QAAQ,CAAC,IAAI,CAAC,MAAA,CAAC,CAAC,IAAI,mCAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;gBACnD,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,KAAK;oBAC9B,QAAQ,CAAC,IAAI,CACX,KAAK,CAAC,CAAC,QAAQ;yBACZ,MAAM,EAAE;yBACR,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;yBAClC,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,CAAC;gBACJ,SAAS,CAAC,IAAI,CACZ,oBAAE,CAAC,OAAO,CAAC,uBAAuB,CAChC,SAAS,EACT,oBAAE,CAAC,OAAO,CAAC,kBAAkB,CAC3B,CAAC,CAAC,IAAI,EACN,CAAC,CAAC,OAAO;oBACP,CAAC,CAAC,oBAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAA,CAAC,CAAC,IAAI,mCAAI,CAAC,CAAC,QAAQ,CAAC;oBACnD,CAAC,CAAC,SAAS,EACb,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,KAAK;oBAC1B,CAAC,CAAC,oBAAE,CAAC,OAAO,CAAC,kBAAkB,CAC3B,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3B,oBAAE,CAAC,OAAO,CAAC,qBAAqB,CAC9B,KAAK,EACL,SAAS,EACT,oBAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAClC,CACF,CACF;oBACH,CAAC,CAAC,SAAS,CACd,EACD,oBAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAC3C,CACF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;QAEJ,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC5D,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,uBAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,GAAG,QAAQ;SACZ,CAAC;IACJ,CAAC;CACF;AArHD,4CAqHC;AAuBD,MAAM,YAAY,GAAG,eAAe,CAAC"}

package/src/utils/FormatUtil.ts

@@ -1,31 +0,0 @@
-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;
-    }
-  };
-}