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

package/dist/lib/dashboard.schema.js

@@ -4,10 +4,13 @@ exports.queryBindingSchema = exports.querySchema = exports.saveSchema = exports.
 const v3_1 = require("zod/v3");
 const analytics_1 = require("@xpert-ai/plugin-sdk/analytics");
 const artifact_document_1 = require("@xpert-ai/plugin-sdk/artifact-document");
+const dashboard_sources_1 = require("./dashboard-sources");
 const id = v3_1.z.string().regex(/^[A-Za-z][A-Za-z0-9_.-]{0,79}$/);
 exports.dashboardSchema = v3_1.z.object({
     schema: v3_1.z.literal('xpert.live-dashboard'), id: v3_1.z.string().uuid(), title: v3_1.z.string().min(1).max(160),
     bindings: v3_1.z.array(analytics_1.analyticsBindingSchema).max(8),
+    sourceMetadata: dashboard_sources_1.sourceMetadataSchema.optional(),
+    components: dashboard_sources_1.dashboardComponentsSchema.optional(),
     presentation: v3_1.z.object({ type: v3_1.z.literal('html'), html: artifact_document_1.artifactDocumentHtml, dependencies: artifact_document_1.artifactDocumentDependencyLocks.optional() }).strict().optional(),
     controls: v3_1.z.array(v3_1.z.object({ controlId: id, type: v3_1.z.enum(['string', 'number', 'boolean', 'date']),
         defaultValue: v3_1.z.union([v3_1.z.string(), v3_1.z.number(), v3_1.z.boolean(), v3_1.z.null()]).optional(),
@@ -25,6 +28,20 @@ exports.dashboardSchema = v3_1.z.object({
         ctx.addIssue({ code: 'custom', message: 'An unconfigured draft must contain no views or controls' });
     unique(manifest.bindings.map((binding) => binding.id), 'binding');
     unique(manifest.bindings.map((binding) => binding.output.datasetId), 'dataset');
+    unique((manifest.sourceMetadata ?? []).map(item => item.bindingId), 'source metadata');
+    unique((manifest.components ?? []).map(item => item.id), 'component');
+    unique((manifest.components ?? []).map(item => item.elementId), 'component element');
+    for (const metadata of manifest.sourceMetadata ?? [])
+        if (!manifest.bindings.some(binding => binding.id === metadata.bindingId))
+            ctx.addIssue({ code: 'custom', message: 'Source metadata references an undeclared Binding' });
+    for (const component of manifest.components ?? []) {
+        unique(component.sources.map(source => source.bindingId), 'component source');
+        for (const source of component.sources) {
+            const binding = manifest.bindings.find(item => item.id === source.bindingId);
+            if (!binding || source.fieldIds?.some(field => !binding.output.fields.some(item => item.id === field)))
+                ctx.addIssue({ code: 'custom', message: 'Component references an undeclared Binding or field' });
+        }
+    }
     unique(manifest.controls.map((control) => control.controlId), 'control');
     unique([...manifest.charts, ...manifest.tables].map((view) => view.id), 'view');
     if (manifest.bindings.length && !manifest.presentation && !manifest.charts.length && !manifest.tables.length)
@@ -68,7 +85,7 @@ exports.dashboardSchema = v3_1.z.object({
 });
 /** Updates never choose identity or source scope; those come from the authorized saved version. */
 exports.dashboardChangesSchema = exports.dashboardSchema.innerType().pick({ title: true, bindings: true,
-    controls: true, charts: true, tables: true, presentation: true }).partial().strict();
+    controls: true, charts: true, tables: true, presentation: true, sourceMetadata: true, components: true }).partial().strict();
 exports.controlsSchema = v3_1.z.record(v3_1.z.union([v3_1.z.string().max(4000), v3_1.z.number().finite(), v3_1.z.boolean(), v3_1.z.null()]));
 exports.saveSchema = v3_1.z.object({ manifest: exports.dashboardSchema, expectedVersionId: v3_1.z.string().uuid().nullable(), expectedRevision: v3_1.z.number().int().nonnegative().default(0) }).strict();
 exports.querySchema = v3_1.z.object({ artifactId: v3_1.z.string().uuid(), versionId: v3_1.z.string().uuid().optional(), draftRevision: v3_1.z.number().int().positive().optional(), controls: exports.controlsSchema.default({}) }).strict();

package/dist/lib/dashboard.service.d.ts

@@ -1,6 +1,7 @@
 import type { AnalyticsValue, AnalyticsDiscoveryRequest, AnalyticsQueryRequest, XpertResolvedViewHostContext } from '@xpert-ai/contracts';
 import { type RuntimeCapabilityRegistry } from '@xpert-ai/plugin-sdk';
 import { type DashboardManifest, type DashboardChanges } from './dashboard.schema';
+import { type ArtifactDocumentDependencyAsset } from '@xpert-ai/plugin-sdk/artifact-document';
 import { HtmlDashboardValidation } from './html-validation';
 import type { DashboardAccess, DashboardMode } from './project';
 export declare const PLUGIN_NAME = "@xpert-ai/plugin-live-dashboard";
@@ -14,11 +15,11 @@ export declare class DashboardService {
     list(context: XpertResolvedViewHostContext): Promise<{
         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;
     }[]>;
     access(context: XpertResolvedViewHostContext): Promise<DashboardAccess>;
     listPage(context: XpertResolvedViewHostContext, page?: number, pageSize?: number): Promise<{
@@ -28,11 +29,11 @@ export declare class DashboardService {
         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;
         }[];
     }>;
     searchPage(context: XpertResolvedViewHostContext, input: {
@@ -42,19 +43,28 @@ export declare class DashboardService {
         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;
     }>;
+    selectedSummary(context: XpertResolvedViewHostContext, artifactId: string): Promise<{
+        title: string | null | undefined;
+        draftRevision?: number | undefined;
+        canDelete: boolean;
+        artifactId: string;
+        versionId: string | null | undefined;
+        versionNumber: number | undefined;
+        updatedAt: string | Date | undefined;
+    } | undefined>;
     trash(context: XpertResolvedViewHostContext, artifactId: string, expectedRevision: number): Promise<{
         artifactId: string;
     }>;
-    save(context: XpertResolvedViewHostContext, manifest: DashboardManifest, expectedVersionId: string | null, expectedRevision?: number): Promise<{
+    save(context: XpertResolvedViewHostContext, manifest: DashboardManifest, expectedVersionId: string | null, expectedRevision?: number, importedDependencies?: ArtifactDocumentDependencyAsset[]): Promise<{
         artifactId: string;
         draftId: string;
         draftRevision: number;
@@ -64,9 +74,9 @@ export declare class DashboardService {
     }>;
     open(context: XpertResolvedViewHostContext, artifactId: string, versionId?: string, draftRevision?: number, mode?: DashboardMode): Promise<{
         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";
@@ -76,20 +86,35 @@ export declare class DashboardService {
                 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;
@@ -110,9 +135,9 @@ export declare class DashboardService {
     /** Trusted View transport only. Agent read tools receive locks, never megabytes of library code. */
     openDocument(context: XpertResolvedViewHostContext, artifactId: string, versionId?: string, draftRevision?: number, mode?: DashboardMode): Promise<{
         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";
@@ -122,27 +147,42 @@ export declare class DashboardService {
                 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;
                 dependencies?: import("@xpert-ai/plugin-sdk/artifact-document").ArtifactDocumentDependencyLock[] | undefined;
             } | undefined;
         };
-        dependencies: import("@xpert-ai/plugin-sdk/artifact-document").ArtifactDocumentDependencyAsset[];
+        dependencies: ArtifactDocumentDependencyAsset[];
         contentHash: string;
         draftId?: string | undefined;
         draftRevision?: number | undefined;
@@ -241,9 +281,9 @@ export declare class DashboardService {
             reason: "unavailable";
         }[];
         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";
@@ -253,20 +293,35 @@ export declare class DashboardService {
                 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;

package/dist/lib/dashboard.service.js

@@ -18,6 +18,8 @@ const common_1 = require("@nestjs/common");
 const node_crypto_1 = require("node:crypto");
 const plugin_sdk_1 = require("@xpert-ai/plugin-sdk");
 const dashboard_schema_1 = require("./dashboard.schema");
+const source_validation_1 = require("./source-validation");
+const artifact_document_1 = require("@xpert-ai/plugin-sdk/artifact-document");
 const renderer_1 = require("./renderer");
 const dashboard_queries_1 = require("./dashboard-queries");
 const html_validation_1 = require("./html-validation");
@@ -59,7 +61,7 @@ let DashboardService = class DashboardService {
         return { page, pageSize, hasMore: page * pageSize < result.total, items: items.filter(item => access.canReadDraft || !!item.currentVersionId).map(item => {
                 const draft = drafts.get(item.id);
                 return { ...summary(item), canDelete: !!draft && access.canManage,
-                    ...(draft ? { title: draft.title ?? item.title, draftRevision: draft.revision } : {}) };
+                    ...(draft ? { title: draft.title ?? item.title, draftRevision: draft.revision, updatedAt: draft.updatedAt ?? item.updatedAt } : {}) };
             }) };
     }
     async searchPage(context, input) {
@@ -76,6 +78,18 @@ let DashboardService = class DashboardService {
         }
         return { items: matches.slice(offset, offset + pageSize), page: input.page, hasMore: matches.length > offset + pageSize };
     }
+    async selectedSummary(context, artifactId) {
+        const access = await this.access(context);
+        const artifact = await this.runtime.require(plugin_sdk_1.ArtifactsRuntimeCapability).getArtifact(artifactId);
+        assertOwned(context, artifact);
+        if (artifact.status !== 'active')
+            throw new common_1.ForbiddenException('DASHBOARD_ARCHIVED');
+        if (!access.canReadDraft && !artifact.currentVersionId)
+            return undefined;
+        const draft = access.canReadDraft ? (await this.runtime.require(plugin_sdk_1.ArtifactDraftsRuntimeCapability).list([artifactId]))[0] : undefined;
+        return { ...summary(artifact), canDelete: !!draft && access.canManage,
+            ...(draft ? { title: draft.title ?? artifact.title, draftRevision: draft.revision } : {}) };
+    }
     async trash(context, artifactId, expectedRevision) {
         await this.authorizeProject(context, 'manage');
         const artifact = await this.runtime.require(plugin_sdk_1.ArtifactsRuntimeCapability).getArtifact(artifactId);
@@ -86,10 +100,11 @@ let DashboardService = class DashboardService {
         await this.runtime.require(plugin_sdk_1.ArtifactDraftsRuntimeCapability).setRecycled({ artifactId, expectedRevision, recycled: true });
         return { artifactId };
     }
-    async save(context, manifest, expectedVersionId, expectedRevision = 0) {
+    async save(context, manifest, expectedVersionId, expectedRevision = 0, importedDependencies) {
         await this.authorizeProject(context, 'write');
         const scopedActor = actor(context);
         const parsed = dashboard_schema_1.dashboardSchema.parse(manifest);
+        (0, source_validation_1.assertComponentElements)(parsed);
         const artifacts = this.runtime.require(plugin_sdk_1.ArtifactsRuntimeCapability);
         const source = { pluginName: exports.PLUGIN_NAME, resourceType: RESOURCE_TYPE, resourceId: `${hostPrefix(context)}${parsed.id}` };
         const existing = await artifacts.findArtifactBySource(source);
@@ -100,7 +115,10 @@ let DashboardService = class DashboardService {
         }
         // A failed first upload can leave an Artifact with no saved content; revision 0 initializes it.
         const previous = existing && (existing.currentVersionId || expectedRevision > 0) ? await this.openDocument(context, existing.id) : null;
-        const dependencies = await (0, document_libraries_1.resolveLibraryAssets)(parsed.presentation?.dependencies ?? [], previous?.dependencies);
+        if (importedDependencies && existing)
+            throw new common_1.BadRequestException('DASHBOARD_IMPORT_NEW_ID_REQUIRED');
+        const dependencies = importedDependencies ? (0, artifact_document_1.verifyArtifactDocumentDependencies)(importedDependencies, parsed.presentation?.dependencies ?? [])
+            : await (0, document_libraries_1.resolveLibraryAssets)(parsed.presentation?.dependencies ?? [], previous?.dependencies);
         const buffer = (0, document_package_1.encodeDashboardPackage)(parsed, dependencies);
         if (buffer.byteLength > document_package_1.MAX_DASHBOARD_PACKAGE_BYTES)
             throw new common_1.BadRequestException('DASHBOARD_MANIFEST_TOO_LARGE');

package/dist/lib/document-package.d.ts

@@ -5,9 +5,9 @@ export declare const MAX_DASHBOARD_PACKAGE_BYTES = 9000000;
 export declare function encodeDashboardPackage(manifest: DashboardManifest, dependencies: ArtifactDocumentDependencyAsset[]): Buffer<ArrayBuffer>;
 export declare function decodeDashboardPackage(bytes: Buffer): {
     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";
@@ -17,20 +17,35 @@ export declare function decodeDashboardPackage(bytes: Buffer): {
             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;

package/dist/lib/editing-patch.d.ts

@@ -5,16 +5,19 @@ export declare const removalsSchema: z.ZodOptional<z.ZodObject<{
     controlIds: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
     viewIds: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
     htmlElementIds: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    componentIds: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
 }, "strict", z.ZodTypeAny, {
     bindingIds: string[];
     controlIds: string[];
     viewIds: string[];
     htmlElementIds: string[];
+    componentIds: string[];
 }, {
     bindingIds?: string[] | undefined;
     controlIds?: string[] | undefined;
     viewIds?: string[] | undefined;
     htmlElementIds?: string[] | undefined;
+    componentIds?: string[] | undefined;
 }>>;
 export declare function upsertComponents<T>(existing: T[], changes: T[] | undefined, id: (item: T) => string, removed?: string[]): T[];
 export declare function htmlElementIds(html: string): Set<string>;

package/dist/lib/editing-patch.js

@@ -8,7 +8,8 @@ const parse5_1 = require("parse5");
 const v3_1 = require("zod/v3");
 exports.removalsSchema = v3_1.z.object({
     bindingIds: v3_1.z.array(v3_1.z.string()).max(8).default([]), controlIds: v3_1.z.array(v3_1.z.string()).max(24).default([]),
-    viewIds: v3_1.z.array(v3_1.z.string()).max(40).default([]), htmlElementIds: v3_1.z.array(v3_1.z.string()).max(500).default([])
+    viewIds: v3_1.z.array(v3_1.z.string()).max(40).default([]), htmlElementIds: v3_1.z.array(v3_1.z.string()).max(500).default([]),
+    componentIds: v3_1.z.array(v3_1.z.string()).max(160).default([])
 }).strict().optional().describe('Only explicitly requested removals. Arrays of changed components otherwise upsert by stable ID and preserve omitted components.');
 function upsertComponents(existing, changes, id, removed = []) {
     if (new Set(changes?.map(id)).size !== (changes?.length ?? 0))

package/dist/lib/editing-session.d.ts

@@ -84,41 +84,41 @@ export declare const dashboardStateSchema: z.ZodObject<{
             draftRevision?: number | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
+        scope: string;
         target: {
             artifactId: string;
             schemaVersion: 1;
             versionId?: string | undefined;
             draftRevision?: number | undefined;
         } | null;
-        scope: string;
     }, {
+        scope: string;
         target: {
             artifactId: string;
             schemaVersion: 1;
             versionId?: string | undefined;
             draftRevision?: number | undefined;
         } | null;
-        scope: string;
     }>>>;
 }, "strip", z.ZodTypeAny, {
     dashboardEditing?: {
+        scope: string;
         target: {
             artifactId: string;
             schemaVersion: 1;
             versionId?: string | undefined;
             draftRevision?: number | undefined;
         } | null;
-        scope: string;
     } | null | undefined;
 }, {
     dashboardEditing?: {
+        scope: string;
         target: {
             artifactId: string;
             schemaVersion: 1;
             versionId?: string | undefined;
             draftRevision?: number | undefined;
         } | null;
-        scope: string;
     } | null | undefined;
 }>;
 /** Checkpoints belong to an actor and conversation. Copied state must never choose another user's target. */