remult 0.17.2 → 0.18.0

package/src/data-api.js

@@ -1,30 +1,58 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeError = exports.determineSort = exports.DataApi = void 0;
+exports.getLiveQueryChannel = exports.serializeError = exports.determineSort = exports.DataApi = void 0;
 var tslib_1 = require("tslib");
 var filter_interfaces_1 = require("./filter/filter-interfaces");
+var context_1 = require("./context");
 var filter_interfaces_2 = require("./filter/filter-interfaces");
+var server_action_1 = require("./server-action");
+var getId_1 = require("./remult3/getId");
+var rest_data_provider_1 = require("./data-providers/rest-data-provider");
 var DataApi = /** @class */ (function () {
     function DataApi(repository, remult) {
         this.repository = repository;
         this.remult = remult;
     }
-    DataApi.prototype.httpGet = function (res, req) {
-        if (req.get("__action") == "count") {
-            return this.count(res, req);
-        }
-        else
-            return this.getArray(res, req);
-    };
-    DataApi.prototype.httpPost = function (res, req, body) {
-        switch (req.get("__action")) {
+    DataApi.prototype.httpGet = function (res, req, serializeRequest) {
+        var _a;
+        var action = req === null || req === void 0 ? void 0 : req.get("__action");
+        if (action === null || action === void 0 ? void 0 : action.startsWith(rest_data_provider_1.liveQueryAction))
+            return this.liveQuery(res, req, undefined, serializeRequest, getLiveQueryChannel(action.substring(rest_data_provider_1.liveQueryAction.length), (_a = this.remult.user) === null || _a === void 0 ? void 0 : _a.id));
+        switch (action) {
             case "get":
-                return this.getArray(res, req, body);
             case "count":
-                return this.count(res, req, body);
-            default:
-                return this.post(res, body);
+                return this.count(res, req, undefined);
         }
+        return this.getArray(res, req, undefined);
+    };
+    DataApi.prototype.httpPost = function (res, req, body, serializeRequest) {
+        var _a, _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var action, _c;
+            return tslib_1.__generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        action = req === null || req === void 0 ? void 0 : req.get("__action");
+                        if (action === null || action === void 0 ? void 0 : action.startsWith(rest_data_provider_1.liveQueryAction))
+                            return [2 /*return*/, this.liveQuery(res, req, undefined, serializeRequest, getLiveQueryChannel(action.substring(rest_data_provider_1.liveQueryAction.length), (_a = this.remult.user) === null || _a === void 0 ? void 0 : _a.id))];
+                        _c = action;
+                        switch (_c) {
+                            case "get": return [3 /*break*/, 1];
+                            case "count": return [3 /*break*/, 2];
+                            case "endLiveQuery": return [3 /*break*/, 3];
+                        }
+                        return [3 /*break*/, 5];
+                    case 1: return [2 /*return*/, this.getArray(res, req, body)];
+                    case 2: return [2 /*return*/, this.count(res, req, body)];
+                    case 3: return [4 /*yield*/, this.remult.liveQueryStorage.remove(getLiveQueryChannel(body.id, (_b = this.remult.user) === null || _b === void 0 ? void 0 : _b.id))];
+                    case 4:
+                        _d.sent();
+                        res.success("ok");
+                        return [2 /*return*/];
+                    case 5: return [2 /*return*/, this.post(res, body)];
+                }
+            });
+        });
     };
     DataApi.prototype.get = function (response, id) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
@@ -77,29 +105,34 @@ var DataApi = /** @class */ (function () {
             });
         });
     };
-    DataApi.prototype.getArray = function (response, request, filterBody) {
+    DataApi.prototype.getArrayImpl = function (response, request, filterBody) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var findOptions, _a, hasId_1, w, sort, dir, limit, err_2;
+            var findOptions, _a, sort, dir, limit, hasId_1, w, r;
             var _this = this;
             return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        if (!this.repository.metadata.apiReadAllowed) {
-                            response.forbidden();
-                            return [2 /*return*/];
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 6, , 7]);
                         findOptions = { load: function () { return []; } };
                         _a = findOptions;
                         return [4 /*yield*/, this.buildWhere(request, filterBody)];
-                    case 2:
+                    case 1:
                         _a.where = _b.sent();
-                        if (!this.remult.isAllowed(this.repository.metadata.options.apiRequireId)) return [3 /*break*/, 4];
+                        if (request) {
+                            sort = request.get("_sort");
+                            if (sort != undefined) {
+                                dir = request.get('_order');
+                                findOptions.orderBy = determineSort(sort, dir);
+                            }
+                            limit = +request.get("_limit");
+                            if (!limit && DataApi.defaultGetLimit)
+                                limit = DataApi.defaultGetLimit;
+                            findOptions.limit = limit;
+                            findOptions.page = +request.get("_page");
+                        }
+                        if (!this.remult.isAllowed(this.repository.metadata.options.apiRequireId)) return [3 /*break*/, 3];
                         hasId_1 = false;
                         return [4 /*yield*/, filter_interfaces_2.Filter.fromEntityFilter(this.repository.metadata, findOptions.where)];
-                    case 3:
+                    case 2:
                         w = _b.sent();
                         if (w) {
                             w.__applyToConsumer({
@@ -123,47 +156,97 @@ var DataApi = /** @class */ (function () {
                         }
                         if (!hasId_1) {
                             response.forbidden();
-                            return [2 /*return*/];
+                            throw new server_action_1.ForbiddenError();
                         }
-                        _b.label = 4;
+                        _b.label = 3;
+                    case 3: return [4 /*yield*/, this.repository.find(findOptions)
+                            .then(function (r) { 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*/, Promise.all(r.map(function (y) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
+                                            return [2 /*return*/, this.repository.getEntityRef(y).toApiJson()];
+                                        }); }); }))];
+                                    case 1: return [2 /*return*/, _a.sent()];
+                                }
+                            });
+                        }); })];
                     case 4:
-                        if (request) {
-                            sort = request.get("_sort");
-                            if (sort != undefined) {
-                                dir = request.get('_order');
-                                findOptions.orderBy = determineSort(sort, dir);
-                            }
-                            limit = +request.get("_limit");
-                            if (!limit && DataApi.defaultGetLimit)
-                                limit = DataApi.defaultGetLimit;
-                            findOptions.limit = limit;
-                            findOptions.page = +request.get("_page");
+                        r = _b.sent();
+                        return [2 /*return*/, { r: r, findOptions: findOptions }];
+                }
+            });
+        });
+    };
+    DataApi.prototype.getArray = function (response, request, filterBody) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var r, err_2;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.repository.metadata.apiReadAllowed) {
+                            response.forbidden();
+                            return [2 /*return*/];
                         }
-                        return [4 /*yield*/, this.repository.find(findOptions)
-                                .then(function (r) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                                var _a, _b;
-                                var _this = this;
-                                return tslib_1.__generator(this, function (_c) {
-                                    switch (_c.label) {
-                                        case 0:
-                                            _b = (_a = response).success;
-                                            return [4 /*yield*/, Promise.all(r.map(function (y) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
-                                                    return [2 /*return*/, this.repository.getEntityRef(y).toApiJson()];
-                                                }); }); }))];
-                                        case 1:
-                                            _b.apply(_a, [_c.sent()]);
-                                            return [2 /*return*/];
-                                    }
-                                });
-                            }); })];
-                    case 5:
-                        _b.sent();
-                        return [3 /*break*/, 7];
-                    case 6:
-                        err_2 = _b.sent();
-                        response.error(err_2);
-                        return [3 /*break*/, 7];
-                    case 7: return [2 /*return*/];
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.getArrayImpl(response, request, filterBody)];
+                    case 2:
+                        r = (_a.sent()).r;
+                        response.success(r);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_2 = _a.sent();
+                        if (err_2.isForbiddenError)
+                            response.forbidden();
+                        else
+                            response.error(err_2);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    DataApi.prototype.liveQuery = function (response, request, filterBody, serializeRequest, queryChannel) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var r, data, err_3;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.repository.metadata.apiReadAllowed) {
+                            response.forbidden();
+                            return [2 /*return*/];
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 4, , 5]);
+                        return [4 /*yield*/, this.getArrayImpl(response, request, filterBody)];
+                    case 2:
+                        r = _a.sent();
+                        data = {
+                            requestJson: serializeRequest(),
+                            findOptionsJson: rest_data_provider_1.findOptionsToJson(r.findOptions, this.repository.metadata),
+                            lastIds: r.r.map(function (y) { return getId_1.getId(_this.repository.metadata, y); })
+                        };
+                        return [4 /*yield*/, this.remult.liveQueryStorage.add({
+                                entityKey: this.repository.metadata.key,
+                                id: queryChannel,
+                                data: data
+                            })];
+                    case 3:
+                        _a.sent();
+                        response.success(r.r);
+                        return [3 /*break*/, 5];
+                    case 4:
+                        err_3 = _a.sent();
+                        if (err_3.isForbiddenError)
+                            response.forbidden();
+                        else
+                            response.error(err_3);
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
                 }
             });
         });
@@ -205,7 +288,7 @@ var DataApi = /** @class */ (function () {
     };
     DataApi.prototype.doOnId = function (response, id, what) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var err_3;
+            var err_4;
             var _this = this;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
@@ -237,8 +320,8 @@ var DataApi = /** @class */ (function () {
                         _a.sent();
                         return [3 /*break*/, 3];
                     case 2:
-                        err_3 = _a.sent();
-                        response.error(err_3);
+                        err_4 = _a.sent();
+                        response.error(err_4);
                         return [3 /*break*/, 3];
                     case 3: return [2 /*return*/];
                 }
@@ -263,10 +346,10 @@ var DataApi = /** @class */ (function () {
                                             response.forbidden();
                                             return [2 /*return*/];
                                         }
-                                        return [4 /*yield*/, this.repository.getEntityRef(row).save()];
+                                        return [4 /*yield*/, ref.save()];
                                     case 2:
                                         _a.sent();
-                                        response.success(this.repository.getEntityRef(row).toApiJson());
+                                        response.success(ref.toApiJson());
                                         return [2 /*return*/];
                                 }
                             });
@@ -308,29 +391,87 @@ var DataApi = /** @class */ (function () {
     };
     DataApi.prototype.post = function (response, body) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var newr, err_4;
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
+            var insert_1, result_1, _a, _b, err_5;
+            var _this = this;
+            return tslib_1.__generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        _a.trys.push([0, 3, , 4]);
-                        newr = this.repository.create();
-                        return [4 /*yield*/, this.repository.getEntityRef(newr)._updateEntityBasedOnApi(body)];
+                        _c.trys.push([0, 5, , 6]);
+                        insert_1 = function (what) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                            var newr;
+                            return tslib_1.__generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        newr = this.repository.create();
+                                        return [4 /*yield*/, this.repository.getEntityRef(newr)._updateEntityBasedOnApi(what)];
+                                    case 1:
+                                        _a.sent();
+                                        if (!this.repository.getEntityRef(newr).apiInsertAllowed) {
+                                            throw new server_action_1.ForbiddenError();
+                                        }
+                                        return [4 /*yield*/, this.repository.getEntityRef(newr).save()];
+                                    case 2:
+                                        _a.sent();
+                                        return [2 /*return*/, this.repository.getEntityRef(newr).toApiJson()];
+                                }
+                            });
+                        }); };
+                        if (!Array.isArray(body)) return [3 /*break*/, 2];
+                        result_1 = [];
+                        return [4 /*yield*/, context_1.doTransaction(this.remult, function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                                var body_1, body_1_1, item, _a, _b, e_1_1;
+                                var e_1, _c;
+                                return tslib_1.__generator(this, function (_d) {
+                                    switch (_d.label) {
+                                        case 0:
+                                            _d.trys.push([0, 5, 6, 7]);
+                                            body_1 = tslib_1.__values(body), body_1_1 = body_1.next();
+                                            _d.label = 1;
+                                        case 1:
+                                            if (!!body_1_1.done) return [3 /*break*/, 4];
+                                            item = body_1_1.value;
+                                            _b = (_a = result_1).push;
+                                            return [4 /*yield*/, insert_1(item)];
+                                        case 2:
+                                            _b.apply(_a, [_d.sent()]);
+                                            _d.label = 3;
+                                        case 3:
+                                            body_1_1 = body_1.next();
+                                            return [3 /*break*/, 1];
+                                        case 4: return [3 /*break*/, 7];
+                                        case 5:
+                                            e_1_1 = _d.sent();
+                                            e_1 = { error: e_1_1 };
+                                            return [3 /*break*/, 7];
+                                        case 6:
+                                            try {
+                                                if (body_1_1 && !body_1_1.done && (_c = body_1.return)) _c.call(body_1);
+                                            }
+                                            finally { if (e_1) throw e_1.error; }
+                                            return [7 /*endfinally*/];
+                                        case 7: return [2 /*return*/];
+                                    }
+                                });
+                            }); })];
                     case 1:
-                        _a.sent();
-                        if (!this.repository.getEntityRef(newr).apiInsertAllowed) {
-                            response.forbidden();
-                            return [2 /*return*/];
-                        }
-                        return [4 /*yield*/, this.repository.getEntityRef(newr).save()];
-                    case 2:
-                        _a.sent();
-                        response.created(this.repository.getEntityRef(newr).toApiJson());
+                        _c.sent();
+                        response.created(result_1);
                         return [3 /*break*/, 4];
+                    case 2:
+                        _b = (_a = response).created;
+                        return [4 /*yield*/, insert_1(body)];
                     case 3:
-                        err_4 = _a.sent();
-                        response.error(err_4);
-                        return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/];
+                        _b.apply(_a, [_c.sent()]);
+                        _c.label = 4;
+                    case 4: return [3 /*break*/, 6];
+                    case 5:
+                        err_5 = _c.sent();
+                        if (err_5.isForbiddenError)
+                            response.forbidden();
+                        else
+                            response.error(err_5);
+                        return [3 /*break*/, 6];
+                    case 6: return [2 /*return*/];
                 }
             });
         });
@@ -366,3 +507,7 @@ function serializeError(data) {
     return data;
 }
 exports.serializeError = serializeError;
+function getLiveQueryChannel(queryId, userId) {
+    return "users:" + userId + ":queries:" + queryId;
+}
+exports.getLiveQueryChannel = getLiveQueryChannel;

package/src/data-interfaces.d.ts

@@ -4,7 +4,11 @@ import { EntityMetadata, OmitEB } from './remult3';
 export interface DataProvider {
     getEntityDataProvider(entity: EntityMetadata): EntityDataProvider;
     transaction(action: (dataProvider: DataProvider) => Promise<void>): Promise<void>;
-    supportsCustomFilter?: boolean;
+    supportsRawFilter?: boolean;
+    ensureSchema?(entities: EntityMetadata[]): Promise<void>;
+}
+export interface Storage {
+    ensureSchema(): Promise<void>;
 }
 export interface EntityDataProvider {
     count(where: Filter): Promise<number>;

package/src/data-providers/array-entity-data-provider.d.ts

@@ -4,7 +4,7 @@ import { EntityMetadata, EntityFilter } from '../remult3';
 export declare class ArrayEntityDataProvider implements EntityDataProvider {
     private entity;
     private rows?;
-    static customFilter(filter: CustomArrayFilter): EntityFilter<any>;
+    static rawFilter(filter: CustomArrayFilter): EntityFilter<any>;
     constructor(entity: EntityMetadata, rows?: any[]);
     private verifyThatRowHasAllNotNullColumns;
     count(where?: Filter): Promise<number>;

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

@@ -27,7 +27,7 @@ var ArrayEntityDataProvider = /** @class */ (function () {
             }
         }
     }
-    ArrayEntityDataProvider.customFilter = function (filter) {
+    ArrayEntityDataProvider.rawFilter = function (filter) {
         var _a;
         return _a = {},
             _a[filter_interfaces_1.customDatabaseFilterToken] = {
@@ -102,22 +102,7 @@ var ArrayEntityDataProvider = /** @class */ (function () {
                     }
                     if (options.orderBy) {
                         rows = rows.sort(function (a, b) {
-                            var r = 0;
-                            for (var i = 0; i < options.orderBy.Segments.length; i++) {
-                                var seg = options.orderBy.Segments[i];
-                                var left = a[seg.field.key];
-                                var right = b[seg.field.key];
-                                if (left > right)
-                                    r = 1;
-                                else if (left < right)
-                                    r = -1;
-                                if (r != 0) {
-                                    if (seg.isDescending)
-                                        r *= -1;
-                                    return r;
-                                }
-                            }
-                            return r;
+                            return options.orderBy.compare(a, b);
                         });
                     }
                     rows = pageArray(rows, options);

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

@@ -6,9 +6,9 @@ import { ApiClient } from '../context';
 export declare class RestDataProvider implements DataProvider {
     private apiProvider;
     constructor(apiProvider: () => ApiClient);
-    getEntityDataProvider(entity: EntityMetadata): EntityDataProvider;
+    getEntityDataProvider(entity: EntityMetadata): RestEntityDataProvider;
     transaction(action: (dataProvider: DataProvider) => Promise<void>): Promise<void>;
-    supportsCustomFilter: boolean;
+    supportsRawFilter: boolean;
 }
 export declare class RestEntityDataProvider implements EntityDataProvider {
     private url;
@@ -18,7 +18,7 @@ export declare class RestEntityDataProvider implements EntityDataProvider {
     translateFromJson(row: any): {};
     translateToJson(row: any): {};
     count(where: Filter): Promise<number>;
-    find(options: EntityDataProviderFindOptions): Promise<Array<any>>;
+    find(options?: EntityDataProviderFindOptions): Promise<Array<any>>;
     update(id: any, data: any): Promise<any>;
     delete(id: any): Promise<void>;
     insert(data: any): Promise<any>;
@@ -36,3 +36,4 @@ export declare class RestDataProviderHttpProviderUsingFetch implements RestDataP
     }): Promise<any>;
 }
 export declare function addFilterToUrlAndReturnTrueIfSuccessful(filter: any, url: UrlBuilder): boolean;
+export declare const liveQueryAction = "liveQuery-";