@skmtc/core 0.0.803 → 0.0.805

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;;;;;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"}
+{"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;;;;;GAKG;AACH,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;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF;;;;;GAKG;AACH,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;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF;;;;;GAKG;AACH,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;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}

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

@@ -66,6 +66,9 @@ exports.oasParameterRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating example reference data.
+ */
 exports.oasExampleRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('example'),
@@ -73,6 +76,9 @@ exports.oasExampleRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating request body reference data.
+ */
 exports.oasRequestBodyRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('requestBody'),
@@ -80,6 +86,9 @@ exports.oasRequestBodyRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating header reference data.
+ */
 exports.oasHeaderRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('header'),
@@ -87,12 +96,21 @@ exports.oasHeaderRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown_types_js_1.markdown)
 });
+/**
+ * Valibot schema for validating security scheme reference data.
+ */
 exports.oasSecuritySchemeRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('securityScheme'),
     $ref: v.string()
 });
 // OasPathItemRefData
+/**
+ * Valibot schema for validating any OpenAPI reference data.
+ *
+ * Union schema that validates all supported reference types,
+ * ensuring type safety across the entire reference system.
+ */
 exports.oasRefData = v.union([
     exports.oasSchemaRefData,
     exports.oasResponseRefData,

package/script/oas/server/Server.d.ts

@@ -2,22 +2,94 @@ import "../../_dnt.polyfills.js";
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { OasServerVariable } from '../serverVariable/ServerVariable.js';
+/**
+ * Constructor fields for {@link OasServer}.
+ *
+ * Defines the configuration options available when creating server instances,
+ * including URL, description, variables, and extension fields.
+ */
 export type ServerFields = {
     description?: string | undefined;
     url: string;
     variables?: Record<string, OasServerVariable> | undefined;
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Server Object in the OpenAPI Specification.
+ *
+ * The `OasServer` class encapsulates server connectivity information, including
+ * the server URL, optional description, and variable definitions for URL templating.
+ * Servers are used to specify different environments (development, staging, production)
+ * or different API versions that clients can connect to.
+ *
+ * @example Basic server
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://api.example.com/v1',
+ *   description: 'Production API server'
+ * });
+ * ```
+ *
+ * @example Server with variables
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://{environment}.example.com/{version}',
+ *   description: 'Configurable API server',
+ *   variables: {
+ *     environment: new OasServerVariable({
+ *       enum: ['api', 'staging', 'dev'],
+ *       default: 'api',
+ *       description: 'API environment'
+ *     }),
+ *     version: new OasServerVariable({
+ *       default: 'v1',
+ *       description: 'API version'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasServer {
+    /** Type identifier for this OAS server */
     oasType: 'server';
+    /** Human-readable description of the server */
     description: string | undefined;
+    /** Server URL with optional variable templating */
     url: string;
+    /** Variable definitions for URL templating */
     variables: Record<string, OasServerVariable> | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasServer instance.
+     *
+     * @param fields - Server configuration including URL, description, and variables
+     */
     constructor(fields: ServerFields);
+    /**
+     * Determines if this server is a reference object.
+     *
+     * @returns Always false since servers are not reference objects in OpenAPI
+     */
     isRef(): boolean;
+    /**
+     * Resolves this server object.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolve(): OasServer;
+    /**
+     * Resolves this server object one level.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolveOnce(): OasServer;
+    /**
+     * Converts this OAS server to an OpenAPI v3 JSON schema representation.
+     *
+     * @param _options - Conversion options (currently unused for server objects)
+     * @returns OpenAPI v3 server object with URL, description, and variables
+     */
     toJsonSchema(_options: ToJsonSchemaOptions): OpenAPIV3.ServerObject;
 }
 //# sourceMappingURL=Server.d.ts.map

package/script/oas/server/Server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Server.d.ts","sourceRoot":"","sources":["../../../src/oas/server/Server.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAE5E,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,SAAS;IACpB,OAAO,EAAE,QAAQ,CAAW;IAC5B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,YAAY;IAOhC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;IAIxB,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CAOpE"}
+{"version":3,"file":"Server.d.ts","sourceRoot":"","sources":["../../../src/oas/server/Server.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,SAAS;IACpB,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAW;IAC5B,+CAA+C;IAC/C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAA;IACX,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACxD,+CAA+C;IAC/C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;;;OAIG;gBACS,MAAM,EAAE,YAAY;IAOhC;;;;OAIG;IACH,KAAK,IAAI,OAAO;IAIhB;;;;OAIG;IACH,OAAO,IAAI,SAAS;IAIpB;;;;OAIG;IACH,WAAW,IAAI,SAAS;IAIxB;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CAOpE"}

package/script/oas/server/Server.js

@@ -2,32 +2,77 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasServer = void 0;
 require("../../_dnt.polyfills.js");
+/**
+ * Represents a Server Object in the OpenAPI Specification.
+ *
+ * The `OasServer` class encapsulates server connectivity information, including
+ * the server URL, optional description, and variable definitions for URL templating.
+ * Servers are used to specify different environments (development, staging, production)
+ * or different API versions that clients can connect to.
+ *
+ * @example Basic server
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://api.example.com/v1',
+ *   description: 'Production API server'
+ * });
+ * ```
+ *
+ * @example Server with variables
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://{environment}.example.com/{version}',
+ *   description: 'Configurable API server',
+ *   variables: {
+ *     environment: new OasServerVariable({
+ *       enum: ['api', 'staging', 'dev'],
+ *       default: 'api',
+ *       description: 'API environment'
+ *     }),
+ *     version: new OasServerVariable({
+ *       default: 'v1',
+ *       description: 'API version'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 class OasServer {
+    /**
+     * Creates a new OasServer instance.
+     *
+     * @param fields - Server configuration including URL, description, and variables
+     */
     constructor(fields) {
+        /** Type identifier for this OAS server */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'server'
         });
+        /** Human-readable description of the server */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Server URL with optional variable templating */
         Object.defineProperty(this, "url", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Variable definitions for URL templating */
         Object.defineProperty(this, "variables", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,
@@ -39,15 +84,36 @@ class OasServer {
         this.variables = fields.variables;
         this.extensionFields = fields.extensionFields;
     }
+    /**
+     * Determines if this server is a reference object.
+     *
+     * @returns Always false since servers are not reference objects in OpenAPI
+     */
     isRef() {
         return false;
     }
+    /**
+     * Resolves this server object.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolve() {
         return this;
     }
+    /**
+     * Resolves this server object one level.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolveOnce() {
         return this;
     }
+    /**
+     * Converts this OAS server to an OpenAPI v3 JSON schema representation.
+     *
+     * @param _options - Conversion options (currently unused for server objects)
+     * @returns OpenAPI v3 server object with URL, description, and variables
+     */
     toJsonSchema(_options) {
         return {
             description: this.description,

package/script/types/Brand.d.ts

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

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

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

package/script/types/Brand.js

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