speckeeper 0.7.1 → 0.8.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-import { S as SpecEntry } from './model-BPZMYasZ.js';
-export { C as CheckResult, a as CoverageChecker, b as CoverageResult, E as Exporter, c as ExternalChecker, L as LintResult, d as LintRule, M as MergedDesign, e as Model, f as ModelLevel, R as RELATION_CONSTRAINTS, g as RELATION_TYPES, h as Relation, i as RelationSchema, j as RelationValidationError, k as RelationsFieldSchema, l as RenderContext, m as Renderer, n as SpecModule, o as buildRegistryFromConfig, p as defineSpecs, q as detectCycles, r as findModelTypeFromConfig, s as getLevelIndex, t as getSpecsFromConfig, u as inferModelIdFromSpecId, v as mergeSpecs, w as validateRelationLevel } from './model-BPZMYasZ.js';
+import { C as CheckContext, a as CheckResult, E as ExportContext, M as ModelDefinition, b as MetaModelRegistry, L as LintContext, c as LintRule, d as LintIssue, S as SpecEntry } from './config-api-Bh0zX8W7.js';
+export { A as ArtifactConfig, B as BaseModelInstance, e as CheckError, f as CheckErrorSchema, g as CheckResult, h as CheckResultSchema, i as CheckWarning, j as CheckWarningSchema, k as CoverageChecker, l as CoverageResult, m as Exporter, n as ExternalChecker, I as InferModelType, J as JsonSchemaExporter, o as LintIssueSchema, p as LintResult, q as LintRule, r as MarkdownExporter, s as MergedDesign, t as MermaidExporter, u as MetaModelConfig, v as Model, w as ModelDefinitionInput, x as ModelLevel, R as RELATION_CONSTRAINTS, y as RELATION_TYPES, z as ReferenceDefinition, D as ReferenceDefinitionSchema, F as Relation, G as RelationSchema, H as RelationValidationError, K as RelationsFieldSchema, N as RenderContext, O as Renderer, P as ResolvedSpeckeeperConfig, Q as SpecModule, T as SpeckeeperConfigInput, U as buildRegistryFromConfig, V as createLintRule, W as createMarkdownExporter, X as createMermaidExporter, Y as defineConfig, Z as defineModel, _ as defineSpecs, $ as detectCycles, a0 as findModelTypeFromConfig, a1 as getLevelIndex, a2 as getSpecsFromConfig, a3 as inferModelIdFromSpecId, a4 as loadSpeckeeperConfig, a5 as mergeSpecs, a6 as validateRelationLevel } from './config-api-Bh0zX8W7.js';
 
 declare const PhaseSchema: z.ZodEnum<["REQ", "HLD", "LLD", "IMPL", "OPS", "CI"]>;
 type Phase = z.infer<typeof PhaseSchema>;
@@ -150,333 +150,6 @@ interface ModelRegistrySchema {
     terms: Map<TermId, unknown>;
 }
 
-/**
- * Export Context
- * Context information passed to exporter functions
- */
-interface ExportContext {
-    /** Access to all models (MetaModelRegistry type, using unknown to avoid circular references) */
-    registry: unknown;
-    /** Configuration (SpeckeeperConfig type, using unknown to avoid circular references) */
-    config: unknown;
-    /** Output base directory */
-    outputDir: string;
-    /** Current date/time */
-    generatedAt: Date;
-}
-/**
- * Lint Context
- * Context information passed to lint functions
- */
-interface LintContext {
-    /** Access to all models (MetaModelRegistry type) */
-    registry: unknown;
-    /** Current phase */
-    phase?: 'REQ' | 'HLD' | 'LLD' | 'OPS';
-    /** Strict mode */
-    strict?: boolean;
-}
-/**
- * Check Context
- * Context information passed to external SSOT check functions
- */
-interface CheckContext {
-    /** Access to all models (MetaModelRegistry type) */
-    registry: unknown;
-    /** External SSOT file path */
-    sourcePath: string;
-    /** Configuration (SpeckeeperConfig type) */
-    config: unknown;
-}
-/**
- * Lint Issue
- */
-interface LintIssue {
-    /** Issue message */
-    message: string;
-    /** Problematic field (optional) */
-    field?: string;
-    /** Fix suggestion (optional) */
-    suggestion?: string;
-}
-/**
- * Check Result
- */
-interface CheckResult {
-    /** Whether successful */
-    success: boolean;
-    /** List of error messages */
-    errors: CheckError[];
-    /** List of warning messages */
-    warnings: CheckWarning[];
-}
-interface CheckError {
-    /** Error message */
-    message: string;
-    /** Target model ID */
-    modelId: string;
-    /** External SSOT reference */
-    externalRef?: string;
-}
-interface CheckWarning {
-    /** Warning message */
-    message: string;
-    /** Target model ID */
-    modelId: string;
-}
-/**
- * Markdown Exporter
- */
-interface MarkdownExporter<T> {
-    /** Single document generation */
-    single: (model: T, context: ExportContext) => string;
-    /** Index page generation (optional) */
-    index?: (models: T[], context: ExportContext) => string;
-    /** Output directory (relative path from docs/) */
-    outputDir: string;
-    /** Filename generation (default is model.id) */
-    filename?: (model: T) => string;
-}
-/**
- * Mermaid Diagram Exporter
- */
-interface MermaidExporter<T> {
-    /** Diagram type */
-    diagramType: 'flowchart' | 'sequenceDiagram' | 'erDiagram' | 'stateDiagram' | 'C4Context' | 'C4Container' | 'C4Component' | 'custom';
-    /** Diagram generation function */
-    generate: (models: T[], context: ExportContext) => string;
-    /** Output file path (relative path from docs/) */
-    outputPath: string;
-    /** Diagram title */
-    title?: string;
-}
-/**
- * JSON Schema Exporter Settings
- */
-interface JsonSchemaExporter {
-    /** Enabled */
-    enabled: boolean;
-    /** Output directory (relative path from specs/) */
-    outputDir: string;
-}
-/**
- * Lint Rule
- */
-interface LintRule<T> {
-    /** Rule ID */
-    id: string;
-    /** Rule description */
-    description: string;
-    /** Severity */
-    severity: 'error' | 'warning' | 'info';
-    /** Check function */
-    check: (model: T, context: LintContext) => LintIssue | null;
-}
-/**
- * External SSOT Checker
- */
-interface ExternalChecker<T> {
-    /** External SSOT type to check */
-    targetType: 'openapi' | 'ddl' | 'iac' | 'custom';
-    /** Execute check */
-    check: (model: T, externalSource: unknown, context: CheckContext) => CheckResult;
-    /** Get external SSOT file path (from model) */
-    getSourcePath?: (model: T) => string | undefined;
-}
-/**
- * Inter-model Reference Definition (for traceability)
- */
-interface ReferenceDefinition {
-    /** Field name with reference */
-    field: string;
-    /** Referenced model ID */
-    targetModel: string;
-    /** Whether reference is required */
-    required?: boolean;
-    /** Whether reference is array */
-    isArray?: boolean;
-}
-/**
- * Model Definition
- * Interface for users to define new entities
- */
-interface ModelDefinition<T extends z.ZodTypeAny = z.ZodTypeAny> {
-    /** Model unique identifier (kebab-case recommended) */
-    id: string;
-    /** Model name (PascalCase recommended) */
-    name: string;
-    /** Model description */
-    description: string;
-    /** Zod Schema */
-    schema: T;
-    /** ID prefix for generation */
-    idPrefix: string;
-    /** Exporter settings */
-    exporters?: {
-        /** Markdown exporter */
-        markdown?: MarkdownExporter<z.infer<T>>;
-        /** Mermaid diagram exporter (multiple allowed) */
-        mermaid?: MermaidExporter<z.infer<T>> | MermaidExporter<z.infer<T>>[];
-        /** JSON Schema exporter */
-        jsonSchema?: JsonSchemaExporter;
-    };
-    /** Lint rules */
-    lintRules?: LintRule<z.infer<T>>[];
-    /** External SSOT checker */
-    externalChecker?: ExternalChecker<z.infer<T>>;
-    /** Reference definitions (for traceability) */
-    references?: ReferenceDefinition[];
-    /** DSL function name (the Xxx part of defineXxx) */
-    dslName?: string;
-    /** Phase (the phase where this model is primarily used) */
-    phase?: 'REQ' | 'HLD' | 'LLD' | 'OPS';
-}
-/**
- * Meta Model Registry
- * Manages registered model definitions and model instances
- */
-interface MetaModelRegistry {
-    /** Registered model definitions */
-    definitions: Map<string, ModelDefinition>;
-    /** Model instances (Map<instanceId, instance> for each model ID) */
-    instances: Map<string, Map<string, unknown>>;
-}
-/**
- * Additional settings for meta model
- */
-interface MetaModelConfig {
-    /** Custom model definitions */
-    models?: ModelDefinition[];
-    /** External SSOT settings */
-    externalSsot?: {
-        openapi?: {
-            enabled: boolean;
-            paths: string[];
-        };
-        ddl?: {
-            enabled: boolean;
-            type: 'ddl' | 'prisma' | 'typeorm' | 'drizzle';
-            path: string;
-        };
-        iac?: {
-            enabled: boolean;
-            type: 'cloudformation' | 'cdk' | 'terraform';
-            path: string;
-        };
-    };
-}
-/**
- * Base type for model instances
- * All model instances have an id
- */
-interface BaseModelInstance {
-    id: string;
-}
-/**
- * Helper type for creating type-safe model definitions
- */
-type InferModelType<T extends ModelDefinition> = z.infer<T['schema']>;
-declare const ReferenceDefinitionSchema: z.ZodObject<{
-    field: z.ZodString;
-    targetModel: z.ZodString;
-    required: z.ZodOptional<z.ZodBoolean>;
-    isArray: z.ZodOptional<z.ZodBoolean>;
-}, "strip", z.ZodTypeAny, {
-    field: string;
-    targetModel: string;
-    required?: boolean | undefined;
-    isArray?: boolean | undefined;
-}, {
-    field: string;
-    targetModel: string;
-    required?: boolean | undefined;
-    isArray?: boolean | undefined;
-}>;
-declare const LintIssueSchema: z.ZodObject<{
-    message: z.ZodString;
-    field: z.ZodOptional<z.ZodString>;
-    suggestion: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    field?: string | undefined;
-    suggestion?: string | undefined;
-}, {
-    message: string;
-    field?: string | undefined;
-    suggestion?: string | undefined;
-}>;
-declare const CheckErrorSchema: z.ZodObject<{
-    message: z.ZodString;
-    modelId: z.ZodString;
-    externalRef: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    modelId: string;
-    externalRef?: string | undefined;
-}, {
-    message: string;
-    modelId: string;
-    externalRef?: string | undefined;
-}>;
-declare const CheckWarningSchema: z.ZodObject<{
-    message: z.ZodString;
-    modelId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    modelId: string;
-}, {
-    message: string;
-    modelId: string;
-}>;
-declare const CheckResultSchema: z.ZodObject<{
-    success: z.ZodBoolean;
-    errors: z.ZodArray<z.ZodObject<{
-        message: z.ZodString;
-        modelId: z.ZodString;
-        externalRef: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        modelId: string;
-        externalRef?: string | undefined;
-    }, {
-        message: string;
-        modelId: string;
-        externalRef?: string | undefined;
-    }>, "many">;
-    warnings: z.ZodArray<z.ZodObject<{
-        message: z.ZodString;
-        modelId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        modelId: string;
-    }, {
-        message: string;
-        modelId: string;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    success: boolean;
-    errors: {
-        message: string;
-        modelId: string;
-        externalRef?: string | undefined;
-    }[];
-    warnings: {
-        message: string;
-        modelId: string;
-    }[];
-}, {
-    success: boolean;
-    errors: {
-        message: string;
-        modelId: string;
-        externalRef?: string | undefined;
-    }[];
-    warnings: {
-        message: string;
-        modelId: string;
-    }[];
-}>;
-
 /**
  * Register model definition
  */
@@ -594,180 +267,6 @@ declare function getModelRegistryStats(): {
     totalInstances: number;
 };
 
-/**
- * speckeeper configuration type
- */
-interface SpeckeeperConfigInput {
-    /** Project name */
-    projectName?: string;
-    /** Project version */
-    version?: string;
-    /** Design files directory */
-    designDir?: string;
-    /** Docs output directory */
-    docsDir?: string;
-    /** Specs output directory */
-    specsDir?: string;
-    /** Custom model definitions (Model instances or ModelDefinition objects) */
-    models?: any[];
-    /** Spec data entries from design/index.ts via mergeSpecs() */
-    specs?: SpecEntry[];
-    /** External SSOT configuration */
-    externalSsot?: {
-        openapi?: {
-            enabled: boolean;
-            paths: string[];
-        };
-        ddl?: {
-            enabled: boolean;
-            type: 'ddl' | 'prisma' | 'typeorm' | 'drizzle';
-            path: string;
-        };
-        iac?: {
-            enabled: boolean;
-            type: 'cloudformation' | 'cdk' | 'terraform';
-            path: string;
-        };
-    };
-    /** External SSOT file paths — maps node IDs to file paths/globs */
-    externalPaths?: Record<string, string>;
-    /** Lint configuration */
-    lint?: {
-        /** Strict mode */
-        strict?: boolean;
-        /** Disable specific rules */
-        disabledRules?: string[];
-    };
-}
-/**
- * Resolved speckeeper configuration
- */
-interface ResolvedSpeckeeperConfig extends SpeckeeperConfigInput {
-    designDir: string;
-    docsDir: string;
-    specsDir: string;
-}
-/**
- * Define speckeeper configuration
- *
- * @example
- * ```typescript
- * // speckeeper.config.ts
- * import { defineConfig, defineModel } from 'speckeeper';
- *
- * export default defineConfig({
- *   projectName: 'My Project',
- *   models: [
- *     // Custom model definitions
- *   ],
- * });
- * ```
- */
-declare function defineConfig(input: SpeckeeperConfigInput): ResolvedSpeckeeperConfig;
-/**
- * Model definition input type
- */
-interface ModelDefinitionInput<T extends z.ZodTypeAny> {
-    /** Unique identifier for the model (kebab-case recommended) */
-    id: string;
-    /** Model name (PascalCase recommended) */
-    name: string;
-    /** Model description */
-    description: string;
-    /** Zod schema */
-    schema: T;
-    /** Prefix for ID generation */
-    idPrefix: string;
-    /** Exporter configuration */
-    exporters?: {
-        markdown?: MarkdownExporter<z.infer<T>>;
-        mermaid?: MermaidExporter<z.infer<T>> | MermaidExporter<z.infer<T>>[];
-        jsonSchema?: JsonSchemaExporter;
-    };
-    /** Lint rules */
-    lintRules?: LintRule<z.infer<T>>[];
-    /** External SSOT checker */
-    externalChecker?: ExternalChecker<z.infer<T>>;
-    /** Reference definitions */
-    references?: ReferenceDefinition[];
-    /** DSL function name */
-    dslName?: string;
-    /** Phase */
-    phase?: 'REQ' | 'HLD' | 'LLD' | 'OPS';
-}
-/**
- * Create a custom model definition
- *
- * @example
- * ```typescript
- * const RetryPolicyModel = defineModel({
- *   id: 'retry-policy',
- *   name: 'RetryPolicy',
- *   description: 'Retry policy definition',
- *   schema: z.object({
- *     id: z.string(),
- *     name: z.string(),
- *     maxAttempts: z.number().min(1),
- *     initialDelay: z.number().min(0),
- *     backoffMultiplier: z.number().min(1),
- *   }),
- *   idPrefix: 'RETRY',
- *   exporters: {
- *     markdown: {
- *       single: (m) => `# ${m.name}\n\n- Max Attempts: ${m.maxAttempts}`,
- *       outputDir: 'docs/retry-policies',
- *     },
- *   },
- *   lintRules: [
- *     {
- *       id: 'retry-max-limit',
- *       description: 'maxAttempts should not exceed 10',
- *       severity: 'warning',
- *       check: (m) => m.maxAttempts > 10
- *         ? { message: `maxAttempts ${m.maxAttempts} exceeds recommended limit` }
- *         : null,
- *     },
- *   ],
- * });
- * ```
- */
-declare function defineModel<T extends z.ZodTypeAny>(input: ModelDefinitionInput<T>): ModelDefinition<T>;
-/**
- * Helper to create Markdown exporter
- */
-declare function createMarkdownExporter<T>(config: {
-    outputDir: string;
-    single: (model: T, context: unknown) => string;
-    index?: (models: T[], context: unknown) => string;
-    filename?: (model: T) => string;
-}): MarkdownExporter<T>;
-/**
- * Helper to create Mermaid diagram exporter
- */
-declare function createMermaidExporter<T>(config: {
-    diagramType: MermaidExporter<T>['diagramType'];
-    outputPath: string;
-    generate: (models: T[], context: unknown) => string;
-    title?: string;
-}): MermaidExporter<T>;
-/**
- * Helper to create lint rule
- */
-declare function createLintRule<T>(config: {
-    id: string;
-    description: string;
-    severity: 'error' | 'warning' | 'info';
-    check: (model: T, context: unknown) => {
-        message: string;
-        field?: string;
-        suggestion?: string;
-    } | null;
-}): LintRule<T>;
-/**
- * Load speckeeper.config.ts file and register custom models
- */
-declare function loadSpeckeeperConfig(configPath?: string): Promise<ResolvedSpeckeeperConfig | null>;
-
 /**
  * Specification-compliant output path definitions
  *
@@ -913,4 +412,4 @@ declare function findDefinitionFiles(srcDir: string, subDir: string): Promise<st
 declare function generateDocsPath(baseDir: string, category: string, filename: string): string;
 declare function generateSpecsPath(baseDir: string, category: string, filename: string): string;
 
-export { type APIRefId, type ActorId, type BaseModelInstance, type BatchRefId, type BatchWriteResult, type BoundaryId, type CheckContext, type CheckError, CheckErrorSchema, CheckResultSchema, type CheckWarning, CheckWarningSchema, type ComponentId, type ConcretizationSlot, ConcretizationSlotSchema, type DTORequirementId, type DriftResult, type EntityId, type ErrorCaseId, type EventRequirementId, type ExportContext, type FormId, ID_PATTERNS, type IaCRefId, type InferModelType, type JsonSchemaExporter, type LayerId, type Link, LinkSchema, type LintContext, type LintIssue, LintIssueSchema, type MarkdownExporter, type MermaidExporter, type MetaModelConfig, type MetaModelRegistry, type ModelDefinition, type ModelDefinitionInput, type ModelRegistrySchema, type OutputPaths, type Phase, PhaseSchema, type Priority, PrioritySchema, type ProcessFlowId, type ReferenceDefinition, ReferenceDefinitionSchema, type RelationId, type RequirementId, type ResolvedSpeckeeperConfig, type RuleId, type ScreenId, type Severity, SpecEntry, type SpeckeeperConfig, type SpeckeeperConfigInput, type StateId, type TableRefId, type TermId, type TransitionId, type UIComponentId, type UseCaseId, type ValidationError, type ValidationResult, type WriteResult, batchWriteFiles, checkBatchDrift, checkExternalSsot, checkFileDrift, checkReferenceIntegrity, computeHash, createAPIRefId, createActorId, createBatchRefId, createBoundaryId, createComponentId, createDTORequirementId, createEntityId, createErrorCaseId, createEventRequirementId, createFormId, createIaCRefId, createLayerId, createLintRule, createMarkdownExporter, createMermaidExporter, createProcessFlowId, createRelationId, createRequirementId, createRuleId, createScreenId, createStateId, createTableRefId, createTermId, createTransitionId, createUIComponentId, createUseCaseId, defineConfig, defineModel, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllInstances, getAllModelDefinitions, getAllModelInstances, getExpectedOutputDirs, getGlobalModelRegistry, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, lintAllModels, lintModel, loadConfig, loadSpeckeeperConfig, registerModelDefinition, registerModelDefinitions, registerModelInstance, resetModelInstances, resetModelRegistry, resolveReference, validateConfig, validateOutputPaths, writeFile, writeJsonFile };
+export { type APIRefId, type ActorId, type BatchRefId, type BatchWriteResult, type BoundaryId, CheckContext, type ComponentId, type ConcretizationSlot, ConcretizationSlotSchema, type DTORequirementId, type DriftResult, type EntityId, type ErrorCaseId, type EventRequirementId, ExportContext, type FormId, ID_PATTERNS, type IaCRefId, type LayerId, type Link, LinkSchema, LintContext, LintIssue, MetaModelRegistry, ModelDefinition, type ModelRegistrySchema, type OutputPaths, type Phase, PhaseSchema, type Priority, PrioritySchema, type ProcessFlowId, type RelationId, type RequirementId, type RuleId, type ScreenId, type Severity, SpecEntry, type SpeckeeperConfig, type StateId, type TableRefId, type TermId, type TransitionId, type UIComponentId, type UseCaseId, type ValidationError, type ValidationResult, type WriteResult, batchWriteFiles, checkBatchDrift, checkExternalSsot, checkFileDrift, checkReferenceIntegrity, computeHash, createAPIRefId, createActorId, createBatchRefId, createBoundaryId, createComponentId, createDTORequirementId, createEntityId, createErrorCaseId, createEventRequirementId, createFormId, createIaCRefId, createLayerId, createProcessFlowId, createRelationId, createRequirementId, createRuleId, createScreenId, createStateId, createTableRefId, createTermId, createTransitionId, createUIComponentId, createUseCaseId, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllInstances, getAllModelDefinitions, getAllModelInstances, getExpectedOutputDirs, getGlobalModelRegistry, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, lintAllModels, lintModel, loadConfig, registerModelDefinition, registerModelDefinitions, registerModelInstance, resetModelInstances, resetModelRegistry, resolveReference, validateConfig, validateOutputPaths, writeFile, writeJsonFile };