@real-router/persistent-params-plugin 0.1.34 → 0.1.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/metafile-cjs.json +1 -1
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/index.mjs.map +1 -1
- package/dist/esm/metafile-esm.json +1 -1
- package/package.json +3 -3
- package/src/factory.ts +106 -0
- package/src/index.ts +1 -1
- package/src/param-utils.ts +82 -0
- package/src/plugin.ts +105 -268
- package/src/validation.ts +128 -0
- package/src/constants.ts +0 -7
- package/src/utils.ts +0 -250
package/dist/cjs/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var t=require("@real-router/core");function r(t){const r={};for(const e in t)Object.hasOwn(t,e)&&(r[e]=t[e]);return r}function e(t){return"number"==typeof t?Number.isFinite(t):"string"==typeof t||"boolean"==typeof t}var a=/[\s#%&/=?\\]/,s=String.raw`Cannot contain: = & ? # % / \ or whitespace`;function n(t){if(a.test(t))throw new TypeError(`[@real-router/persistent-params-plugin] Invalid parameter name "${t}". ${s}`)}function i(t,r){if(null===r)throw new TypeError(`[@real-router/persistent-params-plugin] Parameter "${t}" cannot be null. Use undefined to remove the parameter from persistence.`);if(void 0!==r&&!e(r)){const e=Array.isArray(r)?"array":typeof r;throw new TypeError(`[@real-router/persistent-params-plugin] Parameter "${t}" must be a primitive value (string, number, or boolean), got ${e}. Objects and arrays are not supported in URL parameters.`)}}var o=class{#t;#r;#e;#a;#s;#n;constructor(t,r,e,a){this.#t=t,this.#a=r,this.#r=e,this.#e=a}getPlugin(){try{const t=[...this.#r].join("&");this.#t.setRootPath(`${this.#e}?${t}`)}catch(t){throw new Error(`[@real-router/persistent-params-plugin] Failed to update root path: ${t instanceof Error?t.message:String(t)}`,{cause:t})}return this.#s=this.#t.addInterceptor("buildPath",(t,r,e)=>t(r,this.#i(e??{}))),this.#n=this.#t.addInterceptor("forwardState",(t,r,e)=>{const a=t(r,e);return{...a,params:this.#i(a.params)}}),{onTransitionSuccess:t=>{this.#o(t)},teardown:()=>{this.#p()}}}#i(t){const e=r(t);let a;for(const t of Object.keys(e)){const r=e[t];void 0===r&&this.#r.has(t)?(this.#r.delete(t),a??={...this.#a},delete a[t]):i(t,r)}return a&&(this.#a=Object.freeze(a)),function(t,e){const a=r(e),s={};for(const r in t)Object.hasOwn(t,r)&&void 0!==t[r]&&(s[r]=t[r]);for(const t of Object.keys(a)){const r=a[t];void 0===r?delete s[t]:s[t]=r}return s}(this.#a,e)}#o(t){let r;for(const e of this.#r){const a=t.params[e];Object.hasOwn(t.params,e)&&void 0!==a?(i(e,a),this.#a[e]!==a&&(r??={...this.#a},r[e]=a)):Object.hasOwn(this.#a,e)&&void 0!==this.#a[e]&&(r??={...this.#a},delete r[e])}r&&(this.#a=Object.freeze(r))}#p(){try{this.#s?.(),this.#n?.(),this.#t.setRootPath(this.#e)}catch(t){console.error("persistent-params-plugin","Error during teardown:",t)}}},p=()=>({});exports.persistentParamsPluginFactory=function(r={}){return function(t){if(null==(r=t)||!(Array.isArray(r)?r.every(t=>{if("string"!=typeof t||0===t.length)return!1;try{return n(t),!0}catch{return!1}}):"object"==typeof r&&Object.getPrototypeOf(r)===Object.prototype&&Object.entries(r).every(([t,r])=>{if("string"!=typeof t||0===t.length)return!1;try{n(t)}catch{return!1}return e(r)}))){let r;throw r=null===t?"null":Array.isArray(t)?"array with invalid items":typeof t,new TypeError(`[@real-router/persistent-params-plugin] Invalid params configuration. Expected array of non-empty strings or object with primitive values, got ${r}.`)}var r}(r),Array.isArray(r)&&0===r.length?p:Array.isArray(r)||0!==Object.keys(r).length?e=>{let a;if(Array.isArray(r)){const t={};for(const e of r)t[e]=void 0;a=Object.freeze(t)}else a=Object.freeze({...r});const s=new Set(Array.isArray(r)?[...r]:Object.keys(r)),n=t.getPluginApi(e),i=n.getRootPath();return new o(n,a,s,i).getPlugin()}:p};//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/constants.ts","../../src/utils.ts","../../src/plugin.ts"],"names":["getPluginApi"],"mappings":";;;AAMO,IAAM,aAAA,0BAAuB,0BAA0B,CAAA;;;;;;;;ACC9D,IAAM,uBAAA,GAA0B,cAAA;AAChC,IAAM,wBAAwB,MAAA,CAAO,GAAA,CAAA,2CAAA,CAAA;AAE9B,SAAS,iBAAiB,GAAA,EAAmB;AAClD,EAAA,IAAI,uBAAA,CAAwB,IAAA,CAAK,GAAG,CAAA,EAAG;AACrC,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,gEAAA,EAAmE,GAAG,CAAA,GAAA,EAAM,qBAAqB,CAAA;AAAA,KACnG;AAAA,EACF;AACF;AAgBO,SAAS,oBACd,MAAA,EACkC;AAClC,EAAA,IAAI,MAAA,KAAW,IAAA,IAAQ,MAAA,KAAW,MAAA,EAAW;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AAGA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,IAAA,OAAO,MAAA,CAAO,KAAA,CAAM,CAAC,IAAA,KAAS;AAC5B,MAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,CAAK,WAAW,CAAA,EAAG;AACjD,QAAA,OAAO,KAAA;AAAA,MACT;AAEA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,IAAI,CAAA;AAErB,QAAA,OAAO,IAAA;AAAA,MACT,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAGA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAE9B,IAAA,IAAI,MAAA,CAAO,cAAA,CAAe,MAAM,CAAA,KAAM,OAAO,SAAA,EAAW;AACtD,MAAA,OAAO,KAAA;AAAA,IACT;AAGA,IAAA,OAAO,MAAA,CAAO,QAAQ,MAAM,CAAA,CAAE,MAAM,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAEpD,MAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,WAAW,CAAA,EAAG;AAC/C,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,GAAG,CAAA;AAAA,MACtB,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,OAAO,EAAiB,KAAK,CAAA;AAAA,IAC/B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,KAAA;AACT;AAUO,SAAS,kBAAA,CAAmB,KAAa,KAAA,EAAsB;AACpE,EAAA,IAAI,UAAU,IAAA,EAAM;AAClB,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,sDAAsD,GAAG,CAAA,yEAAA;AAAA,KAE3D;AAAA,EACF;AAEA,EAAA,IAAI,KAAA,KAAU,MAAA,IAAa,CAAC,CAAA,CAAiB,KAAK,CAAA,EAAG;AACnD,IAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,UAAU,OAAO,KAAA;AAE3D,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,mDAAA,EAAsD,GAAG,CAAA,8DAAA,EAClB,UAAU,CAAA,yDAAA;AAAA,KAEnD;AAAA,EACF;AACF;AAcO,SAAS,iBAAiB,MAAA,EAAwB;AACvD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,MAAA,EAAQ;AAExB,IAAA,IAAI,MAAA,CAAO,MAAA,CAAO,MAAA,EAAQ,GAAG,CAAA,EAAG;AAC9B,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,MAAA,CAAO,GAAG,CAAA;AAAA,IAC1B;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AAcO,SAAS,iBAAiB,IAAA,EAG/B;AACA,EAAA,MAAM,iBAAA,GAAoB,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AAG1C,EAAA,IAAI,sBAAsB,EAAA,EAAI;AAC5B,IAAA,OAAO,EAAE,QAAA,EAAU,IAAA,EAAM,WAAA,EAAa,EAAA,EAAG;AAAA,EAC3C;AAGA,EAAA,IAAI,sBAAsB,CAAA,EAAG;AAC3B,IAAA,OAAO,EAAE,QAAA,EAAU,EAAA,EAAI,aAAa,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA,EAAE;AAAA,EACpD;AAGA,EAAA,OAAO;AAAA,IACL,QAAA,EAAU,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,iBAAiB,CAAA;AAAA,IACzC,WAAA,EAAa,IAAA,CAAK,KAAA,CAAM,iBAAA,GAAoB,CAAC;AAAA,GAC/C;AACF;AAcO,SAAS,gBAAA,CACd,eACA,UAAA,EACQ;AACR,EAAA,IAAI,UAAA,CAAW,WAAW,CAAA,EAAG;AAC3B,IAAA,OAAO,aAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAA,GAAY,gBAAgB,GAAA,GAAM,EAAA;AAExC,EAAA,OAAO,aAAA,GAAgB,SAAA,GAAY,UAAA,CAAW,IAAA,CAAK,GAAG,CAAA;AACxD;AAuBO,SAAS,WAAA,CACd,YACA,OAAA,EACQ;AAER,EAAA,MAAM,iBAAA,GAAoB,iBAAiB,OAAO,CAAA;AAIlD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,IAAI,MAAA,CAAO,OAAO,UAAA,EAAY,GAAG,KAAK,UAAA,CAAW,GAAG,MAAM,MAAA,EAAW;AACnE,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,UAAA,CAAW,GAAG,CAAA;AAAA,IAC9B;AAAA,EACF;AAGA,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,iBAAiB,CAAA,EAAG;AAChD,IAAA,MAAM,KAAA,GAAQ,kBAAkB,GAAG,CAAA;AAEnC,IAAA,IAAI,UAAU,MAAA,EAAW;AAEvB,MAAA,OAAO,OAAO,GAAG,CAAA;AAAA,IACnB,CAAA,MAAO;AAEL,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,KAAA;AAAA,IAChB;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;;;ACzLO,SAAS,6BAAA,CACd,MAAA,GAAiC,EAAC,EACnB;AAEf,EAAA,IAAI,CAAC,mBAAA,CAAoB,MAAM,CAAA,EAAG;AAChC,IAAA,IAAI,UAAA;AAGJ,IAAA,IAAI,WAAW,IAAA,EAAM;AACnB,MAAA,UAAA,GAAa,MAAA;AAAA,IACf,CAAA,MAAA,IAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAChC,MAAA,UAAA,GAAa,0BAAA;AAAA,IACf,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,OAAO,MAAA;AAAA,IACtB;AAEA,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,kJAC8E,UAAU,CAAA,CAAA;AAAA,KAC1F;AAAA,EACF;AAGA,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,MAAA,CAAO,WAAW,CAAA,EAAG;AAChD,IAAA,OAAO,OAAO,EAAC,CAAA;AAAA,EACjB;AAEA,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA,EAAG;AAC9D,IAAA,OAAO,OAAO,EAAC,CAAA;AAAA,EACjB;AAEA,EAAA,OAAO,CAAC,MAAA,KAAmB;AAEzB,IAAA,IAAI,iBAAiB,MAAA,EAAQ;AAC3B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,iLAAA;AAAA,OAEF;AAAA,IACF;AAGA,IAAC,MAAA,CAA8C,aAAa,CAAA,GAAI,IAAA;AAGhE,IAAA,IAAI,gBAAA;AAEJ,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,MAAA,MAAM,UAAkB,EAAC;AAEzB,MAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,QAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,MAAA;AAAA,MACnB;AAEA,MAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,OAAO,CAAA;AAAA,IAC1C,CAAA,MAAO;AACL,MAAA,gBAAA,GAAmB,MAAA,CAAO,MAAA,CAAO,EAAE,GAAG,QAAQ,CAAA;AAAA,IAChD;AAGA,IAAA,MAAM,gBAAgB,IAAI,GAAA;AAAA,MACxB,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,CAAC,GAAG,MAAM,CAAA,GAAI,MAAA,CAAO,IAAA,CAAK,MAAM;AAAA,KAC1D;AAEA,IAAA,MAAM,GAAA,GAAMA,kBAAa,MAAM,CAAA;AAG/B,IAAA,MAAM,iBAAA,GAAoB,MAAA,CAAO,SAAA,CAAU,IAAA,CAAK,MAAM,CAAA;AACtD,IAAA,MAAM,oBAAA,GAAuB,IAAI,eAAA,EAAgB;AACjD,IAAA,MAAM,gBAAA,GAAmB,IAAI,WAAA,EAAY;AAGzC,IAAA,IAAI;AACF,MAAA,MAAM,EAAE,QAAA,EAAU,WAAA,EAAY,GAAI,iBAAiB,gBAAgB,CAAA;AACnE,MAAA,MAAM,iBAAiB,gBAAA,CAAiB,WAAA,EAAa,CAAC,GAAG,aAAa,CAAC,CAAA;AAEvE,MAAA,GAAA,CAAI,WAAA,CAAY,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,cAAc,CAAA,CAAE,CAAA;AAAA,IACjD,SAA8F,KAAA,EAAO;AACnG,MAAA,OAAQ,OAA8C,aAAa,CAAA;AAEnE,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,uEAAuE,KAAA,YAAiB,KAAA,GAAQ,MAAM,OAAA,GAAU,MAAA,CAAO,KAAK,CAAC,CAAA,CAAA;AAAA,QAC7H,EAAE,OAAO,KAAA;AAAM,OACjB;AAAA,IACF;AAWA,IAAA,SAAS,qBAAqB,gBAAA,EAAkC;AAE9D,MAAA,MAAM,UAAA,GAAa,iBAAiB,gBAAgB,CAAA;AAGpD,MAAA,MAAM,iBAA2B,EAAC;AAElC,MAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,UAAU,CAAA,EAAG;AACzC,QAAA,MAAM,KAAA,GAAQ,WAAW,GAAG,CAAA;AAG5B,QAAA,IAAI,KAAA,KAAU,MAAA,IAAa,aAAA,CAAc,GAAA,CAAI,GAAG,CAAA,EAAG;AACjD,UAAA,cAAA,CAAe,KAAK,GAAG,CAAA;AAAA,QACzB,CAAA,MAAO;AAEL,UAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAAA,QAC/B;AAAA,MACF;AAGA,MAAA,IAAI,cAAA,CAAe,SAAS,CAAA,EAAG;AAE7B,QAAA,KAAA,MAAW,OAAO,cAAA,EAAgB;AAChC,UAAA,aAAA,CAAc,OAAO,GAAG,CAAA;AAAA,QAC1B;AAGA,QAAA,MAAM,SAAA,GAAoB,EAAE,GAAG,gBAAA,EAAiB;AAEhD,QAAA,KAAA,MAAW,OAAO,cAAA,EAAgB;AAChC,UAAA,OAAO,UAAU,GAAG,CAAA;AAAA,QACtB;AAEA,QAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,SAAS,CAAA;AAAA,MAC5C;AAGA,MAAA,OAAO,WAAA,CAAY,kBAAkB,UAAU,CAAA;AAAA,IACjD;AAIA,IAAA,MAAA,CAAO,SAAA,GAAY,CAAC,SAAA,EAAW,eAAA,GAAkB,OAC/C,iBAAA,CAAkB,SAAA,EAAW,oBAAA,CAAqB,eAAe,CAAC,CAAA;AAEpE,IAAA,GAAA,CAAI,eAAA;AAAA,MACF,CAA4B,WAAmB,WAAA,KAAmB;AAChE,QAAA,MAAM,MAAA,GAAS,oBAAA,CAAqB,SAAA,EAAW,WAAW,CAAA;AAE1D,QAAA,OAAO;AAAA,UACL,GAAG,MAAA;AAAA,UACH,MAAA,EAAQ,oBAAA,CAAqB,MAAA,CAAO,MAAM;AAAA,SAC5C;AAAA,MACF;AAAA,KACF;AAEA,IAAA,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOL,oBAAoB,OAAA,EAAS;AAC3B,QAAA,IAAI;AAEF,UAAA,MAAM,UAAkB,EAAC;AACzB,UAAA,MAAM,WAAqB,EAAC;AAC5B,UAAA,IAAI,UAAA,GAAa,KAAA;AAEjB,UAAA,KAAA,MAAW,OAAO,aAAA,EAAe;AAC/B,YAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,MAAA,CAAO,GAAG,CAAA;AAGhC,YAAA,IAAI,CAAC,OAAO,MAAA,CAAO,OAAA,CAAQ,QAAQ,GAAG,CAAA,IAAK,UAAU,KAAA,CAAA,EAAW;AAE9D,cAAA,IACE,MAAA,CAAO,OAAO,gBAAA,EAAkB,GAAG,KACnC,gBAAA,CAAiB,GAAG,MAAM,KAAA,CAAA,EAC1B;AACA,gBAAA,QAAA,CAAS,KAAK,GAAG,CAAA;AACjB,gBAAA,UAAA,GAAa,IAAA;AAAA,cACf;AAEA,cAAA;AAAA,YACF;AAGA,YAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAG7B,YAAA,IAAI,gBAAA,CAAiB,GAAG,CAAA,KAAM,KAAA,EAAO;AACnC,cAAA,OAAA,CAAQ,GAAG,CAAA,GAAI,KAAA;AACf,cAAA,UAAA,GAAa,IAAA;AAAA,YACf;AAAA,UACF;AAGA,UAAA,IAAI,UAAA,EAAY;AACd,YAAA,MAAM,SAAA,GAAoB,EAAE,GAAG,gBAAA,EAAkB,GAAG,OAAA,EAAQ;AAG5D,YAAA,KAAA,MAAW,OAAO,QAAA,EAAU;AAC1B,cAAA,OAAO,UAAU,GAAG,CAAA;AAAA,YACtB;AAEA,YAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,SAAS,CAAA;AAAA,UAC5C;AAAA,QACF,SAAS,KAAA,EAAO;AAGd,UAAA,OAAA,CAAQ,KAAA;AAAA,YACN,0BAAA;AAAA,YACA,mCAAA;AAAA,YACA;AAAA,WACF;AAAA,QACF;AAAA,MACF,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,QAAA,GAAW;AACT,QAAA,IAAI;AACF,UAAA,MAAA,CAAO,SAAA,GAAY,iBAAA;AACnB,UAAA,GAAA,CAAI,gBAAgB,oBAAoB,CAAA;AACxC,UAAA,GAAA,CAAI,YAAY,gBAAgB,CAAA;AAEhC,UAAA,OAAQ,OAA8C,aAAa,CAAA;AAAA,QACrE,SAA0F,KAAA,EAAO;AAC/F,UAAA,OAAA,CAAQ,KAAA;AAAA,YACN,0BAAA;AAAA,YACA,wBAAA;AAAA,YACA;AAAA,WACF;AAAA,QACF;AAAA,MACF;AAAA,KACF;AAAA,EACF,CAAA;AACF","file":"index.js","sourcesContent":["// packages/persistent-params-plugin/modules/constants.ts\n\n/**\n * Symbol to mark router as initialized with this plugin.\n * Prevents double initialization and memory leaks from method wrapping.\n */\nexport const PLUGIN_MARKER = Symbol(\"persistent-params-plugin\");\n","// packages/persistent-params-plugin/modules/utils.ts\n\nimport { isPrimitiveValue } from \"type-guards\";\n\nimport type { PersistentParamsConfig } from \"./types\";\nimport type { Params } from \"@real-router/core\";\n\nconst INVALID_PARAM_KEY_REGEX = /[\\s#%&/=?\\\\]/;\nconst INVALID_CHARS_MESSAGE = String.raw`Cannot contain: = & ? # % / \\ or whitespace`;\n\nexport function validateParamKey(key: string): void {\n if (INVALID_PARAM_KEY_REGEX.test(key)) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid parameter name \"${key}\". ${INVALID_CHARS_MESSAGE}`,\n );\n }\n}\n\n/**\n * Validates params configuration structure and values.\n * Ensures all parameter names are non-empty strings and all default values are primitives.\n *\n * @param config - Configuration to validate\n * @returns true if configuration is valid\n */\n/**\n * Validates params configuration structure and values.\n * Ensures all parameter names are non-empty strings and all default values are primitives.\n *\n * @param config - Configuration to validate\n * @returns true if configuration is valid\n */\nexport function isValidParamsConfig(\n config: unknown,\n): config is PersistentParamsConfig {\n if (config === null || config === undefined) {\n return false;\n }\n\n // Array configuration: all items must be non-empty strings\n if (Array.isArray(config)) {\n return config.every((item) => {\n if (typeof item !== \"string\" || item.length === 0) {\n return false;\n }\n\n try {\n validateParamKey(item);\n\n return true;\n } catch {\n return false;\n }\n });\n }\n\n // Object configuration: must be plain object with primitive values\n if (typeof config === \"object\") {\n // Reject non-plain objects (Date, Map, etc.)\n if (Object.getPrototypeOf(config) !== Object.prototype) {\n return false;\n }\n\n // All keys must be non-empty strings, all values must be primitives\n return Object.entries(config).every(([key, value]) => {\n // Check key is non-empty string\n if (typeof key !== \"string\" || key.length === 0) {\n return false;\n }\n\n // Validate key doesn't contain special characters\n try {\n validateParamKey(key);\n } catch {\n return false;\n }\n\n // Validate value is primitive (NaN/Infinity already rejected by isPrimitiveValue)\n return isPrimitiveValue(value);\n });\n }\n\n return false;\n}\n\n/**\n * Validates parameter value before persisting.\n * Throws descriptive TypeError if value is not valid for URL parameters.\n *\n * @param key - Parameter name for error messages\n * @param value - Value to validate\n * @throws {TypeError} If value is null, array, object, or other non-primitive type\n */\nexport function validateParamValue(key: string, value: unknown): void {\n if (value === null) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" cannot be null. ` +\n `Use undefined to remove the parameter from persistence.`,\n );\n }\n\n if (value !== undefined && !isPrimitiveValue(value)) {\n const actualType = Array.isArray(value) ? \"array\" : typeof value;\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" must be a primitive value ` +\n `(string, number, or boolean), got ${actualType}. ` +\n `Objects and arrays are not supported in URL parameters.`,\n );\n }\n}\n\n/**\n * Safely extracts own properties from params object.\n * Uses Object.hasOwn to prevent prototype pollution attacks.\n *\n * @param params - Parameters object (may contain inherited properties)\n * @returns New object with only own properties\n *\n * @example\n * const malicious = Object.create({ __proto__: { admin: true } });\n * malicious.mode = 'dev';\n * const safe = extractOwnParams(malicious); // { mode: 'dev' } (no __proto__)\n */\nexport function extractOwnParams(params: Params): Params {\n const result: Params = {};\n\n for (const key in params) {\n // Only process own properties, skip inherited ones\n if (Object.hasOwn(params, key)) {\n result[key] = params[key];\n }\n }\n\n return result;\n}\n\n/**\n * Parses path into base path and query string components.\n * Handles edge cases like leading ?, multiple ?, empty path.\n *\n * @param path - Path to parse (e.g., \"/route?param=value\")\n * @returns Object with basePath and queryString\n *\n * @example\n * parseQueryString('/users?page=1') // { basePath: '/users', queryString: 'page=1' }\n * parseQueryString('?existing') // { basePath: '', queryString: 'existing' }\n * parseQueryString('/path') // { basePath: '/path', queryString: '' }\n */\nexport function parseQueryString(path: string): {\n basePath: string;\n queryString: string;\n} {\n const questionMarkIndex = path.indexOf(\"?\");\n\n // No query string\n if (questionMarkIndex === -1) {\n return { basePath: path, queryString: \"\" };\n }\n\n // Path starts with ? (edge case)\n if (questionMarkIndex === 0) {\n return { basePath: \"\", queryString: path.slice(1) };\n }\n\n // Normal case: path?query\n return {\n basePath: path.slice(0, questionMarkIndex),\n queryString: path.slice(questionMarkIndex + 1),\n };\n}\n\n/**\n * Builds query string from parameter names.\n * Preserves existing query parameters and appends new ones.\n *\n * @param existingQuery - Existing query string (without leading ?)\n * @param paramNames - Parameter names to append\n * @returns Combined query string\n *\n * @example\n * buildQueryString('existing=1', ['mode', 'lang']) // 'existing=1&mode&lang'\n * buildQueryString('', ['mode']) // 'mode'\n */\nexport function buildQueryString(\n existingQuery: string,\n paramNames: readonly string[],\n): string {\n if (paramNames.length === 0) {\n return existingQuery;\n }\n\n const separator = existingQuery ? \"&\" : \"\";\n\n return existingQuery + separator + paramNames.join(\"&\");\n}\n\n/**\n * Merges persistent and current parameters into a single Params object.\n * Keys explicitly set to `undefined` in current params are removed from result.\n *\n * Creates a new immutable object - does not mutate input parameters.\n *\n * @param persistent - Frozen persistent parameters\n * @param current - Current parameters from navigation\n * @returns New Params object with merged values\n *\n * @example\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: 'light', mode: 'dev' };\n * mergeParams(persistent, current); // { lang: 'en', theme: 'light', mode: 'dev' }\n *\n * @example\n * // Removing parameters with undefined\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: undefined };\n * mergeParams(persistent, current); // { lang: 'en' } (theme removed)\n */\nexport function mergeParams(\n persistent: Readonly<Params>,\n current: Params,\n): Params {\n // Safely extract own properties from current params\n const safeCurrentParams = extractOwnParams(current);\n\n // Start with persistent params, but EXCLUDE undefined values\n // (undefined values don't appear in URLs, so we shouldn't include them)\n const result: Params = {};\n\n for (const key in persistent) {\n if (Object.hasOwn(persistent, key) && persistent[key] !== undefined) {\n result[key] = persistent[key];\n }\n }\n\n // Apply current params\n for (const key of Object.keys(safeCurrentParams)) {\n const value = safeCurrentParams[key];\n\n if (value === undefined) {\n // Remove param if explicitly set to undefined\n delete result[key];\n } else {\n // Add or update param\n result[key] = value;\n }\n }\n\n return result;\n}\n","// packages/persistent-params-plugin/modules/plugin.ts\n\nimport { getPluginApi } from \"@real-router/core\";\n\nimport { PLUGIN_MARKER } from \"./constants\";\nimport {\n buildQueryString,\n extractOwnParams,\n isValidParamsConfig,\n mergeParams,\n parseQueryString,\n validateParamValue,\n} from \"./utils\";\n\nimport type { PersistentParamsConfig } from \"./types\";\nimport type { Params, PluginFactory, Plugin } from \"@real-router/core\";\n\n/**\n * Factory for the persistent parameters' plugin.\n *\n * This plugin allows you to specify certain route parameters to be persisted across\n * all navigation transitions. Persisted parameters are automatically merged into\n * route parameters when building paths or states.\n *\n * Key features:\n * - Automatic persistence of query parameters across navigations\n * - Support for default values\n * - Type-safe (only primitives: string, number, boolean)\n * - Immutable internal state\n * - Protection against prototype pollution\n * - Full teardown support (can be safely unsubscribed)\n *\n * If a persisted parameter is explicitly set to `undefined` during navigation,\n * it will be removed from the persisted state and omitted from subsequent URLs.\n *\n * The plugin also adjusts the router's root path to include query parameters for\n * all persistent params, ensuring correct URL construction.\n *\n * @param params - Either an array of parameter names (strings) to persist,\n * or an object mapping parameter names to initial values.\n * If an array, initial values will be `undefined`.\n *\n * @returns A PluginFactory that creates the persistent params plugin instance.\n *\n * @example\n * // Persist parameters without default values\n * router.usePlugin(persistentParamsPlugin(['mode', 'lang']));\n *\n * @example\n * // Persist parameters with default values\n * router.usePlugin(persistentParamsPlugin({ mode: 'dev', lang: 'en' }));\n *\n * @example\n * // Removing a persisted parameter\n * router.navigate('route', { mode: undefined }); // mode will be removed\n *\n * @example\n * // Unsubscribing (full cleanup)\n * const unsubscribe = router.usePlugin(persistentParamsPlugin(['mode']));\n * unsubscribe(); // Restores original router state\n *\n * @throws {TypeError} If params is not a valid array of strings or object with primitives\n * @throws {Error} If plugin is already initialized on this router instance\n */\nexport function persistentParamsPluginFactory(\n params: PersistentParamsConfig = {},\n): PluginFactory {\n // Validate input configuration\n if (!isValidParamsConfig(params)) {\n let actualType: string;\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (params === null) {\n actualType = \"null\";\n } else if (Array.isArray(params)) {\n actualType = \"array with invalid items\";\n } else {\n actualType = typeof params;\n }\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid params configuration. ` +\n `Expected array of non-empty strings or object with primitive values, got ${actualType}.`,\n );\n }\n\n // Empty configuration - valid but does nothing\n if (Array.isArray(params) && params.length === 0) {\n return () => ({});\n }\n\n if (!Array.isArray(params) && Object.keys(params).length === 0) {\n return () => ({});\n }\n\n return (router): Plugin => {\n // Check if plugin is already initialized on this router\n if (PLUGIN_MARKER in router) {\n throw new Error(\n `[@real-router/persistent-params-plugin] Plugin already initialized on this router. ` +\n `To reconfigure, first unsubscribe the existing plugin using the returned unsubscribe function.`,\n );\n }\n\n // Mark router as initialized\n (router as unknown as Record<symbol, boolean>)[PLUGIN_MARKER] = true;\n\n // Initialize frozen persistent parameters\n let persistentParams: Readonly<Params>;\n\n if (Array.isArray(params)) {\n const initial: Params = {};\n\n for (const param of params) {\n initial[param] = undefined;\n }\n\n persistentParams = Object.freeze(initial);\n } else {\n persistentParams = Object.freeze({ ...params });\n }\n\n // Track parameter names\n const paramNamesSet = new Set<string>(\n Array.isArray(params) ? [...params] : Object.keys(params),\n );\n\n const api = getPluginApi(router);\n\n // Store original router methods for restoration\n const originalBuildPath = router.buildPath.bind(router);\n const originalForwardState = api.getForwardState();\n const originalRootPath = api.getRootPath();\n\n // Update router root path to include query parameters for persistent params\n try {\n const { basePath, queryString } = parseQueryString(originalRootPath);\n const newQueryString = buildQueryString(queryString, [...paramNamesSet]);\n\n api.setRootPath(`${basePath}?${newQueryString}`);\n } /* v8 ignore start -- @preserve: defensive error wrapping for setRootPath failure */ catch (error) {\n delete (router as unknown as Record<symbol, boolean>)[PLUGIN_MARKER];\n\n throw new Error(\n `[@real-router/persistent-params-plugin] Failed to update root path: ${error instanceof Error ? error.message : String(error)}`,\n { cause: error },\n );\n } /* v8 ignore stop */\n\n /**\n * Merges persistent parameters with current navigation parameters.\n * Validates all parameter values before merging.\n *\n * @param additionalParams - Parameters passed during navigation\n * @returns Merged parameters object\n * @throws {TypeError} If any parameter value is invalid (not a primitive)\n */\n\n function withPersistentParams(additionalParams: Params): Params {\n // Extract safe params (prevent prototype pollution)\n const safeParams = extractOwnParams(additionalParams);\n\n // Validate and collect parameters to remove in a single pass\n const paramsToRemove: string[] = [];\n\n for (const key of Object.keys(safeParams)) {\n const value = safeParams[key];\n\n // If undefined and tracked, mark for removal (skip validation)\n if (value === undefined && paramNamesSet.has(key)) {\n paramsToRemove.push(key);\n } else {\n // Validate all other parameters\n validateParamValue(key, value);\n }\n }\n\n // Process all removals in one batch\n if (paramsToRemove.length > 0) {\n // Remove from both Set\n for (const key of paramsToRemove) {\n paramNamesSet.delete(key);\n }\n\n // Update persistentParams once (batch freeze)\n const newParams: Params = { ...persistentParams };\n\n for (const key of paramsToRemove) {\n delete newParams[key];\n }\n\n persistentParams = Object.freeze(newParams);\n }\n\n // Merge persistent and current params\n return mergeParams(persistentParams, safeParams);\n }\n\n // Override router methods to inject persistent params\n // buildPath: needed for direct buildPath() calls (doesn't go through forwardState)\n router.buildPath = (routeName, buildPathParams = {}) =>\n originalBuildPath(routeName, withPersistentParams(buildPathParams));\n\n api.setForwardState(\n <P extends Params = Params>(routeName: string, routeParams: P) => {\n const result = originalForwardState(routeName, routeParams);\n\n return {\n ...result,\n params: withPersistentParams(result.params) as P,\n };\n },\n );\n\n return {\n /**\n * Updates persistent parameters after successful transition.\n * Only processes parameters that are tracked and have changed.\n *\n * @param toState - Target state after successful transition\n */\n onTransitionSuccess(toState) {\n try {\n // Collect changed parameters and removals\n const updates: Params = {};\n const removals: string[] = [];\n let hasChanges = false;\n\n for (const key of paramNamesSet) {\n const value = toState.params[key];\n\n // If parameter is not in state params or is undefined, mark for removal\n if (!Object.hasOwn(toState.params, key) || value === undefined) {\n /* v8 ignore next 6 -- @preserve: defensive removal for states committed via navigateToState bypassing forwardState */\n if (\n Object.hasOwn(persistentParams, key) &&\n persistentParams[key] !== undefined\n ) {\n removals.push(key);\n hasChanges = true;\n }\n\n continue;\n }\n\n // Validate type before storing\n validateParamValue(key, value);\n\n // Only update if value actually changed\n if (persistentParams[key] !== value) {\n updates[key] = value;\n hasChanges = true;\n }\n }\n\n // Create new frozen object only if there were changes\n if (hasChanges) {\n const newParams: Params = { ...persistentParams, ...updates };\n\n /* v8 ignore next 3 -- @preserve: removals only populated by defensive navigateToState path above */\n for (const key of removals) {\n delete newParams[key];\n }\n\n persistentParams = Object.freeze(newParams);\n }\n } catch (error) {\n // Log error but don't break navigation\n /* v8 ignore next 5 -- @preserve defensive: validation happens before navigate() */\n console.error(\n \"persistent-params-plugin\",\n \"Error updating persistent params:\",\n error,\n );\n }\n },\n\n /**\n * Cleanup function to restore original router state.\n * Restores all overridden methods and paths.\n * Called when plugin is unsubscribed.\n */\n teardown() {\n try {\n router.buildPath = originalBuildPath;\n api.setForwardState(originalForwardState);\n api.setRootPath(originalRootPath);\n\n delete (router as unknown as Record<symbol, boolean>)[PLUGIN_MARKER];\n } /* v8 ignore start -- @preserve: defensive error logging for teardown failure */ catch (error) {\n console.error(\n \"persistent-params-plugin\",\n \"Error during teardown:\",\n error,\n );\n } /* v8 ignore stop */\n },\n };\n };\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../../src/param-utils.ts","../../src/validation.ts","../../src/plugin.ts","../../src/factory.ts"],"names":["getPluginApi"],"mappings":";;;AAgBO,SAAS,iBAAiB,MAAA,EAAwB;AACvD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,MAAA,EAAQ;AAExB,IAAA,IAAI,MAAA,CAAO,MAAA,CAAO,MAAA,EAAQ,GAAG,CAAA,EAAG;AAC9B,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,MAAA,CAAO,GAAG,CAAA;AAAA,IAC1B;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AAuBO,SAAS,WAAA,CACd,YACA,OAAA,EACQ;AAER,EAAA,MAAM,iBAAA,GAAoB,iBAAiB,OAAO,CAAA;AAIlD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,IAAI,MAAA,CAAO,OAAO,UAAA,EAAY,GAAG,KAAK,UAAA,CAAW,GAAG,MAAM,MAAA,EAAW;AACnE,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,UAAA,CAAW,GAAG,CAAA;AAAA,IAC9B;AAAA,EACF;AAGA,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,iBAAiB,CAAA,EAAG;AAChD,IAAA,MAAM,KAAA,GAAQ,kBAAkB,GAAG,CAAA;AAEnC,IAAA,IAAI,UAAU,MAAA,EAAW;AAEvB,MAAA,OAAO,OAAO,GAAG,CAAA;AAAA,IACnB,CAAA,MAAO;AAEL,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,KAAA;AAAA,IAChB;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;;;;;;;;AC3EA,IAAM,uBAAA,GAA0B,cAAA;AAChC,IAAM,wBAAwB,MAAA,CAAO,GAAA,CAAA,2CAAA,CAAA;AAE9B,SAAS,iBAAiB,GAAA,EAAmB;AAClD,EAAA,IAAI,uBAAA,CAAwB,IAAA,CAAK,GAAG,CAAA,EAAG;AACrC,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,gEAAA,EAAmE,GAAG,CAAA,GAAA,EAAM,qBAAqB,CAAA;AAAA,KACnG;AAAA,EACF;AACF;AASO,SAAS,oBACd,MAAA,EACkC;AAClC,EAAA,IAAI,MAAA,KAAW,IAAA,IAAQ,MAAA,KAAW,MAAA,EAAW;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AAGA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,IAAA,OAAO,MAAA,CAAO,KAAA,CAAM,CAAC,IAAA,KAAS;AAC5B,MAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,CAAK,WAAW,CAAA,EAAG;AACjD,QAAA,OAAO,KAAA;AAAA,MACT;AAEA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,IAAI,CAAA;AAErB,QAAA,OAAO,IAAA;AAAA,MACT,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAGA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAE9B,IAAA,IAAI,MAAA,CAAO,cAAA,CAAe,MAAM,CAAA,KAAM,OAAO,SAAA,EAAW;AACtD,MAAA,OAAO,KAAA;AAAA,IACT;AAGA,IAAA,OAAO,MAAA,CAAO,QAAQ,MAAM,CAAA,CAAE,MAAM,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAEpD,MAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,WAAW,CAAA,EAAG;AAC/C,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,GAAG,CAAA;AAAA,MACtB,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,OAAO,EAAiB,KAAK,CAAA;AAAA,IAC/B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,KAAA;AACT;AAUO,SAAS,kBAAA,CAAmB,KAAa,KAAA,EAAsB;AACpE,EAAA,IAAI,UAAU,IAAA,EAAM;AAClB,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,sDAAsD,GAAG,CAAA,yEAAA;AAAA,KAE3D;AAAA,EACF;AAEA,EAAA,IAAI,KAAA,KAAU,MAAA,IAAa,CAAC,CAAA,CAAiB,KAAK,CAAA,EAAG;AACnD,IAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,UAAU,OAAO,KAAA;AAE3D,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,mDAAA,EAAsD,GAAG,CAAA,8DAAA,EAClB,UAAU,CAAA,yDAAA;AAAA,KAEnD;AAAA,EACF;AACF;AAQO,SAAS,eAAe,MAAA,EAAuB;AACpD,EAAA,IAAI,CAAC,mBAAA,CAAoB,MAAM,CAAA,EAAG;AAChC,IAAA,IAAI,UAAA;AAEJ,IAAA,IAAI,WAAW,IAAA,EAAM;AACnB,MAAA,UAAA,GAAa,MAAA;AAAA,IACf,CAAA,MAAA,IAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAChC,MAAA,UAAA,GAAa,0BAAA;AAAA,IACf,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,OAAO,MAAA;AAAA,IACtB;AAEA,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,kJAC8E,UAAU,CAAA,CAAA;AAAA,KAC1F;AAAA,EACF;AACF;;;ACxHO,IAAM,yBAAN,MAA6B;AAAA,EACzB,IAAA;AAAA,EACA,cAAA;AAAA,EACA,iBAAA;AAAA,EAET,iBAAA;AAAA,EACA,2BAAA;AAAA,EACA,8BAAA;AAAA,EAEA,WAAA,CACE,GAAA,EACA,gBAAA,EACA,aAAA,EACA,gBAAA,EACA;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,GAAA;AACZ,IAAA,IAAA,CAAK,iBAAA,GAAoB,gBAAA;AACzB,IAAA,IAAA,CAAK,cAAA,GAAiB,aAAA;AACtB,IAAA,IAAA,CAAK,iBAAA,GAAoB,gBAAA;AAAA,EAC3B;AAAA,EAEA,SAAA,GAAoB;AAClB,IAAA,IAAI;AACF,MAAA,MAAM,cAAc,CAAC,GAAG,KAAK,cAAc,CAAA,CAAE,KAAK,GAAG,CAAA;AAErD,MAAA,IAAA,CAAK,KAAK,WAAA,CAAY,CAAA,EAAG,KAAK,iBAAiB,CAAA,CAAA,EAAI,WAAW,CAAA,CAAE,CAAA;AAAA,IAClE,SAA8F,KAAA,EAAO;AACnG,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,uEAAuE,KAAA,YAAiB,KAAA,GAAQ,MAAM,OAAA,GAAU,MAAA,CAAO,KAAK,CAAC,CAAA,CAAA;AAAA,QAC7H,EAAE,OAAO,KAAA;AAAM,OACjB;AAAA,IACF;AAEA,IAAA,IAAA,CAAK,2BAAA,GAA8B,KAAK,IAAA,CAAK,cAAA;AAAA,MAC3C,WAAA;AAAA,MACA,CAAC,IAAA,EAAM,KAAA,EAAO,SAAA,KACZ,IAAA,CAAK,KAAA,EAAO,IAAA,CAAK,qBAAA,CAAsB,SAAA,IAAa,EAAE,CAAC;AAAA,KAC3D;AAEA,IAAA,IAAA,CAAK,8BAAA,GAAiC,KAAK,IAAA,CAAK,cAAA;AAAA,MAC9C,cAAA;AAAA,MACA,CAAC,IAAA,EAAM,SAAA,EAAW,WAAA,KAAgB;AAChC,QAAA,MAAM,MAAA,GAAS,IAAA,CAAK,SAAA,EAAW,WAAW,CAAA;AAE1C,QAAA,OAAO;AAAA,UACL,GAAG,MAAA;AAAA,UACH,MAAA,EAAQ,IAAA,CAAK,qBAAA,CAAsB,MAAA,CAAO,MAAM;AAAA,SAClD;AAAA,MACF;AAAA,KACF;AAEA,IAAA,OAAO;AAAA,MACL,mBAAA,EAAqB,CAAC,OAAA,KAAY;AAChC,QAAA,IAAA,CAAK,qBAAqB,OAAO,CAAA;AAAA,MACnC,CAAA;AAAA,MACA,UAAU,MAAM;AACd,QAAA,IAAA,CAAK,SAAA,EAAU;AAAA,MACjB;AAAA,KACF;AAAA,EACF;AAAA,EAEA,sBAAsB,gBAAA,EAAkC;AACtD,IAAA,MAAM,UAAA,GAAa,iBAAiB,gBAAgB,CAAA;AACpD,IAAA,IAAI,SAAA;AAEJ,IAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,UAAU,CAAA,EAAG;AACzC,MAAA,MAAM,KAAA,GAAQ,WAAW,GAAG,CAAA;AAE5B,MAAA,IAAI,UAAU,MAAA,IAAa,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,GAAG,CAAA,EAAG;AACvD,QAAA,IAAA,CAAK,cAAA,CAAe,OAAO,GAAG,CAAA;AAC9B,QAAA,SAAA,KAAc,EAAE,GAAG,IAAA,CAAK,iBAAA,EAAkB;AAC1C,QAAA,OAAO,UAAU,GAAG,CAAA;AAAA,MACtB,CAAA,MAAO;AACL,QAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAAA,MAC/B;AAAA,IACF;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA,CAAO,MAAA,CAAO,SAAS,CAAA;AAAA,IAClD;AAEA,IAAA,OAAO,WAAA,CAAY,IAAA,CAAK,iBAAA,EAAmB,UAAU,CAAA;AAAA,EACvD;AAAA,EAEA,qBAAqB,OAAA,EAAsB;AACzC,IAAA,IAAI,SAAA;AAEJ,IAAA,KAAA,MAAW,GAAA,IAAO,KAAK,cAAA,EAAgB;AACrC,MAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,MAAA,CAAO,GAAG,CAAA;AAEhC,MAAA,IAAI,CAAC,OAAO,MAAA,CAAO,OAAA,CAAQ,QAAQ,GAAG,CAAA,IAAK,UAAU,MAAA,EAAW;AAE9D,QAAA,IACE,MAAA,CAAO,MAAA,CAAO,IAAA,CAAK,iBAAA,EAAmB,GAAG,KACzC,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA,KAAM,MAAA,EAChC;AACA,UAAA,SAAA,KAAc,EAAE,GAAG,IAAA,CAAK,iBAAA,EAAkB;AAC1C,UAAA,OAAO,UAAU,GAAG,CAAA;AAAA,QACtB;AAEA,QAAA;AAAA,MACF;AAEA,MAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAE7B,MAAA,IAAI,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA,KAAM,KAAA,EAAO;AACzC,QAAA,SAAA,KAAc,EAAE,GAAG,IAAA,CAAK,iBAAA,EAAkB;AAC1C,QAAA,SAAA,CAAU,GAAG,CAAA,GAAI,KAAA;AAAA,MACnB;AAAA,IACF;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA,CAAO,MAAA,CAAO,SAAS,CAAA;AAAA,IAClD;AAAA,EACF;AAAA,EAEA,SAAA,GAAkB;AAChB,IAAA,IAAI;AACF,MAAA,IAAA,CAAK,2BAAA,IAA8B;AACnC,MAAA,IAAA,CAAK,8BAAA,IAAiC;AACtC,MAAA,IAAA,CAAK,IAAA,CAAK,WAAA,CAAY,IAAA,CAAK,iBAAiB,CAAA;AAAA,IAC9C,SAA0F,KAAA,EAAO;AAC/F,MAAA,OAAA,CAAQ,KAAA;AAAA,QACN,0BAAA;AAAA,QACA,wBAAA;AAAA,QACA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AACF,CAAA;;;AC9HA,IAAM,IAAA,GAAO,OAAO,EAAC,CAAA;AAiDd,SAAS,6BAAA,CACd,MAAA,GAAiC,EAAC,EACnB;AACf,EAAA,cAAA,CAAe,MAAM,CAAA;AAGrB,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,MAAA,CAAO,WAAW,CAAA,EAAG;AAChD,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA,EAAG;AAC9D,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,OAAO,CAAC,MAAA,KAAmB;AAEzB,IAAA,IAAI,gBAAA;AAEJ,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,MAAA,MAAM,UAAkB,EAAC;AAEzB,MAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,QAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,MAAA;AAAA,MACnB;AAEA,MAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,OAAO,CAAA;AAAA,IAC1C,CAAA,MAAO;AACL,MAAA,gBAAA,GAAmB,MAAA,CAAO,MAAA,CAAO,EAAE,GAAG,QAAQ,CAAA;AAAA,IAChD;AAEA,IAAA,MAAM,gBAAgB,IAAI,GAAA;AAAA,MACxB,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,CAAC,GAAG,MAAM,CAAA,GAAI,MAAA,CAAO,IAAA,CAAK,MAAM;AAAA,KAC1D;AAEA,IAAA,MAAM,GAAA,GAAMA,kBAAa,MAAM,CAAA;AAC/B,IAAA,MAAM,gBAAA,GAAmB,IAAI,WAAA,EAAY;AAEzC,IAAA,MAAM,SAAS,IAAI,sBAAA;AAAA,MACjB,GAAA;AAAA,MACA,gBAAA;AAAA,MACA,aAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,OAAO,OAAO,SAAA,EAAU;AAAA,EAC1B,CAAA;AACF","file":"index.js","sourcesContent":["// packages/persistent-params-plugin/modules/param-utils.ts\n\nimport type { Params } from \"@real-router/core\";\n\n/**\n * Safely extracts own properties from params object.\n * Uses Object.hasOwn to prevent prototype pollution attacks.\n *\n * @param params - Parameters object (may contain inherited properties)\n * @returns New object with only own properties\n *\n * @example\n * const malicious = Object.create({ __proto__: { admin: true } });\n * malicious.mode = 'dev';\n * const safe = extractOwnParams(malicious); // { mode: 'dev' } (no __proto__)\n */\nexport function extractOwnParams(params: Params): Params {\n const result: Params = {};\n\n for (const key in params) {\n /* v8 ignore next -- @preserve: core validates params prototype — inherited keys never reach here */\n if (Object.hasOwn(params, key)) {\n result[key] = params[key];\n }\n }\n\n return result;\n}\n\n/**\n * Merges persistent and current parameters into a single Params object.\n * Keys explicitly set to `undefined` in current params are removed from result.\n *\n * Creates a new immutable object - does not mutate input parameters.\n *\n * @param persistent - Frozen persistent parameters\n * @param current - Current parameters from navigation\n * @returns New Params object with merged values\n *\n * @example\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: 'light', mode: 'dev' };\n * mergeParams(persistent, current); // { lang: 'en', theme: 'light', mode: 'dev' }\n *\n * @example\n * // Removing parameters with undefined\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: undefined };\n * mergeParams(persistent, current); // { lang: 'en' } (theme removed)\n */\nexport function mergeParams(\n persistent: Readonly<Params>,\n current: Params,\n): Params {\n // Safely extract own properties from current params\n const safeCurrentParams = extractOwnParams(current);\n\n // Start with persistent params, but EXCLUDE undefined values\n // (undefined values don't appear in URLs, so we shouldn't include them)\n const result: Params = {};\n\n for (const key in persistent) {\n if (Object.hasOwn(persistent, key) && persistent[key] !== undefined) {\n result[key] = persistent[key];\n }\n }\n\n // Apply current params\n for (const key of Object.keys(safeCurrentParams)) {\n const value = safeCurrentParams[key];\n\n if (value === undefined) {\n // Remove param if explicitly set to undefined\n delete result[key];\n } else {\n // Add or update param\n result[key] = value;\n }\n }\n\n return result;\n}\n","// packages/persistent-params-plugin/src/validation.ts\n\nimport { isPrimitiveValue } from \"type-guards\";\n\nimport type { PersistentParamsConfig } from \"./types\";\n\nconst INVALID_PARAM_KEY_REGEX = /[\\s#%&/=?\\\\]/;\nconst INVALID_CHARS_MESSAGE = String.raw`Cannot contain: = & ? # % / \\ or whitespace`;\n\nexport function validateParamKey(key: string): void {\n if (INVALID_PARAM_KEY_REGEX.test(key)) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid parameter name \"${key}\". ${INVALID_CHARS_MESSAGE}`,\n );\n }\n}\n\n/**\n * Validates params configuration structure and values.\n * Ensures all parameter names are non-empty strings and all default values are primitives.\n *\n * @param config - Configuration to validate\n * @returns true if configuration is valid\n */\nexport function isValidParamsConfig(\n config: unknown,\n): config is PersistentParamsConfig {\n if (config === null || config === undefined) {\n return false;\n }\n\n // Array configuration: all items must be non-empty strings\n if (Array.isArray(config)) {\n return config.every((item) => {\n if (typeof item !== \"string\" || item.length === 0) {\n return false;\n }\n\n try {\n validateParamKey(item);\n\n return true;\n } catch {\n return false;\n }\n });\n }\n\n // Object configuration: must be plain object with primitive values\n if (typeof config === \"object\") {\n // Reject non-plain objects (Date, Map, etc.)\n if (Object.getPrototypeOf(config) !== Object.prototype) {\n return false;\n }\n\n // All keys must be non-empty strings, all values must be primitives\n return Object.entries(config).every(([key, value]) => {\n // Check key is non-empty string\n if (typeof key !== \"string\" || key.length === 0) {\n return false;\n }\n\n // Validate key doesn't contain special characters\n try {\n validateParamKey(key);\n } catch {\n return false;\n }\n\n // Validate value is primitive (NaN/Infinity already rejected by isPrimitiveValue)\n return isPrimitiveValue(value);\n });\n }\n\n return false;\n}\n\n/**\n * Validates parameter value before persisting.\n * Throws descriptive TypeError if value is not valid for URL parameters.\n *\n * @param key - Parameter name for error messages\n * @param value - Value to validate\n * @throws {TypeError} If value is null, array, object, or other non-primitive type\n */\nexport function validateParamValue(key: string, value: unknown): void {\n if (value === null) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" cannot be null. ` +\n `Use undefined to remove the parameter from persistence.`,\n );\n }\n\n if (value !== undefined && !isPrimitiveValue(value)) {\n const actualType = Array.isArray(value) ? \"array\" : typeof value;\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" must be a primitive value ` +\n `(string, number, or boolean), got ${actualType}. ` +\n `Objects and arrays are not supported in URL parameters.`,\n );\n }\n}\n\n/**\n * Validates the params configuration and throws a descriptive error if invalid.\n *\n * @param params - Configuration to validate\n * @throws {TypeError} If params is not a valid configuration\n */\nexport function validateConfig(params: unknown): void {\n if (!isValidParamsConfig(params)) {\n let actualType: string;\n\n if (params === null) {\n actualType = \"null\";\n } else if (Array.isArray(params)) {\n actualType = \"array with invalid items\";\n } else {\n actualType = typeof params;\n }\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid params configuration. ` +\n `Expected array of non-empty strings or object with primitive values, got ${actualType}.`,\n );\n }\n}\n","// packages/persistent-params-plugin/src/plugin.ts\n\nimport { extractOwnParams, mergeParams } from \"./param-utils\";\nimport { validateParamValue } from \"./validation\";\n\nimport type { Params, PluginApi, State, Plugin } from \"@real-router/core\";\n\nexport class PersistentParamsPlugin {\n readonly #api: PluginApi;\n readonly #paramNamesSet: Set<string>;\n readonly #originalRootPath: string;\n\n #persistentParams: Readonly<Params>;\n #removeBuildPathInterceptor: (() => void) | undefined;\n #removeForwardStateInterceptor: (() => void) | undefined;\n\n constructor(\n api: PluginApi,\n persistentParams: Readonly<Params>,\n paramNamesSet: Set<string>,\n originalRootPath: string,\n ) {\n this.#api = api;\n this.#persistentParams = persistentParams;\n this.#paramNamesSet = paramNamesSet;\n this.#originalRootPath = originalRootPath;\n }\n\n getPlugin(): Plugin {\n try {\n const queryString = [...this.#paramNamesSet].join(\"&\");\n\n this.#api.setRootPath(`${this.#originalRootPath}?${queryString}`);\n } /* v8 ignore start -- @preserve: defensive error wrapping for setRootPath failure */ catch (error) {\n throw new Error(\n `[@real-router/persistent-params-plugin] Failed to update root path: ${error instanceof Error ? error.message : String(error)}`,\n { cause: error },\n );\n } /* v8 ignore stop */\n\n this.#removeBuildPathInterceptor = this.#api.addInterceptor(\n \"buildPath\",\n (next, route, navParams) =>\n next(route, this.#withPersistentParams(navParams ?? {})),\n );\n\n this.#removeForwardStateInterceptor = this.#api.addInterceptor(\n \"forwardState\",\n (next, routeName, routeParams) => {\n const result = next(routeName, routeParams);\n\n return {\n ...result,\n params: this.#withPersistentParams(result.params),\n };\n },\n );\n\n return {\n onTransitionSuccess: (toState) => {\n this.#onTransitionSuccess(toState);\n },\n teardown: () => {\n this.#teardown();\n },\n };\n }\n\n #withPersistentParams(additionalParams: Params): Params {\n const safeParams = extractOwnParams(additionalParams);\n let newParams: Params | undefined;\n\n for (const key of Object.keys(safeParams)) {\n const value = safeParams[key];\n\n if (value === undefined && this.#paramNamesSet.has(key)) {\n this.#paramNamesSet.delete(key);\n newParams ??= { ...this.#persistentParams };\n delete newParams[key];\n } else {\n validateParamValue(key, value);\n }\n }\n\n if (newParams) {\n this.#persistentParams = Object.freeze(newParams);\n }\n\n return mergeParams(this.#persistentParams, safeParams);\n }\n\n #onTransitionSuccess(toState: State): void {\n let newParams: Params | undefined;\n\n for (const key of this.#paramNamesSet) {\n const value = toState.params[key];\n\n if (!Object.hasOwn(toState.params, key) || value === undefined) {\n /* v8 ignore next 4 -- @preserve: defensive removal for states committed via navigateToState bypassing forwardState */\n if (\n Object.hasOwn(this.#persistentParams, key) &&\n this.#persistentParams[key] !== undefined\n ) {\n newParams ??= { ...this.#persistentParams };\n delete newParams[key];\n }\n\n continue;\n }\n\n validateParamValue(key, value);\n\n if (this.#persistentParams[key] !== value) {\n newParams ??= { ...this.#persistentParams };\n newParams[key] = value;\n }\n }\n\n if (newParams) {\n this.#persistentParams = Object.freeze(newParams);\n }\n }\n\n #teardown(): void {\n try {\n this.#removeBuildPathInterceptor?.();\n this.#removeForwardStateInterceptor?.();\n this.#api.setRootPath(this.#originalRootPath);\n } /* v8 ignore start -- @preserve: defensive error logging for teardown failure */ catch (error) {\n console.error(\n \"persistent-params-plugin\",\n \"Error during teardown:\",\n error,\n );\n } /* v8 ignore stop */\n }\n}\n","// packages/persistent-params-plugin/modules/factory.ts\n\nimport { getPluginApi } from \"@real-router/core\";\n\nimport { PersistentParamsPlugin } from \"./plugin\";\nimport { validateConfig } from \"./validation\";\n\nimport type { PersistentParamsConfig } from \"./types\";\nimport type { Params, PluginFactory, Plugin } from \"@real-router/core\";\n\nconst noop = () => ({});\n\n/**\n * Factory for the persistent parameters' plugin.\n *\n * This plugin allows you to specify certain route parameters to be persisted across\n * all navigation transitions. Persisted parameters are automatically merged into\n * route parameters when building paths or states.\n *\n * Key features:\n * - Automatic persistence of query parameters across navigations\n * - Support for default values\n * - Type-safe (only primitives: string, number, boolean)\n * - Immutable internal state\n * - Protection against prototype pollution\n * - Full teardown support (can be safely unsubscribed)\n *\n * If a persisted parameter is explicitly set to `undefined` during navigation,\n * it will be removed from the persisted state and omitted from subsequent URLs.\n *\n * The plugin also adjusts the router's root path to include query parameters for\n * all persistent params, ensuring correct URL construction.\n *\n * @param params - Either an array of parameter names (strings) to persist,\n * or an object mapping parameter names to initial values.\n * If an array, initial values will be `undefined`.\n *\n * @returns A PluginFactory that creates the persistent params plugin instance.\n *\n * @example\n * // Persist parameters without default values\n * router.usePlugin(persistentParamsPlugin(['mode', 'lang']));\n *\n * @example\n * // Persist parameters with default values\n * router.usePlugin(persistentParamsPlugin({ mode: 'dev', lang: 'en' }));\n *\n * @example\n * // Removing a persisted parameter\n * router.navigate('route', { mode: undefined }); // mode will be removed\n *\n * @example\n * // Unsubscribing (full cleanup)\n * const unsubscribe = router.usePlugin(persistentParamsPlugin(['mode']));\n * unsubscribe(); // Restores original router state\n *\n * @throws {TypeError} If params is not a valid array of strings or object with primitives\n * @throws {Error} If plugin is already initialized on this router instance\n */\nexport function persistentParamsPluginFactory(\n params: PersistentParamsConfig = {},\n): PluginFactory {\n validateConfig(params);\n\n // Empty configuration - valid but does nothing\n if (Array.isArray(params) && params.length === 0) {\n return noop;\n }\n\n if (!Array.isArray(params) && Object.keys(params).length === 0) {\n return noop;\n }\n\n return (router): Plugin => {\n // Initialize frozen persistent parameters\n let persistentParams: Readonly<Params>;\n\n if (Array.isArray(params)) {\n const initial: Params = {};\n\n for (const param of params) {\n initial[param] = undefined;\n }\n\n persistentParams = Object.freeze(initial);\n } else {\n persistentParams = Object.freeze({ ...params });\n }\n\n const paramNamesSet = new Set<string>(\n Array.isArray(params) ? [...params] : Object.keys(params),\n );\n\n const api = getPluginApi(router);\n const originalRootPath = api.getRootPath();\n\n const plugin = new PersistentParamsPlugin(\n api,\n persistentParams,\n paramNamesSet,\n originalRootPath,\n );\n\n return plugin.getPlugin();\n };\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/types.ts":{"bytes":515,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/
|
|
1
|
+
{"inputs":{"../../node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js":{"bytes":569,"imports":[],"format":"esm"},"src/types.ts":{"bytes":515,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/param-utils.ts":{"bytes":2555,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"../type-guards/dist/esm/index.mjs":{"bytes":3451,"imports":[{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/validation.ts":{"bytes":3824,"imports":[{"path":"../type-guards/dist/esm/index.mjs","kind":"import-statement","original":"type-guards"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/plugin.ts":{"bytes":4027,"imports":[{"path":"src/param-utils.ts","kind":"import-statement","original":"./param-utils"},{"path":"src/validation.ts","kind":"import-statement","original":"./validation"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/factory.ts":{"bytes":3414,"imports":[{"path":"@real-router/core","kind":"import-statement","external":true},{"path":"src/plugin.ts","kind":"import-statement","original":"./plugin"},{"path":"src/validation.ts","kind":"import-statement","original":"./validation"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"},"src/index.ts":{"bytes":165,"imports":[{"path":"src/types.ts","kind":"import-statement","original":"./types"},{"path":"src/factory.ts","kind":"import-statement","original":"./factory"},{"path":"/home/runner/work/real-router/real-router/node_modules/.pnpm/tsup@8.5.1_jiti@2.6.1_postcss@8.5.6_typescript@5.9.3/node_modules/tsup/assets/cjs_shims.js","kind":"import-statement","external":true}],"format":"esm"}},"outputs":{"dist/cjs/index.js.map":{"imports":[],"exports":[],"inputs":{},"bytes":19205},"dist/cjs/index.js":{"imports":[{"path":"@real-router/core","kind":"import-statement","external":true}],"exports":["PersistentParamsConfig","persistentParamsPluginFactory"],"entryPoint":"src/index.ts","inputs":{"src/factory.ts":{"bytesInOutput":988},"src/param-utils.ts":{"bytesInOutput":679},"../type-guards/dist/esm/index.mjs":{"bytesInOutput":118},"src/validation.ts":{"bytesInOutput":2226},"src/plugin.ts":{"bytesInOutput":3092},"src/index.ts":{"bytesInOutput":0}},"bytes":7507}}}
|
package/dist/esm/index.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{getPluginApi as
|
|
1
|
+
import{getPluginApi as t}from"@real-router/core";function r(t){const r={};for(const e in t)Object.hasOwn(t,e)&&(r[e]=t[e]);return r}function e(t){return"number"==typeof t?Number.isFinite(t):"string"==typeof t||"boolean"==typeof t}var a=/[\s#%&/=?\\]/,s=String.raw`Cannot contain: = & ? # % / \ or whitespace`;function n(t){if(a.test(t))throw new TypeError(`[@real-router/persistent-params-plugin] Invalid parameter name "${t}". ${s}`)}function o(t,r){if(null===r)throw new TypeError(`[@real-router/persistent-params-plugin] Parameter "${t}" cannot be null. Use undefined to remove the parameter from persistence.`);if(void 0!==r&&!e(r)){const e=Array.isArray(r)?"array":typeof r;throw new TypeError(`[@real-router/persistent-params-plugin] Parameter "${t}" must be a primitive value (string, number, or boolean), got ${e}. Objects and arrays are not supported in URL parameters.`)}}var i=class{#t;#r;#e;#a;#s;#n;constructor(t,r,e,a){this.#t=t,this.#a=r,this.#r=e,this.#e=a}getPlugin(){try{const t=[...this.#r].join("&");this.#t.setRootPath(`${this.#e}?${t}`)}catch(t){throw new Error(`[@real-router/persistent-params-plugin] Failed to update root path: ${t instanceof Error?t.message:String(t)}`,{cause:t})}return this.#s=this.#t.addInterceptor("buildPath",(t,r,e)=>t(r,this.#o(e??{}))),this.#n=this.#t.addInterceptor("forwardState",(t,r,e)=>{const a=t(r,e);return{...a,params:this.#o(a.params)}}),{onTransitionSuccess:t=>{this.#i(t)},teardown:()=>{this.#p()}}}#o(t){const e=r(t);let a;for(const t of Object.keys(e)){const r=e[t];void 0===r&&this.#r.has(t)?(this.#r.delete(t),a??={...this.#a},delete a[t]):o(t,r)}return a&&(this.#a=Object.freeze(a)),function(t,e){const a=r(e),s={};for(const r in t)Object.hasOwn(t,r)&&void 0!==t[r]&&(s[r]=t[r]);for(const t of Object.keys(a)){const r=a[t];void 0===r?delete s[t]:s[t]=r}return s}(this.#a,e)}#i(t){let r;for(const e of this.#r){const a=t.params[e];Object.hasOwn(t.params,e)&&void 0!==a?(o(e,a),this.#a[e]!==a&&(r??={...this.#a},r[e]=a)):Object.hasOwn(this.#a,e)&&void 0!==this.#a[e]&&(r??={...this.#a},delete r[e])}r&&(this.#a=Object.freeze(r))}#p(){try{this.#s?.(),this.#n?.(),this.#t.setRootPath(this.#e)}catch(t){console.error("persistent-params-plugin","Error during teardown:",t)}}},p=()=>({});function c(r={}){return function(t){if(null==(r=t)||!(Array.isArray(r)?r.every(t=>{if("string"!=typeof t||0===t.length)return!1;try{return n(t),!0}catch{return!1}}):"object"==typeof r&&Object.getPrototypeOf(r)===Object.prototype&&Object.entries(r).every(([t,r])=>{if("string"!=typeof t||0===t.length)return!1;try{n(t)}catch{return!1}return e(r)}))){let r;throw r=null===t?"null":Array.isArray(t)?"array with invalid items":typeof t,new TypeError(`[@real-router/persistent-params-plugin] Invalid params configuration. Expected array of non-empty strings or object with primitive values, got ${r}.`)}var r}(r),Array.isArray(r)&&0===r.length?p:Array.isArray(r)||0!==Object.keys(r).length?e=>{let a;if(Array.isArray(r)){const t={};for(const e of r)t[e]=void 0;a=Object.freeze(t)}else a=Object.freeze({...r});const s=new Set(Array.isArray(r)?[...r]:Object.keys(r)),n=t(e),o=n.getRootPath();return new i(n,a,s,o).getPlugin()}:p}export{c as persistentParamsPluginFactory};//# sourceMappingURL=index.mjs.map
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/constants.ts","../../src/utils.ts","../../src/plugin.ts"],"names":[],"mappings":";;;AAMO,IAAM,aAAA,0BAAuB,0BAA0B,CAAA;;;;;;;;ACC9D,IAAM,uBAAA,GAA0B,cAAA;AAChC,IAAM,wBAAwB,MAAA,CAAO,GAAA,CAAA,2CAAA,CAAA;AAE9B,SAAS,iBAAiB,GAAA,EAAmB;AAClD,EAAA,IAAI,uBAAA,CAAwB,IAAA,CAAK,GAAG,CAAA,EAAG;AACrC,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,gEAAA,EAAmE,GAAG,CAAA,GAAA,EAAM,qBAAqB,CAAA;AAAA,KACnG;AAAA,EACF;AACF;AAgBO,SAAS,oBACd,MAAA,EACkC;AAClC,EAAA,IAAI,MAAA,KAAW,IAAA,IAAQ,MAAA,KAAW,MAAA,EAAW;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AAGA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,IAAA,OAAO,MAAA,CAAO,KAAA,CAAM,CAAC,IAAA,KAAS;AAC5B,MAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,CAAK,WAAW,CAAA,EAAG;AACjD,QAAA,OAAO,KAAA;AAAA,MACT;AAEA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,IAAI,CAAA;AAErB,QAAA,OAAO,IAAA;AAAA,MACT,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAGA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAE9B,IAAA,IAAI,MAAA,CAAO,cAAA,CAAe,MAAM,CAAA,KAAM,OAAO,SAAA,EAAW;AACtD,MAAA,OAAO,KAAA;AAAA,IACT;AAGA,IAAA,OAAO,MAAA,CAAO,QAAQ,MAAM,CAAA,CAAE,MAAM,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAEpD,MAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,WAAW,CAAA,EAAG;AAC/C,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,GAAG,CAAA;AAAA,MACtB,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,OAAO,EAAiB,KAAK,CAAA;AAAA,IAC/B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,KAAA;AACT;AAUO,SAAS,kBAAA,CAAmB,KAAa,KAAA,EAAsB;AACpE,EAAA,IAAI,UAAU,IAAA,EAAM;AAClB,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,sDAAsD,GAAG,CAAA,yEAAA;AAAA,KAE3D;AAAA,EACF;AAEA,EAAA,IAAI,KAAA,KAAU,MAAA,IAAa,CAAC,CAAA,CAAiB,KAAK,CAAA,EAAG;AACnD,IAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,UAAU,OAAO,KAAA;AAE3D,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,mDAAA,EAAsD,GAAG,CAAA,8DAAA,EAClB,UAAU,CAAA,yDAAA;AAAA,KAEnD;AAAA,EACF;AACF;AAcO,SAAS,iBAAiB,MAAA,EAAwB;AACvD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,MAAA,EAAQ;AAExB,IAAA,IAAI,MAAA,CAAO,MAAA,CAAO,MAAA,EAAQ,GAAG,CAAA,EAAG;AAC9B,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,MAAA,CAAO,GAAG,CAAA;AAAA,IAC1B;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AAcO,SAAS,iBAAiB,IAAA,EAG/B;AACA,EAAA,MAAM,iBAAA,GAAoB,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AAG1C,EAAA,IAAI,sBAAsB,EAAA,EAAI;AAC5B,IAAA,OAAO,EAAE,QAAA,EAAU,IAAA,EAAM,WAAA,EAAa,EAAA,EAAG;AAAA,EAC3C;AAGA,EAAA,IAAI,sBAAsB,CAAA,EAAG;AAC3B,IAAA,OAAO,EAAE,QAAA,EAAU,EAAA,EAAI,aAAa,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA,EAAE;AAAA,EACpD;AAGA,EAAA,OAAO;AAAA,IACL,QAAA,EAAU,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,iBAAiB,CAAA;AAAA,IACzC,WAAA,EAAa,IAAA,CAAK,KAAA,CAAM,iBAAA,GAAoB,CAAC;AAAA,GAC/C;AACF;AAcO,SAAS,gBAAA,CACd,eACA,UAAA,EACQ;AACR,EAAA,IAAI,UAAA,CAAW,WAAW,CAAA,EAAG;AAC3B,IAAA,OAAO,aAAA;AAAA,EACT;AAEA,EAAA,MAAM,SAAA,GAAY,gBAAgB,GAAA,GAAM,EAAA;AAExC,EAAA,OAAO,aAAA,GAAgB,SAAA,GAAY,UAAA,CAAW,IAAA,CAAK,GAAG,CAAA;AACxD;AAuBO,SAAS,WAAA,CACd,YACA,OAAA,EACQ;AAER,EAAA,MAAM,iBAAA,GAAoB,iBAAiB,OAAO,CAAA;AAIlD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,IAAI,MAAA,CAAO,OAAO,UAAA,EAAY,GAAG,KAAK,UAAA,CAAW,GAAG,MAAM,MAAA,EAAW;AACnE,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,UAAA,CAAW,GAAG,CAAA;AAAA,IAC9B;AAAA,EACF;AAGA,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,iBAAiB,CAAA,EAAG;AAChD,IAAA,MAAM,KAAA,GAAQ,kBAAkB,GAAG,CAAA;AAEnC,IAAA,IAAI,UAAU,MAAA,EAAW;AAEvB,MAAA,OAAO,OAAO,GAAG,CAAA;AAAA,IACnB,CAAA,MAAO;AAEL,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,KAAA;AAAA,IAChB;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;;;ACzLO,SAAS,6BAAA,CACd,MAAA,GAAiC,EAAC,EACnB;AAEf,EAAA,IAAI,CAAC,mBAAA,CAAoB,MAAM,CAAA,EAAG;AAChC,IAAA,IAAI,UAAA;AAGJ,IAAA,IAAI,WAAW,IAAA,EAAM;AACnB,MAAA,UAAA,GAAa,MAAA;AAAA,IACf,CAAA,MAAA,IAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAChC,MAAA,UAAA,GAAa,0BAAA;AAAA,IACf,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,OAAO,MAAA;AAAA,IACtB;AAEA,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,kJAC8E,UAAU,CAAA,CAAA;AAAA,KAC1F;AAAA,EACF;AAGA,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,MAAA,CAAO,WAAW,CAAA,EAAG;AAChD,IAAA,OAAO,OAAO,EAAC,CAAA;AAAA,EACjB;AAEA,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA,EAAG;AAC9D,IAAA,OAAO,OAAO,EAAC,CAAA;AAAA,EACjB;AAEA,EAAA,OAAO,CAAC,MAAA,KAAmB;AAEzB,IAAA,IAAI,iBAAiB,MAAA,EAAQ;AAC3B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,iLAAA;AAAA,OAEF;AAAA,IACF;AAGA,IAAC,MAAA,CAA8C,aAAa,CAAA,GAAI,IAAA;AAGhE,IAAA,IAAI,gBAAA;AAEJ,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,MAAA,MAAM,UAAkB,EAAC;AAEzB,MAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,QAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,MAAA;AAAA,MACnB;AAEA,MAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,OAAO,CAAA;AAAA,IAC1C,CAAA,MAAO;AACL,MAAA,gBAAA,GAAmB,MAAA,CAAO,MAAA,CAAO,EAAE,GAAG,QAAQ,CAAA;AAAA,IAChD;AAGA,IAAA,MAAM,gBAAgB,IAAI,GAAA;AAAA,MACxB,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,CAAC,GAAG,MAAM,CAAA,GAAI,MAAA,CAAO,IAAA,CAAK,MAAM;AAAA,KAC1D;AAEA,IAAA,MAAM,GAAA,GAAM,aAAa,MAAM,CAAA;AAG/B,IAAA,MAAM,iBAAA,GAAoB,MAAA,CAAO,SAAA,CAAU,IAAA,CAAK,MAAM,CAAA;AACtD,IAAA,MAAM,oBAAA,GAAuB,IAAI,eAAA,EAAgB;AACjD,IAAA,MAAM,gBAAA,GAAmB,IAAI,WAAA,EAAY;AAGzC,IAAA,IAAI;AACF,MAAA,MAAM,EAAE,QAAA,EAAU,WAAA,EAAY,GAAI,iBAAiB,gBAAgB,CAAA;AACnE,MAAA,MAAM,iBAAiB,gBAAA,CAAiB,WAAA,EAAa,CAAC,GAAG,aAAa,CAAC,CAAA;AAEvE,MAAA,GAAA,CAAI,WAAA,CAAY,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,cAAc,CAAA,CAAE,CAAA;AAAA,IACjD,SAA8F,KAAA,EAAO;AACnG,MAAA,OAAQ,OAA8C,aAAa,CAAA;AAEnE,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,uEAAuE,KAAA,YAAiB,KAAA,GAAQ,MAAM,OAAA,GAAU,MAAA,CAAO,KAAK,CAAC,CAAA,CAAA;AAAA,QAC7H,EAAE,OAAO,KAAA;AAAM,OACjB;AAAA,IACF;AAWA,IAAA,SAAS,qBAAqB,gBAAA,EAAkC;AAE9D,MAAA,MAAM,UAAA,GAAa,iBAAiB,gBAAgB,CAAA;AAGpD,MAAA,MAAM,iBAA2B,EAAC;AAElC,MAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,UAAU,CAAA,EAAG;AACzC,QAAA,MAAM,KAAA,GAAQ,WAAW,GAAG,CAAA;AAG5B,QAAA,IAAI,KAAA,KAAU,MAAA,IAAa,aAAA,CAAc,GAAA,CAAI,GAAG,CAAA,EAAG;AACjD,UAAA,cAAA,CAAe,KAAK,GAAG,CAAA;AAAA,QACzB,CAAA,MAAO;AAEL,UAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAAA,QAC/B;AAAA,MACF;AAGA,MAAA,IAAI,cAAA,CAAe,SAAS,CAAA,EAAG;AAE7B,QAAA,KAAA,MAAW,OAAO,cAAA,EAAgB;AAChC,UAAA,aAAA,CAAc,OAAO,GAAG,CAAA;AAAA,QAC1B;AAGA,QAAA,MAAM,SAAA,GAAoB,EAAE,GAAG,gBAAA,EAAiB;AAEhD,QAAA,KAAA,MAAW,OAAO,cAAA,EAAgB;AAChC,UAAA,OAAO,UAAU,GAAG,CAAA;AAAA,QACtB;AAEA,QAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,SAAS,CAAA;AAAA,MAC5C;AAGA,MAAA,OAAO,WAAA,CAAY,kBAAkB,UAAU,CAAA;AAAA,IACjD;AAIA,IAAA,MAAA,CAAO,SAAA,GAAY,CAAC,SAAA,EAAW,eAAA,GAAkB,OAC/C,iBAAA,CAAkB,SAAA,EAAW,oBAAA,CAAqB,eAAe,CAAC,CAAA;AAEpE,IAAA,GAAA,CAAI,eAAA;AAAA,MACF,CAA4B,WAAmB,WAAA,KAAmB;AAChE,QAAA,MAAM,MAAA,GAAS,oBAAA,CAAqB,SAAA,EAAW,WAAW,CAAA;AAE1D,QAAA,OAAO;AAAA,UACL,GAAG,MAAA;AAAA,UACH,MAAA,EAAQ,oBAAA,CAAqB,MAAA,CAAO,MAAM;AAAA,SAC5C;AAAA,MACF;AAAA,KACF;AAEA,IAAA,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOL,oBAAoB,OAAA,EAAS;AAC3B,QAAA,IAAI;AAEF,UAAA,MAAM,UAAkB,EAAC;AACzB,UAAA,MAAM,WAAqB,EAAC;AAC5B,UAAA,IAAI,UAAA,GAAa,KAAA;AAEjB,UAAA,KAAA,MAAW,OAAO,aAAA,EAAe;AAC/B,YAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,MAAA,CAAO,GAAG,CAAA;AAGhC,YAAA,IAAI,CAAC,OAAO,MAAA,CAAO,OAAA,CAAQ,QAAQ,GAAG,CAAA,IAAK,UAAU,KAAA,CAAA,EAAW;AAE9D,cAAA,IACE,MAAA,CAAO,OAAO,gBAAA,EAAkB,GAAG,KACnC,gBAAA,CAAiB,GAAG,MAAM,KAAA,CAAA,EAC1B;AACA,gBAAA,QAAA,CAAS,KAAK,GAAG,CAAA;AACjB,gBAAA,UAAA,GAAa,IAAA;AAAA,cACf;AAEA,cAAA;AAAA,YACF;AAGA,YAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAG7B,YAAA,IAAI,gBAAA,CAAiB,GAAG,CAAA,KAAM,KAAA,EAAO;AACnC,cAAA,OAAA,CAAQ,GAAG,CAAA,GAAI,KAAA;AACf,cAAA,UAAA,GAAa,IAAA;AAAA,YACf;AAAA,UACF;AAGA,UAAA,IAAI,UAAA,EAAY;AACd,YAAA,MAAM,SAAA,GAAoB,EAAE,GAAG,gBAAA,EAAkB,GAAG,OAAA,EAAQ;AAG5D,YAAA,KAAA,MAAW,OAAO,QAAA,EAAU;AAC1B,cAAA,OAAO,UAAU,GAAG,CAAA;AAAA,YACtB;AAEA,YAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,SAAS,CAAA;AAAA,UAC5C;AAAA,QACF,SAAS,KAAA,EAAO;AAGd,UAAA,OAAA,CAAQ,KAAA;AAAA,YACN,0BAAA;AAAA,YACA,mCAAA;AAAA,YACA;AAAA,WACF;AAAA,QACF;AAAA,MACF,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,QAAA,GAAW;AACT,QAAA,IAAI;AACF,UAAA,MAAA,CAAO,SAAA,GAAY,iBAAA;AACnB,UAAA,GAAA,CAAI,gBAAgB,oBAAoB,CAAA;AACxC,UAAA,GAAA,CAAI,YAAY,gBAAgB,CAAA;AAEhC,UAAA,OAAQ,OAA8C,aAAa,CAAA;AAAA,QACrE,SAA0F,KAAA,EAAO;AAC/F,UAAA,OAAA,CAAQ,KAAA;AAAA,YACN,0BAAA;AAAA,YACA,wBAAA;AAAA,YACA;AAAA,WACF;AAAA,QACF;AAAA,MACF;AAAA,KACF;AAAA,EACF,CAAA;AACF","file":"index.mjs","sourcesContent":["// packages/persistent-params-plugin/modules/constants.ts\n\n/**\n * Symbol to mark router as initialized with this plugin.\n * Prevents double initialization and memory leaks from method wrapping.\n */\nexport const PLUGIN_MARKER = Symbol(\"persistent-params-plugin\");\n","// packages/persistent-params-plugin/modules/utils.ts\n\nimport { isPrimitiveValue } from \"type-guards\";\n\nimport type { PersistentParamsConfig } from \"./types\";\nimport type { Params } from \"@real-router/core\";\n\nconst INVALID_PARAM_KEY_REGEX = /[\\s#%&/=?\\\\]/;\nconst INVALID_CHARS_MESSAGE = String.raw`Cannot contain: = & ? # % / \\ or whitespace`;\n\nexport function validateParamKey(key: string): void {\n if (INVALID_PARAM_KEY_REGEX.test(key)) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid parameter name \"${key}\". ${INVALID_CHARS_MESSAGE}`,\n );\n }\n}\n\n/**\n * Validates params configuration structure and values.\n * Ensures all parameter names are non-empty strings and all default values are primitives.\n *\n * @param config - Configuration to validate\n * @returns true if configuration is valid\n */\n/**\n * Validates params configuration structure and values.\n * Ensures all parameter names are non-empty strings and all default values are primitives.\n *\n * @param config - Configuration to validate\n * @returns true if configuration is valid\n */\nexport function isValidParamsConfig(\n config: unknown,\n): config is PersistentParamsConfig {\n if (config === null || config === undefined) {\n return false;\n }\n\n // Array configuration: all items must be non-empty strings\n if (Array.isArray(config)) {\n return config.every((item) => {\n if (typeof item !== \"string\" || item.length === 0) {\n return false;\n }\n\n try {\n validateParamKey(item);\n\n return true;\n } catch {\n return false;\n }\n });\n }\n\n // Object configuration: must be plain object with primitive values\n if (typeof config === \"object\") {\n // Reject non-plain objects (Date, Map, etc.)\n if (Object.getPrototypeOf(config) !== Object.prototype) {\n return false;\n }\n\n // All keys must be non-empty strings, all values must be primitives\n return Object.entries(config).every(([key, value]) => {\n // Check key is non-empty string\n if (typeof key !== \"string\" || key.length === 0) {\n return false;\n }\n\n // Validate key doesn't contain special characters\n try {\n validateParamKey(key);\n } catch {\n return false;\n }\n\n // Validate value is primitive (NaN/Infinity already rejected by isPrimitiveValue)\n return isPrimitiveValue(value);\n });\n }\n\n return false;\n}\n\n/**\n * Validates parameter value before persisting.\n * Throws descriptive TypeError if value is not valid for URL parameters.\n *\n * @param key - Parameter name for error messages\n * @param value - Value to validate\n * @throws {TypeError} If value is null, array, object, or other non-primitive type\n */\nexport function validateParamValue(key: string, value: unknown): void {\n if (value === null) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" cannot be null. ` +\n `Use undefined to remove the parameter from persistence.`,\n );\n }\n\n if (value !== undefined && !isPrimitiveValue(value)) {\n const actualType = Array.isArray(value) ? \"array\" : typeof value;\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" must be a primitive value ` +\n `(string, number, or boolean), got ${actualType}. ` +\n `Objects and arrays are not supported in URL parameters.`,\n );\n }\n}\n\n/**\n * Safely extracts own properties from params object.\n * Uses Object.hasOwn to prevent prototype pollution attacks.\n *\n * @param params - Parameters object (may contain inherited properties)\n * @returns New object with only own properties\n *\n * @example\n * const malicious = Object.create({ __proto__: { admin: true } });\n * malicious.mode = 'dev';\n * const safe = extractOwnParams(malicious); // { mode: 'dev' } (no __proto__)\n */\nexport function extractOwnParams(params: Params): Params {\n const result: Params = {};\n\n for (const key in params) {\n // Only process own properties, skip inherited ones\n if (Object.hasOwn(params, key)) {\n result[key] = params[key];\n }\n }\n\n return result;\n}\n\n/**\n * Parses path into base path and query string components.\n * Handles edge cases like leading ?, multiple ?, empty path.\n *\n * @param path - Path to parse (e.g., \"/route?param=value\")\n * @returns Object with basePath and queryString\n *\n * @example\n * parseQueryString('/users?page=1') // { basePath: '/users', queryString: 'page=1' }\n * parseQueryString('?existing') // { basePath: '', queryString: 'existing' }\n * parseQueryString('/path') // { basePath: '/path', queryString: '' }\n */\nexport function parseQueryString(path: string): {\n basePath: string;\n queryString: string;\n} {\n const questionMarkIndex = path.indexOf(\"?\");\n\n // No query string\n if (questionMarkIndex === -1) {\n return { basePath: path, queryString: \"\" };\n }\n\n // Path starts with ? (edge case)\n if (questionMarkIndex === 0) {\n return { basePath: \"\", queryString: path.slice(1) };\n }\n\n // Normal case: path?query\n return {\n basePath: path.slice(0, questionMarkIndex),\n queryString: path.slice(questionMarkIndex + 1),\n };\n}\n\n/**\n * Builds query string from parameter names.\n * Preserves existing query parameters and appends new ones.\n *\n * @param existingQuery - Existing query string (without leading ?)\n * @param paramNames - Parameter names to append\n * @returns Combined query string\n *\n * @example\n * buildQueryString('existing=1', ['mode', 'lang']) // 'existing=1&mode&lang'\n * buildQueryString('', ['mode']) // 'mode'\n */\nexport function buildQueryString(\n existingQuery: string,\n paramNames: readonly string[],\n): string {\n if (paramNames.length === 0) {\n return existingQuery;\n }\n\n const separator = existingQuery ? \"&\" : \"\";\n\n return existingQuery + separator + paramNames.join(\"&\");\n}\n\n/**\n * Merges persistent and current parameters into a single Params object.\n * Keys explicitly set to `undefined` in current params are removed from result.\n *\n * Creates a new immutable object - does not mutate input parameters.\n *\n * @param persistent - Frozen persistent parameters\n * @param current - Current parameters from navigation\n * @returns New Params object with merged values\n *\n * @example\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: 'light', mode: 'dev' };\n * mergeParams(persistent, current); // { lang: 'en', theme: 'light', mode: 'dev' }\n *\n * @example\n * // Removing parameters with undefined\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: undefined };\n * mergeParams(persistent, current); // { lang: 'en' } (theme removed)\n */\nexport function mergeParams(\n persistent: Readonly<Params>,\n current: Params,\n): Params {\n // Safely extract own properties from current params\n const safeCurrentParams = extractOwnParams(current);\n\n // Start with persistent params, but EXCLUDE undefined values\n // (undefined values don't appear in URLs, so we shouldn't include them)\n const result: Params = {};\n\n for (const key in persistent) {\n if (Object.hasOwn(persistent, key) && persistent[key] !== undefined) {\n result[key] = persistent[key];\n }\n }\n\n // Apply current params\n for (const key of Object.keys(safeCurrentParams)) {\n const value = safeCurrentParams[key];\n\n if (value === undefined) {\n // Remove param if explicitly set to undefined\n delete result[key];\n } else {\n // Add or update param\n result[key] = value;\n }\n }\n\n return result;\n}\n","// packages/persistent-params-plugin/modules/plugin.ts\n\nimport { getPluginApi } from \"@real-router/core\";\n\nimport { PLUGIN_MARKER } from \"./constants\";\nimport {\n buildQueryString,\n extractOwnParams,\n isValidParamsConfig,\n mergeParams,\n parseQueryString,\n validateParamValue,\n} from \"./utils\";\n\nimport type { PersistentParamsConfig } from \"./types\";\nimport type { Params, PluginFactory, Plugin } from \"@real-router/core\";\n\n/**\n * Factory for the persistent parameters' plugin.\n *\n * This plugin allows you to specify certain route parameters to be persisted across\n * all navigation transitions. Persisted parameters are automatically merged into\n * route parameters when building paths or states.\n *\n * Key features:\n * - Automatic persistence of query parameters across navigations\n * - Support for default values\n * - Type-safe (only primitives: string, number, boolean)\n * - Immutable internal state\n * - Protection against prototype pollution\n * - Full teardown support (can be safely unsubscribed)\n *\n * If a persisted parameter is explicitly set to `undefined` during navigation,\n * it will be removed from the persisted state and omitted from subsequent URLs.\n *\n * The plugin also adjusts the router's root path to include query parameters for\n * all persistent params, ensuring correct URL construction.\n *\n * @param params - Either an array of parameter names (strings) to persist,\n * or an object mapping parameter names to initial values.\n * If an array, initial values will be `undefined`.\n *\n * @returns A PluginFactory that creates the persistent params plugin instance.\n *\n * @example\n * // Persist parameters without default values\n * router.usePlugin(persistentParamsPlugin(['mode', 'lang']));\n *\n * @example\n * // Persist parameters with default values\n * router.usePlugin(persistentParamsPlugin({ mode: 'dev', lang: 'en' }));\n *\n * @example\n * // Removing a persisted parameter\n * router.navigate('route', { mode: undefined }); // mode will be removed\n *\n * @example\n * // Unsubscribing (full cleanup)\n * const unsubscribe = router.usePlugin(persistentParamsPlugin(['mode']));\n * unsubscribe(); // Restores original router state\n *\n * @throws {TypeError} If params is not a valid array of strings or object with primitives\n * @throws {Error} If plugin is already initialized on this router instance\n */\nexport function persistentParamsPluginFactory(\n params: PersistentParamsConfig = {},\n): PluginFactory {\n // Validate input configuration\n if (!isValidParamsConfig(params)) {\n let actualType: string;\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (params === null) {\n actualType = \"null\";\n } else if (Array.isArray(params)) {\n actualType = \"array with invalid items\";\n } else {\n actualType = typeof params;\n }\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid params configuration. ` +\n `Expected array of non-empty strings or object with primitive values, got ${actualType}.`,\n );\n }\n\n // Empty configuration - valid but does nothing\n if (Array.isArray(params) && params.length === 0) {\n return () => ({});\n }\n\n if (!Array.isArray(params) && Object.keys(params).length === 0) {\n return () => ({});\n }\n\n return (router): Plugin => {\n // Check if plugin is already initialized on this router\n if (PLUGIN_MARKER in router) {\n throw new Error(\n `[@real-router/persistent-params-plugin] Plugin already initialized on this router. ` +\n `To reconfigure, first unsubscribe the existing plugin using the returned unsubscribe function.`,\n );\n }\n\n // Mark router as initialized\n (router as unknown as Record<symbol, boolean>)[PLUGIN_MARKER] = true;\n\n // Initialize frozen persistent parameters\n let persistentParams: Readonly<Params>;\n\n if (Array.isArray(params)) {\n const initial: Params = {};\n\n for (const param of params) {\n initial[param] = undefined;\n }\n\n persistentParams = Object.freeze(initial);\n } else {\n persistentParams = Object.freeze({ ...params });\n }\n\n // Track parameter names\n const paramNamesSet = new Set<string>(\n Array.isArray(params) ? [...params] : Object.keys(params),\n );\n\n const api = getPluginApi(router);\n\n // Store original router methods for restoration\n const originalBuildPath = router.buildPath.bind(router);\n const originalForwardState = api.getForwardState();\n const originalRootPath = api.getRootPath();\n\n // Update router root path to include query parameters for persistent params\n try {\n const { basePath, queryString } = parseQueryString(originalRootPath);\n const newQueryString = buildQueryString(queryString, [...paramNamesSet]);\n\n api.setRootPath(`${basePath}?${newQueryString}`);\n } /* v8 ignore start -- @preserve: defensive error wrapping for setRootPath failure */ catch (error) {\n delete (router as unknown as Record<symbol, boolean>)[PLUGIN_MARKER];\n\n throw new Error(\n `[@real-router/persistent-params-plugin] Failed to update root path: ${error instanceof Error ? error.message : String(error)}`,\n { cause: error },\n );\n } /* v8 ignore stop */\n\n /**\n * Merges persistent parameters with current navigation parameters.\n * Validates all parameter values before merging.\n *\n * @param additionalParams - Parameters passed during navigation\n * @returns Merged parameters object\n * @throws {TypeError} If any parameter value is invalid (not a primitive)\n */\n\n function withPersistentParams(additionalParams: Params): Params {\n // Extract safe params (prevent prototype pollution)\n const safeParams = extractOwnParams(additionalParams);\n\n // Validate and collect parameters to remove in a single pass\n const paramsToRemove: string[] = [];\n\n for (const key of Object.keys(safeParams)) {\n const value = safeParams[key];\n\n // If undefined and tracked, mark for removal (skip validation)\n if (value === undefined && paramNamesSet.has(key)) {\n paramsToRemove.push(key);\n } else {\n // Validate all other parameters\n validateParamValue(key, value);\n }\n }\n\n // Process all removals in one batch\n if (paramsToRemove.length > 0) {\n // Remove from both Set\n for (const key of paramsToRemove) {\n paramNamesSet.delete(key);\n }\n\n // Update persistentParams once (batch freeze)\n const newParams: Params = { ...persistentParams };\n\n for (const key of paramsToRemove) {\n delete newParams[key];\n }\n\n persistentParams = Object.freeze(newParams);\n }\n\n // Merge persistent and current params\n return mergeParams(persistentParams, safeParams);\n }\n\n // Override router methods to inject persistent params\n // buildPath: needed for direct buildPath() calls (doesn't go through forwardState)\n router.buildPath = (routeName, buildPathParams = {}) =>\n originalBuildPath(routeName, withPersistentParams(buildPathParams));\n\n api.setForwardState(\n <P extends Params = Params>(routeName: string, routeParams: P) => {\n const result = originalForwardState(routeName, routeParams);\n\n return {\n ...result,\n params: withPersistentParams(result.params) as P,\n };\n },\n );\n\n return {\n /**\n * Updates persistent parameters after successful transition.\n * Only processes parameters that are tracked and have changed.\n *\n * @param toState - Target state after successful transition\n */\n onTransitionSuccess(toState) {\n try {\n // Collect changed parameters and removals\n const updates: Params = {};\n const removals: string[] = [];\n let hasChanges = false;\n\n for (const key of paramNamesSet) {\n const value = toState.params[key];\n\n // If parameter is not in state params or is undefined, mark for removal\n if (!Object.hasOwn(toState.params, key) || value === undefined) {\n /* v8 ignore next 6 -- @preserve: defensive removal for states committed via navigateToState bypassing forwardState */\n if (\n Object.hasOwn(persistentParams, key) &&\n persistentParams[key] !== undefined\n ) {\n removals.push(key);\n hasChanges = true;\n }\n\n continue;\n }\n\n // Validate type before storing\n validateParamValue(key, value);\n\n // Only update if value actually changed\n if (persistentParams[key] !== value) {\n updates[key] = value;\n hasChanges = true;\n }\n }\n\n // Create new frozen object only if there were changes\n if (hasChanges) {\n const newParams: Params = { ...persistentParams, ...updates };\n\n /* v8 ignore next 3 -- @preserve: removals only populated by defensive navigateToState path above */\n for (const key of removals) {\n delete newParams[key];\n }\n\n persistentParams = Object.freeze(newParams);\n }\n } catch (error) {\n // Log error but don't break navigation\n /* v8 ignore next 5 -- @preserve defensive: validation happens before navigate() */\n console.error(\n \"persistent-params-plugin\",\n \"Error updating persistent params:\",\n error,\n );\n }\n },\n\n /**\n * Cleanup function to restore original router state.\n * Restores all overridden methods and paths.\n * Called when plugin is unsubscribed.\n */\n teardown() {\n try {\n router.buildPath = originalBuildPath;\n api.setForwardState(originalForwardState);\n api.setRootPath(originalRootPath);\n\n delete (router as unknown as Record<symbol, boolean>)[PLUGIN_MARKER];\n } /* v8 ignore start -- @preserve: defensive error logging for teardown failure */ catch (error) {\n console.error(\n \"persistent-params-plugin\",\n \"Error during teardown:\",\n error,\n );\n } /* v8 ignore stop */\n },\n };\n };\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../../src/param-utils.ts","../../src/validation.ts","../../src/plugin.ts","../../src/factory.ts"],"names":[],"mappings":";;;AAgBO,SAAS,iBAAiB,MAAA,EAAwB;AACvD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,MAAA,EAAQ;AAExB,IAAA,IAAI,MAAA,CAAO,MAAA,CAAO,MAAA,EAAQ,GAAG,CAAA,EAAG;AAC9B,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,MAAA,CAAO,GAAG,CAAA;AAAA,IAC1B;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AAuBO,SAAS,WAAA,CACd,YACA,OAAA,EACQ;AAER,EAAA,MAAM,iBAAA,GAAoB,iBAAiB,OAAO,CAAA;AAIlD,EAAA,MAAM,SAAiB,EAAC;AAExB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,IAAI,MAAA,CAAO,OAAO,UAAA,EAAY,GAAG,KAAK,UAAA,CAAW,GAAG,MAAM,MAAA,EAAW;AACnE,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,UAAA,CAAW,GAAG,CAAA;AAAA,IAC9B;AAAA,EACF;AAGA,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,iBAAiB,CAAA,EAAG;AAChD,IAAA,MAAM,KAAA,GAAQ,kBAAkB,GAAG,CAAA;AAEnC,IAAA,IAAI,UAAU,MAAA,EAAW;AAEvB,MAAA,OAAO,OAAO,GAAG,CAAA;AAAA,IACnB,CAAA,MAAO;AAEL,MAAA,MAAA,CAAO,GAAG,CAAA,GAAI,KAAA;AAAA,IAChB;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;;;;;;;;AC3EA,IAAM,uBAAA,GAA0B,cAAA;AAChC,IAAM,wBAAwB,MAAA,CAAO,GAAA,CAAA,2CAAA,CAAA;AAE9B,SAAS,iBAAiB,GAAA,EAAmB;AAClD,EAAA,IAAI,uBAAA,CAAwB,IAAA,CAAK,GAAG,CAAA,EAAG;AACrC,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,gEAAA,EAAmE,GAAG,CAAA,GAAA,EAAM,qBAAqB,CAAA;AAAA,KACnG;AAAA,EACF;AACF;AASO,SAAS,oBACd,MAAA,EACkC;AAClC,EAAA,IAAI,MAAA,KAAW,IAAA,IAAQ,MAAA,KAAW,MAAA,EAAW;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AAGA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,IAAA,OAAO,MAAA,CAAO,KAAA,CAAM,CAAC,IAAA,KAAS;AAC5B,MAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,CAAK,WAAW,CAAA,EAAG;AACjD,QAAA,OAAO,KAAA;AAAA,MACT;AAEA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,IAAI,CAAA;AAErB,QAAA,OAAO,IAAA;AAAA,MACT,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAGA,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAE9B,IAAA,IAAI,MAAA,CAAO,cAAA,CAAe,MAAM,CAAA,KAAM,OAAO,SAAA,EAAW;AACtD,MAAA,OAAO,KAAA;AAAA,IACT;AAGA,IAAA,OAAO,MAAA,CAAO,QAAQ,MAAM,CAAA,CAAE,MAAM,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AAEpD,MAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,WAAW,CAAA,EAAG;AAC/C,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,IAAI;AACF,QAAA,gBAAA,CAAiB,GAAG,CAAA;AAAA,MACtB,CAAA,CAAA,MAAQ;AACN,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,OAAO,EAAiB,KAAK,CAAA;AAAA,IAC/B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,KAAA;AACT;AAUO,SAAS,kBAAA,CAAmB,KAAa,KAAA,EAAsB;AACpE,EAAA,IAAI,UAAU,IAAA,EAAM;AAClB,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,sDAAsD,GAAG,CAAA,yEAAA;AAAA,KAE3D;AAAA,EACF;AAEA,EAAA,IAAI,KAAA,KAAU,MAAA,IAAa,CAAC,CAAA,CAAiB,KAAK,CAAA,EAAG;AACnD,IAAA,MAAM,aAAa,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,UAAU,OAAO,KAAA;AAE3D,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,CAAA,mDAAA,EAAsD,GAAG,CAAA,8DAAA,EAClB,UAAU,CAAA,yDAAA;AAAA,KAEnD;AAAA,EACF;AACF;AAQO,SAAS,eAAe,MAAA,EAAuB;AACpD,EAAA,IAAI,CAAC,mBAAA,CAAoB,MAAM,CAAA,EAAG;AAChC,IAAA,IAAI,UAAA;AAEJ,IAAA,IAAI,WAAW,IAAA,EAAM;AACnB,MAAA,UAAA,GAAa,MAAA;AAAA,IACf,CAAA,MAAA,IAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAChC,MAAA,UAAA,GAAa,0BAAA;AAAA,IACf,CAAA,MAAO;AACL,MAAA,UAAA,GAAa,OAAO,MAAA;AAAA,IACtB;AAEA,IAAA,MAAM,IAAI,SAAA;AAAA,MACR,kJAC8E,UAAU,CAAA,CAAA;AAAA,KAC1F;AAAA,EACF;AACF;;;ACxHO,IAAM,yBAAN,MAA6B;AAAA,EACzB,IAAA;AAAA,EACA,cAAA;AAAA,EACA,iBAAA;AAAA,EAET,iBAAA;AAAA,EACA,2BAAA;AAAA,EACA,8BAAA;AAAA,EAEA,WAAA,CACE,GAAA,EACA,gBAAA,EACA,aAAA,EACA,gBAAA,EACA;AACA,IAAA,IAAA,CAAK,IAAA,GAAO,GAAA;AACZ,IAAA,IAAA,CAAK,iBAAA,GAAoB,gBAAA;AACzB,IAAA,IAAA,CAAK,cAAA,GAAiB,aAAA;AACtB,IAAA,IAAA,CAAK,iBAAA,GAAoB,gBAAA;AAAA,EAC3B;AAAA,EAEA,SAAA,GAAoB;AAClB,IAAA,IAAI;AACF,MAAA,MAAM,cAAc,CAAC,GAAG,KAAK,cAAc,CAAA,CAAE,KAAK,GAAG,CAAA;AAErD,MAAA,IAAA,CAAK,KAAK,WAAA,CAAY,CAAA,EAAG,KAAK,iBAAiB,CAAA,CAAA,EAAI,WAAW,CAAA,CAAE,CAAA;AAAA,IAClE,SAA8F,KAAA,EAAO;AACnG,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,uEAAuE,KAAA,YAAiB,KAAA,GAAQ,MAAM,OAAA,GAAU,MAAA,CAAO,KAAK,CAAC,CAAA,CAAA;AAAA,QAC7H,EAAE,OAAO,KAAA;AAAM,OACjB;AAAA,IACF;AAEA,IAAA,IAAA,CAAK,2BAAA,GAA8B,KAAK,IAAA,CAAK,cAAA;AAAA,MAC3C,WAAA;AAAA,MACA,CAAC,IAAA,EAAM,KAAA,EAAO,SAAA,KACZ,IAAA,CAAK,KAAA,EAAO,IAAA,CAAK,qBAAA,CAAsB,SAAA,IAAa,EAAE,CAAC;AAAA,KAC3D;AAEA,IAAA,IAAA,CAAK,8BAAA,GAAiC,KAAK,IAAA,CAAK,cAAA;AAAA,MAC9C,cAAA;AAAA,MACA,CAAC,IAAA,EAAM,SAAA,EAAW,WAAA,KAAgB;AAChC,QAAA,MAAM,MAAA,GAAS,IAAA,CAAK,SAAA,EAAW,WAAW,CAAA;AAE1C,QAAA,OAAO;AAAA,UACL,GAAG,MAAA;AAAA,UACH,MAAA,EAAQ,IAAA,CAAK,qBAAA,CAAsB,MAAA,CAAO,MAAM;AAAA,SAClD;AAAA,MACF;AAAA,KACF;AAEA,IAAA,OAAO;AAAA,MACL,mBAAA,EAAqB,CAAC,OAAA,KAAY;AAChC,QAAA,IAAA,CAAK,qBAAqB,OAAO,CAAA;AAAA,MACnC,CAAA;AAAA,MACA,UAAU,MAAM;AACd,QAAA,IAAA,CAAK,SAAA,EAAU;AAAA,MACjB;AAAA,KACF;AAAA,EACF;AAAA,EAEA,sBAAsB,gBAAA,EAAkC;AACtD,IAAA,MAAM,UAAA,GAAa,iBAAiB,gBAAgB,CAAA;AACpD,IAAA,IAAI,SAAA;AAEJ,IAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,UAAU,CAAA,EAAG;AACzC,MAAA,MAAM,KAAA,GAAQ,WAAW,GAAG,CAAA;AAE5B,MAAA,IAAI,UAAU,MAAA,IAAa,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,GAAG,CAAA,EAAG;AACvD,QAAA,IAAA,CAAK,cAAA,CAAe,OAAO,GAAG,CAAA;AAC9B,QAAA,SAAA,KAAc,EAAE,GAAG,IAAA,CAAK,iBAAA,EAAkB;AAC1C,QAAA,OAAO,UAAU,GAAG,CAAA;AAAA,MACtB,CAAA,MAAO;AACL,QAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAAA,MAC/B;AAAA,IACF;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA,CAAO,MAAA,CAAO,SAAS,CAAA;AAAA,IAClD;AAEA,IAAA,OAAO,WAAA,CAAY,IAAA,CAAK,iBAAA,EAAmB,UAAU,CAAA;AAAA,EACvD;AAAA,EAEA,qBAAqB,OAAA,EAAsB;AACzC,IAAA,IAAI,SAAA;AAEJ,IAAA,KAAA,MAAW,GAAA,IAAO,KAAK,cAAA,EAAgB;AACrC,MAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,MAAA,CAAO,GAAG,CAAA;AAEhC,MAAA,IAAI,CAAC,OAAO,MAAA,CAAO,OAAA,CAAQ,QAAQ,GAAG,CAAA,IAAK,UAAU,MAAA,EAAW;AAE9D,QAAA,IACE,MAAA,CAAO,MAAA,CAAO,IAAA,CAAK,iBAAA,EAAmB,GAAG,KACzC,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA,KAAM,MAAA,EAChC;AACA,UAAA,SAAA,KAAc,EAAE,GAAG,IAAA,CAAK,iBAAA,EAAkB;AAC1C,UAAA,OAAO,UAAU,GAAG,CAAA;AAAA,QACtB;AAEA,QAAA;AAAA,MACF;AAEA,MAAA,kBAAA,CAAmB,KAAK,KAAK,CAAA;AAE7B,MAAA,IAAI,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA,KAAM,KAAA,EAAO;AACzC,QAAA,SAAA,KAAc,EAAE,GAAG,IAAA,CAAK,iBAAA,EAAkB;AAC1C,QAAA,SAAA,CAAU,GAAG,CAAA,GAAI,KAAA;AAAA,MACnB;AAAA,IACF;AAEA,IAAA,IAAI,SAAA,EAAW;AACb,MAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA,CAAO,MAAA,CAAO,SAAS,CAAA;AAAA,IAClD;AAAA,EACF;AAAA,EAEA,SAAA,GAAkB;AAChB,IAAA,IAAI;AACF,MAAA,IAAA,CAAK,2BAAA,IAA8B;AACnC,MAAA,IAAA,CAAK,8BAAA,IAAiC;AACtC,MAAA,IAAA,CAAK,IAAA,CAAK,WAAA,CAAY,IAAA,CAAK,iBAAiB,CAAA;AAAA,IAC9C,SAA0F,KAAA,EAAO;AAC/F,MAAA,OAAA,CAAQ,KAAA;AAAA,QACN,0BAAA;AAAA,QACA,wBAAA;AAAA,QACA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AACF,CAAA;;;AC9HA,IAAM,IAAA,GAAO,OAAO,EAAC,CAAA;AAiDd,SAAS,6BAAA,CACd,MAAA,GAAiC,EAAC,EACnB;AACf,EAAA,cAAA,CAAe,MAAM,CAAA;AAGrB,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,MAAA,CAAO,WAAW,CAAA,EAAG;AAChD,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA,EAAG;AAC9D,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,OAAO,CAAC,MAAA,KAAmB;AAEzB,IAAA,IAAI,gBAAA;AAEJ,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AACzB,MAAA,MAAM,UAAkB,EAAC;AAEzB,MAAA,KAAA,MAAW,SAAS,MAAA,EAAQ;AAC1B,QAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,MAAA;AAAA,MACnB;AAEA,MAAA,gBAAA,GAAmB,MAAA,CAAO,OAAO,OAAO,CAAA;AAAA,IAC1C,CAAA,MAAO;AACL,MAAA,gBAAA,GAAmB,MAAA,CAAO,MAAA,CAAO,EAAE,GAAG,QAAQ,CAAA;AAAA,IAChD;AAEA,IAAA,MAAM,gBAAgB,IAAI,GAAA;AAAA,MACxB,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,CAAC,GAAG,MAAM,CAAA,GAAI,MAAA,CAAO,IAAA,CAAK,MAAM;AAAA,KAC1D;AAEA,IAAA,MAAM,GAAA,GAAM,aAAa,MAAM,CAAA;AAC/B,IAAA,MAAM,gBAAA,GAAmB,IAAI,WAAA,EAAY;AAEzC,IAAA,MAAM,SAAS,IAAI,sBAAA;AAAA,MACjB,GAAA;AAAA,MACA,gBAAA;AAAA,MACA,aAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,OAAO,OAAO,SAAA,EAAU;AAAA,EAC1B,CAAA;AACF","file":"index.mjs","sourcesContent":["// packages/persistent-params-plugin/modules/param-utils.ts\n\nimport type { Params } from \"@real-router/core\";\n\n/**\n * Safely extracts own properties from params object.\n * Uses Object.hasOwn to prevent prototype pollution attacks.\n *\n * @param params - Parameters object (may contain inherited properties)\n * @returns New object with only own properties\n *\n * @example\n * const malicious = Object.create({ __proto__: { admin: true } });\n * malicious.mode = 'dev';\n * const safe = extractOwnParams(malicious); // { mode: 'dev' } (no __proto__)\n */\nexport function extractOwnParams(params: Params): Params {\n const result: Params = {};\n\n for (const key in params) {\n /* v8 ignore next -- @preserve: core validates params prototype — inherited keys never reach here */\n if (Object.hasOwn(params, key)) {\n result[key] = params[key];\n }\n }\n\n return result;\n}\n\n/**\n * Merges persistent and current parameters into a single Params object.\n * Keys explicitly set to `undefined` in current params are removed from result.\n *\n * Creates a new immutable object - does not mutate input parameters.\n *\n * @param persistent - Frozen persistent parameters\n * @param current - Current parameters from navigation\n * @returns New Params object with merged values\n *\n * @example\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: 'light', mode: 'dev' };\n * mergeParams(persistent, current); // { lang: 'en', theme: 'light', mode: 'dev' }\n *\n * @example\n * // Removing parameters with undefined\n * const persistent = { lang: 'en', theme: 'dark' };\n * const current = { theme: undefined };\n * mergeParams(persistent, current); // { lang: 'en' } (theme removed)\n */\nexport function mergeParams(\n persistent: Readonly<Params>,\n current: Params,\n): Params {\n // Safely extract own properties from current params\n const safeCurrentParams = extractOwnParams(current);\n\n // Start with persistent params, but EXCLUDE undefined values\n // (undefined values don't appear in URLs, so we shouldn't include them)\n const result: Params = {};\n\n for (const key in persistent) {\n if (Object.hasOwn(persistent, key) && persistent[key] !== undefined) {\n result[key] = persistent[key];\n }\n }\n\n // Apply current params\n for (const key of Object.keys(safeCurrentParams)) {\n const value = safeCurrentParams[key];\n\n if (value === undefined) {\n // Remove param if explicitly set to undefined\n delete result[key];\n } else {\n // Add or update param\n result[key] = value;\n }\n }\n\n return result;\n}\n","// packages/persistent-params-plugin/src/validation.ts\n\nimport { isPrimitiveValue } from \"type-guards\";\n\nimport type { PersistentParamsConfig } from \"./types\";\n\nconst INVALID_PARAM_KEY_REGEX = /[\\s#%&/=?\\\\]/;\nconst INVALID_CHARS_MESSAGE = String.raw`Cannot contain: = & ? # % / \\ or whitespace`;\n\nexport function validateParamKey(key: string): void {\n if (INVALID_PARAM_KEY_REGEX.test(key)) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid parameter name \"${key}\". ${INVALID_CHARS_MESSAGE}`,\n );\n }\n}\n\n/**\n * Validates params configuration structure and values.\n * Ensures all parameter names are non-empty strings and all default values are primitives.\n *\n * @param config - Configuration to validate\n * @returns true if configuration is valid\n */\nexport function isValidParamsConfig(\n config: unknown,\n): config is PersistentParamsConfig {\n if (config === null || config === undefined) {\n return false;\n }\n\n // Array configuration: all items must be non-empty strings\n if (Array.isArray(config)) {\n return config.every((item) => {\n if (typeof item !== \"string\" || item.length === 0) {\n return false;\n }\n\n try {\n validateParamKey(item);\n\n return true;\n } catch {\n return false;\n }\n });\n }\n\n // Object configuration: must be plain object with primitive values\n if (typeof config === \"object\") {\n // Reject non-plain objects (Date, Map, etc.)\n if (Object.getPrototypeOf(config) !== Object.prototype) {\n return false;\n }\n\n // All keys must be non-empty strings, all values must be primitives\n return Object.entries(config).every(([key, value]) => {\n // Check key is non-empty string\n if (typeof key !== \"string\" || key.length === 0) {\n return false;\n }\n\n // Validate key doesn't contain special characters\n try {\n validateParamKey(key);\n } catch {\n return false;\n }\n\n // Validate value is primitive (NaN/Infinity already rejected by isPrimitiveValue)\n return isPrimitiveValue(value);\n });\n }\n\n return false;\n}\n\n/**\n * Validates parameter value before persisting.\n * Throws descriptive TypeError if value is not valid for URL parameters.\n *\n * @param key - Parameter name for error messages\n * @param value - Value to validate\n * @throws {TypeError} If value is null, array, object, or other non-primitive type\n */\nexport function validateParamValue(key: string, value: unknown): void {\n if (value === null) {\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" cannot be null. ` +\n `Use undefined to remove the parameter from persistence.`,\n );\n }\n\n if (value !== undefined && !isPrimitiveValue(value)) {\n const actualType = Array.isArray(value) ? \"array\" : typeof value;\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Parameter \"${key}\" must be a primitive value ` +\n `(string, number, or boolean), got ${actualType}. ` +\n `Objects and arrays are not supported in URL parameters.`,\n );\n }\n}\n\n/**\n * Validates the params configuration and throws a descriptive error if invalid.\n *\n * @param params - Configuration to validate\n * @throws {TypeError} If params is not a valid configuration\n */\nexport function validateConfig(params: unknown): void {\n if (!isValidParamsConfig(params)) {\n let actualType: string;\n\n if (params === null) {\n actualType = \"null\";\n } else if (Array.isArray(params)) {\n actualType = \"array with invalid items\";\n } else {\n actualType = typeof params;\n }\n\n throw new TypeError(\n `[@real-router/persistent-params-plugin] Invalid params configuration. ` +\n `Expected array of non-empty strings or object with primitive values, got ${actualType}.`,\n );\n }\n}\n","// packages/persistent-params-plugin/src/plugin.ts\n\nimport { extractOwnParams, mergeParams } from \"./param-utils\";\nimport { validateParamValue } from \"./validation\";\n\nimport type { Params, PluginApi, State, Plugin } from \"@real-router/core\";\n\nexport class PersistentParamsPlugin {\n readonly #api: PluginApi;\n readonly #paramNamesSet: Set<string>;\n readonly #originalRootPath: string;\n\n #persistentParams: Readonly<Params>;\n #removeBuildPathInterceptor: (() => void) | undefined;\n #removeForwardStateInterceptor: (() => void) | undefined;\n\n constructor(\n api: PluginApi,\n persistentParams: Readonly<Params>,\n paramNamesSet: Set<string>,\n originalRootPath: string,\n ) {\n this.#api = api;\n this.#persistentParams = persistentParams;\n this.#paramNamesSet = paramNamesSet;\n this.#originalRootPath = originalRootPath;\n }\n\n getPlugin(): Plugin {\n try {\n const queryString = [...this.#paramNamesSet].join(\"&\");\n\n this.#api.setRootPath(`${this.#originalRootPath}?${queryString}`);\n } /* v8 ignore start -- @preserve: defensive error wrapping for setRootPath failure */ catch (error) {\n throw new Error(\n `[@real-router/persistent-params-plugin] Failed to update root path: ${error instanceof Error ? error.message : String(error)}`,\n { cause: error },\n );\n } /* v8 ignore stop */\n\n this.#removeBuildPathInterceptor = this.#api.addInterceptor(\n \"buildPath\",\n (next, route, navParams) =>\n next(route, this.#withPersistentParams(navParams ?? {})),\n );\n\n this.#removeForwardStateInterceptor = this.#api.addInterceptor(\n \"forwardState\",\n (next, routeName, routeParams) => {\n const result = next(routeName, routeParams);\n\n return {\n ...result,\n params: this.#withPersistentParams(result.params),\n };\n },\n );\n\n return {\n onTransitionSuccess: (toState) => {\n this.#onTransitionSuccess(toState);\n },\n teardown: () => {\n this.#teardown();\n },\n };\n }\n\n #withPersistentParams(additionalParams: Params): Params {\n const safeParams = extractOwnParams(additionalParams);\n let newParams: Params | undefined;\n\n for (const key of Object.keys(safeParams)) {\n const value = safeParams[key];\n\n if (value === undefined && this.#paramNamesSet.has(key)) {\n this.#paramNamesSet.delete(key);\n newParams ??= { ...this.#persistentParams };\n delete newParams[key];\n } else {\n validateParamValue(key, value);\n }\n }\n\n if (newParams) {\n this.#persistentParams = Object.freeze(newParams);\n }\n\n return mergeParams(this.#persistentParams, safeParams);\n }\n\n #onTransitionSuccess(toState: State): void {\n let newParams: Params | undefined;\n\n for (const key of this.#paramNamesSet) {\n const value = toState.params[key];\n\n if (!Object.hasOwn(toState.params, key) || value === undefined) {\n /* v8 ignore next 4 -- @preserve: defensive removal for states committed via navigateToState bypassing forwardState */\n if (\n Object.hasOwn(this.#persistentParams, key) &&\n this.#persistentParams[key] !== undefined\n ) {\n newParams ??= { ...this.#persistentParams };\n delete newParams[key];\n }\n\n continue;\n }\n\n validateParamValue(key, value);\n\n if (this.#persistentParams[key] !== value) {\n newParams ??= { ...this.#persistentParams };\n newParams[key] = value;\n }\n }\n\n if (newParams) {\n this.#persistentParams = Object.freeze(newParams);\n }\n }\n\n #teardown(): void {\n try {\n this.#removeBuildPathInterceptor?.();\n this.#removeForwardStateInterceptor?.();\n this.#api.setRootPath(this.#originalRootPath);\n } /* v8 ignore start -- @preserve: defensive error logging for teardown failure */ catch (error) {\n console.error(\n \"persistent-params-plugin\",\n \"Error during teardown:\",\n error,\n );\n } /* v8 ignore stop */\n }\n}\n","// packages/persistent-params-plugin/modules/factory.ts\n\nimport { getPluginApi } from \"@real-router/core\";\n\nimport { PersistentParamsPlugin } from \"./plugin\";\nimport { validateConfig } from \"./validation\";\n\nimport type { PersistentParamsConfig } from \"./types\";\nimport type { Params, PluginFactory, Plugin } from \"@real-router/core\";\n\nconst noop = () => ({});\n\n/**\n * Factory for the persistent parameters' plugin.\n *\n * This plugin allows you to specify certain route parameters to be persisted across\n * all navigation transitions. Persisted parameters are automatically merged into\n * route parameters when building paths or states.\n *\n * Key features:\n * - Automatic persistence of query parameters across navigations\n * - Support for default values\n * - Type-safe (only primitives: string, number, boolean)\n * - Immutable internal state\n * - Protection against prototype pollution\n * - Full teardown support (can be safely unsubscribed)\n *\n * If a persisted parameter is explicitly set to `undefined` during navigation,\n * it will be removed from the persisted state and omitted from subsequent URLs.\n *\n * The plugin also adjusts the router's root path to include query parameters for\n * all persistent params, ensuring correct URL construction.\n *\n * @param params - Either an array of parameter names (strings) to persist,\n * or an object mapping parameter names to initial values.\n * If an array, initial values will be `undefined`.\n *\n * @returns A PluginFactory that creates the persistent params plugin instance.\n *\n * @example\n * // Persist parameters without default values\n * router.usePlugin(persistentParamsPlugin(['mode', 'lang']));\n *\n * @example\n * // Persist parameters with default values\n * router.usePlugin(persistentParamsPlugin({ mode: 'dev', lang: 'en' }));\n *\n * @example\n * // Removing a persisted parameter\n * router.navigate('route', { mode: undefined }); // mode will be removed\n *\n * @example\n * // Unsubscribing (full cleanup)\n * const unsubscribe = router.usePlugin(persistentParamsPlugin(['mode']));\n * unsubscribe(); // Restores original router state\n *\n * @throws {TypeError} If params is not a valid array of strings or object with primitives\n * @throws {Error} If plugin is already initialized on this router instance\n */\nexport function persistentParamsPluginFactory(\n params: PersistentParamsConfig = {},\n): PluginFactory {\n validateConfig(params);\n\n // Empty configuration - valid but does nothing\n if (Array.isArray(params) && params.length === 0) {\n return noop;\n }\n\n if (!Array.isArray(params) && Object.keys(params).length === 0) {\n return noop;\n }\n\n return (router): Plugin => {\n // Initialize frozen persistent parameters\n let persistentParams: Readonly<Params>;\n\n if (Array.isArray(params)) {\n const initial: Params = {};\n\n for (const param of params) {\n initial[param] = undefined;\n }\n\n persistentParams = Object.freeze(initial);\n } else {\n persistentParams = Object.freeze({ ...params });\n }\n\n const paramNamesSet = new Set<string>(\n Array.isArray(params) ? [...params] : Object.keys(params),\n );\n\n const api = getPluginApi(router);\n const originalRootPath = api.getRootPath();\n\n const plugin = new PersistentParamsPlugin(\n api,\n persistentParams,\n paramNamesSet,\n originalRootPath,\n );\n\n return plugin.getPlugin();\n };\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"src/types.ts":{"bytes":515,"imports":[],"format":"esm"},"src/
|
|
1
|
+
{"inputs":{"src/types.ts":{"bytes":515,"imports":[],"format":"esm"},"src/param-utils.ts":{"bytes":2555,"imports":[],"format":"esm"},"../type-guards/dist/esm/index.mjs":{"bytes":3451,"imports":[],"format":"esm"},"src/validation.ts":{"bytes":3824,"imports":[{"path":"../type-guards/dist/esm/index.mjs","kind":"import-statement","original":"type-guards"}],"format":"esm"},"src/plugin.ts":{"bytes":4027,"imports":[{"path":"src/param-utils.ts","kind":"import-statement","original":"./param-utils"},{"path":"src/validation.ts","kind":"import-statement","original":"./validation"}],"format":"esm"},"src/factory.ts":{"bytes":3414,"imports":[{"path":"@real-router/core","kind":"import-statement","external":true},{"path":"src/plugin.ts","kind":"import-statement","original":"./plugin"},{"path":"src/validation.ts","kind":"import-statement","original":"./validation"}],"format":"esm"},"src/index.ts":{"bytes":165,"imports":[{"path":"src/types.ts","kind":"import-statement","original":"./types"},{"path":"src/factory.ts","kind":"import-statement","original":"./factory"}],"format":"esm"}},"outputs":{"dist/esm/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":19205},"dist/esm/index.mjs":{"imports":[{"path":"@real-router/core","kind":"import-statement","external":true}],"exports":["PersistentParamsConfig","persistentParamsPluginFactory"],"entryPoint":"src/index.ts","inputs":{"src/factory.ts":{"bytesInOutput":988},"src/param-utils.ts":{"bytesInOutput":679},"../type-guards/dist/esm/index.mjs":{"bytesInOutput":118},"src/validation.ts":{"bytesInOutput":2226},"src/plugin.ts":{"bytesInOutput":3092},"src/index.ts":{"bytesInOutput":0}},"bytes":7507}}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@real-router/persistent-params-plugin",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.36",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"description": "Persist query parameters across route transitions",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -45,10 +45,10 @@
|
|
|
45
45
|
"homepage": "https://github.com/greydragon888/real-router",
|
|
46
46
|
"sideEffects": false,
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@real-router/core": "^0.
|
|
48
|
+
"@real-router/core": "^0.33.0"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"type-guards": "^0.3.
|
|
51
|
+
"type-guards": "^0.3.3"
|
|
52
52
|
},
|
|
53
53
|
"scripts": {
|
|
54
54
|
"test": "vitest",
|
package/src/factory.ts
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
// packages/persistent-params-plugin/modules/factory.ts
|
|
2
|
+
|
|
3
|
+
import { getPluginApi } from "@real-router/core";
|
|
4
|
+
|
|
5
|
+
import { PersistentParamsPlugin } from "./plugin";
|
|
6
|
+
import { validateConfig } from "./validation";
|
|
7
|
+
|
|
8
|
+
import type { PersistentParamsConfig } from "./types";
|
|
9
|
+
import type { Params, PluginFactory, Plugin } from "@real-router/core";
|
|
10
|
+
|
|
11
|
+
const noop = () => ({});
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Factory for the persistent parameters' plugin.
|
|
15
|
+
*
|
|
16
|
+
* This plugin allows you to specify certain route parameters to be persisted across
|
|
17
|
+
* all navigation transitions. Persisted parameters are automatically merged into
|
|
18
|
+
* route parameters when building paths or states.
|
|
19
|
+
*
|
|
20
|
+
* Key features:
|
|
21
|
+
* - Automatic persistence of query parameters across navigations
|
|
22
|
+
* - Support for default values
|
|
23
|
+
* - Type-safe (only primitives: string, number, boolean)
|
|
24
|
+
* - Immutable internal state
|
|
25
|
+
* - Protection against prototype pollution
|
|
26
|
+
* - Full teardown support (can be safely unsubscribed)
|
|
27
|
+
*
|
|
28
|
+
* If a persisted parameter is explicitly set to `undefined` during navigation,
|
|
29
|
+
* it will be removed from the persisted state and omitted from subsequent URLs.
|
|
30
|
+
*
|
|
31
|
+
* The plugin also adjusts the router's root path to include query parameters for
|
|
32
|
+
* all persistent params, ensuring correct URL construction.
|
|
33
|
+
*
|
|
34
|
+
* @param params - Either an array of parameter names (strings) to persist,
|
|
35
|
+
* or an object mapping parameter names to initial values.
|
|
36
|
+
* If an array, initial values will be `undefined`.
|
|
37
|
+
*
|
|
38
|
+
* @returns A PluginFactory that creates the persistent params plugin instance.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* // Persist parameters without default values
|
|
42
|
+
* router.usePlugin(persistentParamsPlugin(['mode', 'lang']));
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* // Persist parameters with default values
|
|
46
|
+
* router.usePlugin(persistentParamsPlugin({ mode: 'dev', lang: 'en' }));
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* // Removing a persisted parameter
|
|
50
|
+
* router.navigate('route', { mode: undefined }); // mode will be removed
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* // Unsubscribing (full cleanup)
|
|
54
|
+
* const unsubscribe = router.usePlugin(persistentParamsPlugin(['mode']));
|
|
55
|
+
* unsubscribe(); // Restores original router state
|
|
56
|
+
*
|
|
57
|
+
* @throws {TypeError} If params is not a valid array of strings or object with primitives
|
|
58
|
+
* @throws {Error} If plugin is already initialized on this router instance
|
|
59
|
+
*/
|
|
60
|
+
export function persistentParamsPluginFactory(
|
|
61
|
+
params: PersistentParamsConfig = {},
|
|
62
|
+
): PluginFactory {
|
|
63
|
+
validateConfig(params);
|
|
64
|
+
|
|
65
|
+
// Empty configuration - valid but does nothing
|
|
66
|
+
if (Array.isArray(params) && params.length === 0) {
|
|
67
|
+
return noop;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
if (!Array.isArray(params) && Object.keys(params).length === 0) {
|
|
71
|
+
return noop;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
return (router): Plugin => {
|
|
75
|
+
// Initialize frozen persistent parameters
|
|
76
|
+
let persistentParams: Readonly<Params>;
|
|
77
|
+
|
|
78
|
+
if (Array.isArray(params)) {
|
|
79
|
+
const initial: Params = {};
|
|
80
|
+
|
|
81
|
+
for (const param of params) {
|
|
82
|
+
initial[param] = undefined;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
persistentParams = Object.freeze(initial);
|
|
86
|
+
} else {
|
|
87
|
+
persistentParams = Object.freeze({ ...params });
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
const paramNamesSet = new Set<string>(
|
|
91
|
+
Array.isArray(params) ? [...params] : Object.keys(params),
|
|
92
|
+
);
|
|
93
|
+
|
|
94
|
+
const api = getPluginApi(router);
|
|
95
|
+
const originalRootPath = api.getRootPath();
|
|
96
|
+
|
|
97
|
+
const plugin = new PersistentParamsPlugin(
|
|
98
|
+
api,
|
|
99
|
+
persistentParams,
|
|
100
|
+
paramNamesSet,
|
|
101
|
+
originalRootPath,
|
|
102
|
+
);
|
|
103
|
+
|
|
104
|
+
return plugin.getPlugin();
|
|
105
|
+
};
|
|
106
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
// packages/persistent-params-plugin/modules/param-utils.ts
|
|
2
|
+
|
|
3
|
+
import type { Params } from "@real-router/core";
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Safely extracts own properties from params object.
|
|
7
|
+
* Uses Object.hasOwn to prevent prototype pollution attacks.
|
|
8
|
+
*
|
|
9
|
+
* @param params - Parameters object (may contain inherited properties)
|
|
10
|
+
* @returns New object with only own properties
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* const malicious = Object.create({ __proto__: { admin: true } });
|
|
14
|
+
* malicious.mode = 'dev';
|
|
15
|
+
* const safe = extractOwnParams(malicious); // { mode: 'dev' } (no __proto__)
|
|
16
|
+
*/
|
|
17
|
+
export function extractOwnParams(params: Params): Params {
|
|
18
|
+
const result: Params = {};
|
|
19
|
+
|
|
20
|
+
for (const key in params) {
|
|
21
|
+
/* v8 ignore next -- @preserve: core validates params prototype — inherited keys never reach here */
|
|
22
|
+
if (Object.hasOwn(params, key)) {
|
|
23
|
+
result[key] = params[key];
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
return result;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Merges persistent and current parameters into a single Params object.
|
|
32
|
+
* Keys explicitly set to `undefined` in current params are removed from result.
|
|
33
|
+
*
|
|
34
|
+
* Creates a new immutable object - does not mutate input parameters.
|
|
35
|
+
*
|
|
36
|
+
* @param persistent - Frozen persistent parameters
|
|
37
|
+
* @param current - Current parameters from navigation
|
|
38
|
+
* @returns New Params object with merged values
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* const persistent = { lang: 'en', theme: 'dark' };
|
|
42
|
+
* const current = { theme: 'light', mode: 'dev' };
|
|
43
|
+
* mergeParams(persistent, current); // { lang: 'en', theme: 'light', mode: 'dev' }
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* // Removing parameters with undefined
|
|
47
|
+
* const persistent = { lang: 'en', theme: 'dark' };
|
|
48
|
+
* const current = { theme: undefined };
|
|
49
|
+
* mergeParams(persistent, current); // { lang: 'en' } (theme removed)
|
|
50
|
+
*/
|
|
51
|
+
export function mergeParams(
|
|
52
|
+
persistent: Readonly<Params>,
|
|
53
|
+
current: Params,
|
|
54
|
+
): Params {
|
|
55
|
+
// Safely extract own properties from current params
|
|
56
|
+
const safeCurrentParams = extractOwnParams(current);
|
|
57
|
+
|
|
58
|
+
// Start with persistent params, but EXCLUDE undefined values
|
|
59
|
+
// (undefined values don't appear in URLs, so we shouldn't include them)
|
|
60
|
+
const result: Params = {};
|
|
61
|
+
|
|
62
|
+
for (const key in persistent) {
|
|
63
|
+
if (Object.hasOwn(persistent, key) && persistent[key] !== undefined) {
|
|
64
|
+
result[key] = persistent[key];
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// Apply current params
|
|
69
|
+
for (const key of Object.keys(safeCurrentParams)) {
|
|
70
|
+
const value = safeCurrentParams[key];
|
|
71
|
+
|
|
72
|
+
if (value === undefined) {
|
|
73
|
+
// Remove param if explicitly set to undefined
|
|
74
|
+
delete result[key];
|
|
75
|
+
} else {
|
|
76
|
+
// Add or update param
|
|
77
|
+
result[key] = value;
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
return result;
|
|
82
|
+
}
|