better-supabase 0.0.0 → 0.1.0

package/package.json

@@ -1,21 +1,7 @@
 {
   "name": "better-supabase",
-  "version": "0.0.0",
-  "main": "index.js",
+  "version": "0.1.0",
   "description": "Strongly typed Supabase: generated schema, typed repositories, plugins, auth glue and framework integrations, with a CLI from day one.",
-  "publishConfig": {
-    "access": "public"
-  },
-  "license": "MIT",
-  "homepage": "https://bettersupabase.com",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ScaleDockHQ/better-supabase.git",
-    "directory": "packages/better-supabase"
-  },
-  "bugs": {
-    "url": "https://github.com/ScaleDockHQ/better-supabase/issues"
-  },
   "keywords": [
     "hono",
     "mcp",
@@ -28,5 +14,248 @@
     "supabase",
     "tanstack-query",
     "typescript"
-  ]
-}
+  ],
+  "homepage": "https://bettersupabase.com",
+  "bugs": {
+    "url": "https://github.com/ScaleDockHQ/better-supabase/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ScaleDockHQ/better-supabase.git",
+    "directory": "packages/better-supabase"
+  },
+  "bin": {
+    "better-supabase": "./bin/better-supabase.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "schemas",
+    "skills",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./config": {
+      "types": "./dist/config/index.d.ts",
+      "default": "./dist/config/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "default": "./dist/client/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "react-server": "./dist/react/server.js",
+      "default": "./dist/react/index.js"
+    },
+    "./query": {
+      "types": "./dist/query/index.d.ts",
+      "default": "./dist/query/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "default": "./dist/server/index.js"
+    },
+    "./postgres": {
+      "types": "./dist/postgres/index.d.ts",
+      "default": "./dist/postgres/index.js"
+    },
+    "./ssr": {
+      "types": "./dist/ssr/index.d.ts",
+      "default": "./dist/ssr/index.js"
+    },
+    "./next": {
+      "types": "./dist/next/index.d.ts",
+      "default": "./dist/next/index.js"
+    },
+    "./next/image": {
+      "types": "./dist/next/image/index.d.ts",
+      "default": "./dist/next/image/index.js"
+    },
+    "./hono": {
+      "types": "./dist/hono/index.d.ts",
+      "default": "./dist/hono/index.js"
+    },
+    "./orpc": {
+      "types": "./dist/orpc/index.d.ts",
+      "default": "./dist/orpc/index.js"
+    },
+    "./edge": {
+      "types": "./dist/edge/index.d.ts",
+      "default": "./dist/edge/index.js"
+    },
+    "./mcp": {
+      "types": "./dist/mcp/index.d.ts",
+      "default": "./dist/mcp/index.js"
+    },
+    "./jobs": {
+      "types": "./dist/jobs/index.d.ts",
+      "default": "./dist/jobs/index.js"
+    },
+    "./env": {
+      "types": "./dist/env/index.d.ts",
+      "default": "./dist/env/index.js"
+    },
+    "./list": {
+      "types": "./dist/list/index.d.ts",
+      "default": "./dist/list/index.js"
+    },
+    "./storage": {
+      "types": "./dist/storage/index.d.ts",
+      "default": "./dist/storage/index.js"
+    },
+    "./realtime": {
+      "types": "./dist/realtime/index.d.ts",
+      "default": "./dist/realtime/index.js"
+    },
+    "./events": {
+      "types": "./dist/events/index.d.ts",
+      "default": "./dist/events/index.js"
+    },
+    "./webhooks": {
+      "types": "./dist/webhooks/index.d.ts",
+      "default": "./dist/webhooks/index.js"
+    },
+    "./openapi": {
+      "types": "./dist/openapi/index.d.ts",
+      "default": "./dist/openapi/index.js"
+    },
+    "./otel": {
+      "types": "./dist/otel/index.d.ts",
+      "default": "./dist/otel/index.js"
+    },
+    "./plugins/timestamps": {
+      "types": "./dist/plugins/timestamps/index.d.ts",
+      "default": "./dist/plugins/timestamps/index.js"
+    },
+    "./lint": {
+      "types": "./dist/lint/index.d.ts",
+      "default": "./dist/lint/index.js"
+    },
+    "./plugins/rules": {
+      "types": "./dist/plugins/rules/index.d.ts",
+      "default": "./dist/plugins/rules/index.js"
+    },
+    "./plugins/soft-delete": {
+      "types": "./dist/plugins/soft-delete/index.d.ts",
+      "default": "./dist/plugins/soft-delete/index.js"
+    },
+    "./plugins/tenant": {
+      "types": "./dist/plugins/tenant/index.d.ts",
+      "default": "./dist/plugins/tenant/index.js"
+    },
+    "./plugins/actor": {
+      "types": "./dist/plugins/actor/index.d.ts",
+      "default": "./dist/plugins/actor/index.js"
+    },
+    "./plugins/validation": {
+      "types": "./dist/plugins/validation/index.d.ts",
+      "default": "./dist/plugins/validation/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "default": "./dist/testing/index.js"
+    },
+    "./cli": {
+      "types": "./dist/cli/index.d.ts",
+      "default": "./dist/cli/index.js"
+    },
+    "./schemas/*.json": "./schemas/*.json",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@standard-schema/spec": "1.1.0",
+    "@supabase/middleware": "0.6.0",
+    "@supabase/postgrest-typegen": "0.2.2",
+    "@supabase/server": "1.8.1",
+    "@supabase/ssr": "0.12.7"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "0.18.5",
+    "@better-supabase/typescript-config": "0.0.0",
+    "@effect/platform-node": "4.0.0-rc.117",
+    "@opentelemetry/api": "1.9.1",
+    "@orpc/server": "2.0.0-beta.40",
+    "@supabase/config": "0.10.0",
+    "@supabase/supabase-js": "2.117.2",
+    "@tanstack/query-core": "5.104.0",
+    "@tanstack/react-query": "5.104.0",
+    "@types/node": "26.6.3",
+    "@types/pg": "8.23.1",
+    "@types/react": "19.3.0",
+    "@types/react-dom": "19.3.0",
+    "@vitest/coverage-v8": "5.0.2",
+    "effect": "4.0.0-rc.117",
+    "hono": "4.13.10",
+    "next": "16.3.6",
+    "oxfmt": "0.71.0",
+    "pg": "8.23.0",
+    "publint": "0.3.24",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "tsdown": "0.23.0",
+    "typescript": "7.0.2",
+    "valibot": "1.5.0",
+    "vitest": "5.0.2",
+    "zod": "4.6.5"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": ">=1.9",
+    "@orpc/server": ">=2.0.0-0",
+    "@supabase/config": ">=0.9.0 <0.11",
+    "@supabase/supabase-js": "^2.116.0",
+    "@tanstack/query-core": "^5",
+    "hono": ">=4",
+    "next": ">=16",
+    "pg": ">=8",
+    "react": "^19"
+  },
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    },
+    "@orpc/server": {
+      "optional": true
+    },
+    "@supabase/config": {
+      "optional": true
+    },
+    "@tanstack/query-core": {
+      "optional": true
+    },
+    "hono": {
+      "optional": true
+    },
+    "next": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "bench": "node src/next/next.bench.ts",
+    "build": "tsdown",
+    "check:publish": "publint && pnpm pack --out pack.tgz && attw --profile esm-only pack.tgz && rm -f pack.tgz",
+    "test": "vitest run --coverage",
+    "typecheck": "tsc --noEmit --checkers 4"
+  }
+}

package/schemas/config-v1.json

@@ -0,0 +1,328 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/better-supabase/schemas/config-v1.json",
+  "title": "better-supabase config",
+  "description": "Configuration for better-supabase.config.ts (or .json).",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string" },
+    "source": {
+      "description": "Where codegen reads the database from. Without any of these, $DATABASE_URL and then the local stack are used.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "dbUrl": {
+          "type": "string",
+          "description": "Postgres connection string."
+        },
+        "projectRef": {
+          "type": "string",
+          "description": "Hosted project ref, read through the Management API read-only SQL endpoint."
+        },
+        "accessToken": {
+          "type": "string",
+          "description": "Management API token for projectRef. Defaults to $SUPABASE_ACCESS_TOKEN."
+        },
+        "snapshot": {
+          "type": "string",
+          "description": "Read a saved introspection snapshot instead of connecting."
+        }
+      }
+    },
+    "schemas": {
+      "description": "Postgres schemas to generate.",
+      "type": "array",
+      "items": { "type": "string" },
+      "default": ["public"]
+    },
+    "casing": { "$ref": "#/$defs/casing", "default": "snake" },
+    "tables": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "casing": { "$ref": "#/$defs/casing" },
+          "exclude": { "type": "boolean" },
+          "relations": {
+            "type": "object",
+            "additionalProperties": { "type": "string" }
+          }
+        }
+      }
+    },
+    "output": {
+      "type": "string",
+      "description": "Main generated module.",
+      "default": "src/lib/supabase/generated.ts"
+    },
+    "postgrestVersion": {
+      "type": "string",
+      "description": "PostgREST major version written to database.types.ts.",
+      "default": "13"
+    },
+    "codecs": {
+      "description": "Runtime types for timestamps, int8 and numeric columns.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "timestamptz": { "enum": ["string", "date"], "default": "string" },
+        "int8": { "enum": ["number", "string", "bigint"], "default": "number" },
+        "numeric": { "enum": ["number", "string"], "default": "number" }
+      }
+    },
+    "json": {
+      "description": "Types for jsonb columns, keyed by `table.column`.",
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": ["import"],
+            "additionalProperties": false,
+            "properties": {
+              "import": {
+                "type": "string",
+                "description": "`./path.ts#TypeName`"
+              },
+              "schema": {
+                "type": "object",
+                "description": "JSON Schema enforced by `sql add jsonb-schemas` (pg_jsonschema)."
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": ["type"],
+            "additionalProperties": false,
+            "properties": {
+              "type": {
+                "type": "string",
+                "description": "Inline TypeScript type."
+              },
+              "schema": {
+                "type": "object",
+                "description": "JSON Schema enforced by `sql add jsonb-schemas` (pg_jsonschema)."
+              }
+            }
+          }
+        ]
+      }
+    },
+    "generators": {
+      "description": "Generator plugins. Only available in better-supabase.config.ts.",
+      "type": "array"
+    },
+    "plugins": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "timestamps": {
+          "oneOf": [
+            { "type": "boolean" },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "createdAt": { "type": "string" },
+                "updatedAt": { "type": "string" }
+              }
+            }
+          ]
+        },
+        "softDelete": {
+          "oneOf": [
+            { "type": "boolean" },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": { "column": { "type": "string" } }
+            }
+          ]
+        },
+        "tenant": {
+          "oneOf": [
+            { "type": "boolean" },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "column": { "type": "string" },
+                "claim": { "type": "string" }
+              }
+            }
+          ]
+        },
+        "actor": {
+          "oneOf": [
+            { "type": "boolean" },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "createdBy": { "type": "string" },
+                "updatedBy": { "type": "string" }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "buckets": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "required": ["path"],
+        "additionalProperties": false,
+        "properties": {
+          "id": { "type": "string" },
+          "public": { "type": "boolean" },
+          "path": {
+            "type": "string",
+            "description": "Path template, e.g. `{orgId}/{customerId}/logo.webp`."
+          },
+          "policy": { "enum": ["tenant", "owner", "public", "none"] },
+          "fileSizeLimit": { "type": "string" },
+          "allowedMimeTypes": { "type": "array", "items": { "type": "string" } }
+        }
+      }
+    },
+    "topics": {
+      "description": "Realtime topic templates.",
+      "type": "object",
+      "additionalProperties": { "type": "string" }
+    },
+    "sensitive": {
+      "description": "Columns guarded by the noSensitiveSelect rule (`table.column` or `schema.table.column`).",
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "storagePaths": {
+      "description": "Text columns holding a storage object path (`table.column` or `schema.table.column`), mapped to a `buckets` key or bucket id. Typed as `StoragePath<'bucket-id'>`.",
+      "type": "object",
+      "additionalProperties": { "type": "string" }
+    },
+    "expose": {
+      "description": "Data API grants keyed by `table` or `schema.table`: privileges for authenticated, or per role. Written by the `grants` SQL kit module and checked by doctor (BS106).",
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          { "$ref": "#/$defs/privileges" },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "anon": { "$ref": "#/$defs/privileges" },
+              "authenticated": { "$ref": "#/$defs/privileges" }
+            }
+          }
+        ]
+      }
+    },
+    "readSets": {
+      "description": "Modules exporting `defineReadSet` results. `gen` compiles them into the `read-sets` SQL kit module.",
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "entitlements": {
+      "description": "Where the `entitlements` SQL kit module finds each tenant's Stripe customer.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "customer": {
+          "description": "`table.column` or `schema.table.column` holding the Stripe customer id.",
+          "type": "string",
+          "default": "organizations.stripe_customer_id"
+        },
+        "key": {
+          "description": "The tenant id column of that table.",
+          "type": "string",
+          "default": "id"
+        }
+      }
+    },
+    "vectorSearch": {
+      "description": "Embedding columns keyed by `table` or `schema.table`. The `vector-search` SQL kit module writes `search_<table>(query, k)` for each.",
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          { "type": "string", "description": "The embedding column." },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["column"],
+            "properties": {
+              "column": { "type": "string" },
+              "distance": {
+                "enum": ["cosine", "l2", "inner_product"],
+                "default": "cosine"
+              }
+            }
+          }
+        ]
+      }
+    },
+    "realtime": {
+      "description": "Live query change broadcasts.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "tables": {
+          "description": "Tables that broadcast change signals (`table` or `schema.table`). Install with `better-supabase sql add realtime-tables`.",
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "sql": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "dir": { "type": "string", "default": "supabase/schemas" },
+        "prefix": { "type": "string", "default": "900_better_supabase" },
+        "testsDir": { "type": "string", "default": "supabase/tests" },
+        "kit": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "seed": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "entry": { "type": "string", "default": "supabase/seed.ts" },
+        "output": {
+          "type": "string",
+          "default": "supabase/seeds/000_better_supabase.sql"
+        }
+      }
+    },
+    "openapi": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "entry": { "type": "string", "default": "src/lib/openapi.ts" },
+        "output": { "type": "string", "default": "openapi.json" }
+      }
+    },
+    "doctor": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "ignore": {
+          "type": "array",
+          "items": { "type": "string", "pattern": "^BS\\d{3}$" }
+        },
+        "strict": { "type": "boolean" },
+        "sources": { "type": "array", "items": { "type": "string" } },
+        "policyHelperLimit": { "type": "integer", "minimum": 1 }
+      }
+    }
+  },
+  "$defs": {
+    "casing": { "enum": ["snake", "camel"] },
+    "privileges": {
+      "type": "array",
+      "items": { "enum": ["select", "insert", "update", "delete"] }
+    }
+  }
+}