react-magic-search-params 1.1.5 → 2.0.1

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var V=Object.defineProperty;var ie=Object.getOwnPropertyDescriptor;var ue=Object.getOwnPropertyNames;var me=Object.prototype.hasOwnProperty;var Pe=(m,y)=>{for(var f in y)V(m,f,{get:y[f],enumerable:!0})},le=(m,y,f,p)=>{if(y&&typeof y=="object"||typeof y=="function")for(let d of ue(y))!me.call(m,d)&&d!==f&&V(m,d,{get:()=>y[d],enumerable:!(p=ie(y,d))||p.enumerable});return m};var pe=m=>le(V({},"__esModule",{value:!0}),m);var fe={};Pe(fe,{useMagicSearchParams:()=>Y});module.exports=pe(fe);var Q=require("react-router-dom"),P=require("react"),Y=({mandatory:m={},optional:y={},defaultParams:f={},arraySerialization:p="csv",forceParams:d={},omitParamsByValues:q=[],codecs:F={},historyMode:E="push",resetOnChange:G={},paginationStrategy:w,unknownParamsPolicy:A="drop"})=>{let[i,L]=(0,Q.useSearchParams)(),j=(0,P.useRef)({}),U=(0,P.useRef)({}),I=(0,P.useCallback)((e,r)=>{L(e,{replace:(r??E)==="replace"})},[L,E]),l=(0,P.useMemo)(()=>({...m,...y}),[m,y]),J=(0,P.useMemo)(()=>Array.from(Object.keys(l)),[l]),v=(0,P.useCallback)(e=>Object.prototype.hasOwnProperty.call(l,e),[l]),X=e=>!Array.isArray(l[e])||p==="csv"?i.get(e):p==="repeat"?i.getAll(e):i.getAll(`${e}[]`),H=(0,P.useCallback)(()=>{if(A==="drop")return[];let e=[];for(let[r,a]of i.entries()){let s=r.endsWith("[]")?r.replace("[]",""):r;v(s)||e.push([r,a])}return e},[A,i,v]),_=(0,P.useCallback)(e=>{if(A==="drop")return e;let r=new URLSearchParams(e.toString()),a=H();for(let[s,t]of a)r.append(s,t);return r},[A,H]),W=(e,r)=>Array.isArray(e)&&Array.isArray(r)?e.length!==r.length?!1:e.every((a,s)=>a===r[s]):e===r,C=(0,P.useMemo)(()=>Object.keys(l).filter(e=>Array.isArray(l[e])),[l]),Z=(e,r)=>{let a={...e};return C.length===0||C.forEach(s=>{let t=[];switch(p){case"csv":{t=(i.get(s)||"").split(",").map(o=>o.trim()).filter(Boolean);break}case"repeat":{let n=i.getAll(s);t=n.length>0?n:[];break}case"brackets":{let n=i.getAll(`${s}[]`);t=n.length>0?n:[];break}default:t=(i.get(s)??"").split(",").map(o=>o.trim()).filter(Boolean)}if(r[s]!==void 0){let n=r[s],o=[];typeof n=="string"?o=t.includes(n)?t.filter(u=>u!==n):[...t,n]:Array.isArray(n)?o=Array.from(new Set([...n.map(String)])):o=t,a[s]=o}}),a},O=e=>{let r=new URLSearchParams,a=Object.keys(e);for(let s of a){let t=F[s];if(t?.serialize){let n=t.serialize(e[s],{key:s});if(n==null)continue;if(Array.isArray(n))if(Array.isArray(l[s]))if(p==="csv")r.set(s,n.join(","));else if(p==="repeat")for(let o of n)r.append(s,String(o));else for(let o of n)r.append(`${s}[]`,String(o));else n.length>0&&r.set(s,String(n[0]));else r.set(s,String(n));continue}if(Array.isArray(l[s])){let n=e[s];switch(p){case"csv":{r.set(s,n.join(","));break}case"repeat":{for(let o of n)r.append(s,String(o));break}case"brackets":{for(let o of n)r.append(`${s}[]`,String(o));break}default:r.set(s,n.join(","))}}else r.set(s,String(e[s]))}return r},h=(e,r)=>Object.prototype.hasOwnProperty.call(m,e)?m[e]:Object.prototype.hasOwnProperty.call(f,e)?f[e]:r,$=({paramsForced:e,compareParams:r})=>Object.entries(e).every(([s,t])=>r[s]===t),T=e=>{let r=X(e),a=F[e];if(a?.parse)return a.parse(r,{key:e,searchParams:i});if(typeof l[e]=="number"){let s=Number.parseInt(String(r??""),10);if(Number.isNaN(s)){let t=h(e,0);return typeof t=="number"?t:0}return s}return typeof l[e]=="boolean"?String(r)==="true":Array.isArray(l[e])?p==="csv"?String(r??"").split(",").filter(Boolean):Array.isArray(r)?r:r?[r]:[]:Array.isArray(r)?r[0]??"":r??""},B=(e,r)=>{if(Array.isArray(l[e])){if(p==="brackets"){let t=i.getAll(`${e}[]`),n=O({[e]:t}).toString();return decodeURIComponent(n)}if(p==="csv"){let t=i.getAll(e),n=O({[e]:t}).toString();return decodeURIComponent(n)}let s=i.getAll(e);return O({[e]:s}).toString()}return r[e]},z=e=>{let r={};for(let[a,s]of e.entries())if(a.endsWith("[]")){let t=a.replace("[]","");r[t]?r[t].push(s):r[t]=[s]}else r[a]?Array.isArray(r[a])?r[a].push(s):r[a]=[r[a],s]:r[a]=s;return r},S=(0,P.useMemo)(()=>p==="brackets"?z(i):Object.fromEntries(i.entries()),[i,p]),b=({convert:e=!0}={})=>Object.keys(S).reduce((a,s)=>{if(Object.prototype.hasOwnProperty.call(l,s)){let t=p==="brackets"?s.replace("[]",""):s;a[t]=e===!0?T(t):B(s,S)}return a},{}),K=(e,r)=>{let a=String(e);return r?.convert!==!1?T(a):B(a,S)},ee=e=>e==null||typeof e!="object"?!1:Object.prototype.hasOwnProperty.call(e,"newParams")||Object.prototype.hasOwnProperty.call(e,"keepParams")||Object.prototype.hasOwnProperty.call(e,"historyMode"),re=e=>{let r=b({convert:!0});if(typeof e=="function"){let a=e(r);return ee(a)?{newParams:typeof a.newParams=="function"?a.newParams(r):a.newParams??{},keepParams:a.keepParams??{},historyMode:a.historyMode}:{newParams:a,keepParams:{},historyMode:void 0}}return e?{newParams:typeof e.newParams=="function"?e.newParams(r):e.newParams??{},keepParams:e.keepParams??{},historyMode:e.historyMode}:{newParams:{},keepParams:{},historyMode:void 0}},se=({currentParams:e,newParams:r,keepParams:a})=>{let s={...r},t={...a};for(let[n,o]of Object.entries(G))if(!(!o||o.length===0||!Object.prototype.hasOwnProperty.call(s,n)||W(s[n],e[n]))){for(let c of o)if(!Object.prototype.hasOwnProperty.call(d,c)){if(Object.prototype.hasOwnProperty.call(m,c)){s[c]=m[c],delete t[c];continue}if(Object.prototype.hasOwnProperty.call(f,c)){s[c]=f[c],delete t[c];continue}delete s[c],t[c]=!1}}return{newParams:s,keepParams:t}},ae=(e,r)=>{let a=b(),s=Object.entries(e).filter(([o])=>!Array.isArray(l[o])),t=Object.assign({...a,...Object.fromEntries(s)},d),n=Object.keys(t).reduce((o,u)=>{if(Object.prototype.hasOwnProperty.call(r,u)&&r[u]===!1)return o;let c=t[u];return c!=null&&c!==""&&!q.includes(c)&&(o[u]=c),o},{});return{...m,...n}},te=e=>J.reduce((a,s)=>(Object.prototype.hasOwnProperty.call(e,s)&&(a[s]=e[s]),a),{}),ne=()=>{let e=C.length>0,r=b({convert:e});return Object.keys(r).reduce((s,t)=>(Object.prototype.hasOwnProperty.call(m,t)&&(s[t]=r[t]),s),{})},D=({keepMandatoryParams:e=!0,historyMode:r}={})=>{let a=O({...m,...e&&{...ne()},...d}),s=_(a);I(s,r)},g=e=>{let r=re(e),a=b({convert:!0}),s=se({currentParams:a,newParams:r.newParams,keepParams:r.keepParams}),t=s.newParams,n=s.keepParams;if(Object.keys(t).length===0&&Object.keys(n).length===0){D({historyMode:r.historyMode});return}let o=ae(t,n),u=Z(o,t),c=te(u),R=O(c),x=_(R);I(x,r.historyMode)},M=w?.mode==="page"?w:void 0,k=w?.mode==="offset"?w:void 0,N=w?.mode==="cursor"?w:void 0,oe={mode:w?.mode??"page",next:e=>{let r=w?.mode??"page";if(r==="cursor"){let n=N?.cursorKey??"cursor";typeof e=="string"&&g({newParams:{[n]:e}});return}if(r==="offset"){let n=k?.offsetKey??"offset",o=k?.limitKey??"limit",u=Number(K(n,{convert:!0})??0),c=Number(K(o,{convert:!0})??h(String(o),10)),R=Number.isFinite(u)?u:0,x=Number.isFinite(c)&&c>0?c:10;g({newParams:{[n]:R+x}});return}let a=M?M.pageKey??"page":"page",s=Number(K(a,{convert:!0})??h(String(a),1)),t=Number.isFinite(s)&&s>0?s:1;g({newParams:{[a]:t+1}})},prev:()=>{let e=w?.mode??"page";if(e==="cursor"){let t=N?.cursorKey??"cursor";g({keepParams:{[t]:!1}});return}if(e==="offset"){let t=k?.offsetKey??"offset",n=k?.limitKey??"limit",o=Number(K(t,{convert:!0})??0),u=Number(K(n,{convert:!0})??h(String(n),10)),c=Number.isFinite(o)?o:0,R=Number.isFinite(u)&&u>0?u:10;g({newParams:{[t]:Math.max(0,c-R)}});return}let r=M?M.pageKey??"page":"page",a=Number(K(r,{convert:!0})??h(String(r),1)),s=Number.isFinite(a)&&a>0?a:1;g({newParams:{[r]:Math.max(1,s-1)}})},reset:()=>{let e=w?.mode??"page";if(e==="cursor"){let s=N?.cursorKey??"cursor";g({keepParams:{[s]:!1}});return}if(e==="offset"){let s=k?.offsetKey??"offset",t=Number(h(String(s),0));g({newParams:{[s]:Number.isFinite(t)?t:0}});return}let r=M?M.pageKey??"page":"page",a=Number(h(String(r),1));g({newParams:{[r]:Number.isFinite(a)&&a>0?a:1}})},setCursor:e=>{let a=(w?.mode??"page")==="cursor"?N?.cursorKey??"cursor":"cursor";if(e==null||e===""){g({keepParams:{[a]:!1}});return}g({newParams:{[a]:e}})}},ce=(0,P.useCallback)((e,r)=>{let a=String(e);return j.current[a]=r,()=>{delete j.current[a],delete U.current[a]}},[]);return(0,P.useEffect)(()=>{for(let[e,r]of Object.entries(j.current)){let a=v(e)?T(e):i.get(e),s=U.current[e]??null;if(!W(a,s))for(let t of r)t({key:e,previousValue:s,currentValue:a});U.current[e]=a}},[S,v,i]),(0,P.useEffect)(()=>{let e=Object.keys(f),r=Object.keys(d);if(e.length===0&&r.length===0)return;function a(){let s=O(f).toString(),t=b(),n=O(t).toString();if(!$({paramsForced:d,compareParams:t})){g({newParams:{...f,...d}});return}let u=$({paramsForced:d,compareParams:f});if(e.length>0&&u){if(s===n)return;g({newParams:f})}}a()},[]),{searchParams:i,updateParams:g,clearParams:D,getParams:b,getParam:K,onChange:ce,pagination:oe}};0&&(module.exports={useMagicSearchParams});

package/dist/index.d.mts

@@ -0,0 +1,99 @@
+type CommonParams = {
+    page?: number;
+    page_size?: number;
+};
+type MergeParams<M, O> = {
+    [K in keyof M]: M[K];
+} & {
+    [K in keyof O]?: O[K];
+};
+type ParamCodec<TValue> = {
+    parse?: (value: string | string[] | null, context: {
+        key: string;
+        searchParams: URLSearchParams;
+    }) => TValue;
+    serialize?: (value: TValue, context: {
+        key: string;
+    }) => string | string[] | null | undefined;
+};
+type ParamCodecs<TParams extends Record<string, unknown>> = Partial<{
+    [K in keyof TParams]: ParamCodec<TParams[K]>;
+}>;
+type ParamKey<TParams extends Record<string, unknown>> = Extract<keyof TParams, string>;
+type PaginationStrategy<TParams extends Record<string, unknown>> = {
+    mode: 'page';
+    pageKey?: ParamKey<TParams>;
+    pageSizeKey?: ParamKey<TParams>;
+} | {
+    mode: 'offset';
+    offsetKey?: ParamKey<TParams>;
+    limitKey?: ParamKey<TParams>;
+} | {
+    mode: 'cursor';
+    cursorKey?: ParamKey<TParams>;
+};
+type ResetOnChangeRules<TParams extends Record<string, unknown>> = Partial<Record<ParamKey<TParams>, Array<ParamKey<TParams>>>>;
+type UnknownParamsPolicy = 'drop' | 'preserve';
+type HistoryMode = 'push' | 'replace';
+type OnChangeEvent<TParams extends Record<string, unknown>> = {
+    key: keyof TParams;
+    previousValue: unknown;
+    currentValue: unknown;
+};
+type OnChangeCallback<TParams extends Record<string, unknown>> = ((event: OnChangeEvent<TParams>) => void) | (() => void);
+/**
+ * Interface for the configuration object that the hook receives
+ */
+interface UseMagicSearchParamsOptions<M extends Record<string, unknown>, O extends Record<string, unknown>> {
+    mandatory: M;
+    optional?: O;
+    defaultParams?: Partial<MergeParams<M, O>>;
+    forceParams?: Partial<MergeParams<M, O>>;
+    arraySerialization?: 'csv' | 'repeat' | 'brackets';
+    omitParamsByValues?: Array<'all' | 'default' | 'unknown' | 'none' | 'void'>;
+    codecs?: ParamCodecs<MergeParams<M, O>>;
+    historyMode?: HistoryMode;
+    resetOnChange?: ResetOnChangeRules<MergeParams<M, O>>;
+    paginationStrategy?: PaginationStrategy<MergeParams<M, O>>;
+    unknownParamsPolicy?: UnknownParamsPolicy;
+}
+/**
+Generic hook to handle search parameters in the URL
+@param mandatory - Mandatory parameters (e.g., page=1, page_size=10, etc.)
+@param optional - Optional parameters (e.g., order, search, etc.)
+@param defaultParams - Default parameters sent in the URL on initialization
+@param forceParams - Parameters forced into the URL regardless of user input
+@param omitParamsByValues - Parameters omitted if they have specific values
+*/
+declare const useMagicSearchParams: <M extends Record<string, unknown> & CommonParams, O extends Record<string, unknown>>({ mandatory, optional, defaultParams, arraySerialization, forceParams, omitParamsByValues, codecs, historyMode, resetOnChange, paginationStrategy, unknownParamsPolicy }: UseMagicSearchParamsOptions<M, O>) => {
+    searchParams: URLSearchParams;
+    updateParams: (input?: {
+        newParams?: Partial<MergeParams<M, O>> | ((current: MergeParams<M, O>) => Partial<MergeParams<M, O>>);
+        keepParams?: Partial<Record<Extract<keyof M, string> | Extract<keyof O, string>, boolean>>;
+        historyMode?: HistoryMode;
+    } | ((current: MergeParams<M, O>) => {
+        newParams?: Partial<MergeParams<M, O>> | ((current: MergeParams<M, O>) => Partial<MergeParams<M, O>>);
+        keepParams?: Partial<Record<Extract<keyof M, string> | Extract<keyof O, string>, boolean>>;
+        historyMode?: HistoryMode;
+    } | Partial<MergeParams<M, O>>)) => void;
+    clearParams: ({ keepMandatoryParams, historyMode: historyModeOverride }?: {
+        keepMandatoryParams?: boolean;
+        historyMode?: HistoryMode;
+    }) => void;
+    getParams: ({ convert }?: {
+        convert?: boolean | undefined;
+    }) => MergeParams<M, O>;
+    getParam: <K extends Extract<keyof M, string> | Extract<keyof O, string>, T extends boolean = true>(key: K, options?: {
+        convert: T;
+    }) => T extends true ? MergeParams<M, O>[K] : string;
+    onChange: (paramName: Extract<keyof M, string> | Extract<keyof O, string>, callbacks: Array<OnChangeCallback<MergeParams<M, O>>>) => () => void;
+    pagination: {
+        mode: "page" | "offset" | "cursor";
+        next: (cursor?: string) => void;
+        prev: () => void;
+        reset: () => void;
+        setCursor: (cursor: string | null | undefined) => void;
+    };
+};
+
+export { type HistoryMode, type OnChangeEvent, type PaginationStrategy, type ParamCodec, type ResetOnChangeRules, type UnknownParamsPolicy, type UseMagicSearchParamsOptions, useMagicSearchParams };

package/dist/index.d.ts

@@ -1 +1,99 @@
-export { useMagicSearchParams, UseMagicSearchParamsOptions } from './useMagicSearchParams';
+type CommonParams = {
+    page?: number;
+    page_size?: number;
+};
+type MergeParams<M, O> = {
+    [K in keyof M]: M[K];
+} & {
+    [K in keyof O]?: O[K];
+};
+type ParamCodec<TValue> = {
+    parse?: (value: string | string[] | null, context: {
+        key: string;
+        searchParams: URLSearchParams;
+    }) => TValue;
+    serialize?: (value: TValue, context: {
+        key: string;
+    }) => string | string[] | null | undefined;
+};
+type ParamCodecs<TParams extends Record<string, unknown>> = Partial<{
+    [K in keyof TParams]: ParamCodec<TParams[K]>;
+}>;
+type ParamKey<TParams extends Record<string, unknown>> = Extract<keyof TParams, string>;
+type PaginationStrategy<TParams extends Record<string, unknown>> = {
+    mode: 'page';
+    pageKey?: ParamKey<TParams>;
+    pageSizeKey?: ParamKey<TParams>;
+} | {
+    mode: 'offset';
+    offsetKey?: ParamKey<TParams>;
+    limitKey?: ParamKey<TParams>;
+} | {
+    mode: 'cursor';
+    cursorKey?: ParamKey<TParams>;
+};
+type ResetOnChangeRules<TParams extends Record<string, unknown>> = Partial<Record<ParamKey<TParams>, Array<ParamKey<TParams>>>>;
+type UnknownParamsPolicy = 'drop' | 'preserve';
+type HistoryMode = 'push' | 'replace';
+type OnChangeEvent<TParams extends Record<string, unknown>> = {
+    key: keyof TParams;
+    previousValue: unknown;
+    currentValue: unknown;
+};
+type OnChangeCallback<TParams extends Record<string, unknown>> = ((event: OnChangeEvent<TParams>) => void) | (() => void);
+/**
+ * Interface for the configuration object that the hook receives
+ */
+interface UseMagicSearchParamsOptions<M extends Record<string, unknown>, O extends Record<string, unknown>> {
+    mandatory: M;
+    optional?: O;
+    defaultParams?: Partial<MergeParams<M, O>>;
+    forceParams?: Partial<MergeParams<M, O>>;
+    arraySerialization?: 'csv' | 'repeat' | 'brackets';
+    omitParamsByValues?: Array<'all' | 'default' | 'unknown' | 'none' | 'void'>;
+    codecs?: ParamCodecs<MergeParams<M, O>>;
+    historyMode?: HistoryMode;
+    resetOnChange?: ResetOnChangeRules<MergeParams<M, O>>;
+    paginationStrategy?: PaginationStrategy<MergeParams<M, O>>;
+    unknownParamsPolicy?: UnknownParamsPolicy;
+}
+/**
+Generic hook to handle search parameters in the URL
+@param mandatory - Mandatory parameters (e.g., page=1, page_size=10, etc.)
+@param optional - Optional parameters (e.g., order, search, etc.)
+@param defaultParams - Default parameters sent in the URL on initialization
+@param forceParams - Parameters forced into the URL regardless of user input
+@param omitParamsByValues - Parameters omitted if they have specific values
+*/
+declare const useMagicSearchParams: <M extends Record<string, unknown> & CommonParams, O extends Record<string, unknown>>({ mandatory, optional, defaultParams, arraySerialization, forceParams, omitParamsByValues, codecs, historyMode, resetOnChange, paginationStrategy, unknownParamsPolicy }: UseMagicSearchParamsOptions<M, O>) => {
+    searchParams: URLSearchParams;
+    updateParams: (input?: {
+        newParams?: Partial<MergeParams<M, O>> | ((current: MergeParams<M, O>) => Partial<MergeParams<M, O>>);
+        keepParams?: Partial<Record<Extract<keyof M, string> | Extract<keyof O, string>, boolean>>;
+        historyMode?: HistoryMode;
+    } | ((current: MergeParams<M, O>) => {
+        newParams?: Partial<MergeParams<M, O>> | ((current: MergeParams<M, O>) => Partial<MergeParams<M, O>>);
+        keepParams?: Partial<Record<Extract<keyof M, string> | Extract<keyof O, string>, boolean>>;
+        historyMode?: HistoryMode;
+    } | Partial<MergeParams<M, O>>)) => void;
+    clearParams: ({ keepMandatoryParams, historyMode: historyModeOverride }?: {
+        keepMandatoryParams?: boolean;
+        historyMode?: HistoryMode;
+    }) => void;
+    getParams: ({ convert }?: {
+        convert?: boolean | undefined;
+    }) => MergeParams<M, O>;
+    getParam: <K extends Extract<keyof M, string> | Extract<keyof O, string>, T extends boolean = true>(key: K, options?: {
+        convert: T;
+    }) => T extends true ? MergeParams<M, O>[K] : string;
+    onChange: (paramName: Extract<keyof M, string> | Extract<keyof O, string>, callbacks: Array<OnChangeCallback<MergeParams<M, O>>>) => () => void;
+    pagination: {
+        mode: "page" | "offset" | "cursor";
+        next: (cursor?: string) => void;
+        prev: () => void;
+        reset: () => void;
+        setCursor: (cursor: string | null | undefined) => void;
+    };
+};
+
+export { type HistoryMode, type OnChangeEvent, type PaginationStrategy, type ParamCodec, type ResetOnChangeRules, type UnknownParamsPolicy, type UseMagicSearchParamsOptions, useMagicSearchParams };

package/dist/index.js

@@ -1,8 +1 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./react-magic-search-params.cjs.production.min.js')
-} else {
-  module.exports = require('./react-magic-search-params.cjs.development.js')
-}
+import{useSearchParams as ie}from"react-router-dom";import{useMemo as N,useEffect as Q,useRef as Y,useCallback as k}from"react";var ue=({mandatory:f={},optional:V={},defaultParams:g={},arraySerialization:l="csv",forceParams:d={},omitParamsByValues:q=[],codecs:F={},historyMode:E="push",resetOnChange:G={},paginationStrategy:p,unknownParamsPolicy:R="drop"})=>{let[i,L]=ie(),j=Y({}),U=Y({}),I=k((e,r)=>{L(e,{replace:(r??E)==="replace"})},[L,E]),m=N(()=>({...f,...V}),[f,V]),J=N(()=>Array.from(Object.keys(m)),[m]),A=k(e=>Object.prototype.hasOwnProperty.call(m,e),[m]),X=e=>!Array.isArray(m[e])||l==="csv"?i.get(e):l==="repeat"?i.getAll(e):i.getAll(`${e}[]`),H=k(()=>{if(R==="drop")return[];let e=[];for(let[r,a]of i.entries()){let s=r.endsWith("[]")?r.replace("[]",""):r;A(s)||e.push([r,a])}return e},[R,i,A]),_=k(e=>{if(R==="drop")return e;let r=new URLSearchParams(e.toString()),a=H();for(let[s,t]of a)r.append(s,t);return r},[R,H]),W=(e,r)=>Array.isArray(e)&&Array.isArray(r)?e.length!==r.length?!1:e.every((a,s)=>a===r[s]):e===r,C=N(()=>Object.keys(m).filter(e=>Array.isArray(m[e])),[m]),Z=(e,r)=>{let a={...e};return C.length===0||C.forEach(s=>{let t=[];switch(l){case"csv":{t=(i.get(s)||"").split(",").map(o=>o.trim()).filter(Boolean);break}case"repeat":{let n=i.getAll(s);t=n.length>0?n:[];break}case"brackets":{let n=i.getAll(`${s}[]`);t=n.length>0?n:[];break}default:t=(i.get(s)??"").split(",").map(o=>o.trim()).filter(Boolean)}if(r[s]!==void 0){let n=r[s],o=[];typeof n=="string"?o=t.includes(n)?t.filter(u=>u!==n):[...t,n]:Array.isArray(n)?o=Array.from(new Set([...n.map(String)])):o=t,a[s]=o}}),a},y=e=>{let r=new URLSearchParams,a=Object.keys(e);for(let s of a){let t=F[s];if(t?.serialize){let n=t.serialize(e[s],{key:s});if(n==null)continue;if(Array.isArray(n))if(Array.isArray(m[s]))if(l==="csv")r.set(s,n.join(","));else if(l==="repeat")for(let o of n)r.append(s,String(o));else for(let o of n)r.append(`${s}[]`,String(o));else n.length>0&&r.set(s,String(n[0]));else r.set(s,String(n));continue}if(Array.isArray(m[s])){let n=e[s];switch(l){case"csv":{r.set(s,n.join(","));break}case"repeat":{for(let o of n)r.append(s,String(o));break}case"brackets":{for(let o of n)r.append(`${s}[]`,String(o));break}default:r.set(s,n.join(","))}}else r.set(s,String(e[s]))}return r},w=(e,r)=>Object.prototype.hasOwnProperty.call(f,e)?f[e]:Object.prototype.hasOwnProperty.call(g,e)?g[e]:r,$=({paramsForced:e,compareParams:r})=>Object.entries(e).every(([s,t])=>r[s]===t),T=e=>{let r=X(e),a=F[e];if(a?.parse)return a.parse(r,{key:e,searchParams:i});if(typeof m[e]=="number"){let s=Number.parseInt(String(r??""),10);if(Number.isNaN(s)){let t=w(e,0);return typeof t=="number"?t:0}return s}return typeof m[e]=="boolean"?String(r)==="true":Array.isArray(m[e])?l==="csv"?String(r??"").split(",").filter(Boolean):Array.isArray(r)?r:r?[r]:[]:Array.isArray(r)?r[0]??"":r??""},B=(e,r)=>{if(Array.isArray(m[e])){if(l==="brackets"){let t=i.getAll(`${e}[]`),n=y({[e]:t}).toString();return decodeURIComponent(n)}if(l==="csv"){let t=i.getAll(e),n=y({[e]:t}).toString();return decodeURIComponent(n)}let s=i.getAll(e);return y({[e]:s}).toString()}return r[e]},z=e=>{let r={};for(let[a,s]of e.entries())if(a.endsWith("[]")){let t=a.replace("[]","");r[t]?r[t].push(s):r[t]=[s]}else r[a]?Array.isArray(r[a])?r[a].push(s):r[a]=[r[a],s]:r[a]=s;return r},v=N(()=>l==="brackets"?z(i):Object.fromEntries(i.entries()),[i,l]),h=({convert:e=!0}={})=>Object.keys(v).reduce((a,s)=>{if(Object.prototype.hasOwnProperty.call(m,s)){let t=l==="brackets"?s.replace("[]",""):s;a[t]=e===!0?T(t):B(s,v)}return a},{}),O=(e,r)=>{let a=String(e);return r?.convert!==!1?T(a):B(a,v)},ee=e=>e==null||typeof e!="object"?!1:Object.prototype.hasOwnProperty.call(e,"newParams")||Object.prototype.hasOwnProperty.call(e,"keepParams")||Object.prototype.hasOwnProperty.call(e,"historyMode"),re=e=>{let r=h({convert:!0});if(typeof e=="function"){let a=e(r);return ee(a)?{newParams:typeof a.newParams=="function"?a.newParams(r):a.newParams??{},keepParams:a.keepParams??{},historyMode:a.historyMode}:{newParams:a,keepParams:{},historyMode:void 0}}return e?{newParams:typeof e.newParams=="function"?e.newParams(r):e.newParams??{},keepParams:e.keepParams??{},historyMode:e.historyMode}:{newParams:{},keepParams:{},historyMode:void 0}},se=({currentParams:e,newParams:r,keepParams:a})=>{let s={...r},t={...a};for(let[n,o]of Object.entries(G))if(!(!o||o.length===0||!Object.prototype.hasOwnProperty.call(s,n)||W(s[n],e[n]))){for(let c of o)if(!Object.prototype.hasOwnProperty.call(d,c)){if(Object.prototype.hasOwnProperty.call(f,c)){s[c]=f[c],delete t[c];continue}if(Object.prototype.hasOwnProperty.call(g,c)){s[c]=g[c],delete t[c];continue}delete s[c],t[c]=!1}}return{newParams:s,keepParams:t}},ae=(e,r)=>{let a=h(),s=Object.entries(e).filter(([o])=>!Array.isArray(m[o])),t=Object.assign({...a,...Object.fromEntries(s)},d),n=Object.keys(t).reduce((o,u)=>{if(Object.prototype.hasOwnProperty.call(r,u)&&r[u]===!1)return o;let c=t[u];return c!=null&&c!==""&&!q.includes(c)&&(o[u]=c),o},{});return{...f,...n}},te=e=>J.reduce((a,s)=>(Object.prototype.hasOwnProperty.call(e,s)&&(a[s]=e[s]),a),{}),ne=()=>{let e=C.length>0,r=h({convert:e});return Object.keys(r).reduce((s,t)=>(Object.prototype.hasOwnProperty.call(f,t)&&(s[t]=r[t]),s),{})},D=({keepMandatoryParams:e=!0,historyMode:r}={})=>{let a=y({...f,...e&&{...ne()},...d}),s=_(a);I(s,r)},P=e=>{let r=re(e),a=h({convert:!0}),s=se({currentParams:a,newParams:r.newParams,keepParams:r.keepParams}),t=s.newParams,n=s.keepParams;if(Object.keys(t).length===0&&Object.keys(n).length===0){D({historyMode:r.historyMode});return}let o=ae(t,n),u=Z(o,t),c=te(u),M=y(c),x=_(M);I(x,r.historyMode)},K=p?.mode==="page"?p:void 0,b=p?.mode==="offset"?p:void 0,S=p?.mode==="cursor"?p:void 0,oe={mode:p?.mode??"page",next:e=>{let r=p?.mode??"page";if(r==="cursor"){let n=S?.cursorKey??"cursor";typeof e=="string"&&P({newParams:{[n]:e}});return}if(r==="offset"){let n=b?.offsetKey??"offset",o=b?.limitKey??"limit",u=Number(O(n,{convert:!0})??0),c=Number(O(o,{convert:!0})??w(String(o),10)),M=Number.isFinite(u)?u:0,x=Number.isFinite(c)&&c>0?c:10;P({newParams:{[n]:M+x}});return}let a=K?K.pageKey??"page":"page",s=Number(O(a,{convert:!0})??w(String(a),1)),t=Number.isFinite(s)&&s>0?s:1;P({newParams:{[a]:t+1}})},prev:()=>{let e=p?.mode??"page";if(e==="cursor"){let t=S?.cursorKey??"cursor";P({keepParams:{[t]:!1}});return}if(e==="offset"){let t=b?.offsetKey??"offset",n=b?.limitKey??"limit",o=Number(O(t,{convert:!0})??0),u=Number(O(n,{convert:!0})??w(String(n),10)),c=Number.isFinite(o)?o:0,M=Number.isFinite(u)&&u>0?u:10;P({newParams:{[t]:Math.max(0,c-M)}});return}let r=K?K.pageKey??"page":"page",a=Number(O(r,{convert:!0})??w(String(r),1)),s=Number.isFinite(a)&&a>0?a:1;P({newParams:{[r]:Math.max(1,s-1)}})},reset:()=>{let e=p?.mode??"page";if(e==="cursor"){let s=S?.cursorKey??"cursor";P({keepParams:{[s]:!1}});return}if(e==="offset"){let s=b?.offsetKey??"offset",t=Number(w(String(s),0));P({newParams:{[s]:Number.isFinite(t)?t:0}});return}let r=K?K.pageKey??"page":"page",a=Number(w(String(r),1));P({newParams:{[r]:Number.isFinite(a)&&a>0?a:1}})},setCursor:e=>{let a=(p?.mode??"page")==="cursor"?S?.cursorKey??"cursor":"cursor";if(e==null||e===""){P({keepParams:{[a]:!1}});return}P({newParams:{[a]:e}})}},ce=k((e,r)=>{let a=String(e);return j.current[a]=r,()=>{delete j.current[a],delete U.current[a]}},[]);return Q(()=>{for(let[e,r]of Object.entries(j.current)){let a=A(e)?T(e):i.get(e),s=U.current[e]??null;if(!W(a,s))for(let t of r)t({key:e,previousValue:s,currentValue:a});U.current[e]=a}},[v,A,i]),Q(()=>{let e=Object.keys(g),r=Object.keys(d);if(e.length===0&&r.length===0)return;function a(){let s=y(g).toString(),t=h(),n=y(t).toString();if(!$({paramsForced:d,compareParams:t})){P({newParams:{...g,...d}});return}let u=$({paramsForced:d,compareParams:g});if(e.length>0&&u){if(s===n)return;P({newParams:g})}}a()},[]),{searchParams:i,updateParams:P,clearParams:D,getParams:h,getParam:O,onChange:ce,pagination:oe}};export{ue as useMagicSearchParams};

package/package.json

@@ -3,7 +3,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/Gabriel117343/react-magic-search-params"
-   },
+  },
   "homepage": "https://react-magic-search-params.netlify.app",
   "keywords": [
     "react",
@@ -14,31 +14,39 @@
     "autocomplete",
     "use-url-search-params",
     "use-search-params",
-    "use-query-parameters"
-
+    "use-query-parameters",
+    "query-parameters"
   ],
-  "version": "1.1.5",
+  "version": "2.0.1",
+  "private": false,
   "license": "MIT",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "typings": "dist/index.d.ts",
+  "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "engines": {
-    "node": ">=10"
+    "node": ">=18"
   },
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "vitest",
-    "lint": "tsdx lint",
-    "prepare": "tsdx build",
+    "start": "tsup --watch",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "build": "tsup",
+    "test": "vitest run --environment jsdom",
+    "test:watch": "vitest --environment jsdom",
+    "lint": "tsc --noEmit",
+    "prepare": "tsup",
     "size": "size-limit",
-    "analyze": "size-limit --why"
+    "analyze": "size-limit --why",
+    "prepack": "node -e \"const fs=require('fs');fs.copyFileSync('README.md','.README.repo.md');fs.copyFileSync('README_NPM.md','README.md');\"",
+    "postpack": "node -e \"const fs=require('fs');if(fs.existsSync('.README.repo.md')){fs.copyFileSync('.README.repo.md','README.md');fs.unlinkSync('.README.repo.md');}\""
   },
   "peerDependencies": {
-    "react": ">=16",
+    "react": ">=18 <20",
     "react-router-dom": ">=6"
   },
   "husky": {
@@ -54,36 +62,37 @@
   },
   "name": "react-magic-search-params",
   "author": "Gabriel S.",
-  "module": "dist/react-magic-search-params.esm.js",
   "size-limit": [
     {
-      "path": "dist/usemagicsearchparams-library.cjs.production.min.js",
+      "path": "dist/index.cjs",
       "limit": "10 KB"
     },
     {
-      "path": "dist/usemagicsearchparams-library.esm.js",
+      "path": "dist/index.js",
       "limit": "10 KB"
     }
   ],
   "devDependencies": {
     "@size-limit/preset-small-lib": "^11.2.0",
-    "@types/react": "^19.0.10",
-    "@types/react-dom": "^19.0.4",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "@testing-library/react": "^16.3.0",
     "husky": "^9.1.7",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
+    "jsdom": "^26.1.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "react-router-dom": "^7.0.0",
     "size-limit": "^11.2.0",
-    "tsdx": "^0.14.1",
+    "tsup": "^8.5.0",
     "tslib": "^2.8.1",
-    "typescript": "^3.9.10",
-    "vitest": "^3.0.8",
-    "@testing-library/react": "^16.2.0"
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
   },
   "exports": {
     ".": {
-      "import": "./dist/react-magic-search-params.esm.js",
-      "require": "./dist/react-magic-search-params.cjs.production.min.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   }
-}
+}

package/dist/constants/defaultParamsPage.d.ts

@@ -1,12 +0,0 @@
-export declare const paramsUsers: {
-    mandatory: {
-        page: number;
-        page_size: 10;
-        only_is_active: boolean;
-        tags: unknown[];
-    };
-    optional: {
-        order: string;
-        search: string;
-    };
-};