@xpert-ai/plugin-live-dashboard 0.4.0 → 0.5.0

package/dist/lib/view.provider.d.ts

@@ -1,8 +1,9 @@
 import { DashboardProjectsService } from './projects.service';
-import type { XpertExtensionViewManifest, XpertResolvedViewHostContext, XpertViewActionRequest, XpertViewQuery } from '@xpert-ai/contracts';
-import { type IXpertViewExtensionProvider } from '@xpert-ai/plugin-sdk';
+import type { XpertExtensionViewManifest, XpertResolvedViewHostContext, XpertViewActionRequest, XpertViewQuery, XpertViewFileAccessRequest } from '@xpert-ai/contracts';
+import { type IXpertViewExtensionProvider, type XpertViewFileActionFile } from '@xpert-ai/plugin-sdk';
 import { DashboardService } from './dashboard.service';
 import { DashboardSharingService } from './sharing.service';
+import { DashboardArchiveService } from './archive.service';
 export declare const VIEW_KEY = "live-dashboard";
 export declare const VIEW_PROVIDER = "live-dashboard";
 export declare const FEATURE = "live_dashboard";
@@ -10,7 +11,8 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
     private readonly service;
     private readonly sharing;
     private readonly projects;
-    constructor(service: DashboardService, sharing: DashboardSharingService, projects: DashboardProjectsService);
+    private readonly archives;
+    constructor(service: DashboardService, sharing: DashboardSharingService, projects: DashboardProjectsService, archives: DashboardArchiveService);
     supports(context: XpertResolvedViewHostContext): boolean;
     getViewManifests(context: XpertResolvedViewHostContext, slot: string): XpertExtensionViewManifest[];
     getRemoteComponentEntry(): Promise<{
@@ -33,12 +35,21 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
             dashboards: {
                 title: string | null | undefined;
                 draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
                 canDelete: boolean;
                 artifactId: string;
                 versionId: string | null | undefined;
                 versionNumber: number | undefined;
-                updatedAt: string | Date | undefined;
             }[];
+            selectedDashboard: {
+                title: string | null | undefined;
+                draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
+                canDelete: boolean;
+                artifactId: string;
+                versionId: string | null | undefined;
+                versionNumber: number | undefined;
+            } | undefined;
             pagination: {
                 page: number;
                 pageSize: number;
@@ -48,9 +59,9 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
         } | {
             saved: {
                 manifest: {
-                    schema: "xpert.live-dashboard";
-                    id: string;
                     title: string;
+                    id: string;
+                    schema: "xpert.live-dashboard";
                     bindings: import("@xpert-ai/contracts").AnalyticsBinding[];
                     controls: {
                         type: "string" | "number" | "boolean" | "date";
@@ -60,20 +71,35 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
                         allowedValues?: (string | number | boolean | null)[] | undefined;
                     }[];
                     charts: {
+                        title: string;
                         type: "bar" | "line" | "area" | "pie" | "scatter";
                         id: string;
-                        title: string;
                         datasetId: string;
                         x: string;
                         y: string;
                         color?: string | undefined;
                     }[];
                     tables: {
-                        id: string;
                         title: string;
+                        id: string;
                         datasetId: string;
                         fields: string[];
                     }[];
+                    sourceMetadata?: {
+                        bindingId: string;
+                        title: string;
+                        description?: string | undefined;
+                    }[] | undefined;
+                    components?: {
+                        title: string;
+                        id: string;
+                        elementId: string;
+                        kind: "filter" | "metric" | "chart" | "table" | "text";
+                        sources: {
+                            bindingId: string;
+                            fieldIds?: string[] | undefined;
+                        }[];
+                    }[] | undefined;
                     presentation?: {
                         type: "html";
                         html: string;
@@ -91,7 +117,7 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
                 artifactId: string;
                 versionId: string | null | undefined;
                 versionNumber: number | undefined;
-            };
+            } | undefined;
             versions: {
                 current: boolean;
                 artifactId: string;
@@ -113,12 +139,21 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
             dashboards: {
                 title: string | null | undefined;
                 draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
                 canDelete: boolean;
                 artifactId: string;
                 versionId: string | null | undefined;
                 versionNumber: number | undefined;
-                updatedAt: string | Date | undefined;
             }[];
+            selectedDashboard: {
+                title: string | null | undefined;
+                draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
+                canDelete: boolean;
+                artifactId: string;
+                versionId: string | null | undefined;
+                versionNumber: number | undefined;
+            } | undefined;
             pagination: {
                 page: number;
                 pageSize: number;
@@ -139,12 +174,21 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
             dashboards: {
                 title: string | null | undefined;
                 draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
                 canDelete: boolean;
                 artifactId: string;
                 versionId: string | null | undefined;
                 versionNumber: number | undefined;
-                updatedAt: string | Date | undefined;
             }[];
+            selectedDashboard: {
+                title: string | null | undefined;
+                draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
+                canDelete: boolean;
+                artifactId: string;
+                versionId: string | null | undefined;
+                versionNumber: number | undefined;
+            } | undefined;
             pagination: {
                 page: number;
                 pageSize: number;
@@ -154,16 +198,28 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
         };
     }>;
     executeViewAction(context: XpertResolvedViewHostContext, viewKey: string, action: string, request: XpertViewActionRequest): Promise<{
+        success: boolean;
+        data: import("@xpert-ai/contracts").AnalyticsDiscoveryResult;
+        refresh: boolean;
+    } | {
         success: boolean;
         data: {
+            discarded: boolean;
+        };
+        refresh: boolean;
+    } | {
+        success: boolean;
+        data: {
+            canEdit: boolean;
+            mode: string;
             items: {
                 title: string | null | undefined;
                 draftRevision?: number | undefined;
+                updatedAt: string | Date | undefined;
                 canDelete: boolean;
                 artifactId: string;
                 versionId: string | null | undefined;
                 versionNumber: number | undefined;
-                updatedAt: string | Date | undefined;
             }[];
             page: number;
             hasMore: boolean;
@@ -210,9 +266,152 @@ export declare class DashboardViewProvider implements IXpertViewExtensionProvide
             artifactId: string;
         };
         refresh: boolean;
+    } | {
+        success: boolean;
+        data: {
+            payload?: {
+                ok: boolean;
+                widget_type: string;
+                surface: string;
+                sources: never[];
+                manifest: {
+                    version: number;
+                    surface: string;
+                    title: string;
+                    cards: never[];
+                    filters: never[];
+                    sources: never[];
+                    charts: {
+                        id: string;
+                        title: string;
+                        type: "bar" | "line" | "area" | "pie" | "scatter";
+                        dataset: string;
+                        encodings: {
+                            color?: {
+                                field: string;
+                            } | undefined;
+                            x: {
+                                field: string;
+                            };
+                            y: {
+                                field: string;
+                            };
+                        };
+                    }[];
+                    tables: {
+                        id: string;
+                        title: string;
+                        dataset: string;
+                        columns: {
+                            field: string;
+                            label: string;
+                        }[];
+                    }[];
+                    blocks: ({
+                        id: string;
+                        type: string;
+                        chartId: string;
+                    } | {
+                        id: string;
+                        type: string;
+                        tableId: string;
+                    })[];
+                };
+                snapshot: {
+                    version: number;
+                    generatedAt: string;
+                    status: string;
+                    datasets: any;
+                };
+            } | undefined;
+            datasets: import("@xpert-ai/contracts").AnalyticalDataset[];
+            failures: {
+                bindingId: string;
+                datasetId: string;
+                reason: "unavailable";
+            }[];
+        };
+        refresh: boolean;
     } | {
         success: boolean;
         data: import("@xpert-ai/contracts").AnalyticalDataset;
         refresh: boolean;
     }>;
+    executeViewFileAction(context: XpertResolvedViewHostContext, viewKey: string, action: string, _request: XpertViewActionRequest, file: XpertViewFileActionFile): Promise<{
+        success: boolean;
+        data: {
+            importId: `${string}-${string}-${string}-${string}-${string}`;
+            manifest: {
+                title: string;
+                id: string;
+                schema: "xpert.live-dashboard";
+                bindings: import("@xpert-ai/contracts").AnalyticsBinding[];
+                controls: {
+                    type: "string" | "number" | "boolean" | "date";
+                    controlId: string;
+                    label: string;
+                    defaultValue?: string | number | boolean | null | undefined;
+                    allowedValues?: (string | number | boolean | null)[] | undefined;
+                }[];
+                charts: {
+                    title: string;
+                    type: "bar" | "line" | "area" | "pie" | "scatter";
+                    id: string;
+                    datasetId: string;
+                    x: string;
+                    y: string;
+                    color?: string | undefined;
+                }[];
+                tables: {
+                    title: string;
+                    id: string;
+                    datasetId: string;
+                    fields: string[];
+                }[];
+                sourceMetadata?: {
+                    bindingId: string;
+                    title: string;
+                    description?: string | undefined;
+                }[] | undefined;
+                components?: {
+                    title: string;
+                    id: string;
+                    elementId: string;
+                    kind: "filter" | "metric" | "chart" | "table" | "text";
+                    sources: {
+                        bindingId: string;
+                        fieldIds?: string[] | undefined;
+                    }[];
+                }[] | undefined;
+                presentation?: {
+                    type: "html";
+                    html: string;
+                    dependencies?: import("@xpert-ai/plugin-sdk/artifact-document").ArtifactDocumentDependencyLock[] | undefined;
+                } | undefined;
+            };
+            requirements: {
+                schema: string;
+                version: number;
+                bindings: {
+                    id: string;
+                    providerId: string;
+                    operation: string;
+                    contractVersion: number;
+                    source: import("@xpert-ai/contracts").AnalyticsSourceRef;
+                }[];
+                externalResources: string[];
+                dynamicResourcesMayExist: boolean;
+                includesQueryResults: boolean;
+                requiresAuthorizedHost: boolean;
+            };
+            sources: import("@xpert-ai/contracts").AnalyticsSourceSummary[];
+        };
+        refresh: boolean;
+    }>;
+    resolveViewFile(context: XpertResolvedViewHostContext, viewKey: string, request: XpertViewFileAccessRequest): Promise<{
+        reference: import("@xpert-ai/plugin-sdk").WorkspacePortableFileReference;
+        fileName: string;
+        mimeType: string;
+        size: number;
+    }>;
 }

package/dist/lib/view.provider.js

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DashboardViewProvider = exports.FEATURE = exports.VIEW_PROVIDER = exports.VIEW_KEY = void 0;
 const projects_service_1 = require("./projects.service");
+const projects_schema_1 = require("./projects.schema");
 const common_1 = require("@nestjs/common");
 const v3_1 = require("zod/v3");
 const contracts_1 = require("@xpert-ai/contracts");
@@ -23,15 +24,18 @@ const dashboard_receipt_1 = require("./dashboard-receipt");
 const dashboard_navigation_1 = require("./dashboard-navigation");
 const project_1 = require("./project");
 const dashboard_icon_1 = require("./dashboard-icon");
+const dashboard_sources_1 = require("./dashboard-sources");
+const archive_service_1 = require("./archive.service");
 exports.VIEW_KEY = 'live-dashboard';
 exports.VIEW_PROVIDER = 'live-dashboard';
 exports.FEATURE = 'live_dashboard';
 const text = (en_US, zh_Hans) => ({ en_US, zh_Hans });
 let DashboardViewProvider = class DashboardViewProvider {
-    constructor(service, sharing, projects) {
+    constructor(service, sharing, projects, archives) {
         this.service = service;
         this.sharing = sharing;
         this.projects = projects;
+        this.archives = archives;
     }
     supports(context) { return context.hostType === 'agent'; }
     getViewManifests(context, slot) {
@@ -43,6 +47,7 @@ let DashboardViewProvider = class DashboardViewProvider {
                 workbench: { projectType: project_1.DASHBOARD_PROJECT_TYPE, fixed: true, openMode: 'on-demand', menu: { enabled: true, label: text('Live dashboards', '实时看板'), icon: dashboard_icon_1.dashboardIcon, order: 35 } },
                 view: { type: 'remote_component', runtime: 'react', protocolVersion: 1, component: { isolation: 'iframe', entry: exports.VIEW_KEY }, dataSource: { mode: 'platform' } },
                 dataSource: { mode: 'platform', querySchema: { supportsSelection: true, supportsParameters: true, supportsPagination: true, defaultPageSize: 50 }, cache: { enabled: false } },
+                fileAccess: { purposes: ['download'] },
                 clientCommands: [{ key: 'workbench.content.status' }, { key: 'workbench.content.resolve' }, { key: contracts_1.ASSISTANT_CONTEXT_SET_COMMAND, label: text('Select dashboard for Assistant', '设置助理当前看板') },
                     { key: contracts_1.ASSISTANT_CHAT_SEND_MESSAGE_COMMAND, label: text('Create with Assistant', '交给助理制作') },
                     { key: contracts_1.ARTIFACT_PRESENTATION_OPEN_COMMAND, label: text('Open shared page', '打开独立页面') },
@@ -50,6 +55,8 @@ let DashboardViewProvider = class DashboardViewProvider {
                 hostEvents: { subscriptions: [{ key: 'dashboard-created', event: 'assistant.tool.completed',
                             filter: { toolNames: dashboard_receipt_1.DASHBOARD_MUTATION_TOOLS }, action: { type: 'forward', debounceMs: 0 } }] },
                 actions: [
+                    { key: 'import-preview', label: text('Import dashboard file', '导入看板文件'), actionType: 'invoke', transport: 'file' },
+                    ...['import-commit', 'import-discard', 'import-browse'].map(key => ({ key, label: text('Import dashboard', '导入看板'), actionType: 'invoke' })),
                     ...[
                         { key: 'dashboards', label: text('Select dashboard', '选择看板') },
                         { key: 'projects', label: text('Select project', '选择项目') },
@@ -74,22 +81,35 @@ let DashboardViewProvider = class DashboardViewProvider {
         if (mode === 'draft' && !access.canReadDraft)
             throw new common_1.ForbiddenException('DASHBOARD_DRAFT_ACCESS_DENIED');
         const page = await this.service.listPage(context, params.page, params.pageSize);
+        const selectedDashboard = params.artifactId
+            ? page.items.find(item => item.artifactId === params.artifactId) ?? await this.service.selectedSummary(context, params.artifactId)
+            : undefined;
         const versions = params.artifactId ? await this.service.history(context, params.artifactId) : undefined;
         const unavailable = params.artifactId && mode === 'published' && !params.versionId && !versions?.some(version => version.current);
+        const saved = !unavailable && params.artifactId ? await this.service.openDocument(context, params.artifactId, params.versionId, params.draftRevision, mode) : undefined;
         return { meta: { navigationTarget: (0, dashboard_navigation_1.dashboardNavigationTarget)(context), access, mode, currentProject,
-                dashboards: page.items, pagination: { page: page.page, pageSize: page.pageSize, hasMore: page.hasMore },
+                dashboards: page.items, selectedDashboard, pagination: { page: page.page, pageSize: page.pageSize, hasMore: page.hasMore },
                 sources: access.canEdit ? await this.service.sources(context) : [],
                 ...(unavailable ? { notice: 'not_published' } : params.artifactId ? {
-                    saved: await this.service.openDocument(context, params.artifactId, params.versionId, params.draftRevision, mode), versions
+                    saved: saved && { ...saved, manifest: access.canEdit ? saved.manifest : (0, dashboard_sources_1.publicDashboardManifest)(saved.manifest) }, versions
                 } : {}) } };
     }
     async executeViewAction(context, viewKey, action, request) {
         assertView(viewKey);
+        if (action === 'import-commit')
+            return { success: true, data: await this.archives.commit(context, archive_service_1.importInputSchema.parse(request.input)), refresh: false };
+        if (action === 'import-browse')
+            return { success: true, data: await this.archives.browse(context, archive_service_1.importBrowseSchema.parse(request.input)), refresh: false };
+        if (action === 'import-discard')
+            return { success: true, data: await this.archives.discard(context, v3_1.z.object({ importId: v3_1.z.string().uuid() }).strict().parse(request.input).importId), refresh: false };
         if (action === 'dashboards') {
-            const parsed = projects_service_1.projectSearchSchema.safeParse(request.input);
+            const parsed = projects_schema_1.dashboardSearchSchema.safeParse(request.input);
             if (!parsed.success)
                 throw new common_1.BadRequestException('DASHBOARD_INVALID_PICKER_QUERY');
-            return { success: true, data: await this.service.searchPage(context, parsed.data), refresh: false };
+            const target = parsed.data.projectId ? await this.projects.pickerContext(context, parsed.data.projectId) : context;
+            const page = await this.service.searchPage(target, parsed.data);
+            const access = await this.service.access(target);
+            return { success: true, data: { ...page, canEdit: access.canEdit, mode: access.canReadDraft ? 'draft' : 'published' }, refresh: false };
         }
         if (action === 'projects')
             return { success: true, data: await this.projects.list(context, projects_service_1.projectSearchSchema.parse(request.input)), refresh: false };
@@ -100,11 +120,12 @@ let DashboardViewProvider = class DashboardViewProvider {
             return { success: true, data: action === 'share-status' ? await this.sharing.inspect(context, input.artifactId, input.versionId) : await this.sharing.revoke(context, input.artifactId), refresh: false };
         }
         if (action === 'delete') {
-            const parsed = v3_1.z.object({ artifactId: v3_1.z.string().uuid(), expectedRevision: v3_1.z.number().int().positive(), confirmed: v3_1.z.literal(true) }).strict().safeParse(request.input);
+            const parsed = v3_1.z.object({ artifactId: v3_1.z.string().uuid(), expectedRevision: v3_1.z.number().int().positive(), confirmed: v3_1.z.literal(true), projectId: v3_1.z.string().uuid().optional() }).strict().safeParse(request.input);
             if (!parsed.success)
                 throw new common_1.BadRequestException('DASHBOARD_DELETION_CONFIRMATION_REQUIRED');
             const input = parsed.data;
-            return { success: true, data: await this.service.trash(context, input.artifactId, input.expectedRevision), refresh: false };
+            const target = input.projectId ? await this.projects.pickerContext(context, input.projectId) : context;
+            return { success: true, data: await this.service.trash(target, input.artifactId, input.expectedRevision), refresh: false };
         }
         if (action === 'publish') {
             const parsed = v3_1.z.object({ artifactId: v3_1.z.string().uuid(), expectedRevision: v3_1.z.number().int().positive(),
@@ -120,7 +141,8 @@ let DashboardViewProvider = class DashboardViewProvider {
         }
         if (action === 'query') {
             const input = dashboard_schema_1.querySchema.parse(request.input);
-            return { success: true, data: await this.service.query(context, input.artifactId, input.versionId, input.controls, input.draftRevision), refresh: false };
+            const result = await this.service.query(context, input.artifactId, input.versionId, input.controls, input.draftRevision);
+            return { success: true, data: { datasets: result.datasets, failures: result.failures, ...('payload' in result ? { payload: result.payload } : {}) }, refresh: false };
         }
         if (action === 'query-binding') {
             const parsed = dashboard_schema_1.queryBindingSchema.safeParse(request.input);
@@ -131,11 +153,23 @@ let DashboardViewProvider = class DashboardViewProvider {
         }
         throw new common_1.BadRequestException('DASHBOARD_ACTION_UNSUPPORTED');
     }
+    async executeViewFileAction(context, viewKey, action, _request, file) {
+        assertView(viewKey);
+        if (action !== 'import-preview')
+            throw new common_1.BadRequestException('DASHBOARD_ACTION_UNSUPPORTED');
+        return { success: true, data: await this.archives.prepare(context, file.buffer), refresh: false };
+    }
+    async resolveViewFile(context, viewKey, request) {
+        assertView(viewKey);
+        if (request.purpose !== 'download')
+            throw new common_1.ForbiddenException('DASHBOARD_ACTION_UNSUPPORTED');
+        return this.archives.exportFile(context, request.fileKey);
+    }
 };
 exports.DashboardViewProvider = DashboardViewProvider;
 exports.DashboardViewProvider = DashboardViewProvider = __decorate([
     (0, plugin_sdk_1.ViewExtensionProvider)(exports.VIEW_PROVIDER),
-    __metadata("design:paramtypes", [dashboard_service_1.DashboardService, sharing_service_1.DashboardSharingService, projects_service_1.DashboardProjectsService])
+    __metadata("design:paramtypes", [dashboard_service_1.DashboardService, sharing_service_1.DashboardSharingService, projects_service_1.DashboardProjectsService, archive_service_1.DashboardArchiveService])
 ], DashboardViewProvider);
 function assertView(key) { if (key !== exports.VIEW_KEY)
     throw new common_1.BadRequestException('DASHBOARD_VIEW_UNSUPPORTED'); }