@cube-dev/platform-client 0.23.0 → 0.23.1

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.23.1] - 2026-10-23
+
+### Changed
+
+- `useCubePlatformApiLazyQuery` declares its parameters (`method`, `path`, `init`, `options`, `queryClient`) and is generic over the method and path. Calls stay the same. The hooks no longer infer their parameters over every path, which exceeded the compiler's type instantiation depth.
+- The descriptions of `GET` and `PUT /api/v1/deployments/{deploymentId}/env-vars` now explain that a deployment connects to its databases through environment variables (`CUBEJS_DB_*` for the default data source, `CUBEJS_DS_<NAME>_DB_*` for additional ones) and that saving does not test the connection. Their summaries are now "List environment variables, including the database connection settings" and "Set environment variables, including connecting or changing a database".
+- The descriptions of `POST /build/api/v1/deployments` and `POST /api/v1/deployments/{deploymentId}/creation-step/advance` now say that neither connects a data source; set the database variables with `PUT /api/v1/deployments/{deploymentId}/env-vars`.
+
 ## [0.23.0] - 2026-10-22
 
 ### Added

package/dist/react-query/hooks.d.ts

@@ -35,7 +35,7 @@ export declare const useCubePlatformApiQuery: UseQueryMethodWithAnyError;
 export declare const useCubePlatformApiSuspenseQuery: CubePlatformQueryClient['useSuspenseQuery'];
 export declare const useCubePlatformApiMutation: CubePlatformQueryClient['useMutation'];
 export declare const useCubePlatformApiQueryOptions: CubePlatformQueryClient['queryOptions'];
-type UseQueryParams = Parameters<CubePlatformQueryClient['useQuery']>;
-export declare function useCubePlatformApiLazyQuery(...args: UseQueryParams): UseCubePlatformApiLazyQueryResult<unknown, unknown>;
+type LazyQueryOptions = Omit<UseQueryOptions, 'queryKey' | 'queryFn'>;
+export declare function useCubePlatformApiLazyQuery<Method extends HttpMethod, Path extends PathsWithMethod<paths, Method>, Init extends MaybeOptionalInit<paths[Path], Method>>(method: Method, path: Path, ...[init, options, reactQueryClient]: RequiredKeysOf<Init> extends never ? [InitWithUnknowns<Init>?, LazyQueryOptions?, QueryClient?] : [InitWithUnknowns<Init>, LazyQueryOptions?, QueryClient?]): UseCubePlatformApiLazyQueryResult<unknown, unknown>;
 export {};
 //# sourceMappingURL=hooks.d.ts.map

package/dist/react-query/hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/react-query/hooks.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,eAAe,EACf,cAAc,EACf,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAGpE,KAAK,uBAAuB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;AAGzD,KAAK,gBAAgB,CAAC,IAAI,IAAI,IAAI,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAChE,KAAK,qBAAqB,CAAC,KAAK,EAAE,OAAO,IAAI,OAAO,SAAS,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAIlG,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEhD;;;GAGG;AAEH,KAAK,0BAA0B,GAAG,CAChC,MAAM,SAAS,UAAU,EACzB,IAAI,SAAS,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,EAC3C,IAAI,SAAS,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,EACnD,QAAQ,SAAS,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,EAC7F,OAAO,SAAS,IAAI,CAClB,eAAe,CACb,QAAQ,CAAC,MAAM,CAAC,EAEhB,GAAG,EACH,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAE1D,GAAG,CACJ,EACD,UAAU,GAAG,SAAS,CACvB,EAED,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,IAAI,EACT,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,KAAK,GAC/D,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,GACjD,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,KACjD,cAAc,CACjB,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAE1D,GAAG,CACJ,CAAC;AAqBF;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,IAAI,uBAAuB,CAE5D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,EAOnB,0BAA0B,CAAC;AAE5C,eAAO,MAAM,+BAA+B,EAAE,uBAAuB,CAAC,kBAAkB,CAQvC,CAAC;AAIlD,eAAO,MAAM,0BAA0B,EAAE,uBAAuB,CAAC,aAAa,CA8BvB,CAAC;AAExD,eAAO,MAAM,8BAA8B,EAAE,uBAAuB,CAAC,cAAc,CAO3B,CAAC;AAEzD,KAAK,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC;AAEtE,wBAAgB,2BAA2B,CACzC,GAAG,IAAI,EAAE,cAAc,GACtB,iCAAiC,CAAC,OAAO,EAAE,OAAO,CAAC,CAyBrD"}
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/react-query/hooks.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,eAAe,EACf,cAAc,EACf,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAGpE,KAAK,uBAAuB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;AAGzD,KAAK,gBAAgB,CAAC,IAAI,IAAI,IAAI,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAChE,KAAK,qBAAqB,CAAC,KAAK,EAAE,OAAO,IAAI,OAAO,SAAS,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAIlG,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEhD;;;GAGG;AAEH,KAAK,0BAA0B,GAAG,CAChC,MAAM,SAAS,UAAU,EACzB,IAAI,SAAS,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,EAC3C,IAAI,SAAS,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,EACnD,QAAQ,SAAS,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,EAC7F,OAAO,SAAS,IAAI,CAClB,eAAe,CACb,QAAQ,CAAC,MAAM,CAAC,EAEhB,GAAG,EACH,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAE1D,GAAG,CACJ,EACD,UAAU,GAAG,SAAS,CACvB,EAED,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,IAAI,EACT,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,KAAK,GAC/D,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,GACjD,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,CAAC,KACjD,cAAc,CACjB,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAE1D,GAAG,CACJ,CAAC;AAqBF;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,IAAI,uBAAuB,CAE5D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,EAOnB,0BAA0B,CAAC;AAE5C,eAAO,MAAM,+BAA+B,EAAE,uBAAuB,CAAC,kBAAkB,CAO5B,CAAC;AAI7D,eAAO,MAAM,0BAA0B,EAAE,uBAAuB,CAAC,aAAa,CA8BvB,CAAC;AAExD,eAAO,MAAM,8BAA8B,EAAE,uBAAuB,CAAC,cAAc,CAO3B,CAAC;AAEzD,KAAK,gBAAgB,GAAG,IAAI,CAAC,eAAe,EAAE,UAAU,GAAG,SAAS,CAAC,CAAC;AAEtE,wBAAgB,2BAA2B,CACzC,MAAM,SAAS,UAAU,EACzB,IAAI,SAAS,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,EAC3C,IAAI,SAAS,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,EAEnD,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,KAAK,GACpE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE,WAAW,CAAC,CAAC,GAC1D,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,EAAE,WAAW,CAAC,CAAC,GAC5D,iCAAiC,CAAC,OAAO,EAAE,OAAO,CAAC,CAiBrD"}

package/dist/react-query/hooks.js

@@ -34,13 +34,14 @@ export function useCubePlatformApi() {
 export const useCubePlatformApiQuery = ((...args) => {
     // eslint-disable-next-line react-hooks/rules-of-hooks
     const queryClient = useCubePlatformApiContext();
+    // Untyped inside: inferring the client's parameters over every path exceeds
+    // the compiler's instantiation depth. The cast below is the public type.
     return queryClient.useQuery(...args);
 });
 export const useCubePlatformApiSuspenseQuery = ((...args) => {
     // eslint-disable-next-line react-hooks/rules-of-hooks
     const queryClient = useCubePlatformApiContext();
-    const result = queryClient.useSuspenseQuery(...args);
-    return result;
+    return queryClient.useSuspenseQuery(...args);
 });
 export const useCubePlatformApiMutation = ((method, path, options, queryClient) => {
     const { client, ...restOptions } = options ?? {};
@@ -65,11 +66,9 @@ export const useCubePlatformApiQueryOptions = ((...args) => {
     const queryClient = useCubePlatformApiContext();
     return queryClient.queryOptions(...args);
 });
-export function useCubePlatformApiLazyQuery(...args) {
-    const [method, path, init, options, reactQueryClient] = args;
-    const result = useCubePlatformApiQuery(method, path, init, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    { ...options, enabled: false }, reactQueryClient);
+export function useCubePlatformApiLazyQuery(method, path, ...[init, options, reactQueryClient]) {
+    const useQuery = useCubePlatformApiQuery;
+    const result = useQuery(method, path, init, { ...options, enabled: false }, reactQueryClient);
     const trigger = useCallback(async () => {
         const { data } = await result.refetch();
         return data;

package/dist/react-query/hooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/react-query/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,wBAAwB,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EACL,sBAAsB,GAEvB,MAAM,8BAA8B,CAAC;AA0DtC,SAAS,yBAAyB;IAChC,MAAM,OAAO,GAAG,UAAU,CAAC,sBAAsB,CAAuC,CAAC;IAEzF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,yEAAyE;YACvE,0EAA0E,CAC7E,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC;AAC7B,CAAC;AAED,SAAS,iCAAiC;IACxC,MAAM,OAAO,GAAG,UAAU,CAAC,sBAAsB,CAAuC,CAAC;IAEzF,OAAO,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;AACtC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,yBAAyB,EAAE,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CACtC,GAAG,IAAqD,EACxD,EAAE;IACF,sDAAsD;IACtD,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAEhD,OAAO,WAAW,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC,CAA0C,CAAC;AAE5C,MAAM,CAAC,MAAM,+BAA+B,GAAgD,CAAC,CAC3F,GAAG,IAA6D,EAChE,EAAE;IACF,sDAAsD;IACtD,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAChD,MAAM,MAAM,GAAG,WAAW,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;IAErD,OAAO,MAA2D,CAAC;AACrE,CAAC,CAAgD,CAAC;AAIlD,MAAM,CAAC,MAAM,0BAA0B,GAA2C,CAAC,CACjF,MAAyB,EACzB,IAAuB,EACvB,OAA6D,EAC7D,WAAyB,EACzB,EAAE;IACF,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEjD,sDAAsD;IACtD,MAAM,kBAAkB,GAAG,iCAAiC,EAAE,CAAC;IAE/D,sDAAsD;IACtD,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,EAAE;QACrC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,wBAAwB,CAAQ,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,mBAAmB,GAAG,iBAAiB,IAAI,kBAAkB,CAAC;IAEpE,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,yFAAyF;YACvF,+GAA+G,CAClH,CAAC;IACJ,CAAC;IAED,OAAO,mBAAmB,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AACjF,CAAC,CAAsD,CAAC;AAExD,MAAM,CAAC,MAAM,8BAA8B,GAA4C,CAAC,CACtF,GAAG,IAAyD,EAC5D,EAAE;IACF,sDAAsD;IACtD,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAEhD,OAAO,WAAW,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC;AAC3C,CAAC,CAAuD,CAAC;AAIzD,MAAM,UAAU,2BAA2B,CACzC,GAAG,IAAoB;IAEvB,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE7D,MAAM,MAAM,GAAG,uBAAuB,CACpC,MAAM,EACN,IAAI,EACJ,IAAI;IACJ,8DAA8D;IAC9D,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,KAAK,EAAS,EACrC,gBAAgB,CACjB,CAAC;IAEF,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QACrC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QAExC,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO;QACL,OAAO;QACP,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,SAAS,EAAE,MAAM,CAAC,UAAU;QAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/react-query/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,wBAAwB,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EACL,sBAAsB,GAEvB,MAAM,8BAA8B,CAAC;AA0DtC,SAAS,yBAAyB;IAChC,MAAM,OAAO,GAAG,UAAU,CAAC,sBAAsB,CAAuC,CAAC;IAEzF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,yEAAyE;YACvE,0EAA0E,CAC7E,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC;AAC7B,CAAC;AAED,SAAS,iCAAiC;IACxC,MAAM,OAAO,GAAG,UAAU,CAAC,sBAAsB,CAAuC,CAAC;IAEzF,OAAO,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;AACtC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,yBAAyB,EAAE,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,GAAG,IAAe,EAAE,EAAE;IAC7D,sDAAsD;IACtD,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAEhD,4EAA4E;IAC5E,yEAAyE;IACzE,OAAQ,WAAW,CAAC,QAAoD,CAAC,GAAG,IAAI,CAAC,CAAC;AACpF,CAAC,CAA0C,CAAC;AAE5C,MAAM,CAAC,MAAM,+BAA+B,GAAgD,CAAC,CAC3F,GAAG,IAAe,EAClB,EAAE;IACF,sDAAsD;IACtD,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAEhD,OAAQ,WAAW,CAAC,gBAA4D,CAAC,GAAG,IAAI,CAAC,CAAC;AAC5F,CAAC,CAA2D,CAAC;AAI7D,MAAM,CAAC,MAAM,0BAA0B,GAA2C,CAAC,CACjF,MAAyB,EACzB,IAAuB,EACvB,OAA6D,EAC7D,WAAyB,EACzB,EAAE;IACF,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEjD,sDAAsD;IACtD,MAAM,kBAAkB,GAAG,iCAAiC,EAAE,CAAC;IAE/D,sDAAsD;IACtD,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,EAAE;QACrC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,wBAAwB,CAAQ,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,MAAM,mBAAmB,GAAG,iBAAiB,IAAI,kBAAkB,CAAC;IAEpE,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CACb,yFAAyF;YACvF,+GAA+G,CAClH,CAAC;IACJ,CAAC;IAED,OAAO,mBAAmB,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AACjF,CAAC,CAAsD,CAAC;AAExD,MAAM,CAAC,MAAM,8BAA8B,GAA4C,CAAC,CACtF,GAAG,IAAe,EAClB,EAAE;IACF,sDAAsD;IACtD,MAAM,WAAW,GAAG,yBAAyB,EAAE,CAAC;IAEhD,OAAQ,WAAW,CAAC,YAAwD,CAAC,GAAG,IAAI,CAAC,CAAC;AACxF,CAAC,CAAuD,CAAC;AAIzD,MAAM,UAAU,2BAA2B,CAKzC,MAAc,EACd,IAAU,EACV,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,gBAAgB,CAE0B;IAE7D,MAAM,QAAQ,GAAG,uBAAyE,CAAC;IAC3F,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,gBAAgB,CAAC,CAAC;IAE9F,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QACrC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QAExC,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO;QACL,OAAO;QACP,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,SAAS,EAAE,MAAM,CAAC,UAAU;QAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC"}

package/dist/schema.d.ts

@@ -130,6 +130,92 @@ export interface paths {
         patch: operations["ScimUsersPublicController.patchUser"];
         trace?: never;
     };
+    "/api/v1/access-requests/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List pending access requests
+         * @description List the pending access requests for a workbook, dashboard, or folder, oldest first. Requires permission to share it. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        get: operations["AccessRequestsPublicController.listAccessRequests"];
+        put?: never;
+        /**
+         * Request access
+         * @description Ask for access to a workbook, dashboard, or folder you cannot open. The owner and the users with Full access to it get an inbox notification.
+         *
+         *     A dashboard request is a request for its workbook. While a request is pending, sending it again returns the same request and notifies nobody. Returns `409` if you already have the requested access. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        post: operations["AccessRequestsPublicController.createAccessRequest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/access-requests/mine": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get my pending access request
+         * @description Return your pending access request for a workbook, dashboard, or folder, or `null` when there is none. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        get: operations["AccessRequestsPublicController.getMyAccessRequest"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/access-requests/{id}/approve": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Approve an access request
+         * @description Grant the requester the chosen level and resolve the request. A higher level the requester already holds is kept. Requires permission to share the resource. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        post: operations["AccessRequestsPublicController.approveAccessRequest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/access-requests/{id}/decline": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Decline an access request
+         * @description Decline the request and notify the requester, who can then request access again. Requires permission to share the resource. This is currently in preview — reach out to the Cube support team to activate it for your account.
+         */
+        post: operations["AccessRequestsPublicController.declineAccessRequest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/ai-engineer/settings": {
         parameters: {
             query?: never;
@@ -402,7 +488,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Advance a deployment to a given onboarding step (e.g. after connecting a source) */
+        /**
+         * Advance a deployment to a given onboarding step (e.g. after connecting a source)
+         * @description It neither connects nor tests a source. Connecting one is done separately, by setting the database variables with PUT /:deploymentId/env-vars.
+         */
         post: operations["DeploymentsPublicController.advanceCreationStep"];
         delete?: never;
         options?: never;
@@ -780,13 +869,13 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get env variables
-         * @description Lists the deployment environment variables, cursor-paginated via `first`/`after`. Values of secret-named variables (containing PASS, SECRET, TOKEN, KEY, or CREDENTIAL) are returned as `[ENCRYPTED]`.
+         * List environment variables, including the database connection settings
+         * @description Lists the deployment environment variables, cursor-paginated via `first`/`after`. Values of secret-named variables (containing PASS, SECRET, TOKEN, KEY, or CREDENTIAL) are returned as `[ENCRYPTED]`. A deployment connects to its databases through these variables — there is no separate connections endpoint. The default data source uses `CUBEJS_DB_*` (for example `CUBEJS_DB_TYPE`, `CUBEJS_DB_HOST`, `CUBEJS_DB_USER`, `CUBEJS_DB_PASS`), plus the `CUBEJS_JDBC_*`, `CUBEJS_AWS_*` or `CUBEJS_FIREBOLT_*` families some drivers use. Additional data sources are listed in `CUBEJS_DATASOURCES` and configured as `CUBEJS_DS_<NAME>_DB_*`.
          */
         get: operations["EnvVariablesPublicController.getEnvVariables"];
         /**
-         * Set env variables
-         * @description Upserts deployment environment variables by name; variables not included keep their existing values. Passing the `[ENCRYPTED]` placeholder (the masked read value) is rejected — omit variables you do not intend to change. New variable names must be POSIX identifiers (`^[A-Za-z_][A-Za-z0-9_]*$`); names already stored on the deployment may be resent unchanged so a legacy name can still be updated or removed.
+         * Set environment variables, including connecting or changing a database
+         * @description Upserts deployment environment variables by name; variables not included keep their existing values. Passing the `[ENCRYPTED]` placeholder (the masked read value) is rejected — omit variables you do not intend to change. New variable names must be POSIX identifiers (`^[A-Za-z_][A-Za-z0-9_]*$`); names already stored on the deployment may be resent unchanged so a legacy name can still be updated or removed. A deployment connects to its databases through these variables — there is no separate connections endpoint. The default data source uses `CUBEJS_DB_*` (for example `CUBEJS_DB_TYPE`, `CUBEJS_DB_HOST`, `CUBEJS_DB_USER`, `CUBEJS_DB_PASS`), plus the `CUBEJS_JDBC_*`, `CUBEJS_AWS_*` or `CUBEJS_FIREBOLT_*` families some drivers use. Additional data sources are listed in `CUBEJS_DATASOURCES` and configured as `CUBEJS_DS_<NAME>_DB_*`. Saving does not test the connection: a wrong value is accepted here and only fails when the deployment next connects to the database.
          */
         put: operations["EnvVariablesPublicController.setEnvVariables"];
         post?: never;
@@ -1044,7 +1133,7 @@ export interface paths {
          * Create a scheduled notification
          * @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.
          *
-         *     Creates a scheduled notification — a recurring run of a dashboard whose rendered result is delivered to its recipients. The cadence is set by `scheduleType` plus the relevant time fields (`minute`, `hour`, `dayOfWeek`, `dayOfMonth`) or a raw `customCron` expression when `scheduleType` is `CUSTOM`; `timezone` defaults to UTC. Identify the target dashboard with either `dashboardId` (numeric) or `dashboardPublicId` (string) — supply exactly one; it must belong to this deployment, otherwise `404` is returned. The created notification has no recipients — add them via `POST /notifications/{id}/recipients`.
+         *     Creates a scheduled notification — a recurring run of a dashboard whose rendered result is delivered to its recipients. The cadence is set by `scheduleType` plus the relevant time fields (`minute`, `hour`, `dayOfWeek`, `dayOfMonth`) or a raw `customCron` expression when `scheduleType` is `CUSTOM`; `timezone` defaults to UTC. Identify the target dashboard with either `dashboardId` (numeric) or `dashboardPublicId` (string) — supply exactly one; it must belong to this deployment, otherwise `404` is returned. The created notification has no recipients — add them via `POST /notifications/{id}/recipients`. To make it a data alert, create it, add its recipients, then set `alert` with an update.
          */
         post: operations["NotificationsPublicController.createNotification"];
         delete?: never;
@@ -1071,7 +1160,7 @@ export interface paths {
          * Update a scheduled notification
          * @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.
          *
-         *     Updates a notification’s schedule definition. Any subset of the schedule fields may be supplied (`scheduleType` + time fields or `customCron`, `timezone`), along with `isEnabled`, `notificationEnabled`, and `notificationFormat`. Omitted fields are left unchanged. This endpoint never modifies recipients — manage those through the `/recipients` sub-resource. Returns `404` if the notification is not part of this deployment.
+         *     Updates a notification’s schedule definition. Any subset of the schedule fields may be supplied (`scheduleType` + time fields or `customCron`, `timezone`), along with `isEnabled`, `notificationEnabled`, `notificationFormat` and `alert`. Omitted fields are left unchanged. This endpoint never modifies recipients — manage those through the `/recipients` sub-resource. An `alert` needs notifications switched on and at least one recipient, otherwise `400` is returned. Returns `404` if the notification is not part of this deployment.
          */
         put: operations["NotificationsPublicController.updateNotification"];
         post?: never;
@@ -3709,7 +3798,7 @@ export interface paths {
         put?: never;
         /**
          * Create a deployment with an empty starter project and trigger its first build
-         * @description Scaffolds an empty starter project and triggers the first build. When `creationMethod` is `github`, no starter project is scaffolded — connect a repository afterwards via POST /build/api/v1/deployments/:deploymentId/github/connect.
+         * @description Scaffolds an empty starter project and triggers the first build. When `creationMethod` is `github`, no starter project is scaffolded — connect a repository afterwards via POST /build/api/v1/deployments/:deploymentId/github/connect. The deployment starts with no database connection: set one with PUT /api/v1/deployments/:deploymentId/env-vars.
          */
         post: operations["DeploymentsBuildPublicController.createDeployment"];
         delete?: never;
@@ -4018,6 +4107,32 @@ export interface components {
             token: string;
             url: string;
         };
+        AccessRequestItem: {
+            /** Format: date-time */
+            createdAt: string;
+            id: number;
+            level: components["schemas"]["AccessRequestItemLevel"];
+            message?: string | null;
+            /** @description Set in the list of pending requests for a resource. */
+            requester?: components["schemas"]["ResourceOwner"] | null;
+            requesterUserId: number;
+            resourceId: string;
+            /** @description Where the request is stored: a dashboard request is its workbook. */
+            resourceType: components["schemas"]["AccessRequestItemResourceType"];
+            status: components["schemas"]["AccessRequestItemStatus"];
+        };
+        /** @enum {string} */
+        AccessRequestItemLevel: "view" | "edit";
+        /** @enum {string} */
+        AccessRequestItemResourceType: "Workbook" | "Folder";
+        /** @enum {string} */
+        AccessRequestItemStatus: "pending" | "granted" | "declined";
+        /** @enum {string} */
+        AccessRequestResourceQueryResourceType: "Workbook" | "Folder" | "Dashboard";
+        AccessRequestsListResponse: {
+            items: components["schemas"]["AccessRequestItem"][];
+            pageInfo?: components["schemas"]["PageInfo"] | null;
+        };
         AddNotificationRecipientsInput: {
             /** @description Recipients to subscribe (1–1000 per request) */
             recipients: components["schemas"]["NotificationRecipientInput"][];
@@ -4220,6 +4335,12 @@ export interface components {
             targetDeploymentId: number;
             targetFolderId?: number | null;
         };
+        ApproveAccessRequestBody: {
+            /** @description The level to grant. It can differ from the requested one. */
+            level: components["schemas"]["ApproveAccessRequestBodyLevel"];
+        };
+        /** @enum {string} */
+        ApproveAccessRequestBodyLevel: "view" | "edit" | "full";
         BranchResponse: {
             id: number;
             isStagingEnvironmentEnabled?: boolean | null;
@@ -4461,6 +4582,18 @@ export interface components {
             fontSize?: string | null;
             fontWeight?: string | null;
         };
+        CreateAccessRequestBody: {
+            level: components["schemas"]["CreateAccessRequestBodyLevel"];
+            /** @description An optional note to the people who can share it, 500 characters at most. */
+            message?: string | null;
+            /** @description The workbook or folder id, or the public id of a dashboard, which stands for its workbook. */
+            resourceId: string;
+            resourceType: components["schemas"]["CreateAccessRequestBodyResourceType"];
+        };
+        /** @enum {string} */
+        CreateAccessRequestBodyLevel: "view" | "edit";
+        /** @enum {string} */
+        CreateAccessRequestBodyResourceType: "Workbook" | "Folder" | "Dashboard";
         CreateApiKeyInput: {
             allowedEndpoints?: string[] | null;
             deploymentIds?: number[] | null;
@@ -4984,6 +5117,43 @@ export interface components {
             x: number;
             y: number;
         };
+        DataAlertRule: {
+            direction?: string | null;
+            grain?: string | null;
+            id: string;
+            measureColumn: string;
+            measureTitle: string;
+            operator?: string | null;
+            percent?: number | null;
+            reportId: number;
+            timeColumn?: string | null;
+            type: string;
+            value?: number | null;
+            widgetId: string;
+            widgetTitle: string;
+        };
+        DataAlertRuleInput: {
+            direction?: components["schemas"]["DataAlertRuleInputDirection"] | null;
+            grain?: components["schemas"]["DataAlertRuleInputGrain"] | null;
+            measureColumn: string;
+            measureTitle: string;
+            operator?: components["schemas"]["DataAlertRuleInputOperator"] | null;
+            percent?: number | null;
+            reportId: number;
+            timeColumn?: string | null;
+            type: components["schemas"]["DataAlertRuleInputType"];
+            value?: number | null;
+            widgetId: string;
+            widgetTitle: string;
+        };
+        /** @enum {string} */
+        DataAlertRuleInputDirection: "up" | "down" | "either";
+        /** @enum {string} */
+        DataAlertRuleInputGrain: "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
+        /** @enum {string} */
+        DataAlertRuleInputOperator: "gt" | "lt" | "eq";
+        /** @enum {string} */
+        DataAlertRuleInputType: "threshold" | "change" | "anomaly";
         DataModelFileContent: {
             content: string;
             path: string;
@@ -6051,6 +6221,8 @@ export interface components {
             hash: string;
         };
         /** @enum {string} */
+        ListAccessRequestsQueryResourceType: "Workbook" | "Folder" | "Dashboard";
+        /** @enum {string} */
         ListDatabricksMetricViewSyncsQueryStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
         LocalEncryptedSecret: {
             authTagBase64: string;
@@ -6093,7 +6265,13 @@ export interface components {
         };
         /** @enum {string} */
         MoveWorkspaceObjectInputType: "FOLDER" | "WORKBOOK" | "REPORT";
+        MyAccessRequestResponse: {
+            /** @description The pending request of the caller for the resource, or null. */
+            accessRequest?: components["schemas"]["AccessRequestItem"] | null;
+        };
         NotificationDto: {
+            /** @description The data alert, present only when the notification has one: it is then sent only when this condition starts to hold. */
+            alert?: components["schemas"]["DataAlertRule"] | null;
             cronExpression: string;
             dashboardId: number;
             deploymentId: number;
@@ -7357,6 +7535,8 @@ export interface components {
             position?: number | null;
         };
         UpdateNotificationInput: {
+            /** @description A data alert: the notification is then sent only when this condition on one chart starts to hold. Omit to leave the stored rule as it is; `null` removes it. Needs `notificationEnabled` and at least one recipient, otherwise `400`. Data alerts are currently in preview — reach out to the Cube support team to activate them for your account. */
+            alert?: components["schemas"]["DataAlertRuleInput"] | null;
             customCron?: string | null;
             dayOfMonth?: number | null;
             dayOfWeek?: number | null;
@@ -8221,6 +8401,123 @@ export interface operations {
             };
         };
     };
+    "AccessRequestsPublicController.listAccessRequests": {
+        parameters: {
+            query: {
+                resourceType: components["schemas"]["ListAccessRequestsQueryResourceType"];
+                resourceId: string;
+                after?: string;
+                first?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccessRequestsListResponse"];
+                };
+            };
+        };
+    };
+    "AccessRequestsPublicController.createAccessRequest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description CreateAccessRequestBody */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CreateAccessRequestBody"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccessRequestItem"];
+                };
+            };
+        };
+    };
+    "AccessRequestsPublicController.getMyAccessRequest": {
+        parameters: {
+            query: {
+                resourceType: components["schemas"]["AccessRequestResourceQueryResourceType"];
+                resourceId: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["MyAccessRequestResponse"];
+                };
+            };
+        };
+    };
+    "AccessRequestsPublicController.approveAccessRequest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number;
+            };
+            cookie?: never;
+        };
+        /** @description ApproveAccessRequestBody */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["ApproveAccessRequestBody"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccessRequestItem"];
+                };
+            };
+        };
+    };
+    "AccessRequestsPublicController.declineAccessRequest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: any;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccessRequestItem"];
+                };
+            };
+        };
+    };
     "AIEngineerPublicController.getAIEngineerSettings": {
         parameters: {
             query?: {