@drzl/analyzer 1.11.0 → 1.13.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
 });
@@ -214,6 +215,15 @@ function describeV1Column(column) {
   if (typeof dims === "number" && dims >= 1) out.arrayDimensions = dims;
   return out;
 }
+function unwrapArrayColumn(column) {
+  let element = column;
+  let dimensions = 0;
+  while (element?.baseColumn && String(element?.constructor?.name ?? "").endsWith("Array")) {
+    element = element.baseColumn;
+    dimensions++;
+  }
+  return { element, dimensions };
+}
 function declaredLength(column) {
   const n = column?.length ?? column?.config?.length ?? column?.config?.dimensions;
   return typeof n === "number" && Number.isFinite(n) && n > 0 ? n : void 0;
@@ -228,6 +238,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);
@@ -508,10 +524,23 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         return { tsType: "number", dbType: "REAL" };
       case "SQLiteBlob":
         return { tsType: "Uint8Array", dbType: "BLOB" };
+      // SQLite spells a mode as a distinct class rather than as config, so `text({mode:'json'})`
+      // is a `SQLiteTextJson` and matched no arm at all: the column came back UNKNOWN, which is
+      // wider than the `any` a json column at least used to get.
+      case "SQLiteTextJson":
+      case "SQLiteBlobJson":
+        return { tsType: "any", dbType: "JSON" };
+      case "SQLiteBigInt":
+        return { tsType: "bigint", dbType: "BIGINT" };
       case "SQLiteNumeric":
         return { tsType: "string", dbType: "NUMERIC" };
       case "SQLiteBoolean":
         return { tsType: "boolean", dbType: "INTEGER" };
+      // 0.4x gives an enum its own class, which had no arm here at all, so an enum column came
+      // back `unknown` and every generator emitted a schema that accepted anything. The values
+      // were on the column the whole time, in `enumValues`, waiting for a type to attach to.
+      case "PgEnumColumn":
+        return { tsType: "string", dbType: "TEXT" };
       case "PgInteger":
       case "PgSmallInt":
         return { tsType: "number", dbType: "INTEGER" };
@@ -643,25 +672,26 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
     const foreignKeys = [];
     const pkCols = [];
     const uniqueGroups = /* @__PURE__ */ new Map();
-    for (const [colName, col] of Object.entries(columnsObj)) {
+    for (const [colName, outerCol] of Object.entries(columnsObj)) {
+      const { element: col, dimensions: arrayDims } = unwrapArrayColumn(outerCol);
       let { tsType, dbType } = this.mapColumnType(col);
       if (tsType === "unknown" && /At$/.test(colName)) {
         tsType = "Date";
         dbType = "INTEGER";
       }
       const ev = col?.enumValues;
-      const nullable = !col?.notNull && !col?.config?.notNull;
-      const rawDefault = col?.default;
+      const nullable = !outerCol?.notNull && !outerCol?.config?.notNull;
+      const rawDefault = outerCol?.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;
+      const generatedIdentity = outerCol?.generatedIdentity;
+      const isGenerated = !!(outerCol?.generated || generatedIdentity?.type === "always" || outerCol?.isGenerated);
+      const hasDefault = outerCol?.hasDefault === true || outerCol?.default !== void 0 || outerCol?.config?.default !== void 0 || outerCol?.defaultFn !== void 0 || isGenerated;
       const references = void 0;
-      const isUnique = !!(col?.isUnique || col?.config?.isUnique);
-      const isPk = !!(col?.primary || col?.config?.primaryKey);
+      const isUnique = !!(outerCol?.isUnique || outerCol?.config?.isUnique);
+      const isPk = !!(outerCol?.primary || outerCol?.config?.primaryKey);
       if (isPk) pkCols.push(colName);
       if (isUnique) unique.push({ columns: [colName] });
-      const uName = col?.uniqueName || col?.config?.uniqueName;
+      const uName = outerCol?.uniqueName || outerCol?.config?.uniqueName;
       if (uName) {
         const arr = uniqueGroups.get(uName) ?? [];
         arr.push(colName);
@@ -670,6 +700,19 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
       const v1 = describeV1Column(col);
       const constraints = this.columnConstraints(col);
       if (v1?.shape) delete constraints.maxLength;
+      const jsonShape = dbType === "JSON" || dbType === "JSONB" || col?.config?.mode === "json" ? { kind: "json" } : void 0;
+      const shape = (v1?.shape ?? jsonShape)?.kind;
+      const finalTs = v1?.tsType ?? tsType;
+      const wide = (finalTs === "unknown" || finalTs === "any") && (!shape || shape === "custom");
+      if (wide) {
+        const sqlType = typeof col?.getSQLType === "function" ? col.getSQLType() : void 0;
+        issues.push({
+          code: "DRZL_ANL_UNKNOWN_COLUMN",
+          level: "warn",
+          message: `Column "${colName}" on table "${tsName}" has no known type${sqlType ? ` (SQL type ${sqlType})` : ""}, so its validator will accept any value.`,
+          hint: shape === "custom" ? "A customType has no runtime shape to read. Declare it with .$type<T>() and turn on typedColumns to give the validator the type." : "Open an issue naming the column type so it can be modelled, or declare it with .$type<T>() and turn on typedColumns."
+        });
+      }
       columns.push({
         name: colName,
         tsType,
@@ -682,7 +725,12 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         enumValues: Array.isArray(ev) ? ev : void 0,
         ...defaultValue !== void 0 ? { defaultValue } : {},
         ...constraints,
-        ...v1 ?? {}
+        ...v1 ?? {},
+        // After the v1 spread, which sets its own `arrayDimensions` from `dimensions`. On 0.4x
+        // that spread has nothing to say and this is the only source.
+        ...arrayDims ? { arrayDimensions: arrayDims } : {},
+        // Only where v1 did not already describe the value, so a shaped column keeps its shape.
+        ...jsonShape && !v1?.shape ? { shape: jsonShape } : {}
       });
     }
     const name = this.getSymbol(tbl, "drizzle:Name") || tsName;
@@ -757,6 +805,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: {}
     };
   }
@@ -957,6 +1008,7 @@ var index_default = SchemaAnalyzer;
 0 && (module.exports = {
   SchemaAnalyzer,
   describeV1Column,
+  isReadOnlyRelation,
   isRelationsV2,
   readRelationsV2
 });

package/dist/index.d.cts

@@ -182,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 {
@@ -223,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`.
@@ -338,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

@@ -182,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 {
@@ -223,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`.
@@ -338,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

@@ -175,6 +175,15 @@ function describeV1Column(column) {
   if (typeof dims === "number" && dims >= 1) out.arrayDimensions = dims;
   return out;
 }
+function unwrapArrayColumn(column) {
+  let element = column;
+  let dimensions = 0;
+  while (element?.baseColumn && String(element?.constructor?.name ?? "").endsWith("Array")) {
+    element = element.baseColumn;
+    dimensions++;
+  }
+  return { element, dimensions };
+}
 function declaredLength(column) {
   const n = column?.length ?? column?.config?.length ?? column?.config?.dimensions;
   return typeof n === "number" && Number.isFinite(n) && n > 0 ? n : void 0;
@@ -189,6 +198,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);
@@ -469,10 +484,23 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         return { tsType: "number", dbType: "REAL" };
       case "SQLiteBlob":
         return { tsType: "Uint8Array", dbType: "BLOB" };
+      // SQLite spells a mode as a distinct class rather than as config, so `text({mode:'json'})`
+      // is a `SQLiteTextJson` and matched no arm at all: the column came back UNKNOWN, which is
+      // wider than the `any` a json column at least used to get.
+      case "SQLiteTextJson":
+      case "SQLiteBlobJson":
+        return { tsType: "any", dbType: "JSON" };
+      case "SQLiteBigInt":
+        return { tsType: "bigint", dbType: "BIGINT" };
       case "SQLiteNumeric":
         return { tsType: "string", dbType: "NUMERIC" };
       case "SQLiteBoolean":
         return { tsType: "boolean", dbType: "INTEGER" };
+      // 0.4x gives an enum its own class, which had no arm here at all, so an enum column came
+      // back `unknown` and every generator emitted a schema that accepted anything. The values
+      // were on the column the whole time, in `enumValues`, waiting for a type to attach to.
+      case "PgEnumColumn":
+        return { tsType: "string", dbType: "TEXT" };
       case "PgInteger":
       case "PgSmallInt":
         return { tsType: "number", dbType: "INTEGER" };
@@ -604,25 +632,26 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
     const foreignKeys = [];
     const pkCols = [];
     const uniqueGroups = /* @__PURE__ */ new Map();
-    for (const [colName, col] of Object.entries(columnsObj)) {
+    for (const [colName, outerCol] of Object.entries(columnsObj)) {
+      const { element: col, dimensions: arrayDims } = unwrapArrayColumn(outerCol);
       let { tsType, dbType } = this.mapColumnType(col);
       if (tsType === "unknown" && /At$/.test(colName)) {
         tsType = "Date";
         dbType = "INTEGER";
       }
       const ev = col?.enumValues;
-      const nullable = !col?.notNull && !col?.config?.notNull;
-      const rawDefault = col?.default;
+      const nullable = !outerCol?.notNull && !outerCol?.config?.notNull;
+      const rawDefault = outerCol?.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;
+      const generatedIdentity = outerCol?.generatedIdentity;
+      const isGenerated = !!(outerCol?.generated || generatedIdentity?.type === "always" || outerCol?.isGenerated);
+      const hasDefault = outerCol?.hasDefault === true || outerCol?.default !== void 0 || outerCol?.config?.default !== void 0 || outerCol?.defaultFn !== void 0 || isGenerated;
       const references = void 0;
-      const isUnique = !!(col?.isUnique || col?.config?.isUnique);
-      const isPk = !!(col?.primary || col?.config?.primaryKey);
+      const isUnique = !!(outerCol?.isUnique || outerCol?.config?.isUnique);
+      const isPk = !!(outerCol?.primary || outerCol?.config?.primaryKey);
       if (isPk) pkCols.push(colName);
       if (isUnique) unique.push({ columns: [colName] });
-      const uName = col?.uniqueName || col?.config?.uniqueName;
+      const uName = outerCol?.uniqueName || outerCol?.config?.uniqueName;
       if (uName) {
         const arr = uniqueGroups.get(uName) ?? [];
         arr.push(colName);
@@ -631,6 +660,19 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
       const v1 = describeV1Column(col);
       const constraints = this.columnConstraints(col);
       if (v1?.shape) delete constraints.maxLength;
+      const jsonShape = dbType === "JSON" || dbType === "JSONB" || col?.config?.mode === "json" ? { kind: "json" } : void 0;
+      const shape = (v1?.shape ?? jsonShape)?.kind;
+      const finalTs = v1?.tsType ?? tsType;
+      const wide = (finalTs === "unknown" || finalTs === "any") && (!shape || shape === "custom");
+      if (wide) {
+        const sqlType = typeof col?.getSQLType === "function" ? col.getSQLType() : void 0;
+        issues.push({
+          code: "DRZL_ANL_UNKNOWN_COLUMN",
+          level: "warn",
+          message: `Column "${colName}" on table "${tsName}" has no known type${sqlType ? ` (SQL type ${sqlType})` : ""}, so its validator will accept any value.`,
+          hint: shape === "custom" ? "A customType has no runtime shape to read. Declare it with .$type<T>() and turn on typedColumns to give the validator the type." : "Open an issue naming the column type so it can be modelled, or declare it with .$type<T>() and turn on typedColumns."
+        });
+      }
       columns.push({
         name: colName,
         tsType,
@@ -643,7 +685,12 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         enumValues: Array.isArray(ev) ? ev : void 0,
         ...defaultValue !== void 0 ? { defaultValue } : {},
         ...constraints,
-        ...v1 ?? {}
+        ...v1 ?? {},
+        // After the v1 spread, which sets its own `arrayDimensions` from `dimensions`. On 0.4x
+        // that spread has nothing to say and this is the only source.
+        ...arrayDims ? { arrayDimensions: arrayDims } : {},
+        // Only where v1 did not already describe the value, so a shaped column keeps its shape.
+        ...jsonShape && !v1?.shape ? { shape: jsonShape } : {}
       });
     }
     const name = this.getSymbol(tbl, "drizzle:Name") || tsName;
@@ -718,6 +765,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: {}
     };
   }
@@ -918,6 +968,7 @@ export {
   SchemaAnalyzer,
   index_default as default,
   describeV1Column,
+  isReadOnlyRelation,
   isRelationsV2,
   readRelationsV2
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drzl/analyzer",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "private": false,
   "license": "Apache-2.0",
   "type": "module",
@@ -45,6 +45,6 @@
   "scripts": {
     "build": "tsup src/index.ts --dts --format esm,cjs",
     "lint": "eslint . --ext .ts",
-    "test": "vitest run"
+    "test": "vitest run --testTimeout=20000"
   }
 }