@arbidocs/sdk 0.3.37 → 0.3.39

package/dist/{browser-C4thO0RE.d.cts → browser-MSSje4v8.d.cts}

@@ -572,6 +572,68 @@ declare function stripCitationMarkdown(text: string): string;
  */
 
 type DocUpdateRequest$1 = components['schemas']['DocUpdateRequest'];
+type DocResponse = components['schemas']['DocResponse'];
+/**
+ * Ordering for paginated document listing.
+ *
+ * - `id_asc` — walk by primary key (default). Stable, matches legacy behavior.
+ * - `created_desc` — newest-first. Uses a warm index; preferred for progressive
+ *   loaders that want the most-recently-added docs in the first page.
+ *
+ * These values are derived from the backend schema docs for the `order` query
+ * param on `GET /v1/document/list`. The schema types the param as `string` to
+ * allow future additions without a breaking schema change, so we define the
+ * narrow union here in the SDK.
+ */
+type DocumentListOrder = 'id_asc' | 'created_desc';
+/**
+ * Response shape for paginated document listing.
+ *
+ * - `full` (default) — returns full `DocResponse` with decrypted `doc_metadata`
+ *   and joined `doctags`. Same as the legacy single-shot endpoint.
+ * - `lite` — skips the doctags JOIN and `doc_metadata` decrypt. Returned docs
+ *   will have `doctags: []` and `doc_metadata: null`. Use this for listing
+ *   large workspaces and fetch full per-doc data on demand via
+ *   `GET /v1/document/` when a specific doc is opened.
+ *
+ * These values are derived from the backend schema docs for the `fields` query
+ * param on `GET /v1/document/list`. The schema types the param as `string`.
+ */
+type DocumentListFields = 'full' | 'lite';
+/**
+ * Options for paginated document listing.
+ */
+interface ListPaginatedOptions {
+    /**
+     * Number of documents per page.
+     * @default 5000
+     */
+    pageSize?: number;
+    /**
+     * Sort order for pagination.
+     * @default 'id_asc'
+     */
+    order?: DocumentListOrder;
+    /**
+     * Response shape. Use `'lite'` to skip doctags and doc_metadata decrypt.
+     * When `fields: 'lite'`, returned docs have `doctags: []` and `doc_metadata: null`.
+     * Fetch full per-doc data on demand when a specific doc is opened.
+     * @default 'full'
+     */
+    fields?: DocumentListFields;
+    /**
+     * AbortSignal to cancel iteration mid-stream.
+     */
+    signal?: AbortSignal;
+}
+/**
+ * Options for `listAll` — collects all pages into a single array.
+ */
+interface ListAllOptions extends Omit<ListPaginatedOptions, 'signal'> {
+    signal?: AbortSignal;
+}
+/** Hard cap on pages to guard against runaway loops on misbehaving backends. */
+declare const MAX_PAGES = 400;
 /** File extensions supported for document upload. */
 declare const SUPPORTED_EXTENSIONS: Set<string>;
 /**
@@ -655,6 +717,40 @@ declare function listDocuments(arbi: ArbiClient): Promise<{
         title?: string | null | undefined;
     } | null | undefined;
 }[]>;
+/**
+ * Async iterator that yields pages of documents sequentially.
+ *
+ * Fetches pages one at a time using `limit`/`offset` pagination. Sequential
+ * (not parallel) because the backend decrypt step is CPU-bound on a shared
+ * thread pool — parallel requests contend and don't finish meaningfully faster.
+ *
+ * @example
+ * ```ts
+ * for await (const page of listPaginated(arbi, { pageSize: 5000, order: 'created_desc', fields: 'lite' })) {
+ *   // page: DocResponse[] — render incrementally as pages arrive
+ * }
+ * ```
+ *
+ * @param arbi - Authenticated ArbiClient
+ * @param options - Pagination options (pageSize, order, fields, signal)
+ * @yields Pages of documents until the backend returns a short page or signal is aborted
+ */
+declare function listPaginated(arbi: ArbiClient, options?: ListPaginatedOptions): AsyncGenerator<DocResponse[]>;
+/**
+ * Collect all workspace documents into a single array using sequential pagination.
+ *
+ * Uses `listPaginated` internally. Warns if `MAX_PAGES` is hit.
+ *
+ * **Note:** When `fields: 'lite'` is passed, returned docs have `doctags: []`
+ * and `doc_metadata: null`. Fetch full per-doc data on demand when a specific
+ * doc is opened.
+ *
+ * @example
+ * ```ts
+ * const docs = await listAll(arbi, { fields: 'lite', order: 'created_desc' })
+ * ```
+ */
+declare function listAll(arbi: ArbiClient, options?: ListAllOptions): Promise<DocResponse[]>;
 declare function getDocuments(arbi: ArbiClient, externalIds: string[]): Promise<{
     external_id: string;
     workspace_ext_id: string;
@@ -839,6 +935,11 @@ interface UploadDirectResult {
 declare function uploadDocumentsDirect(arbi: ArbiClient, workspaceKey: Uint8Array, files: DirectUploadFile[], options?: UploadDirectOptions): Promise<UploadDirectResult>;
 
 type documents_DirectUploadFile = DirectUploadFile;
+type documents_DocumentListFields = DocumentListFields;
+type documents_DocumentListOrder = DocumentListOrder;
+type documents_ListAllOptions = ListAllOptions;
+type documents_ListPaginatedOptions = ListPaginatedOptions;
+declare const documents_MAX_PAGES: typeof MAX_PAGES;
 declare const documents_SUPPORTED_EXTENSIONS: typeof SUPPORTED_EXTENSIONS;
 type documents_SkippedFile = SkippedFile;
 type documents_UploadBatchResult = UploadBatchResult;
@@ -850,14 +951,16 @@ declare const documents_deleteDocuments: typeof deleteDocuments;
 declare const documents_downloadDocument: typeof downloadDocument;
 declare const documents_getDocuments: typeof getDocuments;
 declare const documents_getParsedContent: typeof getParsedContent;
+declare const documents_listAll: typeof listAll;
 declare const documents_listDocuments: typeof listDocuments;
+declare const documents_listPaginated: typeof listPaginated;
 declare const documents_sanitizeFolderPath: typeof sanitizeFolderPath;
 declare const documents_updateDocuments: typeof updateDocuments;
 declare const documents_uploadDocumentsDirect: typeof uploadDocumentsDirect;
 declare const documents_uploadFiles: typeof uploadFiles;
 declare const documents_uploadUrl: typeof uploadUrl;
 declare namespace documents {
-  export { type documents_DirectUploadFile as DirectUploadFile, documents_SUPPORTED_EXTENSIONS as SUPPORTED_EXTENSIONS, type documents_SkippedFile as SkippedFile, type documents_UploadBatchResult as UploadBatchResult, type documents_UploadDirectOptions as UploadDirectOptions, type documents_UploadDirectResult as UploadDirectResult, type documents_UploadOptions as UploadOptions, type documents_UploadResult as UploadResult, documents_deleteDocuments as deleteDocuments, documents_downloadDocument as downloadDocument, documents_getDocuments as getDocuments, documents_getParsedContent as getParsedContent, documents_listDocuments as listDocuments, documents_sanitizeFolderPath as sanitizeFolderPath, documents_updateDocuments as updateDocuments, documents_uploadDocumentsDirect as uploadDocumentsDirect, uploadFile$1 as uploadFile, documents_uploadFiles as uploadFiles, documents_uploadUrl as uploadUrl };
+  export { type documents_DirectUploadFile as DirectUploadFile, type documents_DocumentListFields as DocumentListFields, type documents_DocumentListOrder as DocumentListOrder, type documents_ListAllOptions as ListAllOptions, type documents_ListPaginatedOptions as ListPaginatedOptions, documents_MAX_PAGES as MAX_PAGES, documents_SUPPORTED_EXTENSIONS as SUPPORTED_EXTENSIONS, type documents_SkippedFile as SkippedFile, type documents_UploadBatchResult as UploadBatchResult, type documents_UploadDirectOptions as UploadDirectOptions, type documents_UploadDirectResult as UploadDirectResult, type documents_UploadOptions as UploadOptions, type documents_UploadResult as UploadResult, documents_deleteDocuments as deleteDocuments, documents_downloadDocument as downloadDocument, documents_getDocuments as getDocuments, documents_getParsedContent as getParsedContent, documents_listAll as listAll, documents_listDocuments as listDocuments, documents_listPaginated as listPaginated, documents_sanitizeFolderPath as sanitizeFolderPath, documents_updateDocuments as updateDocuments, documents_uploadDocumentsDirect as uploadDocumentsDirect, uploadFile$1 as uploadFile, documents_uploadFiles as uploadFiles, documents_uploadUrl as uploadUrl };
 }
 
 /**
@@ -1499,6 +1602,78 @@ declare class Arbi {
                 title?: string | null | undefined;
             } | null | undefined;
         }[]>;
+        /**
+         * Async iterator that yields pages of documents sequentially.
+         * Use this for large workspaces to stream output as pages arrive.
+         *
+         * @example
+         * ```ts
+         * for await (const page of arbi.documents.listPaginated({ pageSize: 5000, order: 'created_desc', fields: 'lite' })) {
+         *   // page: DocResponse[] — render incrementally
+         * }
+         * ```
+         */
+        listPaginated: (options?: ListPaginatedOptions) => AsyncGenerator<{
+            external_id: string;
+            workspace_ext_id: string;
+            file_name?: string | null;
+            status?: string | null;
+            error_message?: string | null;
+            n_pages?: number | null;
+            n_chunks?: number | null;
+            tokens?: number | null;
+            file_type?: string | null;
+            file_size?: number | null;
+            storage_type?: string | null;
+            storage_uri?: string | null;
+            content_hash?: string | null;
+            shared?: boolean | null;
+            re_ocred?: boolean | null;
+            config_ext_id?: string | null;
+            parent_ext_id?: string | null;
+            created_by_ext_id: string;
+            updated_by_ext_id?: string | null;
+            created_at: string;
+            updated_at: string;
+            wp_type?: string | null;
+            folder?: string | null;
+            doctags: components["schemas"]["DocTagResponse"][];
+            doc_metadata?: components["schemas"]["DocMetadata"] | null;
+        }[], any, any>;
+        /**
+         * Collect all workspace documents into a single array using sequential pagination.
+         *
+         * **Note:** When `fields: 'lite'` is passed, returned docs have `doctags: []`
+         * and `doc_metadata: null`. Fetch full per-doc data on demand when a specific
+         * doc is opened.
+         */
+        listAll: (options?: ListAllOptions) => Promise<{
+            external_id: string;
+            workspace_ext_id: string;
+            file_name?: string | null;
+            status?: string | null;
+            error_message?: string | null;
+            n_pages?: number | null;
+            n_chunks?: number | null;
+            tokens?: number | null;
+            file_type?: string | null;
+            file_size?: number | null;
+            storage_type?: string | null;
+            storage_uri?: string | null;
+            content_hash?: string | null;
+            shared?: boolean | null;
+            re_ocred?: boolean | null;
+            config_ext_id?: string | null;
+            parent_ext_id?: string | null;
+            created_by_ext_id: string;
+            updated_by_ext_id?: string | null;
+            created_at: string;
+            updated_at: string;
+            wp_type?: string | null;
+            folder?: string | null;
+            doctags: components["schemas"]["DocTagResponse"][];
+            doc_metadata?: components["schemas"]["DocMetadata"] | null;
+        }[]>;
         get: (externalIds: string[]) => Promise<{
             external_id: string;
             workspace_ext_id: string;
@@ -3860,4 +4035,4 @@ declare namespace responses {
   export { type responses_SubmitBackgroundQueryOptions as SubmitBackgroundQueryOptions, responses_extractResponseText as extractResponseText, responses_getResponse as getResponse, responses_submitBackgroundQuery as submitBackgroundQuery };
 }
 
-export { agentconfig as $, type AuthHeaders as A, type ResponseContentPartAddedEvent as B, type ConfigStore as C, type DmCryptoContext as D, type ResponseCreatedEvent as E, type FormattedWsMessage as F, type ResponseFailedEvent as G, type ResponseOutputItemAddedEvent as H, type ResponseOutputItemDoneEvent as I, type ResponseOutputTextDeltaEvent as J, type ResponseOutputTextDoneEvent as K, type ResponseUsage as L, type MessageLevel as M, type SSEEvent as N, type OutputTokensDetails as O, type SSEStreamCallbacks as P, type QueryOptions as Q, type ReconnectOptions as R, type SkippedFile as S, type SSEStreamResult as T, type UploadResult as U, type SSEStreamStartData as V, type UserInfo as W, type UserInputRequestEvent as X, type UserMessageEvent as Y, type WorkspaceContext as Z, type WsConnection as _, type CliConfig as a, assistant as a0, authenticatedFetch as a1, buildRetrievalChunkTool as a2, buildRetrievalFullContextTool as a3, buildRetrievalTocTool as a4, connectWebSocket as a5, connectWithReconnect as a6, consumeSSEStream as a7, contacts as a8, conversations as a9, resolveCitations as aA, resolveWorkspace as aB, responses as aC, selectWorkspace as aD, selectWorkspaceById as aE, settings as aF, streamSSE as aG, stripCitationMarkdown as aH, summarizeCitations as aI, tags as aJ, workspaces as aK, countCitations as aa, createAuthenticatedClient as ab, createDocumentWaiter as ac, dm as ad, doctags as ae, documents as af, files as ag, formatAgentStepLabel as ah, formatFileSize as ai, formatStreamSummary as aj, formatUserName as ak, formatWorkspaceChoices as al, formatWsMessage as am, generateEncryptedWorkspaceKey as an, generateNewWorkspaceKey as ao, getErrorCode as ap, getErrorMessage as aq, getRawWorkspaceKey as ar, health as as, parseSSEEvents as at, performPasswordLogin as au, performSigningKeyLogin as av, performSsoDeviceFlowLogin as aw, requireData as ax, requireOk as ay, resolveAuth as az, type CliCredentials as b, type ChatSession as c, type UploadBatchResult as d, type UploadOptions as e, type UploadDirectOptions as f, type UploadDirectResult as g, SUPPORTED_EXTENSIONS as h, type AgentStepEvent as i, Arbi as j, ArbiApiError as k, ArbiError as l, type ArbiOptions as m, type ArtifactEvent as n, type AuthContext as o, type AuthenticatedClient as p, type CitationSummary as q, type ConnectOptions as r, DOC_TERMINAL_STATUSES as s, type DocumentWaiter as t, type DocumentWaiterOptions as u, type MessageMetadataPayload$1 as v, type MessageQueuedEvent as w, type ReconnectableWsConnection as x, type ResolvedCitation as y, type ResponseCompletedEvent as z };
+export { type UserInputRequestEvent as $, type AuthHeaders as A, type ReconnectableWsConnection as B, type ConfigStore as C, type DmCryptoContext as D, type ResolvedCitation as E, type FormattedWsMessage as F, type ResponseCompletedEvent as G, type ResponseContentPartAddedEvent as H, type ResponseCreatedEvent as I, type ResponseFailedEvent as J, type ResponseOutputItemAddedEvent as K, type ListAllOptions as L, type MessageLevel as M, type ResponseOutputItemDoneEvent as N, type OutputTokensDetails as O, type ResponseOutputTextDeltaEvent as P, type QueryOptions as Q, type ReconnectOptions as R, type SkippedFile as S, type ResponseOutputTextDoneEvent as T, type UploadResult as U, type ResponseUsage as V, type SSEEvent as W, type SSEStreamCallbacks as X, type SSEStreamResult as Y, type SSEStreamStartData as Z, type UserInfo as _, type CliConfig as a, type UserMessageEvent as a0, type WorkspaceContext as a1, type WsConnection as a2, agentconfig as a3, assistant as a4, authenticatedFetch as a5, buildRetrievalChunkTool as a6, buildRetrievalFullContextTool as a7, buildRetrievalTocTool as a8, connectWebSocket as a9, performSsoDeviceFlowLogin as aA, requireData as aB, requireOk as aC, resolveAuth as aD, resolveCitations as aE, resolveWorkspace as aF, responses as aG, selectWorkspace as aH, selectWorkspaceById as aI, settings as aJ, streamSSE as aK, stripCitationMarkdown as aL, summarizeCitations as aM, tags as aN, workspaces as aO, connectWithReconnect as aa, consumeSSEStream as ab, contacts as ac, conversations as ad, countCitations as ae, createAuthenticatedClient as af, createDocumentWaiter as ag, dm as ah, doctags as ai, documents as aj, files as ak, formatAgentStepLabel as al, formatFileSize as am, formatStreamSummary as an, formatUserName as ao, formatWorkspaceChoices as ap, formatWsMessage as aq, generateEncryptedWorkspaceKey as ar, generateNewWorkspaceKey as as, getErrorCode as at, getErrorMessage as au, getRawWorkspaceKey as av, health as aw, parseSSEEvents as ax, performPasswordLogin as ay, performSigningKeyLogin as az, type CliCredentials as b, type ChatSession as c, type UploadBatchResult as d, type UploadOptions as e, type UploadDirectOptions as f, type UploadDirectResult as g, SUPPORTED_EXTENSIONS as h, type AgentStepEvent as i, Arbi as j, ArbiApiError as k, ArbiError as l, type ArbiOptions as m, type ArtifactEvent as n, type AuthContext as o, type AuthenticatedClient as p, type CitationSummary as q, type ConnectOptions as r, DOC_TERMINAL_STATUSES as s, type DocumentListFields as t, type DocumentListOrder as u, type DocumentWaiter as v, type DocumentWaiterOptions as w, type ListPaginatedOptions as x, type MessageMetadataPayload$1 as y, type MessageQueuedEvent as z };

package/dist/{browser-C4thO0RE.d.ts → browser-MSSje4v8.d.ts}

@@ -572,6 +572,68 @@ declare function stripCitationMarkdown(text: string): string;
  */
 
 type DocUpdateRequest$1 = components['schemas']['DocUpdateRequest'];
+type DocResponse = components['schemas']['DocResponse'];
+/**
+ * Ordering for paginated document listing.
+ *
+ * - `id_asc` — walk by primary key (default). Stable, matches legacy behavior.
+ * - `created_desc` — newest-first. Uses a warm index; preferred for progressive
+ *   loaders that want the most-recently-added docs in the first page.
+ *
+ * These values are derived from the backend schema docs for the `order` query
+ * param on `GET /v1/document/list`. The schema types the param as `string` to
+ * allow future additions without a breaking schema change, so we define the
+ * narrow union here in the SDK.
+ */
+type DocumentListOrder = 'id_asc' | 'created_desc';
+/**
+ * Response shape for paginated document listing.
+ *
+ * - `full` (default) — returns full `DocResponse` with decrypted `doc_metadata`
+ *   and joined `doctags`. Same as the legacy single-shot endpoint.
+ * - `lite` — skips the doctags JOIN and `doc_metadata` decrypt. Returned docs
+ *   will have `doctags: []` and `doc_metadata: null`. Use this for listing
+ *   large workspaces and fetch full per-doc data on demand via
+ *   `GET /v1/document/` when a specific doc is opened.
+ *
+ * These values are derived from the backend schema docs for the `fields` query
+ * param on `GET /v1/document/list`. The schema types the param as `string`.
+ */
+type DocumentListFields = 'full' | 'lite';
+/**
+ * Options for paginated document listing.
+ */
+interface ListPaginatedOptions {
+    /**
+     * Number of documents per page.
+     * @default 5000
+     */
+    pageSize?: number;
+    /**
+     * Sort order for pagination.
+     * @default 'id_asc'
+     */
+    order?: DocumentListOrder;
+    /**
+     * Response shape. Use `'lite'` to skip doctags and doc_metadata decrypt.
+     * When `fields: 'lite'`, returned docs have `doctags: []` and `doc_metadata: null`.
+     * Fetch full per-doc data on demand when a specific doc is opened.
+     * @default 'full'
+     */
+    fields?: DocumentListFields;
+    /**
+     * AbortSignal to cancel iteration mid-stream.
+     */
+    signal?: AbortSignal;
+}
+/**
+ * Options for `listAll` — collects all pages into a single array.
+ */
+interface ListAllOptions extends Omit<ListPaginatedOptions, 'signal'> {
+    signal?: AbortSignal;
+}
+/** Hard cap on pages to guard against runaway loops on misbehaving backends. */
+declare const MAX_PAGES = 400;
 /** File extensions supported for document upload. */
 declare const SUPPORTED_EXTENSIONS: Set<string>;
 /**
@@ -655,6 +717,40 @@ declare function listDocuments(arbi: ArbiClient): Promise<{
         title?: string | null | undefined;
     } | null | undefined;
 }[]>;
+/**
+ * Async iterator that yields pages of documents sequentially.
+ *
+ * Fetches pages one at a time using `limit`/`offset` pagination. Sequential
+ * (not parallel) because the backend decrypt step is CPU-bound on a shared
+ * thread pool — parallel requests contend and don't finish meaningfully faster.
+ *
+ * @example
+ * ```ts
+ * for await (const page of listPaginated(arbi, { pageSize: 5000, order: 'created_desc', fields: 'lite' })) {
+ *   // page: DocResponse[] — render incrementally as pages arrive
+ * }
+ * ```
+ *
+ * @param arbi - Authenticated ArbiClient
+ * @param options - Pagination options (pageSize, order, fields, signal)
+ * @yields Pages of documents until the backend returns a short page or signal is aborted
+ */
+declare function listPaginated(arbi: ArbiClient, options?: ListPaginatedOptions): AsyncGenerator<DocResponse[]>;
+/**
+ * Collect all workspace documents into a single array using sequential pagination.
+ *
+ * Uses `listPaginated` internally. Warns if `MAX_PAGES` is hit.
+ *
+ * **Note:** When `fields: 'lite'` is passed, returned docs have `doctags: []`
+ * and `doc_metadata: null`. Fetch full per-doc data on demand when a specific
+ * doc is opened.
+ *
+ * @example
+ * ```ts
+ * const docs = await listAll(arbi, { fields: 'lite', order: 'created_desc' })
+ * ```
+ */
+declare function listAll(arbi: ArbiClient, options?: ListAllOptions): Promise<DocResponse[]>;
 declare function getDocuments(arbi: ArbiClient, externalIds: string[]): Promise<{
     external_id: string;
     workspace_ext_id: string;
@@ -839,6 +935,11 @@ interface UploadDirectResult {
 declare function uploadDocumentsDirect(arbi: ArbiClient, workspaceKey: Uint8Array, files: DirectUploadFile[], options?: UploadDirectOptions): Promise<UploadDirectResult>;
 
 type documents_DirectUploadFile = DirectUploadFile;
+type documents_DocumentListFields = DocumentListFields;
+type documents_DocumentListOrder = DocumentListOrder;
+type documents_ListAllOptions = ListAllOptions;
+type documents_ListPaginatedOptions = ListPaginatedOptions;
+declare const documents_MAX_PAGES: typeof MAX_PAGES;
 declare const documents_SUPPORTED_EXTENSIONS: typeof SUPPORTED_EXTENSIONS;
 type documents_SkippedFile = SkippedFile;
 type documents_UploadBatchResult = UploadBatchResult;
@@ -850,14 +951,16 @@ declare const documents_deleteDocuments: typeof deleteDocuments;
 declare const documents_downloadDocument: typeof downloadDocument;
 declare const documents_getDocuments: typeof getDocuments;
 declare const documents_getParsedContent: typeof getParsedContent;
+declare const documents_listAll: typeof listAll;
 declare const documents_listDocuments: typeof listDocuments;
+declare const documents_listPaginated: typeof listPaginated;
 declare const documents_sanitizeFolderPath: typeof sanitizeFolderPath;
 declare const documents_updateDocuments: typeof updateDocuments;
 declare const documents_uploadDocumentsDirect: typeof uploadDocumentsDirect;
 declare const documents_uploadFiles: typeof uploadFiles;
 declare const documents_uploadUrl: typeof uploadUrl;
 declare namespace documents {
-  export { type documents_DirectUploadFile as DirectUploadFile, documents_SUPPORTED_EXTENSIONS as SUPPORTED_EXTENSIONS, type documents_SkippedFile as SkippedFile, type documents_UploadBatchResult as UploadBatchResult, type documents_UploadDirectOptions as UploadDirectOptions, type documents_UploadDirectResult as UploadDirectResult, type documents_UploadOptions as UploadOptions, type documents_UploadResult as UploadResult, documents_deleteDocuments as deleteDocuments, documents_downloadDocument as downloadDocument, documents_getDocuments as getDocuments, documents_getParsedContent as getParsedContent, documents_listDocuments as listDocuments, documents_sanitizeFolderPath as sanitizeFolderPath, documents_updateDocuments as updateDocuments, documents_uploadDocumentsDirect as uploadDocumentsDirect, uploadFile$1 as uploadFile, documents_uploadFiles as uploadFiles, documents_uploadUrl as uploadUrl };
+  export { type documents_DirectUploadFile as DirectUploadFile, type documents_DocumentListFields as DocumentListFields, type documents_DocumentListOrder as DocumentListOrder, type documents_ListAllOptions as ListAllOptions, type documents_ListPaginatedOptions as ListPaginatedOptions, documents_MAX_PAGES as MAX_PAGES, documents_SUPPORTED_EXTENSIONS as SUPPORTED_EXTENSIONS, type documents_SkippedFile as SkippedFile, type documents_UploadBatchResult as UploadBatchResult, type documents_UploadDirectOptions as UploadDirectOptions, type documents_UploadDirectResult as UploadDirectResult, type documents_UploadOptions as UploadOptions, type documents_UploadResult as UploadResult, documents_deleteDocuments as deleteDocuments, documents_downloadDocument as downloadDocument, documents_getDocuments as getDocuments, documents_getParsedContent as getParsedContent, documents_listAll as listAll, documents_listDocuments as listDocuments, documents_listPaginated as listPaginated, documents_sanitizeFolderPath as sanitizeFolderPath, documents_updateDocuments as updateDocuments, documents_uploadDocumentsDirect as uploadDocumentsDirect, uploadFile$1 as uploadFile, documents_uploadFiles as uploadFiles, documents_uploadUrl as uploadUrl };
 }
 
 /**
@@ -1499,6 +1602,78 @@ declare class Arbi {
                 title?: string | null | undefined;
             } | null | undefined;
         }[]>;
+        /**
+         * Async iterator that yields pages of documents sequentially.
+         * Use this for large workspaces to stream output as pages arrive.
+         *
+         * @example
+         * ```ts
+         * for await (const page of arbi.documents.listPaginated({ pageSize: 5000, order: 'created_desc', fields: 'lite' })) {
+         *   // page: DocResponse[] — render incrementally
+         * }
+         * ```
+         */
+        listPaginated: (options?: ListPaginatedOptions) => AsyncGenerator<{
+            external_id: string;
+            workspace_ext_id: string;
+            file_name?: string | null;
+            status?: string | null;
+            error_message?: string | null;
+            n_pages?: number | null;
+            n_chunks?: number | null;
+            tokens?: number | null;
+            file_type?: string | null;
+            file_size?: number | null;
+            storage_type?: string | null;
+            storage_uri?: string | null;
+            content_hash?: string | null;
+            shared?: boolean | null;
+            re_ocred?: boolean | null;
+            config_ext_id?: string | null;
+            parent_ext_id?: string | null;
+            created_by_ext_id: string;
+            updated_by_ext_id?: string | null;
+            created_at: string;
+            updated_at: string;
+            wp_type?: string | null;
+            folder?: string | null;
+            doctags: components["schemas"]["DocTagResponse"][];
+            doc_metadata?: components["schemas"]["DocMetadata"] | null;
+        }[], any, any>;
+        /**
+         * Collect all workspace documents into a single array using sequential pagination.
+         *
+         * **Note:** When `fields: 'lite'` is passed, returned docs have `doctags: []`
+         * and `doc_metadata: null`. Fetch full per-doc data on demand when a specific
+         * doc is opened.
+         */
+        listAll: (options?: ListAllOptions) => Promise<{
+            external_id: string;
+            workspace_ext_id: string;
+            file_name?: string | null;
+            status?: string | null;
+            error_message?: string | null;
+            n_pages?: number | null;
+            n_chunks?: number | null;
+            tokens?: number | null;
+            file_type?: string | null;
+            file_size?: number | null;
+            storage_type?: string | null;
+            storage_uri?: string | null;
+            content_hash?: string | null;
+            shared?: boolean | null;
+            re_ocred?: boolean | null;
+            config_ext_id?: string | null;
+            parent_ext_id?: string | null;
+            created_by_ext_id: string;
+            updated_by_ext_id?: string | null;
+            created_at: string;
+            updated_at: string;
+            wp_type?: string | null;
+            folder?: string | null;
+            doctags: components["schemas"]["DocTagResponse"][];
+            doc_metadata?: components["schemas"]["DocMetadata"] | null;
+        }[]>;
         get: (externalIds: string[]) => Promise<{
             external_id: string;
             workspace_ext_id: string;
@@ -3860,4 +4035,4 @@ declare namespace responses {
   export { type responses_SubmitBackgroundQueryOptions as SubmitBackgroundQueryOptions, responses_extractResponseText as extractResponseText, responses_getResponse as getResponse, responses_submitBackgroundQuery as submitBackgroundQuery };
 }
 
-export { agentconfig as $, type AuthHeaders as A, type ResponseContentPartAddedEvent as B, type ConfigStore as C, type DmCryptoContext as D, type ResponseCreatedEvent as E, type FormattedWsMessage as F, type ResponseFailedEvent as G, type ResponseOutputItemAddedEvent as H, type ResponseOutputItemDoneEvent as I, type ResponseOutputTextDeltaEvent as J, type ResponseOutputTextDoneEvent as K, type ResponseUsage as L, type MessageLevel as M, type SSEEvent as N, type OutputTokensDetails as O, type SSEStreamCallbacks as P, type QueryOptions as Q, type ReconnectOptions as R, type SkippedFile as S, type SSEStreamResult as T, type UploadResult as U, type SSEStreamStartData as V, type UserInfo as W, type UserInputRequestEvent as X, type UserMessageEvent as Y, type WorkspaceContext as Z, type WsConnection as _, type CliConfig as a, assistant as a0, authenticatedFetch as a1, buildRetrievalChunkTool as a2, buildRetrievalFullContextTool as a3, buildRetrievalTocTool as a4, connectWebSocket as a5, connectWithReconnect as a6, consumeSSEStream as a7, contacts as a8, conversations as a9, resolveCitations as aA, resolveWorkspace as aB, responses as aC, selectWorkspace as aD, selectWorkspaceById as aE, settings as aF, streamSSE as aG, stripCitationMarkdown as aH, summarizeCitations as aI, tags as aJ, workspaces as aK, countCitations as aa, createAuthenticatedClient as ab, createDocumentWaiter as ac, dm as ad, doctags as ae, documents as af, files as ag, formatAgentStepLabel as ah, formatFileSize as ai, formatStreamSummary as aj, formatUserName as ak, formatWorkspaceChoices as al, formatWsMessage as am, generateEncryptedWorkspaceKey as an, generateNewWorkspaceKey as ao, getErrorCode as ap, getErrorMessage as aq, getRawWorkspaceKey as ar, health as as, parseSSEEvents as at, performPasswordLogin as au, performSigningKeyLogin as av, performSsoDeviceFlowLogin as aw, requireData as ax, requireOk as ay, resolveAuth as az, type CliCredentials as b, type ChatSession as c, type UploadBatchResult as d, type UploadOptions as e, type UploadDirectOptions as f, type UploadDirectResult as g, SUPPORTED_EXTENSIONS as h, type AgentStepEvent as i, Arbi as j, ArbiApiError as k, ArbiError as l, type ArbiOptions as m, type ArtifactEvent as n, type AuthContext as o, type AuthenticatedClient as p, type CitationSummary as q, type ConnectOptions as r, DOC_TERMINAL_STATUSES as s, type DocumentWaiter as t, type DocumentWaiterOptions as u, type MessageMetadataPayload$1 as v, type MessageQueuedEvent as w, type ReconnectableWsConnection as x, type ResolvedCitation as y, type ResponseCompletedEvent as z };
+export { type UserInputRequestEvent as $, type AuthHeaders as A, type ReconnectableWsConnection as B, type ConfigStore as C, type DmCryptoContext as D, type ResolvedCitation as E, type FormattedWsMessage as F, type ResponseCompletedEvent as G, type ResponseContentPartAddedEvent as H, type ResponseCreatedEvent as I, type ResponseFailedEvent as J, type ResponseOutputItemAddedEvent as K, type ListAllOptions as L, type MessageLevel as M, type ResponseOutputItemDoneEvent as N, type OutputTokensDetails as O, type ResponseOutputTextDeltaEvent as P, type QueryOptions as Q, type ReconnectOptions as R, type SkippedFile as S, type ResponseOutputTextDoneEvent as T, type UploadResult as U, type ResponseUsage as V, type SSEEvent as W, type SSEStreamCallbacks as X, type SSEStreamResult as Y, type SSEStreamStartData as Z, type UserInfo as _, type CliConfig as a, type UserMessageEvent as a0, type WorkspaceContext as a1, type WsConnection as a2, agentconfig as a3, assistant as a4, authenticatedFetch as a5, buildRetrievalChunkTool as a6, buildRetrievalFullContextTool as a7, buildRetrievalTocTool as a8, connectWebSocket as a9, performSsoDeviceFlowLogin as aA, requireData as aB, requireOk as aC, resolveAuth as aD, resolveCitations as aE, resolveWorkspace as aF, responses as aG, selectWorkspace as aH, selectWorkspaceById as aI, settings as aJ, streamSSE as aK, stripCitationMarkdown as aL, summarizeCitations as aM, tags as aN, workspaces as aO, connectWithReconnect as aa, consumeSSEStream as ab, contacts as ac, conversations as ad, countCitations as ae, createAuthenticatedClient as af, createDocumentWaiter as ag, dm as ah, doctags as ai, documents as aj, files as ak, formatAgentStepLabel as al, formatFileSize as am, formatStreamSummary as an, formatUserName as ao, formatWorkspaceChoices as ap, formatWsMessage as aq, generateEncryptedWorkspaceKey as ar, generateNewWorkspaceKey as as, getErrorCode as at, getErrorMessage as au, getRawWorkspaceKey as av, health as aw, parseSSEEvents as ax, performPasswordLogin as ay, performSigningKeyLogin as az, type CliCredentials as b, type ChatSession as c, type UploadBatchResult as d, type UploadOptions as e, type UploadDirectOptions as f, type UploadDirectResult as g, SUPPORTED_EXTENSIONS as h, type AgentStepEvent as i, Arbi as j, ArbiApiError as k, ArbiError as l, type ArbiOptions as m, type ArtifactEvent as n, type AuthContext as o, type AuthenticatedClient as p, type CitationSummary as q, type ConnectOptions as r, DOC_TERMINAL_STATUSES as s, type DocumentListFields as t, type DocumentListOrder as u, type DocumentWaiter as v, type DocumentWaiterOptions as w, type ListPaginatedOptions as x, type MessageMetadataPayload$1 as y, type MessageQueuedEvent as z };