@ad-execute-manager/count-recorder 2.0.1

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,272 @@
+# @ad-execute-manager/count-recorder
+
+A flexible count recorder utility for JavaScript applications with daily tracking, expiration support, and user-specific counting.
+
+## Installation
+
+```bash
+npm install @ad-execute-manager/count-recorder
+```
+
+## Features
+
+- **Daily Count Tracking**: Track counts on a daily basis with automatic reset
+- **Expiration Support**: Set expiration times for count data, including 'today' option
+- **User-specific Counting**: Track counts per user with automatic userId integration
+- **Storage Integration**: Uses @ad-execute-manager/storage for persistent storage
+- **Total Count Management**: Set and manage total count limits
+- **Remaining Count Calculation**: Automatically calculate remaining counts
+- **TypeScript Support**: Includes TypeScript type definitions
+- **Error Handling**: Built-in error handling for required parameters
+
+## Usage
+
+### Basic Usage
+
+```javascript
+import { CountRecorder } from '@ad-execute-manager/count-recorder';
+
+// Create a count recorder instance
+const dailyTaskRecorder = CountRecorder.new({
+  local_sign: 'daily_task_recorder',
+  total: 5, // Maximum 5 times per day
+  expire: 'today', // Reset daily
+  userId: 'user123' // User-specific counting
+});
+
+// Check remaining counts
+const remaining = dailyTaskRecorder.remain();
+console.log('Remaining tasks:', remaining);
+
+if (remaining > 0) {
+  // Perform the task
+  console.log('Performing task...');
+  
+  // Update the count
+  dailyTaskRecorder.updateToday();
+  
+  console.log('Task performed, count updated');
+} else {
+  console.log('Daily limit reached');
+}
+```
+
+### Advanced Usage
+
+```javascript
+import { CountRecorder } from '@ad-execute-manager/count-recorder';
+
+// Create multiple recorders for different purposes
+
+// Daily ad impression recorder
+const adRecorder = CountRecorder.new({
+  local_sign: 'ad_impression_recorder',
+  total: 10, // Maximum 10 ads per day
+  expire: 'today',
+  userId: 'user123'
+});
+
+// Weekly feature usage recorder
+const featureRecorder = CountRecorder.new({
+  local_sign: 'feature_usage_recorder',
+  total: 20, // Maximum 20 uses per week
+  expire: 7 * 24 * 60 * 60 * 1000, // 7 days expiration
+  userId: 'user123'
+});
+
+// Check and use ad impressions
+function showAd() {
+  const remaining = adRecorder.remain();
+  
+  if (remaining > 0) {
+    console.log('Showing ad...');
+    adRecorder.updateToday();
+    console.log('Ad shown, remaining:', adRecorder.remain());
+    return true;
+  } else {
+    console.log('Ad limit reached for today');
+    return false;
+  }
+}
+
+// Check and use feature
+function usePremiumFeature() {
+  const remaining = featureRecorder.remain();
+  
+  if (remaining > 0) {
+    console.log('Using premium feature...');
+    featureRecorder.updateToday();
+    console.log('Feature used, remaining:', featureRecorder.remain());
+    return true;
+  } else {
+    console.log('Feature usage limit reached');
+    return false;
+  }
+}
+
+// Usage examples
+// showAd();
+// usePremiumFeature();
+```
+
+## API
+
+### Constructor
+
+```javascript
+new CountRecorder(args)
+```
+
+- **args** (Object): Configuration arguments
+  - **local_sign** (String): Local storage identifier (required)
+  - **total** (Number): Total count limit, defaults to 0
+  - **expire** (Number|'today'): Expiration time in milliseconds or 'today' for day-bound, defaults to 'today'
+  - **userId** (String|Number): User ID for user-specific counting
+
+### Methods
+
+- **remain()**: Get remaining count
+  - **returns** (Number): Remaining count
+
+- **updateToday()**: Update today's count
+
+### Static Methods
+
+- **CountRecorder.new(args)**: Create a new CountRecorder instance
+  - **args** (Object): Same as constructor arguments
+  - **returns** (CountRecorder): New CountRecorder instance
+
+## Examples
+
+### Example 1: Daily Login Tracker
+
+```javascript
+import { CountRecorder } from '@ad-execute-manager/count-recorder';
+
+// Create login recorder
+const loginRecorder = CountRecorder.new({
+  local_sign: 'daily_login_recorder',
+  total: 1, // Only one login count per day
+  expire: 'today',
+  userId: 'user123'
+});
+
+// Check if user has already logged in today
+function checkDailyLogin() {
+  const remaining = loginRecorder.remain();
+  
+  if (remaining > 0) {
+    console.log('First login today');
+    // Give daily login bonus
+    giveDailyBonus();
+    // Update login count
+    loginRecorder.updateToday();
+  } else {
+    console.log('Already logged in today');
+  }
+}
+
+// Give daily bonus
+function giveDailyBonus() {
+  console.log('Giving daily login bonus...');
+  // Bonus logic here
+}
+
+// Usage
+// checkDailyLogin();
+```
+
+### Example 2: Ad Impression Limiter
+
+```javascript
+import { CountRecorder } from '@ad-execute-manager/count-recorder';
+
+// Create ad impression recorder
+const adRecorder = CountRecorder.new({
+  local_sign: 'ad_impression_recorder',
+  total: 8, // Maximum 8 ads per day
+  expire: 'today',
+  userId: 'user123'
+});
+
+// Check if ad can be shown
+function canShowAd() {
+  const remaining = adRecorder.remain();
+  return remaining > 0;
+}
+
+// Show ad and update count
+function showAd() {
+  if (canShowAd()) {
+    console.log('Showing ad...');
+    // Ad showing logic here
+    adRecorder.updateToday();
+    console.log('Ad shown, remaining impressions:', adRecorder.remain());
+    return true;
+  } else {
+    console.log('Ad limit reached for today');
+    return false;
+  }
+}
+
+// Check remaining ad impressions
+function checkAdLimit() {
+  const remaining = adRecorder.remain();
+  console.log(`Remaining ad impressions: ${remaining}/8`);
+  return remaining;
+}
+
+// Usage examples
+// checkAdLimit();
+// showAd();
+```
+
+### Example 3: Feature Usage Tracker
+
+```javascript
+import { CountRecorder } from '@ad-execute-manager/count-recorder';
+
+// Create feature usage recorder
+const featureRecorder = CountRecorder.new({
+  local_sign: 'premium_feature_recorder',
+  total: 15, // Maximum 15 uses per day
+  expire: 'today',
+  userId: 'user123'
+});
+
+// Use premium feature
+function usePremiumFeature(featureName) {
+  const remaining = featureRecorder.remain();
+  
+  if (remaining > 0) {
+    console.log(`Using premium feature: ${featureName}`);
+    // Feature usage logic here
+    featureRecorder.updateToday();
+    console.log(`Feature used, remaining uses: ${featureRecorder.remain()}/15`);
+    return true;
+  } else {
+    console.log('Premium feature usage limit reached for today');
+    return false;
+  }
+}
+
+// Check feature usage status
+function checkFeatureUsage() {
+  const remaining = featureRecorder.remain();
+  const used = 15 - remaining;
+  console.log(`Premium feature usage: ${used}/15 today`);
+  return { used, remaining, total: 15 };
+}
+
+// Usage examples
+// checkFeatureUsage();
+// usePremiumFeature('AI Summarizer');
+```
+
+## Dependencies
+
+- **@ad-execute-manager/storage**: For persistent storage of count data
+
+## License
+
+MIT

package/dist/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 '@ad-execute-manager/storage';

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 _ in t)__webpack_require__.o(t,_)&&!__webpack_require__.o(e,_)&&Object.defineProperty(e,_,{enumerable:!0,get:t[_]})},__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__,{CountRecorder:()=>CountRecorder});const storage_namespaceObject=require("@ad-execute-manager/storage");class CountRecorder{_total=0;_local_sign="";_expire="today";constructor(e){if(this.storage=storage_namespaceObject.Storage.new({userId:e.userId}),!e.local_sign)throw Error("local_sign is required");this._local_sign=e.local_sign,this._total=e.total??0,this._expire=e.expire??"today",this._init()}_init(){this._initLocalTimes()}_adTimes(){return this._total}_safeLocalValue(e){return"object"!=typeof e||null===e?{}:e}_initLocalTimes(){let e=this._adTimes(),t=this.storage.getUserItem(this._local_sign),_=this._safeLocalValue(t);_&&(null==_?void 0:_.total)==e||this.storage.setUserItem(this._local_sign,{total:e,today:(null==_?void 0:_.today)??0},this._expire)}updateToday(){let e=this._adTimes(),t=this.storage.getUserItem(this._local_sign),_=this._safeLocalValue(t),r=(null==_?void 0:_.today)??0;this.storage.setUserItem(this._local_sign,{total:e,today:r+1},this._expire)}remain(){let e=this.storage.getUserItem(this._local_sign),t=this._safeLocalValue(e),_=(null==t?void 0:t.today)??0;return Number((null==t?void 0:t.total)??0)-Number(_)}static new(e){return new CountRecorder(e)}}for(var __rspack_i in exports.CountRecorder=__webpack_exports__.CountRecorder,__webpack_exports__)-1===["CountRecorder"].indexOf(__rspack_i)&&(exports[__rspack_i]=__webpack_exports__[__rspack_i]);Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { CountRecorder } from "./CountRecorder.js";

package/dist/index.js

@@ -0,0 +1 @@
+import{Storage as t}from"@ad-execute-manager/storage";class e{_total=0;_local_sign="";_expire="today";constructor(e){if(this.storage=t.new({userId:e.userId}),!e.local_sign)throw Error("local_sign is required");this._local_sign=e.local_sign,this._total=e.total??0,this._expire=e.expire??"today",this._init()}_init(){this._initLocalTimes()}_adTimes(){return this._total}_safeLocalValue(t){return"object"!=typeof t||null===t?{}:t}_initLocalTimes(){let t=this._adTimes(),e=this.storage.getUserItem(this._local_sign),s=this._safeLocalValue(e);s&&(null==s?void 0:s.total)==t||this.storage.setUserItem(this._local_sign,{total:t,today:(null==s?void 0:s.today)??0},this._expire)}updateToday(){let t=this._adTimes(),e=this.storage.getUserItem(this._local_sign),s=this._safeLocalValue(e),i=(null==s?void 0:s.today)??0;this.storage.setUserItem(this._local_sign,{total:t,today:i+1},this._expire)}remain(){let t=this.storage.getUserItem(this._local_sign),e=this._safeLocalValue(t),s=(null==e?void 0:e.today)??0;return Number((null==e?void 0:e.total)??0)-Number(s)}static new(t){return new e(t)}}export{e as CountRecorder};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@ad-execute-manager/count-recorder",
+  "version": "2.0.1",
+  "description": "A flexible count recorder utility for JavaScript applications with multiple count recorder adapters and customizable options.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "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/logger",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/singcl/ad-execute-manager.git",
+    "directory": "packages/logger"
+  },
+  "bugs": {
+    "url": "https://github.com/singcl/ad-execute-manager/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "keywords": [
+    "logger",
+    "logging",
+    "utility",
+    "javascript",
+    "nodejs",
+    "typescript",
+    "log-levels",
+    "debug"
+  ],
+  "scripts": {
+    "build": "rslib build && tsc",
+    "dev": "rslib build --watch",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "test": "rstest",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@ad-execute-manager/storage": "^2.0.1"
+  },
+  "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"
+  }
+}