@singcl/ad-execute-manager 1.0.4 → 1.0.6

package/dist/ad/LovelUnlockManager.d.ts

@@ -0,0 +1,233 @@
+export default LovelUnlockManager;
+export type InitSign = "bookStore" | "reader" | "bookIntro";
+/**
+ * @typedef {'bookStore'|'reader'|'bookIntro'} InitSign
+ */
+declare class LovelUnlockManager {
+    static instance: any;
+    /**
+     * @static
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @param {number} args.unlockChapterThreshold 单次解锁章节阈值
+     * @param {number} args.unlockChapterNum 解锁章节数
+     * @param {number} args.unlockChapterWaterLevel 解锁章节水滴阈值
+     */
+    static build(args: {
+        sign: InitSign;
+        unlockChapterThreshold: number;
+        unlockChapterNum: number;
+        unlockChapterWaterLevel: number;
+    }): any;
+    /**
+     * @static
+     * @returns  {LovelUnlockManager}
+     */
+    static getInstance(): LovelUnlockManager;
+    /**
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @param {number} args.unlockChapterThreshold 单次解锁章节阈值
+     * @param {number} args.unlockChapterNum 解锁章节数
+     * @param {number} args.unlockChapterWaterLevel 解锁章节水滴阈值
+     */
+    static "new"(args: {
+        sign: InitSign;
+        unlockChapterThreshold: number;
+        unlockChapterNum: number;
+        unlockChapterWaterLevel: number;
+    }): LovelUnlockManager;
+    /**
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @param {number} args.unlockChapterThreshold 单次解锁章节阈值
+     * @param {number} args.unlockChapterNum 解锁章节数
+     * @param {number} args.unlockChapterWaterLevel 解锁章节水滴阈值
+     */
+    constructor(args: {
+        sign: InitSign;
+        unlockChapterThreshold: number;
+        unlockChapterNum: number;
+        unlockChapterWaterLevel: number;
+    });
+    /**
+     * 初始化标识 'bookStore' | 'reader' | 'bookIntro'
+     * @access private
+     */
+    _initSign: string;
+    /**
+     * 剧情详情数据
+     * @access private
+     * @type {Array.<DramaDetailRecord>}
+     */
+    _dramaDetailData: Array<{
+        /**
+         * 章节id
+         */
+        episodeId: string;
+        /**
+         * 1 已解锁 0 未解锁 null 未解锁
+         */
+        flagTag: number | null;
+        /**
+         * 章节名称
+         */
+        albumId: string;
+    }>;
+    /**
+     * 单次解锁章节阈值
+     * @access private
+     */
+    _unlockChapterThreshold: number;
+    /**
+     * 解锁章节数
+     * @access private
+     */
+    _unlockChapterNum: number;
+    /**
+     *  解锁章节水滴阈值
+     * @access private
+     */
+    _unlockChapterWaterLevel: number;
+    /**
+     * 是否达到阈值
+     * @access private
+     */
+    _isReachThreshold: boolean;
+    /**
+     * 已经解锁的章节id数组
+     * @access private
+     * @type {Array.<string>}
+     */
+    _unlockedIdArr: Array<string>;
+    /**
+     * 设置剧情详情数据
+     * @param {Array.<DramaDetailRecord>} value 剧情详情数据
+     */
+    set drama(value: Array<{
+        /**
+         * 章节id
+         */
+        episodeId: string;
+        /**
+         * 1 已解锁 0 未解锁 null 未解锁
+         */
+        flagTag: number | null;
+        /**
+         * 章节名称
+         */
+        albumId: string;
+    }>);
+    /**
+     * @typedef {object} DramaDetailRecord
+     * @property {string} episodeId 章节id
+     * @property {number | null} flagTag 1 已解锁 0 未解锁 null 未解锁
+     * @property {string} albumId 章节名称
+     */
+    /**
+     * 获取剧情详情数据
+     * @returns {Array.<DramaDetailRecord>} 剧情详情数据
+     */
+    get drama(): Array<{
+        /**
+         * 章节id
+         */
+        episodeId: string;
+        /**
+         * 1 已解锁 0 未解锁 null 未解锁
+         */
+        flagTag: number | null;
+        /**
+         * 章节名称
+         */
+        albumId: string;
+    }>;
+    /**
+     * 设置是否达到阈值
+     * @access private
+     * @param {Array.<DramaDetailRecord>} value 剧情详情数据
+     */
+    _checkReachThreshold(v?: any[]): void;
+    /**
+     * 判断达到阈值
+     * @access private
+     * @returns
+     */
+    _isUnlockThreshold(): boolean;
+    /**
+     * 从指定chapterId开始解锁指定数量的章节，前后章节数量相等
+     * @access private
+     * @param {string} chapterId  章节id
+     * @param {number} count  解锁章节数量
+     * @returns {Array.<string>} 解锁的章节id数组
+     */
+    _unlockChapterIds(chapterId: string, count?: number): Array<string>;
+    /**
+     * 从指定chapterId开始解锁指定数量的章节，增加水位
+     * @access private
+     * @param {string} chapterId  章节id
+     * @param {number} count  解锁章节数量
+     * @returns {Array.<string> | undefined} 解锁的章节id数组
+     */
+    _unlockChapterIdsWithWater(chapterId: string, count?: number): Array<string> | undefined;
+    /**
+     * 判断是否达到解锁阈值,走不同的逻辑
+     * @access public
+     * @param {() => void} callback 原逻辑【达到阈值前】回调函数
+     * @param {(ids: Array.<string>) => void} [callbackThreshold]  新逻辑【达到阈值后】回调函数
+     * @param {string} [chapterId] 章节id
+     */
+    ready(callback: () => void, callbackThreshold?: (ids: Array<string>) => void, chapterId?: string): void;
+    /**
+     * @typedef {object} ProcessUpdateResult
+     * @property {string} chapterId 章节id
+     * @property {number} percent 当前章节的阅读进度
+     */
+    /**
+     * 章节阅读进度更新
+     * @access public
+     * @param {ProcessUpdateResult} r 当前章节的阅读进度
+     * @param {(ids: Array.<string>) => void} callback 达到阈值后回调函数
+     */
+    onProcessUpdate(r: {
+        /**
+         * 章节id
+         */
+        chapterId: string;
+        /**
+         * 当前章节的阅读进度
+         */
+        percent: number;
+    }, callback: (ids: Array<string>) => void): void;
+    /**
+     * @typedef {object} ChapterChangeResult
+     * @property {string} currentChapterId 变化前的章节ID
+     * @property {string} nextChapterId 变化后的章节ID
+     * @property {string} [nextOutChapterId] 开发者自己的章节ID
+     */
+    /**
+     * 章节变化
+     * @access public
+     * @param {ChapterChangeResult} r 当前章节的阅读进度
+     * @param {(ids: Array.<string>) => void} callback 达到阈值后回调函数
+     */
+    onChapterChange(r: {
+        /**
+         * 变化前的章节ID
+         */
+        currentChapterId: string;
+        /**
+         * 变化后的章节ID
+         */
+        nextChapterId: string;
+        /**
+         * 开发者自己的章节ID
+         */
+        nextOutChapterId?: string;
+    }, callback: (ids: Array<string>) => void): void;
+    /**
+     * 解锁所有章节
+     * @access public
+     */
+    unlockAll(): void;
+}

package/dist/ad/RewardAdFather.d.ts

@@ -0,0 +1,123 @@
+export default RewardAdFather;
+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 IRewardedVideoAd = {
+    /**
+     * 显示激励视频广告
+     */
+    show: () => Promise<void>;
+};
+/**
+ * @typedef IRewardedVideoAd
+ * @property {() => Promise.<void>} show 显示激励视频广告
+ */
+declare class RewardAdFather {
+    /** @type {IRewordAdConfig | null} */
+    static args: IRewordAdConfig | null;
+    /**
+     * @param {IRewordAdConfig} args
+     */
+    static buildArgs(args: IRewordAdConfig): void;
+    /**
+     * 使用管理器执行广告
+     * @param {Object} adInstance 广告实例
+     * @param {Object} ctx 上下文对象，用于传递数据和状态
+     * @param {Object} ctx.options 广告执行选项
+     * @param {Object} ctx.options.log 是否打印日志
+     * @param {Object} ctx.collection 回调集合
+     * @returns {Promise} 广告执行结果的Promise
+     */
+    static executeWithManager(adInstance: any, ctx: {
+        options: {
+            log: any;
+        };
+        collection: any;
+    }): Promise<any>;
+    /**
+     * @param {IConstructArgs} args
+     */
+    constructor(args: IConstructArgs);
+    _initSign: string;
+    _preserveOnEnd: boolean;
+    _rewardAd: any;
+    _ttErrorMsgs: string[];
+    _ttErrorCodes: number[];
+    _adConfig: {};
+    /**
+     * 初始化
+     * 子类可以选择覆盖此方法，或使用默认实现
+     * @param {IRewordAdConfig} params
+     * @param {(v: IRewardedVideoAd) => void} [callback] 初始化成功回调
+     * @returns {this} 当前实例
+     */
+    initialize(params: IRewordAdConfig, callback?: (v: IRewardedVideoAd) => void): this;
+    initialized(): boolean;
+    /**
+     * 执行广告展示
+     * @abstract
+     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {CallbackCollection} [ctx.collection] 回调集合
+     * @param {Function} next 执行下一个任务的回调函数，在洋葱模型中手动调用以继续执行流程
+     * @returns {Promise<unknown>} 广告执行结果的Promise
+     * @throws {Error} 子类必须实现此方法
+     */
+    ad(ctx?: {
+        options?: IRewordAdConfig;
+        collection?: CallbackCollection;
+    }, next?: Function): Promise<unknown>;
+    /**
+     * 确保广告按顺序执行
+     * @template T
+     * @param {T} value - 泛型参数
+     * @param {Object} [ctx] 上下文对象，用于传递数据和状态
+     * @param {IRewordAdConfig} [ctx.options] 广告执行选项
+     * @param {CallbackCollection} [ctx.collection] 回调集合
+     * @returns {Promise.<T>} 广告执行结果的Promise
+     */
+    addExecuteManager<T>(ctx?: {
+        options?: IRewordAdConfig;
+        collection?: CallbackCollection;
+    }): Promise<T>;
+    destroy(): void;
+    clear(): void;
+    /**
+     *
+     * @param {({isEnded: boolean, count: number}) => void} callback
+     */
+    onClose(callback: ({ isEnded: boolean, count: number }: any) => void): void;
+    /**
+     *
+     * @param {({isEnded: boolean, count: number}) => void} callback
+     */
+    offClose(callback: ({ isEnded: boolean, count: number }: any) => void): void;
+    /**
+     * show
+     * @returns { Promise.<void>}
+     * @params {{errMsg: string; errCode: number}} err
+     */
+    show(): Promise<void>;
+    /**
+     * show
+     * @returns { Promise.<void>}
+     */
+    load(): Promise<void>;
+    /**
+     *
+     * @param {({errMsg: string; errCode: number}) => void} callback
+     */
+    onError(callback: any): void;
+    /**
+     *
+     * @param {({errMsg: string; errCode: number}) => void} callback
+     */
+    offError(callback: any): void;
+    onLoad(callback: any): void;
+    offLoad(callback: any): void;
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}

package/dist/ad/RewardAdGlobalRecorder.d.ts

@@ -0,0 +1,111 @@
+export default RewardAdGlobalRecorder;
+export type RecordType = "halfway" | "finished" | "completed";
+/**
+ * @typedef {'halfway' | 'finished' | 'completed'} RecordType
+ */
+declare class RewardAdGlobalRecorder {
+    static instance: any;
+    /**
+     *
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @returns  {RewardAdGlobalRecorder}
+     */
+    static build(args: {
+        sign: InitSign;
+    }): RewardAdGlobalRecorder;
+    /**
+     *
+     * @returns  {RewardAdGlobalRecorder}
+     */
+    static getInstance(): RewardAdGlobalRecorder;
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     */
+    constructor(args: {
+        sign: string;
+    });
+    _initSign: string;
+    _halfway: {
+        scene: 6;
+        count: number;
+    }[];
+    _finished: {
+        scene: 6;
+        count: number;
+    }[];
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     */
+    initialize(args: {
+        sign: string;
+    }): void;
+    /**
+     * 找到相同的场景值，如果没有则新增
+     * @param {object} args
+     * @param {RecordType} args.type
+     * @param {number} args.scene
+     */
+    _halfwayUpdate(args: {
+        type: RecordType;
+        scene: number;
+    }): void;
+    /**
+     * @param {object} args
+     * @param {number[]} args.scenes
+     * @returns
+     */
+    _halfwayGet(args: {
+        scenes: number[];
+    }): number;
+    _halfwayReset(): void;
+    /**
+     * 找到相同的场景值，如果没有则新增
+     * @param {object} args
+     * @param {RecordType} args.type
+     * @param {number} args.scene
+     */
+    _finishedUpdate(args: {
+        type: RecordType;
+        scene: number;
+    }): void;
+    /**
+     * @param {object} args
+     * @param {number[]} args.scenes
+     * @returns
+     */
+    _finishedGet(args: {
+        scenes: number[];
+    }): number;
+    _finishedReset(): void;
+    /**
+     * @param {object} args
+     * @param {RecordType} args.type
+     * @param {number} args.scene
+     */
+    record(args: {
+        type: RecordType;
+        scene: number;
+    }): void;
+    /**
+     *
+     * @param {RecordType} type
+     */
+    rest(type: RecordType): void;
+    /**
+     * @param {object} args
+     * @param {number[]} [args.scenes]
+     * @param {RecordType} args.type
+     */
+    get(args: {
+        scenes?: number[];
+        type: RecordType;
+    }): number;
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}

package/dist/ad/RewardAdLaunch.d.ts

@@ -0,0 +1,87 @@
+export default RewardAdLaunch;
+export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
+/**
+ * @typedef {import('../typings/ad.js').IRewordAdConfig} IRewordAdConfig
+ */
+declare class RewardAdLaunch extends RewardAdNovel {
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdLaunch}
+     */
+    static build(args: IConstructArgs): RewardAdLaunch;
+    /**
+     *
+     * @returns  {RewardAdLaunch}
+     */
+    static getInstance(): RewardAdLaunch;
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdLaunch}
+     */
+    static "new"(args: IConstructArgs): RewardAdLaunch;
+    /**
+     *
+     * @type  {Promise.<unknown>}
+     */
+    static ad: Promise<unknown>;
+    /**
+     *
+     * @param {object} options 启动参数
+     * @param {string} options.path 启动路径
+     * @param {object} options.query 启动参数
+     * @param {string} options.query.promotionid 推广参数
+     * @param {(args: { options: object } | null) => Promise.<void>} callback 回调
+     * @returns
+     */
+    static satisfy(options: {
+        path: string;
+        query: {
+            promotionid: string;
+        };
+    }, callback: (args: {
+        options: object;
+    } | null) => Promise<void>): Promise<void>;
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     */
+    constructor(args: {
+        sign: string;
+    });
+    _scene: 0;
+    launchSettings: RewardAdLaunchSettings;
+}
+import RewardAdNovel from './RewardAdNovel';
+declare class RewardAdLaunchSettings {
+    /**
+     *
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @returns  {RewardAdLaunchSettings}
+     */
+    static "new"(args: {
+        sign: InitSign;
+    }): RewardAdLaunchSettings;
+    _fixedFrequency: any;
+    frequency: {
+        total: number;
+        current: number;
+    };
+    commonSettings: CommonSettings;
+    countRecorder: CountRecorder;
+    /**
+     * 获取启动广告的展示次数
+     * @returns {number} 启动广告的展示次数配置，如果没有配置则返回0
+     */
+    _adTimes(): number;
+    updateToday(): void;
+    updateFrequency(): void;
+    remainFrequency(): number;
+    timesPerFrequency(): number;
+    _remain(): number;
+    condition(): boolean;
+}
+import CommonSettings from './CommonSettings';
+import { CountRecorder } from './CountRecorder';

package/dist/ad/RewardAdLaunchAlone.d.ts

@@ -0,0 +1,59 @@
+export default RewardAdLaunchAlone;
+export type IRewordAdConfig = import("../typings/ad.js").IRewordAdConfig;
+export type CallbackCollection = import("../typings/ad.js").CallbackCollection;
+/**
+ * @typedef {import('../typings/ad.js').IRewordAdConfig} IRewordAdConfig
+ */
+/**
+ * @typedef {import('../typings/ad.js').CallbackCollection} CallbackCollection
+ */
+declare class RewardAdLaunchAlone extends RewardAdNovel {
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdLaunchAlone}
+     */
+    static build(args: IConstructArgs): RewardAdLaunchAlone;
+    /**
+     *
+     * @returns  {RewardAdLaunchAlone}
+     */
+    static getInstance(): RewardAdLaunchAlone;
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdLaunchAlone}
+     */
+    static "new"(args: IConstructArgs): RewardAdLaunchAlone;
+    /**
+     *
+     * @type  {Promise.<unknown>}
+     */
+    static ad: Promise<unknown>;
+    /**
+     *
+     * @param {object} options 启动参数
+     * @param {string} options.path 启动路径
+     * @param {object} options.query 启动参数
+     * @param {string} options.query.promotionid 推广参数
+     * @param {() => Promise.<void>} callback 回调
+     * @returns
+     */
+    static satisfy(options: {
+        path: string;
+        query: {
+            promotionid: string;
+        };
+    }, callback: () => Promise<void>): Promise<void>;
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     * @param {IRewordAdConfig=} args.adConfig 激励视频参数 (可选)
+     */
+    constructor(args: {
+        sign: string;
+        adConfig?: IRewordAdConfig | undefined;
+    });
+    _scene: 9;
+}
+import RewardAdNovel from './RewardAdNovel';