@everystack/model 0.3.4 → 0.3.5

package/README.md

@@ -74,6 +74,8 @@ export const models = [Account, Note];
 
 Modifiers: `.primaryKey()`, `.notNull()` / `.nullable()`, `.unique()`, `.default(value)` / `.defaultNow()` / `.defaultRandom()`, `.references(() => Other, { onDelete, onUpdate })`, `.private()` (never serialized), `.readonly()` (never accepted on write), `.validate(zodSchema)`, and `.renamedFrom('oldField')` (turns a drop+add into a data-preserving `RENAME COLUMN`).
 
+Renaming a whole table works the same way, at the model level: `defineModel('articles', { renamedFrom: 'posts', ... })` compiles to one `ALTER TABLE … RENAME TO …` (data preserved, policies ride along) instead of CREATE plus a held DROP. Both markers are one-shot — remove them once every environment is past the state; a satisfied rename is an inert notice.
+
 `.validate(...)` does double duty: the SQL-expressible refinements (`min`/`max`/`length`/range/enum) become a Postgres `CHECK` — the backstop for the SSR-direct write path that never runs app-layer Zod — while richer refinements stay app-layer only.
 
 ## Constraints

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@everystack/model",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Declare a table's schema, validation, and authorization once — compiled to migrations, RLS, and handler config",
   "license": "AGPL-3.0-only",
   "publishConfig": {

package/src/model.ts

@@ -63,6 +63,15 @@ export interface ModelDefinition {
    * can span schemas — the model's schema always wins over a generate call's default.
    */
   schema?: string;
+  /**
+   * `renamedFrom: 'old_table'` — a one-shot migration hint, the table-level
+   * analog of `field.renamedFrom()`. A diff cannot distinguish RENAME from
+   * DROP+ADD; the marker carries the intent, so the diff emits one
+   * `ALTER TABLE … RENAME TO …` (data preserved) instead of CREATE plus a
+   * held DROP. Same schema as the model. Remove it once every environment
+   * is past the state — a satisfied rename is an inert notice.
+   */
+  renamedFrom?: string;
   /**
    * `true` removes the table from the generic data API — `deriveHandlerConfig`
    * skips it, so it never enters `exposedTables`. Default `false`. Package-owned
@@ -90,6 +99,8 @@ export interface ModelDescriptor {
   schema: string;
   /** `true` removes the table from the generic data API (not in `exposedTables`). Default `false`. */
   private: boolean;
+  /** One-shot rename hint: this table used to be named `renamedFrom` (same schema). */
+  renamedFrom?: string;
 }
 
 export function defineModel(table: string, def: ModelDefinition): ModelDescriptor {
@@ -108,5 +119,6 @@ export function defineModel(table: string, def: ModelDefinition): ModelDescripto
     writtenBy: def.writtenBy ?? 'app',
     schema: def.schema ?? 'public',
     private: def.private ?? false,
+    ...(def.renamedFrom ? { renamedFrom: def.renamedFrom } : {}),
   };
 }