@larc-iu/plaid-client 0.2.0-alpha.3 → 0.2.0-alpha.30

package/src/apiLayers.d.ts

@@ -0,0 +1,369 @@
+/**
+ * @typedef {import("./types.js").TextEditOp} TextEditOp
+ * @typedef {import("./types.js").TextGap} TextGap
+ * @typedef {import("./types.js").MetadataOp} MetadataOp
+ * @typedef {import("./types.js").LayerConstraint} LayerConstraint
+ * @typedef {import("./types.js").ConstraintWriteOptions} ConstraintWriteOptions
+ * @typedef {import("./types.js").ConstraintViolation} ConstraintViolation
+ * @typedef {import("./types.js").Requester} Requester
+ * @typedef {import("./types.js").BatchRef} BatchRef
+ * @typedef {import("./types.js").ServiceParam} ServiceParam
+ * @typedef {import("./types.js").ServiceInfo} ServiceInfo
+ * @typedef {import("./types.js").DiscoveredService} DiscoveredService
+ * @typedef {import("./types.js").ResponseHelper} ResponseHelper
+ * @typedef {import("./types.js").ServiceRegistration} ServiceRegistration
+ * @typedef {import("./types.js").ServiceStatusEvent} ServiceStatusEvent
+ * @typedef {import("./types.js").OperationGroupsBundle} OperationGroupsBundle
+ * @typedef {import("./types.js").PlaidClientOptions} PlaidClientOptions
+ * @typedef {import("./types.js").OperationKind} OperationKind
+ * @typedef {import("./types.js").KeySeed} KeySeed
+ * @typedef {import("./types.js").PlaidBatch} PlaidBatch
+ * @typedef {import("./types.js").AuditPageOptions} AuditPageOptions
+ * @typedef {import("./types.js").VocabItemRestoreSummary} VocabItemRestoreSummary
+ * @typedef {import("./types.js").UserDataEntry} UserDataEntry
+ * @typedef {import("./types.js").AdminUserDataEntry} AdminUserDataEntry
+ * @typedef {import("./types.js").ActivityTallyRow} ActivityTallyRow
+ * @typedef {import("./types.js").ConstraintRepair} ConstraintRepair
+ * @typedef {import("./types.js").ValueSetRule} ValueSetRule
+ * @typedef {import("./types.js").RefusedValues} RefusedValues
+ * @typedef {import("./types.js").CommentableType} CommentableType
+ * @typedef {import("./types.js").Comment} Comment
+ * @typedef {import("./types.js").Guideline} Guideline
+ * @typedef {import("./types.js").ClientEventType} ClientEventType
+ * @typedef {import("./types.js").ClientEvent} ClientEvent
+ * @typedef {import("./types.js").Invite} Invite
+ * @typedef {import("./types.js").ServerLimits} ServerLimits
+ * @typedef {import("./types.js").ServerHealth} ServerHealth
+ * @typedef {import("./types.js").RateLimitBucket} RateLimitBucket
+ * @typedef {import("./types.js").RateLimitSnapshot} RateLimitSnapshot
+ * @typedef {import("./types.js").BackupStatus} BackupStatus
+ * @typedef {import("./types.js").ServerReport} ServerReport
+ * @typedef {import("./types.js").LiveLog} LiveLog
+ * @typedef {import("./types.js").SSEConnection} SSEConnection
+ * @typedef {import("./types.js").SSEStats} SSEStats
+ * @typedef {import("./types.js").AtomicValue} AtomicValue
+ * @typedef {import("./types.js").Created} Created
+ * @typedef {import("./types.js").Project} Project
+ * @typedef {import("./types.js").ProjectTextLayer} ProjectTextLayer
+ * @typedef {import("./types.js").ProjectTokenLayer} ProjectTokenLayer
+ * @typedef {import("./types.js").ProjectSpanLayer} ProjectSpanLayer
+ * @typedef {import("./types.js").ProjectRelationLayer} ProjectRelationLayer
+ * @typedef {import("./types.js").ProjectVocab} ProjectVocab
+ * @typedef {import("./types.js").PlaidDocument} PlaidDocument
+ * @typedef {import("./types.js").DocumentTextLayer} DocumentTextLayer
+ * @typedef {import("./types.js").DocumentTokenLayer} DocumentTokenLayer
+ * @typedef {import("./types.js").DocumentSpanLayer} DocumentSpanLayer
+ * @typedef {import("./types.js").PlaidText} PlaidText
+ * @typedef {import("./types.js").TextReshape} TextReshape
+ * @typedef {import("./types.js").Token} Token
+ * @typedef {import("./types.js").Span} Span
+ * @typedef {import("./types.js").Relation} Relation
+ * @typedef {import("./types.js").VocabItem} VocabItem
+ * @typedef {import("./types.js").VocabLink} VocabLink
+ * @typedef {import("./types.js").VocabLayer} VocabLayer
+ * @typedef {import("./types.js").TextLayer} TextLayer
+ * @typedef {import("./types.js").TokenLayer} TokenLayer
+ * @typedef {import("./types.js").SpanLayer} SpanLayer
+ * @typedef {import("./types.js").RelationLayer} RelationLayer
+ * @typedef {import("./types.js").MetadataRecords} MetadataRecords
+ * @typedef {import("./types.js").LayerRecords} LayerRecords
+ * @typedef {import("./types.js").User} User
+ * @typedef {import("./types.js").ProjectListEntry} ProjectListEntry
+ * @typedef {import("./types.js").DocumentListEntry} DocumentListEntry
+ * @typedef {import("./types.js").ApiToken} ApiToken
+ * @typedef {import("./types.js").AuditUser} AuditUser
+ * @typedef {import("./types.js").AuditTarget} AuditTarget
+ * @typedef {import("./types.js").AuditOp} AuditOp
+ * @typedef {import("./types.js").AuditEntry} AuditEntry
+ * @typedef {import("./types.js").LockGrant} LockGrant
+ * @typedef {import("./types.js").DocumentRestoreSummary} DocumentRestoreSummary
+ * @typedef {import("./types.js").RestoreCounts} RestoreCounts
+ * @typedef {import("./types.js").OperationGroup} OperationGroup
+ * @typedef {import("./types.js").QueryResult} QueryResult
+ */
+/**
+ * @template [T=any]
+ * @typedef {import("./types.js").Page<T>} Page
+ */
+/** @param {import("./client.js").PlaidClient} client */
+export function textLayersApi(client: import("./client.js").PlaidClient): {
+    get: (layerId: string) => Promise<import("./types.js").TextLayer>;
+    delete: (layerId: string, auditMessage?: string) => Promise<void>;
+    update: (layerId: string, name: string, auditMessage?: string) => Promise<import("./types.js").TextLayer>;
+    shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+    setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    /**
+     * 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>;
+};
+/** @param {import("./client.js").PlaidClient} client */
+export function tokenLayersApi(client: import("./client.js").PlaidClient): {
+    setConstraints: (layerId: string, namespace: string, constraints: import("./families.js").LayerConstraint[], auditMessage?: string, options?: {
+        expected?: Array<object> | null;
+    }) => Promise<{
+        constraints: Record<string, import("./families.js").LayerConstraint[]>;
+    }>;
+    deleteConstraints: (layerId: string, namespace: string, auditMessage?: string, options?: {
+        expected?: Array<object> | null;
+    }) => Promise<void>;
+    checkConstraints: (layerId: string, constraints: import("./families.js").LayerConstraint[], options?: {
+        limit?: number;
+    }) => Promise<{
+        violations: import("./families.js").ConstraintViolation[];
+        violationCount: number;
+    }>;
+    repairConstraints: (layerId: string, constraints: import("./families.js").LayerConstraint[], auditMessage?: string, options?: {
+        document?: string;
+    }) => Promise<{
+        repaired: import("./families.js").ConstraintRepair[];
+        locked: Array<{
+            document: string;
+            lockedBy: string;
+        }>;
+        violations: import("./families.js").ConstraintViolation[];
+        violationCount: number;
+    }>;
+    setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    get: (layerId: string) => Promise<import("./types.js").TokenLayer>;
+    delete: (layerId: string, auditMessage?: string) => Promise<void>;
+    update: (layerId: string, name: string, auditMessage?: string) => Promise<import("./types.js").TokenLayer>;
+    shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+    /**
+     * 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>;
+    /**
+     * 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]>;
+    }>;
+};
+/** @param {import("./client.js").PlaidClient} client */
+export function spanLayersApi(client: import("./client.js").PlaidClient): {
+    get: (layerId: string) => Promise<import("./types.js").SpanLayer>;
+    delete: (layerId: string, auditMessage?: string) => Promise<void>;
+    update: (layerId: string, name: string, auditMessage?: string) => Promise<import("./types.js").SpanLayer>;
+    shift: (layerId: string, direction: string, auditMessage?: string) => Promise<void>;
+    refusedValues: (layerId: string, rule: import("./families.js").ValueSetRule, options?: {
+        limit?: number;
+    }) => Promise<import("./families.js").RefusedValues>;
+    setConstraints: (layerId: string, namespace: string, constraints: import("./families.js").LayerConstraint[], auditMessage?: string, options?: {
+        expected?: Array<object> | null;
+    }) => Promise<{
+        constraints: Record<string, import("./families.js").LayerConstraint[]>;
+    }>;
+    deleteConstraints: (layerId: string, namespace: string, auditMessage?: string, options?: {
+        expected?: Array<object> | null;
+    }) => Promise<void>;
+    checkConstraints: (layerId: string, constraints: import("./families.js").LayerConstraint[], options?: {
+        limit?: number;
+    }) => Promise<{
+        violations: import("./families.js").ConstraintViolation[];
+        violationCount: number;
+    }>;
+    repairConstraints: (layerId: string, constraints: import("./families.js").LayerConstraint[], auditMessage?: string, options?: {
+        document?: string;
+    }) => Promise<{
+        repaired: import("./families.js").ConstraintRepair[];
+        locked: Array<{
+            document: string;
+            lockedBy: string;
+        }>;
+        violations: import("./families.js").ConstraintViolation[];
+        violationCount: number;
+    }>;
+    setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    /**
+     * 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>;
+};
+/** @param {import("./client.js").PlaidClient} client */
+export function relationLayersApi(client: import("./client.js").PlaidClient): {
+    refusedValues: (layerId: string, rule: import("./families.js").ValueSetRule, options?: {
+        limit?: number;
+    }) => Promise<import("./families.js").RefusedValues>;
+    setConstraints: (layerId: string, namespace: string, constraints: import("./families.js").LayerConstraint[], auditMessage?: string, options?: {
+        expected?: Array<object> | null;
+    }) => Promise<{
+        constraints: Record<string, import("./families.js").LayerConstraint[]>;
+    }>;
+    deleteConstraints: (layerId: string, namespace: string, auditMessage?: string, options?: {
+        expected?: Array<object> | null;
+    }) => Promise<void>;
+    checkConstraints: (layerId: string, constraints: import("./families.js").LayerConstraint[], options?: {
+        limit?: number;
+    }) => Promise<{
+        violations: import("./families.js").ConstraintViolation[];
+        violationCount: number;
+    }>;
+    repairConstraints: (layerId: string, constraints: import("./families.js").LayerConstraint[], auditMessage?: string, options?: {
+        document?: string;
+    }) => Promise<{
+        repaired: import("./families.js").ConstraintRepair[];
+        locked: Array<{
+            document: string;
+            lockedBy: string;
+        }>;
+        violations: import("./families.js").ConstraintViolation[];
+        violationCount: number;
+    }>;
+    setConfig: (id: string, namespace: string, configKey: string, configValue: any, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    deleteConfig: (id: string, namespace: string, configKey: string, auditMessage?: string, options?: {
+        expected?: any;
+    }) => Promise<void>;
+    get: (layerId: string) => Promise<import("./types.js").RelationLayer>;
+    delete: (layerId: string, auditMessage?: string) => Promise<void>;
+    update: (layerId: string, name: string, auditMessage?: string) => Promise<import("./types.js").RelationLayer>;
+    shift: (layerId: string, direction: string, auditMessage?: string) => 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>;
+};
+export type TextEditOp = import("./types.js").TextEditOp;
+export type TextGap = import("./types.js").TextGap;
+export type MetadataOp = import("./types.js").MetadataOp;
+export type LayerConstraint = import("./types.js").LayerConstraint;
+export type ConstraintWriteOptions = import("./types.js").ConstraintWriteOptions;
+export type ConstraintViolation = import("./types.js").ConstraintViolation;
+export type Requester = import("./types.js").Requester;
+export type BatchRef = import("./types.js").BatchRef;
+export type ServiceParam = import("./types.js").ServiceParam;
+export type ServiceInfo = import("./types.js").ServiceInfo;
+export type DiscoveredService = import("./types.js").DiscoveredService;
+export type ResponseHelper = import("./types.js").ResponseHelper;
+export type ServiceRegistration = import("./types.js").ServiceRegistration;
+export type ServiceStatusEvent = import("./types.js").ServiceStatusEvent;
+export type OperationGroupsBundle = import("./types.js").OperationGroupsBundle;
+export type PlaidClientOptions = import("./types.js").PlaidClientOptions;
+export type OperationKind = import("./types.js").OperationKind;
+export type KeySeed = import("./types.js").KeySeed;
+export type PlaidBatch = import("./types.js").PlaidBatch;
+export type AuditPageOptions = import("./types.js").AuditPageOptions;
+export type VocabItemRestoreSummary = import("./types.js").VocabItemRestoreSummary;
+export type UserDataEntry = import("./types.js").UserDataEntry;
+export type AdminUserDataEntry = import("./types.js").AdminUserDataEntry;
+export type ActivityTallyRow = import("./types.js").ActivityTallyRow;
+export type ConstraintRepair = import("./types.js").ConstraintRepair;
+export type ValueSetRule = import("./types.js").ValueSetRule;
+export type RefusedValues = import("./types.js").RefusedValues;
+export type CommentableType = import("./types.js").CommentableType;
+export type Comment = import("./types.js").Comment;
+export type Guideline = import("./types.js").Guideline;
+export type ClientEventType = import("./types.js").ClientEventType;
+export type ClientEvent = import("./types.js").ClientEvent;
+export type Invite = import("./types.js").Invite;
+export type ServerLimits = import("./types.js").ServerLimits;
+export type ServerHealth = import("./types.js").ServerHealth;
+export type RateLimitBucket = import("./types.js").RateLimitBucket;
+export type RateLimitSnapshot = import("./types.js").RateLimitSnapshot;
+export type BackupStatus = import("./types.js").BackupStatus;
+export type ServerReport = import("./types.js").ServerReport;
+export type LiveLog = import("./types.js").LiveLog;
+export type SSEConnection = import("./types.js").SSEConnection;
+export type SSEStats = import("./types.js").SSEStats;
+export type AtomicValue = import("./types.js").AtomicValue;
+export type Created = import("./types.js").Created;
+export type Project = import("./types.js").Project;
+export type ProjectTextLayer = import("./types.js").ProjectTextLayer;
+export type ProjectTokenLayer = import("./types.js").ProjectTokenLayer;
+export type ProjectSpanLayer = import("./types.js").ProjectSpanLayer;
+export type ProjectRelationLayer = import("./types.js").ProjectRelationLayer;
+export type ProjectVocab = import("./types.js").ProjectVocab;
+export type PlaidDocument = import("./types.js").PlaidDocument;
+export type DocumentTextLayer = import("./types.js").DocumentTextLayer;
+export type DocumentTokenLayer = import("./types.js").DocumentTokenLayer;
+export type DocumentSpanLayer = import("./types.js").DocumentSpanLayer;
+export type PlaidText = import("./types.js").PlaidText;
+export type TextReshape = import("./types.js").TextReshape;
+export type Token = import("./types.js").Token;
+export type Span = import("./types.js").Span;
+export type Relation = import("./types.js").Relation;
+export type VocabItem = import("./types.js").VocabItem;
+export type VocabLink = import("./types.js").VocabLink;
+export type VocabLayer = import("./types.js").VocabLayer;
+export type TextLayer = import("./types.js").TextLayer;
+export type TokenLayer = import("./types.js").TokenLayer;
+export type SpanLayer = import("./types.js").SpanLayer;
+export type RelationLayer = import("./types.js").RelationLayer;
+export type MetadataRecords = import("./types.js").MetadataRecords;
+export type LayerRecords = import("./types.js").LayerRecords;
+export type User = import("./types.js").User;
+export type ProjectListEntry = import("./types.js").ProjectListEntry;
+export type DocumentListEntry = import("./types.js").DocumentListEntry;
+export type ApiToken = import("./types.js").ApiToken;
+export type AuditUser = import("./types.js").AuditUser;
+export type AuditTarget = import("./types.js").AuditTarget;
+export type AuditOp = import("./types.js").AuditOp;
+export type AuditEntry = import("./types.js").AuditEntry;
+export type LockGrant = import("./types.js").LockGrant;
+export type DocumentRestoreSummary = import("./types.js").DocumentRestoreSummary;
+export type RestoreCounts = import("./types.js").RestoreCounts;
+export type OperationGroup = import("./types.js").OperationGroup;
+export type QueryResult = import("./types.js").QueryResult;
+export type Page<T = any> = import("./types.js").Page<T>;

package/src/apiLayers.js

@@ -0,0 +1,222 @@
+/**
+ * The layer bundles: text, token, span and relation layers, each a factory
+ * of the client (client.js installs them).
+ */
+
+import { bodyOf, configMethods, constraintMethods, layerMethods, valueSetMethods } from "./families.js";
+import { queryTimeout } from "./http.js";
+
+/**
+ * @typedef {import("./types.js").TextEditOp} TextEditOp
+ * @typedef {import("./types.js").TextGap} TextGap
+ * @typedef {import("./types.js").MetadataOp} MetadataOp
+ * @typedef {import("./types.js").LayerConstraint} LayerConstraint
+ * @typedef {import("./types.js").ConstraintWriteOptions} ConstraintWriteOptions
+ * @typedef {import("./types.js").ConstraintViolation} ConstraintViolation
+ * @typedef {import("./types.js").Requester} Requester
+ * @typedef {import("./types.js").BatchRef} BatchRef
+ * @typedef {import("./types.js").ServiceParam} ServiceParam
+ * @typedef {import("./types.js").ServiceInfo} ServiceInfo
+ * @typedef {import("./types.js").DiscoveredService} DiscoveredService
+ * @typedef {import("./types.js").ResponseHelper} ResponseHelper
+ * @typedef {import("./types.js").ServiceRegistration} ServiceRegistration
+ * @typedef {import("./types.js").ServiceStatusEvent} ServiceStatusEvent
+ * @typedef {import("./types.js").OperationGroupsBundle} OperationGroupsBundle
+ * @typedef {import("./types.js").PlaidClientOptions} PlaidClientOptions
+ * @typedef {import("./types.js").OperationKind} OperationKind
+ * @typedef {import("./types.js").KeySeed} KeySeed
+ * @typedef {import("./types.js").PlaidBatch} PlaidBatch
+ * @typedef {import("./types.js").AuditPageOptions} AuditPageOptions
+ * @typedef {import("./types.js").VocabItemRestoreSummary} VocabItemRestoreSummary
+ * @typedef {import("./types.js").UserDataEntry} UserDataEntry
+ * @typedef {import("./types.js").AdminUserDataEntry} AdminUserDataEntry
+ * @typedef {import("./types.js").ActivityTallyRow} ActivityTallyRow
+ * @typedef {import("./types.js").ConstraintRepair} ConstraintRepair
+ * @typedef {import("./types.js").ValueSetRule} ValueSetRule
+ * @typedef {import("./types.js").RefusedValues} RefusedValues
+ * @typedef {import("./types.js").CommentableType} CommentableType
+ * @typedef {import("./types.js").Comment} Comment
+ * @typedef {import("./types.js").Guideline} Guideline
+ * @typedef {import("./types.js").ClientEventType} ClientEventType
+ * @typedef {import("./types.js").ClientEvent} ClientEvent
+ * @typedef {import("./types.js").Invite} Invite
+ * @typedef {import("./types.js").ServerLimits} ServerLimits
+ * @typedef {import("./types.js").ServerHealth} ServerHealth
+ * @typedef {import("./types.js").RateLimitBucket} RateLimitBucket
+ * @typedef {import("./types.js").RateLimitSnapshot} RateLimitSnapshot
+ * @typedef {import("./types.js").BackupStatus} BackupStatus
+ * @typedef {import("./types.js").ServerReport} ServerReport
+ * @typedef {import("./types.js").LiveLog} LiveLog
+ * @typedef {import("./types.js").SSEConnection} SSEConnection
+ * @typedef {import("./types.js").SSEStats} SSEStats
+ * @typedef {import("./types.js").AtomicValue} AtomicValue
+ * @typedef {import("./types.js").Created} Created
+ * @typedef {import("./types.js").Project} Project
+ * @typedef {import("./types.js").ProjectTextLayer} ProjectTextLayer
+ * @typedef {import("./types.js").ProjectTokenLayer} ProjectTokenLayer
+ * @typedef {import("./types.js").ProjectSpanLayer} ProjectSpanLayer
+ * @typedef {import("./types.js").ProjectRelationLayer} ProjectRelationLayer
+ * @typedef {import("./types.js").ProjectVocab} ProjectVocab
+ * @typedef {import("./types.js").PlaidDocument} PlaidDocument
+ * @typedef {import("./types.js").DocumentTextLayer} DocumentTextLayer
+ * @typedef {import("./types.js").DocumentTokenLayer} DocumentTokenLayer
+ * @typedef {import("./types.js").DocumentSpanLayer} DocumentSpanLayer
+ * @typedef {import("./types.js").PlaidText} PlaidText
+ * @typedef {import("./types.js").TextReshape} TextReshape
+ * @typedef {import("./types.js").Token} Token
+ * @typedef {import("./types.js").Span} Span
+ * @typedef {import("./types.js").Relation} Relation
+ * @typedef {import("./types.js").VocabItem} VocabItem
+ * @typedef {import("./types.js").VocabLink} VocabLink
+ * @typedef {import("./types.js").VocabLayer} VocabLayer
+ * @typedef {import("./types.js").TextLayer} TextLayer
+ * @typedef {import("./types.js").TokenLayer} TokenLayer
+ * @typedef {import("./types.js").SpanLayer} SpanLayer
+ * @typedef {import("./types.js").RelationLayer} RelationLayer
+ * @typedef {import("./types.js").MetadataRecords} MetadataRecords
+ * @typedef {import("./types.js").LayerRecords} LayerRecords
+ * @typedef {import("./types.js").User} User
+ * @typedef {import("./types.js").ProjectListEntry} ProjectListEntry
+ * @typedef {import("./types.js").DocumentListEntry} DocumentListEntry
+ * @typedef {import("./types.js").ApiToken} ApiToken
+ * @typedef {import("./types.js").AuditUser} AuditUser
+ * @typedef {import("./types.js").AuditTarget} AuditTarget
+ * @typedef {import("./types.js").AuditOp} AuditOp
+ * @typedef {import("./types.js").AuditEntry} AuditEntry
+ * @typedef {import("./types.js").LockGrant} LockGrant
+ * @typedef {import("./types.js").DocumentRestoreSummary} DocumentRestoreSummary
+ * @typedef {import("./types.js").RestoreCounts} RestoreCounts
+ * @typedef {import("./types.js").OperationGroup} OperationGroup
+ * @typedef {import("./types.js").QueryResult} QueryResult
+ */
+
+/**
+ * @template [T=any]
+ * @typedef {import("./types.js").Page<T>} Page
+ */
+
+/** @param {import("./client.js").PlaidClient} client */
+export function textLayersApi(client) {
+  return {
+    /**
+     * 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, name, auditMessage, { id } = {}) =>
+      client._request("POST", "/api/v1/text-layers", {
+        auditMessage,
+        body: bodyOf({ id, "project-id": projectId, name }),
+      }),
+    ...configMethods(client, "text-layers"),
+    ...layerMethods(client, "text-layers"),
+  };
+}
+
+/** @param {import("./client.js").PlaidClient} client */
+export function tokenLayersApi(client) {
+  return {
+    /**
+     * 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,
+      name,
+      overlapMode,
+      parentTokenLayerId,
+      auditMessage,
+      { id } = {},
+    ) =>
+      client._request("POST", "/api/v1/token-layers", {
+        auditMessage,
+        body: bodyOf({
+          id,
+          "text-layer-id": textLayerId,
+          name,
+          "overlap-mode": overlapMode,
+          "parent-token-layer-id": parentTokenLayerId,
+        }),
+      }),
+    /**
+     * 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, value) =>
+      client._request("POST", "/api/v1/query/token-counts", {
+        body: { layers: layerIds, value },
+        outOfBand: true,
+        timeout: queryTimeout(client),
+        noBusyRetry: true,
+      }),
+    ...layerMethods(client, "token-layers"),
+    ...configMethods(client, "token-layers"),
+    ...constraintMethods(client, "token-layers"),
+  };
+}
+
+/** @param {import("./client.js").PlaidClient} client */
+export function spanLayersApi(client) {
+  return {
+    /**
+     * 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, name, auditMessage, { id } = {}) =>
+      client._request("POST", "/api/v1/span-layers", {
+        auditMessage,
+        body: bodyOf({ id, "token-layer-id": tokenLayerId, name }),
+      }),
+    ...configMethods(client, "span-layers"),
+    ...constraintMethods(client, "span-layers"),
+    ...valueSetMethods(client, "span-layers"),
+    ...layerMethods(client, "span-layers"),
+  };
+}
+
+/** @param {import("./client.js").PlaidClient} client */
+export function relationLayersApi(client) {
+  return {
+    /**
+     * 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, name, auditMessage, { id } = {}) =>
+      client._request("POST", "/api/v1/relation-layers", {
+        auditMessage,
+        body: bodyOf({ id, "span-layer-id": spanLayerId, name }),
+      }),
+    ...layerMethods(client, "relation-layers"),
+    ...configMethods(client, "relation-layers"),
+    ...constraintMethods(client, "relation-layers"),
+    ...valueSetMethods(client, "relation-layers"),
+  };
+}