Update OpenAPI schema transforms

Signed-off-by: Andrew Richardson <[email protected]>

Author: awrichar

package.json

@@ -12,7 +12,7 @@
     "lint": "eslint \"lib/*.ts\"",
     "lint:fix": "eslint \"lib/*.ts\" --fix",
     "format": "prettier --write \"lib/*.ts\" \"examples/**/*.ts\"",
-    "schema": "ts-node scripts/schema.ts"
+    "schema": "ts-node scripts/parseSchema.ts"
   },
   "repository": {
     "type": "git",
@@ -45,4 +45,4 @@
     "form-data": "^4.0.0",
     "ws": "^8.17.1"
   }
-}
+}

scripts/parseSchema.ts

@@ -0,0 +1,38 @@
+import { promises as fs } from 'fs';
+import openapiTS, { astToString } from 'openapi-typescript';
+import * as ts from 'typescript';
+import { pathToFileURL } from 'url';
+
+const STRING = ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);
+const ANY = ts.factory.createKeywordTypeNode(ts.SyntaxKind.AnyKeyword);
+
+async function run() {
+  const localPath = pathToFileURL('../firefly/doc-site/docs/swagger/swagger.yaml');
+  console.log(`Generating types from ${localPath}`);
+  const output = await openapiTS(localPath.toString(), {
+    transform: (schemaObject, options) => {
+      if (schemaObject.type === 'object' && schemaObject.additionalProperties) {
+        // For objects with arbitrary properties, use "any" instead of "unknown"
+        return ANY;
+      }
+
+      if (
+        schemaObject.type === 'string' &&
+        schemaObject.format === 'uuid' &&
+        schemaObject.nullable &&
+        options.path &&
+        options.path.indexOf('/responses/') >= 0 &&
+        options.path.endsWith('/id')
+      ) {
+        // For IDs in a response body, override to be non-nullable
+        schemaObject.nullable = false;
+        return STRING;
+      }
+    },
+  });
+  await fs.writeFile('lib/schema.ts', astToString(output));
+}
+
+run().catch((err) => {
+  console.error('Error running script', err);
+});