Generate public runtime enum exports during SDK updates

CONTRIBUTING.md

@@ -17,7 +17,7 @@ yarn
 
 ## Development
 
-Generated GraphQL clients live in `generated/`. Regenerate them after changing queries or the schema:
+Generated GraphQL clients live in `generated/`. Codegen also regenerates `src/types.ts` with runtime exports for every generated enum. Regenerate them after changing queries or the schema:
 
 ```bash
 yarn gen-clients

scripts/generateEnumExports.ts

@@ -0,0 +1,27 @@
+import ts from "typescript";
+
+export const generateEnumExports = (source: string): string => {
+  const sourceFile = ts.createSourceFile(
+    "generated.ts",
+    source,
+    ts.ScriptTarget.Latest,
+    true,
+  );
+  const enumNames = sourceFile.statements
+    .filter(ts.isEnumDeclaration)
+    .filter((declaration) =>
+      declaration.modifiers?.some(
+        ({ kind }) => kind === ts.SyntaxKind.ExportKeyword,
+      ),
+    )
+    .map(({ name }) => name.text)
+    .sort();
+
+  return [
+    "/* This file was generated by `yarn gen-clients`. Don't edit it directly */",
+    ...(enumNames.length > 0
+      ? [`export { ${enumNames.join(", ")} } from "../generated/generated.js";`]
+      : []),
+    'export type * from "../generated/generated.js";',
+  ].join("\n");
+};

src/codegen.ts

@@ -5,6 +5,8 @@ import { generate } from "@graphql-codegen/cli";
 import type { Types } from "@graphql-codegen/plugin-helpers";
 import prettier from "prettier";
 
+import { generateEnumExports } from "../scripts/generateEnumExports.js";
+
 const GENERATED_FILENAME = "generated/generated.ts";
 
 generate(
@@ -49,6 +51,17 @@ generate(
     });
     const qualifiedFilename = path.resolve(process.cwd(), fileOutput.filename);
     writeFileSync(qualifiedFilename, prettifiedOutput, "utf-8");
+    const enumExports = await prettier.format(
+      generateEnumExports(prettifiedOutput),
+      {
+        parser: "typescript",
+      },
+    );
+    writeFileSync(
+      path.resolve(process.cwd(), "src/types.ts"),
+      enumExports,
+      "utf-8",
+    );
     process.exit(0);
   })
   .catch((error) => {

src/types.ts

@@ -1,3 +1,4 @@
+/* This file was generated by `yarn gen-clients`. Don't edit it directly */
 export {
   BalanceUpdateConsistencyMode,
   CurrencyCode,
@@ -13,11 +14,19 @@ export {
   LedgerMigrationStatus,
   LedgerTypes,
   LinkType,
+  PaymentCurrencyCode,
+  PaymentMode,
+  PaymentStatus,
+  PostLinesAs,
   ReadBalanceConsistencyMode,
   SceneEventType,
   SchemaConsistencyMode,
   SchemaLedgerAccountStatus,
   SchemaLedgerEntryStatus,
+  SchemaPaymentAccountingEventKey,
+  SchemaPaymentTypeDirection,
+  SchemaPaymentTypeStatus,
+  SchemaSystemLineKind,
   StripeEnv,
   TxType,
   UnitEnv,

tests/enum-exports.test.ts

@@ -0,0 +1,61 @@
+import { runInNewContext } from "node:vm";
+import { generate } from "@graphql-codegen/cli";
+import type { Types } from "@graphql-codegen/plugin-helpers";
+import ts from "typescript";
+import { expect, it } from "vitest";
+
+import { generateEnumExports } from "../scripts/generateEnumExports.js";
+
+const evaluateModule = (
+  source: string,
+  dependencies: Record<string, Record<string, unknown>>,
+): Record<string, unknown> => {
+  const exports: Record<string, unknown> = {};
+  const { outputText } = ts.transpileModule(source, {
+    compilerOptions: { module: ts.ModuleKind.CommonJS },
+  });
+  runInNewContext(outputText, {
+    exports,
+    require: (name: string) => dependencies[name],
+  });
+  return exports;
+};
+
+it.each([
+  {
+    schema:
+      "enum CheckoutChannel { CARD BANK } type Query { channel: CheckoutChannel }",
+    enumName: "CheckoutChannel",
+  },
+  { schema: "type Query { id: ID }", enumName: undefined },
+])(
+  "generates usable public exports for $schema",
+  async ({ schema, enumName }) => {
+    const outputs: Types.FileOutput[] = await generate(
+      {
+        schema,
+        generates: {
+          "generated/generated.ts": { plugins: ["typescript"] },
+        },
+      },
+      false,
+    );
+    const generatedSource = outputs.find(
+      ({ filename }) => filename === "generated/generated.ts",
+    )!;
+    const source = `${generatedSource.content}
+      enum PrivateChannel { INTERNAL }
+      export const getSdk = () => ({});
+    `;
+    const generatedModule = evaluateModule(source, {});
+    const publicModule = evaluateModule(generateEnumExports(source), {
+      "../generated/generated.js": generatedModule,
+    });
+
+    expect(Object.keys(publicModule)).toEqual(enumName ? [enumName] : []);
+    if (enumName) {
+      expect(publicModule[enumName]).toBe(generatedModule[enumName]);
+      expect(publicModule[enumName]).toEqual({ Card: "CARD", Bank: "BANK" });
+    }
+  },
+);