remult 3.4.0-next.7 → 3.4.0

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/remult-proxy.js

@@ -112,16 +112,11 @@ var RemultProxy = /** @class */ (function () {
                         .repo.apply(_b, tslib_1.__spreadArray([], tslib_1.__read(args), false)))
                         .updateMany.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args2), false));
                 },
-                _a.find = function () {
-                    var _a, _b;
-                    var args2 = [];
-                    for (var _i = 0; _i < arguments.length; _i++) {
-                        args2[_i] = arguments[_i];
-                    }
-                    return (_a = (_b = self
+                _a.find = function (options) {
+                    var _a;
+                    return (_a = self
                         .remultFactory())
-                        .repo.apply(_b, tslib_1.__spreadArray([], tslib_1.__read(args), false)))
-                        .find.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args2), false));
+                        .repo.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args), false)).find(options);
                 },
                 _a.groupBy = function () {
                     var _a, _b;
@@ -145,27 +140,17 @@ var RemultProxy = /** @class */ (function () {
                         .repo.apply(_b, tslib_1.__spreadArray([], tslib_1.__read(args), false)))
                         .aggregate.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args2), false));
                 },
-                _a.findFirst = function () {
-                    var _a, _b;
-                    var args2 = [];
-                    for (var _i = 0; _i < arguments.length; _i++) {
-                        args2[_i] = arguments[_i];
-                    }
-                    return (_a = (_b = self
+                _a.findFirst = function (where, options) {
+                    var _a;
+                    return (_a = self
                         .remultFactory())
-                        .repo.apply(_b, tslib_1.__spreadArray([], tslib_1.__read(args), false)))
-                        .findFirst.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args2), false));
+                        .repo.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args), false)).findFirst(where, options);
                 },
-                _a.findOne = function () {
-                    var _a, _b;
-                    var args2 = [];
-                    for (var _i = 0; _i < arguments.length; _i++) {
-                        args2[_i] = arguments[_i];
-                    }
-                    return (_a = (_b = self
+                _a.findOne = function (options) {
+                    var _a;
+                    return (_a = self
                         .remultFactory())
-                        .repo.apply(_b, tslib_1.__spreadArray([], tslib_1.__read(args), false)))
-                        .findOne.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args2), false));
+                        .repo.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(args), false)).findOne(options);
                 },
                 _a.findId = function (a, b) {
                     var _a;

package/src/remult3/RepositoryImplementation.d.ts

@@ -106,6 +106,7 @@ declare abstract class rowHelperBase<T> {
      * must not be serialized by {@link toApiJson}. */
     _fieldsExcludedBySelect?: Set<string>;
     constructor(fieldsMetadata: FieldMetadata[], instance: T, remult: Remult, isNewRow: boolean, excludeRelationMembers?: Set<string>);
+    _skipRelationFieldSync: boolean;
     _subscribers?: SubscribableImp;
     subscribe(listener: RefSubscriber): Unsubscribe;
     _isLoading: boolean;
@@ -302,7 +303,7 @@ export declare function isAutoIncrement(f: FieldMetadata): boolean;
 export declare function ValueListFieldType<valueType extends ValueListItem = ValueListItem>(...options: (ValueListFieldOptions<any, valueType> | ((options: FieldOptions<any, valueType>, remult: Remult) => void))[]): (type: ClassType<valueType>, context?: any) => void;
 export interface ValueListFieldOptions<entityType, valueType> extends FieldOptions<entityType, valueType> {
     getValues?: () => valueType[];
-    /** Value used when a stored id is not in the list. A value, or `(id) => value`. @default undefined */
+    /** Value used when a stored id is not in the list. A value, or `(id) => value`. Only `null` and `undefined` stay `undefined`; a blank `''` uses this, which is the usual legacy column. A declared id of `''` is unaffected. @default undefined */
     unknownIdValue?: valueType | ((id: any) => valueType | undefined);
 }
 export declare class ValueListInfo<T extends ValueListItem> implements ValueConverter<T> {
@@ -314,7 +315,8 @@ export declare class ValueListInfo<T extends ValueListItem> implements ValueConv
     private unknownIdValue?;
     private constructor();
     getValues(): T[];
-    byId(key: any): T | undefined;
+    /** Declared id only. Pass `useUnknownIdValue` to also apply `unknownIdValue` (`null` and `undefined` still return `undefined`). */
+    byId(key: any, useUnknownIdValue?: boolean): T | undefined;
     fromJson(val: any): T;
     toJson(val: T): any;
     fromDb(val: any): T;

package/src/remult3/RepositoryImplementation.js

@@ -57,6 +57,18 @@ var classValidatorValidate = undefined;
 //     })
 //     .catch(() => {
 //     });
+// Assigning a `toOne` also writes its `field`/`fields`, which would wipe the FK of a row whose
+// target is missing.
+function setMissingRelationToNull(row, key) {
+    var ref = (0, getEntityRef_js_1.getEntityRef)(row);
+    ref._skipRelationFieldSync = true;
+    try {
+        row[key] = null;
+    }
+    finally {
+        ref._skipRelationFieldSync = false;
+    }
+}
 var RepositoryImplementation = /** @class */ (function () {
     function RepositoryImplementation(_entity, _remult, _dataProvider, _info, _defaultFindOptions) {
         this._entity = _entity;
@@ -954,7 +966,7 @@ var RepositoryImplementation = /** @class */ (function () {
     };
     RepositoryImplementation.prototype._rawFind = function (options_1) {
         return tslib_1.__awaiter(this, arguments, void 0, function (options, skipOrderByAndLimit, loader, actualFind) {
-            var opt, rawRows, result;
+            var findOptions, opt, rawRows, result;
             if (skipOrderByAndLimit === void 0) { skipOrderByAndLimit = false; }
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
@@ -964,7 +976,13 @@ var RepositoryImplementation = /** @class */ (function () {
                         if (this._defaultFindOptions) {
                             options = tslib_1.__assign(tslib_1.__assign({}, this._defaultFindOptions), options);
                         }
-                        return [4 /*yield*/, this._buildEntityDataProviderFindOptions(options)];
+                        findOptions = options;
+                        if ((!findOptions.orderBy || Object.keys(findOptions.orderBy).length === 0) &&
+                            !this._dataProvider.isProxy &&
+                            this._info.entityInfo.defaultOrderBy) {
+                            findOptions = tslib_1.__assign(tslib_1.__assign({}, findOptions), { orderBy: this._info.entityInfo.defaultOrderBy });
+                        }
+                        return [4 /*yield*/, this._buildEntityDataProviderFindOptions(findOptions)];
                     case 1:
                         opt = _a.sent();
                         if (skipOrderByAndLimit) {
@@ -1029,10 +1047,6 @@ var RepositoryImplementation = /** @class */ (function () {
                                 return f.key;
                             });
                         }
-                        if (!options.orderBy || Object.keys(options.orderBy).length === 0) {
-                            if (!this._dataProvider.isProxy)
-                                options.orderBy = this._info.entityInfo.defaultOrderBy;
-                        }
                         _a = opt;
                         return [4 /*yield*/, this._translateWhereToFilter(options.where)];
                     case 1:
@@ -1225,10 +1239,12 @@ var RepositoryImplementation = /** @class */ (function () {
                     var _loop_2 = function (row) {
                         var _e = this_1._findOptionsBasedOnRelation(rel, col, incl, row, otherRepo), findOptions = _e.findOptions, returnNull = _e.returnNull, returnUndefined = _e.returnUndefined;
                         var colKey = col.key;
-                        if (returnNull)
-                            row[colKey] = null;
-                        else if (returnUndefined)
-                            row[colKey] = undefined;
+                        if (returnNull || returnUndefined) {
+                            if (rel.type === 'toMany')
+                                row[colKey] = (returnNull ? null : undefined);
+                            else
+                                setMissingRelationToNull(row, colKey);
+                        }
                         else {
                             var entityType = rel.toEntity;
                             var toRepo_1 = otherRepo;
@@ -1243,14 +1259,12 @@ var RepositoryImplementation = /** @class */ (function () {
                                 metadata: toRepo_1.metadata,
                             }, findOptions)
                                 .then(function (result) {
-                                if (result.length == 0 && rel.type == 'toOne')
-                                    return;
-                                row[colKey] =
-                                    rel.type !== 'toMany'
-                                        ? result.length == 0
-                                            ? null
-                                            : result[0]
-                                        : result;
+                                if (rel.type === 'toMany')
+                                    row[colKey] = result;
+                                else if (result.length == 0)
+                                    setMissingRelationToNull(row, colKey);
+                                else
+                                    row[colKey] = result[0];
                             });
                         }
                     };
@@ -1894,6 +1908,7 @@ var rowHelperBase = /** @class */ (function () {
         this.instance = instance;
         this.remult = remult;
         this.isNewRow = isNewRow;
+        this._skipRelationFieldSync = false;
         this._isLoading = false;
         this.lookups = new Map();
         this.originalValues = {};
@@ -1953,7 +1968,7 @@ var rowHelperBase = /** @class */ (function () {
                         },
                         set: function (newVal) {
                             val_1 = newVal;
-                            if (newVal === undefined)
+                            if (newVal === undefined || _this._skipRelationFieldSync)
                                 return;
                             var op = col.options;
                             if (op.field) {
@@ -2804,7 +2819,9 @@ var rowHelperImplementation = /** @class */ (function (_super) {
                         finally { if (e_41) throw e_41.error; }
                         return [7 /*endfinally*/];
                     case 12:
-                        this.repo._remult.liveQueryPublisher.itemChanged(this.repo.metadata.key, [{ id: this.getId(), oldId: this.getOriginalId(), deleted: false }]);
+                        this.repo._remult.liveQueryPublisher.itemChanged(this.repo.metadata.key, [
+                            { id: this.getId(), oldId: this.getOriginalId(), deleted: false },
+                        ]);
                         this.saveOriginalData();
                         this._isNew = false;
                         return [2 /*return*/, this.instance];
@@ -4045,21 +4062,22 @@ var ValueListInfo = /** @class */ (function () {
     ValueListInfo.prototype.getValues = function () {
         return this.values;
     };
-    ValueListInfo.prototype.byId = function (key) {
-        if (this.isNumeric)
-            key = +key;
-        return this.byIdMap.get(key);
-    };
-    ValueListInfo.prototype.fromJson = function (val) {
-        var known = this.byId(val);
-        if (known !== undefined)
+    /** Declared id only. Pass `useUnknownIdValue` to also apply `unknownIdValue` (`null` and `undefined` still return `undefined`). */
+    ValueListInfo.prototype.byId = function (key, useUnknownIdValue) {
+        if (useUnknownIdValue === void 0) { useUnknownIdValue = false; }
+        var lookupKey = this.isNumeric ? +key : key;
+        var known = this.byIdMap.get(lookupKey);
+        if (known !== undefined || !useUnknownIdValue)
             return known;
-        if (val == null)
+        if (key == null)
             return undefined;
         var fallback = this.unknownIdValue;
         if (typeof fallback !== 'function')
             return fallback;
-        return fallback(this.isNumeric ? +val : val);
+        return fallback(lookupKey);
+    };
+    ValueListInfo.prototype.fromJson = function (val) {
+        return this.byId(val, true);
     };
     ValueListInfo.prototype.toJson = function (val) {
         if (!val)

package/src/remult3/remult3.d.ts

@@ -395,6 +395,10 @@ export type GroupByResult<entityType, groupByFields extends (keyof entityType)[]
 };
 /** used to perform CRUD operations on an `entityType` */
 export interface Repository<entityType> {
+    /** returns an array based on the provided options. Included relations drop their `?`, see {@link Loaded} */
+    find<const include extends MembersToInclude<entityType>>(options: FindOptions<entityType> & {
+        include: include;
+    }): Promise<Loaded<entityType, include>[]>;
     /** returns an array based on the provided options */
     find(options?: FindOptions<entityType>): Promise<entityType[]>;
     /** Using the same options as the {@link find} method, but subscribing to entity changes.
@@ -410,6 +414,9 @@ export interface Repository<entityType> {
      * @example
      * await taskRepo.findFirst({ completed:false },{ createIfNotFound: true })
      *      */
+    findFirst<const include extends MembersToInclude<entityType>>(where: EntityFilter<entityType> | undefined, options: FindFirstOptions<entityType> & {
+        include: include;
+    }): Promise<Loaded<entityType, include> | undefined>;
     findFirst(where?: EntityFilter<entityType>, options?: FindFirstOptions<entityType>): Promise<entityType | undefined>;
     /** returns the first item that matchers the `where` condition
      * @example
@@ -417,8 +424,14 @@ export interface Repository<entityType> {
      * @example
      * await taskRepo.findFirst({ where:{ completed:false }, createIfNotFound: true })
      *      */
+    findOne<const include extends MembersToInclude<entityType>>(options: FindFirstOptions<entityType> & {
+        include: include;
+    }): Promise<Loaded<entityType, include> | undefined>;
     findOne(options?: FindFirstOptions<entityType>): Promise<entityType | undefined>;
     /** returns the items that matches the id. If id is undefined | null, returns null */
+    findId<const include extends MembersToInclude<entityType>>(id: idType<entityType>, options: FindFirstOptionsBase<entityType> & {
+        include: include;
+    }): Promise<Loaded<entityType, include> | undefined | null>;
     findId(id: idType<entityType>, options?: FindFirstOptionsBase<entityType>): Promise<entityType | undefined | null>;
     /**
      * Performs an aggregation on the repository's entity type based on the specified options.
@@ -1183,6 +1196,29 @@ export type ObjectMembersOnly<T> = MembersOnly<{
 export type MembersToInclude<T> = {
     [K in keyof ObjectMembersOnly<T>]?: boolean | (NonNullable<T[K]> extends Array<any> ? FindOptions<NonNullable<T[K]>[number]> : FindFirstOptions<NonNullable<T[K]>>);
 };
+type LoadedTarget<target, include> = include extends {
+    include: infer nested;
+} ? Loaded<target, nested> : target;
+type LoadedRelation<value, include> = NonNullable<value> extends (infer target)[] ? LoadedTarget<target, include>[] : null extends value ? LoadedTarget<NonNullable<value>, include> | null : LoadedTarget<NonNullable<value>, include>;
+type LoadedKeys<entityType, include> = {
+    [K in keyof include & keyof entityType]-?: [include[K]] extends [
+        true | object
+    ] ? K : never;
+}[keyof include & keyof entityType];
+/**
+ * The entity type `find` returns for a given `include`.
+ * Included relations drop their `?`, and nested `include`s work the same way.
+ * A relation declared `| null` stays nullable.
+ * A relation included with `false` or a widened `boolean` keeps its declared type.
+ * An included relation whose target row is missing loads as `null`.
+ * Declare it `| null` when that can happen, e.g. an optional FK or a target a `backendPrefilter` can hide.
+ * @example
+ * const tasks = await repo(Task).find({ include: { category: true } })
+ * tasks[0].category.name // `category` is loaded, no `?.` needed
+ */
+export type Loaded<entityType, include> = 0 extends 1 & (entityType | include) ? entityType : [LoadedKeys<entityType, include>] extends [never] ? entityType : Omit<entityType, LoadedKeys<entityType, include>> & {
+    [K in LoadedKeys<entityType, include>]-?: LoadedRelation<Exclude<entityType[K], undefined>, include[K]>;
+};
 export type RepositoryRelations<entityType> = {
     [K in keyof ObjectMembersOnly<entityType>]-?: NonNullable<entityType[K]> extends Array<infer R> ? Repository<R> : entityType[K] extends infer R ? {
         findOne: (options?: FindOptionsBase<R>) => Promise<R>;
@@ -1229,3 +1265,4 @@ export declare const flags: {
     /** Version poll while SSE is stale */
     liveQueryPollWhenStaleMs: number;
 };
+export {};

package/src/sort.js

@@ -159,9 +159,6 @@ var Sort = /** @class */ (function () {
      */
     Sort.createUniqueSort = function (entityMetadata, orderBy) {
         var e_3, _a;
-        if ((!orderBy || Object.keys(orderBy).length === 0) &&
-            entityMetadata.options.defaultOrderBy)
-            orderBy = Sort.translateOrderByToSort(entityMetadata, entityMetadata.options.defaultOrderBy);
         if (!orderBy)
             orderBy = new Sort();
         var _loop_2 = function (field) {

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;