safe-vault 1.0.0

package/dist/index.cjs

@@ -0,0 +1,80 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  SafeVault: () => SafeVault
+});
+module.exports = __toCommonJS(index_exports);
+var SafeVault = class {
+  storage;
+  constructor(storage = localStorage) {
+    if (typeof window === "undefined") {
+      throw new Error("SafeVault can only be used in browser environments");
+    }
+    this.storage = storage;
+  }
+  /**
+   * Set a value with optional TTL (in milliseconds)
+   */
+  set(key, value, ttl) {
+    const expiry = typeof ttl === "number" ? Date.now() + ttl : null;
+    const data = {
+      value,
+      expiry
+    };
+    this.storage.setItem(key, JSON.stringify(data));
+  }
+  /**
+   * Get a value. Returns null if expired or not found.
+   */
+  get(key) {
+    const item = this.storage.getItem(key);
+    if (!item) return null;
+    try {
+      const data = JSON.parse(item);
+      if (data.expiry !== null && Date.now() > data.expiry) {
+        this.storage.removeItem(key);
+        return null;
+      }
+      return data.value;
+    } catch {
+      this.storage.removeItem(key);
+      return null;
+    }
+  }
+  /**
+   * Remove a single key
+   */
+  remove(key) {
+    this.storage.removeItem(key);
+  }
+  /**
+   * Clear all storage
+   */
+  clear() {
+    this.storage.clear();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SafeVault
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["interface StorageValue<T> {\r\n  value: T;\r\n  expiry: number | null;\r\n}\r\n\r\nexport class SafeVault<Schema extends Record<string, any>> {\r\n  private storage: Storage;\r\n\r\n  constructor(storage: Storage = localStorage) {\r\n    if (typeof window === \"undefined\") {\r\n      throw new Error(\"SafeVault can only be used in browser environments\");\r\n    }\r\n    this.storage = storage;\r\n  }\r\n\r\n  /**\r\n   * Set a value with optional TTL (in milliseconds)\r\n   */\r\n  set<K extends keyof Schema>(\r\n    key: K,\r\n    value: Schema[K],\r\n    ttl?: number\r\n  ): void {\r\n    const expiry = typeof ttl === \"number\" ? Date.now() + ttl : null;\r\n\r\n    const data: StorageValue<Schema[K]> = {\r\n      value,\r\n      expiry,\r\n    };\r\n\r\n    this.storage.setItem(key as string, JSON.stringify(data));\r\n  }\r\n\r\n  /**\r\n   * Get a value. Returns null if expired or not found.\r\n   */\r\n  get<K extends keyof Schema>(key: K): Schema[K] | null {\r\n    const item = this.storage.getItem(key as string);\r\n    if (!item) return null;\r\n\r\n    try {\r\n      const data: StorageValue<Schema[K]> = JSON.parse(item);\r\n\r\n      if (data.expiry !== null && Date.now() > data.expiry) {\r\n        this.storage.removeItem(key as string);\r\n        return null;\r\n      }\r\n\r\n      return data.value;\r\n    } catch {\r\n      // corrupted JSON\r\n      this.storage.removeItem(key as string);\r\n      return null;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Remove a single key\r\n   */\r\n  remove<K extends keyof Schema>(key: K): void {\r\n    this.storage.removeItem(key as string);\r\n  }\r\n\r\n  /**\r\n   * Clear all storage\r\n   */\r\n  clear(): void {\r\n    this.storage.clear();\r\n  }\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,IAAM,YAAN,MAAoD;AAAA,EACjD;AAAA,EAER,YAAY,UAAmB,cAAc;AAC3C,QAAI,OAAO,WAAW,aAAa;AACjC,YAAM,IAAI,MAAM,oDAAoD;AAAA,IACtE;AACA,SAAK,UAAU;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA,EAKA,IACE,KACA,OACA,KACM;AACN,UAAM,SAAS,OAAO,QAAQ,WAAW,KAAK,IAAI,IAAI,MAAM;AAE5D,UAAM,OAAgC;AAAA,MACpC;AAAA,MACA;AAAA,IACF;AAEA,SAAK,QAAQ,QAAQ,KAAe,KAAK,UAAU,IAAI,CAAC;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA,EAKA,IAA4B,KAA0B;AACpD,UAAM,OAAO,KAAK,QAAQ,QAAQ,GAAa;AAC/C,QAAI,CAAC,KAAM,QAAO;AAElB,QAAI;AACF,YAAM,OAAgC,KAAK,MAAM,IAAI;AAErD,UAAI,KAAK,WAAW,QAAQ,KAAK,IAAI,IAAI,KAAK,QAAQ;AACpD,aAAK,QAAQ,WAAW,GAAa;AACrC,eAAO;AAAA,MACT;AAEA,aAAO,KAAK;AAAA,IACd,QAAQ;AAEN,WAAK,QAAQ,WAAW,GAAa;AACrC,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAA+B,KAAc;AAC3C,SAAK,QAAQ,WAAW,GAAa;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AACZ,SAAK,QAAQ,MAAM;AAAA,EACrB;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,22 @@
+declare class SafeVault<Schema extends Record<string, any>> {
+    private storage;
+    constructor(storage?: Storage);
+    /**
+     * Set a value with optional TTL (in milliseconds)
+     */
+    set<K extends keyof Schema>(key: K, value: Schema[K], ttl?: number): void;
+    /**
+     * Get a value. Returns null if expired or not found.
+     */
+    get<K extends keyof Schema>(key: K): Schema[K] | null;
+    /**
+     * Remove a single key
+     */
+    remove<K extends keyof Schema>(key: K): void;
+    /**
+     * Clear all storage
+     */
+    clear(): void;
+}
+
+export { SafeVault };

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+declare class SafeVault<Schema extends Record<string, any>> {
+    private storage;
+    constructor(storage?: Storage);
+    /**
+     * Set a value with optional TTL (in milliseconds)
+     */
+    set<K extends keyof Schema>(key: K, value: Schema[K], ttl?: number): void;
+    /**
+     * Get a value. Returns null if expired or not found.
+     */
+    get<K extends keyof Schema>(key: K): Schema[K] | null;
+    /**
+     * Remove a single key
+     */
+    remove<K extends keyof Schema>(key: K): void;
+    /**
+     * Clear all storage
+     */
+    clear(): void;
+}
+
+export { SafeVault };

package/dist/index.js

@@ -0,0 +1,55 @@
+// src/index.ts
+var SafeVault = class {
+  storage;
+  constructor(storage = localStorage) {
+    if (typeof window === "undefined") {
+      throw new Error("SafeVault can only be used in browser environments");
+    }
+    this.storage = storage;
+  }
+  /**
+   * Set a value with optional TTL (in milliseconds)
+   */
+  set(key, value, ttl) {
+    const expiry = typeof ttl === "number" ? Date.now() + ttl : null;
+    const data = {
+      value,
+      expiry
+    };
+    this.storage.setItem(key, JSON.stringify(data));
+  }
+  /**
+   * Get a value. Returns null if expired or not found.
+   */
+  get(key) {
+    const item = this.storage.getItem(key);
+    if (!item) return null;
+    try {
+      const data = JSON.parse(item);
+      if (data.expiry !== null && Date.now() > data.expiry) {
+        this.storage.removeItem(key);
+        return null;
+      }
+      return data.value;
+    } catch {
+      this.storage.removeItem(key);
+      return null;
+    }
+  }
+  /**
+   * Remove a single key
+   */
+  remove(key) {
+    this.storage.removeItem(key);
+  }
+  /**
+   * Clear all storage
+   */
+  clear() {
+    this.storage.clear();
+  }
+};
+export {
+  SafeVault
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["interface StorageValue<T> {\r\n  value: T;\r\n  expiry: number | null;\r\n}\r\n\r\nexport class SafeVault<Schema extends Record<string, any>> {\r\n  private storage: Storage;\r\n\r\n  constructor(storage: Storage = localStorage) {\r\n    if (typeof window === \"undefined\") {\r\n      throw new Error(\"SafeVault can only be used in browser environments\");\r\n    }\r\n    this.storage = storage;\r\n  }\r\n\r\n  /**\r\n   * Set a value with optional TTL (in milliseconds)\r\n   */\r\n  set<K extends keyof Schema>(\r\n    key: K,\r\n    value: Schema[K],\r\n    ttl?: number\r\n  ): void {\r\n    const expiry = typeof ttl === \"number\" ? Date.now() + ttl : null;\r\n\r\n    const data: StorageValue<Schema[K]> = {\r\n      value,\r\n      expiry,\r\n    };\r\n\r\n    this.storage.setItem(key as string, JSON.stringify(data));\r\n  }\r\n\r\n  /**\r\n   * Get a value. Returns null if expired or not found.\r\n   */\r\n  get<K extends keyof Schema>(key: K): Schema[K] | null {\r\n    const item = this.storage.getItem(key as string);\r\n    if (!item) return null;\r\n\r\n    try {\r\n      const data: StorageValue<Schema[K]> = JSON.parse(item);\r\n\r\n      if (data.expiry !== null && Date.now() > data.expiry) {\r\n        this.storage.removeItem(key as string);\r\n        return null;\r\n      }\r\n\r\n      return data.value;\r\n    } catch {\r\n      // corrupted JSON\r\n      this.storage.removeItem(key as string);\r\n      return null;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Remove a single key\r\n   */\r\n  remove<K extends keyof Schema>(key: K): void {\r\n    this.storage.removeItem(key as string);\r\n  }\r\n\r\n  /**\r\n   * Clear all storage\r\n   */\r\n  clear(): void {\r\n    this.storage.clear();\r\n  }\r\n}\r\n"],"mappings":";AAKO,IAAM,YAAN,MAAoD;AAAA,EACjD;AAAA,EAER,YAAY,UAAmB,cAAc;AAC3C,QAAI,OAAO,WAAW,aAAa;AACjC,YAAM,IAAI,MAAM,oDAAoD;AAAA,IACtE;AACA,SAAK,UAAU;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA,EAKA,IACE,KACA,OACA,KACM;AACN,UAAM,SAAS,OAAO,QAAQ,WAAW,KAAK,IAAI,IAAI,MAAM;AAE5D,UAAM,OAAgC;AAAA,MACpC;AAAA,MACA;AAAA,IACF;AAEA,SAAK,QAAQ,QAAQ,KAAe,KAAK,UAAU,IAAI,CAAC;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA,EAKA,IAA4B,KAA0B;AACpD,UAAM,OAAO,KAAK,QAAQ,QAAQ,GAAa;AAC/C,QAAI,CAAC,KAAM,QAAO;AAElB,QAAI;AACF,YAAM,OAAgC,KAAK,MAAM,IAAI;AAErD,UAAI,KAAK,WAAW,QAAQ,KAAK,IAAI,IAAI,KAAK,QAAQ;AACpD,aAAK,QAAQ,WAAW,GAAa;AACrC,eAAO;AAAA,MACT;AAEA,aAAO,KAAK;AAAA,IACd,QAAQ;AAEN,WAAK,QAAQ,WAAW,GAAa;AACrC,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAA+B,KAAc;AAC3C,SAAK,QAAQ,WAAW,GAAa;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AACZ,SAAK,QAAQ,MAAM;AAAA,EACrB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "safe-vault",
+  "version": "1.0.0",
+  "description": "Type-safe localStorage wrapper with TTL support",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "tsc --noEmit"
+  },
+  "keywords": [
+    "localStorage",
+    "storage",
+    "ttl",
+    "typescript",
+    "cache"
+  ],
+  "license": "MIT"
+}

package/readme.md

@@ -0,0 +1,7 @@
+# safe-vault
+
+A lightweight, type-safe wrapper around browser storage with TTL expiration.
+
+## Install
+```bash
+npm install safe-vault