@axiom-lattice/client-sdk 3.0.6 → 4.0.1

package/dist/index.d.ts

@@ -1,10 +1,20 @@
-import { Message, MessageChunk, DatabaseConfigEntry, MetricsServerConfigEntry, DataSource, McpServerConfigEntry, McpTool, LocalA2ATemplateDefinition, TaskItem, CreateDatabaseConfigRequest, UpdateDatabaseConfigRequest, CreateMetricsServerConfigRequest, UpdateMetricsServerConfigRequest, CreateMcpServerConfigRequest, UpdateMcpServerConfigRequest, ConnectionEntry, CreateTaskRequest, UpdateTaskRequest, TaskWorkItem, LocalA2AProviderState, Skill, CreateSkillRequest, CreateShareRequest, ShareResult, ShareRecord } from '@axiom-lattice/protocols';
-export { LocalA2AProviderId, LocalA2AProviderState, LocalA2AProviderStatus, LocalA2ATemplateDefinition, LocalRuntimeConfig } from '@axiom-lattice/protocols';
+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';
 
 /**
  * Core types for the Axiom Lattice Client SDK
  */
 
+/** Optional filters for listing Agent Web Apps. */
+interface ListAgentWebAppsParams {
+    /** Return only publications for this assistant. */
+    assistantId?: string;
+}
+/** Agent Web App list data, unwrapped from the gateway response envelope. */
+interface AgentWebAppsListResponse {
+    records: AgentWebApp[];
+    total: number;
+}
 /**
  * Tool interface for API responses
  * Represents a tool configuration stored in the database
@@ -717,6 +727,12 @@ interface UpdateWorkspaceRequest {
     description?: string;
     storageType?: StorageType;
 }
+/**
+ * Project kind classification
+ *
+ * Defaults to "business" for legacy data and omitted input.
+ */
+type ProjectKind = "business" | "training" | "personal";
 /**
  * Project information
  */
@@ -728,6 +744,8 @@ interface Project {
     description?: string;
     /** Application-specific configuration stored as JSON */
     config?: Record<string, unknown>;
+    /** Project classification; defaults to "business" when omitted */
+    kind?: ProjectKind;
     createdAt: Date | string;
     updatedAt: Date | string;
 }
@@ -739,6 +757,8 @@ interface CreateProjectRequest {
     description?: string;
     /** Application-specific configuration stored as JSON (optional) */
     config?: Record<string, unknown>;
+    /** Project classification; defaults to "business" when omitted */
+    kind?: ProjectKind;
 }
 /**
  * Update project request
@@ -752,6 +772,8 @@ interface UpdateProjectRequest {
     description?: string;
     /** Application-specific configuration stored as JSON (replaces existing if provided) */
     config?: Record<string, unknown>;
+    /** Project classification */
+    kind?: ProjectKind;
 }
 /**
  * File item in workspace
@@ -849,6 +871,40 @@ interface LocalA2ATemplatesListResponse {
         total: number;
     };
 }
+/**
+ * A single A2A API key as returned by the management endpoints.
+ *
+ * The `key` value is masked in list responses (only the first 8 characters
+ * followed by "..." are returned); only create/rotate responses expose the
+ * full key value.
+ */
+interface A2AKeyListItem {
+    id: string;
+    key: string;
+    tenantId: string;
+    projectId: string;
+    assistantIds?: string[];
+    label?: string;
+    enabled: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Input for creating a new A2A API key.
+ */
+interface CreateA2AKeyInput {
+    tenantId: string;
+    projectId: string;
+    assistantIds?: string[];
+    label?: string;
+}
+/**
+ * A2A API key list response (already unwrapped from `{ success, data }`).
+ */
+interface A2AKeysListResponse {
+    records: A2AKeyListItem[];
+    total: number;
+}
 /**
  * Options for removing a pending message
  */
@@ -890,6 +946,20 @@ interface TaskResponse {
     data?: TaskItem;
     error?: string;
 }
+/** A recoverable lifecycle evidence write failure returned with task completion. */
+interface TaskLifecycleWarning {
+    code: string;
+    taskId: string;
+    evidenceId?: string;
+    eventKey?: string;
+    parentTaskId?: string;
+}
+/** The full response envelope returned by the task completion endpoint. */
+interface CompleteTaskResponse extends TaskResponse {
+    evidenceId?: string;
+    eventKey?: string;
+    warnings?: TaskLifecycleWarning[];
+}
 /**
  * A single parsed Server-Sent Events payload yielded by `Client.streamEvents`.
  */
@@ -898,6 +968,16 @@ interface StreamEvent {
     data: Record<string, unknown>;
 }
 
+/** Completion evidence accepted by the task lifecycle endpoint. */
+interface CompleteTaskInput {
+    result: string;
+    beliefImpact?: Array<{
+        key: string;
+        after: number;
+        basis: string;
+    }>;
+}
+
 /**
  * Abstract client class for interacting with the Axiom Lattice Agent Service API
  * Provides common functionality for different client implementations
@@ -908,6 +988,7 @@ declare abstract class AbstractClient {
     tenantId: string;
     protected registeredTools: Map<string, RegisterToolOptions>;
     private onUnauthorizedHandler?;
+    private hydrateAgentWebApp;
     /**
      * Server tools namespace for managing tools via API
      */
@@ -984,7 +1065,7 @@ declare abstract class AbstractClient {
         create: (data: CreateTaskRequest) => Promise<TaskItem>;
         update: (id: string, data: UpdateTaskRequest) => Promise<TaskItem>;
         delete: (id: string) => Promise<void>;
-        complete: (id: string) => Promise<TaskItem>;
+        complete: (id: string, data: CompleteTaskInput) => Promise<CompleteTaskResponse>;
         workItems: {
             list: (taskId: string, params?: {
                 action?: string;
@@ -1257,6 +1338,100 @@ declare abstract class AbstractClient {
             };
         };
     };
+    /**
+     * A2A API keys namespace for managing A2A API keys
+     */
+    a2aKeys: {
+        /**
+         * Lists A2A API keys, optionally filtered by tenant
+         * Key values are masked in list responses
+         * @param params - Optional tenant filter and pagination
+         * @returns A promise that resolves to the list of key records and total
+         */
+        list: (params?: {
+            tenantId?: string;
+            limit?: number;
+            offset?: number;
+        }) => Promise<A2AKeysListResponse>;
+        /**
+         * Creates a new A2A API key
+         * The full key value is returned only from this call
+         * @param input - Key creation input (tenant, project, optional assistant whitelist and label)
+         * @returns A promise that resolves to the created key record (full key value)
+         */
+        create: (input: CreateA2AKeyInput) => Promise<A2AKeyListItem>;
+        /**
+         * Permanently deletes an A2A API key
+         * @param id - Key identifier
+         * @returns A promise that resolves when the key is deleted
+         */
+        delete: (id: string) => Promise<void>;
+        /**
+         * Disables an A2A API key
+         * @param id - Key identifier
+         * @returns A promise that resolves to the updated key record
+         */
+        disable: (id: string) => Promise<A2AKeyListItem>;
+        /**
+         * Enables a previously disabled A2A API key
+         * @param id - Key identifier
+         * @returns A promise that resolves to the updated key record
+         */
+        enable: (id: string) => Promise<A2AKeyListItem>;
+        /**
+         * Rotates an A2A API key, generating a new key value
+         * The full new key value is returned only from this call
+         * @param id - Key identifier
+         * @returns A promise that resolves to the updated key record (full new key value)
+         */
+        rotate: (id: string) => Promise<A2AKeyListItem>;
+    };
+    /** Agent Web Apps namespace for managing React SDK publications. */
+    webApps: {
+        /**
+         * Lists Agent Web Apps, optionally filtered by assistant.
+         * @param params - Optional assistant filter
+         * @returns A promise that resolves to the publication records and total
+         */
+        list: (params?: ListAgentWebAppsParams) => Promise<AgentWebAppsListResponse>;
+        /**
+         * Retrieves an Agent Web App by ID.
+         * @param id - Agent Web App identifier
+         * @returns A promise that resolves to the publication
+         */
+        get: (id: string) => Promise<AgentWebApp>;
+        /**
+         * Creates an Agent Web App.
+         * @param input - Publication configuration
+         * @returns A promise that resolves to the created publication
+         */
+        create: (input: CreateAgentWebAppInput) => Promise<AgentWebApp>;
+        /**
+         * Updates editable fields on an Agent Web App.
+         * @param id - Agent Web App identifier
+         * @param input - Fields to update
+         * @returns A promise that resolves to the updated publication
+         */
+        update: (id: string, input: UpdateAgentWebAppInput) => Promise<AgentWebApp>;
+        /**
+         * Enables an Agent Web App.
+         * @param id - Agent Web App identifier
+         * @returns A promise that resolves to the enabled publication
+         */
+        enable: (id: string) => Promise<AgentWebApp>;
+        /**
+         * Disables an Agent Web App.
+         * @param id - Agent Web App identifier
+         * @returns A promise that resolves to the disabled publication
+         */
+        disable: (id: string) => Promise<AgentWebApp>;
+        /**
+         * Permanently deletes an Agent Web App.
+         * @param id - Agent Web App identifier
+         * @returns A promise that resolves when the publication is deleted
+         */
+        delete: (id: string) => Promise<void>;
+    };
     /**
      * Skills namespace for managing skills
      */
@@ -1454,12 +1629,154 @@ declare class ResourcesClient {
     listShares(): Promise<ShareRecord[]>;
 }
 
+/** A registered entity type that can be exported. */
+interface ExportableTypeInfo {
+    entityType: string;
+    label: string;
+    category: "core" | "plugin";
+    dependsOn: string[];
+    cascadeParents: string[];
+}
+/** Explicit entity IDs selected for each exportable type. */
+type ExportEntityIds = Record<string, string[]>;
+/** A completed export job returned by the gateway. */
+interface ExportJobResult {
+    jobId: string;
+    summary: Record<string, number>;
+}
+/** An export preview that requires dependency confirmation. */
+interface ExportConfirmationRequired {
+    needsConfirmation: true;
+    missingDependencies: string[];
+    cascadeAdditions: string[];
+}
+/** Result of starting an export. */
+type ExportConfigResult = ExportJobResult | ExportConfirmationRequired;
+/** A selectable entity shown before an export. */
+interface ExportEntityPreview {
+    id: string;
+    name: string;
+    description?: string;
+}
+/** Selectable entities grouped by entity type. */
+type ExportEntityPreviewMap = Record<string, ExportEntityPreview[]>;
+/** A single entity stored in an export bundle. */
+interface ExportableEntity {
+    _exportId: string;
+    data: Record<string, unknown>;
+}
+/** Plain JSON bundle contained in an export archive. */
+interface ExportBundle {
+    version: 1;
+    exportedAt: string;
+    sourceTenantId: string;
+    entities: Record<string, ExportableEntity[]>;
+    dependencyOrder: string[];
+    _warning?: string;
+}
+/** A conflict discovered while previewing an import. */
+interface ImportConflict {
+    _exportId: string;
+    entityType: string;
+    conflictType: "id_exists" | "unique_constraint";
+    existingName?: string;
+    existingId?: string;
+    field?: string;
+}
+/** A new entity discovered while previewing an import. */
+interface ImportInsertion {
+    _exportId: string;
+    entityType: string;
+    name: string;
+}
+/** An invalid entity discovered while previewing an import. */
+interface ImportPreviewError {
+    _exportId: string;
+    entityType: string;
+    error: string;
+}
+/** Gateway result for an import preview. */
+interface ImportPreviewResult {
+    conflicts: ImportConflict[];
+    insertions: ImportInsertion[];
+    errors: ImportPreviewError[];
+}
+/** Resolution selected for an import conflict. */
+interface ImportResolution {
+    _exportId: string;
+    action: "skip" | "overwrite" | "rename";
+    newId?: string;
+}
+/** Import conflict resolutions keyed by export ID. */
+type ImportResolutions = Record<string, ImportResolution>;
+/** Result for one imported entity. */
+interface ImportEntityResult {
+    _exportId: string;
+    entityType: string;
+    status: "created" | "updated" | "skipped" | "failed";
+    newId?: string;
+    error?: string;
+}
+/** Gateway result after applying an import. */
+interface ImportApplyResult {
+    results: ImportEntityResult[];
+    idMap: Record<string, string>;
+}
+/** Binary or encoded archive accepted by import operations. */
+type ArchiveInput = File | Blob | ArrayBuffer | Uint8Array | string;
+/** Explicit archive or plain-bundle source for an import operation. */
+type ImportSource = {
+    archive: ArchiveInput;
+    bundle?: never;
+} | {
+    bundle: ExportBundle;
+    archive?: never;
+};
+/** Decoded archive returned by an export download. */
+interface ExportDownload {
+    filename: string;
+    data: Uint8Array;
+}
+
+type HeaderProvider = () => Record<string, string>;
+/** Client for the gateway tenant export/import archive API. */
+declare class ExportImportClient {
+    private readonly baseURL;
+    private readonly headers;
+    private readonly headerProvider?;
+    /**
+     * Creates an export/import client.
+     *
+     * @param config - Base client configuration.
+     * @param headerProvider - Optional provider for headers that change after construction.
+     */
+    constructor(config: ClientConfig, headerProvider?: HeaderProvider);
+    private request;
+    /** Returns all entity types registered for export. */
+    getExportableTypes(): Promise<ExportableTypeInfo[]>;
+    /** Starts an export or returns dependencies requiring confirmation. */
+    exportConfig(tenantId: string, entityTypes: string[], entityIds?: ExportEntityIds): Promise<ExportConfigResult>;
+    /** Starts an export after confirming dependency additions. */
+    exportConfigConfirm(tenantId: string, entityTypes: string[], entityIds?: ExportEntityIds): Promise<ExportJobResult>;
+    /** Lists selectable entities for the requested export types. */
+    previewEntities(tenantId: string, entityTypes: string[]): Promise<ExportEntityPreviewMap>;
+    /** Returns the gateway URL for an export download job. */
+    getExportDownloadUrl(tenantId: string, jobId: string): string;
+    /** Downloads an export archive as raw bytes. */
+    downloadExport(tenantId: string, jobId: string): Promise<ExportDownload>;
+    /** Previews an archive or plain JSON bundle import. */
+    importPreview(tenantId: string, source: ImportSource): Promise<ImportPreviewResult>;
+    /** Applies an archive or plain JSON bundle import with conflict resolutions. */
+    importApply(tenantId: string, source: ImportSource, resolutions: ImportResolutions): Promise<ImportApplyResult>;
+}
+
 /**
  * Web client class for interacting with the Axiom Lattice Agent Service API
  */
 declare class Client extends AbstractClient {
     private headers;
     resources: ResourcesClient;
+    exportImport: ExportImportClient;
     /**
      * Creates a new Client instance
      * @param config - Configuration options for the client
@@ -1648,7 +1965,7 @@ declare class WorkspaceClient {
     getWorkspace(workspaceId: string): Promise<Workspace>;
     updateWorkspace(workspaceId: string, updates: UpdateWorkspaceRequest): Promise<Workspace>;
     deleteWorkspace(workspaceId: string): Promise<void>;
-    listProjects(workspaceId: string): Promise<Project[]>;
+    listProjects(workspaceId: string, kind?: ProjectKind): Promise<Project[]>;
     createProject(workspaceId: string, data: CreateProjectRequest): Promise<Project>;
     getProject(workspaceId: string, projectId: string): Promise<Project>;
     updateProject(workspaceId: string, projectId: string, updates: UpdateProjectRequest): Promise<Project>;
@@ -1688,36 +2005,6 @@ declare class WorkspaceClient {
     }>;
 }
 
-/**
- * ExportImportClient
- *
- * Client for tenant export/import API: exportable types, export config,
- * import preview, and import apply.
- */
-
-declare class ExportImportClient {
-    private baseURL;
-    private headers;
-    constructor(config: ClientConfig);
-    private request;
-    getExportableTypes(): Promise<any[]>;
-    exportConfig(tenantId: string, entityTypes: string[]): Promise<{
-        jobId: string;
-        summary: Record<string, number>;
-    } | {
-        needsConfirmation: boolean;
-        missingDependencies: string[];
-        cascadeAdditions: string[];
-    }>;
-    exportConfigConfirm(tenantId: string, entityTypes: string[]): Promise<{
-        jobId: string;
-        summary: Record<string, number>;
-    }>;
-    getExportDownloadUrl(tenantId: string, jobId: string): string;
-    importPreview(tenantId: string, file: File | Blob): Promise<any>;
-    importApply(tenantId: string, bundle: any, resolutions: Record<string, any>): Promise<any>;
-}
-
 /**
  * ChunkMessageMerger
  *
@@ -1737,4 +2024,4 @@ declare function createSimpleMessageMerger(): {
     reset: () => void;
 };
 
-export { AbortAgentParams, AbstractClient, AgentState, ApiError, Assistant, AssistantListResponse, AssistantResponse, AuthenticationError, ChatResponse, ChatSendOptions, ChatStreamOptions, Client, ClientConfig, CreateAssistantOptions, CreateProjectRequest, CreateThreadOptions, CreateWorkspaceRequest, DatabaseConfigResponse, DatabaseConfigsListResponse, DatasourcesListResponse, ExportImportClient, FileItem, GetMessagesOptions, GetScheduledTasksOptions, ListThreadsOptions, LocalA2ATemplatesListResponse, McpServerResponse, McpServersListResponse, MetricsConfigResponse, MetricsConfigsListResponse, NetworkError, PendingMessage, Project, RegisterToolOptions, RemovePendingMessageOptions, ResourcesClient, ResumeStreamOptions, RetryConfig, RunOptions, ScheduleExecutionType, ScheduledTask, ScheduledTaskStatus, ScheduledTasksListResponse, StorageType, StreamCallbacks, StreamEvent, TaskResponse, TasksListResponse, TestConnectionResponse, TestMcpServerResponse, Thread, ThreadListResponse, ThreadResponse, Tool, ToolResponse, ToolsListResponse, Transport, UpdateAssistantOptions, UpdateProjectRequest, UpdateThreadOptions, UpdateWorkspaceRequest, WeChatClient, Workspace, WorkspaceClient, createSimpleMessageMerger };
+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 };