@indiegems/gem-web-sdk 13.0.0 → 13.2.0

package/dist/sdk.d.ts

@@ -87,6 +87,7 @@ interface RequestOptions {
     readonly keepalive?: boolean;
     readonly ifMatch?: string;
     readonly replaySafe?: boolean;
+    readonly retryRateLimited?: boolean;
 }
 interface VersionedGetOptions {
     readonly signal?: AbortSignal;
@@ -1177,7 +1178,7 @@ interface PlayerBadge$1 {
     readonly itemId: string;
     readonly iconUrl: string;
 }
-type Avatar3dFamily = "small_human" | (string & {});
+type Avatar3dFamily = "small_human" | "adult_human" | (string & {});
 interface WornAvatar3d$1 {
     readonly family: Avatar3dFamily;
     readonly id: string;
@@ -2264,6 +2265,12 @@ interface GemAdResult {
     readonly requestId: string;
     readonly outcome: "shown" | "no_ad" | "unavailable";
 }
+interface GemMomentResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.momentResult";
+    readonly requestId: string;
+    readonly shown: boolean;
+}
 interface GemSignInResult {
     readonly gem: typeof PROTOCOL;
     readonly type: "gem.signInResult";
@@ -4460,6 +4467,7 @@ interface RewardCue {
         y: number;
     };
 }
+type GemCorner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
 type FrameState = "waiting" | "connected" | "refused" | "closed";
 interface FramePlayer extends PlayerIdentity {
     readonly displayName: PlayerText;
@@ -4499,6 +4507,7 @@ interface FrameCallbacks {
     onDeviceSettings?(msg: GemDeviceSettings): void;
     onDeviceSettingsResult?(msg: GemDeviceSettingsResult): void;
     onAdResult?(msg: GemAdResult): void;
+    onMomentResult?(msg: GemMomentResult): void;
     onSignInResult?(msg: GemSignInResult): void;
     onFriendChallengeResult?(msg: GemFriendChallengeResult): void;
     onError?(code: GemErrorCode, message?: string): void;
@@ -4554,6 +4563,7 @@ declare class GemFrame {
         readonly id: string;
         readonly label: string;
     }>): boolean;
+    setGemCorner(corner: GemCorner): boolean;
     requestShare(params: ReadonlyArray<{
         readonly key: string;
         readonly value: string;
@@ -4572,6 +4582,8 @@ declare class GemFrame {
     requestAvatar3dPurchase(requestId: string, itemId: string, currencySlug: string): boolean;
     putDeviceSettings(requestId: string, settings: Readonly<Record<string, unknown>>): boolean;
     requestAd(requestId: string, placement: string, format: "interstitial" | "rewarded"): boolean;
+    signalMoment(requestId: string, kind: string, placement?: string): boolean;
+    readyCalled(): boolean;
     requestSignIn(requestId: string): boolean;
     requestFriendChallenge(requestId: string, playerId: string, template: string, params?: Readonly<Record<string, string | number>>): boolean;
     close(): void;
@@ -4580,6 +4592,7 @@ declare class GemFrame {
     private dropUnknownType;
     private refuse;
     private fail;
+    private gated;
     private send;
     private receive;
     private dispatchInbound;
@@ -4648,6 +4661,17 @@ interface AdsApi {
     requestAd(req: AdRequest): Promise<AdOutcome>;
     rewardedStatus(placement: string): Promise<RewardedStatus>;
 }
+type MomentKind = "level_end" | "run_end" | "match_end" | "menu_return" | "other_break";
+interface MomentSignal {
+    kind: MomentKind;
+    placement?: string;
+}
+interface MomentResult {
+    readonly shown: boolean;
+}
+interface MomentsApi {
+    signal(moment: MomentSignal): Promise<MomentResult>;
+}
 type DeviceSettings = Readonly<Record<string, unknown>>;
 type DeviceSettingsPutOutcome = "stored" | "too_large" | "unavailable";
 interface DeviceSettingsApi {
@@ -4658,6 +4682,15 @@ interface DeviceSettingsApi {
 declare class GemUnframedError extends Error {
     constructor();
 }
+interface AvatarRigNode {
+    readonly node: string;
+    readonly parent: string | null;
+}
+interface AvatarRigs {
+    readonly small_human: readonly AvatarRigNode[];
+    readonly adult_human: readonly AvatarRigNode[];
+}
+declare const AVATAR_RIGS: AvatarRigs;
 declare const DEVICE_SETTINGS_MAX_BYTES = 16384;
 declare const ARCADE_EMBEDDERS: readonly string[];
 interface GemOptions {
@@ -4773,6 +4806,7 @@ interface Gem {
     readonly gameConfig: GameConfigApi;
     readonly purchases: PurchaseApi;
     readonly deviceSettings: DeviceSettingsApi;
+    readonly moments: MomentsApi;
     readonly ads: AdsApi;
     readonly account: AccountApi;
     readonly share: ShareApi;
@@ -4802,6 +4836,7 @@ interface Gem {
     cueReward(cue: RewardCue): boolean;
     setWalletVisible(visible: boolean, options?: WalletVisibleOptions): boolean;
     setMenu(menu: GameMenu): boolean;
+    setGemCorner(corner: GemCorner): boolean;
     exit(reason?: string): Promise<void>;
     readonly boot: BootTimeline;
     readonly frame: GemFrame;
@@ -4827,4 +4862,4 @@ interface ExitAnalytics {
 }
 declare function leaveAndExit(rooms: ExitRooms, bridge: ExitBridge | null, reason?: string, analytics?: ExitAnalytics): Promise<void>;
 declare function createGem(options?: GemOptions): Gem;
-export { ARCADE_EMBEDDERS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Avatar3dFamily, type Avatar3dOffer, type Avatar3dPrice, type Avatar3dPurchaseRequest, type Avatars3dApi, type Base64String, type BootMark, type BootTimeline, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, ChallengesApi, type ClientOptions, type Clock, type ConditionalRequestHeaders, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, type ControlsApi, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EarnAllowance, type EarnAllowanceEvent, type EarnAllowancePeriod, type EarnAllowanceReadOptions, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, type FriendChallenge, FriendChallengeError, type FriendChallengeErrorCode, type FriendChallengeOutcome, type FriendChallengeOutcomeKind, type FriendChallengeRequest, type FriendChallengesPage, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameMenu, type GameMenuItem, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemGraphicsQuality, type GemIdentity, type GemInsets, type GemLook, type GemLookBase, type GemLookDelta, type GemLookOptions, type GemLookSpeed, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, type GemRecommendedSettings, type GemReservedArea, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, GemUnframedError, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, type LeaderboardPeriod, LeaderboardsApi, type ListChallengesOptions, type ListFriendChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchBackfillState, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchPlayerReport, type MatchPlayerReportResult, type MatchServeOptions, type MatchTransport, type MessageMeta, type MultiTransportSession, PLATFORM_EVENTS, type PeriodOptions, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, PlatformEarnAllowanceApi, type PlatformEventName, type PlayerBadge$1 as PlayerBadge, type PlayerBoost, type PlayerBoostMultiplier, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry$1 as ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, PurchaseRefusal, type PurchaseRefusalCode, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RecipeAvailability, type RecipeLock, type RequestOptions, type RewardCue, type RewardedStatus, type RoomArgValue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerApi, type ServerBundleHost, type ServerTokenGrant, type SessionEndReason, type ShareApi, type ShareRequest, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TokenGrant, type Transport, type TransportAdvert, type TransportKind, TransportRefusal, type TransportRequest, type TransportResponse, UNRELIABLE_CHANNEL_LABEL, type VersionedGetOptions, type VersionedResponse, type VibrationApi, type WalletVisibleOptions, type WornAvatar3d$1 as WornAvatar3d, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };
+export { ARCADE_EMBEDDERS, AVATAR_RIGS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Avatar3dFamily, type Avatar3dOffer, type Avatar3dPrice, type Avatar3dPurchaseRequest, type AvatarRigNode, type AvatarRigs, type Avatars3dApi, type Base64String, type BootMark, type BootTimeline, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, ChallengesApi, type ClientOptions, type Clock, type ConditionalRequestHeaders, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, type ControlsApi, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EarnAllowance, type EarnAllowanceEvent, type EarnAllowancePeriod, type EarnAllowanceReadOptions, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, type FriendChallenge, FriendChallengeError, type FriendChallengeErrorCode, type FriendChallengeOutcome, type FriendChallengeOutcomeKind, type FriendChallengeRequest, type FriendChallengesPage, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameMenu, type GameMenuItem, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemCorner, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemGraphicsQuality, type GemIdentity, type GemInsets, type GemLook, type GemLookBase, type GemLookDelta, type GemLookOptions, type GemLookSpeed, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, type GemRecommendedSettings, type GemReservedArea, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, GemUnframedError, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, type LeaderboardPeriod, LeaderboardsApi, type ListChallengesOptions, type ListFriendChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchBackfillState, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchPlayerReport, type MatchPlayerReportResult, type MatchServeOptions, type MatchTransport, type MessageMeta, type MomentKind, type MomentResult, type MomentSignal, type MomentsApi, type MultiTransportSession, PLATFORM_EVENTS, type PeriodOptions, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, PlatformEarnAllowanceApi, type PlatformEventName, type PlayerBadge$1 as PlayerBadge, type PlayerBoost, type PlayerBoostMultiplier, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry$1 as ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, PurchaseRefusal, type PurchaseRefusalCode, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RecipeAvailability, type RecipeLock, type RequestOptions, type RewardCue, type RewardedStatus, type RoomArgValue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerApi, type ServerBundleHost, type ServerTokenGrant, type SessionEndReason, type ShareApi, type ShareRequest, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TokenGrant, type Transport, type TransportAdvert, type TransportKind, TransportRefusal, type TransportRequest, type TransportResponse, UNRELIABLE_CHANNEL_LABEL, type VersionedGetOptions, type VersionedResponse, type VibrationApi, type WalletVisibleOptions, type WornAvatar3d$1 as WornAvatar3d, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };

package/dist/server-api.d.ts

@@ -40,6 +40,7 @@ interface RequestOptions {
     readonly keepalive?: boolean;
     readonly ifMatch?: string;
     readonly replaySafe?: boolean;
+    readonly retryRateLimited?: boolean;
 }
 interface VersionedGetOptions {
     readonly signal?: AbortSignal;

package/dist/server.d.ts

@@ -69,6 +69,7 @@ interface RequestOptions {
     readonly keepalive?: boolean;
     readonly ifMatch?: string;
     readonly replaySafe?: boolean;
+    readonly retryRateLimited?: boolean;
 }
 interface VersionedGetOptions {
     readonly signal?: AbortSignal;

package/docs/analytics.md

@@ -11,9 +11,9 @@ you design around them:
 - **Nothing is recorded that you did not declare.** There is no free-text property. Every event,
   every dimension and every value a dimension may take is published in your game config ahead of
   time, and anything else is refused per event rather than stored.
-- **Detail older than 30 days is gone.** Raw events live 30 days. The daily counters built from
+- **Detail older than 60 days is gone.** Raw events live 60 days. The daily counters built from
   them live 400. A question you can only answer by reading individual events is a question you can
-  only ask about the last month.
+  only ask about the last two months.
 
 What you record here is **yours**. It feeds your own reporting and nothing the platform treats as
 authoritative — see [section 8](#8-what-analytics-is-not) before you attach a reward to it.
@@ -253,7 +253,10 @@ Two results are not refusals and should not be treated as one:
   being counted twice.
 
 A rate limit or a temporarily unreachable backend **keeps the queue** and rejects the `flush`
-promise, so the next send carries the same events. A refusal that would fail identically forever
+promise, so the next send carries the same events. The SDK's own sends then wait for the longer
+of the platform's `Retry-After` and a cooldown that starts at 10 seconds and doubles with each
+refusal in a row, up to five minutes; the send on the way out of the page goes regardless. Only one
+`flush` is on the wire at a time. A refusal that would fail identically forever
 discards its batch instead, because a queue that can never empty fills up and starts dropping the
 events that would explain the problem.
 

package/docs/api/api-reference-function.md

@@ -1,6 +1,6 @@
 # The function surface — API reference
 
-Generated from `@indiegems/gem-web-sdk/function` v13.0.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
+Generated from `@indiegems/gem-web-sdk/function` v13.2.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
 
 `@indiegems/gem-web-sdk/function` exports exactly the symbols on this page and nothing else.
 
@@ -8,6 +8,8 @@ Generated from `@indiegems/gem-web-sdk/function` v13.0.0, the version of the pac
 import { createGem } from '@indiegems/gem-web-sdk/function';
 ```
 
+⚠️ **JavaScript functions are disabled for now, due to performance issues.** Uploading a new JavaScript function is refused with `400 js_functions_disabled`: write a new function in Rust, as [serverless-functions](../serverless-functions.md#3-writing-one) shows. A JavaScript function already published keeps running, and this page is what it imports.
+
 A function imports the same package your game already depends on, written out in [getting-started](../getting-started.md#3-add-the-sdk) — the only place the install is written out. Your function’s build bundles this module, so the version your function runs is the one your `package.json` names: pin the version your game pins. A function published importing the SDK from the engine runs the engine’s built-in copy instead; [serverless-functions-js](../serverless-functions-js.md) says what that means.
 
 <a id="analyticsvalue"></a>
@@ -243,7 +245,7 @@ is what says which events exist, which dimensions each has and which values
 each dimension may take. An undeclared name or key is not stored — it comes
 back as a rejection, which the SDK prints to the console during development.
 
-⚠️ **Detail older than 30 days is gone.** Raw events live 30 days; the daily
+⚠️ **Detail older than 60 days is gone.** Raw events live 60 days; the daily
 counters live 400. Anything you want to be able to ask about a year from now
 has to be a declared dimension today.
 
@@ -355,9 +357,14 @@ the page.
 A refusal that could clear on its own — a 429 from the rate limiter, a 503
 while the platform's idempotency store is unreachable — KEEPS the queue
 and rejects, so the next flush sends the same events rather than losing
-them. A refusal that cannot clear discards the batch it was sent for,
+them. The SDK's own flushes then hold off for the longer of the server's
+`Retry-After` and a cooldown that doubles from 10 seconds, up to five
+minutes. A refusal that cannot clear discards the batch it was sent for,
 because resending it can only fail identically.
 
+One flush at a time: called while another is still on the wire, this
+resolves at once with nothing sent, and what is queued goes out after it.
+
 | Parameter | Type |
 | --- | --- |
 | `options` | `AnalyticsFlushOptions` |
@@ -666,6 +673,22 @@ It buys the same budget a read gets — see [ClientOptions.maxRetries](#clientop
 final: only the failures [GemApiError.retryable](#gemapierror-retryable) describes, and a
 connection that died with no answer, are attempted again.
 
+<a id="requestoptions-retryratelimited"></a>
+
+## RequestOptions.retryRateLimited
+
+```ts
+readonly retryRateLimited?: boolean
+```
+
+Set `false` to make a 429 final for this call instead of waiting out
+`Retry-After` and trying again.
+
+For a caller that keeps its own queue and its own cooldown, such as a
+batch sender on a timer: retrying inside the call only spends more of the
+same limit, and holds the caller's queue while it does. Every other
+failure is retried exactly as before. Defaults to `true`.
+
 <a id="versionedgetoptions"></a>
 
 ## VersionedGetOptions
@@ -4884,13 +4907,21 @@ putting it in an `<img src>`.
 ## Avatar3dFamily
 
 ```ts
-type Avatar3dFamily = "small_human" | string & object
+type Avatar3dFamily = "small_human" | "adult_human" | string & object
 ```
 
 A rig family — the skeleton contract a 3D avatar is built on, and what a
-game declares it can animate. `small_human` is the first: a `root` node
-with a `body` child, which holds `head`, `arm_l`, `arm_r`, `leg_l` and
-`leg_r`, and a `hand_socket` under `arm_r`.
+game declares it can animate. Two today:
+
+- `small_human`, the toy rig: a `root` node with a `body` child, which holds
+  `head`, `arm_l`, `arm_r`, `leg_l` and `leg_r`, and a `hand_socket` under
+  `arm_r`.
+- `adult_human`, a full humanoid with fingers: 56 nodes from `root` and
+  `hips` down to `toes_r`, every one world-aligned at rest, so one clip plays
+  on every avatar in the family.
+
+`AVATAR_RIGS` (from `@indiegems/gem-web-sdk/sdk`) lists every node of
+both, with its parent.
 
 Open-ended (`| (string & {})`) so a family the platform adds later does not
 break a `switch` you compiled against this version: keep a `default` arm and