@cube-dev/platform-client 0.4.0 → 0.6.0

package/CHANGELOG.md

@@ -9,6 +9,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- Curate public-facing entries here before the next release. -->
 
+## [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`.
+- Re-added `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) and its `UpdatePublishedAiWidgetThreadInput` schema (`widgetId`, `threadId`, optional `checksum`) — reverting the `0.4.0` removal. Regenerating an AI-analysis widget on a **published** dashboard persists the new thread id (+ checksum) back to the published config so an immediate reload shows the fresh result instead of the stale one. It stores **only** the thread id and checksum — never summary text (CUB-4031).
+- `PATCH /api/v1/users/me/settings` (`UsersPublicController.updateMySettings`) — merge a partial patch into your own settings; omitted fields are left as they are, and `sheets` merges field-by-field (an explicit `null` clears it). `UserSettingsInput` gained `sheets`. New schema: `SheetsUserSettingsInput` (`autoRunQueryOnChange`, `openExplorationFromSheet`, `revealSheetOnOpen`, `showAppliedFilters`, `suppressDuplicateValues`).
+- `POST /api/v1/deployments/{id}/token` (`DeploymentsPublicController.deploymentToken`) now accepts an optional body to request a shorter token lifetime than the 24-hour default. New schema: `CreateDeploymentTokenInput` (`expiresIn`, 60–86400 seconds) — recommended for tokens held outside a browser session (scripts, BI tools, scheduled jobs).
+- `AppTheme` / `AppThemeResponse` (`GET /api/v1/app-theme`, `GET /api/v1/app-config`) gained `palette` and `logoUrl` — the new theme model: base/accent color seeds, contrast level, a pastel toggle, surface mode, and per-semantic color overrides (danger/warning/success/note/code). New schemas: `AppThemePalette`, `AppThemePaletteSeed`, `AppThemePaletteThemes`, `AppThemeCodePalette`, `AppThemeSurfaceMode`.
+- `DashboardWidgetDtoType` / `DashboardWidgetInputType` gained a new `"FIELD"` enum value, for the Field switcher dashboard control.
+- `ReportPlacement` gained `queryChecksum` and `syncStatus` (new schema `ReportPlacementSyncStatus`: `"UP_TO_DATE"` | `"CHANGED"` | `"UNKNOWN"`), and `Report` gained `currentQueryChecksum` — together they let a client tell whether the cells at a placement still reflect the exploration as it stands now.
+
+### Changed
+
+- `POST /api/v1/usage-analytics/token` — corrected docs: tokens expire after 1 hour, not ~24 hours as previously stated. `expiresAt` on the response has always reflected the real value.
+
+### Deprecated
+
+- `AppTheme.light` / `AppTheme.dark` — use `palette` and `logoUrl` instead.
+- `UserSettingsInput.lastSeenChangelogId` — ignored; the changelog now arrives in the notification inbox, which carries its own read state. Accepted for backward compatibility but never read or written.
+
+## [0.5.0] - 2026-08-30
+
+### Added
+
+- `POST /api/v1/usage-analytics/token` (`UsageAnalyticsPublicController.createToken`) — issues a short-lived Cube API token scoped to your account, for querying your own Usage Analytics (usage/billing) data programmatically instead of only through the embedded Admin page. New schema: `UsageAnalyticsTokenResponse`. Admin-only.
+- `CreateNotificationInput` / `UpdateNotificationInput` gained `notificationAiSummary` — include an AI-generated "what changed" summary in the notification body. Read back as `notificationAiSummary` on the corresponding notification response schema.
+- `EmbedSettings` gained `enableDashboardComments` — controls whether embedded published dashboards allow comments.
+- `UserSettingsInput` gained `defaultDeploymentId` — a personal override for the deployment a user lands on when opening the workspace without one specified in the URL; `null`/unset inherits the account-wide default. It is readable via the existing `settings` object on the `User` schema.
+- `UserCreateInput` gained `settings` — seed a new user's personal settings (the `UserSettingsInput` fields, e.g. `locale`, `theme`, `defaultDeploymentId`) at creation time instead of a follow-up update. Typed as a free-form object in the spec.
+- `ReportSnapshotDtoKind` gained a new `"sankey"` enum value.
+
 ## [0.4.0] - 2026-08-27
 
 ### Added
@@ -64,7 +95,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-- **BREAKING:** `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) and its `UpdatePublishedAiWidgetThreadInput` schema (added in `0.2.0`). It persisted an AI-analysis thread id + checksum into the published dashboard config — the mechanism that caused read-only/anonymous viewers to hit `WorkbookEdit`/403s and let one viewer's filter state clobber the shared config (CUB-3898). AI-analysis results are now cached server-side keyed by dashboard state, so no client-facing endpoint replaces it. This is a deliberate breaking removal; SDK consumers referencing the operation or schema should drop those references.
+- **BREAKING:** `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) and its `UpdatePublishedAiWidgetThreadInput` schema (added in `0.2.0`). It persisted an AI-analysis thread id + checksum into the published dashboard config — the mechanism that caused read-only/anonymous viewers to hit `WorkbookEdit`/403s and let one viewer's filter state clobber the shared config (CUB-3898). AI-analysis results are recovered by replaying the chat thread whose id the dashboard config stores, so no client-facing endpoint replaces it (CUB-4031). This is a deliberate breaking removal; SDK consumers referencing the operation or schema should drop those references.
 
 ## [0.3.0] - 2026-07-30
 

package/dist/schema.d.ts

@@ -1037,6 +1037,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Update published dashboard ai widget thread */
+        post: operations["WorkbooksPublicController.updatePublishedDashboardAiWidgetThread"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/duplicate": {
         parameters: {
             query?: never;
@@ -2022,6 +2039,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/usage-analytics/token": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Issue a Cube API token for Usage Analytics
+         * @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
+         *
+         *     Issues a short-lived Cube API token for Cube's internal **Usage Analytics** deployment — the data shown on **Admin → Usage Analytics** — so you can query your own usage and billing data programmatically (REST API, BI tools, scripts) instead of only through the embedded page.
+         *
+         *     The token is scoped to your account: it carries the same server-resolved security context as the embedded Usage Analytics page, so queries only ever see your own data. Send it as `Authorization: Bearer <token>` on requests to the returned `apiUrl` (the deployment's [Cube REST API](https://cube.dev/docs/product/apis-integrations/rest-api)).
+         *
+         *     Tokens expire after 1 hour (see `expiresAt`). Issue a fresh one per session or scheduled refresh — issuing is idempotent and cheap.
+         *
+         *     Requires Usage Analytics to be enabled for the account, otherwise `404` is returned.
+         */
+        post: operations["UsageAnalyticsPublicController.createToken"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/user-attribute-values/": {
         parameters: {
             query?: never;
@@ -2260,6 +2305,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/users/me/settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update my settings
+         * @description Merge a partial patch into the authenticated user's own settings. Omitted fields are left as they are; `sheets` merges field-by-field, and an explicit `null` clears it.
+         */
+        patch: operations["UsersPublicController.updateMySettings"];
+        trace?: never;
+    };
     "/api/v1/users/{id}": {
         parameters: {
             query?: never;
@@ -2681,18 +2746,61 @@ export interface components {
             timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
         };
         AppTheme: {
+            /**
+             * @deprecated
+             * @description Deprecated: use palette and logoUrl instead.
+             */
             dark: components["schemas"]["AppThemeScheme"];
+            /**
+             * @deprecated
+             * @description Deprecated: use palette and logoUrl instead.
+             */
             light: components["schemas"]["AppThemeScheme"];
+            logoUrl: string;
+            palette: components["schemas"]["AppThemePalette"];
             typography?: components["schemas"]["AppThemeTypography"] | null;
         };
+        AppThemeCodePalette: {
+            saturation?: number | null;
+        };
         AppThemeFontRef: {
             fontRef: string;
             fontWeight: number;
         };
+        AppThemePalette: {
+            accent?: components["schemas"]["AppThemePaletteSeed"] | null;
+            base?: components["schemas"]["AppThemePaletteSeed"] | null;
+            contrastLevel?: number | null;
+            pastel?: boolean | null;
+            surfaceMode?: components["schemas"]["AppThemeSurfaceMode"] | null;
+            themes?: components["schemas"]["AppThemePaletteThemes"] | null;
+        };
+        AppThemePaletteSeed: {
+            color?: string | null;
+            hue?: number | null;
+            saturation?: number | null;
+        };
+        AppThemePaletteThemes: {
+            code?: components["schemas"]["AppThemeCodePalette"] | null;
+            danger?: components["schemas"]["AppThemePaletteSeed"] | null;
+            note?: components["schemas"]["AppThemePaletteSeed"] | null;
+            success?: components["schemas"]["AppThemePaletteSeed"] | null;
+            warning?: components["schemas"]["AppThemePaletteSeed"] | null;
+        };
         AppThemeResponse: {
             applyThemeGlobally: boolean;
+            /**
+             * @deprecated
+             * @description Deprecated: use palette and logoUrl instead.
+             */
             dark: components["schemas"]["AppThemeScheme"];
+            /**
+             * @deprecated
+             * @description Deprecated: use palette and logoUrl instead.
+             */
             light: components["schemas"]["AppThemeScheme"];
+            logoUrl: string;
+            palette: components["schemas"]["AppThemePalette"];
             typography?: components["schemas"]["AppThemeTypography"];
         };
         AppThemeScheme: {
@@ -2702,6 +2810,8 @@ export interface components {
             foregroundColor: string;
             logoUrl: string;
         };
+        /** @enum {string} */
+        AppThemeSurfaceMode: "neutral" | "tinted";
         AppThemeTypography: {
             body: components["schemas"]["AppThemeFontRef"];
             fonts: components["schemas"]["ThemeFont"][];
@@ -2859,6 +2969,9 @@ export interface components {
         CreateDeploymentInputCreationMethod: "upload" | "cubecloud" | "github" | "ssh";
         /** @enum {string} */
         CreateDeploymentInputDeployMode: "git" | "cli";
+        CreateDeploymentTokenInput: {
+            expiresIn?: number | null;
+        };
         CreateEmbedGroupInput: {
             description?: string | null;
             /** @description Group name, unique within the embed tenant. The `system:` prefix is reserved and rejected. */
@@ -2878,6 +2991,7 @@ export interface components {
             filters?: components["schemas"]["DashboardFilterInput"][] | null;
             hour?: number | null;
             minute?: number | null;
+            notificationAiSummary?: boolean | null;
             notificationEnabled?: boolean | null;
             notificationFormat?: components["schemas"]["CreateNotificationInputNotificationFormat"] | null;
             scheduleType: components["schemas"]["CreateNotificationInputScheduleType"];
@@ -3182,7 +3296,7 @@ export interface components {
             type: components["schemas"]["DashboardWidgetDtoType"];
         };
         /** @enum {string} */
-        DashboardWidgetDtoType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
+        DashboardWidgetDtoType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "FIELD" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
         DashboardWidgetInput: {
             config?: {
                 [key: string]: any;
@@ -3196,7 +3310,7 @@ export interface components {
             type: components["schemas"]["DashboardWidgetInputType"];
         };
         /** @enum {string} */
-        DashboardWidgetInputType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
+        DashboardWidgetInputType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "FIELD" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
         DashboardWidgetPosition: {
             h: number;
             w: number;
@@ -3573,6 +3687,7 @@ export interface components {
             showDashboardChat?: boolean | null;
         };
         EmbedSettings: {
+            enableDashboardComments?: boolean | null;
             locale?: string | null;
             showDashboardChat?: boolean | null;
             timezone?: string | null;
@@ -3857,6 +3972,8 @@ export interface components {
             humanReadableSchedule: string;
             id: number;
             isEnabled: boolean;
+            /** @description Whether this notification carries an AI-generated "what changed" summary in its body. */
+            notificationAiSummary: boolean;
             notificationEnabled: boolean;
             notificationFormat: string;
             timeGrains?: components["schemas"]["DashboardTimeGrain"][] | null;
@@ -3977,6 +4094,13 @@ export interface components {
         PivotItemsMeasuresAxis: "columns" | "rows";
         /** @enum {string} */
         PivotItemsMeasuresPosition: "before" | "after";
+        Policy: {
+            actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
+            resourceType: components["schemas"]["PolicyResourceType"];
+            resources: string[];
+        };
+        /** @enum {string} */
+        PolicyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread";
         PostTokenBySessionIdInput: {
             sessionId: string;
         };
@@ -4160,6 +4284,7 @@ export interface components {
             canManage?: boolean | null;
             createdAt: string;
             createdBy?: number;
+            currentQueryChecksum?: string | null;
             deploymentId: number;
             description?: string | null;
             endResultCell?: string | null;
@@ -4216,16 +4341,20 @@ export interface components {
             id?: string | null;
             placedAt?: string | null;
             placedByUserId?: number | null;
+            queryChecksum?: string | null;
             refreshedAt?: string | null;
             refreshedByUserId?: number | null;
             resultLocation: string;
             sheetId?: string | null;
             sheetName?: string | null;
+            syncStatus?: components["schemas"]["ReportPlacementSyncStatus"] | null;
             workbookId: string;
             workbookName?: string | null;
         };
         /** @enum {string} */
         ReportPlacementHost: "GOOGLE_SHEETS" | "EXCEL";
+        /** @enum {string} */
+        ReportPlacementSyncStatus: "UP_TO_DATE" | "CHANGED" | "UNKNOWN";
         ReportSnapshot: {
             description?: string | null;
             fillMissingRows?: components["schemas"]["FillMissingRows"] | null;
@@ -4246,7 +4375,7 @@ export interface components {
             versionNumber: number;
         };
         /** @enum {string} */
-        ReportSnapshotDtoKind: "vega" | "table" | "kpi" | "html" | "map";
+        ReportSnapshotDtoKind: "vega" | "table" | "kpi" | "html" | "map" | "sankey";
         ReportSnapshotPreferences: {
             columnFormats?: {
                 [key: string]: components["schemas"]["ColumnFormatOverride"];
@@ -4310,6 +4439,13 @@ export interface components {
         SheetsUiSettings: {
             showAppliedFilters?: boolean | null;
         };
+        SheetsUserSettingsInput: {
+            autoRunQueryOnChange?: boolean | null;
+            openExplorationFromSheet?: boolean | null;
+            revealSheetOnOpen?: boolean | null;
+            showAppliedFilters?: boolean | null;
+            suppressDuplicateValues?: boolean | null;
+        };
         SourceTreeResponse: {
             /**
              * @deprecated
@@ -4430,6 +4566,7 @@ export interface components {
             hour?: number | null;
             isEnabled?: boolean | null;
             minute?: number | null;
+            notificationAiSummary?: boolean | null;
             notificationEnabled?: boolean | null;
             notificationFormat?: components["schemas"]["UpdateNotificationInputNotificationFormat"] | null;
             scheduleType?: components["schemas"]["UpdateNotificationInputScheduleType"] | null;
@@ -4464,6 +4601,11 @@ export interface components {
             subFormat?: string | null;
             targetEnvVar?: string | null;
         };
+        UpdatePublishedAiWidgetThreadInput: {
+            checksum?: string | null;
+            threadId: string;
+            widgetId: string;
+        };
         UpdateReportInput: {
             endResultCell?: string | null;
             externalWorkbookId?: string | null;
@@ -4522,6 +4664,15 @@ export interface components {
         UploadTransaction: {
             id: string;
         };
+        UsageAnalyticsTokenResponse: {
+            /** @description Base URL of the Usage Analytics deployment’s Cube REST API (e.g. `https://<host>/cubejs-api/v1`). Query it with the returned token. */
+            apiUrl: string;
+            /** @description Id of the Usage Analytics deployment the token was issued for. */
+            deploymentId: number;
+            expiresAt?: string | null;
+            /** @description A short-lived JWT for the Usage Analytics deployment, carrying this tenant’s security context. Send it as `Authorization: Bearer <token>` on requests to `apiUrl`. */
+            token: string;
+        };
         User: {
             activeRoleId?: number | null;
             aliases?: components["schemas"]["UserAlias"][] | null;
@@ -4545,6 +4696,7 @@ export interface components {
             title?: string | null;
             tosAccepted?: Record<string, never> | null;
             updatedAt?: (string) | null;
+            userPolicies?: components["schemas"]["Policy"][] | null;
             username: string;
         };
         UserAlias: {
@@ -4634,6 +4786,9 @@ export interface components {
             isExternal?: any | null;
             password?: string | null;
             picture?: any | null;
+            settings?: {
+                [key: string]: any;
+            } | null;
             username: string;
         };
         UserGroupDTO: {
@@ -4664,8 +4819,10 @@ export interface components {
         };
         UserSettingsInput: {
             alternatingRowColors?: boolean | null;
+            defaultDeploymentId?: number | null;
             lastSeenChangelogId?: number | null;
             locale?: string | null;
+            sheets?: components["schemas"]["SheetsUserSettingsInput"] | null;
             theme?: string | null;
             timezone?: string | null;
         };
@@ -6445,7 +6602,12 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        /** @description CreateDeploymentTokenInput */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CreateDeploymentTokenInput"];
+            };
+        };
         responses: {
             200: {
                 headers: {
@@ -6659,6 +6821,33 @@ export interface operations {
             };
         };
     };
+    "WorkbooksPublicController.updatePublishedDashboardAiWidgetThread": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deploymentId: number;
+                workbookId: number;
+            };
+            cookie?: never;
+        };
+        /** @description UpdatePublishedAiWidgetThreadInput */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdatePublishedAiWidgetThreadInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["Dashboard"];
+                };
+            };
+        };
+    };
     "WorkbooksPublicController.duplicateWorkbook": {
         parameters: {
             query?: never;
@@ -8158,6 +8347,25 @@ export interface operations {
             };
         };
     };
+    "UsageAnalyticsPublicController.createToken": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["UsageAnalyticsTokenResponse"];
+                };
+            };
+        };
+    };
     "UserAttributeValuesPublicController.upsertUserAttributeValue": {
         parameters: {
             query?: never;
@@ -8517,6 +8725,30 @@ export interface operations {
             };
         };
     };
+    "UsersPublicController.updateMySettings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description UserSettings */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UserSettingsInput"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+        };
+    };
     "UsersAdminPublicController.updateUser": {
         parameters: {
             query?: never;