uql-orm 0.25.0 → 0.26.0

package/dist/schema/types.d.ts

@@ -4,7 +4,6 @@
  * A unified graph representation of database schema with relationships as first-class citizens.
  * Enables reliable diffing, smart relation detection, and dialect-agnostic schema operations.
  */
-import type { IndexColumnSchema } from '../type/entity.js';
 import type { IndexSchema } from '../type/migration.js';
 /**
  * Type categories universal across SQL dialects.
@@ -56,7 +55,8 @@ export type RelationshipSource = 'explicit_fk' | 'entity_decorator' | 'naming_pa
 /**
  * Index algorithm/type supported by various databases.
  */
-export type IndexType = 'btree' | 'hash' | 'gin' | 'gist' | 'brin' | 'fulltext' | 'hnsw' | 'ivfflat' | 'vector' | 'vectorSearch';
+export declare const INDEX_TYPES: readonly ['btree', 'hash', 'gin', 'gist', 'brin', 'fulltext', 'hnsw', 'ivfflat', 'vector', 'vectorSearch'];
+export type IndexType = (typeof INDEX_TYPES)[number];
 /**
  * Source of where an index was defined.
  */
@@ -149,16 +149,9 @@ export interface RelationshipNode {
  * Index node in the schema graph.
  * Represents a database index on one or more columns.
  */
-export type IndexNode = Omit<IndexSchema, 'columns'> & {
+export type IndexNode = IndexSchema & {
     /** Reference to the table this index belongs to */
     readonly table: TableNode;
-    /** Columns included in the index (order matters). Empty for an index over expressions only. */
-    readonly columns: ColumnNode[];
-    /**
-     * The index as authored, with names resolved: expressions, prefix lengths and per-column order that
-     * a `ColumnNode` cannot represent. The generator renders these; `columns` is what diffing compares.
-     */
-    readonly entries?: readonly IndexColumnSchema[];
     /** Where this index was defined */
     readonly source?: IndexSource;
     /** Current sync status */
@@ -187,7 +180,6 @@ export interface ColumnDiff {
     readonly actual?: ColumnNode;
     /** Whether this change could cause data loss */
     readonly isBreaking?: boolean;
-    /** Human-readable description of the change */
     readonly description?: string;
 }
 /**
@@ -208,6 +200,7 @@ export interface IndexDiff {
     readonly type: 'create' | 'drop' | 'alter';
     readonly expected?: IndexNode;
     readonly actual?: IndexNode;
+    readonly description?: string;
 }
 /**
  * Difference between two relationship definitions.
@@ -263,7 +256,7 @@ export type DriftSeverity = 'critical' | 'warning' | 'info';
 /**
  * Type of schema drift.
  */
-export type DriftType = 'missing_table' | 'unexpected_table' | 'missing_column' | 'unexpected_column' | 'type_mismatch' | 'constraint_mismatch' | 'missing_index' | 'unexpected_index' | 'missing_relationship' | 'unexpected_relationship';
+export type DriftType = 'missing_table' | 'unexpected_table' | 'missing_column' | 'unexpected_column' | 'type_mismatch' | 'constraint_mismatch' | 'missing_index' | 'unexpected_index' | 'index_mismatch' | 'missing_relationship' | 'unexpected_relationship';
 /**
  * A single schema drift issue.
  */

package/dist/schema/types.js

@@ -8,3 +8,18 @@
  * Default action for foreign key ON DELETE and ON UPDATE clauses.
  */
 export const DEFAULT_FOREIGN_KEY_ACTION = 'NO ACTION';
+/**
+ * Index algorithm/type supported by various databases.
+ */
+export const INDEX_TYPES = [
+    'btree',
+    'hash',
+    'gin',
+    'gist',
+    'brin',
+    'fulltext',
+    'hnsw',
+    'ivfflat',
+    'vector',
+    'vectorSearch',
+];

package/dist/type/dialect.d.ts

@@ -200,7 +200,12 @@ export interface SqlQueryDialect extends QueryDialect {
  * An index capability that some engines have and others reject outright. Verified live: expression
  * indexes exist everywhere but MariaDB 12.3 (which needs a generated column); prefix lengths are
  * MySQL-family only and *required* there to index `TEXT`; `NULLS FIRST/LAST` and operator classes are
- * Postgres-only (CockroachDB 26.2 answers "unimplemented"); `INCLUDE` is Postgres-wire only.
+ * Postgres-only (CockroachDB 26.2 answers "unimplemented"); `INCLUDE` is Postgres-wire only; the
+ * MySQL family is alone in having no partial indexes.
+ *
+ * Introspectors reuse the vocabulary for what they can read *back*, which is what diffing may
+ * compare. The two sets are deliberately not the same object and must not be unified: Postgres can
+ * emit an expression index and read one back, but MySQL emits one it cannot describe afterwards.
  */
-export type IndexFeature = 'expression' | 'prefixLength' | 'nullsOrder' | 'opsClass' | 'include';
+export type IndexFeature = 'expression' | 'partial' | 'prefixLength' | 'nullsOrder' | 'opsClass' | 'include';
 export declare const INDEX_FEATURE_LABELS: Record<IndexFeature, string>;

package/dist/type/dialect.js

@@ -1,5 +1,6 @@
 export const INDEX_FEATURE_LABELS = {
     expression: 'expression indexes',
+    partial: 'partial indexes',
     prefixLength: 'index prefix lengths',
     nullsOrder: 'NULLS FIRST/LAST in an index',
     opsClass: 'index operator classes',

package/dist/type/entity.d.ts

@@ -237,6 +237,13 @@ export type FieldOptions<V = TsTypeOf<FieldType>> = {
      * Entity that this field references (for foreign keys).
      */
     readonly references?: EntityGetter;
+    /**
+     * Referential action for the generated foreign key. Delete side only: `onUpdate` below already means
+     * a value callback. Reach for `@ManyToOne({ onDelete, onUpdate })` when the update side matters too, or
+     * when this disagrees with a relation also declared on the same column (the relation wins).
+     * @example `@Field({ references: () => Company, onDelete: 'CASCADE' }) companyId?: string;`
+     */
+    readonly onDelete?: ForeignKeyAction;
     readonly virtual?: QueryRaw;
     readonly updatable?: boolean;
     readonly eager?: boolean;
@@ -363,16 +370,11 @@ export type RelationOptions<E = any> = {
     cardinality: RelationCardinality;
     readonly cascade?: boolean | CascadeType;
     /**
-     * Referential actions for the generated foreign key, letting the database do the work instead of the
-     * ORM: `onDelete: 'CASCADE'` makes deleting the parent a single statement rather than the graph walk
-     * `cascade` performs. Defaults to the migrator's `defaultForeignKeyAction`.
-     *
-     * Read only from the side that owns the key (`@ManyToOne`, or a `@OneToOne` without `mappedBy`),
-     * matching where TypeORM, Prisma and Drizzle put it. Not available on a bare `@Field({ references })`
-     * with no relation, because `FieldOptions.onUpdate` already means a value callback there.
-     *
-     * This overlaps `cascade` rather than conflicting with it: declaring both deletes the children in JS
-     * and then leaves the foreign key nothing to cascade, so pick one.
+     * Referential actions for the generated foreign key, letting the database cascade instead of the ORM's
+     * `cascade` (pick one; declaring both leaves the FK nothing to do). Read from the owning side
+     * (`@ManyToOne`, or a `@OneToOne` without `mappedBy`). `onDelete` falls back to the FK field's own
+     * `@Field({ onDelete })` when unset here; `onUpdate` has no such fallback since that key already means
+     * a value callback on `FieldOptions`.
      */
     readonly onDelete?: ForeignKeyAction;
     readonly onUpdate?: ForeignKeyAction;

package/dist/type/migration.d.ts

@@ -1,5 +1,6 @@
 import type { VectorCast } from '../dialect/vectorCast.js';
 import type { FullColumnDefinition, TableDefinition, TableForeignKeyDefinition } from '../migrate/builder/types.js';
+import type { IndexFacet } from '../schema/indexDifferences.js';
 import type { SchemaAST } from '../schema/schemaAST.js';
 import type { ForeignKeyAction, IndexNode, IndexType, TableNode } from '../schema/types.js';
 import type { EntityMeta, FieldOptions, IndexColumnSchema, LoggingOptions, SqlQuerier, Type, VectorIndexOptions } from './index.js';
@@ -131,7 +132,13 @@ export interface TableSchema {
  */
 export interface IndexSchema extends VectorIndexOptions {
     readonly name: string;
-    readonly columns: readonly IndexColumnSchema[];
+    /**
+     * What the index is over, in order. Named `entries` and not `columns` because an entry need not be
+     * a column at all: `raw('lower(email)')` is one, and so is a column carrying a prefix length or a
+     * stored order. The authored form, `@Index([...])`, still spells this `columns`, since that is what
+     * it reads like at the call site.
+     */
+    readonly entries: readonly IndexColumnSchema[];
     readonly unique: boolean;
     /** Index type (btree, hnsw, ivfflat, etc.) */
     readonly type?: IndexType;
@@ -281,6 +288,12 @@ export interface SqlDdlGenerator extends SchemaGenerator {
  * Interface for introspecting the current database schema
  */
 export interface SchemaIntrospector {
+    /**
+     * What this introspector can read back about an index, and so all that diffing may compare.
+     * Comparing a feature it cannot read reports the same drift forever: the entity side declares it,
+     * the database side never reports it, and no migration can close the gap.
+     */
+    readonly indexFacets: ReadonlySet<IndexFacet>;
     /**
      * Introspect entire database schema and return SchemaAST.
      */

package/dist/util/string.util.js

@@ -43,7 +43,12 @@ export function pascalCase(str) {
         return '';
     return str
         .split(/[_\s-]+/)
-        .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+        .map((word) => {
+        // Lower-casing the rest is only right for a word that carries no case of its own: it turns
+        // `USER_ID` into `UserId`, but it also turns `tenantId` into `Tenantid`.
+        const rest = word === word.toUpperCase() ? word.slice(1).toLowerCase() : word.slice(1);
+        return word.charAt(0).toUpperCase() + rest;
+    })
         .join('');
 }
 /**

package/package.json

@@ -3,7 +3,7 @@
   "homepage": "https://uql-orm.dev",
   "description": "Extremely fast, type-safe TypeScript ORM - one API for every database",
   "license": "MIT",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "type": "module",
   "engines": {
     "node": ">=24"
@@ -58,7 +58,7 @@
   ],
   "scripts": {
     "prepack": "bun run verify-dist.ts && cp ../../README.md .",
-    "postpack": "rm README.md",
+    "postpack": "rm README.md && npm pkg delete gitHead",
     "compile.browser": "bun build src/browser/index.ts --minify --sourcemap=linked --format=esm --target=browser --outdir=dist/browser --entry-naming 'uql-browser.min.[ext]'",
     "build": "bun run clean && tsc -b tsconfig.build.json && bun run compile.browser && bun run verify-dist.ts",
     "start": "tsc --watch",
@@ -197,6 +197,5 @@
   ],
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "cfe2b005308b808d2e6e3d6e062c13791c883d13"
+  }
 }

package/LICENSE.md

@@ -1,22 +0,0 @@
-Copyright (c) 2015-present UQL Contributors
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.