@axiom-lattice/client-sdk 4.3.4 → 4.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/__tests__/project-rooms.test.js +0 -66
- package/dist/__tests__/project-rooms.test.js.map +1 -1
- package/dist/__tests__/room-events.test.d.ts +2 -0
- package/dist/__tests__/room-events.test.d.ts.map +1 -0
- package/dist/__tests__/room-events.test.js +144 -0
- package/dist/__tests__/room-events.test.js.map +1 -0
- package/dist/__tests__/workspace-rooms.test.d.ts +2 -0
- package/dist/__tests__/workspace-rooms.test.d.ts.map +1 -0
- package/dist/__tests__/workspace-rooms.test.js +116 -0
- package/dist/__tests__/workspace-rooms.test.js.map +1 -0
- package/dist/client.d.ts +4 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +4 -0
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +137 -46
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +300 -181
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +298 -181
- package/dist/index.mjs.map +1 -1
- package/dist/project-room-hydrators.d.ts +18 -0
- package/dist/project-room-hydrators.d.ts.map +1 -0
- package/dist/project-room-hydrators.js +95 -0
- package/dist/project-room-hydrators.js.map +1 -0
- package/dist/project-rooms.d.ts +3 -51
- package/dist/project-rooms.d.ts.map +1 -1
- package/dist/project-rooms.js +5 -178
- package/dist/project-rooms.js.map +1 -1
- package/dist/room-events.d.ts +108 -0
- package/dist/room-events.d.ts.map +1 -0
- package/dist/room-events.js +127 -0
- package/dist/room-events.js.map +1 -0
- package/dist/workspace-rooms.d.ts +26 -0
- package/dist/workspace-rooms.d.ts.map +1 -0
- package/dist/workspace-rooms.js +67 -0
- package/dist/workspace-rooms.js.map +1 -0
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
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,
|
|
1
|
+
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, Project as Project$1, ProjectRoomEventScope } from '@axiom-lattice/protocols';
|
|
2
2
|
export { AgentWebApp, AgentWebAppAppearance, AgentWebAppFeatures, AgentWebAppScope, AgentWebAppStatus, CapabilityBundle, CapabilityPreview, CreateAgentWebAppInput, CreateCapabilityBundleInput, LocalA2AProviderId, LocalA2AProviderState, LocalA2AProviderStatus, LocalA2ATemplateDefinition, LocalRuntimeConfig, UpdateAgentWebAppInput, UpdateCapabilityBundleInput } from '@axiom-lattice/protocols';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -1865,6 +1865,7 @@ declare class ProjectRoomClientError extends Error {
|
|
|
1865
1865
|
readonly details?: unknown | undefined;
|
|
1866
1866
|
constructor(message: string, status: number, code: string, retryable: boolean, details?: unknown | undefined);
|
|
1867
1867
|
}
|
|
1868
|
+
|
|
1868
1869
|
interface ProjectRoomRecord extends Omit<ProjectRoom, "createdAt" | "updatedAt"> {
|
|
1869
1870
|
createdAt: Date;
|
|
1870
1871
|
updatedAt: Date;
|
|
@@ -1937,41 +1938,7 @@ interface UpdateProjectBotMembershipInput {
|
|
|
1937
1938
|
mentionName?: string;
|
|
1938
1939
|
expectedUpdatedAt: Date | string;
|
|
1939
1940
|
}
|
|
1940
|
-
type
|
|
1941
|
-
occurredAt: Date;
|
|
1942
|
-
data: {
|
|
1943
|
-
message: ProjectRoomMessageRecord;
|
|
1944
|
-
};
|
|
1945
|
-
}) | (Omit<ProjectRoomRosterChangedEvent, "occurredAt" | "data"> & {
|
|
1946
|
-
occurredAt: Date;
|
|
1947
|
-
data: {
|
|
1948
|
-
change: ProjectRoomRosterChangedEvent["data"]["change"];
|
|
1949
|
-
membership: ProjectRoomPublicBotRecord;
|
|
1950
|
-
};
|
|
1951
|
-
}) | (Omit<ProjectRoomMembershipChangedEvent, "occurredAt" | "data"> & {
|
|
1952
|
-
occurredAt: Date;
|
|
1953
|
-
data: {
|
|
1954
|
-
change: ProjectRoomMembershipChangedEvent["data"]["change"];
|
|
1955
|
-
membership: ProjectRoomPublicMembershipRecord;
|
|
1956
|
-
};
|
|
1957
|
-
}) | (Omit<ProjectRoomTaskChangedEvent, "occurredAt" | "data"> & {
|
|
1958
|
-
occurredAt: Date;
|
|
1959
|
-
data: Omit<ProjectRoomTaskChangedEvent["data"], "updatedAt"> & {
|
|
1960
|
-
updatedAt: Date;
|
|
1961
|
-
};
|
|
1962
|
-
});
|
|
1963
|
-
interface ProjectRoomSseFrame {
|
|
1964
|
-
event: HydratedProjectRoomBusinessEvent | ProjectRoomControlEvent;
|
|
1965
|
-
id?: string;
|
|
1966
|
-
retry?: number;
|
|
1967
|
-
}
|
|
1968
|
-
type HeadersGetter = () => Record<string, string>;
|
|
1969
|
-
interface ProjectRoomEventConnection extends AsyncIterable<ProjectRoomSseFrame> {
|
|
1970
|
-
readonly opened: Promise<{
|
|
1971
|
-
status: 200;
|
|
1972
|
-
lastEventId?: string;
|
|
1973
|
-
}>;
|
|
1974
|
-
}
|
|
1941
|
+
type HeadersGetter$1 = () => Record<string, string>;
|
|
1975
1942
|
declare class ProjectRoomsClient {
|
|
1976
1943
|
private readonly baseURL;
|
|
1977
1944
|
private readonly getHeaders;
|
|
@@ -1979,6 +1946,7 @@ declare class ProjectRoomsClient {
|
|
|
1979
1946
|
list: (projectId: string, options?: ListProjectRoomMessagesOptions) => Promise<ProjectRoomMessageRecord[]>;
|
|
1980
1947
|
send: (projectId: string, input: SendProjectRoomMessageInput) => Promise<ProjectRoomSendResult>;
|
|
1981
1948
|
retry: (projectId: string, messageId: string) => Promise<ProjectRoomDispatchResult[]>;
|
|
1949
|
+
markRead: (projectId: string) => Promise<void>;
|
|
1982
1950
|
};
|
|
1983
1951
|
readonly members: {
|
|
1984
1952
|
list: (projectId: string) => Promise<ProjectRoomMembershipRecord[]>;
|
|
@@ -1994,18 +1962,139 @@ declare class ProjectRoomsClient {
|
|
|
1994
1962
|
resume: (projectId: string, membershipId: string, input: MutationExpectedUpdatedAt) => Promise<ProjectRoomBotRecord>;
|
|
1995
1963
|
remove: (projectId: string, membershipId: string, input: MutationExpectedUpdatedAt) => Promise<unknown>;
|
|
1996
1964
|
};
|
|
1997
|
-
|
|
1998
|
-
connect: (projectId: string, options: {
|
|
1999
|
-
lastEventId?: string;
|
|
2000
|
-
signal: AbortSignal;
|
|
2001
|
-
}) => ProjectRoomEventConnection;
|
|
2002
|
-
};
|
|
2003
|
-
constructor(baseURL: string, getHeaders: HeadersGetter);
|
|
1965
|
+
constructor(baseURL: string, getHeaders: HeadersGetter$1);
|
|
2004
1966
|
getRoom(projectId: string): Promise<ProjectRoomRecord>;
|
|
2005
|
-
getRealtimeMode(projectId: string): Promise<unknown>;
|
|
2006
1967
|
private records;
|
|
2007
1968
|
private request;
|
|
2008
|
-
|
|
1969
|
+
}
|
|
1970
|
+
|
|
1971
|
+
interface ProjectRecord extends Omit<Project$1, "createdAt" | "updatedAt"> {
|
|
1972
|
+
createdAt: Date;
|
|
1973
|
+
updatedAt: Date;
|
|
1974
|
+
}
|
|
1975
|
+
/** A hydrated workspace room entry from the aggregated rooms endpoint. */
|
|
1976
|
+
interface WorkspaceRoomEntryRecord {
|
|
1977
|
+
project: ProjectRecord;
|
|
1978
|
+
room: ProjectRoomRecord;
|
|
1979
|
+
lastMessage?: ProjectRoomMessageRecord;
|
|
1980
|
+
participantCount: number;
|
|
1981
|
+
participantNames: string[];
|
|
1982
|
+
isPublic?: boolean;
|
|
1983
|
+
/** Messages after the user's read horizon, excluding the user's own messages. */
|
|
1984
|
+
unreadCount: number;
|
|
1985
|
+
}
|
|
1986
|
+
/** Aggregated workspace room list client (single request, server-computed unread counts). */
|
|
1987
|
+
declare class WorkspaceRoomsClient {
|
|
1988
|
+
private readonly baseURL;
|
|
1989
|
+
private readonly getHeaders;
|
|
1990
|
+
constructor(baseURL: string, getHeaders: () => Record<string, string>);
|
|
1991
|
+
/** Lists the user's rooms in a workspace with last message and unread count. */
|
|
1992
|
+
list(workspaceId: string): Promise<WorkspaceRoomEntryRecord[]>;
|
|
1993
|
+
}
|
|
1994
|
+
|
|
1995
|
+
/** Routing scope attached to room-scoped frames by the workspace stream. */
|
|
1996
|
+
type RoomEventScopeRecord = ProjectRoomEventScope;
|
|
1997
|
+
type WorkspaceRoomKnownBusinessEvent = {
|
|
1998
|
+
type: "message.created";
|
|
1999
|
+
id: string;
|
|
2000
|
+
occurredAt: Date;
|
|
2001
|
+
scope: RoomEventScopeRecord;
|
|
2002
|
+
data: {
|
|
2003
|
+
message: ProjectRoomMessageRecord;
|
|
2004
|
+
};
|
|
2005
|
+
} | {
|
|
2006
|
+
type: "roster.changed";
|
|
2007
|
+
id: string;
|
|
2008
|
+
occurredAt: Date;
|
|
2009
|
+
scope: RoomEventScopeRecord;
|
|
2010
|
+
data: {
|
|
2011
|
+
change: string;
|
|
2012
|
+
membership: ProjectRoomPublicBotRecord;
|
|
2013
|
+
};
|
|
2014
|
+
} | {
|
|
2015
|
+
type: "membership.changed";
|
|
2016
|
+
id: string;
|
|
2017
|
+
occurredAt: Date;
|
|
2018
|
+
scope: RoomEventScopeRecord;
|
|
2019
|
+
data: {
|
|
2020
|
+
change: string;
|
|
2021
|
+
membership: ProjectRoomPublicMembershipRecord;
|
|
2022
|
+
};
|
|
2023
|
+
} | {
|
|
2024
|
+
type: "task.changed";
|
|
2025
|
+
id: string;
|
|
2026
|
+
occurredAt: Date;
|
|
2027
|
+
scope: RoomEventScopeRecord;
|
|
2028
|
+
data: {
|
|
2029
|
+
taskId: string;
|
|
2030
|
+
status: string;
|
|
2031
|
+
ownerMembershipId: string;
|
|
2032
|
+
updatedAt: Date;
|
|
2033
|
+
};
|
|
2034
|
+
} | {
|
|
2035
|
+
type: "read.changed";
|
|
2036
|
+
id: string;
|
|
2037
|
+
occurredAt: Date;
|
|
2038
|
+
data: {
|
|
2039
|
+
projectId: string;
|
|
2040
|
+
roomId: string;
|
|
2041
|
+
lastReadAt: Date;
|
|
2042
|
+
};
|
|
2043
|
+
} | {
|
|
2044
|
+
type: "membership.affected";
|
|
2045
|
+
id: string;
|
|
2046
|
+
occurredAt: Date;
|
|
2047
|
+
data: {
|
|
2048
|
+
change: "added" | "removed" | "role_changed";
|
|
2049
|
+
projectId: string;
|
|
2050
|
+
roomId: string;
|
|
2051
|
+
};
|
|
2052
|
+
};
|
|
2053
|
+
/** A business event of a type this client version does not know (forward compatibility). */
|
|
2054
|
+
interface WorkspaceRoomUnknownBusinessEvent {
|
|
2055
|
+
type: string;
|
|
2056
|
+
id: string;
|
|
2057
|
+
occurredAt: Date;
|
|
2058
|
+
data: unknown;
|
|
2059
|
+
scope?: RoomEventScopeRecord;
|
|
2060
|
+
}
|
|
2061
|
+
type WorkspaceRoomBusinessEvent = WorkspaceRoomKnownBusinessEvent | WorkspaceRoomUnknownBusinessEvent;
|
|
2062
|
+
type WorkspaceRoomControlEvent = {
|
|
2063
|
+
type: "ready";
|
|
2064
|
+
data: {
|
|
2065
|
+
epoch: string;
|
|
2066
|
+
headEventId: string | null;
|
|
2067
|
+
};
|
|
2068
|
+
} | {
|
|
2069
|
+
type: "resync";
|
|
2070
|
+
data: {
|
|
2071
|
+
reason: "SERVER_RESTART" | "CURSOR_EXPIRED" | "SLOW_CONSUMER";
|
|
2072
|
+
};
|
|
2073
|
+
} | {
|
|
2074
|
+
type: "access.revoked";
|
|
2075
|
+
data: {
|
|
2076
|
+
reason: "PROJECT_ACCESS_REVOKED" | "TOKEN_EXPIRED" | "CONNECTION_SUPERSEDED";
|
|
2077
|
+
};
|
|
2078
|
+
};
|
|
2079
|
+
interface WorkspaceRoomEventFrame {
|
|
2080
|
+
event: WorkspaceRoomBusinessEvent | WorkspaceRoomControlEvent;
|
|
2081
|
+
id?: string;
|
|
2082
|
+
retry?: number;
|
|
2083
|
+
}
|
|
2084
|
+
interface WorkspaceRoomEventConnection extends AsyncIterable<WorkspaceRoomEventFrame> {
|
|
2085
|
+
readonly opened: Promise<{
|
|
2086
|
+
status: 200;
|
|
2087
|
+
}>;
|
|
2088
|
+
}
|
|
2089
|
+
type HeadersGetter = () => Record<string, string>;
|
|
2090
|
+
/** Live-only workspace-scoped room events SSE client (no cursor, replay, or resync). */
|
|
2091
|
+
declare class RoomEventsClient {
|
|
2092
|
+
private readonly baseURL;
|
|
2093
|
+
private readonly getHeaders;
|
|
2094
|
+
constructor(baseURL: string, getHeaders: HeadersGetter);
|
|
2095
|
+
connect(workspaceId: string, options: {
|
|
2096
|
+
signal: AbortSignal;
|
|
2097
|
+
}): WorkspaceRoomEventConnection;
|
|
2009
2098
|
}
|
|
2010
2099
|
|
|
2011
2100
|
/**
|
|
@@ -2016,6 +2105,8 @@ declare class Client extends AbstractClient {
|
|
|
2016
2105
|
resources: ResourcesClient;
|
|
2017
2106
|
exportImport: ExportImportClient;
|
|
2018
2107
|
readonly projectRooms: ProjectRoomsClient;
|
|
2108
|
+
readonly workspaceRooms: WorkspaceRoomsClient;
|
|
2109
|
+
readonly roomEvents: RoomEventsClient;
|
|
2019
2110
|
/**
|
|
2020
2111
|
* Creates a new Client instance
|
|
2021
2112
|
* @param config - Configuration options for the client
|
|
@@ -2352,4 +2443,4 @@ declare function createSimpleMessageMerger(): {
|
|
|
2352
2443
|
reset: () => void;
|
|
2353
2444
|
};
|
|
2354
2445
|
|
|
2355
|
-
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,
|
|
2446
|
+
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, ListAgentWebAppsParams, ListProjectRoomMessagesOptions, ListThreadsOptions, LocalA2ATemplatesListResponse, McpServerResponse, McpServersListResponse, MetricsConfigResponse, MetricsConfigsListResponse, MutationExpectedUpdatedAt, NetworkError, 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
CHANGED
|
@@ -1 +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"}
|
|
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,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC"}
|