state-in-url 4.1.3 → 4.1.5

package/README.md

@@ -22,6 +22,7 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/asmyshlyaev177/state-in-url/badge)](https://scorecard.dev/viewer/?uri=github.com/asmyshlyaev177/state-in-url)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9679/badge)](https://www.bestpractices.dev/projects/9679)
+[![license](https://img.shields.io/github/license/asmyshlyaev177/state-in-url.svg?style=flat-square)](https://github.com/asmyshlyaev177/state-in-url/blob/master/LICENSE)
 <!-- or by embedding this in your HTML:
 <a href="https://www.bestpractices.dev/projects/9679"><img src="https://www.bestpractices.dev/projects/9679/badge"></a>  -->
 
@@ -33,8 +34,10 @@ English | [한국어](./README.KO.md) | [简体中文](./README.CN.md)
 
 ![Demo-gif](https://github.com/asmyshlyaev177/state-in-url/blob/master/assets/Demo-gif.gif)
 
-<a href="https://state-in-url.dev" target="_blank">DEMO</a> |
-<a href="https://state-in-url.netlify.app/" target="_blank">DEMO2</a>
+# Demo
+
+<a href="https://state-in-url.dev" target="_blank">Demo</a> |
+<a href="https://state-in-url.netlify.app/" target="_blank">Mirror link</a>
 
 <a href="https://github.com/asmyshlyaev177/state-in-url/blob/master/Limits.md"  target="_blank">URI size limitation, <b>up to 12KB</b> is safe</a>
 
@@ -82,12 +85,13 @@ This library is a good alternative for NUQS.
 - ✨ **Complex data**: Nested objects, dates and arrays, works same as JSON, but in URL
 - ☂ **Default values**: Giving you default values if parameter not in url
 - ⌨ **Organized**: All possible values defined at start, protect you from getting non existing key
+- **flexible**: Can use more than 1 state objects on the same page, just use different keys
 - **Fast**: Minimal rerenders, around [1ms](https://github.com/asmyshlyaev177/state-in-url/blob/87c8c7c995c5cd7d9e7aa039c30bfe64b24abe4b/packages/urlstate/encoder/encoder.test.ts#L185) to encode and decode big object
 - **Server Side Rendering**: Can use it in Server Components, Next.js 14 and 15 are supported
 - **Lightweight**: Zero dependencies, library less than 2KB
 - **DX**: Good developer experience, documentation, JSDoc comments, and examples
 - **Framework Flexibility**: Hooks for `Next.js` and `react-router`, helpers to use it with other frameworks or pure JS
-- **Well tested**: Unit tests and Playwright tests for Chrome/Firefox/Safari
+- **Well tested**: [Unit tests and Playwright tests for Chrome/Firefox/Safari](https://github.com/asmyshlyaev177/state-in-url/actions/workflows/tests.yml)
 - **Permissive license**: MIT
 
 ## Table of content
@@ -592,7 +596,14 @@ const userState = {
 };
 
 export const useUserState = () => {
-  const { urlState, setUrl } = useUrlState(userState);
+  const { urlState, setUrl, reset } = useUrlState(userState);
+
+  // other logic
+
+  // reset query params when navigating to other page
+  React.useEffect(() => {
+    return reset
+  }, [])
 
   return { userState: urlState, setUserState: setUrl };;
 }

package/dist/next/useUrlState/useUrlState.d.ts

@@ -7,10 +7,19 @@ import { type JSONCompatible } from "../../utils";
  * .
  */
 export declare function useUrlState<T extends JSONCompatible>({ defaultState: T, searchParams, replace, scroll, useHistory, }: OldParams<T>): {
+    /**
+     * @deprecated use `urlState`
+     */
     state: T;
     urlState: T;
+    /**
+     * @deprecated use `setState`
+     */
     updateState: (value: Partial<T> | ((currState: T) => T)) => void;
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
+    /**
+     * @deprecated use `setUrl`
+     */
     updateUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
     setUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
 };
@@ -49,9 +58,42 @@ export declare function useUrlState<T extends JSONCompatible>({ defaultState: T,
  *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState}
  */
 export declare function useUrlState<T extends JSONCompatible>(defaultState: T, params?: Params): {
+    /**
+     * State object. Don't mutate directly, use `setState` or `setUrl`
+     */
     urlState: T;
+    /**
+     * * Example:
+     * ```ts
+     * setState({ name: 'test' });
+     * // or
+     * setState(curr => ({ ...curr, name: 'test' }) );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState#updatestate}
+     */
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
+    /**
+     * * Example:
+     * ```ts
+     * setUrl({ name: 'test' });
+     * // or
+     * setUrl(curr => ({ ...curr, name: 'test' }), { replace: true, scroll: false  } );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState#updateurl}
+     */
     setUrl: (value?: Partial<T> | ((currState: T) => T), options?: Options) => void;
+    /**
+     * * Example:
+     * ```ts
+     * reset();
+     * // or
+     * reset({ replace: false, scroll: true })
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/next/useUrlState#reset}
+     */
     reset: (options?: Options & {
         [key: string]: unknown;
     }) => void;

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

@@ -7,8 +7,14 @@ import { type JSONCompatible } from "../../utils";
  * .
  */
 export declare function useUrlState<T extends JSONCompatible>({ defaultState: T, searchParams, replace, useHistory, }: OldParams<T>): {
+    /**
+     * @deprecated use `urlState`
+     */
     state: T;
     urlState: T;
+    /**
+     * @deprecated use `setState`
+     */
     updateState: (value: Partial<T> | ((currState: T) => T)) => void;
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
     updateUrl: (value?: Partial<T> | ((currState: T) => T)) => void;
@@ -46,9 +52,46 @@ export declare function useUrlState<T extends JSONCompatible>({ defaultState: T,
  *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState}
  */
 export declare function useUrlState<T extends JSONCompatible>(defaultState: T, params?: Params): {
+    /**
+     * State object. Don't mutate directly, use `setState` or `setUrl`
+     */
     urlState: T;
+    /**
+     * * Example:
+     * ```ts
+     * 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}
+     */
     setState: (value: Partial<T> | ((currState: T) => T)) => void;
+    /**
+     * * Example:
+     * ```ts
+     * setUrl({ name: 'test' });
+     * // or
+     * setUrl(curr => ({ ...curr, name: 'test' }), { replace: true } );
+     * // can pass optional React-Router `NavigateOptions`
+     * setUrl(curr => ({ ...curr, name: 'test' }), { preventScrollReset: false } );
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#updateurl}
+     */
     setUrl: (value?: Partial<T> | ((currState: T) => T), options?: Params) => void;
+    /**
+     * * Example:
+     * ```ts
+     * reset();
+     * // or
+     * reset({ replace: false, preventScrollReset: false })
+     *  ```
+     *
+     *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/master/packages/urlstate/react-router/useUrlState#reset}
+     */
     reset: (options?: NavigateOptions & {
         [key: string]: unknown;
     }) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "state-in-url",
-  "version": "4.1.3",
+  "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.",
   "homepage": "https://state-in-url.dev",
   "repository": {