@singcl/ad-execute-manager 1.0.5 → 1.0.6

package/dist/typings/ad.d.ts

@@ -0,0 +1,193 @@
+export type IRewordAdConfig = {
+    /**
+     * 激励视频广告id - 必填
+     */
+    adUnitId: string;
+    /**
+     * 是否开启进度提醒。开启时广告文案为「再看 n 个xxx」，关闭时为「再看 1 个xxx」。其中 n 表示用户当前还需额外观看广告的次数
+     * 再得广告的奖励文案，用户每看完一个广告都会展示，multiton 为 true 时必填。
+     * 文案完整内容为「再看 1 个xxx」，其中 xxx 是 multitonRewardMsg 配置的文案内容，最大长度为 7，
+     * 文案内容根据 multitonRewardMsg 的配置按顺序展示。若 multitonRewardMsg 长度小于 multitonRewardTimes ，
+     * 则后续的激励再得广告文案取 multitonRewardMsg 数组最后一个。
+     */
+    progressTip?: boolean | undefined;
+    multitonRewardMsg?: Array<string> | undefined;
+    /**
+     * 是否开启激励再得广告
+     */
+    multiton?: boolean | undefined;
+    /**
+     * 额外观看广告的次数，合法的数据范围为 1～4，multiton 为 true 时必填
+     */
+    multitonRewardTimes?: number | undefined;
+    /**
+     * 场景值 - 自用参数，非tt API要求的参数
+     */
+    scene?: number | undefined;
+    /**
+     * 奖励金额 - 自用参数 ，非tt API要求的参数
+     */
+    log?: boolean | undefined;
+    /**
+     * 重试次数 - 自用参数 ，非tt API要求的参数
+     */
+    retry: number;
+};
+export type InterstitialAdConfig = {
+    /**
+     * 单个广告单元的 id。可从「开放平台控制台-进入对应小程序-运营-商业化变现-广告管理」中获取 - 必填
+     */
+    adUnitId: string;
+    /**
+     * 场景值 - 自用参数
+     */
+    scene?: number | undefined;
+};
+export type IExeCallbackArgs = {
+    /**
+     * 广告执行场景
+     */
+    scene: number;
+    /**
+     * 是否看完
+     */
+    isEnded: boolean;
+    /**
+     * 完整观看次数
+     */
+    count: number;
+    /**
+     * 剩余观看次数
+     */
+    remain?: number;
+};
+export type CallbackCollection = {
+    /**
+     * 每次外部回调
+     */
+    always?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 完整看完广告外部回调 不管一个还是几个
+     */
+    finished?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 半途退出广告外部回调
+     */
+    halfway?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 完成广告外部回调 不管看不看完
+     */
+    complete?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 取消广告外部回调
+     */
+    onCancel?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 展示广告外部回调
+     */
+    before?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 展示广告成功外部回调
+     */
+    success?: (ctx?: IExeCallbackArgs) => void;
+    /**
+     * 计时回调
+     */
+    prelude?: (ctx?: unknown) => void;
+};
+export type ICallbackArgs = {
+    /**
+     * 广告执行场景
+     */
+    scene: number;
+    /**
+     * 是否看完
+     */
+    isEnded: boolean;
+    /**
+     * 完整观看次数
+     */
+    count: number;
+    /**
+     * 剩余观看次数
+     */
+    remain?: 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;
+    /**
+     * 广告执行失败回调
+     */
+    onError?: (e: unknown) => void;
+};
+export type IConstructArgs = {
+    /**
+     * 初始化标识
+     */
+    sign: string;
+    /**
+     * 重试次数
+     */
+    retry: number;
+    /**
+     * 是否保留tt激励视频广告实例
+     */
+    preserveOnEnd: boolean;
+    /**
+     * 激励视频参数 (可选)
+     */
+    adConfig?: IRewordAdConfig | undefined;
+    /**
+     * 回调集合
+     */
+    collection?: IConnection | undefined;
+};
+/**
+ * 广告场景类型映射对象
+ */
+export type ScentTypeMap = {
+    readonly 0: "launch_ad";
+    readonly 1: "novel_plugin_strong_ad";
+    readonly 2: "novel_plugin_unlock_btn";
+    readonly 3: "novel_plugin_free_benefit_btn";
+    readonly 4: "home_free_welfare_btn";
+    readonly 5: "home_free_popup";
+    readonly 6: "other";
+    readonly 7: "home_back_show";
+    readonly 8: "novel_plugin_free_time_btn";
+    readonly 9: "launch_ad_alone";
+};
+/**
+ * 广告场景类型文本映射对象（反向映射）
+ */
+export type ScentTextMap = { readonly [K in ScentTypeMap[keyof ScentTypeMap]]: { [P in keyof ScentTypeMap]: ScentTypeMap[P] extends K ? P : never; }[keyof ScentTypeMap]; };
+/**
+ * 场景值枚举 可持续添加
+ */
+export type RewardAdTriggerScene = keyof ScentTextMap;
+/**
+ * 场景值枚举 可持续添加
+ */
+export type RewardAdTriggerSceneType = keyof ScentTypeMap;

package/dist/typings/tracker.d.ts

@@ -0,0 +1,115 @@
+/**
+ * A dictionary mapping event names to their corresponding properties.
+ */
+export type EventDictionary = {
+    /**
+     * - 免费解锁弹窗
+     */
+    free_unlock_popup: {
+        that: 0 | 1 | 2 | 3;
+        trigger_time: 0 | 1 | 2 | 3;
+        result: 0 | 1 | any;
+    };
+    /**
+     * - 加载激励广告 加载激励广告时触发 - 无太大参考意义，可以忽略
+     */
+    incentive_ad_load: {
+        scene: number;
+        result: string;
+    };
+    /**
+     * 展示激励广告 激励广告展示时触发
+     */
+    incentive_ad_show: {
+        scene: number;
+        result: string;
+        msg: string;
+    };
+    /**
+     * 关闭激励广告 激励广告关闭时触发
+     */
+    incentive_ad_close: {
+        scene: number;
+        ad_count: number;
+        ad_view_duration: string;
+        ad_is_completed: 0 | 1;
+    };
+    /**
+     * 注册登录 触发时机 "打开小程序 进行注册/登录
+     */
+    login: {
+        trigger_time: 1 | 2;
+        result: 0 | 1;
+    };
+    /**
+     * 简介页交互 触发时机 点击简介页的按钮
+     */
+    book_intro: {
+        trigger_time: 1 | 2 | 3 | 4;
+        book_title: 0 | 1;
+    };
+    /**
+     * 进入小程序页面
+     */
+    cpage: {
+        page: number;
+    };
+    /**
+     * 点击书籍
+     */
+    click_book: {
+        scene: number;
+        book_title: 0 | 1;
+    };
+    /**
+     * 添加桌面图标
+     */
+    add_shortcut: {
+        result: 0 | 1;
+        scene: number;
+    };
+    /**
+     * 小说章节展示 "1、用户首次展示新的章节（该章节如果未解锁，不上报；2s内只上报一次）2、用户解锁新的章节"
+     */
+    chapter_show: {
+        book_title: 0 | 1;
+        chapter_number: number;
+        is_end: number;
+    };
+    /**
+     * 小说阅读开始
+     */
+    speed_read_card: {
+        book_title: 0 | 1;
+        result: number;
+        trigger_time: number;
+    };
+    /**
+     * 展示首页福利弹窗
+     */
+    home_welfare_popup_show: {
+        trigger_time: 1 | 2;
+        result: 0 | 1;
+    };
+    /**
+     * 关闭首页福利弹窗
+     */
+    home_welfare_popup_close: {
+        trigger_way: 0 | 1 | 2;
+        result: 0 | 1;
+    };
+    /**
+     * 展示免费领取弹窗
+     */
+    free_popup_show: {
+        trigger_time: 1 | 2;
+        result: 0 | 1;
+    };
+    /**
+     * 关闭免费领取弹窗
+     */
+    free_popup_close: {
+        trigger_way: 0 | 1 | 2;
+        result: 0 | 1;
+    };
+};

package/dist/utils/functional.d.ts

@@ -0,0 +1,13 @@
+/**
+ *
+ * @param {string[]} ttErrorMsgs
+ * @param {string[]} keywords
+ * @returns
+ */
+export function matchErrorWithKeywords(ttErrorMsgs: string[], keyword: any): boolean;
+/**
+ * 根据 adSceneFlag 查找对应的 showTimes
+ * @param {string} sceneFlag - 要查找的 adSceneFlag 值
+ * @returns {number|null} 匹配项的值，默认showTimes
+ */
+export function findAdTypeBySceneFlag(strategyList: any, sceneFlag: string, type?: string): number | null;

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@singcl/ad-execute-manager",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
     }
   },
   "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "rslib build",
+    "build": "rslib build && tsc",
     "dev": "rslib build --watch",
     "format": "prettier --write .",
     "lint": "eslint .",
@@ -29,6 +31,7 @@
     "eslint": "^9.39.2",
     "eslint-plugin-import": "^2.32.0",
     "globals": "^16.5.0",
-    "prettier": "^3.7.3"
+    "prettier": "^3.7.3",
+    "typescript": "^5.9.3"
   }
 }