@oasiz/sdk 1.6.1 → 1.6.2

package/dist/index.d.cts

@@ -41,6 +41,83 @@ declare function getViewportInsets(): ViewportInsets;
 declare function getSafeAreaTop(): number;
 declare function setLeaderboardVisible(visible: boolean): void;
 
+type Unsubscribe = () => void;
+declare function onPause(callback: () => void): Unsubscribe;
+declare function onResume(callback: () => void): Unsubscribe;
+
+interface BackButtonTestingOptions {
+    /**
+     * When true, pressing Escape dispatches the same event the host app sends for
+     * back actions. Defaults to true.
+     */
+    keyboard?: boolean;
+    /**
+     * When true, the SDK traps one browser-history entry while back override is
+     * active, so the browser Back button can be used for local testing. Defaults
+     * to true.
+     */
+    browserHistory?: boolean;
+    /** Log setup details to the console. Defaults to false. */
+    log?: boolean;
+}
+interface BackButtonTestingHandle {
+    destroy: () => void;
+    isBackOverrideActive: () => boolean;
+    triggerBack: () => void;
+    triggerLeave: () => void;
+}
+declare function enableBackButtonTesting(options?: BackButtonTestingOptions): BackButtonTestingHandle;
+declare function onBackButton(callback: () => void): Unsubscribe;
+declare function onLeaveGame(callback: () => void): Unsubscribe;
+declare function leaveGame(): void;
+
+type AppSimulatorDeviceName = "iphone-11" | "iphone-11-pro" | "iphone-11-pro-max" | "iphone-12-mini" | "iphone-12" | "iphone-12-pro" | "iphone-12-pro-max" | "iphone-13-mini" | "iphone-13" | "iphone-13-pro" | "iphone-13-pro-max" | "iphone-14" | "iphone-14-plus" | "iphone-14-pro" | "iphone-14-pro-max" | "iphone-15" | "iphone-15-plus" | "iphone-15-pro" | "iphone-15-pro-max" | "iphone-16" | "iphone-16-plus" | "iphone-16-pro" | "iphone-16-pro-max" | "iphone-16e" | "iphone-17" | "iphone-17-pro" | "iphone-17-pro-max" | "iphone-17e" | "iphone-air" | "iphone-se" | "pixel-8";
+type AppSimulatorOrientation = "portrait" | "landscape";
+interface AppSimulatorDevice {
+    height: number;
+    name?: string;
+    safeArea?: Partial<ViewportInsetEdges>;
+    width: number;
+}
+interface AppSimulatorOptions {
+    browserHistoryBack?: BackButtonTestingOptions["browserHistory"];
+    comments?: number;
+    device?: AppSimulatorDeviceName | AppSimulatorDevice;
+    enabled?: boolean;
+    /**
+     * When true, the SDK tries to place the current game DOM inside a centered
+     * phone viewport on desktop. Use false if your game already runs in browser
+     * device emulation or owns its own preview frame. Defaults to true.
+     */
+    frame?: boolean | "auto";
+    keyboardBack?: BackButtonTestingOptions["keyboard"];
+    leaderboardVisible?: boolean;
+    likes?: number;
+    log?: boolean;
+    orientation?: AppSimulatorOrientation;
+    score?: number;
+    title?: string;
+}
+interface AppSimulatorHandle {
+    closeSheet: () => void;
+    destroy: () => void;
+    getViewportInsets: () => ViewportInsets;
+    hide: () => void;
+    isVisible: () => boolean;
+    openComments: () => void;
+    openLeaderboard: () => void;
+    setCounts: (counts: {
+        comments?: number;
+        likes?: number;
+    }) => void;
+    setLeaderboardVisible: (visible: boolean) => void;
+    setLiked: (liked: boolean) => void;
+    show: () => void;
+    triggerBack: () => void;
+    triggerLeave: () => void;
+}
+declare function enableAppSimulator(options?: AppSimulatorOptions): AppSimulatorHandle;
+
 type HapticType = "light" | "medium" | "heavy" | "success" | "error";
 type LogOverlayLevel = "debug" | "log" | "info" | "warn" | "error";
 interface LogOverlayEntry {
@@ -235,38 +312,9 @@ declare function loadGameState(): GameState;
 declare function saveGameState(state: GameState): void;
 declare function flushGameState(): void;
 
-type Unsubscribe = () => void;
-declare function onPause(callback: () => void): Unsubscribe;
-declare function onResume(callback: () => void): Unsubscribe;
-
-interface BackButtonTestingOptions {
-    /**
-     * When true, pressing Escape dispatches the same event the host app sends for
-     * back actions. Defaults to true.
-     */
-    keyboard?: boolean;
-    /**
-     * When true, the SDK traps one browser-history entry while back override is
-     * active, so the browser Back button can be used for local testing. Defaults
-     * to true.
-     */
-    browserHistory?: boolean;
-    /** Log setup details to the console. Defaults to false. */
-    log?: boolean;
-}
-interface BackButtonTestingHandle {
-    destroy: () => void;
-    isBackOverrideActive: () => boolean;
-    triggerBack: () => void;
-    triggerLeave: () => void;
-}
-declare function enableBackButtonTesting(options?: BackButtonTestingOptions): BackButtonTestingHandle;
-declare function onBackButton(callback: () => void): Unsubscribe;
-declare function onLeaveGame(callback: () => void): Unsubscribe;
-declare function leaveGame(): void;
-
 declare const oasiz: {
     submitScore: typeof submitScore;
+    enableAppSimulator: typeof enableAppSimulator;
     addScore: typeof addScore;
     setScore: typeof setScore;
     getPlayerCharacter: typeof getPlayerCharacter;
@@ -298,4 +346,4 @@ declare const oasiz: {
     readonly graphicsPerformance: GraphicsPerformanceMetric;
 };
 
-export { type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };
+export { type AppSimulatorDevice, type AppSimulatorDeviceName, type AppSimulatorHandle, type AppSimulatorOptions, type AppSimulatorOrientation, type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableAppSimulator, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };

package/dist/index.d.ts

@@ -41,6 +41,83 @@ declare function getViewportInsets(): ViewportInsets;
 declare function getSafeAreaTop(): number;
 declare function setLeaderboardVisible(visible: boolean): void;
 
+type Unsubscribe = () => void;
+declare function onPause(callback: () => void): Unsubscribe;
+declare function onResume(callback: () => void): Unsubscribe;
+
+interface BackButtonTestingOptions {
+    /**
+     * When true, pressing Escape dispatches the same event the host app sends for
+     * back actions. Defaults to true.
+     */
+    keyboard?: boolean;
+    /**
+     * When true, the SDK traps one browser-history entry while back override is
+     * active, so the browser Back button can be used for local testing. Defaults
+     * to true.
+     */
+    browserHistory?: boolean;
+    /** Log setup details to the console. Defaults to false. */
+    log?: boolean;
+}
+interface BackButtonTestingHandle {
+    destroy: () => void;
+    isBackOverrideActive: () => boolean;
+    triggerBack: () => void;
+    triggerLeave: () => void;
+}
+declare function enableBackButtonTesting(options?: BackButtonTestingOptions): BackButtonTestingHandle;
+declare function onBackButton(callback: () => void): Unsubscribe;
+declare function onLeaveGame(callback: () => void): Unsubscribe;
+declare function leaveGame(): void;
+
+type AppSimulatorDeviceName = "iphone-11" | "iphone-11-pro" | "iphone-11-pro-max" | "iphone-12-mini" | "iphone-12" | "iphone-12-pro" | "iphone-12-pro-max" | "iphone-13-mini" | "iphone-13" | "iphone-13-pro" | "iphone-13-pro-max" | "iphone-14" | "iphone-14-plus" | "iphone-14-pro" | "iphone-14-pro-max" | "iphone-15" | "iphone-15-plus" | "iphone-15-pro" | "iphone-15-pro-max" | "iphone-16" | "iphone-16-plus" | "iphone-16-pro" | "iphone-16-pro-max" | "iphone-16e" | "iphone-17" | "iphone-17-pro" | "iphone-17-pro-max" | "iphone-17e" | "iphone-air" | "iphone-se" | "pixel-8";
+type AppSimulatorOrientation = "portrait" | "landscape";
+interface AppSimulatorDevice {
+    height: number;
+    name?: string;
+    safeArea?: Partial<ViewportInsetEdges>;
+    width: number;
+}
+interface AppSimulatorOptions {
+    browserHistoryBack?: BackButtonTestingOptions["browserHistory"];
+    comments?: number;
+    device?: AppSimulatorDeviceName | AppSimulatorDevice;
+    enabled?: boolean;
+    /**
+     * When true, the SDK tries to place the current game DOM inside a centered
+     * phone viewport on desktop. Use false if your game already runs in browser
+     * device emulation or owns its own preview frame. Defaults to true.
+     */
+    frame?: boolean | "auto";
+    keyboardBack?: BackButtonTestingOptions["keyboard"];
+    leaderboardVisible?: boolean;
+    likes?: number;
+    log?: boolean;
+    orientation?: AppSimulatorOrientation;
+    score?: number;
+    title?: string;
+}
+interface AppSimulatorHandle {
+    closeSheet: () => void;
+    destroy: () => void;
+    getViewportInsets: () => ViewportInsets;
+    hide: () => void;
+    isVisible: () => boolean;
+    openComments: () => void;
+    openLeaderboard: () => void;
+    setCounts: (counts: {
+        comments?: number;
+        likes?: number;
+    }) => void;
+    setLeaderboardVisible: (visible: boolean) => void;
+    setLiked: (liked: boolean) => void;
+    show: () => void;
+    triggerBack: () => void;
+    triggerLeave: () => void;
+}
+declare function enableAppSimulator(options?: AppSimulatorOptions): AppSimulatorHandle;
+
 type HapticType = "light" | "medium" | "heavy" | "success" | "error";
 type LogOverlayLevel = "debug" | "log" | "info" | "warn" | "error";
 interface LogOverlayEntry {
@@ -235,38 +312,9 @@ declare function loadGameState(): GameState;
 declare function saveGameState(state: GameState): void;
 declare function flushGameState(): void;
 
-type Unsubscribe = () => void;
-declare function onPause(callback: () => void): Unsubscribe;
-declare function onResume(callback: () => void): Unsubscribe;
-
-interface BackButtonTestingOptions {
-    /**
-     * When true, pressing Escape dispatches the same event the host app sends for
-     * back actions. Defaults to true.
-     */
-    keyboard?: boolean;
-    /**
-     * When true, the SDK traps one browser-history entry while back override is
-     * active, so the browser Back button can be used for local testing. Defaults
-     * to true.
-     */
-    browserHistory?: boolean;
-    /** Log setup details to the console. Defaults to false. */
-    log?: boolean;
-}
-interface BackButtonTestingHandle {
-    destroy: () => void;
-    isBackOverrideActive: () => boolean;
-    triggerBack: () => void;
-    triggerLeave: () => void;
-}
-declare function enableBackButtonTesting(options?: BackButtonTestingOptions): BackButtonTestingHandle;
-declare function onBackButton(callback: () => void): Unsubscribe;
-declare function onLeaveGame(callback: () => void): Unsubscribe;
-declare function leaveGame(): void;
-
 declare const oasiz: {
     submitScore: typeof submitScore;
+    enableAppSimulator: typeof enableAppSimulator;
     addScore: typeof addScore;
     setScore: typeof setScore;
     getPlayerCharacter: typeof getPlayerCharacter;
@@ -298,4 +346,4 @@ declare const oasiz: {
     readonly graphicsPerformance: GraphicsPerformanceMetric;
 };
 
-export { type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };
+export { type AppSimulatorDevice, type AppSimulatorDeviceName, type AppSimulatorHandle, type AppSimulatorOptions, type AppSimulatorOrientation, type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableAppSimulator, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };