@axiom-lattice/client-sdk 4.2.0 → 4.3.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { AgentWebApp, Message, MessageChunk, DatabaseConfigEntry, MetricsServerConfigEntry, DataSource, McpServerConfigEntry, McpTool, LocalA2ATemplateDefinition, TaskItem, CreateDatabaseConfigRequest, UpdateDatabaseConfigRequest, CreateMetricsServerConfigRequest, UpdateMetricsServerConfigRequest, CreateMcpServerConfigRequest, UpdateMcpServerConfigRequest, ConnectionEntry, CreateTaskRequest, UpdateTaskRequest, TaskWorkItem, LocalA2AProviderState, CreateAgentWebAppInput, UpdateAgentWebAppInput, Skill, CreateSkillRequest, CreateShareRequest, ShareResult, ShareRecord } from '@axiom-lattice/protocols';
-export { AgentWebApp, AgentWebAppAppearance, AgentWebAppFeatures, AgentWebAppScope, AgentWebAppStatus, CreateAgentWebAppInput, LocalA2AProviderId, LocalA2AProviderState, LocalA2AProviderStatus, LocalA2ATemplateDefinition, LocalRuntimeConfig, UpdateAgentWebAppInput } from '@axiom-lattice/protocols';
+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';
+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
@@ -10,6 +10,24 @@ interface ListAgentWebAppsParams {
     /** Return only publications for this assistant. */
     assistantId?: string;
 }
+/** Project capability bundle selection and its resolved preview. */
+interface ProjectCapabilitiesResponse {
+    project: Project;
+    persistedBundleIds?: string[];
+    bundles: CapabilityBundle[];
+    preview: CapabilityPreview;
+}
+/** Safe status for a persisted capability bundle that cannot be returned. */
+interface InvalidCapabilityBundleSummary {
+    bundleId: string;
+    code: "INVALID_BUNDLE_CONFIG";
+    message: string;
+}
+/** Valid capability bundles plus safe summaries for invalid legacy records. */
+interface CapabilityBundleListResponse {
+    bundles: CapabilityBundle[];
+    errors: InvalidCapabilityBundleSummary[];
+}
 /** Agent Web App list data, unwrapped from the gateway response envelope. */
 interface AgentWebAppsListResponse {
     records: AgentWebApp[];
@@ -1387,6 +1405,75 @@ declare abstract class AbstractClient {
          */
         rotate: (id: string) => Promise<A2AKeyListItem>;
     };
+    /** Capability bundle namespace for managing tenant-scoped bundles. */
+    capabilityBundles: {
+        /**
+         * List all capability bundles visible to the current tenant.
+         * @returns The tenant's capability bundles, unwrapped from the API response.
+         */
+        list: () => Promise<CapabilityBundle[]>;
+        /**
+         * List valid bundles together with safe invalid-record summaries.
+         * @returns Inventory suitable for management and remediation workflows.
+         */
+        listInventory: () => Promise<CapabilityBundleListResponse>;
+        /**
+         * Get one capability bundle by identifier.
+         * @param bundleId - Capability bundle identifier.
+         * @returns The requested capability bundle.
+         */
+        get: (bundleId: string) => Promise<CapabilityBundle>;
+        /**
+         * Create a capability bundle for the current tenant.
+          * @param input - Bundle name, optional description, and capabilities. The server generates the stable key.
+         * @returns The created capability bundle.
+         */
+        create: (input: CreateCapabilityBundleInput) => Promise<CapabilityBundle>;
+        /**
+         * Update a capability bundle for the current tenant.
+         * @param bundleId - Capability bundle identifier.
+          * @param input - The partial bundle fields and required expected revision to update.
+         * @returns The updated capability bundle.
+         */
+        update: (bundleId: string, input: UpdateCapabilityBundleInput) => Promise<CapabilityBundle>;
+        /**
+         * Delete a capability bundle when the backend permits deletion.
+         * @param bundleId - Capability bundle identifier.
+         * @returns A promise that resolves after the bundle is deleted.
+         * @throws ApiError when the bundle is missing, in use, or the request fails.
+         */
+        delete: (bundleId: string) => Promise<void>;
+    };
+    projects: {
+        capabilities: {
+            /**
+             * Get a project's selected bundles and its persisted capability preview.
+             * @param projectId - Project identifier.
+             * @returns The project, selected bundles, and preview resolved from persisted selections.
+             */
+            get: (projectId: string) => Promise<ProjectCapabilitiesResponse>;
+            /**
+             * Replace a project's selected capability bundles.
+             * @param projectId - Project identifier.
+             * @param bundleIds - Ordered capability bundle identifiers to persist.
+             * @returns The updated project, selected bundles, and persisted-selection preview.
+             */
+            update: (projectId: string, bundleIds: string[], expectedRevisions: Record<string, string>) => Promise<ProjectCapabilitiesResponse>;
+            /**
+             * Preview the capability bundles currently persisted on a project.
+             * @param projectId - Project identifier.
+             * @returns The preview resolved from the project's persisted bundle selections.
+             */
+            preview: (projectId: string) => Promise<CapabilityPreview>;
+            /**
+             * Preview a draft bundle selection without changing the project.
+             * @param projectId - Project identifier.
+             * @param bundleIds - Ordered capability bundle identifiers to preview.
+             * @returns The draft preview resolved from the supplied bundle IDs; no project state is changed.
+             */
+            previewWithBundles: (projectId: string, bundleIds: string[]) => Promise<CapabilityPreview>;
+        };
+    };
     /** Agent Web Apps namespace for managing React SDK publications. */
     webApps: {
         /**
@@ -1771,6 +1858,156 @@ declare class ExportImportClient {
     importApply(tenantId: string, source: ImportSource, resolutions: ImportResolutions): Promise<ImportApplyResult>;
 }
 
+declare class ProjectRoomClientError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly retryable: boolean;
+    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;
+}
+interface ProjectRoomMessageRecord extends Omit<ProjectRoomPublicMessage, "createdAt"> {
+    createdAt: Date;
+}
+interface ProjectRoomMembershipRecord extends Omit<ProjectMembership, "joinedAt" | "updatedAt"> {
+    joinedAt: Date;
+    updatedAt: Date;
+}
+interface ProjectRoomBotRecord extends Omit<ProjectBotMembership, "joinedAt" | "updatedAt"> {
+    joinedAt: Date;
+    updatedAt: Date;
+}
+interface ProjectRoomPublicMembershipRecord extends Omit<ProjectRoomPublicMembership, "joinedAt" | "updatedAt"> {
+    joinedAt: Date;
+    updatedAt: Date;
+}
+interface ProjectRoomPublicBotRecord extends Omit<ProjectRoomPublicBotMembership, "joinedAt" | "updatedAt"> {
+    joinedAt: Date;
+    updatedAt: Date;
+}
+type ProjectRoomDispatchErrorCode = "BOT_PAUSED" | "TARGET_UNAVAILABLE" | "TARGET_REQUIRED" | "CHANNEL_UNAVAILABLE" | "DISPATCH_FAILED" | "DISPATCH_STATUS_UNKNOWN" | "AUTHORIZATION_REVOKED" | "ROSTER_CONFLICT";
+interface ProjectRoomDispatchResult {
+    membershipId?: string;
+    success: boolean;
+    errorCode?: ProjectRoomDispatchErrorCode;
+}
+interface ProjectRoomSendResult {
+    message: ProjectRoomMessageRecord;
+    dispatch: ProjectRoomDispatchResult[];
+    replayed: boolean;
+}
+interface SendProjectRoomMessageInput {
+    text: string;
+    mentions: ProjectRoomMention[];
+    replyToMessageId?: string;
+    idempotencyKey: string;
+}
+interface ListProjectRoomMessagesOptions {
+    limit?: number;
+    cursor?: {
+        createdAt: Date;
+        id: string;
+    };
+}
+interface UpdateProjectMembershipInput {
+    role: ProjectHumanRole;
+    expectedUpdatedAt: Date;
+}
+interface MutationExpectedUpdatedAt {
+    expectedUpdatedAt: Date | string;
+}
+interface AddProjectMembershipInput {
+    userId: string;
+    role: ProjectHumanRole;
+}
+interface AddProjectBotMembershipInput {
+    assistantId: string;
+    role: ProjectBotRole;
+    title: string;
+    responsibility?: string;
+    mentionName: string;
+}
+interface UpdateProjectBotMembershipInput {
+    role?: ProjectBotRole;
+    title?: string;
+    responsibility?: string;
+    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;
+    }>;
+}
+declare class ProjectRoomsClient {
+    private readonly baseURL;
+    private readonly getHeaders;
+    readonly messages: {
+        list: (projectId: string, options?: ListProjectRoomMessagesOptions) => Promise<ProjectRoomMessageRecord[]>;
+        send: (projectId: string, input: SendProjectRoomMessageInput) => Promise<ProjectRoomSendResult>;
+        retry: (projectId: string, messageId: string) => Promise<ProjectRoomDispatchResult[]>;
+    };
+    readonly members: {
+        list: (projectId: string) => Promise<ProjectRoomMembershipRecord[]>;
+        add: (projectId: string, input: AddProjectMembershipInput) => Promise<ProjectRoomMembershipRecord>;
+        update: (projectId: string, membershipId: string, input: UpdateProjectMembershipInput) => Promise<ProjectRoomMembershipRecord>;
+        remove: (projectId: string, membershipId: string, input: MutationExpectedUpdatedAt) => Promise<unknown>;
+    };
+    readonly bots: {
+        list: (projectId: string) => Promise<ProjectRoomBotRecord[]>;
+        add: (projectId: string, input: AddProjectBotMembershipInput) => Promise<ProjectRoomBotRecord>;
+        update: (projectId: string, membershipId: string, input: UpdateProjectBotMembershipInput) => Promise<ProjectRoomBotRecord>;
+        pause: (projectId: string, membershipId: string, input: MutationExpectedUpdatedAt) => Promise<ProjectRoomBotRecord>;
+        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);
+    getRoom(projectId: string): Promise<ProjectRoomRecord>;
+    getRealtimeMode(projectId: string): Promise<unknown>;
+    private records;
+    private request;
+    private connect;
+}
+
 /**
  * Web client class for interacting with the Axiom Lattice Agent Service API
  */
@@ -1778,6 +2015,7 @@ declare class Client extends AbstractClient {
     private headers;
     resources: ResourcesClient;
     exportImport: ExportImportClient;
+    readonly projectRooms: ProjectRoomsClient;
     /**
      * Creates a new Client instance
      * @param config - Configuration options for the client
@@ -1894,6 +2132,17 @@ declare class WeChatClient extends AbstractClient {
      * @param tenantId - Tenant identifier
      */
     setTenantId(tenantId: string): void;
+    /**
+     * Set workspace and project headers for requests made by this client.
+     * @param workspaceId - Workspace identifier, or undefined to leave it unchanged
+     * @param projectId - Project identifier, or undefined to leave it unchanged
+     */
+    setWorkspaceContext(workspaceId?: string, projectId?: string): void;
+    /**
+     * Get the workspace and project headers currently applied to this client.
+     * @returns A copy of the current workspace and project header values
+     */
+    getWorkspaceHeaders(): Record<string, string>;
     /**
      * Creates a new instance of the client with the given configuration
      * @param config - Configuration options for the client
@@ -2039,4 +2288,4 @@ declare function createSimpleMessageMerger(): {
     reset: () => void;
 };
 
-export { A2AKeyListItem, A2AKeysListResponse, AbortAgentParams, AbstractClient, AgentState, AgentWebAppsListResponse, ApiError, ArchiveInput, Assistant, AssistantListResponse, AssistantResponse, AuthenticationError, 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, ListAgentWebAppsParams, ListThreadsOptions, LocalA2ATemplatesListResponse, McpServerResponse, McpServersListResponse, MetricsConfigResponse, MetricsConfigsListResponse, NetworkError, PendingMessage, Project, ProjectKind, RegisterToolOptions, RemovePendingMessageOptions, ResourcesClient, ResumeStreamOptions, RetryConfig, RunOptions, ScheduleExecutionType, ScheduledTask, ScheduledTaskStatus, ScheduledTasksListResponse, StorageType, StreamCallbacks, StreamEvent, TaskLifecycleWarning, TaskResponse, TasksListResponse, TestConnectionResponse, TestMcpServerResponse, Thread, ThreadListResponse, ThreadResponse, Tool, ToolResponse, ToolsListResponse, Transport, UpdateAssistantOptions, 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, 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, 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 };

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,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,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,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"}