verdifax 1.4.0 → 1.5.0

package/dist/index.d.ts

@@ -881,6 +881,173 @@ interface ApproverRevocation {
     id: number;
     revoked: boolean;
 }
+/** The kind of a control signal. Each is also a CloudEvents type,
+ *  `com.verdifax.` and the kind. */
+type SignalKind = "run.refused" | "run.halted" | "run.failed" | "policy.changed" | "signoff.recorded" | "approver.registered" | "approver.revoked" | "key.created" | "key.revoked";
+/** The Verdifax event inside a {@link SignalEvent}, verdifax.signal.v1. */
+interface SignalEventData {
+    /** `verdifax.signal.v1`. */
+    form: string;
+    kind: SignalKind | (string & {});
+    /** The account, `account-N`. */
+    account: string;
+    /** The event's place in the account's feed, from 1. */
+    sequence: number;
+    /** The previous event's `event_hash`, or 64 zeros for the account's
+     *  first event. */
+    previous_signal_hash: Hex64;
+    /** {@link signalEventHash} of the kind, the entry's hash and the place. */
+    event_hash: Hex64;
+    run_id?: number;
+    api_key_id?: number;
+    /** A short reason a reader can route on, for a refused, halted or
+     *  failed run. */
+    reason?: string;
+    /** The sealed entry the event names, in the exact form
+     *  `verdifax-verify` reads. */
+    entry: Record<string, unknown>;
+}
+/** One control signal, as a CloudEvents 1.0 envelope. */
+interface SignalEvent {
+    specversion: string;
+    /** `account-N/SEQUENCE`. */
+    id: string;
+    source: string;
+    /** `com.verdifax.` and the kind. */
+    type: string;
+    time: string;
+    datacontenttype: string;
+    data: SignalEventData;
+}
+/** One page of the feed. Returned by {@link VerdifaxClient.getSignals}. */
+interface SignalPage {
+    /** The events after the place asked for, oldest first. */
+    events: SignalEvent[];
+    /** The place to read from next: the last event's sequence, or the
+     *  place asked for when the page is empty. */
+    next_after: number;
+    /** The newest sequence in the account's feed, 0 when it is empty. */
+    newest: number;
+}
+/** Options for {@link VerdifaxClient.getSignals}. */
+interface GetSignalsOptions {
+    /** The last sequence already read. 0, the default, reads from the start. */
+    after?: number;
+    /** 1 to 500 events. The server's default is 100. */
+    limit?: number;
+    /** 0 to 25 seconds to hold the request open when there is no event yet.
+     *  Defaults to 0. */
+    wait?: number;
+    /** Read GET /account/signals with the owner key instead of GET /signals
+     *  with a feed key. */
+    asOwner?: boolean;
+}
+/** Options for {@link VerdifaxClient.followSignals}. */
+interface FollowSignalsOptions {
+    /** The last sequence already read. 0, the default, reads from the start. */
+    after?: number;
+    /** 0 to 25 seconds each read waits for the next event. Defaults to 25. */
+    wait?: number;
+    /** Read GET /account/signals with the owner key instead of GET /signals
+     *  with a feed key. */
+    asOwner?: boolean;
+}
+/** Options for {@link VerdifaxClient.createFeedKey}. */
+interface CreateFeedKeyOptions {
+    /** RFC 3339 or YYYY-MM-DD. */
+    expiresAt?: string;
+}
+/** A new feed key with its secret, which is shown this once. A feed key
+ *  reads the account's signal feed and nothing else. Returned by
+ *  {@link VerdifaxClient.createFeedKey}. */
+type CreatedFeedKey = CreatedAccountKey;
+/** Returned by {@link VerdifaxClient.revokeFeedKey}. */
+interface FeedKeyRevocation {
+    ok: boolean;
+    id: number;
+    revoked: boolean;
+}
+/** Options for {@link VerdifaxClient.createWebhook}. */
+interface CreateWebhookOptions {
+    /** The kinds to deliver, each once. Empty or left out takes every kind. */
+    types?: SignalKind[];
+}
+/** A webhook subscription, without its secret. */
+interface Webhook {
+    id: number;
+    url: string;
+    /** The kinds it delivers. Empty means every kind. */
+    types: SignalKind[];
+    created_at: string;
+}
+/** A new webhook subscription with its secret, `whsec_` and base64,
+ *  which is shown this once. Check each delivery with it using
+ *  {@link verifyWebhook}. Returned by {@link VerdifaxClient.createWebhook}. */
+interface CreatedWebhook extends Webhook {
+    ok: boolean;
+    secret: string;
+    hint: string;
+}
+/** Returned by {@link VerdifaxClient.listWebhooks}. */
+interface WebhookList {
+    ok: boolean;
+    webhooks: Webhook[];
+}
+/** Returned by {@link VerdifaxClient.deleteWebhook}. */
+interface WebhookDeletion {
+    ok: boolean;
+    id: number;
+    deleted: boolean;
+}
+/** Options for {@link VerdifaxClient.listWebhookDeliveries}. */
+interface ListWebhookDeliveriesOptions {
+    /** 1 to 500 deliveries. The server's default is 50. */
+    limit?: number;
+}
+/** One delivery of one event to a webhook. A delivery is a copy: the pull
+ *  feed and the public log are the record. */
+interface WebhookDelivery {
+    /** The event's place in the account's feed. */
+    sequence: number;
+    /** `pending`, `delivered` or `failed`. */
+    status: string;
+    attempts: number;
+    last_status_code: number;
+    last_error: string;
+    created_at: string;
+    delivered_at?: string;
+    next_attempt_at?: string;
+}
+/** Returned by {@link VerdifaxClient.listWebhookDeliveries}: the newest
+ *  deliveries first. */
+interface WebhookDeliveryList {
+    ok: boolean;
+    webhook_id: number;
+    deliveries: WebhookDelivery[];
+}
+/** The headers of a webhook delivery: a fetch `Headers`, or an object such
+ *  as Node's `req.headers`. Names are read without regard to case. */
+type WebhookHeaders = {
+    get(name: string): string | null;
+} | Record<string, string | string[] | undefined>;
+/** Options for {@link verifyWebhook}. */
+interface VerifyWebhookOptions {
+    /** How far, in seconds, `webhook-timestamp` may be from `now` in either
+     *  direction. Defaults to 300. */
+    toleranceSeconds?: number;
+    /** The time to check the timestamp against. Defaults to the current
+     *  time. */
+    now?: Date;
+}
+/** An event's place in its account's feed, for {@link signalEventHash}. */
+interface SignalEventHashFields {
+    /** The account, `account-N`. */
+    account: string;
+    /** The event's sequence, a whole number. */
+    sequence: number;
+    /** The previous event's hash, or 64 zeros for the account's first. */
+    previousSignalHash: string;
+}
 
 /**
  * The job helper: runs the steps of one job and keeps the map of step ids
@@ -1002,6 +1169,15 @@ declare const MAX_BATCH_ROWS = 1000;
  * | `getNewestSignOff(options)` | GET /signoffs/newest, or GET /account/signoffs/newest with asOwner | required |
  * | `getSignOffs(runId, options)` | GET /runs/{id}/signoffs, or GET /account/runs/{id}/signoffs with asOwner | required |
  * | `getSignOffHistory()` | GET /account/signoffs/history | owner key |
+ * | `getSignals(options)` | GET /signals, or GET /account/signals with asOwner | feed key, or owner key |
+ * | `followSignals(options)` | GET /signals page after page, or GET /account/signals with asOwner | feed key, or owner key |
+ * | `createFeedKey(name, options)` | POST /account/feed-keys | owner key |
+ * | `revokeFeedKey(id)` | DELETE /account/feed-keys/{id} | owner key |
+ * | `createWebhook(url, options)` | POST /account/webhooks | owner key |
+ * | `listWebhooks()` | GET /account/webhooks | owner key |
+ * | `deleteWebhook(id)` | DELETE /account/webhooks/{id} | owner key |
+ * | `listWebhookDeliveries(id, options)` | GET /account/webhooks/{id}/deliveries | owner key |
+ * | `getFailureReceipt(id)` | GET /runs/{id}/failure-receipt | required |
  * | `job(jobId)` | none, returns a {@link VerdifaxJob} | none |
  *
  * With the `signingKey` option set, every path to POST /execute carries
@@ -1220,6 +1396,44 @@ declare class VerdifaxClient {
     /** The account's whole chain of sign-offs, oldest first, in the form
      *  `verdifax-verify --signoff-history FILE` reads. Needs the owner key. */
     getSignOffHistory(): Promise<SignOffRecord[]>;
+    /** One page of the account's feed: the events after `after`, oldest
+     *  first, with `next_after` to read from next. With `wait` the server
+     *  holds the request open up to that many seconds for the next event, and
+     *  this call's timeout is at least the wait plus 30 seconds. With
+     *  `asOwner` it reads GET /account/signals with the owner key. Bad
+     *  options are refused before sending. Save the events and check them
+     *  with `verdifax-verify --signals`. */
+    getSignals(options?: GetSignalsOptions): Promise<SignalPage>;
+    /** Follows the feed from `after`, yielding each event once, in order,
+     *  until you stop with `break` or `return`. Each read starts at the page
+     *  before's `next_after`, waits up to `wait` seconds (default 25) when
+     *  there is no event, and is retried like any GET. A read that still
+     *  fails throws {@link SignalFeedError}, whose `lastSequence` is the last
+     *  sequence yielded: follow again from there and nothing is lost. Bad
+     *  options are refused here, before anything is sent. */
+    followSignals(options?: FollowSignalsOptions): AsyncGenerator<SignalEvent, void, undefined>;
+    /** Creates a feed key in the owner's account. A feed key reads the
+     *  account's signal feed, with {@link getSignals} and
+     *  {@link followSignals}, and nothing else. The secret is in the result
+     *  this once. */
+    createFeedKey(name: string, options?: CreateFeedKeyOptions): Promise<CreatedFeedKey>;
+    /** Revokes one of the account's feed keys. An id that is not a feed key
+     *  of the account throws {@link NotFoundError}. */
+    revokeFeedKey(id: number): Promise<FeedKeyRevocation>;
+    /** Subscribes an https address to the account's signals. `types` are the
+     *  kinds to deliver, each once; empty or left out takes every kind. The
+     *  secret, `whsec_` and base64, is in the result this once: check each
+     *  delivery with {@link verifyWebhook}. A delivery is a copy: the pull
+     *  feed and the public log are the record. The server checks the address
+     *  too, and refuses an eleventh subscription with HTTP 409. */
+    createWebhook(url: string, options?: CreateWebhookOptions): Promise<CreatedWebhook>;
+    /** The account's webhook subscriptions, without their secrets. */
+    listWebhooks(): Promise<WebhookList>;
+    /** Ends a webhook subscription. Its events stay in the pull feed. */
+    deleteWebhook(id: number): Promise<WebhookDeletion>;
+    /** A webhook's newest deliveries first, up to `limit` (1 to 500; the
+     *  server's default is 50). */
+    listWebhookDeliveries(id: number, options?: ListWebhookDeliveriesOptions): Promise<WebhookDeliveryList>;
     getRun(runId: number): Promise<Run>;
     verifyRun(runId: number): Promise<VerifyResponse>;
     listRuns(params?: ListRunsParams): Promise<{
@@ -1256,6 +1470,10 @@ declare class VerdifaxClient {
     getAivpT4HaltReceipt(runId: number): Promise<Record<string, unknown>>;
     getAttestationGapReceipt(runId: number): Promise<Record<string, unknown>>;
     getCESAuditRecord(runId: number): Promise<Record<string, unknown>>;
+    /** A failed run's sealed failure receipt, in the form `verdifax-verify`
+     *  reads. A run that failed before failure receipts were sealed has none
+     *  and throws {@link NotFoundError}. */
+    getFailureReceipt(runId: number): Promise<Record<string, unknown>>;
     /** The audit report for a run, as JSON. */
     getRunReport(runId: number): Promise<Record<string, unknown>>;
     /** The run's sealed audit bundle as the exact JSON text the server
@@ -1556,6 +1774,48 @@ declare function signOffPreimage(fields: {
  *  never holds the approver's private key. */
 declare function approverKeyProof(approverKey: Uint8Array | KeyObject): ApproverKeyProof;
 
+/**
+ * The signal feed: every control signal Verdifax recorded for an account,
+ * in order, each with its sealed entry. The feed cannot show a signal
+ * Verdifax never recorded.
+ *
+ * A feed key reads the feed and nothing else. The owner key reads the same
+ * feed on its /account route and manages feed keys and webhooks. A webhook
+ * delivery is a copy: the pull feed and the public log are the record.
+ *
+ * The request building, the checks made before sending, the follow loop,
+ * webhook verification and the event hash live here; the client's methods
+ * are thin wrappers over them.
+ */
+
+/**
+ * Checks one webhook delivery under the Standard Webhooks scheme and
+ * returns its CloudEvent. Pass the headers as received, the body as the
+ * exact bytes received (a Buffer, a Uint8Array or a string, never parsed
+ * JSON) and the subscription's `whsec_` secret.
+ *
+ * The signed content is `webhook-id`, a dot, `webhook-timestamp`, a dot and
+ * the body. `webhook-signature` is a space-separated list of `v1,<base64>`
+ * entries, and any one may match; each is compared in constant time. A
+ * timestamp more than `toleranceSeconds` (default 300) from `now` in either
+ * direction is refused. Header names are read without regard to case. The
+ * body must be a JSON object whose top-level `id` is a string equal to
+ * `webhook-id`.
+ *
+ * Throws {@link VerdifaxError} naming the check that failed. The secret is
+ * never placed in an error message. A delivery is a copy: the pull feed and
+ * the public log are the record.
+ */
+declare function verifyWebhook(headers: WebhookHeaders, body: Uint8Array | string, secret: string, options?: VerifyWebhookOptions): SignalEvent;
+/**
+ * The hash the next event in an account's feed names, matching the
+ * orchestrator's SignalEventHash: hex SHA-256 of `verdifax.signal.v1`, the
+ * kind, the hash of the event's entry, the account, the decimal sequence
+ * and the previous event's hash, joined by single zero bytes. It makes no
+ * request.
+ */
+declare function signalEventHash(kind: string, entryHash: string, fields: SignalEventHashFields): string;
+
 /**
  * Input-validation helpers, mirrors the Python SDK's
  * `_validation.py` and the Go SDK's `validation.go` for
@@ -1639,5 +1899,17 @@ declare class APIKeyRequiredError extends VerdifaxError {
     readonly name: string;
     constructor();
 }
+/** Thrown by {@link VerdifaxClient.followSignals} when a read fails or a
+ *  page does not follow on from the last one. `lastSequence` is the last
+ *  sequence the generator handed out, so the feed is never lost: follow
+ *  again with `after: lastSequence`. The error the read threw, after the
+ *  client's normal retries, is `cause`. */
+declare class SignalFeedError extends VerdifaxError {
+    readonly lastSequence: number;
+    readonly name: string;
+    constructor(lastSequence: number, reason: string, options?: {
+        cause?: unknown;
+    });
+}
 
-export { APIError, APIKeyRequiredError, type Account, type AccountInfo, type AccountKey, type AccountKeyList, type AccountKeyRevocation, type AccountRunsExport, type AdminAPIKey, type AdminCreateAccountOptions, type AdminCreateAccountResponse, type AdminCreateKeyOptions, type AdminCreateKeyResponse, type AdminEraseRequest, type Approver, type ApproverKeyProof, type ApproverList, type ApproverRegistration, type ApproverRevocation, type AsOwnerOptions, type AttestRequest, type AttestationList, AuthError, CRES_ENGINE_VERSION, CRES_PREIMAGE_VERSION, type ClientConfig, type CreateAccountKeyOptions, type CreatedAccountKey, type DCAEProofBundle, type DCAEVerdict, DCAE_PREIMAGE_VERSION, DSE_FORMULA_VERSION, type DeletionReceipt, type DeterminismDiff, type DeterminismRun, EXECUTE_FIELDS, type ExecuteBatchResponse, type ExecuteBatchResult, type ExecuteRequest, type ExecuteResponse, type ExecutionManifest, type ExportRow, type ExportRunsParams, type FormulaEra, type Health, type Hex64, type JobLink, type JobStepOptions, type KeyTier, type ListAttestationsParams, type ListRunsParams, MAX_BATCH_ROWS, type NewestSignOff, NotFoundError, type PDFFormat, type Policy, type PolicyActivation, type PolicyActivationSignature, type PolicyActorType, type PolicyClassification, type PolicyContext, type PolicyList, type PolicyObjectType, type PolicyTestRequest, type PolicyTestResult, type PolicyWithDocument, RUN_STATUSES, type ReproducibilityContext, type RequestKeyChange, type RequestKeyPair, type RequestKeyRegistration, type RequestKeyRegistrationBody, type RequestSignature, type RequestSignatureV2, type Run, type RunStats, type RunStatus, type RunSummary, type RunsExport, type RunsExportCSV, type SearchRunsParams, type SignOffDecision, type SignOffOptions, type SignOffRecord, type SignOffSignature, type SignOffTarget, type SignOffTargetKind, type SignedRequestBody, VerdifaxClient, VerdifaxError, VerdifaxJob, type VerdifaxVersion, type VerifyDeterminismResponse, type VerifyResponse, approverKeyProof, captureEnvironment, cresReceiptHash, dcaeClosureHash, dseDispatchHash, formatProviderPayload, fromEnv, generateRequestKeyPair, policyActivationApproval, policyActivationPreimage, requestKeyChangeApproval, requestKeyChangePreimage, requestKeyRegistrationBody, requestSignaturePreimage, requestSignaturePreimageV2, signOffPreimage, signRequest, signRequestV2, validateHex64, validateJobName, validateRouteId };
+export { APIError, APIKeyRequiredError, type Account, type AccountInfo, type AccountKey, type AccountKeyList, type AccountKeyRevocation, type AccountRunsExport, type AdminAPIKey, type AdminCreateAccountOptions, type AdminCreateAccountResponse, type AdminCreateKeyOptions, type AdminCreateKeyResponse, type AdminEraseRequest, type Approver, type ApproverKeyProof, type ApproverList, type ApproverRegistration, type ApproverRevocation, type AsOwnerOptions, type AttestRequest, type AttestationList, AuthError, CRES_ENGINE_VERSION, CRES_PREIMAGE_VERSION, type ClientConfig, type CreateAccountKeyOptions, type CreateFeedKeyOptions, type CreateWebhookOptions, type CreatedAccountKey, type CreatedFeedKey, type CreatedWebhook, type DCAEProofBundle, type DCAEVerdict, DCAE_PREIMAGE_VERSION, DSE_FORMULA_VERSION, type DeletionReceipt, type DeterminismDiff, type DeterminismRun, EXECUTE_FIELDS, type ExecuteBatchResponse, type ExecuteBatchResult, type ExecuteRequest, type ExecuteResponse, type ExecutionManifest, type ExportRow, type ExportRunsParams, type FeedKeyRevocation, type FollowSignalsOptions, type FormulaEra, type GetSignalsOptions, type Health, type Hex64, type JobLink, type JobStepOptions, type KeyTier, type ListAttestationsParams, type ListRunsParams, type ListWebhookDeliveriesOptions, MAX_BATCH_ROWS, type NewestSignOff, NotFoundError, type PDFFormat, type Policy, type PolicyActivation, type PolicyActivationSignature, type PolicyActorType, type PolicyClassification, type PolicyContext, type PolicyList, type PolicyObjectType, type PolicyTestRequest, type PolicyTestResult, type PolicyWithDocument, RUN_STATUSES, type ReproducibilityContext, type RequestKeyChange, type RequestKeyPair, type RequestKeyRegistration, type RequestKeyRegistrationBody, type RequestSignature, type RequestSignatureV2, type Run, type RunStats, type RunStatus, type RunSummary, type RunsExport, type RunsExportCSV, type SearchRunsParams, type SignOffDecision, type SignOffOptions, type SignOffRecord, type SignOffSignature, type SignOffTarget, type SignOffTargetKind, type SignalEvent, type SignalEventData, type SignalEventHashFields, SignalFeedError, type SignalKind, type SignalPage, type SignedRequestBody, VerdifaxClient, VerdifaxError, VerdifaxJob, type VerdifaxVersion, type VerifyDeterminismResponse, type VerifyResponse, type VerifyWebhookOptions, type Webhook, type WebhookDeletion, type WebhookDelivery, type WebhookDeliveryList, type WebhookHeaders, type WebhookList, approverKeyProof, captureEnvironment, cresReceiptHash, dcaeClosureHash, dseDispatchHash, formatProviderPayload, fromEnv, generateRequestKeyPair, policyActivationApproval, policyActivationPreimage, requestKeyChangeApproval, requestKeyChangePreimage, requestKeyRegistrationBody, requestSignaturePreimage, requestSignaturePreimageV2, signOffPreimage, signRequest, signRequestV2, signalEventHash, validateHex64, validateJobName, validateRouteId, verifyWebhook };