remult 3.4.0-next.9 → 3.4.1

package/src/filter/filter-consumer-bridge-to-sql-request.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomSqlFilterBuilder = exports.FilterConsumerBridgeToSqlRequest = void 0;
+exports.CustomSqlFilterBuilder = exports.FilterConsumerBridgeToSqlRequest = exports.LIKE_ESCAPE_SQL = void 0;
+exports.escapeLike = escapeLike;
 exports.isDbReadonly = isDbReadonly;
 exports.shouldNotCreateField = shouldNotCreateField;
 exports.shouldCreateEntity = shouldCreateEntity;
@@ -11,12 +12,24 @@ var tslib_1 = require("tslib");
 var sql_database_js_1 = require("../data-providers/sql-database.js");
 var remult_proxy_js_1 = require("../remult-proxy.js");
 var RepositoryImplementation_js_1 = require("../remult3/RepositoryImplementation.js");
+var valueConverters_js_1 = require("../valueConverters.js");
 var entityDbName_js_1 = require("./entityDbName.js");
 var fieldDbName_js_1 = require("./fieldDbName.js");
+// `[` starts a character class in sql server's like. `]` on its own is a literal
+// everywhere, so escaping the opening bracket is enough. The other engines treat
+// an escaped non-wildcard as that literal, so one escape set works for all of them.
+var REGEX_LIKE_SPECIAL = /[!%_\[]/g;
+// `!` not `\`: a backslash in a string literal is an escape in mysql and in pg without standard_conforming_strings
+exports.LIKE_ESCAPE_SQL = " escape '!'";
+function escapeLike(val) {
+    return val.replace(REGEX_LIKE_SPECIAL, '!$&');
+}
 var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
-    function FilterConsumerBridgeToSqlRequest(r, nameProvider) {
+    function FilterConsumerBridgeToSqlRequest(r, nameProvider, jsonColumnStorage) {
+        if (jsonColumnStorage === void 0) { jsonColumnStorage = 'native'; }
         this.r = r;
         this.nameProvider = nameProvider;
+        this.jsonColumnStorage = jsonColumnStorage;
         this.where = '';
         this._addWhere = true;
         this.promises = [];
@@ -81,7 +94,7 @@ var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
                     case 1:
                         if (!!orElements_1_1.done) return [3 /*break*/, 4];
                         element = orElements_1_1.value;
-                        f = new FilterConsumerBridgeToSqlRequest(this.r, this.nameProvider);
+                        f = new FilterConsumerBridgeToSqlRequest(this.r, this.nameProvider, this.jsonColumnStorage);
                         f._addWhere = false;
                         element.__applyToConsumer(f);
                         return [4 /*yield*/, f.resolveWhere()];
@@ -128,7 +141,7 @@ var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        f = new FilterConsumerBridgeToSqlRequest(this.r, this.nameProvider);
+                        f = new FilterConsumerBridgeToSqlRequest(this.r, this.nameProvider, this.jsonColumnStorage);
                         f._addWhere = false;
                         element.__applyToConsumer(f);
                         return [4 /*yield*/, f.resolveWhere()];
@@ -163,7 +176,9 @@ var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
                     this.addToWhere(this.nameProvider.$dbNameOf(col) +
                         ' in (' +
                         val
-                            .map(function (x) { return toDbSql(_this.r, col, col.valueConverter.toDb(x)); })
+                            .map(function (x) {
+                            return toDbSql(_this.r, col, (0, valueConverters_js_1.toDbColumn)(col, x, _this.jsonColumnStorage));
+                        })
                             .join(',') +
                         ')');
                 else
@@ -191,53 +206,29 @@ var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
         this.add(col, val, '<');
     };
     FilterConsumerBridgeToSqlRequest.prototype.containsCaseInsensitive = function (col, val) {
-        var _this = this;
-        this.promises.push((function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                this.addToWhere('lower (' +
-                    this.nameProvider.$dbNameOf(col) +
-                    ") like lower ('%" +
-                    val.replace(/'/g, "''") +
-                    "%')");
-                return [2 /*return*/];
-            });
-        }); })());
+        this.like(col, '%' + escapeLike(val) + '%');
     };
     FilterConsumerBridgeToSqlRequest.prototype.notContainsCaseInsensitive = function (col, val) {
-        var _this = this;
-        this.promises.push((function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                this.addToWhere('not lower (' +
-                    this.nameProvider.$dbNameOf(col) +
-                    ") like lower ('%" +
-                    val.replace(/'/g, "''") +
-                    "%')");
-                return [2 /*return*/];
-            });
-        }); })());
+        this.like(col, '%' + escapeLike(val) + '%', 'not ');
     };
     FilterConsumerBridgeToSqlRequest.prototype.startsWithCaseInsensitive = function (col, val) {
-        var _this = this;
-        this.promises.push((function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                this.addToWhere('lower (' +
-                    this.nameProvider.$dbNameOf(col) +
-                    ") like lower ('" +
-                    val.replace(/'/g, "''") +
-                    "%')");
-                return [2 /*return*/];
-            });
-        }); })());
+        this.like(col, escapeLike(val) + '%');
     };
     FilterConsumerBridgeToSqlRequest.prototype.endsWithCaseInsensitive = function (col, val) {
+        this.like(col, '%' + escapeLike(val));
+    };
+    FilterConsumerBridgeToSqlRequest.prototype.like = function (col, pattern, not) {
         var _this = this;
+        if (not === void 0) { not = ''; }
         this.promises.push((function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
             return tslib_1.__generator(this, function (_a) {
-                this.addToWhere('lower (' +
+                this.addToWhere(not +
+                    'lower (' +
                     this.nameProvider.$dbNameOf(col) +
-                    ") like lower ('%" +
-                    val.replace(/'/g, "''") +
-                    "')");
+                    ') like lower (' +
+                    this.r.param(pattern) +
+                    ')' +
+                    exports.LIKE_ESCAPE_SQL);
                 return [2 /*return*/];
             });
         }); })());
@@ -251,7 +242,7 @@ var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
                     ' ' +
                     operator +
                     ' ' +
-                    toDbSql(this.r, col, col.valueConverter.toDb(val));
+                    toDbSql(this.r, col, (0, valueConverters_js_1.toDbColumn)(col, val, this.jsonColumnStorage));
                 this.addToWhere(x);
                 return [2 /*return*/];
             });
@@ -274,7 +265,7 @@ var FilterConsumerBridgeToSqlRequest = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         if (!(databaseCustom === null || databaseCustom === void 0 ? void 0 : databaseCustom.buildSql)) return [3 /*break*/, 2];
-                        item = new CustomSqlFilterBuilder(this.r, this.nameProvider.wrapIdentifier);
+                        item = new CustomSqlFilterBuilder(this.r, this.nameProvider.wrapIdentifier, this.jsonColumnStorage);
                         return [4 /*yield*/, databaseCustom.buildSql(item)];
                     case 1:
                         sql = _a.sent();
@@ -296,10 +287,12 @@ exports.FilterConsumerBridgeToSqlRequest = FilterConsumerBridgeToSqlRequest;
  * Represents a custom SQL filter builder.
  */
 var CustomSqlFilterBuilder = /** @class */ (function () {
-    function CustomSqlFilterBuilder(r, wrapIdentifier) {
+    function CustomSqlFilterBuilder(r, wrapIdentifier, jsonColumnStorage) {
+        if (jsonColumnStorage === void 0) { jsonColumnStorage = 'native'; }
         var _this = this;
         this.r = r;
         this.wrapIdentifier = wrapIdentifier;
+        this.jsonColumnStorage = jsonColumnStorage;
         this.sql = '';
         /**
          * Adds a parameter value.
@@ -308,8 +301,8 @@ var CustomSqlFilterBuilder = /** @class */ (function () {
          * @returns {string} - The SQL token.
          */
         this.param = function (val, field) {
-            if (typeof field === 'object' && field.valueConverter.toDb) {
-                val = field.valueConverter.toDb(val);
+            if (field) {
+                val = (0, valueConverters_js_1.toDbColumn)(field, val, _this.jsonColumnStorage);
             }
             return _this.r.param(val);
         };

package/src/filter/walk-filter.d.ts

@@ -0,0 +1,3 @@
+/** Return this from {@link walkFilter}'s visitor to drop that field key. */
+export declare const omitFilterField: unique symbol;
+export declare function walkFilter(filter: unknown, visit: (key: string, value: unknown) => unknown): unknown;

package/src/filter/walk-filter.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.omitFilterField = void 0;
+exports.walkFilter = walkFilter;
+var tslib_1 = require("tslib");
+/** Return this from {@link walkFilter}'s visitor to drop that field key. */
+exports.omitFilterField = Symbol('omitFilterField');
+function isCompoundFilterKey(key) {
+    return key === '$and' || key === '$or' || key === '$not';
+}
+// `$and`, `$or`, and `$not` are entered. Every other key is a field, passed to `visit`.
+// `visit` returns the value to keep, or `omitFilterField` to drop the key.
+function walkFilter(filter, visit) {
+    var e_1, _a, e_2, _b;
+    if (Array.isArray(filter)) {
+        var result_1 = [];
+        try {
+            for (var filter_1 = tslib_1.__values(filter), filter_1_1 = filter_1.next(); !filter_1_1.done; filter_1_1 = filter_1.next()) {
+                var item = filter_1_1.value;
+                result_1.push(walkFilter(item, visit));
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (filter_1_1 && !filter_1_1.done && (_a = filter_1.return)) _a.call(filter_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return result_1;
+    }
+    if (!filter || typeof filter !== 'object')
+        return filter;
+    var result = {};
+    try {
+        for (var _c = tslib_1.__values(Object.keys(filter)), _d = _c.next(); !_d.done; _d = _c.next()) {
+            var key = _d.value;
+            var value = filter[key];
+            if (isCompoundFilterKey(key)) {
+                result[key] = walkFilter(value, visit);
+                continue;
+            }
+            var next = visit(key, value);
+            if (next !== exports.omitFilterField)
+                result[key] = next;
+        }
+    }
+    catch (e_2_1) { e_2 = { error: e_2_1 }; }
+    finally {
+        try {
+            if (_d && !_d.done && (_b = _c.return)) _b.call(_c);
+        }
+        finally { if (e_2) throw e_2.error; }
+    }
+    return result;
+}

package/src/sql-command.d.ts

@@ -18,6 +18,11 @@ export interface SqlImplementation extends HasWrapIdentifier {
 export interface HasWrapIdentifier {
     wrapIdentifier?(name: string): string;
 }
+/** How a provider stores `Fields.json`: a real json column, a text column, or text only on write (mysql2 parses on read). */
+export type JsonColumnStorage = 'native' | 'text' | 'textOnWrite';
+export interface HasJsonColumnStorage {
+    jsonColumnStorage: JsonColumnStorage;
+}
 export interface SqlCommandFactory extends HasWrapIdentifier {
     createCommand(): SqlCommand;
     execute(sql: string): Promise<SqlResult>;

package/src/valueConverters.d.ts

@@ -1,4 +1,5 @@
-import type { ValueConverter } from './column-interfaces.js';
+import type { FieldMetadata, ValueConverter } from './column-interfaces.js';
+import type { JsonColumnStorage } from './sql-command.js';
 export declare class ValueConverters {
     static readonly Date: ValueConverter<Date>;
     static readonly DateOnly: ValueConverter<Date>;
@@ -13,3 +14,5 @@ export declare class ValueConverters {
     static readonly JsonString: ValueConverter<any>;
     static readonly JsonValue: ValueConverter<any>;
 }
+export declare function fromDbColumn(field: FieldMetadata, value: any, storage: JsonColumnStorage): any;
+export declare function toDbColumn(field: FieldMetadata, value: any, storage: JsonColumnStorage): any;

package/src/valueConverters.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValueConverters = void 0;
+exports.fromDbColumn = fromDbColumn;
+exports.toDbColumn = toDbColumn;
 var tslib_1 = require("tslib");
 var inputTypes_js_1 = require("../inputTypes.js");
 var zeroDate = new Date('0000-01-01');
@@ -213,6 +215,17 @@ var ValueConverters = /** @class */ (function () {
     return ValueConverters;
 }());
 exports.ValueConverters = ValueConverters;
+function fromDbColumn(field, value, storage) {
+    if (storage === 'text' && field.valueConverter.fieldTypeInDb === 'json')
+        return ValueConverters.JsonString.fromDb(value);
+    return field.valueConverter.fromDb(value);
+}
+function toDbColumn(field, value, storage) {
+    if ((storage === 'text' || storage === 'textOnWrite') &&
+        field.valueConverter.fieldTypeInDb === 'json')
+        return ValueConverters.JsonString.toDb(value);
+    return field.valueConverter.toDb(value);
+}
 function enforceString(value) {
     if (value === null || value === undefined)
         return value;