@singcl/ad-execute-manager 1.0.0 → 1.0.1

package/README.md

@@ -1,268 +1 @@
-# ad-execute-manager
-
-广告执行管理器是一个用于管理和执行广告任务的JavaScript库，特别适用于激励视频广告的场景化管理和执行。
-
-## 功能特性
-
-- **任务管理**：支持广告任务的添加、执行和取消
-- **场景化**：支持不同场景下的广告展示和统计
-- **激励视频**：专注于激励视频广告的管理和执行
-- **回调机制**：提供丰富的回调函数来处理广告的各种状态
-- **统计分析**：集成广告展示和点击的统计分析功能
-- **单例模式**：使用单例模式管理广告实例，确保资源的有效利用
-
-## 目录结构
-
-```
-src/
-├── ad/                    # 广告相关核心代码
-│   ├── AdExecuteManager.js          # 广告执行管理器
-│   ├── RewardAdFather.js            # 激励视频广告基类
-│   ├── RewardAdNovel.js             # 小说场景激励视频广告
-│   ├── RewardAdLaunch.js            # 启动场景激励视频广告
-│   ├── RewardAdLaunchAlone.js       # 单独启动场景激励视频广告
-│   ├── RewardAdReadingLoad.js       # 阅读加载场景激励视频广告
-│   ├── RewardAdReadingUnload.js     # 阅读卸载场景激励视频广告
-│   ├── RewardAdSceneTriggerManager.js  # 广告场景触发管理器
-│   ├── RewardAdGlobalRecorder.js    # 广告全局记录器
-│   ├── LovelUnlockManager.js        # 解锁管理器
-│   ├── AdUnlock/                    # 广告解锁相关代码
-│   ├── ExbAnalyticsJS.js            # 统计分析工具
-│   ├── Storage.js                   # 存储工具
-│   ├── CountRecorder.js             # 计数记录器
-│   ├── Logger.js                    # 日志工具
-│   ├── SerializableError.js         # 可序列化错误
-│   ├── compose.js                   # 函数组合工具
-│   └── const.js                     # 常量定义
-├── typings/               # 类型定义
-│   ├── ad.js                        # 广告相关类型定义
-│   └── tracker.js                   # 统计跟踪相关类型定义
-├── utils/                 # 工具函数
-│   └── functional.js                # 函数式工具函数
-└── index.js               # 入口文件
-```
-
-## 安装
-
-```bash
-npm install @singcl/ad-execute-manager
-```
-
-## 快速开始
-
-### 导入
-
-```javascript
-import AdExecuteManager from '@singcl/ad-execute-manager';
-import RewardAdNovel from '@singcl/ad-execute-manager/lib/ad/RewardAdNovel';
-```
-
-### 创建广告实例
-
-```javascript
-// 创建激励视频广告实例
-const rewardAdNovel = new RewardAdNovel({
-  sign: 'novel_ad',
-  adConfig: {
-    adUnitId: 'your_ad_unit_id',
-    multiton: true,
-    multitonRewardTimes: 4,
-    multitonRewardMsg: ['全部小说免费看'],
-    progressTip: true
-  },
-  collection: {
-    onShow: (args) => {
-      console.log('广告展示', args);
-    },
-    onFinish: (args) => {
-      console.log('广告看完', args);
-    },
-    onHalfway: (args) => {
-      console.log('广告中途退出', args);
-    },
-    onError: (error) => {
-      console.error('广告错误', error);
-    }
-  }
-});
-```
-
-### 执行广告任务
-
-```javascript
-// 获取广告执行管理器实例
-const adManager = AdExecuteManager.getInstance({ log: true });
-
-// 添加广告任务
-adManager.addTask(rewardAdNovel, {
-  options: {
-    scene: 1, // 小说插件强制广告场景
-    log: true
-  },
-  collection: {
-    always: (args) => {
-      console.log('广告总是回调', args);
-    },
-    finished: (args) => {
-      console.log('广告完成回调', args);
-    },
-    halfway: (args) => {
-      console.log('广告中途回调', args);
-    }
-  }
-}).then((result) => {
-  console.log('广告任务完成', result);
-}).catch((error) => {
-  console.error('广告任务失败', error);
-});
-```
-
-## API 文档
-
-### AdExecuteManager
-
-广告执行管理器，用于管理广告任务的执行流程。
-
-#### 静态方法
-
-- `getInstance(args)`: 获取单例实例
-  - `args`: 配置参数
-    - `log`: 是否打印日志
-
-#### 实例方法
-
-- `addTask(adInstance, ctx)`: 添加广告任务
-  - `adInstance`: 广告实例（必须是RewardAdFather的子类）
-  - `ctx`: 广告执行上下文
-    - `options`: 广告执行选项
-    - `collection`: 回调集合
-  - 返回: Promise对象
-
-- `clearTasks()`: 清空所有任务（包括正在执行的任务）
-
-- `getTaskCount()`: 获取当前未完成的任务总数
-
-- `isRunning()`: 检查是否有任务正在运行
-
-- `getCurrentTaskId()`: 获取当前执行的任务ID
-
-### RewardAdFather
-
-激励视频广告基类，所有具体的激励视频广告类都继承自此类。
-
-#### 构造方法
-
-- `constructor(args)`: 创建广告实例
-  - `args`: 配置参数
-    - `sign`: 初始化标识
-    - `adConfig`: 广告配置
-    - `preserveOnEnd`: 是否保留广告实例
-
-#### 实例方法
-
-- `initialize(params, callback)`: 初始化广告
-  - `params`: 初始化参数
-  - `callback`: 初始化成功回调
-
-- `ad(ctx, next)`: 执行广告展示（抽象方法，子类必须实现）
-  - `ctx`: 广告执行上下文
-  - `next`: 执行下一个任务的回调函数
-
-- `addExecuteManager(ctx)`: 确保广告按顺序执行
-
-- `destroy()`: 销毁广告实例
-
-- `show()`: 显示广告
-
-- `load()`: 加载广告
-
-- `onClose(callback)`: 监听广告关闭事件
-
-- `onError(callback)`: 监听广告错误事件
-
-- `onLoad(callback)`: 监听广告加载事件
-
-### RewardAdNovel
-
-小说场景激励视频广告实现类。
-
-#### 静态方法
-
-- `build(args)`: 创建并获取单例实例
-
-- `getInstance()`: 获取单例实例
-
-- `new(args)`: 创建新实例
-
-## 广告场景类型
-
-| 场景值 | 场景名称 | 说明 |
-| --- | --- | --- |
-| 0 | launch_ad | 启动广告 |
-| 1 | novel_plugin_strong_ad | 小说插件强制广告 |
-| 2 | novel_plugin_unlock_btn | 小说插件解锁按钮 |
-| 3 | novel_plugin_free_benefit_btn | 小说插件免费福利按钮 |
-| 4 | home_free_welfare_btn | 首页免费福利按钮 |
-| 5 | home_free_popup | 首页免费弹窗 |
-| 6 | other | 其他场景 |
-| 7 | home_back_show | 首页返回展示 |
-| 8 | novel_plugin_free_time_btn | 小说插件免费时间按钮 |
-| 9 | launch_ad_alone | 单独启动广告 |
-
-## 回调集合
-
-### CallbackCollection
-
-| 回调函数 | 说明 |
-| --- | --- |
-| always | 每次广告结束时都会调用 |
-| finished | 完整看完广告时调用 |
-| halfway | 半途退出广告时调用 |
-| complete | 完成广告时调用（不管是否看完） |
-| onCancel | 取消广告时调用 |
-| before | 展示广告前调用 |
-| success | 展示广告成功时调用 |
-| prelude | 计时回调 |
-
-## 开发
-
-### 构建
-
-```bash
-npm run build
-```
-
-### 开发模式
-
-```bash
-npm run dev
-```
-
-### 代码格式化
-
-```bash
-npm run format
-```
-
-### 代码检查
-
-```bash
-npm run lint
-```
-
-### 测试
-
-```bash
-npm run test
-```
-
-## 依赖
-
-- @rslib/core: 用于项目构建
-- @rstest/core: 用于测试
-- eslint: 用于代码检查
-- prettier: 用于代码格式化
-
-## 许可证
-
-MIT
+# AD Execute Manager

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singcl/ad-execute-manager",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "exports": {
     ".": {
@@ -29,8 +29,5 @@
     "eslint-plugin-import": "^2.32.0",
     "globals": "^16.5.0",
     "prettier": "^3.7.3"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }