crelte 0.1.0 → 0.1.2

package/dist/Crelte.d.ts

@@ -1,13 +1,10 @@
 import { Cookies } from './cookies/index.js';
-import CrelteBase from './CrelteBase.js';
-import CrelteRouted, { GraphQlQuery } from './CrelteRouted.js';
-import GraphQl, { GraphQlOptions, GraphQlRequestOptions } from './graphql/GraphQl.js';
-import Globals from './loadData/Globals.js';
+import GraphQl, { GraphQlOptions, GraphQlQuery } from './graphql/GraphQl.js';
+import Globals, { Global, GlobalData } from './loadData/Globals.js';
 import Events from './plugins/Events.js';
 import Plugins, { Plugin } from './plugins/Plugins.js';
-import Route from './routing/Route.js';
-import Router, { RouterOpts } from './routing/Router.js';
-import Site, { SiteFromGraphQl } from './routing/Site.js';
+import Router, { RouterOptions } from './routing/Router.js';
+import { SiteFromGraphQl } from './routing/Site.js';
 import SsrCache from './ssr/SsrCache.js';
 export declare class CrelteBuilder {
     ssrCache: SsrCache;
@@ -19,37 +16,104 @@ export declare class CrelteBuilder {
     cookies: Cookies;
     constructor();
     setupGraphQl(endpoint: string, opts?: GraphQlOptions): void;
-    setupRouter(sites: SiteFromGraphQl[], opts?: RouterOpts): void;
+    setupRouter(sites: SiteFromGraphQl[], opts?: RouterOptions): void;
     setupCookies(cookies: string): void;
     build(): Crelte;
 }
-export default class Crelte implements CrelteBase {
-    ssrCache: SsrCache;
-    graphQl: GraphQl;
-    router: Router;
-    plugins: Plugins;
-    events: Events;
-    globals: Globals;
-    cookies: Cookies;
-    constructor(builder: CrelteBuilder);
+/**
+ * Options to configure the request
+ */
+export type QueryOptions = {
+    /**
+     * Ignore the response status code
+     * @default false
+     */
+    ignoreStatusCode?: boolean;
+    /**
+     * Configure caching
+     * @default true
+     */
+    caching?: boolean;
+    /**
+     * Status code of the response
+     * This will be set after the request if
+     * `ignoreStatusCode` is set to `true`
+     */
+    status?: number;
+};
+/**
+ * This is the main class of Crelte and can be accessed
+ * in component initialisation via `getCrelte()` and is the
+ * first parameter in `loadData`
+ */
+export default class Crelte {
+    protected _ssrCache: SsrCache;
+    protected _graphQl: GraphQl;
+    protected _router: Router;
+    protected _plugins: Plugins;
+    protected _events: Events;
+    protected _globals: Globals;
+    protected _cookies: Cookies;
+    constructor(builder: CrelteBuilder | Crelte);
+    /**
+     * Get the SSR cache
+     */
+    get ssrCache(): SsrCache;
+    /**
+     * Get the GraphQl instance
+     */
+    get graphQl(): GraphQl;
+    /**
+     * Get the Router instance
+     */
+    get router(): Router;
+    /**
+     * Get the Plugins instance
+     */
+    get plugins(): Plugins;
+    /**
+     * Get the Events instance
+     */
+    get events(): Events;
+    /**
+     * Get the Globals instance
+     */
+    get globals(): Globals;
+    /**
+     * Get the Cookies instance
+     */
+    get cookies(): Cookies;
+    /**
+     * Get a Plugin by name
+     */
     getPlugin(name: string): Plugin | null;
     /**
-     * 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
      */
+    getEnv(name: 'ENDPOINT_URL'): string;
+    getEnv(name: 'CRAFT_WEB_URL'): string;
     getEnv(name: string): string | null;
-    getGlobal(name: string): any | null;
-    toRouted(route?: Route, site?: Site): CrelteRouted;
+    /**
+     * 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
+     * `CrelteRequest.getGlobalAsync`
+     */
+    getGlobal<T extends GlobalData>(name: string): Global<T> | null;
     /**
      * Run a GraphQl Query
      *
-     * @param query the default export from a graphql file
+     * @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
-     * @param options opts `{ caching: true, previewToken: string,
-     * siteToken: string, ignoreStatusCode: false, headers: {} }`
      */
-    query(query: GraphQlQuery, variables?: Record<string, unknown>, opts?: GraphQlRequestOptions): Promise<unknown>;
+    query(query: GraphQlQuery, variables?: Record<string, unknown>, opts?: QueryOptions): Promise<unknown>;
+    /** @hidden */
     _getContext(): Map<string, any>;
 }
 //# sourceMappingURL=Crelte.d.ts.map

package/dist/Crelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Crelte.d.ts","sourceRoot":"","sources":["../../../src/Crelte.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,YAAY,EAAE,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,OAAO,EAAE,EACf,cAAc,EACd,qBAAqB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAC5C,OAAO,MAAM,MAAM,qBAAqB,CAAC;AACzC,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,MAAM,oBAAoB,CAAC;AACvC,OAAO,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,qBAAa,aAAa;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;;IAajB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,cAAmB;IAIxD,WAAW,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,GAAE,UAAe;IAI3D,YAAY,CAAC,OAAO,EAAE,MAAM;IAI5B,KAAK,IAAI,MAAM;CAGf;AAED,MAAM,CAAC,OAAO,OAAO,MAAO,YAAW,UAAU;IAChD,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;gBAEL,OAAO,EAAE,aAAa;IAalC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAItC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAMnC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI;IAKnC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,YAAY;IAalD;;;;;;;;OAQG;IACG,KAAK,CACV,KAAK,EAAE,YAAY,EACnB,SAAS,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACvC,IAAI,GAAE,qBAA0B,GAC9B,OAAO,CAAC,OAAO,CAAC;IAMnB,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;CAO/B"}
+{"version":3,"file":"Crelte.d.ts","sourceRoot":"","sources":["../../../src/Crelte.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,OAAO,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,MAAM,MAAM,qBAAqB,CAAC;AACzC,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,qBAAa,aAAa;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;;IAajB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,cAAmB;IAIxD,WAAW,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,IAAI,GAAE,aAAkB;IAI9D,YAAY,CAAC,OAAO,EAAE,MAAM;IAI5B,KAAK,IAAI,MAAM;CAGf;AACD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC9B,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;gBAEhB,OAAO,EAAE,aAAa,GAAG,MAAM;IAa3C;;OAEG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAItC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM;IACpC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IACrC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAKnC;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI;IAI/D;;;;;;;OAOG;IACG,KAAK,CACV,KAAK,EAAE,YAAY,EACnB,SAAS,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACvC,IAAI,GAAE,YAAiB,GACrB,OAAO,CAAC,OAAO,CAAC;IAQnB,cAAc;IACd,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;CAO/B"}

package/dist/Crelte.js

@@ -1,6 +1,5 @@
 import ClientCookies from './cookies/ClientCookies.js';
 import ServerCookies from './cookies/ServerCookies.js';
-import CrelteRouted from './CrelteRouted.js';
 import GraphQl from './graphql/GraphQl.js';
 import Globals from './loadData/Globals.js';
 import Events from './plugins/Events.js';
@@ -38,66 +37,108 @@ export class CrelteBuilder {
         return new Crelte(this);
     }
 }
+/**
+ * This is the main class of Crelte and can be accessed
+ * in component initialisation via `getCrelte()` and is the
+ * first parameter in `loadData`
+ */
 export default class Crelte {
-    ssrCache;
-    graphQl;
-    router;
-    plugins;
-    events;
-    globals;
-    cookies;
+    _ssrCache;
+    _graphQl;
+    _router;
+    _plugins;
+    _events;
+    _globals;
+    _cookies;
     constructor(builder) {
         if (!builder.graphQl || !builder.router)
             throw new Error('builder not ready');
-        this.ssrCache = builder.ssrCache;
-        this.graphQl = builder.graphQl;
-        this.router = builder.router;
-        this.plugins = builder.plugins;
-        this.events = builder.events;
-        this.globals = builder.globals;
-        this.cookies = builder.cookies;
+        this._ssrCache = builder.ssrCache;
+        this._graphQl = builder.graphQl;
+        this._router = builder.router;
+        this._plugins = builder.plugins;
+        this._events = builder.events;
+        this._globals = builder.globals;
+        this._cookies = builder.cookies;
     }
-    getPlugin(name) {
-        return this.plugins.get(name);
+    /**
+     * Get the SSR cache
+     */
+    get ssrCache() {
+        return this._ssrCache;
+    }
+    /**
+     * Get the GraphQl instance
+     */
+    get graphQl() {
+        return this._graphQl;
+    }
+    /**
+     * Get the Router instance
+     */
+    get router() {
+        return this._router;
+    }
+    /**
+     * Get the Plugins instance
+     */
+    get plugins() {
+        return this._plugins;
+    }
+    /**
+     * Get the Events instance
+     */
+    get events() {
+        return this._events;
+    }
+    /**
+     * Get the Globals instance
+     */
+    get globals() {
+        return this._globals;
+    }
+    /**
+     * Get the Cookies instance
+     */
+    get cookies() {
+        return this._cookies;
     }
     /**
-     * returns an env Variables, always needs to be prefixed VITE_
-     * Except ENDPOINT_URL and CRAFT_WEB_URL
+     * Get a Plugin by name
      */
+    getPlugin(name) {
+        return this.plugins.get(name);
+    }
     getEnv(name) {
         return this.ssrCache.get(name);
     }
-    /// calling this from loadGlobalData will always return null
-    /// this does return the resolved store
+    /**
+     * 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
+     * `CrelteRequest.getGlobalAsync`
+     */
     getGlobal(name) {
         return this.globals.get(name) ?? null;
     }
-    /// requires a site if the route does not contain a site
-    toRouted(route, site) {
-        if (!route) {
-            route = this.router.route.get();
-        }
-        if (!site) {
-            if (!route.site)
-                throw new Error('site is required');
-            site = route.site;
-        }
-        return new CrelteRouted(this, route, site);
-    }
     /**
      * Run a GraphQl Query
      *
-     * @param query the default export from a graphql file
+     * @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
-     * @param options opts `{ caching: true, previewToken: string,
-     * siteToken: string, ignoreStatusCode: false, headers: {} }`
      */
     async query(query, variables = {}, opts = {}) {
         // this function is added as convenience
-        return this.toRouted().query(query, variables, opts);
+        return this.graphQl.query(query, variables, {
+            route: this.router.route.get(),
+            ...opts,
+        });
     }
-    // don't use
+    /** @hidden */
     _getContext() {
         const map = new Map();
         map.set('crelte', this);

package/dist/CrelteRequest.d.ts

@@ -0,0 +1,63 @@
+import Crelte, { QueryOptions } from './Crelte.js';
+import { GraphQlQuery } from './graphql/GraphQl.js';
+import Site from './routing/Site.js';
+import Request from './routing/Request.js';
+import Route from './routing/Route.js';
+import { GlobalData } from './loadData/Globals.js';
+export default class CrelteRequest extends Crelte {
+    /**
+     * The current request
+     */
+    req: Request;
+    /**
+     * The current site
+     */
+    site: Site;
+    private innerGlobals;
+    constructor(inner: Crelte, req: Request, site: Site);
+    /**
+     * Create a CrelteRequest from a Crelte instance
+     *
+     * If you don't provide a route or request the current route
+     * will be used.
+     *
+     * ## Note
+     * If you provide a route it must contain a site or you must
+     * provide one,
+     */
+    static fromCrelte(inner: Crelte, req?: Route | Request, site?: Site): CrelteRequest;
+    /**
+     * Get the current request
+     * @deprecated
+     */
+    get route(): Request;
+    /**
+     * returns a globalSet
+     *
+     * ## Note
+     * This only works in loadData, in loadGlobalData this will
+     * always return null. In that context you should use
+     * `.getGlobalAsync`
+     */
+    getGlobal<T extends GlobalData>(name: string): T | null;
+    /**
+     * Get 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
+     */
+    getGlobalAsync<T extends GlobalData>(name: string): Promise<T | null>;
+    /**
+     * 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?: QueryOptions): Promise<unknown>;
+    /** @hidden */
+    _globalDataLoaded(): void;
+}
+//# sourceMappingURL=CrelteRequest.d.ts.map

package/dist/CrelteRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrelteRequest.d.ts","sourceRoot":"","sources":["../../../src/CrelteRequest.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,IAAI,MAAM,mBAAmB,CAAC;AACrC,OAAO,OAAO,MAAM,sBAAsB,CAAC;AAC3C,OAAO,KAAK,MAAM,oBAAoB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,MAAM;IAChD;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX,OAAO,CAAC,YAAY,CAAmB;gBAG3B,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI;IAQnD;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAChB,KAAK,EAAE,MAAM,EACb,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,EACrB,IAAI,CAAC,EAAE,IAAI,GACT,aAAa;IAiBhB;;;OAGG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAIvD;;;;;;OAMG;IACG,cAAc,CAAC,CAAC,SAAS,UAAU,EACxC,IAAI,EAAE,MAAM,GACV,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAUpB;;;;;;;OAOG;IACG,KAAK,CACV,KAAK,EAAE,YAAY,EACnB,SAAS,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACvC,IAAI,GAAE,YAAiB,GACrB,OAAO,CAAC,OAAO,CAAC;IAQnB,cAAc;IACd,iBAAiB;CAGjB"}

package/dist/CrelteRequest.js

@@ -0,0 +1,94 @@
+import Crelte from './Crelte.js';
+import Request from './routing/Request.js';
+export default class CrelteRequest extends Crelte {
+    /**
+     * The current request
+     */
+    req;
+    /**
+     * The current site
+     */
+    site;
+    innerGlobals;
+    /// requires a site if the route does not contain a site
+    constructor(inner, req, site) {
+        super(inner);
+        this.req = req;
+        this.site = site;
+        this.innerGlobals = new Map();
+    }
+    /**
+     * Create a CrelteRequest from a Crelte instance
+     *
+     * If you don't provide a route or request the current route
+     * will be used.
+     *
+     * ## Note
+     * If you provide a route it must contain a site or you must
+     * provide one,
+     */
+    static fromCrelte(inner, req, site) {
+        if (!req) {
+            req = inner.router.route.get();
+        }
+        if (!site) {
+            if (!req.site)
+                throw new Error('site is required');
+            site = req.site;
+        }
+        return new CrelteRequest(inner, req instanceof Request ? req : Request.fromRoute(req), site);
+    }
+    /**
+     * Get the current request
+     * @deprecated
+     */
+    get route() {
+        return this.req;
+    }
+    /**
+     * returns a globalSet
+     *
+     * ## Note
+     * This only works in loadData, in loadGlobalData this will
+     * always return null. In that context you should use
+     * `.getGlobalAsync`
+     */
+    getGlobal(name) {
+        return this.innerGlobals.get(name) ?? null;
+    }
+    /**
+     * Get 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
+     */
+    async getGlobalAsync(name) {
+        const global = this.innerGlobals.get(name);
+        if (global)
+            return global;
+        const r = await this.globals.getAsync(name);
+        if (!r)
+            return null;
+        return r.bySiteId(this.site.id);
+    }
+    /**
+     * 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 = {}) {
+        // this function is added as convenience
+        return this.graphQl.query(query, variables, {
+            route: this.req,
+            ...opts,
+        });
+    }
+    /** @hidden */
+    _globalDataLoaded() {
+        this.innerGlobals = this.globals._globalsBySite(this.site.id);
+    }
+}

package/dist/blocks/Blocks.d.ts

@@ -1,12 +1,28 @@
-import { CrelteRouted } from '../index.js';
+import { CrelteRequest } from '../index.js';
 export interface Module {
+    /** Svelte component */
     default: any;
+    /** Handle of the block, this only works with { eager: true } */
     handle?: string | string[];
+    /** If true the typeHandle will be avaiable for this component */
     keepTypeHandle?: boolean;
-    loadData?: (block: any) => Promise<any>;
+    loadData?: (cr: CrelteRequest, block: any, opts: BlockOptions) => Promise<any>;
 }
+export type BlockOptions = {
+    /**
+     * The returns the sibling block or null if it does not exist
+     *
+     * -1 = previous block
+     * 0 = current block
+     * 1 = next block
+     */
+    getSibling: (offset: number) => Record<string, any> | null;
+};
 export type AsyncModule = (() => Promise<Module>) | Module;
 export type BlockModulesOptions = {
+    /**
+     * If a block should handle multiple typehandles
+     */
     alias?: Record<string, string>;
 };
 export declare class BlockModules {
@@ -20,13 +36,21 @@ export declare class BlockModules {
      */
     load(requiredModules: Set<string>): Promise<Map<string, Module>>;
 }
+/**
+ * Creates a new Blocks instance
+ *
+ * Consider using the Blocks component instead
+ *
+ * @param blocks the blocks data each block must have a typeHandle
+ * @param modules the modules created with `blockModules`
+ */
 export declare function newBlocks(blocks: any[], modules: BlockModules): Promise<Blocks>;
 export default class Blocks {
     blocks: any[];
     data: any[];
     modules: Map<string, Module>;
     constructor(blocks: any[], modules: Map<string, Module>);
-    loadData(cr: CrelteRouted): Promise<void>;
+    loadData(cr: CrelteRequest): Promise<void>;
     each(): {
         mod: any;
         props: any;

package/dist/blocks/Blocks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Blocks.d.ts","sourceRoot":"","sources":["../../../../src/blocks/Blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,MAAM,WAAW,MAAM;IAEtB,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CACxC;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IAEjC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,qBAAa,YAAY;IACxB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAG1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACpC,IAAI,GAAE,mBAAwB;IAgC/B;;;;OAIG;IACG,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAmBtE;AAED,wBAAsB,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,YAAY,mBAanE;AAED,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAEjB,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAMjD,QAAQ,CAAC,EAAE,EAAE,YAAY;IAkB/B,IAAI,IAAI;QAAE,GAAG,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,EAAE;CAclC"}
+{"version":3,"file":"Blocks.d.ts","sourceRoot":"","sources":["../../../../src/blocks/Blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,MAAM,WAAW,MAAM;IACtB,uBAAuB;IACvB,OAAO,EAAE,GAAG,CAAC;IAEb,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3B,iEAAiE;IACjE,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,EAAE,CACV,EAAE,EAAE,aAAa,EACjB,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,YAAY,KACd,OAAO,CAAC,GAAG,CAAC,CAAC;CAClB;AAED,MAAM,MAAM,YAAY,GAAG;IAC1B;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,qBAAa,YAAY;IACxB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAG1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACpC,IAAI,GAAE,mBAAwB;IAgC/B;;;;OAIG;IACG,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAmBtE;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC9B,MAAM,EAAE,GAAG,EAAE,EACb,OAAO,EAAE,YAAY,GACnB,OAAO,CAAC,MAAM,CAAC,CAajB;AAED,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAEjB,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAMjD,QAAQ,CAAC,EAAE,EAAE,aAAa;IAkBhC,IAAI,IAAI;QAAE,GAAG,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,EAAE;CAclC"}

package/dist/blocks/Blocks.js

@@ -42,6 +42,14 @@ export class BlockModules {
         return new Map([...requiredModules.keys()].map((mod, i) => [mod, loaded[i]]));
     }
 }
+/**
+ * Creates a new Blocks instance
+ *
+ * Consider using the Blocks component instead
+ *
+ * @param blocks the blocks data each block must have a typeHandle
+ * @param modules the modules created with `blockModules`
+ */
 export async function newBlocks(blocks, modules) {
     // define all required modules
     const requiredModules = new Set();

package/dist/blocks/Blocks.svelte

@@ -1,4 +1,4 @@
-<script context="module">import { CrelteRouted } from "../index.js";
+<script context="module">import CrelteRequest from "../CrelteRequest.js";
 import Blocks, {
   BlockModules,
   newBlocks

package/dist/blocks/Blocks.svelte.d.ts

@@ -1,9 +1,40 @@
 import { SvelteComponent } from "svelte";
-import { CrelteRouted } from '../index.js';
-import Blocks, { type AsyncModule, type Module, type BlockModulesOptions, BlockModules } from './Blocks.js';
-export type { BlockModules, BlockModulesOptions, AsyncModule, Module };
+import CrelteRequest from '../CrelteRequest.js';
+import Blocks, { type AsyncModule, type BlockModulesOptions, BlockModules } from './Blocks.js';
+/**
+ * Create a BlockModules instance from modules
+ *
+ * ## Example
+ * ```ts
+ * const mods = blockModules(
+ *     import.meta.glob('./contentDetail/*.svelte', { eager: true })
+    );
+ * ```
+ *
+ * ## Example with alias
+ * ```ts
+ * const mods = blockModules(
+ *     import.meta.glob('./contentDetail/*.svelte'),
+ *     {
+ *         alias: {
+ * 		       fakename: 'filename',
+ *         }
+ *     }
+ * );
+ */
 export declare function blockModules(modules: Record<string, AsyncModule>, opts?: BlockModulesOptions): BlockModules;
-export declare function loadBlocksData(cr: CrelteRouted, blocks: any[], modules: BlockModules): Promise<Blocks>;
+/**
+ * Load blocks data
+ *
+ * ## Example
+ * ```ts
+ * const mods = blockModules(import.meta.glob('./contentDetail/*.svelte'));
+ *
+ * export const loadData = {
+ *     blocks: (cr, entry) => loadBlocksData(cr, entry.blocks, mods)
+ * };
+ */
+export declare function loadBlocksData(cr: CrelteRequest, blocks: any[], modules: BlockModules): Promise<Blocks>;
 declare const __propDef: {
     props: {
         [x: string]: any;
@@ -21,4 +52,5 @@ export type BlocksEvents = typeof __propDef.events;
 export type BlocksSlots = typeof __propDef.slots;
 export default class Blocks extends SvelteComponent<BlocksProps, BlocksEvents, BlocksSlots> {
 }
+export {};
 //# sourceMappingURL=Blocks.svelte.d.ts.map

package/dist/blocks/Blocks.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Blocks.svelte.d.ts","sourceRoot":"","sources":["../../../../src/blocks/Blocks.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAEvC;AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AA8B3C,OAAO,MAAM,EAAE,EACd,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,KAAK,mBAAmB,EACxB,YAAY,EAEZ,MAAM,aAAa,CAAC;AAErB,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AAEvE,wBAAgB,YAAY,CAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACpC,IAAI,GAAE,mBAAwB,GAC5B,YAAY,CAEd;AAED,wBAAsB,cAAc,CACnC,EAAE,EAAE,YAAY,EAChB,MAAM,EAAE,GAAG,EAAE,EACb,OAAO,EAAE,YAAY,GACnB,OAAO,CAAC,MAAM,CAAC,CAMjB;AAcF,QAAA,MAAM,SAAS;;;gBAD8B,MAAM;;;;;;;;CAC2B,CAAC;AAC/E,MAAM,MAAM,WAAW,GAAG,OAAO,SAAS,CAAC,KAAK,CAAC;AACjD,MAAM,MAAM,YAAY,GAAG,OAAO,SAAS,CAAC,MAAM,CAAC;AACnD,MAAM,MAAM,WAAW,GAAG,OAAO,SAAS,CAAC,KAAK,CAAC;AAEjD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,eAAe,CAAC,WAAW,EAAE,YAAY,EAAE,WAAW,CAAC;CAC1F"}
+{"version":3,"file":"Blocks.svelte.d.ts","sourceRoot":"","sources":["../../../../src/blocks/Blocks.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAEvC;AACA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAkBhD,OAAO,MAAM,EAAE,EACd,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,YAAY,EAEZ,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACpC,IAAI,GAAE,mBAAwB,GAC5B,YAAY,CAEd;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CACnC,EAAE,EAAE,aAAa,EACjB,MAAM,EAAE,GAAG,EAAE,EACb,OAAO,EAAE,YAAY,GACnB,OAAO,CAAC,MAAM,CAAC,CAMjB;AAcF,QAAA,MAAM,SAAS;;;gBAD8B,MAAM;;;;;;;;CAC2B,CAAC;AAC/E,MAAM,MAAM,WAAW,GAAG,OAAO,SAAS,CAAC,KAAK,CAAC;AACjD,MAAM,MAAM,YAAY,GAAG,OAAO,SAAS,CAAC,MAAM,CAAC;AACnD,MAAM,MAAM,WAAW,GAAG,OAAO,SAAS,CAAC,KAAK,CAAC;AAEjD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,eAAe,CAAC,WAAW,EAAE,YAAY,EAAE,WAAW,CAAC;CAC1F"}

package/dist/blocks/index.d.ts

@@ -1,5 +1,8 @@
-import Blocks, { type BlockModules, type BlockModulesOptions, type AsyncModule, type Module, blockModules, loadBlocksData } from './Blocks.svelte';
-export type { BlockModules, BlockModulesOptions, AsyncModule, Module };
-export { Blocks, blockModules, loadBlocksData };
+import Blocks, { blockModules, loadBlocksData } from './Blocks.svelte';
+import type { BlockModules, BlockModulesOptions, AsyncModule, Module, BlockOptions } from './Blocks.js';
+import type BlocksInstance from './Blocks.js';
+import { newBlocks } from './Blocks.js';
+export type { BlocksInstance, BlockModules, BlockModulesOptions, AsyncModule, Module, BlockOptions, };
+export { newBlocks, Blocks, blockModules, loadBlocksData };
 export default Blocks;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/blocks/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EACd,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAChB,KAAK,MAAM,EACX,YAAY,EACZ,cAAc,EACd,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AAEvE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAEhD,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/blocks/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,KAAK,EACX,YAAY,EACZ,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,YAAY,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,cAAc,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,YAAY,EACX,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,YAAY,GACZ,CAAC;AAEF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,eAAe,MAAM,CAAC"}

package/dist/blocks/index.js

@@ -1,3 +1,4 @@
-import Blocks, { blockModules, loadBlocksData, } from './Blocks.svelte';
-export { Blocks, blockModules, loadBlocksData };
+import Blocks, { blockModules, loadBlocksData } from './Blocks.svelte';
+import { newBlocks } from './Blocks.js';
+export { newBlocks, Blocks, blockModules, loadBlocksData };
 export default Blocks;

package/dist/cookies/ServerCookies.d.ts

@@ -1,5 +1,5 @@
 import { Cookies, SetOptions } from './index.js';
-import { SetCookie } from './utils.js';
+import { type SetCookie } from './utils.js';
 export default class ServerCookies implements Cookies {
     requestCookies: Map<string, string>;
     setCookies: Map<string, SetCookie>;

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

@@ -1 +1 @@
-{"version":3,"file":"ServerCookies.d.ts","sourceRoot":"","sources":["../../../../src/cookies/ServerCookies.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAgB,SAAS,EAAqB,MAAM,YAAY,CAAC;AAExE,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,OAAO;IACpD,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;;IAOnC,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM5B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAUhC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI;IAIzD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI1B,qBAAqB,IAAI,MAAM,EAAE;CAKjC"}
+{"version":3,"file":"ServerCookies.d.ts","sourceRoot":"","sources":["../../../../src/cookies/ServerCookies.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAgB,KAAK,SAAS,EAAqB,MAAM,YAAY,CAAC;AAE7E,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,OAAO;IACpD,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;;IAOnC,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM5B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAUhC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI;IAIzD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI1B,qBAAqB,IAAI,MAAM,EAAE;CAKjC"}