@skmtc/core 0.0.786 → 0.0.788

package/script/dsl/JsonFile.js

@@ -1,20 +1,154 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonFile = void 0;
+/**
+ * Represents a JSON file in the SKMTC DSL system.
+ *
+ * The `JsonFile` class is used to generate JSON files as part of the code generation
+ * process. It provides a simple interface for creating configuration files, manifests,
+ * package.json files, and other JSON-based artifacts with proper formatting.
+ *
+ * ## Key Features
+ *
+ * - **JSON Formatting**: Automatically formats JSON with 2-space indentation
+ * - **Type Safety**: Accepts any valid JSON-serializable content structure
+ * - **Path Management**: Associates content with specific file paths
+ * - **String Conversion**: Easy integration with file writing systems
+ *
+ * @example Basic JSON file creation
+ * ```typescript
+ * import { JsonFile } from '@skmtc/core';
+ *
+ * const packageJson = new JsonFile({
+ *   path: './package.json',
+ *   content: {
+ *     name: 'my-api-client',
+ *     version: '1.0.0',
+ *     type: 'module',
+ *     main: './index.js',
+ *     dependencies: {
+ *       'axios': '^1.0.0'
+ *     }
+ *   }
+ * });
+ *
+ * const jsonContent = packageJson.toString();
+ * console.log(jsonContent);
+ * // {
+ * //   "name": "my-api-client",
+ * //   "version": "1.0.0",
+ * //   "type": "module",
+ * //   "main": "./index.js",
+ * //   "dependencies": {
+ * //     "axios": "^1.0.0"
+ * //   }
+ * // }
+ * ```
+ *
+ * @example Configuration file generation
+ * ```typescript
+ * const configFile = new JsonFile({
+ *   path: './src/config/api.json',
+ *   content: {
+ *     baseUrl: 'https://api.example.com',
+ *     timeout: 5000,
+ *     retryAttempts: 3,
+ *     endpoints: {
+ *       users: '/users',
+ *       products: '/products',
+ *       orders: '/orders'
+ *     }
+ *   }
+ * });
+ *
+ * // Write to file system
+ * await Deno.writeTextFile(configFile.path, configFile.toString());
+ * ```
+ *
+ * @example OpenAPI specification output
+ * ```typescript
+ * const openApiFile = new JsonFile({
+ *   path: './dist/openapi.json',
+ *   content: {
+ *     openapi: '3.0.0',
+ *     info: {
+ *       title: 'My API',
+ *       version: '1.0.0'
+ *     },
+ *     paths: {
+ *       '/users': {
+ *         get: {
+ *           summary: 'List users',
+ *           responses: {
+ *             '200': {
+ *               description: 'Success'
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * });
+ * ```
+ *
+ * @example Using with generator registration
+ * ```typescript
+ * class MyGenerator extends ContentBase {
+ *   generate() {
+ *     const manifestFile = new JsonFile({
+ *       path: './generated/manifest.json',
+ *       content: {
+ *         generatedAt: new Date().toISOString(),
+ *         version: '1.0.0',
+ *         files: [
+ *           './models/User.ts',
+ *           './models/Product.ts'
+ *         ]
+ *       }
+ *     });
+ *
+ *     // Register with the generation context
+ *     this.register({ jsonFile: manifestFile });
+ *   }
+ * }
+ * ```
+ */
 class JsonFile {
+    /**
+     * Creates a new JsonFile instance.
+     *
+     * @param args - JSON file configuration
+     * @param args.path - The output path for this JSON file
+     * @param args.content - The JSON content to write
+     *
+     * @example
+     * ```typescript
+     * const configFile = new JsonFile({
+     *   path: './config/settings.json',
+     *   content: {
+     *     theme: 'dark',
+     *     language: 'en',
+     *     features: ['auth', 'notifications']
+     *   }
+     * });
+     * ```
+     */
     constructor({ path, content }) {
+        /** The file type, always 'json' for JSON files */
         Object.defineProperty(this, "fileType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'json'
         });
+        /** The file path for this generated JSON file */
         Object.defineProperty(this, "path", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The JSON content to write to the file */
         Object.defineProperty(this, "content", {
             enumerable: true,
             configurable: true,
@@ -24,6 +158,29 @@ class JsonFile {
         this.path = path;
         this.content = content;
     }
+    /**
+     * Converts the JSON content to a formatted string.
+     *
+     * This method serializes the content object to JSON with 2-space indentation
+     * for readable output. The resulting string is suitable for writing directly
+     * to a file or including in the generation pipeline.
+     *
+     * @returns The formatted JSON content as a string
+     *
+     * @example
+     * ```typescript
+     * const file = new JsonFile({
+     *   path: './data.json',
+     *   content: { name: 'test', value: 42 }
+     * });
+     *
+     * console.log(file.toString());
+     * // {
+     * //   "name": "test",
+     * //   "value": 42
+     * // }
+     * ```
+     */
     toString() {
         return JSON.stringify(this.content, null, 2);
     }

package/script/oas/array/Array.d.ts

@@ -2,21 +2,129 @@ import "../../_dnt.polyfills.js";
 import type { OasSchema, ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OasRef } from '../ref/Ref.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasArray}.
+ *
+ * @template Nullable - Whether the array value can be null
+ */
 export type ArrayFields<Nullable extends boolean | undefined> = {
+    /** Schema definition for array items */
     items: OasSchema | OasRef<'schema'>;
+    /** A short summary of the array schema */
     title?: string;
+    /** A description of the array schema */
     description?: string;
+    /** Whether the array value can be null */
     nullable?: Nullable;
+    /** Whether array items must be unique */
     uniqueItems?: boolean;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
+    /** Example array value */
     example?: Nullable extends true ? unknown[] | null | undefined : unknown[] | undefined;
+    /** Maximum number of items allowed */
     maxItems?: number;
+    /** Minimum number of items required */
     minItems?: number;
+    /** Array of allowed enum values for the entire array */
     enums?: Nullable extends true ? (unknown | null)[] | undefined : unknown[] | undefined;
+    /** Default value for the array */
     defaultValue?: Nullable extends true ? unknown[] | null | undefined : unknown[] | undefined;
 };
 /**
- * Object representing an array in the OpenAPI Specification.
+ * Represents an array schema in the OpenAPI Specification.
+ *
+ * `OasArray` handles array type definitions with comprehensive validation
+ * constraints including item count limits, uniqueness requirements, and
+ * item type specifications. It supports nested schemas and references
+ * for complex array structures.
+ *
+ * This class is used throughout the OAS processing pipeline to represent
+ * array fields in API schemas, including lists of objects, primitive arrays,
+ * and complex nested array structures.
+ *
+ * ## Key Features
+ *
+ * - **Item Type Definition**: Support for any schema type as array items
+ * - **Size Constraints**: Minimum and maximum item count validation
+ * - **Uniqueness Validation**: Ensure array items are unique (like Set behavior)
+ * - **Nested Schemas**: Support for complex nested array structures
+ * - **Reference Handling**: Seamless integration with schema references
+ * - **Nullable Support**: Type-safe nullable array handling
+ * - **JSON Schema**: Conversion to standard JSON Schema format
+ *
+ * @template Nullable - Whether the array value can be null
+ *
+ * @example String array
+ * ```typescript
+ * import { OasArray, OasString } from '@skmtc/core';
+ *
+ * const tagsArray = new OasArray({
+ *   title: 'Tags',
+ *   description: 'List of tags associated with the item',
+ *   items: new OasString({ minLength: 1 }),
+ *   minItems: 1,
+ *   uniqueItems: true,
+ *   example: ['javascript', 'typescript', 'react']
+ * });
+ * ```
+ *
+ * @example Object array with references
+ * ```typescript
+ * import { OasArray, OasRef } from '@skmtc/core';
+ *
+ * const usersArray = new OasArray({
+ *   title: 'Users',
+ *   description: 'List of user objects',
+ *   items: new OasRef({ refName: 'User' }),
+ *   maxItems: 100,
+ *   example: [
+ *     { id: 1, name: 'John' },
+ *     { id: 2, name: 'Jane' }
+ *   ]
+ * });
+ * ```
+ *
+ * @example Nested array (array of arrays)
+ * ```typescript
+ * const matrixArray = new OasArray({
+ *   title: 'Matrix',
+ *   description: '2D array of numbers',
+ *   items: new OasArray({
+ *     items: new OasInteger({ minimum: 0 })
+ *   }),
+ *   example: [
+ *     [1, 2, 3],
+ *     [4, 5, 6],
+ *     [7, 8, 9]
+ *   ]
+ * });
+ * ```
+ *
+ * @example Nullable array with constraints
+ * ```typescript
+ * const optionalIdsArray = new OasArray<true>({
+ *   title: 'Optional IDs',
+ *   description: 'Optional list of IDs',
+ *   items: new OasInteger({ format: 'int64', minimum: 1 }),
+ *   nullable: true,
+ *   minItems: 0,
+ *   maxItems: 10,
+ *   defaultValue: null
+ * });
+ * ```
+ *
+ * @example Unique items validation
+ * ```typescript
+ * const uniqueEmailsArray = new OasArray({
+ *   title: 'Email Recipients',
+ *   description: 'List of unique email addresses',
+ *   items: new OasString({ format: 'email' }),
+ *   uniqueItems: true, // Ensures no duplicate emails
+ *   minItems: 1,
+ *   example: ['user1@example.com', 'user2@example.com']
+ * });
+ * ```
  */
 export declare class OasArray<Nullable extends boolean | undefined = boolean | undefined> {
     /**

package/script/oas/array/Array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Array.d.ts","sourceRoot":"","sources":["../../../src/oas/array/Array.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAC9D,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACtF,YAAY,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;CAC5F,CAAA;AAED;;GAEG;AACH,qBAAa,QAAQ,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAC9E;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,OAAO,CAAS;IACvB;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,WAAW,EAAE,OAAO,GAAG,SAAS,CAAA;IAEhC,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAEpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACrF;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAE5B;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IAErF;;OAEG;IACH,YAAY,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;gBAE9E,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC;IAczC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAI7B,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAIjC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,iBAAiB;CAexE"}
+{"version":3,"file":"Array.d.ts","sourceRoot":"","sources":["../../../src/oas/array/Array.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAC9D,wCAAwC;IACxC,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACnC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,yCAAyC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,0BAA0B;IAC1B,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACtF,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACtF,kCAAkC;IAClC,YAAY,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;CAC5F,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8FG;AACH,qBAAa,QAAQ,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAC9E;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,OAAO,CAAS;IACvB;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,WAAW,EAAE,OAAO,GAAG,SAAS,CAAA;IAEhC,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAEpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACrF;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAE5B;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IAErF;;OAEG;IACH,YAAY,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;gBAE9E,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC;IAczC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAI7B,WAAW,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAIjC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,iBAAiB;CAexE"}

package/script/oas/array/Array.js

@@ -3,7 +3,99 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasArray = void 0;
 require("../../_dnt.polyfills.js");
 /**
- * Object representing an array in the OpenAPI Specification.
+ * Represents an array schema in the OpenAPI Specification.
+ *
+ * `OasArray` handles array type definitions with comprehensive validation
+ * constraints including item count limits, uniqueness requirements, and
+ * item type specifications. It supports nested schemas and references
+ * for complex array structures.
+ *
+ * This class is used throughout the OAS processing pipeline to represent
+ * array fields in API schemas, including lists of objects, primitive arrays,
+ * and complex nested array structures.
+ *
+ * ## Key Features
+ *
+ * - **Item Type Definition**: Support for any schema type as array items
+ * - **Size Constraints**: Minimum and maximum item count validation
+ * - **Uniqueness Validation**: Ensure array items are unique (like Set behavior)
+ * - **Nested Schemas**: Support for complex nested array structures
+ * - **Reference Handling**: Seamless integration with schema references
+ * - **Nullable Support**: Type-safe nullable array handling
+ * - **JSON Schema**: Conversion to standard JSON Schema format
+ *
+ * @template Nullable - Whether the array value can be null
+ *
+ * @example String array
+ * ```typescript
+ * import { OasArray, OasString } from '@skmtc/core';
+ *
+ * const tagsArray = new OasArray({
+ *   title: 'Tags',
+ *   description: 'List of tags associated with the item',
+ *   items: new OasString({ minLength: 1 }),
+ *   minItems: 1,
+ *   uniqueItems: true,
+ *   example: ['javascript', 'typescript', 'react']
+ * });
+ * ```
+ *
+ * @example Object array with references
+ * ```typescript
+ * import { OasArray, OasRef } from '@skmtc/core';
+ *
+ * const usersArray = new OasArray({
+ *   title: 'Users',
+ *   description: 'List of user objects',
+ *   items: new OasRef({ refName: 'User' }),
+ *   maxItems: 100,
+ *   example: [
+ *     { id: 1, name: 'John' },
+ *     { id: 2, name: 'Jane' }
+ *   ]
+ * });
+ * ```
+ *
+ * @example Nested array (array of arrays)
+ * ```typescript
+ * const matrixArray = new OasArray({
+ *   title: 'Matrix',
+ *   description: '2D array of numbers',
+ *   items: new OasArray({
+ *     items: new OasInteger({ minimum: 0 })
+ *   }),
+ *   example: [
+ *     [1, 2, 3],
+ *     [4, 5, 6],
+ *     [7, 8, 9]
+ *   ]
+ * });
+ * ```
+ *
+ * @example Nullable array with constraints
+ * ```typescript
+ * const optionalIdsArray = new OasArray<true>({
+ *   title: 'Optional IDs',
+ *   description: 'Optional list of IDs',
+ *   items: new OasInteger({ format: 'int64', minimum: 1 }),
+ *   nullable: true,
+ *   minItems: 0,
+ *   maxItems: 10,
+ *   defaultValue: null
+ * });
+ * ```
+ *
+ * @example Unique items validation
+ * ```typescript
+ * const uniqueEmailsArray = new OasArray({
+ *   title: 'Email Recipients',
+ *   description: 'List of unique email addresses',
+ *   items: new OasString({ format: 'email' }),
+ *   uniqueItems: true, // Ensures no duplicate emails
+ *   minItems: 1,
+ *   example: ['user1@example.com', 'user2@example.com']
+ * });
+ * ```
  */
 class OasArray {
     constructor(fields) {

package/script/oas/integer/Integer.d.ts

@@ -2,21 +2,119 @@ import "../../_dnt.polyfills.js";
 import type { OasRef } from '../ref/Ref.js';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
+/**
+ * Constructor fields for {@link OasInteger}.
+ *
+ * @template Nullable - Whether the integer value can be null
+ */
 export type IntegerFields<Nullable extends boolean | undefined> = {
+    /** A short summary of the integer schema */
     title?: string;
+    /** A description of the integer schema */
     description?: string;
+    /** Whether the integer value can be null */
     nullable?: Nullable;
+    /** Integer format specification (int32 or int64) */
     format?: 'int32' | 'int64';
+    /** Default value for the integer */
     default?: Nullable extends true ? number | null | undefined : number | undefined;
+    /** Array of allowed enum values */
     enums?: Nullable extends true ? (number | null)[] | undefined : number[] | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
+    /** Example value for the integer */
     example?: Nullable extends true ? number | null | undefined : number | undefined;
+    /** Number must be a multiple of this value */
     multipleOf?: number;
+    /** Maximum value (inclusive) */
     maximum?: number;
+    /** Whether maximum is exclusive */
     exclusiveMaximum?: boolean;
+    /** Minimum value (inclusive) */
     minimum?: number;
+    /** Whether minimum is exclusive */
     exclusiveMinimum?: boolean;
 };
+/**
+ * Represents an integer schema in the OpenAPI Specification.
+ *
+ * `OasInteger` handles integer type definitions with comprehensive validation
+ * constraints including range limits, multiple-of validation, format specifications,
+ * and enum restrictions. It supports both 32-bit and 64-bit integer formats
+ * and provides nullable type support.
+ *
+ * This class is used throughout the OAS processing pipeline to represent
+ * integer fields in API schemas, including IDs, counts, timestamps, and
+ * other numeric values that must be whole numbers.
+ *
+ * ## Key Features
+ *
+ * - **Format Support**: int32 and int64 format specifications
+ * - **Range Validation**: Minimum and maximum value constraints
+ * - **Multiple Validation**: Ensure values are multiples of specified numbers
+ * - **Enum Values**: Restricted sets of allowed integer values
+ * - **Nullable Support**: Type-safe nullable integer handling
+ * - **JSON Schema**: Conversion to standard JSON Schema format
+ *
+ * @template Nullable - Whether the integer value can be null
+ *
+ * @example Basic integer schema
+ * ```typescript
+ * import { OasInteger } from '@skmtc/core';
+ *
+ * const ageInteger = new OasInteger({
+ *   title: 'Age',
+ *   description: 'Person age in years',
+ *   minimum: 0,
+ *   maximum: 150,
+ *   example: 25
+ * });
+ * ```
+ *
+ * @example ID with int64 format
+ * ```typescript
+ * const userIdInteger = new OasInteger({
+ *   title: 'User ID',
+ *   description: 'Unique user identifier',
+ *   format: 'int64',
+ *   minimum: 1,
+ *   example: 1234567890123
+ * });
+ * ```
+ *
+ * @example Count with multiple-of validation
+ * ```typescript
+ * const batchSizeInteger = new OasInteger({
+ *   title: 'Batch Size',
+ *   description: 'Number of items to process',
+ *   minimum: 10,
+ *   maximum: 1000,
+ *   multipleOf: 10, // Must be multiple of 10
+ *   default: 50
+ * });
+ * ```
+ *
+ * @example Status code enum
+ * ```typescript
+ * const statusCodeInteger = new OasInteger({
+ *   title: 'HTTP Status Code',
+ *   description: 'Valid HTTP response status codes',
+ *   enums: [200, 201, 400, 401, 404, 500],
+ *   example: 200
+ * });
+ * ```
+ *
+ * @example Nullable integer
+ * ```typescript
+ * const optionalCountInteger = new OasInteger<true>({
+ *   title: 'Optional Count',
+ *   description: 'Count value that can be null',
+ *   nullable: true,
+ *   minimum: 0,
+ *   default: null
+ * });
+ * ```
+ */
 export declare class OasInteger<Nullable extends boolean | undefined = boolean | undefined> {
     /**
      * Object is part the 'schema' set which is used

package/script/oas/integer/Integer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Integer.d.ts","sourceRoot":"","sources":["../../../src/oas/integer/Integer.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAC1B,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACpF,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED,qBAAa,UAAU,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAChF;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,SAAS,CAAS;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnF,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;gBACnE,MAAM,GAAE,aAAa,CAAC,QAAQ,CAAM;IAgBhD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC;IAI/B,WAAW,IAAI,UAAU,CAAC,QAAQ,CAAC;IAKnC,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAiB5E"}
+{"version":3,"file":"Integer.d.ts","sourceRoot":"","sources":["../../../src/oas/integer/Integer.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAChE,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,oDAAoD;IACpD,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAC1B,oCAAoC;IACpC,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,mCAAmC;IACnC,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACpF,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,oCAAoC;IACpC,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,qBAAa,UAAU,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAChF;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,SAAS,CAAS;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnF,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;gBACnE,MAAM,GAAE,aAAa,CAAC,QAAQ,CAAM;IAgBhD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC;IAI/B,WAAW,IAAI,UAAU,CAAC,QAAQ,CAAC;IAKnC,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAiB5E"}

package/script/oas/integer/Integer.js

@@ -2,6 +2,86 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasInteger = void 0;
 require("../../_dnt.polyfills.js");
+/**
+ * Represents an integer schema in the OpenAPI Specification.
+ *
+ * `OasInteger` handles integer type definitions with comprehensive validation
+ * constraints including range limits, multiple-of validation, format specifications,
+ * and enum restrictions. It supports both 32-bit and 64-bit integer formats
+ * and provides nullable type support.
+ *
+ * This class is used throughout the OAS processing pipeline to represent
+ * integer fields in API schemas, including IDs, counts, timestamps, and
+ * other numeric values that must be whole numbers.
+ *
+ * ## Key Features
+ *
+ * - **Format Support**: int32 and int64 format specifications
+ * - **Range Validation**: Minimum and maximum value constraints
+ * - **Multiple Validation**: Ensure values are multiples of specified numbers
+ * - **Enum Values**: Restricted sets of allowed integer values
+ * - **Nullable Support**: Type-safe nullable integer handling
+ * - **JSON Schema**: Conversion to standard JSON Schema format
+ *
+ * @template Nullable - Whether the integer value can be null
+ *
+ * @example Basic integer schema
+ * ```typescript
+ * import { OasInteger } from '@skmtc/core';
+ *
+ * const ageInteger = new OasInteger({
+ *   title: 'Age',
+ *   description: 'Person age in years',
+ *   minimum: 0,
+ *   maximum: 150,
+ *   example: 25
+ * });
+ * ```
+ *
+ * @example ID with int64 format
+ * ```typescript
+ * const userIdInteger = new OasInteger({
+ *   title: 'User ID',
+ *   description: 'Unique user identifier',
+ *   format: 'int64',
+ *   minimum: 1,
+ *   example: 1234567890123
+ * });
+ * ```
+ *
+ * @example Count with multiple-of validation
+ * ```typescript
+ * const batchSizeInteger = new OasInteger({
+ *   title: 'Batch Size',
+ *   description: 'Number of items to process',
+ *   minimum: 10,
+ *   maximum: 1000,
+ *   multipleOf: 10, // Must be multiple of 10
+ *   default: 50
+ * });
+ * ```
+ *
+ * @example Status code enum
+ * ```typescript
+ * const statusCodeInteger = new OasInteger({
+ *   title: 'HTTP Status Code',
+ *   description: 'Valid HTTP response status codes',
+ *   enums: [200, 201, 400, 401, 404, 500],
+ *   example: 200
+ * });
+ * ```
+ *
+ * @example Nullable integer
+ * ```typescript
+ * const optionalCountInteger = new OasInteger<true>({
+ *   title: 'Optional Count',
+ *   description: 'Count value that can be null',
+ *   nullable: true,
+ *   minimum: 0,
+ *   default: null
+ * });
+ * ```
+ */
 class OasInteger {
     constructor(fields = {}) {
         /**