state-in-url 4.1.5 → 4.1.7

package/README.md

@@ -43,7 +43,7 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 
 <hr />
 
-Add a ⭐️ and <a href="https://github.com/asmyshlyaev177" target="_blank">follow me</a> to support the project!
+Add a <a href="#"><img src="https://raw.githubusercontent.com/acervenky/animated-github-badges/master/assets/starbadge.gif" width="25" height="25"></a>  and <a href="https://github.com/asmyshlyaev177" target="_blank">follow me</a> to support the project!
 
 Will appreciate you feedback/opinion on [discussions](https://github.com/asmyshlyaev177/state-in-url/discussions/1)
 

package/dist/react-router/useUrlState/useUrlState.d.ts

@@ -25,7 +25,7 @@ export declare function useUrlState<T extends JSONCompatible>({ defaultState: T,
  *
  * @param {JSONCompatible<T>} [defaultState] Fallback (default) values for state
  * @param {Object} params - Object with other parameters
- * @param {NavigateOptions} params.NavigateOptions See type from `react-router-dom`
+ * @param {NavigateOptions} params.NavigateOptions See type from [`react-router-dom`](https://api.reactrouter.com/v7/interfaces/react_router.NavigateOptions.html)
  * @param {boolean} params.replace replace URL or push, default `true`
  * @param {boolean} params.useHistory use window.history for navigation, default `false`
  * @param {boolean} params.preventScrollReset keep scroll position, default `true`
@@ -62,8 +62,6 @@ export declare function useUrlState<T extends JSONCompatible>(defaultState: T, p
      * setState({ name: 'test' });
      * // or
      * setState(curr => ({ ...curr, name: 'test' }) );
-     * // can pass optional React-Router `NavigateOptions`
-     * setState(curr => ({ ...curr, name: 'test' }) );
      *  ```
      *
      *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#updatestate}

package/dist/useUrlStateBase/useUrlStateBase.mjs

@@ -1 +1 @@
-import u from"react";import{TIMEOUT as b}from"../constants/constants.mjs";import{useInsertionEffect as L}from"../useInsertionEffect.mjs";import{useSharedState as P}from"../useSharedState/useSharedState.mjs";import{useUrlEncode as y}from"../useUrlEncode/useUrlEncode.mjs";import{filterUnknownParamsClient as C}from"../utils.mjs";function O(t,a,l){const{parse:s,stringify:o}=y(t),{state:m,getState:r,setState:c}=P(t,()=>l?.({parse:s})||t),p=u.useRef(void 0);L(()=>{const e=()=>{const n=s(C(t));c(n)};return window.addEventListener(E,e),()=>{window.removeEventListener(E,e),clearTimeout(p.current)}},[c]);const f=u.useRef([]),w=u.useCallback((e,n)=>{const h=typeof e=="function"?e(r()):e?{...r(),...e}:r(),S=o(h,I(t)),U=`${window.location.pathname}${S.length?"?":""}${S}${window.location.hash}`,k=`${window.location.pathname}${window.location.search}${window.location.hash}`;if(U===k)return;let i;c(h);const T=n?.replace;delete n?.replace,f.current.push([T?"replace":"push",U,n]),clearTimeout(p.current),p.current=setTimeout(()=>{queueMicrotask(()=>{for(;f.current.length;){const d=f.current.shift();d&&d?.[1]!==i?.[1]&&(i=d)}const[$,v,R]=i||{};i=void 0,$&&a[$](v,R)})},b)},[a,o,r]),g=u.useCallback(e=>{w(t,e)},[w]);return{updateState:c,updateUrl:w,state:m,reset:g,getState:r}}function I(t){const a=Object.keys(t),l=window.location.search,s=new URLSearchParams(l),o=new URLSearchParams;return s.forEach((m,r)=>!a.includes(r)&&o.set(r,m)),o}const E="popstate";export{O as useUrlStateBase};
+import u from"react";import{TIMEOUT as b}from"../constants/constants.mjs";import{useInsertionEffect as v}from"../useInsertionEffect.mjs";import{useSharedState as y}from"../useSharedState/useSharedState.mjs";import{useUrlEncode as L}from"../useUrlEncode/useUrlEncode.mjs";import{filterUnknownParamsClient as P}from"../utils.mjs";function C(t,a,l){const{parse:c,stringify:n}=L(t),{state:m,getState:r,setState:s}=y(t,()=>l?.({parse:c})||t),p=u.useRef(void 0);v(()=>{const e=()=>{const o=c(P(t));s(o)};return window.addEventListener(S,e),()=>{window.removeEventListener(S,e),clearTimeout(p.current)}},[s]);const i=u.useRef([]),f=u.useCallback((e,o)=>{const w=typeof e=="function"?e(r()):e?{...r(),...e}:r(),d=n(w,I(t)),h=`${window.location.pathname}${d.length?"?":""}${d}${window.location.hash}`,$=`${window.location.pathname}${window.location.search}${window.location.hash}`;if(h===$)return;s(w);const E=o?.replace;delete o?.replace,i.current.push([E?"replace":"push",h,o]),clearTimeout(p.current),p.current=setTimeout(()=>{queueMicrotask(()=>{if(!i.current.length)return;const g=i.current.at(-1);i.current=[];const[T,k,R]=g||[];a[T](k,R)})},b)},[a,n,r]),U=u.useCallback(e=>{f(t,e)},[f]);return{updateState:s,updateUrl:f,state:m,reset:U,getState:r}}function I(t){const a=Object.keys(t),l=window.location.search,c=new URLSearchParams(l),n=new URLSearchParams;return c.forEach((m,r)=>!a.includes(r)&&n.set(r,m)),n}const S="popstate";export{C as useUrlStateBase};

package/dist/utils.d.ts

@@ -27,8 +27,8 @@ export declare function filterUnknownParams<T extends object>(shape: T, searchPa
 export declare function filterUnknown<T extends object>(shape: T, entries: [key: string, value: string][]): string[][];
 export declare function assignValue<T extends object>(shape: T, newVal: Partial<T>): T;
 export interface Router {
-    push: (href: string, opts: object) => void;
-    replace: (href: string, opts: object) => void;
+    push: (href: string, opts?: object) => void;
+    replace: (href: string, opts?: object) => void;
 }
 export declare const routerHistory: Router;
 export declare const isSafari: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "state-in-url",
-  "version": "4.1.5",
-  "description": "Easily share complex state objects between unrelated React components, preserve types and structure, with TS validation. Deep links and url state synchronization wthout any hasssle or boilerplate.",
+  "version": "4.1.7",
+  "description": "Store state in URL as in object, types and structure are preserved, with TS validation. Same API as React.useState, wthout any hasssle or boilerplate. Next.js@14-15 and react-router@6-7.",
   "homepage": "https://state-in-url.dev",
   "repository": {
     "type": "git",
@@ -388,30 +388,57 @@
     "wireit": "^0.14.9"
   },
   "keywords": [
-    "front-end",
-    "state-management",
+    "state in url",
+    "useSearchParams",
+    "useUrlState",
+    "url state",
+    "search params",
+    "nuqs alternative",
+    "reactive",
+    "json",
+    "state sync",
     "state management",
-    "deep links",
-    "deep linking",
+    "encode",
+    "decode",
+    "Next.js",
+    "react-router",
+    "url",
     "url synchronization",
-    "useUrlState",
-    "state in url",
+    "url sync",
+    "state synchronization",
+    "synchronized state",
+    "state-in-url",
+    "store",
+    "react hook",
+    "state hook",
+    "url-state",
     "client components communication",
     "query string",
-    "search params",
+    "query-string",
+    "querystring",
+    "search-params",
+    "searchparams",
+    "params",
+    "parse",
+    "stringify",
     "query params",
     "typescript",
-    "workflow",
-    "javascript",
     "hooks",
     "react.js",
     "reactjs",
     "react",
     "NextJS",
-    "Next.js",
-    "nuqs alternative",
     "query params parser",
-    "query params parsing"
+    "query params parsing",
+    "shared state",
+    "state sharing",
+    "front-end",
+    "state-management",
+    "state-sync",
+    "search",
+    "encode url",
+    "decode url",
+    "fast"
   ],
   "packageManager": "npm@10.8.2"
 }