@supawatch/target-supabase-types 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Omar Dulaimi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { type Snapshot, type SnapshotFile, type Target, type TargetCapabilities, type TargetOptions } from "@supawatch/core";
+export type SupabaseTypesOptions = TargetOptions;
+export declare class SupabaseTypesTarget implements Target<SupabaseTypesOptions> {
+    readonly name = "supabase-types";
+    readonly fileExtension = ".ts";
+    readonly capabilities: TargetCapabilities;
+    renderTable(): never;
+    renderSnapshot(snapshot: Snapshot, _opts: SupabaseTypesOptions): SnapshotFile[];
+}
+export default SupabaseTypesTarget;

package/dist/index.js

@@ -0,0 +1,163 @@
+import { arrayRuntimeFor, runtimeFor, } from "@supawatch/core";
+function tsType(runtime, jsonRef) {
+    switch (runtime.kind) {
+        case "number":
+            return "number";
+        case "string":
+            return "string";
+        case "boolean":
+            return "boolean";
+        case "date":
+            return "string"; // never reached under the supabase-js profile; defensive
+        case "bytes":
+            return "string";
+        case "json":
+            return jsonRef;
+        case "unknown":
+            return "unknown";
+        case "array": {
+            const el = tsType(runtime.element, jsonRef);
+            return el.includes("|") ? `(${el})[]` : `${el}[]`;
+        }
+        case "enum":
+            return runtime.labels.map((l) => JSON.stringify(l)).join(" | ");
+    }
+}
+// Re-resolve a column's runtime under the supabase-js profile from its
+// catalog identity, so the bridge is correct even when the rest of the
+// run uses the postgres-js profile.
+function bridgeRuntime(col, snapshot) {
+    if (col.runtime.kind === "array") {
+        return arrayRuntimeFor(runtimeFromName(col.runtime.element, snapshot), 1, "supabase-js");
+    }
+    if (col.runtime.kind === "string" && col.runtime.format === "array-literal") {
+        // postgres-js collapses enum arrays to a raw literal; PostgREST
+        // parses them. Recover the element labels via the enum reference.
+        const e = snapshot.enums.find((x) => x.name === col.enumRef);
+        if (e) {
+            return { kind: "array", element: { kind: "enum", labels: e.labels } };
+        }
+    }
+    return runtimeFor(col.pgTypeName, kindOf(col, snapshot), { enums: snapshot.enums }, "supabase-js");
+}
+function kindOf(col, snapshot) {
+    if (snapshot.enums.some((e) => e.name === col.pgTypeName))
+        return "e";
+    if (snapshot.composites.some((c) => c.name === col.pgTypeName))
+        return "c";
+    return "b";
+}
+function runtimeFromName(element, _snapshot) {
+    return element;
+}
+function writableColumns(table) {
+    return table.columns.filter((c) => !c.generated && c.identity !== "always");
+}
+function insertOptional(col) {
+    return col.hasDefault || col.nullable || col.identity === "default";
+}
+function fieldLine(col, snapshot, optional, indent) {
+    const runtime = bridgeRuntime(col, snapshot);
+    let t = tsType(runtime, "Json");
+    if (col.nullable && t !== "unknown")
+        t = `${t} | null`;
+    return `${indent}${col.name}${optional ? "?" : ""}: ${t}`;
+}
+export class SupabaseTypesTarget {
+    name = "supabase-types";
+    fileExtension = ".ts";
+    capabilities = {
+        strictObjects: false,
+        brandedTypes: false,
+        dateInstances: false,
+    };
+    renderTable() {
+        throw new Error("supabase-types is a snapshot-level target");
+    }
+    renderSnapshot(snapshot, _opts) {
+        const schemas = [...new Set(snapshot.tables.map((t) => t.schema))].sort();
+        const lines = [
+            "// Generated by supawatch. Do not edit.",
+            "export type Json =",
+            "  | string",
+            "  | number",
+            "  | boolean",
+            "  | null",
+            "  | { [key: string]: Json | undefined }",
+            "  | Json[];",
+            "",
+            "export interface Database {",
+        ];
+        for (const schema of schemas) {
+            const tables = snapshot.tables.filter((t) => t.schema === schema && t.kind === "table");
+            const views = snapshot.tables.filter((t) => t.schema === schema && t.kind === "view");
+            const enums = snapshot.enums.filter((e) => e.schema === schema);
+            const composites = snapshot.composites.filter((c) => c.schema === schema);
+            lines.push(`  ${schema}: {`);
+            lines.push("    Tables: {");
+            for (const table of tables) {
+                lines.push(`      ${table.name}: {`);
+                lines.push("        Row: {");
+                for (const col of table.columns) {
+                    lines.push(fieldLine(col, snapshot, false, "          ") + ";");
+                }
+                lines.push("        };");
+                lines.push("        Insert: {");
+                for (const col of writableColumns(table)) {
+                    lines.push(fieldLine(col, snapshot, insertOptional(col), "          ") + ";");
+                }
+                lines.push("        };");
+                lines.push("        Update: {");
+                for (const col of writableColumns(table)) {
+                    lines.push(fieldLine(col, snapshot, true, "          ") + ";");
+                }
+                lines.push("        };");
+                lines.push("        Relationships: [");
+                for (const fk of table.foreignKeys) {
+                    lines.push("          {");
+                    lines.push(`            foreignKeyName: ${JSON.stringify(fk.name)};`);
+                    lines.push(`            columns: [${fk.columns.map((c) => JSON.stringify(c)).join(", ")}];`);
+                    lines.push("            isOneToOne: false;");
+                    lines.push(`            referencedRelation: ${JSON.stringify(fk.referencedTable)};`);
+                    lines.push(`            referencedColumns: [${fk.referencedColumns.map((c) => JSON.stringify(c)).join(", ")}];`);
+                    lines.push("          },");
+                }
+                lines.push("        ];");
+                lines.push("      };");
+            }
+            lines.push("    };");
+            lines.push("    Views: {");
+            for (const view of views) {
+                lines.push(`      ${view.name}: {`);
+                lines.push("        Row: {");
+                for (const col of view.columns) {
+                    lines.push(fieldLine(col, snapshot, false, "          ") + ";");
+                }
+                lines.push("        };");
+                lines.push("      };");
+            }
+            lines.push("    };");
+            lines.push("    Functions: Record<string, never>;");
+            lines.push("    Enums: {");
+            for (const e of enums) {
+                lines.push(`      ${e.name}: ${e.labels.map((l) => JSON.stringify(l)).join(" | ")};`);
+            }
+            lines.push("    };");
+            lines.push("    CompositeTypes: {");
+            for (const c of composites) {
+                lines.push(`      ${c.name}: {`);
+                for (const f of c.fields) {
+                    const t = tsType(f.runtime, "Json");
+                    lines.push(`        ${f.name}: ${t} | null;`);
+                }
+                lines.push("      };");
+            }
+            lines.push("    };");
+            lines.push("  };");
+        }
+        lines.push("}");
+        lines.push("");
+        return [{ file: "database.types.ts", content: lines.join("\n") }];
+    }
+}
+export default SupabaseTypesTarget;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@supawatch/target-supabase-types",
+  "version": "0.1.1",
+  "license": "MIT",
+  "author": "Omar Dulaimi",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/omar-dulaimi/supawatch.git",
+    "directory": "packages/target-supabase-types"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@supawatch/core": "0.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.1",
+    "typescript": "^5.9.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}