crelte 0.2.2 → 0.3.1

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
      */
@@ -135,7 +154,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 +168,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 +210,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;;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
@@ -138,7 +158,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 +172,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 +253,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 +304,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 +314,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 +325,7 @@ export default class Route {
                 scrollY: this.scrollY,
                 index: this.index,
             },
+            state: this._state,
         };
     }
 }

package/dist/routing/Router.d.ts

@@ -27,10 +27,16 @@ type ServerInited = {
 export default class Router {
     /**
      * The current route
+     *
+     * ## Note
+     * Will always contain a route expect in the first loadData call
      */
     private _route;
     /**
      * The current site
+     *
+     * ## Note
+     * Will always contain a site expect in the first loadData call
      */
     private _site;
     private _request;
@@ -51,12 +57,22 @@ export default class Router {
     constructor(sites: SiteFromGraphQl[], opts?: RouterOptions);
     /**
      * returns a store with the current route
+     *
+     * ## Note
+     * Will always contain a route expect in the first loadData call
+     *
+     * Consider to use CrelteRequest instead
      */
-    get route(): Readable<Route>;
+    get route(): Readable<Route | null>;
     /**
      * returns a store with the current site
+     *
+     * ## Note
+     * Will always contain a site expect in the first loadData call
+     *
+     * Consider to use CrelteRequest instead
      */
-    get site(): Readable<Site>;
+    get site(): Readable<Site | null>;
     /**
      * The sites which are available
      */
@@ -95,7 +111,7 @@ export default class Router {
      * 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'
@@ -111,7 +127,7 @@ 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;
@@ -163,6 +179,7 @@ export default class Router {
      *
      * This will trigger every time a new route is set
      * and is equivalent to router.route.subscribe(fn)
+     * expect that it will not trigger instantly
      *
      * @returns a function to remove the listener
      */
@@ -175,6 +192,14 @@ export default class Router {
      * @returns a function to remove the listener
      */
     onRequest(fn: (req: Request) => void): () => void;
+    /**
+     * Resolve a url or Route and convert it to a Request
+     *
+     * @param target
+     * @param opts, any option present will override the value in target
+     * @return Returns null if the url does not match our host (the protocol get's ignored)
+     */
+    targetToRequest(target: string | URL | Route | Request, opts?: RequestOptions): Request;
     private setNewRoute;
     private _initClient;
     private _initServer;

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;;OAEG;IACH,OAAO,CAAC,MAAM,CAAkB;IAEhC;;OAEG;IACH,OAAO,CAAC,KAAK,CAAiB;IAG9B,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;;OAEG;IACH,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAEzB;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;IAIhC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,GAAE,cAAmB;IAazD;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAInC;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK;IAIpC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,MAAM,IAAI;IAI/C;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI;IAIjD,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;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;IAYtD;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAKhC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,GAAE,cAAmB;IAWzD;;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;IA6DzB,OAAO,CAAC,QAAQ;IAoBhB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,UAAU;YAIJ,SAAS;YAsBT,gBAAgB;IAkB9B,OAAO,CAAC,WAAW;CAKnB"}

package/dist/routing/Router.js

@@ -11,10 +11,16 @@ const defaultRouterOpts = {
 export default class Router {
     /**
      * The current route
+     *
+     * ## Note
+     * Will always contain a route expect in the first loadData call
      */
     _route;
     /**
      * The current site
+     *
+     * ## Note
+     * Will always contain a site expect in the first loadData call
      */
     _site;
     // the next request, just here to destroy it
@@ -64,12 +70,22 @@ export default class Router {
     }
     /**
      * returns a store with the current route
+     *
+     * ## Note
+     * Will always contain a route expect in the first loadData call
+     *
+     * Consider to use CrelteRequest instead
      */
     get route() {
         return this._route.readclone();
     }
     /**
      * returns a store with the current site
+     *
+     * ## Note
+     * Will always contain a site expect in the first loadData call
+     *
+     * Consider to use CrelteRequest instead
      */
     get site() {
         return this._site.readonly();
@@ -124,7 +140,7 @@ export default class Router {
      * 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'
@@ -140,7 +156,7 @@ 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, opts = {}) {
@@ -153,13 +169,12 @@ export default class Router {
             disableLoadData: opts.disableLoadData ?? true,
         });
         this.inner.push(req);
-        this.destroyRequest();
-        this.setNewRoute(route);
     }
     /**
      * @deprecated use push instead
      */
     pushState(route) {
+        console.warn('pushState is deprecated, use push instead');
         this.push(route);
     }
     /**
@@ -193,13 +208,12 @@ export default class Router {
             disableLoadData: opts.disableLoadData ?? true,
         });
         this.inner.replace(req);
-        this.destroyRequest();
-        this.setNewRoute(req);
     }
     /**
      * @deprecated use replace instead
      */
     replaceState(route) {
+        console.warn('replaceState is deprecated, use replace instead');
         this.replace(route);
     }
     /**
@@ -225,11 +239,13 @@ export default class Router {
      *
      * This will trigger every time a new route is set
      * and is equivalent to router.route.subscribe(fn)
+     * expect that it will not trigger instantly
      *
      * @returns a function to remove the listener
      */
     onRoute(fn) {
-        return this.route.subscribe(fn);
+        let first = true;
+        return this.route.subscribe(r => (first ? (first = false) : fn(r)));
     }
     /**
      * Add a listener for the onRequest event
@@ -241,6 +257,16 @@ export default class Router {
     onRequest(fn) {
         return this._onRequest.add(fn);
     }
+    /**
+     * Resolve a url or Route and convert it to a Request
+     *
+     * @param target
+     * @param opts, any option present will override the value in target
+     * @return Returns null if the url does not match our host (the protocol get's ignored)
+     */
+    targetToRequest(target, opts = {}) {
+        return this.inner.targetToRequest(target, opts);
+    }
     setNewRoute(route) {
         this._route.setSilent(route);
         const siteChanged = this.site.get()?.id !== route.site.id;
@@ -269,11 +295,11 @@ export default class Router {
                 });
             };
         });
-        const route = this.inner.targetToRequest(url);
-        route.origin = 'init';
+        const req = this.inner.targetToRequest(url);
+        req.origin = 'init';
         // let's see if the url matches any route and site
         // if not let's redirect to the site which matches the acceptLang
-        if (!route.siteMatches()) {
+        if (!req.siteMatches()) {
             const site = this.inner.siteByAcceptLang(acceptLang);
             return {
                 success: true,
@@ -282,12 +308,13 @@ export default class Router {
                 props: {},
             };
         }
-        this.inner.setRoute(route);
+        this.inner.route = req.toRoute();
+        this.inner.onRoute(req, () => { });
         const resp = await prom;
         const hist = this.inner.history;
         if (hist.url || hist.req) {
             const nReq = this.inner.targetToRequest(hist.req ?? hist.url);
-            if (!route.eq(nReq)) {
+            if (!req.eq(nReq)) {
                 return {
                     success: true,
                     redirect: true,

package/dist/ssr/SsrCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SsrCache.d.ts","sourceRoot":"","sources":["../../../../src/ssr/SsrCache.ts"],"names":[],"mappings":"AAAA,wBAAsB,OAAO,CAAC,IAAI,EAAE,GAAG,mBAetC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B,OAAO,CAAC,KAAK,CAAsB;;IAYnC;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAO/C;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAI7B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;IAI9B,cAAc;IACd,KAAK;IAIL,OAAO,CAAC,YAAY;IAIpB,cAAc;IACd,aAAa,IAAI,MAAM;CAGvB"}
+{"version":3,"file":"SsrCache.d.ts","sourceRoot":"","sources":["../../../../src/ssr/SsrCache.ts"],"names":[],"mappings":"AAAA,wBAAsB,OAAO,CAAC,IAAI,EAAE,GAAG,mBAoBtC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B,OAAO,CAAC,KAAK,CAAsB;;IAYnC;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAO/C;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAI7B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC;IAI9B,cAAc;IACd,KAAK;IAIL,OAAO,CAAC,YAAY;IAIpB,cAAc;IACd,aAAa,IAAI,MAAM;CAGvB"}

package/dist/ssr/SsrCache.js

@@ -1,7 +1,12 @@
 export async function calcKey(data) {
+    const json = JSON.stringify(data);
+    // this should only happen in an unsecure context
+    // specifically in the craft preview locally
+    if (!crypto?.subtle)
+        return json;
     // Convert the string data to an ArrayBuffer
     const encoder = new TextEncoder();
-    const dataBuffer = encoder.encode(JSON.stringify(data));
+    const dataBuffer = encoder.encode(json);
     // Use the Web Crypto API to hash the data with SHA-1
     const hashBuffer = await crypto.subtle.digest('SHA-1', dataBuffer);
     // Convert the ArrayBuffer to a hex string

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function objClone(obj: any): any;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils.ts"],"names":[],"mappings":"AAGA,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAMtC"}

package/dist/utils.js

@@ -0,0 +1,8 @@
+// This are internal utils. Consider adding them to crelte-std instead
+// this tries to do a structuredClone and else just uses JSON
+export function objClone(obj) {
+    if (typeof structuredClone === 'function') {
+        return structuredClone(obj);
+    }
+    return JSON.parse(JSON.stringify(obj));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "crelte",
-	"version": "0.2.2",
+	"version": "0.3.1",
 	"author": "Crelte <support@crelte.com>",
 	"type": "module",
 	"scripts": {
@@ -70,7 +70,7 @@
 		}
 	},
 	"dependencies": {
-		"crelte-std": "^0.1.0",
+		"crelte-std": "^0.1.1",
 		"svelte": "^4.2.12"
 	},
 	"devDependencies": {