@cube-dev/platform-client 0.0.19 → 0.1.0

package/CHANGELOG.md

@@ -12,6 +12,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+<!-- Curate public-facing entries here before the next release. -->
+
+## [0.1.0] - 2026-06-07
+### Added
+
+- `GET /api/v1/deployments/{deploymentId}/folders` now supports cursor-based pagination via the `first` and `after` query parameters, and returns an `items` array alongside a `pageInfo` cursor block — matching the other list endpoints.
+
+### Changed
+
+- **BREAKING:** The folders list response type `FoldersFindAllResult` is now `FoldersListResponse`.
+- **BREAKING:** Notification recipient types renamed for consistency: `PublicRecipientDto` → `NotificationRecipient`, `PublicRecipientInput` → `NotificationRecipientInput`, `AddRecipientsInput` → `AddNotificationRecipientsInput`, `RemoveRecipientInput` → `RemoveNotificationRecipientInput`, `RemoveRecipientsInput` → `RemoveNotificationRecipientsInput`, `RecipientsListDto` → `NotificationRecipientsListResponse`, `RecipientsMutationResultDto` → `NotificationRecipientsMutationResponse`, `NotificationsListDto` → `NotificationsListResponse`.
+
+### Deprecated
+
+- The `data` and `count` fields on the folders list response are deprecated in favor of `items` and `pageInfo`. They remain populated for backward compatibility.
+
+## [0.0.20] - 2026-06-05
+
 ### Added
 
 - `createCubePlatformClient` — the new name for the client factory.

package/README.md

@@ -0,0 +1,81 @@
+# @cube-dev/platform-client
+
+A typed client for the [Cube Cloud](https://cube.dev/) Platform control-plane REST API. It wraps the public OpenAPI spec with end-to-end types for every endpoint, request, and response, plus optional React Query bindings.
+
+## Documentation & changelog
+
+- **API reference & guides:** https://docs.cube.dev/api-reference/introduction
+- **Changelog:** https://docs.cube.dev/api-reference/changelog
+
+A copy of the per-release changelog also ships in this package as [`CHANGELOG.md`](./CHANGELOG.md).
+
+## Installation
+
+```bash
+npm install @cube-dev/platform-client
+# or
+yarn add @cube-dev/platform-client
+```
+
+## Usage
+
+```ts
+import { createCubePlatformClient } from '@cube-dev/platform-client';
+
+const client = createCubePlatformClient({
+  baseUrl: 'https://<your-tenant>.cubecloud.dev',
+  // Called on every request — return the auth headers for the Platform API.
+  getHeaders: () => ({ Authorization: process.env.CUBE_API_TOKEN! }),
+});
+
+// `fetchClient` is a fully-typed openapi-fetch client: paths, params,
+// request bodies and responses are all checked against the OpenAPI spec.
+const { data, error } = await client.fetchClient.GET('/api/v1/deployments/', {
+  params: { query: { first: 50 } },
+});
+
+for (const deployment of data?.items ?? []) {
+  console.log(deployment.id, deployment.name, deployment.deploymentUrl);
+}
+```
+
+### React Query bindings
+
+The `./react-query` entry point exposes a provider and typed hooks built on [`@tanstack/react-query`](https://tanstack.com/query) (a peer dependency, along with `react`):
+
+```tsx
+import { createCubePlatformClient } from '@cube-dev/platform-client';
+import {
+  CubePlatformApiProvider,
+  useCubePlatformApiQuery,
+} from '@cube-dev/platform-client/react-query';
+
+const client = createCubePlatformClient({ baseUrl, getHeaders });
+
+function App() {
+  return (
+    <CubePlatformApiProvider client={client}>
+      <Deployments />
+    </CubePlatformApiProvider>
+  );
+}
+
+function Deployments() {
+  const { data } = useCubePlatformApiQuery('get', '/api/v1/deployments/');
+  return <ul>{data?.items.map((deployment) => <li key={deployment.id}>{deployment.name}</li>)}</ul>;
+}
+```
+
+## Types
+
+The full set of schema types is exported as `PlatformApiSchemas`, and the raw OpenAPI `paths` / `operations` types are available for advanced use:
+
+```ts
+import type { PlatformApiSchemas, paths } from '@cube-dev/platform-client';
+
+type Deployment = PlatformApiSchemas['Deployment'];
+```
+
+## License
+
+MIT

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

@@ -11,11 +11,11 @@ export type CubeCloudApiProviderProps = CubePlatformApiProviderProps;
 /** @deprecated Renamed to {@link useCubePlatformApi}. */
 export declare const useCubeCloudApi: typeof useCubePlatformApi;
 /** @deprecated Renamed to {@link useCubePlatformApiQuery}. */
-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 & {
+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 & {
     [key: string]: unknown;
 })?, Options?, import("@tanstack/query-core").QueryClient?] : [Init & {
     [key: string]: unknown;
-}, 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>;
+}, Options?, import("@tanstack/query-core").QueryClient?]) => import("@tanstack/react-query").UseQueryResult<Options["select"] extends infer T_1 ? T_1 extends Options["select"] ? T_1 extends (data: Response["data"]) => infer R ? R : Response["data"] : never : never, any>;
 /** @deprecated Renamed to {@link useCubePlatformApiSuspenseQuery}. */
 export declare const useCubeCloudApiSuspenseQuery: import("openapi-react-query").UseSuspenseQueryMethod<paths, `${string}/${string}`>;
 /** @deprecated Renamed to {@link useCubePlatformApiMutation}. */

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

@@ -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;;;;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"}
+{"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;;;;+QAA0B,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"}