@larc-iu/plaid-client 0.2.0-alpha.23 → 0.2.0-alpha.29

package/src/index.d.ts

@@ -0,0 +1,4568 @@
+/**
+ * How long `admin.backup()` waits for the server to finish writing a backup:
+ * minutes on a large database, past the usual per-request timeout.
+ */
+export const BACKUP_TIMEOUT_MS: number;
+export default PlaidClient;
+export { wasReplayed } from "./replayed.js";
+export type TextEditOp = import("./textEdits.js").TextEditOp;
+export type TextGap = import("./textEdits.js").TextGap;
+export type MetadataOp = import("./metadataOps.js").MetadataOp;
+export type LayerConstraint = import("./constraints.js").LayerConstraint;
+export type ConstraintWriteOptions = import("./constraints.js").ConstraintWriteOptions;
+export type ConstraintViolation = import("./constraints.js").ConstraintViolation;
+export type Requester = import("./requester.js").Requester;
+export type BatchRef = import("./batchRef.js").BatchRef;
+export type ServiceParam = import("./serviceSchema.js").ServiceParam;
+export type ServiceInfo = import("./serviceSchema.js").ServiceInfo;
+export type DiscoveredService = import("./serviceSchema.js").DiscoveredService;
+export type ResponseHelper = import("./services.js").ResponseHelper;
+export type ServiceRegistration = import("./services.js").ServiceRegistration;
+export type ServiceStatusEvent = import("./services.js").ServiceStatusEvent;
+export type OperationGroupsBundle = PlaidClient["operationGroups"];
+/**
+ * A single page of a cursor-paginated collection.
+ */
+export type Page<T = any> = {
+    entries: T[];
+    nextCursor: string | null;
+};
+/**
+ * Client options.
+ */
+export type PlaidClientOptions = {
+    /**
+     * Per-request timeout in ms (default
+     * 30000, 0 or null disables it).
+     */
+    timeout?: number | null;
+    /**
+     * Timeout for batch submissions in
+     * ms (default 180000, 0 or null disables it). Aborting a batch does NOT
+     * stop the server, which keeps running the transaction and holding the
+     * write lock. Defaults to `timeout` when that is given and this is not.
+     */
+    batchTimeout?: number | null;
+    /**
+     * Delays in ms before sending a keyed
+     * write again when its answer was lost (no response, 502 or 504). Default
+     * [1000, 3000, 9000].
+     */
+    retryDelaysMs?: number[];
+    /**
+     * Fired once when
+     * a request returns HTTP 401 (missing, expired or invalid token). 403 does
+     * NOT trigger it.
+     */
+    onAuthError?: ((error: Error) => void) | null;
+};
+/**
+ * What kind of operation a logical-operation group is (`?group-kind=`).
+ */
+export type OperationKind = "assistant-plan" | "service-run" | "import" | "bulk-edit" | "guess-adoption" | "repair" | "review";
+/**
+ * Idempotency-Key seed for an operation run more than once (`client.keySeed()`).
+ */
+export type KeySeed = {
+    seed: string;
+    stamps: Map<number, number | null>;
+};
+/**
+ * A batch: the client's bundles, on which every write of project data queues
+ * until `submit()`. See `PlaidClient.batch()`. `submit()` resolves to one
+ * result per operation, in order. `ref(opIndex, index)` stands for the id a
+ * queued operation will create, in the body of a later write on this batch.
+ */
+export type PlaidBatch = PlaidClient & {
+    readonly client: PlaidClient;
+    readonly operations: Array<{
+        path: string;
+        method: string;
+        body?: any;
+    }>;
+    submit(): Promise<any[]>;
+    abort(): void;
+    ref(opIndex?: number, index?: number): BatchRef;
+};
+/**
+ * Options for a single page of any audit log. `kinds` keeps only the entries
+ * of operations of these kinds, each whole. `order: "desc"` pages newest
+ * first, and a cursor belongs to the direction that made it. `opsLimit` keeps
+ * only each entry's oldest N operations in `ops` (1..1000), and every entry
+ * has `opCount`. `entryId` reads only that entry rather than a page.
+ */
+export type AuditPageOptions = {
+    startTime?: string;
+    endTime?: string;
+    opTypes?: string[] | string;
+    kinds?: OperationKind[] | string;
+    order?: "asc" | "desc";
+    limit?: number;
+    cursor?: string;
+    opsLimit?: number;
+    entryId?: string;
+};
+/**
+ * What `vocabLayers.restoreItem` did, or with `dryRun` would do.
+ */
+export type VocabItemRestoreSummary = {
+    /**
+     * The entry was gone and came back under its old id.
+     */
+    inserted: boolean;
+    /**
+     * A living entry's form was set back.
+     */
+    form: boolean;
+    /**
+     * A living entry's fields were set back.
+     */
+    metadata: boolean;
+    /**
+     * 0 when nothing changes.
+     */
+    total: number;
+};
+/**
+ * One private data entry. `version` is raised by one on every write of the
+ * entry, and a new entry is 1.
+ */
+export type UserDataEntry = {
+    key: string;
+    updatedAt: string;
+    version: number;
+    value?: any;
+};
+export type AdminUserDataEntry = UserDataEntry & {
+    userId: string;
+};
+/**
+ * One user's activity over a scope and window (`audit.tally`).
+ */
+export type ActivityTallyRow = {
+    user: {
+        id: string;
+        displayName?: string;
+    };
+    operations: number;
+    changes: number;
+    documents: number;
+    firstTs: string;
+    lastTs: string;
+    byDay?: Array<{
+        date: string;
+        changes: number;
+    }>;
+};
+/**
+ * What a constraint repair did in one document.
+ */
+export type ConstraintRepair = {
+    document: string;
+    constraint: string;
+    deleted: number;
+    joined: number;
+};
+/**
+ * A value-set rule as `refusedValues` takes it: the list, the characters a
+ * value is split on, and whether every part (`"all"`, the default) or only
+ * the first must be listed.
+ */
+export type ValueSetRule = {
+    values: string[];
+    delimiters?: string;
+    parts?: "all" | "first";
+};
+/**
+ * What a value-set rule would refuse in a layer's stored values: how many,
+ * how many distinct, and the most frequent with the parts not listed.
+ */
+export type RefusedValues = {
+    count: number;
+    valueCount: number;
+    values: Array<{
+        value: any;
+        parts: string[];
+        count: number;
+    }>;
+};
+/**
+ * Entities that can carry a comment.
+ */
+export type CommentableType = "document" | "text" | "token" | "span" | "relation" | "vocab-item";
+/**
+ * One comment. `projectId` and `documentId` are null for a comment on a
+ * vocabulary entry, and `vocabLayerId` is set only for one. `anchorLabel` is
+ * what the comment is about, in words, captured when it was posted: a
+ * comment outlives its anchor. `edited` is true once the body has been
+ * rewritten since it was posted.
+ */
+export type Comment = {
+    id: string;
+    projectId: string | null;
+    documentId: string | null;
+    vocabLayerId: string | null;
+    entityType: CommentableType;
+    entityId: string;
+    anchorLabel: string | null;
+    authorId: string;
+    body: string;
+    createdAt: string;
+    updatedAt: string;
+    edited: boolean;
+};
+/**
+ * One entry in a project's annotation manual. `body` is present on a single
+ * read and on a list made with `includeBodies`, `bodyChars` on a list made
+ * without. `pinned`: the assistant is given this one in full on every turn.
+ */
+export type Guideline = {
+    id: string;
+    projectId: string;
+    title: string;
+    body?: string;
+    bodyChars?: number;
+    pinned: boolean;
+    createdAt: string;
+    updatedAt: string;
+};
+/**
+ * A research-telemetry event type.
+ */
+export type ClientEventType = "suggestion.shown" | "suggestion.adopted" | "suggestion.dismissed" | "plan.opened";
+/**
+ * One research-telemetry event as the server stores it.
+ */
+export type ClientEvent = {
+    id: number;
+    projectId: string;
+    documentId: string | null;
+    userId: string;
+    type: ClientEventType;
+    targetId: string | null;
+    data: Record<string, any> | null;
+    clientTs: string | null;
+    ts: string;
+};
+/**
+ * An invite. `kind` is "signup" or "password-reset", `status` "active",
+ * "used", "expired", "revoked" or "inactive".
+ */
+export type Invite = {
+    id: string;
+    kind: string;
+    status: string;
+    createdBy: string;
+    createdAt: string;
+    expiresAt: string;
+    maxUses: number;
+    uses: number;
+    revokedAt: string | null;
+    note: string | null;
+    targetUserId: string | null;
+    grantAdmin: boolean;
+    projectId: string | null;
+    projectRole: string | null;
+};
+/**
+ * Server limits, as reported by /api/v1/info. An unset limit is absent.
+ * `passwordMinLength` is the shortest password the server accepts on any
+ * path, `lockExpirationMs` how long a document lock is held before it lapses.
+ */
+export type ServerLimits = {
+    mediaFileBytes?: number;
+    jsonBodyBytes?: number;
+    batchOperations?: number;
+    metadataDepth?: number;
+    metadataKeyCount?: number;
+    metadataStringLength?: number;
+    metadataTotalBytes?: number;
+    userDataValueBytes?: number;
+    guidelineTitleLength?: number;
+    guidelineBodyLength?: number;
+    commentBodyLength?: number;
+    passwordMinLength?: number;
+    lockExpirationMs?: number;
+};
+export type ServerHealth = {
+    ok: boolean;
+    version: string;
+    uptimeMs: number;
+    audit: {
+        dbSizeMb?: number;
+        auditRows?: number;
+        error?: string;
+    };
+};
+export type RateLimitBucket = {
+    ip: string;
+    userId?: string;
+    failures: number;
+    limit: number;
+    blocked: boolean;
+};
+export type RateLimitSnapshot = {
+    windowMs: number;
+    logins: RateLimitBucket[];
+    ips: RateLimitBucket[];
+    invites: RateLimitBucket[];
+};
+export type BackupStatus = {
+    enabled: boolean;
+    directory: string;
+    retention: number;
+    time: string;
+    backups: Array<{
+        name: string;
+        bytes: number;
+        modified: string;
+    }>;
+    ok?: boolean;
+};
+export type ServerReport = {
+    version: string;
+    jvm: {
+        uptimeMs: number;
+        startedAt: string;
+        java: string;
+        heapUsed: number;
+        heapMax: number;
+    };
+    database: {
+        path: string | null;
+        bytes: number | null;
+        walBytes: number | null;
+        slowQueryThresholdMs?: number;
+        journalMode?: string;
+        maxPoolSize?: number;
+        tables: Record<string, number | null>;
+    };
+    media: {
+        directory: string;
+        files: number;
+        bytes: number;
+        orphans: number;
+        orphanBytes: number;
+    };
+    backup: BackupStatus;
+    settings: Record<string, any>;
+};
+/**
+ * The live log. Requests and events are buffered separately, so a burst of
+ * requests cannot evict an error. In each, `matched` is how many passed the
+ * filters (which may exceed what `entries` holds) and `held` how many are
+ * buffered in total. `file` is the configured log file's absolute path, or
+ * null when logging to stdout.
+ */
+export type LiveLog = {
+    requests: {
+        entries: object[];
+        matched: number;
+        held: number;
+        capacity: number;
+        stats: Record<string, number | null>;
+    };
+    events: {
+        entries: object[];
+        matched: number;
+        held: number;
+        capacity: number;
+        byLevel: Record<string, number>;
+    };
+    file: string | null;
+};
+/**
+ * An open server-sent-events stream. Once CLOSED, `error` says why: null when
+ * this side closed it. A refused stream's error carries the HTTP `status`,
+ * and one the server ended is named "StreamClosed".
+ */
+export type SSEConnection = {
+    close: () => void;
+    getStats: () => SSEStats;
+    readyState: number;
+    error: (Error & {
+        status?: number;
+    }) | null;
+};
+/**
+ * How an SSE connection has fared so far. `events` counts what arrived by
+ * event type ("audit-log", "message", "heartbeat", "connected", "other").
+ */
+export type SSEStats = {
+    durationSeconds: number;
+    isConnected: boolean;
+    isClosed: boolean;
+    clientId: string | null;
+    events: Record<string, number>;
+    readyState: number;
+};
+/**
+ * A value a span or relation holds: a JSON scalar.
+ */
+export type AtomicValue = string | number | boolean | null;
+/**
+ * What a create answers: the new record's id.
+ */
+export type Created = {
+    id: string;
+};
+/**
+ * A project. `textLayers` nests its layers in their display order, each
+ * with the layers built on it, and `vocabs` lists the vocabularies linked to
+ * it.
+ */
+export type Project = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    readers: string[];
+    writers: string[];
+    maintainers: string[];
+    textLayers: ProjectTextLayer[];
+    vocabs: ProjectVocab[];
+};
+export type ProjectTextLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    tokenLayers: ProjectTokenLayer[];
+};
+export type ProjectTokenLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+    spanLayers: ProjectSpanLayer[];
+};
+export type ProjectSpanLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+    relationLayers: ProjectRelationLayer[];
+};
+export type ProjectRelationLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+};
+export type ProjectVocab = {
+    id: string;
+    name: string;
+    maintainers: string[];
+    config: Record<string, any>;
+};
+/**
+ * A document. `version` rises by one on every write to it or its layers.
+ * A read with `includeBody` also carries `textLayers`, the document's
+ * annotation nested under each layer.
+ */
+export type PlaidDocument = {
+    id: string;
+    name: string;
+    project: string;
+    version: number;
+    timeCreated: string;
+    timeModified: string;
+    metadata?: Record<string, any>;
+    textLayers?: DocumentTextLayer[];
+};
+/**
+ * A text layer as a document read nests it: `text` is null where the
+ * document has no text in this layer.
+ */
+export type DocumentTextLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    text: {
+        id: string;
+        document: string;
+        body: string;
+        digest: string;
+        metadata?: Record<string, any>;
+    } | null;
+    tokenLayers: DocumentTokenLayer[];
+};
+export type DocumentTokenLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+    overlapMode: string;
+    parentTokenLayer: string | null;
+    tokens: Array<{
+        id: string;
+        begin: number;
+        end: number;
+        precedence: number | null;
+        metadata?: Record<string, any>;
+    }>;
+    spanLayers: DocumentSpanLayer[];
+    vocabs: Array<ProjectVocab & {
+        vocabLinks: Array<{
+            id: string;
+            vocabItem: VocabItem;
+            tokens: string[];
+            metadata?: Record<string, any>;
+        }>;
+    }>;
+};
+export type DocumentSpanLayer = {
+    id: string;
+    name: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+    spans: Array<{
+        id: string;
+        value: AtomicValue;
+        tokens: string[];
+        metadata?: Record<string, any>;
+    }>;
+    relationLayers: Array<ProjectRelationLayer & {
+        relations: Array<{
+            id: string;
+            source: string;
+            target: string;
+            value: AtomicValue;
+            metadata?: Record<string, any>;
+        }>;
+    }>;
+};
+/**
+ * A text: one document's body in one text layer. `digest` names the body,
+ * as an edit's `base`.
+ */
+export type PlaidText = {
+    id: string;
+    body: string;
+    document: string;
+    layer: string;
+    digest: string;
+    metadata?: Record<string, any>;
+};
+/**
+ * What a text write changed besides the body: the tokens whose extent
+ * moved (with `layer` and `text` on one the write made), the spans and
+ * vocabulary links whose tokens or value changed, and the ids of what it
+ * deleted.
+ */
+export type TextReshape = {
+    tokens: Array<{
+        id: string;
+        begin: number;
+        end: number;
+        layer?: string;
+        text?: string;
+    }>;
+    spans: Array<{
+        id: string;
+        tokens?: string[];
+        value?: AtomicValue;
+    }>;
+    vocabLinks: Array<{
+        id: string;
+        tokens: string[];
+    }>;
+    deleted: {
+        tokens: string[];
+        spans: string[];
+        relations: string[];
+        vocabLinks: string[];
+    };
+};
+/**
+ * A token. `value` is the text it covers.
+ */
+export type Token = {
+    id: string;
+    text: string;
+    begin: number;
+    end: number;
+    layer: string;
+    document: string;
+    precedence: number | null;
+    value: string;
+    metadata?: Record<string, any>;
+};
+export type Span = {
+    id: string;
+    layer: string;
+    document: string;
+    value: AtomicValue;
+    tokens: string[];
+    metadata?: Record<string, any>;
+};
+/**
+ * A relation, from the span `source` to the span `target`.
+ */
+export type Relation = {
+    id: string;
+    layer: string;
+    document: string;
+    source: string;
+    target: string;
+    value: AtomicValue;
+    metadata?: Record<string, any>;
+};
+export type VocabItem = {
+    id: string;
+    layer: string;
+    form: string;
+    metadata?: Record<string, any>;
+};
+/**
+ * A link from a vocabulary entry to the tokens of one occurrence.
+ */
+export type VocabLink = {
+    id: string;
+    vocabItem: string;
+    document: string;
+    tokens: string[];
+    metadata?: Record<string, any>;
+};
+/**
+ * A vocabulary. `items` is there on a read made with `includeItems`.
+ */
+export type VocabLayer = {
+    id: string;
+    name: string;
+    timeCreated: string;
+    timeModified: string;
+    config: Record<string, any>;
+    maintainers: string[];
+    items?: VocabItem[];
+};
+export type TextLayer = {
+    id: string;
+    name: string;
+    project: string;
+    config: Record<string, any>;
+};
+export type TokenLayer = {
+    id: string;
+    name: string;
+    textLayer: string;
+    project: string;
+    overlapMode: string;
+    parentTokenLayer: string | null;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+};
+export type SpanLayer = {
+    id: string;
+    name: string;
+    tokenLayer: string;
+    project: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+};
+export type RelationLayer = {
+    id: string;
+    name: string;
+    spanLayer: string;
+    project: string;
+    config: Record<string, any>;
+    constraints: Record<string, LayerConstraint[]>;
+};
+/**
+ * The records with metadata, by the path segment of their routes.
+ */
+export type MetadataRecords = {
+    documents: PlaidDocument;
+    texts: PlaidText;
+    tokens: Token;
+    spans: Span;
+    relations: Relation;
+    "vocab-items": VocabItem;
+    "vocab-links": VocabLink;
+};
+/**
+ * The four layer kinds, by the path segment of their routes.
+ */
+export type LayerRecords = {
+    "text-layers": TextLayer;
+    "token-layers": TokenLayer;
+    "span-layers": SpanLayer;
+    "relation-layers": RelationLayer;
+};
+export type User = {
+    id: string;
+    displayName: string;
+    isAdmin: boolean;
+    deactivatedAt: string | null;
+    avatarHash: string | null;
+};
+/**
+ * A project as the project list gives it: the project, with how many
+ * documents it has and when the newest of them last changed.
+ */
+export type ProjectListEntry = Project & {
+    documentCount: number;
+    lastModified: string | null;
+};
+/**
+ * A document as a project's document list gives it.
+ */
+export type DocumentListEntry = {
+    id: string;
+    name: string;
+    version: number;
+    timeCreated: string;
+    timeModified: string;
+};
+/**
+ * A named API token, without the signed token itself, which only `create`
+ * returns.
+ */
+export type ApiToken = {
+    id: string;
+    userId: string;
+    name: string;
+    createdAt: string;
+    lastUsedAt: string | null;
+    revokedAt: string | null;
+};
+/**
+ * Who made an operation, as the audit log names them.
+ */
+export type AuditUser = {
+    id: string;
+    displayName: string;
+    avatarHash: string | null;
+};
+/**
+ * A project or a document an audit entry names, while it exists.
+ */
+export type AuditTarget = {
+    id: string;
+    name: string;
+};
+/**
+ * One operation of an audit entry.
+ */
+export type AuditOp = {
+    id: string;
+    /**
+     * The kind of write, such as "document/update".
+     */
+    type: string;
+    description: string;
+    time: string;
+    /**
+     * The time to read at to see the operation done.
+     */
+    endTime: string;
+    user: AuditUser | null;
+    credential?: string;
+    project?: AuditTarget;
+    document?: AuditTarget;
+    batchId?: string;
+};
+/**
+ * One entry of an audit log: a logical operation, an atomic batch or a lone
+ * write, with its operations oldest first (`ops`, cut to `opsLimit` when one
+ * was asked for, while `opCount` counts them all).
+ */
+export type AuditEntry = {
+    id: string;
+    time: string;
+    endTime: string;
+    user: AuditUser | null;
+    projects: AuditTarget[];
+    documents: AuditTarget[];
+    ops: AuditOp[];
+    opCount: number;
+    groupId?: string;
+    message?: string;
+    kind?: OperationKind;
+    ref?: string;
+    batchId?: string;
+    apiToken?: {
+        id: string;
+        name: string;
+    };
+    credential?: string;
+};
+/**
+ * A document lock as its holder sees it. `expiresAt` is in epoch
+ * milliseconds.
+ */
+export type LockGrant = {
+    lockId: string;
+    userId: string;
+    expiresAt: number;
+};
+/**
+ * What `documents.restore` did, or with `dryRun` would do: per kind of
+ * record, how many come back, are set back and are removed (per layer for
+ * the layered kinds), and what could not come back, with why.
+ */
+export type DocumentRestoreSummary = {
+    name: boolean;
+    documentMetadata: boolean;
+    texts: RestoreCounts;
+    tokens: RestoreCounts & {
+        byLayer: Array<RestoreCounts & {
+            layerId: string;
+        }>;
+    };
+    spans: RestoreCounts & {
+        byLayer: Array<RestoreCounts & {
+            layerId: string;
+        }>;
+    };
+    relations: RestoreCounts & {
+        byLayer: Array<RestoreCounts & {
+            layerId: string;
+        }>;
+    };
+    vocabLinks: RestoreCounts;
+    skipped: Array<{
+        kind: string;
+        count: number;
+        reason: string;
+    }>;
+    /**
+     * When the name the
+     * document had then belongs to another document now: the name it keeps,
+     * and that other document's name.
+     */
+    nameKept?: {
+        name: string;
+        taken: string;
+    };
+    /**
+     * 0 when nothing changes.
+     */
+    total: number;
+};
+export type RestoreCounts = {
+    inserted: number;
+    updated: number;
+    deleted: number;
+};
+/**
+ * A logical-operation group: its label, who made it and when, and the kind
+ * and reference of the operation when it has them.
+ */
+export type OperationGroup = {
+    id: string;
+    message: string | null;
+    user: string;
+    createdAt: string;
+    kind?: string;
+    ref?: string;
+};
+/**
+ * A query's answer. For "ids" and "entities", one row of `results` per
+ * match, a cell per `columns` entry: an id, or the entity as its GET
+ * answers it. For "count", only the count. `truncated`: the rows or the
+ * count stopped at the server's cap.
+ */
+export type QueryResult = {
+    return: string;
+    count: number;
+    truncated: boolean;
+    columns?: string[];
+    results?: any[][];
+};
+export class PlaidClient {
+    /**
+     * Liveness, version and database size, with NO authentication and no client
+     * instance — for a launcher or status page checking whether a server is up
+     * before anyone logs in.
+     * @param {string} baseUrl - The API base URL
+     * @param {{timeout?: number | null}} [options]
+     * @returns {Promise<ServerHealth>}
+     */
+    static health(baseUrl: string, options?: {
+        timeout?: number | null;
+    }): Promise<ServerHealth>;
+    /**
+     * The limits this server enforces, with NO authentication and no client
+     * instance. See the instance method for the shape.
+     * @param {string} baseUrl - The API base URL
+     * @param {{timeout?: number | null}} [options]
+     * @returns {Promise<{limits: ServerLimits}>}
+     */
+    static info(baseUrl: string, options?: {
+        timeout?: number | null;
+    }): Promise<{
+        limits: ServerLimits;
+    }>;
+    /**
+     * Build the link to hand someone for an invite code. The server never sees
+     * an app URL, so the app that minted the invite is the one that names it.
+     * Both SPAs use HashRouter, so the code rides in the fragment — which also
+     * keeps it out of server access logs.
+     * @param {string} appUrl - Where the SPA lives, e.g. "https://plaid.example.org/igt/"
+     * @param {string} code - The code returned by invites.create()
+     * @returns {string}
+     */
+    static inviteUrl(appUrl: string, code: string): string;
+    /**
+     * Describe an invite code, with NO authentication — this is what a signup
+     * page calls before the redeemer has an account. Returns the kind of link
+     * ("signup" or "password-reset"), its status ("active", "used", "expired",
+     * "revoked", or "inactive" when its creator can no longer grant what it
+     * grants), and the project it grants access to, if any.
+     *
+     * Throws a 404-shaped error if the code is unknown. A known-but-dead code
+     * resolves normally with a non-"active" status, so the page can say why.
+     * @param {string} baseUrl - The API base URL
+     * @param {string} code - The invite code
+     * @param {object} [options]
+     * @returns {Promise<{kind: string, status: string, expiresAt: string, projectName?: string, projectRole?: string, email?: string, grantAdmin: boolean}>}
+     */
+    static lookupInvite(baseUrl: string, code: string, options?: object): Promise<{
+        kind: string;
+        status: string;
+        expiresAt: string;
+        projectName?: string;
+        projectRole?: string;
+        email?: string;
+        grantAdmin: boolean;
+    }>;
+    /**
+     * Redeem an invite code, with NO authentication.
+     *
+     * For a signup invite, pass `email` and `password` to create the account
+     * (and optionally `displayName`); the invite's grants are applied in the
+     * same transaction. For a password reset link, pass `password` only.
+     * Resolves to a logged-in client, exactly like login() — the redeemer just
+     * chose these credentials, so there is no reason to send them to a login
+     * form to retype them.
+     * @param {string} baseUrl - The API base URL
+     * @param {string} code - The invite code
+     * @param {object} credentials
+     * @param {string} [credentials.email] - The new account's email address,
+     *   which becomes its id and login (signup only)
+     * @param {string} [credentials.displayName] - How the new user is shown in
+     *   the UI; defaults to the local part of the email (signup only)
+     * @param {string} credentials.password - Desired password (min 8 characters)
+     * @param {object} [options]
+     * @returns {Promise<{client: PlaidClient, userId: string, kind: string}>}
+     */
+    static redeemInvite(baseUrl: string, code: string, { email, password, displayName }?: {
+        email?: string;
+        displayName?: string;
+        password: string;
+    }, options?: object): Promise<{
+        client: PlaidClient;
+        userId: string;
+        kind: string;
+    }>;
+    /**
+     * Authenticate and return a new client instance with token. This is the
+     * single auth entry point — there is no `client.login` resource.
+     * @param {string} baseUrl - The base URL for the API
+     * @param {string} userId - User ID for authentication
+     * @param {string} password - Password for authentication
+     * @param {object} [options] - Client options forwarded to the constructor (e.g. { timeout })
+     * @returns {Promise<PlaidClient>} - Authenticated client instance
+     */
+    static login(baseUrl: string, userId: string, password: string, options?: object): Promise<PlaidClient>;
+    /**
+     * Create a new PlaidClient instance
+     * @param {string} baseUrl - The base URL for the API
+     * @param {string} token - The authentication token
+     * @param {PlaidClientOptions} [options] - Client options
+     */
+    constructor(baseUrl: string, token: string, options?: PlaidClientOptions);
+    baseUrl: string;
+    token: string;
+    /** @type {number | null} */
+    timeout: number | null;
+    /** @type {number | null} */
+    batchTimeout: number | null;
+    /** @type {number[] | undefined} */
+    retryDelaysMs: number[] | undefined;
+    /**
+     * The latest version seen for each document written through this client,
+     * keyed by document id.
+     * @type {Record<string, number>}
+     */
+    documentVersions: Record<string, number>;
+    /**
+     * True once a response left its version list out
+     * (X-Document-Versions-Omitted, past fifty documents). Every version held
+     * was then forgotten, and the strict-mode document's is read again before
+     * the next write.
+     * @type {boolean | undefined}
+     */
+    documentVersionsOmitted: boolean | undefined;
+    /** @type {number | null} */
+    serverClockOffsetMs: number | null;
+    /**
+     * The document strict mode is entered for, or null.
+     * @type {string | null}
+     */
+    strictModeDocumentId: string | null;
+    /** @type {import("./documentLock.js").DocumentLockLost | null} */
+    documentLockLost: import("./documentLock.js").DocumentLockLost | null;
+    /**
+     * @type {{id: string, message: string | null, kind: OperationKind | null,
+     *   ref: string | null, depth: number, written: boolean, refined: any,
+     *   frames: object[]} | null}
+     */
+    operationGroup: {
+        id: string;
+        message: string | null;
+        kind: OperationKind | null;
+        ref: string | null;
+        depth: number;
+        written: boolean;
+        refined: any;
+        frames: object[];
+    } | null;
+    /** @type {((error: Error) => void) | null} */
+    onAuthError: ((error: Error) => void) | null;
+    /** @private */
+    private _authErrorFired;
+    /** @private */
+    private _retryListeners;
+    /** @private */
+    private _serverFacts;
+    /** @private @type {object | null} */
+    private _openedFrame;
+    /**
+     * A stream of this client ended without being closed here: the server may
+     * have restarted, with other limits.
+     * @private
+     */
+    private _noteStreamDropped;
+    /**
+     * A stream of this client is open. After a drop the limits are read again,
+     * once however many streams reopen.
+     * @private
+     */
+    private _noteStreamOpened;
+    /**
+     * Hear every time a request is sent again: after a 503 (the database was
+     * busy), or for a keyed write after its answer was lost (no response, 502,
+     * 504). The listener gets `{ attempt, retries, delay, error }` before the
+     * wait. A screen that writes through the client directly can say it is
+     * retrying while the server does not answer, though the browser is online.
+     * @param {(info: {attempt: number, retries: number, delay: number, error: Error}) => void} listener
+     * @returns {() => void} the unsubscribe
+     */
+    onRetry(listener: (info: {
+        attempt: number;
+        retries: number;
+        delay: number;
+        error: Error;
+    }) => void): () => void;
+    /**
+     * Tell every `onRetry` listener. A listener that throws is passed over.
+     * @private
+     */
+    private _noteRetry;
+    /**
+     * The server's time now, as its last response's Date header put it (to the
+     * second), else this machine's. Judge a time the server stamped, such as an
+     * audit entry's `ts`, against this rather than `Date.now()`: a browser
+     * clock can be minutes off.
+     * @returns {Date}
+     */
+    serverNow(): Date;
+    /**
+     * The API bundles (`client.documents`, `client.tokens`, ...). Installed on
+     * the client, and again on every batch it opens (see `batch()`): a batch is
+     * a view of the client with its own `_request`, so the same bundles built
+     * on it queue instead of sending.
+     * @private
+     */
+    private _installResources;
+    vocabLinks: {
+        /**
+         * Get a vocab link by ID
+         * @param {string} id - The resource ID
+         * @returns {Promise<VocabLink>}
+         */
+        get: (id: string) => Promise<VocabLink>;
+        /**
+         * Delete a vocab link
+         * @param {string} id - The resource ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (id: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<VocabLink>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<VocabLink>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<VocabLink>;
+        /**
+         * Create a new vocab link between tokens and a vocab item.
+         * @param {string} vocabItem - The vocab item to link
+         * @param {Array} tokens - The tokens to link
+         * @param {any} [metadata] - Metadata for the link. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (vocabItem: string, tokens: any[], metadata?: any, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Create multiple vocab links in a single operation. Entries may
+         * reference different vocab items, but all tokens across the call must
+         * belong to one document.
+         * @param {Array<{vocabItem: string, tokens: string[], metadata?: any}>} body - The vocab links to create
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{ids: string[]}>} The created entity IDs, in input order. (bulkDelete resolves to no value.)
+         */
+        bulkCreate: (body: Array<{
+            vocabItem: string;
+            tokens: string[];
+            metadata?: any;
+        }>, auditMessage?: string) => Promise<{
+            ids: string[];
+        }>;
+        /**
+         * Delete multiple vocab links in a single operation. Provide an array of IDs.
+         * @param {string[]} body - The vocab link IDs to delete
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        bulkDelete: (body: string[], auditMessage?: string) => Promise<void>;
+    };
+    vocabLayers: {
+        /**
+         * List all vocab layers accessible to user. Transparently follows
+         * pagination cursors and returns the full flat array.
+         * @returns {Promise<VocabLayer[]>}
+         */
+        list: () => Promise<VocabLayer[]>;
+        /**
+         * Fetch a single page of vocab layers.
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<VocabLayer>>}
+         */
+        listPage: ({ limit, cursor }?: {
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<VocabLayer>>;
+        /**
+         * Async-iterate vocab layers page by page; yields each page's entries array.
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<VocabLayer[]>}
+         */
+        iterPages: ({ pageSize }?: {
+            pageSize?: number;
+        }) => AsyncGenerator<VocabLayer[]>;
+        /**
+         * Create a new vocab layer. Note: this also registers the user as a maintainer.
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (name: string, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Assign a user as a maintainer for this vocab layer.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        addMaintainer: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Remove a user's maintainer privileges for this vocab layer.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        removeMaintainer: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Set a configuration value in an editor namespace.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {any} configValue - Configuration value to set
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`: the value read for this key (null or undefined when it
+         *   was absent). The write is then refused with a 409 when the stored value differs. A value the key
+         *   already holds is not written and leaves no audit row, so the value read, expecting it, states in a
+         *   batch that the key is unchanged.
+         * @returns {Promise<void>}
+         */
+        setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Remove a configuration value.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`, as on setConfig. A key that is absent is not
+         *   written, so expecting null states in a batch that it is still absent.
+         * @returns {Promise<void>}
+         */
+        deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Get a vocab layer by ID. With `asOf`, the vocabulary as it was at that
+         * instant, read from its history: the same shape as the live read, its
+         * entries with `includeItems`. A vocabulary that did not exist then is a
+         * 404, a malformed or pruned time a 400.
+         * @param {string} id - The resource ID
+         * @param {boolean} [includeItems] - Include vocab items
+         * @param {string} [asOf] - The moment to read at (ISO-8601 instant)
+         * @returns {Promise<VocabLayer>}
+         */
+        get: (id: string, includeItems?: boolean, asOf?: string) => Promise<VocabLayer>;
+        /**
+         * One entry of the vocabulary as it was at `asOf`, also when it has
+         * been deleted since. The same shape as `vocabItems.get`. A 404 when
+         * the entry was not in this vocabulary at that time.
+         * @param {string} id - The vocabulary ID
+         * @param {string} itemId - The entry ID
+         * @param {string} asOf - The moment to read at (ISO-8601 instant)
+         * @returns {Promise<VocabItem>}
+         */
+        getItemAt: (id: string, itemId: string, asOf: string) => Promise<VocabItem>;
+        /**
+         * Get the audit log of a vocabulary: every change to it or to its
+         * entries, folded into entries as the document log is. Links are not
+         * listed, they belong to the document they annotate. Transparently
+         * follows pagination cursors and returns the full flat array.
+         * @param {string} id - The vocabulary ID
+         * @param {string} [startTime] - Start of time range
+         * @param {string} [endTime] - End of time range
+         * @param {string[]|string} [opTypes] - Only return operations of these
+         *   types, spelled as in an entry's `op/type` (e.g.
+         *   `['vocab-item/delete', 'vocab-item/restore']`)
+         * @param {string} [itemId] - Only the changes that wrote this one entry,
+         *   each with only its operations that did
+         * @param {string[]|string} [kinds] - Only the entries of operations of
+         *   these kinds (e.g. `['review', 'guess-adoption']`), each whole
+         * @returns {Promise<AuditEntry[]>}
+         */
+        audit: (id: string, startTime?: string, endTime?: string, opTypes?: string[] | string, itemId?: string, kinds?: string[] | string) => Promise<AuditEntry[]>;
+        /**
+         * One page of the same log, newest-first with `order: "desc"`. Use this
+         * rather than audit() wherever the caller wants the recent end of a log
+         * that may be long: audit() walks every page before it resolves.
+         * @param {string} id - The vocabulary ID
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only entries at or after this instant
+         * @param {string} [opts.endTime] - Only entries at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types
+         * @param {OperationKind[]|string} [opts.kinds] - Only the entries of operations of these kinds, each whole
+         * @param {"asc"|"desc"} [opts.order] - "desc" pages newest-first
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {number} [opts.opsLimit] - Keep only each entry's oldest N
+         *   operations in `ops` (1..1000). `opCount` on every entry says how
+         *   many it has
+         * @param {string} [opts.entryId] - Read only this entry, not a page
+         * @param {string} [opts.itemId] - Only the changes that wrote this one
+         *   entry, each with only its operations that did
+         * @returns {Promise<Page<AuditEntry>>}
+         */
+        auditPage: (id: string, { startTime, endTime, opTypes, kinds, order, limit, cursor, opsLimit, entryId, itemId }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: OperationKind[] | string;
+            order?: "asc" | "desc";
+            limit?: number;
+            cursor?: string;
+            opsLimit?: number;
+            entryId?: string;
+            itemId?: string;
+        }) => Promise<Page<AuditEntry>>;
+        /**
+         * Put one entry of the vocabulary back as it was at `asOf`, as one
+         * operation. A deleted entry comes back under its original id with its
+         * form and fields, and a living one has its form and fields set back.
+         * Links are not part of an entry: a deleted entry's links come back
+         * through each document's own `documents.restore`. Resolves to
+         * `{inserted, form, metadata, total}`, `total` 0 when nothing changes.
+         * A form set back bumps every linking document, and the new versions
+         * come back in X-Document-Versions (or, past fifty documents,
+         * X-Document-Versions-Omitted), which the client takes up as on any
+         * write. A time when the entry did not exist is a 400. Maintainers of
+         * the vocabulary only.
+         * @param {string} id - The vocabulary ID
+         * @param {string} itemId - The entry ID
+         * @param {string} asOf - The moment to go back to (ISO-8601 instant),
+         *   typically a history entry's `endTime`
+         * @param {{dryRun?: boolean}} [options] - `{ dryRun }`: with `dryRun` true nothing
+         *   is written and the summary says what would change
+         * @param {string} [auditMessage] - Custom audit message for this operation
+         * @returns {Promise<VocabItemRestoreSummary>}
+         */
+        restoreItem: (id: string, itemId: string, asOf: string, { dryRun }?: {
+            dryRun?: boolean;
+        }, auditMessage?: string) => Promise<VocabItemRestoreSummary>;
+        /**
+         * Delete a vocab layer.
+         * @param {string} id - The resource ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (id: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Update a vocab layer's name.
+         * @param {string} id - The resource ID
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<VocabLayer>}
+         */
+        update: (id: string, name: string, auditMessage?: string) => Promise<VocabLayer>;
+    };
+    relations: {
+        /**
+         * Update the target span of a relation.
+         * @param {string} relationId - The relation ID
+         * @param {string} spanId - The span ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Relation>}
+         */
+        setTarget: (relationId: string, spanId: string, auditMessage?: string) => Promise<Relation>;
+        /**
+         * Get a relation by ID.
+         * @param {string} relationId - The relation ID
+         * @returns {Promise<Relation>}
+         */
+        get: (relationId: string) => Promise<Relation>;
+        /**
+         * Delete a relation.
+         * @param {string} relationId - The relation ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (relationId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Update a relation's value.
+         * @param {string} relationId - The relation ID
+         * @param {any} value - The value
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Relation>}
+         */
+        update: (relationId: string, value: any, auditMessage?: string) => Promise<Relation>;
+        /**
+         * Update the source span of a relation.
+         * @param {string} relationId - The relation ID
+         * @param {string} spanId - The span ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Relation>}
+         */
+        setSource: (relationId: string, spanId: string, auditMessage?: string) => Promise<Relation>;
+        /**
+         * Create a new relation. A relation is a directed edge between two spans
+         * with a value, useful for expressing phenomena such as syntactic or
+         * semantic relations.
+         * @param {string} relationLayerId - The relation layer ID
+         * @param {string} source - The source span ID
+         * @param {string} target - The target span ID
+         * @param {any} value - The value
+         * @param {any} [metadata] - Metadata map. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (relationLayerId: string, source: string, target: string, value: any, metadata?: any, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Create multiple relations in a single operation.
+         * @param {Array} body - The request body
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{ids: string[]}>} The created entity IDs, in input order. (bulkDelete resolves to no value.)
+         */
+        bulkCreate: (body: any[], auditMessage?: string) => Promise<{
+            ids: string[];
+        }>;
+        /**
+         * Delete multiple relations in a single operation. Provide an array of IDs.
+         * @param {Array} body - The request body
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        bulkDelete: (body: any[], auditMessage?: string) => Promise<void>;
+        /**
+         * Update many relations in a single operation: set values and/or patch metadata.
+         * @param {Array} body - Objects of the shape `{id, value?, metadata?}`. `value` is set only when the key is present (null sends JSON null); `metadata` is a list of metadata ops, as for patchMetadata. The relations may lie in several documents of one project; every document touched has its version bumped and every new version comes back in `X-Document-Versions` (past fifty documents, only their number, in `X-Document-Versions-Omitted`). A `document-version` precondition is accepted only when every entry lies in one document. An unknown id refuses the whole update.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{count: number}>} How many relations were updated.
+         */
+        bulkUpdate: (body: any[], auditMessage?: string) => Promise<{
+            count: number;
+        }>;
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<Relation>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<Relation>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<Relation>;
+    };
+    spanLayers: {
+        /**
+         * Create a new span layer.
+         * @param {string} tokenLayerId - The token layer ID
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (tokenLayerId: string, name: string, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a layer by ID.
+         * @param {string} layerId - The layer ID
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        get: (layerId: string) => Promise<SpanLayer>;
+        /**
+         * Delete a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (layerId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Rename a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} name - The new name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        update: (layerId: string, name: string, auditMessage?: string) => Promise<SpanLayer>;
+        /**
+         * Move a layer one place in its display order.
+         * @param {string} layerId - The layer ID
+         * @param {string} direction - The direction ("up" or "down")
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+        /**
+         * The stored values of this layer that a value-set rule would refuse,
+         * before it is declared: exactly what a declaration of it would meet,
+         * with the rule's exemptions (an unconfirmed machine value, a value an
+         * import, a document copy or a restore set). Writes nothing, and a
+         * reader may ask.
+         * @param {string} layerId - The layer ID
+         * @param {ValueSetRule} rule - The list as a value-set declaration takes it
+         * @param {{limit?: number}} [options] - `limit`: how many values to list, the most frequent first
+         *   (default 20, at most 100)
+         * @returns {Promise<RefusedValues>}
+         */
+        refusedValues: (layerId: string, rule: ValueSetRule, options?: {
+            limit?: number;
+        }) => Promise<RefusedValues>;
+        /**
+         * Declare an app namespace's constraints on this layer, replacing that
+         * namespace's list. Refused with 422 and the violations when the layer's
+         * stored data breaks them (see violationsOf).
+         * @param {string} layerId - The layer ID
+         * @param {string} namespace - The declaring app's namespace, e.g. "igt"
+         * @param {LayerConstraint[]} constraints - e.g. [{type: "single-span"}, {type: "value-set", values: ["N"]}]
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: Array<object>|null}} [options] - `expected`: the list read for this
+         *   namespace (null when it was absent). The write is then refused with a 409 when the stored
+         *   list differs.
+         * @returns {Promise<{constraints: Record<string, LayerConstraint[]>}>} the layer's whole constraint map
+         */
+        setConstraints: (layerId: string, namespace: string, constraints: LayerConstraint[], auditMessage?: string, options?: {
+            expected?: Array<object> | null;
+        }) => Promise<{
+            constraints: Record<string, LayerConstraint[]>;
+        }>;
+        /**
+         * Remove an app namespace's constraints from this layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} namespace - The declaring app's namespace
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: Array<object>|null}} [options] - `expected`, as on setConstraints.
+         * @returns {Promise<void>}
+         */
+        deleteConstraints: (layerId: string, namespace: string, auditMessage?: string, options?: {
+            expected?: Array<object> | null;
+        }) => Promise<void>;
+        /**
+         * The violations the given constraints would meet in this layer's stored
+         * data. Writes nothing.
+         * @param {string} layerId - The layer ID
+         * @param {LayerConstraint[]} constraints - The list to check
+         * @param {{limit?: number}} [options] - `limit`: how many violations to list (default 100)
+         * @returns {Promise<{violations: ConstraintViolation[], violationCount: number}>}
+         */
+        checkConstraints: (layerId: string, constraints: LayerConstraint[], options?: {
+            limit?: number;
+        }) => Promise<{
+            violations: ConstraintViolation[];
+            violationCount: number;
+        }>;
+        /**
+         * Apply the remedies of the given constraints' remediable types
+         * (coextensive, single-span, single-link, same-ancestor) to every
+         * violation in this layer's stored data, one operation per document.
+         * With `document`, only that document is repaired, and a writer may
+         * ask. A document another user holds the lock on is left as it is and
+         * listed under `locked`.
+         * @param {string} layerId - The layer ID
+         * @param {LayerConstraint[]} constraints - The list to repair for
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{document?: string}} [options]
+         * @returns {Promise<{repaired: ConstraintRepair[], locked: Array<{document: string, lockedBy: string}>, violations: ConstraintViolation[], violationCount: number}>}
+         */
+        repairConstraints: (layerId: string, constraints: LayerConstraint[], auditMessage?: string, options?: {
+            document?: string;
+        }) => Promise<{
+            repaired: ConstraintRepair[];
+            locked: Array<{
+                document: string;
+                lockedBy: string;
+            }>;
+            violations: ConstraintViolation[];
+            violationCount: number;
+        }>;
+        /**
+         * Set a configuration value in an editor namespace.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {any} configValue - Configuration value to set
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`: the value read for this key (null or undefined when it
+         *   was absent). The write is then refused with a 409 when the stored value differs. A value the key
+         *   already holds is not written and leaves no audit row, so the value read, expecting it, states in a
+         *   batch that the key is unchanged.
+         * @returns {Promise<void>}
+         */
+        setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Remove a configuration value.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`, as on setConfig. A key that is absent is not
+         *   written, so expecting null states in a batch that it is still absent.
+         * @returns {Promise<void>}
+         */
+        deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+    };
+    spans: {
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<Span>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<Span>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<Span>;
+        /**
+         * Replace tokens for a span.
+         * @param {string} spanId - The span ID
+         * @param {Array} tokens - The tokens
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Span>}
+         */
+        setTokens: (spanId: string, tokens: any[], auditMessage?: string) => Promise<Span>;
+        /**
+         * Create a new span. A span holds a primary atomic value and optional
+         * metadata, and must at all times be associated with one or more tokens.
+         * @param {string} spanLayerId - The span layer ID
+         * @param {Array} tokens - The tokens
+         * @param {any} value - The value
+         * @param {any} [metadata] - Metadata map. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (spanLayerId: string, tokens: any[], value: any, metadata?: any, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a span by ID.
+         * @param {string} spanId - The span ID
+         * @returns {Promise<Span>}
+         */
+        get: (spanId: string) => Promise<Span>;
+        /**
+         * Delete a span.
+         * @param {string} spanId - The span ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (spanId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Update a span's value.
+         * @param {string} spanId - The span ID
+         * @param {any} value - The value
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Span>}
+         */
+        update: (spanId: string, value: any, auditMessage?: string) => Promise<Span>;
+        /**
+         * Create multiple spans in a single operation.
+         * @param {Array} body - The request body
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{ids: string[]}>} The created entity IDs, in input order. (bulkDelete resolves to no value.)
+         */
+        bulkCreate: (body: any[], auditMessage?: string) => Promise<{
+            ids: string[];
+        }>;
+        /**
+         * Delete multiple spans in a single operation. Provide an array of IDs.
+         * @param {Array} body - The request body
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        bulkDelete: (body: any[], auditMessage?: string) => Promise<void>;
+        /**
+         * Update many spans in a single operation: set values and/or patch metadata.
+         * @param {Array} body - Objects of the shape `{id, value?, metadata?}`. `value` is set only when the key is present (null sends JSON null); `metadata` is a list of metadata ops, as for patchMetadata. The spans may lie in several documents of one project; every document touched has its version bumped and every new version comes back in `X-Document-Versions` (past fifty documents, only their number, in `X-Document-Versions-Omitted`). A `document-version` precondition is accepted only when every entry lies in one document. An unknown id refuses the whole update.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{count: number}>} How many spans were updated.
+         */
+        bulkUpdate: (body: any[], auditMessage?: string) => Promise<{
+            count: number;
+        }>;
+    };
+    server: {
+        /**
+         * This server's version and the limits it enforces, e.g.
+         * `{ limits: { mediaFileBytes, jsonBodyBytes, batchOperations, … } }`.
+         * Sizes are in bytes. Unauthenticated.
+         * @returns {Promise<{limits: ServerLimits}>}
+         */
+        info: () => Promise<{
+            limits: ServerLimits;
+        }>;
+        /**
+         * Read `GET /info` again and resolve to it. Until it answers, a reader
+         * waits for it. The facts known before are kept when the server does
+         * not answer, and the error is thrown.
+         * @returns {Promise<{limits: ServerLimits}>}
+         */
+        refresh: () => Promise<{
+            limits: ServerLimits;
+        }>;
+        /**
+         * Just the limits, which is what a caller almost always wants.
+         * @returns {Promise<ServerLimits>}
+         */
+        limits: () => Promise<ServerLimits>;
+        /**
+         * Liveness, version and database size. Unauthenticated, and served
+         * outside the REST router at /health, so it answers even while the API
+         * is refusing requests. Never cached — the point is that it is current.
+         * @returns {Promise<ServerHealth>}
+         */
+        health: () => Promise<ServerHealth>;
+    };
+    auth: {
+        /**
+         * End every sign-in of this user on every device: each browser tab,
+         * script and service holding one of the user's sign-in tokens is
+         * refused from now on, this client included. Named API tokens are not
+         * affected (revoke one with `apiTokens.revoke`). To sign out of one tab
+         * only, discard its token instead. A signal rather than project data:
+         * made on a batch it still goes out at once, and it never joins an
+         * operation.
+         * @returns {Promise<void>}
+         */
+        logoutEverywhere: () => Promise<void>;
+    };
+    texts: {
+        /**
+         * Create a new text in a document's text layer. A text is a container for
+         * one long string in `body` for a given layer.
+         * @param {string} textLayerId - The text layer ID
+         * @param {string} documentId - The document ID
+         * @param {string} body - The request body
+         * @param {any} [metadata] - Metadata map. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage]
+         * @param {{id?: string, tokenEdges?: number[], tokenizeLayer?: string}} [options] - `id`: the
+         *   new text's id, a UUIDv7 this client minted. `tokenEdges`: the code-point offsets where
+         *   the tokens made next on this text begin and end. The body is stored composed, except a
+         *   character one of them falls inside, which stays as sent (see composeText).
+         *   `tokenizeLayer`: a word layer of the text, which gets the body's words, cut by the
+         *   server ("Tokenize new text").
+         * @returns {Promise<Created>}
+         */
+        create: (textLayerId: string, documentId: string, body: string, metadata?: any, auditMessage?: string, { id, tokenEdges, tokenizeLayer }?: {
+            id?: string;
+            tokenEdges?: number[];
+            tokenizeLayer?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a text.
+         * @param {string} textId - The text ID
+         * @returns {Promise<PlaidText>}
+         */
+        get: (textId: string) => Promise<PlaidText>;
+        /**
+         * Delete a text and all dependent data.
+         * @param {string} textId - The text ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (textId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Update a text's body. A diff is computed and token indices are updated
+         * so that tokens remain intact. Alternatively, `body` can be a list of
+         * edit directives (code-point indices, applied in order):
+         *   {type: 'delete', index, value: count}
+         *   {type: 'insert', index, value: string}
+         *   {type: 'replace', index, length, value: string} — unlike
+         *     delete+insert, a token covering the whole range is resized to keep
+         *     it (respell a word in place without losing its annotations).
+         * A list is applied exactly as sent. With `base` (the `digest` of the
+         * body the update was made on, as every read of a text gives it) the
+         * update applies only to that body, and is refused with 409 and
+         * `text-changed` otherwise. Strict mode then does not stamp it, unless
+         * `versioned` is true (a batch whose later writes are stamped needs its
+         * first write stamped too).
+         * @param {string} textId - The text ID
+         * @param {any} body - The request body
+         * @param {string} [auditMessage]
+         * `tokenizeLayer`: a word layer of the text, whose words the server makes for the text the
+         * update types, after it places the old tokens ("Tokenize new text"). They come in the
+         * answer's `reshape`.
+         * @param {{base?: string, versioned?: boolean, tokenizeLayer?: string}} [options]
+         * @returns {Promise<PlaidText & {reshape: TextReshape}>}
+         */
+        update: (textId: string, body: any, auditMessage?: string, { base, versioned, tokenizeLayer }?: {
+            base?: string;
+            versioned?: boolean;
+            tokenizeLayer?: string;
+        }) => Promise<PlaidText & {
+            reshape: TextReshape;
+        }>;
+        /**
+         * Change a text's body by the edits made at the caret: a list of edit
+         * directives as `update` takes them (code-point indices, applied in
+         * order, each index in the body the ones before it left). Only their
+         * net change counts. An insert or a delete stays where it was made, and
+         * a stretch deleted and typed over is read as a whole new body is. The
+         * answer is the text with its new `digest` and `reshape` (the tokens
+         * moved, the spans and vocab links trimmed, the rows deleted). With
+         * `base`, the digest of the body the edits were made on, the edit
+         * applies only to that body and is refused with 409 and `text-changed`
+         * otherwise, and strict mode does not stamp it unless `versioned` is
+         * true. `tokenizeLayer` is as `update` takes it. See composeTextEdits and gapsToOps.
+         * @param {string} textId - The text ID
+         * @param {Array<object>} edits - The edit directives
+         * @param {string} [auditMessage]
+         * @param {{base?: string, versioned?: boolean, tokenizeLayer?: string}} [options]
+         * @returns {Promise<PlaidText & {reshape: TextReshape}>}
+         */
+        edit: (textId: string, edits: Array<object>, auditMessage?: string, { base, versioned, tokenizeLayer }?: {
+            base?: string;
+            versioned?: boolean;
+            tokenizeLayer?: string;
+        }) => Promise<PlaidText & {
+            reshape: TextReshape;
+        }>;
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<PlaidText>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<PlaidText>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<PlaidText>;
+    };
+    users: {
+        /**
+         * List (or search) users. Transparently follows pagination cursors and
+         * returns the full flat array. Admin-or-maintainer only.
+         * @param {object} [opts]
+         * @param {string} [opts.q] - Filter to users whose display name contains this text, or whose email starts with it (contains it, when the text holds an at sign), case-insensitive
+         * @returns {Promise<User[]>}
+         */
+        list: ({ q }?: {
+            q?: string;
+        }) => Promise<User[]>;
+        /**
+         * Fetch a single page of users (optionally filtered by `q`).
+         * @param {object} [opts]
+         * @param {string} [opts.q] - Filter to users whose display name contains this text, or whose email starts with it (contains it, when the text holds an at sign), case-insensitive
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<User>>}
+         */
+        listPage: ({ q, limit, cursor }?: {
+            q?: string;
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<User>>;
+        /**
+         * Async-iterate users page by page; yields each page's entries array.
+         * @param {object} [opts]
+         * @param {string} [opts.q] - Filter to users whose display name contains this text, or whose email starts with it (contains it, when the text holds an at sign), case-insensitive
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<User[]>}
+         */
+        iterPages: ({ q, pageSize }?: {
+            q?: string;
+            pageSize?: number;
+        }) => AsyncGenerator<User[]>;
+        /**
+         * Create a new user. Admin only, and not with a named API token (403):
+         * it needs a sign-in token.
+         * @param {string} email - The account's email address. It becomes the
+         *   user's id and is what they log in with; it can never be changed.
+         * @param {string} password - The password
+         * @param {boolean} isAdmin - Whether the user is an admin
+         * @param {string} [displayName] - How the user is shown in the UI.
+         *   Defaults to the local part of the email.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Created>}
+         */
+        create: (email: string, password: string, isAdmin: boolean, displayName?: string, auditMessage?: string) => Promise<Created>;
+        /**
+         * Get audit log for a user's actions. Transparently follows pagination
+         * cursors and returns the full flat array.
+         * @param {string} userId - The user ID
+         * @param {string} [startTime] - Start of time range
+         * @param {string} [endTime] - End of time range
+         * @param {string[]|string} [opTypes] - Only return operations of these
+         *   types, spelled as in an entry's `op/type` (e.g.
+         *   `['span-layer/create', 'span-layer/delete']`). An entry appears when
+         *   one of its operations matches, carrying only the ones that did.
+         * @param {string[]|string} [kinds] - Only the entries of operations of
+         *   these kinds (e.g. `['review', 'guess-adoption']`), each whole
+         * @returns {Promise<AuditEntry[]>}
+         */
+        audit: (userId: string, startTime?: string, endTime?: string, opTypes?: string[] | string, kinds?: string[] | string) => Promise<AuditEntry[]>;
+        /**
+         * One page of the same log, newest-first with `order: "desc"`. Use this
+         * rather than audit() wherever the caller wants the recent end of a log
+         * that may be long: audit() walks every page before it resolves.
+         * @param {string} userId - The user ID
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only entries at or after this instant
+         * @param {string} [opts.endTime] - Only entries at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types
+         * @param {OperationKind[]|string} [opts.kinds] - Only the entries of operations of these kinds, each whole
+         * @param {"asc"|"desc"} [opts.order] - "desc" pages newest-first
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {number} [opts.opsLimit] - Keep only each entry's oldest N
+         *   operations in `ops` (1..1000). `opCount` on every entry says how
+         *   many it has
+         * @param {string} [opts.entryId] - Read only this entry, not a page
+         * @returns {Promise<Page<AuditEntry>>}
+         */
+        auditPage: (userId: string, { startTime, endTime, opTypes, kinds, order, limit, cursor, opsLimit, entryId }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: OperationKind[] | string;
+            order?: "asc" | "desc";
+            limit?: number;
+            cursor?: string;
+            opsLimit?: number;
+            entryId?: string;
+        }) => Promise<Page<AuditEntry>>;
+        /**
+         * Get a user by ID
+         * @param {string} id - The resource ID
+         * @returns {Promise<User>}
+         */
+        get: (id: string) => Promise<User>;
+        /**
+         * Deactivate a user. Users are never hard-deleted: deactivation
+         * rejects their logins and tokens, strips their project memberships
+         * and vocab maintainerships, and revokes their API tokens. The user
+         * stays visible in listings with a deactivated-at timestamp.
+         * Reversible via activate(), which restores login only.
+         * @param {string} id - The resource ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (id: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Reactivate a deactivated user, restoring their ability to log in.
+         * Project memberships, vocab maintainerships, and API tokens removed
+         * at deactivation are NOT restored — re-grant them deliberately.
+         * @param {string} id - The resource ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<User>}
+         */
+        activate: (id: string, auditMessage?: string) => Promise<User>;
+        /**
+         * Modify a user. Admins may change the display name, password, and admin
+         * status of any user. All other users may only modify their own display
+         * name or password. A password change cannot be made with a named API
+         * token (403): it needs a sign-in token.
+         *
+         * A user's id is their email address and is fixed for the life of the
+         * account — it is what they log in with, so nothing can change it.
+         * @param {string} id - The resource ID (the user's email address)
+         * @param {string} [password] - New password
+         * @param {string} [displayName] - New display name
+         * @param {boolean} [isAdmin] - New admin status
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<User>}
+         */
+        update: (id: string, password?: string, displayName?: string, isAdmin?: boolean, auditMessage?: string) => Promise<User>;
+        /**
+         * A token that shows any user's profile picture without an
+         * Authorization header, for an `<img>`, which cannot send one. Resolves
+         * to `{ token, expiresAt }` (`expiresAt` an ISO-8601 instant, a day on by
+         * default). The server refuses it on every route but the picture, and
+         * it stops working when the user signs out or changes password.
+         *
+         * One token serves the whole client: it is kept and handed out again
+         * until under ten minutes of it remain (half its life, for one minted
+         * near the end of a login), calls made while one is being minted share
+         * that request, and it is dropped when the client's token changes.
+         * avatarUrl() uses it.
+         * @param {{renew?: boolean}} [options] - `renew`: mint a new one
+         *   whatever is kept, unless one was minted in the last few seconds
+         *   (or is being minted), which is shared
+         * @returns {Promise<{token: string, expiresAt: string}>}
+         */
+        avatarToken: ({ renew }?: {
+            renew?: boolean;
+        }) => Promise<{
+            token: string;
+            expiresAt: string;
+        }>;
+        /**
+         * Build a URL for a user's profile picture, for an `<img>` src. The
+         * URL carries the client's avatar token (see avatarToken()), never the
+         * login token.
+         *
+         * Pass the user record's `avatarHash` as the second argument whenever you
+         * have it: the URL then addresses that exact picture, so the browser can
+         * cache it indefinitely and still pick up a replacement the moment the
+         * user changes it. Resolves to null when `avatarHash` is null (the user
+         * has no picture), so callers can fall back to initials without a
+         * wasted request.
+         * @param {string} id - The user ID
+         * @param {string|null} [avatarHash] - The user record's `avatarHash`
+         * @param {{renew?: boolean}} [options] - `renew`: mint a new avatar
+         *   token first, for a picture its URL failed to load (the token
+         *   stops working when the login it was minted under ends)
+         * @returns {Promise<string|null>}
+         */
+        avatarUrl: (id: string, avatarHash?: string | null, { renew }?: {
+            renew?: boolean;
+        }) => Promise<string | null>;
+        /**
+         * Fetch a user's profile picture as raw bytes. Most callers want
+         * avatarUrl() instead. This one is for non-browser consumers.
+         * @param {string} id - The user ID
+         * @returns {Promise<ArrayBuffer>}
+         */
+        getAvatar: (id: string) => Promise<ArrayBuffer>;
+        /**
+         * Upload a profile picture. Your own, or anyone's if you are an admin.
+         * The server center-crops to a square, scales to the configured edge
+         * length, and re-encodes, so no client-side resizing is needed. Accepts
+         * PNG, JPEG, WebP, and GIF. Resolves to the updated user record.
+         * @param {string} id - The user ID
+         * @param {File} file - The image to upload
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<User>}
+         */
+        setAvatar: (id: string, file: File, auditMessage?: string) => Promise<User>;
+        /**
+         * Remove a profile picture. Your own, or anyone's if you are an admin.
+         * @param {string} id - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        deleteAvatar: (id: string, auditMessage?: string) => Promise<void>;
+    };
+    userData: {
+        /**
+         * List a user's private data entries ({key, updatedAt}, plus value when
+         * includeValues), ordered by key. Owner or admin only. Transparently
+         * follows pagination cursors and returns the full flat array.
+         *
+         * Narrow with `prefix` (the literal head of a key) and/or `pattern`, a
+         * GLOB over the whole key (`*` any run, `?` one character) — the way to
+         * ask for a key convention identified by a segment in the middle, e.g.
+         * `igt:assistant:*:meta:*` for every conversation's sidebar entry across
+         * every project without dragging down the transcripts beside them.
+         *
+         * `pageSize` is exposed here, and defaults lower than elsewhere, because
+         * one value runs to megabytes (`userDataValueBytes` in
+         * `server.limits()`): a page of them with `includeValues` is the
+         * largest response this API can be asked for. Raise it when the listing
+         * is keys, or the values are known to be small.
+         * @param {string} userId
+         * @param {object} [opts]
+         * @param {string} [opts.prefix] - Only keys starting with this prefix
+         * @param {string} [opts.pattern] - Only keys matching this GLOB
+         * @param {boolean} [opts.includeValues] - Also return each entry's value
+         * @param {number} [opts.pageSize=100] - Entries per request (1..1000)
+         * @returns {Promise<UserDataEntry[]>}
+         */
+        list: (userId: string, { prefix, pattern, includeValues, pageSize }?: {
+            prefix?: string;
+            pattern?: string;
+            includeValues?: boolean;
+            pageSize?: number;
+        }) => Promise<UserDataEntry[]>;
+        /**
+         * One page of a user's private data entries, ordered by key.
+         * @param {string} userId
+         * @param {object} [opts]
+         * @param {string} [opts.prefix] - Only keys starting with this prefix
+         * @param {string} [opts.pattern] - Only keys matching this GLOB
+         * @param {boolean} [opts.includeValues] - Also return each entry's value
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<UserDataEntry>>}
+         */
+        listPage: (userId: string, { prefix, pattern, includeValues, limit, cursor }?: {
+            prefix?: string;
+            pattern?: string;
+            includeValues?: boolean;
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<UserDataEntry>>;
+        /**
+         * Async generator over a user's private data entries, one page at a time.
+         * @param {string} userId
+         * @param {object} [opts]
+         * @param {string} [opts.prefix] - Only keys starting with this prefix
+         * @param {string} [opts.pattern] - Only keys matching this GLOB
+         * @param {boolean} [opts.includeValues] - Also return each entry's value
+         * @param {number} [opts.pageSize=100] - Entries per request (1..1000)
+         * @returns {AsyncGenerator<UserDataEntry[]>}
+         */
+        iterPages: (userId: string, { prefix, pattern, includeValues, pageSize }?: {
+            prefix?: string;
+            pattern?: string;
+            includeValues?: boolean;
+            pageSize?: number;
+        }) => AsyncGenerator<UserDataEntry[]>;
+        /**
+         * Read one private data entry ({key, updatedAt, version, value}); 404 if absent.
+         * @param {string} userId
+         * @param {string} key
+         * @returns {Promise<UserDataEntry & {value: any}>}
+         */
+        get: (userId: string, key: string) => Promise<UserDataEntry & {
+            value: any;
+        }>;
+        /**
+         * Create or replace one private data entry. `value` is any JSON, up to
+         * the server's `userDataValueBytes` (`server.limits()`, 5 MB by
+         * default), and is refused with 413 over it, after which
+         * `server.limits()` answers the figure the server has now. Not audited,
+         * not batchable.
+         *
+         * The server stores it verbatim, but this client recases object keys on
+         * the way out and back like any other body (`myKey` <-> `my-key`), so a
+         * value whose keys are camelCase round-trips unchanged while one keyed
+         * by arbitrary strings does not. Put such a map under a `metadata` key,
+         * which both clients pass through untouched.
+         *
+         * Every write raises the entry's `version` by one, and reads answer it.
+         * With `version`, the write lands only when the entry is still at that
+         * version (0: only when there is no entry), and is otherwise refused with
+         * 409, `error: "version-mismatch"`, and the stored `version` and
+         * `updatedAt` on the error's `responseData`: read it again and make the
+         * change on what is there.
+         * @param {string} userId
+         * @param {string} key
+         * @param {*} value
+         * @param {object} [opts]
+         * @param {number} [opts.version] - The version this write was made from
+         * @returns {Promise<{key: string, updatedAt: string, version: number}>}
+         */
+        put: (userId: string, key: string, value: any, { version }?: {
+            version?: number;
+        }) => Promise<{
+            key: string;
+            updatedAt: string;
+            version: number;
+        }>;
+        /**
+         * Delete one private data entry; 404 if absent.
+         * @param {string} userId
+         * @param {string} key
+         * @returns {Promise<void>}
+         */
+        delete: (userId: string, key: string) => Promise<void>;
+    };
+    apiTokens: {
+        /**
+         * List a user's named API tokens. Never includes the signed token
+         * string itself — that is only returned once, by create().
+         * Transparently follows pagination cursors and returns the full flat array.
+         * @param {string} userId - The user ID who owns the tokens
+         * @returns {Promise<ApiToken[]>}
+         */
+        list: (userId: string) => Promise<ApiToken[]>;
+        /**
+         * Fetch a single page of a user's named API tokens.
+         * @param {string} userId - The user ID who owns the tokens
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<ApiToken>>}
+         */
+        listPage: (userId: string, { limit, cursor }?: {
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<ApiToken>>;
+        /**
+         * Async-iterate a user's named API tokens page by page; yields each
+         * page's entries array.
+         * @param {string} userId - The user ID who owns the tokens
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<ApiToken[]>}
+         */
+        iterPages: (userId: string, { pageSize }?: {
+            pageSize?: number;
+        }) => AsyncGenerator<ApiToken[]>;
+        /**
+         * Mint a named API token for a user. The returned `token` is the signed
+         * credential and is shown ONLY here — store it immediately. API tokens
+         * do not expire and survive password changes / logout; revoke to kill.
+         * A client signed in with a named API token cannot do this (403): it
+         * needs a sign-in token.
+         * @param {string} userId - The user ID who will own the token
+         * @param {string} name - A human label, e.g. "Stanza parser"
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{id: string, name: string, token: string}>}
+         */
+        create: (userId: string, name: string, auditMessage?: string) => Promise<{
+            id: string;
+            name: string;
+            token: string;
+        }>;
+        /**
+         * Revoke a named API token (soft-revoke; idempotent).
+         * A client signed in with a named API token cannot do this (403): it
+         * needs a sign-in token.
+         * @param {string} userId - The user ID who owns the token
+         * @param {string} tokenId - The token ID to revoke
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        revoke: (userId: string, tokenId: string, auditMessage?: string) => Promise<void>;
+    };
+    invites: {
+        /**
+         * List invites you minted, oldest first. With `projectId`, lists that
+         * project's invites instead (including co-maintainers'), which requires
+         * maintainer or admin on it. Never includes invite codes — the code is
+         * returned once, by create(), and is not recoverable afterward.
+         * Transparently follows pagination cursors and returns the full flat array.
+         * @param {object} [opts]
+         * @param {string} [opts.projectId] - List this project's invites instead of your own
+         * @param {boolean} [opts.all] - List every invite on the server (admin only)
+         * @returns {Promise<Invite[]>}
+         */
+        list: ({ projectId, all }?: {
+            projectId?: string;
+            all?: boolean;
+        }) => Promise<Invite[]>;
+        /**
+         * Fetch a single page of invites.
+         * @param {object} [opts]
+         * @param {string} [opts.projectId] - List this project's invites instead of your own
+         * @param {boolean} [opts.all] - List every invite on the server (admin only)
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<Invite>>}
+         */
+        listPage: ({ projectId, all, limit, cursor }?: {
+            projectId?: string;
+            all?: boolean;
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<Invite>>;
+        /**
+         * Async-iterate invites page by page; yields each page's entries array.
+         * @param {object} [opts]
+         * @param {string} [opts.projectId] - List this project's invites instead of your own
+         * @param {boolean} [opts.all] - List every invite on the server (admin only)
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<Invite[]>}
+         */
+        iterPages: ({ projectId, all, pageSize }?: {
+            projectId?: string;
+            all?: boolean;
+            pageSize?: number;
+        }) => AsyncGenerator<Invite[]>;
+        /**
+         * Mint an invite. The returned `code` is shown ONLY here — it is never
+         * stored and cannot be recovered, so build and hand off the link now.
+         * Use PlaidClient.inviteUrl() to turn it into one.
+         *
+         * Admins may mint anything. A project maintainer may mint role grants on
+         * projects they maintain, and nothing else: no admin grant, no grantless
+         * invite, no password resets — so for a non-admin, projectId/projectRole
+         * are required in practice (403 without them).
+         *
+         * Needs a signed-in session: a client signed in with a named API token
+         * cannot mint any invite (403).
+         *
+         * EVERY option is optional; `create()` with no arguments mints a
+         * single-use signup link granting nothing but an account. Two pairing
+         * rules the server enforces with a 400: projectId and projectRole must be
+         * given TOGETHER, and targetUserId may not be combined with projectId,
+         * grantAdmin, or a maxUses above 1.
+         * @param {object} [opts]
+         * @param {string} [opts.projectId] - Project the redeemer joins (requires projectRole)
+         * @param {string} [opts.projectRole] - "reader" | "writer" | "maintainer" (requires projectId)
+         * @param {boolean} [opts.grantAdmin] - Make the new account a global admin (admin only)
+         * @param {string} [opts.targetUserId] - Password reset for that user instead of a signup; admin only, single-use, grants nothing
+         * @param {number} [opts.maxUses] - How many accounts this link may create (default 1)
+         * @param {number} [opts.ttlDays] - Days until it expires (default 14, max 365)
+         * @param {string} [opts.note] - Human label shown in your invite list
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Invite & {code: string}>}
+         */
+        create: ({ projectId, projectRole, grantAdmin, targetUserId, maxUses, ttlDays, note, }?: {
+            projectId?: string;
+            projectRole?: string;
+            grantAdmin?: boolean;
+            targetUserId?: string;
+            maxUses?: number;
+            ttlDays?: number;
+            note?: string;
+        }, auditMessage?: string) => Promise<Invite & {
+            code: string;
+        }>;
+        /**
+         * Revoke an invite, killing the link immediately. Idempotent. Allowed for
+         * the creator, an admin, or a maintainer of the invite's project.
+         * @param {string} id - The invite ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        revoke: (id: string, auditMessage?: string) => Promise<void>;
+    };
+    admin: {
+        /**
+         * Everything about the server in one read: version and JVM uptime,
+         * database size and per-table row counts, media directory usage, backup
+         * configuration and the backups on disk, and the settings an operator
+         * gets asked to confirm. Carries no secrets. Runs a count per table and
+         * walks the media directory, so open it, do not poll it. Admin only.
+         * @returns {Promise<ServerReport>}
+         */
+        server: () => Promise<ServerReport>;
+        /**
+         * Take a database backup right now, outside the nightly schedule.
+         * Resolves to the backup block with `ok` reporting whether the snapshot
+         * succeeded. Uses VACUUM INTO, which only reads, so it is safe while
+         * people are working. Admin only.
+         *
+         * The server answers once the backup is written, which takes minutes on
+         * a large database, so this waits up to `BACKUP_TIMEOUT_MS` (30 minutes)
+         * rather than the client's usual timeout. A proxy in front of the server
+         * may still give up first (a 504): the backup goes on, and its file
+         * shows in `server().backup.backups` once it is written.
+         * @returns {Promise<BackupStatus>}
+         *
+         * outOfBand, as every admin action on the server itself is: none of them
+         * writes project data (see the note at the top of http.js).
+         */
+        backup: () => Promise<BackupStatus>;
+        /**
+         * Documents currently held by an editing lock, with who holds each and
+         * when it expires on its own. Admin only.
+         * @returns {Promise<{entries: Array<{documentId: string, userId: string, expiresAt: number}>}>}
+         */
+        locks: () => Promise<{
+            entries: Array<{
+                documentId: string;
+                userId: string;
+                expiresAt: number;
+            }>;
+        }>;
+        /**
+         * Drop the lock on a document whoever holds it. Idempotent. For a client
+         * that went away without releasing one. Admin only.
+         * @param {string} documentId - The document ID
+         * @returns {Promise<{result: string}>}
+         */
+        releaseLock: (documentId: string) => Promise<{
+            result: string;
+        }>;
+        /**
+         * Live login and invite rate-limit buckets: the address, the account
+         * where there is one, failures inside the window, the limit, and whether
+         * it is currently blocking. Admin only.
+         * @returns {Promise<RateLimitSnapshot>}
+         */
+        rateLimits: () => Promise<RateLimitSnapshot>;
+        /**
+         * Forget recorded rate-limit failures. With `ip`, clears that address,
+         * narrowed to one account with `userId`. With neither, clears every
+         * bucket. Only ever unblocks. Admin only.
+         * @param {object} [opts]
+         * @param {string} [opts.ip] - Clear only this address
+         * @param {string} [opts.userId] - Narrow to one account on that address
+         * @returns {Promise<{result: string}>}
+         */
+        clearRateLimits: ({ ip, userId }?: {
+            ip?: string;
+            userId?: string;
+        }) => Promise<{
+            result: string;
+        }>;
+        /**
+         * What the server has logged, structured and filtered, from an in-memory
+         * buffer kept whether or not a log file is configured. `requests` is one
+         * entry per HTTP request (method, path, status, duration, and who made
+         * it), `events` is everything else, with a stack trace where there was
+         * one. They are buffered separately so a burst of requests cannot evict
+         * an error. Both come newest first, `matched` counts what passed the
+         * filters, and request `stats` describe the filtered set. Covers Plaid's
+         * own log stream since the last restart: for library messages and older
+         * history, see `logFile`. Admin only.
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Max entries per kind (default 200, max 2000)
+         * @param {string} [opts.q] - Substring of any field, case-insensitive
+         * @param {string} [opts.level] - Minimum level for events, e.g. "warn"
+         * @param {string} [opts.status] - "2xx".."5xx", an exact code, or "failures"
+         * @param {string} [opts.user] - Only requests made by this account
+         * @param {string} [opts.method] - Only requests with this HTTP method
+         * @returns {Promise<LiveLog>}
+         */
+        logs: ({ limit, q, level, status, user, method }?: {
+            limit?: number;
+            q?: string;
+            level?: string;
+            status?: string;
+            user?: string;
+            method?: string;
+        }) => Promise<LiveLog>;
+        /**
+         * The tail of the configured log file, as text lines. The only place
+         * third-party library messages and anything from before the last restart
+         * can be read. Resolves with an `error` string instead of lines when no
+         * log file is configured or it does not exist yet. Admin only.
+         * @param {object} [opts]
+         * @param {number} [opts.lines] - How many lines (default 200, max 2000)
+         * @returns {Promise<{file: (string|null), lines: string[], error?: string}>}
+         */
+        logFile: ({ lines }?: {
+            lines?: number;
+        }) => Promise<{
+            file: (string | null);
+            lines: string[];
+            error?: string;
+        }>;
+        /**
+         * Private user-data entries across every account, each carrying its
+         * `userId`. `/users/:userId/data` has always been owner-or-admin; this
+         * is the same reach across accounts at once. Transparently follows
+         * pagination cursors and returns the full flat array. Admin only.
+         *
+         * Narrow with `prefix` (the literal head of a key) and/or `pattern`, a
+         * GLOB over the whole key (`*` any run, `?` one character) — the way to
+         * ask for a key convention identified by a segment in the middle, e.g.
+         * `igt:assistant:*:meta:*`. Values come only with `includeValues`, and
+         * are recased like any other body (see `userData.put`).
+         * @param {object} [opts]
+         * @param {string} [opts.prefix] - Only keys starting with this
+         * @param {string} [opts.pattern] - Only keys matching this GLOB
+         * @param {boolean} [opts.includeValues] - Also return each entry's value
+         * @returns {Promise<AdminUserDataEntry[]>}
+         */
+        userData: ({ prefix, pattern, includeValues }?: {
+            prefix?: string;
+            pattern?: string;
+            includeValues?: boolean;
+        }) => Promise<AdminUserDataEntry[]>;
+        /**
+         * One page of private user-data entries across accounts, ordered by
+         * (user, key). Admin only.
+         * @param {object} [opts]
+         * @param {string} [opts.prefix] - Only keys starting with this
+         * @param {string} [opts.pattern] - Only keys matching this GLOB
+         * @param {boolean} [opts.includeValues] - Also return each entry's value
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<AdminUserDataEntry>>}
+         */
+        userDataPage: ({ prefix, pattern, includeValues, limit, cursor }?: {
+            prefix?: string;
+            pattern?: string;
+            includeValues?: boolean;
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<AdminUserDataEntry>>;
+    };
+    audit: {
+        /**
+         * The audit log across every project, oldest first. Same fold, window
+         * and op-type filter as the per-project read, with the entity scope
+         * dropped. Admin only. Transparently follows pagination cursors and
+         * returns the full flat array.
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only operations at or after this instant
+         * @param {string} [opts.endTime] - Only operations at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types (e.g.
+         *   `['span-layer/create']`). An entry appears when one of its operations
+         *   matches, carrying only the ones that did.
+         * @param {string[]|string} [opts.kinds] - Only the entries of operations
+         *   of these kinds (e.g. `['review']`), each whole
+         * @returns {Promise<AuditEntry[]>}
+         */
+        list: ({ startTime, endTime, opTypes, kinds }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: string[] | string;
+        }) => Promise<AuditEntry[]>;
+        /**
+         * Fetch a single page of the instance-wide audit log. Admin only.
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only entries at or after this instant
+         * @param {string} [opts.endTime] - Only entries at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types
+         * @param {OperationKind[]|string} [opts.kinds] - Only the entries of operations of these kinds, each whole
+         * @param {"asc"|"desc"} [opts.order] - "desc" pages newest-first, which
+         *   is what a feed wants. A cursor belongs to the direction that made it.
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {number} [opts.opsLimit] - Keep only each entry's oldest N
+         *   operations in `ops` (1..1000). `opCount` on every entry says how
+         *   many it has
+         * @param {string} [opts.entryId] - Read only this entry, not a page
+         * @returns {Promise<Page<AuditEntry>>}
+         */
+        listPage: ({ startTime, endTime, opTypes, kinds, order, limit, cursor, opsLimit, entryId }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: OperationKind[] | string;
+            order?: "asc" | "desc";
+            limit?: number;
+            cursor?: string;
+            opsLimit?: number;
+            entryId?: string;
+        }) => Promise<Page<AuditEntry>>;
+        /**
+         * Async-iterate the instance-wide audit log page by page. Admin only.
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only entries at or after this instant
+         * @param {string} [opts.endTime] - Only entries at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types
+         * @param {OperationKind[]|string} [opts.kinds] - Only the entries of operations of these kinds, each whole
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<AuditEntry[]>}
+         */
+        iterPages: ({ startTime, endTime, opTypes, kinds, pageSize }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: OperationKind[] | string;
+            pageSize?: number;
+        }) => AsyncGenerator<AuditEntry[]>;
+        /**
+         * Per-user activity counts. `changes` is the number of logical actions,
+         * folded the way the audit feed folds them, so one "Confirm word
+         * analysis" counts once however many rows it wrote; `operations` is the
+         * unfolded row count. Only users who did something appear — subtract
+         * from the roster you already hold to find the ones who did not.
+         *
+         * With `projectId`, scoped to that project and open to its maintainers.
+         * Without one, instance-wide and admin only.
+         * @param {object} [opts]
+         * @param {string} [opts.projectId] - Scope to one project
+         * @param {string} [opts.startTime] - Only count at or after this instant
+         * @param {string} [opts.endTime] - Only count at or before this instant
+         * @param {boolean} [opts.daily] - Also return `byDay`, a list of
+         *   `{date, changes}` per user, oldest first, at the cost of a second
+         *   grouped scan
+         * @returns {Promise<ActivityTallyRow[]>}
+         */
+        tally: ({ projectId, startTime, endTime, daily }?: {
+            projectId?: string;
+            startTime?: string;
+            endTime?: string;
+            daily?: boolean;
+        }) => Promise<ActivityTallyRow[]>;
+    };
+    tokenLayers: {
+        /**
+         * Declare an app namespace's constraints on this layer, replacing that
+         * namespace's list. Refused with 422 and the violations when the layer's
+         * stored data breaks them (see violationsOf).
+         * @param {string} layerId - The layer ID
+         * @param {string} namespace - The declaring app's namespace, e.g. "igt"
+         * @param {LayerConstraint[]} constraints - e.g. [{type: "single-span"}, {type: "value-set", values: ["N"]}]
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: Array<object>|null}} [options] - `expected`: the list read for this
+         *   namespace (null when it was absent). The write is then refused with a 409 when the stored
+         *   list differs.
+         * @returns {Promise<{constraints: Record<string, LayerConstraint[]>}>} the layer's whole constraint map
+         */
+        setConstraints: (layerId: string, namespace: string, constraints: LayerConstraint[], auditMessage?: string, options?: {
+            expected?: Array<object> | null;
+        }) => Promise<{
+            constraints: Record<string, LayerConstraint[]>;
+        }>;
+        /**
+         * Remove an app namespace's constraints from this layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} namespace - The declaring app's namespace
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: Array<object>|null}} [options] - `expected`, as on setConstraints.
+         * @returns {Promise<void>}
+         */
+        deleteConstraints: (layerId: string, namespace: string, auditMessage?: string, options?: {
+            expected?: Array<object> | null;
+        }) => Promise<void>;
+        /**
+         * The violations the given constraints would meet in this layer's stored
+         * data. Writes nothing.
+         * @param {string} layerId - The layer ID
+         * @param {LayerConstraint[]} constraints - The list to check
+         * @param {{limit?: number}} [options] - `limit`: how many violations to list (default 100)
+         * @returns {Promise<{violations: ConstraintViolation[], violationCount: number}>}
+         */
+        checkConstraints: (layerId: string, constraints: LayerConstraint[], options?: {
+            limit?: number;
+        }) => Promise<{
+            violations: ConstraintViolation[];
+            violationCount: number;
+        }>;
+        /**
+         * Apply the remedies of the given constraints' remediable types
+         * (coextensive, single-span, single-link, same-ancestor) to every
+         * violation in this layer's stored data, one operation per document.
+         * With `document`, only that document is repaired, and a writer may
+         * ask. A document another user holds the lock on is left as it is and
+         * listed under `locked`.
+         * @param {string} layerId - The layer ID
+         * @param {LayerConstraint[]} constraints - The list to repair for
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{document?: string}} [options]
+         * @returns {Promise<{repaired: ConstraintRepair[], locked: Array<{document: string, lockedBy: string}>, violations: ConstraintViolation[], violationCount: number}>}
+         */
+        repairConstraints: (layerId: string, constraints: LayerConstraint[], auditMessage?: string, options?: {
+            document?: string;
+        }) => Promise<{
+            repaired: ConstraintRepair[];
+            locked: Array<{
+                document: string;
+                lockedBy: string;
+            }>;
+            violations: ConstraintViolation[];
+            violationCount: number;
+        }>;
+        /**
+         * Set a configuration value in an editor namespace.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {any} configValue - Configuration value to set
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`: the value read for this key (null or undefined when it
+         *   was absent). The write is then refused with a 409 when the stored value differs. A value the key
+         *   already holds is not written and leaves no audit row, so the value read, expecting it, states in a
+         *   batch that the key is unchanged.
+         * @returns {Promise<void>}
+         */
+        setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Remove a configuration value.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`, as on setConfig. A key that is absent is not
+         *   written, so expecting null states in a batch that it is still absent.
+         * @returns {Promise<void>}
+         */
+        deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Count, per document, the tokens of each layer whose surface matches a
+         * regex, as a query's `value: {regex}` on a token decides. Each text is
+         * read once, so it stays fast on a long document. Layers you cannot read
+         * are left out.
+         * @param {string[]} layerIds - The token layer ids
+         * @param {{regex: string, flags?: string}} value - The regex spec
+         * @returns {Promise<{results: Array<[string, string, number]>}>} [layerId,
+         *   documentId, count] rows, a document with tokens of the layer and no
+         *   match counting 0.
+         */
+        countMatching: (layerIds: string[], value: {
+            regex: string;
+            flags?: string;
+        }) => Promise<{
+            results: Array<[string, string, number]>;
+        }>;
+        /**
+         * Create a new token layer.
+         * @param {string} textLayerId - The text layer ID
+         * @param {string} name - The name
+         * @param {string} [overlapMode] - Per-layer, immutable token invariant: "any" (default), "non-overlapping", or "partitioning". On partitioning layers, single token create/update/delete are rejected; use bulkCreate plus split/merge/shift.
+         * @param {string} [parentTokenLayerId] - Optional immutable parent token layer. Tokens in this layer must nest within a parent-layer token; the parent layer must be in the same text layer and be "non-overlapping" or "partitioning" (an "any" parent is rejected). A nested layer may be "any" or "non-overlapping" but not "partitioning" (partitioning is only for root layers), e.g. words (non-overlapping, parent=sentences) within sentences (partitioning).
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (textLayerId: string, name: string, overlapMode?: string, parentTokenLayerId?: string, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a layer by ID.
+         * @param {string} layerId - The layer ID
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        get: (layerId: string) => Promise<TokenLayer>;
+        /**
+         * Delete a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (layerId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Rename a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} name - The new name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        update: (layerId: string, name: string, auditMessage?: string) => Promise<TokenLayer>;
+        /**
+         * Move a layer one place in its display order.
+         * @param {string} layerId - The layer ID
+         * @param {string} direction - The direction ("up" or "down")
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+    };
+    documents: {
+        /**
+         * Get audit log for a document. Transparently follows pagination cursors
+         * and returns the full flat array. Each entry, and each of its `ops`,
+         * says what kind of credential made it as `credential`: `login`,
+         * `named-token` or `delegated` (absent on older operations, `service`
+         * on some from 2026-10-06 to 2026-10-08),
+         * beside `apiToken` (the named token's id and name) when there was one.
+         * @param {string} documentId - The document ID
+         * @param {string} [startTime] - Start of time range
+         * @param {string} [endTime] - End of time range
+         * @param {string[]|string} [opTypes] - Only return operations of these
+         *   types, spelled as in an entry's `op/type` (e.g.
+         *   `['span-layer/create', 'span-layer/delete']`). An entry appears when
+         *   one of its operations matches, carrying only the ones that did.
+         * @param {string[]|string} [kinds] - Only the entries of operations of
+         *   these kinds (e.g. `['review', 'guess-adoption']`), each whole
+         * @returns {Promise<AuditEntry[]>}
+         */
+        audit: (documentId: string, startTime?: string, endTime?: string, opTypes?: string[] | string, kinds?: string[] | string) => Promise<AuditEntry[]>;
+        /**
+         * One page of the same log, newest-first with `order: "desc"`. Use this
+         * rather than audit() wherever the caller wants the recent end of a log
+         * that may be long: audit() walks every page before it resolves.
+         * @param {string} documentId - The document ID
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only entries at or after this instant
+         * @param {string} [opts.endTime] - Only entries at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types
+         * @param {OperationKind[]|string} [opts.kinds] - Only the entries of operations of these kinds, each whole
+         * @param {"asc"|"desc"} [opts.order] - "desc" pages newest-first
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {number} [opts.opsLimit] - Keep only each entry's oldest N
+         *   operations in `ops` (1..1000). `opCount` on every entry says how
+         *   many it has
+         * @param {string} [opts.entryId] - Read only this entry, not a page
+         * @returns {Promise<Page<AuditEntry>>}
+         */
+        auditPage: (documentId: string, { startTime, endTime, opTypes, kinds, order, limit, cursor, opsLimit, entryId }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: OperationKind[] | string;
+            order?: "asc" | "desc";
+            limit?: number;
+            cursor?: string;
+            opsLimit?: number;
+            entryId?: string;
+        }) => Promise<Page<AuditEntry>>;
+        /**
+         * Restore a document to its state at an earlier time, as one
+         * operation: what was deleted since then comes back under its original
+         * id, what was added since is removed, and what changed is set back,
+         * across every layer. A layer deleted since then, or a vocabulary entry
+         * that no longer exists, is skipped and reported under `skipped`. A name
+         * another document holds now stays with it, and the document keeps its
+         * current name, reported under `nameKept` (`{name, taken}`).
+         * Resolves to a summary of the changes. Maintainers only.
+         * @param {string} documentId - The document ID
+         * @param {string} asOf - The moment to go back to (ISO-8601 instant),
+         *   typically a history entry's `endTime`
+         * @param {{dryRun?: boolean}} [options] - `{ dryRun }`: with `dryRun` true nothing
+         *   is written and the summary says what would change
+         * @param {string} [auditMessage] - Custom audit message for this operation
+         * @returns {Promise<DocumentRestoreSummary>}
+         */
+        restore: (documentId: string, asOf: string, { dryRun }?: {
+            dryRun?: boolean;
+        }, auditMessage?: string) => Promise<DocumentRestoreSummary>;
+        /**
+         * Get a document. Set `includeBody` to true to include all data.
+         *
+         * A document with a recording has `mediaUrl`, and `mediaDuration`, the
+         * recording's length in seconds, when the server could read it from the
+         * file at upload (WAV, MP4, M4A, MOV, FLAC, MP3).
+         *
+         * `layers` narrows a body read to the layers you name (ids of any kind:
+         * text, token, span, or relation). A layer comes back when it is named
+         * or is an ancestor of a named layer, and carries its own
+         * texts/tokens/spans/relations/vocabs only when it is itself named — so
+         * name the text layer too if you also want the text body. An id that is
+         * not a layer of this document's project is an error, not a quietly
+         * smaller response. Requires `includeBody`.
+         * @param {string} documentId - The document ID
+         * @param {boolean} [includeBody] - Include document body data
+         * @param {string} [asOf] - Temporal query timestamp
+         * @param {string[]|string} [layers] - Layer ids to restrict a body read to
+         * @returns {Promise<PlaidDocument>}
+         */
+        get: (documentId: string, includeBody?: boolean, asOf?: string, layers?: string[] | string) => Promise<PlaidDocument>;
+        /**
+         * Delete a document and all data contained.
+         * @param {string} documentId - The document ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (documentId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Update a document's name. A name another document of the project holds,
+         * ignoring case,
+         * is refused with 422 and `name-taken`.
+         * @param {string} documentId - The document ID
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<PlaidDocument>}
+         */
+        update: (documentId: string, name: string, auditMessage?: string) => Promise<PlaidDocument>;
+        /**
+         * Create a new document in a project.
+         * @param {string} projectId - The project ID
+         * @param {string} name - The name
+         * @param {any} [metadata] - Metadata map. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @param {boolean} [opts.freeName] - A name another document of the project holds, ignoring case, becomes
+         *   the first free "name (2)", "name (3)" and on. Without it such a name is refused with 422
+         *   and `name-taken`.
+         * @returns {Promise<{id: string, name: string}>} The new id and the name stored
+         */
+        create: (projectId: string, name: string, metadata?: any, auditMessage?: string, { id, freeName }?: {
+            id?: string;
+            freeName?: boolean;
+        }) => Promise<{
+            id: string;
+            name: string;
+        }>;
+        /**
+         * Copy a document and everything in it into a new document of the same
+         * project, as one operation. The copy shares the source's layers and
+         * the vocabulary entries its links name, and holds the source's texts,
+         * tokens, spans, relations and vocab links under fresh ids, with their
+         * metadata. Comments do not travel. The media file does, unless
+         * `includeMedia` is false. Resolves to `{ id, name }`, plus `mediaError` when
+         * the source had media the copy could not take with it. A name another
+         * document of the project holds, ignoring case, is refused with 422 and `name-taken`,
+         * unless `freeName`, which takes the first free "name (2)", "name (3)"
+         * and on.
+         * @param {string} documentId - The document to copy
+         * @param {string} name - The new document's name
+         * @param {{includeMedia?: boolean, id?: string, freeName?: boolean}} [options] - `{ includeMedia }`: false leaves the media
+         *   file behind
+         * @param {string} [auditMessage] - Custom audit message for this operation
+         * @returns {Promise<{id: string, name: string, mediaError?: string}>}
+         */
+        copy: (documentId: string, name: string, { includeMedia, id, freeName }?: {
+            includeMedia?: boolean;
+            id?: string;
+            freeName?: boolean;
+        }, auditMessage?: string) => Promise<{
+            id: string;
+            name: string;
+            mediaError?: string;
+        }>;
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<PlaidDocument>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<PlaidDocument>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<PlaidDocument>;
+        /**
+         * Check the lock status of a document.
+         * @param {string} documentId - The document ID
+         * @returns {Promise<{userId: string, expiresAt: number} | void>}
+         */
+        checkLock: (documentId: string) => Promise<{
+            userId: string;
+            expiresAt: number;
+        } | void>;
+        /**
+         * Acquire a document lock as a new holder.
+         *
+         * The answer's `lockId` names the holder: `renewLock` and `releaseLock`
+         * take it. While the lock is held, a second acquire is refused with
+         * HTTP 423, whoever makes it, this user included.
+         *
+         * `newLockId` names the holder from the client's side (a fresh UUID). An
+         * acquire whose answer never arrived can then be sent again, which
+         * answers 200 while that holder has the lock, or released. Without it
+         * the server mints the id, and a lost answer leaves a lock nobody can
+         * release until it expires.
+         *
+         * outOfBand: the lock is a signal, not project data (see the note at
+         * the top of http.js). Queued on a batch it would be taken only at
+         * submit, after every write it was meant to guard, and until then answer
+         * success to a caller that does not hold it and cannot see the 423
+         * saying somebody else does.
+         * @param {string} documentId - The document ID
+         * @param {string} [auditMessage]
+         * @param {string} [newLockId] - A holder id this client minted
+         * @returns {Promise<LockGrant>}
+         */
+        acquireLock: (documentId: string, auditMessage?: string, newLockId?: string) => Promise<LockGrant>;
+        /**
+         * Renew the lock `lockId` holds while it is live. HTTP 423 if another
+         * holder has it, and also once it has expired or been dropped, even when
+         * nobody holds the document now: a renewal never takes a free document.
+         * outOfBand, for the same reason as acquireLock.
+         * @param {string} documentId - The document ID
+         * @param {string} lockId - The `lockId` acquireLock answered with
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<LockGrant>}
+         */
+        renewLock: (documentId: string, lockId: string, auditMessage?: string) => Promise<LockGrant>;
+        /**
+         * Release the lock `lockId` holds. Idempotent: a lock that holder no
+         * longer has is left alone. outOfBand, for the same reason as
+         * acquireLock: queued, the lock would be held until the batch submits,
+         * and not released at all if it aborts.
+         * @param {string} documentId - The document ID
+         * @param {string} lockId - The `lockId` acquireLock answered with
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        releaseLock: (documentId: string, lockId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Hold this document's server-enforced lock for the length of `fn`,
+         * releasing it on the way out (including on error). Resolves to what
+         * `fn` returned.
+         *
+         *   await client.documents.locked(docId, async () => {
+         *     // delete + recreate tokens
+         *   });
+         *
+         * Wrap any multi-step, server-side mutation of a document that must not
+         * interleave with a human editor or another service, e.g. a parser or
+         * tokenizer that deletes and recreates a document's tokens, spans and
+         * relations. A single atomic call does not need it. While the lock is
+         * held, writes to the document by ANOTHER user are refused with HTTP
+         * 423; the holder's own writes pass and renew it. If anyone already
+         * holds it, another block of this same user included, this rejects with
+         * a readable 423 and `fn` does not run.
+         *
+         * The lock is renewed for as long as `fn` runs, so work that computes
+         * for minutes before it writes holds the lock the whole time rather than
+         * only for its first minute. If a renewal fails the lock is gone: every
+         * later write from this client throws `DocumentLockLost`, and a block
+         * that got to the end anyway ends with that error rather than reporting
+         * success. `fn` receives a lock handle and may read `lock.lost` (or call
+         * `lock.raiseIfLost()`) to give up sooner.
+         *
+         * The lock is per HOLDER: each block is its own, named by
+         * `lock.lockId`, and only that id renews or releases it. NOT
+         * re-entrant: a nested `locked()` block on one document is a second
+         * holder and gets the 423. Lock at exactly one level per call path.
+         * The block mints its holder id and sends it with the acquire, so an
+         * acquire whose answer was lost is sent again (up to three tries) and,
+         * if none is answered, released rather than left to expire. A
+         * lost lock is recorded on the CLIENT, like strict mode, so it stops
+         * every write the client makes (on any batch of it too) and not only the
+         * ones this block makes.
+         *
+         * A core restart drops every lock, and until the next renewal finds it
+         * gone (up to half the lock window) this block's writes still pass, since
+         * writes carry no lock id. When a write must not land past that point,
+         * hold the document in strict mode too (`enterStrictMode`), so such a
+         * write is refused with a 409.
+         * @template T
+         * @param {string} documentId - The document ID
+         * @param {(lock: import("./documentLock.js").DocumentLock) => T | Promise<T>} fn - The work to run while holding it
+         * @param {{keepAlive?: boolean}} [options] - `{ keepAlive }`: renew on a timer (default true)
+         * @returns {Promise<T>}
+         */
+        locked: <T>(documentId: string, fn: (lock: import("./documentLock.js").DocumentLock) => T | Promise<T>, options?: {
+            keepAlive?: boolean;
+        }) => Promise<T>;
+        /**
+         * Get the media file for a document. Media is not versioned, so there is
+         * no as-of form: the route refuses the parameter. Prefer the document's
+         * own `mediaUrl`, which carries the file's version for caching.
+         * @param {string} documentId - The document ID
+         * @returns {Promise<ArrayBuffer>}
+         */
+        getMedia: (documentId: string) => Promise<ArrayBuffer>;
+        /**
+         * Get a link that plays the document's recording without an
+         * Authorization header, for an audio or video element's `src`, which
+         * cannot send one. `url` is the document's media URL with a
+         * `media-token` added, resolved against the client's base URL. The token
+         * opens only this recording, for this user, and the server refuses it on
+         * every other route. It expires at `expiresAt` (an ISO-8601 instant, six
+         * hours on by default), and sooner when the user signs out, changes
+         * password or loses access to the project: ask for a new link then. A
+         * document with no recording is a 404. Writes nothing, so it takes no
+         * Idempotency-Key and goes over the wire when made on a batch.
+         * @param {string} documentId - The document ID
+         * @returns {Promise<{url: string, expiresAt: string}>}
+         */
+        mediaLink: (documentId: string) => Promise<{
+            url: string;
+            expiresAt: string;
+        }>;
+        /**
+         * Upload a media file for a document. Uses Apache Tika for content validation.
+         * A document that already has a recording refuses it with a 409
+         * (`media-exists`, and the current `media-url`): delete that one first.
+         * A WAV whose samples are not PCM, 32-bit float, A-law or mu-law (IMA or
+         * MS ADPCM, GSM, 64-bit float and the rest), which browsers cannot play,
+         * is refused with a 415 whose `error` names its coding.
+         * @param {string} documentId - The document ID
+         * @param {File} file - The file to upload
+         * @param {string} [auditMessage] - Custom audit-log message for this write
+         * @param {{onProgress?: (progress: {loaded: number, total: number | null}) => void}} [options] - `{ onProgress }`: called with `{ loaded, total }` (bytes) as the file goes up. In a browser the upload then travels by XMLHttpRequest, and the request timeout only fires when the upload stalls, not on total time.
+         * @returns {Promise<{message: string, extension: string, contentType: string}>}
+         */
+        uploadMedia: (documentId: string, file: File, auditMessage?: string, { onProgress }?: {
+            onProgress?: (progress: {
+                loaded: number;
+                total: number | null;
+            }) => void;
+        }) => Promise<{
+            message: string;
+            extension: string;
+            contentType: string;
+        }>;
+        /**
+         * Delete media file for a document
+         * @param {string} documentId - The document ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{mediaVersion?: string}} [options] - `mediaVersion`: the
+         *   recording meant, the `?v=` of the document's `mediaUrl`. The delete
+         *   is refused with a 409 (`media-changed`, and the current `media-url`)
+         *   when the stored recording is another one.
+         * @returns {Promise<void>}
+         */
+        deleteMedia: (documentId: string, auditMessage?: string, { mediaVersion }?: {
+            mediaVersion?: string;
+        }) => Promise<void>;
+    };
+    projects: {
+        /**
+         * Assign a user as a maintainer for this project.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        addMaintainer: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Remove a user's maintainer privileges for this project.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        removeMaintainer: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Get audit log for a project. Transparently follows pagination cursors
+         * and returns the full flat array. Each entry, and each of its `ops`,
+         * says what kind of credential made it as `credential`: `login`,
+         * `named-token` or `delegated` (absent on older operations, `service`
+         * on some from 2026-10-06 to 2026-10-08),
+         * beside `apiToken` (the named token's id and name) when there was one.
+         * @param {string} projectId - The project ID
+         * @param {string} [startTime] - Start of time range
+         * @param {string} [endTime] - End of time range
+         * @param {string[]|string} [opTypes] - Only return operations of these
+         *   types, spelled as in an entry's `op/type` (e.g.
+         *   `['span-layer/create', 'span-layer/delete']`). An entry appears when
+         *   one of its operations matches, carrying only the ones that did.
+         * @param {string[]|string} [kinds] - Only the entries of operations of
+         *   these kinds (e.g. `['review', 'guess-adoption']`), each whole
+         * @returns {Promise<AuditEntry[]>}
+         */
+        audit: (projectId: string, startTime?: string, endTime?: string, opTypes?: string[] | string, kinds?: string[] | string) => Promise<AuditEntry[]>;
+        /**
+         * One page of the same log, newest-first with `order: "desc"`. Use this
+         * rather than audit() wherever the caller wants the recent end of a log
+         * that may be long: audit() walks every page before it resolves.
+         * @param {string} projectId - The project ID
+         * @param {object} [opts]
+         * @param {string} [opts.startTime] - Only entries at or after this instant
+         * @param {string} [opts.endTime] - Only entries at or before this instant
+         * @param {string[]|string} [opts.opTypes] - Only these op types
+         * @param {OperationKind[]|string} [opts.kinds] - Only the entries of operations of these kinds, each whole
+         * @param {"asc"|"desc"} [opts.order] - "desc" pages newest-first
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {number} [opts.opsLimit] - Keep only each entry's oldest N
+         *   operations in `ops` (1..1000). `opCount` on every entry says how
+         *   many it has
+         * @param {string} [opts.entryId] - Read only this entry, not a page
+         * @returns {Promise<Page<AuditEntry>>}
+         */
+        auditPage: (projectId: string, { startTime, endTime, opTypes, kinds, order, limit, cursor, opsLimit, entryId }?: {
+            startTime?: string;
+            endTime?: string;
+            opTypes?: string[] | string;
+            kinds?: OperationKind[] | string;
+            order?: "asc" | "desc";
+            limit?: number;
+            cursor?: string;
+            opsLimit?: number;
+            entryId?: string;
+        }) => Promise<Page<AuditEntry>>;
+        /**
+         * When the calling user last wrote to each document in a project, as a
+         * `{documentId: timestamp}` map. Documents they have never written to
+         * are absent. One request covers a whole document list.
+         *
+         * The response is NOT key-transformed: its keys are document ids, and
+         * camelCasing would mangle the hyphens in a UUID.
+         * @param {string} projectId - The project ID
+         * @returns {Promise<Object<string, string>>}
+         */
+        myLastEdits: (projectId: string) => Promise<{
+            [x: string]: string;
+        }>;
+        /**
+         * Link a vocabulary to a project.
+         * @param {string} id - The resource ID
+         * @param {string} vocabId - The vocab layer ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        linkVocab: (id: string, vocabId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Unlink a vocabulary from a project.
+         * @param {string} id - The resource ID
+         * @param {string} vocabId - The vocab layer ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        unlinkVocab: (id: string, vocabId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Get a project by ID. To fetch the project's documents, use
+         * listDocuments(id) — the include-documents flag has been removed.
+         * @param {string} id - The resource ID
+         * @returns {Promise<Project>}
+         */
+        get: (id: string) => Promise<Project>;
+        /**
+         * List all documents in a project. Transparently follows pagination
+         * cursors and returns the full flat array.
+         *
+         * Note: this endpoint does not support temporal (`as-of`) queries; the
+         * server rejects `?as-of=` on the documents-list route with a 400.
+         * @param {string} id - The project ID
+         * @returns {Promise<DocumentListEntry[]>}
+         */
+        listDocuments: (id: string) => Promise<DocumentListEntry[]>;
+        /**
+         * Fetch a single page of a project's documents.
+         *
+         * Note: this endpoint does not support temporal (`as-of`) queries; the
+         * server rejects `?as-of=` on the documents-list route with a 400.
+         * @param {string} id - The project ID
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<DocumentListEntry>>}
+         */
+        listDocumentsPage: (id: string, { limit, cursor }?: {
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<DocumentListEntry>>;
+        /**
+         * Async-iterate a project's documents page by page; yields each page's
+         * entries array.
+         *
+         * Note: this endpoint does not support temporal (`as-of`) queries; the
+         * server rejects `?as-of=` on the documents-list route with a 400.
+         * @param {string} id - The project ID
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<DocumentListEntry[]>}
+         */
+        iterDocuments: (id: string, { pageSize }?: {
+            pageSize?: number;
+        }) => AsyncGenerator<DocumentListEntry[]>;
+        /**
+         * Delete a project and everything in it. This is irrecoverable. The
+         * project is gone when this returns, and what it holds is removed on
+         * the server afterwards.
+         * @param {string} id - The resource ID
+         * @param {string} [auditMessage] - Custom audit-log message
+         * @param {object} [options]
+         * @param {number} [options.timeout] - Per-request timeout in ms, the client's own by default (0/null disables)
+         * @returns {Promise<void>}
+         */
+        delete: (id: string, auditMessage?: string, { timeout }?: {
+            timeout?: number;
+        }) => Promise<void>;
+        /**
+         * Update a project's name.
+         * @param {string} id - The resource ID
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Project>}
+         */
+        update: (id: string, name: string, auditMessage?: string) => Promise<Project>;
+        /**
+         * List all projects accessible to user. Transparently follows pagination
+         * cursors and returns the full flat array.
+         * @returns {Promise<ProjectListEntry[]>}
+         */
+        list: () => Promise<ProjectListEntry[]>;
+        /**
+         * Fetch a single page of projects.
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @returns {Promise<Page<ProjectListEntry>>}
+         */
+        listPage: ({ limit, cursor }?: {
+            limit?: number;
+            cursor?: string;
+        }) => Promise<Page<ProjectListEntry>>;
+        /**
+         * Async-iterate projects page by page; yields each page's entries array.
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<ProjectListEntry[]>}
+         */
+        iterPages: ({ pageSize }?: {
+            pageSize?: number;
+        }) => AsyncGenerator<ProjectListEntry[]>;
+        /**
+         * Create a new project. Note: this also registers the user as a maintainer.
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (name: string, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Set a configuration value in an editor namespace.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {any} configValue - Configuration value to set
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`: the value read for this key (null or undefined when it
+         *   was absent). The write is then refused with a 409 when the stored value differs. A value the key
+         *   already holds is not written and leaves no audit row, so the value read, expecting it, states in a
+         *   batch that the key is unchanged.
+         * @returns {Promise<void>}
+         */
+        setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Remove a configuration value.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`, as on setConfig. A key that is absent is not
+         *   written, so expecting null states in a batch that it is still absent.
+         * @returns {Promise<void>}
+         */
+        deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Set a user's access level to read and write for this project.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        addWriter: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Remove a user's writer privileges for this project.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        removeWriter: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Set a user's access level to read-only for this project.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        addReader: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Remove a user's reader privileges for this project.
+         * @param {string} id - The resource ID
+         * @param {string} userId - The user ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        removeReader: (id: string, userId: string, auditMessage?: string) => Promise<void>;
+    };
+    textLayers: {
+        /**
+         * Create a new text layer for a project.
+         * @param {string} projectId - The project ID
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (projectId: string, name: string, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a layer by ID.
+         * @param {string} layerId - The layer ID
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        get: (layerId: string) => Promise<TextLayer>;
+        /**
+         * Delete a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (layerId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Rename a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} name - The new name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        update: (layerId: string, name: string, auditMessage?: string) => Promise<TextLayer>;
+        /**
+         * Move a layer one place in its display order.
+         * @param {string} layerId - The layer ID
+         * @param {string} direction - The direction ("up" or "down")
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Set a configuration value in an editor namespace.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {any} configValue - Configuration value to set
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`: the value read for this key (null or undefined when it
+         *   was absent). The write is then refused with a 409 when the stored value differs. A value the key
+         *   already holds is not written and leaves no audit row, so the value read, expecting it, states in a
+         *   batch that the key is unchanged.
+         * @returns {Promise<void>}
+         */
+        setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Remove a configuration value.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`, as on setConfig. A key that is absent is not
+         *   written, so expecting null states in a batch that it is still absent.
+         * @returns {Promise<void>}
+         */
+        deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+    };
+    vocabItems: {
+        /**
+         * Create a new vocab item
+         * @param {string} vocabLayerId - The vocab layer ID
+         * @param {string} form - The vocab item form
+         * @param {any} [metadata] - Metadata map. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (vocabLayerId: string, form: string, metadata?: any, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Create multiple vocab items in a single operation. Entries may target
+         * different vocab layers; the user must have write access to each.
+         * @param {Array<{vocabLayerId: string, form: string, metadata?: any}>} body - The vocab items to create
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{ids: string[]}>}
+         */
+        bulkCreate: (body: Array<{
+            vocabLayerId: string;
+            form: string;
+            metadata?: any;
+        }>, auditMessage?: string) => Promise<{
+            ids: string[];
+        }>;
+        /**
+         * Update many vocab items in a single operation: set forms and/or patch
+         * metadata.
+         * @param {Array<{id: string, form?: string, metadata?: Array<object>}>} body - `form` is set only when the key is present; `metadata` is a list of metadata ops, as for patchMetadata. The entries may lie in several vocab layers; the user must have write access to each. An unknown id refuses the whole update, and an id may appear only once. Only an entry whose form really changes restates the documents linking it, and a strict-mode client picks up their new versions from the response.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{count: number}>} How many vocab items were updated.
+         */
+        bulkUpdate: (body: Array<{
+            id: string;
+            form?: string;
+            metadata?: Array<object>;
+        }>, auditMessage?: string) => Promise<{
+            count: number;
+        }>;
+        /**
+         * Delete multiple vocab items in a single operation. Each item's
+         * descendant vocab links are deleted too. Provide an array of IDs.
+         *
+         * Every document holding one of those links has its version bumped, and
+         * a strict-mode client picks up their new versions from the response.
+         * @param {string[]} body - The vocab item IDs to delete
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        bulkDelete: (body: string[], auditMessage?: string) => Promise<void>;
+        /**
+         * Get a vocab item by ID
+         * @param {string} id - The resource ID
+         * @returns {Promise<VocabItem>}
+         */
+        get: (id: string) => Promise<VocabItem>;
+        /**
+         * Delete a vocab item, and every link to it. Every document holding one
+         * of those links has its version bumped, and a strict-mode client picks
+         * up their new versions from the response.
+         * @param {string} id - The resource ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expectedLinkCount?: number}} [options] - `expectedLinkCount`: the
+         *   number of links the caller showed. The delete is refused with a 409 when
+         *   the entry has any other number of links by then.
+         * @returns {Promise<void>}
+         */
+        delete: (id: string, auditMessage?: string, { expectedLinkCount }?: {
+            expectedLinkCount?: number;
+        }) => Promise<void>;
+        /**
+         * Merge entries into this one, in one operation. Every link to a loser
+         * moves to the survivor (keeping its id and metadata), except a link on
+         * words the survivor is already linked to, which is deleted, and then the
+         * losers are deleted. Links are read when the merge runs, so one made
+         * after the caller looked moves too. Every loser must be in the
+         * survivor's vocabulary, and a loser that is already gone is skipped, so
+         * a repeated merge changes nothing. Metadata naming a loser by its id,
+         * in the vocabulary's other entries and in the documents of every
+         * project it is linked to, is rewritten to name the survivor. A
+         * reference to a loser in the survivor's own metadata is the caller's to
+         * rewrite, in the same batch.
+         * Needs maintainer rights on the vocabulary.
+         * @param {string} survivorId - The entry that stays
+         * @param {string[]} loserIds - The entries merged into it
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{moved: number, duplicates: number, removed: string[]}>}
+         */
+        merge: (survivorId: string, loserIds: string[], auditMessage?: string) => Promise<{
+            moved: number;
+            duplicates: number;
+            removed: string[];
+        }>;
+        /**
+         * Update a vocab item's form. A document read carries the entry's form on
+         * every link to it, so a rename restates those documents: each has its
+         * version bumped, and a strict-mode client picks up their new versions
+         * from the response.
+         * @param {string} id - The resource ID
+         * @param {string} form - The vocab item form
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<VocabItem>}
+         */
+        update: (id: string, form: string, auditMessage?: string) => Promise<VocabItem>;
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<VocabItem>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<VocabItem>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<VocabItem>;
+    };
+    relationLayers: {
+        /**
+         * The stored values of this layer that a value-set rule would refuse,
+         * before it is declared: exactly what a declaration of it would meet,
+         * with the rule's exemptions (an unconfirmed machine value, a value an
+         * import, a document copy or a restore set). Writes nothing, and a
+         * reader may ask.
+         * @param {string} layerId - The layer ID
+         * @param {ValueSetRule} rule - The list as a value-set declaration takes it
+         * @param {{limit?: number}} [options] - `limit`: how many values to list, the most frequent first
+         *   (default 20, at most 100)
+         * @returns {Promise<RefusedValues>}
+         */
+        refusedValues: (layerId: string, rule: ValueSetRule, options?: {
+            limit?: number;
+        }) => Promise<RefusedValues>;
+        /**
+         * Declare an app namespace's constraints on this layer, replacing that
+         * namespace's list. Refused with 422 and the violations when the layer's
+         * stored data breaks them (see violationsOf).
+         * @param {string} layerId - The layer ID
+         * @param {string} namespace - The declaring app's namespace, e.g. "igt"
+         * @param {LayerConstraint[]} constraints - e.g. [{type: "single-span"}, {type: "value-set", values: ["N"]}]
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: Array<object>|null}} [options] - `expected`: the list read for this
+         *   namespace (null when it was absent). The write is then refused with a 409 when the stored
+         *   list differs.
+         * @returns {Promise<{constraints: Record<string, LayerConstraint[]>}>} the layer's whole constraint map
+         */
+        setConstraints: (layerId: string, namespace: string, constraints: LayerConstraint[], auditMessage?: string, options?: {
+            expected?: Array<object> | null;
+        }) => Promise<{
+            constraints: Record<string, LayerConstraint[]>;
+        }>;
+        /**
+         * Remove an app namespace's constraints from this layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} namespace - The declaring app's namespace
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: Array<object>|null}} [options] - `expected`, as on setConstraints.
+         * @returns {Promise<void>}
+         */
+        deleteConstraints: (layerId: string, namespace: string, auditMessage?: string, options?: {
+            expected?: Array<object> | null;
+        }) => Promise<void>;
+        /**
+         * The violations the given constraints would meet in this layer's stored
+         * data. Writes nothing.
+         * @param {string} layerId - The layer ID
+         * @param {LayerConstraint[]} constraints - The list to check
+         * @param {{limit?: number}} [options] - `limit`: how many violations to list (default 100)
+         * @returns {Promise<{violations: ConstraintViolation[], violationCount: number}>}
+         */
+        checkConstraints: (layerId: string, constraints: LayerConstraint[], options?: {
+            limit?: number;
+        }) => Promise<{
+            violations: ConstraintViolation[];
+            violationCount: number;
+        }>;
+        /**
+         * Apply the remedies of the given constraints' remediable types
+         * (coextensive, single-span, single-link, same-ancestor) to every
+         * violation in this layer's stored data, one operation per document.
+         * With `document`, only that document is repaired, and a writer may
+         * ask. A document another user holds the lock on is left as it is and
+         * listed under `locked`.
+         * @param {string} layerId - The layer ID
+         * @param {LayerConstraint[]} constraints - The list to repair for
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{document?: string}} [options]
+         * @returns {Promise<{repaired: ConstraintRepair[], locked: Array<{document: string, lockedBy: string}>, violations: ConstraintViolation[], violationCount: number}>}
+         */
+        repairConstraints: (layerId: string, constraints: LayerConstraint[], auditMessage?: string, options?: {
+            document?: string;
+        }) => Promise<{
+            repaired: ConstraintRepair[];
+            locked: Array<{
+                document: string;
+                lockedBy: string;
+            }>;
+            violations: ConstraintViolation[];
+            violationCount: number;
+        }>;
+        /**
+         * Set a configuration value in an editor namespace.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {any} configValue - Configuration value to set
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`: the value read for this key (null or undefined when it
+         *   was absent). The write is then refused with a 409 when the stored value differs. A value the key
+         *   already holds is not written and leaves no audit row, so the value read, expecting it, states in a
+         *   batch that the key is unchanged.
+         * @returns {Promise<void>}
+         */
+        setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Remove a configuration value.
+         * @param {string} id - The record's ID
+         * @param {string} namespace - The config namespace
+         * @param {string} configKey - The config key
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{expected?: any}} [options] - `expected`, as on setConfig. A key that is absent is not
+         *   written, so expecting null states in a batch that it is still absent.
+         * @returns {Promise<void>}
+         */
+        deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+            expected?: any;
+        }) => Promise<void>;
+        /**
+         * Create a new relation layer.
+         * @param {string} spanLayerId - The span layer ID
+         * @param {string} name - The name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (spanLayerId: string, name: string, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a layer by ID.
+         * @param {string} layerId - The layer ID
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        get: (layerId: string) => Promise<RelationLayer>;
+        /**
+         * Delete a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (layerId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Rename a layer.
+         * @param {string} layerId - The layer ID
+         * @param {string} name - The new name
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<LayerRecords[K]>}
+         */
+        update: (layerId: string, name: string, auditMessage?: string) => Promise<RelationLayer>;
+        /**
+         * Move a layer one place in its display order.
+         * @param {string} layerId - The layer ID
+         * @param {string} direction - The direction ("up" or "down")
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+    };
+    tokens: {
+        /**
+         * Replace all metadata of an entity. Keys left out of the new map are removed.
+         * @param {string} id - The entity's ID
+         * @param {object} body - The new metadata map
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        setMetadata: (id: string, body: object, auditMessage?: string) => Promise<Token>;
+        /**
+         * Remove all metadata from an entity.
+         * @param {string} id - The entity's ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        deleteMetadata: (id: string, auditMessage?: string) => Promise<Token>;
+        /**
+         * Edit an entity's metadata with a list of ops applied in order, in one operation. `{op: 'set', path, value}` writes value at path, creating missing objects along it; `{op: 'delete', path}` removes the key at path (a no-op when absent). A path is a non-empty array of keys, the first a top-level key. A path through a non-object is refused (400). See metadataOps and applyMetadataOps.
+         * @param {string} id - The entity's ID
+         * @param {MetadataOp[]} body - The metadata ops
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<MetadataRecords[K]>}
+         */
+        patchMetadata: (id: string, body: MetadataOp[], auditMessage?: string) => Promise<Token>;
+        /**
+         * Create a new token in a token layer. Tokens define text substrings
+         * using begin and end offsets. Tokens may be zero-width and may overlap.
+         * For tokens sharing the same begin, precedence controls the linear
+         * ordering.
+         *
+         * Offsets are 0-based indices in Unicode CODE POINTS (not UTF-16 code
+         * units): a supplementary-plane character (emoji, SMP script) is one
+         * position. JS strings are UTF-16, so do NOT use `str.length` /
+         * `str.substring` to compute offsets — count code points instead
+         * (e.g. `[...str].length`, or iterate with `codePointAt`).
+         * @param {string} tokenLayerId - The token layer ID
+         * @param {string} text - The text ID
+         * @param {number} begin - Start offset, inclusive (Unicode code points)
+         * @param {number} end - End offset, exclusive (Unicode code points)
+         * @param {number} [precedence] - Ordering precedence
+         * @param {any} [metadata] - Metadata map. Omit to leave unset; pass null to send JSON null.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {object} [opts]
+         * @param {string} [opts.id] - The new entity's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Created>}
+         */
+        create: (tokenLayerId: string, text: string, begin: number, end: number, precedence?: number, metadata?: any, auditMessage?: string, { id }?: {
+            id?: string;
+        }) => Promise<Created>;
+        /**
+         * Get a token.
+         * @param {string} tokenId - The token ID
+         * @returns {Promise<Token>}
+         */
+        get: (tokenId: string) => Promise<Token>;
+        /**
+         * Delete a token and remove it from any spans. If this causes a span to
+         * have no remaining tokens, the span will also be deleted.
+         * @param {string} tokenId - The token ID
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (tokenId: string, auditMessage?: string) => Promise<void>;
+        /**
+         * Update a token.
+         * @param {string} tokenId - The token ID
+         * @param {number} [begin] - New start offset, inclusive (Unicode code points)
+         * @param {number} [end] - New end offset, exclusive (Unicode code points)
+         * @param {?number} [precedence] - Ordering precedence. Omit (undefined)
+         *   to leave unchanged; pass a number to set; pass null explicitly to
+         *   CLEAR it (revert to no explicit ordering). bodyOf keeps null but
+         *   drops undefined, so the three cases map correctly to the server.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Token>}
+         */
+        update: (tokenId: string, begin?: number, end?: number, precedence?: number | null, auditMessage?: string) => Promise<Token>;
+        /**
+         * Create multiple tokens in a single operation.
+         * @param {Array} body - The request body
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{ids: string[]}>} The created entity IDs, in input order. (bulkDelete resolves to no value.)
+         */
+        bulkCreate: (body: any[], auditMessage?: string) => Promise<{
+            ids: string[];
+        }>;
+        /**
+         * Delete multiple tokens in a single operation. Provide an array of IDs.
+         * @param {Array} body - The request body
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        bulkDelete: (body: any[], auditMessage?: string) => Promise<void>;
+        /**
+         * Update many tokens in a single operation: patch metadata.
+         * @param {Array} body - Objects of the shape `{id, metadata}`. `metadata` is a list of metadata ops, as for patchMetadata. The tokens may lie in several documents of one project; every document touched has its version bumped and every new version comes back in `X-Document-Versions` (past fifty documents, only their number, in `X-Document-Versions-Omitted`). A `document-version` precondition is accepted only when every entry lies in one document. An unknown id refuses the whole update.
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{count: number}>} How many tokens were updated.
+         */
+        bulkUpdate: (body: any[], auditMessage?: string) => Promise<{
+            count: number;
+        }>;
+        /**
+         * Split a token at a Unicode code-point offset. A new token is made for one
+         * half and its ID is returned. The original token keeps its ID, spans and
+         * vocab-links on the left half, or on the right half with `keep: "right"`.
+         * @param {string} tokenId - The token ID
+         * @param {number} position - Code-point offset to split at (strictly between begin and end)
+         * @param {string} [auditMessage] - Audit message for this write
+         * @param {{id?: string, keep?: "left"|"right"}} [options] - `id`: the new
+         *   token's id, a UUIDv7 this client minted. `keep`: the half the original token
+         *   (its id, spans, vocab-links, comments and metadata) stays on, `"left"` by
+         *   default. With `"right"` the new token, whose id is answered, is the left
+         *   half. A relation layer whose relations must stay inside one token
+         *   of this layer declares a same-ancestor constraint, and the server deletes
+         *   the relations the split leaves crossing in the same transaction.
+         * @returns {Promise<Created>}
+         */
+        split: (tokenId: string, position: number, auditMessage?: string, { id, keep }?: {
+            id?: string;
+            keep?: "left" | "right";
+        }) => Promise<Created>;
+        /**
+         * Merge two tokens. The left token (smaller begin) survives with the combined
+         * extent; the right is deleted and its spans/vocab-links are reparented to the left.
+         * On partitioning layers the tokens must be adjacent; on non-overlapping layers the
+         * merged extent must not engulf a third token.
+         * @param {string} tokenId - The anchor token ID
+         * @param {string} otherTokenId - The other token to merge in
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Token>}
+         */
+        merge: (tokenId: string, otherTokenId: string, auditMessage?: string) => Promise<Token>;
+        /**
+         * Shift a token's boundary. On partitioning layers the adjacent token is
+         * auto-adjusted to preserve the partition; on non-overlapping layers a shift that
+         * would create an overlap is rejected.
+         * @param {string} tokenId - The token ID
+         * @param {number} [begin] - New start offset, inclusive (Unicode code points)
+         * @param {number} [end] - New end offset, exclusive (Unicode code points)
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Token>}
+         */
+        shift: (tokenId: string, begin?: number, end?: number, auditMessage?: string) => Promise<Token>;
+    };
+    messages: {
+        /**
+         * Open a Server-Sent Events stream for a project.
+         * @param {string} projectId - The UUID of the project to listen to
+         * @param {(eventType: string, data: any) => void | boolean} onEvent - Callback function that receives (eventType, data). If it returns true, listening will stop.
+         * @param {string} [path] - Stream path under baseUrl (defaults to the project /listen bus; service channels pass their own).
+         * @returns {SSEConnection} SSE connection object with .close() and .getStats() methods
+         */
+        listen: (projectId: string, onEvent: (eventType: string, data: any) => void | boolean, path?: string) => SSEConnection;
+        /**
+         * Send a message to project listeners.
+         *
+         * `data` may be any JSON value and is sent VERBATIM (`rawBody`): a
+         * message payload is opaque application data, like `metadata` and
+         * `config`, so its keys must not be re-cased on the way out. Without
+         * this a key such as `case-marker` would reach listeners as
+         * `caseMarker` in JS and `case_marker` in Python. `listen` restores it
+         * verbatim on the way in.
+         *
+         * A message is not saved and writes nothing to History, so it never
+         * joins an open operation (`withOperation`). Made on a batch it still
+         * queues, so a message queued after the writes goes out after them.
+         * @param {string} projectId - The UUID of the project to send to
+         * @param {any} data - The message data to send
+         * @returns {Promise<{success: boolean, message: string}>}
+         */
+        sendMessage: (projectId: string, data: any) => Promise<{
+            success: boolean;
+            message: string;
+        }>;
+        /**
+         * Discover the services seen on a project (synchronous GET). Currently
+         * connected services carry `online: true`; previously-seen offline ones
+         * carry `online: false` plus a `lastSeenAt` stamp.
+         * @param {string} projectId - The UUID of the project to query
+         * @returns {Promise<DiscoveredService[]>} Array of discovered service information
+         */
+        discoverServices: (projectId: string) => Promise<DiscoveredService[]>;
+        /**
+         * Forget a previously-seen (offline) service. Maintainer-only; 409 if
+         * the service is currently connected.
+         * @param {string} projectId - The UUID of the project
+         * @param {string} serviceId - The ID of the service to forget
+         * @returns {Promise<void>}
+         */
+        discardService: (projectId: string, serviceId: string) => Promise<void>;
+        /**
+         * Register as a service and handle incoming work requests.
+         *
+         * The registration reopens its channel whenever it drops, so a server
+         * restart needs no service restart.
+         * @param {string} projectId - The UUID of the project to serve
+         * @param {ServiceInfo} serviceInfo - Service information {serviceId, serviceName, description}
+         * @param {(data: any, responseHelper: ResponseHelper) => void} onServiceRequest - Callback (data, responseHelper)
+         * @param {Object} [extras] - Optional additional service metadata
+         * @param {(event: ServiceStatusEvent, projectId: string, detail?: string) => void} [onStatus] - Optional callback (event, projectId, detail) for
+         *   connection transitions: 'registered', 'reconnected', 'disconnected',
+         *   and 'stopped' when the server refuses the channel for good, which
+         *   ends the registration
+         * @returns {ServiceRegistration} Service registration with .stop(), .isRunning(), .isConnected()
+         */
+        serve: (projectId: string, serviceInfo: ServiceInfo, onServiceRequest: (data: any, responseHelper: ResponseHelper) => void, extras?: any, onStatus?: (event: ServiceStatusEvent, projectId: string, detail?: string) => void) => ServiceRegistration;
+        /**
+         * Request a service to perform work and await its result.
+         *
+         * The request outlives this call: after a timeout, an abort, or a
+         * dropped connection the service goes on, and `attachServiceRequest`
+         * collects the result given the request id, which `opts.onAccepted`
+         * receives as soon as the server has taken the request. Pass
+         * `opts.requestId` (a UUID you mint) to know the id before submitting;
+         * submitting an id that names a request you already made rejoins it
+         * instead of starting another.
+         * @param {string} projectId - The UUID of the project
+         * @param {string} serviceId - The ID of the service to request
+         * @param {any} data - The request data
+         * @param {number} [timeout=10000] - Timeout in ms
+         * @param {function} [onProgress] - Called with each progress payload {percent, message}
+         * @param {AbortSignal} [signal] - Abort to stop waiting; rejects with an AbortError
+         * @param {{requestId?: string, onAccepted?: (requestId: string) => void, projectIds?: string[], noOperation?: boolean}} [opts] - {requestId, onAccepted, projectIds, noOperation}
+         * @returns {Promise<any>} The service's result
+         */
+        requestService: (projectId: string, serviceId: string, data: any, timeout?: number, onProgress?: Function, signal?: AbortSignal, opts?: {
+            requestId?: string;
+            onAccepted?: (requestId: string) => void;
+            projectIds?: string[];
+            noOperation?: boolean;
+        }) => Promise<any>;
+        /**
+         * Rejoin a service request made earlier and await its result: the
+         * latest progress is replayed, then the result comes, or at once if the
+         * request already finished. Only the user who submitted it (or an
+         * admin). Rejects with an error whose `status` is 404 when the request
+         * is unknown or expired (a finished request's result is kept for a
+         * while, not forever).
+         * @param {string} projectId - The UUID of the project
+         * @param {string} requestId - The request id
+         * @param {number} [timeout=10000] - Timeout in ms
+         * @param {function} [onProgress] - Called with each progress payload
+         * @param {AbortSignal} [signal] - Abort to stop waiting
+         * @returns {Promise<any>} The service's result
+         */
+        attachServiceRequest: (projectId: string, requestId: string, timeout?: number, onProgress?: Function, signal?: AbortSignal) => Promise<any>;
+        /**
+         * Ask the service to stop a request made earlier. The request still
+         * ends with whatever the service then reports, on the stream of whoever
+         * is awaiting it. Rejects with 404 if unknown or expired, 409 once
+         * finished.
+         * @param {string} projectId - The UUID of the project
+         * @param {string} requestId - The request id
+         * @returns {Promise<void>}
+         */
+        cancelServiceRequest: (projectId: string, requestId: string) => Promise<void>;
+    };
+    /**
+     * Run a query over every project you can read.
+     *
+     * `body` is the query AST. Its keys follow the usual client convention
+     * (camelCase, e.g. `scope.projectIds`) and are converted to the wire
+     * format automatically; clause heads and variables are plain strings you
+     * write literally (e.g. `'span'`, `'?s1'`, `'vocab-link'`). Example:
+     *
+     *   await client.query({
+     *     find: ['?s1', '?s2'],
+     *     where: [
+     *       ['span', '?s1', { layer: posLayerId, value: 'NOUN' }],
+     *       ['span', '?s2', { layer: posLayerId, value: 'VERB' }],
+     *       ['covers', '?s1', '?t1'], ['covers', '?s2', '?t2'],
+     *       ['precedes', '?t1', '?t2'],
+     *     ],
+     *     return: 'entities',   // 'ids' (default) | 'entities' | 'count'
+     *     limit: 100,
+     *   });
+     *
+     * A `layer` is referenced by its id (its UUID) only — not by name or
+     * path. To match a layer by name, bind it with a `*-layer` clause (e.g.
+     * `['span-layer', '?sl', { name: 'pos' }]`) and use the variable.
+     *
+     * Optional keys: `scope` (restrict to projects by id, `{projectIds}`), `orderBy`
+     * (sort rows), and `bindings` (substitute `?name` placeholders with literals).
+     * `return` may also be an aggregate spec `{group, aggregates}`. See the query
+     * language reference.
+     *
+     * @param {Object} body - The query AST ({find, where, scope?, limit?, orderBy?,
+     *   return?, bindings?}).
+     * @returns {Promise<QueryResult>} For 'ids'/'entities': {columns, results, count, truncated}.
+     *   For 'count': {return: 'count', count, truncated}, where `truncated` says
+     *   the count stopped at the server's cap. Entity cells are full entity
+     *   objects (same shape as the GET endpoints).
+     */
+    query: (body: any) => Promise<QueryResult>;
+    operationGroups: {
+        /**
+         * Get a logical-operation group (its label + creator).
+         * @param {string} id - The group id
+         * @returns {Promise<OperationGroup>}
+         */
+        get: (id: string) => Promise<OperationGroup>;
+        /**
+         * Relabel a logical-operation group after the fact. Owner or admin only.
+         * @param {string} id - The group id
+         * @param {string|null} message - The new label
+         * @returns {Promise<OperationGroup>}
+         */
+        update: (id: string, message: string | null) => Promise<OperationGroup>;
+    };
+    comments: {
+        /**
+         * Post a comment on an entity. Requires write access to the entity's
+         * project, or to the vocabulary for a vocab-item; the author is the
+         * authenticated caller. Comments are not audited and do not bump the
+         * document version.
+         *
+         * A comment outlives its anchor: deleting the entity does not delete
+         * the comment. `anchorLabel` is the caption shown once that happens
+         * ("Gloss of ktab, sentence 4"), so pass what the comment is about.
+         * @param {CommentableType} entityType - What kind of thing is being commented on
+         * @param {string} entityId - The commented entity's id
+         * @param {string} body - The comment text (1..10000 characters)
+         * @param {object} [opts]
+         * @param {string} [opts.anchorLabel] - What the comment is about, in words (at most 200 characters)
+         * @param {string} [opts.id] - The new comment's id, minted by the caller (see uuidv7)
+         * @returns {Promise<Comment>}
+         */
+        create: (entityType: CommentableType, entityId: string, body: string, { anchorLabel, id }?: {
+            anchorLabel?: string;
+            id?: string;
+        }) => Promise<Comment>;
+        /**
+         * Read one comment.
+         * @param {string} id - The comment id
+         * @returns {Promise<Comment>}
+         */
+        get: (id: string) => Promise<Comment>;
+        /**
+         * Edit a comment's body. Only the comment's AUTHOR may do this - not
+         * maintainers, not admins. Sets `edited` on the comment.
+         * @param {string} id - The comment id
+         * @param {string} body - The replacement text
+         * @returns {Promise<Comment>}
+         */
+        update: (id: string, body: string) => Promise<Comment>;
+        /**
+         * Delete a comment. The author may delete their own; a project
+         * maintainer (or admin) may delete any.
+         * @param {string} id - The comment id
+         * @returns {Promise<void>}
+         */
+        delete: (id: string) => Promise<void>;
+        /**
+         * List comments in a project, oldest first. Transparently follows
+         * pagination cursors and returns the full flat array.
+         * @param {string} projectId - The project to read
+         * @param {object} [filters] - Narrow the scope
+         * @param {string} [filters.documentId] - Every comment anywhere in one document
+         * @param {string} [filters.entityType] - With entityId, one entity's thread
+         * @param {string} [filters.entityId] - With entityType, one entity's thread
+         * @returns {Promise<Comment[]>}
+         */
+        list: (projectId: string, { documentId, entityType, entityId }?: {
+            documentId?: string;
+            entityType?: string;
+            entityId?: string;
+        }) => Promise<Comment[]>;
+        /**
+         * Fetch a single page of a project's comments.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {string} [opts.documentId] - Every comment anywhere in one document
+         * @param {string} [opts.entityType] - With entityId, one entity's thread
+         * @param {string} [opts.entityId] - With entityType, one entity's thread
+         * @returns {Promise<Page<Comment>>}
+         */
+        listPage: (projectId: string, { limit, cursor, documentId, entityType, entityId }?: {
+            limit?: number;
+            cursor?: string;
+            documentId?: string;
+            entityType?: string;
+            entityId?: string;
+        }) => Promise<Page<Comment>>;
+        /**
+         * Async-iterate a project's comments page by page; yields each page's entries array.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @param {string} [opts.documentId] - Every comment anywhere in one document
+         * @param {string} [opts.entityType] - With entityId, one entity's thread
+         * @param {string} [opts.entityId] - With entityType, one entity's thread
+         * @returns {AsyncGenerator<Comment[]>}
+         */
+        iterPages: (projectId: string, { pageSize, documentId, entityType, entityId }?: {
+            pageSize?: number;
+            documentId?: string;
+            entityType?: string;
+            entityId?: string;
+        }) => AsyncGenerator<Comment[]>;
+        /**
+         * Comment counts per entity, as an `{entityId: n}` map, over the same
+         * scope and filters as `list`. One cheap request paints a comment
+         * indicator on every annotated item in a document without paging
+         * through the bodies.
+         *
+         * The response is NOT key-transformed: its keys are entity ids, and
+         * camelCasing would mangle the hyphens in a UUID.
+         * @param {string} projectId - The project to read
+         * @param {{documentId?: string, entityType?: CommentableType, entityId?: string}} [filters] - Same filters as list()
+         * @returns {Promise<Object<string, number>>}
+         */
+        counts: (projectId: string, { documentId, entityType, entityId }?: {
+            documentId?: string;
+            entityType?: CommentableType;
+            entityId?: string;
+        }) => Promise<{
+            [x: string]: number;
+        }>;
+        /**
+         * List the comments on a vocabulary's entries, oldest first. Requires
+         * read access to the vocabulary. Transparently follows pagination
+         * cursors and returns the full flat array.
+         * @param {string} vocabId - The vocab layer to read
+         * @param {object} [filters]
+         * @param {string} [filters.entityId] - One entry's thread
+         * @returns {Promise<Comment[]>}
+         */
+        listInVocab: (vocabId: string, { entityId }?: {
+            entityId?: string;
+        }) => Promise<Comment[]>;
+        /**
+         * Fetch a single page of a vocabulary's comments.
+         * @param {string} vocabId - The vocab layer to read
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {string} [opts.entityId] - One entry's thread
+         * @returns {Promise<Page<Comment>>}
+         */
+        listInVocabPage: (vocabId: string, { limit, cursor, entityId }?: {
+            limit?: number;
+            cursor?: string;
+            entityId?: string;
+        }) => Promise<Page<Comment>>;
+        /**
+         * Async-iterate a vocabulary's comments page by page, oldest first;
+         * yields each page's entries array.
+         * @param {string} vocabId - The vocab layer to read
+         * @param {object} [opts]
+         * @param {string} [opts.entityId] - One entry's thread
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @returns {AsyncGenerator<Comment[]>}
+         */
+        iterInVocabPages: (vocabId: string, { entityId, pageSize }?: {
+            entityId?: string;
+            pageSize?: number;
+        }) => AsyncGenerator<Comment[]>;
+        /**
+         * Comment counts per entry of a vocabulary, as an `{entityId: n}` map.
+         * The response is NOT key-transformed: its keys are entry ids.
+         * @param {string} vocabId - The vocab layer to read
+         * @param {object} [filters]
+         * @param {string} [filters.entityId] - One entry only
+         * @returns {Promise<Object<string, number>>}
+         */
+        countsInVocab: (vocabId: string, { entityId }?: {
+            entityId?: string;
+        }) => Promise<{
+            [x: string]: number;
+        }>;
+    };
+    events: {
+        /**
+         * Record one research-telemetry event (plaid-core sql/client_event.clj).
+         * Fire and forget: the event is buffered and sent with
+         * others every ten seconds, at fifty events, and when the page is
+         * hidden. A batch that fails is dropped, nothing is retried, and
+         * nothing is ever thrown. Sends nothing for a project whose switch
+         * (`config.plaid.research.telemetry`) is off, which it reads from the
+         * project itself. `suggestion.shown` is recorded once per target,
+         * field and value in a page session.
+         * @param {ClientEventType} type - The event type
+         * @param {object} fields
+         * @param {string} fields.projectId - The project it happened in
+         * @param {string} [fields.documentId] - The document it happened in
+         * @param {string} [fields.targetId] - What it is about: a token, a plan
+         * @param {object} [fields.data] - Its details, keyed by single lowercase words (`value`, `source`, `field`, `written`, `conversation`)
+         * @returns {boolean} Whether the event was buffered
+         */
+        record: (type: ClientEventType, fields: {
+            projectId: string;
+            documentId?: string;
+            targetId?: string;
+            data?: object;
+        }) => boolean;
+        /**
+         * Send what the recorder holds now, rather than at its next interval.
+         * @returns {void}
+         */
+        flush: () => void;
+        /**
+         * Tell the recorder a project's switch at once, e.g. right after a
+         * maintainer changed it. Turning it off drops what is buffered.
+         * @param {string} projectId - The project
+         * @param {boolean} on - Whether telemetry is on
+         * @returns {void}
+         */
+        setEnabled: (projectId: string, on: boolean) => void;
+        /**
+         * Record events directly, with no buffering. Requires write access, and
+         * the server refuses with a 403 while the project's switch is off. All
+         * or nothing: one bad event refuses the request with a 400 naming it.
+         * @param {string} projectId - The project the events happened in
+         * @param {Array<{type: string, documentId?: string, targetId?: string, data?: object, clientTs?: string}>} events - At most 500 events
+         * @returns {Promise<{count: number}>}
+         */
+        create: (projectId: string, events: Array<{
+            type: string;
+            documentId?: string;
+            targetId?: string;
+            data?: object;
+            clientTs?: string;
+        }>) => Promise<{
+            count: number;
+        }>;
+        /**
+         * A project's events in arrival order. Maintainer or admin only.
+         * Transparently follows pagination cursors and returns the full flat
+         * array.
+         * @param {string} projectId - The project to read
+         * @param {object} [filters]
+         * @param {string|string[]} [filters.types] - Only these types
+         * @param {string} [filters.startTime] - Only events the server stamped at or after this instant
+         * @param {string} [filters.endTime] - Only events the server stamped at or before this instant
+         * @returns {Promise<ClientEvent[]>}
+         */
+        list: (projectId: string, { types, startTime, endTime }?: {
+            types?: string | string[];
+            startTime?: string;
+            endTime?: string;
+        }) => Promise<ClientEvent[]>;
+        /**
+         * One page of a project's events. Maintainer or admin only.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {string|string[]} [opts.types] - Only these types
+         * @param {string} [opts.startTime] - Only events at or after this instant
+         * @param {string} [opts.endTime] - Only events at or before this instant
+         * @returns {Promise<Page<ClientEvent>>}
+         */
+        listPage: (projectId: string, { limit, cursor, types, startTime, endTime }?: {
+            limit?: number;
+            cursor?: string;
+            types?: string | string[];
+            startTime?: string;
+            endTime?: string;
+        }) => Promise<Page<ClientEvent>>;
+        /**
+         * Async-iterate a project's events page by page; yields each page's entries array.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @param {string|string[]} [opts.types] - Only these types
+         * @param {string} [opts.startTime] - Only events at or after this instant
+         * @param {string} [opts.endTime] - Only events at or before this instant
+         * @returns {AsyncGenerator<ClientEvent[]>}
+         */
+        iterPages: (projectId: string, { pageSize, types, startTime, endTime }?: {
+            pageSize?: number;
+            types?: string | string[];
+            startTime?: string;
+            endTime?: string;
+        }) => AsyncGenerator<ClientEvent[]>;
+    };
+    guidelines: {
+        /**
+         * Create a guideline in a project. `title` is the handle an assistant
+         * asks for one by, and the only thing a person has to keep current. It is
+         * NOT required to be unique, so a title already in use is written like
+         * any other: warn about it, do not refuse it. A `pinned` guideline is one
+         * the assistant is given in full on every turn.
+         * @param {string} projectId - The project the guideline belongs to
+         * @param {string} title - The handle an assistant asks for one by (1..100 characters)
+         * @param {object} [opts]
+         * @param {string} [opts.body] - The Markdown text (up to 20000 characters; may be empty)
+         * @param {boolean} [opts.pinned] - Send this one to the assistant in full on every turn
+         * @param {string} [opts.id] - The new guideline's id, minted by the caller (see uuidv7)
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<{id: string}>}
+         */
+        create: (projectId: string, title: string, { body, pinned, id }?: {
+            body?: string;
+            pinned?: boolean;
+            id?: string;
+        }, auditMessage?: string) => Promise<{
+            id: string;
+        }>;
+        /**
+         * Read one guideline, Markdown body included.
+         * @param {string} id - The guideline id
+         * @returns {Promise<Guideline>}
+         */
+        get: (id: string) => Promise<Guideline>;
+        /**
+         * Update a guideline. Every field is optional and an omitted one is
+         * left alone, so an edit to the body need not restate the title.
+         *
+         * Pass `expectedUpdatedAt` (the `updatedAt` you last read) when a person
+         * has been editing prose: the write then fails with 409 rather than
+         * overwriting somebody who saved in between. Leave it off for a pin
+         * toggle or a script, which have nothing of anyone's to lose.
+         * @param {string} id - The guideline id
+         * @param {object} [changes]
+         * @param {string} [changes.title] - The new handle
+         * @param {string} [changes.body] - The new Markdown text
+         * @param {boolean} [changes.pinned] - Whether the assistant always gets it in full
+         * @param {string} [changes.expectedUpdatedAt] - Write only if this is still the stored updatedAt
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<Guideline>}
+         */
+        update: (id: string, { title, body, pinned, expectedUpdatedAt }?: {
+            title?: string;
+            body?: string;
+            pinned?: boolean;
+            expectedUpdatedAt?: string;
+        }, auditMessage?: string) => Promise<Guideline>;
+        /**
+         * Delete a guideline.
+         * @param {string} id - The guideline id
+         * @param {string} [auditMessage] - Audit message for this write
+         * @returns {Promise<void>}
+         */
+        delete: (id: string, auditMessage?: string) => Promise<void>;
+        /**
+         * List a project's guidelines, by title. Transparently follows
+         * pagination cursors and returns the full flat array.
+         *
+         * Without `includeBodies` each entry carries `bodyChars`, the length of
+         * its body, so a caller can budget before fetching any. Pinned
+         * guidelines are NOT sorted first: `pinned` is on every entry and
+         * grouping is the caller's.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {boolean} [opts.includeBodies] - Return each body instead of its length
+         * @returns {Promise<Guideline[]>}
+         */
+        list: (projectId: string, { includeBodies }?: {
+            includeBodies?: boolean;
+        }) => Promise<Guideline[]>;
+        /**
+         * Fetch a single page of a project's guidelines.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {number} [opts.limit] - Page size (1..1000; server default 100)
+         * @param {string} [opts.cursor] - Opaque cursor from a previous page
+         * @param {boolean} [opts.includeBodies] - Return each body instead of its length
+         * @returns {Promise<Page<Guideline>>}
+         */
+        listPage: (projectId: string, { limit, cursor, includeBodies }?: {
+            limit?: number;
+            cursor?: string;
+            includeBodies?: boolean;
+        }) => Promise<Page<Guideline>>;
+        /**
+         * Async-iterate a project's guidelines page by page; yields each page's entries array.
+         * @param {string} projectId - The project to read
+         * @param {object} [opts]
+         * @param {number} [opts.pageSize] - Per-request page size
+         * @param {boolean} [opts.includeBodies] - Return each body instead of its length
+         * @returns {AsyncGenerator<Guideline[]>}
+         */
+        iterPages: (projectId: string, { pageSize, includeBodies }?: {
+            pageSize?: number;
+            includeBodies?: boolean;
+        }) => AsyncGenerator<Guideline[]>;
+    };
+    /** @private */
+    private _request;
+    /**
+     * Enter strict mode for a specific document, requiring document version
+     * headers so that conflicting concurrent writes are rejected.
+     * @param {string} documentId - The ID of the document to track versions for
+     */
+    enterStrictMode(documentId: string): void;
+    /** Exit strict mode and stop tracking document versions for writes. */
+    exitStrictMode(): void;
+    /**
+     * Begin a LOGICAL OPERATION: a user-meaningful action ("Merge morphemes",
+     * "Re-transcribe") implemented as many low-level writes, possibly across
+     * several batches and even a service round-trip. Until `endOperation()`,
+     * every write is stamped with a client-minted `?group-id=` (and the message)
+     * so the audit log shows the whole run as ONE expandable entry labeled
+     * `message`, with each write's own description underneath.
+     *
+     * Grouping is orthogonal to batches: a batch is a transaction boundary, an
+     * operation is an intent boundary. An operation is NOT atomic — if write 3
+     * of 5 fails, writes 1–2 stay committed (and logged under the group). Use a
+     * batch inside the operation for any step that must be all-or-nothing.
+     *
+     * Nesting flattens: a `beginOperation` while one is open is a no-op that
+     * joins the outer operation (the outer label wins), and the matching
+     * `endOperation` is likewise a no-op. The label is recorded on the FIRST
+     * write, so an operation that is never ended (crash, closed tab) is still
+     * labeled in the log.
+     *
+     * "Every write" is the writes of project data. Reads never join, and neither
+     * do the out-of-band signals shaped like a write (a document lock taken or
+     * renewed, a stopped service request, a service reporting itself, an admin
+     * control), and neither does a broadcast message (`messages.sendMessage`):
+     * none of them is audited, so there would be nothing under the label.
+     *
+     * `kind` says what kind of operation this is, for a program reading the
+     * log: one of `assistant-plan`, `service-run`, `import`, `bulk-edit`,
+     * `guess-adoption`, `repair` or `review` (the server refuses any other).
+     * Any other kind throws here, before anything is written.
+     * `ref` is a short string naming what the operation came from, in the
+     * shape its kind documents (the core manual, "Kinds of operation"). Both
+     * are recorded from the first write like the label, and a nested operation
+     * keeps the outer one's.
+     *
+     * `keys` (from `keySeed()`) makes a run of the operation send the same
+     * requests as an earlier run with the same keys: the nth keyed request that
+     * joins it takes the Idempotency-Key `<seed>.<n>` and the document-version
+     * its first run claimed, so a request that landed is answered from its
+     * first send and writes nothing again. The count starts at 0 at each
+     * outermost begin. A nested operation joins the outer one's keys, unless it
+     * brings its own: then it numbers from 0 under its own seed until its
+     * matching end, and the outer numbering resumes after it.
+     *
+     * @param {string} message - Human label for the operation.
+     * @param {{groupId?: string, kind?: OperationKind, ref?: string, keys?: KeySeed, minted?: Iterable<string>}} [opts] - Optional `{ groupId, kind, ref, keys, minted }`. `groupId` adopts an existing group id instead of minting one (a service joining the requester's operation; `requestService` propagates an open operation to the service automatically). Python's is `group_id`. `kind`, `ref` and `keys` are described above. `minted` is the ids the operation mints for what it creates: a create refused 409 id-taken for one of them was made by an earlier send of the operation, and answers as made.
+     * @returns {string} The operation's group id.
+     */
+    beginOperation(message: string, { groupId, kind, ref, keys, minted }?: {
+        groupId?: string;
+        kind?: OperationKind;
+        ref?: string;
+        keys?: KeySeed;
+        minted?: Iterable<string>;
+    }): string;
+    /**
+     * A seed for the Idempotency-Keys of a logical operation that may be run
+     * again from the top (see beginOperation's `keys`). Keep it with the work
+     * it belongs to and pass it to every run.
+     * @returns {KeySeed}
+     */
+    keySeed(): KeySeed;
+    /**
+     * End the current logical operation. With no argument this is purely local
+     * (no request). Pass a refined `message` to relabel the group now that the
+     * outcome is known (e.g. `endOperation('Merged 3 morphemes')`) — that sends
+     * one PATCH, skipped if the operation never wrote anything. A refine from a
+     * nested (flattened) `endOperation` is ignored; the outer label wins.
+     * @param {string} [message] - Optional refined label.
+     * @returns {Promise<void>}
+     */
+    endOperation(message?: string): Promise<void>;
+    /**
+     * Run `fn` as one logical operation (see beginOperation), ending it when
+     * `fn` settles — including on throw. `fn` receives a `setMessage(msg)`
+     * callback to refine the label once the outcome is known.
+     *
+     *   await client.withOperation('Merge morphemes', async (setMessage) => {
+     *     await client.batched(async (b) => { ... });
+     *     setMessage(`Merged ${n} morphemes`);
+     *   });
+     *
+     * The kind and reference (see beginOperation) come after `fn`:
+     *
+     *   await client.withOperation('Import ELAN corpus', run, { kind: 'import', ref: 'format:elan' });
+     *
+     * @template T
+     * @param {string} message - Human label for the operation.
+     * @param {(setMessage: (msg: string) => void) => T | Promise<T>} fn - The work to run; receives `setMessage(msg)` to refine the label once the outcome is known.
+     * @param {{kind?: OperationKind, ref?: string, groupId?: string, keys?: KeySeed, minted?: Iterable<string>}} [opts] - Optional `{ kind, ref, groupId, keys, minted }`, as for beginOperation. `kind` is one of `assistant-plan`, `service-run`, `import`, `bulk-edit`, `guess-adoption`, `repair` or `review`, and any other throws before `fn` runs.
+     * @returns {Promise<T>} Whatever `fn` resolves to.
+     */
+    withOperation<T>(message: string, fn: (setMessage: (msg: string) => void) => T | Promise<T>, { kind, ref, groupId, keys, minted }?: {
+        kind?: OperationKind;
+        ref?: string;
+        groupId?: string;
+        keys?: KeySeed;
+        minted?: Iterable<string>;
+    }): Promise<T>;
+    /**
+     * Open a batch: a view of this client with the same bundles, on which every
+     * write of project data queues instead of going out. `submit()` sends the
+     * queued operations as ONE atomic request (larger than the server's cap,
+     * as consecutive requests with the results concatenated in queue order,
+     * each atomic on its own, so a failure in a later one leaves the earlier
+     * ones committed, and the error it throws carries `committed`, the count
+     * saved, and `committedResults`, their results) and
+     * resolves to one result per operation; `abort()` drops them. A call made
+     * on the client itself is never touched by an open batch, and a read or an
+     * out-of-band signal made on the batch goes over the wire now (see the note
+     * at the top of `http.js`).
+     *
+     *   const b = client.batch();
+     *   b.tokens.bulkCreate(sentenceOps);
+     *   b.tokens.bulkCreate(wordOps);
+     *   const [sentRes, wordRes] = await b.submit();
+     *
+     * Server-side a batch runs sequentially in one transaction: a child op sees
+     * parents created earlier in the same batch, and any op's failure rolls the
+     * whole batch back. A batch is not nestable. Prefer `batched()`, which
+     * submits or aborts for you.
+     *
+     * `timeout` (ms, or null for none) is how long each of this batch's
+     * requests may wait for its answer, in place of the client's
+     * `batchTimeout`, for this batch alone.
+     * @param {{timeout?: number | null}} [options]
+     * @returns {PlaidBatch} the batch view
+     */
+    batch({ timeout }?: {
+        timeout?: number | null;
+    }): PlaidBatch;
+    /**
+     * POST one batch request (at most MAX_BATCH_OPS operations). Resolves to
+     * one `{ status, headers, body }` per operation, with only the body
+     * recased: the headers keep the server's spelling. `key` is the request's
+     * Idempotency-Key: a batch whose answer is lost (no response, 502, 504) is
+     * sent again under it, and answered from the first send if that landed.
+     * `timeout` is this request's, in place of `batchTimeout` when given.
+     * @private
+     */
+    private _postBatch;
+    /**
+     * Run `fn` with a batch, then submit all queued ops as `submit()` does (ONE
+     * atomic request up to MAX_BATCH_OPS operations, consecutive requests past
+     * it), or abort the batch if `fn` throws. `fn` receives the batch and makes its
+     * writes on it; it must NOT call `submit()` itself. Resolves to the batch
+     * results array (`[]` if `fn` queued nothing).
+     *
+     *   const [sentRes, wordRes] = await client.batched(async (b) => {
+     *     b.tokens.bulkCreate(sentenceOps);
+     *     b.tokens.bulkCreate(wordOps);
+     *   });
+     *
+     * A write made on `client` inside `fn` is not part of the batch: it goes
+     * over the wire at once, as it would anywhere else. See `batch()`, which
+     * also says what `timeout` does.
+     * @param {(batch: PlaidBatch) => (void | Promise<void>)} fn
+     * @param {{timeout?: number | null}} [options]
+     * @returns {Promise<any[]>}
+     */
+    batched(fn: (batch: PlaidBatch) => (void | Promise<void>), { timeout }?: {
+        timeout?: number | null;
+    }): Promise<any[]>;
+}
+/**
+ * The server's cap on operations per batch request (plaid.rest-api.v1.batch).
+ * A batch queued past it is submitted as consecutive requests.
+ */
+export const MAX_BATCH_OPS: 1000;
+export { valueSetAllows, violationsOf } from "./constraints.js";
+export { cpLength, cpSlice, cpSlicer, utf16ToCp, cpIndexOf, composeText } from "./codepoint.js";
+export { composeTextEdits, gapsToOps, applyTextOps } from "./textEdits.js";
+export { PLAID_NAMESPACE, ROLE_KEY, PRESERVE_ON_SPLIT_KEY, SPLIT_ON_SPACE_KEY, ROLES, readRole, findByRole } from "./roles.js";
+export { TASKS, servesTask, filterServicesByTask, getParamSchema, getServiceSummary, buildDefaultValues, coerceParamValues } from "./serviceSchema.js";
+export { ServiceCancelled, createCancelScope, UNKNOWN_OUTCOME, UNREACHABLE } from "./services.js";
+export { REQUESTED_BY, makeRequester, requesterOf } from "./requester.js";
+export { DocumentLock, DocumentLockLost } from "./documentLock.js";
+export { PROV, PROV_STATES, PROVENANCE_KEYS, stampInferred, confirmedInferred, stampContributed, provState, provOrigin, isMachine, isProtected, needsReview, contributeOnEdit, serviceSource, REVIEW_KEY, readReview, projectRole, isReviewed, withReviewedUser, writerPolicy } from "./provenance.js";
+export { metadataOps, applyMetadataOps, mergeMetadata, isReservedMetadataKey } from "./metadataOps.js";
+export { createdId, createdIds } from "./created.js";
+export { uuidv4, uuidv7, normalizeUserId } from "./ids.js";