qortex-core 0.3.0-beta.3 → 0.3.0-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qortex-core",
-  "version": "0.3.0-beta.3",
+  "version": "0.3.0-beta.4",
   "description": "Framework-agnostic query cache & fetch registry (MFE friendly).",
   "main": "index.js",
   "module": "index.mjs",
@@ -11,6 +11,11 @@
       "types": "./index.d.ts",
       "import": "./index.mjs",
       "require": "./index.js"
+    },
+    "./persister-export": {
+      "types": "./persister-export.d.ts",
+      "import": "./persister-export.mjs",
+      "require": "./persister-export.js"
     }
   },
   "publishConfig": {
@@ -20,6 +25,9 @@
     "index.js",
     "index.mjs",
     "index.d.ts",
+    "persister-export.js",
+    "persister-export.mjs",
+    "persister-export.d.ts",
     "README.md"
   ],
   "repository": {

package/persister-export.d.ts

@@ -0,0 +1,48 @@
+import { P as PersisterConfig, B as BasePersister } from './types-14ced1fe.js';
+export { e as Persister } from './types-14ced1fe.js';
+
+/**
+ * Creates a persister instance for data persistence.
+ *
+ * This factory function creates a persister that can save and load query state data
+ * to/from browser storage (localStorage or sessionStorage). The persister handles
+ * serialization, validation, burst key management, and debounced syncing automatically.
+ *
+ * @param {'local' | 'session'} type - The type of storage to use
+ *   - `'local'`: Uses localStorage for persistent data across browser sessions
+ *   - `'session'`: Uses sessionStorage for data that persists only during the current session
+ * @param {PersisterConfig} [config] - Optional configuration for the persister
+ * @returns {Persister | undefined} A persister instance, or undefined if storage is not available
+ *
+ * @example
+ * ```typescript
+ * // Basic usage with localStorage
+ * const persister = createPersister('local');
+ *
+ * // With custom configuration
+ * const persister = createPersister('local', {
+ *   burstKey: 'v1.0.0',
+ *   prefix: 'my_app',
+ *   debounceTime: 50
+ * });
+ *
+ * // Use with query manager
+ * setDefaultConfig({ persister });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Session storage for temporary data
+ * const sessionPersister = createPersister('session', {
+ *   prefix: 'temp_data',
+ *   debounceTime: 200
+ * });
+ *
+ * setDefaultConfig({ persister: sessionPersister });
+ * ```
+ *
+ * @throws {Error} If an invalid storage type is provided
+ */
+declare const createPersister: (type: "local" | "session", config?: PersisterConfig) => BasePersister | undefined;
+
+export { PersisterConfig, createPersister };

package/persister-export.js

@@ -0,0 +1,5 @@
+'use strict';
+
+function g(e){return typeof e=="string"&&["idle","fetching","success","error"].includes(e)}function h(e){return typeof e=="string"&&["shallow","deep"].includes(e)}function b(e){return e===!1||typeof e=="string"&&["always","stale"].includes(e)}function Q(e){return !(!e||typeof e!="object"||!g(e.status)||typeof e.staleTime!="number"||e.staleTime<0||typeof e.isInvalidated!="boolean"||!h(e.equalityStrategy)||!b(e.refetchOnSubscribe))}function n(e){if(!e||typeof e!="object"||!e.entries||typeof e.entries!="object")return !1;for(let[t,r]of Object.entries(e.entries))if(typeof t!="string"||!Q(r))return !1;return !(typeof e.burstKey!="string"||typeof e.timestamp!="number"||e.timestamp<0)}function l(e){let{fetcher:t,equalityFn:r,fetchPromise:s,refetch:i,...a}=e;return a}function u(e,t){return {...t??{},...e}}function y(e){try{let t=JSON.parse(e);return n(t)?t:null}catch{return null}}var f=()=>{console.warn("[Qortex] No storage found, persister will not be able to persist data");},c=()=>{console.warn("[Qortex] Persister is being set after queries have been used. This may cause data inconsistency. It is recommended to set the persister before any query usage.");};var o=class{constructor(t,r){this.syncTimeout=null;this.debounceTime=100;this.burstKey="0.3.0";this.storageKey="qortex";this.storage=t,this.burstKey=r?.burstKey??this.burstKey,this.storageKey=r?.prefix??this.storageKey,this.debounceTime=r?.debounceTime??this.debounceTime;}save(t){try{let r={entries:{},burstKey:this.burstKey,timestamp:Date.now()};for(let[i,a]of Object.entries(t))r.entries[i]=a;let s=JSON.stringify(r);this.storage.setItem(this.storageKey,s);}catch(r){console.warn("[Qortex] Failed to persist state:",r);}}load(t,r){r&&c();try{let s=this.storage.getItem(this.storageKey);if(!s)return;let i=y(s);if(!i){console.warn("[Qortex] Invalid persisted state format, clearing cache"),this.clear();return}if(i.burstKey!==this.burstKey){console.warn("[Qortex] Burst key mismatch, clearing cache"),this.clear();return}for(let[a,p]of Object.entries(i.entries)){let S=p,d=t.get(a),m=u(S,d);t.set(a,m);}}catch(s){console.warn("[Qortex] Failed to load persisted state:",s),this.clear();}}clear(){try{this.storage.removeItem(this.storageKey);}catch(t){console.warn("[Qortex] Failed to clear persisted data:",t);}}sync(t){this.syncTimeout&&clearTimeout(this.syncTimeout),this.syncTimeout=setTimeout(()=>{let r={};for(let[s,i]of t.entries())r[s]=l(i);this.save(r);},this.debounceTime);}};var P=e=>{switch(e){case"local":if(typeof localStorage<"u")return window.localStorage;break;case"session":if(typeof sessionStorage<"u")return window.sessionStorage;break;default:throw new Error(`Invalid storage type: ${e}`)}},w=(e,t)=>{let r=P(e);if(!r){f();return}return new o(r,t)};
+
+exports.createPersister = w;

package/persister-export.mjs

@@ -0,0 +1,3 @@
+function g(e){return typeof e=="string"&&["idle","fetching","success","error"].includes(e)}function h(e){return typeof e=="string"&&["shallow","deep"].includes(e)}function b(e){return e===!1||typeof e=="string"&&["always","stale"].includes(e)}function Q(e){return !(!e||typeof e!="object"||!g(e.status)||typeof e.staleTime!="number"||e.staleTime<0||typeof e.isInvalidated!="boolean"||!h(e.equalityStrategy)||!b(e.refetchOnSubscribe))}function n(e){if(!e||typeof e!="object"||!e.entries||typeof e.entries!="object")return !1;for(let[t,r]of Object.entries(e.entries))if(typeof t!="string"||!Q(r))return !1;return !(typeof e.burstKey!="string"||typeof e.timestamp!="number"||e.timestamp<0)}function l(e){let{fetcher:t,equalityFn:r,fetchPromise:s,refetch:i,...a}=e;return a}function u(e,t){return {...t??{},...e}}function y(e){try{let t=JSON.parse(e);return n(t)?t:null}catch{return null}}var f=()=>{console.warn("[Qortex] No storage found, persister will not be able to persist data");},c=()=>{console.warn("[Qortex] Persister is being set after queries have been used. This may cause data inconsistency. It is recommended to set the persister before any query usage.");};var o=class{constructor(t,r){this.syncTimeout=null;this.debounceTime=100;this.burstKey="0.3.0";this.storageKey="qortex";this.storage=t,this.burstKey=r?.burstKey??this.burstKey,this.storageKey=r?.prefix??this.storageKey,this.debounceTime=r?.debounceTime??this.debounceTime;}save(t){try{let r={entries:{},burstKey:this.burstKey,timestamp:Date.now()};for(let[i,a]of Object.entries(t))r.entries[i]=a;let s=JSON.stringify(r);this.storage.setItem(this.storageKey,s);}catch(r){console.warn("[Qortex] Failed to persist state:",r);}}load(t,r){r&&c();try{let s=this.storage.getItem(this.storageKey);if(!s)return;let i=y(s);if(!i){console.warn("[Qortex] Invalid persisted state format, clearing cache"),this.clear();return}if(i.burstKey!==this.burstKey){console.warn("[Qortex] Burst key mismatch, clearing cache"),this.clear();return}for(let[a,p]of Object.entries(i.entries)){let S=p,d=t.get(a),m=u(S,d);t.set(a,m);}}catch(s){console.warn("[Qortex] Failed to load persisted state:",s),this.clear();}}clear(){try{this.storage.removeItem(this.storageKey);}catch(t){console.warn("[Qortex] Failed to clear persisted data:",t);}}sync(t){this.syncTimeout&&clearTimeout(this.syncTimeout),this.syncTimeout=setTimeout(()=>{let r={};for(let[s,i]of t.entries())r[s]=l(i);this.save(r);},this.debounceTime);}};var P=e=>{switch(e){case"local":if(typeof localStorage<"u")return window.localStorage;break;case"session":if(typeof sessionStorage<"u")return window.sessionStorage;break;default:throw new Error(`Invalid storage type: ${e}`)}},w=(e,t)=>{let r=P(e);if(!r){f();return}return new o(r,t)};
+
+export { w as createPersister };