@skmtc/core 0.0.800 → 0.0.803

package/esm/oas/string/toString.d.ts

@@ -1,11 +1,75 @@
 import type { OpenAPIV3 } from 'openapi-types';
 import type { ParseContext } from '../../context/ParseContext.js';
 import { OasString } from './String.js';
+/**
+ * Arguments for transforming an OpenAPI string schema into OAS representation.
+ */
 type ToStringArgs = {
+    /** The OpenAPI v3 schema object to transform (must be type 'string') */
     value: OpenAPIV3.SchemaObject;
+    /** Parse context providing utilities and tracing capabilities */
     context: ParseContext;
 };
-export declare const toString: ({ context, value }: ToStringArgs) => OasString<boolean | undefined>;
+/**
+ * Transforms an OpenAPI v3 string schema object into an internal OAS string representation.
+ *
+ * This function processes OpenAPI string 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 string representation with proper validation
+ * of string 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 OasString instance with format validation
+ *
+ * @param args - Transformation arguments
+ * @param args.context - Parse context providing utilities and tracing
+ * @param args.value - The OpenAPI v3 string schema object to transform
+ * @returns Transformed OAS string object with parsed properties
+ *
+ * @example Basic string transformation
+ * ```typescript
+ * import { toString } from '@skmtc/core';
+ *
+ * const openApiString = {
+ *   type: 'string',
+ *   format: 'email',
+ *   maxLength: 255,
+ *   pattern: '^[\\w.-]+@[\\w.-]+\\.[a-zA-Z]{2,}$'
+ * };
+ *
+ * const oasString = toString({
+ *   context: parseContext,
+ *   value: openApiString
+ * });
+ *
+ * console.log(oasString.format); // 'email'
+ * console.log(oasString.maxLength); // 255
+ * ```
+ *
+ * @example String with nullable and enums
+ * ```typescript
+ * const statusString = {
+ *   type: 'string',
+ *   nullable: true,
+ *   enum: ['active', 'inactive', 'pending', null],
+ *   default: 'active',
+ *   example: 'pending'
+ * };
+ *
+ * const oasString = toString({
+ *   context: parseContext,
+ *   value: statusString
+ * });
+ *
+ * console.log(oasString.nullable); // true
+ * console.log(oasString.enums); // ['active', 'inactive', 'pending', null]
+ * ```
+ */
+export declare const toString: ({ context, value }: ToStringArgs) => OasString;
 type ToParsedStringArgs<Nullable extends boolean | undefined> = {
     value: Omit<OpenAPIV3.SchemaObject, 'nullable' | 'example' | 'enums' | 'default'>;
     context: ParseContext;
@@ -14,6 +78,66 @@ type ToParsedStringArgs<Nullable extends boolean | undefined> = {
     enums: Nullable extends true ? (string | null)[] | undefined : string[] | undefined;
     defaultValue: Nullable extends true ? string | null | undefined : string | undefined;
 };
+/**
+ * Creates an OAS string instance from pre-parsed string schema components.
+ *
+ * This function is the final step in the string transformation pipeline, taking
+ * already-parsed nullable, example, enum, and default values and combining them
+ * with the remaining string properties to create the complete OasString instance.
+ *
+ * The function handles format validation against known OpenAPI string formats,
+ * length constraints parsing, pattern validation, and specification extension
+ * processing. It logs warnings for unrecognized formats while still preserving
+ * them in the output.
+ *
+ * @template Nullable - Boolean type indicating if the string can be null
+ * @param args - Pre-parsed string components
+ * @param args.context - Parse context for tracing and issue logging
+ * @param args.nullable - Parsed nullable flag
+ * @param args.example - Parsed example value (type-safe with nullable)
+ * @param args.enums - Parsed enumeration constraints (type-safe with nullable)
+ * @param args.defaultValue - Parsed default value (type-safe with nullable)
+ * @param args.value - OpenAPI string object without parsed fields
+ * @returns Complete OAS string instance with all properties and validation
+ *
+ * @example Date-time string with validation
+ * ```typescript
+ * const dateTimeString = toParsedString({
+ *   context: parseContext,
+ *   nullable: false,
+ *   example: '2023-12-25T10:00:00Z',
+ *   enums: undefined,
+ *   defaultValue: undefined,
+ *   value: {
+ *     type: 'string',
+ *     format: 'date-time',
+ *     title: 'Event Date',
+ *     description: 'When the event occurs'
+ *   }
+ * });
+ *
+ * console.log(dateTimeString.format); // 'date-time'
+ * ```
+ *
+ * @example String with custom format (generates warning)
+ * ```typescript
+ * const customFormatString = toParsedString({
+ *   context: parseContext,
+ *   nullable: false,
+ *   example: 'ABC123',
+ *   enums: undefined,
+ *   defaultValue: undefined,
+ *   value: {
+ *     type: 'string',
+ *     format: 'custom-id', // Unknown format, will log warning
+ *     pattern: '^[A-Z]{3}[0-9]{3}$'
+ *   }
+ * });
+ *
+ * // Logs: "Unexpected format: custom-id"
+ * console.log(customFormatString.format); // 'custom-id' (still preserved)
+ * ```
+ */
 export declare const toParsedString: <Nullable extends boolean | undefined>({ context, nullable, example, enums, defaultValue, value }: ToParsedStringArgs<Nullable>) => OasString<Nullable>;
 export {};
 //# sourceMappingURL=toString.d.ts.map

package/esm/oas/string/toString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toString.d.ts","sourceRoot":"","sources":["../../../src/oas/string/toString.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,mCAmCxD,CAAA;AAED,KAAK,kBAAkB,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAC9D,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC,CAAA;IACjF,OAAO,EAAE,YAAY,CAAA;IACrB,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnF,YAAY,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;CACrF,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,QAAQ,SAAS,OAAO,GAAG,SAAS,EAAE,4DAOlE,kBAAkB,CAAC,QAAQ,CAAC,KAAG,SAAS,CAAC,QAAQ,CA0CnD,CAAA"}
+{"version":3,"file":"toString.d.ts","sourceRoot":"","sources":["../../../src/oas/string/toString.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;;GAEG;AACH,KAAK,YAAY,GAAG;IAClB,wEAAwE;IACxE,KAAK,EAAE,SAAS,CAAC,YAAY,CAAA;IAC7B,iEAAiE;IACjE,OAAO,EAAE,YAAY,CAAA;CACtB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,eAAO,MAAM,QAAQ,GAAI,oBAAoB,YAAY,KAAG,SAmC3D,CAAA;AAED,KAAK,kBAAkB,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAC9D,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC,CAAA;IACjF,OAAO,EAAE,YAAY,CAAA;IACrB,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnF,YAAY,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;CACrF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,SAAS,OAAO,GAAG,SAAS,EAAE,4DAOlE,kBAAkB,CAAC,QAAQ,CAAC,KAAG,SAAS,CAAC,QAAQ,CA0CnD,CAAA"}

package/esm/oas/string/toString.js

@@ -6,6 +6,65 @@ import { parseNullable } from '../_helpers/parseNullable.js';
 import { parseExample } from '../_helpers/parseExample.js';
 import { parseEnum } from '../_helpers/parseEnum.js';
 import { parseDefault } from '../_helpers/parseDefault.js';
+/**
+ * Transforms an OpenAPI v3 string schema object into an internal OAS string representation.
+ *
+ * This function processes OpenAPI string 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 string representation with proper validation
+ * of string 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 OasString instance with format validation
+ *
+ * @param args - Transformation arguments
+ * @param args.context - Parse context providing utilities and tracing
+ * @param args.value - The OpenAPI v3 string schema object to transform
+ * @returns Transformed OAS string object with parsed properties
+ *
+ * @example Basic string transformation
+ * ```typescript
+ * import { toString } from '@skmtc/core';
+ *
+ * const openApiString = {
+ *   type: 'string',
+ *   format: 'email',
+ *   maxLength: 255,
+ *   pattern: '^[\\w.-]+@[\\w.-]+\\.[a-zA-Z]{2,}$'
+ * };
+ *
+ * const oasString = toString({
+ *   context: parseContext,
+ *   value: openApiString
+ * });
+ *
+ * console.log(oasString.format); // 'email'
+ * console.log(oasString.maxLength); // 255
+ * ```
+ *
+ * @example String with nullable and enums
+ * ```typescript
+ * const statusString = {
+ *   type: 'string',
+ *   nullable: true,
+ *   enum: ['active', 'inactive', 'pending', null],
+ *   default: 'active',
+ *   example: 'pending'
+ * };
+ *
+ * const oasString = toString({
+ *   context: parseContext,
+ *   value: statusString
+ * });
+ *
+ * console.log(oasString.nullable); // true
+ * console.log(oasString.enums); // ['active', 'inactive', 'pending', null]
+ * ```
+ */
 export const toString = ({ context, value }) => {
     const { nullable, value: valueWithoutNullable } = parseNullable({
         value,
@@ -38,6 +97,66 @@ export const toString = ({ context, value }) => {
         value: valueWithoutDefault
     });
 };
+/**
+ * Creates an OAS string instance from pre-parsed string schema components.
+ *
+ * This function is the final step in the string transformation pipeline, taking
+ * already-parsed nullable, example, enum, and default values and combining them
+ * with the remaining string properties to create the complete OasString instance.
+ *
+ * The function handles format validation against known OpenAPI string formats,
+ * length constraints parsing, pattern validation, and specification extension
+ * processing. It logs warnings for unrecognized formats while still preserving
+ * them in the output.
+ *
+ * @template Nullable - Boolean type indicating if the string can be null
+ * @param args - Pre-parsed string components
+ * @param args.context - Parse context for tracing and issue logging
+ * @param args.nullable - Parsed nullable flag
+ * @param args.example - Parsed example value (type-safe with nullable)
+ * @param args.enums - Parsed enumeration constraints (type-safe with nullable)
+ * @param args.defaultValue - Parsed default value (type-safe with nullable)
+ * @param args.value - OpenAPI string object without parsed fields
+ * @returns Complete OAS string instance with all properties and validation
+ *
+ * @example Date-time string with validation
+ * ```typescript
+ * const dateTimeString = toParsedString({
+ *   context: parseContext,
+ *   nullable: false,
+ *   example: '2023-12-25T10:00:00Z',
+ *   enums: undefined,
+ *   defaultValue: undefined,
+ *   value: {
+ *     type: 'string',
+ *     format: 'date-time',
+ *     title: 'Event Date',
+ *     description: 'When the event occurs'
+ *   }
+ * });
+ *
+ * console.log(dateTimeString.format); // 'date-time'
+ * ```
+ *
+ * @example String with custom format (generates warning)
+ * ```typescript
+ * const customFormatString = toParsedString({
+ *   context: parseContext,
+ *   nullable: false,
+ *   example: 'ABC123',
+ *   enums: undefined,
+ *   defaultValue: undefined,
+ *   value: {
+ *     type: 'string',
+ *     format: 'custom-id', // Unknown format, will log warning
+ *     pattern: '^[A-Z]{3}[0-9]{3}$'
+ *   }
+ * });
+ *
+ * // Logs: "Unexpected format: custom-id"
+ * console.log(customFormatString.format); // 'custom-id' (still preserved)
+ * ```
+ */
 export const toParsedString = ({ context, nullable, example, enums, defaultValue, value }) => {
     const { type: _type, title, description, format, maxLength, minLength, pattern, ...skipped } = v.parse(oasStringData, value);
     const extensionFields = toSpecificationExtensionsV3({

package/esm/oas/tag/tag-types.d.ts

@@ -0,0 +1,8 @@
+import * as v from 'valibot';
+export type OasTagData = {
+    oasType: 'tag';
+    name: string;
+    description?: string;
+};
+export declare const oasTagData: v.GenericSchema<OasTagData>;
+//# sourceMappingURL=tag-types.d.ts.map

package/esm/oas/tag/tag-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag-types.d.ts","sourceRoot":"","sources":["../../../src/oas/tag/tag-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,KAAK,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAKjD,CAAA"}

package/esm/oas/tag/tag-types.js

@@ -0,0 +1,8 @@
+import { markdown } from '../markdown/markdown-types.js';
+import * as v from 'valibot';
+export const oasTagData = v.object({
+    oasType: v.literal('tag'),
+    name: v.string(),
+    description: v.optional(markdown)
+    // externalDocs: externalDocs.optional()
+});

package/esm/oas/union/union-types.d.ts

@@ -30,16 +30,5 @@ export type OasUnionData = {
  * discriminator properties. Uses lazy evaluation to handle recursive
  * schema references in union members.
  */
-export declare const oasUnionData: v.ObjectSchema<{
-    readonly oasType: v.LiteralSchema<"schema", undefined>;
-    readonly type: v.LiteralSchema<"union", undefined>;
-    readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly members: v.LazySchema<v.ArraySchema<v.UnionSchema<[v.GenericSchema<OasSchemaData>, v.GenericSchema<OasSchemaRefData>], undefined>, undefined>>;
-    readonly discriminator: v.OptionalSchema<v.ObjectSchema<{
-        readonly oasType: v.LiteralSchema<"discriminator", undefined>;
-        readonly propertyName: v.StringSchema<undefined>;
-        readonly mapping: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
-    }, undefined>, undefined>;
-}, undefined>;
+export declare const oasUnionData: v.GenericSchema<OasUnionData>;
 //# sourceMappingURL=union-types.d.ts.map

package/esm/oas/union/union-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"union-types.d.ts","sourceRoot":"","sources":["../../../src/oas/union/union-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,qBAAqB,CAAA;AAC7E,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,yCAAyC,CAAA;AAEhD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kDAAkD;IAClD,OAAO,EAAE,QAAQ,CAAA;IACjB,uCAAuC;IACvC,IAAI,EAAE,OAAO,CAAA;IACb,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,OAAO,EAAE,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAA;IAC7C,2DAA2D;IAC3D,aAAa,CAAC,EAAE,oBAAoB,CAAA;CACrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;aAOvB,CAAA"}
+{"version":3,"file":"union-types.d.ts","sourceRoot":"","sources":["../../../src/oas/union/union-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,qBAAqB,CAAA;AAC7E,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,yCAAyC,CAAA;AAEhD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kDAAkD;IAClD,OAAO,EAAE,QAAQ,CAAA;IACjB,uCAAuC;IACvC,IAAI,EAAE,OAAO,CAAA;IACb,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,OAAO,EAAE,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAA;IAC7C,2DAA2D;IAC3D,aAAa,CAAC,EAAE,oBAAoB,CAAA;CACrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC,YAAY,CAOrD,CAAA"}

package/esm/oas/unknown/unknown-types.d.ts

@@ -5,13 +5,7 @@ import * as v from 'valibot';
  * Validates unknown/unspecified schemas used as fallbacks when
  * schema types cannot be determined or for flexible data handling.
  */
-export declare const oasUnknownData: v.ObjectSchema<{
-    readonly oasType: v.LiteralSchema<"schema", undefined>;
-    readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly default: v.OptionalSchema<v.UnknownSchema, undefined>;
-    readonly type: v.LiteralSchema<"unknown", undefined>;
-}, undefined>;
+export declare const oasUnknownData: v.GenericSchema<OasUnknownData>;
 /**
  * Data type for OpenAPI unknown schema objects.
  *

package/esm/oas/unknown/unknown-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unknown-types.d.ts","sourceRoot":"","sources":["../../../src/oas/unknown/unknown-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;aAMzB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,kDAAkD;IAClD,OAAO,EAAE,QAAQ,CAAA;IACjB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yCAAyC;IACzC,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA"}
+{"version":3,"file":"unknown-types.d.ts","sourceRoot":"","sources":["../../../src/oas/unknown/unknown-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC,cAAc,CAMzD,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,kDAAkD;IAClD,OAAO,EAAE,QAAQ,CAAA;IACjB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yCAAyC;IACzC,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA"}

package/esm/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/esm/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/esm/types/CustomValue.js

@@ -1,14 +1,39 @@
 import "../_dnt.polyfills.js";
 import { ContentBase } from '../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";"
+ * ```
+ */
 export class CustomValue extends 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,
@@ -17,19 +42,52 @@ export class CustomValue extends 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}`;
     }
 }
+/**
+ * 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 const isCustomValue = (value) => {
     return Boolean(value && typeof value === 'object' && 'type' in value && value.type === 'custom');
 };

package/esm/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/esm/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/esm/types/DenoJson.js

@@ -1,10 +1,22 @@
 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 const 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.
+ */
 export const packageDenoJson = v.looseObject({
     name: v.string(),
     version: v.string(),