Merge pull request #1297 from samchon/feature/json-schema

Add `tags.Example` type with `@samchon/openapi` upgrading.
samchon · Sep 25, 2024 · 488a63d · 488a63d
2 parents 0602cc8 + 16cff2d
commit 488a63d
Show file tree

Hide file tree

Showing 16 changed files with 1,846 additions and 273 deletions.
diff --git a/benchmark/package.json b/benchmark/package.json
@@ -72,6 +72,6 @@
     "suppress-warnings": "^1.0.2",
     "tstl": "^3.0.0",
     "uuid": "^9.0.1",
-    "typia": "../typia-6.10.2-dev.20240920.tgz"
+    "typia": "../typia-6.10.3-dev.20240925.tgz"
   }
 }
diff --git a/debug/package.json b/debug/package.json
@@ -16,8 +16,9 @@
     "typescript": "^5.4.2"
   },
   "dependencies": {
+    "@samchon/openapi": "^1.0.5",
     "tstl": "^3.0.0",
-    "typia": "../typia-6.10.2-dev.20240920.tgz",
+    "typia": "../typia-6.10.2.tgz",
     "uuid": "^10.0.0"
   }
 }
diff --git a/debug/src/llm.ts b/debug/src/llm.ts
@@ -0,0 +1,12 @@
+import { ILlmApplication } from "@samchon/openapi";
+import typia from "typia";
+
+interface ICalculator {
+  /**
+   * @deprecated
+   */
+  plus(x: number, y: number): number;
+}
+
+const app: ILlmApplication = typia.llm.application<ICalculator>();
+console.log(app.functions[0]?.deprecated);
diff --git a/debug/src/random.ts b/debug/src/random.ts
diff --git a/errors/package.json b/errors/package.json
@@ -32,6 +32,6 @@
     "typescript": "^5.3.2"
   },
   "dependencies": {
-    "typia": "../typia-6.10.2-dev.20240920.tgz"
+    "typia": "../typia-6.10.3-dev.20240925.tgz"
   }
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typia",
-  "version": "6.10.2",
+  "version": "6.10.3-dev.20240925",
   "description": "Superfast runtime validators with only one line",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -67,7 +67,7 @@
   },
   "homepage": "https://typia.io",
   "dependencies": {
-    "@samchon/openapi": "^1.0.2",
+    "@samchon/openapi": "^1.0.5",
     "commander": "^10.0.0",
     "comment-json": "^4.2.3",
     "inquirer": "^8.2.5",

diff --git a/packages/typescript-json/package.json b/packages/typescript-json/package.json
@@ -1,6 +1,6 @@
 {
   "name": "typescript-json",
-  "version": "6.10.2-dev.20240920",
+  "version": "6.10.3-dev.20240925",
   "description": "Superfast runtime validators with only one line",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -63,7 +63,7 @@
   },
   "homepage": "https://typia.io",
   "dependencies": {
-    "typia": "6.10.2-dev.20240920"
+    "typia": "6.10.3-dev.20240925"
   },
   "peerDependencies": {
     "typescript": ">=4.8.0 <5.7.0"

diff --git a/src/programmers/llm/LlmApplicationProgrammer.ts b/src/programmers/llm/LlmApplicationProgrammer.ts
@@ -135,6 +135,9 @@ export namespace LlmApplicationProgrammer {
           })
         : undefined,
     description: props.description ?? undefined,
+    deprecated: props.jsDocTags.some((tag) => tag.name === "deprecated")
+      ? true
+      : undefined,
   });
 
   const writeSchema = (props: {

diff --git a/src/tags/Example.ts b/src/tags/Example.ts
@@ -0,0 +1,17 @@
+import { TagBase } from "./TagBase";
+
+export type Example<
+  Value extends boolean | bigint | number | string | Array<unknown> | null,
+> = TagBase<{
+  target: "boolean" | "bigint" | "number" | "string" | "array";
+  kind: "example";
+  value: Value;
+  exclusive: true;
+  schema: Value extends bigint
+    ? { example: Numeric<Value> }
+    : { example: Value };
+}>;
+
+type Numeric<T extends bigint> = `${T}` extends `${infer N extends number}`
+  ? N
+  : never;
diff --git a/src/tags/Examples.ts b/src/tags/Examples.ts
@@ -0,0 +1,16 @@
+import { TagBase } from "./TagBase";
+
+export type Examples<
+  Dict extends Record<
+    string,
+    boolean | bigint | number | string | Array<unknown> | null
+  >,
+> = TagBase<{
+  target: "boolean" | "bigint" | "number" | "string" | "array";
+  kind: "examples";
+  value: Dict;
+  exclusive: true;
+  schema: {
+    examples: Dict;
+  };
+}>;
diff --git a/src/tags/index.ts b/src/tags/index.ts
@@ -1,6 +1,8 @@
 export * from "./Constant";
 export * from "./ContentMediaType";
 export * from "./Default";
+export * from "./Example";
+export * from "./Examples";
 export * from "./ExclusiveMaximum";
 export * from "./ExclusiveMinimum";
 export * from "./Format";

diff --git a/test-esm/package.json b/test-esm/package.json
@@ -36,6 +36,6 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "typia": "../typia-6.10.2-dev.20240920.tgz"
+    "typia": "../typia-6.10.3-dev.20240925.tgz"
   }
 }
diff --git a/test/package.json b/test/package.json
@@ -52,6 +52,6 @@
     "suppress-warnings": "^1.0.2",
     "tstl": "^3.0.0",
     "uuid": "^9.0.1",
-    "typia": "../typia-6.10.2-dev.20240920.tgz"
+    "typia": "../typia-6.10.3-dev.20240925.tgz"
   }
 }
diff --git a/test/schemas/json/v3_0/UltimateUnion.json b/test/schemas/json/v3_0/UltimateUnion.json
@@ -137,6 +137,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -145,6 +154,13 @@
         ],
         "description": "Constant value type."
       },
+      "Recordstringany": {
+        "type": "object",
+        "properties": {},
+        "nullable": false,
+        "description": "Construct a type with a set of properties K of type T",
+        "additionalProperties": {}
+      },
       "OpenApi.IJsonSchema.IBoolean": {
         "type": "object",
         "properties": {
@@ -175,6 +191,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -240,6 +265,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -305,6 +339,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -368,6 +411,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -421,6 +473,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -523,6 +584,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -615,6 +685,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -645,6 +724,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -717,6 +805,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -755,6 +852,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,
@@ -780,6 +886,15 @@
             "type": "boolean",
             "title": "Whether the type is deprecated or not",
             "description": "Whether the type is deprecated or not."
+          },
+          "example": {
+            "title": "Example value",
+            "description": "Example value."
+          },
+          "examples": {
+            "$ref": "#/components/schemas/Recordstringany",
+            "title": "List of example values as key-value pairs",
+            "description": "List of example values as key-value pairs."
           }
         },
         "nullable": false,