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

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"}