@skmtc/core 0.0.984 → 0.16.2

package/script/dsl/ContentBase.d.ts

@@ -1,131 +0,0 @@
-import type { GenerateContextType } from '../context/generateTypes.js';
-import type { RegisterArgs } from '../context/generateTypes.js';
-import type { GeneratorKey } from './GeneratorKeys.js';
-/**
- * Constructor arguments for {@link ContentBase}.
- */
-type ContentBaseArgs = {
-    /** The generation context providing OAS objects and utilities */
-    context: GenerateContextType;
-    /** Optional generator key for tracking and identification */
-    generatorKey?: GeneratorKey;
-};
-/**
- * Base class for all content generators in the SKMTC DSL system.
- *
- * `ContentBase` provides the foundation for creating custom generators that transform
- * OpenAPI Schema (OAS) objects into code artifacts. It handles registration with the
- * generation context, skipping logic, and provides access to the pipeline's utilities.
- *
- * ## Generator Lifecycle
- *
- * 1. **Construction**: Initialize with context and optional generator key
- * 2. **Registration**: Call {@link register} to add artifacts to the pipeline
- * 3. **Generation**: Implement custom logic using context utilities
- * 4. **Rendering**: Artifacts are automatically rendered by the pipeline
- *
- * @example Basic generator
- * ```typescript
- * import { ContentBase } from '@skmtc/core';
- *
- * class MyModelGenerator extends ContentBase {
- *   generate() {
- *     // Skip if not needed
- *     if (this.shouldSkip()) return;
- *
- *     // Access OAS objects through context
- *     const schemas = this.context.oasDocument.components.schemas;
- *
- *     for (const [name, schema] of Object.entries(schemas)) {
- *       if (schema.isRef()) continue;
- *
- *       const file = new File({
- *         context: this.context,
- *         path: `./models/${name}.ts`,
- *         content: this.generateModelContent(schema)
- *       });
- *
- *       // Register the file for rendering
- *       this.register({ file });
- *     }
- *   }
- *
- *   private generateModelContent(schema: OasObject): string {
- *     // Custom model generation logic
- *     return `export interface ${schema.name} { ... }`;
- *   }
- * }
- * ```
- *
- * @example Generator with skipping logic
- * ```typescript
- * class ConditionalGenerator extends ContentBase {
- *   generate() {
- *     // Check if generation should be skipped
- *     if (this.shouldSkipBasedOnSettings()) {
- *       this.skip('Disabled in settings');
- *       return;
- *     }
- *
- *     // Continue with generation...
- *     const file = this.createOutputFile();
- *     this.register({ file });
- *   }
- *
- *   private shouldSkipBasedOnSettings(): boolean {
- *     return this.context.settings?.skip?.models?.includes('MyModel') ?? false;
- *   }
- * }
- * ```
- */
-export declare class ContentBase {
-    /** The generation context providing access to OAS objects and utilities */
-    context: GenerateContextType;
-    /** Whether this generator has been skipped */
-    skipped: boolean;
-    /** Optional generator key for identification and tracking */
-    generatorKey: GeneratorKey | undefined;
-    /**
-     * Creates a new ContentBase instance.
-     *
-     * @param args - Construction arguments
-     * @param args.context - The generation context
-     * @param args.generatorKey - Optional generator key
-     */
-    constructor({ context, generatorKey }: ContentBaseArgs);
-    /**
-     * Registers generated artifacts with the rendering pipeline.
-     *
-     * This method is called by generator implementations to add files,
-     * JSON artifacts, or other content to the generation output.
-     *
-     * @param args - The artifacts to register
-     * @param args.file - Optional file to register
-     * @param args.jsonFile - Optional JSON file to register
-     *
-     * @example Registering a file
-     * ```typescript
-     * const file = new File({
-     *   context: this.context,
-     *   path: './output.ts',
-     *   content: 'export const value = 42;'
-     * });
-     *
-     * this.register({ file });
-     * ```
-     *
-     * @example Registering JSON data
-     * ```typescript
-     * const jsonFile = new JsonFile({
-     *   context: this.context,
-     *   path: './config.json',
-     *   data: { version: '1.0.0', features: ['api'] }
-     * });
-     *
-     * this.register({ jsonFile });
-     * ```
-     */
-    register(args: RegisterArgs): void;
-}
-export {};
-//# sourceMappingURL=ContentBase.d.ts.map

package/script/dsl/ContentBase.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ContentBase.d.ts","sourceRoot":"","sources":["../../src/dsl/ContentBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD;;GAEG;AACH,KAAK,eAAe,GAAG;IACrB,iEAAiE;IACjE,OAAO,EAAE,mBAAmB,CAAA;IAC5B,6DAA6D;IAC7D,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,qBAAa,WAAW;IACtB,2EAA2E;IAC3E,OAAO,EAAE,mBAAmB,CAAA;IAE5B,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAQ;IAExB,6DAA6D;IAC7D,YAAY,EAAE,YAAY,GAAG,SAAS,CAAA;IAEtC;;;;;;OAMG;gBACS,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,eAAe;IAKtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;CAGnC"}

package/script/dsl/ContentBase.js

@@ -1,141 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentBase = void 0;
-/**
- * Base class for all content generators in the SKMTC DSL system.
- *
- * `ContentBase` provides the foundation for creating custom generators that transform
- * OpenAPI Schema (OAS) objects into code artifacts. It handles registration with the
- * generation context, skipping logic, and provides access to the pipeline's utilities.
- *
- * ## Generator Lifecycle
- *
- * 1. **Construction**: Initialize with context and optional generator key
- * 2. **Registration**: Call {@link register} to add artifacts to the pipeline
- * 3. **Generation**: Implement custom logic using context utilities
- * 4. **Rendering**: Artifacts are automatically rendered by the pipeline
- *
- * @example Basic generator
- * ```typescript
- * import { ContentBase } from '@skmtc/core';
- *
- * class MyModelGenerator extends ContentBase {
- *   generate() {
- *     // Skip if not needed
- *     if (this.shouldSkip()) return;
- *
- *     // Access OAS objects through context
- *     const schemas = this.context.oasDocument.components.schemas;
- *
- *     for (const [name, schema] of Object.entries(schemas)) {
- *       if (schema.isRef()) continue;
- *
- *       const file = new File({
- *         context: this.context,
- *         path: `./models/${name}.ts`,
- *         content: this.generateModelContent(schema)
- *       });
- *
- *       // Register the file for rendering
- *       this.register({ file });
- *     }
- *   }
- *
- *   private generateModelContent(schema: OasObject): string {
- *     // Custom model generation logic
- *     return `export interface ${schema.name} { ... }`;
- *   }
- * }
- * ```
- *
- * @example Generator with skipping logic
- * ```typescript
- * class ConditionalGenerator extends ContentBase {
- *   generate() {
- *     // Check if generation should be skipped
- *     if (this.shouldSkipBasedOnSettings()) {
- *       this.skip('Disabled in settings');
- *       return;
- *     }
- *
- *     // Continue with generation...
- *     const file = this.createOutputFile();
- *     this.register({ file });
- *   }
- *
- *   private shouldSkipBasedOnSettings(): boolean {
- *     return this.context.settings?.skip?.models?.includes('MyModel') ?? false;
- *   }
- * }
- * ```
- */
-class ContentBase {
-    /**
-     * Creates a new ContentBase instance.
-     *
-     * @param args - Construction arguments
-     * @param args.context - The generation context
-     * @param args.generatorKey - Optional generator key
-     */
-    constructor({ context, generatorKey }) {
-        /** The generation context providing access to OAS objects and utilities */
-        Object.defineProperty(this, "context", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** Whether this generator has been skipped */
-        Object.defineProperty(this, "skipped", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        /** Optional generator key for identification and tracking */
-        Object.defineProperty(this, "generatorKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.context = context;
-        this.generatorKey = generatorKey;
-    }
-    /**
-     * Registers generated artifacts with the rendering pipeline.
-     *
-     * This method is called by generator implementations to add files,
-     * JSON artifacts, or other content to the generation output.
-     *
-     * @param args - The artifacts to register
-     * @param args.file - Optional file to register
-     * @param args.jsonFile - Optional JSON file to register
-     *
-     * @example Registering a file
-     * ```typescript
-     * const file = new File({
-     *   context: this.context,
-     *   path: './output.ts',
-     *   content: 'export const value = 42;'
-     * });
-     *
-     * this.register({ file });
-     * ```
-     *
-     * @example Registering JSON data
-     * ```typescript
-     * const jsonFile = new JsonFile({
-     *   context: this.context,
-     *   path: './config.json',
-     *   data: { version: '1.0.0', features: ['api'] }
-     * });
-     *
-     * this.register({ jsonFile });
-     * ```
-     */
-    register(args) {
-        this.context.register(args);
-    }
-}
-exports.ContentBase = ContentBase;

package/script/dsl/EntityType.d.ts

@@ -1,89 +0,0 @@
-/**
- * Represents the type of a TypeScript entity for code generation.
- *
- * `EntityType` encapsulates the distinction between different kinds of
- * TypeScript entities, specifically variables (which become `const` declarations)
- * and types (which become `type` or `interface` declarations).
- *
- * This class is used by the {@link Identifier} system to ensure that
- * generated code uses the correct TypeScript keywords and syntax patterns.
- *
- * @example Variable entity type
- * ```typescript
- * import { EntityType } from '@skmtc/core';
- *
- * const variableEntity = new EntityType('variable');
- * console.log(variableEntity.toString()); // 'const'
- *
- * // Used in code generation:
- * // const API_URL = 'https://api.example.com';
- * ```
- *
- * @example Type entity type
- * ```typescript
- * const typeEntity = new EntityType('type');
- * console.log(typeEntity.toString()); // 'type'
- *
- * // Used in code generation:
- * // type User = { id: string; name: string; };
- * ```
- *
- * @example Integration with Identifier
- * ```typescript
- * import { Identifier, EntityType } from '@skmtc/core';
- *
- * // Create a variable identifier (uses 'const' keyword)
- * const varId = Identifier.createVariable('API_KEY', 'string');
- * console.log(varId.entityType.toString()); // 'const'
- *
- * // Create a type identifier (uses 'type' keyword)
- * const typeId = Identifier.createType('UserStatus');
- * console.log(typeId.entityType.toString()); // 'type'
- * ```
- */
-export declare class EntityType {
-    /** The entity type discriminator */
-    type: 'variable' | 'type';
-    /**
-     * Creates a new EntityType instance.
-     *
-     * @param type - The type of entity ('variable' for const declarations, 'type' for type declarations)
-     *
-     * @example
-     * ```typescript
-     * // For generating const declarations
-     * const constEntity = new EntityType('variable');
-     *
-     * // For generating type declarations
-     * const typeEntity = new EntityType('type');
-     * ```
-     */
-    constructor(type: 'variable' | 'type');
-    /**
-     * Returns the appropriate TypeScript keyword for this entity type.
-     *
-     * This method maps the entity type to the correct TypeScript declaration
-     * keyword that should be used in generated code:
-     * - 'variable' entities become 'const' declarations
-     * - 'type' entities become 'type' declarations
-     *
-     * @returns The TypeScript keyword string ('const' or 'type')
-     *
-     * @example
-     * ```typescript
-     * const varEntity = new EntityType('variable');
-     * console.log(varEntity.toString()); // 'const'
-     *
-     * const typeEntity = new EntityType('type');
-     * console.log(typeEntity.toString()); // 'type'
-     *
-     * // Used in code generation:
-     * const keyword = entityType.toString();
-     * const declaration = `${keyword} ${identifier} = ${value};`;
-     * // Results in: "const API_URL = 'https://example.com';" or
-     * // Results in: "type Status = 'active' | 'inactive';"
-     * ```
-     */
-    toString(): string;
-}
-//# sourceMappingURL=EntityType.d.ts.map

package/script/dsl/EntityType.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EntityType.d.ts","sourceRoot":"","sources":["../../src/dsl/EntityType.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,UAAU;IACrB,oCAAoC;IACpC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAA;IAEzB;;;;;;;;;;;;;OAaG;gBACS,IAAI,EAAE,UAAU,GAAG,MAAM;IAIrC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,IAAI,MAAM;CAYnB"}

package/script/dsl/EntityType.js

@@ -1,110 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityType = void 0;
-/**
- * Represents the type of a TypeScript entity for code generation.
- *
- * `EntityType` encapsulates the distinction between different kinds of
- * TypeScript entities, specifically variables (which become `const` declarations)
- * and types (which become `type` or `interface` declarations).
- *
- * This class is used by the {@link Identifier} system to ensure that
- * generated code uses the correct TypeScript keywords and syntax patterns.
- *
- * @example Variable entity type
- * ```typescript
- * import { EntityType } from '@skmtc/core';
- *
- * const variableEntity = new EntityType('variable');
- * console.log(variableEntity.toString()); // 'const'
- *
- * // Used in code generation:
- * // const API_URL = 'https://api.example.com';
- * ```
- *
- * @example Type entity type
- * ```typescript
- * const typeEntity = new EntityType('type');
- * console.log(typeEntity.toString()); // 'type'
- *
- * // Used in code generation:
- * // type User = { id: string; name: string; };
- * ```
- *
- * @example Integration with Identifier
- * ```typescript
- * import { Identifier, EntityType } from '@skmtc/core';
- *
- * // Create a variable identifier (uses 'const' keyword)
- * const varId = Identifier.createVariable('API_KEY', 'string');
- * console.log(varId.entityType.toString()); // 'const'
- *
- * // Create a type identifier (uses 'type' keyword)
- * const typeId = Identifier.createType('UserStatus');
- * console.log(typeId.entityType.toString()); // 'type'
- * ```
- */
-class EntityType {
-    /**
-     * Creates a new EntityType instance.
-     *
-     * @param type - The type of entity ('variable' for const declarations, 'type' for type declarations)
-     *
-     * @example
-     * ```typescript
-     * // For generating const declarations
-     * const constEntity = new EntityType('variable');
-     *
-     * // For generating type declarations
-     * const typeEntity = new EntityType('type');
-     * ```
-     */
-    constructor(type) {
-        /** The entity type discriminator */
-        Object.defineProperty(this, "type", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.type = type;
-    }
-    /**
-     * Returns the appropriate TypeScript keyword for this entity type.
-     *
-     * This method maps the entity type to the correct TypeScript declaration
-     * keyword that should be used in generated code:
-     * - 'variable' entities become 'const' declarations
-     * - 'type' entities become 'type' declarations
-     *
-     * @returns The TypeScript keyword string ('const' or 'type')
-     *
-     * @example
-     * ```typescript
-     * const varEntity = new EntityType('variable');
-     * console.log(varEntity.toString()); // 'const'
-     *
-     * const typeEntity = new EntityType('type');
-     * console.log(typeEntity.toString()); // 'type'
-     *
-     * // Used in code generation:
-     * const keyword = entityType.toString();
-     * const declaration = `${keyword} ${identifier} = ${value};`;
-     * // Results in: "const API_URL = 'https://example.com';" or
-     * // Results in: "type Status = 'active' | 'inactive';"
-     * ```
-     */
-    toString() {
-        switch (this.type) {
-            case 'variable':
-                return 'const';
-            case 'type':
-                return 'type';
-            default: {
-                const _exhaustive = this.type;
-                throw new Error(`Unhandled entity type: ${_exhaustive}`);
-            }
-        }
-    }
-}
-exports.EntityType = EntityType;