@popoverai/dotrequirements 0.24.2 → 0.25.0

package/dist/codebase-to-spec/schemas.d.ts

@@ -337,5 +337,533 @@ export declare const SPEC_REVIEW_JSON_SCHEMA: {
     readonly required: readonly ["coverage_gaps", "framing_errors", "cross_area_issues", "internal_mechanics_drift", "revisions", "verdict"];
     readonly additionalProperties: false;
 };
+export declare const ConversationalCustomerSchema: z.ZodObject<{
+    description: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+}, {
+    description: string;
+}>;
+export type ConversationalCustomer = z.infer<typeof ConversationalCustomerSchema>;
+/**
+ * One entry in the review thread (project-level or per-area). Discriminated
+ * on `result`:
+ *
+ * - `approved`: no revisions required.
+ * - `needs-revision`: must include a non-empty `revisions` list — each
+ *   entry is a clear, actionable instruction for the next planner pass.
+ */
+export declare const ConversationalReviewEntrySchema: z.ZodDiscriminatedUnion<"result", [z.ZodObject<{
+    result: z.ZodLiteral<"approved">;
+}, "strip", z.ZodTypeAny, {
+    result: "approved";
+}, {
+    result: "approved";
+}>, z.ZodObject<{
+    result: z.ZodLiteral<"needs-revision">;
+    revisions: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    revisions: string[];
+    result: "needs-revision";
+}, {
+    revisions: string[];
+    result: "needs-revision";
+}>]>;
+export type ConversationalReviewEntry = z.infer<typeof ConversationalReviewEntrySchema>;
+/**
+ * Review state. Used both at the project level (outline.review) and per
+ * area (area.review). `result` mirrors the latest thread entry's result
+ * so callers can query state without walking the thread.
+ */
+export declare const ConversationalReviewSchema: z.ZodObject<{
+    result: z.ZodEnum<["approved", "needs-revision"]>;
+    thread: z.ZodArray<z.ZodDiscriminatedUnion<"result", [z.ZodObject<{
+        result: z.ZodLiteral<"approved">;
+    }, "strip", z.ZodTypeAny, {
+        result: "approved";
+    }, {
+        result: "approved";
+    }>, z.ZodObject<{
+        result: z.ZodLiteral<"needs-revision">;
+        revisions: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        revisions: string[];
+        result: "needs-revision";
+    }, {
+        revisions: string[];
+        result: "needs-revision";
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    result: "approved" | "needs-revision";
+    thread: ({
+        result: "approved";
+    } | {
+        revisions: string[];
+        result: "needs-revision";
+    })[];
+}, {
+    result: "approved" | "needs-revision";
+    thread: ({
+        result: "approved";
+    } | {
+        revisions: string[];
+        result: "needs-revision";
+    })[];
+}>;
+export type ConversationalReview = z.infer<typeof ConversationalReviewSchema>;
+export declare const ConversationalAreaSchema: z.ZodObject<{
+    name: z.ZodString;
+    prefix: z.ZodString;
+    description: z.ZodString;
+    source_files: z.ZodArray<z.ZodString, "many">;
+    customers: z.ZodArray<z.ZodObject<{
+        description: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        description: string;
+    }, {
+        description: string;
+    }>, "many">;
+    /**
+     * Per-area review state — same shape as the project-level review.
+     * Optional: planner output doesn't include it; CA adds it after reviewing
+     * a partial. Tracks the per-area iteration loop (specify → review →
+     * editor → re-review → approved) the same way `outline.review` tracks
+     * the outline iteration loop.
+     */
+    review: z.ZodOptional<z.ZodObject<{
+        result: z.ZodEnum<["approved", "needs-revision"]>;
+        thread: z.ZodArray<z.ZodDiscriminatedUnion<"result", [z.ZodObject<{
+            result: z.ZodLiteral<"approved">;
+        }, "strip", z.ZodTypeAny, {
+            result: "approved";
+        }, {
+            result: "approved";
+        }>, z.ZodObject<{
+            result: z.ZodLiteral<"needs-revision">;
+            revisions: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            revisions: string[];
+            result: "needs-revision";
+        }, {
+            revisions: string[];
+            result: "needs-revision";
+        }>]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    }, {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    prefix: string;
+    name: string;
+    description: string;
+    customers: {
+        description: string;
+    }[];
+    source_files: string[];
+    review?: {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    } | undefined;
+}, {
+    prefix: string;
+    name: string;
+    description: string;
+    customers: {
+        description: string;
+    }[];
+    source_files: string[];
+    review?: {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    } | undefined;
+}>;
+export type ConversationalArea = z.infer<typeof ConversationalAreaSchema>;
+export declare const ConversationalOutlineSchema: z.ZodObject<{
+    title: z.ZodString;
+    defaultPrefix: z.ZodString;
+    summary: z.ZodString;
+    /**
+     * Outline-approval review (the outline iteration loop). `compose-orchestrator`
+     * gates composition on `review.result === "approved"`, so this field is
+     * distinct from and must never be conflated with `crossAreaReview` below.
+     */
+    review: z.ZodOptional<z.ZodObject<{
+        result: z.ZodEnum<["approved", "needs-revision"]>;
+        thread: z.ZodArray<z.ZodDiscriminatedUnion<"result", [z.ZodObject<{
+            result: z.ZodLiteral<"approved">;
+        }, "strip", z.ZodTypeAny, {
+            result: "approved";
+        }, {
+            result: "approved";
+        }>, z.ZodObject<{
+            result: z.ZodLiteral<"needs-revision">;
+            revisions: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            revisions: string[];
+            result: "needs-revision";
+        }, {
+            revisions: string[];
+            result: "needs-revision";
+        }>]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    }, {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    }>>;
+    /**
+     * Document-level cross-area review state (CTSO-CONV-5). Recorded after the
+     * per-area partials are composed: the cross-area reviewer appends verdicts
+     * here and the compose-editor reads the latest entry's revisions — the same
+     * auditable thread pattern as `area.review`, kept at the top level because the
+     * review spans the whole composed spec rather than one area. Separate from
+     * `review` so cross-area iteration never disturbs outline approval.
+     */
+    crossAreaReview: z.ZodOptional<z.ZodObject<{
+        result: z.ZodEnum<["approved", "needs-revision"]>;
+        thread: z.ZodArray<z.ZodDiscriminatedUnion<"result", [z.ZodObject<{
+            result: z.ZodLiteral<"approved">;
+        }, "strip", z.ZodTypeAny, {
+            result: "approved";
+        }, {
+            result: "approved";
+        }>, z.ZodObject<{
+            result: z.ZodLiteral<"needs-revision">;
+            revisions: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            revisions: string[];
+            result: "needs-revision";
+        }, {
+            revisions: string[];
+            result: "needs-revision";
+        }>]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    }, {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    }>>;
+    areas: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        prefix: z.ZodString;
+        description: z.ZodString;
+        source_files: z.ZodArray<z.ZodString, "many">;
+        customers: z.ZodArray<z.ZodObject<{
+            description: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            description: string;
+        }, {
+            description: string;
+        }>, "many">;
+        /**
+         * Per-area review state — same shape as the project-level review.
+         * Optional: planner output doesn't include it; CA adds it after reviewing
+         * a partial. Tracks the per-area iteration loop (specify → review →
+         * editor → re-review → approved) the same way `outline.review` tracks
+         * the outline iteration loop.
+         */
+        review: z.ZodOptional<z.ZodObject<{
+            result: z.ZodEnum<["approved", "needs-revision"]>;
+            thread: z.ZodArray<z.ZodDiscriminatedUnion<"result", [z.ZodObject<{
+                result: z.ZodLiteral<"approved">;
+            }, "strip", z.ZodTypeAny, {
+                result: "approved";
+            }, {
+                result: "approved";
+            }>, z.ZodObject<{
+                result: z.ZodLiteral<"needs-revision">;
+                revisions: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                revisions: string[];
+                result: "needs-revision";
+            }, {
+                revisions: string[];
+                result: "needs-revision";
+            }>]>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            result: "approved" | "needs-revision";
+            thread: ({
+                result: "approved";
+            } | {
+                revisions: string[];
+                result: "needs-revision";
+            })[];
+        }, {
+            result: "approved" | "needs-revision";
+            thread: ({
+                result: "approved";
+            } | {
+                revisions: string[];
+                result: "needs-revision";
+            })[];
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        prefix: string;
+        name: string;
+        description: string;
+        customers: {
+            description: string;
+        }[];
+        source_files: string[];
+        review?: {
+            result: "approved" | "needs-revision";
+            thread: ({
+                result: "approved";
+            } | {
+                revisions: string[];
+                result: "needs-revision";
+            })[];
+        } | undefined;
+    }, {
+        prefix: string;
+        name: string;
+        description: string;
+        customers: {
+            description: string;
+        }[];
+        source_files: string[];
+        review?: {
+            result: "approved" | "needs-revision";
+            thread: ({
+                result: "approved";
+            } | {
+                revisions: string[];
+                result: "needs-revision";
+            })[];
+        } | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    defaultPrefix: string;
+    summary: string;
+    areas: {
+        prefix: string;
+        name: string;
+        description: string;
+        customers: {
+            description: string;
+        }[];
+        source_files: string[];
+        review?: {
+            result: "approved" | "needs-revision";
+            thread: ({
+                result: "approved";
+            } | {
+                revisions: string[];
+                result: "needs-revision";
+            })[];
+        } | undefined;
+    }[];
+    review?: {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    } | undefined;
+    crossAreaReview?: {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    } | undefined;
+}, {
+    title: string;
+    defaultPrefix: string;
+    summary: string;
+    areas: {
+        prefix: string;
+        name: string;
+        description: string;
+        customers: {
+            description: string;
+        }[];
+        source_files: string[];
+        review?: {
+            result: "approved" | "needs-revision";
+            thread: ({
+                result: "approved";
+            } | {
+                revisions: string[];
+                result: "needs-revision";
+            })[];
+        } | undefined;
+    }[];
+    review?: {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    } | undefined;
+    crossAreaReview?: {
+        result: "approved" | "needs-revision";
+        thread: ({
+            result: "approved";
+        } | {
+            revisions: string[];
+            result: "needs-revision";
+        })[];
+    } | undefined;
+}>;
+export type ConversationalOutline = z.infer<typeof ConversationalOutlineSchema>;
+/**
+ * Parse YAML text against the conversational outline schema. Throws with
+ * a descriptive message on parse or validation failure.
+ */
+export declare function parseConversationalOutline(text: string): ConversationalOutline;
+/**
+ * Adapt a conversational orchestrator outline to the legacy Outline shape
+ * for use with stages that still take the legacy schema (compose, present).
+ *
+ * Discards orchestrator-only fields (review); maps `source_files` → `files`;
+ * bridges the customer-shape difference by synthesizing a `name` from each
+ * conversational customer's description.
+ */
+export declare function conversationalOutlineToLegacy(outline: ConversationalOutline): Outline;
+/**
+ * Serialize a conversational outline back to YAML text. Uses literal-block
+ * multi-line strings (`|`) where possible for readability.
+ */
+export declare function stringifyConversationalOutline(outline: ConversationalOutline): string;
+/**
+ * Result a specifier or editor worker returns to the workflow after writing
+ * (or skipping) an area's partial.
+ *
+ * - `drafted`: the worker composed and wrote the partial this run.
+ * - `skipped-resume`: a non-empty partial already existed, so the worker left
+ *   it in place (idempotent re-entry — see CTSO-INTEG-2).
+ */
+export declare const PartialResultStatusValues: readonly ["drafted", "skipped-resume"];
+export type PartialResultStatus = (typeof PartialResultStatusValues)[number];
+export declare const PartialResultSchema: z.ZodObject<{
+    area_prefix: z.ZodString;
+    partial_path: z.ZodString;
+    status: z.ZodEnum<["drafted", "skipped-resume"]>;
+    requirement_count: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    status: "drafted" | "skipped-resume";
+    area_prefix: string;
+    partial_path: string;
+    requirement_count?: number | undefined;
+}, {
+    status: "drafted" | "skipped-resume";
+    area_prefix: string;
+    partial_path: string;
+    requirement_count?: number | undefined;
+}>;
+export type PartialResult = z.infer<typeof PartialResultSchema>;
+export declare const PARTIAL_RESULT_JSON_SCHEMA: {
+    readonly type: "object";
+    readonly properties: {
+        readonly area_prefix: {
+            readonly type: "string";
+        };
+        readonly partial_path: {
+            readonly type: "string";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly string[];
+        };
+        readonly requirement_count: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+    };
+    readonly required: readonly ["area_prefix", "partial_path", "status"];
+    readonly additionalProperties: false;
+};
+/**
+ * Verdict a reviewer worker returns to the workflow. Same shape as one
+ * `ConversationalReviewEntry` (discriminated on `result`): `approved` carries
+ * no revisions; `needs-revision` must carry a non-empty `revisions` list. This
+ * verdict drives the per-area convergence loop (CTSO-CONV-4).
+ *
+ * The JSON Schema form is flat (result + optional revisions) — JSON Schema
+ * can't express the discriminated-union constraint as cleanly as Zod. The
+ * runtime retries on mismatch, the prompt instructs the reviewer to include
+ * revisions exactly when the result is needs-revision, and `parseReviewVerdict`
+ * enforces the stricter Zod constraint on the CLI side.
+ */
+export declare const REVIEW_VERDICT_JSON_SCHEMA: {
+    readonly type: "object";
+    readonly properties: {
+        readonly result: {
+            readonly type: "string";
+            readonly enum: readonly ["approved", "needs-revision"];
+        };
+        readonly revisions: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly required: readonly ["result"];
+    readonly additionalProperties: false;
+};
+/**
+ * Parse + validate a specifier/editor worker's JSON result.
+ */
+export declare function parsePartialResult(text: string): PartialResult;
+/**
+ * Parse + validate a reviewer worker's JSON verdict. Reuses
+ * `ConversationalReviewEntrySchema`, so a `needs-revision` verdict requires a
+ * non-empty `revisions` list.
+ */
+export declare function parseReviewVerdict(text: string): ConversationalReviewEntry;
 export declare function parseSpecReview(text: string): SpecReview;
 //# sourceMappingURL=schemas.d.ts.map