@redush/sysconst-validator 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,204 @@
+/**
+ * EvoSpec DSL Validator Types
+ */
+type StableId = string;
+type NodeKind = 'System' | 'Module' | 'Entity' | 'Enum' | 'Value' | 'Interface' | 'Command' | 'Event' | 'Query' | 'Process' | 'Step' | 'Policy' | 'Scenario' | 'Contract';
+interface Meta {
+    title?: string;
+    description?: string;
+    tags?: string[];
+}
+interface Field {
+    type: string;
+    required?: boolean;
+    default?: unknown;
+    description?: string;
+}
+interface Relation {
+    to: StableId;
+    type: 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many';
+}
+interface Contract {
+    type?: string;
+    invariant?: string;
+    temporal?: string;
+    rule?: string;
+    level?: 'hard' | 'soft';
+}
+interface Hook {
+    id: StableId;
+    location: {
+        file: string;
+        anchorStart: string;
+        anchorEnd: string;
+    };
+    contract?: {
+        signature?: string;
+        purity?: boolean;
+        async?: boolean;
+        throws?: boolean;
+    };
+}
+interface Node {
+    kind: NodeKind;
+    id: StableId;
+    meta?: Meta;
+    spec: Record<string, unknown>;
+    impl?: Record<string, unknown>;
+    facets?: Record<string, unknown>;
+    children?: (string | Node)[];
+    contracts?: Contract[];
+    hooks?: Hook[];
+}
+interface Project {
+    id: StableId;
+    name?: string;
+    versioning: {
+        strategy: 'semver';
+        current: string;
+        compatibility?: {
+            data?: 'forward-only' | 'bidirectional';
+            api?: 'no-breaking-in-minor' | 'breaking-allowed';
+            processes?: 'instance-pinned' | 'auto-migrate';
+        };
+    };
+}
+interface Structure {
+    root: string;
+}
+interface Domain {
+    nodes: Node[];
+}
+interface Zone {
+    path: string;
+    mode: 'overwrite' | 'anchored' | 'preserve' | 'spec-controlled';
+}
+interface Pipeline {
+    cmd: string;
+}
+interface Generation {
+    monorepo?: {
+        layout?: {
+            apps?: Record<string, string>;
+            libs?: Record<string, string>;
+        };
+    };
+    zones?: Zone[];
+    hooks?: Hook[];
+    pipelines?: {
+        build?: Pipeline;
+        test?: Pipeline;
+        e2e?: Pipeline;
+        migrate?: Pipeline;
+        lint?: Pipeline;
+    };
+    verification?: {
+        required?: string[];
+        optional?: string[];
+    };
+}
+interface Change {
+    op: string;
+    target: StableId;
+    field?: string;
+    type?: string;
+    required?: boolean;
+    from?: string;
+    to?: string;
+}
+interface MigrationStep {
+    backfill?: {
+        entity: StableId;
+        set: Record<string, unknown>;
+    };
+    sql?: string;
+    script?: string;
+}
+interface Migration {
+    id: StableId;
+    kind: 'data' | 'schema' | 'process';
+    steps: MigrationStep[];
+    validate?: {
+        assert: string;
+    }[];
+}
+interface HistoryEntry {
+    version: string;
+    basedOn: string | null;
+    changes: Change[];
+    migrations: Migration[];
+    notes?: string;
+}
+interface Tests {
+    scenarios?: string[];
+}
+interface DocPack {
+    id: StableId;
+    include: Record<string, unknown>;
+}
+interface Docs {
+    packs?: DocPack[];
+}
+interface EvoSpec {
+    spec: 'sysconst/v1';
+    project: Project;
+    structure: Structure;
+    domain: Domain;
+    generation?: Generation;
+    history?: HistoryEntry[];
+    tests?: Tests;
+    docs?: Docs;
+}
+type ErrorCode = 'STRUCTURAL_ERROR' | 'MISSING_SPEC_VERSION' | 'INVALID_SPEC_VERSION' | 'MISSING_PROJECT' | 'MISSING_PROJECT_ID' | 'MISSING_VERSIONING' | 'MISSING_CURRENT_VERSION' | 'MISSING_STRUCTURE' | 'MISSING_STRUCTURE_ROOT' | 'MISSING_DOMAIN' | 'MISSING_DOMAIN_NODES' | 'INVALID_NODE' | 'MISSING_NODE_KIND' | 'INVALID_NODE_KIND' | 'MISSING_NODE_ID' | 'INVALID_NODE_ID' | 'MISSING_NODE_SPEC' | 'DUPLICATE_NODE_ID' | 'REFERENCE_ERROR' | 'UNRESOLVED_NODEREF' | 'UNRESOLVED_ROOT' | 'INVALID_ROOT_KIND' | 'CIRCULAR_CHILDREN' | 'MISSING_RENAME_OP' | 'MISSING_REMOVE_OP' | 'SEMANTIC_ERROR' | 'ENTITY_MISSING_FIELDS' | 'FIELD_MISSING_TYPE' | 'INVALID_FIELD_TYPE' | 'UNRESOLVED_REF_TYPE' | 'UNRESOLVED_ENUM_TYPE' | 'COMMAND_MISSING_INPUT' | 'EVENT_MISSING_PAYLOAD' | 'QUERY_MISSING_INPUT' | 'QUERY_MISSING_OUTPUT' | 'PROCESS_MISSING_TRIGGER' | 'INVALID_PROCESS_TRIGGER' | 'INVALID_PROCESS_CHILDREN' | 'SCENARIO_MISSING_GIVEN' | 'SCENARIO_MISSING_WHEN' | 'SCENARIO_MISSING_THEN' | 'INVALID_CONTRACT' | 'INVALID_INVARIANT' | 'INVALID_TEMPORAL' | 'UNRESOLVED_EFFECT_EVENT' | 'UNRESOLVED_EFFECT_ENTITY' | 'EVOLUTION_ERROR' | 'INVALID_HISTORY_START' | 'BROKEN_HISTORY_CHAIN' | 'VERSION_MISMATCH' | 'UNDECLARED_CHANGE' | 'MISSING_MIGRATION' | 'INVALID_MIGRATION' | 'MIGRATION_MISSING_ID' | 'MIGRATION_MISSING_KIND' | 'MIGRATION_MISSING_STEPS' | 'INVALID_MIGRATION_KIND' | 'MIGRATION_VIOLATES_INVARIANT' | 'GENERATION_ERROR' | 'UNCOVERED_FILE' | 'OVERLAPPING_ZONES' | 'PRESERVE_ZONE_MODIFIED' | 'HOOK_IN_OVERWRITE' | 'DUPLICATE_HOOK_ID' | 'INVALID_HOOK_ANCHORS' | 'HOOK_CONTENT_MODIFIED' | 'HOOK_ANCHOR_DELETED' | 'HOOK_CONTRACT_VIOLATED' | 'VERIFICATION_ERROR' | 'MISSING_BUILD_PIPELINE' | 'MISSING_TEST_PIPELINE' | 'MISSING_MIGRATE_PIPELINE' | 'EMPTY_PIPELINE_CMD' | 'SCENARIO_INVALID_ENTITY' | 'SCENARIO_INVALID_COMMAND' | 'SCENARIO_INVALID_EVENT' | 'LOW_SCENARIO_COVERAGE' | 'UNVERIFIED_CONTRACT' | 'CONTRACT_VIOLATION' | 'INVARIANT_VIOLATION' | 'TEMPORAL_VIOLATION' | 'API_COMPAT_VIOLATION' | 'POLICY_VIOLATION';
+type ErrorLevel = 'hard' | 'soft';
+type ValidationPhase = 1 | 2 | 3 | 4 | 5 | 6;
+interface ValidationError {
+    code: ErrorCode;
+    phase: ValidationPhase;
+    level: ErrorLevel;
+    message: string;
+    location: string;
+    suggestion?: string;
+    context?: Record<string, unknown>;
+}
+interface ValidationResult {
+    ok: boolean;
+    errors: ValidationError[];
+    warnings: ValidationError[];
+    phase: ValidationPhase;
+}
+interface ValidateOptions {
+    phases?: ValidationPhase[];
+    strict?: boolean;
+}
+
+/**
+ * EvoSpec DSL Validator
+ *
+ * Validates EvoSpec specifications through 6 phases:
+ * 1. Structural - syntax and required fields
+ * 2. Referential - references and identity
+ * 3. Semantic - kind-specific rules
+ * 4. Evolution - version history and migrations
+ * 5. Generation - code generation safety
+ * 6. Verifiability - pipelines and scenarios
+ */
+
+/**
+ * Validate an EvoSpec specification
+ */
+declare function validate(spec: unknown, options?: ValidateOptions): ValidationResult;
+/**
+ * Validate a specific phase only
+ */
+declare function validatePhase(spec: unknown, phase: ValidationPhase): ValidationError[];
+/**
+ * Parse YAML string to spec object
+ */
+declare function parseSpec(yaml: string): unknown;
+/**
+ * Validate YAML string
+ */
+declare function validateYaml(yaml: string, options?: ValidateOptions): ValidationResult;
+
+export { type Change, type Contract, type DocPack, type Docs, type Domain, type ErrorCode, type ErrorLevel, type EvoSpec, type Field, type Generation, type HistoryEntry, type Hook, type Meta, type Migration, type MigrationStep, type Node, type NodeKind, type Pipeline, type Project, type Relation, type StableId, type Structure, type Tests, type ValidateOptions, type ValidationError, type ValidationPhase, type ValidationResult, type Zone, parseSpec, validate, validatePhase, validateYaml };

package/dist/index.d.ts

@@ -0,0 +1,204 @@
+/**
+ * EvoSpec DSL Validator Types
+ */
+type StableId = string;
+type NodeKind = 'System' | 'Module' | 'Entity' | 'Enum' | 'Value' | 'Interface' | 'Command' | 'Event' | 'Query' | 'Process' | 'Step' | 'Policy' | 'Scenario' | 'Contract';
+interface Meta {
+    title?: string;
+    description?: string;
+    tags?: string[];
+}
+interface Field {
+    type: string;
+    required?: boolean;
+    default?: unknown;
+    description?: string;
+}
+interface Relation {
+    to: StableId;
+    type: 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many';
+}
+interface Contract {
+    type?: string;
+    invariant?: string;
+    temporal?: string;
+    rule?: string;
+    level?: 'hard' | 'soft';
+}
+interface Hook {
+    id: StableId;
+    location: {
+        file: string;
+        anchorStart: string;
+        anchorEnd: string;
+    };
+    contract?: {
+        signature?: string;
+        purity?: boolean;
+        async?: boolean;
+        throws?: boolean;
+    };
+}
+interface Node {
+    kind: NodeKind;
+    id: StableId;
+    meta?: Meta;
+    spec: Record<string, unknown>;
+    impl?: Record<string, unknown>;
+    facets?: Record<string, unknown>;
+    children?: (string | Node)[];
+    contracts?: Contract[];
+    hooks?: Hook[];
+}
+interface Project {
+    id: StableId;
+    name?: string;
+    versioning: {
+        strategy: 'semver';
+        current: string;
+        compatibility?: {
+            data?: 'forward-only' | 'bidirectional';
+            api?: 'no-breaking-in-minor' | 'breaking-allowed';
+            processes?: 'instance-pinned' | 'auto-migrate';
+        };
+    };
+}
+interface Structure {
+    root: string;
+}
+interface Domain {
+    nodes: Node[];
+}
+interface Zone {
+    path: string;
+    mode: 'overwrite' | 'anchored' | 'preserve' | 'spec-controlled';
+}
+interface Pipeline {
+    cmd: string;
+}
+interface Generation {
+    monorepo?: {
+        layout?: {
+            apps?: Record<string, string>;
+            libs?: Record<string, string>;
+        };
+    };
+    zones?: Zone[];
+    hooks?: Hook[];
+    pipelines?: {
+        build?: Pipeline;
+        test?: Pipeline;
+        e2e?: Pipeline;
+        migrate?: Pipeline;
+        lint?: Pipeline;
+    };
+    verification?: {
+        required?: string[];
+        optional?: string[];
+    };
+}
+interface Change {
+    op: string;
+    target: StableId;
+    field?: string;
+    type?: string;
+    required?: boolean;
+    from?: string;
+    to?: string;
+}
+interface MigrationStep {
+    backfill?: {
+        entity: StableId;
+        set: Record<string, unknown>;
+    };
+    sql?: string;
+    script?: string;
+}
+interface Migration {
+    id: StableId;
+    kind: 'data' | 'schema' | 'process';
+    steps: MigrationStep[];
+    validate?: {
+        assert: string;
+    }[];
+}
+interface HistoryEntry {
+    version: string;
+    basedOn: string | null;
+    changes: Change[];
+    migrations: Migration[];
+    notes?: string;
+}
+interface Tests {
+    scenarios?: string[];
+}
+interface DocPack {
+    id: StableId;
+    include: Record<string, unknown>;
+}
+interface Docs {
+    packs?: DocPack[];
+}
+interface EvoSpec {
+    spec: 'sysconst/v1';
+    project: Project;
+    structure: Structure;
+    domain: Domain;
+    generation?: Generation;
+    history?: HistoryEntry[];
+    tests?: Tests;
+    docs?: Docs;
+}
+type ErrorCode = 'STRUCTURAL_ERROR' | 'MISSING_SPEC_VERSION' | 'INVALID_SPEC_VERSION' | 'MISSING_PROJECT' | 'MISSING_PROJECT_ID' | 'MISSING_VERSIONING' | 'MISSING_CURRENT_VERSION' | 'MISSING_STRUCTURE' | 'MISSING_STRUCTURE_ROOT' | 'MISSING_DOMAIN' | 'MISSING_DOMAIN_NODES' | 'INVALID_NODE' | 'MISSING_NODE_KIND' | 'INVALID_NODE_KIND' | 'MISSING_NODE_ID' | 'INVALID_NODE_ID' | 'MISSING_NODE_SPEC' | 'DUPLICATE_NODE_ID' | 'REFERENCE_ERROR' | 'UNRESOLVED_NODEREF' | 'UNRESOLVED_ROOT' | 'INVALID_ROOT_KIND' | 'CIRCULAR_CHILDREN' | 'MISSING_RENAME_OP' | 'MISSING_REMOVE_OP' | 'SEMANTIC_ERROR' | 'ENTITY_MISSING_FIELDS' | 'FIELD_MISSING_TYPE' | 'INVALID_FIELD_TYPE' | 'UNRESOLVED_REF_TYPE' | 'UNRESOLVED_ENUM_TYPE' | 'COMMAND_MISSING_INPUT' | 'EVENT_MISSING_PAYLOAD' | 'QUERY_MISSING_INPUT' | 'QUERY_MISSING_OUTPUT' | 'PROCESS_MISSING_TRIGGER' | 'INVALID_PROCESS_TRIGGER' | 'INVALID_PROCESS_CHILDREN' | 'SCENARIO_MISSING_GIVEN' | 'SCENARIO_MISSING_WHEN' | 'SCENARIO_MISSING_THEN' | 'INVALID_CONTRACT' | 'INVALID_INVARIANT' | 'INVALID_TEMPORAL' | 'UNRESOLVED_EFFECT_EVENT' | 'UNRESOLVED_EFFECT_ENTITY' | 'EVOLUTION_ERROR' | 'INVALID_HISTORY_START' | 'BROKEN_HISTORY_CHAIN' | 'VERSION_MISMATCH' | 'UNDECLARED_CHANGE' | 'MISSING_MIGRATION' | 'INVALID_MIGRATION' | 'MIGRATION_MISSING_ID' | 'MIGRATION_MISSING_KIND' | 'MIGRATION_MISSING_STEPS' | 'INVALID_MIGRATION_KIND' | 'MIGRATION_VIOLATES_INVARIANT' | 'GENERATION_ERROR' | 'UNCOVERED_FILE' | 'OVERLAPPING_ZONES' | 'PRESERVE_ZONE_MODIFIED' | 'HOOK_IN_OVERWRITE' | 'DUPLICATE_HOOK_ID' | 'INVALID_HOOK_ANCHORS' | 'HOOK_CONTENT_MODIFIED' | 'HOOK_ANCHOR_DELETED' | 'HOOK_CONTRACT_VIOLATED' | 'VERIFICATION_ERROR' | 'MISSING_BUILD_PIPELINE' | 'MISSING_TEST_PIPELINE' | 'MISSING_MIGRATE_PIPELINE' | 'EMPTY_PIPELINE_CMD' | 'SCENARIO_INVALID_ENTITY' | 'SCENARIO_INVALID_COMMAND' | 'SCENARIO_INVALID_EVENT' | 'LOW_SCENARIO_COVERAGE' | 'UNVERIFIED_CONTRACT' | 'CONTRACT_VIOLATION' | 'INVARIANT_VIOLATION' | 'TEMPORAL_VIOLATION' | 'API_COMPAT_VIOLATION' | 'POLICY_VIOLATION';
+type ErrorLevel = 'hard' | 'soft';
+type ValidationPhase = 1 | 2 | 3 | 4 | 5 | 6;
+interface ValidationError {
+    code: ErrorCode;
+    phase: ValidationPhase;
+    level: ErrorLevel;
+    message: string;
+    location: string;
+    suggestion?: string;
+    context?: Record<string, unknown>;
+}
+interface ValidationResult {
+    ok: boolean;
+    errors: ValidationError[];
+    warnings: ValidationError[];
+    phase: ValidationPhase;
+}
+interface ValidateOptions {
+    phases?: ValidationPhase[];
+    strict?: boolean;
+}
+
+/**
+ * EvoSpec DSL Validator
+ *
+ * Validates EvoSpec specifications through 6 phases:
+ * 1. Structural - syntax and required fields
+ * 2. Referential - references and identity
+ * 3. Semantic - kind-specific rules
+ * 4. Evolution - version history and migrations
+ * 5. Generation - code generation safety
+ * 6. Verifiability - pipelines and scenarios
+ */
+
+/**
+ * Validate an EvoSpec specification
+ */
+declare function validate(spec: unknown, options?: ValidateOptions): ValidationResult;
+/**
+ * Validate a specific phase only
+ */
+declare function validatePhase(spec: unknown, phase: ValidationPhase): ValidationError[];
+/**
+ * Parse YAML string to spec object
+ */
+declare function parseSpec(yaml: string): unknown;
+/**
+ * Validate YAML string
+ */
+declare function validateYaml(yaml: string, options?: ValidateOptions): ValidationResult;
+
+export { type Change, type Contract, type DocPack, type Docs, type Domain, type ErrorCode, type ErrorLevel, type EvoSpec, type Field, type Generation, type HistoryEntry, type Hook, type Meta, type Migration, type MigrationStep, type Node, type NodeKind, type Pipeline, type Project, type Relation, type StableId, type Structure, type Tests, type ValidateOptions, type ValidationError, type ValidationPhase, type ValidationResult, type Zone, parseSpec, validate, validatePhase, validateYaml };