@drzl/analyzer 1.10.0 → 1.12.0

package/dist/index.cjs

@@ -33,6 +33,7 @@ __export(index_exports, {
   SchemaAnalyzer: () => SchemaAnalyzer,
   default: () => index_default,
   describeV1Column: () => describeV1Column,
+  isReadOnlyRelation: () => isReadOnlyRelation,
   isRelationsV2: () => isRelationsV2,
   readRelationsV2: () => readRelationsV2
 });
@@ -228,6 +229,12 @@ function getSymbolOf(target, key) {
   }
   return target[Symbol.for(key)];
 }
+function isReadOnlyRelation(val) {
+  if (!val || typeof val !== "object") return false;
+  return Object.getOwnPropertySymbols(val).some(
+    (sym) => String(sym.description).includes("MaterializedViewConfig")
+  );
+}
 function isRelationsV2(val) {
   if (!val || typeof val !== "object" || Array.isArray(val)) return false;
   const entries = Object.values(val);
@@ -651,6 +658,8 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
       }
       const ev = col?.enumValues;
       const nullable = !col?.notNull && !col?.config?.notNull;
+      const rawDefault = col?.default;
+      const defaultValue = rawDefault !== void 0 && !(rawDefault && typeof rawDefault === "object" && "queryChunks" in rawDefault) ? rawDefault : void 0;
       const generatedIdentity = col?.generatedIdentity;
       const isGenerated = !!(col?.generated || generatedIdentity?.type === "always" || col?.isGenerated);
       const hasDefault = col?.hasDefault === true || col?.default !== void 0 || col?.config?.default !== void 0 || col?.defaultFn !== void 0 || isGenerated;
@@ -678,6 +687,7 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         defaultExpression: void 0,
         references,
         enumValues: Array.isArray(ev) ? ev : void 0,
+        ...defaultValue !== void 0 ? { defaultValue } : {},
         ...constraints,
         ...v1 ?? {}
       });
@@ -754,6 +764,9 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
       indexes: [...pkCols.length ? [{ columns: pkCols }] : [], ...indexes],
       checks,
       foreignKeys,
+      // A materialized view refuses every write, so the generators skip its insert and update
+      // schemas rather than describe an operation the database will always reject.
+      ...isReadOnlyRelation(tbl) ? { readOnly: true } : {},
       meta: {}
     };
   }
@@ -954,6 +967,7 @@ var index_default = SchemaAnalyzer;
 0 && (module.exports = {
   SchemaAnalyzer,
   describeV1Column,
+  isReadOnlyRelation,
   isRelationsV2,
   readRelationsV2
 });

package/dist/index.d.cts

@@ -72,6 +72,15 @@ interface Column {
      * checking at all. See `COLUMN_FORMATS` in `@drzl/validation-core`.
      */
     format?: 'uuid' | 'numeric';
+    /**
+     * The column's default, when it is a literal a schema can reproduce.
+     *
+     * `.default('GB')` stores a plain JS value. `defaultNow()`, `defaultRandom()` and any
+     * `sql` default store an object the database evaluates, and `$defaultFn` stores a function
+     * Drizzle calls at insert time. A schema guessing at either of those would produce a different
+     * value than the one actually stored, so only the literal case is carried.
+     */
+    defaultValue?: unknown;
     /**
      * Array depth for a column declared with `.array()`, absent when the column is a scalar.
      *
@@ -173,6 +182,12 @@ interface Table {
     indexes: Index[];
     checks?: Check[];
     foreignKeys?: ForeignKey[];
+    /**
+     * Set when the relation refuses writes, which today means a materialized view. Insert and
+     * update schemas are not emitted for one, because the database will always refuse the
+     * operation they describe.
+     */
+    readOnly?: boolean;
     meta?: Record<string, unknown>;
 }
 interface Enum {
@@ -214,6 +229,18 @@ declare function describeV1Column(column: any): Partial<Column> | null;
  * `relations` record whose entries carry a `relationType`. That is specific enough not to
  * collide with a table or an enum, both of which are checked before this.
  */
+/**
+ * Whether a relation refuses writes outright.
+ *
+ * A materialized view does: `INSERT INTO mv ...` fails with `cannot change materialized view`,
+ * verified against Postgres. An insert or update schema for one describes an operation the
+ * database will always refuse.
+ *
+ * An ordinary view is deliberately not included. Postgres accepts an INSERT into a simple
+ * auto-updatable view, and whether a given view qualifies depends on its query rather than on
+ * anything the schema file states, so refusing them all would take away something that works.
+ */
+declare function isReadOnlyRelation(val: any): boolean;
 declare function isRelationsV2(val: any): boolean;
 /**
  * Read the relations declared by `defineRelations`.
@@ -329,4 +356,4 @@ declare class SchemaAnalyzer {
     analyze(opts?: AnalyzeOptions): Promise<Analysis>;
 }
 
-export { type Analysis, type AnalyzeOptions, type Check, type Column, type ColumnRef, type ColumnShape, type Dialect, type Enum, type ForeignKey, type Index, type Issue, type Key, type Relation, SchemaAnalyzer, type Table, SchemaAnalyzer as default, describeV1Column, isRelationsV2, readRelationsV2 };
+export { type Analysis, type AnalyzeOptions, type Check, type Column, type ColumnRef, type ColumnShape, type Dialect, type Enum, type ForeignKey, type Index, type Issue, type Key, type Relation, SchemaAnalyzer, type Table, SchemaAnalyzer as default, describeV1Column, isReadOnlyRelation, isRelationsV2, readRelationsV2 };

package/dist/index.d.ts

@@ -72,6 +72,15 @@ interface Column {
      * checking at all. See `COLUMN_FORMATS` in `@drzl/validation-core`.
      */
     format?: 'uuid' | 'numeric';
+    /**
+     * The column's default, when it is a literal a schema can reproduce.
+     *
+     * `.default('GB')` stores a plain JS value. `defaultNow()`, `defaultRandom()` and any
+     * `sql` default store an object the database evaluates, and `$defaultFn` stores a function
+     * Drizzle calls at insert time. A schema guessing at either of those would produce a different
+     * value than the one actually stored, so only the literal case is carried.
+     */
+    defaultValue?: unknown;
     /**
      * Array depth for a column declared with `.array()`, absent when the column is a scalar.
      *
@@ -173,6 +182,12 @@ interface Table {
     indexes: Index[];
     checks?: Check[];
     foreignKeys?: ForeignKey[];
+    /**
+     * Set when the relation refuses writes, which today means a materialized view. Insert and
+     * update schemas are not emitted for one, because the database will always refuse the
+     * operation they describe.
+     */
+    readOnly?: boolean;
     meta?: Record<string, unknown>;
 }
 interface Enum {
@@ -214,6 +229,18 @@ declare function describeV1Column(column: any): Partial<Column> | null;
  * `relations` record whose entries carry a `relationType`. That is specific enough not to
  * collide with a table or an enum, both of which are checked before this.
  */
+/**
+ * Whether a relation refuses writes outright.
+ *
+ * A materialized view does: `INSERT INTO mv ...` fails with `cannot change materialized view`,
+ * verified against Postgres. An insert or update schema for one describes an operation the
+ * database will always refuse.
+ *
+ * An ordinary view is deliberately not included. Postgres accepts an INSERT into a simple
+ * auto-updatable view, and whether a given view qualifies depends on its query rather than on
+ * anything the schema file states, so refusing them all would take away something that works.
+ */
+declare function isReadOnlyRelation(val: any): boolean;
 declare function isRelationsV2(val: any): boolean;
 /**
  * Read the relations declared by `defineRelations`.
@@ -329,4 +356,4 @@ declare class SchemaAnalyzer {
     analyze(opts?: AnalyzeOptions): Promise<Analysis>;
 }
 
-export { type Analysis, type AnalyzeOptions, type Check, type Column, type ColumnRef, type ColumnShape, type Dialect, type Enum, type ForeignKey, type Index, type Issue, type Key, type Relation, SchemaAnalyzer, type Table, SchemaAnalyzer as default, describeV1Column, isRelationsV2, readRelationsV2 };
+export { type Analysis, type AnalyzeOptions, type Check, type Column, type ColumnRef, type ColumnShape, type Dialect, type Enum, type ForeignKey, type Index, type Issue, type Key, type Relation, SchemaAnalyzer, type Table, SchemaAnalyzer as default, describeV1Column, isReadOnlyRelation, isRelationsV2, readRelationsV2 };

package/dist/index.js

@@ -189,6 +189,12 @@ function getSymbolOf(target, key) {
   }
   return target[Symbol.for(key)];
 }
+function isReadOnlyRelation(val) {
+  if (!val || typeof val !== "object") return false;
+  return Object.getOwnPropertySymbols(val).some(
+    (sym) => String(sym.description).includes("MaterializedViewConfig")
+  );
+}
 function isRelationsV2(val) {
   if (!val || typeof val !== "object" || Array.isArray(val)) return false;
   const entries = Object.values(val);
@@ -612,6 +618,8 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
       }
       const ev = col?.enumValues;
       const nullable = !col?.notNull && !col?.config?.notNull;
+      const rawDefault = col?.default;
+      const defaultValue = rawDefault !== void 0 && !(rawDefault && typeof rawDefault === "object" && "queryChunks" in rawDefault) ? rawDefault : void 0;
       const generatedIdentity = col?.generatedIdentity;
       const isGenerated = !!(col?.generated || generatedIdentity?.type === "always" || col?.isGenerated);
       const hasDefault = col?.hasDefault === true || col?.default !== void 0 || col?.config?.default !== void 0 || col?.defaultFn !== void 0 || isGenerated;
@@ -639,6 +647,7 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         defaultExpression: void 0,
         references,
         enumValues: Array.isArray(ev) ? ev : void 0,
+        ...defaultValue !== void 0 ? { defaultValue } : {},
         ...constraints,
         ...v1 ?? {}
       });
@@ -715,6 +724,9 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
       indexes: [...pkCols.length ? [{ columns: pkCols }] : [], ...indexes],
       checks,
       foreignKeys,
+      // A materialized view refuses every write, so the generators skip its insert and update
+      // schemas rather than describe an operation the database will always reject.
+      ...isReadOnlyRelation(tbl) ? { readOnly: true } : {},
       meta: {}
     };
   }
@@ -915,6 +927,7 @@ export {
   SchemaAnalyzer,
   index_default as default,
   describeV1Column,
+  isReadOnlyRelation,
   isRelationsV2,
   readRelationsV2
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drzl/analyzer",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "private": false,
   "license": "Apache-2.0",
   "type": "module",