crelte 0.1.0 → 0.1.2

package/dist/plugins/Plugins.d.ts

@@ -1,11 +1,37 @@
-import Crelte from '../Crelte.js';
+import CrelteCore from '../Crelte.js';
+/**
+ * A plugin
+ */
 export interface Plugin {
     name: string;
 }
-export type PluginCreator = (crelte: Crelte) => Plugin;
+/**
+ * A plugin create function
+ *
+ * Each plugin needs to export a createPluginname function which will be called
+ * by crelte to create the plugin. If youre plugin has options you can create
+ * a configurePluginname function which will be called by youre user and should
+ * return a createPlugin function.
+ *
+ * ## Example App.svelte in module="context"
+ * ```
+ * import { createPlugin, configurePlugin } from 'some-plugin';
+ *
+ * export plugins = [createPlugin, configurePlugin({ enableFeature: true })];
+ * ```
+ */
+export type PluginCreator = (crelte: CrelteCore) => Plugin;
+/**
+ * A plugin manager
+ */
 export default class Plugins {
     plugins: Map<string, Plugin>;
     constructor();
+    /**
+     * @hidden
+     *
+     * Plugins should be added via App.svelte plugins export
+     */
     add(plugin: Plugin): void;
     get(name: string): Plugin | null;
 }

package/dist/plugins/Plugins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Plugins.d.ts","sourceRoot":"","sources":["../../../../src/plugins/Plugins.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,cAAc,CAAC;AAElC,MAAM,WAAW,MAAM;IACtB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;AAEvD,MAAM,CAAC,OAAO,OAAO,OAAO;IAC3B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;;IAM7B,GAAG,CAAC,MAAM,EAAE,MAAM;IAIlB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;CAGhC"}
+{"version":3,"file":"Plugins.d.ts","sourceRoot":"","sources":["../../../../src/plugins/Plugins.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,MAAM;IACtB,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,MAAM,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAC3B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;;IAM7B;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM;IAIlB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;CAGhC"}

package/dist/plugins/Plugins.js

@@ -1,8 +1,16 @@
+/**
+ * A plugin manager
+ */
 export default class Plugins {
     plugins;
     constructor() {
         this.plugins = new Map();
     }
+    /**
+     * @hidden
+     *
+     * Plugins should be added via App.svelte plugins export
+     */
     add(plugin) {
         this.plugins.set(plugin.name, plugin);
     }

package/dist/routing/History.d.ts

@@ -1,22 +1,25 @@
 export default interface History {
-    scrollY(): number;
+    scrollY(): number | null;
     replaceState(data: any, url?: string): void;
     pushState(data: any, url: string): void;
     open(url: string): void;
+    back(): void;
 }
 export declare class ClientHistory implements History {
-    scrollY(): number;
+    scrollY(): number | null;
     replaceState(data: any, url?: string): void;
     pushState(data: any, url: string): void;
     open(url: string): void;
+    back(): void;
 }
 export declare class ServerHistory implements History {
     state: any | null;
     url: string | null;
     constructor();
-    scrollY(): number;
+    scrollY(): number | null;
     replaceState(data: any, url?: string): void;
     pushState(data: any, url: string): void;
     open(url: string): void;
+    back(): void;
 }
 //# sourceMappingURL=History.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"History.d.ts","sourceRoot":"","sources":["../../../../src/routing/History.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,OAAO;IAC/B,OAAO,IAAI,MAAM,CAAC;IAClB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,qBAAa,aAAc,YAAW,OAAO;IAC5C,OAAO,IAAI,MAAM;IAIjB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAI3C,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAIvC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAGvB;AAED,qBAAa,aAAc,YAAW,OAAO;IAC5C,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;IAClB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;;IAOnB,OAAO,IAAI,MAAM;IAIjB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAK3C,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAKvC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAGvB"}
+{"version":3,"file":"History.d.ts","sourceRoot":"","sources":["../../../../src/routing/History.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,OAAO;IAC/B,OAAO,IAAI,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,IAAI,IAAI,CAAC;CACb;AAED,qBAAa,aAAc,YAAW,OAAO;IAC5C,OAAO,IAAI,MAAM,GAAG,IAAI;IAIxB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAI3C,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAIvC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIvB,IAAI,IAAI,IAAI;CAGZ;AAED,qBAAa,aAAc,YAAW,OAAO;IAC5C,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;IAClB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;;IAOnB,OAAO,IAAI,MAAM,GAAG,IAAI;IAIxB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAK3C,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAKvC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIvB,IAAI,IAAI,IAAI;CAGZ"}

package/dist/routing/History.js

@@ -11,6 +11,9 @@ export class ClientHistory {
     open(url) {
         window.location.href = url;
     }
+    back() {
+        window.history.back();
+    }
 }
 export class ServerHistory {
     state;
@@ -20,7 +23,7 @@ export class ServerHistory {
         this.url = null;
     }
     scrollY() {
-        return 0;
+        return null;
     }
     replaceState(data, url) {
         this.state = data;
@@ -33,4 +36,7 @@ export class ServerHistory {
     open(url) {
         this.url = url;
     }
+    back() {
+        throw new Error('Cannot go back on the server');
+    }
 }

package/dist/routing/InnerRouter.d.ts

@@ -1,6 +1,7 @@
-import Route from './Route.js';
 import Site, { SiteFromGraphQl } from './Site.js';
 import History from './History.js';
+import Request from './Request.js';
+import Route from './Route.js';
 export type InnerRouterOpts = {
     preloadOnMouseOver: boolean;
 };
@@ -17,8 +18,8 @@ export default class InnerRouter {
      * @param changeHistory returns a function you need to call when you are ready to
      update the window history (note do not call this after another onRoute call was made)
      */
-    onRoute: (route: Route, site: Site, changeHistory: () => void) => void;
-    onPreload: (route: Route, site: Site) => void;
+    onRoute: (route: Request, site: Site, changeHistory: () => void) => void;
+    onPreload: (route: Request, site: Site) => void;
     private scrollDebounceTimeout;
     /**
      * Creates a new Router
@@ -56,7 +57,7 @@ export default class InnerRouter {
      * @param target
      * @return Returns null if the url does not match our host (the protocol get's ignored)
      */
-    targetToRoute(target: string | URL | Route): Route;
+    targetToRequest(target: string | URL | Route | Request): Request;
     /**
      * Resolve a url and convert it to a Route
      *
@@ -71,16 +72,16 @@ export default class InnerRouter {
      * @param route a route object or an url or uri, never input the same route object again
      * @param pushState if true pushed the state to the window.history
      */
-    open(target: string | URL | Route, pushState?: boolean): void;
+    open(target: string | URL | Route | Request, pushState?: boolean): void;
     /**
      * Sets a route
      *
      * Will trigger an onRoute event but will not store any scroll progress
      * or modify the history
      *
-     * @param route
+     * @param req
      */
-    setRoute(route: Route): void;
+    setRoute(req: Request): void;
     /**
      * This pushes the state of the route without triggering a currentRoute
      * or currentSiteId change
@@ -105,7 +106,7 @@ export default class InnerRouter {
      *
      * @param url
      */
-    preload(target: string | URL | Route): void;
-    domReady(route: Route): void;
+    preload(target: string | URL | Route | Request): void;
+    domReady(req: Request): void;
 }
 //# sourceMappingURL=InnerRouter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"InnerRouter.d.ts","sourceRoot":"","sources":["../../../../src/routing/InnerRouter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,OAAyC,MAAM,cAAc,CAAC;AAErE,MAAM,MAAM,eAAe,GAAG;IAC7B,kBAAkB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACvE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAE9C,OAAO,CAAC,qBAAqB,CAAa;IAE1C;;;;;OAKG;gBACS,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,eAAe;IAmB3D;;OAEG;IACH,UAAU;IAkBV;;OAEG;IACH,UAAU;IAEV;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAsCxD;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAIjC;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,KAAK;IAiBlD;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,KAAK;IA8BjC,MAAM;IA0FN;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,EAAE,SAAS,GAAE,OAAc;IAkC5D;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK;IAOrB;;;;;;;;OAQG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK;IAYtB;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK;IAYzB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK;IAmBpC,QAAQ,CAAC,KAAK,EAAE,KAAK;CAgErB"}
+{"version":3,"file":"InnerRouter.d.ts","sourceRoot":"","sources":["../../../../src/routing/InnerRouter.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,OAAO,OAAsB,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,MAAM,MAAM,eAAe,GAAG;IAC7B,kBAAkB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACzE,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAEhD,OAAO,CAAC,qBAAqB,CAAa;IAE1C;;;;;OAKG;gBACS,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,eAAe;IAmB3D;;OAEG;IACH,UAAU;IAkBV;;OAEG;IACH,UAAU;IAEV;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAsCxD;;OAEG;IACH,WAAW,IAAI,IAAI;IAInB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAIjC;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO;IAqBhE;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,KAAK;IA8BjC,MAAM;IA0FN;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO,EAAE,SAAS,GAAE,OAAc;IAyCtE;;;;;;;OAOG;IACH,QAAQ,CAAC,GAAG,EAAE,OAAO;IAOrB;;;;;;;;OAQG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK;IAYtB;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK;IAYzB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,KAAK,GAAG,OAAO;IAoB9C,QAAQ,CAAC,GAAG,EAAE,OAAO;CAkErB"}

package/dist/routing/InnerRouter.js

@@ -1,6 +1,7 @@
-import Route from './Route.js';
 import Site from './Site.js';
 import { ClientHistory, ServerHistory } from './History.js';
+import Request, { isRequest } from './Request.js';
+import Route from './Route.js';
 /**
  * Manages event listeners or functions.
  */
@@ -43,7 +44,7 @@ export default class InnerRouter {
     initClient() {
         this.listen();
         // let's first try to load from the state
-        const route = this.targetToRoute(window.location.href);
+        const route = this.targetToRequest(window.location.href);
         route._fillFromState(window.history.state);
         route.origin = 'init';
         if (route.search.get('x-craft-live-preview')) {
@@ -115,7 +116,7 @@ export default class InnerRouter {
      * @param target
      * @return Returns null if the url does not match our host (the protocol get's ignored)
      */
-    targetToRoute(target) {
+    targetToRequest(target) {
         if (typeof target === 'string') {
             if (target.startsWith('/')) {
                 const site = this.site;
@@ -126,7 +127,10 @@ export default class InnerRouter {
             }
         }
         if (target instanceof URL) {
-            return this.routeFromUrl(target);
+            target = this.routeFromUrl(target);
+        }
+        if (!isRequest(target)) {
+            return Request.fromRoute(target);
         }
         return target;
     }
@@ -228,7 +232,7 @@ export default class InnerRouter {
         window.addEventListener('popstate', async (e) => {
             if (!('route' in e.state))
                 return;
-            const route = this.targetToRoute(window.location.href);
+            const route = this.targetToRequest(window.location.href);
             route._fillFromState(e.state);
             route.origin = 'pop';
             // since the pop event replaced our state we can't replace the state
@@ -245,33 +249,38 @@ export default class InnerRouter {
      * @param pushState if true pushed the state to the window.history
      */
     open(target, pushState = true) {
-        const route = this.targetToRoute(target);
+        const req = this.targetToRequest(target);
         const current = this.route;
         if (current) {
-            // if the scrollY will still be updated we clear the timeout
+            // if the scrollY would still be updated we clear the timeout
             // since we should have the latest scrollY
             if (this.scrollDebounceTimeout) {
                 clearTimeout(this.scrollDebounceTimeout);
                 this.scrollDebounceTimeout = null;
             }
             // store the scroll position
-            current.scrollY = this.history.scrollY();
-            this.history.replaceState(current._toState());
+            const scrollY = this.history.scrollY();
+            if (typeof scrollY === 'number') {
+                current.scrollY = scrollY;
+                this.history.replaceState(current._toState());
+            }
         }
         // if the domain of the current site is different than the domain of the
         // new site we need to do a window.location.href call
-        if (current && current.url.origin !== route.url.origin) {
-            this.history.open(route.url.href);
+        if ((current && current.url.origin !== req.url.origin) ||
+            // @ts-ignore
+            import.meta.env.SSR) {
+            this.history.open(req.url.href);
             return;
         }
         if (pushState) {
-            route.index = (current?.index ?? 0) + 1;
-            this.onRoute(route, route.site ?? this.site, () => {
-                this.pushState(route);
+            req.index = (current?.index ?? 0) + 1;
+            this.onRoute(req, req.site ?? this.site, () => {
+                this.pushState(req.toRoute());
             });
         }
         else {
-            this.setRoute(route);
+            this.setRoute(req);
         }
     }
     /**
@@ -280,13 +289,13 @@ export default class InnerRouter {
      * Will trigger an onRoute event but will not store any scroll progress
      * or modify the history
      *
-     * @param route
+     * @param req
      */
-    setRoute(route) {
-        this.route = route;
-        if (route.site)
-            this.site = route.site;
-        this.onRoute(route, this.site, () => { });
+    setRoute(req) {
+        this.route = req.toRoute();
+        if (req.site)
+            this.site = req.site;
+        this.onRoute(req, this.site, () => { });
     }
     /**
      * This pushes the state of the route without triggering a currentRoute
@@ -325,26 +334,29 @@ export default class InnerRouter {
      * @param url
      */
     preload(target) {
-        const route = this.targetToRoute(target);
+        const req = this.targetToRequest(target);
+        // todo, don't think this makes any sense
         // if the domain of the current site is different than the domain of the
         // new site id does not make sense to preload
-        if (this.site.url.origin !== route.url.origin) {
+        if (this.site.url.origin !== req.url.origin) {
             return;
         }
         const current = this.route;
-        const site = route.site ?? this.site;
+        const site = req.site ?? this.site;
         // if the origin matches, the route will be able to be load
         // so let's preload it
-        if (current && current.url.origin === route.url.origin) {
-            this.onPreload(route, site);
+        if (current && current.url.origin === req.url.origin) {
+            this.onPreload(req, site);
         }
     }
-    domReady(route) {
+    domReady(req) {
+        if (req.disableScroll)
+            return;
         // scroll to target
         let scrollTo = null;
         // if the route is a live preview init and we have a scrollY stored
         // scroll to that
-        if (route.origin === 'live-preview-init') {
+        if (req.origin === 'live-preview-init') {
             const scrollY = sessionStorage.getItem('live-preview-scroll');
             if (scrollY) {
                 scrollTo = {
@@ -354,10 +366,10 @@ export default class InnerRouter {
             }
             // if we have a hash and the route was not visited
         }
-        else if (route.hash &&
-            ((route.origin === 'init' && typeof route.scrollY !== 'number') ||
-                route.origin === 'click')) {
-            const el = document.getElementById(route.hash.substring(1));
+        else if (req.hash &&
+            ((req.origin === 'init' && typeof req.scrollY !== 'number') ||
+                req.origin === 'click')) {
+            const el = document.getElementById(req.hash.substring(1));
             if (el) {
                 scrollTo = {
                     intoView: el,
@@ -367,10 +379,10 @@ export default class InnerRouter {
         }
         // restore scroll position
         if (!scrollTo &&
-            route.origin !== 'click' &&
-            typeof route.scrollY === 'number') {
+            req.origin !== 'click' &&
+            typeof req.scrollY === 'number') {
             scrollTo = {
-                top: route.scrollY,
+                top: req.scrollY,
                 behavior: 'instant',
             };
         }

package/dist/routing/PageLoader.d.ts

@@ -1,4 +1,4 @@
-import Route from './Route.js';
+import Request from './Request.js';
 import Site from './Site.js';
 export type PageLoaderOptions = {
     debugTiming: boolean;
@@ -7,7 +7,7 @@ export type LoadResponse = {
     success: boolean;
     data: any;
 };
-export type LoadFn = (route: Route, site: Site, opts: LoadOptions) => Promise<any> | any;
+export type LoadFn = (req: Request, site: Site, opts: LoadOptions) => Promise<any> | any;
 export type LoadOptions = {
     setProgress: (num: number) => void;
 };
@@ -18,7 +18,7 @@ export default class PageLoader<More> {
     private debugTiming;
     private preloadedUrls;
     private loadingVersion;
-    onLoaded: (resp: LoadResponse, route: Route, site: Site, more: More) => void;
+    onLoaded: (resp: LoadResponse, req: Request, site: Site, more: More) => void;
     onProgress: (loading: boolean, progress?: number) => void;
     loadFn: LoadFn;
     /**
@@ -31,7 +31,7 @@ export default class PageLoader<More> {
      * Discard the current page load if one is happening
      */
     discard(): void;
-    load(route: Route, site: Site, more: More): Promise<void>;
-    preload(route: Route, site: Site): Promise<void>;
+    load(req: Request, site: Site, more: More): Promise<void>;
+    preload(req: Request, site: Site): Promise<void>;
 }
 //# sourceMappingURL=PageLoader.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PageLoader.d.ts","sourceRoot":"","sources":["../../../../src/routing/PageLoader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CACpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,WAAW,KACb,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB,MAAM,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,IAAI;IACnC,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,aAAa,CAAc;IAEnC,OAAO,CAAC,cAAc,CAAS;IAE/B,QAAQ,EAAE,CACT,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,KACN,IAAI,CAAC;IACV,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;gBACS,OAAO,EAAE,iBAAiB;IAWtC;;OAEG;IACH,OAAO;IAKD,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;IAiCzC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI;CActC"}
+{"version":3,"file":"PageLoader.d.ts","sourceRoot":"","sources":["../../../../src/routing/PageLoader.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CACpB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,WAAW,KACb,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB,MAAM,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,IAAI;IACnC,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,aAAa,CAAc;IAEnC,OAAO,CAAC,cAAc,CAAS;IAE/B,QAAQ,EAAE,CACT,IAAI,EAAE,YAAY,EAClB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,KACN,IAAI,CAAC;IACV,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;gBACS,OAAO,EAAE,iBAAiB;IAWtC;;OAEG;IACH,OAAO;IAKD,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;IAiCzC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI;CActC"}

package/dist/routing/PageLoader.js

@@ -28,7 +28,7 @@ export default class PageLoader {
         this.loadingVersion++;
         this.onProgress(false);
     }
-    async load(route, site, more) {
+    async load(req, site, more) {
         this.onProgress(true);
         const version = ++this.loadingVersion;
         const startTime = this.debugTiming ? Date.now() : null;
@@ -39,7 +39,7 @@ export default class PageLoader {
         };
         const resp = { success: false, data: null };
         try {
-            resp.data = await this.loadFn(route, site, { setProgress });
+            resp.data = await this.loadFn(req, site, { setProgress });
             resp.success = true;
         }
         catch (e) {
@@ -52,18 +52,18 @@ export default class PageLoader {
         if (this.loadingVersion !== version)
             return console.log('route changed quickly, ignoring response');
         this.onProgress(false);
-        this.onLoaded(resp, route, site, more);
+        this.onLoaded(resp, req, site, more);
     }
     // you don't need to wait on this call
-    async preload(route, site) {
-        const url = route.url.origin + route.url.pathname;
+    async preload(req, site) {
+        const url = req.url.origin + req.url.pathname;
         if (this.preloadedUrls.has(url))
             return;
         this.preloadedUrls.add(url);
         try {
-            await this.loadFn(route, site, { setProgress: () => null });
+            await this.loadFn(req, site, { setProgress: () => null });
         }
-        catch (e) {
+        catch (_e) {
             console.log('preload failed');
             // retry at another time
             this.preloadedUrls.delete(url);

package/dist/routing/Request.d.ts

@@ -0,0 +1,102 @@
+import { Barrier } from 'crelte-std/sync';
+import Route, { RouteOrigin } from './Route.js';
+import Site from './Site.js';
+/**
+ * Options to create a Request
+ */
+export type RequestOptions = {
+    scrollY?: number;
+    index?: number;
+    origin?: RouteOrigin;
+    disableScroll?: boolean;
+};
+/**
+ * A Request is a Route with some extra options
+ * you get a Request from the onRequest event or
+ * in a loadGlobal function.
+ */
+export default class Request extends Route {
+    /**
+     * Disable scrolling for this request
+     * @default false
+     */
+    disableScroll: boolean;
+    /** @hidden */
+    _renderBarrier: RenderBarrier;
+    /**
+     * Create a new Request
+     */
+    constructor(url: string | URL, site: Site | null, opts?: RequestOptions);
+    /**
+     * Create a Request from a Route
+     */
+    static fromRoute(route: Route): Request;
+    /**
+     * With delayRender you can make sure that the render waits
+     * until you are ready. This is useful for building page transitions.
+     *
+     * ## Important
+     * If you call delayRender you need to call `ready/remove` or the render
+     * will never happen
+     *
+     * ## Example
+     * ```
+     * import { onRequest } from 'crelte';
+     * import { animate } from 'motion';
+     *
+     * onRequest(async req => {
+     *     if (req.origin !== 'click' && req.origin !== 'manual') return;
+     *
+     *     const delay = req.delayRender();
+     *
+     *     await animate(plane, { x: '0%' });
+     *
+     *     // wait until the new page is ready to be rendered
+     *     // if the render was cancelled we return
+     *     if (await delay.ready()) return;
+     *
+     *     await animate(plane, { x: '100%' });
+     * });
+     * ```
+     */
+    delayRender(): DelayRender;
+    /**
+     * Create a copy of the request
+     */
+    clone(): Request;
+    /**
+     * Create a Route from the Request
+     */
+    toRoute(): Route;
+}
+export declare function isRequest(req: any): req is Request;
+declare class RenderBarrier {
+    inner: Barrier<unknown>;
+    cancelled: boolean;
+    root: DelayRender;
+    constructor();
+    isOpen(): boolean;
+    add(): DelayRender;
+    /** @hidden */
+    cancel(): void;
+    /** @hidden */
+    ready(): Promise<boolean>;
+}
+/**
+ * DelayRender is returned by `Request.delayRender`
+ */
+export type DelayRender = {
+    /**
+     * Call this when you're ready for the render to happen
+     * the promise will resolve when the render is done or was cancelled
+     *
+     * @returns if the render was cancelled
+     */
+    ready: () => Promise<boolean>;
+    /**
+     * If youre not interested when the render happens anymore
+     */
+    remove: () => void;
+};
+export {};
+//# sourceMappingURL=Request.d.ts.map

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

@@ -0,0 +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;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,KAAK;IACzC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB,cAAc;IACd,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;gBAEF,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,IAAI,EAAE,IAAI,GAAG,IAAI,EACjB,IAAI,GAAE,cAAmB;IAQ1B;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK;IAQ7B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,WAAW,IAAI,WAAW;IAI1B;;OAEG;IACH,KAAK;IASL;;OAEG;IACH,OAAO;CAOP;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"}