crelte 0.1.0 → 0.1.2

package/dist/init/client.js

@@ -1,4 +1,5 @@
 import { CrelteBuilder } from '../Crelte.js';
+import CrelteRequest from '../CrelteRequest.js';
 import { loadFn, pluginsBeforeRender, setupPlugins } from './shared.js';
 import { tick } from 'svelte';
 const mainDataDefault = {
@@ -9,6 +10,25 @@ const mainDataDefault = {
     graphQlDebug: false,
     debugTiming: false,
 };
+/**
+ * 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 function main(data) {
     data = { ...mainDataDefault, ...data };
     // rendering steps
@@ -29,7 +49,7 @@ export function main(data) {
         debug: data.graphQlDebug,
         debugTiming: data.debugTiming,
     });
-    // on the client the cookies are always comming from document.cookie
+    // on the client the cookies are always coming from document.cookie
     builder.setupCookies('');
     const csites = builder.ssrCache.get('crelteSites');
     builder.setupRouter(csites, {
@@ -51,8 +71,8 @@ export function main(data) {
     // setup plugins
     setupPlugins(crelte, data.app.plugins ?? []);
     // setup load Data
-    crelte.router._internal.onLoad = (route, site, opts) => {
-        const cr = crelte.toRouted(route, site);
+    crelte.router._internal.onLoad = (req, site, opts) => {
+        const cr = new CrelteRequest(crelte, req, site);
         return loadFn(cr, data.app, data.entryQuery, data.globalQuery, opts);
     };
     // render Space
@@ -72,7 +92,7 @@ export function main(data) {
         }
     };
     let firstLoad = true;
-    crelte.router._internal.onLoaded = async (success, route, site, readyForProps) => {
+    crelte.router._internal.onLoaded = async (success, req, site, readyForProps) => {
         const isFirstLoad = firstLoad;
         firstLoad = false;
         if (!success) {
@@ -87,7 +107,7 @@ export function main(data) {
             }
             return handleLoadError(readyForProps());
         }
-        const cr = crelte.toRouted(route, site);
+        const cr = new CrelteRequest(crelte, req, site);
         const startTime = data.debugTiming ? Date.now() : null;
         let render = async () => {
             // we should trigger the route update here
@@ -98,7 +118,7 @@ export function main(data) {
             if (startTime) {
                 console.log('dom update took ' + (Date.now() - startTime) + 'ms');
             }
-            crelte.router._internal.domReady(route);
+            crelte.router._internal.domReady(cr.req);
         };
         // render with view Transition if enabled and not in hydration
         if (data.viewTransition &&

package/dist/init/server.d.ts

@@ -1,3 +1,4 @@
+import { GraphQlQuery } from '../graphql/GraphQl.js';
 export type ServerData = {
     url: string;
     htmlTemplate: string;
@@ -8,14 +9,43 @@ export type ServerData = {
     viteEnv: Map<string, string>;
     cookies?: string;
 };
+/**
+ * The main function to start the server side rendering
+ */
 export type MainData = {
+    /** The App.svelte module */
     app: any;
-    entryQuery: any;
-    globalQuery?: any;
+    /** The entry query from queries/entry.graphql */
+    entryQuery: GraphQlQuery;
+    /** The global query from queries/global.graphql */
+    globalQuery?: GraphQlQuery;
+    /** Server data provided by crelte-node */
     serverData: ServerData;
+    /** Enable graphql query debugging */
     graphQlDebug?: boolean;
+    /** Enable request and render timing measurement */
     debugTiming?: boolean;
 };
+/**
+ * The main function to start the server side rendering
+ *
+ * ## Example
+ * ```
+ * import * as app from './App.svelte';
+ * import entryQuery from './queries/entry.graphql';
+ * import globalQuery from './queries/global.graphql';
+ * import { main } from 'crelte/server';
+ *
+ * export function render(serverData) {
+ *     return main({
+ *         app,
+ *         entryQuery,
+ *         globalQuery,
+ *         serverData,
+ *     });
+ * }
+ * ```
+ */
 export declare function main(data: MainData): Promise<{
     status: number;
     location?: string;
@@ -31,6 +61,23 @@ export type MainErrorData = {
     errorPage: any;
     serverData: ServerData;
 };
+/**
+ * The main function to start the server side rendering
+ * if there was an error
+ *
+ * ## Example
+ * ```
+ * import * as errorPage from './Error.svelte';
+ *
+ * export function renderError(error, serverData) {
+ *     return mainError({
+ *         error,
+ *         errorPage,
+ *         serverData
+ *     });
+ * }
+ * ```
+ */
 export declare function mainError(data: MainErrorData): Promise<{
     status: number;
     html?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../../src/init/server.ts"],"names":[],"mappings":"AAOA,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IAEtB,GAAG,EAAE,GAAG,CAAC;IACT,UAAU,EAAE,GAAG,CAAC;IAChB,WAAW,CAAC,EAAE,GAAG,CAAC;IAElB,UAAU,EAAE,UAAU,CAAC;IAGvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,wBAAsB,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC,CA4ED;AAED,MAAM,MAAM,KAAK,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAE3B,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE,GAAG,CAAC;IAEf,UAAU,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,wBAAsB,SAAS,CAC9B,IAAI,EAAE,aAAa,GACjB,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA0B5C"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../../src/init/server.ts"],"names":[],"mappings":"AAOA,OAAO,EAAO,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACtB,4BAA4B;IAC5B,GAAG,EAAE,GAAG,CAAC;IACT,iDAAiD;IACjD,UAAU,EAAE,YAAY,CAAC;IACzB,mDAAmD;IACnD,WAAW,CAAC,EAAE,YAAY,CAAC;IAE3B,0CAA0C;IAC1C,UAAU,EAAE,UAAU,CAAC;IAIvB,qCAAqC;IACrC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,mDAAmD;IACnD,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC,CA4ED;AAED,MAAM,MAAM,KAAK,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAE3B,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE,GAAG,CAAC;IAEf,UAAU,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,SAAS,CAC9B,IAAI,EAAE,aAAa,GACjB,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CA0B5C"}

package/dist/init/server.js

@@ -2,6 +2,28 @@ import { CrelteBuilder } from '../Crelte.js';
 import { loadFn, pluginsBeforeRender, setupPlugins } from './shared.js';
 import SsrComponents from '../ssr/SsrComponents.js';
 import SsrCache from '../ssr/SsrCache.js';
+import CrelteRequest from '../CrelteRequest.js';
+import { gql } from '../graphql/GraphQl.js';
+/**
+ * The main function to start the server side rendering
+ *
+ * ## Example
+ * ```
+ * import * as app from './App.svelte';
+ * import entryQuery from './queries/entry.graphql';
+ * import globalQuery from './queries/global.graphql';
+ * import { main } from 'crelte/server';
+ *
+ * export function render(serverData) {
+ *     return main({
+ *         app,
+ *         entryQuery,
+ *         globalQuery,
+ *         serverData,
+ *     });
+ * }
+ * ```
+ */
 export async function main(data) {
     const builder = new CrelteBuilder();
     // setup viteEnv
@@ -24,23 +46,23 @@ export async function main(data) {
     // setup plugins
     setupPlugins(crelte, data.app.plugins ?? []);
     // setup load Data
-    crelte.router._internal.onLoad = (route, site) => {
-        const cr = crelte.toRouted(route, site);
+    crelte.router._internal.onLoad = (req, site) => {
+        const cr = new CrelteRequest(crelte, req, site);
         return loadFn(cr, data.app, data.entryQuery, data.globalQuery);
     };
-    const { success, redirect, route, site, props } = await crelte.router._internal.initServer(data.serverData.url, data.serverData.acceptLang);
+    const { success, redirect, req, site, props } = await crelte.router._internal.initServer(data.serverData.url, data.serverData.acceptLang);
     if (!success)
         throw props;
     if (redirect) {
         return {
             status: 302,
-            location: route.url.toString(),
+            location: req.url.toString(),
         };
     }
     const context = crelte._getContext();
     const ssrComponents = new SsrComponents();
     ssrComponents.addToContext(context);
-    pluginsBeforeRender(crelte.toRouted(route, site));
+    pluginsBeforeRender(new CrelteRequest(crelte, req, site));
     crelte.globals._updateSiteId(site.id);
     // eslint-disable-next-line prefer-const
     let { html, head } = data.app.default.render(props, { context });
@@ -58,6 +80,23 @@ export async function main(data) {
         setCookies: crelte.cookies._getSetCookiesHeaders(),
     };
 }
+/**
+ * The main function to start the server side rendering
+ * if there was an error
+ *
+ * ## Example
+ * ```
+ * import * as errorPage from './Error.svelte';
+ *
+ * export function renderError(error, serverData) {
+ *     return mainError({
+ *         error,
+ *         errorPage,
+ *         serverData
+ *     });
+ * }
+ * ```
+ */
 export async function mainError(data) {
     const ssrCache = new SsrCache();
     const context = new Map();
@@ -86,7 +125,18 @@ async function loadSites(builder) {
         // @ts-ignore
         return globalThis['CRAFT_SITES_CACHED'];
     }
-    const resp = (await builder.graphQl.request('query { crelteSites { id baseUrl language name handle primary } }', {}, 
+    const resp = (await builder.graphQl.query(gql `
+			query {
+				crelteSites {
+					id
+					baseUrl
+					language
+					name
+					handle
+					primary
+				}
+			}
+		`, {}, 
     // don't cache since we cache ourself
     { caching: false }));
     // @ts-ignore

package/dist/init/shared.d.ts

@@ -1,5 +1,6 @@
-import CrelteRouted, { GraphQlQuery } from '../CrelteRouted.js';
 import Crelte from '../Crelte.js';
+import CrelteRequest from '../CrelteRequest.js';
+import { GraphQlQuery } from '../graphql/GraphQl.js';
 import { LoadData } from '../loadData/index.js';
 import { PluginCreator } from '../plugins/Plugins.js';
 import { LoadOptions } from '../routing/PageLoader.js';
@@ -10,11 +11,11 @@ interface App<D, E, T> {
 }
 interface TemplateModule<E, T> {
     default: any;
-    loadData?(cr: CrelteRouted, entry: E): Promise<T>;
+    loadData?(cr: CrelteRequest, entry: E): Promise<T>;
 }
 type LazyTemplateModule<E, T> = (() => Promise<TemplateModule<E, T>>) | TemplateModule<E, T>;
 export declare function setupPlugins(crelte: Crelte, plugins: PluginCreator[]): void;
-export declare function pluginsBeforeRender(cr: CrelteRouted): void;
+export declare function pluginsBeforeRender(cr: CrelteRequest): void;
 /**
  * Get the entry from the page
  *
@@ -24,6 +25,6 @@ export declare function pluginsBeforeRender(cr: CrelteRouted): void;
  * sectionHandle will be automatically set to product
  */
 export declare function getEntry(page: any): any;
-export declare function loadFn<D, E, T>(cr: CrelteRouted, app: App<D, E, T>, entryQuery: GraphQlQuery, globalQuery?: GraphQlQuery, loadOpts?: LoadOptions): Promise<any>;
+export declare function loadFn<D, E, T>(cr: CrelteRequest, app: App<D, E, T>, entryQuery: GraphQlQuery, globalQuery?: GraphQlQuery, loadOpts?: LoadOptions): Promise<any>;
 export {};
 //# sourceMappingURL=shared.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../../src/init/shared.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,EAAE,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAgB,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAG7B,aAAa,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CACrD;AAED,UAAU,cAAc,CAAC,CAAC,EAAE,CAAC;IAE5B,OAAO,EAAE,GAAG,CAAC;IAEb,QAAQ,CAAC,CAAC,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAClD;AAED,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IACzB,CAAC,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GACrC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAKpE;AAED,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAE1D;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAYvC;AAED,wBAAsB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACnC,EAAE,EAAE,YAAY,EAChB,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACjB,UAAU,EAAE,YAAY,EACxB,WAAW,CAAC,EAAE,YAAY,EAC1B,QAAQ,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,GAAG,CAAC,CAsGd"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../../src/init/shared.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAgB,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAG7B,aAAa,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE9B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CACrD;AAED,UAAU,cAAc,CAAC,CAAC,EAAE,CAAC;IAE5B,OAAO,EAAE,GAAG,CAAC;IAEb,QAAQ,CAAC,CAAC,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACnD;AAED,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IACzB,CAAC,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GACrC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAKpE;AAED,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAYvC;AAED,wBAAsB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACnC,EAAE,EAAE,aAAa,EACjB,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACjB,UAAU,EAAE,YAAY,EACxB,WAAW,CAAC,EAAE,YAAY,EAC1B,QAAQ,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,GAAG,CAAC,CAsGd"}

package/dist/init/shared.js

@@ -52,15 +52,15 @@ export async function loadFn(cr, app, entryQuery, globalQuery, loadOpts) {
         })();
     }
     let pageProm = null;
-    if (cr.route.site) {
-        let uri = decodeURI(cr.route.uri);
+    if (cr.req.site) {
+        let uri = decodeURI(cr.req.uri);
         if (uri.startsWith('/'))
             uri = uri.substring(1);
         if (uri === '' || uri === '/')
             uri = '__home__';
         pageProm = cr.query(entryQuery, {
             uri,
-            siteId: cr.route.site.id,
+            siteId: cr.req.site.id,
         });
     }
     const pluginsLoadGlobalData = cr.events.trigger('loadGlobalData', cr);

package/dist/loadData/Globals.d.ts

@@ -5,16 +5,44 @@ export default class Globals {
     private loaded;
     private prevSiteId;
     constructor();
-    get(name: string): Global<any> | null;
-    getAsync(name: string): Promise<Global<any> | null> | Global<any> | null;
+    /**
+     * returns a store which contains a globalSet
+     *
+     * ## Note
+     * This only works in loadData, in loadGlobalData this will
+     * always return null. In that context you should use
+     * `.getGlobalAsync`
+     */
+    get<T extends GlobalData>(name: string): Global<T> | null;
+    /**
+     * Get a store which contains a globalSet and wait until it is loaded
+     *
+     * ## Note
+     * This is only useful in loadGlobalData in all other cases
+     * you can use `.getGlobal` which does return a Promise
+     */
+    getAsync<T extends GlobalData>(name: string): Promise<Global<T> | null> | Global<T> | null;
+    /** @hidden */
     _wasLoaded(): boolean;
+    /** @hidden */
     _setData(siteId: number, data: any): void;
+    /** @hidden */
     _globalsBySite(siteId: number): Map<string, any>;
+    /** @hidden */
     _updateSiteId(siteId: number): void;
 }
+/**
+ * A globalSet Data
+ *
+ * Each global query should contain the siteId
+ */
 export interface GlobalData {
     siteId?: number;
+    [key: string]: any;
 }
+/**
+ * A globalSet store
+ */
 export declare class Global<T extends GlobalData> {
     private inner;
     private languages;
@@ -26,8 +54,19 @@ export declare class Global<T extends GlobalData> {
      * @return a function which should be called to unsubscribe
      */
     subscribe(fn: (val: T) => void): () => void;
+    /**
+     * The current value
+     */
     get(): T;
+    /**
+     * Get the value based on the siteId
+     *
+     * ## Note
+     * If you pass a siteId which comes from craft
+     * you will never receive null
+     */
     bySiteId(siteId: number): T | null;
+    /** @hidden */
     _updateSiteId(siteId: number): void;
 }
 //# sourceMappingURL=Globals.d.ts.map

package/dist/loadData/Globals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Globals.d.ts","sourceRoot":"","sources":["../../../../src/loadData/Globals.ts"],"names":[],"mappings":"AAUA,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC;AAE9D,MAAM,CAAC,OAAO,OAAO,OAAO;IAG3B,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,UAAU,CAAgB;;IASlC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;IAMrC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI;IAexE,UAAU,IAAI,OAAO;IAQrB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAgBlC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;IAUhD,aAAa,CAAC,MAAM,EAAE,MAAM;CAM5B;AAED,MAAM,WAAW,UAAU;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,MAAM,CAAC,CAAC,SAAS,UAAU;IACvC,OAAO,CAAC,KAAK,CAAc;IAE3B,OAAO,CAAC,SAAS,CAAa;gBAElB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM;IAsBvD;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAI3C,GAAG,IAAI,CAAC;IAKR,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAOlC,aAAa,CAAC,MAAM,EAAE,MAAM;CAM5B"}
+{"version":3,"file":"Globals.d.ts","sourceRoot":"","sources":["../../../../src/loadData/Globals.ts"],"names":[],"mappings":"AAUA,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC;AAE9D,MAAM,CAAC,OAAO,OAAO,OAAO;IAG3B,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,UAAU,CAAgB;;IASlC;;;;;;;OAOG;IACH,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI;IAIzD;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,SAAS,UAAU,EAC5B,IAAI,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI;IAc/C,cAAc;IACd,UAAU,IAAI,OAAO;IAOrB,cAAc;IACd,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAgBlC,cAAc;IACd,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;IAUhD,cAAc;IACd,aAAa,CAAC,MAAM,EAAE,MAAM;CAM5B;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,MAAM,CAAC,CAAC,SAAS,UAAU;IACvC,OAAO,CAAC,KAAK,CAAc;IAE3B,OAAO,CAAC,SAAS,CAAa;gBAElB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM;IAsBvD;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAI3C;;OAEG;IACH,GAAG,IAAI,CAAC;IAIR;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAOlC,cAAc;IACd,aAAa,CAAC,MAAM,EAAE,MAAM;CAM5B"}

package/dist/loadData/Globals.js

@@ -19,11 +19,24 @@ export default class Globals {
         this.loaded = false;
         this.prevSiteId = null;
     }
+    /**
+     * returns a store which contains a globalSet
+     *
+     * ## Note
+     * This only works in loadData, in loadGlobalData this will
+     * always return null. In that context you should use
+     * `.getGlobalAsync`
+     */
     get(name) {
         return this.entries.get(name) ?? null;
     }
-    // call this only in loadGlobalData when by default the global
-    // is not available
+    /**
+     * Get a store which contains a globalSet and wait until it is loaded
+     *
+     * ## Note
+     * This is only useful in loadGlobalData in all other cases
+     * you can use `.getGlobal` which does return a Promise
+     */
     getAsync(name) {
         if (this.loaded)
             return this.get(name);
@@ -36,14 +49,14 @@ export default class Globals {
             waiter.push(resolve);
         });
     }
-    // hidden
+    /** @hidden */
     _wasLoaded() {
         return this.loaded;
     }
-    // hidden
     // data is the data from the global graphql
     // so it contains some keys and data which should be parsed
     // and created a store for each key
+    /** @hidden */
     _setData(siteId, data) {
         const wasLoaded = this.loaded;
         this.loaded = true;
@@ -57,6 +70,7 @@ export default class Globals {
             this.waiters.clear();
         }
     }
+    /** @hidden */
     _globalsBySite(siteId) {
         const map = new Map();
         for (const [key, global] of this.entries) {
@@ -64,6 +78,7 @@ export default class Globals {
         }
         return map;
     }
+    /** @hidden */
     _updateSiteId(siteId) {
         // todo we should only trigger
         if (this.prevSiteId === siteId)
@@ -71,6 +86,9 @@ export default class Globals {
         this.entries.forEach(global => global._updateSiteId(siteId));
     }
 }
+/**
+ * A globalSet store
+ */
 export class Global {
     inner;
     /// if languages is null this means we always have the same data
@@ -101,15 +119,25 @@ export class Global {
     subscribe(fn) {
         return this.inner.subscribe(fn);
     }
+    /**
+     * The current value
+     */
     get() {
         return this.inner.get();
     }
-    /// if you pass a siteId which comes from craft then you will never receive null
+    /**
+     * Get the value based on the siteId
+     *
+     * ## Note
+     * If you pass a siteId which comes from craft
+     * you will never receive null
+     */
     bySiteId(siteId) {
         if (this.languages)
             return this.languages.find(d => d.siteId === siteId) ?? null;
         return this.inner.get();
     }
+    /** @hidden */
     _updateSiteId(siteId) {
         if (!this.languages)
             return;

package/dist/loadData/index.d.ts

@@ -1,24 +1,87 @@
-/**
- *
- */
-import type CrelteRouted from '../CrelteRouted.js';
+import CrelteRequest from '../CrelteRequest.js';
 import { type GraphQlQuery } from '../graphql/GraphQl.js';
 import type Globals from './Globals.js';
 import type { Global } from './Globals.js';
 export type { Globals, Global };
-export type LoadData<T> = ((cr: CrelteRouted, ...args: any[]) => Promise<T>) | GraphQlQuery | T;
-export declare function callLoadData(ld: LoadData<unknown>, cr: CrelteRouted, ...args: any[]): Promise<unknown>;
+/**
+ * Load data function
+ *
+ * There are three main ways `loadData` can be defined:
+ *
+ * ## Object
+ * This is the most common way loadData will be used.
+ * Each property should be a loadData type, each one is called in parallel.
+ * And will be available to your component with the same name.
+ * ```
+ * export const loadData = {
+ *
+ * import entriesQuery from '@/queries/entries.graphql';
+ * import { loadData as headerLoadData } from '@/layout/header.svelte';
+ *
+ * export const loadData = {
+ *     entries: entriesQuery,
+ *     header: headerLoadData
+ * };
+ * ```
+ *
+ * ## GraphQl
+ * You can just export a graphql query as a loadData type.
+ * This will export all queries from the graphql file as properties.
+ * ```
+ * import blogsQuery from '@/queries/blogs.graphql';
+ *
+ * export const loadData = blogsQuery;
+ *
+ * // or another option
+ * import { gql } from '@craft-svelte/core/graphql';
+ *
+ * export const loadData = gql`query {
+ *   blogs: entries(section: "blogs") {
+ *     title
+ *     url
+ *  }
+ * }`;
+ * ```
+ *
+ * ## Function
+ * Using a function gives you the most flexibility but also is the
+ * most cumbersome.
+ *
+ * ```
+ * import articlesQuery from '@/queries/articles.graphql';
+ *
+ * export async function loadData(cr, entry) {
+ *     return await cr.query(articlesQuery, {
+ *         category: entry.category
+ *     });
+ * }
+ *
+ * // or
+ * export const loadData = (cr, entry) => cr.query(articlesQuery, {
+ *     category: entry.category
+ * });
+ *
+ * // or if you're in the context of an object
+ * export const loadData = {
+ *     articles: (cr, entry) => cr.query(articlesQuery, {
+ *         category: entry.category
+ *     })
+ * }
+ * ```
+ */
+export type LoadData<T> = ((cr: CrelteRequest, ...args: any[]) => Promise<T>) | GraphQlQuery | T;
+export declare function callLoadData(ld: LoadData<unknown>, cr: CrelteRequest, ...args: any[]): Promise<unknown>;
 /**
  * Spread the data of two loadData functions.
  *
  * ## Example
  * ```
  * export const loadData = mergeLoadData(
- * 		{
- * 			filter: (cr) => cr.route.search.get('filter'),
- * 		},
- * 		(cr) => cr.query(myQuery, { siteId: cr.site.id })
- * )
+ *     {
+ * 	        filter: (cr) => cr.route.search.get('filter'),
+ *     },
+ *     (cr) => cr.query(myQuery, { siteId: cr.site.id })
+ * );
  * ```
  */
 export declare function mergeLoadData(...lds: LoadData<object>[]): LoadData<object>;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/loadData/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAkB,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAEhC,MAAM,MAAM,QAAQ,CAAC,CAAC,IACnB,CAAC,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,GAClD,YAAY,GACZ,CAAC,CAAC;AAEL,wBAAsB,YAAY,CACjC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,EACrB,EAAE,EAAE,YAAY,EAChB,GAAG,IAAI,EAAE,GAAG,EAAE,GACZ,OAAO,CAAC,OAAO,CAAC,CAuBlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,GAAG,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAQ1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/loadData/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAkB,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AAEH,MAAM,MAAM,QAAQ,CAAC,CAAC,IACnB,CAAC,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,GACnD,YAAY,GACZ,CAAC,CAAC;AAEL,wBAAsB,YAAY,CACjC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,EACrB,EAAE,EAAE,aAAa,EACjB,GAAG,IAAI,EAAE,GAAG,EAAE,GACZ,OAAO,CAAC,OAAO,CAAC,CAuBlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,GAAG,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAQ1E"}

package/dist/loadData/index.js

@@ -1,6 +1,3 @@
-/**
- *
- */
 import { isGraphQlQuery } from '../graphql/GraphQl.js';
 export async function callLoadData(ld, cr, ...args) {
     // either we have a function
@@ -24,11 +21,11 @@ export async function callLoadData(ld, cr, ...args) {
  * ## Example
  * ```
  * export const loadData = mergeLoadData(
- * 		{
- * 			filter: (cr) => cr.route.search.get('filter'),
- * 		},
- * 		(cr) => cr.query(myQuery, { siteId: cr.site.id })
- * )
+ *     {
+ * 	        filter: (cr) => cr.route.search.get('filter'),
+ *     },
+ *     (cr) => cr.query(myQuery, { siteId: cr.site.id })
+ * );
  * ```
  */
 export function mergeLoadData(...lds) {

package/dist/plugins/Events.d.ts

@@ -1,11 +1,24 @@
-import { CrelteRouted } from '../index.js';
+import { CrelteRequest } from '../index.js';
 export default class Events {
     inner: Map<string, Set<any>>;
     constructor();
-    on(ev: 'loadGlobalData', fn: (cr: CrelteRouted) => Promise<any>): () => void;
-    on(ev: 'loadData', fn: (cr: CrelteRouted, entry: any, data: any) => Promise<any>): () => void;
-    on(ev: 'beforeRender', fn: (cr: CrelteRouted) => void): () => void;
+    /**
+     * Listens for an event.
+     *
+     * @returns a function to remove the listener
+     */
+    on(ev: 'loadGlobalData', fn: (cr: CrelteRequest) => Promise<any>): () => void;
+    on(ev: 'loadData', fn: (cr: CrelteRequest, entry: any) => Promise<any>): () => void;
+    on(ev: 'beforeRender', fn: (cr: CrelteRequest) => void): () => void;
+    /**
+     * Remove a listener
+     */
     remove(ev: string, fn: any): void;
-    trigger(ev: string, ...args: any[]): any[];
+    /**
+     * Trigger an event
+     */
+    trigger(ev: 'loadGlobalData', cr: CrelteRequest): Promise<any>[];
+    trigger(ev: 'loadData', cr: CrelteRequest, entry: any): Promise<any>[];
+    trigger(ev: 'beforeRender', cr: CrelteRequest): void[];
 }
 //# sourceMappingURL=Events.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Events.d.ts","sourceRoot":"","sources":["../../../../src/plugins/Events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;;IAU7B,EAAE,CACD,EAAE,EAAE,gBAAgB,EACpB,EAAE,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,OAAO,CAAC,GAAG,CAAC,GACpC,MAAM,IAAI;IACb,EAAE,CACD,EAAE,EAAE,UAAU,EACd,EAAE,EAAE,CAAC,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,GAC3D,MAAM,IAAI;IACb,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI;IAelE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG;IAO1B,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE;CAM1C"}
+{"version":3,"file":"Events.d.ts","sourceRoot":"","sources":["../../../../src/plugins/Events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;;IAM7B;;;;OAIG;IAEH,EAAE,CACD,EAAE,EAAE,gBAAgB,EACpB,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,KAAK,OAAO,CAAC,GAAG,CAAC,GACrC,MAAM,IAAI;IACb,EAAE,CACD,EAAE,EAAE,UAAU,EACd,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,GACjD,MAAM,IAAI;IACb,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,IAAI;IAenE;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG;IAO1B;;OAEG;IACH,OAAO,CAAC,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE;IAChE,OAAO,CAAC,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE;IACtE,OAAO,CAAC,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,aAAa,GAAG,IAAI,EAAE;CAOtD"}

package/dist/plugins/Events.js

@@ -14,6 +14,9 @@ export default class Events {
             set.delete(fn);
         };
     }
+    /**
+     * Remove a listener
+     */
     remove(ev, fn) {
         const set = this.inner.get(ev);
         if (!set)