@ad-execute-manager/ad-reward 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 singcl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,460 @@
+# @ad-execute-manager/ad-reward
+
+Reward ad-related classes including RewardAdFather and RewardAdNovel for ad management.
+
+## Installation
+
+```bash
+npm install @ad-execute-manager/ad-reward
+```
+
+## Features
+
+- **RewardAdFather**: Base class for reward ads with common functionality
+- **RewardAdNovel**: Novel-specific reward ad implementation with enhanced features
+- **AdExecuteManager**: Core ad execution management from @ad-execute-manager/core
+- **TypeScript Support**: Includes TypeScript type definitions
+- **Event Callbacks**: Comprehensive event callback system for ad lifecycle events
+- **Error Handling**: Built-in error handling and retry mechanisms
+- **Scene Support**: Scene-based ad configuration for different contexts
+- **Reward Verification**: Support for reward verification and validation
+
+## Usage
+
+### RewardAdNovel
+
+```javascript
+import { RewardAdNovel } from '@ad-execute-manager/ad-reward';
+
+const rewardAd = RewardAdNovel.new({
+  sign: 'novel_reward',
+  preserveOnEnd: false,
+  needEndOnTimeout: true,
+  collection: {
+    onHalfway: (args) => {
+      console.log('Ad halfway:', args);
+    },
+    onShow: (args) => {
+      console.log('Ad shown:', args);
+    },
+    onFinish: (args) => {
+      console.log('Ad finished:', args);
+    },
+    onAlways: (args) => {
+      console.log('Ad always:', args);
+    },
+    onError: (error) => {
+      console.error('Ad error:', error);
+    }
+  }
+});
+
+// Initialize ad
+rewardAd.initialize({
+  adUnitId: 'your-ad-unit-id',
+  retry: 3
+});
+
+// Show ad
+const result = await rewardAd.addExecuteManager({
+  options: {
+    scene: 2,
+    timeout: 10000
+  }
+});
+
+console.log('Ad result:', result);
+```
+
+### Basic Reward Ad Usage
+
+```javascript
+import { RewardAdNovel } from '@ad-execute-manager/ad-reward';
+
+// Create reward ad instance
+const rewardAd = RewardAdNovel.new({
+  sign: 'premium_content_reward',
+  preserveOnEnd: true,
+  needEndOnTimeout: true,
+  collection: {
+    onFinish: (args) => {
+      console.log('Reward ad finished, unlocking premium content');
+      // Unlock premium content logic here
+      unlockPremiumContent();
+    },
+    onError: (error) => {
+      console.error('Reward ad error:', error);
+      // Show error message to user
+      showErrorMessage('Failed to load ad. Please try again later.');
+    }
+  }
+});
+
+// Initialize ad
+rewardAd.initialize({ adUnitId: 'your-ad-unit-id', retry: 3 });
+
+// Function to unlock premium content
+function unlockPremiumContent() {
+  // Logic to unlock premium content
+  console.log('Premium content unlocked!');
+}
+
+// Function to show error message
+function showErrorMessage(message) {
+  // Logic to show error message
+  console.log('Error:', message);
+}
+
+// Show reward ad to unlock premium content
+async function showRewardAdForPremium() {
+  try {
+    const result = await rewardAd.addExecuteManager({ 
+      options: { 
+        scene: 2, 
+        timeout: 15000 
+      } 
+    });
+    console.log('Reward ad result:', result);
+  } catch (error) {
+    console.error('Reward ad execution error:', error);
+  }
+}
+
+// Usage
+// showRewardAdForPremium();
+```
+
+### Ad Instance Management
+
+```javascript
+import { RewardAdNovel } from '@ad-execute-manager/ad-reward';
+
+// Create ad instance
+const rewardAd = RewardAdNovel.new({ sign: 'reward' });
+
+// Initialize ad
+rewardAd.initialize({ adUnitId: 'your-ad-unit-id', retry: 3 });
+
+// Function to show ad based on user action
+async function showAdBasedOnAction(action) {
+  try {
+    switch (action) {
+      case 'unlock_premium':
+        return await rewardAd.addExecuteManager({ 
+          options: { 
+            scene: 2, 
+            timeout: 15000 
+          } 
+        });
+      case 'get_coins':
+        return await rewardAd.addExecuteManager({ 
+          options: { 
+            scene: 3, 
+            timeout: 10000 
+          } 
+        });
+      case 'continue_game':
+        return await rewardAd.addExecuteManager({ 
+          options: { 
+            scene: 4, 
+            timeout: 8000 
+          } 
+        });
+      default:
+        throw new Error('Invalid ad action');
+    }
+  } catch (error) {
+    console.error('Ad error:', error);
+    return { success: false, error: error.message };
+  }
+}
+
+// Usage examples
+// showAdBasedOnAction('unlock_premium');
+// showAdBasedOnAction('get_coins');
+// showAdBasedOnAction('continue_game');
+```
+
+## API
+
+### RewardAdFather
+
+Base class for reward ads with common functionality.
+
+### RewardAdNovel
+
+```typescript
+class RewardAdNovel extends RewardAdFather {
+  /**
+   * Builds and returns an instance of RewardAdNovel
+   * @param args Construction arguments
+   * @returns Instance of RewardAdNovel
+   */
+  static build(args: IConstructArgs): RewardAdNovel;
+  
+  /**
+   * Gets the singleton instance of RewardAdNovel
+   * @returns Singleton instance of RewardAdNovel
+   */
+  static getInstance(): RewardAdNovel;
+  
+  /**
+   * Creates a new instance of RewardAdNovel
+   * @param args Construction arguments
+   * @returns New instance of RewardAdNovel
+   */
+  static new(args: IConstructArgs): RewardAdNovel;
+  
+  /**
+   * Initializes the ad with configuration
+   * @param params Ad configuration parameters
+   * @param callback Optional callback function
+   * @returns Current instance for method chaining
+   */
+  initialize(params: IRewordAdConfig, callback?: (v: IRewardedVideoAd) => void): this;
+  
+  /**
+   * Adds execute manager and runs the ad
+   * @param ctx Context object with options
+   * @returns Promise with ad execution result
+   */
+  addExecuteManager(ctx: any): Promise<any>;
+  
+  /**
+   * Clears the ad instance
+   */
+  clear(): void;
+  
+  /**
+   * Shifts the ad instance
+   */
+  shift(): void;
+}
+```
+
+## Configuration
+
+### Construction Arguments
+
+When creating an ad instance, you can pass the following configuration options:
+
+- **sign**: Unique identifier for the ad instance
+- **preserveOnEnd**: Whether to preserve the instance after ad ends
+- **needEndOnTimeout**: Whether to end the ad on timeout
+- **collection**: Event collection object with callback functions
+  - **onHalfway**: Called when ad reaches halfway point
+  - **onShow**: Called when ad is shown
+  - **onFinish**: Called when ad finishes
+  - **onAlways**: Called always after ad operation
+  - **onError**: Called when ad encounters error
+
+### Initialize Parameters
+
+When initializing an ad, you can pass the following parameters:
+
+- **adUnitId**: Unique identifier for the ad unit
+- **retry**: Number of retry attempts on ad error
+
+## Examples
+
+### Example 1: Premium Content Unlock
+
+```javascript
+import { RewardAdNovel } from '@ad-execute-manager/ad-reward';
+
+// Create reward ad instance for premium content
+const premiumContentAd = RewardAdNovel.new({
+  sign: 'premium_content_reward',
+  preserveOnEnd: true,
+  needEndOnTimeout: true,
+  collection: {
+    onShow: () => {
+      console.log('Premium content reward ad shown');
+      // Track reward ad show event
+    },
+    onFinish: (args) => {
+      console.log('Premium content reward ad finished');
+      // Unlock premium content
+      unlockPremiumContent();
+    },
+    onError: (error) => {
+      console.error('Premium content reward ad error:', error);
+      // Show error message to user
+      showError('Failed to load reward ad. Please try again later.');
+    }
+  }
+});
+
+// Initialize ad
+premiumContentAd.initialize({ 
+  adUnitId: 'your-ad-unit-id', 
+  retry: 3 
+});
+
+// Function to unlock premium content
+function unlockPremiumContent() {
+  console.log('Unlocking premium content...');
+  // Premium content unlock logic here
+  // For example: unlock chapters, remove ads, give bonus content
+}
+
+// Function to show error message
+function showError(message) {
+  console.error('Error:', message);
+  // Error message display logic here
+}
+
+// Show reward ad to unlock premium content
+async function unlockPremiumWithAd() {
+  console.log('Showing reward ad to unlock premium content...');
+  try {
+    await premiumContentAd.addExecuteManager({ 
+      options: { 
+        scene: 2, // Premium content unlock scene
+        timeout: 15000 
+      } 
+    });
+  } catch (error) {
+    console.error('Error showing premium content reward ad:', error);
+    showError('Failed to load reward ad. Please try again later.');
+  }
+}
+```
+
+### Example 2: In-Game Currency Reward
+
+```javascript
+import { RewardAdNovel } from '@ad-execute-manager/ad-reward';
+
+// Create reward ad instance for in-game currency
+const currencyAd = RewardAdNovel.new({
+  sign: 'game_currency_reward',
+  preserveOnEnd: true,
+  needEndOnTimeout: true,
+  collection: {
+    onShow: () => {
+      console.log('In-game currency reward ad shown');
+      // Track currency reward ad show event
+    },
+    onFinish: (args) => {
+      console.log('In-game currency reward ad finished');
+      // Give player in-game currency
+      giveCurrency(100); // Give 100 coins
+    },
+    onError: (error) => {
+      console.error('In-game currency reward ad error:', error);
+      // Show error message to player
+      showGameError('Failed to load reward ad. Please try again later.');
+    }
+  }
+});
+
+// Initialize ad
+currencyAd.initialize({ 
+  adUnitId: 'your-ad-unit-id', 
+  retry: 2 
+});
+
+// Function to give in-game currency
+function giveCurrency(amount) {
+  console.log(`Giving ${amount} coins to player...`);
+  // In-game currency award logic here
+  // For example: update player balance, show reward animation
+}
+
+// Function to show game error message
+function showGameError(message) {
+  console.error('Game error:', message);
+  // Game error message display logic here
+}
+
+// Show reward ad to get in-game currency
+async function getCurrencyWithAd() {
+  console.log('Showing reward ad to get in-game currency...');
+  try {
+    await currencyAd.addExecuteManager({ 
+      options: { 
+        scene: 3, // In-game currency reward scene
+        timeout: 10000 
+      } 
+    });
+  } catch (error) {
+    console.error('Error showing currency reward ad:', error);
+    showGameError('Failed to load reward ad. Please try again later.');
+  }
+}
+```
+
+### Example 3: Continue Game After Defeat
+
+```javascript
+import { RewardAdNovel } from '@ad-execute-manager/ad-reward';
+
+// Create reward ad instance for continue game
+const continueGameAd = RewardAdNovel.new({
+  sign: 'continue_game_reward',
+  preserveOnEnd: false,
+  needEndOnTimeout: true,
+  collection: {
+    onShow: () => {
+      console.log('Continue game reward ad shown');
+      // Track continue game reward ad show event
+    },
+    onFinish: (args) => {
+      console.log('Continue game reward ad finished');
+      // Continue game from where player left off
+      continueGame();
+    },
+    onError: (error) => {
+      console.error('Continue game reward ad error:', error);
+      // Show error message and go to game over
+      showGameOver();
+    }
+  }
+});
+
+// Initialize ad
+continueGameAd.initialize({ 
+  adUnitId: 'your-ad-unit-id', 
+  retry: 1 
+});
+
+// Function to continue game
+function continueGame() {
+  console.log('Continuing game...');
+  // Game continuation logic here
+  // For example: restore player position, health, game state
+}
+
+// Function to show game over
+function showGameOver() {
+  console.log('Showing game over screen...');
+  // Game over screen logic here
+}
+
+// Show reward ad to continue game
+async function continueGameWithAd() {
+  console.log('Showing reward ad to continue game...');
+  try {
+    await continueGameAd.addExecuteManager({ 
+      options: { 
+        scene: 4, // Continue game scene
+        timeout: 8000 
+      } 
+    });
+  } catch (error) {
+    console.error('Error showing continue game reward ad:', error);
+    showGameOver();
+  }
+}
+```
+
+## Dependencies
+
+- **@ad-execute-manager/core**: Core ad execution management
+- **@ad-execute-manager/logger**: Logging utility
+- **@ad-execute-manager/serializable-error**: Serializable error implementation
+
+## License
+
+MIT

package/dist/RewardAdFather.d.ts

@@ -0,0 +1,181 @@
+export default RewardAdFather;
+export type IRewordAdConfig = import("./typings/ad.js").IRewordAdConfig;
+export type CallbackCollection = import("./typings/ad.js").CallbackCollection;
+export type RecoveredInfo = import("./typings/ad.js").RecoveredInfo;
+export type IConstructArgs = import("./typings/ad.js").IConstructArgs;
+export type RewardedVideoAd = import("./typings/create-rewarded-video-ad.js").RewardedVideoAd;
+export type IRewardedVideoAd = {
+    /**
+     * 显示激励视频广告
+     */
+    show: () => Promise<void>;
+};
+/**
+ * @typedef IRewardedVideoAd
+ * @property {() => Promise.<void>} show 显示激励视频广告
+ */
+declare class RewardAdFather {
+    /** @type {IRewordAdConfig | null} */
+    static args: IRewordAdConfig | null;
+    /**
+     * @param {IRewordAdConfig} args
+     */
+    static buildArgs(args: IRewordAdConfig): void;
+    /**
+     * 使用管理器执行广告
+     * @param {Object} adInstance 广告实例
+     * @param {Object} ctx 上下文对象，用于传递数据和状态
+     * @param {Object} ctx.options 广告执行选项
+     * @param {Object} ctx.collection 回调集合
+     * @returns {Promise} 广告执行结果的Promise
+     */
+    static executeWithManager(adInstance: any, ctx: {
+        options: any;
+        collection: any;
+    }): Promise<any>;
+    /**
+     * @param {IConstructArgs} args
+     */
+    constructor(args: IConstructArgs);
+    /** @private  */
+    /** @type {Logger} */
+    _logger: Logger;
+    _adTimeoutTime: number;
+    _initSign: string;
+    _preserveOnEnd: boolean;
+    /**
+     * 激励视频实例
+     * @type {RewardedVideoAd | null}
+     */
+    _rewardAd: RewardedVideoAd | null;
+    /**
+     * 激励视频实例
+     * @type {RewardedVideoAd | null}
+     */
+    __ad__: RewardedVideoAd | null;
+    _ttErrorMsgs: string[];
+    _ttErrorCodes: number[];
+    __bindAdErrorForeverHandler: any;
+    _adConfig: {};
+    /**
+     * 初始化
+     * 子类可以选择覆盖此方法，或使用默认实现
+     * @param {IRewordAdConfig} params
+     * @param {(v: IRewardedVideoAd) => void} [callback] 初始化成功回调
+     * @returns {this} 当前实例
+     */
+    initialize(params: IRewordAdConfig, callback?: (v: IRewardedVideoAd) => void): this;
+    initialized(): boolean;
+    /**
+     * 激励视频展示失败时始终执行的一个方法
+     * @private
+     * @param {{errMsg: string; errCode: number}} e 错误信息
+     */
+    private __adErrorForeverHandler;
+    /**
+     * 激励视频展示失败时始终执行的一个方法
+     * @abstract 激励视频展示失败时始终执行的一个方法，子类需要用到时实现此方法
+     * @param {{errMsg: string; errCode: number}} _e 错误信息
+     * @returns
+     */
+    adErrorForeverHandler(_e: {
+        errMsg: string;
+        errCode: number;
+    }): any;
+    /**
+     * 执行广告展示
+     * @abstract
+     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {CallbackCollection} [ctx.collection] 回调集合
+     * @param {RecoveredInfo} [ctx.recovered] 恢复重试信息
+     * @param {Function} next 执行下一个任务的回调函数，在洋葱模型中手动调用以继续执行流程
+     * @returns {Promise<unknown>} 广告执行结果的Promise
+     * @throws {Error} 子类必须实现此方法
+     */
+    ad(ctx?: {
+        options?: IRewordAdConfig;
+        collection?: CallbackCollection;
+        recovered?: RecoveredInfo;
+    }, next?: Function): Promise<unknown>;
+    /**
+     * 确保广告按顺序执行
+     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {CallbackCollection} [ctx.collection] 回调集合
+     * @returns {Promise.<unknown>} 广告执行结果的Promise
+     */
+    addExecuteManager(ctx?: {
+        options?: IRewordAdConfig;
+        collection?: CallbackCollection;
+    }): Promise<unknown>;
+    destroy(): void;
+    /**
+     * 清理广告实例
+     * @abstract 清理广告实例，子类必须实现此方法
+     */
+    clear(): void;
+    /**
+     * 任务执行完成后始终执行的一个方法
+     * @abstract 任务执行完成后始终执行的一个方法，子类需要用到时实现此方法
+     * @param {object} [_args] 执行结果信息
+     * @param {number} [_args.scene] 场景信息
+     * @param {string} _args.id 任务id
+     * @param {object} [_args.apiError] 广告api错误信息
+     * @param {number} [_args.adTypeR] 广告类型 1 激励视频 2插屏广告
+     * @param {object} _args.recovered 后台恢复重试
+     * @param {boolean} [_args.recovered.retry] 后台恢复预估是否重试
+     * @param {number} [_args.recovered.count] 后台恢复预估重试次数
+     * @param {string} [_args.recovered.message] 后台恢复预估重试原因
+     */
+    record(_args?: {
+        scene?: number;
+        id: string;
+        apiError?: object;
+        adTypeR?: number;
+        recovered: {
+            retry?: boolean;
+            count?: number;
+            message?: string;
+        };
+    }): this;
+    /**
+     *
+     * @param {({isEnded: boolean, count: number}) => void} callback
+     */
+    onClose(callback: ({ isEnded: boolean, count: number }: any) => void): void;
+    /**
+     *
+     * @param {({isEnded: boolean, count: number}) => void} callback
+     */
+    offClose(callback: ({ isEnded: boolean, count: number }: any) => void): void;
+    /**
+     * show
+     * @returns { Promise.<void>}
+     * @params {{errMsg: string; errCode: number}} err
+     */
+    show(): Promise<void>;
+    /**
+     * load
+     * @returns { Promise.<void>}
+     */
+    load(): Promise<void>;
+    /**
+     *
+     * @param {({errMsg: string; errCode: number}) => void} callback
+     */
+    onError(callback: any): void;
+    /**
+     *
+     * @param {({errMsg: string; errCode: number}) => void} callback
+     */
+    offError(callback: any): void;
+    onLoad(callback: any): void;
+    offLoad(callback: any): void;
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}
+import { Logger } from '@ad-execute-manager/logger';