docs: module call response, error codes, remove scenarios
CI / check (push) Successful in 16s
CI / publish (push) Has been skipped

This commit is contained in:
edmand46
2026-09-17 12:27:52 +03:00
parent 6f37b00fb4
commit 4ab406c5cd
3 changed files with 27 additions and 3 deletions
+12
View File
@@ -2,6 +2,18 @@
## Unreleased ## Unreleased
- `client.modules.call` resolves to `CallModuleFunctionClientResponse`, which
carries only `result`. Console output, the kernel call log and `error` are
no longer part of the player response; they stay on the platform dry run.
- Module business errors reject with `RudderHttpError` (`status` 422, body
`{ error, code, requestId }`). `code` is defined by the module and is an
open string.
- `RudderErrorCodes` and the `RudderErrorCode` type are no longer exported
from the package. The generated platform codes are now only `forbidden` and
`row_referenced`; the scenario and quest codes (`early_completion`,
`level_not_reached`, `node_not_active`, `objectives_incomplete`,
`run_expired`, `run_not_active`, `scenario_not_active`, `unknown_run`) are
removed with those domains. Compare `error.code` with string literals.
- Login and token refresh send `platform: 'web'` and, when the new optional - Login and token refresh send `platform: 'web'` and, when the new optional
`appVersion` client option is set, `appVersion`. The backend stores them on `appVersion` client option is set, `appVersion`. The backend stores them on
the player for segment rules (`player.platform`, `player.appVersion`). the player for segment rules (`player.platform`, `player.appVersion`).
+4
View File
@@ -88,6 +88,10 @@ try {
} }
``` ```
A module business error rejects with `RudderHttpError` (`status` 422) whose
`code` is the module's own open string code. The platform codes are
`forbidden` and `row_referenced`.
Invalid client options (missing `baseUrl` / `projectKey`) throw `RudderError` Invalid client options (missing `baseUrl` / `projectKey`) throw `RudderError`
with `code: 'sdk/invalid-options'` from the constructor. with `code: 'sdk/invalid-options'` from the constructor.
+11 -3
View File
@@ -83,7 +83,7 @@ Tokens are saved to the `TokenStore` automatically. The transport injects
| Catalog currencies | `client.catalog` | observable `SyncedState<Map<string, CatalogCurrency>>` | | Catalog currencies | `client.catalog` | observable `SyncedState<Map<string, CatalogCurrency>>` |
| Player storage | `client.storage` + `.save(items)` / `.delete(type)` | observable + mutations | | Player storage | `client.storage` + `.save(items)` / `.delete(type)` | observable + mutations |
| Project storage | `client.projectStorage` + `.save(items)` | observable + mutation | | Project storage | `client.projectStorage` + `.save(items)` | observable + mutation |
| Modules | `client.modules.call(module, fn, args?)` | `CallModuleFunctionResponse` | | Modules | `client.modules.call(module, fn, args?)` | `CallModuleFunctionClientResponse` (`{ result }`) |
| Resources | `client.resources(slug)` | `list` / `get` / `create` / `update` / `delete` | | Resources | `client.resources(slug)` | `list` / `get` / `create` / `update` / `delete` |
There is no UGC, wallet service, or standalone economy service — wallets live There is no UGC, wallet service, or standalone economy service — wallets live
@@ -121,8 +121,16 @@ All SDK errors extend `RudderError` (optional machine-readable `code`):
- `RudderError` with `code: 'sdk/invalid-options'` (`SDK_ERROR_INVALID_OPTIONS`) - `RudderError` with `code: 'sdk/invalid-options'` (`SDK_ERROR_INVALID_OPTIONS`)
— constructor validation — constructor validation
Server error codes (`RudderErrorCodes`, from `src/generated/errors.ts`) are The platform error codes are `forbidden` and `row_referenced`
compared with `error.code === RudderErrorCodes.forbidden`. (`src/generated/errors.ts`, not exported from the package entry); compare
`error.code === 'forbidden'`.
`client.modules.call` resolves to `{ result }` only; console output and the
kernel call log never reach players. A module business error rejects with
`RudderHttpError` whose `status` is 422 and whose `code` is the module's own
code (the body is `{ error, code, requestId }`). Module codes are open strings
with no generated constants, so compare against the codes the module
documents. A module trap is a 500 and a timeout a 504, both without details.
## Reference files ## Reference files