@indiegems/gem-web-sdk 15.3.2 → 16.0.0

package/dist/sdk.d.ts

@@ -2336,6 +2336,120 @@ interface GemFriendChallengeResult {
     readonly retryAfterMs?: number;
     readonly detail?: string;
 }
+interface GemRequestAppLinks {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.requestAppLinks";
+    readonly requestId: string;
+}
+interface GemAppLinksResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.appLinksResult";
+    readonly requestId: string;
+    readonly outcome: "ok" | "declined" | "unavailable";
+    readonly reason?: string;
+    readonly arcade?: {
+        store: "app_store" | "google_play";
+    };
+    readonly game?: {
+        store: "app_store" | "google_play";
+    };
+}
+interface GemRequestOpenApp {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.requestOpenApp";
+    readonly requestId: string;
+    readonly target: "arcade" | "game";
+}
+interface GemOpenAppResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.openAppResult";
+    readonly requestId: string;
+    readonly outcome: "ok" | "declined" | "unavailable";
+    readonly reason?: string;
+}
+interface GemRequestOpenGame {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.requestOpenGame";
+    readonly requestId: string;
+    readonly ref: string;
+}
+interface GemOpenGameResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.openGameResult";
+    readonly requestId: string;
+    readonly outcome: "ok" | "declined" | "unavailable";
+    readonly reason?: string;
+}
+interface GemRequestSimilarGames {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.requestSimilarGames";
+    readonly requestId: string;
+    readonly limit?: number;
+}
+interface GemSimilarGamesResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.similarGamesResult";
+    readonly requestId: string;
+    readonly outcome: "ok" | "declined" | "unavailable";
+    readonly reason?: string;
+    readonly games: {
+        gameId: string;
+        slug?: string;
+        iconUrl: string;
+        capsuleLandscapeUrl: string;
+        capsulePortraitUrl: string;
+        previewVideoUrl?: string;
+        previewPosterUrl?: string;
+        untrusted: {
+            name: string;
+            tagline: string;
+            shortDescription: string;
+            tags: string[];
+        };
+    }[];
+}
+interface GemRequestStoreOffers {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.requestStoreOffers";
+    readonly requestId: string;
+}
+interface GemStoreOffersResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.storeOffersResult";
+    readonly requestId: string;
+    readonly outcome: "ok" | "declined" | "unavailable";
+    readonly reason?: string;
+    readonly offers: {
+        skuId: string;
+        kind: "gem_pack" | "boost" | "pass" | "bundle";
+        name: string;
+        description: string;
+        imageUrl?: string;
+        priceDisplay: string;
+        grant?: {
+            currency: string;
+            amount: number;
+        };
+    }[];
+}
+interface GemRequestStorePurchase {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.requestStorePurchase";
+    readonly requestId: string;
+    readonly skuId: string;
+}
+interface GemStorePurchaseResult {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.storePurchaseResult";
+    readonly requestId: string;
+    readonly outcome: "ok" | "declined" | "unavailable";
+    readonly reason?: string;
+}
+interface GemStorePurchaseSettled {
+    readonly gem: typeof PROTOCOL;
+    readonly type: "gem.storePurchaseSettled";
+    readonly skuId: string;
+}
 interface ConnectOptions {
     readonly clusterTargetId?: ClusterTargetLike;
     readonly retry?: StartMatchRetryOptions;
@@ -4523,6 +4637,8 @@ interface FramePlayer extends PlayerIdentity {
     readonly avatarUrl?: string;
     readonly boost: PlayerBoost;
 }
+type GemArcadeAsk = Omit<GemRequestAppLinks, "gem"> | Omit<GemRequestOpenApp, "gem"> | Omit<GemRequestOpenGame, "gem"> | Omit<GemRequestSimilarGames, "gem"> | Omit<GemRequestStoreOffers, "gem"> | Omit<GemRequestStorePurchase, "gem">;
+type GemArcadeAnswer = GemAppLinksResult | GemOpenAppResult | GemOpenGameResult | GemSimilarGamesResult | GemStoreOffersResult | GemStorePurchaseResult | GemStorePurchaseSettled;
 interface FrameCallbacks {
     onToken?(msg: GemToken): void;
     onPause?(msg: GemPause): void;
@@ -4559,6 +4675,7 @@ interface FrameCallbacks {
     onMomentResult?(msg: GemMomentResult): void;
     onSignInResult?(msg: GemSignInResult): void;
     onFriendChallengeResult?(msg: GemFriendChallengeResult): void;
+    onArcadeAnswer?(msg: GemArcadeAnswer): void;
     onError?(code: GemErrorCode, message?: string): void;
     onDropped?(code: GemErrorCode, message?: string): void;
     onStateChange?(state: FrameState): void;
@@ -4637,6 +4754,7 @@ declare class GemFrame {
     readyCalled(): boolean;
     requestSignIn(requestId: string): boolean;
     requestFriendChallenge(requestId: string, playerId: string, template: string, params?: Readonly<Record<string, string | number>>): boolean;
+    requestArcade(msg: GemArcadeAsk): boolean;
     close(): void;
     private transition;
     private refuseMalformed;
@@ -4656,6 +4774,72 @@ interface ShareApi {
     readonly available: boolean;
     request(request?: ShareRequest): void;
 }
+type ArcadeOutcomeKind = "ok" | "declined" | "unavailable";
+interface ArcadeOutcome {
+    readonly outcome: ArcadeOutcomeKind;
+    readonly reason?: string;
+}
+type AppStore = "app_store" | "google_play";
+interface AppListing {
+    readonly store: AppStore;
+}
+interface AppLinksOutcome extends ArcadeOutcome {
+    readonly arcade?: AppListing;
+    readonly game?: AppListing;
+}
+interface GameCard {
+    readonly gameId: string;
+    readonly slug?: string;
+    readonly name: PlayerText;
+    readonly tagline: PlayerText;
+    readonly shortDescription: PlayerText;
+    readonly tags: readonly PlayerText[];
+    readonly iconUrl: string;
+    readonly capsuleLandscapeUrl: string;
+    readonly capsulePortraitUrl: string;
+    readonly previewVideoUrl?: string;
+    readonly previewPosterUrl?: string;
+}
+interface SimilarGamesOutcome extends ArcadeOutcome {
+    readonly games: readonly GameCard[];
+}
+interface ArcadeAvailability {
+    readonly appLinks: boolean;
+    readonly openGame: boolean;
+}
+interface ArcadeApi {
+    readonly available: ArcadeAvailability;
+    appLinks(): Promise<AppLinksOutcome>;
+    openApp(target: "arcade" | "game"): Promise<ArcadeOutcome>;
+    openGame(ref: string): Promise<ArcadeOutcome>;
+    similarGames(options?: {
+        readonly limit?: number;
+    }): Promise<SimilarGamesOutcome>;
+}
+interface ArcadeOffer {
+    readonly skuId: string;
+    readonly kind: "gem_pack" | "boost" | "pass" | "bundle";
+    readonly name: string;
+    readonly description: string;
+    readonly imageUrl?: string;
+    readonly priceDisplay: string;
+    readonly grant?: {
+        readonly currency: string;
+        readonly amount: number;
+    };
+}
+interface StoreOffersOutcome extends ArcadeOutcome {
+    readonly offers: readonly ArcadeOffer[];
+}
+interface StoreSettlement {
+    readonly skuId: string;
+}
+interface StoreApi {
+    readonly available: boolean;
+    offers(): Promise<StoreOffersOutcome>;
+    purchase(skuId: string): Promise<ArcadeOutcome>;
+    onSettled(listener: (settlement: StoreSettlement) => void): () => void;
+}
 interface VibrationApi {
     readonly available: boolean;
     vibrate(pattern: number | readonly number[]): boolean;
@@ -4915,6 +5099,8 @@ interface Gem {
     readonly ads: AdsApi;
     readonly account: AccountApi;
     readonly share: ShareApi;
+    readonly arcade: ArcadeApi;
+    readonly store: StoreApi;
     readonly avatarPickerAvailable: boolean;
     openAvatarPicker(options?: {
         readonly tab?: "2d" | "3d";
@@ -4969,4 +5155,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, 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 GameSettingsApi, type Gem, GemApiError, type GemAudioChannels, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemControlBox, type GemCorner, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemGameChoiceSetting, type GemGameSetting, type GemGameSettingBase, type GemGameSettingChange, type GemGameSettingIcon, type GemGameSettingOption, type GemGameSettingValue, type GemGameSliderSetting, type GemGameToggleSetting, 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, experimentSelection, 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, type AppLinksOutcome, type AppListing, type AppStore, type ArcadeApi, type ArcadeAvailability, type ArcadeOffer, type ArcadeOutcome, type ArcadeOutcomeKind, 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 GameCard, type GameConfig, type GameMenu, type GameMenuItem, type GameServerLink, type GameSettingsApi, type Gem, GemApiError, type GemAudioChannels, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemControlBox, type GemCorner, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemGameChoiceSetting, type GemGameSetting, type GemGameSettingBase, type GemGameSettingChange, type GemGameSettingIcon, type GemGameSettingOption, type GemGameSettingValue, type GemGameSliderSetting, type GemGameToggleSetting, 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 SimilarGamesOutcome, type SnapshotCurrency, type SnapshotItem, type StoreApi, type StoreOffersOutcome, type StoreSettlement, 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, experimentSelection, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };

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

@@ -1,6 +1,6 @@
 # The function surface — API reference
 
-Generated from `@indiegems/gem-web-sdk/function` v15.3.2, 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` v16.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.
 
 `@indiegems/gem-web-sdk/function` exports exactly the symbols on this page and nothing else.