Export BaseContext interface for strongly-typed loadContext() in _.context.ts files

.changeset/strongly-typed-load-context.md

@@ -0,0 +1,5 @@
+---
+"counterfact": minor
+---
+
+Export `ContextArgs` type from generated `types/scenario-context.ts` so that `_.context.ts` files can strongly type the `loadContext` and `readJson` parameters received in the Context constructor. The default `_.context.ts` template now imports and uses `ContextArgs`.

src/typescript-generator/generate.ts

@@ -256,6 +256,12 @@ function buildApplyContextContent(contextFiles: ContextFileInfo[]): string {
     "/** A scenario function that receives the live REPL environment */",
     "export type Scenario = ($: ApplyContext) => Promise<void> | void;",
     "",
+    "/** Interface for Context objects defined in _.context.ts files */",
+    "export interface BaseContext {",
+    '  readonly loadContext: ApplyContext["loadContext"];',
+    "  readonly readJson: (relativePath: string) => Promise<unknown>;",
+    "}",
+    "",
   ];
 
   return parts.join("\n");

src/typescript-generator/repository.ts

@@ -148,7 +148,9 @@ export class Repository {
 
     await fs.writeFile(
       contextFilePath,
-      `/**
+      `import type { BaseContext } from "../types/scenario-context.js";
+
+/**
 * This is the default context for Counterfact.
 *
 * It defines the context object in the REPL 
@@ -158,8 +160,14 @@ export class Repository {
 * 
 * See https://counterfact.dev/docs/usage.html#working-with-state-the-codecontextcode-object-and-codecontexttscode
 */
-export class Context {
+export class Context implements BaseContext {
+  readonly loadContext: BaseContext["loadContext"];
+  readonly readJson: BaseContext["readJson"];
 
+  constructor({ loadContext, readJson }: BaseContext) {
+    this.loadContext = loadContext;
+    this.readJson = readJson;
+  }
 }
 `,
     );

test/typescript-generator/generate.test.ts

@@ -80,6 +80,13 @@ describe("scenario-context type generation", () => {
       expect(content).toContain(
         "export type Scenario = ($: ApplyContext) => Promise<void> | void;",
       );
+      expect(content).toContain("export interface BaseContext {");
+      expect(content).toContain(
+        '  readonly loadContext: ApplyContext["loadContext"];',
+      );
+      expect(content).toContain(
+        "  readonly readJson: (relativePath: string) => Promise<unknown>;",
+      );
     });
   });