better-supabase 0.12.0 → 0.14.0

package/dist/blocks/shared-signals/index.d.ts

@@ -1,14 +1,14 @@
 /// <reference lib="esnext.temporal" />
-import { t as AsyncResult } from "../../result-BREt7qOh.js";
-import { wt as Events } from "../../events-P3raDX2E.js";
+import { t as AsyncResult } from "../../result-C6jDfedy.js";
+import { Ct as Events } from "../../events-DbLjvxDX.js";
 import { n as Logger } from "../../logger-DWVYUmwi.js";
-import { s as sqlTransport, t as BlockTransport } from "../../block-transport-DezJPPA0.js";
-import { n as BlockOptions } from "../../block-helpers-CjcQM1yA.js";
-import { n as BlockHooks } from "../../block-hooks-DcPJHztl.js";
-import { n as VaultCredentials } from "../../vault-ClkzMGTP.js";
-import { s as BlockOf } from "../../define-block-BHxLHLys.js";
-import { n as Jwks } from "../../jws-35a8VhFV.js";
-import { o as Signer } from "../../signing-keys-v2MRYkDF.js";
+import { n as BlockOptions } from "../../block-helpers-BaugZlJV.js";
+import { s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { n as BlockHooks } from "../../block-hooks-CmjPKqQ_.js";
+import { n as VaultCredentials } from "../../vault-BQTdu4eH.js";
+import { c as BlockOf } from "../../define-block-COpcS6aT.js";
+import { n as Jwks } from "../../jws-D0toeQlA.js";
+import { o as Signer } from "../../signing-keys-B3RHGMMu.js";
 //#region src/blocks/shared-signals/set.d.ts
 /** The `typ` header of a Security Event Token (RFC 8417 §2.3). */
 export declare const SET_TYP = "secevent+jwt";
@@ -47,9 +47,9 @@ export declare const RISC_EVENTS: {
   readonly recoveryInformationChanged: "https://schemas.openid.net/secevent/risc/event-type/recovery-information-changed";
 };
 /**
- * An SSF subject identifier (RFC 9493 and SSF §3): `{ format: "email",
- * email }`, `{ format: "iss_sub", iss, sub }`, `{ format: "opaque", id }`,
- * or a complex subject with `user`, `session`, `tenant` and other members.
+ * An SSF subject identifier (RFC 9493 and SSF §3): `{ format: "email", email
+ * }`, `{ format: "iss_sub", iss, sub }`, `{ format: "opaque", id }`, or a
+ * complex subject with `user`, `session`, `tenant` and other members.
  */
 type SubjectIdentifier = {
   readonly format: string;
@@ -112,25 +112,37 @@ interface VerifySetOptions {
   readonly understoodSubjectMembers?: readonly string[];
 }
 /**
- * Verifies a SET as an RFC 8935 receiver: the signature against `jwks`,
- * `typ`, `iss`, `aud`, `jti`, `iat`, one event and an SSF `sub_id`. A
- * failure carries the error code to answer the transmitter with.
+ * Verifies a SET as an RFC 8935 receiver: the signature against `jwks`, `typ`,
+ * `iss`, `aud`, `jti`, `iat`, one event and an SSF `sub_id`. A failure carries
+ * the error code to answer the transmitter with.
  */
 export declare function verifySet(token: string, options: VerifySetOptions): Promise<SetVerification>;
 //#endregion
 //#region src/blocks/shared-signals/receiver.d.ts
-/** Handles one event type; a throw leaves the SET unprocessed, so the transmitter sends it again. */
+/**
+ * Handles one event type; a throw leaves the SET unprocessed, so the
+ * transmitter sends it again.
+ */
 type SsfEventHandler = (set: VerifiedSet) => void | Promise<void>;
 interface SsfReceiverOptions extends BlockOptions {
-  /** The transmitter's issuer, compared exactly with its metadata and each `iss`. */
+  /**
+   * The transmitter's issuer, compared exactly with its metadata and each
+   * `iss`.
+   */
   readonly issuer: string;
   /** This receiver's `aud`. */
   readonly audience: string;
   /** The transmitter's keys. Default: its metadata's `jwks_uri`, cached. */
   readonly jwks?: Jwks | (() => Promise<Jwks>);
-  /** Handlers by event type URI; `"*"` takes the rest. Unhandled events are acknowledged. */
+  /**
+   * Handlers by event type URI; `"*"` takes the rest. Unhandled events are
+   * acknowledged.
+   */
   readonly handlers?: Readonly<Record<string, SsfEventHandler>>;
-  /** The `Authorization` header value the transmitter pushes with; checked when set. */
+  /**
+   * The `Authorization` header value the transmitter pushes with; checked when
+   * set.
+   */
   readonly authorization?: string;
   /** The transmitter's `critical_subject_members`. */
   readonly criticalSubjectMembers?: readonly string[];
@@ -139,7 +151,10 @@ interface SsfReceiverOptions extends BlockOptions {
   /** The largest pushed SET, in bytes. Default: 64 KiB. */
   readonly maxBodyBytes?: number;
   readonly fetch?: typeof fetch;
-  /** Receives handler errors and the errors `after` hooks throw. Default: `consoleLogger`. */
+  /**
+   * Receives handler errors and the errors `after` hooks throw. Default:
+   * `consoleLogger`.
+   */
   readonly logger?: Logger;
   /** `withBlockHooks` hooks around the receiver's methods. */
   readonly hooks?: NoInfer<BlockHooks<SsfReceiver>>;
@@ -197,7 +212,10 @@ interface SsfReceiver {
   receive(token: string): Promise<SsfReceiveResult>;
   /** The RFC 8935 push endpoint: 202, or 400 with `{ err, description }`. */
   pushHandler(): (request: Request) => Promise<Response>;
-  /** RFC 8936: polls until no more SETs are available, acknowledging what it processed. */
+  /**
+   * RFC 8936: polls until no more SETs are available, acknowledging what it
+   * processed.
+   */
   poll(options: SsfPollOptions): AsyncResult<SsfPollResult>;
   /** The management API with this `Authorization` header value. */
   streams(authorization: string): SsfStreamClient;
@@ -205,9 +223,9 @@ interface SsfReceiver {
   purge(olderThan?: Temporal.Duration): AsyncResult<number>;
 }
 /**
- * An SSF receiver: verifies pushed or polled SETs with the transmitter's
- * keys, drops replays through the `shared-signals` module's `(iss, jti)`
- * table, and calls the handler for the event type. Service role only.
+ * An SSF receiver: verifies pushed or polled SETs with the transmitter's keys,
+ * drops replays through the `shared-signals` module's `(iss, jti)` table, and
+ * calls the handler for the event type. Service role only.
  */
 export declare function createSsfReceiver(options: SsfReceiverOptions): SsfReceiver;
 //#endregion
@@ -236,7 +254,10 @@ interface SsfStream {
 interface SsfReceiverIdentity {
   /** A stable id, such as the OAuth client id. */
   readonly receiver: string;
-  /** Scopes the receiver's streams to one tenant's events; `null` for every tenant. */
+  /**
+   * Scopes the receiver's streams to one tenant's events; `null` for every
+   * tenant.
+   */
   readonly tenant?: string | null;
   /** The `aud` of its SETs. Default: `receiver`. */
   readonly audience?: string | readonly string[];
@@ -273,13 +294,16 @@ interface EmitResult {
 interface SsfTransmitterOptions extends BlockOptions {
   /** The transmitter's issuer: an https URL, the `iss` of every SET. */
   readonly issuer: string;
-  /** Where the signer's public keys are published, e.g. `signingKeys.jwksResponse`. */
+  /**
+   * Where the signer's public keys are published, e.g.
+   * `signingKeys.jwksResponse`.
+   */
   readonly jwksUri: string;
   /** Signs the SETs: `signingKeys.signer({ type: "ssf", id: "transmitter" })`. */
   readonly signer: SetSigner;
   /**
-   * Authenticates a management or poll request and names its receiver;
-   * `null` answers 401. SSF requires the API to be authorized.
+   * Authenticates a management or poll request and names its receiver; `null`
+   * answers 401. SSF requires the API to be authorized.
    */
   readonly authorize: (request: Request) => SsfReceiverIdentity | null | Promise<SsfReceiverIdentity | null>;
   /** The route prefix under the issuer's origin. Default: `/ssf`. */
@@ -290,15 +314,24 @@ interface SsfTransmitterOptions extends BlockOptions {
   readonly deliveryMethods?: readonly SsfDeliveryMethod[];
   /** Seconds between verification requests per stream. Default: 30. */
   readonly minVerificationInterval?: number;
-  /** Keeps a push stream's `authorization_header` in Vault. Without it, such requests fail. */
+  /**
+   * Keeps a push stream's `authorization_header` in Vault. Without it, such
+   * requests fail.
+   */
   readonly credentials?: Pick<VaultCredentials, "set" | "revoke">;
-  /** `authorization_schemes` in the metadata. Default: OAuth 2.0 (`urn:ietf:rfc:6749`). */
+  /**
+   * `authorization_schemes` in the metadata. Default: OAuth 2.0
+   * (`urn:ietf:rfc:6749`).
+   */
   readonly authorizationSchemes?: readonly {
     readonly spec_urn: string;
   }[];
   /** The largest management request body, in bytes. Default: 64 KiB. */
   readonly maxBodyBytes?: number;
-  /** `withBlockHooks` hooks around the transmitter's methods; the routes call through them. */
+  /**
+   * `withBlockHooks` hooks around the transmitter's methods; the routes call
+   * through them.
+   */
   readonly hooks?: NoInfer<BlockHooks<SsfTransmitter>>;
   /** Receives the errors `after` hooks throw. Default: `console`. */
   readonly logger?: Logger;
@@ -325,7 +358,10 @@ interface SsfTransmitter {
   poll(id: string, request: SsfPollRequest): AsyncResult<SsfPollResponse>;
   /** Deletes replay entries and unpolled SETs past the retention. */
   purge(olderThan?: Temporal.Duration): AsyncResult<number>;
-  /** The well-known metadata, stream management, status, verification and poll routes. */
+  /**
+   * The well-known metadata, stream management, status, verification and poll
+   * routes.
+   */
   handler(): (request: Request) => Promise<Response>;
 }
 interface SsfPollRequest {
@@ -342,19 +378,25 @@ interface SsfPollResponse {
 }
 /**
  * An SSF transmitter: streams and their status live in the `shared-signals`
- * module, push SETs go out through webhooks-out endpoints with format
- * `set`, and poll SETs wait in the module's queue. Service role only.
+ * module, push SETs go out through webhooks-out endpoints with format `set`,
+ * and poll SETs wait in the module's queue. Service role only.
  */
 export declare function createSsfTransmitter(options: SsfTransmitterOptions): SsfTransmitter;
 //#endregion
 //#region src/blocks/shared-signals/shared-signals.d.ts
 type SharedSignalsOptions = BlockOptions;
-/** The `shared-signals` block: transmitters and receivers on the shared transport. */
+/**
+ * The `shared-signals` block: transmitters and receivers on the shared
+ * transport.
+ */
 interface SharedSignals {
   transmitter(options: Omit<SsfTransmitterOptions, keyof BlockOptions>): SsfTransmitter;
   receiver(options: Omit<SsfReceiverOptions, keyof BlockOptions>): SsfReceiver;
 }
-/** What `createBlocks` builds: each transmitter and receiver takes the block's transport. */
+/**
+ * What `createBlocks` builds: each transmitter and receiver takes the block's
+ * transport.
+ */
 export declare function createSharedSignals(options: SharedSignalsOptions): SharedSignals;
 //#endregion
 //#region src/blocks/shared-signals/methods.d.ts
@@ -385,7 +427,10 @@ type SharedSignalsEvents = {
   readonly "ssf_stream.status_changed": SsfStreamStatusEventData;
   readonly "ssf_stream.deleted": SsfStreamEventData;
 };
-/** The `shared-signals` block's event types, for its manifest and `onBlockEvent`. */
+/**
+ * The `shared-signals` block's event types, for its manifest and
+ * `onBlockEvent`.
+ */
 export declare const sharedSignalsEvents: Events<SharedSignalsEvents>;
 //#endregion
 //#region src/blocks/shared-signals/manifest.d.ts

package/dist/blocks/shared-signals/index.js

@@ -1,15 +1,14 @@
-import { n as dbError } from "../../errors-BV1SKTVs.js";
-import { a as ok, r as err, t as AsyncResult } from "../../result-DIeYscA3.js";
+import { n as dbError } from "../../errors-03ysrOt4.js";
+import { a as ok, r as err, t as AsyncResult } from "../../result-B3m7xtRY.js";
 import { t as consoleLogger } from "../../logger-glM28NVN.js";
 import { n as isRecord } from "../../guards-6F2bCtQR.js";
-import { o as problemResponse } from "../../problem-JRCohp1j.js";
+import { o as problemResponse } from "../../problem-BWElIgIb.js";
 import { n as SSF_PUSH, r as sharedSignalsSqlOptions, t as SSF_POLL } from "../../methods-7u6vSgz_.js";
-import { n as event, t as defineEvents } from "../../event-map-Dy2vKHai.js";
-import { i as sqlTransport } from "../../block-transport-J7ZepTq2.js";
-import { A as requiredInstant, D as recordOf, E as readBodyCapped, F as stringsOf, I as textOf, f as errorText, k as recordsOf, n as applyTemporal, o as blockCall, y as nullableText } from "../../block-helpers-DkVZNDrj.js";
-import { a as jwksOf, c as verifyCompact, t as JwsError } from "../../jws-CwBB5QAT.js";
-import { r as withBlockHooks } from "../../block-hooks-C22vuIUd.js";
-import { n as defineBlock } from "../../define-block-B6Gjs57G.js";
+import { A as requiredInstant, D as recordOf, E as readBodyCapped, F as stringsOf, I as textOf, U as sqlTransport, f as errorText, k as recordsOf, n as applyTemporal, o as blockCall, y as nullableText } from "../../block-helpers-CiKtrb6g.js";
+import { r as withBlockHooks } from "../../block-hooks-BymdcD0V.js";
+import { n as event, t as defineEvents } from "../../event-map-CtPFhcOp.js";
+import { a as jwksOf, c as verifyCompact, t as JwsError } from "../../jws-DOgHJKHb.js";
+import { n as defineBlock } from "../../define-block-Dze77QTw.js";
 //#region src/blocks/shared-signals/set.ts
 /** The `typ` header of a Security Event Token (RFC 8417 §2.3). */
 const SET_TYP = "secevent+jwt";
@@ -90,9 +89,9 @@ const jwsFailure = (cause) => {
 	}
 };
 /**
-* Verifies a SET as an RFC 8935 receiver: the signature against `jwks`,
-* `typ`, `iss`, `aud`, `jti`, `iat`, one event and an SSF `sub_id`. A
-* failure carries the error code to answer the transmitter with.
+* Verifies a SET as an RFC 8935 receiver: the signature against `jwks`, `typ`,
+* `iss`, `aud`, `jti`, `iat`, one event and an SSF `sub_id`. A failure carries
+* the error code to answer the transmitter with.
 */
 async function verifySet(token, options) {
 	let header;
@@ -155,9 +154,9 @@ function wellKnown(issuer) {
 	return `${parsed.origin}/.well-known/ssf-configuration${path}`;
 }
 /**
-* An SSF receiver: verifies pushed or polled SETs with the transmitter's
-* keys, drops replays through the `shared-signals` module's `(iss, jti)`
-* table, and calls the handler for the event type. Service role only.
+* An SSF receiver: verifies pushed or polled SETs with the transmitter's keys,
+* drops replays through the `shared-signals` module's `(iss, jti)` table, and
+* calls the handler for the event type. Service role only.
 */
 function createSsfReceiver(options) {
 	applyTemporal(options);
@@ -468,8 +467,8 @@ const noStore = (init) => {
 const strings = (value) => Array.isArray(value) && value.every((item) => typeof item === "string") ? value : void 0;
 /**
 * An SSF transmitter: streams and their status live in the `shared-signals`
-* module, push SETs go out through webhooks-out endpoints with format
-* `set`, and poll SETs wait in the module's queue. Service role only.
+* module, push SETs go out through webhooks-out endpoints with format `set`,
+* and poll SETs wait in the module's queue. Service role only.
 */
 function createSsfTransmitter(options) {
 	applyTemporal(options);
@@ -844,7 +843,10 @@ function routes(transmitter, context) {
 }
 //#endregion
 //#region src/blocks/shared-signals/shared-signals.ts
-/** What `createBlocks` builds: each transmitter and receiver takes the block's transport. */
+/**
+* What `createBlocks` builds: each transmitter and receiver takes the block's
+* transport.
+*/
 function createSharedSignals(options) {
 	return {
 		transmitter: (config) => createSsfTransmitter({
@@ -859,7 +861,10 @@ function createSharedSignals(options) {
 }
 //#endregion
 //#region src/blocks/shared-signals/events.ts
-/** The `shared-signals` block's event types, for its manifest and `onBlockEvent`. */
+/**
+* The `shared-signals` block's event types, for its manifest and
+* `onBlockEvent`.
+*/
 const sharedSignalsEvents = defineEvents({
 	"ssf_stream.created": event(),
 	"ssf_stream.status_changed": event(),

package/dist/blocks/shipments/index.d.ts

@@ -0,0 +1,238 @@
+/// <reference lib="esnext.temporal" />
+import { t as AsyncResult } from "../../result-C6jDfedy.js";
+import { t as StandardSchemaV1 } from "../../standard-DbQsD2xZ.js";
+import { n as ExtraFields, r as FieldsOf } from "../../block-fields-3w4MZr8U.js";
+import { dt as SubjectRef } from "../../executor-CPyrQdjh.js";
+import { Ct as Events } from "../../events-DbLjvxDX.js";
+import { n as Logger } from "../../logger-DWVYUmwi.js";
+import { n as BlockOptions } from "../../block-helpers-BaugZlJV.js";
+import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-CmjPKqQ_.js";
+import { n as shipmentsSqlOptions, t as ShipmentsSqlOptions } from "../../options-DZupPoI0.js";
+import { Gt as SectionWrite, Lt as Section, Wt as SectionRowInput, c as BlockOf, rn as EntitySchema } from "../../define-block-COpcS6aT.js";
+import { n as Money } from "../../money-BNRdJQzA.js";
+import { r as WebhookInput } from "../../signatures-zbu6KTNQ.js";
+import { C as TrackingStatus, S as TRACKING_STATUSES, _ as trackingUpdatesOf, a as FlatRateCarrierOptions, b as SHIPMENT_STATUSES, c as ShipmentCarrier, d as ShipmentParcel, f as ShipmentRate, g as shipmentCarrierOf, h as invalidShipmentRequest, i as CarrierTrackingUpdate, l as ShipmentLabel, m as flatRateCarrier, n as CarrierCancelInput, o as FlatRateService, p as ShipmentRateRequest, r as CarrierTrackingEvent, s as ShipmentAddress, t as CarrierCallOptions, u as ShipmentLabelRequest, v as LABEL_FORMATS, x as ShipmentStatus, y as LabelFormat } from "../../carrier-C7Q_21Kd.js";
+//#region src/blocks/shipments/shipments.d.ts
+interface ShipmentsOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockOptions {
+  /**
+   * A Standard Schema for the shipments' extra columns
+   * (`blocks.shipments.options.extraColumns`), keyed by database name.
+   */
+  readonly fields?: S;
+  /**
+   * The carriers that quote, label and track, by `name`. Without one the block
+   * still records shipments and tracking events by hand.
+   */
+  readonly carriers?: readonly ShipmentCarrier[];
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: NoInfer<BlockHooks<Shipments<FieldsOf<S>>>>;
+  /**
+   * Receives the errors `after` hooks throw and a label the block failed to
+   * void. Default: `console`.
+   */
+  readonly logger?: Logger;
+}
+interface ShipmentPackage {
+  readonly id: string;
+  /** From 1. */
+  readonly position: number;
+  readonly weightGrams: number;
+  readonly lengthMm?: number;
+  readonly widthMm?: number;
+  readonly heightMm?: number;
+  readonly reference?: string;
+}
+/** A shipment: its packages, its addresses and, once bought, its label. */
+interface Shipment<F extends object = Record<never, never>> {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly reference: string;
+  /** `draft` until labeled, then the latest tracking event's status. */
+  readonly status: ShipmentStatus;
+  readonly from: ShipmentAddress;
+  readonly to: ShipmentAddress;
+  /** The assets location it ships from. */
+  readonly fromLocationId?: string;
+  readonly subject?: SubjectRef;
+  readonly carrier?: string;
+  readonly service?: string;
+  readonly trackingNumber?: string;
+  readonly trackingUrl?: string;
+  readonly labelId?: string;
+  readonly labelUrl?: string;
+  readonly labelFormat?: LabelFormat;
+  readonly labelCost?: Money;
+  readonly labeledAt?: Temporal.Instant;
+  readonly deliveredAt?: Temporal.Instant;
+  readonly cancelledAt?: Temporal.Instant;
+  readonly createdBy?: string;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+  readonly packages: readonly ShipmentPackage[];
+  /** The extra columns, keyed by database name. */
+  readonly fields: ExtraFields<F>;
+}
+interface ShipmentInput<F extends object = Record<never, never>> {
+  readonly from: ShipmentAddress;
+  readonly to: ShipmentAddress;
+  /** 1 to 50 packages. */
+  readonly packages: readonly ShipmentParcel[];
+  /** Defaults to a generated `SHP-…` code. */
+  readonly reference?: string;
+  /** Needs the assets block. */
+  readonly fromLocationId?: string;
+  /** The record it ships for, such as an order. */
+  readonly subject?: SubjectRef;
+  readonly fields?: Partial<F>;
+}
+interface ShipmentListOptions {
+  readonly status?: ShipmentStatus;
+  readonly subject?: SubjectRef;
+  readonly carrier?: string;
+  /** Shipments created before this, for the next page. */
+  readonly before?: Temporal.Instant;
+  /** Default 50, at most 500. */
+  readonly limit?: number;
+}
+interface ShipmentLabelChoice {
+  /** A carrier's `name` from `options.carriers`. */
+  readonly carrier: string;
+  /** A service code the carrier quoted. */
+  readonly service: string;
+}
+/** One entry of a shipment's tracking timeline. */
+interface TrackingEvent {
+  readonly id: string;
+  /** The carrier's event id; `label:<labelId>` for the label itself. */
+  readonly externalId: string;
+  readonly status: TrackingStatus;
+  readonly occurredAt: Temporal.Instant;
+  readonly description?: string;
+  readonly location?: string;
+  readonly source: "carrier" | "webhook" | "manual";
+  readonly createdAt: Temporal.Instant;
+}
+interface TrackingRecorded<F extends object = Record<never, never>> {
+  /** The events that were new; repeats are skipped. */
+  readonly recorded: number;
+  readonly shipment: Shipment<F>;
+}
+/** What `ingest` did with one tracking number of a webhook. */
+interface TrackingIngested {
+  readonly trackingNumber: string;
+  /** Unset when no shipment has the tracking number. */
+  readonly shipmentId?: string;
+  readonly status?: ShipmentStatus;
+  readonly recorded: number;
+}
+/**
+ * Shipments with packages, carrier labels and a tracking timeline. `F` is the
+ * extra fields `options.fields` describes.
+ */
+interface Shipments<F extends object = Record<never, never>> {
+  /** Creates a draft shipment in the block's tenant. */
+  create(input: ShipmentInput<F>): AsyncResult<Shipment<F>>;
+  /** `null` when it doesn't exist or the caller can't read it. */
+  get(id: string): AsyncResult<Shipment<F> | null>;
+  list(options?: ShipmentListOptions): AsyncResult<readonly Shipment<F>[]>;
+  /** Every configured carrier's quotes, by currency and then cheapest first. */
+  rates(id: string, options?: {
+    readonly currency?: string;
+  }): AsyncResult<readonly ShipmentRate[]>;
+  /**
+   * Buys the label from the carrier and stores it on the draft shipment. The
+   * shipment id is the idempotency key, so a retry doesn't buy twice.
+   */
+  buyLabel(id: string, choice: ShipmentLabelChoice): AsyncResult<Shipment<F>>;
+  /** Pulls the carrier's tracking events and records the new ones. */
+  refresh(id: string): AsyncResult<TrackingRecorded<F>>;
+  /** Records tracking events by hand, such as a courier without an API. */
+  recordTracking(id: string, events: readonly CarrierTrackingEvent[]): AsyncResult<TrackingRecorded<F>>;
+  /**
+   * Verifies a carrier's tracking webhook and records its events on the
+   * shipments with those tracking numbers. Runs on `options.service`, since a
+   * webhook has no user; a redelivery records nothing twice.
+   */
+  ingest(carrier: string, request: WebhookInput): AsyncResult<readonly TrackingIngested[]>;
+  /**
+   * Cancels a shipment that hasn't shipped, voiding its label with the carrier
+   * first.
+   */
+  cancel(id: string): AsyncResult<Shipment<F>>;
+  /** The tracking timeline, oldest first. */
+  trackingEvents(id: string): AsyncResult<readonly TrackingEvent[]>;
+}
+/** The `shipments` SQL module and the configured carriers as typed calls. */
+export declare function createShipments<S extends StandardSchemaV1 | undefined = undefined>(options: ShipmentsOptions<S>): Shipments<FieldsOf<S>>;
+//#endregion
+//#region src/blocks/shipments/events.d.ts
+/** `shipment.created`. */
+interface ShipmentCreatedEventData {
+  readonly organizationId: string;
+  /** The shipment. */
+  readonly id: string;
+  readonly reference: string;
+  readonly subjectType: string | null;
+  readonly subjectId: string | null;
+}
+/** `shipment.labeled`: a label was bought for it. */
+interface ShipmentLabeledEventData {
+  readonly organizationId: string;
+  readonly id: string;
+  readonly carrier: string;
+  readonly service: string;
+  readonly trackingNumber: string;
+}
+/** `shipment.status_changed`: its latest tracking event has another status. */
+interface ShipmentStatusChangedEventData {
+  readonly organizationId: string;
+  readonly id: string;
+  readonly from: string;
+  readonly to: string;
+  readonly trackingNumber: string | null;
+}
+/** `shipment.cancelled`. */
+interface ShipmentCancelledEventData {
+  readonly organizationId: string;
+  readonly id: string;
+  /** Set when the shipment had a label the carrier voided. */
+  readonly trackingNumber: string | null;
+}
+/** The events of the `shipments` block: type to data. */
+type ShipmentsEvents = {
+  readonly "shipment.created": ShipmentCreatedEventData;
+  readonly "shipment.labeled": ShipmentLabeledEventData;
+  readonly "shipment.status_changed": ShipmentStatusChangedEventData;
+  readonly "shipment.cancelled": ShipmentCancelledEventData;
+};
+/** The `shipments` block's event types, for its manifest and `onBlockEvent`. */
+export declare const shipmentsEvents: Events<ShipmentsEvents>;
+//#endregion
+//#region src/blocks/shipments/schemas.d.ts
+/** What `create` takes, with the bounds the SQL checks. */
+export declare const shipmentInputSchema: EntitySchema<ShipmentInput>;
+/** What the section's `create` write takes: the record is the subject. */
+type ShipmentSectionInput = Omit<ShipmentInput, "subject" | "fields">;
+export declare const shipmentSectionInputSchema: EntitySchema<ShipmentSectionInput>;
+/** One event `recordTracking` takes. */
+export declare const trackingEventInputSchema: EntitySchema<CarrierTrackingEvent>;
+//#endregion
+//#region src/blocks/shipments/section.d.ts
+/** The writes of the shipments section. */
+type ShipmentsWrites = {
+  /** Creates a draft shipment for the record, such as an order's parcel. */
+  readonly create: SectionWrite<Shipments, ShipmentSectionInput, Shipment>;
+  /** Cancels one of the record's shipments that hasn't shipped. */
+  readonly cancel: SectionWrite<Shipments, SectionRowInput, Shipment>;
+};
+/** The shipments sent for a record, with their status and tracking. */
+export declare const shipmentsSection: Section<Shipments, readonly Shipment[], undefined, never, ShipmentsWrites>;
+//#endregion
+//#region src/blocks/shipments/manifest.d.ts
+/** The `shipments` block's manifest (ADR 0029). */
+export declare const shipmentsBlock: BlockOf<"shipments", typeof createShipments, ShipmentsEvents, Record<never, never>, never, {
+  readonly shipments: typeof shipmentsSection;
+}>;
+//#endregion
+export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type CarrierCallOptions, type CarrierCancelInput, type CarrierTrackingEvent, type CarrierTrackingUpdate, type FlatRateCarrierOptions, type FlatRateService, LABEL_FORMATS, type LabelFormat, type RpcClient, SHIPMENT_STATUSES, type Shipment, type ShipmentAddress, type ShipmentCancelledEventData, type ShipmentCarrier, type ShipmentCreatedEventData, type ShipmentInput, type ShipmentLabel, type ShipmentLabelChoice, type ShipmentLabelRequest, type ShipmentLabeledEventData, type ShipmentListOptions, type ShipmentPackage, type ShipmentParcel, type ShipmentRate, type ShipmentRateRequest, type ShipmentSectionInput, type ShipmentStatus, type ShipmentStatusChangedEventData, type Shipments, type ShipmentsEvents, type ShipmentsOptions, type ShipmentsSqlOptions, type ShipmentsWrites, TRACKING_STATUSES, type TrackingEvent, type TrackingIngested, type TrackingRecorded, type TrackingStatus, dbTransport, extendBlock, flatRateCarrier, invalidShipmentRequest, rpcTransport, shipmentCarrierOf, shipmentsSqlOptions, sqlTransport, trackingUpdatesOf, withBlockHooks, wrapTransport };