@skmtc/core 0.0.797 → 0.0.799

package/script/oas/operation/Operation.js

@@ -112,84 +112,98 @@ const Object_js_1 = require("../object/Object.js");
  */
 class OasOperation {
     constructor(fields) {
+        /** Type identifier for OAS operation objects */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'operation'
         });
+        /** The API path for this operation */
         Object.defineProperty(this, "path", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The HTTP method for this operation */
         Object.defineProperty(this, "method", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The parent path item containing this operation */
         Object.defineProperty(this, "pathItem", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Unique identifier for the operation */
         Object.defineProperty(this, "operationId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Brief summary of the operation */
         Object.defineProperty(this, "summary", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Tags for organizing operations in documentation */
         Object.defineProperty(this, "tags", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Detailed description of the operation */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Parameters accepted by this operation */
         Object.defineProperty(this, "parameters", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Request body specification for this operation */
         Object.defineProperty(this, "requestBody", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Response specifications mapped by status code */
         Object.defineProperty(this, "responses", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Security requirements for this operation */
         Object.defineProperty(this, "security", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Whether this operation is deprecated */
         Object.defineProperty(this, "deprecated", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** OpenAPI specification extensions */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,

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

@@ -182,8 +182,11 @@ export type ParameterFields = {
  * ```
  */
 export declare class OasParameter {
+    /** Type identifier for OAS parameter objects */
     oasType: 'parameter';
+    /** The name of the parameter */
     name: string;
+    /** Where the parameter is located (path, query, header, cookie) */
     location: OasParameterLocation;
     description?: string | undefined;
     required?: boolean | undefined;

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

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

package/script/oas/parameter/Parameter.js

@@ -148,18 +148,21 @@ require("../../_dnt.polyfills.js");
  */
 class OasParameter {
     constructor(fields) {
+        /** Type identifier for OAS parameter objects */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'parameter'
         });
+        /** The name of the parameter */
         Object.defineProperty(this, "name", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Where the parameter is located (path, query, header, cookie) */
         Object.defineProperty(this, "location", {
             enumerable: true,
             configurable: true,

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

@@ -1,27 +1,69 @@
 import * as v from 'valibot';
+/**
+ * Data type for OpenAPI schema reference objects.
+ *
+ * Represents $ref references to schema objects in OpenAPI documents,
+ * allowing for component reuse and circular reference handling.
+ */
 export type OasSchemaRefData = {
+    /** Type identifier for OAS reference objects */
     oasType: 'ref';
+    /** The type of object being referenced */
     refType: 'schema';
+    /** The reference path (e.g., '#/components/schemas/User') */
     $ref: string;
+    /** Optional summary for the reference */
     summary?: string;
+    /** Optional description for the reference */
     description?: string;
 };
+/**
+ * Valibot schema for validating schema reference data.
+ */
 export declare const oasSchemaRefData: v.GenericSchema<OasSchemaRefData>;
+/**
+ * Data type for OpenAPI response reference objects.
+ *
+ * Represents $ref references to response objects in OpenAPI documents,
+ * enabling response definition reuse across multiple operations.
+ */
 export type OasResponseRefData = {
+    /** Type identifier for OAS reference objects */
     oasType: 'ref';
+    /** The type of object being referenced */
     refType: 'response';
+    /** The reference path (e.g., '#/components/responses/NotFound') */
     $ref: string;
+    /** Optional summary for the reference */
     summary?: string;
+    /** Optional description for the reference */
     description?: string;
 };
+/**
+ * Valibot schema for validating response reference data.
+ */
 export declare const oasResponseRefData: v.GenericSchema<OasResponseRefData>;
+/**
+ * Data type for OpenAPI parameter reference objects.
+ *
+ * Represents $ref references to parameter objects in OpenAPI documents,
+ * allowing parameter definitions to be reused across operations.
+ */
 export type OasParameterRefData = {
+    /** Type identifier for OAS reference objects */
     oasType: 'ref';
+    /** The type of object being referenced */
     refType: 'parameter';
+    /** The reference path (e.g., '#/components/parameters/PageSize') */
     $ref: string;
+    /** Optional summary for the reference */
     summary?: string;
+    /** Optional description for the reference */
     description?: string;
 };
+/**
+ * Valibot schema for validating parameter reference data.
+ */
 export declare const oasParameterRefData: v.GenericSchema<OasParameterRefData>;
 export type OasExampleRefData = {
     oasType: 'ref';

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,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,kBAAkB,GAAG;IAC/B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,UAAU,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,WAAW,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,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,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"}

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

@@ -36,6 +36,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.oasRefData = exports.oasSecuritySchemeRefData = exports.oasHeaderRefData = exports.oasRequestBodyRefData = exports.oasExampleRefData = exports.oasParameterRefData = exports.oasResponseRefData = exports.oasSchemaRefData = void 0;
 const markdown_types_js_1 = require("../markdown/markdown-types.js");
 const v = __importStar(require("valibot"));
+/**
+ * Valibot schema for validating schema reference data.
+ */
 exports.oasSchemaRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('schema'),
@@ -43,6 +46,9 @@ exports.oasSchemaRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating response reference data.
+ */
 exports.oasResponseRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('response'),
@@ -50,6 +56,9 @@ exports.oasResponseRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating parameter reference data.
+ */
 exports.oasParameterRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('parameter'),

package/script/oas/securitySchemes/security-scheme-types.d.ts

@@ -1,55 +1,118 @@
 import * as v from 'valibot';
+/**
+ * Data type for HTTP authentication security schemes.
+ *
+ * Represents HTTP authentication mechanisms like Basic, Bearer,
+ * and other HTTP authentication schemes as defined in RFC 7235.
+ */
 export type OasHttpSecuritySchemeData = {
+    /** Security scheme type identifier */
     type: 'http';
+    /** Human-readable description of the security scheme */
     description?: string;
+    /** HTTP authorization scheme (e.g., 'basic', 'bearer') */
     scheme: string;
+    /** Format hint for bearer tokens (e.g., 'JWT') */
     bearerFormat?: string;
 };
+/**
+ * Valibot schema for validating HTTP security scheme data.
+ */
 export declare const oasHttpSecuritySchemeData: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"http", undefined>;
     readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
     readonly scheme: v.StringSchema<undefined>;
     readonly bearerFormat: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>;
+/**
+ * Data type for API key authentication security schemes.
+ *
+ * Represents API key authentication where the key is passed
+ * via header, query parameter, or cookie.
+ */
 export type OasApiKeySecuritySchemeData = {
+    /** Security scheme type identifier */
     type: 'apiKey';
+    /** Human-readable description of the security scheme */
     description?: string;
+    /** Name of the header, query parameter, or cookie */
     name: string;
+    /** Location where the API key should be sent */
     in: 'header' | 'query' | 'cookie';
 };
+/**
+ * Valibot schema for validating API key security scheme data.
+ */
 export declare const oasApiKeySecuritySchemeData: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"apiKey", undefined>;
     readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
     readonly name: v.StringSchema<undefined>;
     readonly in: v.UnionSchema<[v.LiteralSchema<"header", undefined>, v.LiteralSchema<"query", undefined>, v.LiteralSchema<"cookie", undefined>], undefined>;
 }, undefined>;
+/**
+ * Data type for OAuth2 implicit flow configuration.
+ *
+ * Represents the implicit OAuth2 flow where tokens are obtained
+ * directly from the authorization endpoint without client authentication.
+ */
 export type OasImplicitOAuth2FlowData = {
+    /** URL for the OAuth2 authorization endpoint */
     authorizationUrl: string;
+    /** Optional URL for token refresh */
     refreshUrl: string | undefined;
+    /** Available scopes mapped to their descriptions */
     scopes: Record<string, string>;
 };
+/**
+ * Valibot schema for validating OAuth2 implicit flow data.
+ */
 export declare const oasImplicitOAuth2FlowData: v.ObjectSchema<{
     readonly authorizationUrl: v.StringSchema<undefined>;
     readonly refreshUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
     readonly scopes: v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
 }, undefined>;
+/**
+ * Data type for OAuth2 authorization code flow configuration.
+ *
+ * Represents the authorization code OAuth2 flow, the most secure
+ * flow suitable for server-side applications with client authentication.
+ */
 export type OasAuthorizationCodeOAuth2FlowData = {
+    /** URL for the OAuth2 authorization endpoint */
     authorizationUrl: string;
+    /** URL for the OAuth2 token endpoint */
     tokenUrl: string;
+    /** Optional URL for token refresh */
     refreshUrl: string | undefined;
+    /** Available scopes mapped to their descriptions */
     scopes: Record<string, string>;
 };
+/**
+ * Valibot schema for validating OAuth2 authorization code flow data.
+ */
 export declare const oasAuthorizationCodeOAuth2FlowData: v.ObjectSchema<{
     readonly authorizationUrl: v.StringSchema<undefined>;
     readonly tokenUrl: v.StringSchema<undefined>;
     readonly refreshUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
     readonly scopes: v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
 }, undefined>;
+/**
+ * Data type for OAuth2 client credentials flow configuration.
+ *
+ * Represents the client credentials OAuth2 flow used for
+ * server-to-server authentication without user involvement.
+ */
 export type OasClientCredentialsOAuth2FlowData = {
+    /** URL for the OAuth2 token endpoint */
     tokenUrl: string;
+    /** Optional URL for token refresh */
     refreshUrl: string | undefined;
+    /** Available scopes mapped to their descriptions */
     scopes: Record<string, string>;
 };
+/**
+ * Valibot schema for validating OAuth2 client credentials flow data.
+ */
 export declare const oasClientCredentialsOAuth2FlowData: v.ObjectSchema<{
     readonly tokenUrl: v.StringSchema<undefined>;
     readonly refreshUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;

package/script/oas/securitySchemes/security-scheme-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"security-scheme-types.d.ts","sourceRoot":"","sources":["../../../src/oas/securitySchemes/security-scheme-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;aAKpC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;CAClC,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;aAKtC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;aAK7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;aAI7C,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,QAAQ,CAAC,EAAE,yBAAyB,CAAA;IACpC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;CACrC,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;aAK7B,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,kBAAkB,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;aAItC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,eAAe,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;aAItC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,2BAA2B,GAC3B,2BAA2B,CAAA;AAE/B,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAKhC,CAAA"}
+{"version":3,"file":"security-scheme-types.d.ts","sourceRoot":"","sources":["../../../src/oas/securitySchemes/security-scheme-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;aAKpC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,sCAAsC;IACtC,IAAI,EAAE,QAAQ,CAAA;IACd,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;CAClC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;aAKtC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAA;IACxB,qCAAqC;IACrC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAA;IACxB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;aAK7C,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;aAI7C,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,QAAQ,CAAC,EAAE,yBAAyB,CAAA;IACpC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;CACrC,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;aAK7B,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,kBAAkB,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;aAItC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,eAAe,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;aAItC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,2BAA2B,GAC3B,2BAA2B,CAAA;AAE/B,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAKhC,CAAA"}

package/script/oas/securitySchemes/security-scheme-types.js

@@ -35,29 +35,44 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.oasSecuritySchemeData = exports.oasOpenIdSecuritySchemeData = exports.oasOAuth2SecuritySchemeData = exports.oasOAuth2FlowsData = exports.oasPasswordOAuth2FlowData = exports.oasClientCredentialsOAuth2FlowData = exports.oasAuthorizationCodeOAuth2FlowData = exports.oasImplicitOAuth2FlowData = exports.oasApiKeySecuritySchemeData = exports.oasHttpSecuritySchemeData = void 0;
 const v = __importStar(require("valibot"));
+/**
+ * Valibot schema for validating HTTP security scheme data.
+ */
 exports.oasHttpSecuritySchemeData = v.object({
     type: v.literal('http'),
     description: v.optional(v.string()),
     scheme: v.string(),
     bearerFormat: v.optional(v.string())
 });
+/**
+ * Valibot schema for validating API key security scheme data.
+ */
 exports.oasApiKeySecuritySchemeData = v.object({
     type: v.literal('apiKey'),
     description: v.optional(v.string()),
     name: v.string(),
     in: v.union([v.literal('header'), v.literal('query'), v.literal('cookie')])
 });
+/**
+ * Valibot schema for validating OAuth2 implicit flow data.
+ */
 exports.oasImplicitOAuth2FlowData = v.object({
     authorizationUrl: v.string(),
     refreshUrl: v.optional(v.string()),
     scopes: v.record(v.string(), v.string())
 });
+/**
+ * Valibot schema for validating OAuth2 authorization code flow data.
+ */
 exports.oasAuthorizationCodeOAuth2FlowData = v.object({
     authorizationUrl: v.string(),
     tokenUrl: v.string(),
     refreshUrl: v.optional(v.string()),
     scopes: v.record(v.string(), v.string())
 });
+/**
+ * Valibot schema for validating OAuth2 client credentials flow data.
+ */
 exports.oasClientCredentialsOAuth2FlowData = v.object({
     tokenUrl: v.string(),
     refreshUrl: v.optional(v.string()),

package/script/oas/serverVariable/ServerVariable.d.ts

@@ -1,16 +1,50 @@
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Fields for configuring an OpenAPI server variable object.
+ *
+ * Represents the configuration data needed to create a server variable,
+ * including default values, enumeration constraints, and extensions.
+ */
 export type ServerVariableFields = {
+    /** Human-readable description of the server variable */
     description?: string | undefined;
+    /** Default value for the server variable */
     default: string;
+    /** Array of allowed values for the server variable */
     enums?: string[] | undefined;
+    /** OpenAPI specification extensions */
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents an OpenAPI server variable object.
+ *
+ * Server variables provide parameterization for server URLs,
+ * allowing dynamic server configuration with default values
+ * and enumeration constraints.
+ *
+ * @example Basic server variable
+ * ```typescript
+ * const serverVar = new OasServerVariable({
+ *   default: 'api',
+ *   description: 'API version subdomain',
+ *   enums: ['api', 'api-staging', 'api-dev']
+ * });
+ *
+ * console.log(serverVar.default); // 'api'
+ * console.log(serverVar.enums);   // ['api', 'api-staging', 'api-dev']
+ * ```
+ */
 export declare class OasServerVariable {
+    /** Type identifier for OAS server variable objects */
     oasType: 'serverVariable';
+    /** Human-readable description of the server variable */
     description: string | undefined;
+    /** Default value for the server variable */
     default: string;
+    /** Array of allowed values for the server variable */
     enums?: string[] | undefined;
+    /** OpenAPI specification extensions */
     extensionFields: Record<string, unknown> | undefined;
     constructor(fields: ServerVariableFields);
     isRef(): boolean;

package/script/oas/serverVariable/ServerVariable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ServerVariable.d.ts","sourceRoot":"","sources":["../../../src/oas/serverVariable/ServerVariable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,iBAAiB;IAC5B,OAAO,EAAE,gBAAgB,CAAmB;IAC5C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,oBAAoB;IAOxC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,iBAAiB;IAI5B,WAAW,IAAI,iBAAiB;IAIhC,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAO5E"}
+{"version":3,"file":"ServerVariable.d.ts","sourceRoot":"","sources":["../../../src/oas/serverVariable/ServerVariable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,iBAAiB;IAC5B,sDAAsD;IACtD,OAAO,EAAE,gBAAgB,CAAmB;IAC5C,wDAAwD;IACxD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,oBAAoB;IAOxC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,iBAAiB;IAI5B,WAAW,IAAI,iBAAiB;IAIhC,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAO5E"}

package/script/oas/serverVariable/ServerVariable.js

@@ -1,32 +1,56 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasServerVariable = void 0;
+/**
+ * Represents an OpenAPI server variable object.
+ *
+ * Server variables provide parameterization for server URLs,
+ * allowing dynamic server configuration with default values
+ * and enumeration constraints.
+ *
+ * @example Basic server variable
+ * ```typescript
+ * const serverVar = new OasServerVariable({
+ *   default: 'api',
+ *   description: 'API version subdomain',
+ *   enums: ['api', 'api-staging', 'api-dev']
+ * });
+ *
+ * console.log(serverVar.default); // 'api'
+ * console.log(serverVar.enums);   // ['api', 'api-staging', 'api-dev']
+ * ```
+ */
 class OasServerVariable {
     constructor(fields) {
+        /** Type identifier for OAS server variable objects */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'serverVariable'
         });
+        /** Human-readable description of the server variable */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Default value for the server variable */
         Object.defineProperty(this, "default", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Array of allowed values for the server variable */
         Object.defineProperty(this, "enums", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** OpenAPI specification extensions */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,

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

@@ -1,4 +1,18 @@
 import * as v from 'valibot';
+/**
+ * Union type for OpenAPI string format specifiers.
+ *
+ * Represents the standard string formats defined in OpenAPI v3,
+ * providing semantic meaning for string validation and processing.
+ * Used for generating appropriate validation rules in target languages.
+ */
+export type StringFormat = 'date-time' | 'time' | 'date' | 'duration' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uuid' | 'uri' | 'regex' | 'password' | 'byte' | 'binary';
+/**
+ * Valibot enum schema for valid OpenAPI string format values.
+ *
+ * Defines the standard string formats supported by OpenAPI v3,
+ * including date/time formats, network formats, and encoding formats.
+ */
 export declare const stringFormat: v.EnumSchema<{
     readonly 'date-time': "date-time";
     readonly time: "time";
@@ -15,6 +29,12 @@ export declare const stringFormat: v.EnumSchema<{
     readonly byte: "byte";
     readonly binary: "binary";
 }, undefined>;
+/**
+ * Valibot schema for validating OpenAPI string data objects.
+ *
+ * Validates string schema objects including length constraints,
+ * pattern validation, format specifiers, and enumeration values.
+ */
 export declare const oasStringData: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"string", undefined>;
     readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
@@ -28,18 +48,35 @@ export declare const oasStringData: v.ObjectSchema<{
     readonly nullable: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
     readonly example: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>;
-export type StringFormat = 'date-time' | 'time' | 'date' | 'duration' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uuid' | 'uri' | 'regex' | 'password' | 'byte' | 'binary';
+/**
+ * Data type for OpenAPI string schema objects.
+ *
+ * Represents string schemas with validation constraints,
+ * format specifiers, and metadata. Used throughout the
+ * SKMTC pipeline for string type processing and code generation.
+ */
 export type OasStringData = {
+    /** Human-readable title for the string */
     title?: string;
+    /** Detailed description of the string's purpose */
     description?: string;
+    /** Default value for the string */
     default?: string;
+    /** Type identifier (always 'string') */
     type: 'string';
+    /** Maximum allowed length */
     maxLength?: number;
+    /** Minimum required length */
     minLength?: number;
+    /** Regular expression pattern for validation */
     pattern?: string;
+    /** Array of valid enumeration values */
     enum?: string[];
+    /** Format specifier (date-time, email, etc.) */
     format?: string;
+    /** Whether null values are allowed */
     nullable?: boolean;
+    /** Example value for documentation */
     example?: string;
 };
 //# sourceMappingURL=string-types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"string-types.d.ts","sourceRoot":"","sources":["../../../src/oas/string/string-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;aAevB,CAAA;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;aAYxB,CAAA;AAEF,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,OAAO,GACP,UAAU,GACV,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,UAAU,GACV,MAAM,GACN,QAAQ,CAAA;AAEZ,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA"}
+{"version":3,"file":"string-types.d.ts","sourceRoot":"","sources":["../../../src/oas/string/string-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,OAAO,GACP,UAAU,GACV,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,UAAU,GACV,MAAM,GACN,QAAQ,CAAA;AAEZ;;;;;GAKG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;aAevB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;aAYxB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sCAAsC;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA"}

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

@@ -35,6 +35,12 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.oasStringData = exports.stringFormat = void 0;
 const v = __importStar(require("valibot"));
+/**
+ * Valibot enum schema for valid OpenAPI string format values.
+ *
+ * Defines the standard string formats supported by OpenAPI v3,
+ * including date/time formats, network formats, and encoding formats.
+ */
 exports.stringFormat = v.enum({
     'date-time': 'date-time',
     time: 'time',
@@ -51,6 +57,12 @@ exports.stringFormat = v.enum({
     byte: 'byte',
     binary: 'binary'
 });
+/**
+ * Valibot schema for validating OpenAPI string data objects.
+ *
+ * Validates string schema objects including length constraints,
+ * pattern validation, format specifiers, and enumeration values.
+ */
 exports.oasStringData = v.object({
     type: v.literal('string'),
     title: v.optional(v.string()),