@chainlink/cre-sdk 1.3.0 → 1.4.0-alpha.1

package/README.md

@@ -58,10 +58,16 @@ CRE workflows are compiled to WASM and executed through Javy (QuickJS). This is
 
 - Node built-ins like `node:fs`, `node:crypto`, `node:http`, `node:net`, etc. are not supported in workflows.
 - Browser globals like `fetch`, `window`, and `setTimeout` are also not available in workflow runtime.
-- `cre compile:workflow` / `cre-compile` now validates workflow source and fails fast when unsupported APIs are used.
+- `cre compile:workflow` / `cre-compile` now typechecks your workflow project first (using your nearest `tsconfig.json`), then validates workflow source and fails fast when unsupported APIs are used.
 
 Use CRE capabilities (for example, `cre.capabilities.HTTPClient`) instead of direct Node/browser APIs.
 
+If you need to compile despite TypeScript errors, pass `--skip-type-checks`:
+
+```bash
+bun x cre-compile src/workflow.ts dist/workflow.wasm --skip-type-checks
+```
+
 ## Getting Started
 
 We recommend you consult the [getting started docs](https://docs.chain.link/cre/getting-started/cli-installation) and install the CRE CLI.

package/bin/cre-compile.ts

@@ -1,33 +1,50 @@
 #!/usr/bin/env bun
 
 import { main as compileWorkflow } from "../scripts/src/compile-workflow";
+import { parseCompileCliArgs, skipTypeChecksFlag } from "../scripts/src/compile-cli-args";
+import { WorkflowTypecheckError } from "../scripts/src/typecheck-workflow";
 import { WorkflowRuntimeCompatibilityError } from "../scripts/src/validate-workflow-runtime-compat";
 
 const main = async () => {
-  const cliArgs = process.argv.slice(2);
+  let inputPath: string | undefined;
+  let outputPathArg: string | undefined;
+  let skipTypeChecks = false;
 
-  const inputPath = cliArgs[0];
-  const outputPathArg = cliArgs[1];
+  try {
+    const parsed = parseCompileCliArgs(process.argv.slice(2));
+    inputPath = parsed.inputPath;
+    outputPathArg = parsed.outputPath;
+    skipTypeChecks = parsed.skipTypeChecks;
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : error);
+    console.error(
+      `Usage: cre-compile <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`
+    );
+    process.exit(1);
+  }
 
   if (!inputPath) {
     console.error(
-      "Usage: cre-compile <path/to/workflow.ts> [path/to/output.wasm]"
+      `Usage: cre-compile <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`
     );
     console.error("Examples:");
     console.error("  cre-compile src/standard_tests/secrets/test.ts");
     console.error(
       "  cre-compile src/standard_tests/secrets/test.ts .temp/standard_tests/secrets/test.wasm"
     );
+    console.error(
+      `  cre-compile src/standard_tests/secrets/test.ts .temp/standard_tests/secrets/test.wasm ${skipTypeChecksFlag}`
+    );
     process.exit(1);
   }
 
   // Delegate to the compile-workflow script
-  await compileWorkflow(inputPath, outputPathArg);
+  await compileWorkflow(inputPath, outputPathArg, { skipTypeChecks });
 };
 
 // CLI entry point
 main().catch((e) => {
-  if (e instanceof WorkflowRuntimeCompatibilityError) {
+  if (e instanceof WorkflowRuntimeCompatibilityError || e instanceof WorkflowTypecheckError) {
     console.error(`\n❌ ${e.message}`);
   } else {
     console.error(e);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@chainlink/cre-sdk",
-	"version": "1.3.0",
+	"version": "1.4.0-alpha.1",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -69,7 +69,7 @@
 		"@biomejs/biome": "2.3.14",
 		"@bufbuild/buf": "1.56.0",
 		"@types/bun": "1.3.8",
-		"chain-selectors": "https://github.com/smartcontractkit/chain-selectors.git#8b963095ae797a3024c8e55822cced7bf618176f",
+		"chain-selectors": "https://github.com/smartcontractkit/chain-selectors.git#a86ae261a09f805ea37165f58b017b4538e2e3bb",
 		"fast-glob": "3.3.3",
 		"ts-proto": "2.7.5",
 		"typescript": "5.9.3",

package/scripts/run.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env bun
 
+import { WorkflowTypecheckError } from './src/typecheck-workflow'
 import { WorkflowRuntimeCompatibilityError } from './src/validate-workflow-runtime-compat'
 
 const availableScripts = [
@@ -39,7 +40,10 @@ const main = async () => {
 			process.exit(1)
 		}
 	} catch (error) {
-		if (error instanceof WorkflowRuntimeCompatibilityError) {
+		if (
+			error instanceof WorkflowRuntimeCompatibilityError ||
+			error instanceof WorkflowTypecheckError
+		) {
 			console.error(`\n❌ ${error.message}`)
 		} else {
 			console.error(`Failed to run script ${scriptName}:`, error)

package/scripts/src/compile-cli-args.test.ts

@@ -0,0 +1,32 @@
+import { describe, expect, test } from 'bun:test'
+import { parseCompileCliArgs } from './compile-cli-args'
+
+describe('parseCompileCliArgs', () => {
+	test('parses positional input and output', () => {
+		const parsed = parseCompileCliArgs(['src/workflow.ts', 'dist/workflow.wasm'])
+		expect(parsed).toEqual({
+			inputPath: 'src/workflow.ts',
+			outputPath: 'dist/workflow.wasm',
+			skipTypeChecks: false,
+		})
+	})
+
+	test('parses --skip-type-checks flag', () => {
+		const parsed = parseCompileCliArgs(['src/workflow.ts', '--skip-type-checks'])
+		expect(parsed).toEqual({
+			inputPath: 'src/workflow.ts',
+			outputPath: undefined,
+			skipTypeChecks: true,
+		})
+	})
+
+	test('throws on unknown flags', () => {
+		expect(() => parseCompileCliArgs(['src/workflow.ts', '--foo'])).toThrow('Unknown option: --foo')
+	})
+
+	test('throws on too many positional args', () => {
+		expect(() => parseCompileCliArgs(['src/workflow.ts', 'dist/workflow.wasm', 'extra'])).toThrow(
+			'Too many positional arguments.',
+		)
+	})
+})

package/scripts/src/compile-cli-args.ts

@@ -0,0 +1,35 @@
+export const skipTypeChecksFlag = '--skip-type-checks'
+
+export type ParsedCompileArgs = {
+	inputPath?: string
+	outputPath?: string
+	skipTypeChecks: boolean
+}
+
+export const parseCompileCliArgs = (args: string[]): ParsedCompileArgs => {
+	const positionalArgs: string[] = []
+	let skipTypeChecks = false
+
+	for (const arg of args) {
+		if (arg === skipTypeChecksFlag) {
+			skipTypeChecks = true
+			continue
+		}
+
+		if (arg.startsWith('-')) {
+			throw new Error(`Unknown option: ${arg}`)
+		}
+
+		positionalArgs.push(arg)
+	}
+
+	if (positionalArgs.length > 2) {
+		throw new Error('Too many positional arguments.')
+	}
+
+	return {
+		inputPath: positionalArgs[0],
+		outputPath: positionalArgs[1],
+		skipTypeChecks,
+	}
+}

package/scripts/src/compile-to-js.test.ts

@@ -0,0 +1,90 @@
+import { afterEach, beforeEach, describe, expect, test } from 'bun:test'
+import { existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
+import path from 'node:path'
+import { main as compileToJs } from './compile-to-js'
+import { WorkflowTypecheckError } from './typecheck-workflow'
+
+let tempDir: string
+
+beforeEach(() => {
+	tempDir = mkdtempSync(path.join(process.cwd(), '.tmp-cre-compile-to-js-test-'))
+})
+
+afterEach(() => {
+	rmSync(tempDir, { recursive: true, force: true })
+})
+
+const writeTemp = (filename: string, content: string): string => {
+	const filePath = path.join(tempDir, filename)
+	mkdirSync(path.dirname(filePath), { recursive: true })
+	writeFileSync(filePath, content, 'utf-8')
+	return filePath
+}
+
+describe('compile-to-js typecheck behavior', () => {
+	test('fails on type errors by default', async () => {
+		writeTemp(
+			'tsconfig.json',
+			JSON.stringify(
+				{
+					compilerOptions: {
+						target: 'ES2022',
+						module: 'ESNext',
+						moduleResolution: 'Bundler',
+						skipLibCheck: true,
+						strict: true,
+						types: [],
+						lib: ['ESNext'],
+					},
+					include: ['src/**/*.ts'],
+				},
+				null,
+				2,
+			),
+		)
+		const entry = writeTemp('src/workflow.ts', "export const shouldBeNumber: number = 'oops'\n")
+		const output = path.join(tempDir, 'dist/workflow.js')
+
+		await expect(compileToJs(entry, output)).rejects.toBeInstanceOf(WorkflowTypecheckError)
+	})
+
+	test('continues when --skip-type-checks is enabled', async () => {
+		writeTemp(
+			'tsconfig.json',
+			JSON.stringify(
+				{
+					compilerOptions: {
+						target: 'ES2022',
+						module: 'ESNext',
+						moduleResolution: 'Bundler',
+						skipLibCheck: true,
+						strict: true,
+						types: [],
+						lib: ['ESNext'],
+					},
+					include: ['src/**/*.ts'],
+				},
+				null,
+				2,
+			),
+		)
+		const entry = writeTemp('src/workflow.ts', "export const shouldBeNumber: number = 'oops'\n")
+		const output = path.join(tempDir, 'dist/workflow.js')
+
+		let thrownError: unknown
+		let result: string | undefined
+		try {
+			result = await compileToJs(entry, output, {
+				skipTypeChecks: true,
+			})
+		} catch (error) {
+			thrownError = error
+		}
+
+		expect(thrownError).not.toBeInstanceOf(WorkflowTypecheckError)
+		if (typeof result === 'string') {
+			expect(result).toEqual(output)
+			expect(existsSync(output)).toBeTrue()
+		}
+	})
+})

package/scripts/src/compile-to-js.ts

@@ -2,24 +2,63 @@ import { existsSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs'
 import { mkdir } from 'node:fs/promises'
 import path from 'node:path'
 import { $ } from 'bun'
+import { parseCompileCliArgs, skipTypeChecksFlag } from './compile-cli-args'
+import { assertWorkflowTypecheck } from './typecheck-workflow'
 import { assertWorkflowRuntimeCompatibility } from './validate-workflow-runtime-compat'
 import { wrapWorkflowCode } from './workflow-wrapper'
 
-export const main = async (tsFilePath?: string, outputFilePath?: string) => {
-	const cliArgs = process.argv.slice(3)
+type CompileToJsOptions = {
+	skipTypeChecks?: boolean
+}
+
+const printUsage = () => {
+	console.error(`Usage: bun compile:ts-to-js <path-to-file> [output-file] [${skipTypeChecksFlag}]`)
+	console.error('Example:')
+	console.error('  bun compile:ts-to-js src/tests/foo.ts dist/tests/foo.bundle.js')
+	console.error(
+		`  bun compile:ts-to-js src/tests/foo.ts dist/tests/foo.bundle.js ${skipTypeChecksFlag}`,
+	)
+}
+
+export const main = async (
+	tsFilePath?: string,
+	outputFilePath?: string,
+	options?: CompileToJsOptions,
+) => {
+	let parsedInputPath: string | undefined
+	let parsedOutputPath: string | undefined
+	let parsedSkipTypeChecks = false
+
+	if (tsFilePath != null || outputFilePath != null || options?.skipTypeChecks != null) {
+		parsedInputPath = tsFilePath
+		parsedOutputPath = outputFilePath
+		parsedSkipTypeChecks = options?.skipTypeChecks ?? false
+	} else {
+		try {
+			const parsed = parseCompileCliArgs(process.argv.slice(3))
+			parsedInputPath = parsed.inputPath
+			parsedOutputPath = parsed.outputPath
+			parsedSkipTypeChecks = parsed.skipTypeChecks
+		} catch (error) {
+			console.error(error instanceof Error ? error.message : error)
+			printUsage()
+			process.exit(1)
+		}
+	}
 
 	// Prefer function params, fallback to CLI args
-	const inputPath = tsFilePath ?? cliArgs[0]
-	const outputPathArg = outputFilePath ?? cliArgs[1]
+	const inputPath = parsedInputPath
+	const outputPathArg = parsedOutputPath
 
 	if (!inputPath) {
-		console.error('Usage: bun test:standard:compile:js <path-to-file> [output-file]')
-		console.error('Example:')
-		console.error('  bun test:standard:compile:js src/tests/foo.ts dist/tests/foo.bundle.js')
+		printUsage()
 		process.exit(1)
 	}
 
 	const resolvedInput = path.resolve(inputPath)
+	if (!parsedSkipTypeChecks) {
+		assertWorkflowTypecheck(resolvedInput)
+	}
 	assertWorkflowRuntimeCompatibility(resolvedInput)
 	console.info(`📁 Using input file: ${resolvedInput}`)
 

package/scripts/src/compile-workflow.ts

@@ -1,23 +1,59 @@
 import { existsSync } from 'node:fs'
 import { mkdir } from 'node:fs/promises'
 import path from 'node:path'
+import { parseCompileCliArgs, skipTypeChecksFlag } from './compile-cli-args'
 import { main as compileToJs } from './compile-to-js'
 import { main as compileToWasm } from './compile-to-wasm'
 
-export const main = async (inputFile?: string, outputWasmFile?: string) => {
-	const cliArgs = process.argv.slice(3)
+type CompileWorkflowOptions = {
+	skipTypeChecks?: boolean
+}
+
+const printUsage = () => {
+	console.error(
+		`Usage: bun compile:workflow <path/to/workflow.ts> [path/to/output.wasm] [${skipTypeChecksFlag}]`,
+	)
+	console.error('Examples:')
+	console.error('  bun compile:workflow src/standard_tests/secrets/test.ts')
+	console.error(
+		'  bun compile:workflow src/standard_tests/secrets/test.ts .temp/standard_tests/secrets/test.wasm',
+	)
+	console.error(
+		`  bun compile:workflow src/standard_tests/secrets/test.ts .temp/standard_tests/secrets/test.wasm ${skipTypeChecksFlag}`,
+	)
+}
+
+export const main = async (
+	inputFile?: string,
+	outputWasmFile?: string,
+	options?: CompileWorkflowOptions,
+) => {
+	let parsedInputPath: string | undefined
+	let parsedOutputPath: string | undefined
+	let parsedSkipTypeChecks = false
 
-	// Resolve input/output from params or CLI
-	const inputPath = inputFile ?? cliArgs[0]
-	const outputPathArg = outputWasmFile ?? cliArgs[1]
+	if (inputFile != null || outputWasmFile != null || options?.skipTypeChecks != null) {
+		parsedInputPath = inputFile
+		parsedOutputPath = outputWasmFile
+		parsedSkipTypeChecks = options?.skipTypeChecks ?? false
+	} else {
+		try {
+			const parsed = parseCompileCliArgs(process.argv.slice(3))
+			parsedInputPath = parsed.inputPath
+			parsedOutputPath = parsed.outputPath
+			parsedSkipTypeChecks = parsed.skipTypeChecks
+		} catch (error) {
+			console.error(error instanceof Error ? error.message : error)
+			printUsage()
+			process.exit(1)
+		}
+	}
+
+	const inputPath = parsedInputPath
+	const outputPathArg = parsedOutputPath
 
 	if (!inputPath) {
-		console.error('Usage: bun compile:workflow <path/to/workflow.ts> [path/to/output.wasm]')
-		console.error('Examples:')
-		console.error('  bun compile:workflow src/standard_tests/secrets/test.ts')
-		console.error(
-			'  bun compile:workflow src/standard_tests/secrets/test.ts .temp/standard_tests/secrets/test.wasm',
-		)
+		printUsage()
 		process.exit(1)
 	}
 
@@ -42,10 +78,13 @@ export const main = async (inputFile?: string, outputWasmFile?: string) => {
 
 	console.info(`🚀 Compiling workflow`)
 	console.info(`📁 Input:   ${resolvedInput}\n`)
+	if (parsedSkipTypeChecks) {
+		console.info(`⚠️  Skipping TypeScript checks (${skipTypeChecksFlag})`)
+	}
 
 	// Step 1: TS/JS → JS (bundled)
 	console.info('📦 Step 1: Compiling JS...')
-	await compileToJs(resolvedInput, resolvedJsOutput)
+	await compileToJs(resolvedInput, resolvedJsOutput, { skipTypeChecks: parsedSkipTypeChecks })
 
 	// Step 2: JS → WASM
 	console.info('\n🔨 Step 2: Compiling to WASM...')

package/scripts/src/typecheck-workflow.test.ts

@@ -0,0 +1,77 @@
+import { afterEach, beforeEach, describe, expect, test } from 'bun:test'
+import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import path from 'node:path'
+import { assertWorkflowTypecheck, WorkflowTypecheckError } from './typecheck-workflow'
+
+let tempDir: string
+
+beforeEach(() => {
+	tempDir = mkdtempSync(path.join(tmpdir(), 'cre-typecheck-test-'))
+})
+
+afterEach(() => {
+	rmSync(tempDir, { recursive: true, force: true })
+})
+
+const writeTemp = (filename: string, content: string): string => {
+	const filePath = path.join(tempDir, filename)
+	mkdirSync(path.dirname(filePath), { recursive: true })
+	writeFileSync(filePath, content, 'utf-8')
+	return filePath
+}
+
+describe('assertWorkflowTypecheck', () => {
+	test('passes for valid project using nearby tsconfig', () => {
+		writeTemp(
+			'tsconfig.json',
+			JSON.stringify(
+				{
+					compilerOptions: {
+						target: 'ES2022',
+						module: 'ESNext',
+						moduleResolution: 'Bundler',
+						skipLibCheck: true,
+					},
+					include: ['src/**/*.ts'],
+				},
+				null,
+				2,
+			),
+		)
+		const entry = writeTemp('src/workflow.ts', 'export const value: number = 42\n')
+		expect(() => assertWorkflowTypecheck(entry)).not.toThrow()
+	})
+
+	test('fails when tsconfig cannot be found', () => {
+		const entry = writeTemp('src/workflow.ts', 'export const value = 1\n')
+		expect(() => assertWorkflowTypecheck(entry)).toThrow(WorkflowTypecheckError)
+		expect(() => assertWorkflowTypecheck(entry)).toThrow('Could not find tsconfig.json')
+	})
+
+	test('fails on whole-project type errors outside entry file', () => {
+		writeTemp(
+			'tsconfig.json',
+			JSON.stringify(
+				{
+					compilerOptions: {
+						target: 'ES2022',
+						module: 'ESNext',
+						moduleResolution: 'Bundler',
+						skipLibCheck: true,
+						strict: true,
+					},
+					include: ['src/**/*.ts'],
+				},
+				null,
+				2,
+			),
+		)
+
+		const entry = writeTemp('src/workflow.ts', 'export const value: number = 1\n')
+		writeTemp('src/unrelated.ts', "export const shouldBeNumber: number = 'not-a-number'\n")
+
+		expect(() => assertWorkflowTypecheck(entry)).toThrow(WorkflowTypecheckError)
+		expect(() => assertWorkflowTypecheck(entry)).toThrow('unrelated.ts')
+	})
+})

package/scripts/src/typecheck-workflow.ts

@@ -0,0 +1,96 @@
+import path from 'node:path'
+import * as ts from 'typescript'
+import { skipTypeChecksFlag } from './compile-cli-args'
+
+const toAbsolutePath = (filePath: string) => path.resolve(filePath)
+
+const formatDiagnostic = (diagnostic: ts.Diagnostic): string => {
+	const message = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n')
+	if (!diagnostic.file || diagnostic.start == null) {
+		return message
+	}
+
+	const absoluteFilePath = toAbsolutePath(diagnostic.file.fileName)
+	const relativeFilePath = path.relative(process.cwd(), absoluteFilePath)
+	const displayPath = relativeFilePath || absoluteFilePath
+	const { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start)
+	return `${displayPath}:${line + 1}:${character + 1} ${message}`
+}
+
+class WorkflowTypecheckError extends Error {
+	constructor(message: string) {
+		super(message)
+		this.name = 'WorkflowTypecheckError'
+	}
+}
+
+const findNearestTsconfigPath = (entryFilePath: string): string | null => {
+	const configPath = ts.findConfigFile(
+		path.dirname(entryFilePath),
+		ts.sys.fileExists,
+		'tsconfig.json',
+	)
+	return configPath ?? null
+}
+
+export const assertWorkflowTypecheck = (entryFilePath: string) => {
+	const rootFile = toAbsolutePath(entryFilePath)
+	const configPath = findNearestTsconfigPath(rootFile)
+	if (!configPath) {
+		throw new WorkflowTypecheckError(
+			`TypeScript typecheck failed before workflow compilation.
+Could not find tsconfig.json near: ${rootFile}
+Create a tsconfig.json in your workflow project, or re-run compile with ${skipTypeChecksFlag}.`,
+		)
+	}
+
+	let unrecoverableDiagnostic: ts.Diagnostic | null = null
+	const parsedConfig = ts.getParsedCommandLineOfConfigFile(
+		configPath,
+		{},
+		{
+			...ts.sys,
+			onUnRecoverableConfigFileDiagnostic: (diagnostic) => {
+				unrecoverableDiagnostic = diagnostic
+			},
+		},
+	)
+
+	if (!parsedConfig) {
+		const details = unrecoverableDiagnostic ? formatDiagnostic(unrecoverableDiagnostic) : ''
+		throw new WorkflowTypecheckError(
+			`TypeScript typecheck failed before workflow compilation.
+Failed to parse tsconfig.json: ${configPath}
+${details}
+Fix your tsconfig.json, or re-run compile with ${skipTypeChecksFlag}.`,
+		)
+	}
+
+	const program = ts.createProgram({
+		rootNames: parsedConfig.fileNames,
+		options: {
+			...parsedConfig.options,
+			noEmit: true,
+		},
+		projectReferences: parsedConfig.projectReferences,
+	})
+
+	const diagnostics = [...parsedConfig.errors, ...ts.getPreEmitDiagnostics(program)].filter(
+		(diagnostic) => diagnostic.category === ts.DiagnosticCategory.Error,
+	)
+
+	if (diagnostics.length > 0) {
+		const formatted = diagnostics.map(formatDiagnostic).join('\n')
+		const relativeConfigPath = path.relative(process.cwd(), toAbsolutePath(configPath))
+		const displayConfigPath = relativeConfigPath || toAbsolutePath(configPath)
+		throw new WorkflowTypecheckError(
+			`TypeScript typecheck failed before workflow compilation.
+Using tsconfig: ${displayConfigPath}
+Fix TypeScript errors, or re-run compile with ${skipTypeChecksFlag}.
+
+${formatted}`,
+		)
+	}
+}
+
+export { WorkflowTypecheckError }