zustand-querystring 0.1.0 → 0.2.0

package/dist/{chunk-HU2467IM.mjs → chunk-L542GMLN.mjs}

@@ -4,7 +4,7 @@ import {
 } from "./chunk-OEB5LU3Z.mjs";
 
 // src/middleware.ts
-import { cloneDeep, isEqual, mergeWith } from "lodash-es";
+import { isEqual, mergeWith } from "lodash-es";
 var compact = (newState, initialState) => {
   const output = {};
   Object.keys(newState).forEach((key) => {
@@ -43,13 +43,16 @@ var translateSelectionToState = (selection, state) => {
 var queryStringImpl = (fn, options) => (set, get, api) => {
   const defaultedOptions = {
     key: "state",
+    format: {
+      stringify,
+      parse
+    },
     ...options
   };
-  const { url } = defaultedOptions;
-  const getStateFromUrl = (url2) => {
-    const match = url2.searchParams.get(defaultedOptions.key);
+  const getStateFromUrl = (url) => {
+    const match = url.searchParams.get(defaultedOptions.key);
     if (match) {
-      return parse(match);
+      return defaultedOptions.format.parse(match);
     }
     return null;
   };
@@ -61,17 +64,17 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
     }
     return state != null ? state : {};
   };
-  const initialize = (url2, initialState) => {
+  const initialize = (url, initialState) => {
     try {
-      const stateFromURl = getStateFromUrl(url2);
+      const stateFromURl = getStateFromUrl(url);
       if (!stateFromURl) {
         return initialState;
       }
       const merged = mergeWith(
-        cloneDeep(initialState),
-        getSelectedState(stateFromURl, url2.pathname)
+        {},
+        initialState,
+        getSelectedState(stateFromURl, url.pathname)
       );
-      set(merged, true);
       return merged;
     } catch (error) {
       console.error(error);
@@ -79,28 +82,29 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
     }
   };
   if (typeof window !== "undefined") {
-    const initialState = cloneDeep(
-      fn(
-        (...args) => {
-          set(...args);
-          setQuery();
-        },
-        get,
-        api
-      )
+    const initialState = fn(
+      (...args) => {
+        set(...args);
+        setQuery();
+      },
+      get,
+      api
     );
     const setQuery = () => {
-      const url2 = new URL(window.location.href);
-      const selectedState = getSelectedState(get(), url2.pathname);
+      const url = new URL(window.location.href);
+      const selectedState = getSelectedState(get(), url.pathname);
       const newCompacted = compact(selectedState, initialState);
-      const previous = url2.search;
+      const previous = url.search;
       if (Object.keys(newCompacted).length) {
-        url2.searchParams.set(defaultedOptions.key, stringify(newCompacted));
+        url.searchParams.set(
+          defaultedOptions.key,
+          defaultedOptions.format.stringify(newCompacted)
+        );
       } else {
-        url2.searchParams.delete(defaultedOptions.key);
+        url.searchParams.delete(defaultedOptions.key);
       }
-      if (url2.search !== previous) {
-        history.replaceState(history.state, "", url2);
+      if (url.search !== previous) {
+        history.replaceState(history.state, "", url);
       }
     };
     if (!api.__ZUSTAND_QUERYSTRING_INIT__) {
@@ -120,9 +124,16 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
       originalSetState(...args);
       setQuery();
     };
-    return initialize(new URL(window.location.href), initialState);
-  } else if (url) {
-    return initialize(new URL(url, "http://localhost"), fn(set, get, api));
+    const initialized = initialize(new URL(window.location.href), initialState);
+    api.getInitialState = () => initialized;
+    return initialized;
+  } else if (defaultedOptions.url) {
+    const initialized = initialize(
+      new URL(defaultedOptions.url, "http://localhost"),
+      fn(set, get, api)
+    );
+    api.getInitialState = () => initialized;
+    return initialized;
   }
   return fn(set, get, api);
 };

package/dist/index.d.mts

@@ -0,0 +1,4 @@
+export { QueryStringOptions, querystring } from './middleware.mjs';
+export { parse, stringify } from './parser.mjs';
+export { createURL } from './utils.mjs';
+import 'zustand/vanilla';

package/dist/index.js

@@ -17,14 +17,14 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   createURL: () => createURL,
   parse: () => parse,
   querystring: () => querystring,
   stringify: () => stringify
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/middleware.ts
 var import_lodash_es = require("lodash-es");
@@ -76,13 +76,16 @@ var translateSelectionToState = (selection, state) => {
 var queryStringImpl = (fn, options) => (set, get, api) => {
   const defaultedOptions = {
     key: "state",
+    format: {
+      stringify,
+      parse
+    },
     ...options
   };
-  const { url } = defaultedOptions;
-  const getStateFromUrl = (url2) => {
-    const match = url2.searchParams.get(defaultedOptions.key);
+  const getStateFromUrl = (url) => {
+    const match = url.searchParams.get(defaultedOptions.key);
     if (match) {
-      return parse(match);
+      return defaultedOptions.format.parse(match);
     }
     return null;
   };
@@ -94,17 +97,17 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
     }
     return state != null ? state : {};
   };
-  const initialize = (url2, initialState) => {
+  const initialize = (url, initialState) => {
     try {
-      const stateFromURl = getStateFromUrl(url2);
+      const stateFromURl = getStateFromUrl(url);
       if (!stateFromURl) {
         return initialState;
       }
       const merged = (0, import_lodash_es.mergeWith)(
-        (0, import_lodash_es.cloneDeep)(initialState),
-        getSelectedState(stateFromURl, url2.pathname)
+        {},
+        initialState,
+        getSelectedState(stateFromURl, url.pathname)
       );
-      set(merged, true);
       return merged;
     } catch (error) {
       console.error(error);
@@ -112,28 +115,29 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
     }
   };
   if (typeof window !== "undefined") {
-    const initialState = (0, import_lodash_es.cloneDeep)(
-      fn(
-        (...args) => {
-          set(...args);
-          setQuery();
-        },
-        get,
-        api
-      )
+    const initialState = fn(
+      (...args) => {
+        set(...args);
+        setQuery();
+      },
+      get,
+      api
     );
     const setQuery = () => {
-      const url2 = new URL(window.location.href);
-      const selectedState = getSelectedState(get(), url2.pathname);
+      const url = new URL(window.location.href);
+      const selectedState = getSelectedState(get(), url.pathname);
       const newCompacted = compact(selectedState, initialState);
-      const previous = url2.search;
+      const previous = url.search;
       if (Object.keys(newCompacted).length) {
-        url2.searchParams.set(defaultedOptions.key, stringify(newCompacted));
+        url.searchParams.set(
+          defaultedOptions.key,
+          defaultedOptions.format.stringify(newCompacted)
+        );
       } else {
-        url2.searchParams.delete(defaultedOptions.key);
+        url.searchParams.delete(defaultedOptions.key);
       }
-      if (url2.search !== previous) {
-        history.replaceState(history.state, "", url2);
+      if (url.search !== previous) {
+        history.replaceState(history.state, "", url);
       }
     };
     if (!api.__ZUSTAND_QUERYSTRING_INIT__) {
@@ -153,9 +157,16 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
       originalSetState(...args);
       setQuery();
     };
-    return initialize(new URL(window.location.href), initialState);
-  } else if (url) {
-    return initialize(new URL(url, "http://localhost"), fn(set, get, api));
+    const initialized = initialize(new URL(window.location.href), initialState);
+    api.getInitialState = () => initialized;
+    return initialized;
+  } else if (defaultedOptions.url) {
+    const initialized = initialize(
+      new URL(defaultedOptions.url, "http://localhost"),
+      fn(set, get, api)
+    );
+    api.getInitialState = () => initialized;
+    return initialized;
   }
   return fn(set, get, api);
 };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import {
   querystring
-} from "./chunk-HU2467IM.mjs";
+} from "./chunk-L542GMLN.mjs";
 import {
   createURL
 } from "./chunk-HC4H2XL3.mjs";

package/dist/middleware.d.mts

@@ -0,0 +1,21 @@
+import { StoreMutatorIdentifier, StateCreator } from 'zustand/vanilla';
+
+type DeepSelect<T> = T extends object ? {
+    [P in keyof T]?: DeepSelect<T[P]> | boolean;
+} : boolean;
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+interface QueryStringOptions<T> {
+    url?: string;
+    select?: (pathname: string) => DeepSelect<T>;
+    key?: string;
+    format?: {
+        stringify: (value: DeepPartial<T>) => string;
+        parse: (value: string) => DeepPartial<T>;
+    };
+}
+type QueryString = <T, Mps extends [StoreMutatorIdentifier, unknown][] = [], Mcs extends [StoreMutatorIdentifier, unknown][] = []>(initializer: StateCreator<T, Mps, Mcs>, options?: QueryStringOptions<T>) => StateCreator<T, Mps, Mcs>;
+declare const querystring: QueryString;
+
+export { type QueryStringOptions, querystring };

package/dist/middleware.d.ts

@@ -3,12 +3,19 @@ import { StoreMutatorIdentifier, StateCreator } from 'zustand/vanilla';
 type DeepSelect<T> = T extends object ? {
     [P in keyof T]?: DeepSelect<T[P]> | boolean;
 } : boolean;
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
 interface QueryStringOptions<T> {
     url?: string;
     select?: (pathname: string) => DeepSelect<T>;
     key?: string;
+    format?: {
+        stringify: (value: DeepPartial<T>) => string;
+        parse: (value: string) => DeepPartial<T>;
+    };
 }
 type QueryString = <T, Mps extends [StoreMutatorIdentifier, unknown][] = [], Mcs extends [StoreMutatorIdentifier, unknown][] = []>(initializer: StateCreator<T, Mps, Mcs>, options?: QueryStringOptions<T>) => StateCreator<T, Mps, Mcs>;
 declare const querystring: QueryString;
 
-export { QueryStringOptions, querystring };
+export { type QueryStringOptions, querystring };

package/dist/middleware.js

@@ -71,13 +71,16 @@ var translateSelectionToState = (selection, state) => {
 var queryStringImpl = (fn, options) => (set, get, api) => {
   const defaultedOptions = {
     key: "state",
+    format: {
+      stringify,
+      parse
+    },
     ...options
   };
-  const { url } = defaultedOptions;
-  const getStateFromUrl = (url2) => {
-    const match = url2.searchParams.get(defaultedOptions.key);
+  const getStateFromUrl = (url) => {
+    const match = url.searchParams.get(defaultedOptions.key);
     if (match) {
-      return parse(match);
+      return defaultedOptions.format.parse(match);
     }
     return null;
   };
@@ -89,17 +92,17 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
     }
     return state != null ? state : {};
   };
-  const initialize = (url2, initialState) => {
+  const initialize = (url, initialState) => {
     try {
-      const stateFromURl = getStateFromUrl(url2);
+      const stateFromURl = getStateFromUrl(url);
       if (!stateFromURl) {
         return initialState;
       }
       const merged = (0, import_lodash_es.mergeWith)(
-        (0, import_lodash_es.cloneDeep)(initialState),
-        getSelectedState(stateFromURl, url2.pathname)
+        {},
+        initialState,
+        getSelectedState(stateFromURl, url.pathname)
       );
-      set(merged, true);
       return merged;
     } catch (error) {
       console.error(error);
@@ -107,28 +110,29 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
     }
   };
   if (typeof window !== "undefined") {
-    const initialState = (0, import_lodash_es.cloneDeep)(
-      fn(
-        (...args) => {
-          set(...args);
-          setQuery();
-        },
-        get,
-        api
-      )
+    const initialState = fn(
+      (...args) => {
+        set(...args);
+        setQuery();
+      },
+      get,
+      api
     );
     const setQuery = () => {
-      const url2 = new URL(window.location.href);
-      const selectedState = getSelectedState(get(), url2.pathname);
+      const url = new URL(window.location.href);
+      const selectedState = getSelectedState(get(), url.pathname);
       const newCompacted = compact(selectedState, initialState);
-      const previous = url2.search;
+      const previous = url.search;
       if (Object.keys(newCompacted).length) {
-        url2.searchParams.set(defaultedOptions.key, stringify(newCompacted));
+        url.searchParams.set(
+          defaultedOptions.key,
+          defaultedOptions.format.stringify(newCompacted)
+        );
       } else {
-        url2.searchParams.delete(defaultedOptions.key);
+        url.searchParams.delete(defaultedOptions.key);
       }
-      if (url2.search !== previous) {
-        history.replaceState(history.state, "", url2);
+      if (url.search !== previous) {
+        history.replaceState(history.state, "", url);
       }
     };
     if (!api.__ZUSTAND_QUERYSTRING_INIT__) {
@@ -148,9 +152,16 @@ var queryStringImpl = (fn, options) => (set, get, api) => {
       originalSetState(...args);
       setQuery();
     };
-    return initialize(new URL(window.location.href), initialState);
-  } else if (url) {
-    return initialize(new URL(url, "http://localhost"), fn(set, get, api));
+    const initialized = initialize(new URL(window.location.href), initialState);
+    api.getInitialState = () => initialized;
+    return initialized;
+  } else if (defaultedOptions.url) {
+    const initialized = initialize(
+      new URL(defaultedOptions.url, "http://localhost"),
+      fn(set, get, api)
+    );
+    api.getInitialState = () => initialized;
+    return initialized;
   }
   return fn(set, get, api);
 };

package/dist/middleware.mjs

@@ -1,6 +1,6 @@
 import {
   querystring
-} from "./chunk-HU2467IM.mjs";
+} from "./chunk-L542GMLN.mjs";
 import "./chunk-OEB5LU3Z.mjs";
 export {
   querystring

package/dist/parser.d.mts

@@ -0,0 +1,4 @@
+declare function stringify(input: unknown): string;
+declare function parse(str: string): any;
+
+export { parse, stringify };

package/dist/utils.d.mts

@@ -0,0 +1,7 @@
+declare const createURL: ({ baseUrl, key, state, }: {
+    baseUrl: string;
+    key: string;
+    state: Object;
+}) => string;
+
+export { createURL };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zustand-querystring",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -41,10 +41,10 @@
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "rimraf": "^3.0.2",
-    "tsup": "^6.7.0",
-    "typescript": "^4.9.5",
-    "zustand": "^4.5.4"
+    "rimraf": "^6.0.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "zustand": "^5.0.3"
   },
   "scripts": {
     "build": "tsup src --dts",