@singcl/ad-execute-manager 2.1.2 → 2.3.0

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

@@ -85,8 +85,18 @@ declare class RewardAdNovel extends RewardAdFather {
     _finishedCallback: any;
     _resolve: any;
     _next: any;
+    /** @type {{options: import('./typings/ad.js').IAdOptions, collection: import('./typings/ad.js').CallbackCollection, recovered: import('./typings/ad.js').RecoveredInfo}} */
+    _adExecuteArgs: {
+        options: import("./typings/ad.js").IAdOptions;
+        collection: import("./typings/ad.js").CallbackCollection;
+        recovered: import("./typings/ad.js").RecoveredInfo;
+    };
+    /** @type {Function} */
+    _adNext: Function;
     /** @type {number} 广告执行场景 */
     _scene: number;
+    /** @type {string} 当前广告执行的唯一ID */
+    _eId: string;
     _adTypeR: 1;
     _adTimeout: any;
     _adBeforeShowTimer: any;
@@ -146,20 +156,55 @@ declare class RewardAdNovel extends RewardAdFather {
         retry?: number;
     }): void;
     novelConfig: RewardAdNovelConfig;
-    _onInnerExecuteBefore(): 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
      * 广告展示超时设置
      * @param {object} args
      * @param {string} args.scene 广告执行场景 必填
@@ -167,11 +212,19 @@ declare class RewardAdNovel extends RewardAdFather {
      * @param {Function} args.end 结束当前广告任务的回调函数 必填
      * @param {boolean} [args.preserved] 是否在超时情况下保留广告实例 - 自用参数，非tt API要求的参数
      */
-    _setAdTimeout(args: {
+    private _setAdTimeout;
+    /**
+     * @protected
+     * 广告展示超时设置
+     * @param {object} _args
+     * @param {string} _args.scene 广告执行场景 必填
+     * @param {number} [_args.timeout] 广告超时时间 单位ms
+     * @param {Function} _args.end 结束当前广告任务的回调函数 必填
+     */
+    protected customExecuteAfterTimeout(_args: {
         scene: string;
         timeout?: number;
         end: Function;
-        preserved?: boolean;
     }): void;
     /**
      * 子类可以选择覆盖此方法
@@ -204,10 +257,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;
     /**
      * 广告展示成功分析
@@ -215,6 +270,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] 恢复重试信息
@@ -222,6 +278,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     protected _adShowSuccessAnalytics(_args: {
         scene: string;
+        eId: string;
         msg?: string;
         result: 0 | 1;
         recovered?: import("./typings/ad.js").RecoveredInfo;
@@ -233,6 +290,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 广告执行失败结果
@@ -240,6 +298,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     protected _adShowFailureAnalytics(_args: {
         scene: string;
+        eId: string;
         msg: string;
         errorCode: number;
         result: 0 | 1;
@@ -314,29 +373,46 @@ declare class RewardAdNovel extends RewardAdFather {
     _recovered: import("./typings/ad.js").RecoveredInfo;
     _preservedOnTimeout: boolean;
     /**
+     * ATTENTION: 广告循环执行内部函数，如果需要循环执行，请使用adCircleInner()函数, 不要直接调用此函数
+     * @private
      * @param {object} [ctx] 广告执行上下文
      * @param {object} [ctx.options] 广告执行选项
      * @param {number} [ctx.options.scene] 广告执行场景 必填
      * @param {number} [ctx.options.timeout] 广告超时时间 单位ms
      * @param {object} ctx.collection 回调集合
-     * @param {import('./typings/ad.js').RecoveredInfo} [ctx.recovered] 恢复重试信息
      * @param {(v?: unknown) => void} ctx.collection.resolve 广告执行成功的回调函数
-     * @param {(v?: unknown) => void} [ctx.collection.reject] 广告执行失败的回调函数
      * @param {(v?: unknown) => void} [ctx.collection.before] 广告执行前的回调函数
      * @param {(v?: unknown) => void} [ctx.collection.success] 广告执行成功的回调函数
      * @param {(v?: unknown) => void} [ctx.collection.prelude] 拉起广告前计时的回调函数
+     * @param {import('./typings/ad.js').RecoveredInfo} [ctx.recovered] 恢复重试信息
      * @param {Function} next 执行下一个任务的回调函数，手动调用以继续执行流程
      */
-    _adInner(ctx?: {
+    private _adInner;
+    _before: (v?: unknown) => void;
+    _success: (v?: unknown) => void;
+    /**
+     * 广告循环执行
+     * @public
+     * @param {object} [ctx] 广告执行上下文
+     * @param {object} [ctx.options] 广告执行选项
+     * @param {number} [ctx.options.scene] 广告执行场景 必填
+     * @param {number} [ctx.options.timeout] 广告超时时间 单位ms
+     * @param {object} ctx.collection 回调集合
+     * @param {(v?: unknown) => void} [ctx.collection.before] 广告执行前的回调函数
+     * @param {(v?: unknown) => void} [ctx.collection.success] 广告执行成功的回调函数
+     * @param {(v?: unknown) => void} [ctx.collection.prelude] 拉起广告前计时的回调函数
+     */
+    public adCircleInner(ctx?: {
         options?: {
             scene?: number;
             timeout?: number;
         };
-        collection: object;
-        recovered?: import("./typings/ad.js").RecoveredInfo;
-    }, next?: Function): void;
-    _before: any;
-    _success: any;
+        collection: {
+            before?: (v?: unknown) => void;
+            success?: (v?: unknown) => void;
+            prelude?: (v?: unknown) => void;
+        };
+    }): void;
     /**
      * 广告加载
      * @returns
@@ -348,7 +424,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
@@ -361,7 +437,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
@@ -374,7 +450,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
@@ -494,6 +570,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/dist/count-recorder/src/CountRecorder.d.ts

@@ -33,6 +33,19 @@ export class CountRecorder {
     _initLocalTimes(): void;
     updateToday(): void;
     remain(): number;
+    /**
+     * 保存指定次数
+     * @param {number} count 次数
+     */
+    save(count: number): void;
+    /**
+     * 清除当前类的本地存储
+     */
+    clear(): void;
+    /**
+     * 重置当前类的本地存储
+     */
+    reset(): void;
 }
 export type IConstructorArgs = {
     /**

package/dist/storage/src/Storage.d.ts

@@ -106,6 +106,11 @@ declare class Storage {
      * @param {number|'today'} expire 过期时间（毫秒）或'today'表示当天有效，可选
      */
     setUserItem(key: string, value: any, expire: number | "today"): void;
+    /**
+     * 删除用户维度的存储项
+     * @param {string} key 存储键
+     */
+    removeUserItem(key: string): void;
     /**
      * 删除存储项
      * @param {string} key 存储键

package/package.json

@@ -1,97 +1,97 @@
-{
-  "name": "@singcl/ad-execute-manager",
-  "version": "2.1.2",
-  "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": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "author": {
-    "name": "singcl",
-    "email": "iambabyer@gmail.com",
-    "url": "https://github.com/singcl"
-  },
-  "license": "MIT",
-  "homepage": "https://npmx.dev/package/@singcl/ad-execute-manager",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/singcl/ad-execute-manager.git"
-  },
-  "bugs": {
-    "url": "https://github.com/singcl/ad-execute-manager/issues"
-  },
-  "engines": {
-    "node": ">=8.0.0",
-    "npm": ">=6.0.0",
-    "yarn": ">=1.0.0",
-    "pnpm": ">=8.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "ad",
-    "advertisement",
-    "reward-ad",
-    "interstitial-ad",
-    "ad-manager",
-    "ad-execution",
-    "javascript",
-    "nodejs"
-  ],
-  "scripts": {
-    "build": "rslib build && tsc",
-    "dev": "rslib build --watch",
-    "format": "prettier --write .",
-    "lint": "eslint .",
-    "test": "rstest",
-    "prepublishOnly": "npm i && npm run build",
-    "packages:install": "node build-packages.js install",
-    "packages:build": "node build-packages.js build",
-    "packages:publish": "node build-packages.js publish",
-    "packages:publish:patch": "node build-packages.js publish patch",
-    "packages:publish:minor": "node build-packages.js publish minor",
-    "packages:publish:major": "node build-packages.js publish major",
-    "packages:lint": "node build-packages.js lint",
-    "packages:format": "node build-packages.js format",
-    "packages:clean": "node build-packages.js clean",
-    "packages:all": "node build-packages.js all",
-    "packages:all:patch": "node build-packages.js all patch",
-    "packages:all:minor": "node build-packages.js all minor",
-    "packages:all:major": "node build-packages.js all major"
-  },
-  "devDependencies": {
-    "@babel/eslint-parser": "^7.28.5",
-    "@babel/preset-env": "^7.28.5",
-    "@douyin-microapp/typings": "^1.3.1",
-    "@eslint/js": "^9.39.1",
-    "@rslib/core": "^0.18.5",
-    "@rstest/core": "^0.7.2",
-    "@singcl/ad-execute-manager": "^1.11.12",
-    "eslint": "^9.39.2",
-    "eslint-plugin-import": "^2.32.0",
-    "globals": "^16.5.0",
-    "prettier": "^3.7.3",
-    "typescript": "^5.9.3"
-  },
-  "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-interstitial": "^2.0.6",
-    "@ad-execute-manager/count-recorder": "^2.0.5",
-    "@ad-execute-manager/serializable-error": "^2.0.5",
-    "@ad-execute-manager/storage": "^2.0.5",
-    "@ad-execute-manager/event": "^2.0.5",
-    "@ad-execute-manager/analytics": "^2.0.5"
-  }
-}
+{
+  "name": "@singcl/ad-execute-manager",
+  "version": "2.3.0",
+  "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": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "singcl",
+    "email": "iambabyer@gmail.com",
+    "url": "https://github.com/singcl"
+  },
+  "license": "MIT",
+  "homepage": "https://npmx.dev/package/@singcl/ad-execute-manager",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/singcl/ad-execute-manager.git"
+  },
+  "bugs": {
+    "url": "https://github.com/singcl/ad-execute-manager/issues"
+  },
+  "engines": {
+    "node": ">=8.0.0",
+    "npm": ">=6.0.0",
+    "yarn": ">=1.0.0",
+    "pnpm": ">=8.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "ad",
+    "advertisement",
+    "reward-ad",
+    "interstitial-ad",
+    "ad-manager",
+    "ad-execution",
+    "javascript",
+    "nodejs"
+  ],
+  "scripts": {
+    "build": "rslib build && tsc",
+    "dev": "rslib build --watch",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "test": "rstest",
+    "prepublishOnly": "npm i && npm run build",
+    "packages:install": "node build-packages.js install",
+    "packages:build": "node build-packages.js build",
+    "packages:publish": "node build-packages.js publish",
+    "packages:publish:patch": "node build-packages.js publish patch",
+    "packages:publish:minor": "node build-packages.js publish minor",
+    "packages:publish:major": "node build-packages.js publish major",
+    "packages:lint": "node build-packages.js lint",
+    "packages:format": "node build-packages.js format",
+    "packages:clean": "node build-packages.js clean",
+    "packages:all": "node build-packages.js all",
+    "packages:all:patch": "node build-packages.js all patch",
+    "packages:all:minor": "node build-packages.js all minor",
+    "packages:all:major": "node build-packages.js all major"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@douyin-microapp/typings": "^1.3.1",
+    "@eslint/js": "^9.39.1",
+    "@rslib/core": "^0.18.5",
+    "@rstest/core": "^0.7.2",
+    "@singcl/ad-execute-manager": "^1.11.12",
+    "eslint": "^9.39.2",
+    "eslint-plugin-import": "^2.32.0",
+    "globals": "^16.5.0",
+    "prettier": "^3.7.3",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@ad-execute-manager/core": "^2.0.6",
+    "@ad-execute-manager/logger": "^2.0.5",
+    "@ad-execute-manager/ad-reward": "^2.3.0",
+    "@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.6"
+  }
+}