toolroll 0.9.103 → 0.9.105

package/dist/contracts/trigger-payloads.d.ts

@@ -1,389 +0,0 @@
-/**
- * What a flow trigger reads from outside (flow-triggers.ts): GitHub's issues, pull requests, workflow runs and webhook
- * events, Linear's GraphQL answers and webhook events, a plain webhook's JSON, a mailbox's normalized message and a
- * shared form's fields.
- *
- * These payloads belong to the services that send them, so each schema describes only the fields Toolroll reads and
- * ignores every other key. A field of the wrong type reads as missing (as the hand reader's `text()` and `record()`
- * did), so no delivery or poll is ever refused here: what was accepted before is accepted now, and what a payload
- * lacks is decided after parsing, with the same answer and plain reason as before. Numbers stay as sent (`number`,
- * `webhookTimestamp`) and are coerced with `Number()` after parsing, as they always were; so do the values whose mere
- * presence counts (`pull_request`, `updatedFrom.stateId`).
- */
-import { z } from "zod";
-import type { InboundMail } from "../mailbox.js";
-/** A GitHub issue or pull request, from a poll or inside a webhook event. */
-export declare const githubIssueSchema: z.ZodCatch<z.ZodObject<{
-    number: z.ZodOptional<z.ZodUnknown>;
-    pull_request: z.ZodOptional<z.ZodUnknown>;
-    draft: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
-    labels: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>>>;
-    title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    body: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    author_association: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    user: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        login: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    head: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    base: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    updated_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-}, z.core.$strip>>;
-/** A GitHub Actions workflow run. */
-export declare const githubRunSchema: z.ZodCatch<z.ZodObject<{
-    conclusion: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    head_branch: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    head_sha: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    display_title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    id: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
-    event: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    head_repository: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        full_name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>>;
-/** `repos/:repo/issues` and `repos/:repo/pulls`: a list (anything else reads as an empty one). */
-export declare const githubIssueListSchema: z.ZodCatch<z.ZodArray<z.ZodCatch<z.ZodObject<{
-    number: z.ZodOptional<z.ZodUnknown>;
-    pull_request: z.ZodOptional<z.ZodUnknown>;
-    draft: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
-    labels: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>>>;
-    title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    body: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    author_association: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    user: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        login: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    head: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    base: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    updated_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-}, z.core.$strip>>>>;
-/** `repos/:repo/issues/events`: a list of issue events. */
-export declare const githubIssueEventListSchema: z.ZodCatch<z.ZodArray<z.ZodCatch<z.ZodObject<{
-    event: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    label: z.ZodCatch<z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>>;
-    created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    issue: z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        number: z.ZodOptional<z.ZodUnknown>;
-        pull_request: z.ZodOptional<z.ZodUnknown>;
-        draft: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
-        labels: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-            name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>>;
-        title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        body: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        author_association: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        user: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            login: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        head: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        base: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        updated_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>>>>;
-/** `repos/:repo/actions/runs`. */
-export declare const githubRunListSchema: z.ZodCatch<z.ZodObject<{
-    workflow_runs: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-        conclusion: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        head_branch: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        head_sha: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        display_title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        id: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
-        event: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        head_repository: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            full_name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-    }, z.core.$strip>>>>>;
-}, z.core.$strip>>;
-/** A signed GitHub webhook event (`issues`, `pull_request`, `workflow_run`; a `ping` reads as an empty one). */
-export declare const githubEventSchema: z.ZodCatch<z.ZodObject<{
-    action: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    repository: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        full_name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    label: z.ZodCatch<z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>>;
-    issue: z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        number: z.ZodOptional<z.ZodUnknown>;
-        pull_request: z.ZodOptional<z.ZodUnknown>;
-        draft: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
-        labels: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-            name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>>;
-        title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        body: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        author_association: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        user: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            login: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        head: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        base: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        updated_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    pull_request: z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        number: z.ZodOptional<z.ZodUnknown>;
-        pull_request: z.ZodOptional<z.ZodUnknown>;
-        draft: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
-        labels: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-            name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>>;
-        title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        body: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        author_association: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        user: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            login: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        head: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        base: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            ref: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        updated_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    workflow_run: z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        conclusion: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        head_branch: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        head_sha: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        display_title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        created_at: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        html_url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        id: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
-        event: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        head_repository: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            full_name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>>;
-/** A Linear issue, from the GraphQL query (`labels { nodes }`) or a webhook's `data` (`labels` as a list). */
-export declare const linearIssueSchema: z.ZodCatch<z.ZodObject<{
-    identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    updatedAt: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    state: z.ZodCatch<z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>>;
-    team: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        key: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>;
-    labels: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodCatch<z.ZodObject<{
-        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>, z.ZodObject<{
-        nodes: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-            name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>>;
-    }, z.core.$strip>]>>>;
-}, z.core.$strip>>;
-/** Linear's GraphQL answer to LINEAR_QUERY. */
-export declare const linearAnswerSchema: z.ZodCatch<z.ZodObject<{
-    errors: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-        message: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>>>>;
-    data: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        issues: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            nodes: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-                identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                updatedAt: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                state: z.ZodCatch<z.ZodOptional<z.ZodCatch<z.ZodObject<{
-                    name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                }, z.core.$strip>>>>;
-                team: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-                    key: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                }, z.core.$strip>>>;
-                labels: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodCatch<z.ZodObject<{
-                    name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                }, z.core.$strip>>>, z.ZodObject<{
-                    nodes: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-                        name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-                    }, z.core.$strip>>>>>;
-                }, z.core.$strip>]>>>;
-            }, z.core.$strip>>>>>;
-        }, z.core.$strip>>>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>>;
-/** A signed Linear webhook event. */
-export declare const linearEventSchema: z.ZodCatch<z.ZodObject<{
-    type: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    action: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    webhookTimestamp: z.ZodOptional<z.ZodUnknown>;
-    updatedFrom: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-        stateId: z.ZodOptional<z.ZodUnknown>;
-    }, z.core.$strip>>>;
-    data: z.ZodOptional<z.ZodCatch<z.ZodObject<{
-        identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        title: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        updatedAt: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        state: z.ZodCatch<z.ZodOptional<z.ZodCatch<z.ZodObject<{
-            name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>;
-        team: z.ZodCatch<z.ZodOptional<z.ZodObject<{
-            key: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        labels: z.ZodCatch<z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodCatch<z.ZodObject<{
-            name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>, z.ZodObject<{
-            nodes: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodCatch<z.ZodObject<{
-                name: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-            }, z.core.$strip>>>>>;
-        }, z.core.$strip>]>>>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>>;
-/**
- * A plain webhook's body: any JSON. The trigger's own `titleField` and `bodyField` paths (or title/summary/message and
- * description/body/text) are picked from it after parsing, and a body without one is shown whole, so it is kept as sent.
- */
-export declare const webhookPayloadSchema: z.ZodUnknown;
-/** A message as the mailbox reader hands it on (mailbox.ts normalizes and clips the raw mail before this). */
-export declare const inboundMailSchema: z.ZodObject<{
-    uid: z.ZodNumber;
-    messageId: z.ZodNullable<z.ZodString>;
-    inReplyTo: z.ZodNullable<z.ZodString>;
-    references: z.ZodArray<z.ZodString>;
-    from: z.ZodString;
-    fromName: z.ZodNullable<z.ZodString>;
-    subject: z.ZodString;
-    text: z.ZodString;
-    automatic: z.ZodBoolean;
-}, z.core.$strip>;
-/** A shared form's submission: the first value of each field, as URLSearchParams.get reads it (null when absent). */
-export declare const formSubmissionSchema: z.ZodObject<{
-    t: z.ZodNullable<z.ZodString>;
-    website: z.ZodNullable<z.ZodString>;
-    answers: z.ZodArray<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-export type GithubIssue = z.infer<typeof githubIssueSchema>;
-export type GithubRun = z.infer<typeof githubRunSchema>;
-export type GithubEvent = z.infer<typeof githubEventSchema>;
-export type LinearIssue = z.infer<typeof linearIssueSchema>;
-export type LinearAnswer = z.infer<typeof linearAnswerSchema>;
-export type LinearEvent = z.infer<typeof linearEventSchema>;
-export type FormSubmission = z.infer<typeof formSubmissionSchema>;
-/** Every field a schema reads; none of these readers refuses (a field of the wrong type reads as missing). */
-export declare const readGithubIssue: (raw: unknown) => GithubIssue;
-export declare const readGithubRun: (raw: unknown) => GithubRun;
-export declare const readGithubIssueList: (raw: unknown) => {
-    number?: unknown;
-    pull_request?: unknown;
-    draft?: boolean | undefined;
-    labels?: {
-        name?: string | undefined;
-    }[] | undefined;
-    title?: string | undefined;
-    body?: string | undefined;
-    html_url?: string | undefined;
-    author_association?: string | undefined;
-    user?: {
-        login?: string | undefined;
-    } | undefined;
-    head?: {
-        ref?: string | undefined;
-    } | undefined;
-    base?: {
-        ref?: string | undefined;
-    } | undefined;
-    created_at?: string | undefined;
-    updated_at?: string | undefined;
-}[];
-export declare const readGithubIssueEventList: (raw: unknown) => {
-    event?: string | undefined;
-    label?: {
-        name?: string | undefined;
-    } | undefined;
-    created_at?: string | undefined;
-    issue?: {
-        number?: unknown;
-        pull_request?: unknown;
-        draft?: boolean | undefined;
-        labels?: {
-            name?: string | undefined;
-        }[] | undefined;
-        title?: string | undefined;
-        body?: string | undefined;
-        html_url?: string | undefined;
-        author_association?: string | undefined;
-        user?: {
-            login?: string | undefined;
-        } | undefined;
-        head?: {
-            ref?: string | undefined;
-        } | undefined;
-        base?: {
-            ref?: string | undefined;
-        } | undefined;
-        created_at?: string | undefined;
-        updated_at?: string | undefined;
-    } | undefined;
-}[];
-export declare const readGithubRunList: (raw: unknown) => {
-    workflow_runs?: {
-        conclusion?: string | undefined;
-        head_branch?: string | undefined;
-        head_sha?: string | undefined;
-        name?: string | undefined;
-        display_title?: string | undefined;
-        created_at?: string | undefined;
-        html_url?: string | undefined;
-        id?: number | undefined;
-        event?: string | undefined;
-        head_repository?: {
-            full_name?: string | undefined;
-        } | undefined;
-    }[] | undefined;
-};
-export declare const readGithubEvent: (raw: unknown) => GithubEvent;
-export declare const readLinearIssue: (raw: unknown) => LinearIssue;
-export declare const readLinearAnswer: (raw: unknown) => LinearAnswer;
-export declare const readLinearEvent: (raw: unknown) => LinearEvent;
-export declare const readWebhookPayload: (raw: unknown) => unknown;
-/** A Linear issue's label names, from either shape. */
-export declare function linearLabelNames(issue: LinearIssue): string[];
-/** A message from the mailbox reader. It is the mailbox's own type, so it always reads; one that somehow didn't is
- * used as it came, as before. */
-export declare function readInboundMail(mail: InboundMail): InboundMail;
-/** A shared form's fields: the first value of each, and one answer per question (`a0` …). Strings always read. */
-export declare function readFormSubmission(fields: URLSearchParams, questions: number): FormSubmission;

package/dist/contracts/update-journal.d.ts

@@ -1,254 +0,0 @@
-/**
- * The update journals and their small control records (docs/plans/zod-revamp.md, item 19): the desktop app's update
- * (`desktop-update.json` and the retained `receipt.json`) and `toolroll update`'s (`toolroll-update.json`,
- * `.last.json` and the stage's `update.json`), plus the request, stop, cancel and starting marks beside them.
- *
- * Every journal is Toolroll's own and carries `version: 1`, but the reader ignores keys it does not know: a rollback
- * runs an older Toolroll against a journal a newer one wrote, and every field added since 0.8.0 was added under the
- * same version. A newer version is refused plainly. Readers return the saved object itself once it parses, so a
- * journal saved again keeps its keys, their order and anything a newer release added. Paths, ownership, identities
- * and hashes are checked in plain code by the update modules after parsing, with their existing words.
- */
-import { z } from "zod";
-import { type ContractIssue } from "./contract.js";
-/** What a reader made of a saved journal: the saved object itself, or path-named issues. */
-export type JournalRead<T> = {
-    ok: true;
-    value: T;
-} | {
-    ok: false;
-    issues: ContractIssue[];
-};
-export declare const DESKTOP_UPDATE_PHASES: readonly ["prepared", "draining", "backing-up", "stopping", "installing", "verifying", "rolling-back", "releasing", "complete", "restored", "cancelled", "needs-attention"];
-/** An app bundle as the journal records it (`readDesktopBundle`'s identity). */
-export declare const desktopBundleSchema: z.ZodObject<{
-    path: z.ZodString;
-    hash: z.ZodString;
-    buildId: z.ZodString;
-    version: z.ZodString;
-    bundleId: z.ZodString;
-    schemaVersion: z.ZodNumber;
-    development: z.ZodCatch<z.ZodBoolean>;
-    providerBin: z.ZodString;
-    recoveryProtocol: z.ZodExactOptional<z.ZodNumber>;
-}, z.core.$strip>;
-/** The keys in the order the old reader checked them, so the first issue picks the same refusal it gave. */
-export declare const desktopUpdateJournalSchema: z.ZodObject<{
-    version: z.ZodLiteral<1>;
-    id: z.ZodString;
-    stateDir: z.ZodString;
-    workDir: z.ZodString;
-    label: z.ZodString;
-    intended: z.ZodEnum<{
-        install: "install";
-        restore: "restore";
-    }>;
-    phase: z.ZodEnum<{
-        "backing-up": "backing-up";
-        cancelled: "cancelled";
-        complete: "complete";
-        draining: "draining";
-        installing: "installing";
-        "needs-attention": "needs-attention";
-        prepared: "prepared";
-        releasing: "releasing";
-        restored: "restored";
-        "rolling-back": "rolling-back";
-        stopping: "stopping";
-        verifying: "verifying";
-    }>;
-    old: z.ZodObject<{
-        path: z.ZodString;
-        hash: z.ZodString;
-        buildId: z.ZodString;
-        version: z.ZodString;
-        bundleId: z.ZodString;
-        schemaVersion: z.ZodNumber;
-        development: z.ZodCatch<z.ZodBoolean>;
-        providerBin: z.ZodString;
-        recoveryProtocol: z.ZodExactOptional<z.ZodNumber>;
-    }, z.core.$strip>;
-    next: z.ZodObject<{
-        path: z.ZodString;
-        hash: z.ZodString;
-        buildId: z.ZodString;
-        version: z.ZodString;
-        bundleId: z.ZodString;
-        schemaVersion: z.ZodNumber;
-        development: z.ZodCatch<z.ZodBoolean>;
-        providerBin: z.ZodString;
-        recoveryProtocol: z.ZodExactOptional<z.ZodNumber>;
-    }, z.core.$strip>;
-    databaseFile: z.ZodString;
-    configHash: z.ZodString;
-    wasRunning: z.ZodBoolean;
-    backupHash: z.ZodExactOptional<z.ZodString>;
-    backupPath: z.ZodExactOptional<z.ZodString>;
-    replacementOccurred: z.ZodExactOptional<z.ZodBoolean>;
-    codingCatalogExpected: z.ZodExactOptional<z.ZodBoolean>;
-    stoppedPids: z.ZodExactOptional<z.ZodArray<z.ZodNumber>>;
-    codingBackupPath: z.ZodExactOptional<z.ZodString>;
-    codingBackupHash: z.ZodExactOptional<z.ZodString>;
-    startedAt: z.ZodString;
-    updatedAt: z.ZodString;
-    detail: z.ZodCatch<z.ZodString>;
-    error: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    checkedAt: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    serviceInterrupted: z.ZodExactOptional<z.ZodBoolean>;
-    retryableRecovery: z.ZodExactOptional<z.ZodBoolean>;
-    waiting: z.ZodExactOptional<z.ZodObject<{
-        run: z.ZodNumber;
-        on: z.ZodString;
-        action: z.ZodNullable<z.ZodString>;
-        since: z.ZodString;
-    }, z.core.$strip>>;
-    codingOwnerReleased: z.ZodExactOptional<z.ZodObject<{
-        pid: z.ZodNumber;
-        nativePid: z.ZodNullable<z.ZodNumber>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export type DesktopUpdateJournal = z.infer<typeof desktopUpdateJournalSchema>;
-export type DesktopUpdatePhase = DesktopUpdateJournal["phase"];
-export declare function readDesktopUpdateJournal(input: unknown): JournalRead<DesktopUpdateJournal>;
-/** The automatic-recovery guardian's record (`recovery.json`) as Update status reads it: each field is used only when
- * it has its type, as before; the guardian itself owns the full record. */
-export declare const desktopRecoveryViewSchema: z.ZodObject<{
-    id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    state: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    detail: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    attempts: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
-    repairs: z.ZodCatch<z.ZodOptional<z.ZodNumber>>;
-    updatedAt: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-}, z.core.$strip>;
-export type DesktopRecoveryView = z.infer<typeof desktopRecoveryViewSchema>;
-/** Update status's view of `recovery.json`; anything that is not an object reads as no guardian, as before. */
-export declare function readDesktopRecoveryView(input: unknown): DesktopRecoveryView | null;
-/** `request.json` (a restore) and `stop-request.json`, as `requestUpdateRestore` and `requestUpdateStop` write them. */
-export declare const updateRequestSchema: z.ZodObject<{
-    id: z.ZodExactOptional<z.ZodUnknown>;
-    action: z.ZodExactOptional<z.ZodUnknown>;
-}, z.core.$strip>;
-/** Whether a saved request is `{ id, action }` for this update; anything else is not that request. */
-export declare function updateRequestIs(input: unknown, id: string, action: string): boolean;
-/** The service supervisor's status file, read for the service's process ids before a stop. */
-export declare const supervisorPidsSchema: z.ZodObject<{
-    supervisorPid: z.ZodExactOptional<z.ZodUnknown>;
-    controllerPid: z.ZodExactOptional<z.ZodUnknown>;
-}, z.core.$strip>;
-export declare function supervisorPidsOf(input: unknown): number[];
-export declare const RUNTIME_UPDATE_STEPS: readonly ["verifying", "draining", "backing-up", "rehearsing", "switching", "restarting", "health"];
-export declare const RUNTIME_PHASES: readonly ["scheduled", "verifying", "draining", "backing-up", "rehearsing", "switching", "restarting", "health", "complete", "rolling-back", "restored", "refused", "cancelled", "needs-attention"];
-export declare const runtimeUpdateJournalSchema: z.ZodObject<{
-    version: z.ZodLiteral<1>;
-    id: z.ZodString;
-    stateDir: z.ZodString;
-    stageDir: z.ZodString;
-    kind: z.ZodString;
-    databaseFile: z.ZodString;
-    from: z.ZodObject<{
-        version: z.ZodString;
-        dist: z.ZodString;
-    }, z.core.$strip>;
-    to: z.ZodObject<{
-        version: z.ZodString;
-        dist: z.ZodString;
-    }, z.core.$strip>;
-    when: z.ZodString;
-    at: z.ZodNullable<z.ZodString>;
-    actor: z.ZodCatch<z.ZodString>;
-    phase: z.ZodString;
-    detail: z.ZodCatch<z.ZodString>;
-    error: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    steps: z.ZodArray<z.ZodObject<{
-        phase: z.ZodString;
-        at: z.ZodString;
-    }, z.core.$strip>>;
-    startedAt: z.ZodString;
-    updatedAt: z.ZodString;
-    finishedAt: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-    package: z.ZodExactOptional<z.ZodObject<{
-        sha512: z.ZodString;
-        repository: z.ZodString;
-        workflow: z.ZodString;
-    }, z.core.$strip>>;
-    notes: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodString>>>;
-    backupPath: z.ZodExactOptional<z.ZodString>;
-    backupHash: z.ZodExactOptional<z.ZodString>;
-    codingBackupPath: z.ZodExactOptional<z.ZodString>;
-    codingBackupHash: z.ZodExactOptional<z.ZodString>;
-    restoreFrom: z.ZodExactOptional<z.ZodObject<{
-        path: z.ZodString;
-        hash: z.ZodString;
-        updateId: z.ZodString;
-        codingPath: z.ZodExactOptional<z.ZodString>;
-        codingHash: z.ZodExactOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    rehearsal: z.ZodExactOptional<z.ZodObject<{
-        tables: z.ZodNumber;
-        rows: z.ZodNumber;
-    }, z.core.$strip>>;
-    service: z.ZodExactOptional<z.ZodObject<{
-        unit: z.ZodString;
-        pids: z.ZodArray<z.ZodNumber>;
-    }, z.core.$strip>>;
-    watches: z.ZodExactOptional<z.ZodArray<z.ZodObject<{
-        unit: z.ZodString;
-        pids: z.ZodArray<z.ZodNumber>;
-        loaded: z.ZodExactOptional<z.ZodBoolean>;
-    }, z.core.$strip>>>;
-    switched: z.ZodExactOptional<z.ZodObject<{
-        links: z.ZodArray<z.ZodObject<{
-            path: z.ZodString;
-            previous: z.ZodString;
-        }, z.core.$strip>>;
-        unit: z.ZodNullable<z.ZodObject<{
-            path: z.ZodString;
-            saved: z.ZodString;
-        }, z.core.$strip>>;
-        watches: z.ZodExactOptional<z.ZodArray<z.ZodObject<{
-            path: z.ZodString;
-            saved: z.ZodString;
-        }, z.core.$strip>>>;
-        databaseRestored: z.ZodExactOptional<z.ZodBoolean>;
-    }, z.core.$strip>>;
-    keptAside: z.ZodExactOptional<z.ZodString>;
-    keptAsideUnreadable: z.ZodExactOptional<z.ZodBoolean>;
-    kept: z.ZodExactOptional<z.ZodArray<z.ZodObject<{
-        path: z.ZodString;
-        unreadable: z.ZodBoolean;
-    }, z.core.$strip>>>;
-    restoredDatabase: z.ZodExactOptional<z.ZodBoolean>;
-    codingOwnerReleased: z.ZodExactOptional<z.ZodObject<{
-        pid: z.ZodNumber;
-        nativePid: z.ZodNullable<z.ZodNumber>;
-    }, z.core.$strip>>;
-    seen: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
-    waiting: z.ZodExactOptional<z.ZodObject<{
-        run: z.ZodNumber;
-        on: z.ZodString;
-        action: z.ZodNullable<z.ZodString>;
-        since: z.ZodString;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export type RuntimeUpdateJournalRecord = z.infer<typeof runtimeUpdateJournalSchema>;
-export declare function readRuntimeUpdateJournal(input: unknown): JournalRead<RuntimeUpdateJournalRecord>;
-/** `updater-starting.json`: a launched or resuming updater on its way to `id`. Only `id` and `at` are read. */
-export declare const updaterStartingSchema: z.ZodObject<{
-    id: z.ZodExactOptional<z.ZodUnknown>;
-    state: z.ZodExactOptional<z.ZodUnknown>;
-    at: z.ZodExactOptional<z.ZodUnknown>;
-}, z.core.$strip>;
-/** The mark's update id and start time when it has them; a mark without them is no updater starting, as before. */
-export declare function updaterStartingOf(input: unknown): {
-    id: unknown;
-    at: number;
-} | null;
-/** A staged release's `update.json` as pruning reads it: only `startedAt`, from a partial or older file alike. */
-export declare const stagedReleaseStartSchema: z.ZodObject<{
-    startedAt: z.ZodExactOptional<z.ZodUnknown>;
-}, z.core.$strip>;
-/**
- * When a staged release started, for pruning: `startedAt` as text (`""` when absent or when the file holds some other
- * JSON value). `null` for JSON `null`, and the folder's mtime stands in, as it does for a file that is not JSON.
- */
-export declare function stagedStartedAt(input: unknown): string | null;