@axiom-lattice/client-sdk 4.3.4 → 4.3.7

package/dist/index.d.ts

@@ -1,10 +1,7 @@
-import { CapabilityBundle, CapabilityPreview, AgentWebApp, Message, MessageChunk, DatabaseConfigEntry, MetricsServerConfigEntry, DataSource, McpServerConfigEntry, McpTool, LocalA2ATemplateDefinition, TaskItem, CreateDatabaseConfigRequest, UpdateDatabaseConfigRequest, CreateMetricsServerConfigRequest, UpdateMetricsServerConfigRequest, CreateMcpServerConfigRequest, UpdateMcpServerConfigRequest, ConnectionEntry, CreateTaskRequest, UpdateTaskRequest, TaskWorkItem, LocalA2AProviderState, CreateCapabilityBundleInput, UpdateCapabilityBundleInput, CreateAgentWebAppInput, UpdateAgentWebAppInput, Skill, CreateSkillRequest, CreateShareRequest, ShareResult, ShareRecord, ProjectRoom, ProjectRoomPublicMessage, ProjectMembership, ProjectBotMembership, ProjectRoomPublicMembership, ProjectRoomPublicBotMembership, ProjectRoomMention, ProjectHumanRole, ProjectBotRole, ProjectRoomMessageCreatedEvent, ProjectRoomRosterChangedEvent, ProjectRoomMembershipChangedEvent, ProjectRoomTaskChangedEvent, ProjectRoomControlEvent } from '@axiom-lattice/protocols';
+import * as _axiom_lattice_protocols from '@axiom-lattice/protocols';
+import { CapabilityBundle, CapabilityPreview, AgentWebApp, Message, MessageChunk, DatabaseConfigEntry, MetricsServerConfigEntry, DataSource, McpServerConfigEntry, McpTool, LocalA2ATemplateDefinition, OpenGrant, TaskItem, CreateDatabaseConfigRequest, UpdateDatabaseConfigRequest, CreateMetricsServerConfigRequest, UpdateMetricsServerConfigRequest, CreateMcpServerConfigRequest, UpdateMcpServerConfigRequest, ConnectionEntry, CreateTaskRequest, UpdateTaskRequest, TaskWorkItem, LocalA2AProviderState, OpenCatalog, CreateCapabilityBundleInput, UpdateCapabilityBundleInput, CreateAgentWebAppInput, UpdateAgentWebAppInput, Skill, CreateSkillRequest, CreateShareRequest, ShareResult, ShareRecord, ProjectRoom, ProjectRoomPublicMessage, ProjectMembership, ProjectBotMembership, ProjectRoomPublicMembership, ProjectRoomPublicBotMembership, ProjectRoomMention, ProjectHumanRole, ProjectBotRole, Project as Project$1, ProjectRoomEventScope } from '@axiom-lattice/protocols';
 export { AgentWebApp, AgentWebAppAppearance, AgentWebAppFeatures, AgentWebAppScope, AgentWebAppStatus, CapabilityBundle, CapabilityPreview, CreateAgentWebAppInput, CreateCapabilityBundleInput, LocalA2AProviderId, LocalA2AProviderState, LocalA2AProviderStatus, LocalA2ATemplateDefinition, LocalRuntimeConfig, UpdateAgentWebAppInput, UpdateCapabilityBundleInput } from '@axiom-lattice/protocols';
 
-/**
- * Core types for the Axiom Lattice Client SDK
- */
-
 /** Optional filters for listing Agent Web Apps. */
 interface ListAgentWebAppsParams {
     /** Return only publications for this assistant. */
@@ -903,11 +900,43 @@ interface A2AKeyListItem {
     tenantId: string;
     projectId: string;
     assistantIds?: string[];
+    /** Open-door grants (default-deny capability list). */
+    grants?: OpenGrant[];
     label?: string;
     enabled: boolean;
     createdAt: string;
     updatedAt: string;
 }
+/** What an API key exposes to external callers. */
+interface KeyExposure {
+    tenantId: string;
+    projectId: string;
+    grants: OpenGrant[];
+    mcp: {
+        endpoint: string;
+        tools: Array<{
+            domain: string;
+            toolName: string;
+            description: string;
+            annotations: {
+                readOnlyHint: boolean;
+                destructiveHint: boolean;
+            };
+        }>;
+    };
+    a2a: {
+        agents: Array<{
+            assistantId: string;
+            cardUrl: string;
+            jsonrpcUrl: string;
+            card: Record<string, unknown>;
+        }>;
+    };
+}
+/** Open audit log record as returned over JSON (dates are ISO strings). */
+type OpenAuditLogRecord = Omit<_axiom_lattice_protocols.OpenAuditRecord, "createdAt"> & {
+    createdAt: string;
+};
 /**
  * Input for creating a new A2A API key.
  */
@@ -915,6 +944,8 @@ interface CreateA2AKeyInput {
     tenantId: string;
     projectId: string;
     assistantIds?: string[];
+    /** Open-door grants; omit for legacy assistant-only keys. */
+    grants?: OpenGrant[];
     label?: string;
 }
 /**
@@ -1360,6 +1391,35 @@ declare abstract class AbstractClient {
     /**
      * A2A API keys namespace for managing A2A API keys
      */
+    /** Open API surface helpers (capability catalog for the key picker). */
+    open: {
+        /**
+         * Fetch the grantable capability catalog for the current tenant.
+         * Drives the key-management grants picker.
+         */
+        catalog: () => Promise<OpenCatalog>;
+        /**
+         * Fetch what a key exposes (MCP tools + A2A agent cards).
+         * @param id - Key identifier
+         */
+        exposure: (id: string) => Promise<KeyExposure>;
+        /**
+         * Query the tenant's Open audit log (newest first).
+         * @param params - Optional credential/domain/status/time filters and pagination
+         */
+        auditLogs: (params?: {
+            credentialId?: string;
+            domain?: string;
+            status?: "ok" | "error";
+            from?: string;
+            to?: string;
+            limit?: number;
+            offset?: number;
+        }) => Promise<OpenAuditLogRecord[]>;
+    };
+    /**
+     * @deprecated Use {@link open} / `/api/keys`; kept as a compatibility alias.
+     */
     a2aKeys: {
         /**
          * Lists A2A API keys, optionally filtered by tenant
@@ -1379,6 +1439,13 @@ declare abstract class AbstractClient {
          * @returns A promise that resolves to the created key record (full key value)
          */
         create: (input: CreateA2AKeyInput) => Promise<A2AKeyListItem>;
+        /**
+         * Updates mutable fields (label, project, assistants, grants) of an existing key.
+         * @param id - Key identifier
+         * @param input - Fields to update (only provided fields change)
+         * @returns A promise that resolves to the updated key record
+         */
+        update: (id: string, input: Partial<CreateA2AKeyInput>) => Promise<A2AKeyListItem>;
         /**
          * Permanently deletes an A2A API key
          * @param id - Key identifier
@@ -1865,6 +1932,7 @@ declare class ProjectRoomClientError extends Error {
     readonly details?: unknown | undefined;
     constructor(message: string, status: number, code: string, retryable: boolean, details?: unknown | undefined);
 }
+
 interface ProjectRoomRecord extends Omit<ProjectRoom, "createdAt" | "updatedAt"> {
     createdAt: Date;
     updatedAt: Date;
@@ -1875,6 +1943,7 @@ interface ProjectRoomMessageRecord extends Omit<ProjectRoomPublicMessage, "creat
 interface ProjectRoomMembershipRecord extends Omit<ProjectMembership, "joinedAt" | "updatedAt"> {
     joinedAt: Date;
     updatedAt: Date;
+    name?: string;
 }
 interface ProjectRoomBotRecord extends Omit<ProjectBotMembership, "joinedAt" | "updatedAt"> {
     joinedAt: Date;
@@ -1937,41 +2006,7 @@ interface UpdateProjectBotMembershipInput {
     mentionName?: string;
     expectedUpdatedAt: Date | string;
 }
-type HydratedProjectRoomBusinessEvent = (Omit<ProjectRoomMessageCreatedEvent, "occurredAt" | "data"> & {
-    occurredAt: Date;
-    data: {
-        message: ProjectRoomMessageRecord;
-    };
-}) | (Omit<ProjectRoomRosterChangedEvent, "occurredAt" | "data"> & {
-    occurredAt: Date;
-    data: {
-        change: ProjectRoomRosterChangedEvent["data"]["change"];
-        membership: ProjectRoomPublicBotRecord;
-    };
-}) | (Omit<ProjectRoomMembershipChangedEvent, "occurredAt" | "data"> & {
-    occurredAt: Date;
-    data: {
-        change: ProjectRoomMembershipChangedEvent["data"]["change"];
-        membership: ProjectRoomPublicMembershipRecord;
-    };
-}) | (Omit<ProjectRoomTaskChangedEvent, "occurredAt" | "data"> & {
-    occurredAt: Date;
-    data: Omit<ProjectRoomTaskChangedEvent["data"], "updatedAt"> & {
-        updatedAt: Date;
-    };
-});
-interface ProjectRoomSseFrame {
-    event: HydratedProjectRoomBusinessEvent | ProjectRoomControlEvent;
-    id?: string;
-    retry?: number;
-}
-type HeadersGetter = () => Record<string, string>;
-interface ProjectRoomEventConnection extends AsyncIterable<ProjectRoomSseFrame> {
-    readonly opened: Promise<{
-        status: 200;
-        lastEventId?: string;
-    }>;
-}
+type HeadersGetter$1 = () => Record<string, string>;
 declare class ProjectRoomsClient {
     private readonly baseURL;
     private readonly getHeaders;
@@ -1979,6 +2014,7 @@ declare class ProjectRoomsClient {
         list: (projectId: string, options?: ListProjectRoomMessagesOptions) => Promise<ProjectRoomMessageRecord[]>;
         send: (projectId: string, input: SendProjectRoomMessageInput) => Promise<ProjectRoomSendResult>;
         retry: (projectId: string, messageId: string) => Promise<ProjectRoomDispatchResult[]>;
+        markRead: (projectId: string) => Promise<void>;
     };
     readonly members: {
         list: (projectId: string) => Promise<ProjectRoomMembershipRecord[]>;
@@ -1994,18 +2030,141 @@ declare class ProjectRoomsClient {
         resume: (projectId: string, membershipId: string, input: MutationExpectedUpdatedAt) => Promise<ProjectRoomBotRecord>;
         remove: (projectId: string, membershipId: string, input: MutationExpectedUpdatedAt) => Promise<unknown>;
     };
-    readonly events: {
-        connect: (projectId: string, options: {
-            lastEventId?: string;
-            signal: AbortSignal;
-        }) => ProjectRoomEventConnection;
-    };
-    constructor(baseURL: string, getHeaders: HeadersGetter);
+    constructor(baseURL: string, getHeaders: HeadersGetter$1);
     getRoom(projectId: string): Promise<ProjectRoomRecord>;
-    getRealtimeMode(projectId: string): Promise<unknown>;
     private records;
     private request;
-    private connect;
+}
+
+interface ProjectRecord extends Omit<Project$1, "createdAt" | "updatedAt"> {
+    createdAt: Date;
+    updatedAt: Date;
+}
+/** A hydrated workspace room entry from the aggregated rooms endpoint. */
+interface WorkspaceRoomEntryRecord {
+    project: ProjectRecord;
+    room: ProjectRoomRecord;
+    lastMessage?: ProjectRoomMessageRecord;
+    participantCount: number;
+    participantNames: string[];
+    /** Viewer-relative title for human direct rooms; absent to fall back to `room.name`. */
+    displayName?: string;
+    isPublic?: boolean;
+    /** Messages after the user's read horizon, excluding the user's own messages. */
+    unreadCount: number;
+}
+/** Aggregated workspace room list client (single request, server-computed unread counts). */
+declare class WorkspaceRoomsClient {
+    private readonly baseURL;
+    private readonly getHeaders;
+    constructor(baseURL: string, getHeaders: () => Record<string, string>);
+    /** Lists the user's rooms in a workspace with last message and unread count. */
+    list(workspaceId: string): Promise<WorkspaceRoomEntryRecord[]>;
+}
+
+/** Routing scope attached to room-scoped frames by the workspace stream. */
+type RoomEventScopeRecord = ProjectRoomEventScope;
+type WorkspaceRoomKnownBusinessEvent = {
+    type: "message.created";
+    id: string;
+    occurredAt: Date;
+    scope: RoomEventScopeRecord;
+    data: {
+        message: ProjectRoomMessageRecord;
+    };
+} | {
+    type: "roster.changed";
+    id: string;
+    occurredAt: Date;
+    scope: RoomEventScopeRecord;
+    data: {
+        change: string;
+        membership: ProjectRoomPublicBotRecord;
+    };
+} | {
+    type: "membership.changed";
+    id: string;
+    occurredAt: Date;
+    scope: RoomEventScopeRecord;
+    data: {
+        change: string;
+        membership: ProjectRoomPublicMembershipRecord;
+    };
+} | {
+    type: "task.changed";
+    id: string;
+    occurredAt: Date;
+    scope: RoomEventScopeRecord;
+    data: {
+        taskId: string;
+        status: string;
+        ownerMembershipId: string;
+        updatedAt: Date;
+    };
+} | {
+    type: "read.changed";
+    id: string;
+    occurredAt: Date;
+    data: {
+        projectId: string;
+        roomId: string;
+        lastReadAt: Date;
+    };
+} | {
+    type: "membership.affected";
+    id: string;
+    occurredAt: Date;
+    data: {
+        change: "added" | "removed" | "role_changed";
+        projectId: string;
+        roomId: string;
+    };
+};
+/** A business event of a type this client version does not know (forward compatibility). */
+interface WorkspaceRoomUnknownBusinessEvent {
+    type: string;
+    id: string;
+    occurredAt: Date;
+    data: unknown;
+    scope?: RoomEventScopeRecord;
+}
+type WorkspaceRoomBusinessEvent = WorkspaceRoomKnownBusinessEvent | WorkspaceRoomUnknownBusinessEvent;
+type WorkspaceRoomControlEvent = {
+    type: "ready";
+    data: {
+        epoch: string;
+        headEventId: string | null;
+    };
+} | {
+    type: "resync";
+    data: {
+        reason: "SERVER_RESTART" | "CURSOR_EXPIRED" | "SLOW_CONSUMER";
+    };
+} | {
+    type: "access.revoked";
+    data: {
+        reason: "PROJECT_ACCESS_REVOKED" | "TOKEN_EXPIRED" | "CONNECTION_SUPERSEDED";
+    };
+};
+interface WorkspaceRoomEventFrame {
+    event: WorkspaceRoomBusinessEvent | WorkspaceRoomControlEvent;
+    id?: string;
+    retry?: number;
+}
+interface WorkspaceRoomEventConnection extends AsyncIterable<WorkspaceRoomEventFrame> {
+    readonly opened: Promise<{
+        status: 200;
+    }>;
+}
+type HeadersGetter = () => Record<string, string>;
+/** Live-only workspace-scoped room events SSE client (no cursor, replay, or resync). */
+declare class RoomEventsClient {
+    private readonly baseURL;
+    private readonly getHeaders;
+    constructor(baseURL: string, getHeaders: HeadersGetter);
+    connect(workspaceId: string, options: {
+        signal: AbortSignal;
+    }): WorkspaceRoomEventConnection;
 }
 
 /**
@@ -2016,6 +2175,8 @@ declare class Client extends AbstractClient {
     resources: ResourcesClient;
     exportImport: ExportImportClient;
     readonly projectRooms: ProjectRoomsClient;
+    readonly workspaceRooms: WorkspaceRoomsClient;
+    readonly roomEvents: RoomEventsClient;
     /**
      * Creates a new Client instance
      * @param config - Configuration options for the client
@@ -2352,4 +2513,4 @@ declare function createSimpleMessageMerger(): {
     reset: () => void;
 };
 
-export { A2AKeyListItem, A2AKeysListResponse, AbortAgentParams, AbstractClient, AddProjectBotMembershipInput, AddProjectMembershipInput, AgentState, AgentWebAppsListResponse, ApiError, ArchiveInput, Assistant, AssistantListResponse, AssistantResponse, AuthenticationError, CapabilityBundleListResponse, ChatResponse, ChatSendOptions, ChatStreamOptions, Client, ClientConfig, CompleteTaskInput, CompleteTaskResponse, CreateA2AKeyInput, CreateAssistantOptions, CreateProjectRequest, CreateThreadOptions, CreateWorkspaceRequest, DatabaseConfigResponse, DatabaseConfigsListResponse, DatasourcesListResponse, ExportBundle, ExportConfigResult, ExportConfirmationRequired, ExportDownload, ExportEntityIds, ExportEntityPreview, ExportEntityPreviewMap, ExportImportClient, ExportJobResult, ExportableEntity, ExportableTypeInfo, FileItem, GetMessagesOptions, GetScheduledTasksOptions, HydratedProjectRoomBusinessEvent, ImportApplyResult, ImportConflict, ImportEntityResult, ImportInsertion, ImportPreviewError, ImportPreviewResult, ImportResolution, ImportResolutions, ImportSource, InvalidCapabilityBundleSummary, ListAgentWebAppsParams, ListProjectRoomMessagesOptions, ListThreadsOptions, LocalA2ATemplatesListResponse, McpServerResponse, McpServersListResponse, MetricsConfigResponse, MetricsConfigsListResponse, MutationExpectedUpdatedAt, NetworkError, PendingMessage, Project, ProjectCapabilitiesResponse, ProjectKind, ProjectRoomBotRecord, ProjectRoomClientError, ProjectRoomDispatchErrorCode, ProjectRoomDispatchResult, ProjectRoomEventConnection, ProjectRoomMembershipRecord, ProjectRoomMessageRecord, ProjectRoomPublicBotRecord, ProjectRoomPublicMembershipRecord, ProjectRoomRecord, ProjectRoomSendResult, ProjectRoomSseFrame, ProjectRoomsClient, RegisterToolOptions, RemovePendingMessageOptions, ResourcesClient, ResumeStreamOptions, RetryConfig, RunOptions, RuntimeAxiomClient, RuntimeAxiomIdentity, ScheduleExecutionType, ScheduledTask, ScheduledTaskStatus, ScheduledTasksListResponse, SendProjectRoomMessageInput, StorageType, StreamCallbacks, StreamEvent, TaskLifecycleWarning, TaskResponse, TasksListResponse, TestConnectionResponse, TestMcpServerResponse, Thread, ThreadListResponse, ThreadResponse, Tool, ToolResponse, ToolsListResponse, Transport, UpdateAssistantOptions, UpdateProjectBotMembershipInput, UpdateProjectMembershipInput, UpdateProjectRequest, UpdateThreadOptions, UpdateWorkspaceRequest, WeChatClient, Workspace, WorkspaceClient, createSimpleMessageMerger };
+export { A2AKeyListItem, A2AKeysListResponse, AbortAgentParams, AbstractClient, AddProjectBotMembershipInput, AddProjectMembershipInput, AgentState, AgentWebAppsListResponse, ApiError, ArchiveInput, Assistant, AssistantListResponse, AssistantResponse, AuthenticationError, CapabilityBundleListResponse, ChatResponse, ChatSendOptions, ChatStreamOptions, Client, ClientConfig, CompleteTaskInput, CompleteTaskResponse, CreateA2AKeyInput, CreateAssistantOptions, CreateProjectRequest, CreateThreadOptions, CreateWorkspaceRequest, DatabaseConfigResponse, DatabaseConfigsListResponse, DatasourcesListResponse, ExportBundle, ExportConfigResult, ExportConfirmationRequired, ExportDownload, ExportEntityIds, ExportEntityPreview, ExportEntityPreviewMap, ExportImportClient, ExportJobResult, ExportableEntity, ExportableTypeInfo, FileItem, GetMessagesOptions, GetScheduledTasksOptions, ImportApplyResult, ImportConflict, ImportEntityResult, ImportInsertion, ImportPreviewError, ImportPreviewResult, ImportResolution, ImportResolutions, ImportSource, InvalidCapabilityBundleSummary, KeyExposure, ListAgentWebAppsParams, ListProjectRoomMessagesOptions, ListThreadsOptions, LocalA2ATemplatesListResponse, McpServerResponse, McpServersListResponse, MetricsConfigResponse, MetricsConfigsListResponse, MutationExpectedUpdatedAt, NetworkError, OpenAuditLogRecord, PendingMessage, Project, ProjectCapabilitiesResponse, ProjectKind, ProjectRecord, ProjectRoomBotRecord, ProjectRoomClientError, ProjectRoomDispatchErrorCode, ProjectRoomDispatchResult, ProjectRoomMembershipRecord, ProjectRoomMessageRecord, ProjectRoomPublicBotRecord, ProjectRoomPublicMembershipRecord, ProjectRoomRecord, ProjectRoomSendResult, ProjectRoomsClient, RegisterToolOptions, RemovePendingMessageOptions, ResourcesClient, ResumeStreamOptions, RetryConfig, RoomEventScopeRecord, RoomEventsClient, RunOptions, RuntimeAxiomClient, RuntimeAxiomIdentity, ScheduleExecutionType, ScheduledTask, ScheduledTaskStatus, ScheduledTasksListResponse, SendProjectRoomMessageInput, StorageType, StreamCallbacks, StreamEvent, TaskLifecycleWarning, TaskResponse, TasksListResponse, TestConnectionResponse, TestMcpServerResponse, Thread, ThreadListResponse, ThreadResponse, Tool, ToolResponse, ToolsListResponse, Transport, UpdateAssistantOptions, UpdateProjectBotMembershipInput, UpdateProjectMembershipInput, UpdateProjectRequest, UpdateThreadOptions, UpdateWorkspaceRequest, WeChatClient, Workspace, WorkspaceClient, WorkspaceRoomBusinessEvent, WorkspaceRoomControlEvent, WorkspaceRoomEntryRecord, WorkspaceRoomEventConnection, WorkspaceRoomEventFrame, WorkspaceRoomKnownBusinessEvent, WorkspaceRoomUnknownBusinessEvent, WorkspaceRoomsClient, createSimpleMessageMerger };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC"}