@signaldb/localstorage 1.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @signaldb/localstorage
+
+This is the `localStorage` persistence adapter for [SignalDB](https://github.com/maxnowack/signaldb). SignalDB is a local-first JavaScript database with real-time sync, enabling optimistic UI with signal-based reactivity across multiple frameworks.
+
+See https://signaldb.js.org/reference/localstorage/ for more information.

package/dist/.vite/manifest.json

@@ -0,0 +1,8 @@
+{
+  "src/index.ts": {
+    "file": "index.umd.js",
+    "name": "index",
+    "src": "src/index.ts",
+    "isEntry": true
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Creates a persistence adapter for managing a SignalDB collection using browser `localStorage`.
+ * This adapter reads and writes data to `localStorage`, with customizable serialization and deserialization.
+ * @template T - The type of the items in the collection.
+ * @template I - The type of the unique identifier for the items.
+ * @param name - A unique name for the collection, used as the key in `localStorage`.
+ * @param options - Optional configuration for serialization and deserialization.
+ * @param options.serialize - A function to serialize items to a string (default: `JSON.stringify`).
+ * @param options.deserialize - A function to deserialize a string into items (default: `JSON.parse`).
+ * @returns A SignalDB persistence adapter for managing data in `localStorage`.
+ * @example
+ * import createLocalStorageAdapter from './createLocalStorageAdapter';
+ *
+ * const adapter = createLocalStorageAdapter('myCollection', {
+ *   serialize: (items) => JSON.stringify(items, null, 2), // Pretty-print JSON
+ *   deserialize: (itemsString) => JSON.parse(itemsString), // Default JSON parse
+ * });
+ *
+ * const collection = new Collection({
+ *   persistence: adapter,
+ * });
+ *
+ * // Perform operations on the collection, and changes will be reflected in local storage.
+ */
+export default function createLocalStorageAdapter<T extends {
+    id: I;
+} & Record<string, any>, I>(name: string, options?: {
+    serialize?: (items: T[]) => string;
+    deserialize?: (itemsString: string) => T[];
+}): import("@signaldb/core").PersistenceAdapter<T, I>;

package/dist/index.mjs

@@ -0,0 +1,38 @@
+import { createPersistenceAdapter as m } from "@signaldb/core";
+function h(c, a) {
+  const { serialize: d = JSON.stringify, deserialize: l = JSON.parse } = a || {}, n = `signaldb-collection-${c}`;
+  function s() {
+    return l(localStorage.getItem(n) || "[]");
+  }
+  return m({
+    async load() {
+      const i = s();
+      return Promise.resolve({ items: i });
+    },
+    async save(i, { added: f, modified: u, removed: I }) {
+      const r = s();
+      return f.forEach((e) => {
+        r.push(e);
+      }), u.forEach((e) => {
+        const t = r.findIndex(({ id: o }) => o === e.id);
+        /* istanbul ignore if -- @preserve */
+        if (t === -1)
+          throw new Error(`Item with ID ${e.id} not found`);
+        r[t] = e;
+      }), I.forEach((e) => {
+        const t = r.findIndex(({ id: o }) => o === e.id);
+        /* istanbul ignore if -- @preserve */
+        if (t === -1)
+          throw new Error(`Item with ID ${e.id} not found`);
+        r.splice(t, 1);
+      }), localStorage.setItem(n, d(r)), Promise.resolve();
+    },
+    async register() {
+      return Promise.resolve();
+    }
+  });
+}
+export {
+  h as default
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import { createPersistenceAdapter } from '@signaldb/core';\n/**\n * Creates a persistence adapter for managing a SignalDB collection using browser `localStorage`.\n * This adapter reads and writes data to `localStorage`, with customizable serialization and deserialization.\n * @template T - The type of the items in the collection.\n * @template I - The type of the unique identifier for the items.\n * @param name - A unique name for the collection, used as the key in `localStorage`.\n * @param options - Optional configuration for serialization and deserialization.\n * @param options.serialize - A function to serialize items to a string (default: `JSON.stringify`).\n * @param options.deserialize - A function to deserialize a string into items (default: `JSON.parse`).\n * @returns A SignalDB persistence adapter for managing data in `localStorage`.\n * @example\n * import createLocalStorageAdapter from './createLocalStorageAdapter';\n *\n * const adapter = createLocalStorageAdapter('myCollection', {\n *   serialize: (items) => JSON.stringify(items, null, 2), // Pretty-print JSON\n *   deserialize: (itemsString) => JSON.parse(itemsString), // Default JSON parse\n * });\n *\n * const collection = new Collection({\n *   persistence: adapter,\n * });\n *\n * // Perform operations on the collection, and changes will be reflected in local storage.\n */\nexport default function createLocalStorageAdapter(name, options) {\n    const { serialize = JSON.stringify, deserialize = JSON.parse } = options || {};\n    const collectionId = `signaldb-collection-${name}`;\n    function getItems() {\n        return deserialize(localStorage.getItem(collectionId) || '[]');\n    }\n    return createPersistenceAdapter({\n        async load() {\n            const items = getItems();\n            return Promise.resolve({ items });\n        },\n        async save(items, { added, modified, removed }) {\n            const currentItems = getItems();\n            added.forEach((item) => {\n                currentItems.push(item);\n            });\n            modified.forEach((item) => {\n                const index = currentItems.findIndex(({ id }) => id === item.id);\n                /* istanbul ignore if -- @preserve */\n                if (index === -1)\n                    throw new Error(`Item with ID ${item.id} not found`);\n                currentItems[index] = item;\n            });\n            removed.forEach((item) => {\n                const index = currentItems.findIndex(({ id }) => id === item.id);\n                /* istanbul ignore if -- @preserve */\n                if (index === -1)\n                    throw new Error(`Item with ID ${item.id} not found`);\n                currentItems.splice(index, 1);\n            });\n            localStorage.setItem(collectionId, serialize(currentItems));\n            return Promise.resolve();\n        },\n        async register() {\n            return Promise.resolve();\n        },\n    });\n}\n"],"names":["createLocalStorageAdapter","name","options","serialize","deserialize","collectionId","getItems","createPersistenceAdapter","items","added","modified","removed","currentItems","item","index","id"],"mappings":";AAyBwB,SAAAA,EAA0BC,GAAMC,GAAS;AACvD,QAAA,EAAE,WAAAC,IAAY,KAAK,WAAW,aAAAC,IAAc,KAAK,UAAUF,KAAW,CAAC,GACvEG,IAAe,uBAAuBJ,CAAI;AAChD,WAASK,IAAW;AAChB,WAAOF,EAAY,aAAa,QAAQC,CAAY,KAAK,IAAI;AAAA,EAAA;AAEjE,SAAOE,EAAyB;AAAA,IAC5B,MAAM,OAAO;AACT,YAAMC,IAAQF,EAAS;AACvB,aAAO,QAAQ,QAAQ,EAAE,OAAAE,GAAO;AAAA,IACpC;AAAA,IACA,MAAM,KAAKA,GAAO,EAAE,OAAAC,GAAO,UAAAC,GAAU,SAAAC,KAAW;AAC5C,YAAMC,IAAeN,EAAS;AACxB,aAAAG,EAAA,QAAQ,CAACI,MAAS;AACpB,QAAAD,EAAa,KAAKC,CAAI;AAAA,MAAA,CACzB,GACQH,EAAA,QAAQ,CAACG,MAAS;AACjB,cAAAC,IAAQF,EAAa,UAAU,CAAC,EAAE,IAAAG,QAASA,MAAOF,EAAK,EAAE;AAAA,QAAA;AAE/D,YAAIC,MAAU;AACV,gBAAM,IAAI,MAAM,gBAAgBD,EAAK,EAAE,YAAY;AACvD,QAAAD,EAAaE,CAAK,IAAID;AAAA,MAAA,CACzB,GACOF,EAAA,QAAQ,CAACE,MAAS;AAChB,cAAAC,IAAQF,EAAa,UAAU,CAAC,EAAE,IAAAG,QAASA,MAAOF,EAAK,EAAE;AAAA,QAAA;AAE/D,YAAIC,MAAU;AACV,gBAAM,IAAI,MAAM,gBAAgBD,EAAK,EAAE,YAAY;AAC1C,QAAAD,EAAA,OAAOE,GAAO,CAAC;AAAA,MAAA,CAC/B,GACD,aAAa,QAAQT,GAAcF,EAAUS,CAAY,CAAC,GACnD,QAAQ,QAAQ;AAAA,IAC3B;AAAA,IACA,MAAM,WAAW;AACb,aAAO,QAAQ,QAAQ;AAAA,IAAA;AAAA,EAC3B,CACH;AACL;"}

package/dist/index.umd.js

@@ -0,0 +1,2 @@
+(function(n,r){typeof exports=="object"&&typeof module<"u"?module.exports=r(require("@signaldb/core")):typeof define=="function"&&define.amd?define(["@signaldb/core"],r):(n=typeof globalThis<"u"?globalThis:n||self,n.SignalDB=r(n.core))})(this,function(n){"use strict";function r(a,f){const{serialize:l=JSON.stringify,deserialize:u=JSON.parse}=f||{},s=`signaldb-collection-${a}`;function c(){return u(localStorage.getItem(s)||"[]")}return n.createPersistenceAdapter({async load(){const d=c();return Promise.resolve({items:d})},async save(d,{added:h,modified:m,removed:p}){const t=c();return h.forEach(e=>{t.push(e)}),m.forEach(e=>{const o=t.findIndex(({id:i})=>i===e.id);/* istanbul ignore if -- @preserve */if(o===-1)throw new Error(`Item with ID ${e.id} not found`);t[o]=e}),p.forEach(e=>{const o=t.findIndex(({id:i})=>i===e.id);/* istanbul ignore if -- @preserve */if(o===-1)throw new Error(`Item with ID ${e.id} not found`);t.splice(o,1)}),localStorage.setItem(s,l(t)),Promise.resolve()},async register(){return Promise.resolve()}})}return r});
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../src/index.ts"],"sourcesContent":["import { createPersistenceAdapter } from '@signaldb/core';\n/**\n * Creates a persistence adapter for managing a SignalDB collection using browser `localStorage`.\n * This adapter reads and writes data to `localStorage`, with customizable serialization and deserialization.\n * @template T - The type of the items in the collection.\n * @template I - The type of the unique identifier for the items.\n * @param name - A unique name for the collection, used as the key in `localStorage`.\n * @param options - Optional configuration for serialization and deserialization.\n * @param options.serialize - A function to serialize items to a string (default: `JSON.stringify`).\n * @param options.deserialize - A function to deserialize a string into items (default: `JSON.parse`).\n * @returns A SignalDB persistence adapter for managing data in `localStorage`.\n * @example\n * import createLocalStorageAdapter from './createLocalStorageAdapter';\n *\n * const adapter = createLocalStorageAdapter('myCollection', {\n *   serialize: (items) => JSON.stringify(items, null, 2), // Pretty-print JSON\n *   deserialize: (itemsString) => JSON.parse(itemsString), // Default JSON parse\n * });\n *\n * const collection = new Collection({\n *   persistence: adapter,\n * });\n *\n * // Perform operations on the collection, and changes will be reflected in local storage.\n */\nexport default function createLocalStorageAdapter(name, options) {\n    const { serialize = JSON.stringify, deserialize = JSON.parse } = options || {};\n    const collectionId = `signaldb-collection-${name}`;\n    function getItems() {\n        return deserialize(localStorage.getItem(collectionId) || '[]');\n    }\n    return createPersistenceAdapter({\n        async load() {\n            const items = getItems();\n            return Promise.resolve({ items });\n        },\n        async save(items, { added, modified, removed }) {\n            const currentItems = getItems();\n            added.forEach((item) => {\n                currentItems.push(item);\n            });\n            modified.forEach((item) => {\n                const index = currentItems.findIndex(({ id }) => id === item.id);\n                /* istanbul ignore if -- @preserve */\n                if (index === -1)\n                    throw new Error(`Item with ID ${item.id} not found`);\n                currentItems[index] = item;\n            });\n            removed.forEach((item) => {\n                const index = currentItems.findIndex(({ id }) => id === item.id);\n                /* istanbul ignore if -- @preserve */\n                if (index === -1)\n                    throw new Error(`Item with ID ${item.id} not found`);\n                currentItems.splice(index, 1);\n            });\n            localStorage.setItem(collectionId, serialize(currentItems));\n            return Promise.resolve();\n        },\n        async register() {\n            return Promise.resolve();\n        },\n    });\n}\n"],"names":["createLocalStorageAdapter","name","options","serialize","deserialize","collectionId","getItems","createPersistenceAdapter","items","added","modified","removed","currentItems","item","index","id"],"mappings":"4QAyBwB,SAAAA,EAA0BC,EAAMC,EAAS,CACvD,KAAA,CAAE,UAAAC,EAAY,KAAK,UAAW,YAAAC,EAAc,KAAK,OAAUF,GAAW,CAAC,EACvEG,EAAe,uBAAuBJ,CAAI,GAChD,SAASK,GAAW,CAChB,OAAOF,EAAY,aAAa,QAAQC,CAAY,GAAK,IAAI,CAAA,CAEjE,OAAOE,2BAAyB,CAC5B,MAAM,MAAO,CACT,MAAMC,EAAQF,EAAS,EACvB,OAAO,QAAQ,QAAQ,CAAE,MAAAE,EAAO,CACpC,EACA,MAAM,KAAKA,EAAO,CAAE,MAAAC,EAAO,SAAAC,EAAU,QAAAC,GAAW,CAC5C,MAAMC,EAAeN,EAAS,EACxB,OAAAG,EAAA,QAASI,GAAS,CACpBD,EAAa,KAAKC,CAAI,CAAA,CACzB,EACQH,EAAA,QAASG,GAAS,CACjB,MAAAC,EAAQF,EAAa,UAAU,CAAC,CAAE,GAAAG,KAASA,IAAOF,EAAK,EAAE,EAAA,qCAE/D,GAAIC,IAAU,GACV,MAAM,IAAI,MAAM,gBAAgBD,EAAK,EAAE,YAAY,EACvDD,EAAaE,CAAK,EAAID,CAAA,CACzB,EACOF,EAAA,QAASE,GAAS,CAChB,MAAAC,EAAQF,EAAa,UAAU,CAAC,CAAE,GAAAG,KAASA,IAAOF,EAAK,EAAE,EAAA,qCAE/D,GAAIC,IAAU,GACV,MAAM,IAAI,MAAM,gBAAgBD,EAAK,EAAE,YAAY,EAC1CD,EAAA,OAAOE,EAAO,CAAC,CAAA,CAC/B,EACD,aAAa,QAAQT,EAAcF,EAAUS,CAAY,CAAC,EACnD,QAAQ,QAAQ,CAC3B,EACA,MAAM,UAAW,CACb,OAAO,QAAQ,QAAQ,CAAA,CAC3B,CACH,CACL"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@signaldb/localstorage",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "build": "rimraf dist && vite build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/maxnowack/signaldb.git"
+  },
+  "homepage": "https://signaldb.js.org",
+  "keywords": [
+    "local-storage",
+    "client-database",
+    "client",
+    "database",
+    "local-database",
+    "offline-first",
+    "optimistic-ui",
+    "plugin",
+    "reactive",
+    "reactivity",
+    "solid",
+    "synchronization",
+    "typescript"
+  ],
+  "author": "Max Nowack <max.nowack@gmail.com>",
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.umd.js",
+      "default": "./dist/index.umd.js"
+    }
+  },
+  "main": "./dist/index.umd.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@signaldb/core": "1.x"
+  }
+}