chore(api): fix sync generation output

Author: jgoux

.github/workflows/api-package-sync.yml

@@ -79,6 +79,9 @@ jobs:
         run: pnpm generate
         working-directory: packages/api
 
+      - name: Format API package
+        run: pnpm exec nx run @supabase/api:fmt:fix
+
       - name: Check for generated changes
         id: check
         run: |

packages/api/scripts/generate.ts

@@ -311,7 +311,7 @@ function normalizeJsonSchemaValue(value: unknown): unknown {
   return isRecord(value) ? normalizeNullableJsonSchema(value) : value;
 }
 
-function normalizeNullableJsonSchema(schema: JsonSchema.JsonSchema): JsonSchema.JsonSchema {
+export function normalizeNullableJsonSchema(schema: JsonSchema.JsonSchema): JsonSchema.JsonSchema {
   const normalized: JsonSchema.JsonSchema = {};
   for (const [key, value] of Object.entries(schema)) {
     normalized[key] = normalizeJsonSchemaValue(value);
@@ -330,10 +330,6 @@ function normalizeNullableJsonSchema(schema: JsonSchema.JsonSchema): JsonSchema.
   if (nonNullTypes.length === 0) {
     return { type: "null" };
   }
-  if (!nonNullTypes.includes("object") && !nonNullTypes.includes("array")) {
-    return normalized;
-  }
-
   const nonNullSchema = { ...normalized };
   delete nonNullSchema.type;
   return {
@@ -900,4 +896,6 @@ function main() {
   console.log(`Generated ${operations.length} API operations in ${generatedDir}`);
 }
 
-main();
+if (import.meta.main) {
+  main();
+}

packages/api/scripts/generate.unit.test.ts

@@ -0,0 +1,26 @@
+import * as JsonSchema from "effect/JsonSchema";
+import * as SchemaRepresentation from "effect/SchemaRepresentation";
+import { describe, expect, test } from "vitest";
+
+import { normalizeNullableJsonSchema } from "./generate.ts";
+
+function renderOpenApiSchema(schema: Parameters<typeof JsonSchema.fromSchemaOpenApi3_0>[0]) {
+  const normalized = normalizeNullableJsonSchema(JsonSchema.fromSchemaOpenApi3_0(schema).schema);
+  const multiDocument = SchemaRepresentation.fromJsonSchemaMultiDocument({
+    dialect: "draft-2020-12",
+    definitions: {},
+    schemas: [normalized],
+  });
+  return SchemaRepresentation.toCodeDocument(multiDocument).codes[0]!.runtime;
+}
+
+describe("generate", () => {
+  test("preserves nullable formatted strings in generated schemas", () => {
+    expect(renderOpenApiSchema({ type: "string", format: "email", nullable: true })).toBe(
+      'Schema.Union([Schema.String.annotate({ "format": "email" }), Schema.Null])',
+    );
+    expect(renderOpenApiSchema({ type: "string", format: "date-time", nullable: true })).toBe(
+      'Schema.Union([Schema.String.annotate({ "format": "date-time" }), Schema.Null])',
+    );
+  });
+});