speckeeper 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -879,6 +879,84 @@ declare function getAllModels(): Model<any>[];
  * Clear registry
  */
 declare function clearModelRegistry(): void;
+/**
+ * Register model instances from config.models array.
+ * Filters out non-Model values. Call this once after config is loaded.
+ */
+declare function registerModelsFromConfig(models: unknown[]): void;
+/**
+ * Get specs for a given model ID from specStore
+ */
+declare function getSpecs(modelId: string): unknown[];
+/**
+ * Get all spec IDs across all models
+ */
+declare function getAllSpecIds(): Set<string>;
+/**
+ * Find which model type a spec ID belongs to
+ */
+declare function findModelTypeBySpecId(specId: string): string | null;
+/**
+ * Get a spec by ID (searches all models)
+ */
+declare function getSpecById(specId: string): {
+    modelId: string;
+    spec: unknown;
+} | null;
+/**
+ * A single (Model, data[]) pair.
+ * Uses structural typing (not nominal Model<any>) so that
+ * compiled dist/ Model instances are compatible with src/ types.
+ */
+interface SpecEntry {
+    model: {
+        id: string;
+        register: (data: unknown[]) => void;
+    };
+    data: unknown[];
+}
+/**
+ * Common export interface for spec data files.
+ * Each spec file exports a SpecModule via defineSpecs().
+ */
+interface SpecModule {
+    entries: SpecEntry[];
+}
+/**
+ * Aggregated result from mergeSpecs().
+ */
+interface MergedDesign {
+    models: SpecEntry['model'][];
+    specs: SpecEntry[];
+}
+/**
+ * Define spec data in a spec file. Returns a SpecModule.
+ *
+ * @example
+ * ```typescript
+ * export default defineSpecs(
+ *   [FunctionalRequirementModel.instance, functionalRequirements],
+ *   [NonFunctionalRequirementModel.instance, nonFunctionalRequirements],
+ * );
+ * ```
+ */
+declare function defineSpecs(...entries: [SpecEntry['model'], unknown[]][]): SpecModule;
+/**
+ * Merge multiple SpecModules into a single MergedDesign.
+ * Models are deduplicated by model.id.
+ *
+ * @example
+ * ```typescript
+ * // design/index.ts
+ * export default mergeSpecs(requirements, usecases, glossary);
+ * ```
+ */
+declare function mergeSpecs(...modules: SpecModule[]): MergedDesign;
+/**
+ * Register spec data from config.specs into specStore.
+ * Call this after registerModelsFromConfig().
+ */
+declare function registerSpecsFromConfig(specs: SpecEntry[] | undefined): void;
 
 /**
  * Register model definition
@@ -997,13 +1075,6 @@ declare function getModelRegistryStats(): {
     totalInstances: number;
 };
 
-/**
- * Configuration API for speckeeper
- *
- * Provides `defineConfig` and `defineModel` functions for users to
- * create speckeeper.config.ts files with custom model definitions.
- */
-
 /**
  * speckeeper configuration type
  */
@@ -1020,6 +1091,8 @@ interface SpeckeeperConfigInput {
     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?: {
@@ -1258,6 +1331,7 @@ interface SpeckeeperConfig {
         mermaidCliPath?: string;
     };
     models?: unknown[];
+    specs?: SpecEntry[];
 }
 /**
  * Get output paths compliant with specification
@@ -1318,65 +1392,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;
 
-/**
- * Model Loader
- *
- * Load models and specs from design/ directory.
- * Spec registration is done explicitly via Model.register() in each spec file.
- */
-
-/**
- * Model registry - stores all loaded spec data.
- * Keys are model IDs (e.g. 'functional-requirement', 'usecase').
- * Values are Maps of spec ID -> spec data.
- */
-type ModelRegistry = Record<string, Map<string, unknown>>;
-/**
- * Dynamically import TS files from specified directory.
- * Model class instances found in exports are registered to core registry.
- * Spec data is registered via Model.register() side effects during import.
- */
-declare function loadModelsFromDirectory(dirPath: string, options?: {
-    recursive?: boolean;
-}): Promise<string[]>;
-/**
- * Load all models and specs based on configuration.
- *
- * 1. Reset spec store and model registry
- * 2. Register Model class instances from config.models
- * 3. Scan design/ files (triggers Model.register() calls as side effects)
- * 4. Build registry from specStore
- */
-declare function loadAllModels(config: SpeckeeperConfig, cwd?: string): Promise<{
-    registry: ModelRegistry;
-    loadedFiles: string[];
-    errors: Array<{
-        file: string;
-        error: unknown;
-    }>;
-}>;
-/**
- * Get specs from registry for a given model ID
- */
-declare function getSpecsFromRegistry(registry: ModelRegistry, modelId: string): unknown[];
-/**
- * Get registry statistics
- */
-declare function getRegistryStats(registry: ModelRegistry): Record<string, number>;
-/**
- * Get all IDs in registry
- */
-declare function getAllIds(registry: ModelRegistry): Set<string>;
-/**
- * Identify model type from ID
- */
-declare function findModelType(registry: ModelRegistry, id: string): string | null;
-/**
- * Get model by ID
- */
-declare function getModelById(registry: ModelRegistry, id: string): {
-    type: string;
-    model: unknown;
-} | null;
-
-export { type APIRefId, type ActorId, type BaseModelInstance, type BatchRefId, type BatchWriteResult, type BoundaryId, type CheckContext, type CheckError, CheckErrorSchema, type CheckResult, CheckResultSchema, type CheckWarning, CheckWarningSchema, type ComponentId, type ConcretizationSlot, ConcretizationSlotSchema, type CoverageChecker, type CoverageResult, type DTORequirementId, type DriftResult, type EntityId, type ErrorCaseId, type EventRequirementId, type ExportContext, type Exporter, type ExternalChecker, type FormId, ID_PATTERNS, type IaCRefId, type InferModelType, type JsonSchemaExporter, type LayerId, type Link, LinkSchema, type LintContext, type LintIssue, LintIssueSchema, type LintResult, type LintRule, type MarkdownExporter, type MermaidExporter, type MetaModelConfig, type MetaModelRegistry, Model, type ModelDefinition, type ModelDefinitionInput, type ModelLevel, type ModelRegistry, type ModelRegistrySchema, type OutputPaths, type Phase, PhaseSchema, type Priority, PrioritySchema, type ProcessFlowId, RELATION_CONSTRAINTS, RELATION_TYPES, type ReferenceDefinition, ReferenceDefinitionSchema, type Relation, type RelationId, RelationSchema, type RelationValidationError, RelationsFieldSchema, type RenderContext, type Renderer, type RequirementId, type ResolvedSpeckeeperConfig, type RuleId, type ScreenId, type Severity, 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, clearModelRegistry, 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, detectCycles, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findModelType, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllIds, getAllInstances, getAllModelDefinitions, getAllModelInstances, getAllModels, getExpectedOutputDirs, getGlobalModelRegistry, getLevelIndex, getModel, getModelById, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, getRegistryStats, getSpecStore, getSpecsFromRegistry, inferModelIdFromSpecId, lintAllModels, lintModel, loadAllModels, loadConfig, loadModelsFromDirectory, loadSpeckeeperConfig, registerModel, registerModelDefinition, registerModelDefinitions, registerModelInstance, resetModelInstances, resetModelRegistry, resetSpecStore, resolveReference, validateConfig, validateOutputPaths, validateRelationLevel, writeFile, writeJsonFile };
+export { type APIRefId, type ActorId, type BaseModelInstance, type BatchRefId, type BatchWriteResult, type BoundaryId, type CheckContext, type CheckError, CheckErrorSchema, type CheckResult, CheckResultSchema, type CheckWarning, CheckWarningSchema, type ComponentId, type ConcretizationSlot, ConcretizationSlotSchema, type CoverageChecker, type CoverageResult, type DTORequirementId, type DriftResult, type EntityId, type ErrorCaseId, type EventRequirementId, type ExportContext, type Exporter, type ExternalChecker, type FormId, ID_PATTERNS, type IaCRefId, type InferModelType, type JsonSchemaExporter, type LayerId, type Link, LinkSchema, type LintContext, type LintIssue, LintIssueSchema, type LintResult, type LintRule, type MarkdownExporter, type MergedDesign, type MermaidExporter, type MetaModelConfig, type MetaModelRegistry, Model, type ModelDefinition, type ModelDefinitionInput, type ModelLevel, type ModelRegistrySchema, type OutputPaths, type Phase, PhaseSchema, type Priority, PrioritySchema, type ProcessFlowId, RELATION_CONSTRAINTS, RELATION_TYPES, type ReferenceDefinition, ReferenceDefinitionSchema, type Relation, type RelationId, RelationSchema, type RelationValidationError, RelationsFieldSchema, type RenderContext, type Renderer, type RequirementId, type ResolvedSpeckeeperConfig, type RuleId, type ScreenId, type Severity, type SpecEntry, type SpecModule, 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, clearModelRegistry, 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, defineSpecs, detectCycles, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findModelTypeBySpecId, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllInstances, getAllModelDefinitions, getAllModelInstances, getAllModels, getAllSpecIds, getExpectedOutputDirs, getGlobalModelRegistry, getLevelIndex, getModel, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, getSpecById, getSpecStore, getSpecs, inferModelIdFromSpecId, lintAllModels, lintModel, loadConfig, loadSpeckeeperConfig, mergeSpecs, registerModel, registerModelDefinition, registerModelDefinitions, registerModelInstance, registerModelsFromConfig, registerSpecsFromConfig, resetModelInstances, resetModelRegistry, resetSpecStore, resolveReference, validateConfig, validateOutputPaths, validateRelationLevel, writeFile, writeJsonFile };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-import { existsSync, readFileSync, mkdirSync, writeFileSync, readdirSync, statSync } from 'fs';
-import { resolve, join, dirname, extname, basename } from 'path';
+import { existsSync, readFileSync, mkdirSync, writeFileSync } from 'fs';
+import { resolve, join, dirname } from 'path';
 import { parse } from 'yaml';
 import { createHash } from 'crypto';
 import { glob } from 'glob';
@@ -580,6 +580,63 @@ function getAllModels() {
 function clearModelRegistry() {
   modelRegistry.clear();
 }
+function registerModelsFromConfig(models) {
+  for (const model of models) {
+    if (model && typeof model === "object" && "id" in model && "schema" in model) {
+      registerModel(model);
+    }
+  }
+}
+function getSpecs(modelId) {
+  const map = specStore.get(modelId);
+  if (!map) return [];
+  return Array.from(map.values());
+}
+function getAllSpecIds() {
+  const ids = /* @__PURE__ */ new Set();
+  for (const map of specStore.values()) {
+    for (const id of map.keys()) {
+      ids.add(id);
+    }
+  }
+  return ids;
+}
+function findModelTypeBySpecId(specId) {
+  for (const [modelId, map] of specStore) {
+    if (map.has(specId)) return modelId;
+  }
+  return null;
+}
+function getSpecById(specId) {
+  const modelId = findModelTypeBySpecId(specId);
+  if (!modelId) return null;
+  return { modelId, spec: specStore.get(modelId).get(specId) };
+}
+function defineSpecs(...entries) {
+  return {
+    entries: entries.map(([model, data]) => ({ model, data }))
+  };
+}
+function mergeSpecs(...modules) {
+  const modelMap = /* @__PURE__ */ new Map();
+  const allSpecs = [];
+  for (const mod of modules) {
+    for (const entry of mod.entries) {
+      modelMap.set(entry.model.id, entry.model);
+      allSpecs.push(entry);
+    }
+  }
+  return {
+    models: Array.from(modelMap.values()),
+    specs: allSpecs
+  };
+}
+function registerSpecsFromConfig(specs) {
+  if (!specs) return;
+  for (const entry of specs) {
+    entry.model.register(entry.data);
+  }
+}
 
 // src/core/model-registry.ts
 var globalRegistry = {
@@ -1114,133 +1171,7 @@ function generateDocsPath(baseDir, category, filename) {
 function generateSpecsPath(baseDir, category, filename) {
   return join(baseDir, category, filename);
 }
-function isModelInstance(value) {
-  if (!value || typeof value !== "object") return false;
-  const obj = value;
-  return typeof obj.id === "string" && typeof obj.name === "string" && typeof obj.idPrefix === "string" && obj.schema !== void 0 && typeof obj.validate === "function" && typeof obj.lint === "function";
-}
-function registerExportedModelInstances(module) {
-  for (const [, exportValue] of Object.entries(module)) {
-    if (!exportValue || typeof exportValue !== "object") continue;
-    if (isModelInstance(exportValue)) {
-      registerModel(exportValue);
-    }
-  }
-}
-async function loadModelsFromDirectory(dirPath, options = {}) {
-  const loadedFiles = [];
-  if (!existsSync(dirPath)) {
-    return loadedFiles;
-  }
-  const entries = readdirSync(dirPath);
-  for (const entry of entries) {
-    const fullPath = join(dirPath, entry);
-    const stat = statSync(fullPath);
-    if (stat.isDirectory() && options.recursive) {
-      const subFiles = await loadModelsFromDirectory(fullPath, options);
-      loadedFiles.push(...subFiles);
-    } else if (stat.isFile()) {
-      const ext = extname(entry);
-      if ([".ts", ".js", ".mts", ".mjs"].includes(ext) && !entry.endsWith(".d.ts")) {
-        if (basename(entry, ext) === "index") {
-          continue;
-        }
-        try {
-          const module = await import(fullPath);
-          loadedFiles.push(fullPath);
-          registerExportedModelInstances(module);
-        } catch (error) {
-          console.error(`Failed to load from ${fullPath}:`, error);
-        }
-      }
-    }
-  }
-  return loadedFiles;
-}
-async function loadAllModels(config, cwd = process.cwd()) {
-  resetSpecStore();
-  clearModelRegistry();
-  const loadedFiles = [];
-  const errors = [];
-  if (config.models && Array.isArray(config.models)) {
-    for (const model of config.models) {
-      if (isModelInstance(model)) {
-        registerModel(model);
-      }
-    }
-  }
-  const designDir = resolve(cwd, config.designDir || "design");
-  const modelDirs = [
-    { path: join(designDir, "_models") },
-    { path: join(designDir, "requirements") },
-    { path: join(designDir, "usecases") },
-    { path: join(designDir, "architecture") },
-    { path: join(designDir, "data-model") },
-    { path: join(designDir, "screens") },
-    { path: join(designDir, "flows") },
-    { path: join(designDir, "glossary") },
-    { path: designDir }
-  ];
-  for (const { path: dirPath } of modelDirs) {
-    if (!existsSync(dirPath)) {
-      continue;
-    }
-    try {
-      const files = await loadModelsFromDirectory(dirPath, { recursive: true });
-      loadedFiles.push(...files);
-    } catch (error) {
-      errors.push({ file: dirPath, error });
-    }
-  }
-  const store = getSpecStore();
-  const registry = {};
-  for (const [modelId, specMap] of store) {
-    registry[modelId] = specMap;
-  }
-  return {
-    registry,
-    loadedFiles,
-    errors
-  };
-}
-function getSpecsFromRegistry(registry, modelId) {
-  const map = registry[modelId];
-  if (!map) return [];
-  return Array.from(map.values());
-}
-function getRegistryStats(registry) {
-  const stats = {};
-  for (const [key, map] of Object.entries(registry)) {
-    stats[key] = map.size;
-  }
-  return stats;
-}
-function getAllIds(registry) {
-  const allIds = /* @__PURE__ */ new Set();
-  for (const map of Object.values(registry)) {
-    for (const id of map.keys()) {
-      allIds.add(id);
-    }
-  }
-  return allIds;
-}
-function findModelType(registry, id) {
-  for (const [type, map] of Object.entries(registry)) {
-    if (map.has(id)) {
-      return type;
-    }
-  }
-  return null;
-}
-function getModelById(registry, id) {
-  const type = findModelType(registry, id);
-  if (!type) return null;
-  return {
-    type,
-    model: registry[type].get(id)
-  };
-}
 
-export { CheckErrorSchema, CheckResultSchema, CheckWarningSchema, ConcretizationSlotSchema, ID_PATTERNS, LinkSchema, LintIssueSchema, Model, PhaseSchema, PrioritySchema, RELATION_CONSTRAINTS, RELATION_TYPES, ReferenceDefinitionSchema, RelationSchema, RelationsFieldSchema, batchWriteFiles, checkBatchDrift, checkExternalSsot, checkFileDrift, checkReferenceIntegrity, clearModelRegistry, 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, detectCycles, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findModelType, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllIds, getAllInstances, getAllModelDefinitions, getAllModelInstances, getAllModels, getExpectedOutputDirs, getGlobalModelRegistry, getLevelIndex, getModel, getModelById, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, getRegistryStats, getSpecStore, getSpecsFromRegistry, inferModelIdFromSpecId, lintAllModels, lintModel, loadAllModels, loadConfig, loadModelsFromDirectory, loadSpeckeeperConfig, registerModel, registerModelDefinition, registerModelDefinitions, registerModelInstance, resetModelInstances, resetModelRegistry, resetSpecStore, resolveReference, validateConfig, validateOutputPaths, validateRelationLevel, writeFile, writeJsonFile };
+export { CheckErrorSchema, CheckResultSchema, CheckWarningSchema, ConcretizationSlotSchema, ID_PATTERNS, LinkSchema, LintIssueSchema, Model, PhaseSchema, PrioritySchema, RELATION_CONSTRAINTS, RELATION_TYPES, ReferenceDefinitionSchema, RelationSchema, RelationsFieldSchema, batchWriteFiles, checkBatchDrift, checkExternalSsot, checkFileDrift, checkReferenceIntegrity, clearModelRegistry, 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, defineSpecs, detectCycles, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findModelTypeBySpecId, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllInstances, getAllModelDefinitions, getAllModelInstances, getAllModels, getAllSpecIds, getExpectedOutputDirs, getGlobalModelRegistry, getLevelIndex, getModel, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, getSpecById, getSpecStore, getSpecs, inferModelIdFromSpecId, lintAllModels, lintModel, loadConfig, loadSpeckeeperConfig, mergeSpecs, registerModel, registerModelDefinition, registerModelDefinitions, registerModelInstance, registerModelsFromConfig, registerSpecsFromConfig, resetModelInstances, resetModelRegistry, resetSpecStore, resolveReference, validateConfig, validateOutputPaths, validateRelationLevel, writeFile, writeJsonFile };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map