@samchon/openapi - npm Package Compare versions

Comparing version 2.4.1 to 2.4.2

lib/composers/HttpLlmApplicationComposer.js

@@ -188,3 +188,3 @@ "use strict";
         }
-        // FUNTION NAME
+        // FUNCTION NAME
         var name = emend(props.route.accessor.join("_"));
@@ -191,0 +191,0 @@ var isNameVariable = /^[a-zA-Z0-9_-]+$/.test(name);

lib/composers/llm/LlmSchemaV3_1Composer.js

@@ -52,3 +52,3 @@ "use strict";
 var LlmTypeCheckerV3_1_1 = require("../../utils/LlmTypeCheckerV3_1");
-var OpenApiContraintShifter_1 = require("../../utils/OpenApiContraintShifter");
+var OpenApiConstraintShifter_1 = require("../../utils/OpenApiConstraintShifter");
 var OpenApiTypeChecker_1 = require("../../utils/OpenApiTypeChecker");
@@ -242,3 +242,3 @@ var JsonDescriptionUtil_1 = require("../../utils/internal/JsonDescriptionUtil");
                     : function (x) {
-                        return OpenApiContraintShifter_1.OpenApiContraintShifter.shiftArray(x);
+                        return OpenApiConstraintShifter_1.OpenApiConstraintShifter.shiftArray(x);
                     })(__assign(__assign({}, input), { items: items.value })));
@@ -250,3 +250,3 @@ }
                     : function (x) {
-                        return OpenApiContraintShifter_1.OpenApiContraintShifter.shiftString(x);
+                        return OpenApiConstraintShifter_1.OpenApiConstraintShifter.shiftString(x);
                     })(__assign({}, input)));
@@ -258,3 +258,3 @@ else if (OpenApiTypeChecker_1.OpenApiTypeChecker.isNumber(input) ||
                     : function (x) {
-                        return OpenApiContraintShifter_1.OpenApiContraintShifter.shiftNumeric(x);
+                        return OpenApiConstraintShifter_1.OpenApiConstraintShifter.shiftNumeric(x);
                     })(__assign({}, input)));
@@ -261,0 +261,0 @@ else if (OpenApiTypeChecker_1.OpenApiTypeChecker.isTuple(input))

lib/composers/llm/LlmSchemaV3Composer.js

@@ -53,3 +53,3 @@ "use strict";
 var LlmTypeCheckerV3_1 = require("../../utils/LlmTypeCheckerV3");
-var OpenApiContraintShifter_1 = require("../../utils/OpenApiContraintShifter");
+var OpenApiConstraintShifter_1 = require("../../utils/OpenApiConstraintShifter");
 var OpenApiTypeChecker_1 = require("../../utils/OpenApiTypeChecker");
@@ -148,7 +148,7 @@ var LlmParametersComposer_1 = require("./LlmParametersComposer");
                         LlmTypeCheckerV3_1.LlmTypeCheckerV3.isNumber(next))
-                        OpenApiContraintShifter_1.OpenApiContraintShifter.shiftNumeric(next);
+                        OpenApiConstraintShifter_1.OpenApiConstraintShifter.shiftNumeric(next);
                     else if (LlmTypeCheckerV3_1.LlmTypeCheckerV3.isString(next))
-                        OpenApiContraintShifter_1.OpenApiContraintShifter.shiftString(next);
+                        OpenApiConstraintShifter_1.OpenApiConstraintShifter.shiftString(next);
                     else if (LlmTypeCheckerV3_1.LlmTypeCheckerV3.isArray(next))
-                        OpenApiContraintShifter_1.OpenApiContraintShifter.shiftArray(next);
+                        OpenApiConstraintShifter_1.OpenApiConstraintShifter.shiftArray(next);
                 }
@@ -155,0 +155,0 @@ },

lib/OpenApi.d.ts

@@ -10,3 +10,3 @@ import { OpenApiV3 } from "./OpenApiV3";
  * not a direct OpenAPI v3.1 specification ({@link OpenApiV3_1}), but a little
- * bit shrinked to remove ambiguous and duplicated expressions of OpenAPI v3.1
+ * bit shrunk to remove ambiguous and duplicated expressions of OpenAPI v3.1
  * for the convenience of `typia` and `nestia`.
@@ -77,3 +77,3 @@ *
      * In other words, `OpenApi.IDocument` is a structure of `swagger.json` file of
-     * OpenAPI v3.1 specification, but a little bit shrinked to remove ambiguous and
+     * OpenAPI v3.1 specification, but a little bit shrunk to remove ambiguous and
      * duplicated expressions of OpenAPI v3.1 for the convenience and clarity.
@@ -177,3 +177,3 @@ */
          * It is possible to skip composing this structure, even if some
-         * tag names are regsitered in the API routes ({@link OpenApi.IOperation.tags}).
+         * tag names are registered in the API routes ({@link OpenApi.IOperation.tags}).
          * In that case, the tag name would be displayed in Swagger-UI without
@@ -334,3 +334,3 @@ * description.
          * When this property be configured, the Restful API operation requires
-         * the matched security value for exection. Its key means security key
+         * the matched security value for execution. Its key means security key
          * matched with {@link OpenApi.IDocument.security}.
@@ -523,3 +523,3 @@ *
      * `OpenApi.IJsonSchema` basically follows the JSON schema definition of
-     * OpenAPI v3.1, but a little bit shrinked to remove ambiguous and duplicated
+     * OpenAPI v3.1, but a little bit shrunk to remove ambiguous and duplicated
      * expressions of OpenAPI v3.1 for the convenience and clarity.
@@ -697,3 +697,3 @@ *
              *
-             * Restriction of minumum number of items in the array.
+             * Restriction of minimum number of items in the array.
              *
@@ -751,3 +751,3 @@ * @type uint64
              *
-             * Restriction of minumum number of items in the tuple.
+             * Restriction of minimum number of items in the tuple.
              *
@@ -754,0 +754,0 @@ * @type uint64

lib/OpenApi.js

@@ -18,3 +18,3 @@ "use strict";
  * not a direct OpenAPI v3.1 specification ({@link OpenApiV3_1}), but a little
- * bit shrinked to remove ambiguous and duplicated expressions of OpenAPI v3.1
+ * bit shrunk to remove ambiguous and duplicated expressions of OpenAPI v3.1
  * for the convenience of `typia` and `nestia`.
@@ -21,0 +21,0 @@ *

lib/structures/IHttpConnection.d.ts

@@ -44,3 +44,3 @@ /**
     /**
-     * Addiotional options for the `fetch` function.
+     * Additional options for the `fetch` function.
      *
@@ -47,0 +47,0 @@ * Almost same with {@link RequestInit} type of the {@link fetch} function,

lib/structures/IHttpLlmApplication.d.ts

@@ -51,3 +51,3 @@ import { OpenApi } from "../OpenApi";
  * composed by Human, not by LLM. File uploading feature or some sensitive information
- * like secrety key (password) are the examples. In that case, you can separate the
+ * like secret key (password) are the examples. In that case, you can separate the
  * function parameters to both LLM and Human sides by configuring the
@@ -123,3 +123,3 @@ * {@link IHttpLlmApplication.IOptions.separate} property. The separated parameters are
         /**
-         * Error messsages.
+         * Error messages.
          */
@@ -139,3 +139,3 @@ messages: string[];
          * If the property returns `undefined`, it means that the error has
-         * been occured in the migration level, not of LLM application composition.
+         * been occurred in the migration level, not of LLM application composition.
          *
@@ -142,0 +142,0 @@ * @returns Migration route metadata.

lib/structures/IHttpLlmFunction.d.ts

@@ -20,3 +20,3 @@ import { OpenApi } from "../OpenApi";
  * {@link OpenApi.IOperation} is, `IHttpLlmFunction` has converted every type schema
- * informations from {@link OpenApi.IJsonSchema} to {@link ILlmSchemaV3} to escape
+ * information from {@link OpenApi.IJsonSchema} to {@link ILlmSchemaV3} to escape
  * {@link OpenApi.IJsonSchema.IReference reference types}, and downgrade the version
@@ -168,3 +168,3 @@ * of the JSON schema to OpenAPI 3.0. It's because LLM function call feature cannot
      * used to explain the function to the user. Therefore, the `description`
-     * property has the highest priroity, and you have to consider it.
+     * property has the highest priority, and you have to consider it.
      */
@@ -171,0 +171,0 @@ description?: string;

lib/structures/IHttpMigrateRoute.d.ts

@@ -9,3 +9,3 @@ import { OpenApi } from "../OpenApi";
  *
- * As the `IHttpMigrateRoute` has a lot of speical stories, when you're developing
+ * As the `IHttpMigrateRoute` has a lot of special stories, when you're developing
  * OpenAPI generator library, please read its description carefully including
@@ -12,0 +12,0 @@ * the description of its properties.

lib/structures/ILlmApplication.d.ts

@@ -13,3 +13,3 @@ import { ILlmFunction } from "./ILlmFunction";
  * composed by Human, not by LLM. File uploading feature or some sensitive information
- * like secrety key (password) are the examples. In that case, you can separate the
+ * like secret key (password) are the examples. In that case, you can separate the
  * function parameters to both LLM and human sides by configuring the
@@ -22,3 +22,3 @@ * {@link ILlmApplication.IOptions.separate} property. The separated parameters are
  * if you've configured the {@link ILlmApplication.IOptions.separate} property, you
- * have to merge the separated parameters before the funtion call execution.
+ * have to merge the separated parameters before the function call execution.
  *
@@ -25,0 +25,0 @@ * @reference https://platform.openai.com/docs/guides/function-calling

lib/structures/ILlmFunction.d.ts

@@ -55,3 +55,3 @@ import { ILlmSchema } from "./ILlmSchema";
      * used to explain the function to the user. Therefore, the `description`
-     * property has the highest priroity, and you have to consider it.
+     * property has the highest priority, and you have to consider it.
      */
@@ -58,0 +58,0 @@ description?: string | undefined;

lib/structures/ILlmSchemaV3_1.d.ts

@@ -245,3 +245,3 @@ /**
          *
-         * Restriction of minumum number of items in the array.
+         * Restriction of minimum number of items in the array.
          *
@@ -438,5 +438,5 @@ * @type uint64
         /**
-         * Whether to allow contraint properties or not.
+         * Whether to allow constraint properties or not.
          *
-         * If you configure this property to `false`, the schemas do not containt
+         * If you configure this property to `false`, the schemas do not contain
          * the constraint properties of below. Instead, below properties would be
@@ -443,0 +443,0 @@ * written to the {@link ILlmSchemaV3_1.__IAttribute.description} property

lib/structures/ILlmSchemaV3.d.ts

@@ -23,3 +23,3 @@ /**
  * Also, if you configure {@link ILlmSchemaV3.IConfig.constraint} to `false`,
- * tehse properties would be banned and written to the
+ * these properties would be banned and written to the
  * {@link ILlmSchemaV3.__IAttribute.description} property instead. It's because
@@ -235,3 +235,3 @@ * there are some LLM models which does not support the constraint properties.
          *
-         * Restriction of minumum number of items in the array.
+         * Restriction of minimum number of items in the array.
          *
@@ -397,5 +397,5 @@ * @type uint64
         /**
-         * Whether to allow contraint properties or not.
+         * Whether to allow constraint properties or not.
          *
-         * If you configure this property to `false`, the schemas do not containt
+         * If you configure this property to `false`, the schemas do not contain
          * the constraint properties of below. Instead, below properties would be
@@ -402,0 +402,0 @@ * written to the {@link ILlmSchemaV3.__IAttribute.description} property

lib/structures/IOpenApiSchemaError.d.ts

@@ -5,7 +5,7 @@ import { OpenApi } from "../OpenApi";
  *
- * `IOpenApiSchemaError` is a type representing an error that occured during the
+ * `IOpenApiSchemaError` is a type representing an error that occurred during the
  * iteration or transformation of the OpenAPI schema (JSON schema) of
  * {@link OpenApi.IJsonSchema} type.
  *
- * The most `IOpenApiSchemaError` is occured by the transformation process from
+ * The most `IOpenApiSchemaError` is occurred by the transformation process from
  * {@link OpenApi.IJsonSchema} to {@link ILlmSchema} type. The transformation can
@@ -12,0 +12,0 @@ * be failed by following reasons:

lib/typings/IResult.d.ts

@@ -7,3 +7,3 @@ /**
  *
- * You can distinguise the result by checking the {@link IResult.success} value,
+ * You can distinguished the result by checking the {@link IResult.success} value,
  * and if it's `true`, the success value is stored in {@link IResult.value}.
@@ -10,0 +10,0 @@ * Otherwise, if it's `false`, the error value is stored in {@link IResult.error}.

lib/utils/ChatGptTypeChecker.d.ts

@@ -78,3 +78,3 @@ import { IChatGptSchema } from "../structures/IChatGptSchema";
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -81,0 +81,0 @@ * - {@link IChatGptSchema.IAnyOf.anyOf}

lib/utils/ChatGptTypeChecker.js

@@ -136,3 +136,3 @@ "use strict";
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -139,0 +139,0 @@ * - {@link IChatGptSchema.IAnyOf.anyOf}

lib/utils/GeminiTypeChecker.d.ts

@@ -15,3 +15,3 @@ import { IGeminiSchema } from "../structures/IGeminiSchema";
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -18,0 +18,0 @@ * - {@link IGeminiSchema.IObject.properties}

lib/utils/GeminiTypeChecker.js

@@ -37,3 +37,3 @@ "use strict";
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -40,0 +40,0 @@ * - {@link IGeminiSchema.IObject.properties}

lib/utils/LlmTypeCheckerV3_1.d.ts

@@ -83,3 +83,3 @@ import { ILlmSchemaV3_1 } from "../structures/ILlmSchemaV3_1";
      *
-     * Test whether the target schema is a reference type, and test one thign more
+     * Test whether the target schema is a reference type, and test one thing more
      * that the reference is self-recursive or not.
@@ -110,3 +110,3 @@ *
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -113,0 +113,0 @@ * - {@link ILlmSchemaV3_1.IOneOf.oneOf}

lib/utils/LlmTypeCheckerV3_1.js

@@ -106,3 +106,3 @@ "use strict";
      *
-     * Test whether the target schema is a reference type, and test one thign more
+     * Test whether the target schema is a reference type, and test one thing more
      * that the reference is self-recursive or not.
@@ -146,3 +146,3 @@ *
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -149,0 +149,0 @@ * - {@link ILlmSchemaV3_1.IOneOf.oneOf}

lib/utils/LlmTypeCheckerV3.d.ts

@@ -15,3 +15,3 @@ import { ILlmSchemaV3 } from "../structures/ILlmSchemaV3";
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -18,0 +18,0 @@ * - {@link ILlmSchemaV3.IOneOf.oneOf}

lib/utils/LlmTypeCheckerV3.js

@@ -48,3 +48,3 @@ "use strict";
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -51,0 +51,0 @@ * - {@link ILlmSchemaV3.IOneOf.oneOf}

lib/utils/OpenApiTypeChecker.d.ts

@@ -99,3 +99,3 @@ import { OpenApi } from "../OpenApi";
      *
-     * Test whether the target schema is a reference type, and test one thign more
+     * Test whether the target schema is a reference type, and test one thing more
      * that the reference is self-recursive or not.
@@ -114,3 +114,3 @@ *
      * Escape from the {@link OpenApi.IJsonSchema.IReference} type, replacing the
-     * every references to the actual schemas. If the escape is successfull, the returned
+     * every references to the actual schemas. If the escape is successful, the returned
      * schema never contains any {@link OpenApi.IJsonSchema.IReference} type in its
@@ -162,3 +162,3 @@ * structure.
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -165,0 +165,0 @@ * - {@link OpenApi.IJsonSchema.IOneOf.oneOf}

lib/utils/OpenApiTypeChecker.js

@@ -139,3 +139,3 @@ "use strict";
      *
-     * Test whether the target schema is a reference type, and test one thign more
+     * Test whether the target schema is a reference type, and test one thing more
      * that the reference is self-recursive or not.
@@ -160,3 +160,3 @@ *
      * Escape from the {@link OpenApi.IJsonSchema.IReference} type, replacing the
-     * every references to the actual schemas. If the escape is successfull, the returned
+     * every references to the actual schemas. If the escape is successful, the returned
      * schema never contains any {@link OpenApi.IJsonSchema.IReference} type in its
@@ -201,3 +201,3 @@ * structure.
      *
-     * Here is the list of occuring nested visitings:
+     * Here is the list of occurring nested visitings:
      *
@@ -204,0 +204,0 @@ * - {@link OpenApi.IJsonSchema.IOneOf.oneOf}

package.json

 {
   "name": "@samchon/openapi",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "OpenAPI definitions and converters for 'typia' and 'nestia'.",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -34,3 +34,3 @@ # `@samchon/openapi`
 
-`@samchon/openapi` also provides LLM (Large Language Model) function calling application composer from the OpenAPI document with many strategies. With the [`HttpLlm`](https://github.com/samchon/openapi/blob/master/src/HttpLlm.ts) module, you can perform the LLM funtion calling extremely easily just by delivering the OpenAPI (Swagger) document.
+`@samchon/openapi` also provides LLM (Large Language Model) function calling application composer from the OpenAPI document with many strategies. With the [`HttpLlm`](https://github.com/samchon/openapi/blob/master/src/HttpLlm.ts) module, you can perform the LLM function calling extremely easily just by delivering the OpenAPI (Swagger) document.
 
@@ -49,5 +49,13 @@ - [`HttpLlm.application()`](https://github.com/samchon/openapi/blob/master/src/HttpLlm.ts)
 
+> https://github.com/user-attachments/assets/01604b53-aca4-41cb-91aa-3faf63549ea6
+>
+> Demonstration video composing A.I. chatbot with `@samchon/openapi` and [`@nestia/chat`](https://nestia.io/docs/swagger/chat/)
+>
+> - Shopping A.I. Chatbot Application: [https://nestia.io/chat/shopping](/chat/shopping)
+> - Shopping Backend Repository: https://github.com/samchon/shopping-backend
+> - Shopping Swagger Document (`@nestia/editor`): [https://nestia.io/editor/?url=...](https://nestia.io/editor/?simulate=true&e2e=true&url=https%3A%2F%2Fraw.githubusercontent.com%2Fsamchon%2Fshopping-backend%2Frefs%2Fheads%2Fmaster%2Fpackages%2Fapi%2Fswagger.json)
 
 
 
+
 ## Setup
@@ -97,3 +105,3 @@ ```bash
     application.functions.find(
-      // (f) => f.name === "llm_selected_fuction_name"
+      // (f) => f.name === "llm_selected_function_name"
       (f) => f.path === "/bbs/articles" && f.method === "post",
@@ -220,5 +228,5 @@ );
 
-`@samchon/openapi` provides LLM (Large Language Model) funtion calling application from the "emended OpenAPI v3.1 document". Therefore, if you have any HTTP backend server and succeeded to build an OpenAPI document, you can easily make the A.I. chatbot application.
+`@samchon/openapi` provides LLM (Large Language Model) function calling application from the "emended OpenAPI v3.1 document". Therefore, if you have any HTTP backend server and succeeded to build an OpenAPI document, you can easily make the A.I. chatbot application.
 
-In the A.I. chatbot, LLM will select proper function to remotely call from the conversations with user, and fill arguments of the function automatically. If you actually execute the function call through the `HttpLlm.execute()` funtion, it is the "LLM function call."
+In the A.I. chatbot, LLM will select proper function to remotely call from the conversations with user, and fill arguments of the function automatically. If you actually execute the function call through the `HttpLlm.execute()` function, it is the "LLM function call."
 
@@ -273,6 +281,6 @@ Let's enjoy the fantastic LLM function calling feature very easily with `@samchon/openapi`.
 
-In `@samchon/openapi`, you can execute the LLM function calling by `HttpLlm.execute()` (or `HttpLlm.propagate()`) function. Here is an example code executing the LLM function calling through the `HttpLlm.execute()` function. As you can see, to execute the LLM function call, you have to deliver these informations:
+In `@samchon/openapi`, you can execute the LLM function calling by `HttpLlm.execute()` (or `HttpLlm.propagate()`) function. Here is an example code executing the LLM function calling through the `HttpLlm.execute()` function. As you can see, to execute the LLM function call, you have to deliver these information:
 
   - Connection info to the HTTP server
-  - Application of the LLM fuction calling
+  - Application of the LLM function calling
   - LLM function schema to call
@@ -324,3 +332,3 @@ - Arguments for the function call (maybe composed by LLM)
     application.functions.find(
-      // (f) => f.name === "llm_selected_fuction_name"
+      // (f) => f.name === "llm_selected_function_name"
       (f) => f.path === "/shoppings/sellers/sale" && f.method === "post",
@@ -434,3 +442,3 @@ );
     application.functions.find(
-      // (f) => f.name === "llm_selected_fuction_name"
+      // (f) => f.name === "llm_selected_function_name"
       (f) => f.path === "/shoppings/sellers/sale" && f.method === "post",
@@ -500,2 +508,18 @@ );
 main().catch(console.error);
-```
+```
+
+
+
+
+## Wrtn OS
+[![Wrtn Logo](https://nestia.io/images/sponsors/wrtn-logo.png)](https://wrtnlabs.io)
+
+> https://wrtnlabs.io
+
+The new era of software development.
+
+If you are not familiar with LLM (Large Language Moodel) development or RAG implementation, you can take another option. Prepare your swagger document file, and visit WrtnLabs homepage https://wrtnlabs.io. You can create your own A.I. chatbot with "Wrtn OS", and re-distribute it as you want. The A.I. assistant in the Wrtn OS is much more optimized and cost efficient than the `@nestia/agent`, and it is fully open sourced.
+
+Also, you can sell your swagger document (backend API functions) in the "Wrtn Store", so that let other users to create their own A.I. chatbot with your backend API functions. Conversely, you can purchase the functions you need to create an A.I. chatbot from the store. If you have create an A.I. chatbot with only the functions purchased in the Wrtn Store, it is the no coding development.
+
+I think this is a new way of software development, and a new way of software distribution. It is a new era of software development, and I hope you to be a part of it.

src/composers/HttpLlmApplicationComposer.ts

@@ -199,3 +199,3 @@ import { OpenApi } from "../OpenApi";
 
-    // FUNTION NAME
+    // FUNCTION NAME
     const name: string = emend(props.route.accessor.join("_"));
@@ -202,0 +202,0 @@ const isNameVariable: boolean = /^[a-zA-Z0-9_-]+$/.test(name);

src/composers/llm/LlmSchemaV3_1Composer.ts

@@ -7,3 +7,3 @@ import { OpenApi } from "../../OpenApi";
 import { LlmTypeCheckerV3_1 } from "../../utils/LlmTypeCheckerV3_1";
-import { OpenApiContraintShifter } from "../../utils/OpenApiContraintShifter";
+import { OpenApiConstraintShifter } from "../../utils/OpenApiConstraintShifter";
 import { OpenApiTypeChecker } from "../../utils/OpenApiTypeChecker";
@@ -258,3 +258,3 @@ import { JsonDescriptionUtil } from "../../utils/internal/JsonDescriptionUtil";
             : (x: ILlmSchemaV3_1.IArray) =>
-                OpenApiContraintShifter.shiftArray(x))({
+                OpenApiConstraintShifter.shiftArray(x))({
             ...input,
@@ -269,3 +269,3 @@ items: items.value,
             : (x: ILlmSchemaV3_1.IString) =>
-                OpenApiContraintShifter.shiftString(x))({
+                OpenApiConstraintShifter.shiftString(x))({
             ...input,
@@ -282,3 +282,3 @@ }),
             : (x: ILlmSchemaV3_1.INumber | ILlmSchemaV3_1.IInteger) =>
-                OpenApiContraintShifter.shiftNumeric(x))({
+                OpenApiConstraintShifter.shiftNumeric(x))({
             ...input,
@@ -285,0 +285,0 @@ }),

src/composers/llm/LlmSchemaV3Composer.ts

@@ -8,3 +8,3 @@ import { OpenApi } from "../../OpenApi";
 import { LlmTypeCheckerV3 } from "../../utils/LlmTypeCheckerV3";
-import { OpenApiContraintShifter } from "../../utils/OpenApiContraintShifter";
+import { OpenApiConstraintShifter } from "../../utils/OpenApiConstraintShifter";
 import { OpenApiTypeChecker } from "../../utils/OpenApiTypeChecker";
@@ -143,3 +143,3 @@ import { LlmParametersFinder } from "./LlmParametersComposer";
           )
-            OpenApiContraintShifter.shiftNumeric(
+            OpenApiConstraintShifter.shiftNumeric(
               next as
@@ -150,7 +150,7 @@ | OpenApi.IJsonSchema.IInteger
           else if (LlmTypeCheckerV3.isString(next))
-            OpenApiContraintShifter.shiftString(
+            OpenApiConstraintShifter.shiftString(
               next as OpenApi.IJsonSchema.IString,
             );
           else if (LlmTypeCheckerV3.isArray(next))
-            OpenApiContraintShifter.shiftArray(
+            OpenApiConstraintShifter.shiftArray(
               next as OpenApi.IJsonSchema.IArray,
@@ -157,0 +157,0 @@ );

src/OpenApi.ts

@@ -16,3 +16,3 @@ import { OpenApiV3 } from "./OpenApiV3";
  * not a direct OpenAPI v3.1 specification ({@link OpenApiV3_1}), but a little
- * bit shrinked to remove ambiguous and duplicated expressions of OpenAPI v3.1
+ * bit shrunk to remove ambiguous and duplicated expressions of OpenAPI v3.1
  * for the convenience of `typia` and `nestia`.
@@ -130,3 +130,3 @@ *
    * In other words, `OpenApi.IDocument` is a structure of `swagger.json` file of
-   * OpenAPI v3.1 specification, but a little bit shrinked to remove ambiguous and
+   * OpenAPI v3.1 specification, but a little bit shrunk to remove ambiguous and
    * duplicated expressions of OpenAPI v3.1 for the convenience and clarity.
@@ -245,3 +245,3 @@ */
      * It is possible to skip composing this structure, even if some
-     * tag names are regsitered in the API routes ({@link OpenApi.IOperation.tags}).
+     * tag names are registered in the API routes ({@link OpenApi.IOperation.tags}).
      * In that case, the tag name would be displayed in Swagger-UI without
@@ -428,3 +428,3 @@ * description.
      * When this property be configured, the Restful API operation requires
-     * the matched security value for exection. Its key means security key
+     * the matched security value for execution. Its key means security key
      * matched with {@link OpenApi.IDocument.security}.
@@ -647,3 +647,3 @@ *
    * `OpenApi.IJsonSchema` basically follows the JSON schema definition of
-   * OpenAPI v3.1, but a little bit shrinked to remove ambiguous and duplicated
+   * OpenAPI v3.1, but a little bit shrunk to remove ambiguous and duplicated
    * expressions of OpenAPI v3.1 for the convenience and clarity.
@@ -879,3 +879,3 @@ *
        *
-       * Restriction of minumum number of items in the array.
+       * Restriction of minimum number of items in the array.
        *
@@ -938,3 +938,3 @@ * @type uint64
        *
-       * Restriction of minumum number of items in the tuple.
+       * Restriction of minimum number of items in the tuple.
        *
@@ -941,0 +941,0 @@ * @type uint64

src/structures/IHttpConnection.ts

@@ -49,3 +49,3 @@ /// <reference lib="dom" />
   /**
-   * Addiotional options for the `fetch` function.
+   * Additional options for the `fetch` function.
    *
@@ -52,0 +52,0 @@ * Almost same with {@link RequestInit} type of the {@link fetch} function,

src/structures/IHttpLlmApplication.ts

@@ -53,3 +53,3 @@ import { OpenApi } from "../OpenApi";
  * composed by Human, not by LLM. File uploading feature or some sensitive information
- * like secrety key (password) are the examples. In that case, you can separate the
+ * like secret key (password) are the examples. In that case, you can separate the
  * function parameters to both LLM and Human sides by configuring the
@@ -132,3 +132,3 @@ * {@link IHttpLlmApplication.IOptions.separate} property. The separated parameters are
     /**
-     * Error messsages.
+     * Error messages.
      */
@@ -150,3 +150,3 @@ messages: string[];
      * If the property returns `undefined`, it means that the error has
-     * been occured in the migration level, not of LLM application composition.
+     * been occurred in the migration level, not of LLM application composition.
      *
@@ -153,0 +153,0 @@ * @returns Migration route metadata.

src/structures/IHttpLlmFunction.ts

@@ -21,3 +21,3 @@ import { OpenApi } from "../OpenApi";
  * {@link OpenApi.IOperation} is, `IHttpLlmFunction` has converted every type schema
- * informations from {@link OpenApi.IJsonSchema} to {@link ILlmSchemaV3} to escape
+ * information from {@link OpenApi.IJsonSchema} to {@link ILlmSchemaV3} to escape
  * {@link OpenApi.IJsonSchema.IReference reference types}, and downgrade the version
@@ -175,3 +175,3 @@ * of the JSON schema to OpenAPI 3.0. It's because LLM function call feature cannot
    * used to explain the function to the user. Therefore, the `description`
-   * property has the highest priroity, and you have to consider it.
+   * property has the highest priority, and you have to consider it.
    */
@@ -178,0 +178,0 @@ description?: string;

src/structures/IHttpMigrateRoute.ts

@@ -10,3 +10,3 @@ import { OpenApi } from "../OpenApi";
  *
- * As the `IHttpMigrateRoute` has a lot of speical stories, when you're developing
+ * As the `IHttpMigrateRoute` has a lot of special stories, when you're developing
  * OpenAPI generator library, please read its description carefully including
@@ -13,0 +13,0 @@ * the description of its properties.

src/structures/ILlmApplication.ts

@@ -15,3 +15,3 @@ import { IGeminiSchema } from "./IGeminiSchema";
  * composed by Human, not by LLM. File uploading feature or some sensitive information
- * like secrety key (password) are the examples. In that case, you can separate the
+ * like secret key (password) are the examples. In that case, you can separate the
  * function parameters to both LLM and human sides by configuring the
@@ -24,3 +24,3 @@ * {@link ILlmApplication.IOptions.separate} property. The separated parameters are
  * if you've configured the {@link ILlmApplication.IOptions.separate} property, you
- * have to merge the separated parameters before the funtion call execution.
+ * have to merge the separated parameters before the function call execution.
  *
@@ -27,0 +27,0 @@ * @reference https://platform.openai.com/docs/guides/function-calling

src/structures/ILlmFunction.ts

@@ -60,3 +60,3 @@ import { ILlmSchema } from "./ILlmSchema";
    * used to explain the function to the user. Therefore, the `description`
-   * property has the highest priroity, and you have to consider it.
+   * property has the highest priority, and you have to consider it.
    */
@@ -63,0 +63,0 @@ description?: string | undefined;

src/structures/ILlmSchemaV3_1.ts

@@ -304,3 +304,3 @@ /**
      *
-     * Restriction of minumum number of items in the array.
+     * Restriction of minimum number of items in the array.
      *
@@ -514,5 +514,5 @@ * @type uint64
     /**
-     * Whether to allow contraint properties or not.
+     * Whether to allow constraint properties or not.
      *
-     * If you configure this property to `false`, the schemas do not containt
+     * If you configure this property to `false`, the schemas do not contain
      * the constraint properties of below. Instead, below properties would be
@@ -519,0 +519,0 @@ * written to the {@link ILlmSchemaV3_1.__IAttribute.description} property

src/structures/ILlmSchemaV3.ts

@@ -23,3 +23,3 @@ /**
  * Also, if you configure {@link ILlmSchemaV3.IConfig.constraint} to `false`,
- * tehse properties would be banned and written to the
+ * these properties would be banned and written to the
  * {@link ILlmSchemaV3.__IAttribute.description} property instead. It's because
@@ -294,3 +294,3 @@ * there are some LLM models which does not support the constraint properties.
      *
-     * Restriction of minumum number of items in the array.
+     * Restriction of minimum number of items in the array.
      *
@@ -472,5 +472,5 @@ * @type uint64
     /**
-     * Whether to allow contraint properties or not.
+     * Whether to allow constraint properties or not.
      *
-     * If you configure this property to `false`, the schemas do not containt
+     * If you configure this property to `false`, the schemas do not contain
      * the constraint properties of below. Instead, below properties would be
@@ -477,0 +477,0 @@ * written to the {@link ILlmSchemaV3.__IAttribute.description} property

src/structures/IOpenApiSchemaError.ts

@@ -6,7 +6,7 @@ import { OpenApi } from "../OpenApi";
  *
- * `IOpenApiSchemaError` is a type representing an error that occured during the
+ * `IOpenApiSchemaError` is a type representing an error that occurred during the
  * iteration or transformation of the OpenAPI schema (JSON schema) of
  * {@link OpenApi.IJsonSchema} type.
  *
- * The most `IOpenApiSchemaError` is occured by the transformation process from
+ * The most `IOpenApiSchemaError` is occurred by the transformation process from
  * {@link OpenApi.IJsonSchema} to {@link ILlmSchema} type. The transformation can
@@ -13,0 +13,0 @@ * be failed by following reasons:

src/typings/IResult.ts

@@ -7,3 +7,3 @@ /**
  *
- * You can distinguise the result by checking the {@link IResult.success} value,
+ * You can distinguished the result by checking the {@link IResult.success} value,
  * and if it's `true`, the success value is stored in {@link IResult.value}.
@@ -10,0 +10,0 @@ * Otherwise, if it's `false`, the error value is stored in {@link IResult.error}.

src/utils/ChatGptTypeChecker.ts

@@ -128,3 +128,3 @@ import { IChatGptSchema } from "../structures/IChatGptSchema";
    *
-   * Here is the list of occuring nested visitings:
+   * Here is the list of occurring nested visitings:
    *
@@ -131,0 +131,0 @@ * - {@link IChatGptSchema.IAnyOf.anyOf}

src/utils/GeminiTypeChecker.ts

@@ -19,3 +19,3 @@ import { IGeminiSchema } from "../structures/IGeminiSchema";
    *
-   * Here is the list of occuring nested visitings:
+   * Here is the list of occurring nested visitings:
    *
@@ -22,0 +22,0 @@ * - {@link IGeminiSchema.IObject.properties}

src/utils/LlmTypeCheckerV3_1.ts

@@ -129,3 +129,3 @@ import { ILlmSchemaV3_1 } from "../structures/ILlmSchemaV3_1";
    *
-   * Test whether the target schema is a reference type, and test one thign more
+   * Test whether the target schema is a reference type, and test one thing more
    * that the reference is self-recursive or not.
@@ -176,3 +176,3 @@ *
    *
-   * Here is the list of occuring nested visitings:
+   * Here is the list of occurring nested visitings:
    *
@@ -179,0 +179,0 @@ * - {@link ILlmSchemaV3_1.IOneOf.oneOf}

src/utils/LlmTypeCheckerV3.ts

@@ -19,3 +19,3 @@ import { ILlmSchemaV3 } from "../structures/ILlmSchemaV3";
    *
-   * Here is the list of occuring nested visitings:
+   * Here is the list of occurring nested visitings:
    *
@@ -22,0 +22,0 @@ * - {@link ILlmSchemaV3.IOneOf.oneOf}

src/utils/OpenApiTypeChecker.ts

@@ -152,3 +152,3 @@ import { OpenApi } from "../OpenApi";
    *
-   * Test whether the target schema is a reference type, and test one thign more
+   * Test whether the target schema is a reference type, and test one thing more
    * that the reference is self-recursive or not.
@@ -176,3 +176,3 @@ *
    * Escape from the {@link OpenApi.IJsonSchema.IReference} type, replacing the
-   * every references to the actual schemas. If the escape is successfull, the returned
+   * every references to the actual schemas. If the escape is successful, the returned
    * schema never contains any {@link OpenApi.IJsonSchema.IReference} type in its
@@ -236,3 +236,3 @@ * structure.
    *
-   * Here is the list of occuring nested visitings:
+   * Here is the list of occurring nested visitings:
    *
@@ -239,0 +239,0 @@ * - {@link OpenApi.IJsonSchema.IOneOf.oneOf}

No alert changes

Improved metrics

Total package byte prevSize

1807769

increased by0.1%

Number of lines in readme file

518

increased by5.07%

Worsened metrics

Lines of code

31923

decreased by-0.01%

No dependency changes