@singcl/ad-execute-manager 1.12.5 → 1.12.7

package/dist/ad/InterstitialAdFather.d.ts

@@ -27,14 +27,15 @@ declare class InterstitialAdFather {
      * 使用管理器执行广告
      * @param {Object} adInstance 广告实例
      * @param {Object} ctx 上下文对象，用于传递数据和状态
-     * @param {Object} ctx.options 广告执行选项
-     * @param {Object} ctx.collection 回调集合
-     * @returns {Promise} 广告执行结果的Promise
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {CallbackCollection} [ctx.collection] 回调集合
      */
     static executeWithManager(adInstance: any, ctx: {
-        options: any;
-        collection: any;
-    }): Promise<any>;
+        options?: IRewordAdConfig;
+        collection?: CallbackCollection;
+    }): Promise<import("../core/AdExecuteManager").ITaskResult & {
+        [key: string]: any;
+    }>;
     /**
      * @param {IConstructArgs} args
      */
@@ -89,7 +90,9 @@ declare class InterstitialAdFather {
     addExecuteManager(ctx?: {
         options?: IRewordAdConfig;
         collection?: CallbackCollection;
-    }): Promise<any>;
+    }): Promise<import("../core/AdExecuteManager").ITaskResult & {
+        [key: string]: any;
+    }>;
     destroy(): void;
     /**
      * 清理广告实例

package/dist/ad/RewardAdFather.d.ts

@@ -25,14 +25,15 @@ declare class RewardAdFather {
      * 使用管理器执行广告
      * @param {Object} adInstance 广告实例
      * @param {Object} ctx 上下文对象，用于传递数据和状态
-     * @param {Object} ctx.options 广告执行选项
-     * @param {Object} ctx.collection 回调集合
-     * @returns {Promise} 广告执行结果的Promise
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {CallbackCollection} [ctx.collection] 回调集合
      */
     static executeWithManager(adInstance: any, ctx: {
-        options: any;
-        collection: any;
-    }): Promise<any>;
+        options?: IRewordAdConfig;
+        collection?: CallbackCollection;
+    }): Promise<import("../core/AdExecuteManager").ITaskResult & {
+        [key: string]: any;
+    }>;
     /**
      * @param {IConstructArgs} args
      */
@@ -60,11 +61,11 @@ declare class RewardAdFather {
     /**
      * 初始化
      * 子类可以选择覆盖此方法，或使用默认实现
-     * @param {IRewordAdConfig} params
+     * @param {import('../typings/ad.js').IAdOptions} params
      * @param {(v: IRewardedVideoAd) => void} [callback] 初始化成功回调
      * @returns {this} 当前实例
      */
-    initialize(params: IRewordAdConfig, callback?: (v: IRewardedVideoAd) => void): this;
+    initialize(params: import("../typings/ad.js").IAdOptions, callback?: (v: IRewardedVideoAd) => void): this;
     initialized(): boolean;
     /**
      * 激励视频展示失败时始终执行的一个方法
@@ -107,7 +108,9 @@ declare class RewardAdFather {
     addExecuteManager(ctx?: {
         options?: IRewordAdConfig;
         collection?: CallbackCollection;
-    }): Promise<any>;
+    }): Promise<import("../core/AdExecuteManager").ITaskResult & {
+        [key: string]: any;
+    }>;
     destroy(): void;
     /**
      * 清理广告实例

package/dist/ad/RewardAdNovel.d.ts

@@ -1,78 +1,6 @@
 export default RewardAdNovel;
 export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
-export type ICallbackArgs = {
-    /**
-     * 广告执行场景
-     */
-    scene: number;
-    /**
-     * 是否看完
-     */
-    isEnded: boolean;
-    /**
-     * 完整观看次数
-     */
-    count: number;
-    /**
-     * 执行下一个任务的回调函数，手动调用以继续执行流程[end]
-     */
-    end?: () => void;
-    /**
-     * 执行下一个任务的回调函数， 手动调用以继续执行流程[circle]
-     */
-    circle?: (args: {
-        ignoreRemain: boolean;
-        scene: number;
-    }) => void;
-};
-export type IConnection = {
-    /**
-     * 广告中途退出回调
-     */
-    onHalfway?: (args: ICallbackArgs) => void;
-    /**
-     * 广告展示回调
-     */
-    onShow?: (args: ICallbackArgs) => void;
-    /**
-     * 广告执行成功回调
-     */
-    onFinish?: (args: ICallbackArgs) => void;
-    /**
-     * 广告执行成功回调
-     */
-    onAlways?: (args: ICallbackArgs) => void;
-    /**
-     * 广告执行失败回调
-     */
-    onError?: (e: unknown) => void;
-};
-export type IConstructArgs = {
-    /**
-     * 初始化标识
-     */
-    sign?: string;
-    /**
-     * 是否开启日志
-     */
-    log?: boolean;
-    /**
-     * 是否保留tt激励视频广告实例
-     */
-    preserveOnEnd?: boolean;
-    /**
-     * 是否需要在超时情况下结束广告
-     */
-    needEndOnTimeout?: boolean;
-    /**
-     * 激励视频参数 (可选)
-     */
-    adConfig?: IRewordAdConfig | undefined;
-    /**
-     * 回调集合
-     */
-    collection?: IConnection | undefined;
-};
+export type IConstructArgs = import("../typings/ad.js").IConstructArgs;
 export type ICloseArgs = {
     /**
      * 是否看完
@@ -93,30 +21,7 @@ export type IRewardedVideoAd = {
  * @typedef {import('../typings/ad.js').IRewordAdConfig} IRewordAdConfig
  */
 /**
- * @typedef ICallbackArgs
- * @property {number} scene 广告执行场景
- * @property {boolean} isEnded 是否看完
- * @property {number} count 完整观看次数
- * @property {() => void} [end] 执行下一个任务的回调函数，手动调用以继续执行流程[end]
- * @property {(args: {ignoreRemain: boolean, scene: number}) => void} [circle] 执行下一个任务的回调函数， 手动调用以继续执行流程[circle]
- *
- */
-/**
- * @typedef IConnection
- * @property {(args: ICallbackArgs) => void} [onHalfway] 广告中途退出回调
- * @property {(args: ICallbackArgs) => void} [onShow] 广告展示回调
- * @property {(args: ICallbackArgs) => void} [onFinish] 广告执行成功回调
- * @property {(args: ICallbackArgs) => void} [onAlways] 广告执行成功回调
- * @property {(e:unknown) => void} [onError] 广告执行失败回调
- */
-/**
- * @typedef IConstructArgs
- * @property {string} [sign] 初始化标识
- * @property {boolean} [log] 是否开启日志
- * @property {boolean} [preserveOnEnd] 是否保留tt激励视频广告实例
- * @property {boolean} [needEndOnTimeout] 是否需要在超时情况下结束广告
- * @property {IRewordAdConfig=} [adConfig] 激励视频参数 (可选)
- * @property {IConnection=} [collection] 回调集合
+ * @typedef {import('../typings/ad.js').IConstructArgs} IConstructArgs
  */
 /**
  * @typedef ICloseArgs
@@ -145,11 +50,6 @@ declare class RewardAdNovel extends RewardAdFather {
      * @returns  {RewardAdNovel}
      */
     static "new"(args: IConstructArgs): RewardAdNovel;
-    /**
-     * @param {IConstructArgs} args
-     *
-     */
-    constructor(args: IConstructArgs);
     _onHalfway: any;
     _onShow: any;
     _onFinish: any;
@@ -342,17 +242,30 @@ declare class RewardAdNovel extends RewardAdFather {
         ad_count: number;
     }): any;
     get rewardAd(): import("../typings/create-rewarded-video-ad.js").RewardedVideoAd;
+    /**
+     * 确保广告按顺序执行
+     * @override
+     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
+     * @param {import('../typings/ad.js').IAdOptions} [ctx.options] 广告执行选项
+     * @param {import('../typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
+     */
+    override addExecuteManager(ctx?: {
+        options?: import("../typings/ad.js").IAdOptions;
+        collection?: import("../typings/ad.js").CallbackCollection;
+    }): Promise<import("../core/AdExecuteManager.js").ITaskResult & {
+        [key: string]: any;
+    }>;
     /**
      * @override
      * @param {object} [ctx] 广告执行上下文
-     * @param {import('../typings/ad.js').IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {import('../typings/ad.js').IAdOptions} [ctx.options] 广告执行选项
      * @param {import('../typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
      * @param {import('../typings/ad.js').RecoveredInfo} [ctx.recovered] 恢复重试信息
      * @param {Function} next 执行下一个任务的回调函数，手动调用以继续执行流程
      * @returns {Promise.<object | Undefined>}
      */
     override ad(ctx?: {
-        options?: import("../typings/ad.js").IRewordAdConfig;
+        options?: import("../typings/ad.js").IAdOptions;
         collection?: import("../typings/ad.js").CallbackCollection;
         recovered?: import("../typings/ad.js").RecoveredInfo;
     }, next?: Function): Promise<object | undefined>;

package/dist/typings/ad.d.ts

@@ -22,18 +22,12 @@ export type IRewordAdConfig = {
      * 额外观看广告的次数，合法的数据范围为 1～4，multiton 为 true 时必填
      */
     multitonRewardTimes?: number | undefined;
+};
+export type IRewordAdOther = {
     /**
-     * 场景值 - 自用参数，非tt API要求的参数
-     */
-    scene?: number | undefined;
-    /**
-     * 广告超时时间 单位ms - 自用参数，非tt API要求的参数
-     */
-    timeout?: number | undefined;
-    /**
-     * 重试次数 - 自用参数 ，非tt API要求的参数
+     * 是否需要在超时情况下结束广告 - 自用参数，非tt API要求的参数
      */
-    retry: number;
+    needEndOnTimeout?: boolean | undefined;
     /**
      * 是否绑定永远的错误事件 - 自用参数，非tt API要求的参数
      */
@@ -50,10 +44,6 @@ export type InterstitialAdConfig = {
     scene?: number | undefined;
 };
 export type IExeCallbackArgs = {
-    /**
-     * 广告执行场景
-     */
-    scene: number;
     /**
      * 是否看完
      */
@@ -63,40 +53,77 @@ export type IExeCallbackArgs = {
      */
     count: number;
     /**
-     * 剩余观看次数
+     * 广告场景
      */
-    remain?: number;
+    scene?: string;
+    /**
+     * 广告类型 1:激励视频 2:插屏
+     */
+    adTypeR?: 1 | 2;
+    /**
+     * 广告结束类型
+     */
+    end_type?: "finished" | "halfway";
 };
 export type CallbackCollection = {
     /**
      * 每次外部回调
      */
-    always?: (ctx?: IExeCallbackArgs) => void;
+    always?: (ctx?: IExeCallbackArgs & {
+        [key: string]: unknown;
+    }) => void;
     /**
      * 完整看完广告外部回调 不管一个还是几个
      */
-    finished?: (ctx?: IExeCallbackArgs) => void;
+    finished?: (ctx?: IExeCallbackArgs & {
+        [key: string]: unknown;
+    }) => void;
     /**
      * 半途退出广告外部回调
      */
-    halfway?: (ctx?: IExeCallbackArgs) => void;
+    halfway?: (ctx?: IExeCallbackArgs & {
+        [key: string]: unknown;
+    }) => void;
     /**
      * 取消广告外部回调
      */
-    cancel?: (ctx?: IExeCallbackArgs) => void;
+    cancel?: () => void;
     /**
      * 展示广告外部回调
      */
-    before?: (ctx?: IExeCallbackArgs) => void;
+    before?: (ctx?: {
+        scene: number;
+    }) => void;
     /**
      * 展示广告成功外部回调
      */
-    success?: (ctx?: IExeCallbackArgs) => void;
+    success?: (ctx?: {
+        scene: number;
+    }) => void;
     /**
-     * 计时回调
+     * 计时回调 scene: 广告场景 frequency: 广告展示前间隔时间 time: 广告展示时前间戳
      */
-    prelude?: (ctx?: unknown) => void;
+    prelude?: (ctx?: {
+        scene: number;
+        frequency: number;
+        time: number;
+    }) => void;
 };
+export type IAdOptionsOther = {
+    /**
+     * 场景值 - 自用参数，非tt API要求的参数
+     */
+    scene?: number | undefined;
+    /**
+     * 广告超时时间 单位ms - 自用参数，非tt API要求的参数
+     */
+    timeout?: number | undefined;
+    /**
+     * 重试次数 - 自用参数 ，非tt API要求的参数
+     */
+    retry: number;
+};
+export type IAdOptions = IRewordAdConfig & IRewordAdOther & IAdOptionsOther;
 export type RecoveredInfo = {
     /**
      * 恢复重试次数
@@ -125,48 +152,32 @@ export type IApiError = {
      */
     message?: string;
 };
-export type ICallbackArgs = {
-    /**
-     * 广告执行场景
-     */
-    scene: number;
-    /**
-     * 是否看完
-     */
-    isEnded: boolean;
-    /**
-     * 完整观看次数
-     */
-    count: number;
-    /**
-     * 剩余观看次数
-     */
-    remain?: number;
+export type ICallbackArgs = IExeCallbackArgs;
+export type IConnection = {
     /**
-     * 执行下一个任务的回调函数，手动调用以继续执行流程[end]
+     * 广告中途退出回调
      */
-    end?: () => void;
+    onHalfway?: (args: ICallbackArgs & {
+        [key: string]: unknown;
+    }) => void;
     /**
-     * 执行下一个任务的回调函数， 手动调用以继续执行流程[circle]
+     * 广告展示回调
      */
-    circle?: (args: {
-        ignoreRemain: boolean;
+    onShow?: (args: {
         scene: number;
     }) => void;
-};
-export type IConnection = {
     /**
-     * 广告中途退出回调
-     */
-    onHalfway?: (args: ICallbackArgs) => void;
-    /**
-     * 广告展示回调
+     * 广告执行成功回调
      */
-    onShow?: (args: ICallbackArgs) => void;
+    onFinish?: (args: ICallbackArgs & {
+        [key: string]: unknown;
+    }) => void;
     /**
      * 广告执行成功回调
      */
-    onFinish?: (args: ICallbackArgs) => void;
+    onAlways?: (args: ICallbackArgs & {
+        [key: string]: unknown;
+    }) => void;
     /**
      * 广告执行失败回调
      */
@@ -177,14 +188,6 @@ export type IConstructArgs = {
      * 初始化标识
      */
     sign: string;
-    /**
-     * 是否开启日志
-     */
-    log?: boolean | undefined;
-    /**
-     * 重试次数
-     */
-    retry: number;
     /**
      * 是否保留tt激励视频广告实例
      */

package/package.json

@@ -1,73 +1,73 @@
-{
-  "name": "@singcl/ad-execute-manager",
-  "version": "1.12.5",
-  "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"
-  },
-  "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"
-  }
-}
+{
+  "name": "@singcl/ad-execute-manager",
+  "version": "1.12.7",
+  "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"
+  },
+  "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"
+  }
+}