state-in-url 2.2.1 → 2.2.3

package/dist/encodeState/encodeState.d.ts

@@ -12,7 +12,7 @@ import { type JSONCompatible, type UnknownObj } from '../utils';
  * encodeState({ name: 'test' }, form, 'someExistingParam=123');
  *  ```
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encodeState#encodestate}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encodeState#encodestate}
  */
 export declare function encodeState<T extends JSONCompatible>(state: T, defaults?: T, paramsToKeep?: string | URLSearchParams): string;
 /**
@@ -27,6 +27,6 @@ export declare function encodeState<T extends JSONCompatible>(state: T, defaults
  * decodeState('key=value&name=Alex', form);
  *  ```
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encodeState#decodestate}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encodeState#decodestate}
  */
 export declare function decodeState<T extends JSONCompatible>(uriString: string | URLSearchParams, defaults?: T): undefined extends T ? UnknownObj : T;

package/dist/encoder/encoder.d.ts

@@ -5,9 +5,11 @@ import { type JSONCompatible } from '../utils';
  * @param {unknown} payload any value to serialize
  * @returns {string} URLSearchParams compatible value string
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encoder#encode}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encoder#encode}
  */
 export declare function encode(payload: unknown): string;
+export declare const replacer: (_key: string, value: unknown) => unknown;
+export type Primitive = Exclude<ReturnType<typeof decodePrimitive>, typeof errorSym>;
 /**
  * Decode value part of URLSearchParams back to JS value
  *
@@ -15,14 +17,12 @@ export declare function encode(payload: unknown): string;
  * @param {any} fallback optional fallback value
  * @returns {unknown} decoded object
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encoder#decode}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/encoder#decode}
  */
 export declare function decode<T>(payload: string, fallback?: T): JSONCompatible | Primitive;
-export declare const replacer: (key: string, value: unknown) => unknown;
-export type Primitive = Exclude<ReturnType<typeof decodePrimitive>, typeof errorSym>;
 export declare const decodePrimitive: (str: string) => string | number | boolean | Date | typeof errorSym | null | undefined;
 export declare const errorSym: unique symbol;
-export declare const reviver: (key: string, value: unknown) => unknown;
+export declare const reviver: (_key: string, value: unknown) => unknown;
 /**
  * Parses a JSON string into a TypeScript object.
  *
@@ -30,6 +30,6 @@ export declare const reviver: (key: string, value: unknown) => unknown;
  * @param {T} [fallbackValue] - The fallback value to use if parsing fails.
  * @return {T | Primitive | undefined} - The parsed object or a primitive value, or undefined if parsing fails.
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url}
  */
 export declare function parseJSON<T extends JSONCompatible>(jsonString: string, fallbackValue?: T): T | Primitive | undefined;

package/dist/encoder/encoder.mjs

@@ -1 +1 @@
-import{SYMBOLS as e}from"../constants/constants.mjs";import{typeOf as t}from"../utils.mjs";function r(r){switch(t(r)){case"function":case"symbol":return"";case"date":return e.date+r.toISOString();case"string":return`${e.string}${encodeURIComponent(r)}`;case"number":return e.number+String(r);case"boolean":return e.boolean+String(r);case"object":case"array":return JSON.stringify(r,s).replaceAll('"',"'");case"null":return e.null;case"undefined":return e.undefined;default:return String(r)}}function n(e,t){return c(e.replaceAll("'",'"'),t)}const s=(e,n)=>{const s=t(n);return e&&"object"!==s&&"array"!==s?r(n):n},a=t=>t===e.null?null:t!==e.undefined?t?.startsWith?.(e.number)?Number.parseFloat(t.replace(e.number,"")):t?.startsWith?.(e.boolean)?!!t.includes("true"):t?.startsWith?.(e.date)?new Date(t.slice(1)):t?.startsWith?.(e.string)?decodeURIComponent(t).replace(/^◖/,""):o:void 0,o=Symbol("isError"),u=(e,t)=>{const r="string"==typeof t,n=r&&a(t);return n===o?t:e&&r?n:t};function c(e,t){try{return JSON.parse(e,u)}catch{const r=a(e);return r!==o?r:t}}export{n as decode,a as decodePrimitive,r as encode,o as errorSym,c as parseJSON,s as replacer,u as reviver};
+import{SYMBOLS as e}from"../constants/constants.mjs";import{typeOf as t}from"../utils.mjs";function n(n){if(l(n))return String(n);switch(t(n)){case"function":case"symbol":return"";case"date":return s(n);case"string":return`${e.string}${encodeURIComponent(n)}`;case"number":return e.number+String(n);case"boolean":return e.boolean+String(n);case"object":case"array":return JSON.stringify(n,r).replaceAll('"',"'");case"null":return e.null;case"undefined":return e.undefined;default:return String(n)}}const r=(e,r)=>{const o=t(r);let a=structuredClone(r);return"object"!==o&&"array"!==o||Object.keys(a).forEach((e=>{const n=a[e];"date"===t(n)&&(a[e]=s(n))})),"object"!==o&&"array"!==o?n(a):a};function s(t){return e.date+new Date(t).toISOString()}function o(e,t){return i(e.replaceAll("'",'"'),t)}const a=t=>t===e.null?null:t!==e.undefined?t?.startsWith?.(e.number)?Number.parseFloat(t.replace(e.number,"")):t?.startsWith?.(e.boolean)?!!t.includes("true"):t?.startsWith?.(e.date)?new Date(t.slice(1)):t?.startsWith?.(e.string)?decodeURIComponent(t).replace(/^◖/,""):u:void 0,u=Symbol("isError"),c=(e,t)=>{const n="string"==typeof t,r=n&&a(t);return r===u?t:n?r:t};function i(e,t){try{return JSON.parse(e,c)}catch{const n=a(e);return n!==u?n:t}}const l=t=>new RegExp(`^(${e.string}|${e.boolean}|${e.null}|${e.undefined}|${e.number}|${e.date})`).test(String(t));export{o as decode,a as decodePrimitive,n as encode,u as errorSym,i as parseJSON,r as replacer,c as reviver};

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

@@ -21,7 +21,7 @@ import { type DeepReadonly, type JSONCompatible } from '../../utils';
  * updateUrl(curr => ({ ...curr, name: 'test' }), { replace: true, scroll: true });
  *  ```
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/next/useUrlState#api}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/next/useUrlState#api}
  */
 export declare function useUrlState<T extends JSONCompatible>(defaultState: T, searchParams?: object): {
     state: DeepReadonly<T>;
@@ -49,7 +49,7 @@ export declare function useUrlState<T extends JSONCompatible>(defaultState: T, s
  * updateUrl(curr => ({ ...curr, name: 'test' }), { replace: true, scroll: true });
  *  ```
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/next/useUrlState#api}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/next/useUrlState#api}
  */
 export declare function useUrlState<T extends JSONCompatible>({ defaultState, searchParams, }: {
     defaultState: T;

package/dist/useSharedState/useSharedState.d.ts

@@ -15,7 +15,7 @@ import { type DeepReadonly, type JSONCompatible } from '../utils';
  * // OR
  * setState(curr => ({ ...curr, name: 'test' }))
  *  ```
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useSharedState}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useSharedState}
  */
 export declare function useSharedState<T extends JSONCompatible>(defaultState: T, _getInitial?: () => T): {
     state: T;

package/dist/useUrlEncode/useUrlEncode.d.ts

@@ -17,7 +17,7 @@ import { type JSONCompatible } from '../utils';
  * parse('name=Tom');
  *  ```
  *
- * * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useUrlEncode#api}
+ * * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useUrlEncode#api}
  */
 export declare function useUrlEncode<T extends JSONCompatible>(stateShape: T): {
     /**
@@ -28,7 +28,7 @@ const state = parse('name=◖Tom');
 console.log(state); // Output: { name: 'Tom' }
  *  ```
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useUrlEncode#parse}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useUrlEncode#parse}
  */
     parse: (strOrSearchParams: string | URLSearchParams) => T;
     /**
@@ -39,7 +39,7 @@ const queryString = stringify({ name: 'John' }, 'someExistingParamToKeep=123');
 console.log(queryString); // Output: name=◖John&someExistingParamToKeep=123
 *  ```
 *
-*  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useUrlEncode#stringify}
+*  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/main/packages/urlstate/useUrlEncode#stringify}
 */
     stringify: (state: typeof stateShape, paramsToKeep?: string | URLSearchParams) => string;
 };

package/dist/useUrlStateBase/useUrlStateBase.d.ts

@@ -13,7 +13,7 @@ import { type DeepReadonly, type JSONCompatible } from '../utils';
  * const { state, updateState, updateUrl } = useUrlStateBase(form, router, sp);
  *  ```
  *
- *  * Github {@link https://github.com/asmyshlyaev177/state-in-url/tree/integrations/packages/urlstate/useUrlStateBase#api}
+ *  * Docs {@link https://github.com/asmyshlyaev177/state-in-url/tree/integrations/packages/urlstate/useUrlStateBase#api}
  */
 export declare function useUrlStateBase<T extends JSONCompatible>(defaultState: T, router: Router, searchParams?: object): {
     updateState: (value: Partial<T> | Partial<DeepReadonly<T>> | ((currState: T) => T)) => void;

package/dist/utils.mjs

@@ -1 +1 @@
-const t=t=>{const e=null===t,n=Array.isArray(t),r=t instanceof Date;return(e?"null":r&&"date")||n&&"array"||!e&&!r&&!n&&"object"==typeof t&&"object"||typeof t},e=()=>"undefined"==typeof window,n=t=>new URLSearchParams("string"==typeof t?r(t):t?.toString?.()||""),r=t=>t.split("?")?.[1]||t||"",o=(t,e)=>JSON.stringify(t)===JSON.stringify(e);export{n as getParams,o as isEqual,e as isSSR,t as typeOf};
+const t=t=>{const n=typeof t,r=null===t,e=Array.isArray(t),i=t instanceof Date;return(r?"null":i&&"date")||e&&"array"||!r&&!i&&!e&&"object"===n&&"object"||n},n=()=>"undefined"==typeof window,r=t=>new URLSearchParams("string"==typeof t?e(t):t?.toString?.()||""),e=t=>t.split("?")?.[1]||t||"",i=(t,n)=>JSON.stringify(t)===JSON.stringify(n);export{r as getParams,i as isEqual,n as isSSR,t as typeOf};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "state-in-url",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "Library to store state in browser URL, includes hook for NextJS, hook for pure React, and low level helpers.",
   "homepage": "https://github.com/asmyshlyaev177/state-in-url#readme",
   "keywords": [
@@ -197,7 +197,7 @@
     "last 5 Firefox versions",
     "last 5 FirefoxAndroid versions",
     "Firefox ESR",
-    "last 3 Safari major versions",
+    "last 2 Safari major versions",
     "last 2 iOS major versions"
   ],
   "lint-staged": {
@@ -258,7 +258,6 @@
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
-    "wait-on": "^7.2.0",
     "wireit": "^0.14.4"
   }
 }