@singcl/ad-execute-manager 1.0.5 → 1.0.6

package/dist/ad/AdExecuteManager.d.ts

@@ -0,0 +1,115 @@
+export default AdExecuteManager;
+export type AdTask = {
+    /**
+     * RewardAdFather的子类实例
+     */
+    adInstance: import("./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 {
+    static _instance: any;
+    /**
+     * 获取单例实例
+     * @param {IConstructArgs} [args]
+     * @returns {AdExecuteManager}
+     */
+    static getInstance(args?: IConstructArgs): 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('./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("./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;
+}
+import { Logger } from './Logger';

package/dist/ad/AdUnlock/RewardAdNovelUnlock.d.ts

@@ -0,0 +1,110 @@
+export default RewardAdNovelUnlock;
+export type IRewordAdConfig = import("../../typings/ad.js").IRewordAdConfig;
+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 ICloseArgs = {
+    /**
+     * 是否看完
+     */
+    isEnded: boolean;
+    /**
+     * 完整观看次数
+     */
+    count: number;
+};
+export type IConstructArgs = {
+    /**
+     * 初始化标识
+     */
+    sign: string;
+    /**
+     * 解锁设置
+     */
+    unlockSettings: import("./UnlockSettings").default;
+    /**
+     * 激励视频参数 (可选)
+     */
+    adConfig?: IRewordAdConfig | undefined;
+    /**
+     * 回调集合
+     */
+    collection?: IConnection | undefined;
+};
+/**
+ * @typedef {import('../../typings/ad.js').IRewordAdConfig} IRewordAdConfig
+ */
+/**
+ * @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 ICloseArgs
+ * @property {boolean} isEnded 是否看完
+ * @property {number} count 完整观看次数
+ */
+/**
+ * @typedef IConstructArgs
+ * @property {string} sign 初始化标识
+ * @property {import('./UnlockSettings').default} unlockSettings 解锁设置
+ * @property {IRewordAdConfig=} adConfig 激励视频参数 (可选)
+ * @property {IConnection=} collection 回调集合
+ */
+declare class RewardAdNovelUnlock extends RewardAdNovel {
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdNovelUnlock}
+     */
+    static build(args: IConstructArgs): RewardAdNovelUnlock;
+    static unshift(): typeof RewardAdNovelUnlock;
+    /**
+     *
+     * @returns  {RewardAdNovelUnlock}
+     */
+    static getInstance(): RewardAdNovelUnlock;
+    /**
+     *
+     * @returns  {RewardAdNovelUnlock | null}
+     */
+    static getNovelInstance(): RewardAdNovelUnlock | null;
+    /**
+     *
+     * @param {IConstructArgs} args
+     * @returns  {RewardAdNovelUnlock}
+     */
+    static "new"(args: IConstructArgs): RewardAdNovelUnlock;
+    /**
+     * @param {IConstructArgs} args
+     */
+    constructor(args: IConstructArgs);
+    _scene: 2;
+    /**
+     * @type {import('./UnlockSettings').default}
+     */
+    unlockSettings: import("./UnlockSettings").default;
+}
+import RewardAdNovel from '../RewardAdNovel';

package/dist/ad/AdUnlock/UnlockSettings.d.ts

@@ -0,0 +1,42 @@
+export default UnlockSettings;
+declare class UnlockSettings {
+    /**
+     *
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @returns  {UnlockSettings}
+     */
+    static "new"(args: {
+        sign: InitSign;
+    }): UnlockSettings;
+    /**
+     *
+     * @param {object} [args]
+     */
+    constructor(args?: object);
+    max_tan_ad: {
+        total: number;
+        current: number;
+    };
+    look_jls_p: {
+        is_look_complete: number;
+        total: number;
+        current: number;
+    };
+    commonSettings: CommonSettings;
+    _init(): void;
+    _adTimes(): void;
+    reset(): void;
+    updateMaxTan(): void;
+    updateLookJlsP(): void;
+    remainMaxTan(): number;
+    remainLook(): number;
+    /**
+     * 看广告的次数和弹框的次数不一致
+     * 并且需要完整的看完广告，并且弹框次数小于最大弹框次数
+     * @returns
+     */
+    end(): boolean;
+    ok(): boolean;
+}
+import CommonSettings from '../CommonSettings';

package/dist/ad/CommonSettings.d.ts

@@ -0,0 +1,179 @@
+export default CommonSettings;
+export type ISysConfig = {
+    /**
+     * 再看一次配置
+     */
+    free_incentive_frequency?: number | undefined;
+    /**
+     * 自定义解锁弹窗配置
+     */
+    c_unlock_pop_enable?: number | undefined;
+    /**
+     * 是否进入简介页
+     */
+    launch_go_jianjieye?: number | undefined;
+    /**
+     * 是否可以返回首页
+     */
+    launch_can_back_home?: number | undefined;
+    /**
+     * 返回书城激励视频每日展示次数 0 不展示 具体数量展示几次
+     */
+    back_book_store_ad?: number | undefined;
+    /**
+     * 是否开启启动激励
+     */
+    inter_site_pop_ups?: number | undefined;
+    /**
+     * 启动激励次数
+     */
+    inter_site_pop_ups_num?: number | undefined;
+    /**
+     * 阅读强激励循环次数
+     */
+    strong_incentive_frequency?: number | undefined;
+    /**
+     * 阅读页返回广告
+     */
+    read_page_back_ad?: number | undefined;
+    /**
+     * 进入阅读页每日自动展示激励次数
+     */
+    first_user_day?: number | undefined;
+};
+export type IUserConfig = {
+    /**
+     * 解锁章节中配置的观看解锁章节数
+     */
+    ad_unlock_chapter_num?: number | undefined;
+    /**
+     * 解锁章节中配置的观看奖励视频次数
+     */
+    look_jlsp_num?: number | undefined;
+    /**
+     * 解锁章节中配置的弹窗广告次数
+     */
+    max_tan_ad_num?: number | undefined;
+    /**
+     * 奖励视频是否观看完成
+     */
+    jlsp_is_look_complete?: number | undefined;
+    /**
+     * 书籍ID
+     */
+    dy_book_id?: number | undefined;
+    /**
+     * 默认书籍ID
+     */
+    default_book_id?: number | undefined;
+    /**
+     * 章节ID
+     */
+    index?: number | undefined;
+    /**
+     * 2 表示跳转至速度页面 1 不处理
+     */
+    open_page: string;
+    /**
+     * 是否解锁全部章节 0 未解锁 1 解锁
+     */
+    is_unlock_all: number;
+};
+export type IUserInfo = {
+    /**
+     * 用户ID
+     */
+    id: string;
+    /**
+     * 用户归因类型  1：信息流；2：工具版；3：新用户；4：老用户；5：未归因用户
+     */
+    user_type: 1 | 2 | 3 | 4 | 5;
+    /**
+     * 用户组  - 0：对照组A；1：测试组B
+     */
+    user_ab: 0 | 1;
+};
+/**
+ * 投放渠道参数
+ */
+export type IDeliverOption = {
+    /**
+     * 书籍ID
+     */
+    book_id: string;
+    /**
+     * 章节ID
+     */
+    chapter_id: string;
+    /**
+     * 过去的书籍ID
+     */
+    past_book_id: string;
+};
+declare class CommonSettings {
+    static instance: any;
+    /**
+     *
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @returns  {CommonSettings}
+     */
+    static build(args: {
+        sign: InitSign;
+    }): CommonSettings;
+    /**
+     *
+     * @returns  {CommonSettings}
+     */
+    static getInstance(): CommonSettings;
+    /**
+     *
+     * @param {object} args
+     * @param {InitSign} args.sign 初始化标识
+     * @returns  {CommonSettings}
+     */
+    static "new"(args: {
+        sign: InitSign;
+    }): CommonSettings;
+    /**
+     * @param {object} args
+     * @param {string} args.sign 初始化标识
+     * @param {string} args.loginInfo 登录信息
+     */
+    constructor(args: {
+        sign: string;
+        loginInfo: string;
+    });
+    _initSign: string;
+    _loginInfo: {};
+    /**
+     * 获取用户配置
+     * @returns {IUserConfig}
+     */
+    getUserConfig(): IUserConfig;
+    /**
+     * 获取用户信息
+     * @returns {IUserInfo}
+     */
+    getUserInfo(): IUserInfo;
+    /**
+     * 获取APP配置
+     * @returns {ISysConfig}
+     */
+    getSysConfig(): ISysConfig;
+    /**
+     *  获取用户ID
+     * @returns
+     */
+    getUserId(): string;
+    /**
+     *  1：测试组A 一般指全部功能都开启； 0：对照组B一般会有一个或者几个功能关闭
+     * @returns
+     */
+    getUserAB(): number;
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}

package/dist/ad/CountRecorder.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @typedef {object} IConstructorArgs
+ * @property {string} [sign] 初始化标识
+ * @property {string} local_sign 本地存储标识
+ * @property {number} [total] 总次数
+ * @param {number|'today'} [expire] 过期时间（毫秒）或'today'表示当天有效，可选
+ *
+ */
+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;
+};
+import Storage from './Storage';

package/dist/ad/ExbAnalyticsJS.d.ts

@@ -0,0 +1,131 @@
+export default ExbAnalyticsJS;
+export type EventDictionary = any;
+export type IConstructorArgs = {
+    /**
+     * 初始化标识
+     */
+    sign: string;
+    /**
+     * 是否需要上报
+     */
+    needReport?: boolean;
+};
+export type ICommonUserInfo = {
+    /**
+     * 用户ID
+     */
+    user_id: string;
+    /**
+     * 用户归因类型 0 未登录 1 未归因新用户 2 未归因老用户 3 归因成功新用户 4 归因成功老用户
+     */
+    user_type: 0 | 1 | 2 | 3 | 4;
+    /**
+     * 用户组 0：对照组A；1：测试组B
+     */
+    user_group: 0 | 1;
+};
+/**
+ * @typedef {import('@/typings/tracker').EventDictionary} EventDictionary
+ */
+/**
+ * @typedef {object} IConstructorArgs
+ * @property {string} sign 初始化标识
+ * @property {boolean} [needReport] 是否需要上报
+ *
+ */
+/**
+ * @typedef {object} ICommonUserInfo
+ * @property {string} user_id 用户ID
+ * @property {0 | 1 | 2 | 3 | 4} user_type 用户归因类型 0 未登录 1 未归因新用户 2 未归因老用户 3 归因成功新用户 4 归因成功老用户
+ * @property {0 | 1} user_group 用户组 0：对照组A；1：测试组B
+ *
+ */
+declare class ExbAnalyticsJS {
+    static instance: any;
+    /**
+     *
+     * @param {IConstructorArgs} args
+     * @returns  {ExbAnalyticsJS}
+     */
+    static build(args: IConstructorArgs): ExbAnalyticsJS;
+    /**
+     *
+     * @returns  {ExbAnalyticsJS}
+     */
+    static getInstance(): ExbAnalyticsJS;
+    /**
+     *
+     * @param {IConstructorArgs} args
+     * @returns  {ExbAnalyticsJS}
+     */
+    static "new"(args: IConstructorArgs): ExbAnalyticsJS;
+    /**
+     * @param {IConstructorArgs} args
+     */
+    constructor(args: IConstructorArgs);
+    _initSign: string;
+    _needReport: boolean;
+    /** @type {CommonSettings | null}  */
+    commonSettings: CommonSettings | null;
+    /**
+     * 初始化 比如环境配置，api地址、日志等级等
+     * @param {IConstructorArgs} args
+     */
+    initialize(args: IConstructorArgs): IConstructorArgs;
+    /**
+     * 追踪自定义事件
+     * 用户交互，如点击、提交
+     *
+     * @template {keyof EventDictionary} K
+     * @param {K} eventName - The name of the event to track.
+     * @param {EventDictionary[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 EventDictionary>(eventName: K, properties: EventDictionary[K], debugParams?: {
+        sign?: string;
+    }): void;
+    /**
+     * 获取公共用户信息
+     * @returns {ICommonUserInfo}
+     */
+    _getCommonUserInfo(): ICommonUserInfo;
+    /**
+     * 识别用户身份
+     * 用户登录后，关联用户信息
+     * @returns
+     */
+    identify(): any;
+    /**
+     * 合并用户身份
+     * 匿名用户转为登录用户
+     * @returns
+     */
+    alias(): any;
+    /**
+     * 追踪页面浏览
+     * SPA 路由切换，或手动触发页面事件
+     * @returns
+     */
+    pages(): any;
+    /**
+     * 追踪页面浏览 进入页面
+     *
+     * @template {'cpage'} K
+     * @param {K} eventName - The name of the event to track.
+     * @param {EventDictionary[K]} properties - The properties associated with the event.
+     */
+    page<K extends "cpage">(eventName: K, properties: EventDictionary[K]): void;
+    /**
+     *
+     * @param {EventDictionary['cpage']} properties
+     * @returns
+     */
+    cpage(properties: EventDictionary["cpage"]): void;
+    /**
+     * 站位方法，没有任何左右
+     * @returns
+     */
+    placeholder(): any;
+}
+import CommonSettings from './CommonSettings';

package/dist/ad/Logger.d.ts

@@ -0,0 +1,34 @@
+export class Logger {
+    /**
+     *
+     * @param {object} [options]
+     * @param {string} [options.prefix] - 日志前缀
+     * @param {string} [options.level] - 日志级别
+     * @param {boolean} [options.enabled] - 是否启用日志
+     */
+    constructor(options?: {
+        prefix?: string;
+        level?: string;
+        enabled?: boolean;
+    });
+    prefix: string;
+    enabled: boolean;
+    levels: {
+        error: number;
+        warn: number;
+        info: number;
+        debug: number;
+    };
+    currentLevel: any;
+    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;
+    debug(message: any, ...args: any[]): void;
+    log(level: any, message: any, ...args: any[]): void;
+}