@singcl/ad-execute-manager 2.2.0 → 2.3.1

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

@@ -115,9 +115,11 @@ declare class RewardAdFather {
     }): Promise<ITaskResultGeneric<T> | undefined>;
     /**
      * 销毁广告实例
+     * 只要调用销毁，无论销毁成功或者失败，销毁时会自动移除广告对象上监听的所有 loaded，error，close 事件。
      * @param {boolean} preserved 是否保留广告实例
+     * @returns { Promise.<void>}
      */
-    destroy(preserved?: boolean): void;
+    destroy(preserved?: boolean): Promise<void>;
     /**
      * 清理广告实例
      * @abstract 清理广告实例，子类必须实现此方法

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

@@ -95,6 +95,8 @@ declare class RewardAdNovel extends RewardAdFather {
     _adNext: Function;
     /** @type {number} 广告执行场景 */
     _scene: number;
+    /** @type {string} 当前广告执行的唯一ID */
+    _eId: string;
     _adTypeR: 1;
     _adTimeout: any;
     _adBeforeShowTimer: any;
@@ -154,20 +156,53 @@ declare class RewardAdNovel extends RewardAdFather {
         retry?: number;
     }): void;
     novelConfig: RewardAdNovelConfig;
-    _onInnerExecuteBefore(): any;
-    _onAdExecuteBefore(): any;
+    _onInnerExecuteBefore(_args: any): any;
+    _onAdExecuteBefore(_args: any): any;
     /**
      * @param {object} _args
      * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
      * @param {number} [_args.result] 广告执行成功结果 必填
      * @param {import('./typings/ad.js').RecoveredInfo} [_args.recovered] 恢复重试信息
      * @returns
      */
     _onInnerAdShowSuccess(_args: {
         scene: string;
+        eId: string;
         result?: number;
         recovered?: import("./typings/ad.js").RecoveredInfo;
     }): any;
+    /**
+     * 子类可以选择覆盖此方法，或使用默认实现
+     * 视频展示中时 android会销毁成功，iOS会销毁失败
+     * @param {object} _args
+     * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
+     * @param {string} [_args.errMsg] 广告销毁失败原因
+     * @param {number} [_args.errorCode] 广告销毁失败错误码
+     * @returns
+     */
+    _onInnerAdDestroySuccess(_args: {
+        scene: string;
+        eId: string;
+        errMsg?: string;
+        errorCode?: number;
+    }): any;
+    /**
+     * 子类可以选择覆盖此方法，或使用默认实现
+     * @param {object} _args
+     * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
+     * @param {string} [_args.errMsg] 广告销毁失败原因
+     * @param {number} [_args.errorCode] 广告销毁失败错误码
+     * @returns
+     */
+    _onInnerAdDestroyFailed(_args: {
+        scene: string;
+        eId: string;
+        errMsg?: string;
+        errorCode?: number;
+    }): any;
     /**
      * @private
      * 广告展示超时设置
@@ -178,28 +213,48 @@ declare class RewardAdNovel extends RewardAdFather {
      * @param {boolean} [args.preserved] 是否在超时情况下保留广告实例 - 自用参数，非tt API要求的参数
      */
     private _setAdTimeout;
+    /**
+     * @protected
+     * 广告展示超时设置
+     * @param {object} _args
+     * @param {string} _args.scene 广告执行场景 必填
+     * @param {number} [_args.timeout] 广告超时时间 单位ms
+     * @param {string} _args.eId 广告执行唯一ID 必填
+     * @param {Function} _args.end 结束当前广告任务的回调函数 必填
+     */
+    protected customExecuteAfterTimeout(_args: {
+        scene: string;
+        timeout?: number;
+        eId: string;
+        end: Function;
+    }): void;
     /**
      * 子类可以选择覆盖此方法
      * 添加超时情况下结束任务前的回调
      * @param {object} args
      * @param {string} args.scene 广告执行场景 必填
      * @param {number} args.timeout 广告超时时间 单位ms 必填
+     * @param {string} args.eId 广告执行唯一ID 必填
      */
     _adTimeoutBeforeEnd(args: {
         scene: string;
         timeout: number;
+        eId: string;
     }): {
         scene: string;
         timeout: number;
+        eId: string;
     };
     /**
      * 广告展示前定时器
      * @param {object} args
      * @param {string} args.scene 广告执行场景 必填
+     * @param {string} args.eId 广告执行唯一ID 必填
      * @param {Function} args.prelude 广告展示前回调函数 可选
      */
     _adPreludeInterval(args: {
         scene: string;
+        eId: string;
         prelude: Function;
     }): void;
     _clearAdTimeout(): void;
@@ -209,10 +264,12 @@ declare class RewardAdNovel extends RewardAdFather {
      * @protected
      * @param {object} _args
      * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
      * @returns
      */
     protected _adShowBeforeAnalytics(_args: {
         scene: string;
+        eId: string;
     }): any;
     /**
      * 广告展示成功分析
@@ -220,6 +277,7 @@ declare class RewardAdNovel extends RewardAdFather {
      * @protected
      * @param {object} _args
      * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
      * @param {string} [_args.msg] 广告执行成功原因
      * @param {0|1} _args.result 广告执行成功结果 必填
      * @param {import('./typings/ad.js').RecoveredInfo} [_args.recovered] 恢复重试信息
@@ -227,6 +285,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     protected _adShowSuccessAnalytics(_args: {
         scene: string;
+        eId: string;
         msg?: string;
         result: 0 | 1;
         recovered?: import("./typings/ad.js").RecoveredInfo;
@@ -238,6 +297,7 @@ declare class RewardAdNovel extends RewardAdFather {
      * @protected
      * @param {object} _args
      * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
      * @param {string} _args.msg 广告执行失败原因 必填
      * @param {number} _args.errorCode 广告执行失败错误码 必填
      * @param {0|1} _args.result 广告执行失败结果
@@ -245,6 +305,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     protected _adShowFailureAnalytics(_args: {
         scene: string;
+        eId: string;
         msg: string;
         errorCode: number;
         result: 0 | 1;
@@ -292,12 +353,14 @@ declare class RewardAdNovel extends RewardAdFather {
      * @protected
      * @param {object} _args
      * @param {string} _args.scene 广告执行场景 必填
+     * @param {string} _args.eId 广告执行唯一ID 必填
      * @param {number} _args.ad_is_completed 广告是否完成 必填
      * @param {number} _args.ad_count 广告执行次数 必填
      * @returns
      */
     protected _adCloseSuccessAnalytics(_args: {
         scene: string;
+        eId: string;
         ad_is_completed: number;
         ad_count: number;
     }): any;
@@ -370,7 +433,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     adShow(): Promise<void>;
     /**
-     * @deprecated - 2.x版本自v2.1.1开始已废弃，使用onExeAlways代替
+     * @deprecated - 1.x版本自v2.1.1已废弃，使用onExeAlways代替
      * - 关闭广告时候调用的回调,不管是否看完视频都会调用
      * - 调用adExecuteManager时collection.always回调
      * @param {Array.<unknown>} args
@@ -383,7 +446,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     onExeAlways(...args: Array<unknown>): any;
     /**
-     * @deprecated 2.x版本自v2.1.1开始已废弃，使用onExeHalfway代替
+     * @deprecated 1.x版本自v2.1.1已废弃，使用onExeHalfway代替
      * - 广告未看完时候调用的回调
      * - 调用adExecuteManager时collection.halfway回调
      * @param {Array.<unknown>} args
@@ -396,7 +459,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     onExeHalfway(...args: Array<unknown>): any;
     /**
-     * @deprecated 2.x版本自v2.1.1开始已废弃，使用onExeFinished代替
+     * @deprecated 1.x版本自v2.1.1已废弃，使用onExeFinished代替
      * - 广告看完时候调用的回调
      * - 调用adExecuteManager时collection.finished回调
      * @param {Array.<unknown>} args
@@ -516,6 +579,15 @@ declare class RewardAdNovel extends RewardAdFather {
      * @param {unknown} e
      */
     protected adLoadLister(e: unknown): unknown;
+    /**
+     * 销毁广告实例
+     * @protected
+     * @param {object} [args]
+     * @param {boolean} [args.preserved] 是否保留广告实例
+     */
+    protected __novelDestroy__(args?: {
+        preserved?: boolean;
+    }): void;
     /**
      * 销毁广告实例
      * @protected

package/dist/ad-reward/src/typings/create-rewarded-video-ad.d.ts

@@ -14,7 +14,7 @@ export type RewardedVideoAd = {
     /**
      * 销毁广告实例
      */
-    destroy: () => void;
+    destroy: () => Promise<any>;
     /**
      * 绑定广告 load 事件的监听器
      */

package/dist/analytics/src/AdAnalyticsJS.d.ts

@@ -89,9 +89,10 @@ declare class AdAnalyticsJS {
     /**
      * 获取公共用户信息
      * @public
-     * @returns {ICommonInfo}
+     * @param {string|number} [v] - key
+     * @returns {unknown}
      */
-    public getCommonInfo(): ICommonInfo;
+    public getCommonInfo(v?: string | number): unknown;
     /**
      * 获取埋点公共用户信息
      * @protected

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singcl/ad-execute-manager",
-  "version": "2.2.0",
+  "version": "2.3.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,12 +86,12 @@
   "dependencies": {
     "@ad-execute-manager/core": "^2.0.6",
     "@ad-execute-manager/logger": "^2.0.5",
-    "@ad-execute-manager/ad-reward": "^2.1.1",
+    "@ad-execute-manager/ad-reward": "^2.3.1",
     "@ad-execute-manager/ad-interstitial": "^2.0.6",
     "@ad-execute-manager/count-recorder": "^2.1.0",
     "@ad-execute-manager/serializable-error": "^2.0.5",
     "@ad-execute-manager/storage": "^2.1.0",
     "@ad-execute-manager/event": "^2.0.5",
-    "@ad-execute-manager/analytics": "^2.0.5"
+    "@ad-execute-manager/analytics": "^2.0.6"
   }
 }