remult 3.1.2 → 3.2.0

package/esm/remult-knex/index.js

@@ -146,6 +146,8 @@ class KnexEntityDataProvider {
         let cols = [];
         let colKeys = [];
         for (const x of this.entity.fields) {
+            if (options.select && !options.select.includes(x.key))
+                continue;
             if (x.isServerExpression) {
             }
             else {

package/esm/remult-mongo.js

@@ -96,9 +96,11 @@ class MongoEntityDataProvider {
         this.entity = entity;
         this.session = session;
     }
-    translateFromDb(row, nameProvider) {
+    translateFromDb(row, nameProvider, select) {
         let result = {};
         for (const col of this.entity.fields) {
+            if (select && !select.includes(col.key))
+                continue;
             let val = row[nameProvider.$dbNameOf(col)];
             if (val === undefined) {
                 if (!col.allowNull) {
@@ -241,7 +243,7 @@ class MongoEntityDataProvider {
         }
         return await Promise.all(await collection
             .find(where, op)
-            .map((x) => this.translateFromDb(x, e))
+            .map((x) => this.translateFromDb(x, e, options.select))
             .toArray());
     }
     async update(id, data) {

package/esm/src/data-api.js

@@ -244,6 +244,15 @@ export class DataApi {
                 limit = DataApi.defaultGetLimit;
             findOptions.limit = limit;
             findOptions.page = +request.get('_page');
+            const select = request.get('_select');
+            if (select) {
+                findOptions.select = select
+                    .split(',')
+                    .reduce((acc, key) => {
+                    acc[key] = true;
+                    return acc;
+                }, {});
+            }
         }
         if (this.remult.isAllowed(this.repository.metadata.options.apiRequireId)) {
             let hasId = false;

package/esm/src/data-providers/array-entity-data-provider.js

@@ -249,14 +249,16 @@ export class ArrayEntityDataProvider {
         }
         if (rows)
             return rows.map((i) => {
-                return this.translateFromJson(i, dbNames);
+                return this.translateFromJson(i, dbNames, options?.select);
             });
         return [];
     }
     //@internal
-    translateFromJson(row, dbNames) {
+    translateFromJson(row, dbNames, select) {
         let result = {};
         for (const col of this.entity.fields) {
+            if (select && !select.includes(col.key))
+                continue;
             result[col.key] = col.valueConverter.fromJson(row[dbNames.$dbNameOf(col)]);
         }
         return result;

package/esm/src/data-providers/rest-data-provider.js

@@ -56,6 +56,9 @@ export function findOptionsToJson(options, meta) {
             ...options,
             load: options.load(meta.fields).map((y) => y.key),
         };
+    if (options.select) {
+        options = { ...options, select: Object.keys(options.select) };
+    }
     return options;
 }
 //@internal
@@ -67,6 +70,7 @@ export function findOptionsFromJson(json, meta) {
         'where',
         'orderBy',
         'include',
+        'select',
     ]) {
         if (json[key] !== undefined) {
             if (key === 'where') {
@@ -88,6 +92,12 @@ export function findOptionsFromJson(json, meta) {
                 }
                 r[key] = newInclude;
             }
+            else if (key === 'select') {
+                r[key] = json.select.reduce((acc, key) => {
+                    acc[key] = true;
+                    return acc;
+                }, {});
+            }
             else
                 r[key] = json[key];
         }
@@ -216,6 +226,9 @@ export class RestEntityDataProvider {
                 url.add('_limit', options.limit);
             if (options.page)
                 url.add('_page', options.page);
+            if (options.select) {
+                url.add('_select', options.select.join(','));
+            }
         }
         const run = (action, body) => {
             let u = new UrlBuilder(url.url);

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

@@ -292,7 +292,7 @@ class ActualSQLEntityDataProvider {
     }
     async find(options) {
         let e = await this.init();
-        let { colKeys, select } = this.buildSelect(e);
+        let { colKeys, select } = this.buildSelect(e, options?.select);
         select = 'select ' + select;
         select += '\n from ' + e.$entityName;
         let r = this.sql.createCommand();
@@ -362,10 +362,12 @@ class ActualSQLEntityDataProvider {
         }
         return result;
     }
-    buildSelect(e) {
+    buildSelect(e, selectedFields) {
         let select = '';
         let colKeys = [];
         for (const x of this.entity.fields) {
+            if (selectedFields && !selectedFields.includes(x.key))
+                continue;
             if (x.isServerExpression) {
             }
             else {

package/esm/src/remult3/RepositoryImplementation.js

@@ -583,6 +583,20 @@ export class RepositoryImplementation {
         options = { ...options };
         let opt = {};
         opt = {};
+        if (options.select) {
+            opt.select = Object.keys(options.select)
+                .filter((x) => options.select[x])
+                .map((x) => {
+                let f = this.metadata.fields.find(x);
+                const r = getRelationFieldInfo(f);
+                if (r) {
+                    throw new Error(`select is not allowed for relation field ${x} in entity ${this.metadata.label}, use include instead`);
+                }
+                if (!f)
+                    throw new Error(`Field ${x} not found in entity ${this.metadata.label}`);
+                return f.key;
+            });
+        }
         if (!options.orderBy || Object.keys(options.orderBy).length === 0) {
             if (!this._dataProvider.isProxy)
                 options.orderBy = this._info.entityInfo.defaultOrderBy;
@@ -731,6 +745,7 @@ export class RepositoryImplementation {
                 'limit',
                 'include',
                 'orderBy',
+                'select',
             ]) {
                 //@ts-ignore
                 if (source[key])
@@ -2246,8 +2261,8 @@ export function ValueListFieldType(...options) {
     return (type, context) => {
         FieldType((o) => {
             ;
-            (o.valueConverter = ValueListInfo.get(type)),
-                (o.displayValue = (item, val) => val?.label ?? val?.caption);
+            ((o.valueConverter = ValueListInfo.get(type)),
+                (o.displayValue = (item, val) => val?.label ?? val?.caption));
             o.validate = (entity, ref) => {
                 const values = ValueListInfo.get(type).getValues();
                 if (ref.value && !values.find((v) => v === ref.value)) {

package/package.json

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

package/remult-knex/index.js

@@ -266,6 +266,8 @@ var KnexEntityDataProvider = /** @class */ (function () {
                         try {
                             for (_a = tslib_1.__values(this.entity.fields), _b = _a.next(); !_b.done; _b = _a.next()) {
                                 x = _b.value;
+                                if (options.select && !options.select.includes(x.key))
+                                    continue;
                                 if (x.isServerExpression) {
                                 }
                                 else {

package/remult-mongo.js

@@ -191,12 +191,14 @@ var MongoEntityDataProvider = /** @class */ (function () {
             });
         });
     };
-    MongoEntityDataProvider.prototype.translateFromDb = function (row, nameProvider) {
+    MongoEntityDataProvider.prototype.translateFromDb = function (row, nameProvider, select) {
         var e_3, _a;
         var result = {};
         try {
             for (var _b = tslib_1.__values(this.entity.fields), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var col = _c.value;
+                if (select && !select.includes(col.key))
+                    continue;
                 var val = row[nameProvider.$dbNameOf(col)];
                 if (val === undefined) {
                     if (!col.allowNull) {
@@ -466,7 +468,7 @@ var MongoEntityDataProvider = /** @class */ (function () {
                         _e = (_d = Promise).all;
                         return [4 /*yield*/, collection
                                 .find(where, op)
-                                .map(function (x) { return _this.translateFromDb(x, e); })
+                                .map(function (x) { return _this.translateFromDb(x, e, options.select); })
                                 .toArray()];
                     case 3: return [4 /*yield*/, _e.apply(_d, [_g.sent()])];
                     case 4: return [2 /*return*/, _g.sent()];

package/src/data-api.js

@@ -469,7 +469,7 @@ var DataApi = /** @class */ (function () {
     };
     DataApi.prototype.findOptionsFromRequest = function (request, body) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var findOptions, _a, sort, dir, limit, hasId_1, w;
+            var findOptions, _a, sort, dir, limit, select, hasId_1, w;
             var _this = this;
             return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
@@ -493,6 +493,15 @@ var DataApi = /** @class */ (function () {
                                 limit = DataApi.defaultGetLimit;
                             findOptions.limit = limit;
                             findOptions.page = +request.get('_page');
+                            select = request.get('_select');
+                            if (select) {
+                                findOptions.select = select
+                                    .split(',')
+                                    .reduce(function (acc, key) {
+                                    acc[key] = true;
+                                    return acc;
+                                }, {});
+                            }
                         }
                         if (!this.remult.isAllowed(this.repository.metadata.options.apiRequireId)) return [3 /*break*/, 3];
                         hasId_1 = false;

package/src/data-interfaces.d.ts

@@ -46,6 +46,7 @@ export interface ProxyEntityDataProvider {
     }[]): Promise<any[]>;
 }
 export interface EntityDataProviderFindOptions {
+    select?: string[];
     where?: Filter;
     limit?: number;
     page?: number;

package/src/data-providers/array-entity-data-provider.js

@@ -406,7 +406,7 @@ var ArrayEntityDataProvider = /** @class */ (function () {
                         }
                         if (rows)
                             return [2 /*return*/, rows.map(function (i) {
-                                    return _this.translateFromJson(i, dbNames);
+                                    return _this.translateFromJson(i, dbNames, options === null || options === void 0 ? void 0 : options.select);
                                 })];
                         return [2 /*return*/, []];
                 }
@@ -414,12 +414,14 @@ var ArrayEntityDataProvider = /** @class */ (function () {
         });
     };
     //@internal
-    ArrayEntityDataProvider.prototype.translateFromJson = function (row, dbNames) {
+    ArrayEntityDataProvider.prototype.translateFromJson = function (row, dbNames, select) {
         var e_12, _a;
         var result = {};
         try {
             for (var _b = tslib_1.__values(this.entity.fields), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var col = _c.value;
+                if (select && !select.includes(col.key))
+                    continue;
                 result[col.key] = col.valueConverter.fromJson(row[dbNames.$dbNameOf(col)]);
             }
         }

package/src/data-providers/rest-data-provider.js

@@ -65,6 +65,9 @@ function findOptionsToJson(options, meta) {
         options = tslib_1.__assign(tslib_1.__assign({}, options), { where: filter_interfaces_js_1.Filter.entityFilterToJson(meta, options.where) });
     if (options.load)
         options = tslib_1.__assign(tslib_1.__assign({}, options), { load: options.load(meta.fields).map(function (y) { return y.key; }) });
+    if (options.select) {
+        options = tslib_1.__assign(tslib_1.__assign({}, options), { select: Object.keys(options.select) });
+    }
     return options;
 }
 //@internal
@@ -78,6 +81,7 @@ function findOptionsFromJson(json, meta) {
             'where',
             'orderBy',
             'include',
+            'select',
         ]), _c = _b.next(); !_c.done; _c = _b.next()) {
             var key = _c.value;
             if (json[key] !== undefined) {
@@ -100,6 +104,12 @@ function findOptionsFromJson(json, meta) {
                     }
                     r[key] = newInclude;
                 }
+                else if (key === 'select') {
+                    r[key] = json.select.reduce(function (acc, key) {
+                        acc[key] = true;
+                        return acc;
+                    }, {});
+                }
                 else
                     r[key] = json[key];
             }
@@ -304,6 +314,9 @@ var RestEntityDataProvider = /** @class */ (function () {
                 url.add('_limit', options.limit);
             if (options.page)
                 url.add('_page', options.page);
+            if (options.select) {
+                url.add('_select', options.select.join(','));
+            }
         }
         var run = function (action, body) {
             var u = new urlBuilder_js_1.UrlBuilder(url.url);

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

@@ -421,7 +421,7 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                     case 0: return [4 /*yield*/, this.init()];
                     case 1:
                         e = _g.sent();
-                        _a = this.buildSelect(e), colKeys = _a.colKeys, select = _a.select;
+                        _a = this.buildSelect(e, options === null || options === void 0 ? void 0 : options.select), colKeys = _a.colKeys, select = _a.select;
                         select = 'select ' + select;
                         select += '\n from ' + e.$entityName;
                         r = this.sql.createCommand();
@@ -518,13 +518,15 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
         }
         return result;
     };
-    ActualSQLEntityDataProvider.prototype.buildSelect = function (e) {
+    ActualSQLEntityDataProvider.prototype.buildSelect = function (e, selectedFields) {
         var e_4, _a;
         var select = '';
         var colKeys = [];
         try {
             for (var _b = tslib_1.__values(this.entity.fields), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var x = _c.value;
+                if (selectedFields && !selectedFields.includes(x.key))
+                    continue;
                 if (x.isServerExpression) {
                 }
                 else {

package/src/remult3/RepositoryImplementation.js

@@ -945,12 +945,27 @@ var RepositoryImplementation = /** @class */ (function () {
     RepositoryImplementation.prototype._buildEntityDataProviderFindOptions = function (options) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var opt, _a;
+            var _this = this;
             return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         options = tslib_1.__assign({}, options);
                         opt = {};
                         opt = {};
+                        if (options.select) {
+                            opt.select = Object.keys(options.select)
+                                .filter(function (x) { return options.select[x]; })
+                                .map(function (x) {
+                                var f = _this.metadata.fields.find(x);
+                                var r = (0, relationInfoMember_js_1.getRelationFieldInfo)(f);
+                                if (r) {
+                                    throw new Error("select is not allowed for relation field ".concat(x, " in entity ").concat(_this.metadata.label, ", use include instead"));
+                                }
+                                if (!f)
+                                    throw new Error("Field ".concat(x, " not found in entity ").concat(_this.metadata.label));
+                                return f.key;
+                            });
+                        }
                         if (!options.orderBy || Object.keys(options.orderBy).length === 0) {
                             if (!this._dataProvider.isProxy)
                                 options.orderBy = this._info.entityInfo.defaultOrderBy;
@@ -1245,6 +1260,7 @@ var RepositoryImplementation = /** @class */ (function () {
                         'limit',
                         'include',
                         'orderBy',
+                        'select',
                     ])), _f = _e.next(); !_f.done; _f = _e.next()) {
                         var key = _f.value;
                         //@ts-ignore
@@ -3673,8 +3689,8 @@ function ValueListFieldType() {
     return function (type, context) {
         FieldType.apply(void 0, tslib_1.__spreadArray([function (o) {
                 ;
-                (o.valueConverter = ValueListInfo.get(type)),
-                    (o.displayValue = function (item, val) { var _a; return (_a = val === null || val === void 0 ? void 0 : val.label) !== null && _a !== void 0 ? _a : val === null || val === void 0 ? void 0 : val.caption; });
+                ((o.valueConverter = ValueListInfo.get(type)),
+                    (o.displayValue = function (item, val) { var _a; return (_a = val === null || val === void 0 ? void 0 : val.label) !== null && _a !== void 0 ? _a : val === null || val === void 0 ? void 0 : val.caption; }));
                 o.validate = function (entity, ref) {
                     var values = ValueListInfo.get(type).getValues();
                     if (ref.value && !values.find(function (v) { return v === ref.value; })) {

package/src/remult3/remult3.d.ts

@@ -1023,8 +1023,8 @@ export interface LoadOptions<entityType> {
      */
     load?: (entity: FieldsMetadata<entityType>) => FieldMetadata[];
     /**
-     * An option used in the `find` and `findFirst` methods to specify which related entities should be included
-     * when querying the source entity. It allows you to eagerly load related data to avoid N+1 query problems.
+     * An option used to specify which related entities should be included when querying the source entity.
+     * It allows you to eagerly load related data to avoid N+1 query problems.
      *
      * @param include An object specifying the related entities to include, their options, and filtering criteria.
      *
@@ -1046,6 +1046,14 @@ export interface LoadOptions<entityType> {
     include?: MembersToInclude<entityType>;
 }
 export interface FindOptionsBase<entityType> extends LoadOptions<entityType> {
+    /**
+     * An option used to specify which fields should be included in the result.
+     * @example
+     * ```ts
+     * await repo(Task).find({ select: { id: true, title: true } })
+     * ```
+     */
+    select?: EntitySelectFields<entityType>;
     /** filters the data
      * @example
      * await taskRepo.find({where: { completed:false }})
@@ -1184,6 +1192,9 @@ export type RepositoryRelationsForEntityBase<entityType> = {
 export declare type EntityIdFields<entityType> = {
     [Properties in keyof Partial<MembersOnly<entityType>>]?: true;
 };
+export declare type EntitySelectFields<entityType> = {
+    [Properties in keyof Partial<MembersOnly<entityType>>]?: boolean;
+};
 export interface ClassFieldDecoratorContextStub<entityType, valueType> {
     readonly access: {
         set(object: entityType, value: valueType | null): void;