@automateinc/fleet-types 1.0.110 → 1.0.111

package/README.md

@@ -26,8 +26,10 @@ FLEET_API_PATH=../fleet-api
 FLEET_API_TYPES_PATH=api/types.d.ts
 ```
 
-Both paths are resolved relative to the directory where the command is run. Generate the declaration from Fleet
-API's `AppRouter` with:
+Both paths are resolved relative to the directory where the command is run. The generated declaration includes Fleet
+API's global `PrismaJson` namespace from `prisma/types.d.ts`; backend-only dependencies referenced by that namespace
+are emitted as `unknown` so the declaration remains portable. Generate the declaration from Fleet API's `AppRouter`
+with:
 
 ```bash
 npx @automateinc/fleet-types generate

package/bin/fleet-types.mjs

@@ -81,6 +81,7 @@ async function generateTypes() {
 	const apiRoot = path.resolve(callerRoot, fleetApiPath);
 	const outputPath = path.resolve(callerRoot, fleetApiTypesPath);
 	const routerSourcePath = path.join(apiRoot, "src/routers/trpc/index.ts");
+	const prismaJsonSourcePath = path.join(apiRoot, "prisma/types.d.ts");
 	const apiTsconfigPath = path.join(apiRoot, "tsconfig.json");
 	const executableExtension = process.platform === "win32" ? ".cmd" : "";
 	const callerBiomePath = path.join(callerRoot, `node_modules/.bin/biome${executableExtension}`);
@@ -118,10 +119,14 @@ async function generateTypes() {
 		rootNames: parsedConfig.fileNames,
 	});
 	const routerSource = program.getSourceFile(routerSourcePath);
+	const prismaJsonSource = program.getSourceFile(prismaJsonSourcePath);
 
 	if (!routerSource) {
 		throw new Error(`Unable to load AppRouter source at ${routerSourcePath}.`);
 	}
+	if (!prismaJsonSource) {
+		throw new Error(`Unable to load PrismaJson declarations at ${prismaJsonSourcePath}.`);
+	}
 
 	const sourceDiagnostics = [
 		...program.getSyntacticDiagnostics(routerSource),
@@ -156,6 +161,7 @@ async function generateTypes() {
 	const sourceFile = ts.createSourceFile(emittedPath, emittedDeclaration, ts.ScriptTarget.Latest, true);
 	const sanitizedSourceFile = sanitizeBackendTypes(ts, sourceFile);
 	const transformedSourceFile = transformProcedureOutputs(ts, sanitizedSourceFile);
+	const prismaJsonDeclaration = createPrismaJsonDeclaration(ts, prismaJsonSource);
 	const statements = transformedSourceFile.statements.filter(
 		statement =>
 			ts.isImportDeclaration(statement) ||
@@ -180,7 +186,7 @@ async function generateTypes() {
 	await mkdir(path.dirname(outputPath), { recursive: true });
 	await writeFile(
 		outputPath,
-		`// Generated by \`npx @automateinc/fleet-types generate\`. Do not edit manually.\n${SERIALIZED_OUTPUT_TYPES}\n${appRouterDeclaration}\n`,
+		`// Generated by \`npx @automateinc/fleet-types generate\`. Do not edit manually.\n${prismaJsonDeclaration}\n${SERIALIZED_OUTPUT_TYPES}\n${appRouterDeclaration}\n`,
 	);
 
 	if (existsSync(biomePath)) {
@@ -199,6 +205,40 @@ async function generateTypes() {
 	console.log(`Generated ${path.relative(callerRoot, outputPath)} from ${routerSourcePath}`);
 }
 
+function createPrismaJsonDeclaration(ts, sourceFile) {
+	const backendTypeNames = new Set();
+
+	for (const statement of sourceFile.statements) {
+		if (!ts.isImportDeclaration(statement) || !statement.importClause) continue;
+		if (!ts.isStringLiteral(statement.moduleSpecifier) || !statement.moduleSpecifier.text.startsWith("@/")) continue;
+
+		if (statement.importClause.name) backendTypeNames.add(statement.importClause.name.text);
+
+		const bindings = statement.importClause.namedBindings;
+		if (bindings && ts.isNamespaceImport(bindings)) {
+			backendTypeNames.add(bindings.name.text);
+		} else if (bindings) {
+			for (const element of bindings.elements) backendTypeNames.add(element.name.text);
+		}
+	}
+
+	const sanitizedSourceFile = sanitizeBackendTypes(ts, sourceFile, backendTypeNames);
+	const globalDeclarations = sanitizedSourceFile.statements.filter(
+		statement => ts.isModuleDeclaration(statement) && statement.name.text === "global",
+	);
+
+	if (globalDeclarations.length === 0) {
+		throw new Error(`PrismaJson global declarations were not found in ${sourceFile.fileName}.`);
+	}
+
+	const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
+
+	return globalDeclarations
+		.map(statement => printer.printNode(ts.EmitHint.Unspecified, statement, sanitizedSourceFile))
+		.join("\n")
+		.replace(/^(?: {4})+/gm, indentation => "\t".repeat(indentation.length / 4));
+}
+
 function transformProcedureOutputs(ts, sourceFile) {
 	const procedureTypes = new Set(["TRPCMutationProcedure", "TRPCQueryProcedure", "TRPCSubscriptionProcedure"]);
 	const transformation = ts.transform(sourceFile, [
@@ -256,18 +296,15 @@ function transformProcedureOutputs(ts, sourceFile) {
 	return transformedSourceFile;
 }
 
-function sanitizeBackendTypes(ts, sourceFile) {
+function sanitizeBackendTypes(ts, sourceFile, backendTypeNames = new Set()) {
 	const transformation = ts.transform(sourceFile, [
 		context => {
 			const visit = node => {
-				if (ts.isTypeReferenceNode(node)) {
-					let typeName = node.typeName;
-
-					while (ts.isQualifiedName(typeName)) typeName = typeName.left;
-
-					if (ts.isIdentifier(typeName) && typeName.text === "PrismaJson") {
-						return ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
-					}
+				if (
+					(ts.isTypeReferenceNode(node) || ts.isIndexedAccessTypeNode(node) || ts.isTypeQueryNode(node)) &&
+					referencesBackendType(ts, node, backendTypeNames)
+				) {
+					return ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
 				}
 
 				if (
@@ -292,6 +329,28 @@ function sanitizeBackendTypes(ts, sourceFile) {
 	return transformedSourceFile;
 }
 
+function referencesBackendType(ts, node, backendTypeNames) {
+	if (ts.isTypeReferenceNode(node)) {
+		let typeName = node.typeName;
+
+		while (ts.isQualifiedName(typeName)) typeName = typeName.left;
+
+		return ts.isIdentifier(typeName) && backendTypeNames.has(typeName.text);
+	}
+
+	if (ts.isIndexedAccessTypeNode(node)) return referencesBackendType(ts, node.objectType, backendTypeNames);
+
+	if (ts.isTypeQueryNode(node)) {
+		let expressionName = node.exprName;
+
+		while (ts.isQualifiedName(expressionName)) expressionName = expressionName.left;
+
+		return ts.isIdentifier(expressionName) && backendTypeNames.has(expressionName.text);
+	}
+
+	return false;
+}
+
 function formatTypeScriptDiagnostics(ts, diagnostics, currentDirectory) {
 	return ts.formatDiagnosticsWithColorAndContext(diagnostics, {
 		getCanonicalFileName: fileName => fileName,

package/package.json

@@ -57,5 +57,5 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "types": "dist/types/index.d.ts",
-  "version": "1.0.110"
+  "version": "1.0.111"
 }