@singcl/ad-execute-manager 1.0.5 → 1.0.7

package/dist/ad/RewardAdNovel.d.ts

@@ -0,0 +1,384 @@
+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;
+    _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} params
+     * @param {(v: IRewardedVideoAd) => void} [callback] 初始化成功回调
+     * @returns {this} 当前实例
+     */
+    initialize(args: any, 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 {Function} args.end 结束当前广告任务的回调函数 必填
+     */
+    _setAdTimeout(args: {
+        scene: string;
+        end: Function;
+    }): void;
+    /**
+     * 广告展示前定时器
+     * @param {object} args
+     * @param {string} args.scene 广告执行场景 必填
+     * @param {Function} args.prelude 广告展示前回调函数 可选
+     */
+    _adPreludeInterval(args: {
+        scene: string;
+        prelude: Function;
+    }): void;
+    _clearAdTimeout(): void;
+    get rewardAd(): any;
+    /**
+     * 确保广告按顺序执行
+     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {import('../typings/ad.js').CallbackCollection} [ctx.collection] 回调集合
+     *
+     * @returns {Promise.<IEndArgs & ICloseArgs | Undefined>}
+     */
+    addExecuteManager(ctx?: {
+        options?: IRewordAdConfig;
+        collection?: import("../typings/ad.js").CallbackCollection;
+    }): Promise<(IEndArgs & ICloseArgs) | undefined>;
+    /**
+     * @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>}
+     */
+    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 {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;
+        };
+        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;
+    /**
+     * 关闭激励视频
+     * @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';
+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;
+    });
+    free_incentive_frequency: number;
+    frequency: {
+        total: number;
+        current: number;
+    };
+    commonSettings: CommonSettings;
+    /**
+     *
+     * @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;
+    options(): {
+        multiton: boolean;
+        multitonRewardTimes: number;
+        multitonRewardMsg: string[];
+        progressTip: boolean;
+    } | {
+        multiton?: undefined;
+        multitonRewardTimes?: undefined;
+        multitonRewardMsg?: undefined;
+        progressTip?: undefined;
+    };
+}
+import CommonSettings from './CommonSettings';

package/dist/ad/RewardAdReadingLoad.d.ts

@@ -0,0 +1,83 @@
+export default RewardAdReadingLoad;
+export type ISysConfig = {
+    /**
+     * 再看一次配置
+     */
+    free_incentive_frequency?: number | undefined;
+    /**
+     * 自定义解锁弹窗配置
+     */
+    c_unlock_pop_enable?: number | undefined;
+    /**
+     * 返回书城激励视频每日展示次数 0 不展示 具体数量展示几次
+     */
+    read_load_times?: number | undefined;
+};
+export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
+export type IConstructArgs = import("../typings/ad.js").IConstructArgs;
+/**
+ * @typedef {import('../typings/ad.js').IRewordAdConfig} IRewordAdConfig
+ */
+/**
+ * @typedef {import('../typings/ad.js').IConstructArgs} IConstructArgs
+ */
+declare class RewardAdReadingLoad extends RewardAdNovel {
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdReadingLoad}
+     */
+    static build(args: IConstructArgs): RewardAdReadingLoad;
+    /**
+     *
+     * @returns  {RewardAdReadingLoad}
+     */
+    static getInstance(): RewardAdReadingLoad;
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdReadingLoad}
+     */
+    static "new"(args: IConstructArgs): RewardAdReadingLoad;
+    constructor(args: any);
+    loadSettings: RewardAdReadingLoadSettings;
+    /**
+     * @param {object} options
+     * @param {(con:boolean, options:object) => void} [callback]
+     */
+    satisfy(options: object, callback?: (con: boolean, options: object) => void): void | Promise<void>;
+}
+import RewardAdNovel from './RewardAdNovel';
+declare class RewardAdReadingLoadSettings {
+    /**
+     *
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     * @returns  {RewardAdReadingLoadSettings}
+     */
+    static "new"(args: {
+        sign: string;
+    }): RewardAdReadingLoadSettings;
+    frequency: {
+        total: number;
+        current: number;
+    };
+    commonSettings: CommonSettings;
+    storage: Storage;
+    _init(): void;
+    /**
+     * 获取返回广告的展示次数
+     * @returns {number} 返回广告的展示次数配置，如果没有配置则返回0
+     */
+    _adTimes(): number;
+    _safeLocalValue(v: any): any;
+    _initLocalTimes(): void;
+    _initFrequency(): void;
+    updateFrequency(): void;
+    remainFrequency(): number;
+    updateToday(): void;
+    _remain(): number;
+    condition(): boolean;
+}
+import CommonSettings from './CommonSettings';
+import Storage from './Storage';

package/dist/ad/RewardAdReadingUnload.d.ts

@@ -0,0 +1,44 @@
+export default RewardAdReadingUnload;
+export type ISysConfig = {
+    /**
+     * 再看一次配置
+     */
+    free_incentive_frequency?: number | undefined;
+    /**
+     * 自定义解锁弹窗配置
+     */
+    c_unlock_pop_enable?: number | undefined;
+    /**
+     * 返回书城激励视频每日展示次数 0 不展示 具体数量展示几次
+     */
+    read_page_back_ad?: number | undefined;
+};
+export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
+export type IConstructArgs = import("../typings/ad.js").IConstructArgs;
+/**
+ * @typedef {import('../typings/ad.js').IRewordAdConfig} IRewordAdConfig
+ */
+/**
+ * @typedef {import('../typings/ad.js').IConstructArgs} IConstructArgs
+ */
+declare class RewardAdReadingUnload extends RewardAdNovel {
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdReadingUnload}
+     */
+    static build(args: IConstructArgs): RewardAdReadingUnload;
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdReadingUnload}
+     */
+    static "new"(args: IConstructArgs): RewardAdReadingUnload;
+    /**
+     * @param {object} options
+     * @param {(con:boolean, options:object) => void} [callback]
+     */
+    static satisfy(options: object, callback?: (con: boolean, options: object) => void): void | Promise<void>;
+    constructor(args: any);
+}
+import RewardAdNovel from './RewardAdNovel';

package/dist/ad/RewardAdSceneTriggerManager.d.ts

@@ -0,0 +1,65 @@
+export default RewardAdSceneTriggerManager;
+/**
+ * 场景值枚举 可持续添加
+ */
+export type RewardAdTriggerScene = import("../typings/ad.js").RewardAdTriggerScene;
+/**
+ *  场景值枚举 可持续添加
+ * @typedef {import('../typings/ad.js').RewardAdTriggerScene} RewardAdTriggerScene
+ */
+declare class RewardAdSceneTriggerManager {
+    static instance: any;
+    /**
+     *
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     * @returns  {RewardAdSceneTriggerManager}
+     */
+    static build(args: {
+        sign: string;
+    }): RewardAdSceneTriggerManager;
+    /**
+     *
+     * @returns  {RewardAdSceneTriggerManager}
+     */
+    static getInstance(): RewardAdSceneTriggerManager;
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     */
+    constructor(args: {
+        sign: string;
+    });
+    _initSign: string;
+    /** @type {RewardAdTriggerScene} */
+    _currScene: RewardAdTriggerScene;
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     */
+    initialize(args: {
+        sign: string;
+    }): void;
+    /**
+     * 获取场景值
+     * @param {RewardAdTriggerScene} value 场景值
+     * @returns
+     */
+    addScene(value: RewardAdTriggerScene): this;
+    /**
+     * 获取场景值
+     * @param {import('../typings/ad.js').RewardAdTriggerSceneType} value 场景值类型
+     * @returns
+     */
+    addSceneType(value?: import("../typings/ad.js").RewardAdTriggerSceneType): this;
+    /**
+     *  获取当前场景值
+     * @returns
+     */
+    getCurrentScene(): "launch_ad" | "novel_plugin_strong_ad" | "novel_plugin_unlock_btn" | "novel_plugin_free_benefit_btn" | "home_free_welfare_btn" | "home_free_popup" | "other" | "home_back_show" | "novel_plugin_free_time_btn" | "launch_ad_alone";
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}

package/dist/ad/SerializableError.d.ts

@@ -0,0 +1,9 @@
+export class SerializableError extends Error {
+    constructor(message: any);
+    stack: string;
+    toJSON(): {
+        name: string;
+        message: string;
+        stack: string;
+    };
+}

package/dist/ad/Storage.d.ts

@@ -0,0 +1,98 @@
+export default Storage;
+/**
+ * @example
+const storage = new Storage({
+  prefix: 'myapp_',
+});
+
+// 设置当天有效的数据
+*storage.setItem('dailyTask', { completed: false }, 'today');
+
+// 设置普通带过期时间的数据（2小时）
+storage.setItem('tempData', { value: 123 }, 2 * 60 * 60 * 1000);
+
+// 设置永久有效的数据
+storage.setItem('userSettings', { theme: 'dark' });
+
+// 获取数据
+const dailyTask = storage.getStorageSync('dailyTask');
+const tempData = storage.getStorageSync('tempData');
+const userSettings = storage.getStorageSync('userSettings');
+
+console.log('Daily Task:', dailyTask);
+console.log('Temp Data:', tempData);
+console.log('User Settings:', userSettings);
+ */
+declare class Storage {
+    /**
+     * @param {object=} args
+     * @returns
+     */
+    static "new"(args?: object | undefined): Storage;
+    constructor(options?: {});
+    /** @type {CommonSettings | null}  */
+    _commonSettings: CommonSettings | null;
+    config: {
+        prefix: string;
+        expire: any;
+    };
+    /**
+     * 获取当天结束时间的时间戳
+     * @returns {number} 当天23:59:59的时间戳
+     */
+    getTodayEndTimestamp(): number;
+    /**
+     * 设置存储项 - 内部使用
+     * @param {string} key 存储键
+     * @param {any} value 存储值
+     * @param {number|'today'} expire 过期时间（毫秒）或'today'表示当天有效，可选
+     */
+    _setItem(storageKey: any, value: any, expire: number | "today"): void;
+    /**
+     * 获取存储项 - 内部使用
+     * @param {string} key 存储键
+     * @returns {any} 存储的值，如果过期或不存在则返回null
+     */
+    _getItem(storageKey: any): any;
+    /**
+     * 设置存储项
+     * @param {string} key 存储键
+     * @param {any} value 存储值
+     * @param {number|'today'} expire 过期时间（毫秒）或'today'表示当天有效，可选
+     */
+    setItem(key: string, value: any, expire: number | "today"): void;
+    /**
+     * 获取存储项
+     * @param {string} key 存储键
+     * @returns {any} 存储的值，如果过期或不存在则返回null
+     */
+    getItem(key: string): any;
+    /**
+     * 获取存储项 - 用户维度
+     * @param {string} key 存储键
+     * @returns {any} 存储的值，如果过期或不存在则返回null
+     */
+    getUserItem(key: string): any;
+    /**
+     * 设置存储项 - 用户维度
+     * @param {string} key 存储键
+     * @param {any} value 存储值
+     * @param {number|'today'} expire 过期时间（毫秒）或'today'表示当天有效，可选
+     */
+    setUserItem(key: string, value: any, expire: number | "today"): void;
+    /**
+     * 删除存储项
+     * @param {string} key 存储键
+     */
+    removeItem(key: string): void;
+    /**
+     * 清空所有存储项
+     */
+    clear(): void;
+    /**
+     * 获取所有未过期的存储键
+     * @returns {string[]} 键数组
+     */
+    keys(): string[];
+}
+import CommonSettings from './CommonSettings';

package/dist/ad/compose.d.ts

@@ -0,0 +1,12 @@
+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;