@supawatch/target-dictionary 0.2.0

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/README.md

@@ -0,0 +1,15 @@
+# @supawatch/target-dictionary
+
+The data-dictionary target for
+[supawatch](https://github.com/omar-dulaimi/supawatch). Emits
+`schema-dictionary.md`: per-table sections with SQL types, runtime types,
+nullability, keys, identity and default markers, plus enums, domains and
+composite types. Column and table comments come from Postgres itself
+(`comment on ...`), so the database stays the single source of
+documentation truth, and a comment change regenerates the file live.
+
+```ts
+targets: [{ kind: "dictionary" }]
+```
+
+MIT.

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import type { Snapshot, SnapshotFile, Target, TargetCapabilities, TargetOptions } from "@supawatch/core";
+export type DictionaryTargetOptions = TargetOptions;
+export declare class DictionaryTarget implements Target<DictionaryTargetOptions> {
+    readonly name = "dictionary";
+    readonly fileExtension = ".md";
+    readonly barrel = false;
+    readonly capabilities: TargetCapabilities;
+    renderTable(): never;
+    renderSnapshot(snapshot: Snapshot, _opts: DictionaryTargetOptions): SnapshotFile[];
+}
+export default DictionaryTarget;

package/dist/index.js

@@ -0,0 +1,91 @@
+function runtimeLabel(runtime) {
+    switch (runtime.kind) {
+        case "number":
+            return runtime.integer ? "number (integer)" : "number";
+        case "string":
+            return runtime.format ? `string (${runtime.format})` : "string";
+        case "boolean":
+            return "boolean";
+        case "date":
+            return "Date";
+        case "bytes":
+            return "Uint8Array";
+        case "json":
+            return "json (unknown shape)";
+        case "unknown":
+            return "unknown";
+        case "array":
+            return `array of ${runtimeLabel(runtime.element)}`;
+        case "enum":
+            return `enum: ${runtime.labels.join(", ")}`;
+    }
+}
+export class DictionaryTarget {
+    name = "dictionary";
+    fileExtension = ".md";
+    barrel = false;
+    capabilities = {
+        strictObjects: false,
+        brandedTypes: false,
+        dateInstances: false,
+    };
+    renderTable() {
+        throw new Error("dictionary is a snapshot-level target");
+    }
+    renderSnapshot(snapshot, _opts) {
+        const lines = [
+            "<!-- Generated by supawatch. Do not edit. -->",
+            "# Data dictionary",
+            "",
+        ];
+        for (const table of snapshot.tables) {
+            const marker = table.kind === "view" ? " (view)" : "";
+            lines.push(`## ${table.schema}.${table.name}${marker}`);
+            if (table.comment)
+                lines.push("", table.comment);
+            lines.push("", "| Column | SQL type | Runtime | Nullable | Notes |", "| --- | --- | --- | --- | --- |");
+            for (const col of table.columns) {
+                const notes = [];
+                if (table.primaryKey.includes(col.name))
+                    notes.push("PK");
+                const fk = table.foreignKeys.find((f) => f.columns.includes(col.name));
+                if (fk) {
+                    notes.push(`FK to ${fk.referencedTable}.${fk.referencedColumns[0]}`);
+                }
+                if (col.identity)
+                    notes.push(`identity ${col.identity}`);
+                if (col.generated)
+                    notes.push("generated");
+                if (col.hasDefault)
+                    notes.push("has default");
+                if (col.comment)
+                    notes.push(col.comment);
+                lines.push(`| ${col.name} | ${col.sqlType} | ${runtimeLabel(col.runtime)} | ${col.nullable ? "yes" : "no"} | ${notes.join("; ")} |`);
+            }
+            lines.push("");
+        }
+        if (snapshot.enums.length > 0) {
+            lines.push("## Enums", "");
+            for (const e of snapshot.enums) {
+                lines.push(`- **${e.name}**: ${e.labels.join(", ")}`);
+            }
+            lines.push("");
+        }
+        if (snapshot.domains.length > 0) {
+            lines.push("## Domains", "");
+            for (const d of snapshot.domains) {
+                lines.push(`- **${d.name}**: based on ${d.baseTypeName}`);
+            }
+            lines.push("");
+        }
+        if (snapshot.composites.length > 0) {
+            lines.push("## Composite types", "");
+            for (const c of snapshot.composites) {
+                lines.push(`- **${c.name}**: ${c.fields.map((f) => `${f.name} ${f.pgTypeName}`).join(", ")}`);
+            }
+            lines.push("");
+        }
+        return [{ file: "schema-dictionary.md", content: lines.join("\n") }];
+    }
+}
+export default DictionaryTarget;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@supawatch/target-dictionary",
+  "version": "0.2.0",
+  "description": "A markdown data dictionary generated from live Postgres by supawatch, comments sourced from the database itself.",
+  "keywords": [
+    "supabase",
+    "postgres",
+    "postgresql",
+    "codegen",
+    "schema",
+    "typescript",
+    "data-dictionary",
+    "documentation",
+    "comments"
+  ],
+  "license": "MIT",
+  "author": "Omar Dulaimi",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/omar-dulaimi/supawatch.git",
+    "directory": "packages/target-dictionary"
+  },
+  "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.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.1",
+    "typescript": "^5.9.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}