feat: generate API types from the OpenAPI description

.github/workflows/ci.yml

@@ -25,6 +25,8 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: npm
       - run: npm ci
+      - run: npm run generate
+      - run: git diff --exit-code -- src/generated/api.ts
       - run: npm run typecheck
       - run: npm run lint
       - run: npm test -- --coverage

.prettierignore

@@ -1,4 +1,6 @@
 dist/
+src/generated/
+resources/
 coverage/
 node_modules/
 test/data/

README.md

@@ -469,6 +469,8 @@ client is created, without repeating the value.
 ## Development
 
 ```bash
+./sync.sh          # download the current OpenAPI description
+npm run generate   # rebuild src/generated/api.ts from that file
 npm ci
 npm run typecheck
 npm run lint

eslint.config.js

@@ -7,7 +7,7 @@ import { defineConfig } from 'eslint/config';
 const rootDir = fileURLToPath(new URL('.', import.meta.url));
 
 export default defineConfig(
-  { ignores: ['dist/', 'coverage/', 'node_modules/'] },
+  { ignores: ['dist/', 'coverage/', 'node_modules/', 'src/generated/'] },
   js.configs.recommended,
   {
     files: ['**/*.ts'],

generate.mjs

@@ -0,0 +1,19 @@
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import openapiTS, { astToString } from 'openapi-typescript';
+
+const root = resolve(dirname(fileURLToPath(import.meta.url)));
+const outputPath = resolve(root, 'src/generated/api.ts');
+
+const ast = await openapiTS(new URL('./resources/shieldlabs-api.yaml', import.meta.url));
+const banner = `/**
+ * Generated from resources/shieldlabs-api.yaml. Do not edit by hand.
+ * Refresh with: ./sync.sh && npm run generate
+ */
+`;
+
+mkdirSync(dirname(outputPath), { recursive: true });
+writeFileSync(outputPath, banner + astToString(ast));
+console.log(`Wrote ${outputPath}`);