@cube-dev/platform-client 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -9,7 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- Curate public-facing entries here before the next release. -->
 
+## [0.7.0] - 2026-09-09
+
+### Added
+
+- New public REST API for rendering a published dashboard to PNG or PDF (CUB-4302): `POST /api/v1/deployments/{deploymentId}/dashboard-exports` (`DashboardExportsPublicController.startExport`) submits a render, `GET .../dashboard-exports/{jobId}` (`getExportStatus`) polls its status, and `GET .../dashboard-exports/{jobId}/download` (`downloadExport`) streams the finished file. Asynchronous because a render waits for every widget to finish querying — the job and its file are dropped 5 minutes after submission. By default the render runs under the caller's own security context (requires manage access to the dashboard's workbook); a tenant admin can instead pass `renderAs` to render as another console or embed user, the same subject vocabulary a scheduled notification's recipients use. New schemas: `StartDashboardExportInput`, `DashboardExportJobResponse`, `DashboardExportStatusResponse`, `ExportSubjectInput`.
+- `CreateNotificationInput` / `UpdateNotificationInput` gained `memberSwitchers` — Field-switcher selections applied when the notification's dashboard is rendered — read back on the notification response too. New schema: `DashboardMemberSwitcherInput` / `DashboardMemberSwitcher`.
+- `ConnectReportToWorkbookInput`, `CreateReportInput`, `UpdateReportInput` and `RefreshReportInput` gained `resultChecksum` — a client-computed fingerprint of the cells a write just placed on the sheet, echoed back on `ReportPlacement.resultChecksum` so a client can tell whether a placement has been hand-edited since. New schemas: `ReportPlacementResultChecksumInput` / `ReportPlacementResultChecksum`, `ReportPlacementResultChunkInput` / `ReportPlacementResultChunk`. `ConnectReportToWorkbookInput` also gained `addressOnly`, for an address-only correction (e.g. a renamed sheet tab) that should not erase the stored fingerprint.
+- `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`.
+
 ## [0.6.0] - 2026-09-02
+
 ### Added
 
 - `User` (`GET /api/v1/users/me`, `UsersPublicController.getMe`) gained `userPolicies` — the caller's effective resource policies: direct grants, organization-wide grants and grants inherited from their groups. This is the set the console has always read over GraphQL; on REST it lets an embedded Creator Mode session resolve a workbook another embed user shared with it, which previously granted nothing beyond viewing. New schemas: `Policy`, `PolicyResourceType`.

package/dist/schema.d.ts

@@ -305,6 +305,82 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/dashboard-exports": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Export a dashboard as PNG or PDF
+         * @description Submit a render of a published dashboard. Identify it with either `dashboardId` (numeric) or `dashboardPublicId` (string) — supply exactly one; it must belong to this deployment, otherwise `404` is returned.
+         *
+         *     Returns as soon as the job is accepted, because a render waits for every widget to finish querying. Poll `GET /dashboard-exports/{jobId}` until `status` is `completed`, then fetch the file from `GET /dashboard-exports/{jobId}/download`. The job and its file are dropped at `expiresAt` (5 minutes) — download before then or submit again.
+         *
+         *     Pass `filters`, `timeGrains` and `memberSwitchers` to render the board with specific control values, exactly as a scheduled notification does; omit them to render its saved defaults.
+         *
+         *     By default the dashboard renders under the calling user's own security context, so the file shows what that user would see. Requires **manage** access to the dashboard's workbook — the same permission the console's own "Download as PNG / PDF" actions require, because a whole-dashboard render is a bulk data export.
+         *
+         *     To export on someone else's behalf, pass `renderAs`: the queries behind the image then run under that user's security context instead of yours. **Requires the caller to be a tenant administrator.** Name a console user by `userId` or `email` (`type: USER`), or an embed user by `embedTenantName` + `externalId` (`type: EMBED_USER`). A deactivated console user is not a valid subject and returns `404`; an email is matched case-insensitively.
+         *
+         *     An embed subject is provisioned if it does not exist yet, and `groups`, `userAttributes` and `securityContext` apply to **this render only** — they are carried on the render's own session and are NOT written to the user's stored context, so exporting for someone never changes what their live embedded sessions see. (Use the embed-tenant users API to change a user's stored context.) An embed subject additionally requires the dashboard's workbook to be shared with that embed tenant, otherwise `403` is returned.
+         *
+         *     Returns `403` when the workspace has data downloads restricted — including for an on-behalf-of export, which deliberately does **not** bypass that setting the way a built-in scheduled notification does — and `429` when there are already too many exports in flight for the identity being rendered as.
+         */
+        post: operations["DashboardExportsPublicController.startExport"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the status of a dashboard export
+         * @description Progress of a submitted render. Poll until `status` is `completed` (then download it) or `failed` (then read `error`); `pending` and `processing` both mean keep waiting.
+         *
+         *     Returns `404` once the job has expired, and for a job submitted by a different user — a job is only ever visible to whoever started it.
+         */
+        get: operations["DashboardExportsPublicController.getExportStatus"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}/download": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Download a completed dashboard export
+         * @description Stream the rendered file as an attachment, named `dashboard.png` / `dashboard.pdf` unless `?filename=` supplies a different stem (the extension always follows the rendered format).
+         *
+         *     Returns `409` while the job is still rendering — poll `GET /dashboard-exports/{jobId}` first — `422` if the render failed (terminal: submit a new export rather than retrying this one), and `404` once the job has expired or if it belongs to a different user.
+         */
+        get: operations["DashboardExportsPublicController.downloadExport"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/dbt-sync": {
         parameters: {
             query?: never;
@@ -2911,11 +2987,13 @@ export interface components {
             private?: boolean | null;
         };
         ConnectReportToWorkbookInput: {
+            addressOnly?: boolean | null;
             anchorCell?: string | null;
             endResultCell?: string | null;
             externalWorkbookId: string;
             host?: components["schemas"]["ConnectReportToWorkbookInputHost"] | null;
             placementId?: string | null;
+            resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
             resultLocation: string;
             sheetId?: string | null;
             sheetName?: string | null;
@@ -2990,6 +3068,7 @@ export interface components {
             dayOfWeek?: number | null;
             filters?: components["schemas"]["DashboardFilterInput"][] | null;
             hour?: number | null;
+            memberSwitchers?: components["schemas"]["DashboardMemberSwitcherInput"][] | null;
             minute?: number | null;
             notificationAiSummary?: boolean | null;
             notificationEnabled?: boolean | null;
@@ -3039,6 +3118,7 @@ export interface components {
             name?: string | null;
             pivotItems?: components["schemas"]["PivotItemsInput"] | null;
             publicId?: string | null;
+            resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
             resultLocation?: string | null;
             sheetId?: string | null;
             source?: components["schemas"]["CreateReportInputSource"] | null;
@@ -3189,6 +3269,20 @@ export interface components {
             title?: string | null;
             widgets?: components["schemas"]["DashboardWidget"][] | null;
         };
+        DashboardConfigDraftInput: {
+            app?: components["schemas"]["DashboardAppSourceInput"] | null;
+            description?: string | null;
+            kind?: components["schemas"]["DashboardConfigDraftInputKind"] | null;
+            layout?: components["schemas"]["DashboardLayoutInput"] | null;
+            settings?: {
+                [key: string]: any;
+            } | null;
+            theme?: components["schemas"]["DashboardThemeInput"] | null;
+            title?: string | null;
+            widgets?: components["schemas"]["DashboardWidgetDraftInput"][] | null;
+        };
+        /** @enum {string} */
+        DashboardConfigDraftInputKind: "CLASSIC" | "APP";
         DashboardConfigInput: {
             app?: components["schemas"]["DashboardAppSourceInput"] | null;
             description?: string | null;
@@ -3211,6 +3305,23 @@ export interface components {
             allowEmbed: boolean;
             publicId: string;
         };
+        DashboardExportJobResponse: {
+            /**
+             * Format: date-time
+             * @description When the job (and its rendered file) is evicted from the renderer cache. Download before this, or submit a new export.
+             */
+            expiresAt: string;
+            /** @description Job id to poll for status and to download the finished file with. */
+            jobId: string;
+        };
+        DashboardExportStatusResponse: {
+            contentType?: string | null;
+            error?: string | null;
+            progress?: number | null;
+            status: components["schemas"]["DashboardExportStatusResponseStatus"];
+        };
+        /** @enum {string} */
+        DashboardExportStatusResponseStatus: "pending" | "processing" | "completed" | "failed";
         DashboardFilter: {
             caseSensitive?: any | null;
             endInclusive?: any | null;
@@ -3246,6 +3357,16 @@ export interface components {
             margin?: number[] | null;
             rowHeight?: number | null;
         };
+        DashboardMemberSwitcher: {
+            member: string;
+            selected: string;
+        };
+        DashboardMemberSwitcherInput: {
+            /** @description Path of the member the control replaces, e.g. "Orders.status" */
+            member: string;
+            /** @description Name of the member to show in its place, e.g. "city" (no view prefix) */
+            selected: string;
+        };
         DashboardResponsiveLayouts: {
             lg?: components["schemas"]["DashboardWidgetPosition"] | null;
             md?: components["schemas"]["DashboardWidgetPosition"] | null;
@@ -3295,6 +3416,20 @@ export interface components {
             } | null;
             type: components["schemas"]["DashboardWidgetDtoType"];
         };
+        DashboardWidgetDraftInput: {
+            config?: {
+                [key: string]: any;
+            } | null;
+            id?: string | null;
+            position: components["schemas"]["DashboardWidgetPositionInput"];
+            responsiveLayouts?: components["schemas"]["DashboardResponsiveLayoutsInput"] | null;
+            style?: {
+                [key: string]: any;
+            } | null;
+            type: components["schemas"]["DashboardWidgetDraftInputType"];
+        };
+        /** @enum {string} */
+        DashboardWidgetDraftInputType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "FIELD" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
         /** @enum {string} */
         DashboardWidgetDtoType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "FIELD" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
         DashboardWidgetInput: {
@@ -3753,6 +3888,20 @@ export interface components {
             items: components["schemas"]["EnvVariableItem"][];
             pageInfo?: components["schemas"]["PageInfo"] | null;
         };
+        ExportSubjectInput: {
+            email?: string | null;
+            embedTenantName?: string | null;
+            externalId?: string | null;
+            groups?: string[] | null;
+            securityContext?: {
+                [key: string]: any;
+            } | null;
+            type: components["schemas"]["ExportSubjectInputType"];
+            userAttributes?: components["schemas"]["UserAttributeInput"][] | null;
+            userId?: number | null;
+        };
+        /** @enum {string} */
+        ExportSubjectInputType: "USER" | "EMBED_USER";
         FileHash: {
             hash: string;
         };
@@ -3972,6 +4121,7 @@ export interface components {
             humanReadableSchedule: string;
             id: number;
             isEnabled: boolean;
+            memberSwitchers?: components["schemas"]["DashboardMemberSwitcher"][] | null;
             /** @description Whether this notification carries an AI-generated "what changed" summary in its body. */
             notificationAiSummary: boolean;
             notificationEnabled: boolean;
@@ -4072,21 +4222,29 @@ export interface components {
         };
         PivotItems: {
             columns: string[];
+            displayScale?: components["schemas"]["PivotItemsDisplayScale"] | null;
             filters: string[];
             measures: string[];
             measuresAxis?: components["schemas"]["PivotItemsMeasuresAxis"] | null;
             measuresPosition?: components["schemas"]["PivotItemsMeasuresPosition"] | null;
             rows: string[];
+            showColumnTotals?: boolean | null;
         };
+        /** @enum {string} */
+        PivotItemsDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
         PivotItemsInput: {
             columns: string[];
+            displayScale?: components["schemas"]["PivotItemsInputDisplayScale"] | null;
             filters: string[];
             measures: string[];
             measuresAxis?: components["schemas"]["PivotItemsInputMeasuresAxis"] | null;
             measuresPosition?: components["schemas"]["PivotItemsInputMeasuresPosition"] | null;
             rows: string[];
+            showColumnTotals?: boolean | null;
         };
         /** @enum {string} */
+        PivotItemsInputDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
+        /** @enum {string} */
         PivotItemsInputMeasuresAxis: "columns" | "rows";
         /** @enum {string} */
         PivotItemsInputMeasuresPosition: "before" | "after";
@@ -4167,6 +4325,7 @@ export interface components {
             anchorCell?: string | null;
             externalWorkbookId?: string | null;
             placementId?: string | null;
+            resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
             resultLocation?: string | null;
             sheetId?: string | null;
             sheetName?: string | null;
@@ -4344,6 +4503,7 @@ export interface components {
             queryChecksum?: string | null;
             refreshedAt?: string | null;
             refreshedByUserId?: number | null;
+            resultChecksum?: components["schemas"]["ReportPlacementResultChecksum"] | null;
             resultLocation: string;
             sheetId?: string | null;
             sheetName?: string | null;
@@ -4353,6 +4513,24 @@ export interface components {
         };
         /** @enum {string} */
         ReportPlacementHost: "GOOGLE_SHEETS" | "EXCEL";
+        ReportPlacementResultChecksum: {
+            chunks: components["schemas"]["ReportPlacementResultChunk"][];
+            v: number;
+        };
+        ReportPlacementResultChecksumInput: {
+            chunks: components["schemas"]["ReportPlacementResultChunkInput"][];
+            v: number;
+        };
+        ReportPlacementResultChunk: {
+            from: number;
+            hash: string;
+            to?: number | null;
+        };
+        ReportPlacementResultChunkInput: {
+            from: number;
+            hash: string;
+            to?: number | null;
+        };
         /** @enum {string} */
         ReportPlacementSyncStatus: "UP_TO_DATE" | "CHANGED" | "UNKNOWN";
         ReportSnapshot: {
@@ -4459,6 +4637,17 @@ export interface components {
             }[];
             pageInfo?: components["schemas"]["PageInfo"] | null;
         };
+        StartDashboardExportInput: {
+            dashboardId?: number | null;
+            dashboardPublicId?: string | null;
+            filters?: components["schemas"]["DashboardFilterInput"][] | null;
+            format: components["schemas"]["StartDashboardExportInputFormat"];
+            memberSwitchers?: components["schemas"]["DashboardMemberSwitcherInput"][] | null;
+            renderAs?: components["schemas"]["ExportSubjectInput"] | null;
+            timeGrains?: components["schemas"]["DashboardTimeGrainInput"][] | null;
+        };
+        /** @enum {string} */
+        StartDashboardExportInputFormat: "png" | "pdf";
         StartDbtSyncInput: {
             branchName?: string | null;
             ref?: string | null;
@@ -4565,6 +4754,7 @@ export interface components {
             filters?: components["schemas"]["DashboardFilterInput"][] | null;
             hour?: number | null;
             isEnabled?: boolean | null;
+            memberSwitchers?: components["schemas"]["DashboardMemberSwitcherInput"][] | null;
             minute?: number | null;
             notificationAiSummary?: boolean | null;
             notificationEnabled?: boolean | null;
@@ -4619,6 +4809,7 @@ export interface components {
             pivotItems?: components["schemas"]["PivotItems"] | null;
             placementId?: string | null;
             publicId?: string | null;
+            resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
             resultLocation?: string | null;
             sheetId?: string | null;
             sqlQuery?: string | null;
@@ -4901,7 +5092,7 @@ export interface components {
             dashboardPublished?: components["schemas"]["DashboardConfig"] | null;
         };
         WorkbookDashboardInput: {
-            dashboardDraft?: components["schemas"]["DashboardConfigInput"] | null;
+            dashboardDraft?: components["schemas"]["DashboardConfigDraftInput"] | null;
         };
         /** @enum {string} */
         WorkbookDtoType: "FOLDER" | "WORKBOOK" | "REPORT";
@@ -5573,6 +5764,86 @@ export interface operations {
             };
         };
     };
+    "DashboardExportsPublicController.startExport": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the dashboard. */
+                deploymentId: number;
+            };
+            cookie?: never;
+        };
+        /** @description StartDashboardExportInput */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["StartDashboardExportInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DashboardExportJobResponse"];
+                };
+            };
+        };
+    };
+    "DashboardExportsPublicController.getExportStatus": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the dashboard. */
+                deploymentId: number;
+                /** @description Job id returned when the export was submitted. */
+                jobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["DashboardExportStatusResponse"];
+                };
+            };
+        };
+    };
+    "DashboardExportsPublicController.downloadExport": {
+        parameters: {
+            query?: {
+                /** @description Filename stem for the attachment, without extension. Defaults to `dashboard`. */
+                filename?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Numeric id of the deployment that owns the dashboard. */
+                deploymentId: number;
+                /** @description Job id returned when the export was submitted. */
+                jobId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The rendered dashboard. */
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/pdf": string;
+                    "image/png": string;
+                };
+            };
+        };
+    };
     "DbtSyncPublicController.listDbtSyncs": {
         parameters: {
             query?: {