@avytrix/nestjs-drizzle-crud 3.6.0 → 3.7.1

package/dist/core/abstract/sql-base-crud.service.js

@@ -66,6 +66,10 @@ class SqlBaseCrudService {
             return result.rowsAffected > 0;
         if (typeof result.affectedRows === "number")
             return result.affectedRows > 0;
+        if (typeof result.changes === "number")
+            return result.changes > 0;
+        if (typeof result.meta?.changes === "number")
+            return result.meta.changes > 0;
         return false;
     }
     buildWhereConditionsFromPartial(where) {
@@ -390,15 +394,19 @@ class SqlBaseCrudService {
         return roots;
     }
     parseSelect(select) {
-        const root = { base: [], relations: {} };
+        const tree = () => ({
+            base: [],
+            relations: Object.create(null),
+        });
+        const root = tree();
         for (const entry of select || []) {
             const segments = (entry || "").split(".").filter(Boolean);
             if (segments.length === 0)
                 continue;
             let node = root;
             for (const name of segments.slice(0, -1)) {
-                if (!node.relations[name])
-                    node.relations[name] = { base: [], relations: {} };
+                if (!Object.hasOwn(node.relations, name))
+                    node.relations[name] = tree();
                 node = node.relations[name];
             }
             node.base.push(segments[segments.length - 1]);
@@ -406,7 +414,9 @@ class SqlBaseCrudService {
         return root;
     }
     selectFor(select, name) {
-        return select.relations[name] ?? { base: [], relations: {} };
+        return Object.hasOwn(select.relations, name)
+            ? select.relations[name]
+            : { base: [], relations: {} };
     }
     keysForChildren(nodes, hostTable = this.config.table) {
         return nodes
@@ -806,13 +816,32 @@ class SqlBaseCrudService {
     isUniqueViolation(error) {
         const code = error?.code ?? error?.cause?.code;
         const errno = error?.errno ?? error?.cause?.errno;
-        return code === "23505" || code === "ER_DUP_ENTRY" || errno === 1062;
+        const sqlite = this.sqliteConstraint(error);
+        return (code === "23505" ||
+            code === "ER_DUP_ENTRY" ||
+            errno === 1062 ||
+            sqlite === "UNIQUE" ||
+            sqlite === "PRIMARYKEY");
+    }
+    sqliteConstraint(error) {
+        if (this.config.dialect !== "sqlite")
+            return undefined;
+        for (const e of [error, error?.cause]) {
+            const code = e?.extendedCode ?? e?.code;
+            if (typeof code === "string" && code.startsWith("SQLITE_CONSTRAINT_")) {
+                return code.slice("SQLITE_CONSTRAINT_".length);
+            }
+        }
+        const message = `${error?.cause?.message ?? ""} ${error?.message ?? ""}`;
+        const m = message.match(/(UNIQUE|PRIMARY KEY|FOREIGN KEY|NOT NULL|CHECK) constraint failed/);
+        return m?.[1]?.replace(" ", "");
     }
     toDuplicateException(error) {
         const detail = error?.detail ?? error?.cause?.detail ?? "";
         const message = error?.cause?.message ?? error?.message ?? "";
         const m = detail.match(/Key \((?<field>.+?)\)=\((?<value>.+?)\)/) ??
-            message.match(/Duplicate entry '(?<value>.*)' for key '(?:[^']*\.)?(?<field>[^']+)'/);
+            message.match(/Duplicate entry '(?<value>.*)' for key '(?:[^']*\.)?(?<field>[^']+)'/) ??
+            message.match(/UNIQUE constraint failed: (?:[^.,\s]+\.)?(?<field>[^,\s]+)/);
         return new crud_exceptions_1.DuplicateEntityException(this.getEntityName(), m?.groups?.field ?? "unique field", m?.groups?.value ?? "");
     }
     static DATA_ERRORS = {
@@ -825,18 +854,53 @@ class SqlBaseCrudService {
         "22008": "a date or time value is out of range",
         "21000": "the same key appears more than once in one upsert",
     };
-    isDataException(error) {
+    static MYSQL_DATA_ERRORS = {
+        1048: "a required value is missing",
+        1364: "a required value is missing",
+        1406: "a value is too long for its column",
+        3819: "a value violates a column check constraint",
+        1264: "a numeric value is out of range",
+        1265: "a value does not match its column type",
+        1366: "a value does not match its column type",
+        1292: "a date or time value has an invalid format",
+    };
+    static SQLITE_DATA_ERRORS = {
+        NOTNULL: "a required value is missing",
+        CHECK: "a value violates a column check constraint",
+    };
+    dataErrorMessage(error) {
         const code = error?.code ?? error?.cause?.code;
-        return Object.hasOwn(SqlBaseCrudService.DATA_ERRORS, code ?? "");
+        if (Object.hasOwn(SqlBaseCrudService.DATA_ERRORS, code ?? "")) {
+            return SqlBaseCrudService.DATA_ERRORS[code];
+        }
+        if (this.config.dialect === "mysql") {
+            const errno = error?.errno ?? error?.cause?.errno;
+            return Object.hasOwn(SqlBaseCrudService.MYSQL_DATA_ERRORS, errno ?? "")
+                ? SqlBaseCrudService.MYSQL_DATA_ERRORS[errno]
+                : undefined;
+        }
+        const sqlite = this.sqliteConstraint(error) ?? "";
+        return Object.hasOwn(SqlBaseCrudService.SQLITE_DATA_ERRORS, sqlite)
+            ? SqlBaseCrudService.SQLITE_DATA_ERRORS[sqlite]
+            : undefined;
+    }
+    isDataException(error) {
+        return this.dataErrorMessage(error) !== undefined;
     }
     toDataException(error) {
-        const code = error?.code ?? error?.cause?.code;
-        const message = SqlBaseCrudService.DATA_ERRORS[code] ?? "invalid value";
+        const message = this.dataErrorMessage(error) ?? "invalid value";
         const cause = error?.cause ?? error;
+        const text = String(cause?.message ?? "");
         const column = error?.column ??
             cause?.column ??
             error?.column_name ??
-            cause?.column_name;
+            cause?.column_name ??
+            (this.config.dialect === "mysql"
+                ? text.match(/column '([^']+)'/i)?.[1]
+                : undefined) ??
+            (this.config.dialect === "sqlite"
+                ? text.match(/NOT NULL constraint failed: (?:[^.\s]+\.)?(\S+)/)?.[1]
+                : undefined);
         return new crud_exceptions_1.ValidationFailedException(column ? `${message}: ${column}` : message);
     }
     toClientError(error, operation = "write") {
@@ -862,7 +926,10 @@ class SqlBaseCrudService {
     isForeignKeyViolation(error) {
         const code = error?.code ?? error?.cause?.code;
         const errno = error?.errno ?? error?.cause?.errno;
-        return code === "23503" || errno === 1451 || errno === 1452;
+        return (code === "23503" ||
+            errno === 1451 ||
+            errno === 1452 ||
+            this.sqliteConstraint(error) === "FOREIGNKEY");
     }
     toForeignKeyException(error) {
         const detail = error?.detail ?? error?.cause?.detail ?? "";
@@ -870,14 +937,37 @@ class SqlBaseCrudService {
         return new crud_exceptions_1.ForeignKeyViolationException(this.getEntityName(), m?.groups?.field ?? "reference");
     }
     applyLock(query, options) {
-        if (this.config.dialect !== "postgresql")
+        const strength = options?.forNoKeyUpdate
+            ? "no key update"
+            : options?.lock && options.lock !== "none"
+                ? options.lock
+                : undefined;
+        if (!strength)
             return query;
-        const of = { of: this.config.table };
-        if (options?.forNoKeyUpdate)
-            return query.for("no key update", of);
-        if (options?.lock && options.lock !== "none")
-            return query.for(options.lock, of);
-        return query;
+        if (this.config.dialect === "postgresql") {
+            return query.for(strength, { of: this.config.table });
+        }
+        if (this.config.dialect === "mysql") {
+            return query.for(strength === "share" ? "share" : "update");
+        }
+        throw new common_1.BadRequestException(`Row locks (lock, forNoKeyUpdate) are not supported on ${this.config.dialect}`);
+    }
+    textSearchConfig(language = "english") {
+        if (typeof language !== "string" ||
+            !/^[A-Za-z_][A-Za-z0-9_]{0,62}(\.[A-Za-z_][A-Za-z0-9_]{0,62})?$/.test(language)) {
+            throw new common_1.BadRequestException(`Invalid full-text search language: ${String(language)}`);
+        }
+        return drizzle_orm_1.sql.raw(`'${language}'`);
+    }
+    fullTextParts(columns, term, options = {}) {
+        const config = this.textSearchConfig(options.language);
+        const mode = options.queryMode ?? "plain";
+        if (mode !== "plain" && mode !== "websearch") {
+            throw new common_1.BadRequestException(`Invalid full-text query mode: ${String(mode)} (expected 'plain' or 'websearch')`);
+        }
+        const parse = drizzle_orm_1.sql.raw(mode === "websearch" ? "websearch_to_tsquery" : "plainto_tsquery");
+        const vector = drizzle_orm_1.sql.join(columns.map((column) => (0, drizzle_orm_1.sql) `to_tsvector(${config}, ${column})`), (0, drizzle_orm_1.sql) ` || `);
+        return { vector, query: (0, drizzle_orm_1.sql) `${parse}(${config}, ${term})` };
     }
     buildSearchCondition(search) {
         if (!search?.term || !search.columns?.length)
@@ -894,18 +984,22 @@ class SqlBaseCrudService {
             if (this.config.dialect !== "postgresql") {
                 throw new common_1.BadRequestException("Full-text search only supported in PostgreSQL");
             }
-            const tsVector = drizzle_orm_1.sql.join(columns.map((column) => (0, drizzle_orm_1.sql) `to_tsvector('english', ${column})`), (0, drizzle_orm_1.sql) ` || `);
-            const tsQuery = (0, drizzle_orm_1.sql) `plainto_tsquery('english', ${term})`;
-            return (0, drizzle_orm_1.sql) `${tsVector} @@ ${tsQuery}`;
+            const { vector, query } = this.fullTextParts(columns, term, search);
+            return (0, drizzle_orm_1.sql) `${vector} @@ ${query}`;
         }
         const pattern = `%${term.replace(/[\\%_]/g, "\\$&")}%`;
         const conditions = columns.map((column) => this.caseInsensitiveLike(column, pattern));
         return conditions.length === 1 ? conditions[0] : (0, drizzle_orm_1.or)(...conditions);
     }
     caseInsensitiveLike(column, pattern) {
-        return this.config.dialect === "mysql"
-            ? (0, drizzle_orm_1.like)(column, pattern)
-            : (0, drizzle_orm_1.ilike)(column, pattern);
+        if (this.config.dialect === "postgresql")
+            return (0, drizzle_orm_1.ilike)(column, pattern);
+        return this.likePattern(column, pattern);
+    }
+    likePattern(column, pattern) {
+        return this.config.dialect === "sqlite"
+            ? (0, drizzle_orm_1.sql) `${column} like ${pattern} escape '\\'`
+            : (0, drizzle_orm_1.like)(column, pattern);
     }
     parseQuery(query, options = {}) {
         const config = this.config;
@@ -1211,7 +1305,7 @@ class SqlBaseCrudService {
         return branches.length > 0 ? (0, drizzle_orm_1.or)(...branches) : (0, drizzle_orm_1.sql) `false`;
     }
     afterCursor(spec, value) {
-        const postgres = this.config.dialect !== "mysql";
+        const postgres = this.config.dialect === "postgresql";
         const nullsFirst = postgres ? spec.order === "desc" : spec.order === "asc";
         if (value === null) {
             return nullsFirst ? (0, drizzle_orm_1.isNotNull)(spec.column) : undefined;
@@ -1881,7 +1975,7 @@ class SqlBaseCrudService {
         let statement;
         if (this.config.dialect === "mysql") {
             if (scope) {
-                throw new common_1.BadRequestException("upsert on a scoped entity needs PostgreSQL");
+                throw new common_1.BadRequestException("upsert on a scoped entity needs PostgreSQL or SQLite");
             }
             statement = insert.onDuplicateKeyUpdate({ set });
         }
@@ -2751,7 +2845,7 @@ class SqlBaseCrudService {
                 : `%${escaped}%`;
         return insensitive || this.config.sql?.caseSensitive === false
             ? this.caseInsensitiveLike(column, pattern)
-            : (0, drizzle_orm_1.like)(column, pattern);
+            : this.likePattern(column, pattern);
     }
     applyComplexFilter(conditions, column, filterObj) {
         const coerce = (value) => this.coerceFilterValue(column, value);
@@ -2783,7 +2877,7 @@ class SqlBaseCrudService {
                     conditions.push((0, drizzle_orm_1.ne)(column, coerce(raw)));
                     break;
                 case "like":
-                    conditions.push((0, drizzle_orm_1.like)(column, raw));
+                    conditions.push(this.likePattern(column, raw));
                     break;
                 case "ilike":
                     conditions.push(this.caseInsensitiveLike(column, raw));
@@ -2841,10 +2935,22 @@ class SqlBaseCrudService {
         }
     }
     async executeSqlTransaction(operation, existingTransaction) {
+        this.assertTransactions(existingTransaction ?? this.config.db);
         if (existingTransaction)
             return operation(existingTransaction);
         return this.config.db.transaction(operation);
     }
+    assertTransactions(db) {
+        if (this.config.dialect !== "sqlite")
+            return;
+        const kind = db?.constructor?.[drizzle_orm_1.entityKind];
+        if (kind === "D1Database" || kind === "D1Transaction") {
+            throw new crud_exceptions_1.TransactionException("Cloudflare D1 has no interactive transactions, so mass writes, nested writes and attach/detach/sync are not available on it. Use the single-row methods, or db.batch() yourself.");
+        }
+        if (db?.resultKind === "sync") {
+            throw new crud_exceptions_1.TransactionException("This SQLite driver is synchronous (better-sqlite3, bun:sqlite, sql.js), and its transactions cannot wait for async work, so mass writes, nested writes and attach/detach/sync are not available on it. Use an async driver such as libSQL (@libsql/client).");
+        }
+    }
     getEntityName() {
         try {
             return (0, drizzle_orm_1.getTableName)(this.config.table) || "Entity";
@@ -2868,31 +2974,37 @@ class SqlBaseCrudService {
             this.assertAllowed("searchableColumns", name, options);
             return column;
         });
-        const { transaction } = options || {};
-        const db = transaction || this.config.db;
-        const tsVector = drizzle_orm_1.sql.join(columns.map((column) => (0, drizzle_orm_1.sql) `to_tsvector('english', ${column})`), (0, drizzle_orm_1.sql) ` || `);
-        const tsQuery = (0, drizzle_orm_1.sql) `plainto_tsquery('english', ${searchTerm})`;
-        const matchExpr = (0, drizzle_orm_1.sql) `${tsVector} @@ ${tsQuery}`;
-        const whereExpr = (0, drizzle_orm_1.and)(matchExpr, ...this.rowScope(options));
+        const { filters, language, queryMode, ...readOptions } = options ?? {};
+        const { vector, query } = this.fullTextParts(columns, searchTerm, {
+            language,
+            queryMode,
+        });
         const { page, limit, offset } = this.resolvePagination(pagination?.page, pagination?.limit);
+        const plan = this.planList(filters, undefined, "asc", readOptions);
+        const conditions = [(0, drizzle_orm_1.sql) `${vector} @@ ${query}`, ...plan.conditions];
+        const joins = Array.from(new Set([
+            ...plan.joined.map((node) => node.name),
+            ...plan.filterRelations,
+        ]));
         const pk = this.columnOf(this.config.table, this.config.primaryKey);
-        const orderBy = [(0, drizzle_orm_1.sql) `ts_rank(${tsVector}, ${tsQuery}) DESC`];
+        const orderBy = [(0, drizzle_orm_1.sql) `ts_rank(${vector}, ${query}) DESC`];
         if (pk)
             orderBy.push((0, drizzle_orm_1.asc)(pk));
-        const dataQuery = db
-            .select()
-            .from(this.config.table)
-            .where(whereExpr)
+        let dataQuery = this.startSelect(plan.db, plan.baseSelect, plan.joined, joins.length > 0, plan.selection);
+        dataQuery = this.applyJoins(dataQuery, joins, readOptions)
+            .where((0, drizzle_orm_1.and)(...conditions))
             .orderBy(...orderBy)
             .limit(limit)
             .offset(offset);
-        const countQuery = db
-            .select({ count: (0, drizzle_orm_1.sql) `count(*)` })
-            .from(this.config.table)
-            .where(whereExpr);
-        const [data, totalResult] = await this.runRead(Promise.all([dataQuery, countQuery]));
+        const countQuery = this.buildCountQuery(plan.db, conditions, plan.filterRelations, readOptions);
+        const [fetched, totalResult] = await this.runRead(Promise.all([dataQuery, countQuery]));
         const total = parseInt(totalResult[0]?.count?.toString() || "0", 10);
-        return { data, total, page, limit };
+        const rows = this.normalizeRelations(fetched, plan.joined.map((node) => node.name));
+        await Promise.all([
+            this.loadRelations(plan.db, rows, plan.nodes, plan.selection, undefined, readOptions),
+            this.loadCounts(plan.db, rows, readOptions.counts, readOptions),
+        ]);
+        return { data: rows, total, page, limit };
     }
 }
 exports.SqlBaseCrudService = SqlBaseCrudService;