@ad-execute-manager/core 2.0.0-alpha.1

package/dist/core/AdExecuteManager.d.ts

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

@@ -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;

package/dist/core/index.d.ts

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

package/dist/helper/AdAnalyticsJS.d.ts

@@ -0,0 +1,132 @@
+export default AdAnalyticsJS;
+export type EventDict = {
+    [x: string]: any;
+};
+export type IConstructorArgs = {
+    /**
+     * 初始化标识
+     */
+    sign: string;
+    /**
+     * 是否需要上报
+     */
+    needReport?: boolean;
+    /**
+     * 公共用户信息
+     */
+    commonConfig?: ICommonInfo;
+};
+export type ICommonInfo = {
+    [x: string]: any;
+};
+/**
+ * @typedef {Object.<string, object>} EventDict
+ */
+/**
+ * @typedef {object} IConstructorArgs
+ * @property {string} sign 初始化标识
+ * @property {boolean} [needReport] 是否需要上报
+ * @property {ICommonInfo} [commonConfig] 公共用户信息
+ *
+ */
+/**
+ * @typedef {Object.<string, object>} ICommonInfo
+ *
+ */
+declare class AdAnalyticsJS {
+    static instance: any;
+    /**
+     *
+     * @param {IConstructorArgs} args
+     * @returns  {AdAnalyticsJS}
+     */
+    static build(args: IConstructorArgs): AdAnalyticsJS;
+    /**
+     *
+     * @returns  {AdAnalyticsJS}
+     */
+    static getInstance(): AdAnalyticsJS;
+    /**
+     *
+     * @param {IConstructorArgs} args
+     * @returns  {AdAnalyticsJS}
+     */
+    static "new"(args: IConstructorArgs): AdAnalyticsJS;
+    /**
+     * @param {IConstructorArgs} args
+     */
+    constructor(args: IConstructorArgs);
+    _initSign: string;
+    _needReport: boolean;
+    /** @type {ICommonInfo | null}  */
+    _commonConfig: ICommonInfo | null;
+    /**
+     * 初始化 比如环境配置，api地址、日志等级等
+     * @param {IConstructorArgs} args
+     */
+    initialize(args: IConstructorArgs): IConstructorArgs;
+    /**
+     * 追踪自定义事件
+     * 用户交互，如点击、提交
+     *
+     * @template {keyof EventDict} K
+     * @param {K} eventName - The name of the event to track.
+     * @param {EventDict[K]} properties - The properties associated with the event.
+     * @param {object} [debugParams] - The debug parameters.
+     * @param {string} [debugParams.sign] - Whether to enable debug mode.
+     */
+    track<K extends keyof EventDict>(eventName: K, properties: EventDict[K], debugParams?: {
+        sign?: string;
+    }): void;
+    /**
+     * 获取公共用户信息
+     * @public
+     * @returns {ICommonInfo}
+     */
+    public getCommonInfo(): ICommonInfo;
+    /**
+     * 获取埋点公共用户信息
+     * @protected
+     * @returns {ICommonInfo}
+     */
+    protected getTrackCommonInfo(): ICommonInfo;
+    /**
+     * 识别用户身份
+     * 用户登录后，关联用户信息
+     * @param {string|number} user_id - 用户id
+     * @param {ICommonInfo} info - 用户信息
+     * @returns {AdAnalyticsJS} 返回实例本身，支持链式调用
+     */
+    identify(user_id: string | number, info: ICommonInfo): AdAnalyticsJS;
+    /**
+     * 合并用户身份
+     * 匿名用户转为登录用户
+     * @returns
+     */
+    alias(): any;
+    /**
+     * 追踪页面浏览
+     * SPA 路由切换，或手动触发页面事件
+     * @returns
+     */
+    pages(): any;
+    /**
+     * 追踪页面浏览 进入页面
+     *
+     * @template {'cpage'} K
+     * @param {K} eventName - The name of the event to track.
+     * @param {EventDict[K]} properties - The properties associated with the event.
+     */
+    page<K extends "cpage">(eventName: K, properties: EventDict[K]): void;
+    /**
+     *
+     * @param {EventDict['cpage']} properties
+     * @returns
+     */
+    cpage(properties: EventDict["cpage"]): void;
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}

package/dist/helper/CountRecorder.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @typedef {object} IConstructorArgs
+ * @property {string} [sign] 初始化标识
+ * @property {string} local_sign 本地存储标识
+ * @property {number} [total] 总次数
+ * @property {number|'today'} [expire] 过期时间（毫秒）或'today'表示当天有效，可选
+ * @property {string | number} [userId] 用户ID
+ *
+ */
+export class CountRecorder {
+    /**
+     *
+     * @param {IConstructorArgs} args
+     * @returns  {CountRecorder}
+     */
+    static "new"(args: IConstructorArgs): CountRecorder;
+    /**
+     *
+     * @param {IConstructorArgs} args
+     */
+    constructor(args: IConstructorArgs);
+    _total: number;
+    _local_sign: string;
+    _expire: string;
+    storage: Storage;
+    _init(): void;
+    /**
+     * 获取次数
+     * @returns {number}  次数
+     */
+    _adTimes(): number;
+    _safeLocalValue(v: any): any;
+    _initLocalTimes(): void;
+    updateToday(): void;
+    remain(): number;
+}
+export type IConstructorArgs = {
+    /**
+     * 初始化标识
+     */
+    sign?: string;
+    /**
+     * 本地存储标识
+     */
+    local_sign: string;
+    /**
+     * 总次数
+     */
+    total?: number;
+    /**
+     * 过期时间（毫秒）或'today'表示当天有效，可选
+     */
+    expire?: number | "today";
+    /**
+     * 用户ID
+     */
+    userId?: string | number;
+};
+import Storage from './Storage';

package/dist/helper/EventEmitter.d.ts

@@ -0,0 +1,15 @@
+export class EventEmitter {
+    static geInstance(args: any): EventEmitter;
+    constructor(options?: {});
+    events: {};
+    queues: {};
+    onceEvents: {};
+    maxListeners: any;
+    maxQueueSize: any;
+    maxOnceEvents: any;
+    on(event: any, listener: any): void;
+    once(event: any, listener: any): void;
+    emit(event: any, ...args: any[]): void;
+    off(event: any, listenerToRemove: any): void;
+    removeAllListeners(event: any): void;
+}

package/dist/helper/Logger.d.ts

@@ -0,0 +1,35 @@
+export class Logger {
+    /**
+     *
+     * @param {object} [options]
+     * @param {string} [options.prefix] - 日志前缀
+     * @param {'error'|'warn'|'info'|'log'|'debug'} [options.level] - 日志级别
+     * @param {boolean} [options.enabled] - 是否启用日志
+     */
+    constructor(options?: {
+        prefix?: string;
+        level?: "error" | "warn" | "info" | "log" | "debug";
+        enabled?: boolean;
+    });
+    prefix: string;
+    enabled: boolean;
+    levels: {
+        error: number;
+        warn: number;
+        info: number;
+        log: number;
+        debug: number;
+    };
+    currentLevel: number;
+    enable(): void;
+    disable(): void;
+    isEnabled(): boolean;
+    setLevel(level: any): void;
+    formatMessage(level: any, message: any): string;
+    _log(level: any, message: any, ...args: any[]): void;
+    error(message: any, ...args: any[]): void;
+    warn(message: any, ...args: any[]): void;
+    info(message: any, ...args: any[]): void;
+    log(message: any, ...args: any[]): void;
+    debug(message: any, ...args: any[]): void;
+}

package/dist/helper/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/helper/PubSub.d.ts

@@ -0,0 +1,9 @@
+export default class EventEmitter {
+    events: {};
+    on(eventName: any, callback: any): () => void;
+    off(eventName: any, callback: any): void;
+    emit(eventName: any, ...args: any[]): void;
+    once(eventName: any, callback: any): void;
+    listenerCount(eventName: any): any;
+    removeAllListeners(): void;
+}