crelte 0.1.0 → 0.1.2

package/dist/cookies/index.d.ts

@@ -12,9 +12,16 @@ export interface Cookies {
     get(name: string): string | null;
     /**
      * sets the value of the cookie
+     *
+     * ## Note
+     * in most cases you probably wan't to set the path to '/'
      */
     set(name: string, value: string, opts?: SetOptions): void;
+    /**
+     * removes the cookie
+     */
     remove(name: string): void;
+    /** @hidden */
     _init(cookies: string): void;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/cookies/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAG3B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/cookies/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAE1D;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc;IACd,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B"}

package/dist/graphql/GraphQl.d.ts

@@ -1,22 +1,56 @@
+import Route from '../routing/Route.js';
 import SsrCache from '../ssr/SsrCache.js';
 export type GraphQlErrorResponse = {
     status?: number;
     body?: string;
 };
+/**
+ * A GraphQL query
+ *
+ * You should almost never create this object directly
+ * but instead import a graphql file or use the gql template.
+ */
+export interface GraphQlQuery {
+    path?: string;
+    query: string;
+}
+/**
+ * A GraphQL error
+ */
 export declare class GraphQlError extends Error {
     resp: GraphQlErrorResponse;
     ctx: any;
     constructor(resp: GraphQlErrorResponse, ctx?: any);
+    /**
+     * The status code of the response
+     */
     status(): number;
     __isGraphQlError__(): void;
+    /**
+     * The error message in string form
+     */
     get message(): string;
 }
+/**
+ * Options for the GraphQl class
+ */
 export type GraphQlOptions = {
     debug?: boolean;
     debugTiming?: boolean;
 };
+/**
+ * Options to configure the request
+ *
+ * If you use `Crelte*.query` the following options
+ * will be set automatically:
+ * - path
+ * - route
+ * - previewToken
+ * - siteToken
+ */
 export type GraphQlRequestOptions = {
     path?: string;
+    route?: Route;
     ignoreStatusCode?: boolean;
     previewToken?: string;
     siteToken?: string;
@@ -24,6 +58,9 @@ export type GraphQlRequestOptions = {
     headers?: Record<string, string>;
     status?: number;
 };
+/**
+ * A GraphQL client
+ */
 export default class GraphQl {
     private endpoint;
     private ssrCache;
@@ -31,30 +68,32 @@ export default class GraphQl {
     private loggingRequests;
     private loggingTiming;
     /**
-     * Create a new GraphQL
-     *
-     * @param {Object} [opts={}] opts `{ debug: false, debugTiming: false }`
+     * Create a new GraphQL client
      */
     constructor(endpoint: string, ssrCache: SsrCache, opts?: GraphQlOptions);
-    request(query: string, variables?: Record<string, unknown>, options?: GraphQlRequestOptions): Promise<unknown>;
+    /**
+     * Run a GraphQl Query
+     *
+     * @param query the default export from a graphql file or the gql`query {}`
+     * function
+     * @param variables variables that should be passed to the
+     * graphql query
+     */
+    query(query: GraphQlQuery, variables?: Record<string, unknown>, opts?: GraphQlRequestOptions): Promise<unknown>;
+    private request;
     private rawRequest;
 }
-export declare class GraphQlQuery {
-    query: string;
-    path: string;
-    constructor(query: string, path: string);
-    __GraphQlQuery__(): boolean;
-}
 /** Returns true if the passed object is a GraphQlQuery */
 export declare function isGraphQlQuery(obj: any): obj is GraphQlQuery;
 /**
- * @description Create a GraphQL query string with variables.
+ * Create a GraphQL query string with variables.
  * @param strings
  * @param keys
  *
- * @example
- *
- * const query = gql`query ($id: ID!) { page(id: $id) { id } }`
+ * ## Example
+ * ```
+ * const query = gql`query ($id: ID!) { page(id: $id) { id } }`;
+ * ```
  */
 export declare function gql(strings: TemplateStringsArray | string[] | string, ...keys: unknown[]): GraphQlQuery;
 //# sourceMappingURL=GraphQl.d.ts.map

package/dist/graphql/GraphQl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GraphQl.d.ts","sourceRoot":"","sources":["../../../../src/graphql/GraphQl.ts"],"names":[],"mappings":"AAAA,OAAO,QAAwC,MAAM,oBAAoB,CAAC;AAE1E,MAAM,MAAM,oBAAoB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAGF,qBAAa,YAAa,SAAQ,KAAK;IACtC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,GAAG,EAAE,GAAG,CAAC;gBAGG,IAAI,EAAE,oBAAoB,EAAE,GAAG,GAAE,GAAU;IAOvD,MAAM,IAAI,MAAM;IAIhB,kBAAkB;IAElB,IAAI,OAAO,IAAI,MAAM,CAEpB;CACD;AAED,MAAM,MAAM,cAAc,GAAG;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,OAAO;IAC3B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,SAAS,CAGf;IAEF,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,aAAa,CAAU;IAE/B;;;;OAIG;gBAEF,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,cAAmB;IAYpB,OAAO,CACZ,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACvC,OAAO,GAAE,qBAA0B,GACjC,OAAO,CAAC,OAAO,CAAC;YAsDL,UAAU;CAmFxB;AAED,qBAAa,YAAY;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;gBAED,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMvC,gBAAgB;CAGhB;AAED,0DAA0D;AAC1D,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,YAAY,CAM5D;AAED;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CAClB,OAAO,EAAE,oBAAoB,GAAG,MAAM,EAAE,GAAG,MAAM,EACjD,GAAG,IAAI,EAAE,OAAO,EAAE,GAChB,YAAY,CAuBd"}
+{"version":3,"file":"GraphQl.d.ts","sourceRoot":"","sources":["../../../../src/graphql/GraphQl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,qBAAqB,CAAC;AACxC,OAAO,QAAwC,MAAM,oBAAoB,CAAC;AAE1E,MAAM,MAAM,oBAAoB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACd;AAGD;;GAEG;AACH,qBAAa,YAAa,SAAQ,KAAK;IACtC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,GAAG,EAAE,GAAG,CAAC;gBAGG,IAAI,EAAE,oBAAoB,EAAE,GAAG,GAAE,GAAU;IAOvD;;OAEG;IACH,MAAM,IAAI,MAAM;IAIhB,kBAAkB;IAElB;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;CACD;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAC3B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,SAAS,CAGf;IAEF,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,aAAa,CAAU;IAE/B;;OAEG;gBAEF,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,QAAQ,EAClB,IAAI,GAAE,cAAmB;IAU1B;;;;;;;OAOG;IACG,KAAK,CACV,KAAK,EAAE,YAAY,EACnB,SAAS,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACvC,IAAI,GAAE,qBAA0B,GAC9B,OAAO,CAAC,OAAO,CAAC;YAsBL,OAAO;YA0DP,UAAU;CAmFxB;AAED,0DAA0D;AAC1D,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,YAAY,CAI5D;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAClB,OAAO,EAAE,oBAAoB,GAAG,MAAM,EAAE,GAAG,MAAM,EACjD,GAAG,IAAI,EAAE,OAAO,EAAE,GAChB,YAAY,CAuBd"}

package/dist/graphql/GraphQl.js

@@ -1,5 +1,8 @@
 import { calcKey as ssrCacheCalcKey } from '../ssr/SsrCache.js';
 // todo improve this
+/**
+ * A GraphQL error
+ */
 export class GraphQlError extends Error {
     resp;
     ctx;
@@ -9,14 +12,23 @@ export class GraphQlError extends Error {
         this.resp = resp;
         this.ctx = ctx;
     }
+    /**
+     * The status code of the response
+     */
     status() {
         return this.resp?.status ?? 500;
     }
     __isGraphQlError__() { }
+    /**
+     * The error message in string form
+     */
     get message() {
         return 'GraphqlError: ' + JSON.stringify(this.resp);
     }
 }
+/**
+ * A GraphQL client
+ */
 export default class GraphQl {
     endpoint;
     ssrCache;
@@ -24,9 +36,7 @@ export default class GraphQl {
     loggingRequests;
     loggingTiming;
     /**
-     * Create a new GraphQL
-     *
-     * @param {Object} [opts={}] opts `{ debug: false, debugTiming: false }`
+     * Create a new GraphQL client
      */
     constructor(endpoint, ssrCache, opts = {}) {
         this.endpoint = endpoint;
@@ -35,6 +45,30 @@ export default class GraphQl {
         this.loggingRequests = opts?.debug ?? false;
         this.loggingTiming = opts?.debugTiming ?? false;
     }
+    /**
+     * Run a GraphQl Query
+     *
+     * @param query the default export from a graphql file or the gql`query {}`
+     * function
+     * @param variables variables that should be passed to the
+     * graphql query
+     */
+    async query(query, variables = {}, opts = {}) {
+        if (opts.route) {
+            const search = opts.route.search;
+            // todo should variables contain siteId
+            // or maybe gql should detect loadData and add it there
+            // it might make export const loadData = query; easier
+            if (search.has('token') && search.get('x-craft-live-preview')) {
+                opts.previewToken = search.get('token');
+            }
+            else if (search.has('siteToken')) {
+                opts.siteToken = search.get('siteToken');
+            }
+        }
+        opts.path = query.path;
+        return await this.request(query.query, variables, opts);
+    }
     // returns {} or throws
     // options: {ignoreStatusCode, previewToken, caching, headers}
     async request(query, variables = {}, options = {}) {
@@ -145,32 +179,19 @@ export default class GraphQl {
         return jsonResp.data ?? null;
     }
 }
-export class GraphQlQuery {
-    query;
-    path;
-    constructor(query, path) {
-        this.query = query;
-        this.path = path;
-    }
-    /// doc hidden
-    __GraphQlQuery__() {
-        return true;
-    }
-}
 /** Returns true if the passed object is a GraphQlQuery */
 export function isGraphQlQuery(obj) {
-    return (typeof obj === 'object' &&
-        obj !== null &&
-        typeof obj.__GraphQlQuery__ === 'function');
+    return (typeof obj === 'object' && obj !== null && typeof obj.query === 'string');
 }
 /**
- * @description Create a GraphQL query string with variables.
+ * Create a GraphQL query string with variables.
  * @param strings
  * @param keys
  *
- * @example
- *
- * const query = gql`query ($id: ID!) { page(id: $id) { id } }`
+ * ## Example
+ * ```
+ * const query = gql`query ($id: ID!) { page(id: $id) { id } }`;
+ * ```
  */
 export function gql(strings, ...keys) {
     if (typeof strings === 'string')
@@ -193,5 +214,5 @@ export function gql(strings, ...keys) {
             }
         }
     });
-    return new GraphQlQuery(query, import.meta.url);
+    return { query, path: import.meta.url };
 }

package/dist/graphql/index.d.ts

@@ -1,3 +1,3 @@
 import GraphQl, { gql, GraphQlQuery, GraphQlError, GraphQlRequestOptions } from './GraphQl.js';
-export { GraphQl, gql, GraphQlQuery, GraphQlError, type GraphQlRequestOptions };
+export { GraphQl, gql, type GraphQlQuery, GraphQlError, type GraphQlRequestOptions, };
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/graphql/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EACf,GAAG,EACH,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/graphql/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EACf,GAAG,EACH,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACN,OAAO,EACP,GAAG,EACH,KAAK,YAAY,EACjB,YAAY,EACZ,KAAK,qBAAqB,GAC1B,CAAC"}

package/dist/graphql/index.js

@@ -1,2 +1,2 @@
-import GraphQl, { gql, GraphQlQuery, GraphQlError, } from './GraphQl.js';
-export { GraphQl, gql, GraphQlQuery, GraphQlError };
+import GraphQl, { gql, GraphQlError, } from './GraphQl.js';
+export { GraphQl, gql, GraphQlError, };

package/dist/index.d.ts

@@ -3,65 +3,98 @@ import type Router from './routing/Router.js';
 import type SsrCache from './ssr/SsrCache.js';
 import type Site from './routing/Site.js';
 import type GraphQl from './graphql/GraphQl.js';
-import Crelte from './Crelte.js';
-import CrelteRouted from './CrelteRouted.js';
-import CrelteBase from './CrelteBase.js';
-import { Global, GlobalData } from './loadData/Globals.js';
-import { Cookies } from './cookies/index.js';
-import { Readable } from 'crelte-std/stores';
-export { Crelte, CrelteRouted };
-export type { CrelteBase };
+import Crelte, { type QueryOptions } from './Crelte.js';
+import CrelteRequest from './CrelteRequest.js';
+import type { Global, GlobalData } from './loadData/Globals.js';
+import type { Cookies } from './cookies/index.js';
+import type { Readable } from 'crelte-std/stores';
+export { Crelte, CrelteRequest, type QueryOptions };
 /**
- * Get the Crelte from the current context
+ * Get Crelte from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getCrelte(): Crelte;
 /**
  * Get the router from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getRouter(): Router;
 /**
  * Get the SSR cache from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getSsrCache(): SsrCache;
 /**
  * Get the GraphQl from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getGraphQl(): GraphQl;
 /**
- * Get the current route
+ * Get a store with the current route
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getRoute(): Readable<Route>;
 /**
- * Get the current site
+ * Get a store with the current site
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getSite(): Readable<Site>;
 /**
- * Get the next route
- */
-export declare function getNextRoute(): Readable<Route>;
-/**
- * Get the next site
- */
-export declare function getNextSite(): Readable<Site>;
-/**
- * returns an env Variables, always needs to be prefixed VITE_
- * Except ENDPOINT_URL and CRAFT_WEB_URL
+ * returns an env variable from the craft/.env file.
+ * All env variables need to start with VITE_
+ * except ENDPOINT_URL and CRAFT_WEB_URL
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
+export declare function getEnv(name: 'ENDPOINT_URL'): string;
+export declare function getEnv(name: 'CRAFT_WEB_URL'): string;
 export declare function getEnv(name: string): string | null;
 /**
  * returns a store which indicates if the a page is loading
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getLoading(): Readable<boolean>;
 /**
- * returns a store which indicates the loading progress
+ * returns a store which indicates the loading progress between 0 and 1
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getLoadingProgress(): Readable<number>;
 /**
  * returns a store which contains a globalSet
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getGlobal<T extends GlobalData>(name: string): Global<T> | null;
 /**
  * returns the cookies instance
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export declare function getCookies(): Cookies;
+/**
+ * Listen for requests
+ *
+ * ## Note
+ * This only works during component initialisation.
+ */
+export declare function onRequest(fn: (cr: CrelteRequest) => void): void;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAChD,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;AAChC,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;GAEG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED;;GAEG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED;;GAEG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAEtC;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAEpC;AAED;;GAEG;AACH,wBAAgB,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAC,CAE1C;AAED;;GAEG;AACH,wBAAgB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAExC;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,QAAQ,CAAC,KAAK,CAAC,CAE9C;AAED;;GAEG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,CAE5C;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAElD;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,QAAQ,CAAC,OAAO,CAAC,CAE9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAErD;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,MAAM,GACV,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAElB;AAED;;GAEG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAEpC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAChD,OAAO,MAAM,EAAE,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAC,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAExC;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC;AACrD,wBAAgB,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC;AACtD,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAKpD;;;;;GAKG;AACH,wBAAgB,UAAU,IAAI,QAAQ,CAAC,OAAO,CAAC,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAErD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,MAAM,GACV,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAElB;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,KAAK,IAAI,QAOxD"}

package/dist/index.js

@@ -1,83 +1,110 @@
-import { getContext } from 'svelte';
+import { getContext, onDestroy } from 'svelte';
 import Crelte from './Crelte.js';
-import CrelteRouted from './CrelteRouted.js';
-export { Crelte, CrelteRouted };
+import CrelteRequest from './CrelteRequest.js';
+export { Crelte, CrelteRequest };
 /**
- * Get the Crelte from the current context
+ * Get Crelte from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getCrelte() {
     return getContext('crelte');
 }
 /**
  * Get the router from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getRouter() {
     return getCrelte().router;
 }
 /**
  * Get the SSR cache from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getSsrCache() {
     return getCrelte().ssrCache;
 }
 /**
  * Get the GraphQl from the current context
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getGraphQl() {
     return getCrelte().graphQl;
 }
 /**
- * Get the current route
+ * Get a store with the current route
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getRoute() {
     return getRouter().route;
 }
 /**
- * Get the current site
+ * Get a store with the current site
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getSite() {
     return getRouter().site;
 }
-/**
- * Get the next route
- */
-export function getNextRoute() {
-    return getRouter().nextRoute;
-}
-/**
- * Get the next site
- */
-export function getNextSite() {
-    return getRouter().nextSite;
-}
-/**
- * returns an env Variables, always needs to be prefixed VITE_
- * Except ENDPOINT_URL and CRAFT_WEB_URL
- */
 export function getEnv(name) {
     return getCrelte().getEnv(name);
 }
 /**
  * returns a store which indicates if the a page is loading
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getLoading() {
     return getRouter().loading;
 }
 /**
- * returns a store which indicates the loading progress
+ * returns a store which indicates the loading progress between 0 and 1
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getLoadingProgress() {
     return getRouter().loadingProgress;
 }
 /**
  * returns a store which contains a globalSet
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getGlobal(name) {
     return getCrelte().globals.get(name) ?? null;
 }
 /**
  * returns the cookies instance
+ *
+ * ## Note
+ * This only works during component initialisation.
  */
 export function getCookies() {
     return getCrelte().cookies;
 }
+/**
+ * Listen for requests
+ *
+ * ## Note
+ * This only works during component initialisation.
+ */
+export function onRequest(fn) {
+    const crelte = getCrelte();
+    const rmListener = crelte.router.onRequest((req, site) => {
+        fn(new CrelteRequest(crelte, req, site));
+    });
+    onDestroy(rmListener);
+}

package/dist/init/client.d.ts

@@ -1,13 +1,54 @@
+import { GraphQlQuery } from '../graphql/GraphQl.js';
+/**
+ * The main function to start the client side rendering
+ */
 export type MainData = {
+    /** The App.svelte module */
     app: any;
+    /** The Error.svelte module */
     errorPage: any;
-    entryQuery: any;
-    globalQuery?: any;
+    /** The entry query from queries/entry.graphql */
+    entryQuery: GraphQlQuery;
+    /** The global query from queries/global.graphql */
+    globalQuery?: GraphQlQuery;
+    /**
+     * Preload pages on mouse over
+     * @default false
+     */
     preloadOnMouseOver?: boolean;
+    /**
+     * Use view transitions
+     * @default false
+     */
     viewTransition?: boolean;
+    /**
+     * Play the intro animation
+     * @default false
+     */
     playIntro?: boolean;
+    /** Enable graphql query debugging */
     graphQlDebug?: boolean;
+    /** Enable request and render timing measurement */
     debugTiming?: boolean;
 };
+/**
+ * The main function to start the client side rendering
+ *
+ * ## Example
+ * ```
+ * import * as app from './App.svelte';
+ * import * as errorPage from './Error.svelte';
+ * import entryQuery from './queries/entry.graphql';
+ * import globalQuery from './queries/global.graphql';
+ * import { main } from 'crelte/client';
+ *
+ * main({
+ *     app,
+ *     errorPage,
+ *     entryQuery,
+ *     globalQuery,
+ * });
+ * ```
+ */
 export declare function main(data: MainData): void;
 //# sourceMappingURL=client.d.ts.map

package/dist/init/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/init/client.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,QAAQ,GAAG;IAEtB,GAAG,EAAE,GAAG,CAAC;IAET,SAAS,EAAE,GAAG,CAAC;IACf,UAAU,EAAE,GAAG,CAAC;IAChB,WAAW,CAAC,EAAE,GAAG,CAAC;IAGlB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IAGpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAYF,wBAAgB,IAAI,CAAC,IAAI,EAAE,QAAQ,QAsIlC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/init/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAKrD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACtB,4BAA4B;IAC5B,GAAG,EAAE,GAAG,CAAC;IACT,8BAA8B;IAC9B,SAAS,EAAE,GAAG,CAAC;IACf,iDAAiD;IACjD,UAAU,EAAE,YAAY,CAAC;IACzB,mDAAmD;IACnD,WAAW,CAAC,EAAE,YAAY,CAAC;IAI3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAIpB,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,mDAAmD;IACnD,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAYF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,QAAQ,QAsIlC"}