From 70b985bf57f5599edd1e6c2fd50447bbf091e170 Mon Sep 17 00:00:00 2001 From: edmand46 Date: Thu, 24 Sep 2026 17:52:36 +0300 Subject: [PATCH] docs: @rudder/sdk 0.2.1, readme and skill describe guarantees, not internals --- CHANGELOG.md | 6 +++++- README.md | 6 +++--- package-lock.json | 4 ++-- package.json | 2 +- skills/rudder-web-sdk/SKILL.md | 12 ++++++------ skills/rudder-web-sdk/reference/modules.md | 2 +- 6 files changed, 18 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 88cf3cc..e2b7f87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,16 @@ # Changelog +## 0.2.1 + +- Docs only: README wording. + ## 0.2.0 - `PlayerProfile.balances` (`CurrencyBalance[]`: `currency`, `balance`) replaces `wallets`, and the `Wallet` type is renamed `CurrencyBalance`. - `PlayerProfile.items` (`InventoryStack[]`: `item`, `quantity`) replaces `counters`. -- The server's `resources` to `catalogs` rename changes no public type. +- Catalogs replace resources on the platform; no public type changes. - Module clients generated by `rudder client generate` 0.3.0 list the current kernel error codes in `RudderKernelError`. diff --git a/README.md b/README.md index 61f2e69..e4954bb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ installed modules through generated typed clients. ## Install -The package is published to the Gitea registry at hub.rudder.build, not +The package is published to the Rudder package registry at hub.rudder.build, not npmjs. Point the `@rudder` scope at it in your project's `.npmrc`: ``` @@ -185,8 +185,8 @@ npm run build # tsup → dist (ESM + CJS + d.ts) npm run test:e2e-prod # drives a seeded project on the live backend ``` -Generated wire types (`src/generated`) come from `liveops-backend/apigen`; run -`npm run generate` to refresh them. Do not edit them by hand. +Generated wire types (`src/generated`) come from the platform's API +contract; run `npm run generate` to refresh them. Do not edit them by hand. `test/fixtures/rudder.modules.ts` is CLI output for `test/fixtures/leaderboards.manifest.json`; `npm run typecheck` checks that it diff --git a/package-lock.json b/package-lock.json index 76667e7..aec3bc4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@rudder/sdk", - "version": "0.2.0", + "version": "0.2.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@rudder/sdk", - "version": "0.2.0", + "version": "0.2.1", "devDependencies": { "@types/node": "^26.1.1", "jsdom": "^29.1.1", diff --git a/package.json b/package.json index 3f9f7a6..ee9ed84 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@rudder/sdk", - "version": "0.2.0", + "version": "0.2.1", "publishConfig": { "registry": "https://hub.rudder.build/api/packages/rudder/npm/" }, diff --git a/skills/rudder-web-sdk/SKILL.md b/skills/rudder-web-sdk/SKILL.md index 384f2ed..b180c37 100644 --- a/skills/rudder-web-sdk/SKILL.md +++ b/skills/rudder-web-sdk/SKILL.md @@ -5,19 +5,19 @@ description: Use when working with the Rudder TypeScript/JavaScript client SDK ( # Rudder Web SDK (@rudder/sdk) -Client SDK for web games on the Rudder LiveOps platform. Source of truth: -`liveops-web-sdk/src` (wire types in `src/generated` come from -`liveops-backend/apigen`; never edit them by hand). +Client SDK for web games on the Rudder LiveOps platform. Source of truth: the +package source and its type declarations (wire types in `src/generated` are +generated; never edit them by hand). -0.2.0 covers only the kernel: auth, player, catalog, storage, module calls and -internal revision sync. Game features are installed modules, reached through a +0.2.1 covers only the kernel: auth, player, catalog, storage, module calls and +background sync. Game features are installed modules, reached through a typed client generated from their manifests. There is no `resources(slug)` and no `projectStorage`; game-facing configuration comes from modules such as `remote_config`. ## Install -Published to the Gitea registry at hub.rudder.build, not npmjs. Point the +Published to the Rudder package registry at hub.rudder.build, not npmjs. Point the `@rudder` scope at it in `.npmrc` (anonymous read, no token): ``` diff --git a/skills/rudder-web-sdk/reference/modules.md b/skills/rudder-web-sdk/reference/modules.md index 95a3fd2..9095696 100644 --- a/skills/rudder-web-sdk/reference/modules.md +++ b/skills/rudder-web-sdk/reference/modules.md @@ -58,7 +58,7 @@ client.modules.call( `result`. Console output and the kernel call log never reach players. - Idempotency: each call generates one `Idempotency-Key` (UUID v4) and sends the same key on every retry, so the server runs the function at most once - and returns the stored response for a repeated key. A new `call()` gets a + and a retry with the same key within 24 h returns the first response. A new `call()` gets a new key. - Retries: up to 2, with jittered exponential backoff, on network errors, 5xx and 409 with code `conflict`. Other 4xx responses (including other 409