@skmtc/core 0.0.797 → 0.0.799

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

@@ -2,14 +2,34 @@ import * as v from 'valibot';
 import { type OasSchemaData } from '../schema/schema-types.js';
 import { type OasSchemaRefData } from '../ref/ref-types.js';
 import { type OasDiscriminatorData } from '../discriminator/discriminator-types.js';
+/**
+ * Data type for OpenAPI union schema objects.
+ *
+ * Represents union types (oneOf/anyOf) that allow values to match
+ * one or more of several possible schemas. Includes support for
+ * discriminator properties for efficient type resolution.
+ */
 export type OasUnionData = {
+    /** Type category identifier for schema objects */
     oasType: 'schema';
+    /** Type identifier (always 'union') */
     type: 'union';
+    /** Human-readable title for the union */
     title?: string;
+    /** Detailed description of the union's purpose */
     description?: string;
+    /** Array of schemas that comprise the union */
     members: (OasSchemaData | OasSchemaRefData)[];
+    /** Optional discriminator for efficient type resolution */
     discriminator?: OasDiscriminatorData;
 };
+/**
+ * Valibot schema for validating OpenAPI union data objects.
+ *
+ * Validates union schemas including member schema arrays and optional
+ * 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>;

package/script/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,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAA;IAC7C,aAAa,CAAC,EAAE,oBAAoB,CAAA;CACrC,CAAA;AAED,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;;;;;;;;;;;aAOvB,CAAA"}

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

@@ -38,6 +38,13 @@ const v = __importStar(require("valibot"));
 const schema_types_js_1 = require("../schema/schema-types.js");
 const ref_types_js_1 = require("../ref/ref-types.js");
 const discriminator_types_js_1 = require("../discriminator/discriminator-types.js");
+/**
+ * Valibot schema for validating OpenAPI union data objects.
+ *
+ * Validates union schemas including member schema arrays and optional
+ * discriminator properties. Uses lazy evaluation to handle recursive
+ * schema references in union members.
+ */
 exports.oasUnionData = v.object({
     oasType: v.literal('schema'),
     type: v.literal('union'),

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

@@ -1,4 +1,10 @@
 import * as v from 'valibot';
+/**
+ * Valibot schema for validating OpenAPI unknown data objects.
+ *
+ * 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>;
@@ -6,11 +12,23 @@ export declare const oasUnknownData: v.ObjectSchema<{
     readonly default: v.OptionalSchema<v.UnknownSchema, undefined>;
     readonly type: v.LiteralSchema<"unknown", undefined>;
 }, undefined>;
+/**
+ * Data type for OpenAPI unknown schema objects.
+ *
+ * Represents schemas with unspecified or flexible types, used as
+ * fallbacks when schema types cannot be determined or when maximum
+ * flexibility is required in the API specification.
+ */
 export type OasUnknownData = {
+    /** Type category identifier for schema objects */
     oasType: 'schema';
+    /** Human-readable title for the unknown schema */
     title?: string;
+    /** Detailed description of the schema's purpose */
     description?: string;
+    /** Default value of any type */
     default?: unknown;
+    /** Type identifier (always 'unknown') */
     type: 'unknown';
 };
 //# sourceMappingURL=unknown-types.d.ts.map

package/script/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,eAAO,MAAM,cAAc;;;;;;aAMzB,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,QAAQ,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,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;;;;;;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"}

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

@@ -35,6 +35,12 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.oasUnknownData = void 0;
 const v = __importStar(require("valibot"));
+/**
+ * Valibot schema for validating OpenAPI unknown data objects.
+ *
+ * Validates unknown/unspecified schemas used as fallbacks when
+ * schema types cannot be determined or for flexible data handling.
+ */
 exports.oasUnknownData = v.object({
     oasType: v.literal('schema'),
     title: v.optional(v.string()),

package/script/types/Results.d.ts

@@ -1,10 +1,42 @@
 import "../_dnt.polyfills.js";
 import * as v from 'valibot';
+/**
+ * Type representing the possible outcomes of SKMTC processing operations.
+ *
+ * Used throughout the SKMTC pipeline to track and categorize the results
+ * of parsing, generation, and rendering operations.
+ */
 export type ResultType = 'success' | 'warning' | 'error' | 'skipped' | 'notSupported';
+/**
+ * Type representing result types that indicate issues or problems.
+ *
+ * Used for filtering and handling results that require attention,
+ * excluding successful, skipped, or unsupported operations.
+ */
 export type WarningError = 'warning' | 'error';
+/**
+ * Valibot schema for validating ResultType values.
+ *
+ * Used for runtime validation of result type values throughout
+ * the SKMTC pipeline to ensure type safety and data integrity.
+ */
 export declare const resultType: v.GenericSchema<ResultType>;
+/**
+ * Interface representing a hierarchical results structure.
+ *
+ * Allows for nested result tracking where each key can contain
+ * a result type, another results item (for nesting), or an array
+ * of results items for collections.
+ */
 export interface ResultsItem {
+    /** Dynamic key-value pairs for hierarchical result tracking */
     [key: string]: ResultType | ResultsItem | Array<ResultsItem | null>;
 }
+/**
+ * Valibot schema for validating ResultsItem structures.
+ *
+ * Uses lazy evaluation to handle recursive result item validation,
+ * supporting nested hierarchical result structures.
+ */
 export declare const resultsItem: v.GenericSchema<ResultsItem>;
 //# sourceMappingURL=Results.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Results.d.ts","sourceRoot":"","sources":["../../src/types/Results.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,CAAA;AAErF,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,OAAO,CAAA;AAE9C,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAMjD,CAAA;AAEF,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;CACpE;AAED,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,aAAa,CAAC,WAAW,CAGpD,CAAA"}
+{"version":3,"file":"Results.d.ts","sourceRoot":"","sources":["../../src/types/Results.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,CAAA;AAErF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,OAAO,CAAA;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAMjD,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,+DAA+D;IAC/D,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;CACpE;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,aAAa,CAAC,WAAW,CAGpD,CAAA"}

package/script/types/Results.js

@@ -36,6 +36,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.resultsItem = exports.resultType = void 0;
 require("../_dnt.polyfills.js");
 const v = __importStar(require("valibot"));
+/**
+ * Valibot schema for validating ResultType values.
+ *
+ * Used for runtime validation of result type values throughout
+ * the SKMTC pipeline to ensure type safety and data integrity.
+ */
 exports.resultType = v.union([
     v.literal('success'),
     v.literal('warning'),
@@ -43,4 +49,10 @@ exports.resultType = v.union([
     v.literal('skipped'),
     v.literal('notSupported')
 ]);
+/**
+ * Valibot schema for validating ResultsItem structures.
+ *
+ * Uses lazy evaluation to handle recursive result item validation,
+ * supporting nested hierarchical result structures.
+ */
 exports.resultsItem = v.record(v.string(), v.lazy(() => v.union([exports.resultsItem, exports.resultType, v.array(v.lazy(() => exports.resultsItem))])));