crelte 0.3.0 → 0.3.2

package/dist/routing/Request.d.ts

@@ -8,6 +8,8 @@ export type RequestOptions = {
     scrollY?: number;
     index?: number;
     origin?: RouteOrigin;
+    state?: Record<string, any>;
+    context?: Record<string, any>;
     disableScroll?: boolean;
     disableLoadData?: boolean;
     statusCode?: number;

package/dist/routing/Request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../../src/routing/Request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,EAAE,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,KAAK;IACzC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,cAAc;IACd,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;gBACS,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAE,cAAmB;IASpE;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,cAAmB;IASxD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,WAAW,IAAI,WAAW;IAI1B;;OAEG;IACH,KAAK;IAUL;;OAEG;IACH,OAAO;IAQP,cAAc;IACd,WAAW,CAAC,IAAI,GAAE,cAAmB;CAOrC;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,OAAO,CAElD;AAED,cAAM,aAAa;IAClB,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;;IAQlB,MAAM,IAAI,OAAO;IAIjB,GAAG,IAAI,WAAW;IAclB,cAAc;IACd,MAAM;IAQN,cAAc;IACd,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;CAGzB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC"}
+{"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../../src/routing/Request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,EAAE,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,KAAK;IACzC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,cAAc;IACd,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;gBACS,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAE,cAAmB;IASpE;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,cAAmB;IAWxD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,WAAW,IAAI,WAAW;IAI1B;;OAEG;IACH,KAAK;IAYL;;OAEG;IACH,OAAO;IAUP,cAAc;IACd,WAAW,CAAC,IAAI,GAAE,cAAmB;CASrC;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,OAAO,CAElD;AAED,cAAM,aAAa;IAClB,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;;IAQlB,MAAM,IAAI,OAAO;IAIjB,GAAG,IAAI,WAAW;IAclB,cAAc;IACd,MAAM;IAQN,cAAc;IACd,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;CAGzB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC"}

package/dist/routing/Request.js

@@ -1,5 +1,6 @@
 import { Barrier } from 'crelte-std/sync';
 import Route from './Route.js';
+import { objClone } from '../utils.js';
 /**
  * A Request is a Route with some extra options
  * you get a Request from the onRequest event or
@@ -40,6 +41,8 @@ export default class Request extends Route {
             scrollY: route.scrollY ?? undefined,
             index: route.index,
             origin: route.origin,
+            state: route._state,
+            context: route._context,
             ...opts,
         });
     }
@@ -82,6 +85,8 @@ export default class Request extends Route {
             scrollY: this.scrollY ?? undefined,
             index: this.index,
             origin: this.origin,
+            state: objClone(this._state),
+            context: this._context,
             disableScroll: this.disableScroll,
             statusCode: this.statusCode ?? undefined,
         });
@@ -94,6 +99,8 @@ export default class Request extends Route {
             scrollY: this.scrollY ?? undefined,
             index: this.index,
             origin: this.origin,
+            state: objClone(this._state),
+            context: this._context,
         });
     }
     /** @hidden */
@@ -101,6 +108,8 @@ export default class Request extends Route {
         this.scrollY = opts.scrollY ?? this.scrollY;
         this.index = opts.index ?? this.index;
         this.origin = opts.origin ?? this.origin;
+        this._state = opts.state ?? this._state;
+        this._context = opts.context ?? this._context;
         this.disableScroll = opts.disableScroll ?? this.disableScroll;
         this.statusCode = opts.statusCode ?? this.statusCode;
     }

package/dist/routing/Route.d.ts

@@ -3,6 +3,8 @@ export type RouteOptions = {
     scrollY?: number;
     index?: number;
     origin?: RouteOrigin;
+    state?: Record<string, any>;
+    context?: Record<string, any>;
 };
 /**
  * RouteOrigin represents the origin of a route.
@@ -59,6 +61,23 @@ export default class Route {
      * The origin of this route, See [[RouteOrigin]]
      */
     origin: RouteOrigin;
+    /**
+     * @hidden
+     * State data that can be used to store additional information
+     */
+    _state: Record<string, any>;
+    /**
+     * @hidden
+     * Any data that should be passed to onRoute and onRequest handlers
+     * or exchanged between loadData's
+     * This context is not persistant and should be considered "valid"
+     * only for the current request / route
+     *
+     * ## Note
+     * Consider using state instead. This will not be cloned in the clone
+     * call so will always be the same object
+     */
+    _context: Record<string, any>;
     /**
      * Creates a new Route
      */
@@ -120,6 +139,17 @@ export default class Route {
      * ```
      */
     get hash(): string;
+    /**
+     * Set the hash of the route
+     *
+     * ## Example
+     * ```
+     * const route = new Route('https://example.com/foo/bar/', null);
+     * route.hash = '#hash';
+     * console.log(route.url.href); // 'https://example.com/foo/bar/#hash'
+     * ```
+     */
+    set hash(hash: string);
     /**
      * Checks if there are previous routes which would allow it to go back
      */
@@ -135,7 +165,8 @@ export default class Route {
      */
     getSearchParam(key: string): string | null;
     /**
-     * Sets the search param or removes it if the value is null or undefined
+     * Sets the search param or removes it if the value is null, undefined or an
+     * empty string
      *
      * ## Example
      * ```
@@ -148,6 +179,38 @@ export default class Route {
      * ```
      */
     setSearchParam(key: string, value?: string | number | null): void;
+    /**
+     * Returns a state value if it exists.
+     */
+    getState<T = any>(key: string): T | null;
+    /**
+     * Sets a state value.
+     * If the value is null or undefined, the key will be removed.
+     *
+     * ## When to use state
+     * State is used to store additional information that persists across route changes.
+     * The State is only available in the client code since it is stored using window.history.
+     *
+     * Consider using setSearchParam instead to enable server side rendering.
+     */
+    setState<T>(key: string, value: T | null | undefined): void;
+    /**
+     * Returns a context value if it exists.
+     */
+    getContext<T = any>(key: string): T | null;
+    /**
+     * Sets a context value.
+     * If the value is null or undefined, the key will be removed.
+     *
+     * ## When to use context
+     * Context is used to pass data to onRoute and onRequest handlers or exchange data between loadData calls.
+     * This context is not persistent and should be considered valid only for the current request/route.
+     * The context is not cloned in the clone call and will be the same object.
+     */
+    setContext<T>(key: string, value: T | null | undefined): void;
+    /**
+     * Returns true if the route is in live preview mode
+     */
     inLivePreview(): boolean;
     /**
      * Returns if the site matches the url
@@ -158,6 +221,9 @@ export default class Route {
      *
      * This checks all properties of the url but search params do not have to be
      * in the same order
+     *
+     * ## Note
+     * This does not check the state or context
      */
     eq(route: Route | null): boolean | null;
     /**

package/dist/routing/Route.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../../../../src/routing/Route.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,GACpB,MAAM,GACN,QAAQ,GACR,OAAO,GACP,KAAK,GACL,SAAS,GACT,MAAM,CAAC;AAEV;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACzB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;;;;;;;OASG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;;;;;OASG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;OAEG;gBACS,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAE,YAAiB;IASlE;;;;;;;;;;;;;;;OAeG;IACH,IAAI,GAAG,IAAI,MAAM,CAQhB;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,OAAO,IAAI,MAAM,CAIpB;IAED;;;;;;;;;;;OAWG;IACH,IAAI,MAAM,IAAI,eAAe,CAE5B;IAED;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAI1C;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAQ1D,aAAa,IAAI,OAAO;IAIxB;;OAEG;IACH,WAAW,IAAI,OAAO;IAatB;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAStB;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAQzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAkB5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAI1B;;OAEG;IACH,KAAK;IAQL,cAAc;IACd,cAAc,CAAC,KAAK,EAAE,GAAG;IAQzB,cAAc;IACd,QAAQ,IAAI,GAAG;CAQf"}
+{"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../../../../src/routing/Route.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,GACpB,MAAM,GACN,QAAQ,GACR,OAAO,GACP,KAAK,GACL,SAAS,GACT,MAAM,CAAC;AAEV;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACzB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IAET;;;;;;;;;OASG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;;;;;OASG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE5B;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE9B;;OAEG;gBACS,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAE,YAAiB;IAWlE;;;;;;;;;;;;;;;OAeG;IACH,IAAI,GAAG,IAAI,MAAM,CAQhB;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,OAAO,IAAI,MAAM,CAIpB;IAED;;;;;;;;;;;OAWG;IACH,IAAI,MAAM,IAAI,eAAe,CAE5B;IAED;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;;;;;OASG;IACH,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EAEpB;IAED;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAI1C;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAa1D;;OAEG;IACH,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAIxC;;;;;;;;;OASG;IACH,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS;IAQpD;;OAEG;IACH,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAI1C;;;;;;;;OAQG;IACH,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS;IAOtD;;OAEG;IACH,aAAa,IAAI,OAAO;IAIxB;;OAEG;IACH,WAAW,IAAI,OAAO;IAatB;;;;;;;;OAQG;IACH,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAStB;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAQzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAkB5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAI1B;;OAEG;IACH,KAAK;IAUL,cAAc;IACd,cAAc,CAAC,KAAK,EAAE,GAAG;IAYzB,cAAc;IACd,QAAQ,IAAI,GAAG;CASf"}

package/dist/routing/Route.js

@@ -1,3 +1,4 @@
+import { objClone } from '../utils.js';
 import { trimSlashEnd } from './utils.js';
 /**
  * A Route contains information about the current page for example the url and
@@ -39,6 +40,23 @@ export default class Route {
      * The origin of this route, See [[RouteOrigin]]
      */
     origin;
+    /**
+     * @hidden
+     * State data that can be used to store additional information
+     */
+    _state;
+    /**
+     * @hidden
+     * Any data that should be passed to onRoute and onRequest handlers
+     * or exchanged between loadData's
+     * This context is not persistant and should be considered "valid"
+     * only for the current request / route
+     *
+     * ## Note
+     * Consider using state instead. This will not be cloned in the clone
+     * call so will always be the same object
+     */
+    _context;
     /**
      * Creates a new Route
      */
@@ -48,6 +66,8 @@ export default class Route {
         this.scrollY = opts.scrollY ?? null;
         this.index = opts.index ?? 0;
         this.origin = opts.origin ?? 'manual';
+        this._state = opts.state ?? {};
+        this._context = opts.context ?? {};
     }
     /**
      * Returns the uri of the route
@@ -119,6 +139,19 @@ export default class Route {
     get hash() {
         return this.url.hash;
     }
+    /**
+     * Set the hash of the route
+     *
+     * ## Example
+     * ```
+     * const route = new Route('https://example.com/foo/bar/', null);
+     * route.hash = '#hash';
+     * console.log(route.url.href); // 'https://example.com/foo/bar/#hash'
+     * ```
+     */
+    set hash(hash) {
+        this.url.hash = hash;
+    }
     /**
      * Checks if there are previous routes which would allow it to go back
      */
@@ -138,7 +171,8 @@ export default class Route {
         return this.search.get(key);
     }
     /**
-     * Sets the search param or removes it if the value is null or undefined
+     * Sets the search param or removes it if the value is null, undefined or an
+     * empty string
      *
      * ## Example
      * ```
@@ -151,13 +185,66 @@ export default class Route {
      * ```
      */
     setSearchParam(key, value) {
-        if (typeof value !== 'undefined' && value !== null) {
+        const deleteValue = typeof value === 'undefined' ||
+            value === null ||
+            (typeof value === 'string' && value === '');
+        if (!deleteValue) {
             this.search.set(key, value);
         }
         else {
             this.search.delete(key);
         }
     }
+    /**
+     * Returns a state value if it exists.
+     */
+    getState(key) {
+        return this._state[key] ?? null;
+    }
+    /**
+     * Sets a state value.
+     * If the value is null or undefined, the key will be removed.
+     *
+     * ## When to use state
+     * State is used to store additional information that persists across route changes.
+     * The State is only available in the client code since it is stored using window.history.
+     *
+     * Consider using setSearchParam instead to enable server side rendering.
+     */
+    setState(key, value) {
+        if (typeof value === 'undefined' || value === null) {
+            delete this._state[key];
+        }
+        else {
+            this._state[key] = value;
+        }
+    }
+    /**
+     * Returns a context value if it exists.
+     */
+    getContext(key) {
+        return this._context[key] ?? null;
+    }
+    /**
+     * Sets a context value.
+     * If the value is null or undefined, the key will be removed.
+     *
+     * ## When to use context
+     * Context is used to pass data to onRoute and onRequest handlers or exchange data between loadData calls.
+     * This context is not persistent and should be considered valid only for the current request/route.
+     * The context is not cloned in the clone call and will be the same object.
+     */
+    setContext(key, value) {
+        if (typeof value === 'undefined' || value === null) {
+            delete this._context[key];
+        }
+        else {
+            this._context[key] = value;
+        }
+    }
+    /**
+     * Returns true if the route is in live preview mode
+     */
     inLivePreview() {
         return !!this.search.get('x-craft-live-preview');
     }
@@ -179,6 +266,9 @@ export default class Route {
      *
      * This checks all properties of the url but search params do not have to be
      * in the same order
+     *
+     * ## Note
+     * This does not check the state or context
      */
     eq(route) {
         return (route &&
@@ -227,6 +317,8 @@ export default class Route {
             scrollY: this.scrollY ?? undefined,
             index: this.index,
             origin: this.origin,
+            state: objClone(this._state),
+            context: this._context,
         });
     }
     /** @hidden */
@@ -235,6 +327,9 @@ export default class Route {
             this.scrollY = state.route.scrollY;
         if (typeof state?.route?.index === 'number')
             this.index = state.route.index;
+        if (typeof state?.state === 'object' && state.state !== null) {
+            this._state = state.state;
+        }
     }
     /** @hidden */
     _toState() {
@@ -243,6 +338,7 @@ export default class Route {
                 scrollY: this.scrollY,
                 index: this.index,
             },
+            state: this._state,
         };
     }
 }

package/dist/routing/Router.d.ts

@@ -7,6 +7,17 @@ export type RouterOptions = {
     preloadOnMouseOver?: boolean;
     debugTiming?: boolean;
 };
+/**
+ * Allows to easely modify a Request
+ *
+ * If you return `false` the request will be aborted
+ *
+ * ## Example
+ * ```
+ * router.replace(req => (req.hash = ''));
+ * ```
+ */
+export type UpdateRequest = (req: Request) => boolean | null | undefined | void;
 /**
  * internal only
  */
@@ -106,19 +117,29 @@ export default class Router {
      * // the following page will be opened https://example.com/de/foo/bar
      * ```
      */
-    open(target: string | URL | Route | Request, opts?: RequestOptions): void;
+    open(target: string | URL | Route | Request | UpdateRequest, opts?: RequestOptions): void;
     /**
      * This pushes the new route without triggering a new pageload
      *
      * You can use this when using pagination for example change the route object
-     * (search argument) and then call pushState
+     * (search argument) and then call push
      *
      * ## Note
      * This will always set the origin to 'push'
      * And will clear the scrollY value if you not provide a new one via the `opts`
      * This will disableLoadData by default if you not provide an override via the `opts`
      *
-     * ## Example
+     * ## Example using the update function
+     * ```
+     * import { getRouter } from 'crelte';
+     *
+     * const router = getRouter();
+     *
+     * const page = 1;
+     * router.push(req => req.setSearchParam('page', page || null));
+     * ```
+     *
+     * ## Example using the route object
      * ```
      * import { getRouter } from 'crelte';
      *
@@ -127,25 +148,35 @@ export default class Router {
      * const page = 1;
      * const route = router.route.get();
      * route.setSearchParam('page', page > 0 ? page : null);
-     * router.pushState(route);
+     * router.push(route);
      * ```
      */
-    push(route: Route | Request, opts?: RequestOptions): void;
+    push(route: Route | Request | UpdateRequest, opts?: RequestOptions): void;
     /**
      * @deprecated use push instead
      */
     pushState(route: Route | Request): void;
     /**
-     * This replaces the state of the route without triggering an event
+     * This replaces the state of the route without triggering a new pageload
      *
      * You can use this when using some filters for example a search filter
      *
      * ## Note
      * This will always set the origin to 'replace'
-     * And will clear the scrollY value if you not provide a new one via the `opts`
-     * This will disableLoadData by default if you not provide an override via the `opts`
+     * And will clear the scrollY value if you don't provide a new one via the `opts`
+     * This will disableLoadData by default if you don't provide an override via the `opts`
      *
-     * ## Example
+     * ## Example using the update function
+     * ```
+     * import { getRouter } from 'crelte';
+     *
+     * const router = getRouter();
+     *
+     * const search = 'foo';
+     * router.replace(req => req.setSearchParam('search', search));
+     * ```
+     *
+     * ## Example using the route object
      * ```
      * import { getRouter } from 'crelte';
      *
@@ -153,11 +184,11 @@ export default class Router {
      *
      * const search = 'foo';
      * const route = router.route.get();
-     * route.setSearchParam('search', search ? search : null);
-     * router.replaceState(route);
+     * route.setSearchParam('search', search);
+     * router.replace(route);
      * ```
      */
-    replace(route: Route | Request, opts?: RequestOptions): void;
+    replace(route: Route | Request | UpdateRequest, opts?: RequestOptions): void;
     /**
      * @deprecated use replace instead
      */
@@ -209,6 +240,12 @@ export default class Router {
     private _onLoaded;
     private _onNothingLoaded;
     private _onProgress;
+    /**
+     * Transforms a target to a request
+     *
+     * returns null if the request was canceled by the update request
+     */
+    private targetOrUpdateToRequest;
 }
 export {};
 //# sourceMappingURL=Router.d.ts.map

package/dist/routing/Router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Router.d.ts","sourceRoot":"","sources":["../../../../src/routing/Router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAElD,OAAmB,EAAE,MAAM,EAAgB,MAAM,iBAAiB,CAAC;AAEnE,OAAO,EAAE,QAAQ,EAAY,MAAM,mBAAmB,CAAC;AAEvD,OAAO,OAAO,EAAE,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEvD,MAAM,MAAM,aAAa,GAAG;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAWF;;GAEG;AACH,KAAK,QAAQ,GAAG;IACf,QAAQ,EAAE,CACT,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,OAAO,EAKZ,KAAK,EAAE,MAAM,GAAG,KACZ,IAAI,CAAC;IAIV,eAAe,EAAE,CAChB,GAAG,EAAE,OAAO,EAKZ,KAAK,EAAE,MAAM,IAAI,KACb,IAAI,CAAC;IAEV,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IAEjC,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACxE,CAAC;AAEF,KAAK,YAAY,GAAG;IACnB,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,GAAG,CAAC;CACX,CAAC;AAGF,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAyB;IAEvC;;;;;OAKG;IACH,OAAO,CAAC,KAAK,CAAwB;IAGrC,OAAO,CAAC,QAAQ,CAAiB;IAEjC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAoB;IAEpC;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,OAAO,CAAC,UAAU,CAAuB;IAEzC,cAAc;IACd,SAAS,EAAE,QAAQ,CAAC;IAEpB,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,UAAU,CAAyB;gBAE/B,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,GAAE,aAAkB;IAwC9D;;;;;;;OAOG;IACH,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,CAElC;IAED;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,CAEhC;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,IAAI,EAAE,CAElB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAE/B;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,QAAQ,CAAC,MAAM,CAAC,CAEtC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,EAAE,IAAI,GAAE,cAAmB;IAQtE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,GAAE,cAAmB;IActD;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAKhC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,GAAE,cAAmB;IAazD;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAKnC;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK;IAIpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM,IAAI;IAK/C;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI;IAIjD;;;;;;OAMG;IACH,eAAe,CACd,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,EACtC,IAAI,GAAE,cAAmB,GACvB,OAAO;IAIV,OAAO,CAAC,WAAW;YAQL,WAAW;YAIX,WAAW;IA4DzB,OAAO,CAAC,QAAQ;IAoBhB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,UAAU;YAIJ,SAAS;YAsBT,gBAAgB;IAkB9B,OAAO,CAAC,WAAW;CAKnB"}
+{"version":3,"file":"Router.d.ts","sourceRoot":"","sources":["../../../../src/routing/Router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAElD,OAAmB,EAAE,MAAM,EAAgB,MAAM,iBAAiB,CAAC;AAEnE,OAAO,EAAE,QAAQ,EAAY,MAAM,mBAAmB,CAAC;AAEvD,OAAO,OAAO,EAAE,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEvD,MAAM,MAAM,aAAa,GAAG;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAOF;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC;AAMhF;;GAEG;AACH,KAAK,QAAQ,GAAG;IACf,QAAQ,EAAE,CACT,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,OAAO,EAKZ,KAAK,EAAE,MAAM,GAAG,KACZ,IAAI,CAAC;IAIV,eAAe,EAAE,CAChB,GAAG,EAAE,OAAO,EAKZ,KAAK,EAAE,MAAM,IAAI,KACb,IAAI,CAAC;IAEV,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IAEjC,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACxE,CAAC;AAEF,KAAK,YAAY,GAAG;IACnB,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,GAAG,CAAC;CACX,CAAC;AAGF,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAyB;IAEvC;;;;;OAKG;IACH,OAAO,CAAC,KAAK,CAAwB;IAGrC,OAAO,CAAC,QAAQ,CAAiB;IAEjC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAoB;IAEpC;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,OAAO,CAAC,UAAU,CAAuB;IAEzC,cAAc;IACd,SAAS,EAAE,QAAQ,CAAC;IAEpB,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,UAAU,CAAyB;gBAE/B,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,GAAE,aAAkB;IA0C9D;;;;;;;OAOG;IACH,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,CAElC;IAED;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,CAEhC;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,IAAI,EAAE,CAElB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAE/B;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,QAAQ,CAAC,MAAM,CAAC,CAEtC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACH,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,GAAG,aAAa,EACtD,IAAI,GAAE,cAAmB;IAU1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,aAAa,EAAE,IAAI,GAAE,cAAmB;IAatE;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAKhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,aAAa,EAAE,IAAI,GAAE,cAAmB;IAazE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAKnC;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK;IAIpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM,IAAI;IAK/C;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI;IAIjD;;;;;;OAMG;IACH,eAAe,CACd,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,EACtC,IAAI,GAAE,cAAmB,GACvB,OAAO;IAIV,OAAO,CAAC,WAAW;YAQL,WAAW;YAIX,WAAW;IA8DzB,OAAO,CAAC,QAAQ;IAqBhB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,UAAU;YAKJ,SAAS;YAuBT,gBAAgB;IAmB9B,OAAO,CAAC,WAAW;IAMnB;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;CA8B/B"}