@drzl/analyzer 1.9.0 → 1.11.0

package/dist/index.cjs

@@ -32,7 +32,9 @@ var index_exports = {};
 __export(index_exports, {
   SchemaAnalyzer: () => SchemaAnalyzer,
   default: () => index_default,
-  describeV1Column: () => describeV1Column
+  describeV1Column: () => describeV1Column,
+  isRelationsV2: () => isRelationsV2,
+  readRelationsV2: () => readRelationsV2
 });
 module.exports = __toCommonJS(index_exports);
 var import_meta = {};
@@ -216,6 +218,47 @@ 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;
 }
+function getSymbolOf(target, key) {
+  if (!target) return void 0;
+  try {
+    for (const sym of Object.getOwnPropertySymbols(target)) {
+      if (sym.description === key) return target[sym];
+    }
+  } catch {
+  }
+  return target[Symbol.for(key)];
+}
+function isRelationsV2(val) {
+  if (!val || typeof val !== "object" || Array.isArray(val)) return false;
+  const entries = Object.values(val);
+  if (!entries.length) return false;
+  return entries.every(
+    (e) => !!e && typeof e === "object" && !!e.table && !!e.relations && typeof e.relations === "object" && Object.values(e.relations).every(
+      (r) => r?.relationType === "one" || r?.relationType === "many"
+    )
+  );
+}
+function readRelationsV2(val, issues = []) {
+  const out = [];
+  for (const [tableKey, entry] of Object.entries(val)) {
+    const from = getSymbolOf(entry.table, "drizzle:Name") ?? entry.name ?? tableKey;
+    for (const [fieldName, r] of Object.entries(entry.relations ?? {})) {
+      const to = r?.targetTableName;
+      if (typeof to !== "string" || !to) {
+        issues.push({
+          code: "DRZL_ANL_REL_V2",
+          level: "warn",
+          message: `Relation "${fieldName}" on "${from}" names no target table and was skipped.`
+        });
+        continue;
+      }
+      const via = getSymbolOf(r.throughTable, "drizzle:Name") ?? getSymbolOf(r.through?.sourceTable, "drizzle:Name") ?? void 0;
+      if (via) out.push({ kind: "manyToMany", from, to, via });
+      else out.push({ kind: r.relationType === "many" ? "many" : "one", from, to });
+    }
+  }
+  return out;
+}
 var _SchemaAnalyzer = class _SchemaAnalyzer {
   constructor(schemaPath) {
     this.schemaPath = schemaPath;
@@ -608,6 +651,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;
@@ -635,6 +680,7 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         defaultExpression: void 0,
         references,
         enumValues: Array.isArray(ev) ? ev : void 0,
+        ...defaultValue !== void 0 ? { defaultValue } : {},
         ...constraints,
         ...v1 ?? {}
       });
@@ -769,6 +815,10 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
           if (opts.includeRelations) {
             relations.push(...this.readRelationsObject(val, name, issues));
           }
+        } else if (isRelationsV2(val)) {
+          if (opts.includeRelations) {
+            relations.push(...readRelationsV2(val, issues));
+          }
         } else {
           const ev = val?.enumValues;
           if (Array.isArray(ev) && ev.every((x) => typeof x === "string")) {
@@ -906,5 +956,7 @@ var index_default = SchemaAnalyzer;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   SchemaAnalyzer,
-  describeV1Column
+  describeV1Column,
+  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.
      *
@@ -206,6 +215,25 @@ interface AnalyzeOptions {
  * path below untouched.
  */
 declare function describeV1Column(column: any): Partial<Column> | null;
+/**
+ * Whether an export is a Relations v2 definition, from `defineRelations(schema, (r) => ...)`.
+ *
+ * v2 returns a plain object keyed by table name, each entry `{ table, name, relations }`, with
+ * no marker class or symbol to match on. So the shape is what identifies it: every value has a
+ * `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.
+ */
+declare function isRelationsV2(val: any): boolean;
+/**
+ * Read the relations declared by `defineRelations`.
+ *
+ * Simpler than the v1 reader, which has to invoke a callback with a stand-in builder to find
+ * out what was declared. v2 has already resolved everything: each descriptor states its
+ * `relationType`, its `targetTableName`, and for a many-to-many its `through` table, so nothing
+ * has to be inferred and the join table is stated rather than guessed at by the heuristic that
+ * covers v1.
+ */
+declare function readRelationsV2(val: any, issues?: Issue[]): Relation[];
 declare class SchemaAnalyzer {
     private readonly schemaPath;
     constructor(schemaPath: string);
@@ -310,4 +338,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 };
+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 };

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.
      *
@@ -206,6 +215,25 @@ interface AnalyzeOptions {
  * path below untouched.
  */
 declare function describeV1Column(column: any): Partial<Column> | null;
+/**
+ * Whether an export is a Relations v2 definition, from `defineRelations(schema, (r) => ...)`.
+ *
+ * v2 returns a plain object keyed by table name, each entry `{ table, name, relations }`, with
+ * no marker class or symbol to match on. So the shape is what identifies it: every value has a
+ * `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.
+ */
+declare function isRelationsV2(val: any): boolean;
+/**
+ * Read the relations declared by `defineRelations`.
+ *
+ * Simpler than the v1 reader, which has to invoke a callback with a stand-in builder to find
+ * out what was declared. v2 has already resolved everything: each descriptor states its
+ * `relationType`, its `targetTableName`, and for a many-to-many its `through` table, so nothing
+ * has to be inferred and the join table is stated rather than guessed at by the heuristic that
+ * covers v1.
+ */
+declare function readRelationsV2(val: any, issues?: Issue[]): Relation[];
 declare class SchemaAnalyzer {
     private readonly schemaPath;
     constructor(schemaPath: string);
@@ -310,4 +338,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 };
+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 };

package/dist/index.js

@@ -179,6 +179,47 @@ 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;
 }
+function getSymbolOf(target, key) {
+  if (!target) return void 0;
+  try {
+    for (const sym of Object.getOwnPropertySymbols(target)) {
+      if (sym.description === key) return target[sym];
+    }
+  } catch {
+  }
+  return target[Symbol.for(key)];
+}
+function isRelationsV2(val) {
+  if (!val || typeof val !== "object" || Array.isArray(val)) return false;
+  const entries = Object.values(val);
+  if (!entries.length) return false;
+  return entries.every(
+    (e) => !!e && typeof e === "object" && !!e.table && !!e.relations && typeof e.relations === "object" && Object.values(e.relations).every(
+      (r) => r?.relationType === "one" || r?.relationType === "many"
+    )
+  );
+}
+function readRelationsV2(val, issues = []) {
+  const out = [];
+  for (const [tableKey, entry] of Object.entries(val)) {
+    const from = getSymbolOf(entry.table, "drizzle:Name") ?? entry.name ?? tableKey;
+    for (const [fieldName, r] of Object.entries(entry.relations ?? {})) {
+      const to = r?.targetTableName;
+      if (typeof to !== "string" || !to) {
+        issues.push({
+          code: "DRZL_ANL_REL_V2",
+          level: "warn",
+          message: `Relation "${fieldName}" on "${from}" names no target table and was skipped.`
+        });
+        continue;
+      }
+      const via = getSymbolOf(r.throughTable, "drizzle:Name") ?? getSymbolOf(r.through?.sourceTable, "drizzle:Name") ?? void 0;
+      if (via) out.push({ kind: "manyToMany", from, to, via });
+      else out.push({ kind: r.relationType === "many" ? "many" : "one", from, to });
+    }
+  }
+  return out;
+}
 var _SchemaAnalyzer = class _SchemaAnalyzer {
   constructor(schemaPath) {
     this.schemaPath = schemaPath;
@@ -571,6 +612,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;
@@ -598,6 +641,7 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
         defaultExpression: void 0,
         references,
         enumValues: Array.isArray(ev) ? ev : void 0,
+        ...defaultValue !== void 0 ? { defaultValue } : {},
         ...constraints,
         ...v1 ?? {}
       });
@@ -732,6 +776,10 @@ var _SchemaAnalyzer = class _SchemaAnalyzer {
           if (opts.includeRelations) {
             relations.push(...this.readRelationsObject(val, name, issues));
           }
+        } else if (isRelationsV2(val)) {
+          if (opts.includeRelations) {
+            relations.push(...readRelationsV2(val, issues));
+          }
         } else {
           const ev = val?.enumValues;
           if (Array.isArray(ev) && ev.every((x) => typeof x === "string")) {
@@ -869,5 +917,7 @@ var index_default = SchemaAnalyzer;
 export {
   SchemaAnalyzer,
   index_default as default,
-  describeV1Column
+  describeV1Column,
+  isRelationsV2,
+  readRelationsV2
 };

package/package.json

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