crelte 0.5.8 → 0.5.10

package/dist/queries/Queries.js

@@ -22,6 +22,15 @@ export default class Queries {
         this.route = route;
         this.request = request;
     }
+    /**
+     * Create a new Queries instance
+     *
+     * @param endpoint the craft GraphQl endpoint
+     * @param frontend the frontend url where the server queries are reachable
+     * @param ssrCache the ssrCache to use for caching
+     * @param opts options
+     * @returns
+     */
     static new(endpoint, frontend, ssrCache, opts = {}) {
         return new Queries(new Inner(endpoint, frontend, ssrCache, opts), opts?.route ?? null, null);
     }
@@ -44,6 +53,7 @@ export default class Queries {
         // for convenience we set the siteId as variable if it is known
         if (siteId !== null)
             vars = { siteId, ...vars };
+        // todo, maybe we should set the XCraftSiteId, with the siteId from vars?
         return this.inner.query(query, vars, {
             previewToken,
             siteToken,
@@ -104,24 +114,20 @@ class Inner {
             if (key) {
                 // todo maybe we should objClone here?
                 this.ssrCache.set(key, resp);
-                // ! because the listeners get's in the previous if statement and will
-                // always be set when the key is set
+                // ! (never null) because the listeners get's in the previous
+                // if statement and will always be set when the key is set
                 const listeners = this.listeners.get(key);
-                listeners.forEach(([resolve, _error]) => {
-                    resolve(resp);
-                });
+                listeners.forEach(([resolve, _error]) => resolve(resp));
                 this.listeners.delete(key);
             }
             return resp;
         }
         catch (e) {
             if (key) {
-                // ! because the listeners get's in the previous if statement and will
-                // always be set when the key is set
+                // ! (never null) because the listeners get's in the previous
+                // if statement and will always be set when the key is set
                 const listeners = this.listeners.get(key);
-                listeners.forEach(([_resolve, error]) => {
-                    error(e);
-                });
+                listeners.forEach(([_resolve, error]) => error(e));
                 this.listeners.delete(key);
             }
             throw e;
@@ -163,11 +169,17 @@ class Inner {
         else {
             body = { query: query.query, variables: vars };
         }
-        const resp = await fetch(url, {
-            method: 'POST',
-            headers,
-            body: JSON.stringify(body),
-        });
+        let resp;
+        try {
+            resp = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify(body),
+            });
+        }
+        catch (e) {
+            throw new Error(`query to '${url}' failed with: ${e.message}`);
+        }
         if (!resp.ok) {
             throw new QueryError({ status: resp.status, body: await resp.text() }, 'resp not ok');
         }
@@ -184,8 +196,8 @@ class Inner {
             throw new QueryError({ status: resp.status }, e);
         }
         if ('errors' in jsonResp) {
-            console.log(logName + ' errors', jsonResp.errors);
-            throw new QueryError({ status: resp.status }, jsonResp.errors);
+            console.error(logName + ' errors', jsonResp.errors);
+            throw new QueryError({ status: resp.status, errors: jsonResp.errors }, 'received errors');
         }
         return jsonResp.data ?? null;
     }

package/dist/queries/QueryError.d.ts

@@ -1,6 +1,7 @@
 export type QueryErrorResponse = {
     status?: number;
     body?: string;
+    errors?: any[];
 };
 /**
  * A QueryError error
@@ -19,4 +20,5 @@ export default class QueryError extends Error {
      */
     get message(): string;
 }
+export declare function isQueryError(err: any): err is QueryError;
 //# sourceMappingURL=QueryError.d.ts.map

package/dist/queries/QueryError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"QueryError.d.ts","sourceRoot":"","sources":["../../src/queries/QueryError.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAGF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK;IAC5C,IAAI,EAAE,kBAAkB,CAAC;IACzB,GAAG,EAAE,GAAG,CAAC;gBAGG,IAAI,EAAE,kBAAkB,EAAE,GAAG,GAAE,GAAU;IAOrD;;OAEG;IACH,MAAM,IAAI,MAAM;IAIhB,cAAc;IAEd;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;CACD"}
+{"version":3,"file":"QueryError.d.ts","sourceRoot":"","sources":["../../src/queries/QueryError.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;CACf,CAAC;AAGF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK;IAC5C,IAAI,EAAE,kBAAkB,CAAC;IACzB,GAAG,EAAE,GAAG,CAAC;gBAGG,IAAI,EAAE,kBAAkB,EAAE,GAAG,GAAE,GAAU;IAOrD;;OAEG;IACH,MAAM,IAAI,MAAM;IAIhB,cAAc;IAEd;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;CACD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,UAAU,CAMxD"}

package/dist/queries/QueryError.js

@@ -22,6 +22,11 @@ export default class QueryError extends Error {
      * The error message in string form
      */
     get message() {
-        return 'QueryError: ' + JSON.stringify(this.resp);
+        return 'QueryError: ' + JSON.stringify(this.resp, null, '  ');
     }
 }
+export function isQueryError(err) {
+    return (typeof err === 'object' &&
+        err !== null &&
+        typeof err.__QueryError__ === 'function');
+}

package/dist/queries/gql.d.ts

@@ -4,8 +4,8 @@ import { Query } from './Queries.js';
  * @param strings
  * @param keys
  *
- * ## Example
- * ```
+ * #### Example
+ * ```js
  * const query = gql`query ($id: ID!) { page(id: $id) { id } }`;
  * ```
  */

package/dist/queries/gql.js

@@ -4,8 +4,8 @@ import { isQuery } from './Queries.js';
  * @param strings
  * @param keys
  *
- * ## Example
- * ```
+ * #### Example
+ * ```js
  * const query = gql`query ($id: ID!) { page(id: $id) { id } }`;
  * ```
  */

package/dist/queries/index.d.ts

@@ -1,14 +1,16 @@
 import Queries, { isQuery, QueriesOptions, Query, QueryOptions } from '../queries/Queries.js';
 import { gql } from './gql.js';
-import QueryError from './QueryError.js';
+import QueryError, { QueryErrorResponse } from './QueryError.js';
 import { QueryVar, ValidIf, vars, varsIdsEqual } from './vars.js';
-export { Queries, type QueriesOptions, type QueryOptions, type Query, isQuery, QueryError, gql, vars, type ValidIf, QueryVar, varsIdsEqual, };
-type InferQueryVarType<T> = T extends QueryVar<infer U> ? U : never;
-type InferVariableTypes<T> = {
+export { Queries, type QueriesOptions, type QueryOptions, type Query, isQuery, QueryError, type QueryErrorResponse, gql, vars, type ValidIf, QueryVar, varsIdsEqual, };
+/** @hidden */
+export type InferQueryVarType<T> = T extends QueryVar<infer U> ? U : never;
+/** @hidden */
+export type InferVariableTypes<T> = {
     [K in keyof T]: InferQueryVarType<T[K]>;
 };
 /**
- * ## Example
+ * #### Example
  * ```ts
  * import { vars, Caching } from 'crelte/queries';
  *

package/dist/queries/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EACf,OAAO,EACP,cAAc,EACd,KAAK,EACL,YAAY,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAElE,OAAO,EACN,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,KAAK,EACV,OAAO,EACP,UAAU,EACV,GAAG,EACH,IAAI,EACJ,KAAK,OAAO,EACZ,QAAQ,EACR,YAAY,GACZ,CAAC;AAEF,KAAK,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEpE,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,OAAO,CAClB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IACpE,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/queries/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EACf,OAAO,EACP,cAAc,EACd,KAAK,EACL,YAAY,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,UAAU,EAAE,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAElE,OAAO,EACN,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,KAAK,EACV,OAAO,EACP,UAAU,EACV,KAAK,kBAAkB,EACvB,GAAG,EACH,IAAI,EACJ,KAAK,OAAO,EACZ,QAAQ,EACR,YAAY,GACZ,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE3E,cAAc;AACd,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,OAAO,CAClB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IACpE,OAAO,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC"}

package/dist/queries/vars.d.ts

@@ -7,7 +7,7 @@ export declare const vars: {
      * Id is almost the same as number but will also parse
      * strings, but only allow non negative integers
      *
-     * ## Warning
+     * #### Warning
      * Ids are not automatically safe to be cached
      * you need to validate the response to make sure filters
      * with this id returned something
@@ -21,7 +21,7 @@ export declare const vars: {
      *
      * The numbers are always unique and sorted in ascending order
      *
-     * ## Warning
+     * #### Warning
      * Ids are not automatically safe to be cached, it is also not
      * enough to just check if the filter returned some results.
      * Since for example a `relatedTo` filter works like an `or` and
@@ -69,8 +69,8 @@ export declare function isQueryVar(v: any): v is QueryVar;
  * The first argument needs to come from a `vars.ids()` variable.
  * The second argument should come from a query, where the output is trusted.
  *
- * ## Example
- * ```
+ * #### Example
+ * ```js
  * export const variables = {
  *     categories: vars.ids()
  * };
@@ -81,15 +81,15 @@ export declare function isQueryVar(v: any): v is QueryVar;
  * };
  * ```
  *
- * ## Note
+ * #### Note
  * The following cases are considered equal:
- * ```
+ * ```js
  * varsIdsEqual(null, null);
  * varsIdsEqual([], null);
  * varsIdsEqual([1,2], ['2',1]);
  * ```
  * These are not equal:
- * ```
+ * ```js
  * varsIdsEqual([1], null);
  * varsIdsEqual([2,1], [2,1]); // because the second arg gets ordered
  * ```

package/dist/queries/vars.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vars.d.ts","sourceRoot":"","sources":["../../src/queries/vars.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAErD,eAAO,MAAM,IAAI;eACP,QAAQ,CAAC,GAAG,CAAC;kBACV,QAAQ,CAAC,MAAM,CAAC;kBAChB,QAAQ,CAAC,MAAM,CAAC;IAE5B;;;;;;;;OAQG;cACK,QAAQ,CAAC,MAAM,CAAC;IAExB;;;;;;;;;;;;;;;;;;OAkBG;eACM,QAAQ,CAAC,MAAM,EAAE,CAAC;kBAEf,QAAQ,CAAC,MAAM,CAAC;CAM5B,CAAC;AAIF,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,YAAY,KAAK,OAAO,CAAC;AAE7D,qBAAa,QAAQ,CAAC,CAAC,GAAG,GAAG;IAC5B,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,IAAI,CAA6C;IACzD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,SAAS,CAAa;;IAS9B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC;IAKtB,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;IAKzB,QAAQ,IAAI,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC;IAK9B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,GAAG,CAAC,GAAG,IAAI;IAqE9C;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,YAAY;CACZ;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,QAAQ,CAEhD;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,YAAY,CAC3B,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,EAC9B,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAWT"}
+{"version":3,"file":"vars.d.ts","sourceRoot":"","sources":["../../src/queries/vars.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAErD,eAAO,MAAM,IAAI;eACP,QAAQ,CAAC,GAAG,CAAC;kBACV,QAAQ,CAAC,MAAM,CAAC;kBAChB,QAAQ,CAAC,MAAM,CAAC;IAE5B;;;;;;;;OAQG;cACK,QAAQ,CAAC,MAAM,CAAC;IAExB;;;;;;;;;;;;;;;;;;OAkBG;eACM,QAAQ,CAAC,MAAM,EAAE,CAAC;kBAEf,QAAQ,CAAC,MAAM,CAAC;CAM5B,CAAC;AAIF,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,YAAY,KAAK,OAAO,CAAC;AAE7D,qBAAa,QAAQ,CAAC,CAAC,GAAG,GAAG;IAC5B,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,IAAI,CAA6C;IACzD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,SAAS,CAAa;;IAS9B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC;IAKtB,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;IAKzB,QAAQ,IAAI,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC;IAK9B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,GAAG,CAAC,GAAG,IAAI;IAqE9C;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,YAAY;CACZ;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,QAAQ,CAMhD;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,YAAY,CAC3B,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,EAC9B,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,GACvC,OAAO,CAWT"}

package/dist/queries/vars.js

@@ -6,7 +6,7 @@ export const vars = {
      * Id is almost the same as number but will also parse
      * strings, but only allow non negative integers
      *
-     * ## Warning
+     * #### Warning
      * Ids are not automatically safe to be cached
      * you need to validate the response to make sure filters
      * with this id returned something
@@ -20,7 +20,7 @@ export const vars = {
      *
      * The numbers are always unique and sorted in ascending order
      *
-     * ## Warning
+     * #### Warning
      * Ids are not automatically safe to be cached, it is also not
      * enough to just check if the filter returned some results.
      * Since for example a `relatedTo` filter works like an `or` and
@@ -138,7 +138,9 @@ export class QueryVar {
     __QueryVar__() { }
 }
 export function isQueryVar(v) {
-    return v && typeof v === 'object' && typeof v.__QueryVar__ === 'function';
+    return (typeof v === 'object' &&
+        v !== null &&
+        typeof v.__QueryVar__ === 'function');
 }
 // does not do string to number conversion
 function isValidId(id) {
@@ -150,8 +152,8 @@ function isValidId(id) {
  * The first argument needs to come from a `vars.ids()` variable.
  * The second argument should come from a query, where the output is trusted.
  *
- * ## Example
- * ```
+ * #### Example
+ * ```js
  * export const variables = {
  *     categories: vars.ids()
  * };
@@ -162,15 +164,15 @@ function isValidId(id) {
  * };
  * ```
  *
- * ## Note
+ * #### Note
  * The following cases are considered equal:
- * ```
+ * ```js
  * varsIdsEqual(null, null);
  * varsIdsEqual([], null);
  * varsIdsEqual([1,2], ['2',1]);
  * ```
  * These are not equal:
- * ```
+ * ```js
  * varsIdsEqual([1], null);
  * varsIdsEqual([2,1], [2,1]); // because the second arg gets ordered
  * ```

package/dist/routing/LoadRunner.d.ts

@@ -29,7 +29,7 @@ export default class LoadRunner {
     /**
      * @returns true if the load was completed
      *
-     * ## Throws
+     * #### Throws
      * if there was an error but not if the request
      * was cancelled before
      */

package/dist/routing/LoadRunner.js

@@ -29,7 +29,7 @@ export default class LoadRunner {
     /**
      * @returns true if the load was completed
      *
-     * ## Throws
+     * #### Throws
      * if there was an error but not if the request
      * was cancelled before
      */

package/dist/routing/index.d.ts

@@ -1,8 +1,8 @@
 import Router, { type UpdateRequest } from './router/Router.js';
-import Route, { type RouteOptions } from './route/Route.js';
+import Route, { type TemplateModule, type RouteOptions } from './route/Route.js';
 import Request, { type RequestOptions, type DelayRender } from './route/Request.js';
-import Site from './Site.js';
-import BaseRoute from './route/BaseRoute.js';
+import Site, { type SiteFromGraphQl } from './Site.js';
+import BaseRoute, { type BaseRouteOptions, type RouteOrigin } from './route/BaseRoute.js';
 import { shouldInterceptClick } from './utils.js';
-export { Router, UpdateRequest, BaseRoute, Route, RouteOptions, Site, Request, DelayRender, RequestOptions, shouldInterceptClick, };
+export { Router, UpdateRequest, BaseRoute, BaseRouteOptions, Route, RouteOptions, TemplateModule, Site, SiteFromGraphQl, Request, DelayRender, RequestOptions, shouldInterceptClick, RouteOrigin, };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/routing/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,OAAO,EAAE,EACf,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,OAAO,EACN,MAAM,EACN,aAAa,EACb,SAAS,EACT,KAAK,EACL,YAAY,EACZ,IAAI,EACJ,OAAO,EACP,WAAW,EACX,cAAc,EACd,oBAAoB,GACpB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/routing/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,EACb,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,OAAO,EAAE,EACf,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,IAAI,EAAE,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,SAAS,EAAE,EACjB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,OAAO,EACN,MAAM,EACN,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,KAAK,EACL,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,eAAe,EACf,OAAO,EACP,WAAW,EACX,cAAc,EACd,oBAAoB,EACpB,WAAW,GACX,CAAC"}

package/dist/routing/route/BaseRoute.d.ts

@@ -18,7 +18,7 @@ export type BaseRouteOptions = {
  * - `'replace'`: is set when a route is replaced via `Router.replaceState`
  * - `'push'`: is set when a route is pushed via `Router.pushState`
  *
- * ## Note
+ * #### Note
  * `replace` and `push` will not call loadData
  */
 export type RouteOrigin = 'init' | 'manual' | 'preload' | 'click' | 'pop' | 'replace' | 'push';
@@ -32,9 +32,9 @@ export default class BaseRoute {
      */
     url: URL;
     /**
-     * The site of the route
+     * The {@link Site} of the route
      *
-     * ## Note
+     * #### Note
      * In the `beforeRequest` event the site might not match
      * the url and could be the default site or one that matches
      * the users language.
@@ -45,7 +45,7 @@ export default class BaseRoute {
     /**
      * The scroll position of the current route
      *
-     * ## Note
+     * #### Note
      * This does not have to represent the current scroll position
      * should more be used internally.
      *
@@ -59,7 +59,7 @@ export default class BaseRoute {
      */
     index: number;
     /**
-     * The origin of this route, See [[RouteOrigin]]
+     * The origin of this route, See {@link RouteOrigin}
      */
     origin: RouteOrigin;
     /**
@@ -74,7 +74,7 @@ export default class BaseRoute {
      * This context is not persistant and should be considered "valid"
      * only for the current request / route
      *
-     * ## Note
+     * #### Note
      * Consider using state instead. This will not be cloned in the clone
      * call so will always be the same object
      */
@@ -88,8 +88,8 @@ export default class BaseRoute {
      *
      * Never ends with a slash
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const site = _; // site with url https://example.com/fo
      * const route = new Route('https://example.com/foo/bar/', site);
      * console.log(route.uri); // '/bar'
@@ -105,8 +105,8 @@ export default class BaseRoute {
      *
      * Never ends with a slash
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const site = _; // site with url https://example.com/foo
      * const route = new Route('https://example.com/foo/bar/', null);
      * console.log(route.baseUrl); // 'https://example.com/foo'
@@ -120,11 +120,11 @@ export default class BaseRoute {
     /**
      * Returns the search params
      *
-     * ## Note
+     * #### Note
      * You might also have a look at `getSearchParam` and `setSearchParam`
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/?a=1&b=2', null);
      * console.log(route.search.get('a')); // '1'
      * ```
@@ -133,8 +133,8 @@ export default class BaseRoute {
     /**
      * Returns the hash of the route
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/#hash', null);
      * console.log(route.hash); // '#hash'
      * ```
@@ -143,8 +143,8 @@ export default class BaseRoute {
     /**
      * Set the hash of the route
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/', null);
      * route.hash = '#hash';
      * console.log(route.url.href); // 'https://example.com/foo/bar/#hash'
@@ -158,8 +158,8 @@ export default class BaseRoute {
     /**
      * Gets the search param
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/?a=1&b=2', null);
      * console.log(route.getSearchParam('a')); // '1'
      * ```
@@ -169,8 +169,8 @@ export default class BaseRoute {
      * Sets the search param or removes it if the value is null, undefined or an
      * empty string
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/?a=1&b=2', null);
      * route.setSearchParam('a', '3');
      * console.log(route.url.href); // 'https://example.com/foo/bar/?a=3&b=2'
@@ -188,7 +188,7 @@ export default class BaseRoute {
      * Sets a state value.
      * If the value is null or undefined, the key will be removed.
      *
-     * ## When to use state
+     * #### 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.
      *
@@ -203,7 +203,7 @@ export default class BaseRoute {
      * Sets a context value.
      * If the value is null or undefined, the key will be removed.
      *
-     * ## When to use context
+     * #### 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.
@@ -223,7 +223,7 @@ export default class BaseRoute {
      * This checks the url but search params do not have to be in the
      * same order
      *
-     * ## Note
+     * #### Note
      * This only check the url, not site or anything else.
      */
     eq(route: BaseRoute | null): boolean | null;
@@ -244,7 +244,7 @@ export default class BaseRoute {
     /**
      * Create a copy of the Route
      *
-     * ## Note
+     * #### Note
      * This does not make a copy of the template or context
      */
     clone(): BaseRoute;

package/dist/routing/route/BaseRoute.js

@@ -10,9 +10,9 @@ export default class BaseRoute {
      */
     url;
     /**
-     * The site of the route
+     * The {@link Site} of the route
      *
-     * ## Note
+     * #### Note
      * In the `beforeRequest` event the site might not match
      * the url and could be the default site or one that matches
      * the users language.
@@ -23,7 +23,7 @@ export default class BaseRoute {
     /**
      * The scroll position of the current route
      *
-     * ## Note
+     * #### Note
      * This does not have to represent the current scroll position
      * should more be used internally.
      *
@@ -37,7 +37,7 @@ export default class BaseRoute {
      */
     index;
     /**
-     * The origin of this route, See [[RouteOrigin]]
+     * The origin of this route, See {@link RouteOrigin}
      */
     origin;
     /**
@@ -52,7 +52,7 @@ export default class BaseRoute {
      * This context is not persistant and should be considered "valid"
      * only for the current request / route
      *
-     * ## Note
+     * #### Note
      * Consider using state instead. This will not be cloned in the clone
      * call so will always be the same object
      */
@@ -74,8 +74,8 @@ export default class BaseRoute {
      *
      * Never ends with a slash
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const site = _; // site with url https://example.com/fo
      * const route = new Route('https://example.com/foo/bar/', site);
      * console.log(route.uri); // '/bar'
@@ -96,8 +96,8 @@ export default class BaseRoute {
      *
      * Never ends with a slash
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const site = _; // site with url https://example.com/foo
      * const route = new Route('https://example.com/foo/bar/', null);
      * console.log(route.baseUrl); // 'https://example.com/foo'
@@ -115,11 +115,11 @@ export default class BaseRoute {
     /**
      * Returns the search params
      *
-     * ## Note
+     * #### Note
      * You might also have a look at `getSearchParam` and `setSearchParam`
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/?a=1&b=2', null);
      * console.log(route.search.get('a')); // '1'
      * ```
@@ -130,8 +130,8 @@ export default class BaseRoute {
     /**
      * Returns the hash of the route
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/#hash', null);
      * console.log(route.hash); // '#hash'
      * ```
@@ -142,8 +142,8 @@ export default class BaseRoute {
     /**
      * Set the hash of the route
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/', null);
      * route.hash = '#hash';
      * console.log(route.url.href); // 'https://example.com/foo/bar/#hash'
@@ -161,8 +161,8 @@ export default class BaseRoute {
     /**
      * Gets the search param
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/?a=1&b=2', null);
      * console.log(route.getSearchParam('a')); // '1'
      * ```
@@ -174,8 +174,8 @@ export default class BaseRoute {
      * Sets the search param or removes it if the value is null, undefined or an
      * empty string
      *
-     * ## Example
-     * ```
+     * #### Example
+     * ```js
      * const route = new Route('https://example.com/foo/bar/?a=1&b=2', null);
      * route.setSearchParam('a', '3');
      * console.log(route.url.href); // 'https://example.com/foo/bar/?a=3&b=2'
@@ -205,7 +205,7 @@ export default class BaseRoute {
      * Sets a state value.
      * If the value is null or undefined, the key will be removed.
      *
-     * ## When to use state
+     * #### 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.
      *
@@ -229,7 +229,7 @@ export default class BaseRoute {
      * Sets a context value.
      * If the value is null or undefined, the key will be removed.
      *
-     * ## When to use context
+     * #### 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.
@@ -265,7 +265,7 @@ export default class BaseRoute {
      * This checks the url but search params do not have to be in the
      * same order
      *
-     * ## Note
+     * #### Note
      * This only check the url, not site or anything else.
      */
     eq(route) {
@@ -310,7 +310,7 @@ export default class BaseRoute {
     /**
      * Create a copy of the Route
      *
-     * ## Note
+     * #### Note
      * This does not make a copy of the template or context
      */
     clone() {