react-wire-persisted 1.2.0 → 1.5.0

package/README.md

@@ -5,7 +5,17 @@
 ## Install
 
 ```shell
-$ yarn add -D @forminator/react-wire react-wire-persisted
+$ pnpm add -D @forminator/react-wire react-wire-persisted
+```
+
+## Building
+
+```shell
+$ pnpm build
+$ npm version patch # patch, minor, major
+$ git push
+$ git push --tags
+$ npm publish
 ```
 
 ## Usage

package/dist/react-wire-persisted.mjs

@@ -0,0 +1,231 @@
+import { createWire as b } from "@forminator/react-wire";
+(function() {
+  const s = {};
+  try {
+    if (process) {
+      process.env = Object.assign({}, process.env), Object.assign(process.env, s);
+      return;
+    }
+  } catch {
+  }
+  globalThis.process = { env: s };
+})();
+const m = {}, p = (s) => {
+  m[s] = s;
+}, I = (s) => p(s), O = () => m, S = (s, e = null) => {
+  const t = e || m;
+  return s ? Object.keys(t).reduce((r, n) => ({
+    ...r,
+    [n]: `${s}.${t[n]}`
+  }), {}) : t;
+}, g = {
+  getItem: (s) => g[s],
+  setItem: (s, e) => {
+    g[s] = e;
+  },
+  removeItem: (s) => {
+    delete g[s];
+  }
+}, d = (s) => {
+  const e = typeof s;
+  return s === null ? !0 : Array.isArray(s) || e === "object" ? !1 : e !== "function";
+}, j = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  addKey: p,
+  fakeLocalStorage: g,
+  getKeys: O,
+  getPrefixedKeys: S,
+  isPrimitive: d,
+  key: I
+}, Symbol.toStringTag, { value: "Module" }));
+class h {
+  /**
+   * Initializes the class
+   * @param {String} namespace Namespace to prefix all keys with. Mostly used for the logging & reset functions
+   * @param {Object} registry (Optional) Initialize the storage provider with an existing registry
+   */
+  constructor(e, t) {
+    if (new.target === h)
+      throw TypeError("StorageProvider is abstract. Extend this class to implement it");
+    this.namespace = e || null, this.registry = t || /* istanbul ignore next */
+    {};
+  }
+  /**
+   * Sets the namespace for this storage provider, and migrates
+   * all stored values to the new namespace
+   * @param {String} namespace New namespace for this storage provider
+   */
+  /* istanbul ignore next */
+  setNamespace(e) {
+  }
+  /**
+   * Registers an item with it's initial value. This is used for logging, resetting, etc.
+   * @param {String} key Storage item's key
+   * @param {*} initialValue Storage item's initial value
+   */
+  register(e, t) {
+    this.registry[e] = t;
+  }
+  /**
+   * Reads an item from storage
+   * @param {String} key Key for the item to retrieve
+   */
+  /* istanbul ignore next */
+  getItem(e) {
+  }
+  /**
+   * Stores a value
+   * @param {String} key Item's storage key
+   * @param {String} value Item's value to store
+   */
+  /* istanbul ignore next */
+  setItem(e, t) {
+  }
+  /**
+   * Removes an item from storage
+   * @param {String} key Item's storage key
+   * @param {Boolean} fromRegistry (Optional) If the item should also be removed from the registry
+   */
+  /* istanbul ignore next */
+  removeItem(e, t = !1) {
+  }
+  /**
+   * Gets all stored keys & values
+   * If a `namespace` was set, only keys prefixed with the namespace will be returned
+   */
+  /* istanbul ignore next */
+  getAll() {
+  }
+  /**
+   * 
+   * @param {Boolean} useInitialValues If values should be replaced with their initial values. If false, keys are removed
+   * @param {String[]} excludedKeys (Optional) List of keys to exclude
+   * @param {Boolean} clearRegistry (Optional) If the registry should also be cleared
+   */
+  /* istanbul ignore next */
+  _resetAll(e = !0, t = [], r = !1) {
+  }
+  /**
+   * Resets all values to their initial values
+   * If a `namespace` is set, only keys prefixed with the namespace will be reset
+   * @param {String[]} excludedKeys (Optional) List of keys to exclude
+   */
+  /* istanbul ignore next */
+  resetAll(e = []) {
+  }
+  /**
+   * Removes all items from local storage.
+   * If a `namespace` is set, only keys prefixed with the namespace will be removed
+   * @param {String[]} excludedKeys (Optional) List of keys to exclude
+   */
+  /* istanbul ignore next */
+  removeAll(e = []) {
+  }
+}
+class v extends h {
+  constructor(e = null, t = {}) {
+    super(e, t), this.storage = this.getStorage();
+  }
+  getStorage() {
+    try {
+      return window.localStorage;
+    } catch {
+      return console.warn(new Error("LocalStorageProvider: localStorage not supported")), g;
+    }
+  }
+  setNamespace(e) {
+    if (!this.namespace) {
+      this.namespace = e;
+      return;
+    }
+    if (this.namespace === e)
+      return;
+    const t = JSON.parse(JSON.stringify(this.getAll()));
+    this.removeAll();
+    for (const [r, n] of Object.entries(t)) {
+      const o = r.replace(this.namespace, e);
+      this.setItem(o, n);
+    }
+    this.namespace = e;
+  }
+  getItem(e) {
+    const t = this.storage.getItem(e);
+    if (t == null)
+      return null;
+    try {
+      return JSON.parse(t);
+    } catch {
+      return t;
+    }
+  }
+  setItem(e, t) {
+    let r = t;
+    return r != null && (r = d(t) ? t : JSON.stringify(t)), this.storage.setItem(e, r);
+  }
+  removeItem(e, t = !1) {
+    return t && delete this.registry[e], this.storage.removeItem(e);
+  }
+  getAll() {
+    const e = `${this.namespace}.`;
+    return Object.keys(this.storage).reduce((t, r) => ((!this.namespace || r.startsWith(e)) && (t[r] = this.storage.getItem(r)), t), {});
+  }
+  _resetAll(e = !0, t = [], r = !1) {
+    const n = `${this.namespace}.`;
+    Object.keys(localStorage).forEach((o) => {
+      const l = this.namespace ? o.startsWith(n) : !0, a = t?.includes(o) || !1;
+      !l || a || (e ? Object.prototype.hasOwnProperty.call(this.registry, o) ? this.storage.setItem(o, this.registry[o]) : this.storage.removeItem(o) : (this.storage.removeItem(o), r && delete this.registry[o]));
+    });
+  }
+  resetAll(e = [], t = !1) {
+    this._resetAll(!0, e || [], t);
+  }
+  removeAll(e = [], t = !1) {
+    this._resetAll(!1, e || [], t);
+  }
+}
+const A = {
+  logging: {
+    enabled: !1
+  }
+};
+let y = v, i = new y(), u = { ...A }, f = [];
+const w = () => i.namespace, K = () => i, P = () => u, _ = (s) => {
+  i.setNamespace(s), i = new y(s || w());
+}, E = (s) => {
+  if (u = {
+    ...u,
+    ...s
+  }, u.logging.enabled)
+    for (console.info("Flushing", f.length, "pending logs"); f.length; )
+      console.log(...f.shift());
+}, x = (...s) => {
+  u.logging.enabled ? console.log(...s) : f.push(s);
+}, V = (s, e = null) => {
+  if (!s && typeof s != "number") throw new Error(
+    `createPersistedWire: Key cannot be a falsey value (${s}}`
+  );
+  i.register(s, e);
+  const t = b(e), r = () => t.getValue(), n = (c) => (i.setItem(s, c), t.setValue(c)), o = (c) => {
+    t.subscribe(c);
+  }, l = i.getItem(s), a = l === null ? e : l;
+  return x("react-wire-persisted: create", s, {
+    value: e,
+    storedValue: l,
+    initialValue: a
+  }), a !== e && n(a), {
+    ...t,
+    getValue: r,
+    setValue: n,
+    subscribe: o
+  };
+};
+export {
+  V as createPersistedWire,
+  A as defaultOptions,
+  w as getNamespace,
+  P as getOptions,
+  K as getStorage,
+  _ as setNamespace,
+  E as setOptions,
+  j as utils
+};

package/dist/react-wire-persisted.umd.js

@@ -0,0 +1 @@
+(function(n,a){typeof exports=="object"&&typeof module<"u"?a(exports,require("@forminator/react-wire")):typeof define=="function"&&define.amd?define(["exports","@forminator/react-wire"],a):(n=typeof globalThis<"u"?globalThis:n||self,a(n["react-wire-persisted"]={},n.reactWire))})(this,function(n,a){"use strict";(function(){const s={};try{if(process){process.env=Object.assign({},process.env),Object.assign(process.env,s);return}}catch{}globalThis.process={env:s}})();const h={},y=s=>{h[s]=s},w=s=>y(s),v=()=>h,A=(s,e=null)=>{const t=e||h;return s?Object.keys(t).reduce((r,o)=>({...r,[o]:`${s}.${t[o]}`}),{}):t},c={getItem:s=>c[s],setItem:(s,e)=>{c[s]=e},removeItem:s=>{delete c[s]}},b=s=>{const e=typeof s;return s===null?!0:Array.isArray(s)||e==="object"?!1:e!=="function"},N=Object.freeze(Object.defineProperty({__proto__:null,addKey:y,fakeLocalStorage:c,getKeys:v,getPrefixedKeys:A,isPrimitive:b,key:w},Symbol.toStringTag,{value:"Module"}));class p{constructor(e,t){if(new.target===p)throw TypeError("StorageProvider is abstract. Extend this class to implement it");this.namespace=e||null,this.registry=t||{}}setNamespace(e){}register(e,t){this.registry[e]=t}getItem(e){}setItem(e,t){}removeItem(e,t=!1){}getAll(){}_resetAll(e=!0,t=[],r=!1){}resetAll(e=[]){}removeAll(e=[]){}}class j extends p{constructor(e=null,t={}){super(e,t),this.storage=this.getStorage()}getStorage(){try{return window.localStorage}catch{return console.warn(new Error("LocalStorageProvider: localStorage not supported")),c}}setNamespace(e){if(!this.namespace){this.namespace=e;return}if(this.namespace===e)return;const t=JSON.parse(JSON.stringify(this.getAll()));this.removeAll();for(const[r,o]of Object.entries(t)){const i=r.replace(this.namespace,e);this.setItem(i,o)}this.namespace=e}getItem(e){const t=this.storage.getItem(e);if(t==null)return null;try{return JSON.parse(t)}catch{return t}}setItem(e,t){let r=t;return r!=null&&(r=b(t)?t:JSON.stringify(t)),this.storage.setItem(e,r)}removeItem(e,t=!1){return t&&delete this.registry[e],this.storage.removeItem(e)}getAll(){const e=`${this.namespace}.`;return Object.keys(this.storage).reduce((t,r)=>((!this.namespace||r.startsWith(e))&&(t[r]=this.storage.getItem(r)),t),{})}_resetAll(e=!0,t=[],r=!1){const o=`${this.namespace}.`;Object.keys(localStorage).forEach(i=>{const u=this.namespace?i.startsWith(o):!0,f=t?.includes(i)||!1;!u||f||(e?Object.prototype.hasOwnProperty.call(this.registry,i)?this.storage.setItem(i,this.registry[i]):this.storage.removeItem(i):(this.storage.removeItem(i),r&&delete this.registry[i]))})}resetAll(e=[],t=!1){this._resetAll(!0,e||[],t)}removeAll(e=[],t=!1){this._resetAll(!1,e||[],t)}}const O={logging:{enabled:!1}};let I=j,l=new I,g={...O},m=[];const S=()=>l.namespace,P=()=>l,K=()=>g,W=s=>{l.setNamespace(s),l=new I(s||S())},_=s=>{if(g={...g,...s},g.logging.enabled)for(console.info("Flushing",m.length,"pending logs");m.length;)console.log(...m.shift())},E=(...s)=>{g.logging.enabled?console.log(...s):m.push(s)},T=(s,e=null)=>{if(!s&&typeof s!="number")throw new Error(`createPersistedWire: Key cannot be a falsey value (${s}}`);l.register(s,e);const t=a.createWire(e),r=()=>t.getValue(),o=d=>(l.setItem(s,d),t.setValue(d)),i=d=>{t.subscribe(d)},u=l.getItem(s),f=u===null?e:u;return E("react-wire-persisted: create",s,{value:e,storedValue:u,initialValue:f}),f!==e&&o(f),{...t,getValue:r,setValue:o,subscribe:i}};n.createPersistedWire=T,n.defaultOptions=O,n.getNamespace=S,n.getOptions=K,n.getStorage=P,n.setNamespace=W,n.setOptions=_,n.utils=N,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,57 +1,49 @@
 {
   "name": "react-wire-persisted",
-  "version": "1.2.0",
+  "version": "1.5.0",
   "author": "Wesley Bliss <wesley.bliss@gmail.com>",
   "license": "MIT",
-  "main": "lib/react-wire-persisted.js",
-  "unpkg": "dist/react-wire-persisted.js",
-  "module": "es/react-wire-persisted.js",
+  "type": "module",
+  "main": "./dist/react-wire-persisted.umd.cjs",
+  "module": "./dist/react-wire-persisted.mjs",
   "files": [
-    "dist",
-    "lib",
-    "es",
-    "src"
+    "src",
+    "dist"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/react-wire-persisted.mjs",
+      "require": "./dist/react-wire-persisted.umd.cjs"
+    }
+  },
   "scripts": {
-    "dev": "NODE_ENV=development webpack serve --config config/webpack.config.js --progress",
-    "build": "NODE_ENV=production libton-script build",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:watch:all": "jest --watchAll",
-    "test:watch:coverage": "jest --watch --collectCoverage",
-    "test:snapshots": "jest --updateSnapshot",
-    "test:coverage": "jest --collectCoverage",
-    "test:ci": "jest --runInBand"
+    "dev": "vite --host --config config/vite.config.development.js",
+    "build": "vite build --config config/vite.config.production.js",
+    "test:unit": "NODE_ENV=test vitest run",
+    "test:unit:only": "NODE_ENV=test vitest run -t ",
+    "test:unit:coverage": "NODE_ENV=test vitest run --no-color --reporter=junit --coverage --outputFile=coverage/report.xml"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@babel/core": "^7.17.5",
-    "@babel/plugin-transform-runtime": "^7.17.0",
-    "@babel/preset-env": "^7.16.11",
-    "@babel/preset-react": "^7.16.7",
-    "@forminator/react-wire": "^0.5.0-alpha.1",
-    "@pmmmwh/react-refresh-webpack-plugin": "^0.5.4",
-    "@testing-library/jest-dom": "^5.16.2",
-    "@testing-library/react": "^12.1.3",
-    "babel-jest": "^27.5.1",
-    "babel-loader": "^8.2.3",
-    "browserslist": "^4.19.3",
-    "css-loader": "^6.6.0",
-    "dotenv-webpack": "^7.1.0",
-    "esbuild": "^0.14.23",
-    "html-webpack-plugin": "^5.5.0",
-    "interpolate-html-plugin": "^4.0.0",
-    "jest": "^27.5.1",
-    "libton-script": "^0.12.8",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "snapshot-diff": "^0.9.0",
-    "style-loader": "^3.3.1",
-    "webpack": "^5.69.1",
-    "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-cli": "^4.9.2",
-    "webpack-dev-server": "^4.7.4",
-    "webpack-node-externals": "^3.0.0"
+    "@forminator/react-wire": "^0.7.0",
+    "@testing-library/jest-dom": "^6.6.4",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@vitejs/plugin-react": "^4.7.0",
+    "@vitest/coverage-c8": "^0.33.0",
+    "browserslist": "^4.25.1",
+    "c8": "^10.1.3",
+    "dotenv": "^17.2.1",
+    "esbuild": "^0.25.8",
+    "jest": "^30.0.5",
+    "jest-environment-jsdom": "^30.0.5",
+    "np": "^10.2.0",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
+    "rollup-plugin-inject-process-env": "^1.3.1",
+    "snapshot-diff": "^0.10.0",
+    "vite": "^7.0.6",
+    "vite-jest": "^0.1.4",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
     "@forminator/react-wire": "^0.5.0-alpha.1",
@@ -69,5 +61,8 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "pnpm": {
+    "neverBuiltDependencies": []
   }
 }

package/src/providers/LocalStorageProvider.js

@@ -21,7 +21,7 @@ class LocalStorageProvider extends StorageProvider {
             return window.localStorage
         } catch (e) {
             /* istanbul ignore next */
-            console.warn('LocalStorageProvider: localStorage not supported')
+            console.warn(new Error('LocalStorageProvider: localStorage not supported'))
             /* istanbul ignore next */
             return fakeLocalStorage
         }