@resolid/cache 0.1.1 → 1.0.0

package/README.md

@@ -1,17 +1,15 @@
-# Resolid: Cache Package
+# Type-safe Async Cache for TypeScript
 
 ![GitHub License](https://img.shields.io/github/license/resolid/framework)
 ![NPM Version](https://img.shields.io/npm/v/%40resolid/cache)
 
 <b>[Documentation](https://www.resolid.tech/docs/cache)</b> | [Framework Bundle](https://github.com/resolid/framework)
 
-## Type-safe Async Cache for TypeScript
-
 A fully-typed, flexible cache system for modern TypeScript projects.
 Supports single and batch operations, optional TTL, and pluggable storage backends.
 Designed for libraries, frameworks, and applications needing predictable async caching.
 
-### Feature
+## Feature
 
 - Fully typed with TypeScript — no `any`.
 - Supports get/set/del/clear operations.
@@ -21,7 +19,7 @@ Designed for libraries, frameworks, and applications needing predictable async c
 - Detects existence of keys via `has`.
 - Handles disposal of resources via `dispose`.
 
-### Installation
+## Installation
 
 ```shell
 pnpm add @resolid/cache
@@ -33,12 +31,12 @@ yarn add @resolid/cache
 bun add @resolid/cache
 ```
 
-### Usage
+## Usage
 
 ```js
-import { createCache } from "@resolid/cache";
+import { Cacher } from "@resolid/cache";
 
-const cache = createCache({ defaultTtl: 1000 });
+const cache = new Cacher({ defaultTtl: 1000 });
 
 // Single set/get
 await cache.set("foo", { a: 1 });
@@ -62,16 +60,16 @@ await cache.clear();
 await cache.dispose();
 ```
 
-### Options
+## Options
 
 ```ts
-export type CreateCacheOptions = {
-  store?: CacheStore; // Custom storage backend
-  defaultTtl?: number; // Default TTL in seconds
-};
+export interface CacheOptions {
+  store?: CacheStore;
+  defaultTtl?: number;
+}
 ```
 
-### Store Interface
+## Store Interface
 
 Your custom store should implement `CacheStore`:
 

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import { t as CacheStore } from "./types-D3cbGkJC.mjs";
+
+//#region src/index.d.ts
+interface CacheOptions {
+  store?: CacheStore;
+  defaultTtl?: number;
+}
+declare class Cacher {
+  private readonly _store;
+  private readonly _defaultTtl?;
+  constructor({
+    store,
+    defaultTtl
+  }?: CacheOptions);
+  get<T>(key: string, defaultValue?: T): Promise<T | undefined>;
+  set<T>(key: string, value: T, ttl?: number): Promise<boolean>;
+  del(key: string): Promise<boolean>;
+  clear(): Promise<boolean>;
+  getMultiple<T>(keys: string[], defaultValue?: T): Promise<(T | undefined)[]>;
+  setMultiple<T>(values: Record<string, T>, ttl?: number): Promise<boolean>;
+  delMultiple(keys: string[]): Promise<boolean>;
+  has(key: string): Promise<boolean>;
+  dispose(): Promise<void>;
+}
+//#endregion
+export { CacheOptions, Cacher };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{t as e}from"./null-cache-DGPituGm.mjs";import{destr as t}from"destr";const n=e=>{let t=e.split(`?`)[0].replace(/[/\\]/g,`:`).replace(/:+/g,`:`).replace(/^:|:$/g,``);if(!t)throw Error(`Cache key cannot be empty after normalization`);return t};var r=class{_store;_defaultTtl;constructor({store:t=new e,defaultTtl:n}={}){this._store=t,this._defaultTtl=n}async get(e,r){let i=await this._store.get(n(e));return i===void 0?r:t(i)}set(e,t,r){return this._store.set(n(e),JSON.stringify(t),r??this._defaultTtl)}del(e){return this._store.del(n(e))}clear(){return this._store.clear()}async getMultiple(e,r){return this._store.getMultiple?(await this._store.getMultiple(e.map(n))).map(e=>e===void 0?r:t(e)):Promise.all(e.map(e=>this.get(e,r)))}async setMultiple(e,t){if(this._store.setMultiple){let r=Object.entries(e).reduce((e,[t,r])=>(e[n(t)]=JSON.stringify(r),e),{});return this._store.setMultiple(r,t)}return(await Promise.all(Object.entries(e).map(([e,n])=>this.set(e,n,t)))).every(Boolean)}async delMultiple(e){return this._store.delMultiple?this._store.delMultiple(e.map(n)):(await Promise.all(e.map(e=>this.del(e)))).every(Boolean)}async has(e){return this._store.has?this._store.has(n(e)):await this.get(e)!==void 0}async dispose(){await this._store.dispose?.()}};export{r as Cacher};

package/dist/null-cache-DGPituGm.mjs

@@ -0,0 +1 @@
+var e=class{async get(e){}async set(e,t,n){return!0}async del(e){return!0}async clear(){return!0}async getMultiple(e){return e.map(()=>void 0)}async setMultiple(e,t){return!0}async delMultiple(e){return!0}async has(e){return!1}async dispose(){}};export{e as t};

package/dist/stores.d.mts

@@ -0,0 +1,27 @@
+import { t as CacheStore } from "./types-D3cbGkJC.mjs";
+
+//#region src/stores/memory-cache.d.ts
+declare class MemoryCache implements CacheStore {
+  private readonly _lru;
+  constructor(maxSize?: number);
+  get(key: string): Promise<string | undefined>;
+  set(key: string, value: string, ttl?: number): Promise<boolean>;
+  del(key: string): Promise<boolean>;
+  clear(): Promise<boolean>;
+  dispose(): Promise<void>;
+}
+//#endregion
+//#region src/stores/null-cache.d.ts
+declare class NullCache implements Required<CacheStore> {
+  get<T>(_key: string): Promise<T>;
+  set(__key: string, _value: string, _ttl?: number): Promise<boolean>;
+  del(_key: string): Promise<boolean>;
+  clear(): Promise<boolean>;
+  getMultiple<T>(keys: string[]): Promise<(T | undefined)[]>;
+  setMultiple(_values: Record<string, string>, _ttl?: number): Promise<boolean>;
+  delMultiple(_keys: string[]): Promise<boolean>;
+  has(_key: string): Promise<boolean>;
+  dispose(): Promise<void>;
+}
+//#endregion
+export { CacheStore, MemoryCache, NullCache };

package/dist/stores.mjs

@@ -0,0 +1 @@
+import{t as e}from"./null-cache-DGPituGm.mjs";import t from"quick-lru";var n=class{_lru;constructor(e=1e3){this._lru=new t({maxSize:e})}async get(e){return this._lru.get(e)}async set(e,t,n){return this._lru.set(e,t,n?{maxAge:n*1e3}:void 0),!0}async del(e){return this._lru.delete(e)}async clear(){return this._lru.clear(),!0}async dispose(){this._lru.clear()}};export{n as MemoryCache,e as NullCache};

package/dist/{index-DvzAtk0z.d.ts → types-D3cbGkJC.d.mts}

@@ -1,5 +1,5 @@
-//#region src/types/index.d.ts
-type CacheStore = {
+//#region src/stores/types.d.ts
+interface CacheStore {
   get: (key: string) => Promise<string | undefined>;
   set: (key: string, value: string, ttl?: number) => Promise<boolean>;
   del: (key: string) => Promise<boolean>;
@@ -9,6 +9,6 @@ type CacheStore = {
   delMultiple?: (keys: string[]) => Promise<boolean>;
   has?: (key: string) => Promise<boolean>;
   dispose?: () => Promise<void> | void;
-};
+}
 //#endregion
 export { CacheStore as t };

package/package.json

@@ -1,69 +1,58 @@
 {
   "name": "@resolid/cache",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "private": false,
-  "description": "The Resolid Cache package.",
+  "description": "Type-safe Async Cache for TypeScript",
   "keywords": [
-    "resolid",
     "cache",
-    "cache manager"
+    "cache manager",
+    "resolid"
   ],
   "homepage": "https://www.resolid.tech",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/resolid/framework.git",
-    "directory": "packages/cache"
-  },
   "license": "MIT",
   "author": {
     "name": "Huijie Wei",
     "email": "hello@resolid.tech"
   },
-  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/resolid/framework.git",
+    "directory": "packages/cache"
+  },
+  "files": [
+    "dist"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     },
     "./stores": {
-      "types": "./dist/stores.d.ts",
-      "import": "./dist/stores.js"
-    },
-    "./utils": {
-      "types": "./dist/utils.d.ts",
-      "import": "./dist/utils.js"
-    },
-    "./types": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/types.js"
+      "types": "./dist/stores.d.mts",
+      "import": "./dist/stores.mjs"
     }
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "dependencies": {
     "destr": "^2.0.5",
     "quick-lru": "^7.3.0"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "beta",
-    "tsdown": "^0.15.9",
-    "typescript": "^5.9.3",
-    "vitest": "beta"
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3"
   },
   "engines": {
-    "node": "^20.19.0 || ^22.13.0 || >=24"
-  },
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
+    "node": "^22.13.0 || >=24"
   },
   "scripts": {
     "build": "tsdown",
-    "lint": "eslint .",
+    "lint": "oxlint",
     "test": "vitest run",
     "typecheck": "tsc --noEmit"
   }

package/dist/index.d.ts

@@ -1,21 +0,0 @@
-import { t as CacheStore } from "./index-DvzAtk0z.js";
-
-//#region src/index.d.ts
-type CreateCacheOptions = {
-  store?: CacheStore;
-  defaultTtl?: number;
-};
-type CacheInstance = {
-  get: <T>(key: string, defaultValue?: T) => Promise<T | undefined>;
-  set: <T>(key: string, value: T, ttl?: number) => Promise<boolean>;
-  del: (key: string) => Promise<boolean>;
-  clear: () => Promise<boolean>;
-  getMultiple: <T>(keys: string[], defaultValue?: T) => Promise<(T | undefined)[]>;
-  setMultiple: <T>(values: Record<string, T>, ttl?: number) => Promise<boolean>;
-  delMultiple: (keys: string[]) => Promise<boolean>;
-  has: (key: string) => Promise<boolean>;
-  dispose: () => Promise<void> | void;
-};
-declare const createCache: (options?: CreateCacheOptions) => CacheInstance;
-//#endregion
-export { CacheInstance, CreateCacheOptions, createCache };

package/dist/index.js

@@ -1 +0,0 @@
-import{t as e}from"./null-cache-2iHFUXTp.js";import{t}from"./utils-CV58ddJF.js";import{destr as n}from"destr";const r=(r={})=>{let{defaultTtl:i,store:a=e}=r,o=async(e,r)=>{let i=await a.get(t(e));return i===void 0?r:n(i)},s=(e,n,r)=>a.set(t(e),JSON.stringify(n),r??i),c=e=>a.del(t(e));return{get:o,set:s,del:c,clear:()=>a.clear(),getMultiple:(e,r)=>typeof a.getMultiple==`function`?a.getMultiple(e.map(e=>t(e))).then(e=>e.map(e=>e===void 0?r:n(e))):Promise.all(e.map(e=>o(e,r))),setMultiple:(e,n)=>typeof a.setMultiple==`function`?a.setMultiple(Object.entries(e).reduce((e,[n,r])=>(e[t(n)]=JSON.stringify(r),e),{}),n):Promise.all(Object.entries(e).map(([e,t])=>s(e,t,n))).then(e=>e.every(Boolean)),delMultiple:e=>typeof a.delMultiple==`function`?a.delMultiple(e.map(e=>t(e))):Promise.all(e.map(c)).then(e=>e.every(Boolean)),has:async e=>typeof a.has==`function`?a.has(t(e)):o(e).then(e=>e!==void 0),dispose:async()=>{a.dispose&&await a.dispose()}}};export{r as createCache};

package/dist/null-cache-2iHFUXTp.js

@@ -1 +0,0 @@
-const e={get:async()=>{},set:async()=>!0,del:async()=>!0,clear:async()=>!0,getMultiple:async e=>e.map(()=>void 0),setMultiple:async()=>!0,delMultiple:async()=>!0,has:async()=>!1,dispose:async()=>{}};export{e as t};

package/dist/stores.d.ts

@@ -1,9 +0,0 @@
-import { t as CacheStore } from "./index-DvzAtk0z.js";
-
-//#region src/stores/memory-cache.d.ts
-declare const createMemoryCache: (maxSize?: number) => CacheStore;
-//#endregion
-//#region src/stores/null-cache.d.ts
-declare const nullCache: Required<CacheStore>;
-//#endregion
-export { createMemoryCache, nullCache };

package/dist/stores.js

@@ -1 +0,0 @@
-import{t as e}from"./null-cache-2iHFUXTp.js";import t from"quick-lru";const n=(e=1e3)=>{let n=new t({maxSize:e});return{get:async e=>n.get(e),set:async(e,t,r)=>(n.set(e,t,r?{maxAge:r*1e3}:void 0),!0),del:async e=>n.delete(e),clear:async()=>(n.clear(),!0),dispose:async()=>{n.clear()}}};export{n as createMemoryCache,e as nullCache};

package/dist/types.d.ts

@@ -1,2 +0,0 @@
-import { t as CacheStore } from "./index-DvzAtk0z.js";
-export { CacheStore };

package/dist/types.js

@@ -1 +0,0 @@
-export{};

package/dist/utils-CV58ddJF.js

@@ -1 +0,0 @@
-const e=e=>{let t=e.split(`?`)[0].replace(/[/\\]/g,`:`).replace(/:+/g,`:`).replace(/^:|:$/g,``);if(!t)throw Error(`Cache key cannot be empty after normalization`);return t};export{e as t};

package/dist/utils.d.ts

@@ -1,4 +0,0 @@
-//#region src/utils/index.d.ts
-declare const normalizeKey: (key: string) => string;
-//#endregion
-export { normalizeKey };

package/dist/utils.js

@@ -1 +0,0 @@
-import{t as e}from"./utils-CV58ddJF.js";export{e as normalizeKey};