speckeeper 0.2.1 → 0.4.0

package/dist/index.d.ts

@@ -856,53 +856,69 @@ declare abstract class Model<TSchema extends ZodType> {
     register(specs: z.infer<TSchema>[]): void;
 }
 /**
- * Get the global spec store (model ID → spec ID → spec data)
+ * A single (Model, data[]) pair.
+ * Uses structural typing (not nominal Model<any>) so that
+ * compiled dist/ Model instances are compatible with src/ types.
  */
-declare function getSpecStore(): Map<string, Map<string, unknown>>;
-/**
- * Reset the spec store (clears all registered specs)
- */
-declare function resetSpecStore(): void;
-/**
- * Register model
- */
-declare function registerModel(model: Model<any>): void;
-/**
- * Get model
- */
-declare function getModel(id: string): Model<any> | undefined;
+interface SpecEntry {
+    model: {
+        id: string;
+        register: (data: unknown[]) => void;
+    };
+    data: unknown[];
+}
 /**
- * Get all registered models
+ * Common export interface for spec data files.
+ * Each spec file exports a SpecModule via defineSpecs().
  */
-declare function getAllModels(): Model<any>[];
+interface SpecModule {
+    entries: SpecEntry[];
+}
 /**
- * Clear registry
+ * Aggregated result from mergeSpecs().
  */
-declare function clearModelRegistry(): void;
+interface MergedDesign {
+    models: SpecEntry['model'][];
+    specs: SpecEntry[];
+}
 /**
- * Register model instances from config.models array.
- * Filters out non-Model values. Call this once after config is loaded.
+ * Define spec data in a spec file. Returns a SpecModule.
+ *
+ * @example
+ * ```typescript
+ * export default defineSpecs(
+ *   [FunctionalRequirementModel.instance, functionalRequirements],
+ *   [NonFunctionalRequirementModel.instance, nonFunctionalRequirements],
+ * );
+ * ```
  */
-declare function registerModelsFromConfig(models: unknown[]): void;
+declare function defineSpecs(...entries: [SpecEntry['model'], unknown[]][]): SpecModule;
 /**
- * Get specs for a given model ID from specStore
+ * 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 getSpecs(modelId: string): unknown[];
+declare function mergeSpecs(...modules: SpecModule[]): MergedDesign;
 /**
- * Get all spec IDs across all models
+ * Build a registry (modelId -> Map<specId, spec>) from config.specs.
+ * Pure function — no global state.
  */
-declare function getAllSpecIds(): Set<string>;
+declare function buildRegistryFromConfig(specs: SpecEntry[] | undefined): Record<string, Map<string, unknown>>;
 /**
- * Find which model type a spec ID belongs to
+ * Get specs for a model ID from config.specs.
+ * Pure function — no global state.
  */
-declare function findModelTypeBySpecId(specId: string): string | null;
+declare function getSpecsFromConfig(specs: SpecEntry[] | undefined, modelId: string): unknown[];
 /**
- * Get a spec by ID (searches all models)
+ * Find which model type a spec ID belongs to, from config.specs.
+ * Pure function — no global state.
  */
-declare function getSpecById(specId: string): {
-    modelId: string;
-    spec: unknown;
-} | null;
+declare function findModelTypeFromConfig(specs: SpecEntry[] | undefined, specId: string): string | null;
 
 /**
  * Register model definition
@@ -1021,13 +1037,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
  */
@@ -1044,6 +1053,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?: {
@@ -1282,6 +1293,7 @@ interface SpeckeeperConfig {
         mermaidCliPath?: string;
     };
     models?: unknown[];
+    specs?: SpecEntry[];
 }
 /**
  * Get output paths compliant with specification
@@ -1342,4 +1354,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, 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 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, 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, registerModel, registerModelDefinition, registerModelDefinitions, registerModelInstance, registerModelsFromConfig, 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, buildRegistryFromConfig, 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, defineSpecs, detectCycles, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findModelTypeFromConfig, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllInstances, getAllModelDefinitions, getAllModelInstances, getExpectedOutputDirs, getGlobalModelRegistry, getLevelIndex, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, getSpecsFromConfig, inferModelIdFromSpecId, lintAllModels, lintModel, loadConfig, loadSpeckeeperConfig, mergeSpecs, registerModelDefinition, registerModelDefinitions, registerModelInstance, resetModelInstances, resetModelRegistry, resolveReference, validateConfig, validateOutputPaths, validateRelationLevel, writeFile, writeJsonFile };

package/dist/index.js

@@ -561,57 +561,58 @@ var Model = class {
   }
 };
 var specStore = /* @__PURE__ */ new Map();
-function getSpecStore() {
-  return specStore;
-}
-function resetSpecStore() {
-  specStore.clear();
-}
 var modelRegistry = /* @__PURE__ */ new Map();
-function registerModel(model) {
-  modelRegistry.set(model.id, model);
-}
-function getModel(id) {
-  return modelRegistry.get(id);
-}
 function getAllModels() {
   return Array.from(modelRegistry.values());
 }
-function clearModelRegistry() {
-  modelRegistry.clear();
+function defineSpecs(...entries) {
+  return {
+    entries: entries.map(([model, data]) => ({ model, data }))
+  };
 }
-function registerModelsFromConfig(models) {
-  for (const model of models) {
-    if (model && typeof model === "object" && "id" in model && "schema" in model) {
-      registerModel(model);
+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 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);
+function buildRegistryFromConfig(specs) {
+  const registry = {};
+  if (!specs) return registry;
+  for (const entry of specs) {
+    if (!registry[entry.model.id]) {
+      registry[entry.model.id] = /* @__PURE__ */ new Map();
+    }
+    const map = registry[entry.model.id];
+    for (const spec of entry.data) {
+      map.set(spec.id, spec);
     }
   }
-  return ids;
+  return registry;
+}
+function getSpecsFromConfig(specs, modelId) {
+  if (!specs) return [];
+  return specs.filter((e) => e.model.id === modelId).flatMap((e) => e.data);
 }
-function findModelTypeBySpecId(specId) {
-  for (const [modelId, map] of specStore) {
-    if (map.has(specId)) return modelId;
+function findModelTypeFromConfig(specs, specId) {
+  if (!specs) return null;
+  for (const entry of specs) {
+    for (const spec of entry.data) {
+      if (spec.id === specId) {
+        return entry.model.id;
+      }
+    }
   }
   return null;
 }
-function getSpecById(specId) {
-  const modelId = findModelTypeBySpecId(specId);
-  if (!modelId) return null;
-  return { modelId, spec: specStore.get(modelId).get(specId) };
-}
 
 // src/core/model-registry.ts
 var globalRegistry = {
@@ -1147,6 +1148,6 @@ function generateSpecsPath(baseDir, category, filename) {
   return join(baseDir, category, filename);
 }
 
-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, 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, registerModel, registerModelDefinition, registerModelDefinitions, registerModelInstance, registerModelsFromConfig, 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, buildRegistryFromConfig, 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, defineSpecs, detectCycles, ensureDir, exportAllModels, exportMarkdown, exportMermaid, findConfigFile, findDefinitionFiles, findFiles, findModelTypeFromConfig, findTypeScriptFiles, generateDocsPath, generateSpecsPath, getAllInstances, getAllModelDefinitions, getAllModelInstances, getExpectedOutputDirs, getGlobalModelRegistry, getLevelIndex, getModelDefinition, getModelInstance, getModelRegistryStats, getOutputPaths, getSpecsFromConfig, inferModelIdFromSpecId, lintAllModels, lintModel, loadConfig, loadSpeckeeperConfig, mergeSpecs, registerModelDefinition, registerModelDefinitions, registerModelInstance, resetModelInstances, resetModelRegistry, resolveReference, validateConfig, validateOutputPaths, validateRelationLevel, writeFile, writeJsonFile };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map