@cube-dev/platform-client 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +173 -0
- package/dist/react-query/deprecated.d.ts +2 -2
- package/dist/react-query/deprecated.d.ts.map +1 -1
- package/dist/schema.d.ts +6652 -1574
- package/dist/schema.d.ts.map +1 -1
- package/package.json +7 -10
package/CHANGELOG.md
CHANGED
|
@@ -9,7 +9,180 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
9
9
|
|
|
10
10
|
<!-- Curate public-facing entries here before the next release. -->
|
|
11
11
|
|
|
12
|
+
## [0.4.0] - 2026-08-27
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
|
|
16
|
+
#### dbt Sync — status, results and history
|
|
17
|
+
|
|
18
|
+
- `GET /api/v1/deployments/{deploymentId}/dbt-sync` (`DbtSyncPublicController.listDbtSyncs`) — sync run history, filterable by `status`/`trigger`, cursor-paginated. New schemas: `DbtSyncRun`, `DbtSyncRunListResponse`, `DbtSyncRunPhase`, `DbtSyncRunStats`, `DbtSyncRunTriggerContext`, `DbtSyncRunsQueryStatus`, `DbtSyncRunsQueryTrigger`.
|
|
19
|
+
- `GET /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}` (`getDbtSyncStatus`) — poll a running sync. New schemas: `DbtSyncStatusResponse`, `DbtSyncProgress`.
|
|
20
|
+
- `GET .../dbt-sync/{syncJobId}/result` (`getDbtSyncResult`) and `GET .../dbt-sync/{syncJobId}/logs` (`getDbtSyncLogs`). New schemas: `DbtSyncResultResponse`, `DbtSyncGeneratedFile`, `DbtSyncManifestStats`, `DbtSyncLogEntry`, `DbtSyncLogEntriesListResponse`.
|
|
21
|
+
- `DELETE .../dbt-sync/{syncJobId}` (`cancelDbtSync`) — cancel a running sync. New schema: `DbtSyncCancelResponse`.
|
|
22
|
+
|
|
23
|
+
#### Data model — branch cleanup, staging environments and validation
|
|
24
|
+
|
|
25
|
+
- `DELETE /build/api/v1/deployments/{deploymentId}/branches` (`DataModelPublicController.removeBranch`, `branchName` as a query param since branch names contain slashes) — deletes a branch and its git ref, re-parenting any children onto the deleted branch's own parent; `removeOnUpstream` additionally deletes the ref on the connected GitHub/GitLab remote. New schema: `DataModelWriteResponse` (shared with the existing file-write endpoints).
|
|
26
|
+
- `PUT .../branches/staging-environment` (`setBranchStagingEnvironment`) — enable or disable a branch's always-on staging environment (`<deploymentUrl>/dev-mode/{branchName}/cubejs-api/v1`). New schemas: `SetBranchStagingEnvironmentRequest`, `SetBranchStagingEnvironmentResponse`. `BranchResponse` (from `listBranches`) reads the flag back via a new `isStagingEnvironmentEnabled`.
|
|
27
|
+
- `GET .../data-model/validate` (`validateDataModel`) — compiles the deploy branch, a named branch, or the caller's dev-mode branch and reports compilation errors as a 200 response (`valid: false`), not a request error. New schemas: `DataModelValidationResponse`, `DataModelValidationError`, `DataModelValidationResponseMode`.
|
|
28
|
+
|
|
29
|
+
#### Deployment settings, versions and the spec endpoint
|
|
30
|
+
|
|
31
|
+
- `GET /api/v1/deployments/{deploymentId}/settings` (`DeploymentsPublicController.getDeploymentSettings`) — every deployment setting in one payload (secrets excluded); writes go through the existing `PUT /:deploymentId`. New schema: `DeploymentSettings` (+ its `cloudProvider`/`creationMethod`/`deployMode`/`releaseChannel`/`repoType`/`template` enums).
|
|
32
|
+
- `GET /api/v1/deployments/{deploymentId}/versions` (`listDeploymentVersions`) — the Cube versions this deployment can switch to (release-channel heads plus prior versions run before). New schemas: `DeploymentVersion`, `DeploymentVersionsResponse`, `DeploymentVersionReleaseChannel`.
|
|
33
|
+
- `PUT /api/v1/deployments/{deploymentId}` (`updateDeployment`) / `UpdateDeploymentInput` now accepts `cloudProvider`, `region`, `releaseChannel`, `releaseChannelVersion`, `releaseChannelVersionHold`, `template`, `templateVariables`, `defaultLaunchpadViewGroup`, and `launchpadTabs` — the same settings surface `GET .../settings` now reads back. `releaseChannelVersion` must be one of the versions `GET .../versions` lists for the target channel.
|
|
34
|
+
- `GET /api/v1/spec` (`OpenApiSpecPublicController.getSpec`) — the full OpenAPI 3.1 document served by the build handling the request, for runtime discovery by clients and agents.
|
|
35
|
+
|
|
36
|
+
#### Reports
|
|
37
|
+
|
|
38
|
+
- `DELETE /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbook` (`ReportsPublicController.disconnectReportFromWorkbook`) — removes a single sheet+anchor placement of a report from a spreadsheet, leaving every other placement (in this workbook and others) alone. Addressed by `placementId`, or by `externalWorkbookId` + `sheetName` + `anchorCell`. New schema: `DisconnectReportFromWorkbookInput`.
|
|
39
|
+
- `PUT .../reports/{reportId}/refresh` now takes a body: new schema `RefreshReportInput` (`placementId`, or `externalWorkbookId` + `sheetName`/`sheetId`/`anchorCell`), addressing the same way as disconnect.
|
|
40
|
+
- Report placements are now individually addressable and trackable (new `ConnectReportToWorkbookInputHost` / `CreateReportInputHost` / `UpdateReportInputHost` enums, `"GOOGLE_SHEETS" | "EXCEL"`): `ConnectReportToWorkbookInput` gained `placementId`, `sheetId`, `sheetName`, `anchorCell`, `workbookName` and `host`; `CreateReportInput` gained `host`, `sheetId` and `workbookName`; `UpdateReportInput` gained `host`, `placementId`, `sheetId` and `workbookName`. `ReportPlacement` gained the matching `id`, `host`, `sheetId`, `sheetName`, `anchorCell`, `workbookName`, plus `placedAt`/`placedByUserId` and `refreshedAt`/`refreshedByUserId` (new `ReportPlacementHost` enum). `ReportSnapshot` gained `isSourceReport` and `pythonCode`.
|
|
41
|
+
|
|
42
|
+
#### Cursor pagination on previously offset-only or unpaginated lists
|
|
43
|
+
|
|
44
|
+
- `first`/`after` → `items` + `pageInfo` cursor pagination added to: deployment env variables (`GET .../env-vars`), GitHub branches/installations/repositories (`GitHubPublicController.*`), user attributes (previously `offset`/`limit`), `GET /api/v1/regions/`, report folders, data-model branches and files (`listBranches`/`listFiles`, `BranchesListResponse`/`SourceTreeResponse`), and deployment logs/pods (`DeploymentLogsResponse`/`DeploymentPodsResponse` gain `pageInfo`). Newly-paginated responses keep the legacy `data`/`count`/`pagination` fields, marked `@deprecated`.
|
|
45
|
+
- `UserGroupsPublicController.listGroups` and `UsersPublicController.getUsers` already had `first`/`after`; what's new on both is a `search` query param (case-insensitive substring match on group name / first name, username, email).
|
|
46
|
+
- `DashboardFilterOperator` / `DashboardFilterInputOperator` gained `is_empty` / `is_not_empty`.
|
|
47
|
+
|
|
48
|
+
#### Other new fields
|
|
49
|
+
|
|
50
|
+
- New `TimezoneSettings` schema, plus `timezoneSettings` on `AppConfigResponse` and `resolvedTimezone` / `deployBranchName` / `timezoneSettings` on `AIEngineerSettings`.
|
|
51
|
+
- New `CspsConfig` schema (customer-storage-provider config, mirrored on the existing `CspsConfigInput`).
|
|
52
|
+
- `scopeDeploymentId` added to the agent-space config schemas.
|
|
53
|
+
- `measuresAxis` / `measuresPosition` added to `PivotItems` / `PivotItemsInput` (new `PivotItemsMeasuresAxis` / `PivotItemsMeasuresPosition` / `PivotItemsInputMeasuresAxis` / `PivotItemsInputMeasuresPosition` enums, `"columns" | "rows"` and `"before" | "after"`).
|
|
54
|
+
- `name` / `userCount` added to `InheritedGroupPolicyDto` and `ResourceGroupPolicyDto`.
|
|
55
|
+
- `allowChatWorkspaceAuthoring` added to `EmbedSessionSettings`.
|
|
56
|
+
- `ref` added to `StartDbtSyncInput`.
|
|
57
|
+
|
|
58
|
+
### Changed
|
|
59
|
+
|
|
60
|
+
- **BREAKING (TypeScript):** `DeploymentEnvironmentsListResponse.pagination` and `DeploymentEnvironmentTokensListResponse.pagination` moved from required to `pagination?: DeploymentsPagination | null` now that both responses also carry `items`/`pageInfo`. Code under `strictNullChecks` reading `res.pagination.currentPage` without a null check no longer compiles.
|
|
61
|
+
- **BREAKING (TypeScript):** `NotificationsPublicController.getRecipients`'s cursor params were narrowed — `first?: number | string | null` → `first?: number | null` and `after?: string | number | null` → `after?: string | null` — cleaning up a hand-declared `@OpenAPI({ parameters })` that had merged positionally with the real cursor-param types. A caller passing a numeric `after` or a stringified `first` (both accepted, if oddly typed, before) no longer compiles.
|
|
62
|
+
- `DashboardWidgetDtoType` / `DashboardWidgetInputType` no longer advertise `TABS_CONTAINER` in the type — replaced by `PARENT`, `SPACER`, `DIVIDER`, `CONTAINER` (a `CONTAINER` with `config.layout: 'tabs'` is the current shape for a tabbed container). Existing stored or sent `TABS_CONTAINER` values are still healed server-side for backward compatibility (CUB-3634), so this narrows the advertised type rather than breaking existing integrations at runtime — new code should target `CONTAINER` + `layout`.
|
|
63
|
+
- `PUT /api/v1/deployments/{deploymentId}` (`updateDeployment`) description clarified: writes are a partial merge (omitted fields are left alone, `templateVariables` is merged key-by-key), and `releaseChannelVersion` is validated against `GET .../versions`.
|
|
64
|
+
|
|
65
|
+
### Removed
|
|
66
|
+
|
|
67
|
+
- **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.
|
|
68
|
+
|
|
69
|
+
## [0.3.0] - 2026-07-30
|
|
70
|
+
|
|
71
|
+
> Supersedes `0.2.1`, which never reached npm because its publish job failed.
|
|
72
|
+
> Upgrading from `0.2.0` picks up both releases, so the `0.2.1` entries are
|
|
73
|
+
> repeated below under _Also included from the unpublished 0.2.1_.
|
|
74
|
+
|
|
75
|
+
### Added
|
|
76
|
+
|
|
77
|
+
#### Build API — a new `/build/api/v1` surface
|
|
78
|
+
|
|
79
|
+
- `POST /build/api/v1/deployments/` (`DeploymentsBuildPublicController.createDeployment`) — creates a deployment. New schemas: `CreateDeploymentInput`, `CreateDeploymentInputCloudProvider` (`cubecloud` | `aws` | `gcp`), `CreateDeploymentInputCreationMethod` (`upload` | `cubecloud` | `github` | `ssh`), `CreateDeploymentInputDeployMode` (`git` | `cli`), `CspsConfigInput`.
|
|
80
|
+
- Data-model file authoring: `GET` / `PUT` / `DELETE /build/api/v1/deployments/{deploymentId}/data-model/files` (`DataModelPublicController.listFiles` / `updateFiles` / `removeFiles`) and `POST .../data-model/files/rename` (`renameFiles`). Writes are restricted to dev-mode branches. New schemas: `DataModelFileContent`, `DataModelFilePath`, `DataModelFileRename`, `UpdateDataModelFilesInput`, `RemoveDataModelFilesInput`, `RenameDataModelFilesInput`, `DataModelWriteResponse`.
|
|
81
|
+
- Chunked data-model uploads: `POST .../data-model/upload/start`, `POST .../data-model/upload/file`, `POST .../data-model/upload/finish`, and `GET .../data-model/file-hashes` (`UploadsPublicController.*`). New schemas: `StartUploadResponse`, `UploadFileBody`, `FinishUploadBody`, `FinishUploadResponse`, `UploadTransaction`, `FileHash`, `SourceTreeResponse`.
|
|
82
|
+
- Dev mode and branch operations: `POST` / `DELETE .../dev-mode` (`startDevMode` / `stopDevMode`), `GET` / `POST .../branches` (`listBranches` / `createBranch`), `POST .../commit`, `POST .../pull`, `POST .../merge`, `POST .../merge-to-default`. The dev-mode endpoints return the real dev branch. New schemas: `StartDevModeRequest`, `DevBranchResponse`, `BranchResponse`, `BranchesListResponse`, `CommitChangesRequest`, `PullRequest`, `PullResponse`, `MergeIntoParentBranchRequest`, `MergeToDefaultBranchRequest`, `MergeResponse`.
|
|
83
|
+
- `POST /build/api/v1/deployments/{deploymentId}/github/connect` (`GitHubDeploymentPublicController.connect`) — connects a deployment to a GitHub repository. New schema: `ConnectGitHubRequest`.
|
|
84
|
+
|
|
85
|
+
#### Deployment management
|
|
86
|
+
|
|
87
|
+
- `PUT /api/v1/deployments/{deploymentId}` (`DeploymentsPublicController.updateDeployment`) and `DELETE /api/v1/deployments/{deploymentId}` (`deleteDeployment`). New schemas: `UpdateDeploymentInput`, `UpdateDeploymentInputCreationMethod`, `UpdateDeploymentInputDeployMode`, `DeploymentDeleteResponse`.
|
|
88
|
+
- `GET /api/v1/deployments/{deploymentId}/build-status` (`buildStatus`) — current build/deploy state for a branch. New schema: `BuildStatusResponse`.
|
|
89
|
+
- `GET /api/v1/deployments/{deploymentId}/logs` (`logs`) — container logs, filterable by source and container. New schemas: `DeploymentLogsResponse`, `DeploymentLogLine`, `DeploymentLogsQuerySource` (`production` | `dev`), `DeploymentLogsQueryContainer` (`INIT` | `MAIN` | `cubejs-server` | `vector` | `api-proxy`).
|
|
90
|
+
- `GET /api/v1/deployments/{deploymentId}/pods` (`pods`). New schemas: `DeploymentPodsResponse`, `DeploymentPod`.
|
|
91
|
+
- `GET` / `PUT /api/v1/deployments/{deploymentId}/env-vars` (`EnvVariablesPublicController.getEnvVariables` / `setEnvVariables`). New schemas: `EnvVariablesListResponse`, `EnvVariableItem`, `SetEnvVariablesInput`.
|
|
92
|
+
- `POST /api/v1/deployments/{deploymentId}/creation-step/advance` and `.../creation-step/reset` (`advanceCreationStep` / `resetCreationStep`) for driving the deployment setup wizard. New schema: `AdvanceCreationStepInput`.
|
|
93
|
+
- `GET /api/v1/regions/` (`RegionsPublicController.listRegions`) — regions available to the tenant. New schemas: `RegionsListResponse`, `RegionResponse`.
|
|
94
|
+
|
|
95
|
+
#### Users, attributes and tenant settings
|
|
96
|
+
|
|
97
|
+
- Console user administration: `POST` / `PUT` / `DELETE /api/v1/users/{id}` and `POST /api/v1/users/` (`UsersAdminPublicController.createUser` / `updateUser` / `deleteUser`). New schemas: `UserCreateInput`, `UserUpdateInput`.
|
|
98
|
+
- `POST /api/v1/users/bulk` (`bulkUserAction`) — activate, deactivate or delete many users in one call, with per-user failure reporting. New schemas: `BulkUserActionInput`, `BulkUserActionInputAction` (`DEACTIVATE` | `ACTIVATE` | `DELETE`), `BulkUserActionPayload`, `BulkUserActionResponseAction`, `BulkUserActionFailure`.
|
|
99
|
+
- Tenant-level user attributes: `GET` / `POST /api/v1/user-attributes/` and `PUT /api/v1/user-attributes/{id}` (`UserAttributesPublicController.*`). New schemas: `UserAttribute`, `UserAttributesListResponse`, `UserAttributeCreateInput`, `UserAttributeUpdateInput`, `UserAttributeType` / `UserAttributeCreateInputType` / `GetUserAttributesQueryType` (`string` | `number` | `boolean` | `string_array` | `number_array`).
|
|
100
|
+
- Per-user attribute values: `GET /api/v1/user-attribute-values/{userId}` and `POST /api/v1/user-attribute-values/` (`UserAttributeValuesPublicController.getUserAttributeValues` / `upsertUserAttributeValue`). New schemas: `UserAttributeValue`, `UserAttributeValueType`, `UserAttributeValueCreateInput`.
|
|
101
|
+
- `GET` / `PUT /api/v1/tenant/settings` (`TenantSettingsPublicController.getTenantSettings` / `updateTenantSettings`) — audit log, maintenance window, support access, OIDC and AI/BI interface toggles. New schemas: `TenantSettings`, `TenantSettingsInput`.
|
|
102
|
+
|
|
103
|
+
#### OAuth, OIDC and GitHub integrations
|
|
104
|
+
|
|
105
|
+
- OAuth integration management: `GET` / `POST /api/v1/oauth-integrations/` and `GET` / `PUT` / `DELETE /api/v1/oauth-integrations/{id}` (`OAuthIntegrationsPublicController.*`). New schemas: `OAuthIntegration`, `CreateOAuthIntegrationInput`, `UpdateOAuthIntegrationInput`.
|
|
106
|
+
- Per-user OAuth tokens: `GET /api/v1/user-oauth-tokens/`, `GET` / `DELETE /api/v1/user-oauth-tokens/{integrationId}`, and `POST /api/v1/user-oauth-tokens/{integrationId}/initiate` (`UserOAuthTokensPublicController.*`). New schema: `UserOAuthToken`.
|
|
107
|
+
- OIDC token configuration: `GET` / `POST /api/v1/oidc-token-configs/` and `GET` / `PUT` / `DELETE /api/v1/oidc-token-configs/{id}` (`OidcTokenConfigsPublicController.*`). New schemas: `OidcTokenConfig`, `CreateOidcTokenConfigInput`, `UpdateOidcTokenConfigInput`.
|
|
108
|
+
- GitHub app discovery: `GET /api/v1/github/status`, `GET /api/v1/github/installations`, `GET /api/v1/github/installations/{installationId}/repositories`, and `GET /api/v1/github/repositories/{owner}/{repo}/branches` (`GitHubPublicController.*`). New schemas: `GitHubConnectStatusResponse`, `GitHubInstallationsListResponse`, `GitHubInstallationResponse`, `GitHubReposListResponse`, `GitHubRepoResponse`, `GitHubBranchesListResponse`, `GitHubBranchResponse`.
|
|
109
|
+
|
|
110
|
+
#### Embed tenants, groups and dashboard embedding
|
|
111
|
+
|
|
112
|
+
- `GET /api/v1/embed-tenants/` (`EmbedTenantAdminPublicController.listEmbedTenants`) and `GET /api/v1/embed-tenants/{embedTenantName}/users` (`listEmbedUsers`). New schemas: `EmbedTenantsPublicResponse`, `EmbedTenant`, `EmbedUsersPublicResponse`, `EmbedUser`.
|
|
113
|
+
- Embed group management: `POST /api/v1/embed-tenants/{embedTenantName}/groups` (`createGroup`), `GET` / `PATCH /api/v1/embed-tenants/{embedTenantName}/groups/{id}` (`getGroup` / `updateGroup`), and membership via `GET` / `POST` / `DELETE .../groups/{id}/users` (`getGroupMembers` / `addGroupMembers` / `removeGroupMembers`). New schemas: `CreateEmbedGroupInput`, `UpdateEmbedGroupInput`, `EmbedGroupMemberInput`, `EmbedGroupMembersInput`, `EmbedGroupMembersMutationResponse`.
|
|
114
|
+
- `GET` / `PUT /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access` (`DashboardEmbedAccessPublicController.getEmbedAccess` / `updateEmbedAccess`) — grant or revoke dashboard access per embed tenant, or for all embed users. New schemas: `EmbedAccessResponse`, `EmbedAccessTenantEntry`, `EmbedAccessAllEmbedUsers`, `UpdateEmbedAccessInput`, and the `read` | `none` action enums `EmbedAccessTenantEntryAction`, `EmbedAccessAllEmbedUsersAction`, `UpdateEmbedAccessInputAction`.
|
|
115
|
+
- `PATCH /api/v1/embed/dashboard/{publicId}` (`EmbedPublicController.updateDashboardEmbedding`) — enable or disable signed embedding for a dashboard. New schemas: `UpdateDashboardEmbeddingInput`, `DashboardEmbeddingResponse`.
|
|
116
|
+
- `POST /api/v1/embed/dashboard/{publicId}/python-run` (`EmbedPublicController.postDashboardPythonRun`) — runs a Python report on an embed surface with dashboard filters applied. New schemas: `EmbedPythonFilteredRunInput`, `PythonAnalysisFilteredRun`.
|
|
117
|
+
- The embed session request (`GenerateSession`) accepts a `settings` object. New schema: `EmbedSessionSettings` (`showDashboardChat`).
|
|
118
|
+
|
|
119
|
+
#### Workspace, workbooks and reports
|
|
120
|
+
|
|
121
|
+
- `POST /api/v1/deployments/{deploymentId}/workspace/bulk-delete` and `.../workspace/bulk-move` (`WorkspacePublicController.bulkDeleteWorkspaceObjects` / `bulkMoveWorkspaceObjects`) — delete or move folders, workbooks and reports in one call, with per-item failure reporting. New schemas: `BulkDeleteWorkspaceObjectsInput`, `BulkDeleteWorkspaceObjectsPayload`, `BulkMoveWorkspaceObjectsInput`, `BulkMoveWorkspaceObjectsResponse`, `WorkspaceItemRef`, `WorkspaceItemRefInput`, `WorkspaceBulkFailure`, `BulkActionError`, and the `FOLDER` | `WORKBOOK` | `REPORT` enums `WorkspaceItemRefType`, `WorkspaceItemRefInputType`, `WorkspaceBulkFailureType`.
|
|
122
|
+
- `PUT /api/v1/deployments/{deploymentId}/workbooks/by-slug/{slug}` (`WorkbooksPublicController.upsertWorkbookBySlug`) and `PUT /api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}` (`ReportsPublicController.upsertReportByPublicId`) — create-or-update by stable external identifier.
|
|
123
|
+
- `Folder`, `Workbook` and `Report` responses now include `folderPath`, the ancestor chain of the containing folder. New schema: `WorkspaceFolderPathEntry`.
|
|
124
|
+
- `ReportSnapshot` now includes `periodComparisons` for period-over-period measures. New schemas: `PeriodComparison` (`measure`, `timeDimension`, `offset`, `outputs`), `PeriodComparisonOffset` (`amount`, `unit`).
|
|
125
|
+
- `UpdateReportInput` now accepts `publicId`.
|
|
126
|
+
- `PublishDashboardInput` now accepts `allowEmbed`.
|
|
127
|
+
|
|
128
|
+
#### Dashboard apps
|
|
129
|
+
|
|
130
|
+
- `DashboardConfig` and `DashboardConfigInput` now carry `kind` and `app`, so a dashboard can be an app of authored files rather than a widget document. New schemas: `DashboardAppSource`, `DashboardAppSourceInput`, `DashboardAppManifest`, `DashboardAppManifestInput`, and the `CLASSIC` | `APP` enums `DashboardConfigKind`, `DashboardConfigInputKind`.
|
|
131
|
+
|
|
132
|
+
#### App configuration
|
|
133
|
+
|
|
134
|
+
- `AppConfigResponse` now includes `sheetsUi`. New schema: `SheetsUiSettings` (`showAppliedFilters`).
|
|
135
|
+
- `EmbedSettings` now includes `showDashboardChat`.
|
|
136
|
+
- `AIEngineerSettings` now includes `agentsConfigCredentials`.
|
|
137
|
+
|
|
138
|
+
#### Also included from the unpublished 0.2.1
|
|
139
|
+
|
|
140
|
+
- `POST /api/v1/deployments/{deploymentId}/dbt-sync` operation (`DbtSyncPublicController.startDbtSync`) — starts a dbt sync for a deployment, optionally on a specific branch. New schemas: `StartDbtSyncInput` (`branchName`), `DbtSyncResponse` (`branchName`, `syncJobId`, `workflowId`).
|
|
141
|
+
- `PUT /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbook` operation (`ReportsPublicController.connectReportToWorkbook`) — links a report to the caller's own spreadsheet by recording its placement, and returns the updated `Report`. Requires only read access to the report. New schema: `ConnectReportToWorkbookInput` (`externalWorkbookId`, `resultLocation`, `endResultCell`).
|
|
142
|
+
- New `SecretsManage` and `DownloadData` RBAC actions, available across all policy action enums (`RoleWithAccess.actions`, the inherited/resource user & group policy actions, and the update-policy request bodies).
|
|
143
|
+
- `AIEngineerSettings` now includes `chatThreadPolicies`. New schemas: `ChatThreadPolicy` (`actions`, `effect`, `resourceType`, `resources`), `ChatThreadPolicyEffect` (`allow` | `deny`), `ChatThreadPolicyResourceType`.
|
|
144
|
+
- `GET /api/v1/deployments/{deploymentId}/reports` accepts a new `search` query filter.
|
|
145
|
+
- `Report` now includes `canEdit`, `canManage`, and `externalWorkbookPlacements` — a report can be placed in multiple spreadsheets. New schema: `ReportPlacement` (`workbookId`, `resultLocation`, `endResultCell`).
|
|
146
|
+
- `ReportSnapshot` now includes `fillMissingRows`. New schema: `FillMissingRows` (`member`, `excludedDimensions`).
|
|
147
|
+
- `CreatorMode` now includes `showGeneratedSql` and `showSemanticSql` toggles.
|
|
148
|
+
- `Dashboard` now includes `restrictDataDownload` and `useBoardDashboards`.
|
|
149
|
+
- `UpdatePublishedAiWidgetThreadInput` accepts an optional `checksum`.
|
|
150
|
+
|
|
151
|
+
### Changed
|
|
152
|
+
|
|
153
|
+
- **BREAKING:** the `deleteEmbedTenant` operation moved from `DELETE /api/v1/embed-tenants/{embedTenantName}/` to `DELETE /api/v1/embed-tenants/{embedTenantName}` — the trailing slash is gone, so the typed path key changed.
|
|
154
|
+
- `deleteEmbedTenant` and `deleteGroup` now document their `204` responses, and the embed-tenant path parameters carry descriptions.
|
|
155
|
+
- `DashboardConfigInput.widgets` is now optional. (from the unpublished `0.2.1`)
|
|
156
|
+
|
|
157
|
+
### Removed
|
|
158
|
+
|
|
159
|
+
- **BREAKING:** removed the `GET /api/v1/ai-engineer/active-region` operation (`AIEngineerPublicController.getMyActiveAgentRegion`) and the `ActiveAgentRegion` schema. Use `GET /api/v1/regions/` to discover regions.
|
|
160
|
+
|
|
161
|
+
## [0.2.1] - 2026-07-20
|
|
162
|
+
|
|
163
|
+
> **Never published to npm.** The publish job for this version failed, so `0.2.1`
|
|
164
|
+
> does not exist on the registry. Everything below shipped in `0.3.0`, which
|
|
165
|
+
> repeats these entries in its own section.
|
|
166
|
+
|
|
167
|
+
### Added
|
|
168
|
+
|
|
169
|
+
- `POST /api/v1/deployments/{deploymentId}/dbt-sync` operation (`DbtSyncPublicController.startDbtSync`) — starts a dbt sync for a deployment, optionally on a specific branch. New schemas: `StartDbtSyncInput` (`branchName`), `DbtSyncResponse` (`branchName`, `syncJobId`, `workflowId`).
|
|
170
|
+
- `PUT /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbook` operation (`ReportsPublicController.connectReportToWorkbook`) — links a report to the caller's own spreadsheet by recording its placement, and returns the updated `Report`. Requires only read access to the report. New schema: `ConnectReportToWorkbookInput` (`externalWorkbookId`, `resultLocation`, `endResultCell`).
|
|
171
|
+
- New `SecretsManage` and `DownloadData` RBAC actions, available across all policy action enums (`RoleWithAccess.actions`, the inherited/resource user & group policy actions, and the update-policy request bodies).
|
|
172
|
+
- `AIEngineerSettings` now includes `chatThreadPolicies`. New schemas: `ChatThreadPolicy` (`actions`, `effect`, `resourceType`, `resources`), `ChatThreadPolicyEffect` (`allow` | `deny`), `ChatThreadPolicyResourceType`.
|
|
173
|
+
- `GET /api/v1/deployments/{deploymentId}/reports` accepts a new `search` query filter.
|
|
174
|
+
- `Report` now includes `canEdit`, `canManage`, and `externalWorkbookPlacements` — a report can be placed in multiple spreadsheets. New schema: `ReportPlacement` (`workbookId`, `resultLocation`, `endResultCell`).
|
|
175
|
+
- `ReportSnapshot` now includes `fillMissingRows`. New schema: `FillMissingRows` (`member`, `excludedDimensions`).
|
|
176
|
+
- `CreatorMode` now includes `showGeneratedSql` and `showSemanticSql` toggles.
|
|
177
|
+
- `Dashboard` now includes `restrictDataDownload` and `useBoardDashboards`.
|
|
178
|
+
- `UpdatePublishedAiWidgetThreadInput` accepts an optional `checksum`.
|
|
179
|
+
|
|
180
|
+
### Changed
|
|
181
|
+
|
|
182
|
+
- `DashboardConfigInput.widgets` is now optional.
|
|
183
|
+
|
|
12
184
|
## [0.2.0] - 2026-07-02
|
|
185
|
+
|
|
13
186
|
### Added
|
|
14
187
|
|
|
15
188
|
- `POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread` operation (`WorkbooksPublicController.updatePublishedDashboardAiWidgetThread`) — attaches an AI widget thread to a published dashboard and returns the updated `Dashboard`. New schema: `UpdatePublishedAiWidgetThreadInput` (`threadId`, `widgetId`).
|
|
@@ -11,11 +11,11 @@ export type CubeCloudApiProviderProps = CubePlatformApiProviderProps;
|
|
|
11
11
|
/** @deprecated Renamed to {@link useCubePlatformApi}. */
|
|
12
12
|
export declare const useCubeCloudApi: typeof useCubePlatformApi;
|
|
13
13
|
/** @deprecated Renamed to {@link useCubePlatformApiQuery}. */
|
|
14
|
-
export declare const useCubeCloudApiQuery: <Method extends HttpMethod, Path extends PathsWithMethod<paths, Method>, Init extends import("openapi-fetch").MaybeOptionalInit<paths[Path], Method>, Response extends Required<import("openapi-fetch").FetchResponse<paths[Path][Method] & Record<string, any>, Init, import("openapi-typescript-helpers").MediaType>>, Options extends Omit<import("@tanstack/react-query").UseQueryOptions<Response[
|
|
14
|
+
export declare const useCubeCloudApiQuery: <Method extends HttpMethod, Path extends PathsWithMethod<paths, Method>, Init extends import("openapi-fetch").MaybeOptionalInit<paths[Path], Method>, Response extends Required<import("openapi-fetch").FetchResponse<paths[Path][Method] & Record<string, any>, Init, import("openapi-typescript-helpers").MediaType>>, Options extends Omit<import("@tanstack/react-query").UseQueryOptions<Response['data'], any, Options["select"] extends infer T ? T extends Options["select"] ? T extends (data: Response["data"]) => infer R ? R : Response["data"] : never : never, any>, 'queryKey' | 'queryFn'>>(method: Method, url: Path, ...[init, options, queryClient]: import("openapi-typescript-helpers").RequiredKeysOf<Init> extends never ? [(Init & {
|
|
15
15
|
[key: string]: unknown;
|
|
16
16
|
})?, Options?, import("@tanstack/query-core").QueryClient?] : [Init & {
|
|
17
17
|
[key: string]: unknown;
|
|
18
|
-
}, Options?, import("@tanstack/query-core").QueryClient?]) => import("@tanstack/react-query").UseQueryResult<Options["select"] extends infer
|
|
18
|
+
}, Options?, import("@tanstack/query-core").QueryClient?]) => import("@tanstack/react-query").UseQueryResult<Options["select"] extends infer T ? T extends Options["select"] ? T extends (data: Response["data"]) => infer R ? R : Response["data"] : never : never, any>;
|
|
19
19
|
/** @deprecated Renamed to {@link useCubePlatformApiSuspenseQuery}. */
|
|
20
20
|
export declare const useCubeCloudApiSuspenseQuery: import("openapi-react-query").UseSuspenseQueryMethod<paths, `${string}/${string}`>;
|
|
21
21
|
/** @deprecated Renamed to {@link useCubePlatformApiMutation}. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deprecated.d.ts","sourceRoot":"","sources":["../../src/react-query/deprecated.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,kBAAkB,EAIlB,2BAA2B,EAE5B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACjF,OAAO,KAAK,EAAE,uBAAuB,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB,gCAA0B,CAAC;AAC5D,mEAAmE;AACnE,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAErE,yDAAyD;AACzD,eAAO,MAAM,eAAe,2BAAqB,CAAC;AAClD,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB
|
|
1
|
+
{"version":3,"file":"deprecated.d.ts","sourceRoot":"","sources":["../../src/react-query/deprecated.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,kBAAkB,EAIlB,2BAA2B,EAE5B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACjF,OAAO,KAAK,EAAE,uBAAuB,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB,gCAA0B,CAAC;AAC5D,mEAAmE;AACnE,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAErE,yDAAyD;AACzD,eAAO,MAAM,eAAe,2BAAqB,CAAC;AAClD,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB;;;;yQAA0B,CAAC;AAC5D,sEAAsE;AACtE,eAAO,MAAM,4BAA4B,oFAAkC,CAAC;AAC5E,iEAAiE;AACjE,eAAO,MAAM,uBAAuB,+EAA6B,CAAC;AAClE,kEAAkE;AAClE,eAAO,MAAM,wBAAwB,oCAA8B,CAAC;AACpE,qEAAqE;AACrE,eAAO,MAAM,2BAA2B,kFAAiC,CAAC;AAE1E,8DAA8D;AAC9D,MAAM,MAAM,oBAAoB,CAC9B,MAAM,SAAS,UAAU,EACzB,IAAI,SAAS,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,IACzC,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE1C,wEAAwE;AACxE,MAAM,MAAM,8BAA8B,CAAC,KAAK,EAAE,MAAM,IAAI,iCAAiC,CAC3F,KAAK,EACL,MAAM,CACP,CAAC"}
|