@apps-in-toss/devtools 3.0.5 → 3.1.0-beta.1

package/dist/mock/2x.d.ts

@@ -131,6 +131,39 @@ declare const showFullScreenAd: ((args: {
 }) => () => void) & {
   isSupported: () => boolean;
 };
+declare const Ads: {
+  showTossAdOrShoppingAds: ((args: {
+    options: {
+      spaceUnitId: string;
+      adSpaceId: string;
+    };
+    onEvent: (event: {
+      type: string;
+      data?: {
+        unitType: string;
+        unitAmount: number;
+      };
+    }) => void;
+    onError: (error: unknown) => void;
+  }) => () => void) & {
+    isSupported: () => boolean;
+  };
+  showTossShoppingAds: ((args: {
+    options: {
+      adSpaceId: string;
+    };
+    onEvent: (event: {
+      type: string;
+      data?: {
+        unitType: string;
+        unitAmount: number;
+      };
+    }) => void;
+    onError: (error: unknown) => void;
+  }) => () => void) & {
+    isSupported: () => boolean;
+  };
+};
 //#endregion
 //#region src/mock/analytics/index.d.ts
 /**
@@ -776,8 +809,8 @@ interface AddAccessoryButtonOptions {
   };
 }
 declare const partner: {
-  addAccessoryButton: (options: AddAccessoryButtonOptions) => Promise<void>;
-  removeAccessoryButton: () => Promise<void>;
+  addAccessoryButton(options: AddAccessoryButtonOptions): Promise<void>;
+  removeAccessoryButton(): Promise<void>;
 };
 //#endregion
 //#region src/mock/permissions.d.ts
@@ -1153,4 +1186,123 @@ declare function listUserPresets(): MockPreset[];
 declare function saveUserPreset(label: string, state: MockPresetState, description?: string): MockPreset;
 declare function deleteUserPreset(id: string): void;
 //#endregion
-export { Accuracy, type AitDevtoolsState, Analytics, type AnalyticsLogEntry, type ConsentedUserData, type ConsentedUserDataKey, type DeclaredAgeRange, type DeviceApiMode, type DeviceModes, FetchAlbumPhotosPermissionError, FetchContactsPermissionError, GetClipboardTextPermissionError, GetCurrentLocationPermissionError, GoogleAdMob, type HapticFeedbackType, IAP, type IapNextResult, type LocationCoords, type MockContact, type MockData, type MockIapProduct, type MockLocation, type MockPreset, type MockPresetState, type NetworkStatus, OpenCameraPermissionError, type OperationalEnvironment, PermissionError, type PermissionName, type PermissionStatus, type PlatformOS, type Primitive, SafeAreaInsets, type SafeAreaInsets$1 as SafeAreaInsetsType, SetClipboardTextPermissionError, StartUpdateLocationPermissionError, Storage, TossAds, aitState, appLogin, applyPreset, appsInTossEvent, appsInTossSignTossCert, builtInPresets, captureCurrentState, checkoutPayment, closeView, contactsViral, createAsyncBridge, createConstantBridge, createEventBridge, deleteUserPreset, env, eventLog, fetchAlbumItems, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getAnonymousKey, getAppsInTossGlobals, getClipboardText, getConsentedUserData, getCurrentLocation, getDeclaredAgeRange, getDefaultPlaceholderImages, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPermission, getPlatformOS, getSafeAreaInsets, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, graniteEvent, grantPromotionReward, grantPromotionRewardForGame, isMinVersionSupported, listUserPresets, loadFullScreenAd, matchesPreset, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openPDFViewer, openPermissionDialog, openURL, partner, requestNotificationAgreement, requestPermission, requestReview, requestTossPayPaysBilling, saveBase64Data, saveUserPreset, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, showFullScreenAd, startUpdateLocation, submitGameCenterLeaderBoardScore, tdsEvent };
+//#region src/mock/safe-area-bridge.d.ts
+/** The postMessage envelope the launcher posts to the framed dev app (inset forward). */
+declare const SAFE_AREA_INSETS_MESSAGE_TYPE: "ait:safe-area-insets";
+/**
+ * The postMessage command the launcher partner bar's `←` button sends to the
+ * framed dev app (#510). The framed page calls `history.back()` in response.
+ *
+ * Protocol: only `{ type: 'ait:navigate-back' }` is valid. No other fields are
+ * read or acted on — extra fields are silently ignored by the shape guard.
+ * Game variant never sends this message (back button is partner-bar-only).
+ */
+declare const NAVIGATE_BACK_MESSAGE_TYPE: "ait:navigate-back";
+/**
+ * The postMessage envelope the framed mini-app self-reports its webViewType
+ * with (#580). The mini-app knows its own type from the build constant
+ * `__WEB_VIEW_TYPE__` (`granite.config.ts`'s `webViewProps.type`, injected by
+ * the devtools unplugin). The launcher is cross-origin so it cannot read that
+ * constant directly — the mini-app posts it to `window.parent` once so the
+ * launcher (env-2 PWA shell) switches to game mode automatically, with no
+ * manual `?navBarType=game` URL edit.
+ *
+ * Direction: this is the SEND side's contract (posted from inside the iframe by
+ * `@ait-co/debug-console`'s `packages/debug-console/src/attach.ts`). The
+ * launcher's receive half lives in
+ * `e2e/fixture/launcher/Launcher.tsx` and mirrors the same value enum inline,
+ * staying decoupled from the mock package internals — the same pattern the
+ * other launcher message types follow.
+ *
+ * Value enum: only `'partner'` and `'game'` are valid. The SDK's deprecated
+ * `'external'` alias of `partner` (web-framework 2.6.1) is mapped to `'partner'`
+ * at the send site so the wire only ever carries the two shapes the launcher
+ * emulates.
+ */
+declare const WEB_VIEW_TYPE_MESSAGE_TYPE: "ait:web-view-type";
+/** The two webViewType shapes the launcher can emulate (#580). */
+type WebViewTypeValue = "partner" | "game";
+/**
+ * Parse + validate a raw postMessage payload into a `SafeAreaInsets`, or return
+ * null when it is not a well-formed `ait:safe-area-insets` message. Pure — unit
+ * tested without a real MessageEvent.
+ */
+declare function parseSafeAreaInsetsMessage(data: unknown): SafeAreaInsets$1 | null;
+/**
+ * Parse + validate a raw postMessage payload into a webViewType value
+ * (`'partner'` | `'game'`), or return `null` when it is not a well-formed
+ * `ait:web-view-type` message (#580). Pure — unit tested without a real
+ * MessageEvent.
+ *
+ * Strict shape guard (the safety boundary for the cross-origin receive path):
+ * the payload must be a non-null object whose `type` is exactly
+ * {@link WEB_VIEW_TYPE_MESSAGE_TYPE} and whose `value` is exactly `'partner'`
+ * or `'game'` (an enum allow-list). Anything else — a foreign type, a missing
+ * or non-string value, the deprecated `'external'` alias, or any other string —
+ * returns `null` so a stray postMessage can never flip the launcher's visual
+ * mode. The send site is responsible for collapsing `'external'` → `'partner'`
+ * before posting; the parser does NOT silently accept it.
+ */
+declare function parseWebViewTypeMessage(data: unknown): WebViewTypeValue | null;
+/**
+ * Apply forwarded insets to the mock state. Skips the write (and the resulting
+ * subscribe notify) when nothing changed, so repeated identical messages from a
+ * resize storm don't churn subscribers.
+ */
+declare function applyForwardedSafeAreaInsets(insets: SafeAreaInsets$1): void;
+/**
+ * Install the window `message` listener that receives forwarded insets. Safe to
+ * call multiple times (idempotent) and a no-op outside a browser (SSR/jsdom
+ * without a window). Imported for its side effect by the mock barrel so any
+ * consumer that aliases `@apps-in-toss/web-framework` to the mock gets it wired.
+ *
+ * On each valid `ait:safe-area-insets` message:
+ * 1. Writes the corrected insets into the mock `SafeAreaInsets` state
+ *    (existing #484 behaviour — for apps that still read SDK insets).
+ * 2. Drives the env-2 dead-band compensation style via
+ *    {@link applyEnv2Compensation} — injects a `body { margin-top: calc(-1 *
+ *    env(safe-area-inset-top)) }` style when `top === 0` (partner mode) and
+ *    removes it when `top > 0` (game / full-bleed mode).
+ */
+declare function installSafeAreaInsetsBridge(): void;
+/**
+ * Parse a raw postMessage payload as an `ait:navigate-back` command.
+ *
+ * Returns true when the payload is a well-formed navigate-back command
+ * (`{ type: 'ait:navigate-back' }`), false otherwise. Pure — unit tested
+ * without a real MessageEvent.
+ *
+ * Shape guard: only the `type` field is inspected; any extra fields are
+ * ignored so future extensions do not break older receivers. The function
+ * does NOT read any data field beyond `type` — no sensitive values, no host
+ * disclosure (same principle as the insets bridge).
+ */
+declare function isNavigateBackMessage(data: unknown): boolean;
+/**
+ * Install the window `message` listener that handles `ait:navigate-back`
+ * commands (#510). When the launcher partner bar's `←` button is clicked it
+ * posts `{ type: 'ait:navigate-back' }` to the framed dev app; this listener
+ * calls `dispatchHostBackNavigation()` from the navigation module.
+ *
+ * Dispatch semantics: if there are any `graniteEvent.addEventListener('backEvent', …)`
+ * subscribers the CustomEvent `__ait:backEvent` is fired (same path as the env-1
+ * panel back button — the mini-app intercept channel). When there are no
+ * subscribers `history.back()` is called as the fallback. Back semantics are
+ * owned entirely by the navigation module; this bridge only delegates.
+ *
+ * Safe to call multiple times (idempotent) and a no-op outside a browser.
+ * Installed together with the inset bridge by `installBridges()` so any consumer
+ * of the mock barrel gets both wired automatically.
+ *
+ * No-op on apps that predate this bridge — the launcher posts the message but
+ * older mocks simply have no listener (harmless).
+ */
+declare function installNavigateBackBridge(): void;
+/**
+ * Install both env-2 postMessage bridges in one call (#484 insets + #510
+ * navigate-back). The mock barrel calls this at import time so consumers get
+ * all bridges wired without any explicit setup.
+ */
+declare function installBridges(): void;
+//#endregion
+export { Accuracy, Ads, type AitDevtoolsState, Analytics, type AnalyticsLogEntry, type ConsentedUserData, type ConsentedUserDataKey, type DeclaredAgeRange, type DeviceApiMode, type DeviceModes, FetchAlbumPhotosPermissionError, FetchContactsPermissionError, GetClipboardTextPermissionError, GetCurrentLocationPermissionError, GoogleAdMob, type HapticFeedbackType, IAP, type IapNextResult, type LocationCoords, type MockContact, type MockData, type MockIapProduct, type MockLocation, type MockPreset, type MockPresetState, NAVIGATE_BACK_MESSAGE_TYPE, type NetworkStatus, OpenCameraPermissionError, type OperationalEnvironment, PermissionError, type PermissionName, type PermissionStatus, type PlatformOS, type Primitive, SAFE_AREA_INSETS_MESSAGE_TYPE, SafeAreaInsets, type SafeAreaInsets$1 as SafeAreaInsetsType, SetClipboardTextPermissionError, StartUpdateLocationPermissionError, Storage, TossAds, WEB_VIEW_TYPE_MESSAGE_TYPE, type WebViewTypeValue, aitState, appLogin, applyForwardedSafeAreaInsets, applyPreset, appsInTossEvent, appsInTossSignTossCert, builtInPresets, captureCurrentState, checkoutPayment, closeView, contactsViral, createAsyncBridge, createConstantBridge, createEventBridge, deleteUserPreset, env, eventLog, fetchAlbumItems, fetchAlbumPhotos, fetchContacts, generateHapticFeedback, getAnonymousKey, getAppsInTossGlobals, getClipboardText, getConsentedUserData, getCurrentLocation, getDeclaredAgeRange, getDefaultPlaceholderImages, getDeviceId, getGameCenterGameProfile, getGroupId, getIsTossLoginIntegratedService, getLocale, getNetworkStatus, getOperationalEnvironment, getPermission, getPlatformOS, getSafeAreaInsets, getSchemeUri, getServerTime, getTossAppVersion, getTossShareLink, getUserKeyForGame, graniteEvent, grantPromotionReward, grantPromotionRewardForGame, installBridges, installNavigateBackBridge, installSafeAreaInsetsBridge, isMinVersionSupported, isNavigateBackMessage, listUserPresets, loadFullScreenAd, matchesPreset, onVisibilityChangedByTransparentServiceWeb, openCamera, openGameCenterLeaderboard, openPDFViewer, openPermissionDialog, openURL, parseSafeAreaInsetsMessage, parseWebViewTypeMessage, partner, requestNotificationAgreement, requestPermission, requestReview, requestTossPayPaysBilling, saveBase64Data, saveUserPreset, setClipboardText, setDeviceOrientation, setIosSwipeGestureEnabled, setScreenAwakeMode, setSecureScreen, share, showFullScreenAd, startUpdateLocation, submitGameCenterLeaderBoardScore, tdsEvent };