remult 3.3.0-next.1 → 3.3.1

package/server/remult-admin.d.ts

@@ -30,12 +30,14 @@ export interface FieldUIInfo {
     caption: string;
     type: FieldUIInfoType;
     inputType: string;
+    allowNull: boolean;
     relationToOne?: FieldRelationToOneInfo;
 }
 export interface FieldRelationToOneInfo extends RelationFields {
     entityKey: string;
     idField: string;
     captionField: string;
+    allowNull: boolean;
     where?: any;
 }
 export interface AdminEntitiesOptions {

package/server/remult-admin.js

@@ -65,7 +65,7 @@ function buildEntityInfo(options) {
                             }
                         }
                         if (relRepo.metadata.apiReadAllowed) {
-                            relation = tslib_1.__assign(tslib_1.__assign({}, relInfo), { where: where, entityKey: relRepo.metadata.key, idField: idField_1, captionField: (_b = relRepo.metadata.fields
+                            relation = tslib_1.__assign(tslib_1.__assign({}, relInfo), { allowNull: x.allowNull, where: where, entityKey: relRepo.metadata.key, idField: idField_1, captionField: (_b = relRepo.metadata.fields
                                     .toArray()
                                     .find(function (x) { return x.key != idField_1 && x.valueType == String; })) === null || _b === void 0 ? void 0 : _b.key });
                         }
@@ -85,6 +85,7 @@ function buildEntityInfo(options) {
                     caption: x.label,
                     relationToOne: relation,
                     inputType: x.inputType,
+                    allowNull: x.allowNull,
                     type: x.inputType === inputTypes_js_1.InputTypes.json
                         ? 'json'
                         : x.valueType === Number

package/server/remult-api-server.js

@@ -579,6 +579,7 @@ var RemultServerImplementation = /** @class */ (function () {
                     case 0:
                         _b = (_a = dataApiFactory(c)).put;
                         _c = [res,
+                            req,
                             reqInfo.params.id];
                         return [4 /*yield*/, this.coreOptions.getRequestBody(orig)];
                     case 1: return [2 /*return*/, _b.apply(_a, _c.concat([_d.sent()]))];

package/src/data-api.d.ts

@@ -1,7 +1,6 @@
 import type { Remult } from './context.js';
 import { type ErrorInfo } from './data-interfaces.js';
 import { type EntityMetadata, type FindOptions, type Repository } from './remult3/remult3.js';
-import type { rowHelperImplementation } from './remult3/RepositoryImplementation.js';
 export declare class DataApi<T = unknown> {
     private repository;
     private remult;
@@ -17,6 +16,7 @@ export declare class DataApi<T = unknown> {
     get(response: DataApiResponse, id: any): Promise<void>;
     count(response: DataApiResponse, request: DataApiRequest, body?: any): Promise<void>;
     deleteMany(response: DataApiResponse, request: DataApiRequest, body?: any): Promise<void>;
+    private prepareWhereForManyOperation;
     groupBy(request: DataApiRequest, body: any): Promise<import("./remult3/remult3.js").GroupByResult<T, any[], any[], any[], any[], any[], any[]>[]>;
     getArrayImpl(request: DataApiRequest, body: any): Promise<{
         r: any[];
@@ -33,11 +33,11 @@ export declare class DataApi<T = unknown> {
         where?: any;
         set?: any;
     }): Promise<void>;
-    actualUpdate(row: any, body: any): Promise<rowHelperImplementation<T>>;
-    put(response: DataApiResponse, id: any, body: any): Promise<void>;
+    actualUpdate(row: any, body: any, req: DataApiRequest, doNotSelect?: boolean): Promise<any>;
+    put(response: DataApiResponse, req: DataApiRequest, id: any, body: any): Promise<void>;
     actualDelete(row: any): Promise<void>;
     delete(response: DataApiResponse, id: any): Promise<void>;
-    post(body: any): Promise<any>;
+    post(body: any, req: DataApiRequest): Promise<any>;
 }
 export interface DataApiResponse {
     success(data: any): void;

package/src/data-api.js

@@ -99,7 +99,7 @@ var DataApi = /** @class */ (function () {
                     case 12: return [2 /*return*/, _e.apply(_d, [_h.sent()])];
                     case 13:
                         _g = (_f = res).created;
-                        return [4 /*yield*/, this.post(body)];
+                        return [4 /*yield*/, this.post(body, req)];
                     case 14: return [2 /*return*/, _g.apply(_f, [_h.sent()])];
                     case 15: return [3 /*break*/, 17];
                     case 16:
@@ -146,16 +146,16 @@ var DataApi = /** @class */ (function () {
                                         r = _f.sent();
                                         if (!(r.length == 0)) return [3 /*break*/, 6];
                                         _b = (_a = result).push;
-                                        return [4 /*yield*/, this.post(tslib_1.__assign(tslib_1.__assign({}, item.where), item.set))];
+                                        return [4 /*yield*/, this.post(tslib_1.__assign(tslib_1.__assign({}, item.where), item.set), request)];
                                     case 5:
                                         _b.apply(_a, [_f.sent()]);
                                         return [3 /*break*/, 9];
                                     case 6:
                                         if (!(item.set !== undefined)) return [3 /*break*/, 8];
                                         _d = (_c = result).push;
-                                        return [4 /*yield*/, this.actualUpdate(r[0], item.set)];
+                                        return [4 /*yield*/, this.actualUpdate(r[0], item.set, request)];
                                     case 7:
-                                        _d.apply(_c, [(_f.sent()).toApiJson()]);
+                                        _d.apply(_c, [_f.sent()]);
                                         return [3 /*break*/, 9];
                                     case 8:
                                         result.push(this.repository.getEntityRef(r[0]).toApiJson());
@@ -282,10 +282,9 @@ var DataApi = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 3, , 4]);
                         deleted_1 = 0;
-                        return [4 /*yield*/, this.buildWhere(request, body)];
+                        return [4 /*yield*/, this.prepareWhereForManyOperation(body, request)];
                     case 1:
                         where_1 = _a.sent();
-                        filter_interfaces_js_1.Filter.throwErrorIfFilterIsEmpty(where_1, 'deleteMany');
                         return [4 /*yield*/, (0, context_js_1.doTransaction)(this.remult, function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
                                 var _a, _b, _c, x, e_2_1;
                                 var _d, e_2, _e, _f;
@@ -346,6 +345,24 @@ var DataApi = /** @class */ (function () {
             });
         });
     };
+    DataApi.prototype.prepareWhereForManyOperation = function (body, request) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var where;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        where = undefined;
+                        if (!((body === null || body === void 0 ? void 0 : body.where) !== 'all')) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.buildWhere(request, body)];
+                    case 1:
+                        where = _a.sent();
+                        filter_interfaces_js_1.Filter.throwErrorIfFilterIsEmpty(where, 'deleteMany');
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, where];
+                }
+            });
+        });
+    };
     DataApi.prototype.groupBy = function (request, body) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var findOptions, orderBy, _a, _b, element, direction, group, result;
@@ -762,7 +779,7 @@ var DataApi = /** @class */ (function () {
             return tslib_1.__generator(this, function (_a) {
                 action = request === null || request === void 0 ? void 0 : request.get('__action');
                 if (action == 'emptyId') {
-                    return [2 /*return*/, this.put(response, '', body)];
+                    return [2 /*return*/, this.put(response, request, '', body)];
                 }
                 return [2 /*return*/, this.updateManyImplementation(response, request, {
                         where: undefined,
@@ -779,10 +796,9 @@ var DataApi = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 3, , 4]);
-                        return [4 /*yield*/, this.buildWhere(request, body)];
+                        return [4 /*yield*/, this.prepareWhereForManyOperation(body, request)];
                     case 1:
                         where_2 = _a.sent();
-                        filter_interfaces_js_1.Filter.throwErrorIfFilterIsEmpty(where_2, 'updateMany');
                         return [4 /*yield*/, (0, context_js_1.doTransaction)(this.remult, function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
                                 var updated, _a, _b, _c, x, e_6_1;
                                 var _d, e_6, _e, _f;
@@ -805,7 +821,7 @@ var DataApi = /** @class */ (function () {
                                             _f = _c.value;
                                             _a = false;
                                             x = _f;
-                                            return [4 /*yield*/, this.actualUpdate(x, body.set)];
+                                            return [4 /*yield*/, this.actualUpdate(x, body.set, request)];
                                         case 4:
                                             _g.sent();
                                             updated++;
@@ -846,9 +862,9 @@ var DataApi = /** @class */ (function () {
             });
         });
     };
-    DataApi.prototype.actualUpdate = function (row, body) {
+    DataApi.prototype.actualUpdate = function (row, body, req, doNotSelect) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var ref;
+            var ref, options;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -859,31 +875,32 @@ var DataApi = /** @class */ (function () {
                         if (!ref.apiUpdateAllowed) {
                             throw new server_action_js_1.ForbiddenError();
                         }
-                        return [4 /*yield*/, ref.save()];
+                        options = req.get('_select') === 'none' || doNotSelect
+                            ? { select: 'none' }
+                            : undefined;
+                        return [4 /*yield*/, ref.save(options)];
                     case 2:
                         _a.sent();
-                        return [2 /*return*/, ref];
+                        if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                            return [2 /*return*/, undefined];
+                        return [2 /*return*/, ref.toApiJson()];
                 }
             });
         });
     };
-    DataApi.prototype.put = function (response, id, body) {
+    DataApi.prototype.put = function (response, req, id, body) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var _this = this;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.doOnId(response, id, function (row) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                            var ref;
-                            return tslib_1.__generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this.actualUpdate(row, body)];
-                                    case 1:
-                                        ref = _a.sent();
-                                        response.success(ref.toApiJson());
-                                        return [2 /*return*/];
-                                }
-                            });
-                        }); })];
+                    case 0: return [4 /*yield*/, this.doOnId(response, id, function (row) { return tslib_1.__awaiter(_this, void 0, void 0, function () { var _a, _b; return tslib_1.__generator(this, function (_c) {
+                            switch (_c.label) {
+                                case 0:
+                                    _b = (_a = response).success;
+                                    return [4 /*yield*/, this.actualUpdate(row, body, req)];
+                                case 1: return [2 /*return*/, _b.apply(_a, [_c.sent()])];
+                            }
+                        }); }); })];
                     case 1:
                         _a.sent();
                         return [2 /*return*/];
@@ -930,13 +947,14 @@ var DataApi = /** @class */ (function () {
             });
         });
     };
-    DataApi.prototype.post = function (body) {
+    DataApi.prototype.post = function (body, req) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var insert, result_1;
+            var options, insert, result_1;
             var _this = this;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
+                        options = req.get('_select') === 'none' ? { select: 'none' } : undefined;
                         insert = function (what) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
                             var newr;
                             return tslib_1.__generator(this, function (_a) {
@@ -949,9 +967,11 @@ var DataApi = /** @class */ (function () {
                                         if (!this.repository.getEntityRef(newr).apiInsertAllowed) {
                                             throw new server_action_js_1.ForbiddenError();
                                         }
-                                        return [4 /*yield*/, this.repository.getEntityRef(newr).save()];
+                                        return [4 /*yield*/, this.repository.getEntityRef(newr).save(options)];
                                     case 2:
                                         _a.sent();
+                                        if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                                            return [2 /*return*/, undefined];
                                         return [2 /*return*/, this.repository.getEntityRef(newr).toApiJson()];
                                 }
                             });

package/src/data-interfaces.d.ts

@@ -1,6 +1,6 @@
 import type { FieldMetadata } from '../index.js';
 import type { Filter } from './filter/filter-interfaces.js';
-import type { GroupByOperators, EntityMetadata, MembersOnly } from './remult3/remult3.js';
+import type { GroupByOperators, EntityMetadata, MembersOnly, InsertOrUpdateOptions } from './remult3/remult3.js';
 import { Sort } from './sort.js';
 export interface DataProvider {
     getEntityDataProvider(entity: EntityMetadata): EntityDataProvider;
@@ -28,14 +28,14 @@ export interface EntityDataProvider {
     count(where: Filter): Promise<number>;
     find(options?: EntityDataProviderFindOptions): Promise<Array<any>>;
     groupBy(options?: EntityDataProviderGroupByOptions): Promise<any[]>;
-    update(id: any, data: any): Promise<any>;
+    update(id: any, data: any, options?: InsertOrUpdateOptions): Promise<any>;
     delete(id: any): Promise<void>;
-    insert(data: any): Promise<any>;
+    insert(data: any, options?: InsertOrUpdateOptions): Promise<any>;
 }
 export interface ProxyEntityDataProvider {
-    insertMany(data: any[]): Promise<any[]>;
-    deleteMany(where: Filter): Promise<number>;
-    updateMany(where: Filter, data: any): Promise<number>;
+    insertMany(data: any[], options?: InsertOrUpdateOptions): Promise<any[]>;
+    deleteMany(where: Filter | 'all'): Promise<number>;
+    updateMany(where: Filter | 'all', data: any): Promise<number>;
     query(options: EntityDataProviderFindOptions, aggregateOptions: EntityDataProviderGroupByOptions): Promise<{
         items: any[];
         aggregates: any;

package/src/data-providers/rest-data-provider.d.ts

@@ -2,7 +2,7 @@ import type { DataProvider, EntityDataProvider, EntityDataProviderGroupByOptions
 import { UrlBuilder } from '../../urlBuilder.js';
 import type { ApiClient } from '../context.js';
 import { Filter } from '../filter/filter-interfaces.js';
-import type { EntityMetadata } from '../remult3/remult3.js';
+import type { EntityMetadata, InsertOrUpdateOptions } from '../remult3/remult3.js';
 export declare class RestDataProvider implements DataProvider {
     private apiProvider;
     private entityRequested?;
@@ -33,11 +33,11 @@ export declare class RestEntityDataProvider implements EntityDataProvider, Proxy
         set: any;
     }[]): Promise<any[]>;
     find(options?: EntityDataProviderFindOptions): Promise<Array<any>>;
-    update(id: any, data: any): Promise<any>;
+    update(id: any, data: any, options?: InsertOrUpdateOptions): Promise<any>;
     private toJsonOfIncludedKeys;
     delete(id: any): Promise<void>;
-    insert(data: any): Promise<any>;
-    insertMany(data: any[]): Promise<any[]>;
+    insert(data: any, options?: InsertOrUpdateOptions): Promise<any>;
+    insertMany(data: any[], options?: InsertOrUpdateOptions): Promise<any[]>;
 }
 export declare function addFilterToUrlAndReturnTrueIfSuccessful(filter: any, url: UrlBuilder): boolean;
 export declare const liveQueryAction = "liveQuery-";

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

@@ -287,37 +287,42 @@ var RestEntityDataProvider = /** @class */ (function () {
         var url = new urlBuilder_js_1.UrlBuilder(this.url());
         var filterObject;
         if (options) {
-            if (options.where) {
-                filterObject = options.where.toJson(); //        options.where.__applyToConsumer(new FilterConsumnerBridgeToUrlBuilder(url));
-                if (options.args === undefined)
-                    if (addFilterToUrlAndReturnTrueIfSuccessful(filterObject, url))
-                        filterObject = undefined;
+            if (options.where === 'all') {
+                filterObject = 'all';
             }
-            if (options.orderBy && options.orderBy.Segments) {
-                var sort_1 = '';
-                var order_1 = '';
-                var hasDescending_1 = false;
-                options.orderBy.Segments.forEach(function (c) {
-                    if (sort_1.length > 0) {
-                        sort_1 += ',';
-                        order_1 += ',';
-                    }
-                    sort_1 += c.field.key;
-                    order_1 += c.isDescending ? 'desc' : 'asc';
-                    if (c.isDescending)
-                        hasDescending_1 = true;
-                });
-                if (sort_1)
-                    url.add('_sort', sort_1);
-                if (hasDescending_1)
-                    url.add('_order', order_1);
-            }
-            if (options.limit)
-                url.add('_limit', options.limit);
-            if (options.page)
-                url.add('_page', options.page);
-            if (options.select) {
-                url.add('_select', options.select.join(','));
+            else {
+                if (options.where) {
+                    filterObject = options.where.toJson();
+                    if (options.args === undefined)
+                        if (addFilterToUrlAndReturnTrueIfSuccessful(filterObject, url))
+                            filterObject = undefined;
+                }
+                if (options.orderBy && options.orderBy.Segments) {
+                    var sort_1 = '';
+                    var order_1 = '';
+                    var hasDescending_1 = false;
+                    options.orderBy.Segments.forEach(function (c) {
+                        if (sort_1.length > 0) {
+                            sort_1 += ',';
+                            order_1 += ',';
+                        }
+                        sort_1 += c.field.key;
+                        order_1 += c.isDescending ? 'desc' : 'asc';
+                        if (c.isDescending)
+                            hasDescending_1 = true;
+                    });
+                    if (sort_1)
+                        url.add('_sort', sort_1);
+                    if (hasDescending_1)
+                        url.add('_order', order_1);
+                }
+                if (options.limit)
+                    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) {
@@ -334,7 +339,7 @@ var RestEntityDataProvider = /** @class */ (function () {
                 else
                     body = tslib_1.__assign(tslib_1.__assign({}, body), { where: filterObject });
             }
-            if (options === null || options === void 0 ? void 0 : options.args)
+            if (options && 'args' in options)
                 body.args = options.args;
             if (body && method != 'put')
                 return _this.http().post(u.url, body);
@@ -370,11 +375,17 @@ var RestEntityDataProvider = /** @class */ (function () {
             }); },
         };
     };
-    RestEntityDataProvider.prototype.update = function (id, data) {
+    RestEntityDataProvider.prototype.update = function (id, data, options) {
         var _this = this;
+        var urlArgs = [];
+        if (id == '')
+            urlArgs.push('__action=emptyId');
+        if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+            urlArgs.push('_select=$none');
         return this.http()
             .put(this.url() +
-            (id != '' ? '/' + encodeURIComponent(id) : '?__action=emptyId'), this.toJsonOfIncludedKeys(data))
+            (id != '' ? '/' + encodeURIComponent(id) : '') +
+            (urlArgs.length > 0 ? '?' + urlArgs.join('&') : ''), this.toJsonOfIncludedKeys(data))
             .then(function (y) { return _this.translateFromJson(y); });
     };
     RestEntityDataProvider.prototype.toJsonOfIncludedKeys = function (data) {
@@ -413,16 +424,16 @@ var RestEntityDataProvider = /** @class */ (function () {
             });
         });
     };
-    RestEntityDataProvider.prototype.insert = function (data) {
+    RestEntityDataProvider.prototype.insert = function (data, options) {
         var _this = this;
         return this.http()
-            .post(this.url(), this.translateToJson(data))
+            .post(this.url() + ((options === null || options === void 0 ? void 0 : options.select) === 'none' ? '?_select=$none' : ''), this.translateToJson(data))
             .then(function (y) { return _this.translateFromJson(y); });
     };
-    RestEntityDataProvider.prototype.insertMany = function (data) {
+    RestEntityDataProvider.prototype.insertMany = function (data, options) {
         var _this = this;
         return this.http()
-            .post(this.url(), data.map(function (data) { return _this.translateToJson(data); }))
+            .post(this.url() + ((options === null || options === void 0 ? void 0 : options.select) === 'none' ? '?_select=$none' : ''), data.map(function (data) { return _this.translateToJson(data); }))
             .then(function (y) { return y.map(function (y) { return _this.translateFromJson(y); }); });
     };
     return RestEntityDataProvider;

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

@@ -601,7 +601,7 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
             });
         });
     };
-    ActualSQLEntityDataProvider.prototype.update = function (id, data) {
+    ActualSQLEntityDataProvider.prototype.update = function (id, data, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var e, r, statement, added, _a, _b, x, v, idFilter, f, _c, _d, colKeys, select, returning;
             var e_5, _e;
@@ -651,6 +651,8 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                         returning = true;
                         if (this.sql._getSourceSql().doesNotSupportReturningSyntax)
                             returning = false;
+                        if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                            returning = false;
                         if (returning &&
                             this.sql._getSourceSql().doesNotSupportReturningSyntaxOnlyForUpdate)
                             returning = false;
@@ -660,6 +662,8 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                                 var _a, _b;
                                 (_b = (_a = _this.sql._getSourceSql()).afterMutation) === null || _b === void 0 ? void 0 : _b.call(_a);
                                 if (!returning) {
+                                    if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                                        return undefined;
                                     return getRowAfterUpdate(_this.entity, _this, data, id, 'update');
                                 }
                                 if (sqlResult.rows.length != 1)
@@ -698,7 +702,7 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
             });
         });
     };
-    ActualSQLEntityDataProvider.prototype.insert = function (data) {
+    ActualSQLEntityDataProvider.prototype.insert = function (data, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var e, r, cols, vals, added, _a, _b, x, v, statement, _c, colKeys, select;
             var e_6, _d;
@@ -743,7 +747,8 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                         return [4 /*yield*/, this.buildSelect(e, r, undefined, undefined)];
                     case 2:
                         _c = _e.sent(), colKeys = _c.colKeys, select = _c.select;
-                        if (!this.sql._getSourceSql().doesNotSupportReturningSyntax)
+                        if (!this.sql._getSourceSql().doesNotSupportReturningSyntax &&
+                            !((options === null || options === void 0 ? void 0 : options.select) === 'none'))
                             statement += ' returning ' + select;
                         return [4 /*yield*/, r.execute(statement).then(function (sql) {
                                 var _a, _b;
@@ -754,6 +759,8 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                                         if (typeof id_1 !== 'number')
                                             throw new Error('Auto increment, for a database that is does not support returning syntax, should return an array with the single last added id. Instead it returned: ' +
                                                 JSON.stringify(id_1));
+                                        if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                                            return undefined;
                                         return _this.find({
                                             where: new filter_interfaces_js_1.Filter(function (x) {
                                                 return x.isEqualTo(_this.entity.idMetadata.field, id_1);
@@ -761,9 +768,13 @@ var ActualSQLEntityDataProvider = /** @class */ (function () {
                                         }).then(function (r) { return r[0]; });
                                     }
                                     else {
+                                        if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                                            return undefined;
                                         return getRowAfterUpdate(_this.entity, _this, data, undefined, 'insert');
                                     }
                                 }
+                                if ((options === null || options === void 0 ? void 0 : options.select) === 'none')
+                                    return undefined;
                                 return _this.buildResultRow(colKeys, sql.rows[0], sql);
                             })];
                     case 3: return [2 /*return*/, _e.sent()];

package/src/live-query/SubscriptionChannel.d.ts

@@ -38,18 +38,66 @@ export declare type LiveQueryChange = {
  *
  * @template messageType The type of the message that the channel will handle.
  * @example
+ * ```ts
  * // Defined in code that is shared between the frontend and the backend
- * const statusChange = new SubscriptionChannel<{ oldStatus: number, newStatus: number }>("statusChange");
+ * export const notif = new SubscriptionChannel<{ coolInfo: string }>("notif");
  *
  * // Backend: Publishing a message
- * statusChange.publish({ oldStatus: 1, newStatus: 2 });
+ * notif.publish({ coolInfo: "Message coming from the backend" });
  *
  * // Frontend: Subscribing to messages
- * statusChange.subscribe((message) => {
- *     console.log(`Status changed from ${message.oldStatus} to ${message.newStatus}`);
+ * notif.subscribe((message) => {
+ *     console.log(`Something exciting happened: ${message.coolInfo}`);
  * });
  *
  * // Note: If you want to publish from the frontend, use a BackendMethod for that.
+ * ```
+ *  ---
+ *
+ *  ### Use cases:
+ *
+ *  #### A user _(Paul)_ wants to notify everyone _(Eric & Simona)_
+ *  ```ts
+ *  // shared code between the frontend and the backend
+ *  export const notif = new SubscriptionChannel<{ from: UserInfo, msg: string }>("notif");
+ *
+ *  // Frontend, Paul can call a BackendMethod to send his message
+ *  NotificationContoller.send("Hello everyone!")
+ *
+ *  // Backend
+ *  export class NotificationContoller {
+ *    @BackendMethod({ allowed: true })
+ *    static async send(message: string) {
+ *      notif.publish({ from: remult.user, msg: message });
+ *    }
+ *  }
+ *
+ *  // Frontend: Eric & Simona can subscribe to messages
+ *  notif.subscribe((message) => {
+ *    if (message.from === remult.user) return;
+ *    console.log(`Message from ${message.from.name}: ${message.msg}`);
+ *  });
+ *  ```
+ *
+ *  #### A complexe chart that needs to be updated on multiple changes
+ *  ```ts
+ *  // shared code between the frontend and the backend
+ *  export const chart = new SubscriptionChannel<{ kind: "pie" | "bar" | "line", data: number[] }>("chart");
+ *
+ *  // Entity
+ *  @Entity<Task>("tasks", {
+ *    saved: async (e) => {
+ *      if (e.completed) chart.publish({ kind: "pie", data: [1, 2, 3] });
+ *    }
+ *  })
+ *  export class Task { ... }
+ *
+ *  // Frontend: in the chart component, we can subscribe to messages
+ *  chart.subscribe((message) => {
+ *    chartData = message.data;
+ *  });
+ *  ```
+ *
  */
 export declare class SubscriptionChannel<messageType> {
     channelKey: string;

package/src/live-query/SubscriptionChannel.js

@@ -167,18 +167,66 @@ exports.liveQueryKeepAliveRoute = '_liveQueryKeepAlive';
  *
  * @template messageType The type of the message that the channel will handle.
  * @example
+ * ```ts
  * // Defined in code that is shared between the frontend and the backend
- * const statusChange = new SubscriptionChannel<{ oldStatus: number, newStatus: number }>("statusChange");
+ * export const notif = new SubscriptionChannel<{ coolInfo: string }>("notif");
  *
  * // Backend: Publishing a message
- * statusChange.publish({ oldStatus: 1, newStatus: 2 });
+ * notif.publish({ coolInfo: "Message coming from the backend" });
  *
  * // Frontend: Subscribing to messages
- * statusChange.subscribe((message) => {
- *     console.log(`Status changed from ${message.oldStatus} to ${message.newStatus}`);
+ * notif.subscribe((message) => {
+ *     console.log(`Something exciting happened: ${message.coolInfo}`);
  * });
  *
  * // Note: If you want to publish from the frontend, use a BackendMethod for that.
+ * ```
+ *  ---
+ *
+ *  ### Use cases:
+ *
+ *  #### A user _(Paul)_ wants to notify everyone _(Eric & Simona)_
+ *  ```ts
+ *  // shared code between the frontend and the backend
+ *  export const notif = new SubscriptionChannel<{ from: UserInfo, msg: string }>("notif");
+ *
+ *  // Frontend, Paul can call a BackendMethod to send his message
+ *  NotificationContoller.send("Hello everyone!")
+ *
+ *  // Backend
+ *  export class NotificationContoller {
+ *    @BackendMethod({ allowed: true })
+ *    static async send(message: string) {
+ *      notif.publish({ from: remult.user, msg: message });
+ *    }
+ *  }
+ *
+ *  // Frontend: Eric & Simona can subscribe to messages
+ *  notif.subscribe((message) => {
+ *    if (message.from === remult.user) return;
+ *    console.log(`Message from ${message.from.name}: ${message.msg}`);
+ *  });
+ *  ```
+ *
+ *  #### A complexe chart that needs to be updated on multiple changes
+ *  ```ts
+ *  // shared code between the frontend and the backend
+ *  export const chart = new SubscriptionChannel<{ kind: "pie" | "bar" | "line", data: number[] }>("chart");
+ *
+ *  // Entity
+ *  @Entity<Task>("tasks", {
+ *    saved: async (e) => {
+ *      if (e.completed) chart.publish({ kind: "pie", data: [1, 2, 3] });
+ *    }
+ *  })
+ *  export class Task { ... }
+ *
+ *  // Frontend: in the chart component, we can subscribe to messages
+ *  chart.subscribe((message) => {
+ *    chartData = message.data;
+ *  });
+ *  ```
+ *
  */
 var SubscriptionChannel = /** @class */ (function () {
     /**