@indiegems/gem-web-sdk 5.12.0 → 7.0.0

package/dist/game.d.ts

@@ -42,6 +42,8 @@ interface TransportRequest {
     readonly method: "GET" | "PUT" | "POST" | "PATCH" | "DELETE";
     readonly path: string;
     readonly body?: unknown;
+    readonly bytes?: Uint8Array;
+    readonly responseType?: "json" | "bytes";
     readonly headers?: ConditionalRequestHeaders;
     readonly signal?: AbortSignal;
     readonly keepalive?: boolean;
@@ -51,6 +53,7 @@ interface TransportResponse {
     readonly body: unknown;
     readonly etag?: string;
     readonly retryAfterSeconds?: number;
+    readonly invocationId?: string;
 }
 interface Transport {
     request(request: TransportRequest): Promise<TransportResponse>;
@@ -87,6 +90,10 @@ type VersionedResponse<T> = {
     readonly modified: false;
     readonly etag?: string;
 };
+interface BytesResponse {
+    readonly bytes: Uint8Array;
+    readonly invocationId?: string;
+}
 declare class GemClient {
     private readonly options;
     constructor(options: ClientOptions);
@@ -94,6 +101,7 @@ declare class GemClient {
     getWithEtag<T>(path: string, options?: VersionedGetOptions): Promise<VersionedResponse<T>>;
     put<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
     post<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
+    postBytes(path: string, bytes: Uint8Array, signal?: AbortSignal, options?: RequestOptions): Promise<BytesResponse>;
     patch<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
     delete<T>(path: string, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
     private send;
@@ -104,6 +112,21 @@ interface GameApi {
     readonly client: GemClient;
     gameId(): string;
 }
+type AchievementGrant = {
+    "description"?: string;
+    "display_name": string;
+    "hidden_hint"?: string | null;
+    "icon_url"?: string | null;
+    "id": string;
+    "localized"?: Record<string, unknown>;
+    "points"?: number;
+    "rewards"?: AchievementReward[];
+    "visibility"?: AchievementVisibility;
+};
+type AchievementReward = {
+    "item": string;
+};
+type AchievementVisibility = "visible" | "hidden";
 type Affix = {
     "group"?: string | null;
     "is_active"?: boolean;
@@ -185,6 +208,7 @@ type ItemGeneration = {
 type LevelDefinition = {
     "auto_claim"?: boolean;
     "level": number;
+    "platform_grants"?: PlatformGrant[];
     "rewards"?: RecipeOperation[];
     "threshold": number;
 };
@@ -207,10 +231,15 @@ type PityRule = {
     "threshold": number;
 };
 type PlatformDisplay = "none" | "challenge";
+type PlatformGrant = PlatformGrantMapping | {
+    "achievement": AchievementGrant;
+};
 type PlatformGrantMapping = {
     "amount"?: number | null;
+    "max_per_entity"?: number | null;
     "max_per_window"?: number | null;
     "mode": PlatformGrantMode;
+    "per_unit"?: number | null;
     "target": PlatformGrantTarget;
 };
 type PlatformGrantMode = "on_add" | "on_complete";
@@ -229,7 +258,7 @@ type ProgressionConfig = {
     "label"?: string | null;
     "max_completions"?: number | null;
     "platform_display"?: PlatformDisplay;
-    "platform_grants"?: PlatformGrantMapping[];
+    "platform_grants"?: PlatformGrant[];
     "reset_schedule"?: null | ResetSchedule;
     "rewards_on_complete"?: RecipeOperation[];
     "tracks"?: TrackDefinition[];
@@ -1195,6 +1224,34 @@ declare class ProfilesApi {
     constructor(api: GameApi);
     of(playerId: string, options?: ProfileCallOptions): Promise<PlayerProfile | null>;
 }
+interface FunctionInvokeOptions {
+    readonly signal?: AbortSignal;
+}
+interface FunctionResult {
+    readonly bytes: Uint8Array;
+    readonly invocationId?: string;
+    text(): string;
+    json<T = unknown>(): T;
+}
+type FunctionFailure = "trap" | "memory_exceeded" | "cpu_budget_exceeded" | "host_call_limit";
+declare class GemFunctionError extends GemApiError {
+    readonly invocationId?: string;
+    readonly functionMessage?: string;
+    readonly failure?: FunctionFailure | (string & {});
+    constructor(source: GemApiError, extra: {
+        readonly invocationId?: string;
+        readonly functionMessage?: string;
+        readonly failure?: string;
+    });
+    get retryable(): boolean;
+}
+declare class FunctionsApi {
+    #private;
+    constructor(invoke: (body: Uint8Array, options?: {
+        signal?: AbortSignal;
+    }) => Promise<BytesResponse>);
+    invoke(input: unknown, options?: FunctionInvokeOptions): Promise<FunctionResult>;
+}
 type SessionEndReason = "grant_expiring" | "session_ended" | "navigating" | "kill_switch" | "pagehide";
 type MatchTransport = "dedicated" | "p2p";
 type PlatformEventName = "gem_session_start" | "gem_session_end" | "gem_pause" | "gem_resume" | "gem_boot_ready" | "gem_match_started" | "gem_match_ended" | "gem_auth_lost";
@@ -1501,6 +1558,7 @@ interface Room {
 interface MatchAutoStartFailed {
     readonly roomId: string;
     readonly code: string;
+    readonly handled: boolean;
 }
 interface RoomSummary {
     readonly id: string;
@@ -2512,6 +2570,7 @@ interface GemOptions {
     readonly clientVersion?: ClientVersion;
     readonly pollRooms?: boolean;
     readonly recoverStaleMembership?: boolean;
+    readonly retryAutoStart?: boolean;
     readonly watchSeats?: boolean;
     readonly seatPollIntervalMs?: number;
     readonly autoReconnect?: AutoReconnectOptions | false;
@@ -2589,6 +2648,7 @@ interface Gem {
     readonly friends: FriendsApi;
     readonly platform: PlatformApi;
     readonly profiles: ProfilesApi;
+    readonly functions: FunctionsApi;
     awaitPlayer(timeoutMs?: number): Promise<GemPlayer | null>;
     readonly prefs: GemPrefs | null;
     readonly cohorts: GemCohorts | null;
@@ -2621,4 +2681,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, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type BootMark, type BootTimeline, type Challenge, type ChallengeWindow, ChallengesApi, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, FriendsApi, type FriendsPage, type GameConfig, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, GemFrame, type GemIdentity, type GemInsets, type GemMatchApi, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, GemSaveError, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerLifecycle, type GemTerminationNotice, type GemViewport, type GetLeaderboardOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, LeaderboardsApi, type ListChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchServeOptions, type MatchTransport, type MessageMeta, type MultiTransportSession, PLATFORM_EVENTS, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, type PlatformEventName, type PlayerBadge, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RewardCue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerTokenGrant, type SessionEndReason, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TransportAdvert, type TransportKind, TransportRefusal, UNRELIABLE_CHANNEL_LABEL, asPlayerText, createBootTimeline, createGem, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, text, webTransportAvailable };
+export { ARCADE_EMBEDDERS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type BootMark, type BootTimeline, type Challenge, type ChallengeWindow, ChallengesApi, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameConfig, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, GemFrame, GemFunctionError, type GemIdentity, type GemInsets, type GemMatchApi, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, GemSaveError, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerLifecycle, type GemTerminationNotice, type GemViewport, type GetLeaderboardOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, LeaderboardsApi, type ListChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchServeOptions, type MatchTransport, type MessageMeta, type MultiTransportSession, PLATFORM_EVENTS, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, type PlatformEventName, type PlayerBadge, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RewardCue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerTokenGrant, type SessionEndReason, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TransportAdvert, type TransportKind, TransportRefusal, UNRELIABLE_CHANNEL_LABEL, asPlayerText, createBootTimeline, createGem, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, text, webTransportAvailable };