@samchon/openapi - npm Package Compare versions

Comparing version 2.2.1 to 2.3.0-dev.20241218

lib/HttpMigration.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpMigration = void 0;
-var MigrateConverter_1 = require("./composers/migrate/MigrateConverter");
+var HttpMigrateApplicationComposer_1 = require("./composers/migrate/HttpMigrateApplicationComposer");
 var HttpMigrateRouteFetcher_1 = require("./http/HttpMigrateRouteFetcher");
@@ -73,3 +73,5 @@ /**
      */
-    HttpMigration.application = function (document) { return MigrateConverter_1.MigrateConverter.convert(document); };
+    HttpMigration.application = function (document) {
+        return HttpMigrateApplicationComposer_1.HttpMigrateApplicationComposer.compose(document);
+    };
     /* -----------------------------------------------------------
@@ -76,0 +78,0 @@ FETCHERS

lib/OpenApi.d.ts

@@ -357,2 +357,31 @@ import { OpenApiV3 } from "./OpenApiV3";
         "x-samchon-human"?: boolean;
+        /**
+         * Accessor of the operation.
+         *
+         * If you configure this property, the assigned value would be used as
+         * {@link IHttpMigrateRoute.accessor}. Also, it also can be used as the
+         * {@link IHttpLlmFunction.name} by joininig with `.` character in the
+         * LLM function calling application.
+         *
+         * Note that, the `x-samchon-accessor` value must be unique in the entire
+         * OpenAPI document operations. If there're duplicated `x-samchon-accessor`
+         * values, {@link IHttpMigrateRoute.accessor} will ignore every duplicated
+         * `x-samchon-accessor` values and generate the
+         * {@link IHttpMigrateRoute.accessor} by itself.
+         */
+        "x-samchon-accessor"?: string[];
+        /**
+         * Controller of the operation.
+         *
+         * If you configure this property, the assigned value would be utilized
+         * as the controller name in the OpenAPI generator library like
+         * [`@nestia/editor`](https://nestia.io/docs/editor/) and
+         * [`@nestia/migrate`](https://nestia.io/docs/migrate/).
+         *
+         * Also, if {@link x-samchon-accessor} has been configured, its last
+         * element would be used as the controller method (function) name.
+         * Of course, the OpenAPI document generator `@nestia/sdk` fills both of
+         * them.
+         */
+        "x-samchon-controller"?: string;
     }
@@ -359,0 +388,0 @@ namespace IOperation {

package.json

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

README.md

@@ -0,0 +0,0 @@ # `@samchon/openapi`

src/composers/HttpLlmApplicationComposer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/composers/llm/ChatGptSchemaComposer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/llm/ClaudeSchemaComposer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/llm/GeminiSchemaComposer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/llm/LlamaSchemaComposer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/llm/LlmParametersComposer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/llm/LlmSchemaV3_1Composer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/llm/LlmSchemaV3Composer.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/composers/LlmSchemaComposer.ts

@@ -0,0 +0,0 @@ import { IChatGptSchema } from "../structures/IChatGptSchema";

src/converters/OpenApiV3_1Emender.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/converters/OpenApiV3Downgrader.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/converters/OpenApiV3Upgrader.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/converters/SwaggerV2Downgrader.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/converters/SwaggerV2Upgrader.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/http/HttpLlmFunctionFetcher.ts

@@ -0,0 +0,0 @@ import type { HttpLlm } from "../HttpLlm";

src/HttpLlm.ts

@@ -0,0 +0,0 @@ import { HttpMigration } from "./HttpMigration";

src/HttpMigration.ts

 import { OpenApi } from "./OpenApi";
-import { MigrateConverter } from "./composers/migrate/MigrateConverter";
+import { HttpMigrateApplicationComposer } from "./composers/migrate/HttpMigrateApplicationComposer";
 import { HttpMigrateRouteFetcher } from "./http/HttpMigrateRouteFetcher";
@@ -77,3 +77,4 @@ import { IHttpConnection } from "./structures/IHttpConnection";
     document: OpenApi.IDocument,
-  ): IHttpMigrateApplication => MigrateConverter.convert(document);
+  ): IHttpMigrateApplication =>
+    HttpMigrateApplicationComposer.compose(document);
 
@@ -80,0 +81,0 @@ /**

src/index.ts

@@ -0,0 +0,0 @@ //----

src/OpenApi.ts

@@ -454,2 +454,33 @@ import { OpenApiV3 } from "./OpenApiV3";
     "x-samchon-human"?: boolean;
+
+    /**
+     * Accessor of the operation.
+     *
+     * If you configure this property, the assigned value would be used as
+     * {@link IHttpMigrateRoute.accessor}. Also, it also can be used as the
+     * {@link IHttpLlmFunction.name} by joininig with `.` character in the
+     * LLM function calling application.
+     *
+     * Note that, the `x-samchon-accessor` value must be unique in the entire
+     * OpenAPI document operations. If there're duplicated `x-samchon-accessor`
+     * values, {@link IHttpMigrateRoute.accessor} will ignore every duplicated
+     * `x-samchon-accessor` values and generate the
+     * {@link IHttpMigrateRoute.accessor} by itself.
+     */
+    "x-samchon-accessor"?: string[];
+
+    /**
+     * Controller of the operation.
+     *
+     * If you configure this property, the assigned value would be utilized
+     * as the controller name in the OpenAPI generator library like
+     * [`@nestia/editor`](https://nestia.io/docs/editor/) and
+     * [`@nestia/migrate`](https://nestia.io/docs/migrate/).
+     *
+     * Also, if {@link x-samchon-accessor} has been configured, its last
+     * element would be used as the controller method (function) name.
+     * Of course, the OpenAPI document generator `@nestia/sdk` fills both of
+     * them.
+     */
+    "x-samchon-controller"?: string;
   }
@@ -456,0 +487,0 @@ export namespace IOperation {

src/structures/IChatGptSchema.ts

@@ -0,0 +0,0 @@ /**

src/structures/IClaudeSchema.ts

@@ -0,0 +0,0 @@ import { ILlmSchemaV3_1 } from "./ILlmSchemaV3_1";

src/structures/IHttpConnection.ts

@@ -0,0 +0,0 @@ /// <reference lib="dom" />

src/structures/IHttpLlmApplication.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/structures/IHttpLlmFunction.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/structures/IHttpMigrateApplication.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/structures/IHttpMigrateRoute.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/structures/ILlamaSchema.ts

@@ -0,0 +0,0 @@ import { ILlmSchemaV3_1 } from "./ILlmSchemaV3_1";

src/structures/ILlmApplication.ts

@@ -0,0 +0,0 @@ import { IGeminiSchema } from "./IGeminiSchema";

src/structures/ILlmFunction.ts

@@ -0,0 +0,0 @@ import { ILlmSchema } from "./ILlmSchema";

src/structures/ILlmSchema.ts

@@ -0,0 +0,0 @@ import { IChatGptSchema } from "./IChatGptSchema";

src/structures/ILlmSchemaV3_1.ts

@@ -0,0 +0,0 @@ /**

src/structures/ILlmSchemaV3.ts

@@ -0,0 +0,0 @@ /**

src/structures/IOpenApiSchemaError.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

src/typings/IResult.ts

@@ -0,0 +0,0 @@ /**

src/utils/AccessorUtil.ts

@@ -0,0 +0,0 @@ export namespace AccessorUtil {

src/utils/ChatGptTypeChecker.ts

@@ -0,0 +0,0 @@ import { IChatGptSchema } from "../structures/IChatGptSchema";

src/utils/EndpointUtil.ts

@@ -0,0 +0,0 @@ import { NamingConvention } from "./NamingConvention";

src/utils/GeminiTypeChecker.ts

@@ -0,0 +0,0 @@ import { IGeminiSchema } from "../structures/IGeminiSchema";

src/utils/internal/OpenApiTypeCheckerBase.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../../OpenApi";

src/utils/LlmDataMerger.ts

@@ -0,0 +0,0 @@ import { ILlmFunction } from "../structures/ILlmFunction";

src/utils/LlmTypeCheckerV3_1.ts

@@ -0,0 +0,0 @@ import { ILlmSchemaV3_1 } from "../structures/ILlmSchemaV3_1";

src/utils/LlmTypeCheckerV3.ts

@@ -0,0 +0,0 @@ import { ILlmSchemaV3 } from "../structures/ILlmSchemaV3";

src/utils/NamingConvention.ts

@@ -0,0 +0,0 @@ export namespace NamingConvention {

src/utils/OpenApiTypeChecker.ts

@@ -0,0 +0,0 @@ import { OpenApi } from "../OpenApi";

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1818985

increased by2.26%

Lines of code

31459

increased by0.38%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes