remult 3.4.0-next.6 → 3.4.0-next.9

package/esm/src/data-providers/sql-database.js

@@ -181,7 +181,7 @@ export class SqlDatabase {
     static async selectToRaw(repo, options, sql) {
         const r = getRepository(repo);
         const built = await buildFindSql(r.metadata, await getRepositoryInternals(r)._buildEntityDataProviderFindOptions(options ?? {}), sql?.dbNames ??
-            (await dbNamesOfWithForceSqlExpression(r.metadata, sql?.wrapIdentifier ?? wrapIdentifierOf(r))), sql?.sqlCommand ?? new myDummySQLCommand(), false, sql?.limitSyntax ?? limitSyntaxRequired, { aliasColumns: true, defaultOrderBy: false });
+            (await dbNamesOfWithForceSqlExpression(r.metadata, sql?.wrapIdentifier ?? wrapIdentifierOf(r))), sql?.sqlCommand ?? new myDummySQLCommand(), false, sql?.limitSyntax ?? limitSyntaxRequired, { aliasColumns: true });
         return {
             sql: built.select,
             toResult: (row) => built.toResult((_, alias) => row[alias]),
@@ -353,6 +353,8 @@ class ActualSQLEntityDataProvider {
     async find(options) {
         const e = await this.init();
         const r = this.sql.createCommand();
+        if (options && !options.orderBy)
+            options.orderBy = Sort.createUniqueSort(this.entity, new Sort());
         const { select, toResult } = await buildFindSql(this.entity, options, e, r, this.sql._getSourceSql().orderByNullsFirst, (limit, offset) => this.strategy.getLimitSqlSyntax(limit, offset));
         const result = await r.execute(select);
         return result.rows.map((y) => toResult((i) => y[result.getColumnKeyInResultForIndexInSelect(i)]));
@@ -560,7 +562,7 @@ export function getRowAfterUpdate(meta, dataProvider, data, id, operation) {
     });
 }
 /** The select that `find` runs, and the mapping of one result row to field values. With `aliasColumns`, every column is aliased through `wrapIdentifier`, so a row can be read by alias as well as by position. */
-export async function buildFindSql(entity, options, e, r, orderByNullsFirst, limitSyntax, { aliasColumns = false, defaultOrderBy = true } = {}) {
+export async function buildFindSql(entity, options, e, r, orderByNullsFirst, limitSyntax, { aliasColumns = false } = {}) {
     const { colKeys, select: columns } = await selectColumns(entity, e, r, options?.select, options?.args, aliasColumns);
     let select = 'select ' + columns + '\n from ' + e.$entityName;
     if (options) {
@@ -572,9 +574,6 @@ export async function buildFindSql(entity, options, e, r, orderByNullsFirst, lim
         if (options.limit) {
             options.orderBy = Sort.createUniqueSort(entity, options.orderBy);
         }
-        if (!options.orderBy && defaultOrderBy) {
-            options.orderBy = Sort.createUniqueSort(entity, new Sort());
-        }
         if (options.orderBy) {
             let first = true;
             for (const c of options.orderBy.Segments) {

package/esm/src/remult3/Fields.js

@@ -190,7 +190,12 @@ export class Fields {
    */
     static literal(optionalValues, ...options) {
         return Fields.string({
-            validate: (entity, event) => Validators.in(optionalValues())(entity, event),
+            validate: (entity, event) => {
+                // A value already stored is a fact. Only a new row or a new value has to be in the list.
+                if (!event.isNew && !event.valueChanged())
+                    return;
+                return Validators.in(optionalValues())(entity, event);
+            },
             //@ts-expect-error as we are adding this to options without it being defined in options
             [fieldOptionalValuesFunctionKey]: optionalValues,
         }, ...options);
@@ -200,7 +205,12 @@ export class Fields {
         return Field(
         //@ts-ignore
         () => enumType(), {
-            validate: (entity, event) => Validators.enum(enumType())(entity, event),
+            validate: (entity, event) => {
+                // A value already stored is a fact. Only a new row or a new value has to be in the enum.
+                if (!event.isNew && !event.valueChanged())
+                    return;
+                return Validators.enum(enumType())(entity, event);
+            },
             [fieldOptionalValuesFunctionKey]: () => getEnumValues(enumType()),
         }, ...options, (options) => {
             ;

package/esm/src/remult3/RepositoryImplementation.js

@@ -597,7 +597,16 @@ export class RepositoryImplementation {
         if (this._defaultFindOptions) {
             options = { ...this._defaultFindOptions, ...options };
         }
-        let opt = await this._buildEntityDataProviderFindOptions(options);
+        let findOptions = options;
+        if ((!findOptions.orderBy || Object.keys(findOptions.orderBy).length === 0) &&
+            !this._dataProvider.isProxy &&
+            this._info.entityInfo.defaultOrderBy) {
+            findOptions = {
+                ...findOptions,
+                orderBy: this._info.entityInfo.defaultOrderBy,
+            };
+        }
+        let opt = await this._buildEntityDataProviderFindOptions(findOptions);
         if (skipOrderByAndLimit) {
             delete opt.orderBy;
             delete opt.limit;
@@ -633,10 +642,6 @@ export class RepositoryImplementation {
                 return f.key;
             });
         }
-        if (!options.orderBy || Object.keys(options.orderBy).length === 0) {
-            if (!this._dataProvider.isProxy)
-                options.orderBy = this._info.entityInfo.defaultOrderBy;
-        }
         opt.where = await this._translateWhereToFilter(options.where);
         if (options.orderBy !== undefined)
             opt.orderBy = Sort.translateOrderByToSort(this.metadata, options.orderBy);
@@ -2389,6 +2394,9 @@ export function ValueListFieldType(...options) {
                 if (ref.value && !values.find((v) => v === ref.value)) {
                     ref.value = values.find((v) => v.id === ref.value.id) || ref.value;
                 }
+                // A value already stored is a fact. Only a new row or a new value has to be in the list.
+                if (!ref.isNew && !ref.valueChanged())
+                    return;
                 return Validators.in(values)(entity, ref);
             };
         }, ...options)(type);
@@ -2407,6 +2415,7 @@ export class ValueListInfo {
     byIdMap = new Map();
     values = [];
     isNumeric = false;
+    unknownIdValue;
     constructor(valueListType) {
         this.valueListType = valueListType;
         for (let member in this.valueListType) {
@@ -2427,7 +2436,9 @@ export class ValueListInfo {
         var options = this.valueListType[storableMember];
         if (options) {
             for (const op of options) {
-                if (op?.getValues) {
+                if (!op || typeof op === 'function')
+                    continue;
+                if (op.getValues) {
                     this.values.splice(0, this.values.length, ...op.getValues());
                     this.byIdMap.clear();
                     this.values.forEach((s) => {
@@ -2435,6 +2446,8 @@ export class ValueListInfo {
                         this.byIdMap.set(s.id, s);
                     });
                 }
+                if ('unknownIdValue' in op)
+                    this.unknownIdValue = op.unknownIdValue;
             }
             if (this.values.find((s) => s.id === undefined))
                 throw new Error(`ValueType ${this.valueListType} has values without an id`);
@@ -2446,13 +2459,21 @@ export class ValueListInfo {
     getValues() {
         return this.values;
     }
-    byId(key) {
-        if (this.isNumeric)
-            key = +key;
-        return this.byIdMap.get(key);
+    /** Declared id only. Pass `useUnknownIdValue` to also apply `unknownIdValue` (`null` and `undefined` still return `undefined`). */
+    byId(key, useUnknownIdValue = false) {
+        const lookupKey = this.isNumeric ? +key : key;
+        const known = this.byIdMap.get(lookupKey);
+        if (known !== undefined || !useUnknownIdValue)
+            return known;
+        if (key == null)
+            return undefined;
+        const fallback = this.unknownIdValue;
+        if (typeof fallback !== 'function')
+            return fallback;
+        return fallback(lookupKey);
     }
     fromJson(val) {
-        return this.byId(val);
+        return this.byId(val, true);
     }
     toJson(val) {
         if (!val)

package/esm/src/sort.js

@@ -128,9 +128,6 @@ export class Sort {
      * @returns {Sort} A `Sort` instance representing the unique sort criteria.
      */
     static createUniqueSort(entityMetadata, orderBy) {
-        if ((!orderBy || Object.keys(orderBy).length === 0) &&
-            entityMetadata.options.defaultOrderBy)
-            orderBy = Sort.translateOrderByToSort(entityMetadata, entityMetadata.options.defaultOrderBy);
         if (!orderBy)
             orderBy = new Sort();
         for (const field of entityMetadata.idMetadata.fields) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.4.0-next.6",
+    "version": "3.4.0-next.9",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {

package/src/column-interfaces.d.ts

@@ -58,7 +58,11 @@ export interface FieldOptions<entityType = unknown, valueType = unknown> {
      * @type {AllowedForInstance<entityType>}
      */
     allowApiUpdate?: AllowedForInstance<entityType>;
-    /** An arrow function that'll be used to perform validations on it
+    /** An arrow function that'll be used to perform validations on it.
+     *
+     * `validate` from several option objects is additive: each one is appended.
+     * A function option is the only way to replace validators already set, including a built-in one:
+     * `(options) => { options.validate = ... }`.
      * @example
      * @Fields.string({
      *   validate: Validators.required

package/src/data-providers/sql-database.d.ts

@@ -124,9 +124,8 @@ export interface RawSelectOptions {
 }
 export declare function getRowAfterUpdate<entityType>(meta: EntityMetadata<entityType>, dataProvider: EntityDataProvider, data: any, id: any, operation: string): any;
 /** The select that `find` runs, and the mapping of one result row to field values. With `aliasColumns`, every column is aliased through `wrapIdentifier`, so a row can be read by alias as well as by position. */
-export declare function buildFindSql(entity: EntityMetadata, options: EntityDataProviderFindOptions | undefined, e: EntityDbNamesBase, r: SqlCommandWithParameters, orderByNullsFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string, { aliasColumns, defaultOrderBy }?: {
+export declare function buildFindSql(entity: EntityMetadata, options: EntityDataProviderFindOptions | undefined, e: EntityDbNamesBase, r: SqlCommandWithParameters, orderByNullsFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string, { aliasColumns }?: {
     aliasColumns?: boolean | undefined;
-    defaultOrderBy?: boolean | undefined;
 }): Promise<{
     select: string;
     colKeys: FieldMetadata<unknown, unknown>[];

package/src/data-providers/sql-database.js

@@ -315,7 +315,7 @@ var SqlDatabase = /** @class */ (function () {
                     case 3:
                         _c = (_h.sent());
                         _h.label = 4;
-                    case 4: return [4 /*yield*/, _a.apply(void 0, _b.concat([_c, (_f = sql === null || sql === void 0 ? void 0 : sql.sqlCommand) !== null && _f !== void 0 ? _f : new myDummySQLCommand(), false, (_g = sql === null || sql === void 0 ? void 0 : sql.limitSyntax) !== null && _g !== void 0 ? _g : limitSyntaxRequired, { aliasColumns: true, defaultOrderBy: false }]))];
+                    case 4: return [4 /*yield*/, _a.apply(void 0, _b.concat([_c, (_f = sql === null || sql === void 0 ? void 0 : sql.sqlCommand) !== null && _f !== void 0 ? _f : new myDummySQLCommand(), false, (_g = sql === null || sql === void 0 ? void 0 : sql.limitSyntax) !== null && _g !== void 0 ? _g : limitSyntaxRequired, { aliasColumns: true }]))];
                     case 5:
                         built = _h.sent();
                         return [2 /*return*/, {
@@ -548,6 +548,8 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                     case 1:
                         e = _b.sent();
                         r = this.sql.createCommand();
+                        if (options && !options.orderBy)
+                            options.orderBy = sort_js_1.Sort.createUniqueSort(this.entity, new sort_js_1.Sort());
                         return [4 /*yield*/, buildFindSql(this.entity, options, e, r, this.sql._getSourceSql().orderByNullsFirst, function (limit, offset) { return _this.strategy.getLimitSqlSyntax(limit, offset); })];
                     case 2:
                         _a = _b.sent(), select = _a.select, toResult = _a.toResult;
@@ -918,12 +920,12 @@ function buildFindSql(entity_1, options_1, e_8, r_1, orderByNullsFirst_1, limitS
     return tslib_1.__awaiter(this, arguments, void 0, function (entity, options, e, r, orderByNullsFirst, limitSyntax, _a) {
         var _b, colKeys, columns, select, where, _c, first, _d, _e, c, _f, _g, e_9_1, page;
         var e_9, _h;
-        var _j = _a === void 0 ? {} : _a, _k = _j.aliasColumns, aliasColumns = _k === void 0 ? false : _k, _l = _j.defaultOrderBy, defaultOrderBy = _l === void 0 ? true : _l;
-        return tslib_1.__generator(this, function (_m) {
-            switch (_m.label) {
+        var _j = _a === void 0 ? {} : _a, _k = _j.aliasColumns, aliasColumns = _k === void 0 ? false : _k;
+        return tslib_1.__generator(this, function (_l) {
+            switch (_l.label) {
                 case 0: return [4 /*yield*/, selectColumns(entity, e, r, options === null || options === void 0 ? void 0 : options.select, options === null || options === void 0 ? void 0 : options.args, aliasColumns)];
                 case 1:
-                    _b = _m.sent(), colKeys = _b.colKeys, columns = _b.select;
+                    _b = _l.sent(), colKeys = _b.colKeys, columns = _b.select;
                     select = 'select ' + columns + '\n from ' + e.$entityName;
                     if (!options) return [3 /*break*/, 14];
                     if (!options.where) return [3 /*break*/, 3];
@@ -932,22 +934,19 @@ function buildFindSql(entity_1, options_1, e_8, r_1, orderByNullsFirst_1, limitS
                     _c = select;
                     return [4 /*yield*/, where.resolveWhere()];
                 case 2:
-                    select = _c + _m.sent();
-                    _m.label = 3;
+                    select = _c + _l.sent();
+                    _l.label = 3;
                 case 3:
                     if (options.limit) {
                         options.orderBy = sort_js_1.Sort.createUniqueSort(entity, options.orderBy);
                     }
-                    if (!options.orderBy && defaultOrderBy) {
-                        options.orderBy = sort_js_1.Sort.createUniqueSort(entity, new sort_js_1.Sort());
-                    }
                     if (!options.orderBy) return [3 /*break*/, 13];
                     first = true;
-                    _m.label = 4;
+                    _l.label = 4;
                 case 4:
-                    _m.trys.push([4, 11, 12, 13]);
+                    _l.trys.push([4, 11, 12, 13]);
                     _d = tslib_1.__values(options.orderBy.Segments), _e = _d.next();
-                    _m.label = 5;
+                    _l.label = 5;
                 case 5:
                     if (!!_e.done) return [3 /*break*/, 10];
                     c = _e.value;
@@ -963,8 +962,8 @@ function buildFindSql(entity_1, options_1, e_8, r_1, orderByNullsFirst_1, limitS
                     return [3 /*break*/, 8];
                 case 6: return [4 /*yield*/, e.$dbNameOf(c.field)];
                 case 7:
-                    _g = _m.sent();
-                    _m.label = 8;
+                    _g = _l.sent();
+                    _l.label = 8;
                 case 8:
                     select = _f + _g;
                     if (c.isDescending)
@@ -975,13 +974,13 @@ function buildFindSql(entity_1, options_1, e_8, r_1, orderByNullsFirst_1, limitS
                         else
                             select += ' nulls first';
                     }
-                    _m.label = 9;
+                    _l.label = 9;
                 case 9:
                     _e = _d.next();
                     return [3 /*break*/, 5];
                 case 10: return [3 /*break*/, 13];
                 case 11:
-                    e_9_1 = _m.sent();
+                    e_9_1 = _l.sent();
                     e_9 = { error: e_9_1 };
                     return [3 /*break*/, 13];
                 case 12:
@@ -999,7 +998,7 @@ function buildFindSql(entity_1, options_1, e_8, r_1, orderByNullsFirst_1, limitS
                             page = 1;
                         select += ' ' + limitSyntax(options.limit, (page - 1) * options.limit);
                     }
-                    _m.label = 14;
+                    _l.label = 14;
                 case 14: return [2 /*return*/, {
                         select: select,
                         colKeys: colKeys,

package/src/remult3/Fields.js

@@ -247,6 +247,9 @@ var Fields = /** @class */ (function () {
         }
         return Fields.string.apply(Fields, tslib_1.__spreadArray([(_a = {
                     validate: function (entity, event) {
+                        // A value already stored is a fact. Only a new row or a new value has to be in the list.
+                        if (!event.isNew && !event.valueChanged())
+                            return;
                         return validators_js_1.Validators.in(optionalValues())(entity, event);
                     }
                 },
@@ -265,6 +268,9 @@ var Fields = /** @class */ (function () {
             //@ts-ignore
             function () { return enumType(); }, (_a = {
                     validate: function (entity, event) {
+                        // A value already stored is a fact. Only a new row or a new value has to be in the enum.
+                        if (!event.isNew && !event.valueChanged())
+                            return;
                         return validators_js_1.Validators.enum(enumType())(entity, event);
                     }
                 },

package/src/remult3/RepositoryImplementation.d.ts

@@ -302,6 +302,8 @@ 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`. 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> {
     private valueListType;
@@ -309,9 +311,11 @@ export declare class ValueListInfo<T extends ValueListItem> implements ValueConv
     private byIdMap;
     private values;
     isNumeric: boolean;
+    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

@@ -954,7 +954,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 +964,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 +1035,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:
@@ -3970,6 +3972,9 @@ function ValueListFieldType() {
                     if (ref.value && !values.find(function (v) { return v === ref.value; })) {
                         ref.value = values.find(function (v) { return v.id === ref.value.id; }) || ref.value;
                     }
+                    // A value already stored is a fact. Only a new row or a new value has to be in the list.
+                    if (!ref.isNew && !ref.valueChanged())
+                        return;
                     return validators_js_1.Validators.in(values)(entity, ref);
                 };
             }], tslib_1.__read(options), false))(type);
@@ -4003,7 +4008,9 @@ var ValueListInfo = /** @class */ (function () {
             try {
                 for (var options_1 = tslib_1.__values(options), options_1_1 = options_1.next(); !options_1_1.done; options_1_1 = options_1.next()) {
                     var op = options_1_1.value;
-                    if (op === null || op === void 0 ? void 0 : op.getValues) {
+                    if (!op || typeof op === 'function')
+                        continue;
+                    if (op.getValues) {
                         (_b = this.values).splice.apply(_b, tslib_1.__spreadArray([0, this.values.length], tslib_1.__read(op.getValues()), false));
                         this.byIdMap.clear();
                         this.values.forEach(function (s) {
@@ -4011,6 +4018,8 @@ var ValueListInfo = /** @class */ (function () {
                             _this.byIdMap.set(s.id, s);
                         });
                     }
+                    if ('unknownIdValue' in op)
+                        this.unknownIdValue = op.unknownIdValue;
                 }
             }
             catch (e_54_1) { e_54 = { error: e_54_1 }; }
@@ -4038,13 +4047,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);
+    /** 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 (key == null)
+            return undefined;
+        var fallback = this.unknownIdValue;
+        if (typeof fallback !== 'function')
+            return fallback;
+        return fallback(lookupKey);
     };
     ValueListInfo.prototype.fromJson = function (val) {
-        return this.byId(val);
+        return this.byId(val, true);
     };
     ValueListInfo.prototype.toJson = function (val) {
         if (!val)

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) {