@singcl/ad-execute-manager 2.0.13 → 2.1.1

package/dist/ad-reward/src/RewardAdFather.d.ts

@@ -113,7 +113,11 @@ declare class RewardAdFather {
         options?: import("./typings/ad.js").IAdOptions;
         collection?: CallbackCollection;
     }): Promise<ITaskResultGeneric<T> | undefined>;
-    destroy(): void;
+    /**
+     * 销毁广告实例
+     * @param {boolean} preserved 是否保留广告实例
+     */
+    destroy(preserved?: boolean): void;
     /**
      * 清理广告实例
      * @abstract 清理广告实例，子类必须实现此方法

package/dist/ad-reward/src/RewardAdNovel.d.ts

@@ -50,11 +50,36 @@ declare class RewardAdNovel extends RewardAdFather {
      * @returns  {RewardAdNovel}
      */
     static "new"(args: IConstructArgs): RewardAdNovel;
-    _onHalfway: any;
-    _onShow: any;
-    _onFinish: any;
-    _onAlways: any;
-    _onError: any;
+    /**
+     * @private 内部方法请勿使用，如需要请使用.onHalfway()替代
+     * @description 广告中途退出回调
+     * 初始化广告实例.new()中传入的参数args.collection.onHalfway回调
+     */
+    private _onHalfway;
+    /**
+     * @private 内部方法请勿使用，如需要请使用.onShow()替代
+     * @description 广告展示回调
+     * 初始化广告实例.new()中传入的参数args.collection.onShow回调
+     */
+    private _onShow;
+    /**
+     * @private 内部方法请勿使用，如需要请使用.onFinish()替代
+     * @description 广告执行成功回调
+     * 初始化广告实例.new()中传入的参数args.collection.onFinish回调
+     */
+    private _onFinish;
+    /**
+     * @private 内部方法请勿使用，如需要请使用.onAlways()替代
+     * @description 广告执行成功回调
+     * 初始化广告实例.new()中传入的参数args.collection.onAlways回调
+     */
+    private _onAlways;
+    /**
+     * @private 内部方法请勿使用，如需要请使用.onError()替代
+     * @description 广告执行失败回调
+     * 初始化广告实例.new()中传入的参数args.collection.onError回调
+     */
+    private _onError;
     _alwaysCallback: any;
     _halfwayCallback: any;
     _finishedCallback: any;
@@ -72,12 +97,38 @@ declare class RewardAdNovel extends RewardAdFather {
     _lookUpRemainOnError: boolean;
     /** @deprecated TODO 移除 */
     _needSpeedEndOnTimeout: boolean;
-    bindAdCloseLister: any;
-    bindAdErrorLister: any;
-    bindAdLoadLister: any;
-    bindApiAdErrorLister: any;
-    _bindShiftCloseLister: any;
-    _bindShiftErrorLister: any;
+    /**
+     * @private
+     */
+    private bindAdCloseLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private bindAdErrorLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private bindAdLoadLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private bindApiAdErrorLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private _bindShiftCloseLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private _bindShiftErrorLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private bindAdTimeoutCloseLister;
+    /**
+     * @private 内部方法请勿使用
+     */
+    private bindAdTimeoutErrorLister;
     /**
      * 初始化
      * 子类可以选择覆盖此方法，或使用默认实现
@@ -114,11 +165,13 @@ declare class RewardAdNovel extends RewardAdFather {
      * @param {string} args.scene 广告执行场景 必填
      * @param {number} [args.timeout] 广告超时时间 单位ms
      * @param {Function} args.end 结束当前广告任务的回调函数 必填
+     * @param {boolean} [args.preserved] 是否在超时情况下保留广告实例 - 自用参数，非tt API要求的参数
      */
     _setAdTimeout(args: {
         scene: string;
         timeout?: number;
         end: Function;
+        preserved?: boolean;
     }): void;
     /**
      * 子类可以选择覆盖此方法
@@ -259,6 +312,7 @@ declare class RewardAdNovel extends RewardAdFather {
         recovered?: import("./typings/ad.js").RecoveredInfo;
     }, next?: Function): Promise<object | undefined>;
     _recovered: import("./typings/ad.js").RecoveredInfo;
+    _preservedOnTimeout: boolean;
     /**
      * @param {object} [ctx] 广告执行上下文
      * @param {object} [ctx.options] 广告执行选项
@@ -293,9 +347,88 @@ declare class RewardAdNovel extends RewardAdFather {
      * @returns
      */
     adShow(): Promise<void>;
-    _outerCloseCallback(args: any): void;
-    _outerHalfwayCallback(args: any): void;
-    _outerFinishedCallback(args: any): void;
+    /**
+     * @deprecated - 已废弃，使用onExeAlways代替
+     * - 关闭广告时候调用的回调,不管是否看完视频都会调用
+     * - 调用adExecuteManager时collection.always回调
+     * @param {Array.<unknown>} args
+     */
+    _outerCloseCallback(...args: Array<unknown>): any;
+    /**
+     * - 关闭广告时候调用的回调 不管是否看完视频都会调用
+     * - 调用adExecuteManager时collection.always回调
+     * @param {Array.<unknown>} args
+     */
+    onExeAlways(...args: Array<unknown>): any;
+    /**
+     * @deprecated 已废弃，使用onExeHalfway代替
+     * - 广告未看完时候调用的回调
+     * - 调用adExecuteManager时collection.halfway回调
+     * @param {Array.<unknown>} args
+     */
+    _outerHalfwayCallback(...args: Array<unknown>): any;
+    /**
+     * - 广告未看完时候调用的回调
+     * - 调用adExecuteManager时collection.halfway回调
+     * @param {Array.<unknown>} args
+     */
+    onExeHalfway(...args: Array<unknown>): any;
+    /**
+     * @deprecated 已废弃，使用onExeFinished代替
+     * - 广告看完时候调用的回调
+     * - 调用adExecuteManager时collection.finished回调
+     * @param {Array.<unknown>} args
+     */
+    _outerFinishedCallback(...args: Array<unknown>): any;
+    /**
+     * - 广告看完时候调用的回调
+     * - 调用adExecuteManager时collection.finished回调
+     * @param {Array.<unknown>} args
+     */
+    onExeFinished(...args: Array<unknown>): any;
+    /**
+     * @description 广告中途退出回调
+     * 初始化广告实例.new()中传入的参数args.collection.onHalfway回调
+     *  @param {Array.<unknown>} args
+     */
+    onFinish(...args: Array<unknown>): any;
+    /**
+     *
+     * @description 广告展示回调
+     * 初始化广告实例.new()中传入的参数args.collection.onShow回调
+     *  @param {Array.<unknown>} args
+     */
+    onHalfway(...args: Array<unknown>): any;
+    /**
+     * @description 广告展示回调
+     * 初始化广告实例.new()中传入的参数args.collection.onAlways回调
+     *  @param {Array.<unknown>} args
+     */
+    onAlways(...args: Array<unknown>): any;
+    /**
+     * 内部关闭激励视频
+     * @private
+     * @param {ICloseArgs} args
+     */
+    private __adTimeoutCloseLister__;
+    /**
+     * 子类可以选择覆盖此方法
+     * @param {*} args
+     * @returns
+     */
+    adTimeoutCloseLister(args: any): any;
+    /**
+     * 内部关闭激励视频
+     * @private
+     * @param {*} e
+     */
+    private __adTimeoutErrorLister__;
+    /**
+     * 子类可以选择覆盖此方法
+     * @param {*} e
+     * @returns
+     */
+    adTimeoutErrorLister(e: any): any;
     /**
      * 内部关闭激励视频
      * @private
@@ -361,7 +494,12 @@ declare class RewardAdNovel extends RewardAdFather {
      * @param {unknown} e
      */
     protected adLoadLister(e: unknown): unknown;
-    adDestroy(): void;
+    /**
+     * 销毁广告实例
+     * @protected
+     * @param {boolean} preserved 是否保留广告实例
+     */
+    protected adDestroy(preserved?: boolean): void;
     _shiftCloseLister(args: any): void;
     _shiftErrorLister(args: any): void;
     /**

package/dist/ad-reward/src/typings/ad.d.ts

@@ -122,6 +122,10 @@ export type IAdOptionsOther = {
      * 重试次数 - 自用参数 ，非tt API要求的参数
      */
     retry: number;
+    /**
+     * 是否在超时情况下保留广告实例 - 自用参数，非tt API要求的参数
+     */
+    preservedOnTimeout: boolean;
 };
 export type IAdOptions = IRewordAdConfig & IRewordAdOther & IAdOptionsOther;
 export type RecoveredInfo = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singcl/ad-execute-manager",
-  "version": "2.0.13",
+  "version": "2.1.1",
   "description": "A powerful and flexible ad execution management library for handling reward-based ads, interstitial ads, and other advertising formats in JavaScript applications.",
   "type": "module",
   "exports": {
@@ -86,7 +86,7 @@
   "dependencies": {
     "@ad-execute-manager/core": "^2.0.6",
     "@ad-execute-manager/logger": "^2.0.5",
-    "@ad-execute-manager/ad-reward": "^2.0.6",
+    "@ad-execute-manager/ad-reward": "^2.1.1",
     "@ad-execute-manager/ad-interstitial": "^2.0.6",
     "@ad-execute-manager/count-recorder": "^2.0.5",
     "@ad-execute-manager/serializable-error": "^2.0.5",