cache-sync-keyv 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2025 Bruno Moraes
+
+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 @@
+TODO: Create readme for package

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var _=Object.create;var o=Object.defineProperty;var E=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var p=Object.getPrototypeOf,b=Object.prototype.hasOwnProperty;var T=(r,t)=>{for(var e in t)o(r,e,{get:t[e],enumerable:!0})},c=(r,t,e,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of h(t))!b.call(r,s)&&s!==e&&o(r,s,{get:()=>t[s],enumerable:!(i=E(t,s))||i.enumerable});return r};var u=(r,t,e)=>(e=r!=null?_(p(r)):{},c(t||!r||!r.__esModule?o(e,"default",{value:r,enumerable:!0}):e,r)),g=r=>c(o({},"__esModule",{value:!0}),r);var m={};T(m,{KeyvCacheSync:()=>n});module.exports=g(m);var l=u(require("eventemitter3"),1),a=u(require("keyv"),1);var n=class extends l.default{_store;_sizeLimit=0;_trackStatsEnabled=!1;_statsTracker;_hooks=new Map;constructor(t){super(),this._store=this.initStore(t),this._statsTracker=this.initStatsTracker(),this._trackStatsEnabled=!1}initStore(t){let e=new a.default;return t||e}initStatsTracker(){return{size:0,capacity:0,hits:0,misses:0,hitRate:0,averageLoadDuration:0,successfulLoads:0,failedLoads:0,totalLoadDuration:0,mostAccessed:[],leastAccessed:[]}}get store(){return this._store}set store(t){this._store=t}get sizeLimit(){return this._sizeLimit}set sizeLimit(t){this._sizeLimit=t}get trackStatsEnabled(){return this._trackStatsEnabled}set trackStatsEnabled(t){this._trackStatsEnabled=t}get statsTracker(){return this._statsTracker}set statsTracker(t){this._statsTracker=t}get hooks(){return this._hooks}setHook(t,e){this._hooks.set(t,e)}deleteHook(t){this._hooks.delete(t)}triggerHook(t,...e){let i=this._hooks.get(t);i&&i(...e)}async set(t,e,i){try{let s=[t,e,i];return this.triggerHook(a.KeyvHooks.PRE_SET,...s),await this._store.set(t,e,i),this.triggerHook(a.KeyvHooks.POST_SET,...s),!0}catch(s){return this.emit("on_error",s),!1}}async get(t){try{this.triggerHook(a.KeyvHooks.PRE_GET,t);let e=await this._store.get(t);return this.triggerHook(a.KeyvHooks.POST_GET,t,e),e}catch(e){this.emit("on_error",e);return}}};0&&(module.exports={KeyvCacheSync});

package/dist/index.d.cts

@@ -0,0 +1,49 @@
+import EventEmitter from 'eventemitter3';
+import Keyv from 'keyv';
+
+type KeyvHookCallBack<TArgs extends unknown[] = unknown[]> = (...args: TArgs) => void;
+type KeyvStatItem = {
+    cacheKey: string;
+    lastAccess: number;
+    totalAccess: number;
+};
+type KeyvStats = {
+    size: number;
+    capacity: number;
+    hits: number;
+    misses: number;
+    hitRate: number;
+    averageLoadDuration: number;
+    successfulLoads: number;
+    failedLoads: number;
+    totalLoadDuration: number;
+    mostAccessed: KeyvStatItem[];
+    leastAccessed: KeyvStatItem[];
+};
+
+declare class KeyvCacheSync extends EventEmitter {
+    private _store;
+    private _sizeLimit;
+    private _trackStatsEnabled;
+    private _statsTracker;
+    private _hooks;
+    constructor(keyv?: Keyv);
+    private initStore;
+    private initStatsTracker;
+    get store(): Keyv;
+    set store(store: Keyv);
+    get sizeLimit(): number;
+    set sizeLimit(sizeLimit: number);
+    get trackStatsEnabled(): boolean;
+    set trackStatsEnabled(enabled: boolean);
+    get statsTracker(): KeyvStats;
+    set statsTracker(statsTracker: KeyvStats);
+    get hooks(): Map<string, KeyvHookCallBack>;
+    setHook(hookName: string, hookCallback: KeyvHookCallBack): void;
+    deleteHook(hookName: string): void;
+    triggerHook(hookName: string, ...args: unknown[]): void;
+    set(key: string, value: string, ttl?: number): Promise<boolean>;
+    get<T>(key: string): Promise<T | undefined>;
+}
+
+export { KeyvCacheSync, type KeyvHookCallBack, type KeyvStatItem, type KeyvStats };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import EventEmitter from 'eventemitter3';
+import Keyv from 'keyv';
+
+type KeyvHookCallBack<TArgs extends unknown[] = unknown[]> = (...args: TArgs) => void;
+type KeyvStatItem = {
+    cacheKey: string;
+    lastAccess: number;
+    totalAccess: number;
+};
+type KeyvStats = {
+    size: number;
+    capacity: number;
+    hits: number;
+    misses: number;
+    hitRate: number;
+    averageLoadDuration: number;
+    successfulLoads: number;
+    failedLoads: number;
+    totalLoadDuration: number;
+    mostAccessed: KeyvStatItem[];
+    leastAccessed: KeyvStatItem[];
+};
+
+declare class KeyvCacheSync extends EventEmitter {
+    private _store;
+    private _sizeLimit;
+    private _trackStatsEnabled;
+    private _statsTracker;
+    private _hooks;
+    constructor(keyv?: Keyv);
+    private initStore;
+    private initStatsTracker;
+    get store(): Keyv;
+    set store(store: Keyv);
+    get sizeLimit(): number;
+    set sizeLimit(sizeLimit: number);
+    get trackStatsEnabled(): boolean;
+    set trackStatsEnabled(enabled: boolean);
+    get statsTracker(): KeyvStats;
+    set statsTracker(statsTracker: KeyvStats);
+    get hooks(): Map<string, KeyvHookCallBack>;
+    setHook(hookName: string, hookCallback: KeyvHookCallBack): void;
+    deleteHook(hookName: string): void;
+    triggerHook(hookName: string, ...args: unknown[]): void;
+    set(key: string, value: string, ttl?: number): Promise<boolean>;
+    get<T>(key: string): Promise<T | undefined>;
+}
+
+export { KeyvCacheSync, type KeyvHookCallBack, type KeyvStatItem, type KeyvStats };

package/dist/index.js

@@ -0,0 +1 @@
+import o from"eventemitter3";import n,{KeyvHooks as i}from"keyv";var a=class extends o{_store;_sizeLimit=0;_trackStatsEnabled=!1;_statsTracker;_hooks=new Map;constructor(t){super(),this._store=this.initStore(t),this._statsTracker=this.initStatsTracker(),this._trackStatsEnabled=!1}initStore(t){let e=new n;return t||e}initStatsTracker(){return{size:0,capacity:0,hits:0,misses:0,hitRate:0,averageLoadDuration:0,successfulLoads:0,failedLoads:0,totalLoadDuration:0,mostAccessed:[],leastAccessed:[]}}get store(){return this._store}set store(t){this._store=t}get sizeLimit(){return this._sizeLimit}set sizeLimit(t){this._sizeLimit=t}get trackStatsEnabled(){return this._trackStatsEnabled}set trackStatsEnabled(t){this._trackStatsEnabled=t}get statsTracker(){return this._statsTracker}set statsTracker(t){this._statsTracker=t}get hooks(){return this._hooks}setHook(t,e){this._hooks.set(t,e)}deleteHook(t){this._hooks.delete(t)}triggerHook(t,...e){let r=this._hooks.get(t);r&&r(...e)}async set(t,e,r){try{let s=[t,e,r];return this.triggerHook(i.PRE_SET,...s),await this._store.set(t,e,r),this.triggerHook(i.POST_SET,...s),!0}catch(s){return this.emit("on_error",s),!1}}async get(t){try{this.triggerHook(i.PRE_GET,t);let e=await this._store.get(t);return this.triggerHook(i.POST_GET,t,e),e}catch(e){this.emit("on_error",e);return}}};export{a as KeyvCacheSync};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "cache-sync-keyv",
+  "version": "0.0.1",
+  "description": "cache-sync keyv package",
+  "license": "MIT",
+  "author": {
+    "name": "Bruno Moraes",
+    "email": "brunoskr23@gmail.com"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "*.md"
+  ],
+  "engines": {
+    "node": ">=20.17.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0"
+  },
+  "keywords": [
+    "keyv",
+    "node.js",
+    "typescript",
+    "cache-sync"
+  ],
+  "dependencies": {
+    "eventemitter3": "^5.0.1",
+    "keyv": "^5.5.5"
+  },
+  "peerDependencies": {
+    "eslint": "^9.28.0",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.34.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "prebuild": "pnpm run clean && pnpm run lint:fix && pnpm run format:fix",
+    "build": "pnpm run prebuild && tsup",
+    "test": "vitest run --coverage",
+    "test:file": "vitest run",
+    "test:file:watch": "pnpm test:file --watch",
+    "lint": "eslint",
+    "lint:fix": "pnpm run lint --fix",
+    "format": "prettier --check ./",
+    "format:fix": "prettier --write ./"
+  }
+}