feat: allow overloading of query from snapwp configs

examples/nextjs/starter/tsconfig.json

@@ -45,5 +45,5 @@
 		"**/*.tsx",
 		".next/types/**/*.ts"
 	],
-	"exclude": [ "node_modules", "src/__generated" ]
+	"exclude": [ "node_modules" ]
 }

packages/core/src/config/snapwp-config-manager.ts

@@ -1,7 +1,11 @@
 'use snapWPConfig';
 import { isValidUrl, generateGraphqlUrl } from '@/utils';
 import { Logger } from '@/logger';
-import type { BlockDefinitions } from '@snapwp/types';
+import type {
+	BlockDefinitions,
+	CurrentTemplateDocument,
+	GlobalStylesDocument,
+} from '@snapwp/types';
 import type { HTMLReactParserOptions } from 'html-react-parser';
 
 export interface SnapWPEnv {
@@ -46,6 +50,13 @@ export interface SnapWPConfig {
 	 * html-react-parser overload options
 	 */
 	parserOptions?: HTMLReactParserOptions;
+	/**
+	 * Queries
+	 */
+	queries?: {
+		globalStylesDocument?: GlobalStylesDocument;
+		currentTemplateDocument?: CurrentTemplateDocument;
+	};
 }
 
 /**
@@ -116,6 +127,10 @@ class SnapWPConfigManager {
 			type: 'object',
 			required: false,
 		},
+		queries: {
+			type: 'object',
+			required: false,
+		},
 	};
 
 	/**

packages/query/src/query-engine/index.ts

@@ -62,9 +62,17 @@ export class QueryEngine {
 			QueryEngine.initialize();
 		}
 
+		const { queries } = getConfig();
+
+		let query = GetGlobalStylesDocument;
+
+		if ( queries?.globalStylesDocument ) {
+			query = queries.globalStylesDocument;
+		}
+
 		try {
 			const data = await QueryEngine.apolloClient.query( {
-				query: GetGlobalStylesDocument,
+				query,
 				fetchPolicy: 'network-only', // @todo figure out a caching strategy, instead of always fetching from network
 				errorPolicy: 'all',
 			} );
@@ -99,9 +107,16 @@ export class QueryEngine {
 		}
 		const variables = { uri };
 
+		const { queries } = getConfig();
+
+		let query = GetCurrentTemplateDocument;
+
+		if ( queries?.currentTemplateDocument ) {
+			query = queries.currentTemplateDocument;
+		}
 		try {
 			const data = await QueryEngine.apolloClient.query( {
-				query: GetCurrentTemplateDocument,
+				query,
 				variables,
 				fetchPolicy: 'network-only', // @todo figure out a caching strategy, instead of always fetching from network
 				errorPolicy: 'all',

packages/types/package.json

@@ -38,6 +38,7 @@
 		"@types/react": "*",
 		"resolve-tspaths": "*",
 		"tsc-watch": "*",
-		"typescript": "*"
+		"typescript": "*",
+		"@apollo/client": "^3.11.4"
 	}
 }

packages/types/src/index.ts

@@ -1 +1,2 @@
 export * from './blocks';
+export * from './queries';

packages/types/src/queries/current-template.ts

@@ -0,0 +1,4 @@
+import type { TypedDocumentNode } from '@apollo/client';
+
+// Until we figure out generic types for GraphQL queries, we'll use `any` for now.
+export type CurrentTemplateDocument = TypedDocumentNode< any, any >;

packages/types/src/queries/global-styles.ts

@@ -0,0 +1,4 @@
+import type { TypedDocumentNode } from '@apollo/client';
+
+// Until we figure out generic types for GraphQL queries, we'll use `any` for now.
+export type GlobalStylesDocument = TypedDocumentNode< any, any >;

packages/types/src/queries/index.ts

@@ -0,0 +1,2 @@
+export * from './current-template';
+export * from './global-styles';