@playcraft/adsdk 1.0.12 → 1.0.13-beta.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-type EventName = 'init' | 'ready' | 'start' | 'interactive' | 'interaction' | 'success' | 'resize' | 'pause' | 'resume' | 'volume' | 'retry' | 'finish' | 'install';
+type EventName = 'playcraftInit' | 'playcraftReady' | 'playcraftStart' | 'playcraftInteractive' | 'playcraftInteraction' | 'playcraftChallengeStart' | 'playcraftChallengeProgress' | 'playcraftChallengeSuccess' | 'playcraftChallengeFailed' | 'playcraftResize' | 'playcraftPause' | 'playcraftResume' | 'playcraftVolume' | 'playcraftRetry' | 'playcraftFinish' | 'playcraftInstall';
 
 type InitCallbackType = (maxWidth: number, maxHeight: number) => void;
 /**
@@ -26,135 +26,114 @@ declare class sdk {
     static volume: number;
     /** Number of user interactions with the playable ad (auto-incremented on each touch/click) */
     static interactions: number;
-    /** Number of successful game actions (e.g., successful matches, level clears).
-     * Controlled by calling sdk.recordSuccessCount(), NOT auto-incremented.
-     */
-    static successCount: number;
     /**
      * Initializes the SDK and sets up protocol-specific handlers.
      * This must be called as earlier as possible.
      *
      * @param callback Optional function called when ad container is ready
-     * @param options Optional configuration options
-     * @param options.totalSuccessCount Total number of successful actions expected for progress tracking.
-     *   When set, the SDK will track success progress as a percentage and trigger
-     *   channel-specific milestone events (e.g., AppLovin: CHALLENGE_PASS_25/50/75, CHALLENGE_SOLVED).
-     *   Different channels monitor different percentage thresholds independently.
-     *   Set to 0 or omit to disable progress tracking.
      * @example
      * // Basic initialization
-     * sdk.init();
+     * sdk.playcraftInit();
      *
      * // Initialization with callback
-     * sdk.init((width, height) => {
+     * sdk.playcraftInit((width, height) => {
      *   new App(width, height)
      * });
      *
-     * // Initialization with success count progress tracking
-     * sdk.init((width, height) => {
-     *   new App(width, height)
-     * }, { totalSuccessCount: 20 });
-     *
-     * @fires loading When SDK initialization starts
-     * @fires loaded When game instance is created and ready to load resources
+     * @fires playcraftInit When SDK initialization starts
+     * @fires playcraftReady When game instance is created and ready to load resources
      */
-    static init(callback?: InitCallbackType, options?: {
-        totalSuccessCount?: number;
-    }): void;
+    static playcraftInit(callback?: InitCallbackType): void;
     /**
      * Starts the playable ad experience.
      * Should be called after all resources are loaded and first frame is rendered.
      *
      * @example
-     * // Call just after all resources are preloaded and first frame is rendered
-     * sdk.start();
+     * sdk.playcraftStart();
      *
-     * @fires start When the playable ad starts
-     * @fires resize When the ad container is initially sized
+     * @fires playcraftStart When the playable ad starts
+     * @fires playcraftResize When the ad container is initially sized
      */
-    static start(): void;
+    static playcraftStart(): void;
     /**
      * Marks the main scene as fully loaded and ready for user interaction.
      * Should be called at the end of your main game scene's create() method.
      *
      * @example
-     * // In Phaser MainScene.create()
      * create() {
      *   // ... all initialization code ...
-     *   sdk.interactive();
+     *   sdk.playcraftInteractive();
+     * }
+     *
+     * @fires playcraftInteractive When the main scene is ready for user interaction
+     */
+    static playcraftInteractive(): void;
+    /**
+     * Marks the challenge as started.
+     * Should be called by business logic when the user actually starts playing.
+     *
+     * @example
+     * onFirstClick() {
+     *   sdk.playcraftChallengeStart();
      * }
      *
-     * @fires interactive When the main scene is ready for user interaction
+     * @fires playcraftChallengeStart When the challenge starts
      */
-    static interactive(): void;
+    static playcraftChallengeStart(): void;
     /**
      * Marks the playable ad as finished.
-     * This triggers network-specific completion handlers.
      *
      * @example
-     * // Call when game/experience is complete
-     * sdk.finish();
+     * sdk.playcraftFinish();
      *
-     * @fires finish When the playable ad is marked as finished
+     * @fires playcraftFinish When the playable ad is marked as finished
      */
-    static finish(): void;
+    static playcraftFinish(): void;
     /**
      * Triggers a retry/restart of the playable ad.
-     * Behavior varies by ad network.
      *
      * @example
-     * // Allow user to try again
-     * retryButton.onclick = () => sdk.retry();
+     * retryButton.onclick = () => sdk.playcraftRetry();
      *
-     * @fires retry When a retry is triggered
+     * @fires playcraftRetry When a retry is triggered
      */
-    static retry(): void;
+    static playcraftRetry(): void;
     /**
      * Triggers the install/download action for the advertised app.
-     * Handles different store opening methods across ad networks.
      *
      * @example
-     * // Call when user wants to install
-     * installButton.onclick = () => sdk.install();
+     * installButton.onclick = () => sdk.playcraftInstall();
      *
-     * @fires finish If the ad hasn't been marked as finished
-     * @fires install When the install action is triggered
+     * @fires playcraftFinish If the ad hasn't been marked as finished
+     * @fires playcraftInstall When the install action is triggered
      */
-    static install(params?: {
+    static playcraftInstall(params?: {
         action_type: 'auto' | 'click';
         timeout: number;
     }): void;
     /**
      * Trigger force resize event
-     * Useful when container size changes need to be manually propagated.
      *
      * @example
-     * sdk.resize();
+     * sdk.playcraftResize();
      *
-     * @fires resize With current maxWidth and maxHeight
+     * @fires playcraftResize With current maxWidth and maxHeight
      */
-    static resize(): void;
+    static playcraftResize(): void;
     /**
-     * Records successful game actions (e.g., successful match, level clear).
-     * This should be called by game logic when a meaningful success occurs.
-     * This count is used for progress tracking (e.g., AppLovin milestone events).
+     * Records playable ad challenge progress (0-100).
+     * Triggers channel-specific milestone events based on the progress value.
+     * Milestones are not re-triggered once fired.
      *
-     * @param count Optional success count to add (default: 1)
+     * @param percent Progress percentage (0-100)
      *
      * @example
-     * // Record single success when match completes
-     * onMatchSuccess() {
-     *   sdk.recordSuccessCount();
-     * }
-     *
-     * // Record multiple successes at once
-     * onComboMatch(comboCount) {
-     *   sdk.recordSuccessCount(comboCount);
-     * }
+     * // Report 50% progress
+     * sdk.recordPlaycraftChallengeProgress(50);
      *
-     * @fires success With updated success count (triggers progress tracking)
+     * @fires playcraftChallengeProgress With the progress percentage value
      */
-    static recordSuccessCount(count?: number): void;
+    static recordPlaycraftChallengeProgress(percent: number): void;
     /**
      * Records a game success/completion event.
      * Sends platform-specific success tracking events:
@@ -163,45 +142,40 @@ declare class sdk {
      * - InMobi: Gameplay_Complete
      *
      * @example
-     * // When player completes the level
      * onLevelComplete() {
-     *   sdk.recordSuccess();
+     *   sdk.playcraftRecordSuccess();
      * }
      */
-    static recordSuccess(): void;
+    static playcraftRecordSuccess(): void;
     /**
      * Records a game failure event.
      * Sends platform-specific failure tracking events:
      * - AppLovin: CHALLENGE_FAILED
      *
      * @example
-     * // When player fails the level
      * onLevelFailed() {
-     *   sdk.recordFailed();
+     *   sdk.playcraftRecordFailed();
      * }
      */
-    static recordFailed(): void;
+    static playcraftRecordFailed(): void;
     /**
      * Forces the playable ad into a paused state.
      *
      * @example
-     * // Pause the experience
-     * pauseButton.onclick = () => sdk.pause();
+     * pauseButton.onclick = () => sdk.playcraftPause();
      *
-     * @fires pause When the ad enters paused state
+     * @fires playcraftPause When the ad enters paused state
      */
-    static pause(): void;
+    static playcraftPause(): void;
     /**
      * Resumes the playable ad from a forced pause state.
-     * Only works if the ad was paused via sdk.pause().
      *
      * @example
-     * // Resume from pause
-     * resumeButton.onclick = () => sdk.resume();
+     * resumeButton.onclick = () => sdk.playcraftResume();
      *
-     * @fires resume When the ad resumes from pause
+     * @fires playcraftResume When the ad resumes from pause
      */
-    static resume(): void;
+    static playcraftResume(): void;
     /**
      * Registers an event listener.
      *
@@ -210,15 +184,9 @@ declare class sdk {
      * @param context Optional 'this' context for the callback
      *
      * @example
-     * // Listen for user interactions
-     * sdk.on('interaction', (count) => {
+     * sdk.on('playcraftInteraction', (count) => {
      *   console.log(`User interaction #${count}`);
      * });
-     *
-     * // Listen for resize with context
-     * sdk.on('resize', function(width, height) {
-     *   this.updateLayout(width, height);
-     * }, gameInstance);
      */
     static on(event: EventName, fn: Function, context?: any): void;
     /**
@@ -229,8 +197,7 @@ declare class sdk {
      * @param context Optional 'this' context for the callback
      *
      * @example
-     * // Listen for first interaction only
-     * sdk.once('interaction', () => {
+     * sdk.once('playcraftInteraction', () => {
      *   console.log('First user interaction occurred!');
      * });
      */
@@ -239,20 +206,14 @@ declare class sdk {
      * Removes an event listener.
      *
      * @param event Name of the event to stop listening for
-     * @param fn Optional callback function to remove (if not provided, removes all listeners for the event)
+     * @param fn Optional callback function to remove
      * @param context Optional 'this' context to match when removing
      *
      * @example
-     * // Remove specific listener
-     * const handler = () => console.log('Interaction');
-     * sdk.off('interaction', handler);
-     *
-     * // Remove all listeners for an event
-     * sdk.off('interaction');
+     * sdk.off('playcraftInteraction', handler);
      */
     static off(event: EventName, fn?: Function, context?: any): void;
     /**
-     *
      * @returns 当前渠道
      */
     static getCurChannel(): "applovin" | "ironsource" | "unity" | "mintegral" | "preview" | "google" | "facebook" | "moloco" | "vungle" | "adcolony" | "tapjoy" | "snapchat" | "tiktok" | "appreciate" | "chartboost" | "pangle" | "mytarget" | "liftoff" | "smadex" | "adikteev" | "bigabid" | "inmobi" | "bigoads";
@@ -260,6 +221,36 @@ declare class sdk {
      * 判断是否是 Google
      */
     static isGoogle(): boolean;
+    /**
+     * 设置主题配置，支持传入多份 JSON5 配置。
+     * 每一份配置都可以是 JSON Schema（带 $schema 字段），会自动提取其中的 default 值。
+     * 所有配置按顺序依次深度合并，后面的优先级更高。
+     *
+     * @param configList - 配置数组，每一项可以是：
+     *   - JSON Schema（带 $schema 字段）：自动提取 default 值后参与合并
+     *   - 普通配置对象：直接参与合并
+     * @param config - 额外配置项
+     *   - config.assetRecordByPath: 相对路径到已解析 URL 的映射
+     *
+     * @example
+     * sdk.setConfig(
+     *   [schemaA, schemaB, themeData],
+     *   { assetRecordByPath: imageAssets }
+     * );
+     */
+    static setConfig(configList: any[], config: any): void;
+    /**
+     * 获取合并后的主题配置。
+     * 返回 schema 默认值与用户主题数据深度合并后的结果。
+     * 必须先调用 sdk.setConfig() 才能使用此方法。
+     *
+     * @returns 合并后的主题配置对象
+     *
+     * @example
+     * const config = sdk.getConfig();
+     * console.log(config.primaryColor); // '#ff0000'
+     */
+    static getConfig(): Record<string, any>;
 }
 
 /**
@@ -279,138 +270,4 @@ declare function hideWechatGuide(): void;
  */
 declare function removeWechatGuide(): void;
 
-/**
- * 设置交互总数
- */
-declare function setTotalInteractions(total: number): void;
-/**
- * 检查交互进度，触发对应里程碑
- */
-declare function checkInteractionProgress(currentInteractions: number): void;
-/**
- * init 事件：SDK 初始化开始
- * 渠道埋点: Bigabid:mraid_viewable | InMobi:Ad_Load_Start | AppLovin:LOADING
- * 同时初始化进度里程碑
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onInit(adNetwork?: string): void;
-/**
- * start 事件：游戏资源加载完成
- * 渠道埋点: Bigabid:game_viewable | InMobi:Ad_Viewable | AppLovin:LOADED
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onStart(adNetwork?: string): void;
-/**
- * interactive 事件：主场景就绪，用户可交互
- * 渠道埋点: AppLovin:DISPLAYED
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onInteractive(adNetwork?: string): void;
-/**
- * interaction 事件：首次交互
- * 渠道埋点: Bigabid:engagement | InMobi:First_Engagement | AppLovin:CHALLENGE_STARTED
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onInteraction(adNetwork?: string): void;
-/**
- * success 事件：成功计数（用于进度百分比追踪）
- */
-declare function _onSuccess(successCount: number): void;
-/**
- * finish 事件：游戏结束
- * 渠道埋点: Bigabid:complete | InMobi:Gameplay_Complete | AppLovin:ENDCARD_SHOWN
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onFinish(adNetwork?: string): void;
-/**
- * install 事件：点击安装
- * 渠道埋点: Bigabid:click | InMobi:DSP_Click | AppLovin:CTA_CLICKED
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onInstall(adNetwork?: string): void;
-/**
- * retry 事件：重试游戏
- * 渠道埋点: AppLovin:CHALLENGE_RETRY
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _onRetry(adNetwork?: string): void;
-/**
- * 触发游戏成功事件
- * 不同渠道发送对应的成功埋点
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _trackChallengeSuccess(adNetwork?: string): void;
-/**
- * 触发游戏失败事件
- * 不同渠道发送对应的失败埋点
- * @param adNetwork - 可选的广告渠道名称，不传则使用全局 AD_NETWORK
- */
-declare function _trackChallengeFailed(adNetwork?: string): void;
-/**
- * 统一的埋点追踪对象
- * 包含所有 SDK 事件的埋点方法
- */
-declare const tracking: {
-    /**
-     * SDK 初始化开始
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onInit: typeof _onInit;
-    /**
-     * 游戏资源加载完成
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onStart: typeof _onStart;
-    /**
-     * 主场景就绪，用户可交互
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onInteractive: typeof _onInteractive;
-    /**
-     * 首次交互
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onInteraction: typeof _onInteraction;
-    /**
-     * 成功计数（用于进度百分比追踪）
-     * @param successCount - 当前成功次数
-     */
-    onSuccess: typeof _onSuccess;
-    /**
-     * 游戏结束
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onFinish: typeof _onFinish;
-    /**
-     * 点击安装
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onInstall: typeof _onInstall;
-    /**
-     * 重试游戏
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    onRetry: typeof _onRetry;
-    /**
-     * 设置交互总数（用于进度百分比计算）
-     * @param total - 交互总数
-     */
-    setTotalInteractions: typeof setTotalInteractions;
-    /**
-     * 检查交互进度
-     * @param currentInteractions - 当前交互次数
-     */
-    checkInteractionProgress: typeof checkInteractionProgress;
-    /**
-     * 触发游戏成功事件
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    trackChallengeSuccess: typeof _trackChallengeSuccess;
-    /**
-     * 触发游戏失败事件
-     * @param adNetwork - 可选的广告渠道名称
-     */
-    trackChallengeFailed: typeof _trackChallengeFailed;
-};
-
-export { sdk as default, hideWechatGuide, removeWechatGuide, sdk, showWechatGuide, tracking };
+export { sdk as default, hideWechatGuide, removeWechatGuide, sdk, showWechatGuide };