@resolid/cache-file 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present, Resolid Tech
+
+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,10 @@
+# File Cache store for @resolid/cache
+
+![GitHub License](https://img.shields.io/github/license/resolid/framework)
+![NPM Version](https://img.shields.io/npm/v/%40resolid/cache-file)
+
+<b>[Documentation](https://www.resolid.tech/docs/cache)</b> | [Framework Bundle](https://github.com/resolid/framework)
+
+## License
+
+MIT License (MIT). Please see [LICENSE](./LICENSE) for more information.

package/dist/index.d.mts

@@ -0,0 +1,17 @@
+import { CacheStore } from "@resolid/cache/types";
+
+//#region src/index.d.ts
+declare class FileCache implements CacheStore {
+  private readonly _basePath;
+  private readonly _locks;
+  constructor(basePath: string);
+  private _resolve;
+  private _exists;
+  private _lockedRun;
+  get(key: string): Promise<string | undefined>;
+  set(key: string, value: string, ttl?: number): Promise<boolean>;
+  del(key: string): Promise<boolean>;
+  clear(): Promise<boolean>;
+}
+//#endregion
+export { FileCache };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{access as e,mkdir as t,readFile as n,rm as r,writeFile as i}from"node:fs/promises";import{dirname as a,join as o}from"node:path";const s=/(\.\/|\.\.\/)/;var c=class{_basePath;_locks=new Map;constructor(e){this._basePath=e}_resolve(e){if(s.test(e))throw Error(`Invalid key: ${e}. Should not contain relative paths.`);return o(this._basePath,e.replaceAll(`:`,`/`))}async _exists(t){try{return await e(t),!0}catch{return!1}}async _lockedRun(e,t){let n=this._locks.get(e)??Promise.resolve(),r,i=new Promise(e=>r=e);this._locks.set(e,n.then(()=>i));try{return await n,await t()}finally{r(),this._locks.get(e)===i&&this._locks.delete(e)}}async get(e){let t=this._resolve(e);try{let e=await n(t,{encoding:`utf-8`}),[i,a]=JSON.parse(e);if(a!==-1&&a<Date.now()){await r(t,{force:!0});return}return i}catch{return}}async set(e,n,r){let o=this._resolve(e);return this._lockedRun(e,async()=>(await t(a(o),{recursive:!0}),await i(o,JSON.stringify([n,r?Date.now()+r*1e3:-1])),!0))}async del(e){let t=this._resolve(e);return await this._exists(t)?this._lockedRun(e,async()=>(await r(t),!0)):!1}async clear(){return await r(this._basePath,{recursive:!0,force:!0}),this._locks.clear(),!0}};export{c as FileCache};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@resolid/cache-file",
+  "version": "0.1.0",
+  "private": false,
+  "description": "File Cache store for @resolid/cache",
+  "keywords": [
+    "resolid",
+    "cache",
+    "cache manager",
+    "file"
+  ],
+  "homepage": "https://www.resolid.tech",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/resolid/framework.git",
+    "directory": "packages/cache-file"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Huijie Wei",
+    "email": "hello@resolid.tech"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "tsdown": "^0.16.3",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@resolid/cache": "workspace:^"
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.13.0 || >=24"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}