crelte 0.5.10 → 0.5.12

package/dist/server/queries/QueryGqlRoute.js

@@ -0,0 +1,194 @@
+import { vars } from '../../queries/vars.js';
+import { extractEntry } from '../../loadData/index.js';
+import { calcKey } from '../../ssr/index.js';
+import { newError, validateVars } from './routes.js';
+// only internal
+export default class QueryGqlRoute {
+    name;
+    query;
+    vars;
+    cacheIfFn;
+    transformFn;
+    constructor(name, query, args) {
+        if (args.cacheIfFn && !vars)
+            throw new Error('queryRoute: ' +
+                name +
+                ' cannot have caching function if there are no ' +
+                'variables defined');
+        this.name = name;
+        this.query = query;
+        this.vars = args.vars;
+        this.cacheIfFn = args.cacheIfFn;
+        this.transformFn = args.transformFn;
+        if (args.preventCaching) {
+            if (this.cacheIfFn)
+                throw new Error('unreachable');
+            // prevent filling defaults
+            return;
+        }
+        // add default vars and cacheIfFn if we know the route
+        if (this.name === 'entry')
+            this.fillEntryDefaults();
+        else if (this.name === 'global')
+            this.fillGlobalDefaults();
+        else
+            this.fillBasicDefaults();
+    }
+    fillEntryDefaults() {
+        if (this.vars)
+            return;
+        // the _setName step happens in parseVars which happens before setting
+        // the defaults, so since we're adding vars here we need to set the name
+        // manually
+        this.vars = {
+            siteId: vars.siteId().z_setName('siteId'),
+            uri: vars.string().z_setName('uri'),
+        };
+        this.cacheIfFn = res => !!extractEntry(res);
+    }
+    fillGlobalDefaults() {
+        if (this.vars)
+            return;
+        this.vars = { siteId: vars.siteId().z_setName('siteId') };
+        this.cacheIfFn = () => true;
+    }
+    /**
+     * This adds caching to queries containing `query {` or
+     * `query ($siteId: [QueryArgument) {` without any additional vars
+     */
+    fillBasicDefaults() {
+        if (this.vars)
+            return;
+        const NO_VAR_TEST = /(^|\s)query\s*{/;
+        const SITE_ID_VAR_TEST = /(^|\s)query\s*\(\s*\$siteId\s*:\s*\[\s*QueryArgument\s*\]\s*\)\s*{/;
+        if (NO_VAR_TEST.test(this.query)) {
+            this.vars = {};
+            this.cacheIfFn = () => true;
+        }
+        else if (SITE_ID_VAR_TEST.test(this.query)) {
+            this.vars = { siteId: vars.siteId().z_setName('siteId') };
+            this.cacheIfFn = () => true;
+        }
+        else if (!this.query.includes('query')) {
+            // this warning might be shown to mutation queries or subscriptions
+            // in that case, the user should explicitly set caching to false
+            console.warn(`cannot determine if query (${this.name}) is cacheable, see` +
+                ' https://github.com/crelte/crelte/issues/114 for infos');
+        }
+    }
+    async transform(jsonResp, vars) {
+        if (!this.transformFn || !jsonResp.data)
+            return;
+        const transformed = await this.transformFn(jsonResp.data, vars);
+        if (typeof transformed !== 'undefined')
+            jsonResp.data = transformed;
+    }
+    async handle(caching, csr) {
+        let vars;
+        try {
+            const reqVars = await csr.req.json();
+            vars = validateVars(this.vars, reqVars, caching.router);
+            if ('qName' in vars || 'xCraftSite' in vars)
+                throw new Error('qName and xCraftSite are reserved variable names');
+        }
+        catch (e) {
+            return newError(e, 400);
+        }
+        let logInfo = null;
+        if (caching.debug) {
+            logInfo = `[queries: ${this.name}] vars: ${JSON.stringify(vars)}`;
+        }
+        let previewToken = null;
+        let siteToken = null;
+        const reqSearch = new URL(csr.req.url).searchParams;
+        if (reqSearch.has('token')) {
+            previewToken = reqSearch.get('token');
+        }
+        else if (reqSearch.has('siteToken')) {
+            siteToken = reqSearch.get('siteToken');
+        }
+        // check for x-craft-site header and pass it on
+        const xCraftSite = csr.req.headers.get('X-Craft-Site');
+        let cacheKey = null;
+        const useCache = !previewToken && caching.isEnabled();
+        if (useCache) {
+            cacheKey = await calcKey({ ...vars, qName: this.name, xCraftSite });
+            const cached = await caching.getCache(cacheKey);
+            if (logInfo)
+                console.log(`${logInfo} ${cached ? 'hit' : 'miss'}`);
+            // we found something in the cache
+            if (cached)
+                return Response.json(cached);
+        }
+        const headers = {
+            'Content-Type': 'application/json',
+        };
+        const auth = csr.getEnv('ENDPOINT_TOKEN');
+        if (auth)
+            headers['Authorization'] = 'Bearer ' + auth;
+        const url = new URL(csr.getEnv('ENDPOINT_URL'));
+        if (previewToken)
+            url.searchParams.set('token', previewToken);
+        if (siteToken)
+            url.searchParams.set('siteToken', siteToken);
+        const xDebug = csr.req.headers.get('X-Debug');
+        if (xDebug)
+            headers['X-Debug'] = xDebug;
+        if (xCraftSite)
+            headers['X-Craft-Site'] = xCraftSite;
+        // now execute the gql request
+        let resp;
+        try {
+            resp = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify({
+                    query: this.query,
+                    variables: vars,
+                }),
+            });
+            // if the response is not ok we don't cache anything
+            // and just return the response
+            if (!resp.ok)
+                return resp;
+        }
+        catch (e) {
+            return newError(e, 500);
+        }
+        const respHeaders = {};
+        const xDebugLink = resp.headers.get('X-Debug-Link');
+        if (xDebugLink)
+            respHeaders['X-Debug'] = xDebugLink;
+        let jsonResp;
+        try {
+            jsonResp = await resp.json();
+            if (!jsonResp || typeof jsonResp !== 'object')
+                throw new Error('invalid json response');
+            await this.transform(jsonResp, vars);
+        }
+        catch (e) {
+            return newError(e, 500);
+        }
+        // also no caching for errors
+        if (jsonResp.errors) {
+            return Response.json(jsonResp, { headers: respHeaders });
+        }
+        // now we have a valid json resp.
+        // should we cache it?
+        if (cacheKey && this.cacheIfFn?.(jsonResp.data, vars)) {
+            try {
+                await caching.setCache(cacheKey, jsonResp);
+                if (logInfo)
+                    console.log(logInfo + ' set cache');
+            }
+            catch (e) {
+                console.error('could not cache gql response', e);
+            }
+            // if caching is enabled but not used we warn
+        }
+        else if (cacheKey && logInfo) {
+            console.warn('!! ' + logInfo + ' caching not allowed');
+        }
+        return Response.json(jsonResp, { headers: respHeaders });
+    }
+}

package/dist/server/queries/QueryHandleRoute.d.ts

@@ -0,0 +1,12 @@
+import { QueryVar } from '../../queries/vars.js';
+import CrelteServerRequest from '../CrelteServer.js';
+import ServerRouter from '../ServerRouter.js';
+import { HandleFn } from './routes.js';
+export default class QueryHandleRoute {
+    name: string;
+    handleFn: HandleFn;
+    vars: Record<string, QueryVar> | null;
+    constructor(name: string, handleFn: HandleFn, vars: Record<string, QueryVar> | null);
+    handle(cs: ServerRouter, csr: CrelteServerRequest): Promise<Response>;
+}
+//# sourceMappingURL=QueryHandleRoute.d.ts.map

package/dist/server/queries/QueryHandleRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryHandleRoute.d.ts","sourceRoot":"","sources":["../../../src/server/queries/QueryHandleRoute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,mBAAmB,MAAM,oBAAoB,CAAC;AACrD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAA0B,MAAM,aAAa,CAAC;AAG/D,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;gBAGrC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI;IAOhC,MAAM,CACX,EAAE,EAAE,YAAY,EAChB,GAAG,EAAE,mBAAmB,GACtB,OAAO,CAAC,QAAQ,CAAC;CAYpB"}

package/dist/server/queries/QueryHandleRoute.js

@@ -0,0 +1,24 @@
+import { newError, validateVars } from './routes.js';
+// only internal
+export default class QueryHandleRoute {
+    name;
+    handleFn;
+    vars;
+    constructor(name, handleFn, vars) {
+        this.name = name;
+        this.handleFn = handleFn;
+        this.vars = vars;
+    }
+    async handle(cs, csr) {
+        let vars;
+        try {
+            const reqVars = await csr.req.json();
+            vars = validateVars(this.vars, reqVars, cs);
+        }
+        catch (e) {
+            return newError(e, 400);
+        }
+        const res = await this.handleFn(csr, vars);
+        return Response.json({ data: res });
+    }
+}

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

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../src/server/queries/queries.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAI9C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAwB1C,wBAAsB,eAAe,CACpC,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,YAAY,GAClB,OAAO,CAAC,IAAI,CAAC,CAwEf"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../src/server/queries/queries.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAI9C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AA6B1C,wBAAsB,eAAe,CACpC,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,YAAY,GAClB,OAAO,CAAC,IAAI,CAAC,CAgGf"}

package/dist/server/queries/queries.js

@@ -1,60 +1,78 @@
 import QueriesCaching from './QueriesCaching.js';
-import { QueryRoute } from './routes.js';
 import { isQueryVar } from '../../queries/vars.js';
+import QueryHandleRoute from './QueryHandleRoute.js';
+import QueryGqlRoute from './QueryGqlRoute.js';
 export async function initQueryRoutes(platform, mod, router) {
     if (typeof mod.queries !== 'object') {
-        throw new Error("expected `export const queries = import.meta.glob('@/queries/*', { eager: true });` in server.js");
+        throw new Error('expected `export const queries = import.meta.glob(' +
+            "'@/queries/*', { eager: true });` in server.js");
     }
     const debugCaching = !!mod?.debugCaching;
     const modQueries = mod.queries;
-    const preRoutes = new Map();
+    const routeBuilders = new Map();
     for (const [file, mq] of Object.entries(modQueries)) {
         const filename = file.split('/').pop();
         const dotPos = filename.lastIndexOf('.');
         const name = filename.substring(0, dotPos);
-        let preRoute = preRoutes.get(name);
-        if (!preRoute) {
-            preRoute = {
+        let routeBuilder = routeBuilders.get(name);
+        if (!routeBuilder) {
+            routeBuilder = {
                 query: null,
                 jsFile: null,
                 vars: null,
                 cacheIfFn: null,
                 preventCaching: false,
                 transformFn: null,
+                handleFn: null,
             };
-            preRoutes.set(name, preRoute);
+            routeBuilders.set(name, routeBuilder);
         }
         // set the gql query (this can only happen once)
         if (filename.endsWith('.graphql')) {
-            preRoute.query = mq.query.query;
+            routeBuilder.query = mq.query.query;
             continue;
         }
         // now check that only one file matches
-        if (preRoute.jsFile) {
-            throw new Error(`cannot have two files for the same query ${preRoute.jsFile} and ${filename}`);
+        if (routeBuilder.jsFile) {
+            throw new Error(`cannot have two files for the same query ${routeBuilder.jsFile} and ${filename}`);
         }
         const mts = mq;
         if (mts.variables) {
-            preRoute.vars = parseVars(mts.variables);
+            routeBuilder.vars = parseVars(mts.variables);
         }
         if (mts.caching) {
-            preRoute.cacheIfFn = parseCaching(mts.caching);
+            routeBuilder.cacheIfFn = parseCaching(mts.caching);
         }
         else if (typeof mts.caching === 'boolean') {
-            preRoute.preventCaching = true;
+            routeBuilder.preventCaching = true;
         }
         if (mts.transform) {
-            preRoute.transformFn = parseTransform(mts.transform);
+            routeBuilder.transformFn = parseTransform(mts.transform);
+        }
+        if (mts.handle) {
+            routeBuilder.handleFn = parseHandle(mts.handle);
         }
     }
     const caching = new QueriesCaching(platform, router, {
         debug: debugCaching,
     });
-    for (const [name, pr] of preRoutes.entries()) {
-        if (!pr.query)
-            throw new Error(`no .graphql file for query ${name}`);
-        const route = new QueryRoute(name, pr.query, pr);
-        router.post('/queries/' + route.name, async (csr) => route.handle(caching, csr));
+    for (const [name, rb] of routeBuilders.entries()) {
+        if (rb.query) {
+            if (rb.handleFn)
+                throw new Error('handle function not supported');
+            const route = new QueryGqlRoute(name, rb.query, rb);
+            router.post('/queries/' + route.name, csr => route.handle(caching, csr));
+        }
+        else if (rb.handleFn) {
+            if (rb.cacheIfFn || rb.transformFn || rb.preventCaching)
+                throw new Error('caching or transform not supported');
+            const route = new QueryHandleRoute(name, rb.handleFn, rb.vars);
+            router.post('/queries/' + route.name, csr => route.handle(caching.router, csr));
+        }
+        else {
+            throw new Error(`query js/ts ${name} file needs to either have ` +
+                'a .graphql file or a handle function');
+        }
     }
 }
 function parseVars(vars) {
@@ -81,3 +99,8 @@ function parseTransform(transform) {
         throw new Error('transform should be a function');
     return transform;
 }
+function parseHandle(handle) {
+    if (typeof handle !== 'function')
+        throw new Error('handle should be a function');
+    return handle;
+}

package/dist/server/queries/routes.d.ts

@@ -1,36 +1,13 @@
-import CrelteServerRequest from '../CrelteServer.js';
-import QueriesCaching from './QueriesCaching.js';
 import { QueryVar } from '../../queries/vars.js';
+import CrelteServerRequest from '../CrelteServer.js';
 import ServerRouter from '../ServerRouter.js';
 export type CacheIfFn = (response: any, vars: Record<string, any>) => boolean;
 export type TransformFn = (response: any, vars: Record<string, any>) => void | any | Promise<void | any>;
-export type QueryRouteArgs = {
-    vars: Record<string, QueryVar> | null;
-    cacheIfFn: CacheIfFn | null;
-    preventCaching: boolean;
-    transformFn: TransformFn | null;
-};
-export declare class QueryRoute {
-    name: string;
-    query: string;
-    vars: Record<string, QueryVar> | null;
-    cacheIfFn: CacheIfFn | null;
-    transformFn: TransformFn | null;
-    constructor(name: string, query: string, args: QueryRouteArgs);
-    private fillEntryDefaults;
-    private fillGlobalDefaults;
-    /**
-     * This adds caching to queries containing `query {` or
-     * `query ($siteId: [QueryArgument) {` without any additional vars
-     */
-    private fillBasicDefaults;
-    /**
-     * Returns the validated variables if some vars where defined
-     * else just returns all vars
-     */
-    validateVars(vars: any, cs: ServerRouter): Record<string, any>;
-    private transform;
-    handle(caching: QueriesCaching, csr: CrelteServerRequest): Promise<Response>;
-}
+export type HandleFn = (csr: CrelteServerRequest, vars: Record<string, any>) => Promise<any> | any;
+/**
+ * Returns the validated variables if some vars where defined
+ * else just returns all vars
+ */
+export declare function validateVars(qvars: Record<string, QueryVar> | null, vars: any, cs: ServerRouter): Record<string, any>;
 export declare function newError(e: any, status: number): Response;
 //# sourceMappingURL=routes.d.ts.map

package/dist/server/queries/routes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../../src/server/queries/routes.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,oBAAoB,CAAC;AACrD,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAQ,MAAM,uBAAuB,CAAC;AAEvD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAG9C,MAAM,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC;AAM9E,MAAM,MAAM,WAAW,GAAG,CACzB,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACrB,IAAI,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;AAEtC,MAAM,MAAM,cAAc,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IACtC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CAChC,CAAC;AAGF,qBAAa,UAAU;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;IACtC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;gBAEpB,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc;IA2B7D,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,kBAAkB;IAO1B;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAgBzB;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;YAehD,SAAS;IAUjB,MAAM,CACX,OAAO,EAAE,cAAc,EACvB,GAAG,EAAE,mBAAmB,GACtB,OAAO,CAAC,QAAQ,CAAC;CAkHpB;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,CAEzD"}
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../../src/server/queries/routes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,mBAAmB,MAAM,oBAAoB,CAAC;AACrD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,MAAM,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC;AAM9E,MAAM,MAAM,WAAW,GAAG,CACzB,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACrB,IAAI,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;AAEtC,MAAM,MAAM,QAAQ,GAAG,CACtB,GAAG,EAAE,mBAAmB,EACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACrB,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB;;;GAGG;AACH,wBAAgB,YAAY,CAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,EACtC,IAAI,EAAE,GAAG,EACT,EAAE,EAAE,YAAY,GACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAarB;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,CAEzD"}

package/dist/server/queries/routes.js

@@ -1,203 +1,17 @@
-import { vars } from '../../queries/vars.js';
-import { extractEntry } from '../../loadData/index.js';
-import { calcKey } from '../../ssr/index.js';
-// only internal
-export class QueryRoute {
-    name;
-    query;
-    vars;
-    cacheIfFn;
-    transformFn;
-    constructor(name, query, args) {
-        if (args.cacheIfFn && !vars)
-            throw new Error('queryRoute: ' +
-                name +
-                ' cannot have caching function if there are no ' +
-                'variables defined');
-        this.name = name;
-        this.query = query;
-        this.vars = args.vars;
-        this.cacheIfFn = args.cacheIfFn;
-        this.transformFn = args.transformFn;
-        if (args.preventCaching) {
-            if (this.cacheIfFn)
-                throw new Error('unreachable');
-            // prevent filling defaults
-            return;
-        }
-        // add default vars and cacheIfFn if we know the route
-        if (this.name === 'entry')
-            this.fillEntryDefaults();
-        else if (this.name === 'global')
-            this.fillGlobalDefaults();
-        else
-            this.fillBasicDefaults();
-    }
-    fillEntryDefaults() {
-        if (this.vars)
-            return;
-        // the _setName step happens in parseVars which happens before setting
-        // the defaults
-        this.vars = {
-            siteId: vars.siteId().z_setName('siteId'),
-            uri: vars.string().z_setName('uri'),
-        };
-        this.cacheIfFn = res => !!extractEntry(res);
-    }
-    fillGlobalDefaults() {
-        if (this.vars)
-            return;
-        this.vars = { siteId: vars.siteId().z_setName('siteId') };
-        this.cacheIfFn = () => true;
-    }
-    /**
-     * This adds caching to queries containing `query {` or
-     * `query ($siteId: [QueryArgument) {` without any additional vars
-     */
-    fillBasicDefaults() {
-        if (this.vars)
-            return;
-        const NO_VAR_TEST = /(^|\s)query\s*{/;
-        const SITE_ID_VAR_TEST = /(^|\s)query\s*\(\s*\$siteId\s*:\s*\[\s*QueryArgument\s*\]\s*\)\s*{/;
-        if (NO_VAR_TEST.test(this.query)) {
-            this.vars = {};
-            this.cacheIfFn = () => true;
-        }
-        else if (SITE_ID_VAR_TEST.test(this.query)) {
-            this.vars = { siteId: vars.siteId().z_setName('siteId') };
-            this.cacheIfFn = () => true;
-        }
-    }
-    /**
-     * Returns the validated variables if some vars where defined
-     * else just returns all vars
-     */
-    validateVars(vars, cs) {
-        if (!vars || typeof vars !== 'object')
-            throw new Error('expected an object as vars');
-        if (!this.vars)
-            return vars;
-        const nVars = {};
-        for (const [k, v] of Object.entries(this.vars)) {
-            nVars[k] = v.validValue(vars[k], cs);
-        }
-        return nVars;
-    }
-    async transform(jsonResp, vars) {
-        if (!this.transformFn || !jsonResp.data)
-            return;
-        const transformed = await this.transformFn(jsonResp.data, vars);
-        if (typeof transformed !== 'undefined')
-            jsonResp.data = transformed;
-    }
-    async handle(caching, csr) {
-        let vars;
-        try {
-            const reqVars = await csr.req.json();
-            vars = this.validateVars(reqVars, caching.router);
-            if ('qName' in vars || 'xCraftSite' in vars)
-                throw new Error('qName and xCraftSite are reserved variable names');
-        }
-        catch (e) {
-            return newError(e, 400);
-        }
-        let logInfo = null;
-        if (caching.debug) {
-            logInfo = `[queries: ${this.name}] vars: ${JSON.stringify(vars)}`;
-        }
-        let previewToken = null;
-        let siteToken = null;
-        const reqSearch = new URL(csr.req.url).searchParams;
-        if (reqSearch.has('token')) {
-            previewToken = reqSearch.get('token');
-        }
-        else if (reqSearch.has('siteToken')) {
-            siteToken = reqSearch.get('siteToken');
-        }
-        // check for x-craft-site header and pass it on
-        const xCraftSite = csr.req.headers.get('X-Craft-Site');
-        let cacheKey = null;
-        const useCache = !previewToken && caching.isEnabled();
-        if (useCache) {
-            cacheKey = await calcKey({ ...vars, qName: this.name, xCraftSite });
-            const cached = await caching.getCache(cacheKey);
-            if (logInfo)
-                console.log(`${logInfo} ${cached ? 'hit' : 'miss'}`);
-            // we found something in the cache
-            if (cached)
-                return Response.json(cached);
-        }
-        const headers = {
-            'Content-Type': 'application/json',
-        };
-        const auth = csr.getEnv('ENDPOINT_TOKEN');
-        if (auth)
-            headers['Authorization'] = 'Bearer ' + auth;
-        const url = new URL(csr.getEnv('ENDPOINT_URL'));
-        if (previewToken)
-            url.searchParams.set('token', previewToken);
-        if (siteToken)
-            url.searchParams.set('siteToken', siteToken);
-        const xDebug = csr.req.headers.get('X-Debug');
-        if (xDebug)
-            headers['X-Debug'] = xDebug;
-        if (xCraftSite)
-            headers['X-Craft-Site'] = xCraftSite;
-        // now execute the gql request
-        let resp;
-        try {
-            resp = await fetch(url, {
-                method: 'POST',
-                headers,
-                body: JSON.stringify({
-                    query: this.query,
-                    variables: vars,
-                }),
-            });
-            // if the response is not ok we don't cache anything
-            // and just return the response
-            if (!resp.ok)
-                return resp;
-        }
-        catch (e) {
-            return newError(e, 500);
-        }
-        const respHeaders = {};
-        const xDebugLink = resp.headers.get('X-Debug-Link');
-        if (xDebugLink)
-            respHeaders['X-Debug'] = xDebugLink;
-        let jsonResp;
-        try {
-            jsonResp = await resp.json();
-            if (!jsonResp || typeof jsonResp !== 'object')
-                throw new Error('invalid json response');
-            await this.transform(jsonResp, vars);
-        }
-        catch (e) {
-            return newError(e, 500);
-        }
-        // also no caching for errors
-        if (jsonResp.errors) {
-            return Response.json(jsonResp, { headers: respHeaders });
-        }
-        // now we have a valid json resp.
-        // should we cache it?
-        if (cacheKey && this.cacheIfFn?.(jsonResp.data, vars)) {
-            try {
-                await caching.setCache(cacheKey, jsonResp);
-                if (logInfo)
-                    console.log(logInfo + ' set cache');
-            }
-            catch (e) {
-                console.error('could not cache gql response', e);
-            }
-            // if caching is generally disabled we don't warn
-        }
-        else if (cacheKey && logInfo) {
-            console.warn('!! ' + logInfo + ' caching not allowed');
-        }
-        return Response.json(jsonResp, { headers: respHeaders });
+/**
+ * Returns the validated variables if some vars where defined
+ * else just returns all vars
+ */
+export function validateVars(qvars, vars, cs) {
+    if (!vars || typeof vars !== 'object')
+        throw new Error('expected an object as vars');
+    if (!qvars)
+        return vars;
+    const nVars = {};
+    for (const [k, v] of Object.entries(qvars)) {
+        nVars[k] = v.validValue(vars[k], cs);
     }
+    return nVars;
 }
 export function newError(e, status) {
     return new Response(e.message, { status });

package/dist/std/stores/StagedWritable.d.ts

@@ -0,0 +1,48 @@
+import { CloneableOrPrimitive } from '../index.js';
+import { Readable } from './index.js';
+export default class StagedWritable<T> {
+    private inner;
+    private mode;
+    private staged;
+    /**
+     * Creates a new StagedWritable
+     *
+     * @param def A default value
+     */
+    constructor(def: T);
+    /**
+     * Returns true if the store is currently staged
+     */
+    isStaged(): boolean;
+    /**
+     * Returns a new StagedWritable which is staged and has the same value as the current one
+     * To commit the staged value, call `commit` on the returned StagedWritable
+     */
+    stage(): StagedWritable<T>;
+    /**
+     * The function get's called once with the current value and then when the
+     * values changes
+     *
+     * #### Note
+     * This does not check for equality like svelte.
+     *
+     * @return a function which should be called to unsubscribe
+     */
+    subscribe(fn: (val: T) => void, invalidate?: () => void): () => void;
+    /**
+     * Either updates the store and calls all subscribers with the value or
+     * updates the stateful value if previously toStateful was called
+     */
+    set(inner: T): void;
+    /**
+     * If the value was staged, then update the store and call all subscribers with the value
+     */
+    commit(): void;
+    /**
+     * Get the current value either staged or not
+     */
+    get(): T;
+    readonly(): Readable<T>;
+    readclone<U extends T & CloneableOrPrimitive>(this: StagedWritable<U>): Readable<U>;
+}
+//# sourceMappingURL=StagedWritable.d.ts.map

package/dist/std/stores/StagedWritable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StagedWritable.d.ts","sourceRoot":"","sources":["../../../src/std/stores/StagedWritable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,cAAc,CAAC,CAAC;IACpC,OAAO,CAAC,KAAK,CAAc;IAE3B,OAAO,CAAC,IAAI,CAAa;IACzB,OAAO,CAAC,MAAM,CAAgB;IAE9B;;;;OAIG;gBACS,GAAG,EAAE,CAAC;IAMlB;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;;OAGG;IACH,KAAK,IAAI,cAAc,CAAC,CAAC,CAAC;IAQ1B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,UAAU,CAAC,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAIpE;;;OAGG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC;IASZ;;OAEG;IACH,MAAM;IASN;;OAEG;IACH,GAAG,IAAI,CAAC;IAKR,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC;IAIvB,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,oBAAoB,EAC3C,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GACrB,QAAQ,CAAC,CAAC,CAAC;CAGd"}