fauna-gql-upload/src/lib/codegen.ts

Manage your FaunaDB resources in within your project and upload them using a single command

import fs from "fs";
import path from "path";
import camelize from "../util/camelize";
import { codegen } from "@graphql-codegen/core";
import type { Types, CodegenPlugin } from "@graphql-codegen/plugin-helpers"
import { UrlLoader } from "@graphql-tools/url-loader"
import { GraphQLFileLoader } from "@graphql-tools/graphql-file-loader";
import { CodeFileLoader } from "@graphql-tools/code-file-loader";
import { loadSchema, loadDocuments } from "@graphql-tools/load";

import getConfig from "../util/getConfig";
import { secret } from "../util/env";
import { status } from "../util/logger";
import getEndpoint from "../util/getEndpoint";

const cwd = process.cwd();
const config = getConfig();

export default async function runCodegen(){
	if(!config.codegen) return;

	// @ts-ignore
	const { printSchema, parse } = await import("graphql");

	try{
		const schema = await fetchSchema();
		const documents = await fetchDocuments();
		const { plugins, pluginMap } = await getPlugins();

		const output = await codegen({
			filename: config.codegen?.outputFile,
			schema: parse(printSchema(schema)),
			config: config.codegen.pluginOptions,
			plugins,
			pluginMap,
			documents
		})
		const outputExists = fs.existsSync(config.codegen.outputFile);

		if(!output){
			status("generated GraphQL output is empty", "info")
		}

		if(!outputExists){
			await fs.promises.mkdir(config.codegen.outputFile.split("/").slice(0, -1).join("/"), { recursive: true })
		}

		await fs.promises.writeFile(path.join(cwd, config.codegen.outputFile), output);
		status("generated GraphQL types, queries and mutations", "success");
	}catch(err){
		console.error(err);
	}
}

async function getPlugins(){
	if(!config.codegen) throw new Error("Codegen is not enabled");

	const globalPluginOptions = config.codegen.pluginOptions;
	const customPlugins = config.codegen.plugins || [];
	const pluginMap: { [key: string]: CodegenPlugin } = {};
	let plugins: Types.ConfiguredPlugin[] = [];
	
	if(config.codegen.typescript) {
		plugins.push({ typescript: globalPluginOptions })
		pluginMap.typescript = await import("@graphql-codegen/typescript");
	}

	if(config.codegen.operations && config.codegen.typescript) {
		plugins.push({ typescriptOperations: globalPluginOptions })
		pluginMap.typescriptOperations = await import("@graphql-codegen/typescript-operations");
	}

	if(customPlugins.length > 0)
		await Promise.all(customPlugins.map( async (plugin) => {
			const name = typeof plugin === "string" ? plugin : plugin[0];
			const localPluginOptions = Array.isArray(plugin) ? plugin[1] : {};

			// Remove scope of plugin if it exists
			const parsedName = name.split("/").slice(-1).join("")
			const camelCased = camelize(parsedName);

			// Get the plugin path by its original name
			const pluginPath = await getPluginPath(name);

			const pluginOptions = { ...globalPluginOptions, ...localPluginOptions };
			plugins.push({ [camelCased]: pluginOptions })
			pluginMap[camelCased] = await import(pluginPath);
		}))

	return {plugins, pluginMap};
}

/** Check whether the plugin is official, ie. exists within the "@graphql-codegen" node_modules directory.
	If it is, we return the plugin path with "@graphql-codegen" prepended.
	If it is not, we return the provided plugin path unaltered.
 */
async function getPluginPath(plugin: string){
	try{
		const pluginPath = path.join("@graphql-codegen", plugin);
		await import(pluginPath)
		return pluginPath;
	}catch(err){
		console.error(err);
		return plugin;
	}
}

async function fetchSchema(){
	const endpoint = await getEndpoint();
	const schema = await loadSchema(`${endpoint.graphql}/graphql`, {
		loaders: [
			new UrlLoader()
		],
		headers: {
			Authorization: `Bearer ${secret}`,
			...(config.codegen?.headers || {})
		}
	});

	return schema;
}

async function fetchDocuments(){
	if(!config.codegen) throw new Error("Codegen is not enabled.")
	const docs = config.codegen.documents;
	return loadDocuments(docs, { 
		cwd ,
		loaders: [
			new GraphQLFileLoader(),
			new CodeFileLoader()
		]
	});
}