@skmtc/core 0.0.804 → 0.0.806

package/esm/helpers/strings.d.ts

@@ -1,3 +1,47 @@
+/**
+ * @fileoverview String Manipulation Utilities for SKMTC Core
+ *
+ * This module provides a comprehensive collection of string manipulation utilities
+ * commonly needed for code generation, identifier transformation, and text processing
+ * within the SKMTC pipeline. These utilities handle case conversions, pluralization,
+ * sanitization, and various text transformations.
+ *
+ * ## Key Features
+ *
+ * - **Case Conversion**: camelCase, PascalCase, snake_case, kebab-case, and more
+ * - **Pluralization**: Smart singular/plural transformations with irregular forms
+ * - **Sanitization**: Clean strings for use as identifiers and file names
+ * - **Text Processing**: Trimming, padding, wrapping, and formatting utilities
+ * - **Unicode Support**: Proper handling of international characters
+ *
+ * @example Case conversions
+ * ```typescript
+ * import { capitalize, camelCase, pascalCase } from '@skmtc/core/strings';
+ *
+ * capitalize('hello world'); // 'Hello world'
+ * camelCase('user_profile_data'); // 'userProfileData'
+ * pascalCase('api-response-type'); // 'ApiResponseType'
+ * ```
+ *
+ * @example Pluralization
+ * ```typescript
+ * import { pluralize, singularize } from '@skmtc/core/strings';
+ *
+ * pluralize('user'); // 'users'
+ * pluralize('child'); // 'children'
+ * singularize('categories'); // 'category'
+ * ```
+ *
+ * @example Identifier sanitization
+ * ```typescript
+ * import { sanitizeIdentifier, toFileName } from '@skmtc/core/strings';
+ *
+ * sanitizeIdentifier('123-invalid name!'); // 'invalid_name'
+ * toFileName('My API Response'); // 'my-api-response'
+ * ```
+ *
+ * @module strings
+ */
 /**
  * Capitalizes the first character of a string.
  *

package/esm/helpers/strings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../../src/helpers/strings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,sBAAsB,CAAC;AAE9B,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,MAExC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,KAAG,MAE1C,CAAA;AAED;;GAEG;AACH,KAAK,gBAAgB,GAAG;IACtB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,EAAE,iBAAgB,gBAAqB,KAAG,MAgB9E,CAAA"}
+{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../../src/helpers/strings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH;;;;;;;;;;;;GAYG;AACH,OAAO,sBAAsB,CAAC;AAE9B,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,MAExC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,KAAG,MAE1C,CAAA;AAED;;GAEG;AACH,KAAK,gBAAgB,GAAG;IACtB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,EAAE,iBAAgB,gBAAqB,KAAG,MAgB9E,CAAA"}

package/esm/helpers/strings.js

@@ -1,3 +1,47 @@
+/**
+ * @fileoverview String Manipulation Utilities for SKMTC Core
+ *
+ * This module provides a comprehensive collection of string manipulation utilities
+ * commonly needed for code generation, identifier transformation, and text processing
+ * within the SKMTC pipeline. These utilities handle case conversions, pluralization,
+ * sanitization, and various text transformations.
+ *
+ * ## Key Features
+ *
+ * - **Case Conversion**: camelCase, PascalCase, snake_case, kebab-case, and more
+ * - **Pluralization**: Smart singular/plural transformations with irregular forms
+ * - **Sanitization**: Clean strings for use as identifiers and file names
+ * - **Text Processing**: Trimming, padding, wrapping, and formatting utilities
+ * - **Unicode Support**: Proper handling of international characters
+ *
+ * @example Case conversions
+ * ```typescript
+ * import { capitalize, camelCase, pascalCase } from '@skmtc/core/strings';
+ *
+ * capitalize('hello world'); // 'Hello world'
+ * camelCase('user_profile_data'); // 'userProfileData'
+ * pascalCase('api-response-type'); // 'ApiResponseType'
+ * ```
+ *
+ * @example Pluralization
+ * ```typescript
+ * import { pluralize, singularize } from '@skmtc/core/strings';
+ *
+ * pluralize('user'); // 'users'
+ * pluralize('child'); // 'children'
+ * singularize('categories'); // 'category'
+ * ```
+ *
+ * @example Identifier sanitization
+ * ```typescript
+ * import { sanitizeIdentifier, toFileName } from '@skmtc/core/strings';
+ *
+ * sanitizeIdentifier('123-invalid name!'); // 'invalid_name'
+ * toFileName('My API Response'); // 'my-api-response'
+ * ```
+ *
+ * @module strings
+ */
 /**
  * Capitalizes the first character of a string.
  *

package/esm/oas/contact/Contact.d.ts

@@ -1,15 +1,57 @@
+/**
+ * Constructor fields for {@link OasContact}.
+ *
+ * Defines the configuration options for creating contact information,
+ * including name, URL, email, and extension fields.
+ */
 export type ContactFields = {
     name?: string;
     url?: string;
     email?: string;
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Contact Object in the OpenAPI Specification.
+ *
+ * The `OasContact` class encapsulates contact information for the API,
+ * providing details about who to contact for support, questions, or issues.
+ * This information is typically displayed in API documentation.
+ *
+ * @example Basic contact information
+ * ```typescript
+ * import { OasContact } from '@skmtc/core';
+ *
+ * const contact = new OasContact({
+ *   name: 'API Support Team',
+ *   email: 'support@example.com'
+ * });
+ * ```
+ *
+ * @example Complete contact details
+ * ```typescript
+ * const fullContact = new OasContact({
+ *   name: 'John Doe',
+ *   url: 'https://example.com/contact',
+ *   email: 'john@example.com'
+ * });
+ * ```
+ */
 export declare class OasContact {
+    /** Type identifier for this OAS contact object */
     oasType: "contact";
+    /** The identifying name of the contact person/organization */
     name: string | undefined;
+    /** URL pointing to the contact information */
     url: string | undefined;
+    /** Email address of the contact person/organization */
     email: string | undefined;
+    /** Custom extension fields (x-* properties) for additional contact metadata */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasContact instance.
+     *
+     * @param fields - Contact information fields including name, URL, and email
+     */
     constructor(fields?: ContactFields);
 }
 //# sourceMappingURL=Contact.d.ts.map

package/esm/oas/contact/Contact.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Contact.d.ts","sourceRoot":"","sources":["../../../src/oas/contact/Contact.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,UAAU;IACrB,OAAO,EAAG,SAAS,CAAS;IAE5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAExC,MAAM,GAAE,aAAkB;CAMvC"}
+{"version":3,"file":"Contact.d.ts","sourceRoot":"","sources":["../../../src/oas/contact/Contact.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,UAAU;IACrB,kDAAkD;IAClD,OAAO,EAAG,SAAS,CAAS;IAE5B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,8CAA8C;IAC9C,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;IACvB,uDAAuD;IACvD,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,+EAA+E;IAC/E,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAEpD;;;;OAIG;gBACS,MAAM,GAAE,aAAkB;CAMvC"}

package/esm/oas/contact/Contact.js

@@ -1,29 +1,65 @@
+/**
+ * Represents a Contact Object in the OpenAPI Specification.
+ *
+ * The `OasContact` class encapsulates contact information for the API,
+ * providing details about who to contact for support, questions, or issues.
+ * This information is typically displayed in API documentation.
+ *
+ * @example Basic contact information
+ * ```typescript
+ * import { OasContact } from '@skmtc/core';
+ *
+ * const contact = new OasContact({
+ *   name: 'API Support Team',
+ *   email: 'support@example.com'
+ * });
+ * ```
+ *
+ * @example Complete contact details
+ * ```typescript
+ * const fullContact = new OasContact({
+ *   name: 'John Doe',
+ *   url: 'https://example.com/contact',
+ *   email: 'john@example.com'
+ * });
+ * ```
+ */
 export class OasContact {
+    /**
+     * Creates a new OasContact instance.
+     *
+     * @param fields - Contact information fields including name, URL, and email
+     */
     constructor(fields = {}) {
+        /** Type identifier for this OAS contact object */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'contact'
         });
+        /** The identifying name of the contact person/organization */
         Object.defineProperty(this, "name", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** URL pointing to the contact information */
         Object.defineProperty(this, "url", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Email address of the contact person/organization */
         Object.defineProperty(this, "email", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) for additional contact metadata */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,

package/esm/oas/info/Info.d.ts

@@ -84,13 +84,49 @@ export type InfoFields = {
  */
 export declare class OasInfo {
     #private;
+    /** Type identifier for this OAS info object */
     oasType: 'info';
+    /**
+     * Creates a new OasInfo instance.
+     *
+     * @param fields - API information fields including title, version, description, and contact details
+     */
     constructor(fields: InfoFields);
+    /**
+     * Gets the API title.
+     *
+     * @returns The title of the API
+     */
     get title(): string;
+    /**
+     * Gets the API description.
+     *
+     * @returns Optional detailed description of the API's purpose and functionality
+     */
     get description(): string | undefined;
+    /**
+     * Gets the terms of service URL.
+     *
+     * @returns Optional URL pointing to the API's terms of service
+     */
     get termsOfService(): string | undefined;
+    /**
+     * Gets the contact information.
+     *
+     * @returns Optional contact information for API support and inquiries
+     */
     get contact(): OasContact | undefined;
+    /**
+     * Gets the license information.
+     *
+     * @returns Optional license information governing API usage
+     */
     get license(): OasLicense | undefined;
+    /**
+     * Gets the API version.
+     *
+     * @returns The version string of the API (e.g., '1.0.0', '2.1.3')
+     */
     get version(): string;
     /** Specification Extension fields */
     get extensionFields(): Record<string, unknown> | undefined;

package/esm/oas/info/Info.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Info.d.ts","sourceRoot":"","sources":["../../../src/oas/info/Info.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,qBAAa,OAAO;;IAClB,OAAO,EAAE,MAAM,CAAS;gBAGZ,MAAM,EAAE,UAAU;IAI9B,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,cAAc,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;CACF"}
+{"version":3,"file":"Info.d.ts","sourceRoot":"","sources":["../../../src/oas/info/Info.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,qBAAa,OAAO;;IAClB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAS;IAIxB;;;;OAIG;gBACS,MAAM,EAAE,UAAU;IAI9B;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,cAAc,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;CACF"}

package/esm/oas/info/Info.js

@@ -74,31 +74,68 @@ import "../../_dnt.polyfills.js";
  * ```
  */
 export class OasInfo {
+    /**
+     * Creates a new OasInfo instance.
+     *
+     * @param fields - API information fields including title, version, description, and contact details
+     */
     constructor(fields) {
+        /** Type identifier for this OAS info object */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'info'
         });
+        /** Private storage for all info fields */
         _OasInfo_fields.set(this, void 0);
         __classPrivateFieldSet(this, _OasInfo_fields, fields, "f");
     }
+    /**
+     * Gets the API title.
+     *
+     * @returns The title of the API
+     */
     get title() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").title;
     }
+    /**
+     * Gets the API description.
+     *
+     * @returns Optional detailed description of the API's purpose and functionality
+     */
     get description() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").description;
     }
+    /**
+     * Gets the terms of service URL.
+     *
+     * @returns Optional URL pointing to the API's terms of service
+     */
     get termsOfService() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").termsOfService;
     }
+    /**
+     * Gets the contact information.
+     *
+     * @returns Optional contact information for API support and inquiries
+     */
     get contact() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").contact;
     }
+    /**
+     * Gets the license information.
+     *
+     * @returns Optional license information governing API usage
+     */
     get license() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").license;
     }
+    /**
+     * Gets the API version.
+     *
+     * @returns The version string of the API (e.g., '1.0.0', '2.1.3')
+     */
     get version() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").version;
     }

package/esm/oas/mediaType/MediaType.d.ts

@@ -96,13 +96,30 @@ export type MediaTypeFields = {
  * ```
  */
 export declare class OasMediaType {
+    /** Type identifier for this OAS media type */
     oasType: 'mediaType';
+    /** The media type identifier (e.g., 'application/json', 'text/xml') */
     mediaType: string;
+    /** The schema defining the structure and validation rules for the content */
     schema: OasSchema | OasRef<'schema'> | undefined;
+    /** Example values demonstrating the media type content */
     examples: Record<string, OasExample | OasRef<'example'>> | undefined;
+    /** Custom extension fields (x-* properties) defined for this media type */
     extensionFields: Record<string, unknown> | undefined;
+    /** Encoding information for multipart and form data serialization */
     encoding?: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasMediaType instance.
+     *
+     * @param fields - Media type configuration including content schema, examples, and encoding
+     */
     constructor(fields: MediaTypeFields);
+    /**
+     * Converts this OAS media type to an OpenAPI v3 JSON schema representation.
+     *
+     * @param options - Conversion options including reference handling and formatting preferences
+     * @returns OpenAPI v3 media type object with schema and examples
+     */
     toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.MediaTypeObject;
 }
 //# sourceMappingURL=MediaType.d.ts.map

package/esm/oas/mediaType/MediaType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MediaType.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/MediaType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,qBAAa,YAAY;IACvB,OAAO,EAAE,WAAW,CAAc;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAClC,MAAM,EAAE,eAAe;IAQnC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAMtE"}
+{"version":3,"file":"MediaType.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/MediaType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,qBAAa,YAAY;IACvB,8CAA8C;IAC9C,OAAO,EAAE,WAAW,CAAc;IAClC,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,6EAA6E;IAC7E,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,2EAA2E;IAC3E,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAC9C;;;;OAIG;gBACS,MAAM,EAAE,eAAe;IAQnC;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAMtE"}

package/esm/oas/mediaType/MediaType.js

@@ -76,37 +76,48 @@
  * ```
  */
 export class OasMediaType {
+    /**
+     * Creates a new OasMediaType instance.
+     *
+     * @param fields - Media type configuration including content schema, examples, and encoding
+     */
     constructor(fields) {
+        /** Type identifier for this OAS media type */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'mediaType'
         });
+        /** The media type identifier (e.g., 'application/json', 'text/xml') */
         Object.defineProperty(this, "mediaType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The schema defining the structure and validation rules for the content */
         Object.defineProperty(this, "schema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Example values demonstrating the media type content */
         Object.defineProperty(this, "examples", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) defined for this media type */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Encoding information for multipart and form data serialization */
         Object.defineProperty(this, "encoding", {
             enumerable: true,
             configurable: true,
@@ -119,6 +130,12 @@ export class OasMediaType {
         this.encoding = fields.encoding;
         this.extensionFields = fields.extensionFields;
     }
+    /**
+     * Converts this OAS media type to an OpenAPI v3 JSON schema representation.
+     *
+     * @param options - Conversion options including reference handling and formatting preferences
+     * @returns OpenAPI v3 media type object with schema and examples
+     */
     toJsonSchema(options) {
         return {
             schema: this.schema?.toJsonSchema(options),

package/esm/run/toV3JsonDocument.d.ts

@@ -1,3 +1,57 @@
+/**
+ * @fileoverview OpenAPI Document Conversion Utilities
+ *
+ * This module provides robust utilities for converting OpenAPI documents between
+ * different versions (v2/Swagger, v3.0, v3.1) and formats (JSON, YAML). It handles
+ * the complexities of version migration, format detection, and schema validation
+ * to ensure seamless OpenAPI document processing within the SKMTC pipeline.
+ *
+ * ## Key Features
+ *
+ * - **Multi-Version Support**: Convert between Swagger v2, OpenAPI v3.0, and v3.1
+ * - **Format Detection**: Automatic detection of JSON vs YAML input formats
+ * - **Version Migration**: Safe migration with schema validation and error handling
+ * - **Type Safety**: Full TypeScript support with proper type guards
+ * - **Error Recovery**: Comprehensive error handling for malformed documents
+ *
+ * @example Converting Swagger v2 to OpenAPI v3
+ * ```typescript
+ * import { toV3JsonDocument } from '@skmtc/core/toV3JsonDocument';
+ *
+ * const swaggerV2 = {
+ *   swagger: '2.0',
+ *   info: { title: 'My API', version: '1.0.0' },
+ *   paths: { '/users': { get: { responses: { '200': { description: 'Success' } } } } }
+ * };
+ *
+ * const openApiV3 = await toV3JsonDocument(swaggerV2);
+ * console.log(openApiV3.openapi); // '3.0.0'
+ * ```
+ *
+ * @example Converting from YAML string
+ * ```typescript
+ * const yamlContent = `
+ * openapi: 3.1.0
+ * info:
+ *   title: My API
+ *   version: 1.0.0
+ * paths: {}
+ * `;
+ *
+ * const openApiV3 = await toV3JsonDocument(yamlContent);
+ * ```
+ *
+ * @example Handling conversion errors
+ * ```typescript
+ * try {
+ *   const result = await toV3JsonDocument(malformedDocument);
+ * } catch (error) {
+ *   console.error('Conversion failed:', error.message);
+ * }
+ * ```
+ *
+ * @module toV3JsonDocument
+ */
 import "../_dnt.polyfills.js";
 import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
 /**

package/esm/run/toV3JsonDocument.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toV3JsonDocument.d.ts","sourceRoot":"","sources":["../../src/run/toV3JsonDocument.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAUtE;;;;;GAKG;AACH,KAAK,cAAc,GAAG,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,KAAG,cAM/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,eAAO,MAAM,YAAY,GAAU,QAAQ,cAAc,KAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CA0BrF,CAAA"}
+{"version":3,"file":"toV3JsonDocument.d.ts","sourceRoot":"","sources":["../../src/run/toV3JsonDocument.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,OAAO,sBAAsB,CAAC;AAG9B,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAUtE;;;;;GAKG;AACH,KAAK,cAAc,GAAG,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,KAAG,cAM/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,eAAO,MAAM,YAAY,GAAU,QAAQ,cAAc,KAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CA0BrF,CAAA"}

package/esm/run/toV3JsonDocument.js

@@ -1,3 +1,57 @@
+/**
+ * @fileoverview OpenAPI Document Conversion Utilities
+ *
+ * This module provides robust utilities for converting OpenAPI documents between
+ * different versions (v2/Swagger, v3.0, v3.1) and formats (JSON, YAML). It handles
+ * the complexities of version migration, format detection, and schema validation
+ * to ensure seamless OpenAPI document processing within the SKMTC pipeline.
+ *
+ * ## Key Features
+ *
+ * - **Multi-Version Support**: Convert between Swagger v2, OpenAPI v3.0, and v3.1
+ * - **Format Detection**: Automatic detection of JSON vs YAML input formats
+ * - **Version Migration**: Safe migration with schema validation and error handling
+ * - **Type Safety**: Full TypeScript support with proper type guards
+ * - **Error Recovery**: Comprehensive error handling for malformed documents
+ *
+ * @example Converting Swagger v2 to OpenAPI v3
+ * ```typescript
+ * import { toV3JsonDocument } from '@skmtc/core/toV3JsonDocument';
+ *
+ * const swaggerV2 = {
+ *   swagger: '2.0',
+ *   info: { title: 'My API', version: '1.0.0' },
+ *   paths: { '/users': { get: { responses: { '200': { description: 'Success' } } } } }
+ * };
+ *
+ * const openApiV3 = await toV3JsonDocument(swaggerV2);
+ * console.log(openApiV3.openapi); // '3.0.0'
+ * ```
+ *
+ * @example Converting from YAML string
+ * ```typescript
+ * const yamlContent = `
+ * openapi: 3.1.0
+ * info:
+ *   title: My API
+ *   version: 1.0.0
+ * paths: {}
+ * `;
+ *
+ * const openApiV3 = await toV3JsonDocument(yamlContent);
+ * ```
+ *
+ * @example Handling conversion errors
+ * ```typescript
+ * try {
+ *   const result = await toV3JsonDocument(malformedDocument);
+ * } catch (error) {
+ *   console.error('Conversion failed:', error.message);
+ * }
+ * ```
+ *
+ * @module toV3JsonDocument
+ */
 import "../_dnt.polyfills.js";
 import { parse as parseYaml } from '../deps/jsr.io/@std/yaml/1.0.9/parse.js';
 import { Converter as ThreeOneToThreeZeroConverter } from '@apiture/openapi-down-convert';

package/esm/types/Brand.d.ts

@@ -1,3 +1,44 @@
+/**
+ * @fileoverview Brand Type System for SKMTC Core
+ *
+ * This module provides TypeScript branded types for creating type-safe identifiers
+ * and values that are structurally identical but nominally distinct. Branded types
+ * help prevent mixing up similar primitive types and provide better type safety
+ * across the SKMTC codebase.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Prevents accidental mixing of similar primitive types
+ * - **Nominal Typing**: Creates distinct types from the same underlying type
+ * - **Zero Runtime Cost**: Pure TypeScript compile-time construct
+ * - **Developer Experience**: Better IntelliSense and error messages
+ *
+ * @example Creating branded types
+ * ```typescript
+ * import type { Brand } from '@skmtc/core/Brand';
+ *
+ * type UserId = Brand<string, 'UserId'>;
+ * type ProductId = Brand<string, 'ProductId'>;
+ *
+ * const userId: UserId = 'user-123' as UserId;
+ * const productId: ProductId = 'prod-456' as ProductId;
+ *
+ * // TypeScript will prevent this error:
+ * // const wrong: UserId = productId; // Type error!
+ * ```
+ *
+ * @example Using with numbers
+ * ```typescript
+ * type Score = Brand<number, 'Score'>;
+ * type Percentage = Brand<number, 'Percentage'>;
+ *
+ * function calculateGrade(score: Score, total: Score): Percentage {
+ *   return ((score / total) * 100) as Percentage;
+ * }
+ * ```
+ *
+ * @module Brand
+ */
 /**
  * Unique symbol used for branding types.
  *

package/esm/types/Brand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Brand.d.ts","sourceRoot":"","sources":["../../src/types/Brand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,sBAAsB,CAAC;AAE9B,OAAO,CAAC,MAAM,KAAK,EAAE,OAAO,MAAM,CAAA;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,GAAG;IAAE,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}
+{"version":3,"file":"Brand.d.ts","sourceRoot":"","sources":["../../src/types/Brand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH;;;;;;;;GAQG;AACH,OAAO,sBAAsB,CAAC;AAE9B,OAAO,CAAC,MAAM,KAAK,EAAE,OAAO,MAAM,CAAA;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,GAAG;IAAE,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}