@arbidocs/sdk 0.4.2 → 0.4.4

package/dist/{browser-U90kdb7T.d.cts → browser-Bdzn5DIN.d.cts}

@@ -9,6 +9,10 @@ import { SessionStorageProvider, ArbiClient, LoginResult, components, WebSocketS
 declare class ArbiError extends Error {
     constructor(message: string);
 }
+/** The session cannot be recovered (token and workspace re-open both refused): sign in again. */
+declare class ArbiSessionExpiredError extends ArbiError {
+    constructor(message?: string);
+}
 declare class ArbiApiError extends ArbiError {
     readonly apiError?: unknown;
     constructor(message: string, apiError?: unknown);
@@ -1877,6 +1881,7 @@ declare namespace files {
 type TaskResponse = components['schemas']['TaskResponse'];
 type CreateTaskRequest = components['schemas']['CreateTaskRequest'];
 type UpdateTaskRequest = components['schemas']['UpdateTaskRequest'];
+type TaskRunResponse = components['schemas']['TaskRunResponse'];
 /** List the caller's scheduled tasks (newest first). */
 declare function listTasks(arbi: ArbiClient): Promise<TaskResponse[]>;
 /** Create a scheduled task. `name` is required; supply trigger + action fields. */
@@ -1887,18 +1892,22 @@ declare function updateTask(arbi: ArbiClient, taskId: string, body: UpdateTaskRe
 declare function deleteTask(arbi: ArbiClient, taskId: string): Promise<void>;
 /** Fire a task immediately without advancing its schedule. */
 declare function runTask(arbi: ArbiClient, taskId: string): Promise<TaskResponse>;
+/** A task's run history, newest first. Each run links to its conversation. */
+declare function listTaskRuns(arbi: ArbiClient, taskId: string): Promise<TaskRunResponse[]>;
 
 type tasks_CreateTaskRequest = CreateTaskRequest;
 type tasks_TaskResponse = TaskResponse;
+type tasks_TaskRunResponse = TaskRunResponse;
 type tasks_UpdateTaskRequest = UpdateTaskRequest;
 declare const tasks_createTask: typeof createTask;
 declare const tasks_deleteTask: typeof deleteTask;
 declare const tasks_getTask: typeof getTask;
+declare const tasks_listTaskRuns: typeof listTaskRuns;
 declare const tasks_listTasks: typeof listTasks;
 declare const tasks_runTask: typeof runTask;
 declare const tasks_updateTask: typeof updateTask;
 declare namespace tasks {
-  export { type tasks_CreateTaskRequest as CreateTaskRequest, type tasks_TaskResponse as TaskResponse, type tasks_UpdateTaskRequest as UpdateTaskRequest, tasks_createTask as createTask, tasks_deleteTask as deleteTask, tasks_getTask as getTask, tasks_listTasks as listTasks, tasks_runTask as runTask, tasks_updateTask as updateTask };
+  export { type tasks_CreateTaskRequest as CreateTaskRequest, type tasks_TaskResponse as TaskResponse, type tasks_TaskRunResponse as TaskRunResponse, type tasks_UpdateTaskRequest as UpdateTaskRequest, tasks_createTask as createTask, tasks_deleteTask as deleteTask, tasks_getTask as getTask, tasks_listTaskRuns as listTaskRuns, tasks_listTasks as listTasks, tasks_runTask as runTask, tasks_updateTask as updateTask };
 }
 
 /**
@@ -2034,6 +2043,7 @@ declare class Arbi {
     private loginResult;
     private currentWorkspaceId;
     private dmCryptoContext;
+    private readonly sessionExpiredListeners;
     private readonly options;
     constructor(options: ArbiOptions);
     /** Initialize the SDK client and sodium crypto. Called automatically by login(). */
@@ -2063,11 +2073,27 @@ declare class Arbi {
      * Useful for session recovery without re-entering the password.
      */
     loginWithKey(email: string, signingPrivateKeyBase64: string): Promise<void>;
+    /** A workspace's key, sealed to the caller's own session (what `/open` and `POST /workspace/users` take). */
+    private sealWorkspaceKey;
     /**
      * Select a workspace by ID. Fetches the workspace list, finds the matching
      * workspace, decrypts the wrapped key, and sets up auth headers.
      */
     selectWorkspace(workspaceId: string): Promise<void>;
+    /**
+     * Subscribe to "the session cannot be recovered". Fires when a request failed with 401 or
+     * "No active workspace" and neither a workspace re-open nor a silent re-login was possible
+     * (the server refused; an unreachable server does not fire). The local session is already
+     * cleared when it fires: show "Your session expired, sign in again". Returns an unsubscribe.
+     */
+    onSessionExpired(listener: () => void): () => void;
+    private expireSession;
+    /**
+     * Run a raw-fetch operation (streaming, multipart: no middleware) and, when it fails because
+     * the token expired or the server lost the open workspace, recover once and run it again.
+     * `run` must read the auth headers itself so the retry carries the fresh token.
+     */
+    private recovering;
     /** Log out and clear internal state. */
     logout(): Promise<void>;
     /** Get the underlying ArbiClient (throws if not initialized). */
@@ -2399,6 +2425,63 @@ declare class Arbi {
             agent_ext_id?: string | null | undefined;
             is_temporary: boolean;
         }[]>;
+        /**
+         * Grant users a temporary key scoped to ONE session (identified by its public key), for
+         * example an agent's run session minted by `agents.authorize()`. Nothing standing is created:
+         * the grant expires with that session. Works for any workspace the caller holds a key for;
+         * it does not need to be the open one.
+         */
+        grantTemporaryAccess: (params: {
+            workspaceId: string;
+            emails: string[];
+            sessionPubkeyB64: string;
+            role?: "owner" | "collaborator" | "guest";
+        }) => Promise<{
+            user: {
+                external_id: string;
+                parent_ext_id?: string | null | undefined;
+                email: string;
+                given_name: string;
+                family_name?: string | null | undefined;
+                picture?: string | null | undefined;
+                encryption_public_key: string;
+                is_sso: boolean;
+            };
+            role: components["schemas"]["WorkspaceRole"];
+            joined_at: string;
+            conversation_count: number;
+            document_count: number;
+            files_mb: number;
+            agent_ext_id?: string | null | undefined;
+            is_temporary: boolean;
+        }[]>;
+        /**
+         * Add users (standing, permanent membership) to ANY workspace the caller holds a key for,
+         * without opening it. `addUsers` does the same for the currently open workspace.
+         */
+        grantAccess: (params: {
+            workspaceId: string;
+            emails: string[];
+            role?: "owner" | "collaborator" | "guest";
+        }) => Promise<{
+            user: {
+                external_id: string;
+                parent_ext_id?: string | null | undefined;
+                email: string;
+                given_name: string;
+                family_name?: string | null | undefined;
+                picture?: string | null | undefined;
+                encryption_public_key: string;
+                is_sso: boolean;
+            };
+            role: components["schemas"]["WorkspaceRole"];
+            joined_at: string;
+            conversation_count: number;
+            document_count: number;
+            files_mb: number;
+            agent_ext_id?: string | null | undefined;
+            is_temporary: boolean;
+        }[]>;
         removeUsers: (userIds: string[]) => Promise<void>;
         setUserRole: (userIds: string[], role: "owner" | "collaborator" | "guest") => Promise<{
             user: {
@@ -3100,6 +3183,22 @@ declare class Arbi {
          * Respond to an agent's question during a human-in-the-loop workflow.
          */
         respond: (assistantMessageExtId: string, answer: string) => Promise<unknown>;
+        /** The skills the caller can run (own + shared marketplace), metadata only. */
+        listSkills: (options?: {
+            includeHidden?: boolean;
+        }) => Promise<{
+            name: string;
+            slug: string;
+            description: string;
+            user_invocable: boolean;
+            arg_hint: string;
+            skill_type: string;
+            workspace_ext_id: string;
+            doc_ext_id: string;
+            updated_at: string;
+            visibility: string;
+            is_owner: boolean;
+        }[]>;
         /**
          * Search documents without LLM generation (retrieval only).
          */
@@ -4206,6 +4305,25 @@ declare class Arbi {
         delete: (agentExtIds: string[]) => Promise<{
             [x: string]: unknown;
         }>;
+        /** Mint a TTL'd run session for an agent; see `grantTemporaryAccess` to also deposit a key. */
+        authorize: (agentExtId: string, workspaceId: string, ttlSeconds?: number) => Promise<{
+            session_pubkey_b64: string;
+            agent_email: string;
+            ttl: number;
+        }>;
+        authorizeLimits: () => Promise<{
+            default_ttl_seconds: number;
+            max_ttl_seconds: number;
+        }>;
+        /**
+         * Give an agent temporary, session-scoped access to a workspace: mint its run session, then
+         * deposit the workspace key on it. Returns the session details (`ttl` in seconds).
+         */
+        grantTemporaryAccess: (agentExtId: string, workspaceId: string, ttlSeconds?: number) => Promise<{
+            session_pubkey_b64: string;
+            agent_email: string;
+            ttl: number;
+        }>;
     };
     readonly tasks: {
         list: () => Promise<{
@@ -4394,6 +4512,56 @@ declare class Arbi {
             created_at: string;
             updated_at: string;
         }>;
+        listRuns: (taskId: string) => Promise<{
+            run_id?: string | null;
+            conversation_ext_id?: string | null;
+            status: string;
+            error?: string | null;
+            started_at?: string | null;
+            finished_at?: string | null;
+        }[]>;
+        /**
+         * Run a task and, when the run is parked waiting for workspace access (a temporary
+         * authorization tier), grant the agent's run session a temporary key and run it again.
+         * A task that needs no approval returns from the first call already running.
+         */
+        runWithAuth: (taskId: string) => Promise<{
+            external_id: string;
+            name: string;
+            trigger_type: string;
+            rrule: string | null;
+            run_at: string | null;
+            timezone: string;
+            event_kind: string | null;
+            action_type: string;
+            prompt: string;
+            skill_ref: string | null;
+            status: string;
+            next_run_at: string | null;
+            last_run_at: string | null;
+            last_error: string | null;
+            in_progress: boolean;
+            active_run_id: string | null;
+            agent_session: string | null;
+            active_response_id?: string | null;
+            active_conversation_ext_id?: string | null;
+            run_started_at: string | null;
+            notify_on_complete: boolean;
+            auth_mode: components["schemas"]["AuthMode"];
+            pending_auth_request_id?: string | null;
+            pending_auth_session_pubkey?: string | null;
+            pending_auth_agent_email?: string | null;
+            created_by_kind: string;
+            workspace_ext_id?: string | null;
+            agent_ext_id?: string | null;
+            task_plan?: components["schemas"]["TaskPlan"] | null;
+            is_goal_task: boolean;
+            goal_state?: {
+                [key: string]: unknown;
+            } | null;
+            created_at: string;
+            updated_at: string;
+        }>;
     };
     readonly facts: {
         create: (body: CreateFactRequest) => Promise<{
@@ -4667,7 +4835,46 @@ declare function listWorkspaceUsers(arbi: ArbiClient): Promise<{
     agent_ext_id?: string | null | undefined;
     is_temporary: boolean;
 }[]>;
-declare function addWorkspaceUsers(arbi: ArbiClient, emails: string[], role?: 'owner' | 'collaborator' | 'guest'): Promise<{
+declare function addWorkspaceUsers(arbi: ArbiClient, emails: string[], role?: 'owner' | 'collaborator' | 'guest', 
+/** Share a workspace other than the open one: its id and its key sealed to the caller's session. */
+target?: {
+    workspaceExtId: string;
+    workspaceKey: string;
+}): Promise<{
+    user: {
+        external_id: string;
+        parent_ext_id?: string | null | undefined;
+        email: string;
+        given_name: string;
+        family_name?: string | null | undefined;
+        picture?: string | null | undefined;
+        encryption_public_key: string;
+        is_sso: boolean;
+    };
+    role: components["schemas"]["WorkspaceRole"];
+    joined_at: string;
+    conversation_count: number;
+    document_count: number;
+    files_mb: number;
+    agent_ext_id?: string | null | undefined;
+    is_temporary: boolean;
+}[]>;
+/**
+ * Grant users a TEMPORARY, session-scoped workspace key (`session_pubkey_b64` path of
+ * `POST /v1/workspace/users`). The key is deposited onto the recipient's session (typically an
+ * agent run session) and the membership row expires with it; no standing membership is created.
+ *
+ * `workspaceKey` is the workspace key sealed to the CALLER's own session (what `/open` takes), so
+ * the workspace need not be the open one. Use `Arbi.workspaces.grantTemporaryAccess()` to have the
+ * key derived for you.
+ */
+declare function grantTemporaryWorkspaceAccess(arbi: ArbiClient, params: {
+    emails: string[];
+    workspaceExtId: string;
+    workspaceKey: string;
+    sessionPubkeyB64: string;
+    role?: 'owner' | 'collaborator' | 'guest';
+}): Promise<{
     user: {
         external_id: string;
         parent_ext_id?: string | null | undefined;
@@ -4727,13 +4934,14 @@ declare const workspaces_addWorkspaceUsers: typeof addWorkspaceUsers;
 declare const workspaces_copyDocuments: typeof copyDocuments;
 declare const workspaces_createWorkspace: typeof createWorkspace;
 declare const workspaces_deleteWorkspaces: typeof deleteWorkspaces;
+declare const workspaces_grantTemporaryWorkspaceAccess: typeof grantTemporaryWorkspaceAccess;
 declare const workspaces_listWorkspaceUsers: typeof listWorkspaceUsers;
 declare const workspaces_listWorkspaces: typeof listWorkspaces;
 declare const workspaces_removeWorkspaceUsers: typeof removeWorkspaceUsers;
 declare const workspaces_setUserRole: typeof setUserRole;
 declare const workspaces_updateWorkspace: typeof updateWorkspace;
 declare namespace workspaces {
-  export { workspaces_addWorkspaceUsers as addWorkspaceUsers, workspaces_copyDocuments as copyDocuments, workspaces_createWorkspace as createWorkspace, workspaces_deleteWorkspaces as deleteWorkspaces, workspaces_listWorkspaceUsers as listWorkspaceUsers, workspaces_listWorkspaces as listWorkspaces, workspaces_removeWorkspaceUsers as removeWorkspaceUsers, workspaces_setUserRole as setUserRole, workspaces_updateWorkspace as updateWorkspace };
+  export { workspaces_addWorkspaceUsers as addWorkspaceUsers, workspaces_copyDocuments as copyDocuments, workspaces_createWorkspace as createWorkspace, workspaces_deleteWorkspaces as deleteWorkspaces, workspaces_grantTemporaryWorkspaceAccess as grantTemporaryWorkspaceAccess, workspaces_listWorkspaceUsers as listWorkspaceUsers, workspaces_listWorkspaces as listWorkspaces, workspaces_removeWorkspaceUsers as removeWorkspaceUsers, workspaces_setUserRole as setUserRole, workspaces_updateWorkspace as updateWorkspace };
 }
 
 /**
@@ -5978,4 +6186,4 @@ declare namespace projects {
   export { type projects_ProjectInvoicesResponse as ProjectInvoicesResponse, type projects_ProjectUpdateRequest as ProjectUpdateRequest, type projects_ProjectUsageResponse as ProjectUsageResponse, type projects_UserDailyUsageResponse as UserDailyUsageResponse, projects_createProject as createProject, projects_deleteProject as deleteProject, projects_getProjectInvoices as getProjectInvoices, projects_getProjectUsage as getProjectUsage, projects_getUserUsageToday as getUserUsageToday, projects_listProjects as listProjects, projects_refreshProject as refreshProject, projects_renameProject as renameProject, projects_updateProject as updateProject };
 }
 
-export { type ResponseFailedEvent as $, type AgentControlStateEvent as A, type DocumentWaiterOptions as B, type ChatSession as C, DOC_TERMINAL_STATUSES as D, type FactSearchRequest as E, type FactResponse as F, type FactSearchResponse as G, type FormattedWsMessage as H, type ListFactsOptions as I, type ListPaginatedOptions as J, type MessageMetadataPayload$1 as K, type ListAllOptions as L, type MessageLevel as M, type MessageQueuedEvent as N, type OutputTokensDetails as O, type ParsedSlashCommand as P, type ProbeAnswerEvent as Q, type ProjectInvoicesResponse as R, type ProjectUsageResponse as S, type QueryOptions as T, type ReconnectOptions as U, type ReconnectableWsConnection as V, type ResolvedCitation as W, type ResolvedRecipient as X, type ResponseCompletedEvent as Y, type ResponseContentPartAddedEvent as Z, type ResponseCreatedEvent as _, type AgentStepDeltaEvent as a, parseSlashCommand as a$, type ResponseOutputItemAddedEvent as a0, type ResponseOutputItemDoneEvent as a1, type ResponseOutputTextDeltaEvent as a2, type ResponseOutputTextDoneEvent as a3, type ResponseUsage as a4, type SSEEvent as a5, type SSEStreamCallbacks as a6, type SSEStreamResult as a7, type SSEStreamStartData as a8, SUPPORTED_EXTENSIONS as a9, 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, facts as aK, files as aL, filterSkills as aM, formatAgentStepLabel as aN, formatFileSize as aO, formatItemLabel as aP, formatStreamSummary as aQ, formatUserName as aR, formatWorkspaceChoices as aS, formatWsMessage as aT, generateEncryptedWorkspaceKey as aU, generateNewWorkspaceKey as aV, getErrorCode as aW, getErrorMessage as aX, getRawWorkspaceKey as aY, health as aZ, parseSSEEvents as a_, type SkillSummary as aa, type SkippedFile as ab, type TaskResponse as ac, type TokenBudgetContext as ad, type UpdateFactRequest as ae, type UpdateTaskRequest as af, type UploadBatchResult as ag, type UploadDirectOptions as ah, type UploadDirectResult as ai, type UploadOptions as aj, type UploadResult as ak, type UserDailyUsageResponse as al, type UserInfo as am, type UserInputRequestEvent as an, type UserMessageEvent as ao, WebSocketAuthError as ap, type WorkspaceContext as aq, type WsConnection as ar, agentconfig as as, assistant as at, authenticatedFetch as au, buildDocNameMap as av, buildRetrievalChunkTool as aw, buildRetrievalFullContextTool as ax, buildRetrievalTocTool as ay, connectWebSocket as az, type AgentStepEvent as b, parseSlashTokenInProgress as b0, performPasswordLogin as b1, performSigningKeyLogin as b2, performSsoDeviceFlowLogin as b3, projects as b4, requireData as b5, requireOk as b6, resolveAuth as b7, resolveCitations as b8, resolveWorkspace as b9, responses as ba, selectWorkspace as bb, selectWorkspaceById as bc, settings as bd, streamSSE as be, stripCitationMarkdown as bf, summarizeCitations as bg, tags as bh, tasks as bi, workspaces as bj, Arbi as c, ArbiApiError as d, ArbiError as e, type ArbiErrorEvent as f, type ArbiOptions as g, type ArtifactEvent as h, type AuthContext as i, type AuthHeaders as j, type AuthenticatedClient as k, type CitationSummary as l, type CliConfig as m, type CliCredentials as n, type CommandDescriptor as o, type ConfigStore as p, type ConnectOptions as q, type CreateFactRequest as r, type CreateFactsRequest as s, type CreateTaskRequest as t, type DeferredInterjectionEvent as u, type DmCryptoContext as v, type DocNameMap as w, type DocumentListFields as x, type DocumentListOrder as y, type DocumentWaiter as z };
+export { type ResponseCreatedEvent as $, type AgentControlStateEvent as A, type DocumentWaiter as B, type ChatSession as C, DOC_TERMINAL_STATUSES as D, type DocumentWaiterOptions as E, type FactResponse as F, type FactSearchRequest as G, type FactSearchResponse as H, type FormattedWsMessage as I, type ListFactsOptions as J, type ListPaginatedOptions as K, type ListAllOptions as L, type MessageLevel as M, type MessageMetadataPayload$1 as N, type MessageQueuedEvent as O, type OutputTokensDetails as P, type ParsedSlashCommand as Q, type ProbeAnswerEvent as R, type ProjectInvoicesResponse as S, type ProjectUsageResponse as T, type QueryOptions as U, type ReconnectOptions as V, type ReconnectableWsConnection as W, type ResolvedCitation as X, type ResolvedRecipient as Y, type ResponseCompletedEvent as Z, type ResponseContentPartAddedEvent as _, type AgentStepDeltaEvent as a, parseSSEEvents as a$, type ResponseFailedEvent as a0, type ResponseOutputItemAddedEvent as a1, type ResponseOutputItemDoneEvent as a2, type ResponseOutputTextDeltaEvent as a3, type ResponseOutputTextDoneEvent as a4, type ResponseUsage as a5, type SSEEvent as a6, type SSEStreamCallbacks as a7, type SSEStreamResult as a8, type SSEStreamStartData as a9, connectWebSocket as aA, connectWithReconnect as aB, consumeSSEStream as aC, contacts as aD, conversations as aE, countCitations as aF, createAuthenticatedClient as aG, createDocumentWaiter as aH, dm as aI, doctags as aJ, documents as aK, facts as aL, files as aM, filterSkills as aN, formatAgentStepLabel as aO, formatFileSize as aP, formatItemLabel as aQ, formatStreamSummary as aR, formatUserName as aS, formatWorkspaceChoices as aT, formatWsMessage as aU, generateEncryptedWorkspaceKey as aV, generateNewWorkspaceKey as aW, getErrorCode as aX, getErrorMessage as aY, getRawWorkspaceKey as aZ, health as a_, SUPPORTED_EXTENSIONS as aa, type SkillSummary as ab, type SkippedFile as ac, type TaskResponse as ad, type TokenBudgetContext as ae, type UpdateFactRequest as af, type UpdateTaskRequest as ag, type UploadBatchResult as ah, type UploadDirectOptions as ai, type UploadDirectResult as aj, type UploadOptions as ak, type UploadResult as al, type UserDailyUsageResponse as am, type UserInfo as an, type UserInputRequestEvent as ao, type UserMessageEvent as ap, WebSocketAuthError as aq, type WorkspaceContext as ar, type WsConnection as as, agentconfig as at, assistant as au, authenticatedFetch as av, buildDocNameMap as aw, buildRetrievalChunkTool as ax, buildRetrievalFullContextTool as ay, buildRetrievalTocTool as az, type AgentStepEvent as b, parseSlashCommand as b0, parseSlashTokenInProgress as b1, performPasswordLogin as b2, performSigningKeyLogin as b3, performSsoDeviceFlowLogin as b4, projects as b5, requireData as b6, requireOk as b7, resolveAuth as b8, resolveCitations as b9, resolveWorkspace as ba, responses as bb, selectWorkspace as bc, selectWorkspaceById as bd, settings as be, streamSSE as bf, stripCitationMarkdown as bg, summarizeCitations as bh, tags as bi, tasks as bj, workspaces as bk, Arbi as c, ArbiApiError as d, ArbiError as e, type ArbiErrorEvent as f, type ArbiOptions as g, ArbiSessionExpiredError as h, type ArtifactEvent as i, type AuthContext as j, type AuthHeaders as k, type AuthenticatedClient as l, type CitationSummary as m, type CliConfig as n, type CliCredentials as o, type CommandDescriptor as p, type ConfigStore as q, type ConnectOptions as r, type CreateFactRequest as s, type CreateFactsRequest as t, type CreateTaskRequest as u, type DeferredInterjectionEvent as v, type DmCryptoContext as w, type DocNameMap as x, type DocumentListFields as y, type DocumentListOrder as z };