@lax-wp/editor 0.4.13 → 0.4.15-beta.0

package/dist/api/effectiveRules.d.ts

@@ -0,0 +1,372 @@
+/**
+ * Resolved-effective rulebook + enforcement modes — `FE_INTEGRATION_R2.md`
+ * §4 and §6.
+ *
+ * `GET /v1/playbooks/effective` answers the panel's real question — "what
+ * actually applies to this document, and why" — WITHOUT running a review. It
+ * runs the same precedence ladder as evaluate (shared code, golden-pinned), so
+ * the preview can't drift from what a run would actually do.
+ *
+ * Enforcement modes are the GitHub-Rulesets dry-run: `evaluate` mode lets
+ * rules report as `would_fire` without ever becoming document redlines.
+ */
+import { z } from "zod";
+import { type CdtsScope } from "./playbook";
+/**
+ * A PlaybookRule as it appears in `effective`. Passthrough: the wire carries
+ * the full rule and the doc only enumerates what FE consumes.
+ */
+export declare const effectiveRuleSchema: z.ZodObject<{
+    id: z.ZodString;
+    playbook_id: z.ZodOptional<z.ZodString>;
+    workspace_id: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    default_severity: z.ZodOptional<z.ZodString>;
+    verbatim_excerpt: z.ZodOptional<z.ZodString>;
+    rationale: z.ZodOptional<z.ZodString>;
+    authority: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    mandatory: z.ZodOptional<z.ZodBoolean>;
+    prime_contract_id: z.ZodOptional<z.ZodString>;
+    prime_section_ref: z.ZodOptional<z.ZodString>;
+    /** §6 evaluate-mode dry run: reports but never becomes a redline. */
+    would_fire: z.ZodOptional<z.ZodBoolean>;
+    merged_from: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    id: z.ZodString;
+    playbook_id: z.ZodOptional<z.ZodString>;
+    workspace_id: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    default_severity: z.ZodOptional<z.ZodString>;
+    verbatim_excerpt: z.ZodOptional<z.ZodString>;
+    rationale: z.ZodOptional<z.ZodString>;
+    authority: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    mandatory: z.ZodOptional<z.ZodBoolean>;
+    prime_contract_id: z.ZodOptional<z.ZodString>;
+    prime_section_ref: z.ZodOptional<z.ZodString>;
+    /** §6 evaluate-mode dry run: reports but never becomes a redline. */
+    would_fire: z.ZodOptional<z.ZodBoolean>;
+    merged_from: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    id: z.ZodString;
+    playbook_id: z.ZodOptional<z.ZodString>;
+    workspace_id: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    default_severity: z.ZodOptional<z.ZodString>;
+    verbatim_excerpt: z.ZodOptional<z.ZodString>;
+    rationale: z.ZodOptional<z.ZodString>;
+    authority: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    mandatory: z.ZodOptional<z.ZodBoolean>;
+    prime_contract_id: z.ZodOptional<z.ZodString>;
+    prime_section_ref: z.ZodOptional<z.ZodString>;
+    /** §6 evaluate-mode dry run: reports but never becomes a redline. */
+    would_fire: z.ZodOptional<z.ZodBoolean>;
+    merged_from: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        playbook_id: z.ZodOptional<z.ZodString>;
+        playbook_scope: z.ZodOptional<z.ZodObject<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            category: z.ZodOptional<z.ZodString>;
+            domain: z.ZodOptional<z.ZodString>;
+            type: z.ZodOptional<z.ZodString>;
+            subtype: z.ZodOptional<z.ZodString>;
+        }, z.ZodTypeAny, "passthrough">>>;
+        rule_id: z.ZodOptional<z.ZodString>;
+        verbatim_excerpt: z.ZodOptional<z.ZodString>;
+        authority: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        prime_contract_id: z.ZodOptional<z.ZodString>;
+        prime_section_ref: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>, "many">>;
+}, z.ZodTypeAny, "passthrough">>;
+export declare const supersededRuleSchema: z.ZodObject<{
+    rule_id: z.ZodString;
+    playbook_id: z.ZodOptional<z.ZodString>;
+    winner_rule_id: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodString>;
+    authority: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    prime_contract_id: z.ZodOptional<z.ZodString>;
+    prime_section_ref: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    rule_id: z.ZodString;
+    playbook_id: z.ZodOptional<z.ZodString>;
+    winner_rule_id: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodString>;
+    authority: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    prime_contract_id: z.ZodOptional<z.ZodString>;
+    prime_section_ref: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    rule_id: z.ZodString;
+    playbook_id: z.ZodOptional<z.ZodString>;
+    winner_rule_id: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodString>;
+    authority: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    prime_contract_id: z.ZodOptional<z.ZodString>;
+    prime_section_ref: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+export type EffectiveRule = z.infer<typeof effectiveRuleSchema>;
+export type SupersededRule = z.infer<typeof supersededRuleSchema>;
+export interface EffectiveRulebook {
+    effective: EffectiveRule[];
+    superseded: SupersededRule[];
+}
+export interface EffectiveRulesOptions {
+    /** Union in this prime's derived playbooks. */
+    primeContractId?: string;
+    /** Explicit derived playbook ids. */
+    derivedPlaybookIds?: readonly string[];
+    /**
+     * CDTS coordinate for the walk. Omit entirely for the workspace's full
+     * playbook union (the broadest view) — that is a deliberate mode, not a
+     * missing-parameter error.
+     */
+    scope?: CdtsScope;
+}
+/**
+ * Read-only; needs no approval role. A foreign workspace/prime is
+ * indistinguishable from nonexistent (404), per the isolation posture.
+ */
+export declare const getEffectiveRules: (options?: EffectiveRulesOptions) => Promise<EffectiveRulebook>;
+/**
+ * - `active`   — enforced (also the unset default).
+ * - `evaluate` — dry run: rules report as `would_fire`, never become redlines.
+ * - `disabled` — the playbook vanishes from every selection; rules and
+ *                approvals survive, so re-enabling restores it.
+ */
+export type EnforcementMode = "active" | "evaluate" | "disabled";
+/**
+ * The mode the backend currently has stored — a kill-switch nobody can read is
+ * a kill-switch nobody can trust.
+ *
+ * There is NO endpoint that reports it directly: the derived-rulebook status
+ * DTO (`…/derived/{prime}/status`) drops the header's `mode` column, so the
+ * only readable copy is the SERVING playbook the activation projection writes
+ * (`store.projectRulebook` stamps `Mode` onto `derived:{prime}`). That
+ * projection exists only once the rulebook is ACTIVE, so a draft rulebook
+ * answers 404 — which means "not projected yet", NOT "active". The three
+ * results are distinguished by the caller; collapsing the third into `active`
+ * would assert enforcement is on when nobody knows.
+ */
+export type EnforcementModeRead = {
+    known: true;
+    mode: EnforcementMode;
+}
+/** No serving projection yet (rulebook not active) — the stored mode is unreadable. */
+ | {
+    known: false;
+    reason: "not_projected";
+};
+export declare const getDerivedEnforcementMode: (prime: string) => Promise<EnforcementModeRead>;
+/**
+ * Approval-role gated. Persists across restarts and applies immediately — no
+ * re-approval, no restart.
+ */
+export declare const setDerivedEnforcementMode: (prime: string, mode: EnforcementMode) => Promise<{
+    primeContractId: string;
+    mode: string;
+}>;

package/dist/api/methodology.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Review-methodology API module — `GET /v1/skill/methodology`.
+ *
+ * The backend serves the contract-review methodology prompt VERBATIM as
+ * `text/markdown; charset=utf-8` (internal/playbook-engine/api/methodology.go)
+ * — deliberately NOT JSON-wrapped, so every consumer gets it unescaped. It is
+ * read-only and workspace-independent: the methodology ships with the binary
+ * and is identical for every tenant.
+ *
+ * It cannot ride `request()` from ./playbook, which JSON.parses every body and
+ * would reject markdown as a parse error. Hence the small fetch core below —
+ * the same shape redlines.ts / redlineStream.ts each carry.
+ *
+ * Base URL: this is a playbook-engine route, so it defaults to
+ * VITE_LAX_AI_PLAYBOOK_URL. A host that calls `configurePlaybookApi({baseUrl})`
+ * at runtime should also call `configureMethodologyApi({baseUrl})` — the
+ * playbook module's resolved config is module-private and cannot be read here.
+ */
+export interface MethodologyApiConfig {
+    baseUrl?: string;
+    workspaceId?: string;
+    getAuthToken?: () => string | undefined | Promise<string | undefined>;
+}
+/** Configure once from the consumer (App.tsx / lax-web-portal). */
+export declare const configureMethodologyApi: (next: MethodologyApiConfig) => void;
+export declare class MethodologyApiError extends Error {
+    readonly status?: number;
+    constructor(message: string, status?: number);
+}
+/** The methodology prompt, as markdown source. */
+export declare const getMethodology: (opts?: {
+    signal?: AbortSignal;
+}) => Promise<string>;
+/**
+ * One ATX-heading-delimited section of the methodology.
+ *
+ * The document is ~10KB of prose. A reviewer asking "why was this flagged?"
+ * wants the paragraph that governs their case, not the whole prompt — so the
+ * panel navigates by section. Parsing here (rather than pulling in a markdown
+ * renderer) keeps the package's zero-new-dependency posture; `react-markdown`
+ * is only a PEER dependency of this package and is used nowhere in src/.
+ */
+export interface MethodologySection {
+    /** Heading depth: 1 for `#`, 2 for `##`, ... */
+    level: number;
+    title: string;
+    /** Body text under the heading, excluding the heading line itself. */
+    body: string;
+}
+/**
+ * Split markdown into sections at ATX headings. Content before the first
+ * heading (HTML comments, license banners) is dropped — it is provenance, not
+ * methodology. Fenced code blocks are respected so a `#` comment inside one
+ * cannot fake a heading.
+ */
+export declare const parseMethodologySections: (markdown: string) => MethodologySection[];
+/**
+ * Sections whose title or body mentions every term in the query
+ * (case-insensitive). Empty query returns everything, so the panel can use one
+ * code path for "browse" and "search".
+ */
+export declare const filterMethodologySections: (sections: MethodologySection[], query: string) => MethodologySection[];