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

package/src/lib/types.d.ts

@@ -14,8 +14,48 @@ export interface OperationObjectWithMetadata extends OpenAPIV3.OperationObject {
     path: string;
     method: string;
 }
+/**
+ * Generates a sanitized OperationObject with metadata from a given parameter object, filtering out non-essential properties.
+ * This function is particularly useful for creating lightweight API operation objects that are stripped of human-readable properties
+ * which are not necessary for programmatic processing.
+ *
+ * @param {GenerateParameter} parameter - The source parameter object containing properties like method, path, operationId, parameters, responses, and requestBody.
+ * @returns {OperationObjectWithMetadata} A new object containing only essential API operation data, excluding human-readable properties such as descriptions or examples.
+ *
+ * The function performs the following operations:
+ * 1. Filters and copies properties from the input parameter that are listed in a predefined whitelist.
+ * 2. Further filters the `responses` property to include only successful responses (HTTP status codes 200-299).
+ * 3. Recursively removes properties listed in a blacklist (e.g., 'description', 'example', 'summary') from the object to ensure the output is suitable for programmatic use.
+ *
+ * Note: This function assumes that the input parameter object's structure aligns with typical API operation specifications.
+ */
 export declare function GenerateParameterToOperationObjectWithMetadata(parameter: GenerateParameter): OperationObjectWithMetadata;
+/**
+ * Checks if the provided OpenAPI operation object contains a non-empty `operationId`.
+ *
+ * The `operationId` is a unique string used to identify the operation. The presence of an `operationId` is essential for various tools and libraries that parse and utilize OpenAPI specifications, enabling unique operation referencing and handling.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if `operationId` is present and not empty, otherwise `false`.
+ *
+ * @example
+ *
+ * const operation = { operationId: "getUserById" };
+ * console.log(HasOperationId(operation)); // Output: true
+ * ```
+ */
 export declare function HasOperationId(operation: OpenAPIV3.OperationObject): operation is OperationObject;
+/**
+ * Asserts that the given OpenAPI operation object contains a valid operation ID.
+ *
+ * This function is a type guard that ensures the provided operation object adheres to the expected structure
+ * with a defined operation ID. If the operation object does not have an operation ID, it throws an error.
+ * This is particularly useful for enforcing that all operations in an OpenAPI specification include an
+ * operation ID, which is crucial for certain API tools and libraries that rely on this identifier.
+ *
+ * @param operation - The OpenAPI operation object to be validated.
+ * @throws {Error} Throws an error if the operation object does not have an operation ID.
+ */
 export declare function AssertWithOperationId(operation: OpenAPIV3.OperationObject): asserts operation is OperationObject;
 export type GeneratorFunction<Options extends OpenApiSchemaBase = OpenApiSchemaBase> = (parameters: GenerateParameter<Options>) => void;
 export interface OpenApiSchemaBase {

package/src/lib/types.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssertWithOperationId = exports.HasOperationId = exports.GenerateParameterToOperationObjectWithMetadata = void 0;
+/**
+ * Generates a sanitized OperationObject with metadata from a given parameter object, filtering out non-essential properties.
+ * This function is particularly useful for creating lightweight API operation objects that are stripped of human-readable properties
+ * which are not necessary for programmatic processing.
+ *
+ * @param {GenerateParameter} parameter - The source parameter object containing properties like method, path, operationId, parameters, responses, and requestBody.
+ * @returns {OperationObjectWithMetadata} A new object containing only essential API operation data, excluding human-readable properties such as descriptions or examples.
+ *
+ * The function performs the following operations:
+ * 1. Filters and copies properties from the input parameter that are listed in a predefined whitelist.
+ * 2. Further filters the `responses` property to include only successful responses (HTTP status codes 200-299).
+ * 3. Recursively removes properties listed in a blacklist (e.g., 'description', 'example', 'summary') from the object to ensure the output is suitable for programmatic use.
+ *
+ * Note: This function assumes that the input parameter object's structure aligns with typical API operation specifications.
+ */
 function GenerateParameterToOperationObjectWithMetadata(parameter) {
     const whitelist = ['method', 'path', 'operationId', 'parameters', 'responses', 'requestBody'];
     const copy = {};
@@ -34,10 +49,35 @@ function GenerateParameterToOperationObjectWithMetadata(parameter) {
     return removeHumanProperties(copy);
 }
 exports.GenerateParameterToOperationObjectWithMetadata = GenerateParameterToOperationObjectWithMetadata;
+/**
+ * Checks if the provided OpenAPI operation object contains a non-empty `operationId`.
+ *
+ * The `operationId` is a unique string used to identify the operation. The presence of an `operationId` is essential for various tools and libraries that parse and utilize OpenAPI specifications, enabling unique operation referencing and handling.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if `operationId` is present and not empty, otherwise `false`.
+ *
+ * @example
+ *
+ * const operation = { operationId: "getUserById" };
+ * console.log(HasOperationId(operation)); // Output: true
+ * ```
+ */
 function HasOperationId(operation) {
     return !!operation.operationId;
 }
 exports.HasOperationId = HasOperationId;
+/**
+ * Asserts that the given OpenAPI operation object contains a valid operation ID.
+ *
+ * This function is a type guard that ensures the provided operation object adheres to the expected structure
+ * with a defined operation ID. If the operation object does not have an operation ID, it throws an error.
+ * This is particularly useful for enforcing that all operations in an OpenAPI specification include an
+ * operation ID, which is crucial for certain API tools and libraries that rely on this identifier.
+ *
+ * @param operation - The OpenAPI operation object to be validated.
+ * @throws {Error} Throws an error if the operation object does not have an operation ID.
+ */
 function AssertWithOperationId(operation) {
     if (!HasOperationId(operation)) {
         throw new Error('Ensure all operation have a operation id.');

package/src/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/types.ts"],"names":[],"mappings":";;;AAkBA,SAAgB,8CAA8C,CAAC,SAA4B;IACzF,MAAM,SAAS,GAAG,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,CAAE,CAAC;IAChG,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,IAAI,CAAC,GAAG,CAAC,GAAI,SAAiB,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,MAAM,IACf,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;YACnG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,SAAS,qBAAqB,CAAC,GAAQ;QACrC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,SAAS,GAAG,CAAE,aAAa,EAAE,SAAS,EAAE,SAAS,CAAE,CAAC;QAC1D,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAjCD,wGAiCC;AAED,SAAgB,cAAc,CAAC,SAAoC;IACjE,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC;AACjC,CAAC;AAFD,wCAEC;AAED,SAAgB,qBAAqB,CAAC,SAAoC;IACxE,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAJD,sDAIC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../packages/workspace/open-api/src/lib/types.ts"],"names":[],"mappings":";;;AAkBA;;;;;;;;;;;;;;GAcG;AACH,SAAgB,8CAA8C,CAAC,SAA4B;IACzF,MAAM,SAAS,GAAG,CAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,CAAE,CAAC;IAChG,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,IAAI,CAAC,GAAG,CAAC,GAAI,SAAiB,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,MAAM,IACf,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;YACnG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,SAAS,qBAAqB,CAAC,GAAQ;QACrC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,SAAS,GAAG,CAAE,aAAa,EAAE,SAAS,EAAE,SAAS,CAAE,CAAC;QAC1D,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAjCD,wGAiCC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,cAAc,CAAC,SAAoC;IACjE,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC;AACjC,CAAC;AAFD,wCAEC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,qBAAqB,CAAC,SAAoC;IACxE,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAJD,sDAIC"}

package/src/lib/utilities/any-schema-object.d.ts

@@ -1,4 +1,13 @@
 export interface AnySchemaObject {
     type: 'any';
 }
+/**
+ * Checks if the provided object conforms to the `AnySchemaObject` interface.
+ *
+ * This function determines if the given object is an instance of `AnySchemaObject` by checking
+ * if the object is not null, has a 'type' property, and if the 'type' property is exactly equal to 'any'.
+ *
+ * @param obj - The object to be checked.
+ * @returns True if the object matches the `AnySchemaObject` interface, false otherwise.
+ */
 export declare function IsAnySchemaObject(obj: any): obj is AnySchemaObject;

package/src/lib/utilities/any-schema-object.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsAnySchemaObject = void 0;
+/**
+ * Checks if the provided object conforms to the `AnySchemaObject` interface.
+ *
+ * This function determines if the given object is an instance of `AnySchemaObject` by checking
+ * if the object is not null, has a 'type' property, and if the 'type' property is exactly equal to 'any'.
+ *
+ * @param obj - The object to be checked.
+ * @returns True if the object matches the `AnySchemaObject` interface, false otherwise.
+ */
 function IsAnySchemaObject(obj) {
     return obj && obj['type'] && obj.type === 'any';
 }

package/src/lib/utilities/any-schema-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"any-schema-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/any-schema-object.ts"],"names":[],"mappings":";;;AAIA,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC;AAClD,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"any-schema-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/any-schema-object.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC;AAClD,CAAC;AAFD,8CAEC"}

package/src/lib/utilities/create-component-type-alias-source-file.d.ts

@@ -1,4 +1,23 @@
 import { ArrayRefSchemaObject } from '@rxap/workspace-open-api';
 import { Project } from 'ts-morph';
 import { RefSchemaObject } from './ref-schema-object';
+/**
+ * Creates a TypeScript source file in a specified project with a type alias derived from a given schema object.
+ * This function is particularly useful for generating type definitions based on OpenAPI schema components.
+ *
+ * @param {Project} project - The project within which the source file will be created.
+ * @param {string} operationId - A unique identifier for the operation, used to name the generated file and type alias.
+ * @param {RefSchemaObject | ArrayRefSchemaObject} schema - The schema object that defines the structure of the type.
+ * This can be a direct reference to a schema (`RefSchemaObject`) or a reference to an array of schemas (`ArrayRefSchemaObject`).
+ * @param {string} basePath - The base directory path where the new source file will be created.
+ * @param {string} fileSuffix - A suffix to append to the operationId for the filename and type alias, aiding in the creation of distinct, descriptive names.
+ *
+ * The function performs the following operations:
+ * 1. Constructs the filename from the operationId and fileSuffix, then creates a new TypeScript file in the specified project.
+ * 2. Determines the reference path from the schema object, extracting the component name to be used in type alias and import declarations.
+ * 3. Adds a type alias to the source file that corresponds to the schema reference, appending '[]' to the type if the schema is an array type.
+ * 4. Adds necessary import declarations for the type based on the extracted component name.
+ *
+ * Note: This function relies on utility functions like `dasherize`, `classify`, and path manipulation functions (`join`, `relative`) to format names and paths.
+ */
 export declare function CreateComponentTypeAliasSourceFile(project: Project, operationId: string, schema: RefSchemaObject | ArrayRefSchemaObject, basePath: string, fileSuffix: string): void;

package/src/lib/utilities/create-component-type-alias-source-file.js

@@ -4,6 +4,25 @@ exports.CreateComponentTypeAliasSourceFile = void 0;
 const utilities_1 = require("@rxap/utilities");
 const workspace_open_api_1 = require("@rxap/workspace-open-api");
 const path_1 = require("path");
+/**
+ * Creates a TypeScript source file in a specified project with a type alias derived from a given schema object.
+ * This function is particularly useful for generating type definitions based on OpenAPI schema components.
+ *
+ * @param {Project} project - The project within which the source file will be created.
+ * @param {string} operationId - A unique identifier for the operation, used to name the generated file and type alias.
+ * @param {RefSchemaObject | ArrayRefSchemaObject} schema - The schema object that defines the structure of the type.
+ * This can be a direct reference to a schema (`RefSchemaObject`) or a reference to an array of schemas (`ArrayRefSchemaObject`).
+ * @param {string} basePath - The base directory path where the new source file will be created.
+ * @param {string} fileSuffix - A suffix to append to the operationId for the filename and type alias, aiding in the creation of distinct, descriptive names.
+ *
+ * The function performs the following operations:
+ * 1. Constructs the filename from the operationId and fileSuffix, then creates a new TypeScript file in the specified project.
+ * 2. Determines the reference path from the schema object, extracting the component name to be used in type alias and import declarations.
+ * 3. Adds a type alias to the source file that corresponds to the schema reference, appending '[]' to the type if the schema is an array type.
+ * 4. Adds necessary import declarations for the type based on the extracted component name.
+ *
+ * Note: This function relies on utility functions like `dasherize`, `classify`, and path manipulation functions (`join`, `relative`) to format names and paths.
+ */
 function CreateComponentTypeAliasSourceFile(project, operationId, schema, basePath, fileSuffix) {
     const sourceFile = project.createSourceFile((0, path_1.join)(basePath, `${(0, utilities_1.dasherize)(operationId)}.${fileSuffix}.ts`));
     const ref = (0, workspace_open_api_1.IsRefSchemaObject)(schema) ? schema.$ref : schema.items.$ref;

package/src/lib/utilities/create-component-type-alias-source-file.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-component-type-alias-source-file.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/create-component-type-alias-source-file.ts"],"names":[],"mappings":";;;AAAA,+CAGyB;AACzB,iEAKkC;AAClC,+BAGc;AAId,SAAgB,kCAAkC,CAChD,OAAgB,EAChB,WAAmB,EACnB,MAA8C,EAC9C,QAAgB,EAChB,UAAkB;IAElB,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,GAAI,IAAA,qBAAS,EAAC,WAAW,CAAE,IAAK,UAAW,KAAK,CAAC,CAAC,CAAC;IAC9G,MAAM,GAAG,GAAG,IAAA,sCAAiB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;IACxE,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAC/D,IAAI,IAAI,GAAG,IAAA,oBAAQ,EAAC,aAAa,CAAC,CAAC;IACnC,IAAI,IAAA,2CAAsB,EAAC,MAAM,CAAC,EAAE,CAAC;QACnC,IAAI,IAAI,IAAI,CAAC;IACf,CAAC;IACD,UAAU,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,IAAA,oBAAQ,EAAC,WAAW,CAAC,GAAG,IAAA,oBAAQ,EAAC,UAAU,CAAC;QAClD,UAAU,EAAE,IAAI;QAChB,IAAI;KACL,CAAC,CAAC;IACH,UAAU,CAAC,qBAAqB,CAAC,CAAC;YAChC,YAAY,EAAE,CAAC,IAAA,oBAAQ,EAAC,aAAa,CAAC,CAAC;YACvC,eAAe,EAAE,GAAG,IAAA,eAAQ,EAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,yCAAoB,IAAK,IAAA,qBAAS,EAAC,aAAa,CAAE,EAAE;SACnG,CAAC,CAAC,CAAC;AACN,CAAC;AAvBD,gFAuBC"}
+{"version":3,"file":"create-component-type-alias-source-file.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/create-component-type-alias-source-file.ts"],"names":[],"mappings":";;;AAAA,+CAGyB;AACzB,iEAKkC;AAClC,+BAGc;AAId;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,kCAAkC,CAChD,OAAgB,EAChB,WAAmB,EACnB,MAA8C,EAC9C,QAAgB,EAChB,UAAkB;IAElB,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAA,WAAI,EAAC,QAAQ,EAAE,GAAI,IAAA,qBAAS,EAAC,WAAW,CAAE,IAAK,UAAW,KAAK,CAAC,CAAC,CAAC;IAC9G,MAAM,GAAG,GAAG,IAAA,sCAAiB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;IACxE,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IAC/D,IAAI,IAAI,GAAG,IAAA,oBAAQ,EAAC,aAAa,CAAC,CAAC;IACnC,IAAI,IAAA,2CAAsB,EAAC,MAAM,CAAC,EAAE,CAAC;QACnC,IAAI,IAAI,IAAI,CAAC;IACf,CAAC;IACD,UAAU,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,IAAA,oBAAQ,EAAC,WAAW,CAAC,GAAG,IAAA,oBAAQ,EAAC,UAAU,CAAC;QAClD,UAAU,EAAE,IAAI;QAChB,IAAI;KACL,CAAC,CAAC;IACH,UAAU,CAAC,qBAAqB,CAAC,CAAC;YAChC,YAAY,EAAE,CAAC,IAAA,oBAAQ,EAAC,aAAa,CAAC,CAAC;YACvC,eAAe,EAAE,GAAG,IAAA,eAAQ,EAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,yCAAoB,IAAK,IAAA,qBAAS,EAAC,aAAa,CAAE,EAAE;SACnG,CAAC,CAAC,CAAC;AACN,CAAC;AAvBD,gFAuBC"}

package/src/lib/utilities/get-parameter-type.d.ts

@@ -1,2 +1,12 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Generates a string representing the type of parameter for a given OpenAPI operation.
+ *
+ * This function examines the provided `operation` object to determine if it contains parameters and an operation ID.
+ * If both are present, it constructs a parameter type string using the operation ID and a predefined suffix.
+ * If either is absent, it defaults to returning 'void'.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to analyze.
+ * @returns {string} A string representing the parameter type. Returns 'void' if the necessary conditions are not met.
+ */
 export declare function GetParameterType(operation: OpenAPIV3.OperationObject): string;

package/src/lib/utilities/get-parameter-type.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetParameterType = void 0;
 const utilities_1 = require("@rxap/utilities");
 const config_1 = require("../config");
+/**
+ * Generates a string representing the type of parameter for a given OpenAPI operation.
+ *
+ * This function examines the provided `operation` object to determine if it contains parameters and an operation ID.
+ * If both are present, it constructs a parameter type string using the operation ID and a predefined suffix.
+ * If either is absent, it defaults to returning 'void'.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to analyze.
+ * @returns {string} A string representing the parameter type. Returns 'void' if the necessary conditions are not met.
+ */
 function GetParameterType(operation) {
     let parameterType = 'void';
     if (operation.parameters && operation.parameters.length && operation.operationId) {

package/src/lib/utilities/get-parameter-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-parameter-type.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-parameter-type.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,sCAAkD;AAElD,SAAgB,gBAAgB,CAAC,SAAoC;IAEnE,IAAI,aAAa,GAAG,MAAM,CAAC;IAE3B,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QACjF,aAAa,GAAG,IAAA,oBAAQ,EAAC,CAAE,SAAS,CAAC,WAAW,EAAE,8BAAqB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,aAAa,CAAC;AAEvB,CAAC;AAVD,4CAUC"}
+{"version":3,"file":"get-parameter-type.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-parameter-type.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,sCAAkD;AAElD;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,SAAoC;IAEnE,IAAI,aAAa,GAAG,MAAM,CAAC;IAE3B,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QACjF,aAAa,GAAG,IAAA,oBAAQ,EAAC,CAAE,SAAS,CAAC,WAAW,EAAE,8BAAqB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,aAAa,CAAC;AAEvB,CAAC;AAVD,4CAUC"}

package/src/lib/utilities/get-reqeust-body.d.ts

@@ -1,3 +1,15 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { AnySchemaObject } from './any-schema-object';
+/**
+ * Extracts the schema object from the request body of an OpenAPI operation.
+ *
+ * This function analyzes the `requestBody` of a given OpenAPI operation object to retrieve the schema definition
+ * for the 'application/json' media type. It ensures that the requestBody is not a reference object, as reference
+ * objects are not supported by this function. If the requestBody or the 'application/json' media type does not
+ * contain a schema, the function returns null.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object containing the requestBody from which the schema is to be extracted.
+ * @returns {OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | AnySchemaObject | null} The schema object associated with the 'application/json' media type if available, otherwise null.
+ * @throws {Error} Throws an error if the requestBody itself is a reference object.
+ */
 export declare function GetRequestBody(operation: OpenAPIV3.OperationObject): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | AnySchemaObject | null;

package/src/lib/utilities/get-reqeust-body.js

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetRequestBody = void 0;
 const utilities_1 = require("@rxap/utilities");
 const is_reference_object_1 = require("./is-reference-object");
+/**
+ * Extracts the schema object from the request body of an OpenAPI operation.
+ *
+ * This function analyzes the `requestBody` of a given OpenAPI operation object to retrieve the schema definition
+ * for the 'application/json' media type. It ensures that the requestBody is not a reference object, as reference
+ * objects are not supported by this function. If the requestBody or the 'application/json' media type does not
+ * contain a schema, the function returns null.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object containing the requestBody from which the schema is to be extracted.
+ * @returns {OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | AnySchemaObject | null} The schema object associated with the 'application/json' media type if available, otherwise null.
+ * @throws {Error} Throws an error if the requestBody itself is a reference object.
+ */
 function GetRequestBody(operation) {
     if (operation.requestBody) {
         if ((0, is_reference_object_1.IsReferenceObject)(operation.requestBody)) {

package/src/lib/utilities/get-reqeust-body.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-reqeust-body.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-reqeust-body.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAG3C,+DAA0D;AAE1D,SAAgB,cAAc,CAAC,SAAoC;IAEjE,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,aAAa,GAA0D,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QAE3G,IAAI,IAAA,oBAAQ,EAAC,aAAa,CAAC,EAAE,CAAC;YAE5B,IAAI,IAAA,uCAAiB,EAAC,aAAa,CAAC,EAAE,CAAC;gBACrC,OAAO,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;YAC/E,CAAC;iBAAM,CAAC;gBACN,IAAI,aAAa,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACtC,MAAM,MAAM,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC;oBAC3D,IAAI,MAAM,EAAE,CAAC;wBACX,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QAEH,CAAC;IAEH,CAAC;IAED,OAAO,IAAI,CAAC;AAEd,CAAC;AA7BD,wCA6BC"}
+{"version":3,"file":"get-reqeust-body.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-reqeust-body.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAG3C,+DAA0D;AAE1D;;;;;;;;;;;GAWG;AACH,SAAgB,cAAc,CAAC,SAAoC;IAEjE,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,IAAI,IAAA,uCAAiB,EAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,aAAa,GAA0D,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QAE3G,IAAI,IAAA,oBAAQ,EAAC,aAAa,CAAC,EAAE,CAAC;YAE5B,IAAI,IAAA,uCAAiB,EAAC,aAAa,CAAC,EAAE,CAAC;gBACrC,OAAO,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;YAC/E,CAAC;iBAAM,CAAC;gBACN,IAAI,aAAa,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACtC,MAAM,MAAM,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC;oBAC3D,IAAI,MAAM,EAAE,CAAC;wBACX,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QAEH,CAAC;IAEH,CAAC;IAED,OAAO,IAAI,CAAC;AAEd,CAAC;AA7BD,wCA6BC"}

package/src/lib/utilities/get-request-body-type.d.ts

@@ -1,4 +1,23 @@
 import { GenerateParameter } from '../types';
+/**
+ * Generates a description of the request body type for a given API operation.
+ *
+ * This function examines the specified operation to determine the type of its request body.
+ * It returns an object containing the type as a string and an optional name for the type.
+ * If the operation does not specify a request body, or if the body cannot be determined,
+ * the type defaults to 'void'. If the body is of a generic or undefined type, it is classified
+ * under a generated name using the operation ID and a suffix. If the body schema is too generic
+ * (i.e., matches any schema), the type is set to 'any'.
+ *
+ * @param {GenerateParameter<any>} operation - The operation object to analyze, which should include
+ * an operationId and potentially other metadata necessary
+ * for determining the request body schema.
+ * @returns {{ type: string, name: string | null }} An object containing:
+ * - `type`: A string representing the determined type of the request body. Possible values
+ * are 'void', a specific classified type name, or 'any'.
+ * - `name`: An optional string representing a name for the request body type, which is
+ * null if no specific name is applicable.
+ */
 export declare function GetRequestBodyType(operation: GenerateParameter<any>): {
     type: string;
     name: string | null;

package/src/lib/utilities/get-request-body-type.js

@@ -6,6 +6,25 @@ const config_1 = require("../config");
 const any_schema_object_1 = require("./any-schema-object");
 const get_reqeust_body_1 = require("./get-reqeust-body");
 const is_reference_object_1 = require("./is-reference-object");
+/**
+ * Generates a description of the request body type for a given API operation.
+ *
+ * This function examines the specified operation to determine the type of its request body.
+ * It returns an object containing the type as a string and an optional name for the type.
+ * If the operation does not specify a request body, or if the body cannot be determined,
+ * the type defaults to 'void'. If the body is of a generic or undefined type, it is classified
+ * under a generated name using the operation ID and a suffix. If the body schema is too generic
+ * (i.e., matches any schema), the type is set to 'any'.
+ *
+ * @param {GenerateParameter<any>} operation - The operation object to analyze, which should include
+ * an operationId and potentially other metadata necessary
+ * for determining the request body schema.
+ * @returns {{ type: string, name: string | null }} An object containing:
+ * - `type`: A string representing the determined type of the request body. Possible values
+ * are 'void', a specific classified type name, or 'any'.
+ * - `name`: An optional string representing a name for the request body type, which is
+ * null if no specific name is applicable.
+ */
 function GetRequestBodyType(operation) {
     let requestBodyType = 'void';
     let name = null;

package/src/lib/utilities/get-request-body-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-request-body-type.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-request-body-type.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,sCAAqD;AAErD,2DAAwD;AACxD,yDAAoD;AACpD,+DAA0D;AAE1D,SAAgB,kBAAkB,CAAC,SAAiC;IAElE,IAAI,eAAe,GAAG,MAAM,CAAC;IAC7B,IAAI,IAAI,GAAkB,IAAI,CAAC;IAE/B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,MAAM,WAAW,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACzB,eAAe,GAAG,MAAM,CAAC;QAC3B,CAAC;aAAM,IAAI,CAAC,IAAA,qCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,GAAG,eAAe,GAAG,IAAA,oBAAQ,EAAC,CAAE,SAAS,CAAC,WAAW,EAAE,iCAAwB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACjG,IAAI,CAAC,IAAA,uCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;gBACpC,IAAI,WAAW,CAAC,oBAAoB,KAAK,IAAI,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAChF,eAAe,IAAI,gBAAgB,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,eAAe,GAAG,KAAK,CAAC;QAC1B,CAAC;IAEH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,IAAI;KACL,CAAC;AAEJ,CAAC;AA7BD,gDA6BC"}
+{"version":3,"file":"get-request-body-type.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-request-body-type.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,sCAAqD;AAErD,2DAAwD;AACxD,yDAAoD;AACpD,+DAA0D;AAE1D;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,kBAAkB,CAAC,SAAiC;IAElE,IAAI,eAAe,GAAG,MAAM,CAAC;IAC7B,IAAI,IAAI,GAAkB,IAAI,CAAC;IAE/B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,MAAM,WAAW,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACzB,eAAe,GAAG,MAAM,CAAC;QAC3B,CAAC;aAAM,IAAI,CAAC,IAAA,qCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,GAAG,eAAe,GAAG,IAAA,oBAAQ,EAAC,CAAE,SAAS,CAAC,WAAW,EAAE,iCAAwB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACjG,IAAI,CAAC,IAAA,uCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;gBACpC,IAAI,WAAW,CAAC,oBAAoB,KAAK,IAAI,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAChF,eAAe,IAAI,gBAAgB,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,eAAe,GAAG,KAAK,CAAC;QAC1B,CAAC;IAEH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,IAAI;KACL,CAAC;AAEJ,CAAC;AA7BD,gDA6BC"}

package/src/lib/utilities/get-response-type.d.ts

@@ -1,4 +1,19 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Determines the response type and name for a given OpenAPI operation.
+ *
+ * This function analyzes an OpenAPI operation object to ascertain the appropriate TypeScript type
+ * and name for the response. It defaults to a type of 'void' if no specific response structure is defined
+ * or if the response type is 'any'. If a valid response structure is found and it is not of type 'any',
+ * the function generates a TypeScript type name based on the operation ID and a predefined suffix.
+ * Additionally, if the response object is not a direct reference and either has additional properties
+ * or an undefined type, a generic type parameter 'TResponse' is appended to the response type.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to analyze.
+ * @returns {{ type: string, name: string | null }} An object containing the 'type' as a string
+ * indicating the TypeScript type of the response, and 'name', which is either a string
+ * representing the generated type name or null if no specific type name is generated.
+ */
 export declare function GetResponseType(operation: OpenAPIV3.OperationObject): {
     type: string;
     name: string | null;

package/src/lib/utilities/get-response-type.js

@@ -6,6 +6,21 @@ const config_1 = require("../config");
 const any_schema_object_1 = require("./any-schema-object");
 const get_response_1 = require("./get-response");
 const is_reference_object_1 = require("./is-reference-object");
+/**
+ * Determines the response type and name for a given OpenAPI operation.
+ *
+ * This function analyzes an OpenAPI operation object to ascertain the appropriate TypeScript type
+ * and name for the response. It defaults to a type of 'void' if no specific response structure is defined
+ * or if the response type is 'any'. If a valid response structure is found and it is not of type 'any',
+ * the function generates a TypeScript type name based on the operation ID and a predefined suffix.
+ * Additionally, if the response object is not a direct reference and either has additional properties
+ * or an undefined type, a generic type parameter 'TResponse' is appended to the response type.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to analyze.
+ * @returns {{ type: string, name: string | null }} An object containing the 'type' as a string
+ * indicating the TypeScript type of the response, and 'name', which is either a string
+ * representing the generated type name or null if no specific type name is generated.
+ */
 function GetResponseType(operation) {
     let responseType = 'void';
     let name = null;

package/src/lib/utilities/get-response-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-response-type.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-response-type.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,sCAAiD;AACjD,2DAAwD;AACxD,iDAA6C;AAC7C,+DAA0D;AAE1D,SAAgB,eAAe,CAAC,SAAoC;IAElE,IAAI,YAAY,GAAG,MAAM,CAAC;IAC1B,IAAI,IAAI,GAAkB,IAAI,CAAC;IAE/B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;QAExC,8DAA8D;QAC9D,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,IAAI,GAAG,YAAY,GAAG,IAAA,oBAAQ,EAAC,CAAE,SAAS,CAAC,WAAW,EAAE,6BAAoB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,IAAI,QAAQ,CAAC,oBAAoB,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC1E,YAAY,IAAI,aAAa,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,MAAM,CAAC;QACxB,CAAC;IAEH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI;KACL,CAAC;AAEJ,CAAC;AA5BD,0CA4BC"}
+{"version":3,"file":"get-response-type.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-response-type.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,sCAAiD;AACjD,2DAAwD;AACxD,iDAA6C;AAC7C,+DAA0D;AAE1D;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,SAAoC;IAElE,IAAI,YAAY,GAAG,MAAM,CAAC;IAC1B,IAAI,IAAI,GAAkB,IAAI,CAAC;IAE/B,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;QAExC,8DAA8D;QAC9D,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,IAAI,GAAG,YAAY,GAAG,IAAA,oBAAQ,EAAC,CAAE,SAAS,CAAC,WAAW,EAAE,6BAAoB,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,IAAI,QAAQ,CAAC,oBAAoB,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC1E,YAAY,IAAI,aAAa,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,MAAM,CAAC;QACxB,CAAC;IAEH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,IAAI;KACL,CAAC;AAEJ,CAAC;AA5BD,0CA4BC"}

package/src/lib/utilities/get-response.d.ts

@@ -1,3 +1,16 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { AnySchemaObject } from './any-schema-object';
+/**
+ * Extracts the JSON schema from a specified operation's responses in an OpenAPI 3.0 specification.
+ *
+ * This function navigates through the responses of an OpenAPI operation object to find and return the JSON schema
+ * associated with the response content type 'application/json'. It prioritizes the default response, followed by
+ * HTTP 200 and 201 status codes. If a response is found, the function checks if it is a reference object or an actual
+ * response object. For reference objects, a warning is logged indicating that reference objects are not supported.
+ * If an actual response object with a 'application/json' content type is found, the associated schema is returned.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object containing the responses to be analyzed.
+ * @returns {OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | AnySchemaObject | null} The JSON schema associated with
+ * the operation's response if available, otherwise null. Note that reference objects are recognized but not supported.
+ */
 export declare function GetResponse(operation: OpenAPIV3.OperationObject): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | AnySchemaObject | null;

package/src/lib/utilities/get-response.js

@@ -2,6 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetResponse = void 0;
 const is_reference_object_1 = require("./is-reference-object");
+/**
+ * Extracts the JSON schema from a specified operation's responses in an OpenAPI 3.0 specification.
+ *
+ * This function navigates through the responses of an OpenAPI operation object to find and return the JSON schema
+ * associated with the response content type 'application/json'. It prioritizes the default response, followed by
+ * HTTP 200 and 201 status codes. If a response is found, the function checks if it is a reference object or an actual
+ * response object. For reference objects, a warning is logged indicating that reference objects are not supported.
+ * If an actual response object with a 'application/json' content type is found, the associated schema is returned.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object containing the responses to be analyzed.
+ * @returns {OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject | AnySchemaObject | null} The JSON schema associated with
+ * the operation's response if available, otherwise null. Note that reference objects are recognized but not supported.
+ */
 function GetResponse(operation) {
     if (operation.responses) {
         let response = undefined;

package/src/lib/utilities/get-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-response.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-response.ts"],"names":[],"mappings":";;;AAEA,+DAA0D;AAE1D,SAAgB,WAAW,CAAC,SAAoC;IAE9D,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QAExB,IAAI,QAAQ,GAAqE,SAAS,CAAC;QAE3F,IAAI,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YAEb,IAAI,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;gBAChC,OAAO,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;YAC7E,CAAC;iBAAM,CAAC;gBACN,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;oBAC3D,IAAI,MAAM,EAAE,CAAC;wBACX,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QAEH,CAAC;IAEH,CAAC;IAED,OAAO,IAAI,CAAC;AAEd,CAAC;AAjCD,kCAiCC"}
+{"version":3,"file":"get-response.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-response.ts"],"names":[],"mappings":";;;AAEA,+DAA0D;AAE1D;;;;;;;;;;;;GAYG;AACH,SAAgB,WAAW,CAAC,SAAoC;IAE9D,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QAExB,IAAI,QAAQ,GAAqE,SAAS,CAAC;QAE3F,IAAI,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YAEb,IAAI,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;gBAChC,OAAO,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;YAC7E,CAAC;iBAAM,CAAC;gBACN,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;oBAC3D,IAAI,MAAM,EAAE,CAAC;wBACX,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QAEH,CAAC;IAEH,CAAC;IAED,OAAO,IAAI,CAAC;AAEd,CAAC;AAjCD,kCAiCC"}

package/src/lib/utilities/get-type-parameters.d.ts

@@ -1,3 +1,17 @@
 import { OpenAPIV3 } from 'openapi-types';
 import { OptionalKind, TypeParameterDeclarationStructure } from 'ts-morph';
+/**
+ * Extracts type parameters for the response and request body of a given OpenAPI operation object.
+ * This function analyzes the operation's response and request body to determine if type parameters
+ * should be defined based on the presence of additional properties or undefined types.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to analyze.
+ * @returns {Array<OptionalKind<TypeParameterDeclarationStructure>>} An array of type parameter declarations.
+ * Each type parameter is represented with a name and a default type. If the operation's response or request body
+ * has additional properties set to true or an undefined type, type parameters 'TResponse' and 'TRequestBody'
+ * are added with a default type of 'unknown'.
+ *
+ * Note: The function assumes that the operation object is well-formed and contains the necessary properties
+ * to perform checks on the response and request body. It returns an empty array if no type parameters are needed.
+ */
 export declare function GetTypeParameters(operation: OpenAPIV3.OperationObject): Array<OptionalKind<TypeParameterDeclarationStructure>>;

package/src/lib/utilities/get-type-parameters.js

@@ -5,6 +5,20 @@ const any_schema_object_1 = require("./any-schema-object");
 const get_reqeust_body_1 = require("./get-reqeust-body");
 const get_response_1 = require("./get-response");
 const is_reference_object_1 = require("./is-reference-object");
+/**
+ * Extracts type parameters for the response and request body of a given OpenAPI operation object.
+ * This function analyzes the operation's response and request body to determine if type parameters
+ * should be defined based on the presence of additional properties or undefined types.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to analyze.
+ * @returns {Array<OptionalKind<TypeParameterDeclarationStructure>>} An array of type parameter declarations.
+ * Each type parameter is represented with a name and a default type. If the operation's response or request body
+ * has additional properties set to true or an undefined type, type parameters 'TResponse' and 'TRequestBody'
+ * are added with a default type of 'unknown'.
+ *
+ * Note: The function assumes that the operation object is well-formed and contains the necessary properties
+ * to perform checks on the response and request body. It returns an empty array if no type parameters are needed.
+ */
 function GetTypeParameters(operation) {
     const typeParameters = [];
     if (operation.operationId) {

package/src/lib/utilities/get-type-parameters.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-type-parameters.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-type-parameters.ts"],"names":[],"mappings":";;;AAKA,2DAAwD;AACxD,yDAAoD;AACpD,iDAA6C;AAC7C,+DAA0D;AAE1D,SAAgB,iBAAiB,CAAC,SAAoC;IAEpE,MAAM,cAAc,GAA2D,EAAE,CAAC;IAElF,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC7E,IAAI,QAAQ,CAAC,oBAAoB,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1E,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,SAAS;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,WAAW,IAAI,CAAC,IAAA,qCAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,IAAA,uCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;YACtF,IAAI,WAAW,CAAC,oBAAoB,KAAK,IAAI,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAChF,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,SAAS;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IAEH,CAAC;IAED,OAAO,cAAc,CAAC;AAExB,CAAC;AA/BD,8CA+BC"}
+{"version":3,"file":"get-type-parameters.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/get-type-parameters.ts"],"names":[],"mappings":";;;AAKA,2DAAwD;AACxD,yDAAoD;AACpD,iDAA6C;AAC7C,+DAA0D;AAE1D;;;;;;;;;;;;;GAaG;AACH,SAAgB,iBAAiB,CAAC,SAAoC;IAEpE,MAAM,cAAc,GAA2D,EAAE,CAAC;IAElF,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,IAAA,iCAAc,EAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC7E,IAAI,QAAQ,CAAC,oBAAoB,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1E,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,SAAS;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,WAAW,IAAI,CAAC,IAAA,qCAAiB,EAAC,WAAW,CAAC,IAAI,CAAC,IAAA,uCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;YACtF,IAAI,WAAW,CAAC,oBAAoB,KAAK,IAAI,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAChF,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,SAAS;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IAEH,CAAC;IAED,OAAO,cAAc,CAAC;AAExB,CAAC;AA/BD,8CA+BC"}

package/src/lib/utilities/has-operation-paramters.d.ts

@@ -1,3 +1,13 @@
 import { OpenAPIV3 } from 'openapi-types';
 export type OperationObjectWithParameters = Omit<OpenAPIV3.OperationObject, 'parameters'> & Required<Pick<OpenAPIV3.OperationObject, 'parameters'>>;
+/**
+ * Checks if the provided OpenAPI operation object has any parameters defined.
+ *
+ * This function is a type guard that determines whether the `operation` object
+ * conforms to the `OperationObjectWithParameters` type, which is an extension
+ * of the standard `OpenAPIV3.OperationObject` with a non-empty `parameters` array.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if the `operation` object has a non-empty array of parameters, `false` otherwise.
+ */
 export declare function HasOperationParameters(operation: OpenAPIV3.OperationObject): operation is OperationObjectWithParameters;

package/src/lib/utilities/has-operation-paramters.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HasOperationParameters = void 0;
+/**
+ * Checks if the provided OpenAPI operation object has any parameters defined.
+ *
+ * This function is a type guard that determines whether the `operation` object
+ * conforms to the `OperationObjectWithParameters` type, which is an extension
+ * of the standard `OpenAPIV3.OperationObject` with a non-empty `parameters` array.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if the `operation` object has a non-empty array of parameters, `false` otherwise.
+ */
 function HasOperationParameters(operation) {
     return Array.isArray(operation.parameters) && operation.parameters.length !== 0;
 }

package/src/lib/utilities/has-operation-paramters.js.map

@@ -1 +1 @@
-{"version":3,"file":"has-operation-paramters.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/has-operation-paramters.ts"],"names":[],"mappings":";;;AAMA,SAAgB,sBAAsB,CAAC,SAAoC;IACzE,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;AAClF,CAAC;AAFD,wDAEC"}
+{"version":3,"file":"has-operation-paramters.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/has-operation-paramters.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAC,SAAoC;IACzE,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;AAClF,CAAC;AAFD,wDAEC"}

package/src/lib/utilities/has-operation-request-body.d.ts

@@ -1,3 +1,13 @@
 import { OpenAPIV3 } from 'openapi-types';
 export type OperationObjectWithRequestBody = Omit<OpenAPIV3.OperationObject, 'requestBody'> & Required<Pick<OpenAPIV3.OperationObject, 'requestBody'>>;
+/**
+ * Checks if the provided OpenAPI operation object includes a request body.
+ *
+ * This function is a type guard that determines whether the `operation` object
+ * conforms to the `OperationObjectWithRequestBody` interface, which is an extension
+ * of the standard OpenAPIV3 `OperationObject` that includes a `requestBody`.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if the `operation` includes a `requestBody`, otherwise `false`.
+ */
 export declare function HasOperationRequestBody(operation: OpenAPIV3.OperationObject): operation is OperationObjectWithRequestBody;

package/src/lib/utilities/has-operation-request-body.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HasOperationRequestBody = void 0;
+/**
+ * Checks if the provided OpenAPI operation object includes a request body.
+ *
+ * This function is a type guard that determines whether the `operation` object
+ * conforms to the `OperationObjectWithRequestBody` interface, which is an extension
+ * of the standard OpenAPIV3 `OperationObject` that includes a `requestBody`.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if the `operation` includes a `requestBody`, otherwise `false`.
+ */
 function HasOperationRequestBody(operation) {
     return !!operation.requestBody;
 }

package/src/lib/utilities/has-operation-request-body.js.map

@@ -1 +1 @@
-{"version":3,"file":"has-operation-request-body.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/has-operation-request-body.ts"],"names":[],"mappings":";;;AAMA,SAAgB,uBAAuB,CAAC,SAAoC;IAC1E,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC;AACjC,CAAC;AAFD,0DAEC"}
+{"version":3,"file":"has-operation-request-body.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/has-operation-request-body.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CAAC,SAAoC;IAC1E,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC;AACjC,CAAC;AAFD,0DAEC"}