@skmtc/core 0.0.802 → 0.0.804

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/oas/ref/ref-types.d.ts

@@ -65,6 +65,12 @@ export type OasParameterRefData = {
  * Valibot schema for validating parameter reference data.
  */
 export declare const oasParameterRefData: v.GenericSchema<OasParameterRefData>;
+/**
+ * Data type for OpenAPI example reference objects.
+ *
+ * Represents $ref references to example objects in OpenAPI documents,
+ * enabling example reuse across multiple schema definitions and operations.
+ */
 export type OasExampleRefData = {
     oasType: 'ref';
     refType: 'example';
@@ -72,7 +78,16 @@ export type OasExampleRefData = {
     summary?: string;
     description?: string;
 };
+/**
+ * Valibot schema for validating example reference data.
+ */
 export declare const oasExampleRefData: v.GenericSchema<OasExampleRefData>;
+/**
+ * Data type for OpenAPI request body reference objects.
+ *
+ * Represents $ref references to request body objects in OpenAPI documents,
+ * allowing request body definitions to be reused across operations.
+ */
 export type OasRequestBodyRefData = {
     oasType: 'ref';
     refType: 'requestBody';
@@ -80,7 +95,16 @@ export type OasRequestBodyRefData = {
     summary?: string;
     description?: string;
 };
+/**
+ * Valibot schema for validating request body reference data.
+ */
 export declare const oasRequestBodyRefData: v.GenericSchema<OasRequestBodyRefData>;
+/**
+ * Data type for OpenAPI header reference objects.
+ *
+ * Represents $ref references to header objects in OpenAPI documents,
+ * enabling header definition reuse across operations and responses.
+ */
 export type OasHeaderRefData = {
     oasType: 'ref';
     refType: 'header';
@@ -88,13 +112,37 @@ export type OasHeaderRefData = {
     summary?: string;
     description?: string;
 };
+/**
+ * Valibot schema for validating header reference data.
+ */
 export declare const oasHeaderRefData: v.GenericSchema<OasHeaderRefData>;
+/**
+ * Data type for OpenAPI security scheme reference objects.
+ *
+ * Represents $ref references to security scheme objects in OpenAPI documents,
+ * allowing security scheme definitions to be reused across operations.
+ */
 export type OasSecuritySchemeRefData = {
     oasType: 'ref';
     refType: 'securityScheme';
     $ref: string;
 };
+/**
+ * Valibot schema for validating security scheme reference data.
+ */
 export declare const oasSecuritySchemeRefData: v.GenericSchema<OasSecuritySchemeRefData>;
+/**
+ * Union type representing all possible OpenAPI reference data types.
+ *
+ * Encompasses all supported reference types in the OpenAPI specification,
+ * providing type-safe handling of references to various component types.
+ */
 export type OasRefData = OasSchemaRefData | OasResponseRefData | OasParameterRefData | OasExampleRefData | OasRequestBodyRefData | OasHeaderRefData | OasSecuritySchemeRefData;
+/**
+ * Valibot schema for validating any OpenAPI reference data.
+ *
+ * Union schema that validates all supported reference types,
+ * ensuring type safety across the entire reference system.
+ */
 export declare const oasRefData: v.GenericSchema<OasRefData>;
 //# sourceMappingURL=ref-types.d.ts.map

package/script/oas/ref/ref-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ref-types.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/ref-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAA;IACjB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,UAAU,CAAA;IACnB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,WAAW,CAAA;IACpB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAMnE,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,SAAS,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}
+{"version":3,"file":"ref-types.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/ref-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAA;IACjB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,UAAU,CAAA;IACnB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,WAAW,CAAA;IACpB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAMnE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,SAAS,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}

package/script/oas/ref/ref-types.js

@@ -66,6 +66,9 @@ exports.oasParameterRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating example reference data.
+ */
 exports.oasExampleRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('example'),
@@ -73,6 +76,9 @@ exports.oasExampleRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating request body reference data.
+ */
 exports.oasRequestBodyRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('requestBody'),
@@ -80,6 +86,9 @@ exports.oasRequestBodyRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating header reference data.
+ */
 exports.oasHeaderRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('header'),
@@ -87,12 +96,21 @@ exports.oasHeaderRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating security scheme reference data.
+ */
 exports.oasSecuritySchemeRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('securityScheme'),
     $ref: v.string()
 });
 // OasPathItemRefData
+/**
+ * Valibot schema for validating any OpenAPI reference data.
+ *
+ * Union schema that validates all supported reference types,
+ * ensuring type safety across the entire reference system.
+ */
 exports.oasRefData = v.union([
     exports.oasSchemaRefData,
     exports.oasResponseRefData,

package/script/oas/server/Server.d.ts

@@ -2,22 +2,94 @@ import "../../_dnt.polyfills.js";
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { OasServerVariable } from '../serverVariable/ServerVariable.js';
+/**
+ * Constructor fields for {@link OasServer}.
+ *
+ * Defines the configuration options available when creating server instances,
+ * including URL, description, variables, and extension fields.
+ */
 export type ServerFields = {
     description?: string | undefined;
     url: string;
     variables?: Record<string, OasServerVariable> | undefined;
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Server Object in the OpenAPI Specification.
+ *
+ * The `OasServer` class encapsulates server connectivity information, including
+ * the server URL, optional description, and variable definitions for URL templating.
+ * Servers are used to specify different environments (development, staging, production)
+ * or different API versions that clients can connect to.
+ *
+ * @example Basic server
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://api.example.com/v1',
+ *   description: 'Production API server'
+ * });
+ * ```
+ *
+ * @example Server with variables
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://{environment}.example.com/{version}',
+ *   description: 'Configurable API server',
+ *   variables: {
+ *     environment: new OasServerVariable({
+ *       enum: ['api', 'staging', 'dev'],
+ *       default: 'api',
+ *       description: 'API environment'
+ *     }),
+ *     version: new OasServerVariable({
+ *       default: 'v1',
+ *       description: 'API version'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasServer {
+    /** Type identifier for this OAS server */
     oasType: 'server';
+    /** Human-readable description of the server */
     description: string | undefined;
+    /** Server URL with optional variable templating */
     url: string;
+    /** Variable definitions for URL templating */
     variables: Record<string, OasServerVariable> | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasServer instance.
+     *
+     * @param fields - Server configuration including URL, description, and variables
+     */
     constructor(fields: ServerFields);
+    /**
+     * Determines if this server is a reference object.
+     *
+     * @returns Always false since servers are not reference objects in OpenAPI
+     */
     isRef(): boolean;
+    /**
+     * Resolves this server object.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolve(): OasServer;
+    /**
+     * Resolves this server object one level.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolveOnce(): OasServer;
+    /**
+     * Converts this OAS server to an OpenAPI v3 JSON schema representation.
+     *
+     * @param _options - Conversion options (currently unused for server objects)
+     * @returns OpenAPI v3 server object with URL, description, and variables
+     */
     toJsonSchema(_options: ToJsonSchemaOptions): OpenAPIV3.ServerObject;
 }
 //# sourceMappingURL=Server.d.ts.map

package/script/oas/server/Server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Server.d.ts","sourceRoot":"","sources":["../../../src/oas/server/Server.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAE5E,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,SAAS;IACpB,OAAO,EAAE,QAAQ,CAAW;IAC5B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,YAAY;IAOhC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;IAIxB,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CAOpE"}
+{"version":3,"file":"Server.d.ts","sourceRoot":"","sources":["../../../src/oas/server/Server.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,SAAS;IACpB,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAW;IAC5B,+CAA+C;IAC/C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAA;IACX,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACxD,+CAA+C;IAC/C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;;;OAIG;gBACS,MAAM,EAAE,YAAY;IAOhC;;;;OAIG;IACH,KAAK,IAAI,OAAO;IAIhB;;;;OAIG;IACH,OAAO,IAAI,SAAS;IAIpB;;;;OAIG;IACH,WAAW,IAAI,SAAS;IAIxB;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CAOpE"}

package/script/oas/server/Server.js

@@ -2,32 +2,77 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasServer = void 0;
 require("../../_dnt.polyfills.js");
+/**
+ * Represents a Server Object in the OpenAPI Specification.
+ *
+ * The `OasServer` class encapsulates server connectivity information, including
+ * the server URL, optional description, and variable definitions for URL templating.
+ * Servers are used to specify different environments (development, staging, production)
+ * or different API versions that clients can connect to.
+ *
+ * @example Basic server
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://api.example.com/v1',
+ *   description: 'Production API server'
+ * });
+ * ```
+ *
+ * @example Server with variables
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://{environment}.example.com/{version}',
+ *   description: 'Configurable API server',
+ *   variables: {
+ *     environment: new OasServerVariable({
+ *       enum: ['api', 'staging', 'dev'],
+ *       default: 'api',
+ *       description: 'API environment'
+ *     }),
+ *     version: new OasServerVariable({
+ *       default: 'v1',
+ *       description: 'API version'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 class OasServer {
+    /**
+     * Creates a new OasServer instance.
+     *
+     * @param fields - Server configuration including URL, description, and variables
+     */
     constructor(fields) {
+        /** Type identifier for this OAS server */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'server'
         });
+        /** Human-readable description of the server */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Server URL with optional variable templating */
         Object.defineProperty(this, "url", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Variable definitions for URL templating */
         Object.defineProperty(this, "variables", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,
@@ -39,15 +84,36 @@ class OasServer {
         this.variables = fields.variables;
         this.extensionFields = fields.extensionFields;
     }
+    /**
+     * Determines if this server is a reference object.
+     *
+     * @returns Always false since servers are not reference objects in OpenAPI
+     */
     isRef() {
         return false;
     }
+    /**
+     * Resolves this server object.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolve() {
         return this;
     }
+    /**
+     * Resolves this server object one level.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolveOnce() {
         return this;
     }
+    /**
+     * Converts this OAS server to an OpenAPI v3 JSON schema representation.
+     *
+     * @param _options - Conversion options (currently unused for server objects)
+     * @returns OpenAPI v3 server object with URL, description, and variables
+     */
     toJsonSchema(_options) {
         return {
             description: this.description,

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');
 };