crelte 0.5.7 → 0.5.8

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;AAqB1C,wBAAsB,eAAe,CACpC,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,YAAY,GAClB,OAAO,CAAC,IAAI,CAAC,CAgEf"}
+{"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"}

package/dist/server/queries/queries.js

@@ -19,6 +19,8 @@ export async function initQueryRoutes(platform, mod, router) {
                 jsFile: null,
                 vars: null,
                 cacheIfFn: null,
+                preventCaching: false,
+                transformFn: null,
             };
             preRoutes.set(name, preRoute);
         }
@@ -38,6 +40,12 @@ export async function initQueryRoutes(platform, mod, router) {
         if (mts.caching) {
             preRoute.cacheIfFn = parseCaching(mts.caching);
         }
+        else if (typeof mts.caching === 'boolean') {
+            preRoute.preventCaching = true;
+        }
+        if (mts.transform) {
+            preRoute.transformFn = parseTransform(mts.transform);
+        }
     }
     const caching = new QueriesCaching(platform, router, {
         debug: debugCaching,
@@ -45,7 +53,7 @@ export async function initQueryRoutes(platform, mod, router) {
     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.vars, pr.cacheIfFn);
+        const route = new QueryRoute(name, pr.query, pr);
         router.post('/queries/' + route.name, async (csr) => route.handle(caching, csr));
     }
 }
@@ -68,3 +76,8 @@ function parseCaching(caching) {
         throw new Error('caching should be a function or a boolean');
     return caching;
 }
+function parseTransform(transform) {
+    if (typeof transform !== 'function')
+        throw new Error('transform should be a function');
+    return transform;
+}

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

@@ -3,12 +3,20 @@ import QueriesCaching from './QueriesCaching.js';
 import { QueryVar } from '../../queries/vars.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;
-    constructor(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;
     /**
@@ -21,6 +29,7 @@ export declare class QueryRoute {
      * else just returns all vars
      */
     validateVars(vars: any, cs: ServerRouter): Record<string, any>;
+    private transform;
     handle(caching: QueriesCaching, csr: CrelteServerRequest): Promise<Response>;
 }
 export declare function newError(e: any, status: number): Response;

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;AAG9E,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;gBAG3B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,EACrC,SAAS,EAAE,SAAS,GAAG,IAAI;IAoB5B,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;IAexD,MAAM,CACX,OAAO,EAAE,cAAc,EACvB,GAAG,EAAE,mBAAmB,GACtB,OAAO,CAAC,QAAQ,CAAC;CAiHpB;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,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"}

package/dist/server/queries/routes.js

@@ -7,15 +7,24 @@ export class QueryRoute {
     query;
     vars;
     cacheIfFn;
-    constructor(name, query, vars, cacheIfFn) {
-        if (cacheIfFn && !vars)
+    transformFn;
+    constructor(name, query, args) {
+        if (args.cacheIfFn && !vars)
             throw new Error('queryRoute: ' +
                 name +
-                ' cannot have cacheIfFn if there are no vars defined');
+                ' cannot have caching function if there are no ' +
+                'variables defined');
         this.name = name;
         this.query = query;
-        this.vars = vars;
-        this.cacheIfFn = cacheIfFn;
+        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();
@@ -74,6 +83,13 @@ export class QueryRoute {
         }
         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 {
@@ -155,6 +171,7 @@ export class QueryRoute {
             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);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "crelte",
-	"version": "0.5.7",
+	"version": "0.5.8",
 	"author": "Crelte <support@crelte.com>",
 	"type": "module",
 	"scripts": {

package/src/server/queries/queries.ts

@@ -1,6 +1,6 @@
 import ServerRouter from '../ServerRouter.js';
 import QueriesCaching from './QueriesCaching.js';
-import { CacheIfFn, QueryRoute } from './routes.js';
+import { CacheIfFn, QueryRoute, TransformFn } from './routes.js';
 import { isQueryVar, QueryVar } from '../../queries/vars.js';
 import { Platform } from '../platform.js';
 
@@ -10,8 +10,9 @@ type ModQuery = {
 };
 
 type ModTs = {
-	variables: any;
+	variables?: any;
 	caching?: any;
+	transform?: any;
 };
 
 type ModQueries = Record<string, ModQuery | ModTs>;
@@ -21,6 +22,8 @@ type PreRoute = {
 	jsFile: string | null;
 	vars: Record<string, QueryVar> | null;
 	cacheIfFn: CacheIfFn | null;
+	preventCaching: boolean;
+	transformFn: TransformFn | null;
 };
 
 export async function initQueryRoutes(
@@ -51,6 +54,8 @@ export async function initQueryRoutes(
 				jsFile: null,
 				vars: null,
 				cacheIfFn: null,
+				preventCaching: false,
+				transformFn: null,
 			};
 			preRoutes.set(name, preRoute);
 		}
@@ -75,6 +80,12 @@ export async function initQueryRoutes(
 
 		if (mts.caching) {
 			preRoute.cacheIfFn = parseCaching(mts.caching);
+		} else if (typeof mts.caching === 'boolean') {
+			preRoute.preventCaching = true;
+		}
+
+		if (mts.transform) {
+			preRoute.transformFn = parseTransform(mts.transform);
 		}
 	}
 
@@ -85,7 +96,7 @@ export async function initQueryRoutes(
 	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.vars, pr.cacheIfFn);
+		const route = new QueryRoute(name, pr.query, pr);
 
 		router.post('/queries/' + route.name, async csr =>
 			route.handle(caching, csr),
@@ -119,3 +130,10 @@ function parseCaching(caching: any): CacheIfFn {
 
 	return caching;
 }
+
+function parseTransform(transform: any): TransformFn {
+	if (typeof transform !== 'function')
+		throw new Error('transform should be a function');
+
+	return transform;
+}

package/src/server/queries/routes.ts

@@ -7,30 +7,50 @@ import { calcKey } from '../../ssr/index.js';
 
 export type CacheIfFn = (response: any, vars: Record<string, any>) => boolean;
 
+/// Anything other than returning undefined will replace the response
+//
+// Note that even if you return undefined since the response is by reference
+// you're modifications will be reflected
+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;
+};
+
 // only internal
 export class QueryRoute {
 	name: string;
 	query: string;
 	vars: Record<string, QueryVar> | null;
 	cacheIfFn: CacheIfFn | null;
+	transformFn: TransformFn | null;
 
-	constructor(
-		name: string,
-		query: string,
-		vars: Record<string, QueryVar> | null,
-		cacheIfFn: CacheIfFn | null,
-	) {
-		if (cacheIfFn && !vars)
+	constructor(name: string, query: string, args: QueryRouteArgs) {
+		if (args.cacheIfFn && !vars)
 			throw new Error(
 				'queryRoute: ' +
 					name +
-					' cannot have cacheIfFn if there are no vars defined',
+					' cannot have caching function if there are no ' +
+					'variables defined',
 			);
 
 		this.name = name;
 		this.query = query;
-		this.vars = vars;
-		this.cacheIfFn = cacheIfFn;
+		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();
@@ -96,6 +116,16 @@ export class QueryRoute {
 		return nVars;
 	}
 
+	private async transform(
+		jsonResp: Record<string, any>,
+		vars: Record<string, any>,
+	): Promise<void> {
+		if (!this.transformFn || !jsonResp.data) return;
+
+		const transformed = await this.transformFn(jsonResp.data, vars);
+		if (typeof transformed !== 'undefined') jsonResp.data = transformed;
+	}
+
 	async handle(
 		caching: QueriesCaching,
 		csr: CrelteServerRequest,
@@ -187,6 +217,7 @@ export class QueryRoute {
 			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);
 		}