@cube-dev/platform-client 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- Curate public-facing entries here before the next release. -->
 
+## [0.8.0] - 2026-09-11
+
+### Added
+
+- New public REST API for previewing a Databricks Metric View publication (CUB-4442): `POST /api/v1/deployments/{deploymentId}/databricks-metric-view-previews` (`DatabricksMetricViewPublicationPublicController.startPreview`) queues an offline conversion of the deployment's latest successful build and returns `202` with polling URLs; `GET .../databricks-metric-view-previews/{previewId}` (`previewStatus`) polls progress; `GET .../databricks-metric-view-previews/{previewId}/result` (`previewResult`) returns the completed result (`409` while still running or if it ended without one); `DELETE .../databricks-metric-view-previews/{previewId}` (`cancelPreview`) requests cancellation. Requires `SchemaRead` or `SchemaUpdate` access and the `useDatabricksMetricViewsPush` flag; preview payloads and results are retained for at most seven days. New schemas: `DatabricksMetricViewPublicationPreviewInput`, `DatabricksMetricViewPublicationPreviewStartResponse`, `DatabricksMetricViewPublicationPreviewStatusResponse`, `DatabricksMetricViewPublicationPreviewResultResponse`, `DatabricksMetricViewPublicationViewResult`, `DatabricksMetricViewPublicationIssue`, `DatabricksMetricViewPublicationCounts`, `DatabricksMetricViewPublicationDatasetSource`, `DatabricksMetricViewPublicationRuntime`, `DatabricksMetricViewPublicationProgress`.
+- `StartDbtSyncInput` gained `source` (`"git"` | `"manifest"`) and `manifest` — pass an uploaded `manifest.json` directly instead of having Cube clone the dbt repository and run dbt itself (CUB-4492). The corresponding `DbtSyncRun` response gained `source` (which pull path a run used), and `DbtSyncRunStats` gained `dbtVersion` and `manifestGeneratedAt`, populated for manifest-sourced runs.
+- `EmbedSessionSettings` / `EmbedSettings` gained `allowAi`, `showAiWidgets`, and `showWorkbookChat` (CUB-2615) — per-session AI opt-outs for embeds. `allowAi` disables every AI surface, including the standalone embed chat, and is enforced server-side so a client holding the token can't work around it; the `show*` keys (alongside the existing `showDashboardChat`) only hide specific entry points — the dashboard agent, workspace chat, and AI-summary widget generation, respectively.
+
 ## [0.7.0] - 2026-09-09
 
 ### Added
@@ -19,6 +27,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `PivotItems` / `PivotItemsInput` gained `displayScale` (`"model"` | `"absolute"` | `"thousands"` | `"millions"` | `"billions"`) and `showColumnTotals`.
 - `WorkbookDashboardInput.dashboardDraft` now accepts a widget without an `id` — the server assigns one. New schema `DashboardConfigDraftInput` (with `DashboardWidgetDraftInput`); publishing or creating a dashboard still requires an `id` on every widget via the existing `DashboardConfigInput`.
 
+### Changed
+
+- `CreateReportInput.name` / `.title`, `UpdateReportInput.name` / `.title`, and the `Report.name` response field now enforce `maxLength: 255` (CUB-4440) — matching the column's real storage limit, so a name or title over that limit now returns `400` instead of failing less predictably downstream.
+
 ## [0.6.0] - 2026-09-02
 
 ### Added

package/dist/schema.d.ts

@@ -381,6 +381,64 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/databricks-metric-view-previews": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Start a Databricks Metric View publication preview
+         * @description Queues an offline conversion of static YAML from the deployment's latest successful build and returns polling URLs immediately. Exact retries while the same content-addressed preview is running reuse that work; a later submission starts a fresh execution. Preview payloads and results are retained for at most seven days. The conversion supports scalar dimensions, common and calculated measures, and acyclic many-to-one equi-joins from one Databricks datasource. Access policies, templating, extends, unsafe fanout, unsupported expressions, multiple datasources, and converter loss are blocked per view. Two-part schema.table sources are qualified with CUBEJS_DB_DATABRICKS_CATALOG for the selected datasource; without that setting they fail closed with an actionable issue. Requires SchemaRead or SchemaUpdate access and useDatabricksMetricViewsPush.
+         */
+        post: operations["DatabricksMetricViewPublicationPublicController.startPreview"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Databricks Metric View preview status */
+        get: operations["DatabricksMetricViewPublicationPublicController.previewStatus"];
+        put?: never;
+        post?: never;
+        /** Cancel a Databricks Metric View preview */
+        delete: operations["DatabricksMetricViewPublicationPublicController.cancelPreview"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}/result": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a completed Databricks Metric View preview result
+         * @description Returns 409 while the preview is still running or if it ended without a conversion result.
+         */
+        get: operations["DatabricksMetricViewPublicationPublicController.previewResult"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/dbt-sync": {
         parameters: {
             query?: never;
@@ -3486,6 +3544,120 @@ export interface components {
         DataModelWriteResponse: {
             success: boolean;
         };
+        DatabricksMetricViewPublicationCounts: {
+            dimensions: number;
+            errors: number;
+            joins: number;
+            measures: number;
+            warnings: number;
+        };
+        DatabricksMetricViewPublicationDatasetSource: {
+            dataSource: string;
+            dataset: string;
+            originalSource: string;
+            resolvedSource: string;
+        };
+        DatabricksMetricViewPublicationIssue: {
+            code: string;
+            element?: string | null;
+            message: string;
+            severity: components["schemas"]["DatabricksMetricViewPublicationIssueSeverity"];
+            stage: components["schemas"]["DatabricksMetricViewPublicationIssueStage"];
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationIssueSeverity: "ERROR" | "WARNING";
+        /** @enum {string} */
+        DatabricksMetricViewPublicationIssueStage: "INPUT" | "VIEW_PROJECTION" | "OSSIE_VALIDATION" | "OSSIE_TO_DATABRICKS" | "OUTPUT_VALIDATION" | "EXECUTION";
+        DatabricksMetricViewPublicationPreviewInput: {
+            dataSourceName: string;
+            selectionMode: components["schemas"]["DatabricksMetricViewPublicationPreviewInputSelectionMode"];
+            sourceOverrides?: {
+                [key: string]: string;
+            } | null;
+            targetNames?: {
+                [key: string]: string;
+            } | null;
+            viewNameRegex?: string | null;
+            viewNames?: string[] | null;
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationPreviewInputSelectionMode: "all" | "selected" | "pattern";
+        DatabricksMetricViewPublicationPreviewResultResponse: {
+            buildJobId: number;
+            commit?: string | null;
+            completedAt: string;
+            dataSourceName: string;
+            deploymentId: number;
+            durationMs: number;
+            outcome: components["schemas"]["DatabricksMetricViewPublicationPreviewResultResponseOutcome"];
+            previewId: string;
+            runtime: components["schemas"]["DatabricksMetricViewPublicationRuntime"];
+            sourceSha256: string;
+            version: components["schemas"]["DatabricksMetricViewPublicationPreviewResultResponseVersion"];
+            views: components["schemas"]["DatabricksMetricViewPublicationViewResult"][];
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationPreviewResultResponseOutcome: "success" | "partial" | "failed";
+        /** @enum {integer} */
+        DatabricksMetricViewPublicationPreviewResultResponseVersion: 2;
+        DatabricksMetricViewPublicationPreviewStartResponse: {
+            buildJobId: number;
+            commit?: string | null;
+            dataSourceName: string;
+            deploymentId: number;
+            previewId: string;
+            resultUrl: string;
+            reused: boolean;
+            status: components["schemas"]["DatabricksMetricViewPublicationPreviewStartResponseStatus"];
+            statusUrl: string;
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationPreviewStartResponseStatus: "QUEUED";
+        DatabricksMetricViewPublicationPreviewStatusResponse: {
+            dataSourceName: string;
+            deploymentId: number;
+            error?: string | null;
+            previewId: string;
+            progress: components["schemas"]["DatabricksMetricViewPublicationProgress"];
+            resultAvailable: boolean;
+            startedAt: string;
+            status: components["schemas"]["DatabricksMetricViewPublicationPreviewStatusResponseStatus"];
+            updatedAt: string;
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationPreviewStatusResponseStatus: "QUEUED" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED";
+        DatabricksMetricViewPublicationProgress: {
+            message: string;
+            percentComplete: number;
+            stage: components["schemas"]["DatabricksMetricViewPublicationProgressStage"];
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationProgressStage: "QUEUED" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED";
+        DatabricksMetricViewPublicationRuntime: {
+            bridgeCommit: string;
+            bridgeVersion: string;
+            cubeConverterVersion: string;
+            databricksConverterVersion: string;
+            ossieCommit: string;
+            ossieCoreVersion: string;
+            policyVersion: number;
+            runnerVersion: string;
+            templateName: string;
+        };
+        DatabricksMetricViewPublicationViewResult: {
+            counts: components["schemas"]["DatabricksMetricViewPublicationCounts"];
+            cubeViewName: string;
+            datasetSources: components["schemas"]["DatabricksMetricViewPublicationDatasetSource"][];
+            eligibleForPublication: boolean;
+            issues: components["schemas"]["DatabricksMetricViewPublicationIssue"][];
+            metricViewName: string;
+            metricViewSha256?: string | null;
+            metricViewYaml?: string | null;
+            outcome: components["schemas"]["DatabricksMetricViewPublicationViewResultOutcome"];
+            source?: string | null;
+        };
+        /** @enum {string} */
+        DatabricksMetricViewPublicationViewResultOutcome: "success" | "failed";
         DbtSyncCancelResponse: {
             message: string;
         };
@@ -3548,6 +3720,8 @@ export interface components {
             gitRef?: string | null;
             lastStage?: string | null;
             phases?: components["schemas"]["DbtSyncRunPhase"][] | null;
+            /** @description Where this sync got its dbt metadata: `git` (Cube cloned the dbt repository and ran dbt) or `manifest` (the caller uploaded a `manifest.json` and no repository was accessed). Runs predating the manifest source report `git`. */
+            source: string;
             /** @description When the sync started, as an ISO 8601 timestamp. See completedAt before comparing the two. */
             startedAt: string;
             stats?: components["schemas"]["DbtSyncRunStats"] | null;
@@ -3575,8 +3749,10 @@ export interface components {
         };
         DbtSyncRunStats: {
             cubeCount?: number | null;
+            dbtVersion?: string | null;
             generatedFileCount?: number | null;
             macros?: number | null;
+            manifestGeneratedAt?: string | null;
             models?: number | null;
             sources?: number | null;
         };
@@ -3818,13 +3994,19 @@ export interface components {
             sqlQuery: string;
         };
         EmbedSessionSettings: {
+            allowAi?: boolean | null;
             allowChatWorkspaceAuthoring?: boolean | null;
+            showAiWidgets?: boolean | null;
             showDashboardChat?: boolean | null;
+            showWorkbookChat?: boolean | null;
         };
         EmbedSettings: {
+            allowAi?: boolean | null;
             enableDashboardComments?: boolean | null;
             locale?: string | null;
+            showAiWidgets?: boolean | null;
             showDashboardChat?: boolean | null;
+            showWorkbookChat?: boolean | null;
             timezone?: string | null;
         };
         EmbedTenant: {
@@ -4650,8 +4832,14 @@ export interface components {
         StartDashboardExportInputFormat: "png" | "pdf";
         StartDbtSyncInput: {
             branchName?: string | null;
+            manifest?: {
+                [key: string]: any;
+            } | null;
             ref?: string | null;
+            source?: components["schemas"]["StartDbtSyncInputSource"] | null;
         };
+        /** @enum {string} */
+        StartDbtSyncInputSource: "git" | "manifest";
         StartDevModeRequest: {
             branchName?: string | null;
         };
@@ -5844,6 +6032,99 @@ export interface operations {
             };
         };
     };
+    "DatabricksMetricViewPublicationPublicController.startPreview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        /** @description DatabricksMetricViewPublicationPreviewInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewInput"];
+            };
+        };
+        responses: {
+            202: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewStartResponse"];
+                };
+            };
+        };
+    };
+    "DatabricksMetricViewPublicationPublicController.previewStatus": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                previewId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewStatusResponse"];
+                };
+            };
+        };
+    };
+    "DatabricksMetricViewPublicationPublicController.cancelPreview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                previewId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": any;
+                };
+            };
+        };
+    };
+    "DatabricksMetricViewPublicationPublicController.previewResult": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                previewId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewResultResponse"];
+                };
+            };
+        };
+    };
     "DbtSyncPublicController.listDbtSyncs": {
         parameters: {
             query?: {