wicked-crew-api-types 0.29.0 → 0.30.0

package/index.d.ts

@@ -2710,6 +2710,128 @@ export interface InteractiveDocDeleteResponse {
   ledger: InteractiveDocDeleteLedgerReport;
 }
 
+/** One hand-pinned demo step on a `kind: "demo"` create (api-types 0.30.0): the wizard's ordered
+ *  steps the governed run authors the spec from (ADR-0018: the agent authors, the service records). */
+export interface InteractiveDemoStepDraft {
+  index: number;
+  subject: string;
+  action: string;
+}
+
+/**
+ * The body of `POST /projects/:projectId/interactive/api/docs` as crew's proxy understands it
+ * (acceptance finding F-046; api-types 0.30.0 — the studio types its create from THIS declaration,
+ * no local mirror). The bridge's own fields (`name`, `kind`, `html`, `brief`, `source_paths`,
+ * `url`, `demo_steps`, `style`, `project`, `source_message_id`) are relayed as-is — this type
+ * documents the two things CREW adds at the proxy before forwarding:
+ *
+ *  - `repo_ref` / `repo_refs` — the repository (or repositories) this document is ABOUT, each a
+ *    registered repo id, its registry name, or its root directory's basename. Crew validates them
+ *    against the project's `crew.repo` members BEFORE the bridge sees the request (a miss is the
+ *    400 {@link InteractiveDocCreateRefusal}, nothing created), strips them from the forwarded
+ *    body, and remembers the binding so the governed draft/demo run is grounded on THOSE repos
+ *    (offline snapshot + the project graph) — never on the project's first member. Unfiled
+ *    (`default` mount) documents cannot name a repository.
+ *  - `style` — passed through when given; when ABSENT crew infers it from the brief's format
+ *    words (print-ready / A4 / brochure → `brochure`; slides / deck → `ppt`; memo / whitepaper →
+ *    `doc`) so the bridge's own print instructions apply to a print brief. No format words → the
+ *    bridge's `web` default.
+ */
+export interface InteractiveDocCreateRequest {
+  /** The doc name; the bridge slugifies it (409 when taken or retired). */
+  name?: string;
+  /** Omitted = a plain html doc (`html` required); `source` = generated from brief/sources; `demo` = a recording. */
+  kind?: 'source' | 'demo';
+  /** A plain html doc's content (or a `source` doc's seed). */
+  html?: string;
+  brief?: string;
+  source_paths?: string[];
+  /** `kind: "demo"` — the live app URL to record against. */
+  url?: string;
+  /** `kind: "demo"` — hand-pinned steps; omitted = the run authors them from the brief. */
+  demo_steps?: InteractiveDemoStepDraft[];
+  style?: 'web' | 'ppt' | 'brochure' | 'doc';
+  /** Crew project binding (DES-PROJECT-001 §2.3): registration is the authority. */
+  project?: string;
+  /** The thread message this generation came from (§7.6). */
+  source_message_id?: string;
+  /** ONE subject repository: a repo id, its name, or its root basename. */
+  repo_ref?: string;
+  /** SEVERAL subject repositories (at most 8); the union with `repo_ref`, de-duplicated. */
+  repo_refs?: string[];
+}
+
+/**
+ * The bridge's answer to a successful `POST /projects/:projectId/interactive/api/docs`, relayed
+ * verbatim by crew's proxy (api-types 0.30.0): interactive's `{ name, head, … }` — `generating`
+ * for a `kind: "source"` doc whose first draft a governed run now produces, `learning` for a demo,
+ * `project_id` echoed for a project-bound doc.
+ */
+export interface InteractiveDocCreateResult {
+  name: string;
+  head: number;
+  kind?: 'doc' | 'demo';
+  generating?: boolean;
+  learning?: boolean;
+  project_id?: string;
+}
+
+/**
+ * Crew's 400 on `POST /projects/:projectId/interactive/api/docs` when the request names a
+ * repository the document cannot be grounded on (F-046; api-types 0.30.0). Nothing was created
+ * on the bridge.
+ */
+export interface InteractiveDocCreateRefusal {
+  /** Human-readable, names the fix (attach the repo, pick one of `available`, name it by id, …). */
+  error: string;
+  /**
+   * `repo_not_in_project` — a ref matched no member repo; `unfiled_doc_repo` — a repo named on the
+   * Unfiled mount; `invalid_repo_ref` — junk spelling / shape / over the cap; `ambiguous_repo_ref`
+   * — a name or basename shared by several member repos (name it by id); `project_mismatch` — the
+   * body's `project` is not the route's project (or is present on the Unfiled mount). The proxy
+   * canonicalizes an OMITTED `project` from the route.
+   */
+  code: 'repo_not_in_project' | 'unfiled_doc_repo' | 'invalid_repo_ref' | 'ambiguous_repo_ref' | 'project_mismatch';
+  /** The refs the request named, as spelled (best-effort stringified when malformed). */
+  requested: string[];
+  /** The subset of `requested` that matched no member repo (`repo_not_in_project` only). */
+  missing?: string[];
+  /** `ambiguous_repo_ref`: each ambiguous ref with the member repos it names. */
+  ambiguous?: Array<{ ref: string; candidates: Array<{ id: string; name: string }> }>;
+  /** The project's `crew.repo` members the request could have named. */
+  available?: Array<{ id: string; name: string }>;
+}
+
+/**
+ * The 502 the create earns when the bridge dropped the connection AFTER the request had reached it
+ * (api-types 0.30.0): the document may already exist, so the proxy never replays the POST — list the
+ * project's documents before creating again.
+ */
+export interface InteractiveDocCreateUndetermined {
+  code: 'create_undetermined';
+  error: string;
+}
+
+/**
+ * The payload of `wicked.interactive.status.posted` as crew's own seams emit it (`producer_id:
+ * "wi-crew"`, relayed on `/ws` inside an `interactiveEvent` frame; api-types 0.30.0). Acceptance finding F-045: every
+ * seam emit — status narration, the terminal error/complete lines, and the closing
+ * `draft.completed` / `edit.completed` / `demo.requested` — now carries `project_id` for a
+ * project-bound document (omitted for an Unfiled one), exactly like the bridge's own emits, so a
+ * skin can file the frame under the right thread. A skin should ALSO match frames by
+ * `document_id` alone when the doc is open under exactly one mount (belt and braces).
+ */
+export interface InteractiveStatusPosted {
+  ts: string;
+  document_id: string;
+  /** Present for a project-bound document. */
+  project_id?: string;
+  state: 'processing' | 'working' | 'asking' | 'complete' | 'error';
+  message?: string;
+  /** The edit seam stamps the handoff version it is answering. */
+  version?: number;
+}
+
 /**
  * One row of `GET /projects/:projectId/interactive/api/docs` (crew#472) — the bridge's own
  * `GET /api/docs` row (interactive's `listDocs` shape, relayed field-for-field) stamped with the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wicked-crew-api-types",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "description": "The wire contract of the wicked-crew daemon's /api/v1 REST surface and /ws CoreEvent frames \u2014 types only, zero runtime",
   "type": "module",
   "types": "./index.d.ts",