@ad-execute-manager/helper 2.0.0-alpha.1 → 2.0.0-alpha.2

package/dist/ad/RewardAdNovel.d.ts

@@ -1,464 +0,0 @@
-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;
-    /**
-     * 是否保留tt激励视频广告实例
-     */
-    preserveOnEnd?: boolean;
-    /**
-     * 是否需要在超时情况下结束广告
-     */
-    needEndOnTimeout?: boolean;
-    /**
-     * 激励视频参数 (可选)
-     */
-    adConfig?: IRewordAdConfig | undefined;
-    /**
-     * 回调集合
-     */
-    collection?: IConnection | undefined;
-};
-export type ICloseArgs = {
-    /**
-     * 是否看完
-     */
-    isEnded: boolean;
-    /**
-     * 完整观看次数
-     */
-    count: number;
-};
-export type IEndArgs = {
-    /**
-     * 是否解锁全部
-     */
-    can_unlock_all?: boolean;
-    /**
-     * 是否解锁小说
-     */
-    can_unlock_novel?: boolean;
-    /**
-     * 剩余次数
-     */
-    remain?: number;
-    /**
-     * 结束类型
-     */
-    end_type?: "halfway" | "finished";
-};
-export type IRewardedVideoAd = {
-    /**
-     * 显示激励视频广告
-     */
-    show: () => Promise<void>;
-};
-/**
- * @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} [preserveOnEnd] 是否保留tt激励视频广告实例
- * @property {boolean} [needEndOnTimeout] 是否需要在超时情况下结束广告
- * @property {IRewordAdConfig=} [adConfig] 激励视频参数 (可选)
- * @property {IConnection=} [collection] 回调集合
- */
-/**
- * @typedef ICloseArgs
- * @property {boolean} isEnded 是否看完
- * @property {number} count 完整观看次数
- */
-/**
- * @typedef IEndArgs
- * @property {boolean} [can_unlock_all] 是否解锁全部
- * @property {boolean} [can_unlock_novel] 是否解锁小说
- * @property {number} [remain] 剩余次数
- * @property {'halfway' | 'finished'} [end_type] 结束类型
- *
- */
-/**
- * @typedef IRewardedVideoAd
- * @property {() => Promise.<void>} show 显示激励视频广告
- */
-declare class RewardAdNovel extends RewardAdFather {
-    /**
-     *
-     * @param {IConstructArgs} args
-     * @returns  {RewardAdNovel}
-     */
-    static build(args: IConstructArgs): RewardAdNovel;
-    /**
-     *
-     * @returns  {RewardAdNovel}
-     */
-    static getInstance(): RewardAdNovel;
-    /**
-     *
-     * @param {IConstructArgs} args
-     * @returns  {RewardAdNovel}
-     */
-    static "new"(args: IConstructArgs): RewardAdNovel;
-    /**
-     * @param {IConstructArgs} args
-     *
-     */
-    constructor(args: IConstructArgs);
-    _onHalfway: any;
-    _onShow: any;
-    _onFinish: any;
-    _onAlways: any;
-    _onError: any;
-    _alwaysCallback: any;
-    _halfwayCallback: any;
-    _finishedCallback: any;
-    _resolve: any;
-    _next: any;
-    /** @type {number} 广告执行场景 */
-    _scene: number;
-    _adTypeR: 1;
-    _adTimeout: any;
-    _adTimeoutTime: number;
-    _adBeforeShowTimer: any;
-    _adBeforeShowTime: number;
-    _adSpeedCloseTimer: any;
-    _adSpeedCloseTime: number;
-    _needEndOnTimeout: boolean;
-    /** @deprecated TODO 移除 */
-    _needSpeedEndOnTimeout: boolean;
-    bindAdCloseLister: any;
-    bindAdErrorLister: any;
-    bindAdLoadLister: any;
-    bindApiAdErrorLister: any;
-    _bindShiftCloseLister: any;
-    _bindShiftErrorLister: any;
-    /**
-     * 初始化
-     * 子类可以选择覆盖此方法，或使用默认实现
-     * @param {IRewordAdConfig} args
-     * @param {(v: IRewardedVideoAd) => void} [callback] 初始化成功回调
-     * @returns {this} 当前实例
-     */
-    initialize(args: IRewordAdConfig, callback?: (v: IRewardedVideoAd) => void): this;
-    _initAdLister(): void;
-    /**
-     * @param {object} args
-     * @param {number} [args.retry] 重试次数
-     */
-    _initNovelConfig(args: {
-        retry?: number;
-    }): void;
-    novelConfig: RewardAdNovelConfig;
-    _onInnerExecuteBefore(): any;
-    _onInnerAdShowSuccess(): any;
-    /**
-     * 广告展示超时设置
-     * @param {object} args
-     * @param {string} args.scene 广告执行场景 必填
-     * @param {number} [args.timeout] 广告超时时间 单位ms
-     * @param {Function} args.end 结束当前广告任务的回调函数 必填
-     */
-    _setAdTimeout(args: {
-        scene: string;
-        timeout?: number;
-        end: Function;
-    }): void;
-    /**
-     * 广告展示前定时器
-     * @param {object} args
-     * @param {string} args.scene 广告执行场景 必填
-     * @param {Function} args.prelude 广告展示前回调函数 可选
-     */
-    _adPreludeInterval(args: {
-        scene: string;
-        prelude: Function;
-    }): void;
-    _clearAdTimeout(): void;
-    /**
-     * 广告展示成功前分析
-     * 子类需要埋点可以选择覆盖此方法
-     * @protected
-     * @param {object} _args
-     * @param {string} _args.scene 广告执行场景 必填
-     * @returns
-     */
-    protected _adShowBeforeAnalytics(_args: {
-        scene: string;
-    }): any;
-    /**
-     * 广告展示成功分析
-     * 子类需要埋点可以选择覆盖此方法
-     * @protected
-     * @param {object} _args
-     * @param {string} _args.scene 广告执行场景 必填
-     * @param {string} [_args.msg] 广告执行成功原因
-     * @param {0|1} _args.result 广告执行成功结果
-     * @returns
-     */
-    protected _adShowSuccessAnalytics(_args: {
-        scene: string;
-        msg?: string;
-        result: 0 | 1;
-    }): any;
-    /**
-     * 广告展示失败分析
-     * 子类需要埋点可以选择覆盖此方法
-     * @protected
-     * @param {object} _args
-     * @param {string} _args.scene 广告执行场景 必填
-     * @param {string} _args.msg 广告执行失败原因 必填
-     * @param {number} _args.errorCode 广告执行失败错误码 必填
-     * @param {0|1} _args.result 广告执行失败结果
-     * @returns
-     */
-    protected _adShowFailureAnalytics(_args: {
-        scene: string;
-        msg: string;
-        errorCode: number;
-        result: 0 | 1;
-    }): any;
-    /**
-     * 广告加载成功分析
-     * 子类需要埋点可以选择覆盖此方法
-     * @protected
-     * @param {object} _args
-     * @param {string} _args.scene 广告执行场景 必填
-     * @param {string} [_args.msg] 广告执行成功原因
-     * @param {0|1} _args.result 广告执行成功结果
-     * @returns
-     */
-    protected _adLoadSuccessAnalytics(_args: {
-        scene: string;
-        msg?: string;
-        result: 0 | 1;
-    }): any;
-    /**
-     * 广告加载失败分析
-     * 子类需要埋点可以选择覆盖此方法
-     * @protected
-     * @param {object} _args
-     * @param {string} _args.scene 广告执行场景 必填
-     * @param {string} _args.msg 广告执行失败原因 必填
-     * @param {0|1} _args.result 广告执行失败结果
-     * @returns
-     */
-    protected _adLoadFailureAnalytics(_args: {
-        scene: string;
-        msg: string;
-        result: 0 | 1;
-    }): any;
-    /**
-     * 广告关闭成功分析
-     * 子类需要埋点可以选择覆盖此方法
-     * @protected
-     * @param {object} _args
-     * @param {string} _args.scene 广告执行场景 必填
-     * @param {number} _args.ad_is_completed 广告是否完成 必填
-     * @param {number} _args.ad_count 广告执行次数 必填
-     * @returns
-     */
-    protected _adCloseSuccessAnalytics(_args: {
-        scene: string;
-        ad_is_completed: number;
-        ad_count: number;
-    }): any;
-    get rewardAd(): any;
-    /**
-     * 确保广告按顺序执行
-     * @override
-     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
-     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
-     * @param {import('../typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
-     * @returns {Promise.<IEndArgs & ICloseArgs | Undefined>}
-     */
-    override addExecuteManager(ctx?: {
-        options?: IRewordAdConfig;
-        collection?: import("../typings/ad.js").CallbackCollection;
-    }): Promise<(IEndArgs & ICloseArgs) | undefined>;
-    /**
-     * @override
-     * @param {object} [ctx] 广告执行上下文
-     * @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;
-    }, next?: Function): Promise<(IEndArgs & ICloseArgs) | undefined>;
-    /**
-     * @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.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 {Function} next 执行下一个任务的回调函数，手动调用以继续执行流程
-     */
-    _adInner(ctx?: {
-        options?: {
-            scene?: number;
-            timeout?: number;
-        };
-        collection: {
-            resolve: (v?: unknown) => void;
-            reject?: (v?: unknown) => void;
-            before?: (v?: unknown) => void;
-            success?: (v?: unknown) => void;
-            prelude?: (v?: unknown) => void;
-        };
-    }, next?: Function): void;
-    _before: (v?: unknown) => void;
-    _success: (v?: unknown) => void;
-    /**
-     * 广告加载
-     * @returns
-     */
-    adLoad(): Promise<void>;
-    /**
-     * 广告展示
-     * @returns
-     */
-    adShow(): Promise<void>;
-    _outerCloseCallback(args: any): void;
-    _outerHalfwayCallback(args: any): void;
-    _outerFinishedCallback(args: any): void;
-    /**
-     * 关闭激励视频
-     * 子类重写该方法时，必须调用this._clearAdTimeout();清除超时定时器
-     * @param {ICloseArgs} args
-     */
-    adCloseLister(args: ICloseArgs): void;
-    adErrorLister(e: any): void;
-    apiAdErrorLister(e: any): void;
-    /**
-     * 激励视频广告组件**成功**拉取广告素材时会触发
-     * 创建激励时候后会自动拉取广告素材，如果广告拉取成功，也会触发此事件，不管是否调用show方法
-     * @param {unknown} e
-     */
-    adLoadLister(e: unknown): void;
-    adDestroy(): void;
-    _shiftCloseLister(args: any): void;
-    _shiftErrorLister(args: any): void;
-    /**
-     * 手动出栈
-     */
-    shift(): void;
-}
-import RewardAdFather from './RewardAdFather.js';
-declare class RewardAdNovelConfig {
-    /**
-     *
-     * @param {object} args
-     * @param {string} args.sign 初始化标识
-     * @param {number} [args.retry] 重试次数
-     * @returns  {RewardAdNovelConfig}
-     */
-    static "new"(args: {
-        sign: string;
-        retry?: number;
-    }): RewardAdNovelConfig;
-    /**
-     *
-     * @param {object} [args]
-     * @param {number} [args.retry]
-     */
-    constructor(args?: {
-        retry?: number;
-    });
-    frequency: {
-        total: number;
-        current: number;
-    };
-    /**
-     *
-     * @param {object} [args]
-     * @param {number} [args.retry]
-     */
-    _init(args?: {
-        retry?: number;
-    }): void;
-    /**
-     *
-     * @param {object} [args]
-     * @param {number} [args.retry]
-     */
-    _adTimes(args?: {
-        retry?: number;
-    }): void;
-    reset(): void;
-    updateRetry(): void;
-    remain(): number;
-}

package/dist/ad/index.d.ts

@@ -1,4 +0,0 @@
-export { default as RewardAdFather } from "./RewardAdFather.js";
-export { default as RewardAdNovel } from "./RewardAdNovel.js";
-export { default as InterstitialAdFather } from "./InterstitialAdFather.js";
-export { default as InterstitialAdNovel } from "./InterstitialAdNovel.js";

package/dist/const/const.d.ts

@@ -1,20 +0,0 @@
-/**
- * 广告场景类型映射对象
- * @type {import('../typings/ad.js').SceneTypeMap}
- */
-export const DEFAULT_SCENT_TYPE_OBJ: import("../typings/ad.js").SceneTypeMap;
-/**
- * 广告场景文本映射对象
- * @type {import('../typings/ad.js').SceneTextMap}
- */
-export const DEFAULT_SCENT_TEXT_OBJ: import("../typings/ad.js").SceneTextMap;
-/**
- * 用户类型文本映射对象（反向映射）
- * @type {import('../typings/common.js').IAdType}
- */
-export const AD_TYPE_ENUM: import("../typings/common.js").IAdType;
-/**
- * 广告类型文本映射对象（反向映射）
- * @type {import('../typings/common.js').IAdTypeReverse}
- */
-export const AD_TYPE_ENUM_REVERSE: import("../typings/common.js").IAdTypeReverse;

package/dist/core/AdExecuteManager.d.ts

@@ -1,129 +0,0 @@
-export default AdExecuteManager;
-export type AdTask = {
-    /**
-     * RewardAdFather的子类实例
-     */
-    adInstance: import("../ad/RewardAdFather.js").default;
-    /**
-     * 广告执行选项
-     */
-    options: import("../typings/ad.js").IRewordAdConfig;
-    /**
-     * 回调集合
-     */
-    callbackCollection: import("../typings/ad.js").CallbackCollection;
-    /**
-     * 广告执行成功的回调函数
-     */
-    resolve: Function;
-    /**
-     * 广告执行失败的回调函数
-     */
-    reject: Function;
-    /**
-     * 广告任务的唯一标识符
-     */
-    id: string;
-    /**
-     * 广告任务是否已成功解决
-     */
-    _isResolved: boolean;
-    /**
-     * 广告任务是否已被拒绝
-     */
-    _isRejected: boolean;
-};
-export type IConstructArgs = {
-    /**
-     * 广告执行选项
-     */
-    options?: object;
-    /**
-     * 是否打印日志
-     */
-    log?: boolean;
-};
-declare class AdExecuteManager {
-    /**
-     * 单例实例
-     * @type {AdExecuteManager|null}
-     */
-    static _instance: AdExecuteManager | null;
-    /**
-     * 获取单例实例
-     * @param {IConstructArgs} [args]
-     * @returns {AdExecuteManager}
-     */
-    static getInstance(args?: IConstructArgs): AdExecuteManager;
-    /**
-     * 获取单例实例
-     * @returns {AdExecuteManager}
-     */
-    static getSafeInstance(): AdExecuteManager;
-    /**
-     *
-     * @param {IConstructArgs} args
-     * @returns
-     */
-    constructor(args: IConstructArgs);
-    /**
-     * @type {Array.<AdTask>}
-     */
-    _taskStack: Array<AdTask>;
-    /**
-     * @type {Array.<AdTask>}
-     */
-    _currentBatchTasks: Array<AdTask>;
-    /**
-     * @type {boolean}
-     */
-    _isRunning: boolean;
-    /**
-     * @type {AdTask|null}
-     */
-    _currentTask: AdTask | null;
-    logger: Logger;
-    /**
-     * 添加广告任务
-     * @param {import('../ad/RewardAdFather.js').default} adInstance RewardAdFather的子类实例
-     * @param {Object} ctx 广告执行上下文
-     * @param {import('../typings/ad.js').IRewordAdConfig} ctx.options 广告执行选项
-     * @param {import('../typings/ad.js').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;
-    }): Promise<any>;
-    /**
-     * 组合所有任务
-     * @private
-     */
-    private _compose;
-    /**
-     * 清空任务栈并取消所有任务（包括正在执行的任务和middleware链中等待执行的任务）
-     */
-    clearTasks(): void;
-    /**
-     * 获取当前未完成的任务总数
-     * 包括任务栈中待执行的任务和中间件链中未完成的任务
-     * @returns {number} 未完成的任务数量
-     */
-    getTaskCount(): number;
-    /**
-     * 是否有任务正在运行
-     * @returns {boolean}
-     */
-    isRunning(): boolean;
-    /**
-     * 获取当前执行的任务ID
-     * @returns {string|null} 当前任务ID
-     */
-    getCurrentTaskId(): string | null;
-    /**
-     * 返回一个Promise，当任务队列中的所有任务都完成时resolve
-     * @returns {Promise<void>} 当所有任务完成时resolve的Promise
-     */
-    whenAllTasksComplete(): Promise<void>;
-}
-import { Logger } from '../helper/Logger';

package/dist/core/compose.d.ts

@@ -1,12 +0,0 @@
-export default compose;
-/**
- * Koa中间件核心处理机制
- * @see https://github.com/singcl/koa/blob/master/src/compose-es7.js
- * @param {Array.<Function>} middlewares KOA中间件数组，每个中间件函数接收ctx和next参数
- * @returns {Function} 返回一个组合后的中间件函数，接收ctx参数并按顺序执行所有中间件
- * @version 0.0.1
- * @since 0.0.1
- * @author singcl 24661881@qq.com
- * @description 将多个中间件函数组合成一个单一的中间件函数，形成洋葱模型的调用链
- */
-declare function compose(middlewares: Array<Function>): Function;

package/dist/core/index.d.ts

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