@apps-in-toss/framework 1.9.3 → 1.10.0

package/dist/index.d.cts

@@ -6,8 +6,9 @@ export * from '@apps-in-toss/analytics';
 import { InitialProps, GraniteProps } from '@granite-js/react-native';
 import { WebViewProps as WebViewProps$1 } from '@granite-js/native/react-native-webview';
 import { ExternalWebViewScreenProps } from '@toss/tds-react-native';
-import { StartUpdateLocationOptions, Location } from '@apps-in-toss/types';
+import { StartUpdateLocationOptions, Location, LoadFullScreenAdParams, ShowFullScreenAdParams } from '@apps-in-toss/types';
 export * from '@apps-in-toss/types';
+export { FetchTossAdOptions, LoadFullScreenAdEvent, LoadFullScreenAdOptions, LoadFullScreenAdParams, ShowFullScreenAdEvent, ShowFullScreenAdOptions, ShowFullScreenAdParams, TossAdEventLogParams } from '@apps-in-toss/types';
 import { onVisibilityChangedByTransparentServiceWeb } from '@apps-in-toss/native-modules';
 export * from '@apps-in-toss/native-modules';
 export { OverlayProvider, useOverlay } from '@toss/tds-react-native/private';
@@ -166,75 +167,69 @@ declare function useTopNavigation(): {
 
 declare const env: {
     getDeploymentId: () => string;
+    getWebViewType: () => "partner" | "external" | "game" | undefined;
+    getAppName: () => string;
 };
 
 declare const INTERNAL__onVisibilityChangedByTransparentServiceWeb: typeof onVisibilityChangedByTransparentServiceWeb;
 
-interface LoadFullScreenAdOptions {
-    adGroupId: string;
-}
-interface LoadFullScreenAdEvent {
-    type: 'loaded';
-}
-interface LoadFullScreenAdParams {
-    options: LoadFullScreenAdOptions;
-    onEvent: (data: LoadFullScreenAdEvent) => void;
-    onError: (err: unknown) => void;
-}
 declare const loadFullScreenAd: {
     (params: LoadFullScreenAdParams): () => void;
     isSupported: () => boolean;
 };
-interface ShowFullScreenAdOptions {
-    adGroupId: string;
-}
-type AdMobFullScreenEvent = AdClicked | AdDismissed | AdFailedToShow | AdImpression | AdShow;
-type AdClicked = {
-    type: 'clicked';
-};
-type AdDismissed = {
-    type: 'dismissed';
-};
-type AdFailedToShow = {
-    type: 'failedToShow';
-};
-type AdImpression = {
-    type: 'impression';
-};
-type AdShow = {
-    type: 'show';
-};
-type AdUserEarnedReward = {
-    type: 'userEarnedReward';
-    data: {
-        unitType: string;
-        unitAmount: number;
-    };
-};
-type ShowFullScreenAdEvent = AdMobFullScreenEvent | AdUserEarnedReward | {
-    type: 'requested';
-};
-interface ShowFullScreenAdParams {
-    options: ShowFullScreenAdOptions;
-    onEvent: (data: ShowFullScreenAdEvent) => void;
-    onError: (err: unknown) => void;
-}
 declare function showFullScreenAd(params: ShowFullScreenAdParams): () => void;
 declare namespace showFullScreenAd {
     var isSupported: () => boolean;
 }
 
-interface FetchTossAdOptions {
+interface AdError {
+    code: number;
+    message: string;
+    domain?: string;
+}
+interface BannerSlotEventPayload {
+    slotId: string;
     adGroupId: string;
-    sdkId: string;
-    availableStyleIds: string[];
+    adMetadata: {
+        creativeId: string;
+        requestId: string;
+        styleId: string;
+    };
 }
-
-interface TossAdEventLogParams {
-    log_name: string;
-    log_type: string;
-    params: Record<string, unknown>;
+interface BannerSlotErrorPayload {
+    slotId: string;
+    adGroupId: string;
+    adMetadata: Record<string, never>;
+    error: {
+        code: number;
+        message: string;
+        domain?: string;
+    };
+}
+interface BannerSlotCallbacks {
+    onAdRendered?: (payload: BannerSlotEventPayload) => void;
+    onAdViewable?: (payload: BannerSlotEventPayload) => void;
+    onAdClicked?: (payload: BannerSlotEventPayload) => void;
+    onAdImpression?: (payload: BannerSlotEventPayload) => void;
+    onAdFailedToRender?: (payload: BannerSlotErrorPayload) => void;
+    onNoFill?: (payload: {
+        slotId: string;
+        adGroupId: string;
+        adMetadata: Record<string, never>;
+    }) => void;
 }
+type InlineAdTheme = 'auto' | 'light' | 'dark';
+type InlineAdTone = 'blackAndWhite' | 'grey';
+type InlineAdVariant = 'expanded' | 'card';
+interface InlineAdProps extends BannerSlotCallbacks {
+    adGroupId: string;
+    theme?: InlineAdTheme;
+    tone?: InlineAdTone;
+    variant?: InlineAdVariant;
+    impressFallbackOnMount?: boolean;
+}
+
+declare function InlineAd(props: InlineAdProps): react_jsx_runtime.JSX.Element | null;
 
 declare const Analytics: {
     init: (options: _apps_in_toss_analytics.AnalyticsConfig) => void;
@@ -243,4 +238,4 @@ declare const Analytics: {
     Area: ({ children, params: _params, ...props }: _apps_in_toss_analytics.LoggingAreaProps) => react_jsx_runtime.JSX.Element;
 };
 
-export { Analytics, AppsInToss, type ExternalWebViewProps, type FetchTossAdOptions, type GameWebViewProps, INTERNAL__onVisibilityChangedByTransparentServiceWeb, type LoadFullScreenAdEvent, type LoadFullScreenAdOptions, type LoadFullScreenAdParams, type PartnerWebViewProps, type ShowFullScreenAdEvent, type ShowFullScreenAdOptions, type ShowFullScreenAdParams, type TossAdEventLogParams, type UseGeolocationOptions, WebView, type WebViewProps, env, loadFullScreenAd, showFullScreenAd, useCreateUserAgent, useGeolocation, useTopNavigation, useWaitForReturnNavigator };
+export { type AdError, Analytics, AppsInToss, type BannerSlotCallbacks, type BannerSlotErrorPayload, type BannerSlotEventPayload, type ExternalWebViewProps, type GameWebViewProps, INTERNAL__onVisibilityChangedByTransparentServiceWeb, InlineAd, type InlineAdProps, type InlineAdTheme, type InlineAdTone, type InlineAdVariant, type PartnerWebViewProps, type UseGeolocationOptions, WebView, type WebViewProps, env, loadFullScreenAd, showFullScreenAd, useCreateUserAgent, useGeolocation, useTopNavigation, useWaitForReturnNavigator };

package/dist/index.d.ts

@@ -6,8 +6,9 @@ export * from '@apps-in-toss/analytics';
 import { InitialProps, GraniteProps } from '@granite-js/react-native';
 import { WebViewProps as WebViewProps$1 } from '@granite-js/native/react-native-webview';
 import { ExternalWebViewScreenProps } from '@toss/tds-react-native';
-import { StartUpdateLocationOptions, Location } from '@apps-in-toss/types';
+import { StartUpdateLocationOptions, Location, LoadFullScreenAdParams, ShowFullScreenAdParams } from '@apps-in-toss/types';
 export * from '@apps-in-toss/types';
+export { FetchTossAdOptions, LoadFullScreenAdEvent, LoadFullScreenAdOptions, LoadFullScreenAdParams, ShowFullScreenAdEvent, ShowFullScreenAdOptions, ShowFullScreenAdParams, TossAdEventLogParams } from '@apps-in-toss/types';
 import { onVisibilityChangedByTransparentServiceWeb } from '@apps-in-toss/native-modules';
 export * from '@apps-in-toss/native-modules';
 export { OverlayProvider, useOverlay } from '@toss/tds-react-native/private';
@@ -166,75 +167,69 @@ declare function useTopNavigation(): {
 
 declare const env: {
     getDeploymentId: () => string;
+    getWebViewType: () => "partner" | "external" | "game" | undefined;
+    getAppName: () => string;
 };
 
 declare const INTERNAL__onVisibilityChangedByTransparentServiceWeb: typeof onVisibilityChangedByTransparentServiceWeb;
 
-interface LoadFullScreenAdOptions {
-    adGroupId: string;
-}
-interface LoadFullScreenAdEvent {
-    type: 'loaded';
-}
-interface LoadFullScreenAdParams {
-    options: LoadFullScreenAdOptions;
-    onEvent: (data: LoadFullScreenAdEvent) => void;
-    onError: (err: unknown) => void;
-}
 declare const loadFullScreenAd: {
     (params: LoadFullScreenAdParams): () => void;
     isSupported: () => boolean;
 };
-interface ShowFullScreenAdOptions {
-    adGroupId: string;
-}
-type AdMobFullScreenEvent = AdClicked | AdDismissed | AdFailedToShow | AdImpression | AdShow;
-type AdClicked = {
-    type: 'clicked';
-};
-type AdDismissed = {
-    type: 'dismissed';
-};
-type AdFailedToShow = {
-    type: 'failedToShow';
-};
-type AdImpression = {
-    type: 'impression';
-};
-type AdShow = {
-    type: 'show';
-};
-type AdUserEarnedReward = {
-    type: 'userEarnedReward';
-    data: {
-        unitType: string;
-        unitAmount: number;
-    };
-};
-type ShowFullScreenAdEvent = AdMobFullScreenEvent | AdUserEarnedReward | {
-    type: 'requested';
-};
-interface ShowFullScreenAdParams {
-    options: ShowFullScreenAdOptions;
-    onEvent: (data: ShowFullScreenAdEvent) => void;
-    onError: (err: unknown) => void;
-}
 declare function showFullScreenAd(params: ShowFullScreenAdParams): () => void;
 declare namespace showFullScreenAd {
     var isSupported: () => boolean;
 }
 
-interface FetchTossAdOptions {
+interface AdError {
+    code: number;
+    message: string;
+    domain?: string;
+}
+interface BannerSlotEventPayload {
+    slotId: string;
     adGroupId: string;
-    sdkId: string;
-    availableStyleIds: string[];
+    adMetadata: {
+        creativeId: string;
+        requestId: string;
+        styleId: string;
+    };
 }
-
-interface TossAdEventLogParams {
-    log_name: string;
-    log_type: string;
-    params: Record<string, unknown>;
+interface BannerSlotErrorPayload {
+    slotId: string;
+    adGroupId: string;
+    adMetadata: Record<string, never>;
+    error: {
+        code: number;
+        message: string;
+        domain?: string;
+    };
+}
+interface BannerSlotCallbacks {
+    onAdRendered?: (payload: BannerSlotEventPayload) => void;
+    onAdViewable?: (payload: BannerSlotEventPayload) => void;
+    onAdClicked?: (payload: BannerSlotEventPayload) => void;
+    onAdImpression?: (payload: BannerSlotEventPayload) => void;
+    onAdFailedToRender?: (payload: BannerSlotErrorPayload) => void;
+    onNoFill?: (payload: {
+        slotId: string;
+        adGroupId: string;
+        adMetadata: Record<string, never>;
+    }) => void;
 }
+type InlineAdTheme = 'auto' | 'light' | 'dark';
+type InlineAdTone = 'blackAndWhite' | 'grey';
+type InlineAdVariant = 'expanded' | 'card';
+interface InlineAdProps extends BannerSlotCallbacks {
+    adGroupId: string;
+    theme?: InlineAdTheme;
+    tone?: InlineAdTone;
+    variant?: InlineAdVariant;
+    impressFallbackOnMount?: boolean;
+}
+
+declare function InlineAd(props: InlineAdProps): react_jsx_runtime.JSX.Element | null;
 
 declare const Analytics: {
     init: (options: _apps_in_toss_analytics.AnalyticsConfig) => void;
@@ -243,4 +238,4 @@ declare const Analytics: {
     Area: ({ children, params: _params, ...props }: _apps_in_toss_analytics.LoggingAreaProps) => react_jsx_runtime.JSX.Element;
 };
 
-export { Analytics, AppsInToss, type ExternalWebViewProps, type FetchTossAdOptions, type GameWebViewProps, INTERNAL__onVisibilityChangedByTransparentServiceWeb, type LoadFullScreenAdEvent, type LoadFullScreenAdOptions, type LoadFullScreenAdParams, type PartnerWebViewProps, type ShowFullScreenAdEvent, type ShowFullScreenAdOptions, type ShowFullScreenAdParams, type TossAdEventLogParams, type UseGeolocationOptions, WebView, type WebViewProps, env, loadFullScreenAd, showFullScreenAd, useCreateUserAgent, useGeolocation, useTopNavigation, useWaitForReturnNavigator };
+export { type AdError, Analytics, AppsInToss, type BannerSlotCallbacks, type BannerSlotErrorPayload, type BannerSlotEventPayload, type ExternalWebViewProps, type GameWebViewProps, INTERNAL__onVisibilityChangedByTransparentServiceWeb, InlineAd, type InlineAdProps, type InlineAdTheme, type InlineAdTone, type InlineAdVariant, type PartnerWebViewProps, type UseGeolocationOptions, WebView, type WebViewProps, env, loadFullScreenAd, showFullScreenAd, useCreateUserAgent, useGeolocation, useTopNavigation, useWaitForReturnNavigator };