@ad-execute-manager/core 2.0.0-alpha.2 → 2.0.0-alpha.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 singcl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# @singcl/core
+
+Core functionality for ad execution management including AdExecuteManager, utility functions, and middleware composition.
+
+## Installation
+
+```bash
+npm install @singcl/core
+```
+
+## Features
+
+- **AdExecuteManager**: A powerful ad execution management class for handling reward-based ads, interstitial ads, and other advertising formats
+- **compose**: A middleware composition utility inspired by Koa
+- **needRetryAdError**: A utility function for determining if an ad error should be retried
+
+## Usage
+
+### AdExecuteManager
+
+```javascript
+import { AdExecuteManager } from '@singcl/core';
+
+const adManager = new AdExecuteManager({
+  // Configuration options
+});
+
+// Initialize ad
+const result = await adManager.init();
+
+// Show ad
+const showResult = await adManager.show();
+```
+
+### Middleware Composition
+
+```javascript
+import { compose } from '@singcl/core';
+
+const middlewares = [
+  async (ctx, next) => {
+    console.log('Middleware 1 start');
+    await next();
+    console.log('Middleware 1 end');
+  },
+  async (ctx, next) => {
+    console.log('Middleware 2 start');
+    await next();
+    console.log('Middleware 2 end');
+  }
+];
+
+const composedMiddleware = compose(middlewares);
+await composedMiddleware({});
+```
+
+### Error Retry Utility
+
+```javascript
+import { needRetryAdError } from '@singcl/core';
+
+const apiError = {
+  errMsg: 'ad_show_timeout: normal',
+  timeout: 5000
+};
+
+const shouldRetry = needRetryAdError({
+  apiError,
+  configuredAdTimeout: 5000,
+  errorRetryStrategy: {
+    timeout: true,
+    background: true
+  }
+});
+
+console.log('Should retry:', shouldRetry);
+```
+
+## API
+
+### AdExecuteManager
+
+The main class for managing ad execution with support for initialization, showing, and error handling.
+
+### compose
+
+```typescript
+function compose(middlewares: Array<(ctx: any, next: () => Promise<void>) => Promise<void>>): (ctx: any) => Promise<void>
+```
+
+### needRetryAdError
+
+```typescript
+function needRetryAdError({
+  apiError,
+  configuredAdTimeout,
+  errorRetryStrategy
+}: {
+  apiError: { errMsg?: string; timeout?: number };
+  configuredAdTimeout: number;
+  errorRetryStrategy?: {
+    timeout?: boolean;
+    background?: boolean;
+  };
+}): boolean
+```
+
+## License
+
+MIT

package/dist/AdExecuteManager.d.ts

@@ -0,0 +1,252 @@
+export default AdExecuteManager;
+export type IAdInstance = {
+    /**
+     * 超时时间
+     */
+    _adTimeoutTime: number;
+    /**
+     * 初始化广告
+     */
+    initialize: (ctx: unknown) => IAdInstance;
+    /**
+     * 显示广告
+     */
+    ad: (options: unknown, ctx: unknown, recovered: unknown) => Promise<unknown>;
+    clear: () => void;
+};
+export type IRewordAdConfig = import("./typings/ad.js").IRewordAdConfig;
+export type CallbackCollection = import("./typings/ad.js").CallbackCollection;
+export type AdTask = {
+    /**
+     * RewardAdFather的子类实例
+     */
+    adInstance: IAdInstance;
+    /**
+     * 广告执行选项
+     */
+    options: IRewordAdConfig;
+    /**
+     * 回调集合
+     */
+    callbackCollection: CallbackCollection;
+    /**
+     * 广告执行成功的回调函数
+     */
+    resolve: Function;
+    /**
+     * 广告执行失败的回调函数
+     */
+    reject: Function;
+    /**
+     * 广告任务的唯一标识符
+     */
+    id: string;
+    /**
+     * 广告任务是否已成功解决
+     */
+    _isResolved: boolean;
+    /**
+     * 广告任务是否已被拒绝
+     */
+    _isRejected: boolean;
+    /**
+     * 广告任务后台恢复前台时预估重试次数
+     */
+    _retryCount: number;
+    /**
+     * 广告任务后台恢复前台时预估重试次数的原因
+     */
+    _retryMsg: string;
+};
+export type ErrorRetryStrategy = {
+    /**
+     * 是否重试超时错误
+     */
+    timeout?: boolean;
+    /**
+     * 是否重试后台错误
+     */
+    background?: boolean;
+};
+export type IConstructArgs = {
+    /**
+     * 广告执行选项
+     */
+    options?: object;
+    /**
+     * 是否打印日志
+     */
+    log?: boolean;
+    /**
+     * 是否启用前后台监听, 进入后台时候未执行的任务放入任务栈，等待进入前台恢复执行
+     */
+    enableVisibilityListener?: boolean;
+    /**
+     * 最大重试次数, 默认为1 0表示不重试
+     */
+    maxRetryCount?: number;
+    /**
+     * 进入后台时广告展示错误时重试策略
+     */
+    errorRetryStrategy?: ErrorRetryStrategy;
+};
+declare class AdExecuteManager {
+    /**
+     * 单例实例
+     * @type {AdExecuteManager|null}
+     */
+    static _instance: AdExecuteManager | null;
+    /**
+     * 获取单例实例
+     * @param {IConstructArgs} [args]
+     * @returns {AdExecuteManager}
+     */
+    static getInstance(args?: IConstructArgs): AdExecuteManager;
+    /**
+     * 获取单例实例
+     * @param {IConstructArgs} [args]
+     * @returns {AdExecuteManager}
+     */
+    static build(args?: IConstructArgs): AdExecuteManager;
+    /**
+     * 获取单例实例
+     * @param {IConstructArgs} [args]
+     * @returns {AdExecuteManager}
+     */
+    static "new"(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;
+    /**
+     * @type {boolean}
+     */
+    _isForeground: boolean;
+    /**
+     * @type {Function|null}
+     */
+    _appShowListener: Function | null;
+    /**
+     * @type {Function|null}
+     */
+    _appHideListener: Function | null;
+    /**
+     * @type {boolean}
+     */
+    _enableVisibilityListener: boolean;
+    /**
+     * @type {number}
+     */
+    _maxRetryCount: number;
+    /**
+     * @type {Array.<AdTask>}
+     */
+    _retryQueue: Array<AdTask>;
+    /**
+     * 进入后台时广告展示错误时重试策略
+     */
+    _errorRetryStrategy: {
+        timeout: boolean;
+        background: boolean;
+    };
+    logger: Logger;
+    initialize(_args: any): this;
+    /**
+     * 初始化前后台监听器
+     * @private
+     */
+    private _initVisibilityListener;
+    /**
+     * 处理应用进入后台
+     * @private
+     */
+    private _handleAppHide;
+    /**
+     * 处理应用进入前台
+     * @private
+     */
+    private _handleAppShow;
+    /**
+     * 销毁前后台监听器
+     */
+    destroyVisibilityListener(): void;
+    /**
+     * 启用前后台监听
+     */
+    enableVisibilityListener(): void;
+    /**
+     * 禁用前后台监听
+     */
+    disableVisibilityListener(): void;
+    /**
+     * 获取前后台监听器状态
+     * @returns {boolean} 是否启用
+     */
+    isVisibilityListenerEnabled(): boolean;
+    /**
+     * 添加广告任务
+     * @param {IAdInstance} adInstance RewardAdFather的子类实例
+     * @param {Object} ctx 广告执行上下文
+     * @param {IRewordAdConfig} ctx.options 广告执行选项
+     * @param {CallbackCollection} ctx.collection 回调集合
+     * @returns {Promise} 广告执行结果的Promise
+     */
+    addTask(adInstance: IAdInstance, ctx: {
+        options: IRewordAdConfig;
+        collection: 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 '@ad-execute-manager/helper';

package/dist/_util.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 判断是否需要重试
+ * @param {object} param
+ * @param {object} param.apiError 广告错误信息
+ * @param {number} param.configuredAdTimeout 配置的广告超时时间
+ * @param {object} [param.errorRetryStrategy] 错误重试策略
+ * @param {boolean} [param.errorRetryStrategy.timeout] 是否需要重试超时错误
+ * @param {boolean} [param.errorRetryStrategy.background] 是否需要重试后台错误
+ * @returns
+ */
+export function needRetryAdError({ apiError, configuredAdTimeout, errorRetryStrategy }: {
+    apiError: object;
+    configuredAdTimeout: number;
+    errorRetryStrategy?: {
+        timeout?: boolean;
+        background?: boolean;
+    };
+}): boolean;

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";const __rslib_import_meta_url__="u"<typeof document?new(require("url".replace("",""))).URL("file:"+__filename).href:document.currentScript&&document.currentScript.src||new URL("main.js",document.baseURI).href;var __webpack_require__={};__webpack_require__.d=(e,t)=>{for(var r in t)__webpack_require__.o(t,r)&&!__webpack_require__.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},__webpack_require__.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),__webpack_require__.r=e=>{"u">typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var __webpack_exports__={};__webpack_require__.r(__webpack_exports__),__webpack_require__.d(__webpack_exports__,{AdExecuteManager:()=>src_AdExecuteManager});const helper_namespaceObject=require("@ad-execute-manager/helper");function isTimeoutError(e,t){return(null==e?void 0:e.errMsg)&&"string"==typeof e.errMsg&&e.errMsg.startsWith("ad_show_timeout: normal")&&(null==e?void 0:e.timeout)==t}function isBackgroundError(e){return(null==e?void 0:e.errMsg)&&"string"==typeof e.errMsg&&(e.errMsg.startsWith("app in background is not support show ad")||e.errMsg.startsWith("other controller is presented"))}function needRetryAdError({apiError:e,configuredAdTimeout:t,errorRetryStrategy:r}){return!!((null==r?void 0:r.timeout)&&isTimeoutError(e,t)||(null==r?void 0:r.background)&&isBackgroundError(e))}const compose=e=>e.map(e=>(t,r)=>async i=>await e(Object.assign({},t,i),r)).reduce((e,t)=>(r,i)=>e(r,t(r,i))),src_compose=compose;class AdExecuteManager{static _instance=null;_taskStack=[];_currentBatchTasks=[];_isRunning=!1;_currentTask=null;_isForeground=!0;_appShowListener=null;_appHideListener=null;_enableVisibilityListener=!1;_maxRetryCount=1;_retryQueue=[];_errorRetryStrategy={timeout:!0,background:!0};constructor(e){this.logger=new helper_namespaceObject.Logger({prefix:"AdExecuteManager",enabled:!!(null==e?void 0:e.log)}),(null==e?void 0:e.errorRetryStrategy)&&(this._errorRetryStrategy=Object.assign({},this._errorRetryStrategy,null==e?void 0:e.errorRetryStrategy)),this._enableVisibilityListener=null==e?void 0:e.enableVisibilityListener,this._maxRetryCount=(null==e?void 0:e.maxRetryCount)??1,this._enableVisibilityListener&&this._initVisibilityListener()}initialize(e){return this}static getInstance(e){return AdExecuteManager._instance||(AdExecuteManager._instance=new AdExecuteManager(e)),AdExecuteManager._instance}static build(e){return AdExecuteManager._instance||(AdExecuteManager._instance=new AdExecuteManager(e)),AdExecuteManager._instance}static new(e){return new AdExecuteManager(e)}static getSafeInstance(){return AdExecuteManager._instance?AdExecuteManager._instance:(this.logger.error("AdExecuteManager实例不存在"),null)}_initVisibilityListener(){!("u"<typeof tt)&&tt.onAppShow&&tt.onAppHide?(this._appShowListener=()=>{this._isForeground=!0,this._handleAppShow()},this._appHideListener=()=>{this._isForeground=!1,this._handleAppHide()},tt.onAppShow(this._appShowListener),tt.onAppHide(this._appHideListener),this.logger.info("前后台监听器已初始化")):this.logger.warn("tt API不可用，无法监听前后台状态")}_handleAppHide(){if(this._isRunning&&this._currentBatchTasks.length>0){let e=this._currentBatchTasks.filter(e=>{var t;return e.id!==(null==(t=this._currentTask)?void 0:t.id)&&!e._isResolved&&!e._isRejected});e.length>0&&(this.logger.info(`将 ${e.length} 个未执行的任务放回任务栈,任务ID: ${e.map(e=>e.id).join(",")}`),this._taskStack=[...e,...this._taskStack],this._currentBatchTasks=this._currentBatchTasks.filter(t=>!e.some(e=>e.id===t.id)))}}_handleAppShow(){this._retryQueue.length>0&&(this.logger.info(`应用进入前台:优先执行重试队列，任务数: ${this._retryQueue.length}, 任务ID: ${this._retryQueue.map(e=>e.id).join(",")}`),this._taskStack=[...this._retryQueue,...this._taskStack],this._retryQueue=[]),this._taskStack.length>0&&!this._isRunning&&(this.logger.info(`应用进入前台:恢复待执行任务数: ${this._taskStack.length}, 任务ID: ${this._taskStack.map(e=>e.id).join(",")}`),this._compose())}destroyVisibilityListener(){this._appShowListener&&"u">typeof tt&&tt.offAppShow&&(tt.offAppShow(this._appShowListener),this._appShowListener=null),this._appHideListener&&"u">typeof tt&&tt.offAppHide&&(tt.offAppHide(this._appHideListener),this._appHideListener=null),this.logger.info("前后台监听器已销毁")}enableVisibilityListener(){this._enableVisibilityListener||(this._enableVisibilityListener=!0,this._initVisibilityListener()),this.logger.info("前后台监听器已启用")}disableVisibilityListener(){this._enableVisibilityListener&&(this._enableVisibilityListener=!1,this.destroyVisibilityListener()),this.logger.info("前后台监听器已禁用")}isVisibilityListenerEnabled(){return this._enableVisibilityListener}addTask(e,t){return e&&"function"==typeof e.ad?new Promise((r,i)=>{let s={adInstance:e,options:t.options??{},callbackCollection:t.collection??{},resolve:r,reject:i,id:`ad_${Date.now()}_${Math.random().toString(36).substr(2,9)}`,_isResolved:!1,_isRejected:!1,_retryCount:0,_retryMsg:"ok"};this._taskStack.push(s),this._isRunning||this._compose()}):(this.logger.error("无效的广告实例 请正确实现.ad方法"),Promise.reject(Error("无效的广告实例")))}_compose(){if(0===this._taskStack.length){this._isRunning=!1,this._currentTask=null;return}if(!this._isForeground){this.logger.info(`应用处于后台,暂停任务执行,任务ID: ${this._taskStack.map(e=>e.id).join(",")}`),this._isRunning=!1;return}this._isRunning=!0;let e=[...this._taskStack];this._taskStack=[],this._currentBatchTasks=e;let t=e.map(e=>async(t,r)=>{let{adInstance:i,options:s,callbackCollection:n,resolve:a,id:o,_retryCount:c,_retryMsg:l}=e,_={count:c,retry:c>0,message:l};if(e._isResolved||e._isRejected)return void await r(t);this._currentTask=e;try{let c=async e=>{await r(Object.assign({},t,e))},l=await i.initialize(s).ad({options:s,collection:n,recovered:_},c),h=Object.assign({id:o,recovered:_},l);if(this.logger.info(`任务执行成功，成功信息：${JSON.stringify(h)}`),needRetryAdError({apiError:null==h?void 0:h.apiError,configuredAdTimeout:i._adTimeoutTime,errorRetryStrategy:this._errorRetryStrategy})&&!this._isForeground&&e._retryCount<this._maxRetryCount){var u;e._retryCount++,e._retryMsg=(null==h||null==(u=h.apiError)?void 0:u.errMsg)||"unknown";let t=`任务 ${o} 在后台失败，加入重试队列 (即将第 ${e._retryCount} 次重试, 最大重试次数 ${this._maxRetryCount}, 重试原因: ${e._retryMsg})`;this.logger.warn(t),h.recovered.retry=!0,h.recovered.count=e._retryCount,h.recovered.message=e._retryMsg,e._isResolved=!1,e._isRejected=!1,this._retryQueue.push(e)}else e._isResolved=!0;a(h),null==i||i.record(h)}catch(n){let s=Object.assign({id:o,apiError:n,recovered:_});this.logger.error(`任务执行失败, 继续下一个任务,错误信息：${JSON.stringify(s)}`),e._isRejected=!0;try{null==i||i.clear()}catch(e){this.logger.error("clear error: ",JSON.stringify(Object.assign({id:o,apiError:e})))}a(s),null==i||i.record(s),await r(t)}}),r={roundTasks:t.length};compose(t)(r,async e=>{this.logger.info("本轮活动队列已经清空",e),this._taskStack.length>0?Promise.resolve().then(()=>{this._compose()}):(this._isRunning=!1,this._currentTask=null,this._currentBatchTasks=[])})()}clearTasks(){if(this._currentTask){if(this._currentTask._isResolved||this._currentTask._isRejected){this._currentTask=null;return}try{this._currentTask.callbackCollection&&this._currentTask.callbackCollection.onCancel&&this._currentTask.callbackCollection.onCancel(),this._currentTask._isResolved=!0,this._currentTask.resolve()}catch(e){this.logger.error("clear current task error: ",e)}this._currentTask=null}this._currentBatchTasks.length>0&&(this._currentBatchTasks.forEach(e=>{if(e!==this._currentTask&&!e._isResolved&&!e._isRejected)try{e.callbackCollection&&e.callbackCollection.onCancel&&e.callbackCollection.onCancel(),e._isResolved=!0,e.resolve()}catch(e){this.logger.error("clear current batch task error: ",e)}}),this._currentBatchTasks=[]),this._taskStack.forEach(e=>{if(!e._isResolved&&!e._isRejected&&(e._isResolved=!0,e.resolve(),e.callbackCollection&&e.callbackCollection.onCancel))try{e.callbackCollection.onCancel()}catch(e){this.logger.error("clear task error: ",e)}}),this._retryQueue.forEach(e=>{if(!e._isResolved&&!e._isRejected&&(e._isResolved=!0,e.resolve(),e.callbackCollection&&e.callbackCollection.onCancel))try{e.callbackCollection.onCancel()}catch(e){this.logger.error("clear retry task error: ",e)}}),this._taskStack=[],this._retryQueue=[],this._isRunning=!1}getTaskCount(){return this._taskStack.filter(e=>!e._isResolved&&!e._isRejected).length+this._currentBatchTasks.filter(e=>e!==this._currentTask&&!e._isResolved&&!e._isRejected).length+(!this._currentTask||this._currentTask._isResolved||this._currentTask._isRejected?0:1)+this._retryQueue.filter(e=>!e._isResolved&&!e._isRejected).length}isRunning(){return this._isRunning}getCurrentTaskId(){var e;return(null==(e=this._currentTask)?void 0:e.id)||null}whenAllTasksComplete(){return new Promise(e=>{let t=null,r=()=>{let i=0===this._taskStack.length,s=!this._isRunning,n=null===this._currentTask,a=0===this._currentBatchTasks.length||this._currentBatchTasks.every(e=>e._isResolved||e._isRejected),o=0===this._retryQueue.length;i&&s&&n&&a&&o?(t&&clearTimeout(t),e()):t=setTimeout(r,500)};r()})}}const src_AdExecuteManager=AdExecuteManager;for(var __rspack_i in exports.AdExecuteManager=__webpack_exports__.AdExecuteManager,__webpack_exports__)-1===["AdExecuteManager"].indexOf(__rspack_i)&&(exports[__rspack_i]=__webpack_exports__[__rspack_i]);Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/index.d.ts

@@ -1,15 +1 @@
-export default AdExecuteManager;
-import AdExecuteManager from './core/AdExecuteManager';
-import RewardAdFather from './ad/RewardAdFather';
-import { SerializableError } from './helper/SerializableError';
-import { Logger } from './helper/Logger';
-import Storage from './helper/Storage';
-import { CountRecorder } from './helper/CountRecorder';
-import RewardAdGlobalRecorder from './helper/RewardAdGlobalRecorder';
-import RewardAdSceneTriggerManager from './helper/RewardAdSceneTriggerManager';
-import AdAnalyticsJS from './helper/AdAnalyticsJS';
-import RewardAdNovel from './ad/RewardAdNovel';
-import InterstitialAdFather from './ad/InterstitialAdFather';
-import InterstitialAdNovel from './ad/InterstitialAdNovel';
-import PubSub from './helper/PubSub';
-export { AdExecuteManager, RewardAdFather, SerializableError, Logger, Storage, CountRecorder, RewardAdGlobalRecorder, RewardAdSceneTriggerManager, AdAnalyticsJS, RewardAdNovel, InterstitialAdFather, InterstitialAdNovel, PubSub };
+export { default as AdExecuteManager } from "./AdExecuteManager.js";

package/dist/index.js

@@ -1 +1 @@
-let e=e=>e.map(e=>(t,s)=>async r=>await e(Object.assign({},t,r),s)).reduce((e,t)=>(s,r)=>e(s,t(s,r)));class t{constructor(e={}){let{prefix:t="Logger",level:s="log",enabled:r=!0}=e;this.prefix=t,this.enabled=r,this.levels={error:0,warn:1,info:2,log:3,debug:4},this.currentLevel=this.levels[s]||this.levels.log}enable(){this.enabled=!0}disable(){this.enabled=!1}isEnabled(){return this.enabled}setLevel(e){Object.prototype.hasOwnProperty.call(this.levels,e)&&(this.currentLevel=this.levels[e])}formatMessage(e,t){let s=new Date,r=`${s.getFullYear()}/${s.getMonth()+1}/${s.getDate()} ${s.getHours()}:${s.getMinutes()}:${s.getSeconds()}`;return`[${r}] [${e.toUpperCase()}] [${this.prefix}] ${t}`}_log(e,t,...s){if(!this.enabled)return;let r=this.levels[e];if(void 0!==r&&this.currentLevel>=r){let r=this.formatMessage(e,t);switch(e){case"error":console.error(r,...s);break;case"warn":console.warn(r,...s);break;case"info":console.info(r,...s);break;case"log":default:console.log(r,...s);break;case"debug":console.debug(r,...s)}}}error(e,...t){this._log("error",e,...t)}warn(e,...t){this._log("warn",e,...t)}info(e,...t){this._log("info",e,...t)}log(e,...t){this._log("log",e,...t)}debug(e,...t){this._log("debug",e,...t)}}class s{static _instance=null;_taskStack=[];_currentBatchTasks=[];_isRunning=!1;_currentTask=null;constructor(e){if(this.logger=new t({prefix:"AdExecuteManager",enabled:!!e?.log}),s._instance)return s._instance;s._instance=this}static getInstance(e){return s._instance||(s._instance=new s(e)),s._instance}static getSafeInstance(){return s._instance?s._instance:(this.logger.error("AdExecuteManager实例不存在"),null)}addTask(e,t){return e&&"function"==typeof e.ad?new Promise((s,r)=>{let i={adInstance:e,options:t.options??{},callbackCollection:t.collection??{},resolve:s,reject:r,id:`ad_${Date.now()}_${Math.random().toString(36).substr(2,9)}`,_isResolved:!1,_isRejected:!1};this._taskStack.push(i),this._isRunning||this._compose()}):(this.logger.error("无效的广告实例 请正确实现.ad方法"),Promise.reject(Error("无效的广告实例")))}_compose(){if(0===this._taskStack.length){this._isRunning=!1,this._currentTask=null;return}this._isRunning=!0;let t=[...this._taskStack];this._taskStack=[],this._currentBatchTasks=t;let s=t.map(e=>async(t,s)=>{let{adInstance:r,options:i,callbackCollection:n,resolve:a,id:c}=e;if(e._isResolved||e._isRejected)return void await s(t);this._currentTask=e;try{let l=async e=>{await s(Object.assign({},t,e))},o=await r.initialize(i).ad({options:i,collection:n},l),h=Object.assign({id:c},o);this.logger.info(`任务执行成功，成功信息：${JSON.stringify(h)}`),e._isResolved=!0,a(h),r?.record(h)}catch(n){let i=Object.assign({id:c,apiError:n});this.logger.error(`任务执行失败, 继续下一个任务,错误信息：${JSON.stringify(i)}`),e._isRejected=!0;try{r?.clear()}catch(e){this.logger.error("clear error: ",JSON.stringify(Object.assign({id:c,apiError:e})))}a(i),r?.record(i),await s(t)}}),r={roundTasks:s.length};e(s)(r,async e=>{this.logger.info("本轮活动队列已经清空",e),this._taskStack.length>0?Promise.resolve().then(()=>{this._compose()}):(this._isRunning=!1,this._currentTask=null,this._currentBatchTasks=[])})()}clearTasks(){if(this._currentTask){if(this._currentTask._isResolved||this._currentTask._isRejected){this._currentTask=null;return}try{this._currentTask.callbackCollection&&this._currentTask.callbackCollection.onCancel&&this._currentTask.callbackCollection.onCancel(),this._currentTask._isResolved=!0,this._currentTask.resolve()}catch(e){this.logger.error("clear current task error: ",e)}this._currentTask=null}this._currentBatchTasks.length>0&&(this._currentBatchTasks.forEach(e=>{if(e!==this._currentTask&&!e._isResolved&&!e._isRejected)try{e.callbackCollection&&e.callbackCollection.onCancel&&e.callbackCollection.onCancel(),e._isResolved=!0,e.resolve()}catch(e){this.logger.error("clear current batch task error: ",e)}}),this._currentBatchTasks=[]),this._taskStack.forEach(e=>{if(!e._isResolved&&!e._isRejected&&(e._isResolved=!0,e.resolve(),e.callbackCollection&&e.callbackCollection.onCancel))try{e.callbackCollection.onCancel()}catch(e){this.logger.error("clear task error: ",e)}}),this._taskStack=[],this._isRunning=!1}getTaskCount(){return this._taskStack.filter(e=>!e._isResolved&&!e._isRejected).length+this._currentBatchTasks.filter(e=>e!==this._currentTask&&!e._isResolved&&!e._isRejected).length+(!this._currentTask||this._currentTask._isResolved||this._currentTask._isRejected?0:1)}isRunning(){return this._isRunning}getCurrentTaskId(){return this._currentTask?.id||null}whenAllTasksComplete(){return new Promise(e=>{let t=null,s=()=>{let r=0===this._taskStack.length,i=!this._isRunning,n=null===this._currentTask,a=0===this._currentBatchTasks.length||this._currentBatchTasks.every(e=>e._isResolved||e._isRejected);r&&i&&n&&a?(t&&clearTimeout(t),e()):t=setTimeout(s,500)};s()})}}let r=s;export{r as AdExecuteManager,e as compose};
+import{Logger as e}from"@ad-execute-manager/helper";class t{static _instance=null;_taskStack=[];_currentBatchTasks=[];_isRunning=!1;_currentTask=null;_isForeground=!0;_appShowListener=null;_appHideListener=null;_enableVisibilityListener=!1;_maxRetryCount=1;_retryQueue=[];_errorRetryStrategy={timeout:!0,background:!0};constructor(t){this.logger=new e({prefix:"AdExecuteManager",enabled:!!(null==t?void 0:t.log)}),(null==t?void 0:t.errorRetryStrategy)&&(this._errorRetryStrategy=Object.assign({},this._errorRetryStrategy,null==t?void 0:t.errorRetryStrategy)),this._enableVisibilityListener=null==t?void 0:t.enableVisibilityListener,this._maxRetryCount=(null==t?void 0:t.maxRetryCount)??1,this._enableVisibilityListener&&this._initVisibilityListener()}initialize(e){return this}static getInstance(e){return t._instance||(t._instance=new t(e)),t._instance}static build(e){return t._instance||(t._instance=new t(e)),t._instance}static new(e){return new t(e)}static getSafeInstance(){return t._instance?t._instance:(this.logger.error("AdExecuteManager实例不存在"),null)}_initVisibilityListener(){!("u"<typeof tt)&&tt.onAppShow&&tt.onAppHide?(this._appShowListener=()=>{this._isForeground=!0,this._handleAppShow()},this._appHideListener=()=>{this._isForeground=!1,this._handleAppHide()},tt.onAppShow(this._appShowListener),tt.onAppHide(this._appHideListener),this.logger.info("前后台监听器已初始化")):this.logger.warn("tt API不可用，无法监听前后台状态")}_handleAppHide(){if(this._isRunning&&this._currentBatchTasks.length>0){let e=this._currentBatchTasks.filter(e=>{var t;return e.id!==(null==(t=this._currentTask)?void 0:t.id)&&!e._isResolved&&!e._isRejected});e.length>0&&(this.logger.info(`将 ${e.length} 个未执行的任务放回任务栈,任务ID: ${e.map(e=>e.id).join(",")}`),this._taskStack=[...e,...this._taskStack],this._currentBatchTasks=this._currentBatchTasks.filter(t=>!e.some(e=>e.id===t.id)))}}_handleAppShow(){this._retryQueue.length>0&&(this.logger.info(`应用进入前台:优先执行重试队列，任务数: ${this._retryQueue.length}, 任务ID: ${this._retryQueue.map(e=>e.id).join(",")}`),this._taskStack=[...this._retryQueue,...this._taskStack],this._retryQueue=[]),this._taskStack.length>0&&!this._isRunning&&(this.logger.info(`应用进入前台:恢复待执行任务数: ${this._taskStack.length}, 任务ID: ${this._taskStack.map(e=>e.id).join(",")}`),this._compose())}destroyVisibilityListener(){this._appShowListener&&"u">typeof tt&&tt.offAppShow&&(tt.offAppShow(this._appShowListener),this._appShowListener=null),this._appHideListener&&"u">typeof tt&&tt.offAppHide&&(tt.offAppHide(this._appHideListener),this._appHideListener=null),this.logger.info("前后台监听器已销毁")}enableVisibilityListener(){this._enableVisibilityListener||(this._enableVisibilityListener=!0,this._initVisibilityListener()),this.logger.info("前后台监听器已启用")}disableVisibilityListener(){this._enableVisibilityListener&&(this._enableVisibilityListener=!1,this.destroyVisibilityListener()),this.logger.info("前后台监听器已禁用")}isVisibilityListenerEnabled(){return this._enableVisibilityListener}addTask(e,t){return e&&"function"==typeof e.ad?new Promise((i,r)=>{let s={adInstance:e,options:t.options??{},callbackCollection:t.collection??{},resolve:i,reject:r,id:`ad_${Date.now()}_${Math.random().toString(36).substr(2,9)}`,_isResolved:!1,_isRejected:!1,_retryCount:0,_retryMsg:"ok"};this._taskStack.push(s),this._isRunning||this._compose()}):(this.logger.error("无效的广告实例 请正确实现.ad方法"),Promise.reject(Error("无效的广告实例")))}_compose(){if(0===this._taskStack.length){this._isRunning=!1,this._currentTask=null;return}if(!this._isForeground){this.logger.info(`应用处于后台,暂停任务执行,任务ID: ${this._taskStack.map(e=>e.id).join(",")}`),this._isRunning=!1;return}this._isRunning=!0;let e=[...this._taskStack];this._taskStack=[],this._currentBatchTasks=e;let t=e.map(e=>async(t,i)=>{let{adInstance:r,options:s,callbackCollection:n,resolve:a,id:l,_retryCount:o,_retryMsg:c}=e,h={count:o,retry:o>0,message:c};if(e._isResolved||e._isRejected)return void await i(t);this._currentTask=e;try{let o=async e=>{await i(Object.assign({},t,e))},c=await r.initialize(s).ad({options:s,collection:n,recovered:h},o),u=Object.assign({id:l,recovered:h},c);if(this.logger.info(`任务执行成功，成功信息：${JSON.stringify(u)}`),function({apiError:e,configuredAdTimeout:t,errorRetryStrategy:i}){var r;return!!((null==i?void 0:i.timeout)&&(null==e?void 0:e.errMsg)&&"string"==typeof e.errMsg&&e.errMsg.startsWith("ad_show_timeout: normal")&&(null==e?void 0:e.timeout)==t)||!!((null==i?void 0:i.background)&&(null==(r=e)?void 0:r.errMsg)&&"string"==typeof r.errMsg&&(r.errMsg.startsWith("app in background is not support show ad")||r.errMsg.startsWith("other controller is presented")))}({apiError:null==u?void 0:u.apiError,configuredAdTimeout:r._adTimeoutTime,errorRetryStrategy:this._errorRetryStrategy})&&!this._isForeground&&e._retryCount<this._maxRetryCount){var _;e._retryCount++,e._retryMsg=(null==u||null==(_=u.apiError)?void 0:_.errMsg)||"unknown";let t=`任务 ${l} 在后台失败，加入重试队列 (即将第 ${e._retryCount} 次重试, 最大重试次数 ${this._maxRetryCount}, 重试原因: ${e._retryMsg})`;this.logger.warn(t),u.recovered.retry=!0,u.recovered.count=e._retryCount,u.recovered.message=e._retryMsg,e._isResolved=!1,e._isRejected=!1,this._retryQueue.push(e)}else e._isResolved=!0;a(u),null==r||r.record(u)}catch(n){let s=Object.assign({id:l,apiError:n,recovered:h});this.logger.error(`任务执行失败, 继续下一个任务,错误信息：${JSON.stringify(s)}`),e._isRejected=!0;try{null==r||r.clear()}catch(e){this.logger.error("clear error: ",JSON.stringify(Object.assign({id:l,apiError:e})))}a(s),null==r||r.record(s),await i(t)}}),i={roundTasks:t.length};t.map(e=>(t,i)=>async r=>await e(Object.assign({},t,r),i)).reduce((e,t)=>(i,r)=>e(i,t(i,r)))(i,async e=>{this.logger.info("本轮活动队列已经清空",e),this._taskStack.length>0?Promise.resolve().then(()=>{this._compose()}):(this._isRunning=!1,this._currentTask=null,this._currentBatchTasks=[])})()}clearTasks(){if(this._currentTask){if(this._currentTask._isResolved||this._currentTask._isRejected){this._currentTask=null;return}try{this._currentTask.callbackCollection&&this._currentTask.callbackCollection.onCancel&&this._currentTask.callbackCollection.onCancel(),this._currentTask._isResolved=!0,this._currentTask.resolve()}catch(e){this.logger.error("clear current task error: ",e)}this._currentTask=null}this._currentBatchTasks.length>0&&(this._currentBatchTasks.forEach(e=>{if(e!==this._currentTask&&!e._isResolved&&!e._isRejected)try{e.callbackCollection&&e.callbackCollection.onCancel&&e.callbackCollection.onCancel(),e._isResolved=!0,e.resolve()}catch(e){this.logger.error("clear current batch task error: ",e)}}),this._currentBatchTasks=[]),this._taskStack.forEach(e=>{if(!e._isResolved&&!e._isRejected&&(e._isResolved=!0,e.resolve(),e.callbackCollection&&e.callbackCollection.onCancel))try{e.callbackCollection.onCancel()}catch(e){this.logger.error("clear task error: ",e)}}),this._retryQueue.forEach(e=>{if(!e._isResolved&&!e._isRejected&&(e._isResolved=!0,e.resolve(),e.callbackCollection&&e.callbackCollection.onCancel))try{e.callbackCollection.onCancel()}catch(e){this.logger.error("clear retry task error: ",e)}}),this._taskStack=[],this._retryQueue=[],this._isRunning=!1}getTaskCount(){return this._taskStack.filter(e=>!e._isResolved&&!e._isRejected).length+this._currentBatchTasks.filter(e=>e!==this._currentTask&&!e._isResolved&&!e._isRejected).length+(!this._currentTask||this._currentTask._isResolved||this._currentTask._isRejected?0:1)+this._retryQueue.filter(e=>!e._isResolved&&!e._isRejected).length}isRunning(){return this._isRunning}getCurrentTaskId(){var e;return(null==(e=this._currentTask)?void 0:e.id)||null}whenAllTasksComplete(){return new Promise(e=>{let t=null,i=()=>{let r=0===this._taskStack.length,s=!this._isRunning,n=null===this._currentTask,a=0===this._currentBatchTasks.length||this._currentBatchTasks.every(e=>e._isResolved||e._isRejected),l=0===this._retryQueue.length;r&&s&&n&&a&&l?(t&&clearTimeout(t),e()):t=setTimeout(i,500)};i()})}}let i=t;export{i as AdExecuteManager};

package/dist/typings/ad.d.ts

@@ -5,12 +5,14 @@ export type IRewordAdConfig = {
     adUnitId: string;
     /**
      * 是否开启进度提醒。开启时广告文案为「再看 n 个xxx」，关闭时为「再看 1 个xxx」。其中 n 表示用户当前还需额外观看广告的次数
-     * 再得广告的奖励文案，用户每看完一个广告都会展示，multiton 为 true 时必填。
-     * 文案完整内容为「再看 1 个xxx」，其中 xxx 是 multitonRewardMsg 配置的文案内容，最大长度为 7，
-     * 文案内容根据 multitonRewardMsg 的配置按顺序展示。若 multitonRewardMsg 长度小于 multitonRewardTimes ，
-     * 则后续的激励再得广告文案取 multitonRewardMsg 数组最后一个。
      */
     progressTip?: boolean | undefined;
+    /**
+     * - 再得广告的奖励文案，用户每看完一个广告都会展示，multiton 为 true 时必填。
+     * - 文案完整内容为「再看 1 个xxx」，其中 xxx 是 multitonRewardMsg 配置的文案内容，最大长度为 7，
+     * - 文案内容根据 multitonRewardMsg 的配置按顺序展示。若 multitonRewardMsg 长度小于 multitonRewardTimes ，
+     * - 则后续的激励再得广告文案取 multitonRewardMsg 数组最后一个。
+     */
     multitonRewardMsg?: Array<string> | undefined;
     /**
      * 是否开启激励再得广告
@@ -28,14 +30,14 @@ export type IRewordAdConfig = {
      * 广告超时时间 单位ms - 自用参数，非tt API要求的参数
      */
     timeout?: number | undefined;
-    /**
-     * 奖励金额 - 自用参数 ，非tt API要求的参数
-     */
-    log?: boolean | undefined;
     /**
      * 重试次数 - 自用参数 ，非tt API要求的参数
      */
     retry: number;
+    /**
+     * 是否绑定永远的错误事件 - 自用参数，非tt API要求的参数
+     */
+    foreverErrorBind?: boolean | undefined;
 };
 export type InterstitialAdConfig = {
     /**
@@ -99,6 +101,20 @@ export type CallbackCollection = {
      */
     prelude?: (ctx?: unknown) => void;
 };
+export type RecoveredInfo = {
+    /**
+     * 恢复重试次数
+     */
+    count: number;
+    /**
+     * 是否恢复重试
+     */
+    retry: boolean;
+    /**
+     * 恢复重试原因
+     */
+    message: string;
+};
 export type ICallbackArgs = {
     /**
      * 广告执行场景
@@ -151,6 +167,10 @@ export type IConstructArgs = {
      * 初始化标识
      */
     sign: string;
+    /**
+     * 是否开启日志
+     */
+    log?: boolean | undefined;
     /**
      * 重试次数
      */

package/package.json

@@ -1,13 +1,8 @@
 {
   "name": "@ad-execute-manager/core",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.4",
+  "description": "Core functionality for ad execution management including AdExecuteManager, utility functions, and middleware composition.",
   "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -15,7 +10,60 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "author": "singcl",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "singcl",
+    "email": "iambabyer@gmail.com",
+    "url": "https://github.com/singcl"
+  },
   "license": "MIT",
-  "homepage": "https://npmjs.com/package/@ad-execute-manager/core"
+  "homepage": "https://npmjs.com/package/@singcl/core",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/singcl/ad-execute-manager.git"
+  },
+  "bugs": {
+    "url": "https://github.com/singcl/ad-execute-manager/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "keywords": [
+    "core",
+    "ad-manager",
+    "ad-execution",
+    "middleware",
+    "compose",
+    "utilities",
+    "javascript",
+    "nodejs"
+  ],
+  "scripts": {
+    "build": "rslib build && tsc",
+    "dev": "rslib build --watch",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "test": "rstest",
+    "prepublishOnly": "npm run build"
+  },
+
+  "dependencies": {
+    "@ad-execute-manager/helper": "^2.0.0-alpha.2"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@eslint/js": "^9.39.1",
+    "@rslib/core": "^0.18.5",
+    "@rstest/core": "^0.7.2",
+    "eslint": "^9.39.2",
+    "eslint-plugin-import": "^2.32.0",
+    "globals": "^16.5.0",
+    "prettier": "^3.7.3",
+    "typescript": "^5.9.3"
+  }
 }