zenkit 0.5.0

package/dist/index.d.ts

@@ -0,0 +1,765 @@
+export declare const schemas: {
+    readonly handoff: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            context: {
+                type: string;
+                description: string;
+            };
+            assumptions: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+            constraints: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+            decision: {
+                type: string;
+                description: string;
+            };
+            deliverable: {
+                type: string;
+                properties: {
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    description: {
+                        type: string;
+                    };
+                    files_changed: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    validation_status: {
+                        type: string;
+                        enum: string[];
+                    };
+                };
+                required: string[];
+            };
+            risks: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        description: {
+                            type: string;
+                        };
+                        severity: {
+                            type: string;
+                            enum: string[];
+                        };
+                        mitigation: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            open_questions: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+            next_agent: {
+                type: string;
+                description: string;
+            };
+            metadata: {
+                type: string;
+                properties: {
+                    timestamp: {
+                        type: string;
+                        format: string;
+                    };
+                    source_agent: {
+                        type: string;
+                    };
+                    command: {
+                        type: string;
+                    };
+                    iteration: {
+                        type: string;
+                        minimum: number;
+                    };
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    readonly task: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+                pattern: string;
+            };
+            name: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            description: {
+                type: string;
+            };
+            command: {
+                type: string;
+                enum: string[];
+            };
+            status: {
+                type: string;
+                enum: string[];
+            };
+            context: {
+                type: string;
+            };
+            assumptions: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            constraints: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            acceptance_criteria: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            files_affected: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            assigned_agent: {
+                type: string;
+            };
+            parent_task: {
+                type: string;
+            };
+            dependencies: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            metadata: {
+                type: string;
+                properties: {
+                    created_at: {
+                        type: string;
+                        format: string;
+                    };
+                    updated_at: {
+                        type: string;
+                        format: string;
+                    };
+                    estimated_tokens: {
+                        type: string;
+                        minimum: number;
+                    };
+                    actual_tokens: {
+                        type: string;
+                        minimum: number;
+                    };
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    readonly audit: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            task_id: {
+                type: string;
+            };
+            auditor: {
+                type: string;
+                description: string;
+            };
+            timestamp: {
+                type: string;
+                format: string;
+            };
+            verdict: {
+                type: string;
+                enum: string[];
+            };
+            findings: {
+                type: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        category: {
+                            type: string;
+                            enum: string[];
+                        };
+                        severity: {
+                            type: string;
+                            enum: string[];
+                        };
+                        description: {
+                            type: string;
+                        };
+                        file: {
+                            type: string;
+                        };
+                        line: {
+                            type: string;
+                        };
+                        suggestion: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            rubric_scores: {
+                type: string;
+                properties: {
+                    execution_quality: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                    };
+                    verbosity_score: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                    };
+                    architectural_alignment: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                    };
+                };
+            };
+            open_questions: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            recommendations: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    readonly checkpoint: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            checkpoint_id: {
+                type: string;
+                pattern: string;
+            };
+            task_id: {
+                type: string;
+            };
+            timestamp: {
+                type: string;
+                format: string;
+            };
+            status: {
+                type: string;
+                enum: string[];
+            };
+            stage: {
+                type: string;
+                enum: string[];
+            };
+            state: {
+                type: string;
+                properties: {
+                    files_changed: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    tests_passing: {
+                        type: string;
+                    };
+                    lint_passing: {
+                        type: string;
+                    };
+                    git_ref: {
+                        type: string;
+                    };
+                    notes: {
+                        type: string;
+                    };
+                };
+            };
+            gate_conditions: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        condition: {
+                            type: string;
+                        };
+                        met: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            metadata: {
+                type: string;
+                properties: {
+                    agent: {
+                        type: string;
+                    };
+                    command: {
+                        type: string;
+                    };
+                    iteration: {
+                        type: string;
+                    };
+                    tokens_used: {
+                        type: string;
+                    };
+                    cost_estimate_usd: {
+                        type: string;
+                    };
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    readonly benchmark: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            benchmark_id: {
+                type: string;
+            };
+            version: {
+                type: string;
+            };
+            mode: {
+                type: string;
+                enum: string[];
+                description: string;
+            };
+            task_name: {
+                type: string;
+            };
+            feature_spec: {
+                type: string;
+            };
+            started_at: {
+                type: string;
+                format: string;
+            };
+            completed_at: {
+                type: string;
+                format: string;
+            };
+            duration_ms: {
+                type: string;
+                minimum: number;
+            };
+            status: {
+                type: string;
+                enum: string[];
+            };
+            expected_files: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            files_found: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            files_missing: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            acceptance_criteria_results: {
+                type: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        description: {
+                            type: string;
+                        };
+                        status: {
+                            type: string;
+                            enum: string[];
+                        };
+                        evidence: {
+                            type: string;
+                            description: string;
+                        };
+                        verification_type: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+            stages: {
+                type: string;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        name: {
+                            type: string;
+                        };
+                        status: {
+                            type: string;
+                            enum: string[];
+                        };
+                        duration_ms: {
+                            type: string;
+                        };
+                        checks_run: {
+                            type: string;
+                            minimum: number;
+                        };
+                        checks_passed: {
+                            type: string;
+                            minimum: number;
+                        };
+                        details: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                    };
+                };
+            };
+            validation_summary: {
+                type: string;
+                required: string[];
+                properties: {
+                    total_criteria: {
+                        type: string;
+                    };
+                    criteria_passed: {
+                        type: string;
+                    };
+                    criteria_failed: {
+                        type: string;
+                    };
+                    schemas_valid: {
+                        type: string;
+                    };
+                    examples_valid: {
+                        type: string;
+                    };
+                };
+            };
+            telemetry: {
+                type: string;
+                required: string[];
+                properties: {
+                    estimated: {
+                        type: string;
+                        required: string[];
+                        properties: {
+                            tokens: {
+                                type: string;
+                            };
+                            cost_usd: {
+                                type: string;
+                            };
+                            basis: {
+                                type: string;
+                                description: string;
+                            };
+                        };
+                    };
+                    actual: {
+                        oneOf: ({
+                            type: string;
+                            required?: undefined;
+                            properties?: undefined;
+                        } | {
+                            type: string;
+                            required: string[];
+                            properties: {
+                                tokens: {
+                                    type: string;
+                                };
+                                cost_usd: {
+                                    type: string;
+                                };
+                            };
+                        })[];
+                        description: string;
+                    };
+                };
+            };
+            uncertainty: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+            limitations: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    readonly 'feature-spec': {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            feature_id: {
+                type: string;
+                pattern: string;
+            };
+            name: {
+                type: string;
+                minLength: number;
+            };
+            description: {
+                type: string;
+            };
+            mode: {
+                type: string;
+                enum: string[];
+            };
+            acceptance_criteria: {
+                type: string;
+                minItems: number;
+                items: {
+                    type: string;
+                    required: string[];
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        description: {
+                            type: string;
+                        };
+                        verification: {
+                            type: string;
+                            required: string[];
+                            properties: {
+                                type: {
+                                    type: string;
+                                    enum: string[];
+                                };
+                                path: {
+                                    type: string;
+                                };
+                                pattern: {
+                                    type: string;
+                                };
+                                command: {
+                                    type: string;
+                                    description: string;
+                                };
+                                json_path: {
+                                    type: string;
+                                    description: string;
+                                };
+                                equals: {
+                                    description: string;
+                                };
+                                expected: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            constraints: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            expected_files: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            assigned_commands: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            estimated_complexity: {
+                type: string;
+                enum: string[];
+            };
+            limitations: {
+                type: string;
+                minItems: number;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+};
+export type SchemaName = keyof typeof schemas;
+export interface ValidationError {
+    path: string;
+    message: string;
+    keyword: string;
+}
+export interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    schemaName: SchemaName;
+}
+/**
+ * Validate data against a named ZenKit schema.
+ *
+ * @example
+ * const result = validate('handoff', { context: '...', ... })
+ * if (!result.valid) console.error(result.errors)
+ */
+export declare function validate(schemaName: SchemaName, data: unknown): ValidationResult;
+/**
+ * Get the raw JSON Schema object for a named schema.
+ */
+export declare function getSchema(name: SchemaName): object;
+/**
+ * List all available schema names.
+ */
+export declare function getSchemaNames(): SchemaName[];
+export interface Verification {
+    type: string;
+    path?: string;
+    pattern?: string;
+    expected?: number;
+    command?: string;
+    json_path?: string;
+    equals?: unknown;
+}
+export interface AcceptanceCriterion {
+    id: string;
+    description: string;
+    verification: Verification;
+}
+export interface FeatureSpec {
+    feature_id: string;
+    name: string;
+    description: string;
+    mode: 'zenkit' | 'baseline';
+    acceptance_criteria: AcceptanceCriterion[];
+    constraints: string[];
+    expected_files: string[];
+    assigned_commands: string[];
+    estimated_complexity: string;
+    limitations: string[];
+}
+/**
+ * Load and validate a feature spec from a JSON file.
+ * Returns the parsed spec if valid, throws if invalid.
+ */
+export declare function loadFeatureSpec(specPath: string): FeatureSpec;
+export interface Deliverable {
+    type: 'code' | 'document' | 'schema' | 'plan' | 'review' | 'test' | 'artifact';
+    description: string;
+    files_changed?: string[];
+    validation_status?: 'passed' | 'failed' | 'partial' | 'untested';
+}
+export interface Risk {
+    description: string;
+    severity: 'low' | 'medium' | 'high' | 'critical';
+    mitigation?: string;
+}
+export interface Handoff {
+    context: string;
+    assumptions: string[];
+    constraints?: string[];
+    decision: string;
+    deliverable: Deliverable;
+    risks?: Risk[];
+    open_questions?: string[];
+    next_agent: string;
+    metadata?: {
+        timestamp?: string;
+        source_agent?: string;
+        command?: string;
+        iteration?: number;
+    };
+}
+/**
+ * Create and validate a handoff object.
+ * Returns the handoff if valid, throws if invalid.
+ */
+export declare function createHandoff(handoff: Handoff): Handoff;
+/** @deprecated Use `validate` instead */
+export declare const validateAgainstSchema: typeof validate;
+//# sourceMappingURL=index.d.ts.map