@ndla/types-taxonomy 1.0.36 → 1.0.37

package/package.json

@@ -4,7 +4,8 @@
   "license": "GPL-3.0",
   "scripts": {
     "build": "tsc",
-    "do-publish": "tsc"
+    "do-publish": "tsc",
+    "generate-typescript": "tsx scripts/generate-openapi.ts"
   },
   "repository": {
     "type": "git",
@@ -15,7 +16,11 @@
   "types": "build/taxonomy-api.d.ts",
   "main": "taxonomy-api.js",
   "devDependencies": {
-    "typescript": "^5.0.2"
+    "@types/node": "^22.13.16",
+    "openapi-typescript": "^7.6.1",
+    "tsx": "^4.19.3",
+    "typescript": "^5.3.3"
   },
-  "version": "1.0.36"
+  "version": "1.0.37",
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/scripts/generate-openapi.ts

@@ -0,0 +1,49 @@
+/*
+ * Part of NDLA taxonomy-api
+ * Copyright (C) 2025 NDLA
+ *
+ * See LICENSE
+ *
+ */
+
+import fs from "node:fs";
+import openapiTS, { astToString, TransformObject } from "openapi-typescript";
+import ts, { TypeNode } from "typescript";
+
+if (process.argv.length !== 2) {
+  throw new Error("Invalid use");
+}
+
+const BLOB = ts.factory.createTypeReferenceNode(
+  ts.factory.createIdentifier("Blob"),
+);
+const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull()); // `null`
+
+async function generate_types(appName: string) {
+  const jsonFile = `./openapi.json`;
+  console.log(`Parsing ${jsonFile} to generate typescript files...`);
+  const schema = await fs.promises.readFile(jsonFile, "utf8");
+
+  const ast = await openapiTS(JSON.parse(schema), {
+    exportType: true,
+    // https://openapi-ts.dev/migration-guide#defaultnonnullable-true-by-default
+    defaultNonNullable: false,
+    transform(schemaObject, _options): TypeNode | undefined {
+      if (schemaObject.format === "binary") {
+        if (schemaObject.nullable) {
+          return ts.factory.createUnionTypeNode([BLOB, NULL]);
+        } else {
+          return BLOB;
+        }
+      }
+    },
+  });
+
+  const outputPath = `./taxonomy-api.ts`;
+  const output = astToString(ast);
+
+  console.log(`Outputting to ${outputPath}`);
+  fs.writeFileSync(outputPath, output);
+}
+
+generate_types(process.argv[2]);