@skmtc/core 0.0.802 → 0.0.803

package/script/oas/number/toNumber.d.ts

@@ -5,6 +5,68 @@ type ToNumberArgs = {
     value: OpenAPIV3.SchemaObject;
     context: ParseContext;
 };
+/**
+ * Transforms an OpenAPI v3 number schema object into an internal OAS number representation.
+ *
+ * This function processes OpenAPI number schemas by extracting and parsing nullable values,
+ * examples, enumerations, and default values. It handles the complete transformation from
+ * raw OpenAPI JSON to the SKMTC internal number representation with proper validation
+ * of number formats and constraints.
+ *
+ * The transformation follows a pipeline approach:
+ * 1. Parse nullable flag and extract base value
+ * 2. Parse example values with nullable support
+ * 3. Parse enumeration constraints
+ * 4. Parse default values
+ * 5. Create final OasNumber instance with format validation
+ *
+ * @param args - Transformation arguments
+ * @param args.context - Parse context providing utilities and tracing
+ * @param args.value - The OpenAPI v3 number schema object to transform
+ * @returns Transformed OAS number object with parsed properties
+ *
+ * @example Basic number transformation
+ * ```typescript
+ * import { toNumber } from '@skmtc/core';
+ *
+ * const openApiNumber = {
+ *   type: 'number',
+ *   format: 'double',
+ *   minimum: 0,
+ *   maximum: 100
+ * };
+ *
+ * const oasNumber = toNumber({
+ *   context: parseContext,
+ *   value: openApiNumber
+ * });
+ *
+ * console.log(oasNumber.format); // 'double'
+ * console.log(oasNumber.minimum); // 0
+ * ```
+ *
+ * @example Number with nullable and constraints
+ * ```typescript
+ * const priceNumber = {
+ *   type: 'number',
+ *   format: 'float',
+ *   nullable: true,
+ *   minimum: 0.01,
+ *   maximum: 9999.99,
+ *   exclusiveMaximum: true,
+ *   default: null,
+ *   example: 19.99
+ * };
+ *
+ * const oasNumber = toNumber({
+ *   context: parseContext,
+ *   value: priceNumber
+ * });
+ *
+ * console.log(oasNumber.nullable); // true
+ * console.log(oasNumber.exclusiveMaximum); // true
+ * ```
+ */
 export declare const toNumber: ({ context, value }: ToNumberArgs) => OasNumber;
 export {};
 //# sourceMappingURL=toNumber.d.ts.map

package/script/oas/number/toNumber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toNumber.d.ts","sourceRoot":"","sources":["../../../src/oas/number/toNumber.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAQvC,KAAK,YAAY,GAAG;IAClB,KAAK,EAAE,SAAS,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,QAAQ,GAAI,oBAAoB,YAAY,KAAG,SA2B3D,CAAA"}
+{"version":3,"file":"toNumber.d.ts","sourceRoot":"","sources":["../../../src/oas/number/toNumber.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAQvC,KAAK,YAAY,GAAG;IAClB,KAAK,EAAE,SAAS,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,YAAY,CAAA;CACtB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,eAAO,MAAM,QAAQ,GAAI,oBAAoB,YAAY,KAAG,SA2B3D,CAAA"}

package/script/oas/number/toNumber.js

@@ -42,6 +42,68 @@ const parseNullable_js_1 = require("../_helpers/parseNullable.js");
 const parseExample_js_1 = require("../_helpers/parseExample.js");
 const parseEnum_js_1 = require("../_helpers/parseEnum.js");
 const parseFormat_js_1 = require("../_helpers/parseFormat.js");
+/**
+ * Transforms an OpenAPI v3 number schema object into an internal OAS number representation.
+ *
+ * This function processes OpenAPI number schemas by extracting and parsing nullable values,
+ * examples, enumerations, and default values. It handles the complete transformation from
+ * raw OpenAPI JSON to the SKMTC internal number representation with proper validation
+ * of number formats and constraints.
+ *
+ * The transformation follows a pipeline approach:
+ * 1. Parse nullable flag and extract base value
+ * 2. Parse example values with nullable support
+ * 3. Parse enumeration constraints
+ * 4. Parse default values
+ * 5. Create final OasNumber instance with format validation
+ *
+ * @param args - Transformation arguments
+ * @param args.context - Parse context providing utilities and tracing
+ * @param args.value - The OpenAPI v3 number schema object to transform
+ * @returns Transformed OAS number object with parsed properties
+ *
+ * @example Basic number transformation
+ * ```typescript
+ * import { toNumber } from '@skmtc/core';
+ *
+ * const openApiNumber = {
+ *   type: 'number',
+ *   format: 'double',
+ *   minimum: 0,
+ *   maximum: 100
+ * };
+ *
+ * const oasNumber = toNumber({
+ *   context: parseContext,
+ *   value: openApiNumber
+ * });
+ *
+ * console.log(oasNumber.format); // 'double'
+ * console.log(oasNumber.minimum); // 0
+ * ```
+ *
+ * @example Number with nullable and constraints
+ * ```typescript
+ * const priceNumber = {
+ *   type: 'number',
+ *   format: 'float',
+ *   nullable: true,
+ *   minimum: 0.01,
+ *   maximum: 9999.99,
+ *   exclusiveMaximum: true,
+ *   default: null,
+ *   example: 19.99
+ * };
+ *
+ * const oasNumber = toNumber({
+ *   context: parseContext,
+ *   value: priceNumber
+ * });
+ *
+ * console.log(oasNumber.nullable); // true
+ * console.log(oasNumber.exclusiveMaximum); // true
+ * ```
+ */
 const toNumber = ({ context, value }) => {
     const { nullable, value: valueWithoutNullable } = (0, parseNullable_js_1.parseNullable)({
         value,

package/script/oas/parameter/Parameter.d.ts

@@ -188,22 +188,69 @@ export declare class OasParameter {
     name: string;
     /** Where the parameter is located (path, query, header, cookie) */
     location: OasParameterLocation;
+    /** A brief description of the parameter's purpose and usage */
     description?: string | undefined;
+    /** Determines whether this parameter is mandatory for the operation */
     required?: boolean | undefined;
+    /** Indicates that the parameter is deprecated and should be avoided */
     deprecated?: boolean | undefined;
+    /** Whether to allow empty values for this parameter */
     allowEmptyValue?: boolean | undefined;
+    /** Whether reserved characters are allowed in parameter values */
     allowReserved?: boolean | undefined;
+    /** The schema defining the parameter's data type and validation rules */
     schema?: OasSchema | OasRef<'schema'> | undefined;
+    /** Example values demonstrating parameter usage */
     examples?: Record<string, OasExample | OasRef<'example'>> | undefined;
+    /** Media type definitions for complex parameter content */
     content?: Record<string, OasMediaType> | undefined;
+    /** The serialization style for the parameter (form, simple, etc.) */
     style: OasParameterStyle;
+    /** Whether to explode parameter values into separate key-value pairs */
     explode: boolean;
+    /** Custom extension fields (x-* properties) defined for this parameter */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasParameter instance.
+     *
+     * @param fields - Parameter configuration fields including name, location, schema, and serialization options
+     */
     constructor(fields: ParameterFields);
+    /**
+     * Determines if this parameter is a reference object.
+     *
+     * @returns Always false since this is a concrete parameter instance, not a reference
+     */
     isRef(): this is OasRef<'parameter'>;
+    /**
+     * Resolves this parameter object.
+     *
+     * @returns The parameter instance itself since it's already a concrete object
+     */
     resolve(): OasParameter;
+    /**
+     * Resolves this parameter object one level.
+     *
+     * @returns The parameter instance itself since it's already a concrete object
+     */
     resolveOnce(): OasParameter;
+    /**
+     * Extracts the schema for this parameter.
+     *
+     * Returns the direct schema if available, or extracts schema from content
+     * for the specified media type.
+     *
+     * @param mediaType - Media type to extract schema from when using content definitions
+     * @returns The parameter's schema object
+     * @throws Error if no schema is found for the specified media type
+     */
     toSchema(mediaType?: string): OasSchema | OasRef<'schema'>;
+    /**
+     * Converts this OAS parameter to an OpenAPI v3 JSON schema representation.
+     *
+     * @param options - Conversion options including reference handling and formatting preferences
+     * @returns OpenAPI v3 parameter object with all properties and validation constraints
+     */
     toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.ParameterObject;
 }
 //# sourceMappingURL=Parameter.d.ts.map

package/script/oas/parameter/Parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/Parameter.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAK9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,iDAAiD;IACjD,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,sDAAsD;IACtD,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,qEAAqE;IACrE,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,oDAAoD;IACpD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,gDAAgD;IAChD,KAAK,EAAE,iBAAiB,CAAA;IACxB,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAA;IAChB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+IG;AACH,qBAAa,YAAY;IACvB,gDAAgD;IAChD,OAAO,EAAE,WAAW,CAAc;IAClC,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,mEAAmE;IACnE,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,KAAK,EAAE,iBAAiB,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,eAAe;IAkBnC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC;IAIpC,OAAO,IAAI,YAAY;IAIvB,WAAW,IAAI,YAAY;IAI3B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAc9E,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAuBtE"}
+{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/Parameter.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAK9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,iDAAiD;IACjD,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,sDAAsD;IACtD,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,qEAAqE;IACrE,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,oDAAoD;IACpD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,gDAAgD;IAChD,KAAK,EAAE,iBAAiB,CAAA;IACxB,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAA;IAChB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+IG;AACH,qBAAa,YAAY;IACvB,gDAAgD;IAChD,OAAO,EAAE,WAAW,CAAc;IAClC,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,mEAAmE;IACnE,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,uEAAuE;IACvE,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,uDAAuD;IACvD,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,kEAAkE;IAClE,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,yEAAyE;IACzE,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,qEAAqE;IACrE,KAAK,EAAE,iBAAiB,CAAA;IACxB,wEAAwE;IACxE,OAAO,EAAE,OAAO,CAAA;IAChB,0EAA0E;IAC1E,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;;;OAIG;gBACS,MAAM,EAAE,eAAe;IAkBnC;;;;OAIG;IACH,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC;IAIpC;;;;OAIG;IACH,OAAO,IAAI,YAAY;IAIvB;;;;OAIG;IACH,WAAW,IAAI,YAAY;IAI3B;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAc9E;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAuBtE"}

package/script/oas/parameter/Parameter.js

@@ -147,6 +147,11 @@ require("../../_dnt.polyfills.js");
  * ```
  */
 class OasParameter {
+    /**
+     * Creates a new OasParameter instance.
+     *
+     * @param fields - Parameter configuration fields including name, location, schema, and serialization options
+     */
     constructor(fields) {
         /** Type identifier for OAS parameter objects */
         Object.defineProperty(this, "oasType", {
@@ -169,66 +174,77 @@ class OasParameter {
             writable: true,
             value: void 0
         });
+        /** A brief description of the parameter's purpose and usage */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Determines whether this parameter is mandatory for the operation */
         Object.defineProperty(this, "required", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Indicates that the parameter is deprecated and should be avoided */
         Object.defineProperty(this, "deprecated", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Whether to allow empty values for this parameter */
         Object.defineProperty(this, "allowEmptyValue", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Whether reserved characters are allowed in parameter values */
         Object.defineProperty(this, "allowReserved", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The schema defining the parameter's data type and validation rules */
         Object.defineProperty(this, "schema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Example values demonstrating parameter usage */
         Object.defineProperty(this, "examples", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Media type definitions for complex parameter content */
         Object.defineProperty(this, "content", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The serialization style for the parameter (form, simple, etc.) */
         Object.defineProperty(this, "style", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Whether to explode parameter values into separate key-value pairs */
         Object.defineProperty(this, "explode", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) defined for this parameter */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,
@@ -251,15 +267,40 @@ class OasParameter {
         this.explode = fields.explode;
         this.extensionFields = fields.extensionFields;
     }
+    /**
+     * Determines if this parameter is a reference object.
+     *
+     * @returns Always false since this is a concrete parameter instance, not a reference
+     */
     isRef() {
         return false;
     }
+    /**
+     * Resolves this parameter object.
+     *
+     * @returns The parameter instance itself since it's already a concrete object
+     */
     resolve() {
         return this;
     }
+    /**
+     * Resolves this parameter object one level.
+     *
+     * @returns The parameter instance itself since it's already a concrete object
+     */
     resolveOnce() {
         return this;
     }
+    /**
+     * Extracts the schema for this parameter.
+     *
+     * Returns the direct schema if available, or extracts schema from content
+     * for the specified media type.
+     *
+     * @param mediaType - Media type to extract schema from when using content definitions
+     * @returns The parameter's schema object
+     * @throws Error if no schema is found for the specified media type
+     */
     toSchema(mediaType = 'application/json') {
         if (this.schema) {
             return this.schema;
@@ -270,6 +311,12 @@ class OasParameter {
         }
         return schema;
     }
+    /**
+     * Converts this OAS parameter to an OpenAPI v3 JSON schema representation.
+     *
+     * @param options - Conversion options including reference handling and formatting preferences
+     * @returns OpenAPI v3 parameter object with all properties and validation constraints
+     */
     toJsonSchema(options) {
         return {
             name: this.name,

package/script/types/CustomValue.d.ts

@@ -9,15 +9,73 @@ type CreateArgs = {
     value: Stringable;
     generatorKey?: GeneratorKey;
 };
+/**
+ * Represents a custom value in the SKMTC generation pipeline.
+ *
+ * CustomValue allows generators to create arbitrary content that doesn't fit
+ * standard schema types. Used for injecting custom code, templates, or specialized
+ * content during the generation process.
+ *
+ * @example Creating custom content
+ * ```typescript
+ * const customValue = new CustomValue({
+ *   context: generateContext,
+ *   value: 'const customCode = "generated";',
+ *   generatorKey: 'my-generator'
+ * });
+ *
+ * console.log(customValue.toString()); // "const customCode = "generated";"
+ * ```
+ */
 export declare class CustomValue extends ContentBase {
+    /** Type identifier for this custom value */
     type: "custom";
+    /** The underlying value content that can be converted to string */
     value: Stringable;
+    /**
+     * Creates a new CustomValue instance.
+     *
+     * @param args - Creation arguments including context, value, and optional generator key
+     */
     constructor({ context, value, generatorKey }: CreateArgs);
+    /**
+     * Determines if this custom value is a reference.
+     *
+     * @returns Always false since custom values are concrete content, not references
+     */
     isRef(): this is OasRef<'schema'>;
+    /**
+     * Resolves this custom value.
+     *
+     * @returns The custom value itself since it's already resolved
+     */
     resolve(): CustomValue;
+    /**
+     * Resolves this custom value one level.
+     *
+     * @returns The custom value itself since it's already resolved
+     */
     resolveOnce(): CustomValue;
+    /**
+     * Converts the custom value to its string representation.
+     *
+     * @returns String representation of the underlying value
+     */
     toString(): string;
 }
+/**
+ * Type guard function to check if a value is a CustomValue instance.
+ *
+ * @param value - Value to check
+ * @returns True if the value is a CustomValue, false otherwise
+ *
+ * @example Type checking
+ * ```typescript
+ * if (isCustomValue(someValue)) {
+ *   console.log(someValue.value); // TypeScript knows it's a CustomValue
+ * }
+ * ```
+ */
 export declare const isCustomValue: (value: unknown) => value is CustomValue;
 export {};
 //# sourceMappingURL=CustomValue.d.ts.map

package/script/types/CustomValue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomValue.d.ts","sourceRoot":"","sources":["../../src/types/CustomValue.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,KAAK,UAAU,GAAG;IAChB,OAAO,EAAE,eAAe,CAAA;IACxB,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAED,qBAAa,WAAY,SAAQ,WAAW;IAC1C,IAAI,EAAG,QAAQ,CAAS;IACxB,KAAK,EAAE,UAAU,CAAA;gBAEL,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,UAAU;IAMxD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,WAAW;IAItB,WAAW,IAAI,WAAW;IAIjB,QAAQ,IAAI,MAAM;CAG5B;AAED,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA"}
+{"version":3,"file":"CustomValue.d.ts","sourceRoot":"","sources":["../../src/types/CustomValue.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,KAAK,UAAU,GAAG;IAChB,OAAO,EAAE,eAAe,CAAA;IACxB,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,4CAA4C;IAC5C,IAAI,EAAG,QAAQ,CAAS;IACxB,mEAAmE;IACnE,KAAK,EAAE,UAAU,CAAA;IAEjB;;;;OAIG;gBACS,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,UAAU;IAMxD;;;;OAIG;IACH,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC;;;;OAIG;IACH,OAAO,IAAI,WAAW;IAItB;;;;OAIG;IACH,WAAW,IAAI,WAAW;IAI1B;;;;OAIG;IACM,QAAQ,IAAI,MAAM;CAG5B;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,WAEvD,CAAA"}

package/script/types/CustomValue.js

@@ -3,15 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isCustomValue = exports.CustomValue = void 0;
 require("../_dnt.polyfills.js");
 const ContentBase_js_1 = require("../dsl/ContentBase.js");
+/**
+ * Represents a custom value in the SKMTC generation pipeline.
+ *
+ * CustomValue allows generators to create arbitrary content that doesn't fit
+ * standard schema types. Used for injecting custom code, templates, or specialized
+ * content during the generation process.
+ *
+ * @example Creating custom content
+ * ```typescript
+ * const customValue = new CustomValue({
+ *   context: generateContext,
+ *   value: 'const customCode = "generated";',
+ *   generatorKey: 'my-generator'
+ * });
+ *
+ * console.log(customValue.toString()); // "const customCode = "generated";"
+ * ```
+ */
 class CustomValue extends ContentBase_js_1.ContentBase {
+    /**
+     * Creates a new CustomValue instance.
+     *
+     * @param args - Creation arguments including context, value, and optional generator key
+     */
     constructor({ context, value, generatorKey }) {
         super({ context, generatorKey });
+        /** Type identifier for this custom value */
         Object.defineProperty(this, "type", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'custom'
         });
+        /** The underlying value content that can be converted to string */
         Object.defineProperty(this, "value", {
             enumerable: true,
             configurable: true,
@@ -20,20 +45,53 @@ class CustomValue extends ContentBase_js_1.ContentBase {
         });
         this.value = value;
     }
+    /**
+     * Determines if this custom value is a reference.
+     *
+     * @returns Always false since custom values are concrete content, not references
+     */
     isRef() {
         return false;
     }
+    /**
+     * Resolves this custom value.
+     *
+     * @returns The custom value itself since it's already resolved
+     */
     resolve() {
         return this;
     }
+    /**
+     * Resolves this custom value one level.
+     *
+     * @returns The custom value itself since it's already resolved
+     */
     resolveOnce() {
         return this;
     }
+    /**
+     * Converts the custom value to its string representation.
+     *
+     * @returns String representation of the underlying value
+     */
     toString() {
         return `${this.value}`;
     }
 }
 exports.CustomValue = CustomValue;
+/**
+ * Type guard function to check if a value is a CustomValue instance.
+ *
+ * @param value - Value to check
+ * @returns True if the value is a CustomValue, false otherwise
+ *
+ * @example Type checking
+ * ```typescript
+ * if (isCustomValue(someValue)) {
+ *   console.log(someValue.value); // TypeScript knows it's a CustomValue
+ * }
+ * ```
+ */
 const isCustomValue = (value) => {
     return Boolean(value && typeof value === 'object' && 'type' in value && value.type === 'custom');
 };

package/script/types/DenoJson.d.ts

@@ -1,12 +1,36 @@
 import "../_dnt.polyfills.js";
 import * as v from 'valibot';
+/**
+ * Valibot schema for root-level deno.json configuration files.
+ *
+ * Validates workspace-level deno.json files that manage multiple packages
+ * and define workspace-wide imports and exports.
+ */
 export declare const rootDenoJson: v.GenericSchema<RootDenoJson>;
+/**
+ * Type definition for root-level deno.json configuration.
+ *
+ * Represents the structure of workspace-level deno.json files that coordinate
+ * multiple packages within a Deno workspace.
+ */
 export type RootDenoJson = {
     imports?: Record<string, string>;
     exports?: Record<string, string>;
     workspace?: string[];
 };
+/**
+ * Valibot schema for package-level deno.json configuration files.
+ *
+ * Validates individual package deno.json files that define package-specific
+ * metadata, dependencies, and export configurations.
+ */
 export declare const packageDenoJson: v.GenericSchema<PackageDenoJson>;
+/**
+ * Type definition for package-level deno.json configuration.
+ *
+ * Represents the structure of individual package deno.json files with
+ * required name/version fields and optional import/export configurations.
+ */
 export type PackageDenoJson = {
     name: string;
     version: string;

package/script/types/DenoJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DenoJson.d.ts","sourceRoot":"","sources":["../../src/types/DenoJson.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC,YAAY,CAIrD,CAAA;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,aAAa,CAAC,eAAe,CAK3D,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;CACzC,CAAA"}
+{"version":3,"file":"DenoJson.d.ts","sourceRoot":"","sources":["../../src/types/DenoJson.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC,YAAY,CAIrD,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,aAAa,CAAC,eAAe,CAK3D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;CACzC,CAAA"}

package/script/types/DenoJson.js

@@ -36,11 +36,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageDenoJson = exports.rootDenoJson = void 0;
 require("../_dnt.polyfills.js");
 const v = __importStar(require("valibot"));
+/**
+ * Valibot schema for root-level deno.json configuration files.
+ *
+ * Validates workspace-level deno.json files that manage multiple packages
+ * and define workspace-wide imports and exports.
+ */
 exports.rootDenoJson = v.looseObject({
     imports: v.optional(v.record(v.string(), v.string())),
     exports: v.optional(v.record(v.string(), v.string())),
     workspace: v.optional(v.array(v.string()))
 });
+/**
+ * Valibot schema for package-level deno.json configuration files.
+ *
+ * Validates individual package deno.json files that define package-specific
+ * metadata, dependencies, and export configurations.
+ */
 exports.packageDenoJson = v.looseObject({
     name: v.string(),
     version: v.string(),