@rxap/workspace-open-api 19.0.3-dev.0 → 19.0.3-dev.2

package/src/lib/generate-operation-command.d.ts

@@ -1,2 +1,31 @@
 import { GenerateParameter, OpenApiSchemaBase } from './types';
+/**
+ *
+ *
+ * Asynchronously generates a TypeScript source file for an operation command based on the provided OpenAPI schema.
+ * The function constructs the file name and path from the operation ID, imports necessary modules and types,
+ * and creates a new class that extends `OpenApiOperationCommand` with appropriate decorators and methods.
+ *
+ * @param parameter - An object containing the operation ID, project reference, and additional options necessary
+ * for generating the operation command. The `GenerateParameter` type is expected to be a generic
+ * type that includes `OpenApiSchemaBase`.
+ * @returns A promise that resolves when the file has been created and all modifications are applied.
+ *
+ * The function performs the following steps:
+ * 1. Constructs the file name from the operation ID and predefined suffixes.
+ * 2. Creates a new TypeScript source file in the specified command base path.
+ * 3. Dynamically imports necessary decorators and types based on the operation's response type, parameter type,
+ * and request body type.
+ * 4. Defines a new class with the `Injectable` and `OperationCommand` decorators.
+ * - `Injectable` marks the class as a candidate for dependency injection.
+ * - `OperationCommand` configures the operation-specific metadata like server ID and operation ID.
+ * 5. Adds an `execute` method to the class, which overrides the base class method and handles the operation execution.
+ * 6. The class is structured to handle different scenarios based on whether the operation has parameters, a request body,
+ * or neither.
+ *
+ * Note: This function assumes the presence of certain global constants and functions like `COMMAND_FILE_SUFFIX`,
+ * `COMMAND_BASE_PATH`, `dasherize`, `GetResponseType`, `GetParameterType`, `GetRequestBodyType`, and
+ * `GenerateParameterToOperationObjectWithMetadata`, which are used to configure and structure the generated command class.
+ *
+ */
 export declare function GenerateOperationCommand(parameter: GenerateParameter<OpenApiSchemaBase>): Promise<void>;

package/src/lib/generate-operation-command.js

@@ -10,6 +10,35 @@ const types_1 = require("./types");
 const get_parameter_type_1 = require("./utilities/get-parameter-type");
 const get_request_body_type_1 = require("./utilities/get-request-body-type");
 const get_response_type_1 = require("./utilities/get-response-type");
+/**
+ *
+ *
+ * Asynchronously generates a TypeScript source file for an operation command based on the provided OpenAPI schema.
+ * The function constructs the file name and path from the operation ID, imports necessary modules and types,
+ * and creates a new class that extends `OpenApiOperationCommand` with appropriate decorators and methods.
+ *
+ * @param parameter - An object containing the operation ID, project reference, and additional options necessary
+ * for generating the operation command. The `GenerateParameter` type is expected to be a generic
+ * type that includes `OpenApiSchemaBase`.
+ * @returns A promise that resolves when the file has been created and all modifications are applied.
+ *
+ * The function performs the following steps:
+ * 1. Constructs the file name from the operation ID and predefined suffixes.
+ * 2. Creates a new TypeScript source file in the specified command base path.
+ * 3. Dynamically imports necessary decorators and types based on the operation's response type, parameter type,
+ * and request body type.
+ * 4. Defines a new class with the `Injectable` and `OperationCommand` decorators.
+ * - `Injectable` marks the class as a candidate for dependency injection.
+ * - `OperationCommand` configures the operation-specific metadata like server ID and operation ID.
+ * 5. Adds an `execute` method to the class, which overrides the base class method and handles the operation execution.
+ * 6. The class is structured to handle different scenarios based on whether the operation has parameters, a request body,
+ * or neither.
+ *
+ * Note: This function assumes the presence of certain global constants and functions like `COMMAND_FILE_SUFFIX`,
+ * `COMMAND_BASE_PATH`, `dasherize`, `GetResponseType`, `GetParameterType`, `GetRequestBodyType`, and
+ * `GenerateParameterToOperationObjectWithMetadata`, which are used to configure and structure the generated command class.
+ *
+ */
 function GenerateOperationCommand(parameter) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c;

package/src/lib/generate-operation-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-operation-command.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-operation-command.ts"],"names":[],"mappings":";;;;AAAA,+CAGyB;AACzB,+BAA4B;AAC5B,uCAOkB;AAClB,mCAGiB;AACjB,mCAIiB;AACjB,uEAAkE;AAClE,6EAAuE;AACvE,qEAAgE;AAEhE,SAAsB,wBAAwB,CAC5C,SAA+C;;;QAE/C,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,MAAM,IAAI,GAAG,CAAE,WAAW,EAAE,2BAAmB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,yBAAiB,EAAE,IAAA,qBAAS,EAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEhE,MAAM,gBAAgB,GAAoD;YACxE;gBACE,eAAe,EAAE,qBAAqB;gBACtC,YAAY,EAAE;oBACZ,EAAE,IAAI,EAAE,yBAAyB,EAAE;oBACnC,EAAE,IAAI,EAAE,kBAAkB,EAAE;iBAC7B;aACF;YACD;gBACE,eAAe,EAAE,gBAAgB;gBACjC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;aACzC;SACF,CAAC;QAEF,MAAM,EACJ,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,YAAY,GACnB,GAAG,IAAA,mCAAe,EAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,aAAa,GAAW,IAAA,qCAAgB,EAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,EACJ,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,eAAe,GACtB,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC;QAElC,IAAI,YAAY,EAAE,CAAC;YACjB,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAAI,gBAAiB,IAAA,qBAAS,EAC1E,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CACrC,WAAW;gBACb,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;aACzC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,CAAE,MAAM,EAAE,KAAK,CAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/C,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAAI,iBAAkB,IAAA,qBAAS,EAC3E,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CACvC,YAAY;gBACd,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAE;aAC1C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,eAAe,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAAI,qBAAsB,IAAA,qBAAS,EAC/E,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAC3C,eAAe;gBACjB,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAE;aAC5C,CAAC,CAAC;QACL,CAAC;QAED,MAAM,oBAAoB,GACxB,EAAE,CAAC;QAEL,MAAM,+BAA+B,GACnC,aAAa,KAAK,MAAM,IAAI,eAAe,KAAK,MAAM,CAAC;QAEzD,IAAI,CAAC,+BAA+B,EAAE,CAAC;YACrC,oBAAoB,CAAC,IAAI,CAAC;gBACxB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,qCAAsC,aAAc,KAAM,eAAgB,GAAG;aACpF,CAAC,CAAC;YACH,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,qBAAqB;gBACtC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAE;aAChE,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,oBAAoB,CAAC,IAAI,CAAC;gBACxB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,0CAA0C;gBAChD,WAAW,EAAE,IAAI;aAClB,CAAC,CAAC;YACH,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,qBAAqB;gBACtC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,0CAA0C,EAAE,CAAE;aACvE,CAAC,CAAC;QACL,CAAC;QAED,MAAM,cAAc,GAA4C;YAC9D,IAAI,EAAE,IAAA,oBAAQ,EAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACxC,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,YAAY;oBAClB,SAAS,EAAE,EAAE;iBACd;gBACD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,kBAAO,CAAC,MAAM,CAAC;wBACb,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAS,CAAC;wBACrD,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC;wBAClD,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,KAAK,CACL,IAAI,CAAC,SAAS,CACZ,IAAA,sDAA8C,EAAC,SAAS,CAAC,CAC1D,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAC5B;qBACJ,CAAC,CAAC,MAAM,CAAC;iBACb;aACF;YACD,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,SAAS;oBACf,UAAU,EAAE,oBAAoB;oBAChC,KAAK,EAAE,gBAAK,CAAC,MAAM;oBACnB,UAAU,EAAE,WAAY,YAAa,GAAG;oBACxC,kBAAkB,EAAE,IAAI;oBACxB,UAAU,EAAE,CAAE,mCAAmC,CAAE;iBACpD;aACF;YACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACxC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;gBAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;YACD,UAAU,EAAE,IAAI;SACjB,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAEpC,UAAU,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;CAAA;AAzID,4DAyIC"}
+{"version":3,"file":"generate-operation-command.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-operation-command.ts"],"names":[],"mappings":";;;;AAAA,+CAGyB;AACzB,+BAA4B;AAC5B,uCAOkB;AAClB,mCAGiB;AACjB,mCAIiB;AACjB,uEAAkE;AAClE,6EAAuE;AACvE,qEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAsB,wBAAwB,CAC5C,SAA+C;;;QAE/C,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,MAAM,IAAI,GAAG,CAAE,WAAW,EAAE,2BAAmB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,yBAAiB,EAAE,IAAA,qBAAS,EAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEhE,MAAM,gBAAgB,GAAoD;YACxE;gBACE,eAAe,EAAE,qBAAqB;gBACtC,YAAY,EAAE;oBACZ,EAAE,IAAI,EAAE,yBAAyB,EAAE;oBACnC,EAAE,IAAI,EAAE,kBAAkB,EAAE;iBAC7B;aACF;YACD;gBACE,eAAe,EAAE,gBAAgB;gBACjC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;aACzC;SACF,CAAC;QAEF,MAAM,EACJ,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,YAAY,GACnB,GAAG,IAAA,mCAAe,EAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,aAAa,GAAW,IAAA,qCAAgB,EAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,EACJ,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,eAAe,GACtB,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC;QAElC,IAAI,YAAY,EAAE,CAAC;YACjB,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAAI,gBAAiB,IAAA,qBAAS,EAC1E,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CACrC,WAAW;gBACb,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;aACzC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,CAAE,MAAM,EAAE,KAAK,CAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/C,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAAI,iBAAkB,IAAA,qBAAS,EAC3E,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CACvC,YAAY;gBACd,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAE;aAC1C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,eAAe,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAAI,qBAAsB,IAAA,qBAAS,EAC/E,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAC3C,eAAe;gBACjB,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAE;aAC5C,CAAC,CAAC;QACL,CAAC;QAED,MAAM,oBAAoB,GACxB,EAAE,CAAC;QAEL,MAAM,+BAA+B,GACnC,aAAa,KAAK,MAAM,IAAI,eAAe,KAAK,MAAM,CAAC;QAEzD,IAAI,CAAC,+BAA+B,EAAE,CAAC;YACrC,oBAAoB,CAAC,IAAI,CAAC;gBACxB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,qCAAsC,aAAc,KAAM,eAAgB,GAAG;aACpF,CAAC,CAAC;YACH,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,qBAAqB;gBACtC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAE;aAChE,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,oBAAoB,CAAC,IAAI,CAAC;gBACxB,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,0CAA0C;gBAChD,WAAW,EAAE,IAAI;aAClB,CAAC,CAAC;YACH,gBAAgB,CAAC,IAAI,CAAC;gBACpB,eAAe,EAAE,qBAAqB;gBACtC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,0CAA0C,EAAE,CAAE;aACvE,CAAC,CAAC;QACL,CAAC;QAED,MAAM,cAAc,GAA4C;YAC9D,IAAI,EAAE,IAAA,oBAAQ,EAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACxC,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,YAAY;oBAClB,SAAS,EAAE,EAAE;iBACd;gBACD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,kBAAO,CAAC,MAAM,CAAC;wBACb,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAS,CAAC;wBACrD,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC;wBAClD,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,KAAK,CACL,IAAI,CAAC,SAAS,CACZ,IAAA,sDAA8C,EAAC,SAAS,CAAC,CAC1D,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAC5B;qBACJ,CAAC,CAAC,MAAM,CAAC;iBACb;aACF;YACD,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,SAAS;oBACf,UAAU,EAAE,oBAAoB;oBAChC,KAAK,EAAE,gBAAK,CAAC,MAAM;oBACnB,UAAU,EAAE,WAAY,YAAa,GAAG;oBACxC,kBAAkB,EAAE,IAAI;oBACxB,UAAU,EAAE,CAAE,mCAAmC,CAAE;iBACpD;aACF;YACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACxC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;gBAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;YACD,UAAU,EAAE,IAAI;SACjB,CAAC;QAEF,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAEpC,UAAU,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;CAAA;AAzID,4DAyIC"}

package/src/lib/generate-operation.d.ts

@@ -1,4 +1,24 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { Project } from 'ts-morph';
 import { GeneratorFunction, OpenApiSchemaBase } from './types';
+/**
+ * Processes and generates operations based on the provided OpenAPI specification.
+ *
+ * This function iterates over each path and method in the OpenAPI document, executing a list of generator functions
+ * for operations that are not marked as 'hidden' and have an operation ID. It handles the generation of API operations
+ * by utilizing custom generator functions provided by the user, which can manipulate or utilize the operation data.
+ *
+ * @param openapi - The OpenAPI version 3 document which contains the API specification.
+ * @param project - The project context in which the operations are being generated.
+ * @param options - Configuration options specific to the generation process, extending from a base schema.
+ * @param generatorFunctionList - An array of generator functions that take the operation data and perform tasks such as code generation.
+ *
+ * @typeParam Options - A generic type parameter extending from `OpenApiSchemaBase` which dictates the shape of the options parameter.
+ *
+ * @remarks
+ * - The function logs a message for operations marked as 'hidden'.
+ * - It warns if an operation does not have an operation ID.
+ * - The function assumes the presence of either `components` or `definitions` in the OpenAPI document for schema references.
+ * - It filters out non-HTTP methods from the paths object, ensuring that only valid HTTP operations are processed.
+ */
 export declare function GenerateOperation<Options extends OpenApiSchemaBase = OpenApiSchemaBase>(openapi: OpenAPIV3.Document, project: Project, options: Options, generatorFunctionList: GeneratorFunction<Options>[]): void;

package/src/lib/generate-operation.js

@@ -5,6 +5,27 @@ const types_1 = require("./types");
 const ignore_operation_1 = require("./utilities/ignore-operation");
 const is_http_method_1 = require("./utilities/is-http-method");
 const is_operation_object_1 = require("./utilities/is-operation-object");
+/**
+ * Executes a generator function with the provided parameters to handle OpenAPI operations.
+ *
+ * This function is designed to execute a specific generator function that processes OpenAPI operations
+ * based on the provided project, options, path, method, components, and operation details. It constructs
+ * a parameter object that aggregates all these inputs and passes it to the generator function. If the
+ * generator function fails, it logs an error message detailing the failure.
+ *
+ * @param project - The project context in which the generator operates.
+ * @param options - Configuration options specific to the generator, constrained by OpenApiSchemaBase.
+ * @param path - The API path that is associated with the operation (e.g., '/users/{userId}').
+ * @param method - The HTTP method (e.g., 'GET', 'POST') for the operation.
+ * @param generatorFunction - The generator function to be executed. It should accept a single argument
+ * of type GenerateParameter<Options>.
+ * @param components - The OpenAPI components object that may include schemas, responses, parameters, etc.
+ * @param operation - The specific OpenAPI operation object that the generator will process.
+ *
+ * @template Options - A type parameter that extends OpenApiSchemaBase, used to type the options parameter.
+ *
+ * @throws Will log an error if the generator function throws an exception during execution.
+ */
 function executeGenerator(project, options, path, method, generatorFunction, components, operation) {
     try {
         const parameters = Object.assign(Object.assign({}, operation), { components,
@@ -18,6 +39,26 @@ function executeGenerator(project, options, path, method, generatorFunction, com
         console.error(`Failed to generate [${generatorFunction === null || generatorFunction === void 0 ? void 0 : generatorFunction.name}] for operation: ${operation.operationId}: ${e.message}`);
     }
 }
+/**
+ * Processes and generates operations based on the provided OpenAPI specification.
+ *
+ * This function iterates over each path and method in the OpenAPI document, executing a list of generator functions
+ * for operations that are not marked as 'hidden' and have an operation ID. It handles the generation of API operations
+ * by utilizing custom generator functions provided by the user, which can manipulate or utilize the operation data.
+ *
+ * @param openapi - The OpenAPI version 3 document which contains the API specification.
+ * @param project - The project context in which the operations are being generated.
+ * @param options - Configuration options specific to the generation process, extending from a base schema.
+ * @param generatorFunctionList - An array of generator functions that take the operation data and perform tasks such as code generation.
+ *
+ * @typeParam Options - A generic type parameter extending from `OpenApiSchemaBase` which dictates the shape of the options parameter.
+ *
+ * @remarks
+ * - The function logs a message for operations marked as 'hidden'.
+ * - It warns if an operation does not have an operation ID.
+ * - The function assumes the presence of either `components` or `definitions` in the OpenAPI document for schema references.
+ * - It filters out non-HTTP methods from the paths object, ensuring that only valid HTTP operations are processed.
+ */
 function GenerateOperation(openapi, project, options, generatorFunctionList) {
     var _a, _b;
     const components = (_b = (_a = openapi.components) !== null && _a !== void 0 ? _a : openapi.definitions) !== null && _b !== void 0 ? _b : {};

package/src/lib/generate-operation.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-operation.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-operation.ts"],"names":[],"mappings":";;;AAEA,mCAMiB;AACjB,mEAA+D;AAC/D,+DAA0D;AAC1D,yEAAoE;AAEpE,SAAS,gBAAgB,CACvB,OAAgB,EAChB,OAAgB,EAChB,IAAY,EACZ,MAAc,EACd,iBAA6C,EAC7C,UAAsC,EACtC,SAA0B;IAE1B,IAAI,CAAC;QACH,MAAM,UAAU,mCACX,SAAS,KACZ,UAAU;YACV,MAAM;YACN,IAAI;YACJ,OAAO;YACP,OAAO,GACR,CAAC;QACF,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,uBAAwB,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,IAAK,oBAAqB,SAAS,CAAC,WAAY,KAAM,CAAC,CAAC,OAAQ,EAAE,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAC/B,OAA2B,EAC3B,OAAgB,EAChB,OAAgB,EAChB,qBAAmD;;IAEnD,MAAM,UAAU,GAA+B,MAAA,MAAC,OAAe,CAAC,UAAU,mCAAK,OAAe,CAAC,WAAW,mCAAI,EAAE,CAAC;IAEjH,KAAK,MAAM,CAAE,IAAI,EAAE,OAAO,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAE9D,IAAI,OAAO,EAAE,CAAC;YAEZ,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,6BAAY,CAAC,EAAE,CAAC;gBAE/D,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;gBAElC,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;oBAEjC,IAAI,IAAA,kCAAe,EAAC,CAAE,QAAQ,CAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;wBAE7C,OAAO,CAAC,GAAG,CAAC,qBAAsB,SAAS,CAAC,WAAY,GAAG,CAAC,CAAC;oBAE/D,CAAC;yBAAM,CAAC;wBAEN,IAAI,IAAA,sBAAc,EAAC,SAAS,CAAC,EAAE,CAAC;4BAE9B,KAAK,MAAM,iBAAiB,IAAI,qBAAqB,EAAE,CAAC;gCAEtD,gBAAgB,CACd,OAAO,EACP,OAAO,EACP,IAAI,EACJ,MAAM,EACN,iBAAiB,EACjB,UAAU,EACV,SAAS,CACV,CAAC;4BAEJ,CAAC;wBAEH,CAAC;6BAAM,CAAC;4BACN,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;wBAC5D,CAAC;oBAEH,CAAC;gBAEH,CAAC;YAEH,CAAC;QAEH,CAAC;IAEH,CAAC;AAEH,CAAC;AAtDD,8CAsDC"}
+{"version":3,"file":"generate-operation.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-operation.ts"],"names":[],"mappings":";;;AAEA,mCAMiB;AACjB,mEAA+D;AAC/D,+DAA0D;AAC1D,yEAAoE;AAEpE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,gBAAgB,CACvB,OAAgB,EAChB,OAAgB,EAChB,IAAY,EACZ,MAAc,EACd,iBAA6C,EAC7C,UAAsC,EACtC,SAA0B;IAE1B,IAAI,CAAC;QACH,MAAM,UAAU,mCACX,SAAS,KACZ,UAAU;YACV,MAAM;YACN,IAAI;YACJ,OAAO;YACP,OAAO,GACR,CAAC;QACF,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,uBAAwB,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,IAAK,oBAAqB,SAAS,CAAC,WAAY,KAAM,CAAC,CAAC,OAAQ,EAAE,CAAC,CAAC;IAC/H,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,iBAAiB,CAC/B,OAA2B,EAC3B,OAAgB,EAChB,OAAgB,EAChB,qBAAmD;;IAEnD,MAAM,UAAU,GAA+B,MAAA,MAAC,OAAe,CAAC,UAAU,mCAAK,OAAe,CAAC,WAAW,mCAAI,EAAE,CAAC;IAEjH,KAAK,MAAM,CAAE,IAAI,EAAE,OAAO,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAE9D,IAAI,OAAO,EAAE,CAAC;YAEZ,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,6BAAY,CAAC,EAAE,CAAC;gBAE/D,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;gBAElC,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;oBAEjC,IAAI,IAAA,kCAAe,EAAC,CAAE,QAAQ,CAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;wBAE7C,OAAO,CAAC,GAAG,CAAC,qBAAsB,SAAS,CAAC,WAAY,GAAG,CAAC,CAAC;oBAE/D,CAAC;yBAAM,CAAC;wBAEN,IAAI,IAAA,sBAAc,EAAC,SAAS,CAAC,EAAE,CAAC;4BAE9B,KAAK,MAAM,iBAAiB,IAAI,qBAAqB,EAAE,CAAC;gCAEtD,gBAAgB,CACd,OAAO,EACP,OAAO,EACP,IAAI,EACJ,MAAM,EACN,iBAAiB,EACjB,UAAU,EACV,SAAS,CACV,CAAC;4BAEJ,CAAC;wBAEH,CAAC;6BAAM,CAAC;4BACN,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;wBAC5D,CAAC;oBAEH,CAAC;gBAEH,CAAC;YAEH,CAAC;QAEH,CAAC;IAEH,CAAC;AAEH,CAAC;AAtDD,8CAsDC"}

package/src/lib/generate-parameters.d.ts

@@ -1,3 +1,30 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { Project } from 'ts-morph';
+/**
+ * Generates TypeScript interfaces for the parameters of a given OpenAPI operation object.
+ * This function processes the parameters of the operation, excluding those in the 'header',
+ * and generates TypeScript interfaces using the TypescriptInterfaceGenerator.
+ *
+ * @param operation - The OpenAPI operation object containing details about the API operation.
+ * @param project - The project context in which the interfaces are generated.
+ * @param components - The OpenAPI components object used for resolving any $ref references in the parameters.
+ *
+ * @remarks
+ * This function filters out header parameters and processes only path, query, and cookie parameters.
+ * It handles both direct parameter objects and referenced objects found in the components section of the OpenAPI spec.
+ * If a referenced object is encountered, it resolves the reference and includes the resolved object in the parameter list.
+ * The function throws errors if references are incorrectly formatted or unresolved.
+ *
+ * The function constructs a schema object that describes the structure of the parameters using the properties and required fields.
+ * This schema object is then used by the TypescriptInterfaceGenerator to generate the appropriate TypeScript interfaces.
+ *
+ * Errors during the generation process are logged to the console.
+ *
+ * @example
+ * // Assuming operation, project, and components are already defined:
+ * GenerateParameters(operation, project, components);
+ *
+ * @throws {Error} If the $ref is malformed or cannot be resolved within the components object.
+ * @throws {Error} If reference objects are still present after processing, indicating unresolved references.
+ */
 export declare function GenerateParameters(operation: OpenAPIV3.OperationObject, project: Project, components: OpenAPIV3.ComponentsObject): void;

package/src/lib/generate-parameters.js

@@ -4,6 +4,33 @@ exports.GenerateParameters = void 0;
 const json_schema_to_typescript_1 = require("@rxap/json-schema-to-typescript");
 const config_1 = require("./config");
 const is_reference_object_1 = require("./utilities/is-reference-object");
+/**
+ * Generates TypeScript interfaces for the parameters of a given OpenAPI operation object.
+ * This function processes the parameters of the operation, excluding those in the 'header',
+ * and generates TypeScript interfaces using the TypescriptInterfaceGenerator.
+ *
+ * @param operation - The OpenAPI operation object containing details about the API operation.
+ * @param project - The project context in which the interfaces are generated.
+ * @param components - The OpenAPI components object used for resolving any $ref references in the parameters.
+ *
+ * @remarks
+ * This function filters out header parameters and processes only path, query, and cookie parameters.
+ * It handles both direct parameter objects and referenced objects found in the components section of the OpenAPI spec.
+ * If a referenced object is encountered, it resolves the reference and includes the resolved object in the parameter list.
+ * The function throws errors if references are incorrectly formatted or unresolved.
+ *
+ * The function constructs a schema object that describes the structure of the parameters using the properties and required fields.
+ * This schema object is then used by the TypescriptInterfaceGenerator to generate the appropriate TypeScript interfaces.
+ *
+ * Errors during the generation process are logged to the console.
+ *
+ * @example
+ * // Assuming operation, project, and components are already defined:
+ * GenerateParameters(operation, project, components);
+ *
+ * @throws {Error} If the $ref is malformed or cannot be resolved within the components object.
+ * @throws {Error} If reference objects are still present after processing, indicating unresolved references.
+ */
 function GenerateParameters(operation, project, components) {
     var _a;
     if (operation.parameters && operation.parameters.length && operation.operationId) {

package/src/lib/generate-parameters.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-parameters.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-parameters.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAG/E,qCAGkB;AAElB,yEAAoE;AAEpE,SAAgB,kBAAkB,CAChC,SAAoC,EACpC,OAAgB,EAChB,UAAsC;;IAGtC,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAEjF,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,MAAM,UAAU,GAAyF,EAAE,CAAC;QAC5G,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAA,uCAAiB,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;QAE5G,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,IAAA,uCAAiB,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACvF,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;gBACjC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC;gBAC3B,MAAM,QAAQ,GAAa,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC1C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACjC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC9B,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,GAAG,CAAC,CAAC;gBACjD,CAAC;gBACD,IAAI,iBAAiB,KAAK,YAAY,EAAE,CAAC;oBACvC,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,GAAG,CAAC,CAAC;gBACjD,CAAC;gBACD,IAAI,CAAC,KAAK,IAAI,CAAE,UAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1C,MAAM,IAAI,KAAK,CAAC,UAAW,KAAM,uDAAwD,GAAI,EAAE,CAAC,CAAC;gBACnG,CAAC;gBACD,MAAM,SAAS,GAAI,UAAkB,CAAC,KAAK,CAAC,CAAC;gBAC7C,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,mBAAoB,IAAK,eAAgB,KAAM,cAAe,GAAI,EAAE,CAAC,CAAC;gBACxF,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAA,uCAAiB,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YAEnC,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;YAC5F,CAAC;YAED,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,MAAA,SAAS,CAAC,MAAM,mCAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAEjE,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;gBACvB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;QAEH,CAAC;QAED,MAAM,gBAAgB,GAA2B;YAC/C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,UAAiB;YAC7B,QAAQ;SACT,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,wDAA4B,iCAE3C,gBAAgB,KACnB,UAAU,KAEZ;YACE,MAAM,EAAE,8BAAqB;YAC7B,QAAQ,EAAE,4BAAmB;YAC7B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;QAEF,OAAO,CAAC,KAAK,CAAC,qCAAsC,WAAY,EAAE,CAAC,CAAC;QAEpE,IAAI,CAAC;YAEH,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAEnC,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,+CAAgD,WAAY,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/F,CAAC;IAEH,CAAC;AAEH,CAAC;AAzFD,gDAyFC"}
+{"version":3,"file":"generate-parameters.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-parameters.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAG/E,qCAGkB;AAElB,yEAAoE;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,kBAAkB,CAChC,SAAoC,EACpC,OAAgB,EAChB,UAAsC;;IAGtC,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAEjF,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,MAAM,UAAU,GAAyF,EAAE,CAAC;QAC5G,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAA,uCAAiB,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;QAE5G,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,IAAA,uCAAiB,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACvF,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;gBACjC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC;gBAC3B,MAAM,QAAQ,GAAa,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC1C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBACjC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC9B,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,GAAG,CAAC,CAAC;gBACjD,CAAC;gBACD,IAAI,iBAAiB,KAAK,YAAY,EAAE,CAAC;oBACvC,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,GAAG,CAAC,CAAC;gBACjD,CAAC;gBACD,IAAI,CAAC,KAAK,IAAI,CAAE,UAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1C,MAAM,IAAI,KAAK,CAAC,UAAW,KAAM,uDAAwD,GAAI,EAAE,CAAC,CAAC;gBACnG,CAAC;gBACD,MAAM,SAAS,GAAI,UAAkB,CAAC,KAAK,CAAC,CAAC;gBAC7C,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,mBAAoB,IAAK,eAAgB,KAAM,cAAe,GAAI,EAAE,CAAC,CAAC;gBACxF,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAA,uCAAiB,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YAEnC,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;YAC5F,CAAC;YAED,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,MAAA,SAAS,CAAC,MAAM,mCAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAEjE,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;gBACvB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;QAEH,CAAC;QAED,MAAM,gBAAgB,GAA2B;YAC/C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,UAAiB;YAC7B,QAAQ;SACT,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,wDAA4B,iCAE3C,gBAAgB,KACnB,UAAU,KAEZ;YACE,MAAM,EAAE,8BAAqB;YAC7B,QAAQ,EAAE,4BAAmB;YAC7B,UAAU,EAAE,IAAI;SACjB,EACD,OAAO,CACR,CAAC;QAEF,OAAO,CAAC,KAAK,CAAC,qCAAsC,WAAY,EAAE,CAAC,CAAC;QAEpE,IAAI,CAAC;YAEH,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAEnC,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,+CAAgD,WAAY,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/F,CAAC;IAEH,CAAC;AAEH,CAAC;AAzFD,gDAyFC"}

package/src/lib/generate-remote-method.d.ts

@@ -1,2 +1,27 @@
 import { GenerateParameter, OpenApiSchemaBase } from './types';
+/**
+ *
+ *
+ * Generates a TypeScript source file for a remote method based on the provided OpenAPI schema.
+ * This function constructs a class that extends `OpenApiRemoteMethod` and is decorated with `Injectable` and `RxapOpenApiRemoteMethod`.
+ * The generated class includes a `call` method that can be used to execute the remote method.
+ *
+ * @param parameter - An object containing options and metadata necessary for generating the remote method.
+ * The `parameter` object must include:
+ * - `operationId`: A unique identifier for the operation.
+ * - `project`: A project within which the source file will be created.
+ * - `options`: Additional options such as `serverId` and `packageName` for customizing the generated method.
+ *
+ * The function performs the following steps:
+ * 1. Constructs the file name from the `operationId` and predefined suffixes.
+ * 2. Creates a new TypeScript source file in the specified project.
+ * 3. Dynamically constructs import statements based on the response type, parameter type, and request body type.
+ * 4. Defines a class that extends `OpenApiRemoteMethod` with appropriate type parameters and decorators.
+ * 5. Adds a `call` method to the class, which overrides the base method to execute the remote operation.
+ * 6. Organizes imports and ensures proper formatting of the generated source file.
+ *
+ * The generated class is decorated with `@Injectable` to facilitate its usage within Angular's dependency injection system,
+ * and `@RxapOpenApiRemoteMethod` to configure it with metadata about the remote operation.
+ *
+ */
 export declare function GenerateRemoteMethod(parameter: GenerateParameter<OpenApiSchemaBase>): void;

package/src/lib/generate-remote-method.js

@@ -11,6 +11,31 @@ const get_request_body_type_1 = require("./utilities/get-request-body-type");
 const get_response_type_1 = require("./utilities/get-response-type");
 const get_type_parameters_1 = require("./utilities/get-type-parameters");
 const { dasherize, classify, } = core_1.strings;
+/**
+ *
+ *
+ * Generates a TypeScript source file for a remote method based on the provided OpenAPI schema.
+ * This function constructs a class that extends `OpenApiRemoteMethod` and is decorated with `Injectable` and `RxapOpenApiRemoteMethod`.
+ * The generated class includes a `call` method that can be used to execute the remote method.
+ *
+ * @param parameter - An object containing options and metadata necessary for generating the remote method.
+ * The `parameter` object must include:
+ * - `operationId`: A unique identifier for the operation.
+ * - `project`: A project within which the source file will be created.
+ * - `options`: Additional options such as `serverId` and `packageName` for customizing the generated method.
+ *
+ * The function performs the following steps:
+ * 1. Constructs the file name from the `operationId` and predefined suffixes.
+ * 2. Creates a new TypeScript source file in the specified project.
+ * 3. Dynamically constructs import statements based on the response type, parameter type, and request body type.
+ * 4. Defines a class that extends `OpenApiRemoteMethod` with appropriate type parameters and decorators.
+ * 5. Adds a `call` method to the class, which overrides the base method to execute the remote operation.
+ * 6. Organizes imports and ensures proper formatting of the generated source file.
+ *
+ * The generated class is decorated with `@Injectable` to facilitate its usage within Angular's dependency injection system,
+ * and `@RxapOpenApiRemoteMethod` to configure it with metadata about the remote operation.
+ *
+ */
 function GenerateRemoteMethod(parameter) {
     var _a, _b, _c;
     const operationId = parameter.operationId;

package/src/lib/generate-remote-method.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-remote-method.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-remote-method.ts"],"names":[],"mappings":";;;AAAA,+CAA+C;AAC/C,+BAA4B;AAC5B,uCAOkB;AAClB,mCAGiB;AACjB,mCAIiB;AACjB,uEAAkE;AAClE,6EAAuE;AACvE,qEAAgE;AAChE,yEAAoE;AAEpE,MAAM,EACJ,SAAS,EACT,QAAQ,GACT,GAAG,cAAO,CAAC;AAEZ,SAAgB,oBAAoB,CAAC,SAA+C;;IAClF,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAE1C,MAAM,IAAI,GAAG,CAAE,WAAW,EAAE,iCAAyB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,+BAAuB,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAExE,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAEhE,MAAM,gBAAgB,GAAoD;QACxE;YACE,eAAe,EAAE,8BAA8B;YAC/C,YAAY,EAAE;gBACZ,EAAE,IAAI,EAAE,yBAAyB,EAAE,EAAE,EAAE,IAAI,EAAE,8BAA8B,EAAE;aAC9E;SACF,EAAE;YACD,eAAe,EAAE,eAAe;YAChC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;SACzC;KACF,CAAC;IAEF,gBAAgB,CAAC,IAAI,CAAC;QACpB,eAAe,EAAE,8BAA8B;QAC/C,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAE;KAClD,CAAC,CAAC;IAEH,MAAM,EACJ,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,YAAY,GACnB,GAAG,IAAA,mCAAe,EAAC,SAAS,CAAC,CAAC;IAC/B,MAAM,aAAa,GAAW,IAAA,qCAAgB,EAAC,SAAS,CAAC,CAAC;IAC1D,MAAM,EACJ,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,eAAe,GACtB,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC;IAElC,IAAI,YAAY,EAAE,CAAC;QACjB,gBAAgB,CAAC,IAAI,CAAC;YACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAC5C,gBAAiB,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAE,WAAW;YAC/E,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;SACzC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,CAAE,MAAM,EAAE,KAAK,CAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/C,gBAAgB,CAAC,IAAI,CAAC;YACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAC5C,iBAAkB,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAE,YAAY;YACnF,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAE;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QACpB,gBAAgB,CAAC,IAAI,CAAC;YACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAC5C,qBAAsB,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAE,eAAe;YAC9F,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAED,MAAM,oBAAoB,GAAkD,EAAE,CAAC;IAE/E,MAAM,+BAA+B,GAAG,aAAa,KAAK,MAAM,IAAI,eAAe,KAAK,MAAM,CAAC;IAE/F,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACrC,oBAAoB,CAAC,IAAI,CAAC;YACxB,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,gCAAiC,aAAc,KAAM,eAAgB,GAAG;SAC/E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,cAAc,GAA4C;QAC9D,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACxC,cAAc,EAAE,IAAA,uCAAiB,EAAC,SAAS,CAAC;QAC5C,UAAU,EAAE;YACV;gBACE,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE,kBAAO,CAAC,MAAM,CAAC;oBACxB,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;iBAC7C,CAAC;aACH,EAAE;gBACD,IAAI,EAAE,yBAAyB;gBAC/B,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAO,CAAC,MAAM,CAAC;oBACpC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAS,CAAC,CAAC,CAAC,CAAC,WAAW;oBAC9F,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC;oBAChD,SAAS,EAAE,CAAC,CAAC,EAAE;wBACb,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBACb,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAA,sDAA8C,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;wBACjG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACf,CAAC;iBACF,CAAC,CAAC,MAAM,CAAC;aACX;SACF;QACD,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE,oBAAoB;gBAChC,KAAK,EAAE,gBAAK,CAAC,MAAM;gBACnB,UAAU,EAAE,WAAY,YAAa,GAAG;gBACxC,kBAAkB,EAAE,IAAI;gBACxB,UAAU,EAAE;oBACV,qBAAsB,+BAA+B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAa,IAAI;iBAC/E;aACF;SACF;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;YAClB,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAClB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;QACD,UAAU,EAAE,IAAI;KACjB,CAAC;IAEF,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAEpC,UAAU,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IAEnD,UAAU,CAAC,eAAe,CAAC;QACzB,wBAAwB,EAAE,IAAI;KAC/B,CAAC,CAAC;AACL,CAAC;AA5HD,oDA4HC"}
+{"version":3,"file":"generate-remote-method.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-remote-method.ts"],"names":[],"mappings":";;;AAAA,+CAA+C;AAC/C,+BAA4B;AAC5B,uCAOkB;AAClB,mCAGiB;AACjB,mCAIiB;AACjB,uEAAkE;AAClE,6EAAuE;AACvE,qEAAgE;AAChE,yEAAoE;AAEpE,MAAM,EACJ,SAAS,EACT,QAAQ,GACT,GAAG,cAAO,CAAC;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,oBAAoB,CAAC,SAA+C;;IAClF,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAE1C,MAAM,IAAI,GAAG,CAAE,WAAW,EAAE,iCAAyB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,+BAAuB,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAExE,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAEhE,MAAM,gBAAgB,GAAoD;QACxE;YACE,eAAe,EAAE,8BAA8B;YAC/C,YAAY,EAAE;gBACZ,EAAE,IAAI,EAAE,yBAAyB,EAAE,EAAE,EAAE,IAAI,EAAE,8BAA8B,EAAE;aAC9E;SACF,EAAE;YACD,eAAe,EAAE,eAAe;YAChC,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;SACzC;KACF,CAAC;IAEF,gBAAgB,CAAC,IAAI,CAAC;QACpB,eAAe,EAAE,8BAA8B;QAC/C,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAE;KAClD,CAAC,CAAC;IAEH,MAAM,EACJ,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,YAAY,GACnB,GAAG,IAAA,mCAAe,EAAC,SAAS,CAAC,CAAC;IAC/B,MAAM,aAAa,GAAW,IAAA,qCAAgB,EAAC,SAAS,CAAC,CAAC;IAC1D,MAAM,EACJ,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,eAAe,GACtB,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC;IAElC,IAAI,YAAY,EAAE,CAAC;QACjB,gBAAgB,CAAC,IAAI,CAAC;YACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAC5C,gBAAiB,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAE,WAAW;YAC/E,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAE;SACzC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,CAAE,MAAM,EAAE,KAAK,CAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/C,gBAAgB,CAAC,IAAI,CAAC;YACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAC5C,iBAAkB,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAE,YAAY;YACnF,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAE;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QACpB,gBAAgB,CAAC,IAAI,CAAC;YACpB,eAAe,EAAE,MAAA,SAAS,CAAC,OAAO,CAAC,WAAW,mCAC5C,qBAAsB,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAE,eAAe;YAC9F,YAAY,EAAE,CAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAED,MAAM,oBAAoB,GAAkD,EAAE,CAAC;IAE/E,MAAM,+BAA+B,GAAG,aAAa,KAAK,MAAM,IAAI,eAAe,KAAK,MAAM,CAAC;IAE/F,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACrC,oBAAoB,CAAC,IAAI,CAAC;YACxB,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,gCAAiC,aAAc,KAAM,eAAgB,GAAG;SAC/E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,cAAc,GAA4C;QAC9D,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACxC,cAAc,EAAE,IAAA,uCAAiB,EAAC,SAAS,CAAC;QAC5C,UAAU,EAAE;YACV;gBACE,IAAI,EAAE,YAAY;gBAClB,SAAS,EAAE,kBAAO,CAAC,MAAM,CAAC;oBACxB,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;iBAC7C,CAAC;aACH,EAAE;gBACD,IAAI,EAAE,yBAAyB;gBAC/B,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAO,CAAC,MAAM,CAAC;oBACpC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAS,CAAC,CAAC,CAAC,CAAC,WAAW;oBAC9F,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC;oBAChD,SAAS,EAAE,CAAC,CAAC,EAAE;wBACb,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBACb,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAA,sDAA8C,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;wBACjG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACf,CAAC;iBACF,CAAC,CAAC,MAAM,CAAC;aACX;SACF;QACD,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE,oBAAoB;gBAChC,KAAK,EAAE,gBAAK,CAAC,MAAM;gBACnB,UAAU,EAAE,WAAY,YAAa,GAAG;gBACxC,kBAAkB,EAAE,IAAI;gBACxB,UAAU,EAAE;oBACV,qBAAsB,+BAA+B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAa,IAAI;iBAC/E;aACF;SACF;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;YAClB,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAClB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnB,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;QACD,UAAU,EAAE,IAAI;KACjB,CAAC;IAEF,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAEpC,UAAU,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IAEnD,UAAU,CAAC,eAAe,CAAC;QACzB,wBAAwB,EAAE,IAAI;KAC/B,CAAC,CAAC;AACL,CAAC;AA5HD,oDA4HC"}

package/src/lib/generate-request-body.d.ts

@@ -1,3 +1,19 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { Project } from 'ts-morph';
+/**
+ * Generates TypeScript interfaces or type aliases for the request body of an API operation defined in an OpenAPI specification.
+ *
+ * This function examines the `operation` object to determine the schema of the request body. Depending on the type of schema
+ * (reference, array of references, or a direct schema object), it either generates a type alias directly from the reference
+ * or invokes a TypeScript interface generator to create interfaces.
+ *
+ * If the schema is a reference or an array of references, the function will log a debug message and create a type alias
+ * in the specified project directory. If the schema is a direct object, it will use the `TypescriptInterfaceGenerator` to
+ * generate and build the interface synchronously, handling any errors that occur during the generation process.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object containing the request body definition.
+ * @param {Project} project - The TypeScript project where the generated files will be added.
+ * @param {OpenAPIV3.ComponentsObject} components - The OpenAPI components object used for resolving `$ref` references within schemas.
+ *
+ */
 export declare function GenerateRequestBody(operation: OpenAPIV3.OperationObject, project: Project, components: OpenAPIV3.ComponentsObject): void;

package/src/lib/generate-request-body.js

@@ -7,6 +7,22 @@ const any_schema_object_1 = require("./utilities/any-schema-object");
 const create_component_type_alias_source_file_1 = require("./utilities/create-component-type-alias-source-file");
 const get_reqeust_body_1 = require("./utilities/get-reqeust-body");
 const ref_schema_object_1 = require("./utilities/ref-schema-object");
+/**
+ * Generates TypeScript interfaces or type aliases for the request body of an API operation defined in an OpenAPI specification.
+ *
+ * This function examines the `operation` object to determine the schema of the request body. Depending on the type of schema
+ * (reference, array of references, or a direct schema object), it either generates a type alias directly from the reference
+ * or invokes a TypeScript interface generator to create interfaces.
+ *
+ * If the schema is a reference or an array of references, the function will log a debug message and create a type alias
+ * in the specified project directory. If the schema is a direct object, it will use the `TypescriptInterfaceGenerator` to
+ * generate and build the interface synchronously, handling any errors that occur during the generation process.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object containing the request body definition.
+ * @param {Project} project - The TypeScript project where the generated files will be added.
+ * @param {OpenAPIV3.ComponentsObject} components - The OpenAPI components object used for resolving `$ref` references within schemas.
+ *
+ */
 function GenerateRequestBody(operation, project, components) {
     const requestBodySchema = (0, get_reqeust_body_1.GetRequestBody)(operation);
     if (requestBodySchema && !(0, any_schema_object_1.IsAnySchemaObject)(requestBodySchema) && operation.operationId) {

package/src/lib/generate-request-body.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-request-body.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-request-body.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAG/E,qCAGkB;AAClB,qEAAkE;AAClE,iHAAyG;AACzG,mEAA8D;AAC9D,qEAGuC;AAEvC,SAAgB,mBAAmB,CACjC,SAAoC,EACpC,OAAgB,EAChB,UAAsC;IAGtC,MAAM,iBAAiB,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;IAEpD,IAAI,iBAAiB,IAAI,CAAC,IAAA,qCAAiB,EAAC,iBAAiB,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QACxF,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,IAAI,IAAA,qCAAiB,EAAC,iBAAiB,CAAC,IAAI,IAAA,0CAAsB,EAAC,iBAAiB,CAAC,EAAE,CAAC;YAEtF,OAAO,CAAC,KAAK,CAAC,+CAAgD,WAAY,EAAE,CAAC,CAAC;YAE9E,IAAA,4EAAkC,EAChC,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,+BAAsB,EACtB,iCAAwB,CACzB,CAAC;QAEJ,CAAC;aAAM,CAAC;YAEN,MAAM,SAAS,GAAG,IAAI,wDAA4B,iCAE3C,iBAAiB,KACpB,UAAU,KAEZ;gBACE,MAAM,EAAE,iCAAwB;gBAChC,QAAQ,EAAE,+BAAsB;gBAChC,UAAU,EAAE,IAAI;aACjB,EACD,OAAO,CACR,CAAC;YAEF,OAAO,CAAC,KAAK,CAAC,wCAAyC,WAAY,EAAE,CAAC,CAAC;YAEvE,IAAI,CAAC;gBAEH,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAEnC,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,kDAAmD,WAAY,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAClG,CAAC;QAEH,CAAC;IAEH,CAAC;AAEH,CAAC;AApDD,kDAoDC"}
+{"version":3,"file":"generate-request-body.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-request-body.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAG/E,qCAGkB;AAClB,qEAAkE;AAClE,iHAAyG;AACzG,mEAA8D;AAC9D,qEAGuC;AAEvC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CACjC,SAAoC,EACpC,OAAgB,EAChB,UAAsC;IAGtC,MAAM,iBAAiB,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;IAEpD,IAAI,iBAAiB,IAAI,CAAC,IAAA,qCAAiB,EAAC,iBAAiB,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QACxF,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,IAAI,IAAA,qCAAiB,EAAC,iBAAiB,CAAC,IAAI,IAAA,0CAAsB,EAAC,iBAAiB,CAAC,EAAE,CAAC;YAEtF,OAAO,CAAC,KAAK,CAAC,+CAAgD,WAAY,EAAE,CAAC,CAAC;YAE9E,IAAA,4EAAkC,EAChC,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,+BAAsB,EACtB,iCAAwB,CACzB,CAAC;QAEJ,CAAC;aAAM,CAAC;YAEN,MAAM,SAAS,GAAG,IAAI,wDAA4B,iCAE3C,iBAAiB,KACpB,UAAU,KAEZ;gBACE,MAAM,EAAE,iCAAwB;gBAChC,QAAQ,EAAE,+BAAsB;gBAChC,UAAU,EAAE,IAAI;aACjB,EACD,OAAO,CACR,CAAC;YAEF,OAAO,CAAC,KAAK,CAAC,wCAAyC,WAAY,EAAE,CAAC,CAAC;YAEvE,IAAI,CAAC;gBAEH,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAEnC,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,kDAAmD,WAAY,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAClG,CAAC;QAEH,CAAC;IAEH,CAAC;AAEH,CAAC;AApDD,kDAoDC"}

package/src/lib/generate-response.d.ts

@@ -1,3 +1,26 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { Project } from 'ts-morph';
+/**
+ * Generates TypeScript interfaces or type aliases for API responses based on the provided OpenAPI operation object.
+ * This function determines the appropriate response schema from the operation object and decides whether to generate
+ * a new TypeScript interface or to reuse an existing type alias based on the schema's complexity and references.
+ *
+ * @param operation - The OpenAPI operation object containing the details and specifications of an API operation.
+ * @param project - The TypeScript project context where the generated files will be added.
+ * @param components - The OpenAPI components object which may contain reusable schemas referenced by the operation.
+ *
+ * The function performs the following steps:
+ * 1. Retrieves the appropriate response schema from the operation object.
+ * 2. Checks if the response schema is a simple type, a reference, or an array of references.
+ * 3. If the response schema is a reference or an array of references, it logs a debug message and creates a type alias
+ * in the project without generating a new interface.
+ * 4. If the response schema is neither a reference nor an array of references, it initializes a TypeScript interface
+ * generator with the response schema and additional configuration options.
+ * 5. Attempts to generate and build the TypeScript interface synchronously. If an error occurs during generation,
+ * it logs the error.
+ *
+ * Note: This function uses console.debug for logging skipped operations and console.error for logging errors during
+ * interface generation. It assumes the existence of constants `RESPONSE_BASE_PATH` and `RESPONSE_FILE_SUFFIX` for
+ * file path configuration.
+ */
 export declare function GenerateResponse(operation: OpenAPIV3.OperationObject, project: Project, components: OpenAPIV3.ComponentsObject): void;

package/src/lib/generate-response.js

@@ -7,6 +7,29 @@ const any_schema_object_1 = require("./utilities/any-schema-object");
 const create_component_type_alias_source_file_1 = require("./utilities/create-component-type-alias-source-file");
 const get_response_1 = require("./utilities/get-response");
 const ref_schema_object_1 = require("./utilities/ref-schema-object");
+/**
+ * Generates TypeScript interfaces or type aliases for API responses based on the provided OpenAPI operation object.
+ * This function determines the appropriate response schema from the operation object and decides whether to generate
+ * a new TypeScript interface or to reuse an existing type alias based on the schema's complexity and references.
+ *
+ * @param operation - The OpenAPI operation object containing the details and specifications of an API operation.
+ * @param project - The TypeScript project context where the generated files will be added.
+ * @param components - The OpenAPI components object which may contain reusable schemas referenced by the operation.
+ *
+ * The function performs the following steps:
+ * 1. Retrieves the appropriate response schema from the operation object.
+ * 2. Checks if the response schema is a simple type, a reference, or an array of references.
+ * 3. If the response schema is a reference or an array of references, it logs a debug message and creates a type alias
+ * in the project without generating a new interface.
+ * 4. If the response schema is neither a reference nor an array of references, it initializes a TypeScript interface
+ * generator with the response schema and additional configuration options.
+ * 5. Attempts to generate and build the TypeScript interface synchronously. If an error occurs during generation,
+ * it logs the error.
+ *
+ * Note: This function uses console.debug for logging skipped operations and console.error for logging errors during
+ * interface generation. It assumes the existence of constants `RESPONSE_BASE_PATH` and `RESPONSE_FILE_SUFFIX` for
+ * file path configuration.
+ */
 function GenerateResponse(operation, project, components) {
     const response = (0, get_response_1.GetResponse)(operation);
     if (response && !(0, any_schema_object_1.IsAnySchemaObject)(response) && operation.operationId) {

package/src/lib/generate-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-response.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-response.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAG/E,qCAGkB;AAClB,qEAAkE;AAClE,iHAAyG;AACzG,2DAAuD;AACvD,qEAGuC;AAEvC,SAAgB,gBAAgB,CAC9B,SAAoC,EACpC,OAAgB,EAChB,UAAsC;IAGtC,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;IAExC,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QACtE,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,IAAI,IAAA,qCAAiB,EAAC,QAAQ,CAAC,IAAI,IAAA,0CAAsB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAEpE,OAAO,CAAC,KAAK,CAAC,2CAA4C,WAAY,EAAE,CAAC,CAAC;YAE1E,IAAA,4EAAkC,EAChC,OAAO,EACP,WAAW,EACX,QAAQ,EACR,2BAAkB,EAClB,6BAAoB,CACrB,CAAC;QAEJ,CAAC;aAAM,CAAC;YAEN,MAAM,SAAS,GAAG,IAAI,wDAA4B,iCAE3C,QAAQ,KACX,UAAU,KAEZ;gBACE,MAAM,EAAE,6BAAoB;gBAC5B,QAAQ,EAAE,2BAAkB;gBAC5B,UAAU,EAAE,IAAI;aACjB,EACD,OAAO,CACR,CAAC;YAEF,OAAO,CAAC,KAAK,CAAC,oCAAqC,WAAY,EAAE,CAAC,CAAC;YAEnE,IAAI,CAAC;gBAEH,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAEnC,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,8CAA+C,WAAY,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAC9F,CAAC;QAEH,CAAC;IAEH,CAAC;AAEH,CAAC;AApDD,4CAoDC"}
+{"version":3,"file":"generate-response.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/generate-response.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAG/E,qCAGkB;AAClB,qEAAkE;AAClE,iHAAyG;AACzG,2DAAuD;AACvD,qEAGuC;AAEvC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,gBAAgB,CAC9B,SAAoC,EACpC,OAAgB,EAChB,UAAsC;IAGtC,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;IAExC,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QACtE,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QAE1C,IAAI,IAAA,qCAAiB,EAAC,QAAQ,CAAC,IAAI,IAAA,0CAAsB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAEpE,OAAO,CAAC,KAAK,CAAC,2CAA4C,WAAY,EAAE,CAAC,CAAC;YAE1E,IAAA,4EAAkC,EAChC,OAAO,EACP,WAAW,EACX,QAAQ,EACR,2BAAkB,EAClB,6BAAoB,CACrB,CAAC;QAEJ,CAAC;aAAM,CAAC;YAEN,MAAM,SAAS,GAAG,IAAI,wDAA4B,iCAE3C,QAAQ,KACX,UAAU,KAEZ;gBACE,MAAM,EAAE,6BAAoB;gBAC5B,QAAQ,EAAE,2BAAkB;gBAC5B,UAAU,EAAE,IAAI;aACjB,EACD,OAAO,CACR,CAAC;YAEF,OAAO,CAAC,KAAK,CAAC,oCAAqC,WAAY,EAAE,CAAC,CAAC;YAEnE,IAAI,CAAC;gBAEH,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAEnC,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,8CAA+C,WAAY,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAC9F,CAAC;QAEH,CAAC;IAEH,CAAC;AAEH,CAAC;AApDD,4CAoDC"}

package/src/lib/load-open-api-config.d.ts

@@ -1,4 +1,21 @@
 import { TreeLike } from '@rxap/workspace-utilities';
 import { OpenAPIV3 } from 'openapi-types';
 import { OpenApiSchema } from './types';
+/**
+ * Asynchronously loads an OpenAPI configuration from a specified path or URL.
+ *
+ * This function attempts to load an OpenAPI document based on the provided `options`. If the `options` specify a `path`,
+ * the function checks if the file exists in the provided `host` filesystem-like structure. Depending on the file extension,
+ * it parses the file as JSON or YAML to construct the OpenAPI document. If the file does not exist or has an unsupported extension,
+ * it throws an error.
+ *
+ * If the `options` specify a `url`, the function performs an HTTP request to fetch the OpenAPI document.
+ *
+ * @param host - A `TreeLike` object representing a filesystem-like structure where the OpenAPI file might be located.
+ * @param options - An `OpenApiSchema` object containing either a `path` or a `url` from which to load the OpenAPI document.
+ * The `path` should be a string pointing to a local file in the `host` structure, and the `url` should be a string URL pointing to a remote OpenAPI document.
+ * @returns A Promise that resolves to an `OpenAPIV3.Document` object representing the loaded OpenAPI configuration.
+ * @throws {Error} Throws an error if neither a valid `path` nor `url` is provided in `options`, if the specified file does not exist,
+ * if the file has an unsupported extension, or if any other loading errors occur.
+ */
 export declare function LoadOpenApiConfig(host: TreeLike, options: OpenApiSchema): Promise<OpenAPIV3.Document>;

package/src/lib/load-open-api-config.js

@@ -6,6 +6,23 @@ const workspace_utilities_1 = require("@rxap/workspace-utilities");
 const yaml_1 = require("yaml");
 const http_request_1 = require("./utilities/http-request");
 const is_open_api_schema_from_path_1 = require("./utilities/is-open-api-schema-from-path");
+/**
+ * Asynchronously loads an OpenAPI configuration from a specified path or URL.
+ *
+ * This function attempts to load an OpenAPI document based on the provided `options`. If the `options` specify a `path`,
+ * the function checks if the file exists in the provided `host` filesystem-like structure. Depending on the file extension,
+ * it parses the file as JSON or YAML to construct the OpenAPI document. If the file does not exist or has an unsupported extension,
+ * it throws an error.
+ *
+ * If the `options` specify a `url`, the function performs an HTTP request to fetch the OpenAPI document.
+ *
+ * @param host - A `TreeLike` object representing a filesystem-like structure where the OpenAPI file might be located.
+ * @param options - An `OpenApiSchema` object containing either a `path` or a `url` from which to load the OpenAPI document.
+ * The `path` should be a string pointing to a local file in the `host` structure, and the `url` should be a string URL pointing to a remote OpenAPI document.
+ * @returns A Promise that resolves to an `OpenAPIV3.Document` object representing the loaded OpenAPI configuration.
+ * @throws {Error} Throws an error if neither a valid `path` nor `url` is provided in `options`, if the specified file does not exist,
+ * if the file has an unsupported extension, or if any other loading errors occur.
+ */
 function LoadOpenApiConfig(host, options) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         let openapi;

package/src/lib/load-open-api-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"load-open-api-config.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/load-open-api-config.ts"],"names":[],"mappings":";;;;AAAA,mEAGmC;AAEnC,+BAA6B;AAE7B,2DAAuD;AACvD,2FAAmF;AAEnF,SAAsB,iBAAiB,CAAC,IAAc,EAAE,OAAsB;;QAC5E,IAAI,OAA2B,CAAC;QAChC,IAAI,IAAA,sDAAuB,EAAC,OAAO,CAAC,EAAE,CAAC;YAErC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,iCAAW,CAAC,IAAI,CAAC,CAAC;YAE1C,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAE,CAAC;YAEzD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;iBAAM,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3E,OAAO,GAAG,IAAA,YAAK,EAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YACjE,CAAC;QAEH,CAAC;aAAM,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACvB,OAAO,GAAG,MAAM,IAAA,0BAAW,EAAqB,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CAAA;AA1BD,8CA0BC"}
+{"version":3,"file":"load-open-api-config.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/load-open-api-config.ts"],"names":[],"mappings":";;;;AAAA,mEAGmC;AAEnC,+BAA6B;AAE7B,2DAAuD;AACvD,2FAAmF;AAEnF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,iBAAiB,CAAC,IAAc,EAAE,OAAsB;;QAC5E,IAAI,OAA2B,CAAC;QAChC,IAAI,IAAA,sDAAuB,EAAC,OAAO,CAAC,EAAE,CAAC;YAErC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,iCAAW,CAAC,IAAI,CAAC,CAAC;YAE1C,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAE,CAAC;YAEzD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;iBAAM,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3E,OAAO,GAAG,IAAA,YAAK,EAAC,OAAO,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YACjE,CAAC;QAEH,CAAC;aAAM,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACvB,OAAO,GAAG,MAAM,IAAA,0BAAW,EAAqB,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CAAA;AA1BD,8CA0BC"}

package/src/lib/resolve-ref.d.ts

@@ -1,2 +1,12 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Resolves JSON Reference (`$ref`) within an OpenAPI specification document to their corresponding schema definitions.
+ * This function mutates the original OpenAPI specification object by replacing `$ref` nodes with the actual schema
+ * definitions they refer to, if found within the `components/schemas` section of the specification.
+ *
+ * @param openApiSpec - The OpenAPI specification object (version 3.x) which includes potential `$ref` references and schema definitions.
+ * @param node - The current node in the OpenAPI specification object being examined. This can be any part of the specification.
+ * @param parent - The parent object of the current node. This is used to replace the reference with the actual schema.
+ * @param key - The key in the parent object that corresponds to the current node. This is used to update the parent object with the resolved schema.
+ */
 export declare function ResolveRef(openApiSpec: OpenAPIV3.Document, node: any, parent?: any, key?: string): void;

package/src/lib/resolve-ref.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResolveRef = void 0;
+/**
+ * Resolves JSON Reference (`$ref`) within an OpenAPI specification document to their corresponding schema definitions.
+ * This function mutates the original OpenAPI specification object by replacing `$ref` nodes with the actual schema
+ * definitions they refer to, if found within the `components/schemas` section of the specification.
+ *
+ * @param openApiSpec - The OpenAPI specification object (version 3.x) which includes potential `$ref` references and schema definitions.
+ * @param node - The current node in the OpenAPI specification object being examined. This can be any part of the specification.
+ * @param parent - The parent object of the current node. This is used to replace the reference with the actual schema.
+ * @param key - The key in the parent object that corresponds to the current node. This is used to update the parent object with the resolved schema.
+ */
 function ResolveRef(openApiSpec, node, parent, key) {
     var _a;
     if (typeof node !== 'object' || node === null) {

package/src/lib/resolve-ref.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-ref.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/resolve-ref.ts"],"names":[],"mappings":";;;AAEA,SAAgB,UAAU,CAAC,WAA+B,EAAE,IAAS,EAAE,MAAY,EAAE,GAAY;;IAC/F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9C,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACjB,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;YAC5D,IAAI,MAAM,IAAI,GAAG,KAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,OAAO,CAAA,EAAE,CAAC;gBACrD,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,CAAE,CAAC,EAAE,CAAC,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC;AAhBD,gCAgBC"}
+{"version":3,"file":"resolve-ref.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/resolve-ref.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;GASG;AACH,SAAgB,UAAU,CAAC,WAA+B,EAAE,IAAS,EAAE,MAAY,EAAE,GAAY;;IAC/F,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9C,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACjB,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;YAC5D,IAAI,MAAM,IAAI,GAAG,KAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,OAAO,CAAA,EAAE,CAAC;gBACrD,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,CAAE,CAAC,EAAE,CAAC,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;AACH,CAAC;AAhBD,gCAgBC"}