@xpert-ai/xpert-sdk 0.8.0 → 0.8.1
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/index.d.ts +1 -1
- package/dist/resource-card-content.d.ts +35 -0
- package/dist/resource-card-content.js +2 -0
- package/dist/resource-card-content.js.map +1 -0
- package/dist/resource-card-content.mjs +2 -0
- package/dist/resource-card-content.mjs.map +1 -0
- package/dist/resource-card.d.ts +8 -0
- package/dist/tests/thread-activity.test.js +20 -2
- package/dist/tests/thread-activity.test.js.map +1 -1
- package/dist/tests/thread-activity.test.mjs +20 -2
- package/dist/tests/thread-activity.test.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -13,5 +13,5 @@ export type * from "./runtime-resources.js";
|
|
|
13
13
|
export { WorkbenchClient } from "./workbench.js";
|
|
14
14
|
export type { WorkspaceFileScope, WorkspaceFileDocument, WorkbenchRequestOptions, TerminalEvent, TerminalConnection, TerminalOpenOptions, } from "./workbench.js";
|
|
15
15
|
export * from "./workbench-open.js";
|
|
16
|
-
export type { ConversationResourceCard, ResourceCardOpenTarget, TMessageContentResourceCard, } from "./resource-card.js";
|
|
16
|
+
export type { ConversationResourceCard, ResourceCardContent, ResourceCardField, ResourceCardFile, ResourceCardFileReference, ResourceCardImage, ResourceCardOpenTarget, TMessageContentResourceCard, } from "./resource-card.js";
|
|
17
17
|
export type { ThreadActivitySnapshot } from './thread-activity.js';
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/** Stable provider references; credentials, temporary URLs and bytes never enter messages. */
|
|
2
|
+
export interface ResourceCardFileReference {
|
|
3
|
+
viewKey: string;
|
|
4
|
+
fileKey: string;
|
|
5
|
+
targetId: string;
|
|
6
|
+
}
|
|
7
|
+
export interface ResourceCardFile {
|
|
8
|
+
id: string;
|
|
9
|
+
title: string;
|
|
10
|
+
description?: string;
|
|
11
|
+
file: ResourceCardFileReference;
|
|
12
|
+
}
|
|
13
|
+
export interface ResourceCardImage {
|
|
14
|
+
id: string;
|
|
15
|
+
title: string;
|
|
16
|
+
alt?: string;
|
|
17
|
+
file: ResourceCardFileReference;
|
|
18
|
+
}
|
|
19
|
+
export interface ResourceCardField {
|
|
20
|
+
label: string;
|
|
21
|
+
value: string;
|
|
22
|
+
}
|
|
23
|
+
/** Ordered presentation blocks, independent of the business resource's type. */
|
|
24
|
+
export type ResourceCardContent = {
|
|
25
|
+
title?: string;
|
|
26
|
+
} & ({
|
|
27
|
+
kind: 'image-gallery';
|
|
28
|
+
images: ResourceCardImage[];
|
|
29
|
+
} | {
|
|
30
|
+
kind: 'file-list';
|
|
31
|
+
files: ResourceCardFile[];
|
|
32
|
+
} | {
|
|
33
|
+
kind: 'fields';
|
|
34
|
+
fields: ResourceCardField[];
|
|
35
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resource-card-content.js","sourceRoot":"","sources":["../src/resource-card-content.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resource-card-content.mjs","sourceRoot":"","sources":["../src/resource-card-content.ts"],"names":[],"mappings":""}
|
package/dist/resource-card.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import type { XpertViewScalar } from './view-extension.js';
|
|
2
2
|
import type { IconDefinition } from './schema.js';
|
|
3
|
+
import type { ResourceCardContent, ResourceCardFileReference } from './resource-card-content.js';
|
|
4
|
+
export type { ResourceCardContent, ResourceCardField, ResourceCardFile, ResourceCardFileReference, ResourceCardImage } from './resource-card-content.js';
|
|
3
5
|
/** Public chat resource-card wire contract, synchronized with chatkit-types. */
|
|
4
6
|
export type ResourceCardOpenTarget = {
|
|
5
7
|
viewKey: string;
|
|
@@ -10,6 +12,11 @@ export type ResourceCardOpenTarget = {
|
|
|
10
12
|
} | {
|
|
11
13
|
target: 'assistant.project';
|
|
12
14
|
projectId: string;
|
|
15
|
+
} | {
|
|
16
|
+
target: 'workbench.file';
|
|
17
|
+
fileKey: string;
|
|
18
|
+
targetId: string;
|
|
19
|
+
previewFile?: ResourceCardFileReference;
|
|
13
20
|
});
|
|
14
21
|
export interface ConversationResourceCard {
|
|
15
22
|
resource: {
|
|
@@ -21,6 +28,7 @@ export interface ConversationResourceCard {
|
|
|
21
28
|
title: string;
|
|
22
29
|
description?: string;
|
|
23
30
|
icon?: IconDefinition;
|
|
31
|
+
content?: ResourceCardContent[];
|
|
24
32
|
open: ResourceCardOpenTarget;
|
|
25
33
|
}
|
|
26
34
|
export type TMessageContentResourceCard = {
|
|
@@ -1,8 +1,26 @@
|
|
|
1
1
|
import { describe, expect, it, vi } from 'vitest';
|
|
2
2
|
import { Client } from "../index.js";
|
|
3
|
+
const openTargets = [
|
|
4
|
+
{ target: 'workbench.view', viewKey: 'results' },
|
|
5
|
+
{ target: 'assistant.project', viewKey: 'results', projectId: 'project' },
|
|
6
|
+
{ target: 'workbench.file', viewKey: 'results', fileKey: 'export', targetId: 'version' },
|
|
7
|
+
{
|
|
8
|
+
target: 'workbench.file', viewKey: 'results', fileKey: 'export', targetId: 'version',
|
|
9
|
+
previewFile: { viewKey: 'results', fileKey: 'export-pdf', targetId: 'version' },
|
|
10
|
+
},
|
|
11
|
+
];
|
|
3
12
|
describe('thread activity subscriptions', () => {
|
|
4
|
-
it('
|
|
5
|
-
const
|
|
13
|
+
it.each(openTargets)('preserves $target cards in abortable activity snapshots with a separate cursor', async (open) => {
|
|
14
|
+
const card = {
|
|
15
|
+
resource: { namespace: 'plugin', type: 'report', id: 'report' },
|
|
16
|
+
title: 'Results', open,
|
|
17
|
+
content: [
|
|
18
|
+
{ kind: 'fields', fields: [{ label: 'Status', value: 'Accepted' }] },
|
|
19
|
+
{ kind: 'image-gallery', images: [{ id: 'image', title: 'Plan', file: { viewKey: 'results', fileKey: 'image', targetId: 'version' } }] },
|
|
20
|
+
{ kind: 'file-list', files: [{ id: 'file', title: 'Report', description: 'PDF', file: { viewKey: 'results', fileKey: 'report', targetId: 'version' } }] },
|
|
21
|
+
],
|
|
22
|
+
};
|
|
23
|
+
const data = { version: 1, threadId: 'thread', runs: [], cards: [{ type: 'resource_card', id: 'card', data: card }] };
|
|
6
24
|
const fetch = vi.fn().mockResolvedValue(new Response(`id: snapshot-1\nevent: thread.snapshot\ndata: ${JSON.stringify(data)}\n\n`, { headers: { 'content-type': 'text/event-stream' } }));
|
|
7
25
|
const client = new Client({ apiUrl: 'https://xpert.example/api/ai', callerOptions: { fetch } });
|
|
8
26
|
const controller = new AbortController();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"thread-activity.test.js","sourceRoot":"","sources":["../../src/tests/thread-activity.test.ts"],"names":[],"mappings":"OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ;OAC1C,EAAE,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"thread-activity.test.js","sourceRoot":"","sources":["../../src/tests/thread-activity.test.ts"],"names":[],"mappings":"OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ;OAC1C,EAAE,MAAM,EAA2F;AAE1G,MAAM,WAAW,GAA6B;IAC5C,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAChD,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;IACzE,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE;IACxF;QACE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS;QACpF,WAAW,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE;KAChF;CACF,CAAC;AAEF,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,gFAAgF,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACpH,MAAM,IAAI,GAA6B;YACrC,QAAQ,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE;YAC/D,KAAK,EAAE,SAAS,EAAE,IAAI;YACtB,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE;gBACpE,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE;gBACxI,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE;aAC1J;SACF,CAAC;QACF,MAAM,IAAI,GAA2B,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9I,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,EAA2B,CAAC,iBAAiB,CAAC,IAAI,QAAQ,CAC3E,iDAAiD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAC3E,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,mBAAmB,EAAE,EAAE,CACrD,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAChG,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5I,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAE,GAAW,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QACpE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3E,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,8 +1,26 @@
|
|
|
1
1
|
import { describe, expect, it, vi } from 'vitest';
|
|
2
2
|
import { Client } from "../index.mjs";
|
|
3
|
+
const openTargets = [
|
|
4
|
+
{ target: 'workbench.view', viewKey: 'results' },
|
|
5
|
+
{ target: 'assistant.project', viewKey: 'results', projectId: 'project' },
|
|
6
|
+
{ target: 'workbench.file', viewKey: 'results', fileKey: 'export', targetId: 'version' },
|
|
7
|
+
{
|
|
8
|
+
target: 'workbench.file', viewKey: 'results', fileKey: 'export', targetId: 'version',
|
|
9
|
+
previewFile: { viewKey: 'results', fileKey: 'export-pdf', targetId: 'version' },
|
|
10
|
+
},
|
|
11
|
+
];
|
|
3
12
|
describe('thread activity subscriptions', () => {
|
|
4
|
-
it('
|
|
5
|
-
const
|
|
13
|
+
it.each(openTargets)('preserves $target cards in abortable activity snapshots with a separate cursor', async (open) => {
|
|
14
|
+
const card = {
|
|
15
|
+
resource: { namespace: 'plugin', type: 'report', id: 'report' },
|
|
16
|
+
title: 'Results', open,
|
|
17
|
+
content: [
|
|
18
|
+
{ kind: 'fields', fields: [{ label: 'Status', value: 'Accepted' }] },
|
|
19
|
+
{ kind: 'image-gallery', images: [{ id: 'image', title: 'Plan', file: { viewKey: 'results', fileKey: 'image', targetId: 'version' } }] },
|
|
20
|
+
{ kind: 'file-list', files: [{ id: 'file', title: 'Report', description: 'PDF', file: { viewKey: 'results', fileKey: 'report', targetId: 'version' } }] },
|
|
21
|
+
],
|
|
22
|
+
};
|
|
23
|
+
const data = { version: 1, threadId: 'thread', runs: [], cards: [{ type: 'resource_card', id: 'card', data: card }] };
|
|
6
24
|
const fetch = vi.fn().mockResolvedValue(new Response(`id: snapshot-1\nevent: thread.snapshot\ndata: ${JSON.stringify(data)}\n\n`, { headers: { 'content-type': 'text/event-stream' } }));
|
|
7
25
|
const client = new Client({ apiUrl: 'https://xpert.example/api/ai', callerOptions: { fetch } });
|
|
8
26
|
const controller = new AbortController();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"thread-activity.test.mjs","sourceRoot":"","sources":["../../src/tests/thread-activity.test.ts"],"names":[],"mappings":"OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ;OAC1C,EAAE,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"thread-activity.test.mjs","sourceRoot":"","sources":["../../src/tests/thread-activity.test.ts"],"names":[],"mappings":"OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ;OAC1C,EAAE,MAAM,EAA2F;AAE1G,MAAM,WAAW,GAA6B;IAC5C,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE;IAChD,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE;IACzE,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE;IACxF;QACE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS;QACpF,WAAW,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE;KAChF;CACF,CAAC;AAEF,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,gFAAgF,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACpH,MAAM,IAAI,GAA6B;YACrC,QAAQ,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE;YAC/D,KAAK,EAAE,SAAS,EAAE,IAAI;YACtB,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE;gBACpE,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE;gBACxI,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE;aAC1J;SACF,CAAC;QACF,MAAM,IAAI,GAA2B,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9I,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,EAA2B,CAAC,iBAAiB,CAAC,IAAI,QAAQ,CAC3E,iDAAiD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAC3E,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,mBAAmB,EAAE,EAAE,CACrD,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAChG,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5I,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAE,GAAW,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QACpE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3E,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|