js-bao-wss-client 2.0.5 → 2.0.7

package/README.md

@@ -3532,7 +3532,7 @@ For contributors and developers working on this package:
 
 ### Testing Locally
 
-See [LOCAL_TESTING.md](./LOCAL_TESTING.md) for a comprehensive guide on testing your changes locally using `npm pack`.
+See [LOCAL_TESTING.md](https://github.com/Primitive-Labs/js-bao-wss-client/blob/main/LOCAL_TESTING.md) for a comprehensive guide on testing your changes locally using `npm pack`.
 
 **Quick test:**
 

package/dist/JsBaoClient.d.ts

@@ -33,17 +33,17 @@ export { JsBaoError, isJsBaoError, JsBaoApiError, isJsBaoApiError, JsBaoNetworkE
 export type { JsBaoErrorCode } from "./errors";
 export { AuthError, AUTH_CODES } from "./internal/authController";
 export type { AuthCode } from "./internal/authController";
-export type { DocumentInfo, DocumentPermissionEntry, DocumentInvitation, DocumentInvitationResponse, DocumentAccessResult, DocumentGroupPermissionEntry, DocumentAliasInfo, DocumentAliasScope, PermissionUpdateResult, DirectPermissionGrant, DeferredPermissionGrant, PendingInvitationEntry, PendingGroupInvitationEntry, } from "./api/documentsApi";
+export type { DocumentInfo, DocumentPermissionEntry, DocumentInvitation, DocumentInvitationResponse, DocumentAccessResult, DocumentGroupPermissionEntry, DocumentAliasInfo, DocumentAliasScope, PermissionUpdateResult, DirectPermissionGrant, DeferredPermissionGrant, PendingInvitationEntry, PendingGroupInvitationEntry, LinkAccessResult, } from "./api/documentsApi";
 export type { UserProfile, SharedDocument, SharedDocumentListResult, SharedDocumentsOptions, OwnedDocumentsOptions, } from "./api/meApi";
 export type { SessionInfo } from "./api/sessionApi";
 export type { BasicUserInfo, BatchUserProfile } from "./api/usersApi";
-export type { DatabaseInfo, DatabasePermissionEntry, DatabaseGroupPermissionEntry, GrantDatabaseGroupPermissionParams, DatabaseOwnershipTransferResult, DatabaseOperationInfo, AddManagerParams, GrantPermissionParams, CsvImportOptions, CsvImportProgress, CsvImportResult, DatabaseChangeEvent, DatabaseChangePayload, DatabaseSubscribeOptions, ListDatabasesOptions, } from "./api/databasesApi";
+export type { DatabaseInfo, DatabasePermissionEntry, DatabaseGroupPermissionEntry, GrantDatabaseGroupPermissionParams, DatabaseOwnershipTransferResult, DatabaseOperationInfo, AddManagerParams, GrantPermissionParams, CsvImportOptions, CsvImportProgress, CsvImportResult, CelContextResult, ExecuteOperationOptions, DatabaseChangeEvent, DatabaseChangePayload, DatabaseSubscribeOptions, ListDatabasesOptions, OperationType, OperationFilter, QueryDefinition, MutationOperation, MutationDefinition, CountDefinition, AggregateOperation, AggregateDefinition, PipelineStep, PipelineDefinition, ApplyToQuerySource, ApplyToQueryAction, ApplyToQueryDefinition, OperationDefinition, CreateOperationParams, UpdateOperationParams, } from "./api/databasesApi";
 export type { GroupInfo, GroupMemberInfo, GroupMembershipInfo, GroupDocumentInfo, GroupDatabaseInfo, ListUserMembershipsOptions, PaginatedResult, DirectGroupAdd, DeferredGroupAdd, GroupAddMemberResult, } from "./api/groupsApi";
 export type { CollectionInfo, CollectionDocumentInfo, CollectionGroupPermissionInfo, CollectionMemberInfo, CollectionAccessInfo, DocumentCollectionInfo, AddCollectionMemberParams, DirectCollectionAdd, DeferredCollectionAdd, CollectionAddMemberResult, PendingCollectionInvitationEntry, } from "./api/collectionsApi";
-export type { RuleSetInfo, RuleSetSchema, RuleSetTestResult, RuleSetDebugResult, TraceEntry, TriggerDefInfo, ModelRulesInfo, } from "./api/ruleSetsApi";
+export type { RuleSetInfo, RuleSetSchema, RuleSetTestResult, RuleSetDebugResult, TraceEntry, TriggerDefInfo, ModelRulesInfo, PathDeclaration, RuleLoads, RuleExpression, CategoryRules, } from "./api/ruleSetsApi";
 export type { GroupTypeConfigInfo } from "./api/groupTypeConfigsApi";
 export type { CollectionTypeConfigInfo, CreateCollectionTypeConfigParams, UpdateCollectionTypeConfigParams, } from "./api/collectionTypeConfigsApi";
-export type { DatabaseTypeConfigInfo, CreateDatabaseTypeConfigParams, UpdateDatabaseTypeConfigParams, } from "./api/databaseTypeConfigsApi";
+export type { DatabaseTypeConfigInfo, CreateDatabaseTypeConfigParams, UpdateDatabaseTypeConfigParams, DeclaredMetadataManifest, DeclaredManifestPath, DeclaredManifestPathFrom, DeclaredManifestPathRootFrom, } from "./api/databaseTypeConfigsApi";
 export type { AppInvitationInfo, InvitationQuota, CreateInvitationParams, InvitationListResult, DeferredGrant, DeferredDocumentGrant, DeferredGroupGrant, DeferredGrantListResult, DeferredGrantRevokeResult, AcceptInviteResult, } from "./api/invitationsApi";
 export type { DoDb, DOClientEngine, ModelIdentifier, ModelFieldInfo, SaveOptions } from "js-bao/client";
 export type { DiscoveredSchema, DiscoveredModel, DiscoveredField, DiscoveredConstraint, DiscoveredRelationship } from "js-bao";
@@ -97,15 +97,15 @@ export interface AnalyticsAutoEventsOptions {
     };
 }
 export type { GeminiRole, GeminiContentPart, GeminiMessage, GeminiPromptOptions, GeminiGenerateOptions, GeminiGenerateResult, GeminiModelSummary, GeminiStructuredOutput, GeminiGenerateRawOptions, } from "./api/geminiApi";
-export interface IntegrationCallRequest {
+export interface IntegrationCallRequest<TReq = unknown> {
     integrationKey: string;
     method?: string;
     path?: string;
     query?: Record<string, any>;
     headers?: Record<string, string>;
-    body?: any;
+    body?: TReq;
 }
-export interface IntegrationCallResponse<T = any> {
+export interface IntegrationCallResponse<T = unknown> {
     status: number;
     headers: Record<string, string>;
     body: T;
@@ -114,7 +114,16 @@ export interface IntegrationCallResponse<T = any> {
     errorCode?: string;
 }
 export interface IntegrationsAPI {
-    call<T = any>(request: IntegrationCallRequest): Promise<IntegrationCallResponse<T>>;
+    /**
+     * Call an integration's proxy endpoint.
+     *
+     * The optional generics are additive (issue #1542). `TRes` types the response
+     * body and is **first** to preserve the meaning of existing single-arg
+     * `call<MyResponse>()` call sites; `TReq` types the request `body`. Both
+     * default to `unknown` (issue #1540 typing hygiene), so untyped callers must
+     * narrow before reading arbitrary properties.
+     */
+    call<TRes = unknown, TReq = unknown>(request: IntegrationCallRequest<TReq>): Promise<IntegrationCallResponse<TRes>>;
 }
 export interface WorkflowsAPI {
     /**
@@ -160,7 +169,7 @@ export interface WorkflowsAPI {
      * are unaffected. The generated per-workflow `<key>(client)` factory supplies
      * it from the workflow's `outputSchema`.
      */
-    getStatus<O = any>(options: GetWorkflowStatusOptions): Promise<WorkflowStatusResult<O>>;
+    getStatus<O = unknown>(options: GetWorkflowStatusOptions): Promise<WorkflowStatusResult<O>>;
     /**
      * Wait for an async workflow run to reach a terminal state, then resolve
      * `{ status, output?, error? }` (#1443).
@@ -188,10 +197,10 @@ export interface WorkflowsAPI {
      *
      * The optional generic `O` types the result envelope's `output` (issue #1512)
      * — a terminated run can still carry partial output. Additive, defaults to
-     * `any`. Typed termination is available via this explicit generic; the
-     * generated factory intentionally does not emit a `terminate` member.
+     * `any`. The generated per-workflow factory emits a `terminate` member that
+     * binds this generic to the workflow's `<Key>Output` (issue #1543).
      */
-    terminate<O = any>(options: TerminateWorkflowOptions): Promise<WorkflowStatusResult<O>>;
+    terminate<O = unknown>(options: TerminateWorkflowOptions): Promise<WorkflowStatusResult<O>>;
     /** List workflow runs for the current user */
     listRuns(options?: ListWorkflowRunsOptions): Promise<ListWorkflowRunsResult>;
     /** List step runs for a specific workflow run. The run must have been started by the current user. */
@@ -202,28 +211,48 @@ export interface WorkflowsAPI {
     confirmApply(options: ConfirmApplyOptions): Promise<ConfirmApplyResult>;
     /** Release a claimed workflow apply so another client can retry. Called automatically on apply handler failure. */
     releaseApply(options: ReleaseApplyOptions): Promise<ReleaseApplyResult>;
-    /** Fetch pending workflow applies for a document. */
+    /**
+     * Fetch pending workflow applies for a document.
+     *
+     * Returns a concrete `PendingApply[]` (issue #1542) instead of the former
+     * `any[]`. The server element carries no `output`, so there is no output
+     * generic here — the apply output is typed on `define`/`onApply<O>`, where it
+     * is actually delivered.
+     */
     getPendingApplies(options: {
         contextDocId: string;
-    }): Promise<any[]>;
-    /** Define a workflow with its apply handler. Call once at app initialization so any client can handle apply. */
-    define(workflowKey: string, options: WorkflowDefineOptions): void;
+    }): Promise<PendingApply[]>;
+    /**
+     * Define a workflow with its apply handler. Call once at app initialization
+     * so any client can handle apply.
+     *
+     * The optional generic `O` types the apply handler's `output` (issue #1542).
+     * It is additive and defaults to today's untyped `any`, so existing callers
+     * are unaffected.
+     */
+    define<O = unknown>(workflowKey: string, options: WorkflowDefineOptions<O>): void;
 }
 export interface PromptsAPI {
-    /** Execute a prompt by key and return the result */
-    execute(promptKey: string, options: ExecutePromptOptions): Promise<ExecutePromptResult>;
+    /**
+     * Execute a prompt by key and return the result.
+     *
+     * The optional generics are additive (issue #1542). `V` types the
+     * `variables` bag and `R` types `rawResponse`. Both default to today's
+     * untyped shapes, so existing callers are unaffected.
+     */
+    execute<V extends object = Record<string, unknown>, R = unknown>(promptKey: string, options: ExecutePromptOptions<V>): Promise<ExecutePromptResult<R>>;
 }
 /** Options for executing a prompt */
-export interface ExecutePromptOptions {
+export interface ExecutePromptOptions<V extends object = Record<string, unknown>> {
     /** Variables to pass to the prompt template */
-    variables: Record<string, any>;
+    variables: V;
     /** Override the model specified in the prompt config */
     modelOverride?: string;
     /** Specific config ID to use (defaults to activeConfigId) */
     configId?: string;
 }
 /** Result from executing a prompt */
-export interface ExecutePromptResult {
+export interface ExecutePromptResult<R = unknown> {
     success: boolean;
     output: string;
     error?: string;
@@ -233,7 +262,7 @@ export interface ExecutePromptResult {
         outputTokens?: number;
         totalTokens?: number;
     };
-    rawResponse: any;
+    rawResponse: R;
     configId: string;
 }
 export interface JsBaoClientOptions {
@@ -345,18 +374,18 @@ interface DocumentClosedEvent {
 }
 export interface DocumentMetadataChangedEvent {
     documentId: string;
-    metadata: any | null;
+    metadata: LocalMetadataEntry | null;
     changedFields?: string[];
     action?: "created" | "updated" | "evicted" | "deleted";
     source?: "local" | "server" | "idb";
 }
 export interface MeUpdatedEvent {
-    value: any;
+    value: unknown;
     updatedAt?: string;
     source?: "server" | "cache" | string;
 }
 export interface MeUpdateFailedEvent {
-    error: any;
+    error: unknown;
 }
 export interface PermissionEvent {
     documentId: string;
@@ -527,12 +556,12 @@ export interface WorkflowStatusEvent {
     runKey: string;
     runId: string;
     status: "completed" | "failed" | "terminated";
-    output?: any;
+    output?: unknown;
     error?: string;
     contextDocId?: string;
     needsApply?: boolean;
     startedByUserId?: string;
-    meta?: Record<string, any>;
+    meta?: Record<string, unknown>;
 }
 export interface WorkflowStartedEvent {
     type: "workflowStarted";
@@ -542,7 +571,7 @@ export interface WorkflowStartedEvent {
     runId: string;
     instanceId: string;
     contextDocId?: string;
-    meta?: Record<string, any>;
+    meta?: Record<string, unknown>;
 }
 /** Options for synchronously running a workflow via `workflows.runSync` (#728). */
 export interface RunSyncWorkflowOptions {
@@ -555,7 +584,7 @@ export interface RunSyncWorkflowOptions {
     /** Document ID to associate the run with. Defaults to the user's root document. */
     contextDocId?: string;
     /** User-defined metadata attached to the run (max 1KB). Returned in listRuns and runSync envelope. */
-    meta?: Record<string, any>;
+    meta?: Record<string, unknown>;
     /**
      * Hard wall-clock ceiling in milliseconds. Defaults to 5000. Capped
      * server-side to 30000 (Workers CPU budget). When exceeded, the run
@@ -579,14 +608,20 @@ export interface RunSyncWorkflowResult<O = any> {
     runId: string;
     runKey: string;
     /**
-     * Terminal status from the run.
+     * Status from the run.
      * - "completed" — workflow finished without error
      * - "failed" — engine raised an error (see `error`)
      * - "terminated" — caller-side AbortSignal fired mid-execution
      * - "timeout" — server-side timeout ceiling tripped
      * - "apply_pending" — workflow needs the client-side apply step
+     *
+     * On an idempotency hit or write-race loss (`existing: true`), runSync
+     * echoes the matched run's raw persisted `WorkflowRun.status`, which can
+     * still be transient — `"queued"`, `"running"`, or `"apply_claimed"` — so
+     * this is `WorkflowRunStatus` (the model's full set) plus the runSync-only
+     * `"timeout"` value.
      */
-    status: "completed" | "failed" | "terminated" | "timeout" | "apply_pending" | string;
+    status: WorkflowRunStatus | "timeout";
     /** Final output of the workflow, when `status === "completed"`. */
     output?: O;
     /** Error message when `status === "failed"`. */
@@ -607,7 +642,7 @@ export interface StartWorkflowOptions {
     /** Document ID to associate the run with */
     contextDocId?: string;
     /** User-defined metadata attached to the run (max 1KB). Returned in listRuns and getStatus. */
-    meta?: Record<string, any>;
+    meta?: Record<string, unknown>;
     /** If true, terminates any existing run with the same runKey and starts a new one */
     forceRerun?: boolean;
 }
@@ -616,7 +651,7 @@ export interface StartWorkflowResult {
     runId: string;
     runKey: string;
     instanceId: string;
-    status: string;
+    status: WorkflowRunStatus;
     /** True if this runKey already existed and the existing run was returned */
     existing?: boolean;
 }
@@ -672,7 +707,7 @@ export interface WorkflowRun {
      *  present in run responses (the server sends `errorMessage || null`). */
     errorMessage?: string | null;
     /** User-defined metadata (max 1KB) */
-    meta?: Record<string, any>;
+    meta?: Record<string, unknown>;
 }
 /** Result from listing workflow runs */
 export interface ListWorkflowRunsResult {
@@ -694,17 +729,17 @@ export interface WorkflowStepRunRecord {
     /** completed | failed | skipped */
     status: string;
     /** Rendered step config (after template evaluation) */
-    config?: any;
+    config?: unknown;
     /** Original step config before template rendering (for transform steps) */
-    rawConfig?: any;
+    rawConfig?: unknown;
     /** Resolved input to the step */
-    input?: any;
+    input?: unknown;
     /** Output from the step */
-    output?: any;
+    output?: unknown;
     /** Error message if the step failed */
     error?: string | null;
     /** Structured error details (stack trace, cause chain) if the step failed */
-    errorDetails?: any;
+    errorDetails?: unknown;
     startedAt?: string;
     endedAt?: string;
     durationMs?: number;
@@ -713,9 +748,9 @@ export interface WorkflowStepRunRecord {
     totalTokens?: number;
     retryCount?: number;
     /** Snapshot of input and previous step outputs at the time this step ran */
-    context?: any;
+    context?: unknown;
     /** Template warnings captured during step execution */
-    templateWarnings?: any;
+    templateWarnings?: unknown;
 }
 /** Result from listing step runs for a workflow run */
 export interface ListWorkflowStepRunsResult {
@@ -793,20 +828,61 @@ export interface ReleaseApplyResult {
     released: boolean;
     reason?: string;
 }
-/** Callback for applying a workflow result to a document */
-type WorkflowApplyHandler = (result: {
+/**
+ * Callback for applying a workflow result to a document. `O` types the
+ * workflow's `output` (issue #1542); it is additive and defaults to today's
+ * untyped `any`.
+ */
+type WorkflowApplyHandler<O = unknown> = (result: {
     workflowKey: string;
     runKey: string;
     runId: string;
     contextDocId?: string;
-    output: any;
+    output: O;
     startedByUserId?: string;
     meta?: Record<string, any>;
 }) => void | Promise<void>;
+/**
+ * One pending (or reclaimable) workflow apply, as returned by
+ * `workflows.getPendingApplies`. Concrete shape (issue #1542) mirroring the
+ * server element — it carries no `output`, so there is no output generic here.
+ */
+export interface PendingApply {
+    runId: string;
+    runKey: string;
+    workflowKey: string;
+    workflowId: string;
+    instanceId: string;
+    contextDocId: string;
+    /** "apply_pending", or "apply_claimed" for a run whose apply lease expired. */
+    status: string;
+    startedByUserId: string;
+    /**
+     * ISO timestamp the apply was claimed, or null once claimed and released.
+     * Absent (the key is omitted) for a run that has never been claimed, so this
+     * property is optional.
+     */
+    claimedAt?: string | null;
+    /**
+     * Connection id that holds/held the apply claim, or null. Absent for a run
+     * that has never been claimed, so this property is optional.
+     */
+    claimedBy?: string | null;
+    /** Apply-lease timeout in milliseconds. */
+    applyLeaseTimeoutMs: number;
+    /**
+     * Parsed workflow run metadata, or `null` when none was set. Typed as
+     * `unknown` because the server accepts and round-trips any JSON value here:
+     * `normalizeMeta` stores whatever was passed (object, array, string, number,
+     * boolean) and `parseMeta` returns that same shape. Narrow before use — do
+     * not assume an object.
+     */
+    meta: unknown;
+}
 /** Options for defining a workflow via `workflows.define()` */
-export interface WorkflowDefineOptions {
+export interface WorkflowDefineOptions<O = unknown> {
     /** Handler to apply workflow results to the document. Called automatically when this workflow completes with needsApply. */
-    onApply: WorkflowApplyHandler;
+    onApply: WorkflowApplyHandler<O>;
 }
 /** Options for {@link JsBaoClient.waitForUserId}. */
 export interface WaitForUserIdOptions {
@@ -904,11 +980,11 @@ export interface EvictAllLocalOptions {
 }
 export interface JsBaoEvents {
     error: {
-        error: any;
+        error: unknown;
     };
     status: StatusChangedEvent;
     networkMode: NetworkModeEvent;
-    auth: any;
+    auth: unknown;
     "auth-success": {
         token: string;
         previousToken: string | null;
@@ -928,9 +1004,9 @@ export interface JsBaoEvents {
     "offlineAuth:renewed": OfflineAuthRenewedEvent;
     "offlineAuth:revoked": {};
     "offlineAuth:expiringSoon": OfflineAuthExpiringSoonEvent;
-    connection: any;
-    "connection-error": any;
-    "connection-close": any;
+    connection: unknown;
+    "connection-error": unknown;
+    "connection-close": unknown;
     documentLoaded: DocumentLoadedEvent;
     documentClosed: DocumentClosedEvent;
     documentOpened: DocumentEvent;
@@ -953,8 +1029,8 @@ export interface JsBaoEvents {
     syncPerf: {
         type: "syncPerf";
         documentId: string;
-        timings: Record<string, any>;
-        clientTimings?: Record<string, any>;
+        timings: Record<string, unknown>;
+        clientTimings?: Record<string, unknown>;
     };
     "schema-discovered": SchemaDiscoveredEvent;
 }
@@ -965,7 +1041,7 @@ export interface SchemaDiscoveredEvent {
 }
 export interface AnalyticsClient {
     logEvent(event: AnalyticsEventInput): void;
-    logSnapshot(context?: Record<string, any>): void;
+    logSnapshot(context?: Record<string, unknown>): void;
     flush(): void;
     setPlanOverride(plan: string | null | undefined): void;
     setAppVersionOverride(version: string | null | undefined): void;
@@ -1373,6 +1449,23 @@ export declare class JsBaoClient extends Observable<any> {
     private claimWorkflowApply;
     private releaseWorkflowApply;
     private confirmWorkflowApply;
+    /**
+     * Whether a thrown confirm-apply error is worth retrying. Network failures
+     * (unreachable server, refused connection, DNS failure, or an aborted
+     * timeout — all surfaced as `JsBaoNetworkError`) and HTTP 5xx are transient,
+     * so retrying the idempotent confirm may still succeed. Any other HTTP status
+     * (4xx) is a definitive rejection and is not retried.
+     */
+    private isRetryableConfirmError;
+    /**
+     * Retry the confirm POST on transient failures, bounded by both an attempt
+     * count and a time budget that stays within the server's apply lease. Only
+     * the confirm POST is retried here — the caller runs the user's onApply
+     * handler exactly once, before invoking this, so retries never re-run it.
+     * A `confirmed: false` result (a genuine claim loss) is returned normally,
+     * not retried; the caller releases the claim in that case.
+     */
+    private confirmWorkflowApplyWithRetry;
     private getWorkflowPendingApplies;
     private defineWorkflow;
     private handleWorkflowApply;
@@ -1489,7 +1582,7 @@ export declare class JsBaoClient extends Observable<any> {
      * @param documentId - The document to set awareness for
      * @param state - Arbitrary awareness data (cursor, selection, user info) to broadcast to collaborators
      * @group Awareness */
-    setAwareness(documentId: string, state: any): void;
+    setAwareness<S = unknown>(documentId: string, state: S): void;
     private getIndexedDbNames;
     private doesIndexedDbExist;
     /** Check if a document has IndexedDB persistence.
@@ -1597,11 +1690,11 @@ export declare class JsBaoClient extends Observable<any> {
      *   Note: the server's wire field is named `metadata`; the local cache key is
      *   `docMetadata` to avoid colliding with the cache envelope's `metadata` key.
      * @group Documents */
-    updateLocalMetadata(documentId: string, updates: {
+    updateLocalMetadata<M = unknown>(documentId: string, updates: {
         title?: string;
         tags?: string[];
         thumbnailBlobId?: string | null;
-        docMetadata?: unknown | null;
+        docMetadata?: M | null;
     }): Promise<void>;
     private _updateSynced;
     /** Open a document for real-time collaboration and sync.
@@ -1811,15 +1904,15 @@ export declare class JsBaoClient extends Observable<any> {
      * @param documentId - The document to set awareness for
      * @param state - Arbitrary awareness data (cursor, selection, user info) to broadcast to collaborators
      * @group Awareness */
-    setLocalAwarenessState(documentId: string, state: any): void;
+    setLocalAwarenessState<S = unknown>(documentId: string, state: S): void;
     /** Get the local user's current awareness state for a document.
      * @param documentId - The document to get local awareness for
      * @group Awareness */
-    getLocalAwarenessState(documentId: string): any | null;
+    getLocalAwarenessState<S = unknown>(documentId: string): S | null;
     /** Get all users' awareness states for a document.
      * @param documentId - The document to get awareness states for
      * @group Awareness */
-    getAwarenessStates(documentId: string): Map<string, any>;
+    getAwarenessStates<S = unknown>(documentId: string): Map<string, S>;
     /** Remove awareness states for specific clients and broadcast the removal to the server.
      * @param documentId - The document to remove awareness from
      * @param clientIds - Array of client IDs whose awareness states should be removed
@@ -2153,7 +2246,7 @@ export declare class JsBaoClient extends Observable<any> {
      * @param options - Document creation options
      * @group Documents */
     createDocument(options: CreateDocumentOptions): Promise<{
-        metadata: any;
+        metadata: LocalMetadataEntry;
     }>;
     /** Retry committing a pending offline-created document to the server.
      * @param documentId - The pending document to retry committing