@cube-dev/platform-client 0.0.20 → 0.1.0

package/CHANGELOG.md

@@ -14,7 +14,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- 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