@indiegems/gem-web-sdk 7.3.1 → 7.4.0

package/dist/sdk.d.ts

@@ -205,6 +205,7 @@ type GameConfigSnapshot = {
     "async_opponent_types"?: SnapshotAsyncOpponentType[];
     "catalogs": SnapshotCatalog[];
     "currencies": SnapshotCurrency[];
+    "friend_challenge_templates"?: SnapshotFriendChallengeTemplate[];
     "game_room_templates": SnapshotGameRoomTemplate[];
     "hash": string;
     "items": SnapshotItem[];
@@ -212,6 +213,7 @@ type GameConfigSnapshot = {
     "leaderboards"?: SnapshotLeaderboard[];
     "loot_tables": SnapshotLootTable[];
     "progressions": SnapshotProgression[];
+    "rewarded_placements"?: SnapshotRewardedPlacement[];
     "run_types"?: SnapshotRunType[];
     "version": number;
 };
@@ -419,6 +421,21 @@ type SnapshotCurrency = {
     "min_balance": number;
     "slug"?: string | null;
 };
+type SnapshotFriendChallengeParam = {
+    "key": string;
+    "localized"?: Record<string, unknown> | null;
+    "max"?: unknown;
+    "min"?: unknown;
+    "pattern"?: string | null;
+    "type": string;
+    "values"?: Record<string, unknown> | null;
+};
+type SnapshotFriendChallengeTemplate = {
+    "key": string;
+    "localized"?: Record<string, unknown>;
+    "params"?: SnapshotFriendChallengeParam[];
+    "text": string;
+};
 type SnapshotGameRoomTemplate = {
     "allow_host_transfer": boolean;
     "allow_join_in_progress"?: boolean;
@@ -526,6 +543,25 @@ type SnapshotRecipe = {
     "slug"?: string | null;
     "sort_order": number;
 };
+type SnapshotRewardGrant = {
+    "item_definition_id": string;
+    "quantity": number;
+    "type": "item_grant";
+} | {
+    "amount": number;
+    "currency_id": string;
+    "type": "currency_grant";
+};
+type SnapshotRewardedPlacement = {
+    "allowance_currency_id"?: string | null;
+    "cooldown_seconds": number;
+    "grants": SnapshotRewardGrant[];
+    "max_held"?: number | null;
+    "max_per_day": number;
+    "placement": string;
+    "reward_class": string;
+    "without_ads": string;
+};
 type SnapshotRunType = {
     "bucket_1_allowed_values"?: string[] | null;
     "bucket_1_name"?: string | null;
@@ -1211,10 +1247,35 @@ interface ListFriendsOptions {
     readonly cursor?: string;
     readonly signal?: AbortSignal;
 }
+interface FriendChallengeRequest {
+    readonly playerId: string;
+    readonly template: string;
+    readonly params?: Readonly<Record<string, string | number>>;
+}
+type FriendChallengeOutcomeKind = "accepted" | "cancelled" | "refused" | "unavailable";
+interface FriendChallengeOutcome {
+    readonly outcome: FriendChallengeOutcomeKind;
+}
+type FriendChallengeErrorCode = "unknown_template" | "template_not_on_channel" | "param_invalid" | "param_undeclared" | "recipient_invalid" | (string & {});
+declare class FriendChallengeError extends GemApiError {
+    readonly code?: FriendChallengeErrorCode;
+    readonly param?: string;
+    readonly channel?: string;
+    readonly configVersion?: number;
+    constructor(source: GemApiError, extra?: {
+        readonly param?: string;
+        readonly channel?: string;
+        readonly configVersion?: number;
+    });
+}
+interface FriendsApiDependencies {
+    readonly challenge?: (request: FriendChallengeRequest) => Promise<FriendChallengeOutcome>;
+}
 declare class FriendsApi {
     #private;
-    constructor(api: GameApi$1);
+    constructor(api: GameApi$1, dependencies?: FriendsApiDependencies);
     list(options?: ListFriendsOptions): Promise<FriendsPage>;
+    challenge(request: FriendChallengeRequest): Promise<FriendChallengeOutcome>;
 }
 type PlatformCurrencyAccess = "read" | "spend";
 interface PlatformCurrency {
@@ -1231,9 +1292,35 @@ declare class PlatformCurrenciesApi {
     constructor(api: GameApi$1);
     get(options?: PlatformCurrencyReadOptions): Promise<readonly PlatformCurrency[]>;
 }
+type EarnAllowancePeriod = "day" | "window";
+interface EarnAllowance {
+    readonly currencySlug: string;
+    readonly currencyId: string;
+    readonly limit: number;
+    readonly earned: number;
+    readonly remaining: number;
+    readonly period: EarnAllowancePeriod;
+    readonly periodDays: number;
+    readonly resetsAt?: number;
+}
+interface EarnAllowanceReadOptions {
+    readonly signal?: AbortSignal;
+}
+interface EarnAllowanceSignal {
+    on(listener: () => void): () => void;
+    emit(): void;
+}
+type EarnAllowanceEvent = "changed";
+declare class PlatformEarnAllowanceApi {
+    #private;
+    constructor(api: GameApi$1, signal?: EarnAllowanceSignal, log?: ((line: string) => void) | null);
+    get(options?: EarnAllowanceReadOptions): Promise<readonly EarnAllowance[]>;
+    on(event: EarnAllowanceEvent, listener: () => void): () => void;
+}
 declare class PlatformApi {
     readonly currencies: PlatformCurrenciesApi;
-    constructor(api: GameApi$1);
+    readonly earnAllowance: PlatformEarnAllowanceApi;
+    constructor(api: GameApi$1, earnAllowanceSignal?: EarnAllowanceSignal, log?: ((line: string) => void) | null);
 }
 interface ProfileShowcaseEntry$1 {
     readonly key: string;
@@ -1856,6 +1943,12 @@ interface GemViewport$1 {
         bottom: number;
         left: number;
     };
+    readonly reserved?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }[];
 }
 interface GemDeviceSettings {
     readonly gem: typeof PROTOCOL;
@@ -1977,6 +2070,18 @@ interface GemSignInResult {
     readonly requestId: string;
     readonly outcome: "signed_in" | "declined" | "unavailable";
 }
+interface GemFriendChallengeResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.friendChallengeResult";
+    readonly requestId: string;
+    readonly outcome: "accepted" | "cancelled" | "refused" | "unavailable" | "rate_limited" | "invalid";
+    readonly code?: string;
+    readonly param?: string;
+    readonly channel?: string;
+    readonly configVersion?: number;
+    readonly retryAfterMs?: number;
+    readonly detail?: string;
+}
 interface ConnectOptions {
     readonly clusterTargetId?: ClusterTargetLike;
     readonly retry?: StartMatchRetryOptions;
@@ -3967,25 +4072,6 @@ interface SignInOutcome {
 interface AccountApi {
     requestSignIn(): Promise<SignInOutcome>;
 }
-type AdFormat = "interstitial" | "rewarded";
-interface AdRequest {
-    placement: string;
-    format: AdFormat;
-}
-type AdOutcomeKind = "shown" | "no_ad" | "unavailable";
-interface AdOutcome {
-    readonly outcome: AdOutcomeKind;
-}
-interface AdsApi {
-    requestAd(req: AdRequest): Promise<AdOutcome>;
-}
-type DeviceSettings = Readonly<Record<string, unknown>>;
-type DeviceSettingsPutOutcome = "stored" | "too_large" | "unavailable";
-interface DeviceSettingsApi {
-    readonly current: DeviceSettings | null;
-    wait(timeoutMs?: number): Promise<DeviceSettings | null>;
-    put(settings: DeviceSettings): Promise<DeviceSettingsPutOutcome>;
-}
 interface PlayerBoostMultiplier {
     readonly currencyId: string;
     readonly currencySlug: string;
@@ -4016,6 +4102,7 @@ interface FrameCallbacks {
     onPause?(msg: GemPause): void;
     onPrefs?(msg: GemPrefs$1): void;
     onCohorts?(msg: GemCohorts$1): void;
+    onEarnAllowanceChanged?(): void;
     onViewport?(msg: GemViewport$1): void;
     onWillTerminate?(msg: GemWillTerminate): void;
     onDevtools?(action: "open" | "close" | "toggle"): void;
@@ -4041,6 +4128,7 @@ interface FrameCallbacks {
     onDeviceSettingsResult?(msg: GemDeviceSettingsResult): void;
     onAdResult?(msg: GemAdResult): void;
     onSignInResult?(msg: GemSignInResult): void;
+    onFriendChallengeResult?(msg: GemFriendChallengeResult): void;
     onError?(code: GemErrorCode, message?: string): void;
     onDropped?(code: GemErrorCode, message?: string): void;
     onStateChange?(state: FrameState): void;
@@ -4082,6 +4170,13 @@ declare class GemFrame {
     requestFullscreen(enabled: boolean): void;
     reportMuted(muted: boolean): boolean;
     cueReward(cue: RewardCue): boolean;
+    setWalletVisible(visible: boolean, options?: {
+        only?: readonly string[];
+    }): boolean;
+    requestShare(params: ReadonlyArray<{
+        readonly key: string;
+        readonly value: string;
+    }>): boolean;
     reportFrameStats(stats: {
         fps: number;
         frameTimeP95Ms: number;
@@ -4094,6 +4189,7 @@ declare class GemFrame {
     putDeviceSettings(requestId: string, settings: Readonly<Record<string, unknown>>): boolean;
     requestAd(requestId: string, placement: string, format: "interstitial" | "rewarded"): boolean;
     requestSignIn(requestId: string): boolean;
+    requestFriendChallenge(requestId: string, playerId: string, template: string, params?: Readonly<Record<string, string | number>>): boolean;
     close(): void;
     private transition;
     private refuseMalformed;
@@ -4105,6 +4201,32 @@ declare class GemFrame {
     private dispatchInbound;
     private screenshotDenied;
 }
+interface ShareRequest {
+    readonly params?: Readonly<Record<string, string>>;
+}
+interface ShareApi {
+    readonly available: boolean;
+    request(request?: ShareRequest): void;
+}
+type AdFormat = "interstitial" | "rewarded";
+interface AdRequest {
+    placement: string;
+    format: AdFormat;
+}
+type AdOutcomeKind = "shown" | "no_ad" | "unavailable";
+interface AdOutcome {
+    readonly outcome: AdOutcomeKind;
+}
+interface AdsApi {
+    requestAd(req: AdRequest): Promise<AdOutcome>;
+}
+type DeviceSettings = Readonly<Record<string, unknown>>;
+type DeviceSettingsPutOutcome = "stored" | "too_large" | "unavailable";
+interface DeviceSettingsApi {
+    readonly current: DeviceSettings | null;
+    wait(timeoutMs?: number): Promise<DeviceSettings | null>;
+    put(settings: DeviceSettings): Promise<DeviceSettingsPutOutcome>;
+}
 declare const DEVICE_SETTINGS_MAX_BYTES = 16384;
 declare const ARCADE_EMBEDDERS: readonly string[];
 interface GemOptions {
@@ -4165,6 +4287,16 @@ interface GemInsets {
 }
 interface GemViewport {
     readonly insets: GemInsets;
+    readonly reserved: readonly GemReservedArea[];
+}
+interface GemReservedArea {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+interface WalletVisibleOptions {
+    readonly only?: readonly string[];
 }
 interface GemTerminationNotice {
     readonly reason: GemWillTerminate["reason"];
@@ -4189,6 +4321,7 @@ interface Gem {
     readonly deviceSettings: DeviceSettingsApi;
     readonly ads: AdsApi;
     readonly account: AccountApi;
+    readonly share: ShareApi;
     readonly analytics: AnalyticsApi;
     readonly leaderboards: LeaderboardsApi;
     readonly challenges: ChallengesApi;
@@ -4204,6 +4337,7 @@ interface Gem {
     awaitCohorts(timeoutMs?: number): Promise<GemCohorts | null>;
     reportMuted(muted: boolean): void;
     cueReward(cue: RewardCue): boolean;
+    setWalletVisible(visible: boolean, options?: WalletVisibleOptions): boolean;
     exit(reason?: string): Promise<void>;
     readonly boot: BootTimeline;
     readonly frame: GemFrame;
@@ -4229,4 +4363,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 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, 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$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemIdentity, type GemInsets, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, 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$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 RoomArgValue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerApi, type ServerBundleHost, type ServerTokenGrant, type SessionEndReason, 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, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, 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$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, 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, 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, FriendChallengeError, type FriendChallengeErrorCode, type FriendChallengeOutcome, type FriendChallengeOutcomeKind, type FriendChallengeRequest, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemIdentity, type GemInsets, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, type GemReservedArea, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, 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, 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 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 WalletVisibleOptions, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indiegems/gem-web-sdk",
-  "version": "7.3.1",
+  "version": "7.4.0",
   "description": "postMessage bridge contract between gem-web and browser-playable games",
   "license": "UNLICENSED",
   "type": "module",