@singcl/ad-execute-manager 2.0.0 → 2.0.2

package/dist/ad/{InterstitialAdFather.d.ts → src/InterstitialAdFather.d.ts}

@@ -1,11 +1,11 @@
 export default InterstitialAdFather;
-export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
-export type CallbackCollection = import("../typings/ad.js").CallbackCollection;
-export type IConstructArgs = import("../typings/ad.js").IConstructArgs;
+export type IRewordAdConfig = import("./typings/ad.js").IRewordAdConfig;
+export type CallbackCollection = import("./typings/ad.js").CallbackCollection;
+export type IConstructArgs = import("./typings/ad.js").IConstructArgs;
 /**
  * 激励视频实例
  */
-export type InterstitialAd = import("../typings/create-interstitial-ad.js").InterstitialAd;
+export type InterstitialAd = import("./typings/create-interstitial-ad.js").InterstitialAd;
 export type IRewardedVideoAd = {
     /**
      * 显示激励视频广告
@@ -160,4 +160,4 @@ declare class InterstitialAdFather {
      */
     placeholder(): any;
 }
-import { Logger } from '../helper/Logger';
+import { Logger } from '@ad-execute-manager/helper';

package/dist/ad/{InterstitialAdNovel.d.ts → src/InterstitialAdNovel.d.ts}

@@ -1,5 +1,5 @@
 export default InterstitialAdNovel;
-export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
+export type IRewordAdConfig = import("./typings/ad.js").IRewordAdConfig;
 export type ICallbackArgs = {
     /**
      * 广告执行场景
@@ -104,7 +104,7 @@ export type IRewardedVideoAd = {
     show: () => Promise<void>;
 };
 /**
- * @typedef {import('../typings/ad.js').IRewordAdConfig} IRewordAdConfig
+ * @typedef {import('./typings/ad.js').IRewordAdConfig} IRewordAdConfig
  */
 /**
  * @typedef ICallbackArgs
@@ -331,26 +331,26 @@ declare class InterstitialAdNovel extends InterstitialAdFather {
      * @override
      * @param {Object} [ctx] 上下文对象，用于传递数据和状态
      * @param {IRewordAdConfig} [ctx.options] 广告执行选项
-     * @param {import('../typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
+     * @param {import('./typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
      * @returns {Promise.<IEndArgs & ICloseArgs | Undefined>}
      */
     override addExecuteManager(ctx?: {
         options?: IRewordAdConfig;
-        collection?: import("../typings/ad.js").CallbackCollection;
+        collection?: import("./typings/ad.js").CallbackCollection;
     }): Promise<(IEndArgs & ICloseArgs) | undefined>;
     /**
      * ATTENTION: 应用一旦进入后台，90%概率.show() 方法的.then() 回调将不会被执行, .catch() 回调也不会被执行。
      * 此时将进入超时处理逻辑
      * @override
      * @param {object} [ctx] 广告执行上下文
-     * @param {import('../typings/ad.js').IRewordAdConfig} [ctx.options] 广告执行选项
-     * @param {import('../typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
+     * @param {import('./typings/ad.js').IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {import('./typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
      * @param {Function} next 执行下一个任务的回调函数，手动调用以继续执行流程
      * @returns {Promise.<IEndArgs & ICloseArgs | Undefined>}
      */
     override ad(ctx?: {
-        options?: import("../typings/ad.js").IRewordAdConfig;
-        collection?: import("../typings/ad.js").CallbackCollection;
+        options?: import("./typings/ad.js").IRewordAdConfig;
+        collection?: import("./typings/ad.js").CallbackCollection;
     }, next?: Function): Promise<(IEndArgs & ICloseArgs) | undefined>;
     /**
      * ATTENTION: 应用一旦进入后台，90%概率.show() 方法的.then() 回调将不会被执行, .catch() 回调也不会被执行。

package/dist/ad/{RewardAdFather.d.ts → src/RewardAdFather.d.ts}

@@ -1,9 +1,9 @@
 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 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 = {
     /**
      * 显示激励视频广告
@@ -178,4 +178,4 @@ declare class RewardAdFather {
      */
     placeholder(): any;
 }
-import { Logger } from '../helper/Logger';
+import { Logger } from '@ad-execute-manager/helper';

package/dist/ad/{RewardAdNovel.d.ts → src/RewardAdNovel.d.ts}

@@ -1,5 +1,5 @@
 export default RewardAdNovel;
-export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
+export type IRewordAdConfig = any;
 export type ICallbackArgs = {
     /**
      * 广告执行场景
@@ -64,10 +64,6 @@ export type IConstructArgs = {
      * 是否需要在超时情况下结束广告
      */
     needEndOnTimeout?: boolean;
-    /**
-     * 关闭广告时候是否需要主动结束任务
-     */
-    proactive?: boolean;
     /**
      * 激励视频参数 (可选)
      */
@@ -137,7 +133,6 @@ export type IRewardedVideoAd = {
  * @property {boolean} [log] 是否开启日志
  * @property {boolean} [preserveOnEnd] 是否保留tt激励视频广告实例
  * @property {boolean} [needEndOnTimeout] 是否需要在超时情况下结束广告
- * @property {boolean} [proactive] 关闭广告时候是否需要主动结束任务
  * @property {IRewordAdConfig=} [adConfig] 激励视频参数 (可选)
  * @property {IConnection=} [collection] 回调集合
  */
@@ -202,16 +197,13 @@ declare class RewardAdNovel extends RewardAdFather {
     _needEndOnTimeout: boolean;
     /** @deprecated TODO 移除 */
     _needSpeedEndOnTimeout: boolean;
-    /**
-     * @description 关闭广告时候是否需要主动结束任务
-     */
-    _proactive: boolean;
     bindAdCloseLister: any;
     bindAdErrorLister: any;
     bindAdLoadLister: any;
     bindApiAdErrorLister: any;
     _bindShiftCloseLister: any;
     _bindShiftErrorLister: any;
+    _adConfig: any;
     /**
      * 初始化
      * 子类可以选择覆盖此方法，或使用默认实现
@@ -240,7 +232,7 @@ declare class RewardAdNovel extends RewardAdFather {
     _onInnerAdShowSuccess(_args: {
         scene: string;
         result?: number;
-        recovered?: import("../typings/ad.js").RecoveredInfo;
+        recovered?: any;
     }): any;
     /**
      * 广告展示超时设置
@@ -305,7 +297,7 @@ declare class RewardAdNovel extends RewardAdFather {
         scene: string;
         msg?: string;
         result: 0 | 1;
-        recovered?: import("../typings/ad.js").RecoveredInfo;
+        recovered?: any;
     }): any;
     /**
      * 广告展示失败分析
@@ -376,7 +368,7 @@ declare class RewardAdNovel extends RewardAdFather {
         ad_is_completed: number;
         ad_count: number;
     }): any;
-    get rewardAd(): import("../typings/create-rewarded-video-ad.js").RewardedVideoAd;
+    get rewardAd(): import("./typings/create-rewarded-video-ad.js").RewardedVideoAd;
     /**
      * 确保广告按顺序执行
      * @override
@@ -387,7 +379,7 @@ declare class RewardAdNovel extends RewardAdFather {
      */
     override addExecuteManager(ctx?: {
         options?: IRewordAdConfig;
-        collection?: import("../typings/ad.js").CallbackCollection;
+        collection?: any;
     }): Promise<(IEndArgs & ICloseArgs) | undefined>;
     /**
      * @override
@@ -399,11 +391,11 @@ declare class RewardAdNovel extends RewardAdFather {
      * @returns {Promise.<IEndArgs & ICloseArgs | Undefined>}
      */
     override ad(ctx?: {
-        options?: import("../typings/ad.js").IRewordAdConfig;
-        collection?: import("../typings/ad.js").CallbackCollection;
-        recovered?: import("../typings/ad.js").RecoveredInfo;
+        options?: any;
+        collection?: any;
+        recovered?: any;
     }, next?: Function): Promise<(IEndArgs & ICloseArgs) | undefined>;
-    _recovered: import("../typings/ad.js").RecoveredInfo;
+    _recovered: any;
     /**
      * @param {object} [ctx] 广告执行上下文
      * @param {object} [ctx.options] 广告执行选项
@@ -424,7 +416,7 @@ declare class RewardAdNovel extends RewardAdFather {
             timeout?: number;
         };
         collection: object;
-        recovered?: import("../typings/ad.js").RecoveredInfo;
+        recovered?: any;
     }, next?: Function): void;
     _before: any;
     _success: any;
@@ -442,33 +434,70 @@ declare class RewardAdNovel extends RewardAdFather {
     _outerHalfwayCallback(args: any): void;
     _outerFinishedCallback(args: any): void;
     /**
-     * 关闭激励视频
+     * 内部关闭激励视频
+     * @private
      * @param {ICloseArgs} args
      */
-    __adCloseLister__(args: ICloseArgs): void;
+    private __adCloseLister__;
     /**
-     * 关闭激励视频结束任务
-     * 子类可以重写该方法，如果子类不提供该方法，则使用默认实现
-     * 如果子类需要主动结束任务，则需要设置proactive为true，同时主动调用end方法
+     * 关闭激励视频
+     * 子类可重写该方法
+     * @protected
      * @param {object} args
-     * @param {(ctx: object) => void} args.end 结束任务  如果proactive为true，则需要主动调用end方法，否则不需要调用
-     * @param {(ctx: object) => void} args.conn 调用传入的回调函数 如果proactive为true，则需要主动调用conn方法，否则不需要调用
+     * @param {boolean} args.isEnded 广告是否完成
+     * @param {number} args.count 广告执行次数
+     * @param {string} args.scene 广告执行场景
+     * @param {number} args.adTypeR 广告类型
+     * @param {string} args.end_type 广告关闭类型
+     * @param {object} [connection] 广告关闭回调集合
+     * @param {(ctx: object) => void} [connection.conn] 调用外部传入的回调
+     * @param {(ctx: object) => void} [connection.end] 结束任务的回调
+     *
      */
-    adCloseLister(args: {
-        end: (ctx: object) => void;
-        conn: (ctx: object) => void;
-    }): {
-        end: (ctx: object) => void;
-        conn: (ctx: object) => void;
-    };
-    adErrorLister(e: any): void;
-    apiAdErrorLister(e: any): void;
+    protected adCloseLister(args: {
+        isEnded: boolean;
+        count: number;
+        scene: string;
+        adTypeR: number;
+        end_type: string;
+    }, connection?: {
+        conn?: (ctx: object) => void;
+        end?: (ctx: object) => void;
+    }): void;
+    /**
+     * 激励视频广告组件**失败**时会触发
+     * @private
+     */
+    private __adErrorLister__;
     /**
+     * 激励视频广告组件**失败**时会触发
+     * @protected
+     */
+    protected adErrorLister(e: any): any;
+    /**
+     * 激励视频广告组件api**失败**时会触发
+     * @private
+     */
+    private __apiAdErrorLister__;
+    /**
+     * 激励视频广告组件api**失败**时会触发
+     * @protected
+     */
+    protected apiAdErrorLister(e: any): any;
+    /**
+     * @private
+     * 激励视频广告组件**成功**拉取广告素材时会触发
+     * 创建激励时候后会自动拉取广告素材，如果广告拉取成功，也会触发此事件，不管是否调用show方法
+     * @param {unknown} e
+     */
+    private __adLoadLister__;
+    /**
+     * @protected
      * 激励视频广告组件**成功**拉取广告素材时会触发
      * 创建激励时候后会自动拉取广告素材，如果广告拉取成功，也会触发此事件，不管是否调用show方法
      * @param {unknown} e
      */
-    adLoadLister(e: unknown): void;
+    protected adLoadLister(e: unknown): unknown;
     adDestroy(): void;
     _shiftCloseLister(args: any): void;
     _shiftErrorLister(args: any): void;

package/dist/ad/src/index.d.ts

@@ -0,0 +1,5 @@
+export { AdExecuteManager } from "@ad-execute-manager/core";
+export { default as InterstitialAdFather } from "./InterstitialAdFather";
+export { default as RewardAdFather } from "./RewardAdFather";
+export { default as RewardAdNovel } from "./RewardAdNovel";
+export { default as InterstitialAdNovel } from "./InterstitialAdNovel";

package/dist/{typings → ad/src/typings}/ad.d.ts

@@ -38,10 +38,6 @@ export type IRewordAdConfig = {
      * 是否绑定永远的错误事件 - 自用参数，非tt API要求的参数
      */
     foreverErrorBind?: boolean | undefined;
-    /**
-     * 关闭广告时候是否需要主动结束任务 - 自用参数，非tt API要求的参数
-     */
-    proactive?: boolean | undefined;
 };
 export type InterstitialAdConfig = {
     /**

package/dist/analytics/{AdAnalyticsJS.d.ts → src/AdAnalyticsJS.d.ts}

@@ -138,4 +138,4 @@ declare class AdAnalyticsJS {
      */
     placeholder(): any;
 }
-import { Logger } from '../helper/Logger';
+import { Logger } from '@ad-execute-manager/helper';

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

@@ -0,0 +1 @@
+export { default as AdAnalyticsJS } from "./AdAnalyticsJS.js";

package/dist/core/{AdExecuteManager.d.ts → src/AdExecuteManager.d.ts}

@@ -1,17 +1,34 @@
 export default AdExecuteManager;
+export type IAdInstance = {
+    /**
+     * 超时时间
+     */
+    _adTimeoutTime: number;
+    /**
+     * 初始化广告
+     */
+    initialize: (ctx: unknown) => IAdInstance;
+    /**
+     * 显示广告
+     */
+    ad: (options: unknown, ctx: unknown, recovered: unknown) => Promise<unknown>;
+    clear: () => void;
+};
+export type IRewordAdConfig = import("./typings/ad.js").IRewordAdConfig;
+export type CallbackCollection = import("./typings/ad.js").CallbackCollection;
 export type AdTask = {
     /**
      * RewardAdFather的子类实例
      */
-    adInstance: import("../ad/RewardAdFather.js").default;
+    adInstance: IAdInstance;
     /**
      * 广告执行选项
      */
-    options: import("../typings/ad.js").IRewordAdConfig;
+    options: IRewordAdConfig;
     /**
      * 回调集合
      */
-    callbackCollection: import("../typings/ad.js").CallbackCollection;
+    callbackCollection: CallbackCollection;
     /**
      * 广告执行成功的回调函数
      */
@@ -191,15 +208,15 @@ declare class AdExecuteManager {
     isVisibilityListenerEnabled(): boolean;
     /**
      * 添加广告任务
-     * @param {import('../ad/RewardAdFather.js').default} adInstance RewardAdFather的子类实例
+     * @param {IAdInstance} adInstance RewardAdFather的子类实例
      * @param {Object} ctx 广告执行上下文
-     * @param {import('../typings/ad.js').IRewordAdConfig} ctx.options 广告执行选项
-     * @param {import('../typings/ad.js').CallbackCollection} ctx.collection 回调集合
+     * @param {IRewordAdConfig} ctx.options 广告执行选项
+     * @param {CallbackCollection} ctx.collection 回调集合
      * @returns {Promise} 广告执行结果的Promise
      */
-    addTask(adInstance: import("../ad/RewardAdFather.js").default, ctx: {
-        options: import("../typings/ad.js").IRewordAdConfig;
-        collection: import("../typings/ad.js").CallbackCollection;
+    addTask(adInstance: IAdInstance, ctx: {
+        options: IRewordAdConfig;
+        collection: CallbackCollection;
     }): Promise<any>;
     /**
      * 组合所有任务
@@ -232,4 +249,4 @@ declare class AdExecuteManager {
      */
     whenAllTasksComplete(): Promise<void>;
 }
-import { Logger } from '../helper/Logger';
+import { Logger } from '@ad-execute-manager/helper';

package/dist/core/src/index.d.ts

@@ -0,0 +1 @@
+export { default as AdExecuteManager } from "./AdExecuteManager.js";

package/dist/core/src/typings/ad.d.ts

@@ -0,0 +1,208 @@
+export type IRewordAdConfig = {
+    /**
+     * 激励视频广告id - 必填
+     */
+    adUnitId: string;
+    /**
+     * 是否开启进度提醒。开启时广告文案为「再看 n 个xxx」，关闭时为「再看 1 个xxx」。其中 n 表示用户当前还需额外观看广告的次数
+     */
+    progressTip?: boolean | undefined;
+    /**
+     * - 再得广告的奖励文案，用户每看完一个广告都会展示，multiton 为 true 时必填。
+     * - 文案完整内容为「再看 1 个xxx」，其中 xxx 是 multitonRewardMsg 配置的文案内容，最大长度为 7，
+     * - 文案内容根据 multitonRewardMsg 的配置按顺序展示。若 multitonRewardMsg 长度小于 multitonRewardTimes ，
+     * - 则后续的激励再得广告文案取 multitonRewardMsg 数组最后一个。
+     */
+    multitonRewardMsg?: Array<string> | undefined;
+    /**
+     * 是否开启激励再得广告
+     */
+    multiton?: boolean | undefined;
+    /**
+     * 额外观看广告的次数，合法的数据范围为 1～4，multiton 为 true 时必填
+     */
+    multitonRewardTimes?: number | undefined;
+    /**
+     * 场景值 - 自用参数，非tt API要求的参数
+     */
+    scene?: number | undefined;
+    /**
+     * 广告超时时间 单位ms - 自用参数，非tt API要求的参数
+     */
+    timeout?: number | undefined;
+    /**
+     * 重试次数 - 自用参数 ，非tt API要求的参数
+     */
+    retry: number;
+    /**
+     * 是否绑定永远的错误事件 - 自用参数，非tt API要求的参数
+     */
+    foreverErrorBind?: boolean | undefined;
+};
+export type InterstitialAdConfig = {
+    /**
+     * 单个广告单元的 id。可从「开放平台控制台-进入对应小程序-运营-商业化变现-广告管理」中获取 - 必填
+     */
+    adUnitId: string;
+    /**
+     * 场景值 - 自用参数
+     */
+    scene?: number | undefined;
+};
+export type IExeCallbackArgs = {
+    /**
+     * 广告执行场景
+     */
+    scene: number;
+    /**
+     * 是否看完
+     */
+    isEnded: boolean;
+    /**
+     * 完整观看次数
+     */
+    count: number;
+    /**
+     * 剩余观看次数
+     */
+    remain?: number;
+};
+export type CallbackCollection = {
+    /**
+     * 每次外部回调
+     */
+    always?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 完整看完广告外部回调 不管一个还是几个
+     */
+    finished?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 半途退出广告外部回调
+     */
+    halfway?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 完成广告外部回调 不管看不看完
+     */
+    complete?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 取消广告外部回调
+     */
+    onCancel?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 展示广告外部回调
+     */
+    before?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 展示广告成功外部回调
+     */
+    success?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 计时回调
+     */
+    prelude?: (ctx?: unknown) => void;
+};
+export type RecoveredInfo = {
+    /**
+     * 恢复重试次数
+     */
+    count: number;
+    /**
+     * 是否恢复重试
+     */
+    retry: boolean;
+    /**
+     * 恢复重试原因
+     */
+    message: string;
+};
+export type ICallbackArgs = {
+    /**
+     * 广告执行场景
+     */
+    scene: number;
+    /**
+     * 是否看完
+     */
+    isEnded: boolean;
+    /**
+     * 完整观看次数
+     */
+    count: number;
+    /**
+     * 剩余观看次数
+     */
+    remain?: 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;
+    /**
+     * 广告执行失败回调
+     */
+    onError?: (e: unknown) => void;
+};
+export type IConstructArgs = {
+    /**
+     * 初始化标识
+     */
+    sign: string;
+    /**
+     * 是否开启日志
+     */
+    log?: boolean | undefined;
+    /**
+     * 重试次数
+     */
+    retry: number;
+    /**
+     * 是否保留tt激励视频广告实例
+     */
+    preserveOnEnd: boolean;
+    /**
+     * 激励视频参数 (可选)
+     */
+    adConfig?: IRewordAdConfig | undefined;
+    /**
+     * 回调集合
+     */
+    collection?: IConnection | undefined;
+};
+/**
+ * 广告场景类型映射对象
+ */
+export type SceneTypeMap = {
+    readonly [x: number]: string;
+};
+/**
+ * 广告场景类型文本映射对象（反向映射）
+ */
+export type SceneTextMap = { readonly [K in SceneTypeMap[keyof SceneTypeMap]]: { [P in keyof SceneTypeMap]: SceneTypeMap[P] extends K ? P : never; }[keyof SceneTypeMap]; };
+/**
+ * 场景值枚举 可持续添加
+ */
+export type RewardAdTriggerScene = keyof SceneTextMap;
+/**
+ * 场景值枚举 可持续添加
+ */
+export type RewardAdTriggerSceneType = keyof SceneTypeMap;