edmand46
1491b5e357
- engine/ (DagWalker, sessions, IndexedDbPlanStore) deleted; server owns the graph - trigger/callback/counter carry PendingEffect; GET /sdk/v1/scenarios/pending polled (30s jittered heartbeat paused on hidden tab + wait-deadline timers) - client.effects public API unchanged (done/buy/dismiss/end/claim/battlepass/quest) - planStateStore removed; loginEvent kept; reconcile() makes server the source of truth - generated models regenerated; skills/README/CHANGELOG updated
85 lines
2.6 KiB
Markdown
85 lines
2.6 KiB
Markdown
# Battle pass — `client.battlePass`
|
|
|
|
`BattlePassService` (source: `src/battlepass/BattlePassService.ts`).
|
|
Call-and-response access to battle pass endpoints. Battle pass state is tied to
|
|
a **scenario battle pass node**, so calls carry `scenarioId` + `nodeId` (plus
|
|
`runId` for mutating calls). NOT observable — re-fetch progress explicitly
|
|
after a mutation.
|
|
|
|
In most games you do not call this service directly: a scenario battle pass
|
|
node surfaces through `client.effects.onBattlePass` with a session object that
|
|
wraps these calls (see `reference/scenarios.md`). Use the service directly when
|
|
you already know the scenario/node/run identifiers.
|
|
|
|
## Methods
|
|
|
|
```ts
|
|
getProgress(scenarioId: string, nodeId: string): Promise<GetBattlePassProgressResponse>
|
|
addXp(request: AddBattlePassXpRequest): Promise<AddBattlePassXpResponse>
|
|
claimReward(request: ClaimBattlePassRewardRequest): Promise<ClaimBattlePassRewardResponse>
|
|
purchasePremium(request: PurchaseBattlePassPremiumRequest): Promise<PurchaseBattlePassPremiumResponse>
|
|
```
|
|
|
|
## Request / response types
|
|
|
|
```ts
|
|
interface AddBattlePassXpRequest {
|
|
amount?: number;
|
|
nodeId?: string;
|
|
runId?: string;
|
|
scenarioId?: string;
|
|
source?: string; // configured XP source
|
|
}
|
|
interface AddBattlePassXpResponse {
|
|
level?: number;
|
|
leveledUp?: boolean;
|
|
maxLevel?: boolean;
|
|
xp?: number;
|
|
}
|
|
|
|
interface ClaimBattlePassRewardRequest {
|
|
level?: number;
|
|
nodeId?: string;
|
|
runId?: string;
|
|
scenarioId?: string;
|
|
track?: 'free' | 'premium';
|
|
}
|
|
interface ClaimBattlePassRewardResponse {
|
|
alreadyClaimed?: boolean;
|
|
error?: string;
|
|
granted?: Reward[]; // { amount?, currency?, itemId? }
|
|
success?: boolean;
|
|
}
|
|
|
|
interface GetBattlePassProgressResponse {
|
|
claimedTiers?: ClaimedTier[]; // { level?, track? }
|
|
level?: number;
|
|
premiumOwned?: boolean;
|
|
xp?: number;
|
|
}
|
|
|
|
interface PurchaseBattlePassPremiumRequest {
|
|
idempotencyKey?: string;
|
|
nodeId?: string;
|
|
runId?: string;
|
|
scenarioId?: string;
|
|
}
|
|
interface PurchaseBattlePassPremiumResponse {
|
|
error?: string;
|
|
success?: boolean;
|
|
}
|
|
```
|
|
|
|
## Semantics
|
|
|
|
- `addXp` credits XP from a configured source; returns the new `xp`/`level`
|
|
plus `leveledUp` / `maxLevel` flags.
|
|
- `claimReward` claims a tier reward at a reached level; idempotent
|
|
server-side (`alreadyClaimed`). Claiming a tier above the current level (or
|
|
a premium tier without premium) fails server-side — check `success`/`error`
|
|
in the response and the typed error `code` (`RudderErrorCodes`).
|
|
- `purchasePremium` charges the player's wallet; idempotent; pass your own
|
|
`idempotencyKey` for safe retries.
|
|
- Prefer the `onBattlePass` effect session, which binds `scenarioId` /
|
|
`nodeId` / `runId` and posts scenario callbacks for you.
|