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

package/src/lib/utilities/http-request.d.ts

@@ -1 +1,31 @@
+/**
+ * Performs an HTTP GET request to retrieve JSON data from the specified URL.
+ *
+ * This function supports both HTTP and HTTPS protocols based on the URL provided.
+ * It returns a promise that resolves with the JSON parsed data if the request is successful
+ * and the response contains valid JSON content. If the request fails or the response is not
+ * valid JSON, the promise is rejected with an error message.
+ *
+ * @param {string} url - The URL from which to fetch data. Must be a valid HTTP or HTTPS URL.
+ * @returns {Promise<T>} A promise that resolves with the parsed JSON data as type T, or rejects with an error message.
+ *
+ * @template T - The type of the JSON data expected to be returned by the server.
+ *
+ * ### Example
+ *
+ * interface User {
+ * id: number;
+ * name: string;
+ * }
+ *
+ * const userPromise: Promise<User> = HttpRequest<User>('https://api.example.com/users/1');
+ * userPromise.then(user => console.log(user.name)).catch(error => console.error(error));
+ * ```
+ *
+ * ### Error Handling
+ * - If the status code of the response is not 200, the promise is rejected with "Request Failed. Status Code: [statusCode]".
+ * - If the content type of the response is not `application/json`, the promise is rejected with "Invalid content-type. Expected application/json but received [contentType]".
+ * - If there is an error in parsing the JSON data, the promise is rejected with the parsing error message.
+ * - Network errors or other request issues result in a promise rejection with the respective error message.
+ */
 export declare function HttpRequest<T>(url: string): Promise<T>;

package/src/lib/utilities/http-request.js

@@ -3,6 +3,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpRequest = void 0;
 const http = require("http");
 const https = require("https");
+/**
+ * Performs an HTTP GET request to retrieve JSON data from the specified URL.
+ *
+ * This function supports both HTTP and HTTPS protocols based on the URL provided.
+ * It returns a promise that resolves with the JSON parsed data if the request is successful
+ * and the response contains valid JSON content. If the request fails or the response is not
+ * valid JSON, the promise is rejected with an error message.
+ *
+ * @param {string} url - The URL from which to fetch data. Must be a valid HTTP or HTTPS URL.
+ * @returns {Promise<T>} A promise that resolves with the parsed JSON data as type T, or rejects with an error message.
+ *
+ * @template T - The type of the JSON data expected to be returned by the server.
+ *
+ * ### Example
+ *
+ * interface User {
+ * id: number;
+ * name: string;
+ * }
+ *
+ * const userPromise: Promise<User> = HttpRequest<User>('https://api.example.com/users/1');
+ * userPromise.then(user => console.log(user.name)).catch(error => console.error(error));
+ * ```
+ *
+ * ### Error Handling
+ * - If the status code of the response is not 200, the promise is rejected with "Request Failed. Status Code: [statusCode]".
+ * - If the content type of the response is not `application/json`, the promise is rejected with "Invalid content-type. Expected application/json but received [contentType]".
+ * - If there is an error in parsing the JSON data, the promise is rejected with the parsing error message.
+ * - Network errors or other request issues result in a promise rejection with the respective error message.
+ */
 function HttpRequest(url) {
     function callback(resolve, reject) {
         return function (res) {

package/src/lib/utilities/http-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-request.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/http-request.ts"],"names":[],"mappings":";;;AAAA,6BAA6B;AAC7B,+BAA+B;AAE/B,SAAgB,WAAW,CAAI,GAAW;IAExC,SAAS,QAAQ,CAAC,OAA6B,EAAE,MAA4B;QAE3E,OAAO,UAAU,GAAyB;YAExC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;YAC3B,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAEhD,IAAI,KAAK,CAAC;YACV,wDAAwD;YACxD,oCAAoC;YACpC,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,KAAK,GAAG,IAAI,KAAK,CAAC,mBAAmB;oBACnC,gBAAiB,UAAW,EAAE,CAAC,CAAC;YACpC,CAAC;iBAAM,IAAI,WAAW,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClE,KAAK,GAAG,IAAI,KAAK,CAAC,yBAAyB;oBACzC,0CAA2C,WAAY,EAAE,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,KAAK,EAAE,CAAC;gBACV,0CAA0C;gBAC1C,GAAG,CAAC,MAAM,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO;YACT,CAAC;YAED,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,IAAI,OAAO,GAAG,EAAE,CAAC;YACjB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvB,OAAO,IAAI,KAAK,CAAC;YACnB,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,IAAI,CAAC;oBACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC/B,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBACzB,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC;YACH,CAAC,CAAC,CAAC;QAEL,CAAC,CAAC;IAEJ,CAAC;IAED,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;IACL,CAAC;AAEH,CAAC;AAvDD,kCAuDC"}
+{"version":3,"file":"http-request.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/http-request.ts"],"names":[],"mappings":";;;AAAA,6BAA6B;AAC7B,+BAA+B;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,WAAW,CAAI,GAAW;IAExC,SAAS,QAAQ,CAAC,OAA6B,EAAE,MAA4B;QAE3E,OAAO,UAAU,GAAyB;YAExC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;YAC3B,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAEhD,IAAI,KAAK,CAAC;YACV,wDAAwD;YACxD,oCAAoC;YACpC,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,KAAK,GAAG,IAAI,KAAK,CAAC,mBAAmB;oBACnC,gBAAiB,UAAW,EAAE,CAAC,CAAC;YACpC,CAAC;iBAAM,IAAI,WAAW,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClE,KAAK,GAAG,IAAI,KAAK,CAAC,yBAAyB;oBACzC,0CAA2C,WAAY,EAAE,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,KAAK,EAAE,CAAC;gBACV,0CAA0C;gBAC1C,GAAG,CAAC,MAAM,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO;YACT,CAAC;YAED,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACxB,IAAI,OAAO,GAAG,EAAE,CAAC;YACjB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvB,OAAO,IAAI,KAAK,CAAC;YACnB,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,IAAI,CAAC;oBACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC/B,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBACzB,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACpB,CAAC;YACH,CAAC,CAAC,CAAC;QAEL,CAAC,CAAC;IAEJ,CAAC;IAED,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;IACL,CAAC;AAEH,CAAC;AAvDD,kCAuDC"}

package/src/lib/utilities/ignore-operation.d.ts

@@ -1,2 +1,13 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Creates a predicate function that checks if an OpenAPI operation should be ignored based on its tags.
+ *
+ * The returned function evaluates whether any of the operation's tags match the specified tags to ignore.
+ * If a match is found, the operation is considered for ignoring (i.e., the function returns `true`).
+ * If no tags are specified in the input, or the operation has no tags, the function will return `false`.
+ *
+ * @param {string[]} tags - An array of strings representing the tags to check against the operation's tags.
+ * @returns {(operation: OpenAPIV3.OperationObject) => boolean} A function that takes an OpenAPI operation object
+ * and returns `true` if any of the operation's tags match the tags to ignore, otherwise `false`.
+ */
 export declare function IgnoreOperation(tags?: string[]): (operation: OpenAPIV3.OperationObject) => boolean;

package/src/lib/utilities/ignore-operation.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IgnoreOperation = void 0;
+/**
+ * Creates a predicate function that checks if an OpenAPI operation should be ignored based on its tags.
+ *
+ * The returned function evaluates whether any of the operation's tags match the specified tags to ignore.
+ * If a match is found, the operation is considered for ignoring (i.e., the function returns `true`).
+ * If no tags are specified in the input, or the operation has no tags, the function will return `false`.
+ *
+ * @param {string[]} tags - An array of strings representing the tags to check against the operation's tags.
+ * @returns {(operation: OpenAPIV3.OperationObject) => boolean} A function that takes an OpenAPI operation object
+ * and returns `true` if any of the operation's tags match the tags to ignore, otherwise `false`.
+ */
 function IgnoreOperation(tags = []) {
     return operation => {
         var _a;

package/src/lib/utilities/ignore-operation.js.map

@@ -1 +1 @@
-{"version":3,"file":"ignore-operation.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/ignore-operation.ts"],"names":[],"mappings":";;;AAEA,SAAgB,eAAe,CAAC,OAAiB,EAAE;IACjD,OAAO,SAAS,CAAC,EAAE;;QAEjB,IAAI,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,0CAAE,MAAM,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,KAAK,CAAC;IAEf,CAAC,CAAC;AACJ,CAAC;AAVD,0CAUC"}
+{"version":3,"file":"ignore-operation.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/ignore-operation.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,OAAiB,EAAE;IACjD,OAAO,SAAS,CAAC,EAAE;;QAEjB,IAAI,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,0CAAE,MAAM,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,KAAK,CAAC;IAEf,CAAC,CAAC;AACJ,CAAC;AAVD,0CAUC"}

package/src/lib/utilities/is-collection-response.d.ts

@@ -1,2 +1,15 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Determines if the given OpenAPI operation object represents a collection response.
+ *
+ * This function checks if the operation's response schema explicitly defines an array type,
+ * indicating that the response is a collection of items rather than a single item. It first
+ * retrieves the response schema from the operation object, then verifies that the schema
+ * is neither a wildcard schema object nor a reference to another schema. If these conditions
+ * are met and the response type is an array, the function returns true, indicating a collection
+ * response.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to evaluate.
+ * @returns {boolean} True if the operation's response is a collection (array type), false otherwise.
+ */
 export declare function IsCollectionResponse(operation: OpenAPIV3.OperationObject): boolean;

package/src/lib/utilities/is-collection-response.js

@@ -4,6 +4,19 @@ exports.IsCollectionResponse = void 0;
 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 if the given OpenAPI operation object represents a collection response.
+ *
+ * This function checks if the operation's response schema explicitly defines an array type,
+ * indicating that the response is a collection of items rather than a single item. It first
+ * retrieves the response schema from the operation object, then verifies that the schema
+ * is neither a wildcard schema object nor a reference to another schema. If these conditions
+ * are met and the response type is an array, the function returns true, indicating a collection
+ * response.
+ *
+ * @param {OpenAPIV3.OperationObject} operation - The OpenAPI operation object to evaluate.
+ * @returns {boolean} True if the operation's response is a collection (array type), false otherwise.
+ */
 function IsCollectionResponse(operation) {
     const response = (0, get_response_1.GetResponse)(operation);
     if (response && !(0, any_schema_object_1.IsAnySchemaObject)(response)) {

package/src/lib/utilities/is-collection-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-collection-response.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-collection-response.ts"],"names":[],"mappings":";;;AACA,2DAAwD;AACxD,iDAA6C;AAC7C,+DAA0D;AAE1D,SAAgB,oBAAoB,CAAC,SAAoC;IAEvE,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;IAExC,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,OAAO,QAAQ,CAAC,IAAI,KAAK,OAAO,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAXD,oDAWC"}
+{"version":3,"file":"is-collection-response.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-collection-response.ts"],"names":[],"mappings":";;;AACA,2DAAwD;AACxD,iDAA6C;AAC7C,+DAA0D;AAE1D;;;;;;;;;;;;GAYG;AACH,SAAgB,oBAAoB,CAAC,SAAoC;IAEvE,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,SAAS,CAAC,CAAC;IAExC,IAAI,QAAQ,IAAI,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAA,uCAAiB,EAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,OAAO,QAAQ,CAAC,IAAI,KAAK,OAAO,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAXD,oDAWC"}

package/src/lib/utilities/is-http-method.d.ts

@@ -1 +1,15 @@
+/**
+ * Checks if the provided method string is a valid HTTP method.
+ *
+ * This function determines if the given string corresponds to one of the common HTTP methods
+ * used in web development. It specifically checks for 'get', 'put', 'post', 'delete', or 'patch'.
+ *
+ * @param method - The method string to check.
+ * @returns True if the method is one of the specified HTTP methods, false otherwise.
+ *
+ * @example
+ * IsHttpMethod('get'); // returns true
+ * IsHttpMethod('post'); // returns true
+ * IsHttpMethod('connect'); // returns false
+ */
 export declare function IsHttpMethod(method: string): method is 'get' | 'put' | 'post' | 'delete' | 'patch';

package/src/lib/utilities/is-http-method.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsHttpMethod = void 0;
+/**
+ * Checks if the provided method string is a valid HTTP method.
+ *
+ * This function determines if the given string corresponds to one of the common HTTP methods
+ * used in web development. It specifically checks for 'get', 'put', 'post', 'delete', or 'patch'.
+ *
+ * @param method - The method string to check.
+ * @returns True if the method is one of the specified HTTP methods, false otherwise.
+ *
+ * @example
+ * IsHttpMethod('get'); // returns true
+ * IsHttpMethod('post'); // returns true
+ * IsHttpMethod('connect'); // returns false
+ */
 function IsHttpMethod(method) {
     return ['get', 'put', 'post', 'delete', 'patch'].includes(method);
 }

package/src/lib/utilities/is-http-method.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-http-method.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-http-method.ts"],"names":[],"mappings":";;;AAAA,SAAgB,YAAY,CAAC,MAAc;IACzC,OAAO,CAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"is-http-method.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-http-method.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;GAaG;AACH,SAAgB,YAAY,CAAC,MAAc;IACzC,OAAO,CAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC;AAFD,oCAEC"}

package/src/lib/utilities/is-open-api-schema-from-path.d.ts

@@ -1,2 +1,13 @@
 import { OpenApiSchema, OpenApiSchemaFromPath } from '../types';
+/**
+ * Determines if the provided `options` object conforms to the `OpenApiSchemaFromPath` interface.
+ *
+ * This function checks if the `options` object:
+ * 1. Exists and is not null.
+ * 2. Contains an index signature, ensuring it can hold properties dynamically.
+ * 3. Includes a 'path' property, which is essential for identifying it as an instance of `OpenApiSchemaFromPath`.
+ *
+ * @param options - The object to be tested against the `OpenApiSchemaFromPath` interface.
+ * @returns `true` if `options` matches the `OpenApiSchemaFromPath` interface, otherwise `false`.
+ */
 export declare function IsOpenApiSchemaFromPath(options: OpenApiSchema): options is OpenApiSchemaFromPath;

package/src/lib/utilities/is-open-api-schema-from-path.js

@@ -2,6 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsOpenApiSchemaFromPath = void 0;
 const utilities_1 = require("@rxap/utilities");
+/**
+ * Determines if the provided `options` object conforms to the `OpenApiSchemaFromPath` interface.
+ *
+ * This function checks if the `options` object:
+ * 1. Exists and is not null.
+ * 2. Contains an index signature, ensuring it can hold properties dynamically.
+ * 3. Includes a 'path' property, which is essential for identifying it as an instance of `OpenApiSchemaFromPath`.
+ *
+ * @param options - The object to be tested against the `OpenApiSchemaFromPath` interface.
+ * @returns `true` if `options` matches the `OpenApiSchemaFromPath` interface, otherwise `false`.
+ */
 function IsOpenApiSchemaFromPath(options) {
     return !!options && (0, utilities_1.hasIndexSignature)(options) && !!options['path'];
 }

package/src/lib/utilities/is-open-api-schema-from-path.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-open-api-schema-from-path.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-open-api-schema-from-path.ts"],"names":[],"mappings":";;;AAAA,+CAAoD;AAMpD,SAAgB,uBAAuB,CAAC,OAAsB;IAC5D,OAAO,CAAC,CAAC,OAAO,IAAI,IAAA,6BAAiB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC;AAFD,0DAEC"}
+{"version":3,"file":"is-open-api-schema-from-path.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-open-api-schema-from-path.ts"],"names":[],"mappings":";;;AAAA,+CAAoD;AAMpD;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CAAC,OAAsB;IAC5D,OAAO,CAAC,CAAC,OAAO,IAAI,IAAA,6BAAiB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACtE,CAAC;AAFD,0DAEC"}

package/src/lib/utilities/is-operation-object.d.ts

@@ -1,2 +1,18 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Checks if a given object is a valid OpenAPIV3 OperationObject based on the presence of an `operationId` property.
+ *
+ * An OpenAPI OperationObject typically represents a single API operation on a path and must have an `operationId` which is a unique string used to identify the operation.
+ *
+ * @param obj - The object to be checked.
+ * @returns `true` if the object has a property `operationId` indicating it's likely an OpenAPIV3 OperationObject, otherwise `false`.
+ * @example
+ *
+ * const apiOperation = {
+ * operationId: 'getUser',
+ * summary: 'Gets a user by ID'
+ * };
+ * console.log(IsOperationObject(apiOperation)); // Output: true
+ * ```
+ */
 export declare function IsOperationObject(obj: any): obj is OpenAPIV3.OperationObject;

package/src/lib/utilities/is-operation-object.js

@@ -1,6 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsOperationObject = void 0;
+/**
+ * Checks if a given object is a valid OpenAPIV3 OperationObject based on the presence of an `operationId` property.
+ *
+ * An OpenAPI OperationObject typically represents a single API operation on a path and must have an `operationId` which is a unique string used to identify the operation.
+ *
+ * @param obj - The object to be checked.
+ * @returns `true` if the object has a property `operationId` indicating it's likely an OpenAPIV3 OperationObject, otherwise `false`.
+ * @example
+ *
+ * const apiOperation = {
+ * operationId: 'getUser',
+ * summary: 'Gets a user by ID'
+ * };
+ * console.log(IsOperationObject(apiOperation)); // Output: true
+ * ```
+ */
 function IsOperationObject(obj) {
     return !!obj && !!obj['operationId'];
 }

package/src/lib/utilities/is-operation-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-operation-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-operation-object.ts"],"names":[],"mappings":";;;AAEA,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"is-operation-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-operation-object.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AACvC,CAAC;AAFD,8CAEC"}

package/src/lib/utilities/is-reference-object.d.ts

@@ -1,2 +1,24 @@
 import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Checks if the provided object is a ReferenceObject as defined in the OpenAPI V3 specification.
+ *
+ * A ReferenceObject in the OpenAPI specification is an object that contains a `$ref` property.
+ * This function determines if the given object has a `$ref` property, which would indicate that
+ * it conforms to the ReferenceObject structure.
+ *
+ * @param {any} obj - The object to check. This parameter is optional.
+ * @returns {boolean} - Returns `true` if the object is a ReferenceObject, otherwise returns `false`.
+ *
+ * @example
+ * // returns true
+ * IsReferenceObject({ '$ref': '#/components/schemas/Example' });
+ *
+ * @example
+ * // returns false
+ * IsReferenceObject({ 'name': 'Example' });
+ *
+ * @example
+ * // returns false
+ * IsReferenceObject();
+ */
 export declare function IsReferenceObject(obj?: any): obj is OpenAPIV3.ReferenceObject;

package/src/lib/utilities/is-reference-object.js

@@ -1,6 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsReferenceObject = void 0;
+/**
+ * Checks if the provided object is a ReferenceObject as defined in the OpenAPI V3 specification.
+ *
+ * A ReferenceObject in the OpenAPI specification is an object that contains a `$ref` property.
+ * This function determines if the given object has a `$ref` property, which would indicate that
+ * it conforms to the ReferenceObject structure.
+ *
+ * @param {any} obj - The object to check. This parameter is optional.
+ * @returns {boolean} - Returns `true` if the object is a ReferenceObject, otherwise returns `false`.
+ *
+ * @example
+ * // returns true
+ * IsReferenceObject({ '$ref': '#/components/schemas/Example' });
+ *
+ * @example
+ * // returns false
+ * IsReferenceObject({ 'name': 'Example' });
+ *
+ * @example
+ * // returns false
+ * IsReferenceObject();
+ */
 function IsReferenceObject(obj) {
     return !!obj && !!obj['$ref'];
 }

package/src/lib/utilities/is-reference-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-reference-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-reference-object.ts"],"names":[],"mappings":";;;AAEA,SAAgB,iBAAiB,CAAC,GAAS;IACzC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAFD,8CAEC"}
+{"version":3,"file":"is-reference-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-reference-object.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,iBAAiB,CAAC,GAAS;IACzC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAFD,8CAEC"}

package/src/lib/utilities/is-without-parameters.d.ts

@@ -1,3 +1,13 @@
 import { OpenAPIV3 } from 'openapi-types';
 export type OperationObjectWithoutParameters = Omit<OpenAPIV3.OperationObject, 'parameters'>;
+/**
+ * Checks if the provided OpenAPI operation object does not contain any parameters.
+ *
+ * This function is a type guard that determines whether the `operation` object passed to it
+ * conforms to the `OperationObjectWithoutParameters` type, which is a subtype of the standard
+ * OpenAPI operation object that specifically has no parameters.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if the operation object has no parameters or an empty parameters array, otherwise `false`.
+ */
 export declare function IsWithoutParameters(operation: OpenAPIV3.OperationObject): operation is OperationObjectWithoutParameters;

package/src/lib/utilities/is-without-parameters.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsWithoutParameters = void 0;
+/**
+ * Checks if the provided OpenAPI operation object does not contain any parameters.
+ *
+ * This function is a type guard that determines whether the `operation` object passed to it
+ * conforms to the `OperationObjectWithoutParameters` type, which is a subtype of the standard
+ * OpenAPI operation object that specifically has no parameters.
+ *
+ * @param operation - The OpenAPI operation object to check.
+ * @returns `true` if the operation object has no parameters or an empty parameters array, otherwise `false`.
+ */
 function IsWithoutParameters(operation) {
     return !operation.parameters || !operation.parameters.length;
 }

package/src/lib/utilities/is-without-parameters.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-without-parameters.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-without-parameters.ts"],"names":[],"mappings":";;;AAIA,SAAgB,mBAAmB,CAAC,SAAoC;IACtE,OAAO,CAAC,SAAS,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;AAC/D,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"is-without-parameters.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/is-without-parameters.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,SAAoC;IACtE,OAAO,CAAC,SAAS,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;AAC/D,CAAC;AAFD,kDAEC"}

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

@@ -1,9 +1,35 @@
 export interface RefSchemaObject {
     $ref: string;
 }
+/**
+ * Checks if the given object is a reference schema object.
+ *
+ * A reference schema object is typically used in JSON schema and OpenAPI specifications
+ * to reuse definitions. This function determines if the provided object contains a `$ref` property,
+ * which is a common indicator of a reference schema object.
+ *
+ * @param obj - The object to check.
+ * @returns True if `obj` contains a `$ref` property, indicating it is a reference schema object; otherwise, false.
+ *
+ * @example
+ *
+ * const schema = { $ref: '#/definitions/example' };
+ * console.log(IsRefSchemaObject(schema)); // Output: true
+ * ```
+ */
 export declare function IsRefSchemaObject(obj: any): obj is RefSchemaObject;
 export interface ArrayRefSchemaObject {
     type: 'array';
     items: RefSchemaObject;
 }
+/**
+ * Checks if a given object conforms to the `ArrayRefSchemaObject` type.
+ *
+ * This function determines if the provided object is an `ArrayRefSchemaObject` by checking specific properties:
+ * - The object must exist and have a `type` property equal to 'array'.
+ * - The `items` property of the object must satisfy the `IsRefSchemaObject` check.
+ *
+ * @param obj - The object to be checked.
+ * @returns True if the object matches the `ArrayRefSchemaObject` type criteria, false otherwise.
+ */
 export declare function IsArrayRefSchemaObject(obj: any): obj is ArrayRefSchemaObject;

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

@@ -1,10 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IsArrayRefSchemaObject = exports.IsRefSchemaObject = void 0;
+/**
+ * Checks if the given object is a reference schema object.
+ *
+ * A reference schema object is typically used in JSON schema and OpenAPI specifications
+ * to reuse definitions. This function determines if the provided object contains a `$ref` property,
+ * which is a common indicator of a reference schema object.
+ *
+ * @param obj - The object to check.
+ * @returns True if `obj` contains a `$ref` property, indicating it is a reference schema object; otherwise, false.
+ *
+ * @example
+ *
+ * const schema = { $ref: '#/definitions/example' };
+ * console.log(IsRefSchemaObject(schema)); // Output: true
+ * ```
+ */
 function IsRefSchemaObject(obj) {
     return obj && obj['$ref'];
 }
 exports.IsRefSchemaObject = IsRefSchemaObject;
+/**
+ * Checks if a given object conforms to the `ArrayRefSchemaObject` type.
+ *
+ * This function determines if the provided object is an `ArrayRefSchemaObject` by checking specific properties:
+ * - The object must exist and have a `type` property equal to 'array'.
+ * - The `items` property of the object must satisfy the `IsRefSchemaObject` check.
+ *
+ * @param obj - The object to be checked.
+ * @returns True if the object matches the `ArrayRefSchemaObject` type criteria, false otherwise.
+ */
 function IsArrayRefSchemaObject(obj) {
     return obj && obj.type === 'array' && IsRefSchemaObject(obj.items);
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ref-schema-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/ref-schema-object.ts"],"names":[],"mappings":";;;AAIA,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAFD,8CAEC;AAOD,SAAgB,sBAAsB,CAAC,GAAQ;IAC7C,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAFD,wDAEC"}
+{"version":3,"file":"ref-schema-object.js","sourceRoot":"","sources":["../../../../../../../packages/workspace/open-api/src/lib/utilities/ref-schema-object.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAFD,8CAEC;AAOD;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CAAC,GAAQ;IAC7C,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAFD,wDAEC"}