fix(repo): codegen checks

Author: mandarini

.github/workflows/ci-core.yml

@@ -44,6 +44,9 @@ jobs:
       # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
       # - run: npx nx-cloud record -- echo Hello World
       # When you enable task distribution, run the e2e-ci task instead of e2e
+      - name: Check generated types are in sync
+        run: npm run codegen:check
+
       - name: Build affected packages
         run: npx nx affected --target=build
 

.husky/pre-commit

@@ -0,0 +1,15 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# Check if postgrest-js common types were modified
+if git diff --cached --name-only | grep -q "packages/core/postgrest-js/src/types/common/"; then
+  echo "📝 Detected changes in postgrest-js common types..."
+  echo "🔄 Running codegen to sync types..."
+
+  npm run codegen
+
+  # Add the generated files to the commit
+  git add packages/core/supabase-js/src/lib/rest/types/common/
+
+  echo "✅ Generated types have been updated and staged"
+fi

package.json

@@ -5,6 +5,8 @@
   "scripts": {
     "commit": "cz",
     "prepare": "husky",
+    "codegen": "node scripts/sync-common-types.js",
+    "codegen:check": "node scripts/sync-common-types.js && git diff --exit-code packages/core/supabase-js/src/lib/rest/types/common || (echo '\n❌ Generated types are out of sync.\n   Run: npm run codegen\n   Then commit the changes.\n' && exit 1)",
     "release-canary": "npx tsx scripts/release-canary.ts",
     "release-stable": "npx tsx scripts/release-stable.ts"
   },

packages/core/postgrest-js/package.json

@@ -37,7 +37,6 @@
     "format": "node scripts/format.js",
     "format:check": "node scripts/format.js check",
     "build": "npm run clean && npm run build:cjs && npm run build:esm",
-    "postbuild": "cp -rf ./src/types/common ../supabase-js/src/lib/rest/types/common",
     "build:cjs": "tsc -p tsconfig.json",
     "build:esm": "cpy wrapper.mjs dist/esm/",
     "docs": "typedoc src/index.ts --out docs/v2",

packages/core/supabase-js/src/lib/rest/types/common/common.ts

@@ -1,3 +1,13 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * This file is automatically synchronized from @supabase/postgrest-js
+ * Source: packages/core/postgrest-js/src/types/common/
+ *
+ * To update this file, modify the source in postgrest-js and run:
+ *   npm run codegen
+ */
+
 // Types that are shared between supabase-js and postgrest-js
 
 export type Fetch = typeof fetch
@@ -54,3 +64,4 @@ export type GenericSchema = {
 export type ClientServerOptions = {
   PostgrestVersion?: string
 }
+

packages/core/supabase-js/src/lib/rest/types/common/rpc.ts

@@ -1,3 +1,13 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * This file is automatically synchronized from @supabase/postgrest-js
+ * Source: packages/core/postgrest-js/src/types/common/
+ *
+ * To update this file, modify the source in postgrest-js and run:
+ *   npm run codegen
+ */
+
 import type { GenericFunction, GenericSchema, GenericSetofOption } from './common'
 
 // Functions matching utils

scripts/sync-common-types.js

@@ -0,0 +1,110 @@
+#!/usr/bin/env node
+
+/**
+ * Sync common type definitions from postgrest-js to supabase-js
+ *
+ * This script copies shared type definitions from @supabase/postgrest-js
+ * to @supabase/supabase-js to ensure type compatibility across complex
+ * generic types and conditional types.
+ *
+ * Source of truth: packages/core/postgrest-js/src/types/common/
+ * Destination: packages/core/supabase-js/src/lib/rest/types/common/
+ */
+
+const fs = require('fs')
+const path = require('path')
+const crypto = require('crypto')
+
+const SOURCE_DIR = path.join(__dirname, '../packages/core/postgrest-js/src/types/common')
+const DEST_DIR = path.join(__dirname, '../packages/core/supabase-js/src/lib/rest/types/common')
+
+const HEADER_COMMENT = `/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * This file is automatically synchronized from @supabase/postgrest-js
+ * Source: packages/core/postgrest-js/src/types/common/
+ *
+ * To update this file, modify the source in postgrest-js and run:
+ *   npm run codegen
+ */
+
+`
+
+function getFileHash(filePath) {
+  if (!fs.existsSync(filePath)) return null
+  const content = fs.readFileSync(filePath, 'utf8')
+  return crypto.createHash('md5').update(content).digest('hex')
+}
+
+function stripGeneratedHeader(content) {
+  // Remove existing AUTO-GENERATED header if present
+  const headerRegex = /^\/\*\*\s*\n\s*\*\s*AUTO-GENERATED FILE[\s\S]*?\*\/\s*\n\s*\n/
+  return content.replace(headerRegex, '')
+}
+
+function syncFile(fileName) {
+  const sourcePath = path.join(SOURCE_DIR, fileName)
+  const destPath = path.join(DEST_DIR, fileName)
+
+  if (!fs.existsSync(sourcePath)) {
+    console.error(`❌ Source file not found: ${sourcePath}`)
+    process.exit(1)
+  }
+
+  const sourceContent = fs.readFileSync(sourcePath, 'utf8')
+  const sourceHash = crypto.createHash('md5').update(sourceContent).digest('hex')
+
+  // Check if destination exists and compare content (excluding header)
+  let needsUpdate = true
+  if (fs.existsSync(destPath)) {
+    const destContent = fs.readFileSync(destPath, 'utf8')
+    const destContentStripped = stripGeneratedHeader(destContent)
+    const destHash = crypto.createHash('md5').update(destContentStripped).digest('hex')
+
+    if (sourceHash === destHash) {
+      needsUpdate = false
+    }
+  }
+
+  if (needsUpdate) {
+    const contentWithHeader = HEADER_COMMENT + sourceContent
+    fs.writeFileSync(destPath, contentWithHeader, 'utf8')
+    console.log(`✅ Synced: ${fileName}`)
+    return true
+  } else {
+    console.log(`⏭️  Unchanged: ${fileName}`)
+    return false
+  }
+}
+
+function main() {
+  console.log('🔄 Syncing common types from postgrest-js to supabase-js...\n')
+
+  // Ensure destination directory exists
+  if (!fs.existsSync(DEST_DIR)) {
+    fs.mkdirSync(DEST_DIR, { recursive: true })
+    console.log(`📁 Created directory: ${DEST_DIR}\n`)
+  }
+
+  // Get all .ts files from source directory
+  const sourceFiles = fs.readdirSync(SOURCE_DIR).filter(file => file.endsWith('.ts'))
+
+  if (sourceFiles.length === 0) {
+    console.error(`❌ No TypeScript files found in ${SOURCE_DIR}`)
+    process.exit(1)
+  }
+
+  let changedCount = 0
+  for (const file of sourceFiles) {
+    const changed = syncFile(file)
+    if (changed) changedCount++
+  }
+
+  console.log(`\n✨ Sync complete: ${changedCount} file(s) updated, ${sourceFiles.length - changedCount} unchanged`)
+
+  if (changedCount > 0) {
+    console.log('\n⚠️  Generated files were updated. Please commit these changes.')
+  }
+}
+
+main()