remult 0.18.1-exp.35 → 0.18.1-exp.37

package/README.md

@@ -61,6 +61,7 @@ backend ORM**.
 * :lock: Fine-grained code-based API authorization
 * :relieved: Incrementally adoptable
 * :rocket: Production ready
+* :mega: **NEW - Zero-boilerplate realtime live-queries**
 
 ### Status
 

package/esm/server/expressBridge.d.ts

@@ -6,32 +6,48 @@ import { Repository } from '../src/remult3';
 import { IdEntity } from '../src/id-entity';
 import { LiveQueryStorage, SubscriptionServer } from '../src/live-query/SubscriptionServer';
 export interface RemultServerOptions<RequestType extends GenericRequest> {
-    /** Sets a database connection for Remult.
+    /**Entities to use for the api */
+    entities?: ClassType<any>[];
+    /**Controller to use for the api */
+    controllers?: ClassType<any>[];
+    /** Will be called to get the current user based on the current request */
+    getUser?: (request: RequestType) => Promise<UserInfo | undefined>;
+    /** Will be called for each request and can be used for configuration */
+    initRequest?: (request: RequestType, options: InitRequestOptions) => Promise<void>;
+    /** Will be called once the server is loaded and the data provider is ready */
+    initApi?: (remult: Remult) => void | Promise<void>;
+    /** Data Provider to use for the api.
      *
      * @see [Connecting to a Database](https://remult.dev/docs/databases.html).
     */
     dataProvider?: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);
-    queueStorage?: QueueStorage;
-    liveQueryStorage?: LiveQueryStorage;
-    subscriptionServer?: SubscriptionServer;
-    initRequest?: (request: RequestType, options: InitRequestOptions) => Promise<void>;
-    requestSerializer?: {
-        toJson: (request: RequestType) => any;
-        fromJson: (request: any) => RequestType;
-    };
     /** Will create tables and columns in supporting databases. default: true
      *
      * @description
      * when set to true, it'll create entities that do not exist, and add columns that are missing.
     */
     ensureSchema?: boolean;
-    getUser?: (request: RequestType) => Promise<UserInfo | undefined>;
-    initApi?: (remult: Remult) => void | Promise<void>;
-    logApiEndPoints?: boolean;
-    defaultGetLimit?: number;
-    entities?: ClassType<any>[];
-    controllers?: ClassType<any>[];
+    /** The path to use for the api, default:/api
+     *
+     * @description
+     * If you want to use a different api path adjust this field
+    */
     rootPath?: string;
+    /** The default limit to use for find requests that did not specify a limit */
+    defaultGetLimit?: number;
+    /** When set to true (default) it'll console log each api endpoint that is created */
+    logApiEndPoints?: boolean;
+    /** A subscription server to use for live query and message channels */
+    subscriptionServer?: SubscriptionServer;
+    /** A storage to use to store live queries, relevant mostly for serverless scenarios or larger scales */
+    liveQueryStorage?: LiveQueryStorage;
+    /** Used to store the relevent request info for re running a live query */
+    requestSerializer?: {
+        toJson: (request: RequestType) => any;
+        fromJson: (request: any) => RequestType;
+    };
+    /** Storage to use for backend methods that use queue */
+    queueStorage?: QueueStorage;
 }
 export interface InitRequestOptions {
     liveQueryStorage: LiveQueryStorage;

package/esm/server/index.d.ts

@@ -2,4 +2,5 @@ import { GenericRequest, RemultServer, RemultServerOptions } from './expressBrid
 export { queuedJobInfo, QueueStorage, GenericRequest, GenericRequestHandler, GenericResponse, GenericRouter, RemultServerOptions, SpecificRoute, RemultServer, InitRequestOptions } from './expressBridge';
 export { JsonEntityFileStorage, JsonFileDataProvider } from './JsonEntityFileStorage';
 export { DataProviderLiveQueryStorage } from '../live-query/data-provider-live-query-storage';
+export { SseSubscriptionServer } from '../SseSubscriptionServer';
 export declare function createRemultServer<RequestType extends GenericRequest = GenericRequest>(options?: RemultServerOptions<RequestType>): RemultServer;

package/esm/server/index.js

@@ -2,6 +2,7 @@ import { createRemultServerCore, } from './expressBridge';
 import { initAsyncHooks } from './initAsyncHooks';
 export { JsonEntityFileStorage, JsonFileDataProvider } from './JsonEntityFileStorage';
 export { DataProviderLiveQueryStorage } from '../live-query/data-provider-live-query-storage';
+export { SseSubscriptionServer } from '../SseSubscriptionServer';
 export function createRemultServer(options) {
     initAsyncHooks();
     return createRemultServerCore(options);

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

@@ -305,3 +305,26 @@ class myDummySQLCommand {
         return val.toString();
     }
 }
+async function bulkInsert(array, db) {
+    if (array.length == 0)
+        return;
+    const chunkSize = 250;
+    for (let i = 0; i < array.length; i += chunkSize) {
+        const items = array.slice(i, i + chunkSize);
+        // do whatever
+        const c = db.createCommand();
+        let sql = 'insert into ' +
+            (await items[0]._.metadata.getDbName()) +
+            ' (' +
+            (await Promise.all(items[0]._.metadata.fields.toArray().map((f) => f.getDbName()))).join(',') +
+            ') values ';
+        sql += items
+            .map((row) => '(' +
+            row.$.toArray()
+                .map((f) => c.addParameterAndReturnSqlToken(f.metadata.valueConverter.toDb(f.value)))
+                .join(', ') +
+            ')')
+            .join(',');
+        await c.execute(sql);
+    }
+}

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

@@ -36,6 +36,6 @@ export declare class SubscriptionChannel<messageType> {
     channelKey: string;
     constructor(channelKey: string);
     publish(message: messageType, remult?: Remult): void;
-    subscribe(next: (message: messageType) => void, remult?: Remult): any;
-    subscribe(listener: Partial<SubscriptionListener<messageType>>): any;
+    subscribe(next: (message: messageType) => void, remult?: Remult): Promise<Unsubscribe>;
+    subscribe(listener: Partial<SubscriptionListener<messageType>>): Promise<Unsubscribe>;
 }

package/esm/src/remult3/remult3.d.ts

@@ -115,7 +115,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiUpdateAllowed){
-     *   //Allow user to edit the entity
+     *   // Allow user to edit the entity
      * }
     */
     readonly apiUpdateAllowed: boolean;
@@ -123,7 +123,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiReadAllowed){
-     *   taskRepo.find()
+     *   await taskRepo.find()
      * }
      */
     readonly apiReadAllowed: boolean;
@@ -131,7 +131,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiDeleteAllowed){
-     *   //display delete button
+     *   // display delete button
      * }
     */
     readonly apiDeleteAllowed: boolean;
@@ -139,7 +139,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiInsertAllowed){
-     *   //display insert button
+     *   // display insert button
      * }
     */
     readonly apiInsertAllowed: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.18.1-exp.35",
+    "version": "0.18.1-exp.37",
     "description": "A CRUD framework for full-stack TypeScript",
     "main": "index.js",
     "types": "index.d.ts",

package/server/expressBridge.d.ts

@@ -6,32 +6,48 @@ import { Repository } from '../src/remult3';
 import { IdEntity } from '../src/id-entity';
 import { LiveQueryStorage, SubscriptionServer } from '../src/live-query/SubscriptionServer';
 export interface RemultServerOptions<RequestType extends GenericRequest> {
-    /** Sets a database connection for Remult.
+    /**Entities to use for the api */
+    entities?: ClassType<any>[];
+    /**Controller to use for the api */
+    controllers?: ClassType<any>[];
+    /** Will be called to get the current user based on the current request */
+    getUser?: (request: RequestType) => Promise<UserInfo | undefined>;
+    /** Will be called for each request and can be used for configuration */
+    initRequest?: (request: RequestType, options: InitRequestOptions) => Promise<void>;
+    /** Will be called once the server is loaded and the data provider is ready */
+    initApi?: (remult: Remult) => void | Promise<void>;
+    /** Data Provider to use for the api.
      *
      * @see [Connecting to a Database](https://remult.dev/docs/databases.html).
     */
     dataProvider?: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);
-    queueStorage?: QueueStorage;
-    liveQueryStorage?: LiveQueryStorage;
-    subscriptionServer?: SubscriptionServer;
-    initRequest?: (request: RequestType, options: InitRequestOptions) => Promise<void>;
-    requestSerializer?: {
-        toJson: (request: RequestType) => any;
-        fromJson: (request: any) => RequestType;
-    };
     /** Will create tables and columns in supporting databases. default: true
      *
      * @description
      * when set to true, it'll create entities that do not exist, and add columns that are missing.
     */
     ensureSchema?: boolean;
-    getUser?: (request: RequestType) => Promise<UserInfo | undefined>;
-    initApi?: (remult: Remult) => void | Promise<void>;
-    logApiEndPoints?: boolean;
-    defaultGetLimit?: number;
-    entities?: ClassType<any>[];
-    controllers?: ClassType<any>[];
+    /** The path to use for the api, default:/api
+     *
+     * @description
+     * If you want to use a different api path adjust this field
+    */
     rootPath?: string;
+    /** The default limit to use for find requests that did not specify a limit */
+    defaultGetLimit?: number;
+    /** When set to true (default) it'll console log each api endpoint that is created */
+    logApiEndPoints?: boolean;
+    /** A subscription server to use for live query and message channels */
+    subscriptionServer?: SubscriptionServer;
+    /** A storage to use to store live queries, relevant mostly for serverless scenarios or larger scales */
+    liveQueryStorage?: LiveQueryStorage;
+    /** Used to store the relevent request info for re running a live query */
+    requestSerializer?: {
+        toJson: (request: RequestType) => any;
+        fromJson: (request: any) => RequestType;
+    };
+    /** Storage to use for backend methods that use queue */
+    queueStorage?: QueueStorage;
 }
 export interface InitRequestOptions {
     liveQueryStorage: LiveQueryStorage;

package/server/index.d.ts

@@ -2,4 +2,5 @@ import { GenericRequest, RemultServer, RemultServerOptions } from './expressBrid
 export { queuedJobInfo, QueueStorage, GenericRequest, GenericRequestHandler, GenericResponse, GenericRouter, RemultServerOptions, SpecificRoute, RemultServer, InitRequestOptions } from './expressBridge';
 export { JsonEntityFileStorage, JsonFileDataProvider } from './JsonEntityFileStorage';
 export { DataProviderLiveQueryStorage } from '../live-query/data-provider-live-query-storage';
+export { SseSubscriptionServer } from '../SseSubscriptionServer';
 export declare function createRemultServer<RequestType extends GenericRequest = GenericRequest>(options?: RemultServerOptions<RequestType>): RemultServer;

package/server/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRemultServer = exports.DataProviderLiveQueryStorage = exports.JsonFileDataProvider = exports.JsonEntityFileStorage = void 0;
+exports.createRemultServer = exports.SseSubscriptionServer = exports.DataProviderLiveQueryStorage = exports.JsonFileDataProvider = exports.JsonEntityFileStorage = void 0;
 var expressBridge_1 = require("./expressBridge");
 var initAsyncHooks_1 = require("./initAsyncHooks");
 var JsonEntityFileStorage_1 = require("./JsonEntityFileStorage");
@@ -8,6 +8,8 @@ Object.defineProperty(exports, "JsonEntityFileStorage", { enumerable: true, get:
 Object.defineProperty(exports, "JsonFileDataProvider", { enumerable: true, get: function () { return JsonEntityFileStorage_1.JsonFileDataProvider; } });
 var data_provider_live_query_storage_1 = require("../live-query/data-provider-live-query-storage");
 Object.defineProperty(exports, "DataProviderLiveQueryStorage", { enumerable: true, get: function () { return data_provider_live_query_storage_1.DataProviderLiveQueryStorage; } });
+var SseSubscriptionServer_1 = require("../SseSubscriptionServer");
+Object.defineProperty(exports, "SseSubscriptionServer", { enumerable: true, get: function () { return SseSubscriptionServer_1.SseSubscriptionServer; } });
 function createRemultServer(options) {
     initAsyncHooks_1.initAsyncHooks();
     return expressBridge_1.createRemultServerCore(options);

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

@@ -515,3 +515,64 @@ var myDummySQLCommand = /** @class */ (function () {
     };
     return myDummySQLCommand;
 }());
+function bulkInsert(array, db) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var chunkSize, _loop_2, i;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (array.length == 0)
+                        return [2 /*return*/];
+                    chunkSize = 250;
+                    _loop_2 = function (i) {
+                        var items, c, sql, _a, _b;
+                        return tslib_1.__generator(this, function (_c) {
+                            switch (_c.label) {
+                                case 0:
+                                    items = array.slice(i, i + chunkSize);
+                                    c = db.createCommand();
+                                    _a = 'insert into ';
+                                    return [4 /*yield*/, items[0]._.metadata.getDbName()];
+                                case 1:
+                                    _b = _a +
+                                        (_c.sent()) +
+                                        ' (';
+                                    return [4 /*yield*/, Promise.all(items[0]._.metadata.fields.toArray().map(function (f) { return f.getDbName(); }))];
+                                case 2:
+                                    sql = _b +
+                                        (_c.sent()).join(',') +
+                                        ') values ';
+                                    sql += items
+                                        .map(function (row) {
+                                        return '(' +
+                                            row.$.toArray()
+                                                .map(function (f) {
+                                                return c.addParameterAndReturnSqlToken(f.metadata.valueConverter.toDb(f.value));
+                                            })
+                                                .join(', ') +
+                                            ')';
+                                    })
+                                        .join(',');
+                                    return [4 /*yield*/, c.execute(sql)];
+                                case 3:
+                                    _c.sent();
+                                    return [2 /*return*/];
+                            }
+                        });
+                    };
+                    i = 0;
+                    _a.label = 1;
+                case 1:
+                    if (!(i < array.length)) return [3 /*break*/, 4];
+                    return [5 /*yield**/, _loop_2(i)];
+                case 2:
+                    _a.sent();
+                    _a.label = 3;
+                case 3:
+                    i += chunkSize;
+                    return [3 /*break*/, 1];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}

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

@@ -36,6 +36,6 @@ export declare class SubscriptionChannel<messageType> {
     channelKey: string;
     constructor(channelKey: string);
     publish(message: messageType, remult?: Remult): void;
-    subscribe(next: (message: messageType) => void, remult?: Remult): any;
-    subscribe(listener: Partial<SubscriptionListener<messageType>>): any;
+    subscribe(next: (message: messageType) => void, remult?: Remult): Promise<Unsubscribe>;
+    subscribe(listener: Partial<SubscriptionListener<messageType>>): Promise<Unsubscribe>;
 }

package/src/remult3/remult3.d.ts

@@ -115,7 +115,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiUpdateAllowed){
-     *   //Allow user to edit the entity
+     *   // Allow user to edit the entity
      * }
     */
     readonly apiUpdateAllowed: boolean;
@@ -123,7 +123,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiReadAllowed){
-     *   taskRepo.find()
+     *   await taskRepo.find()
      * }
      */
     readonly apiReadAllowed: boolean;
@@ -131,7 +131,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiDeleteAllowed){
-     *   //display delete button
+     *   // display delete button
      * }
     */
     readonly apiDeleteAllowed: boolean;
@@ -139,7 +139,7 @@ export interface EntityMetadata<entityType = any> {
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiInsertAllowed){
-     *   //display insert button
+     *   // display insert button
      * }
     */
     readonly apiInsertAllowed: boolean;

package/esm/live-query/ably.d.ts

@@ -1,13 +0,0 @@
-import type * as Ably from 'ably';
-import type { SubscriptionServer } from '../src/live-query/SubscriptionServer';
-import type { SubscriptionClient, SubscriptionClientConnection } from '../src/live-query/SubscriptionChannel';
-export declare class AblySubscriptionClient implements SubscriptionClient {
-    private ably;
-    constructor(ably: Ably.Types.RealtimePromise);
-    openConnection(onReconnect: VoidFunction): Promise<SubscriptionClientConnection>;
-}
-export declare class AblySubscriptionServer implements SubscriptionServer {
-    private ably;
-    constructor(ably: Ably.Types.RestPromise);
-    publishMessage<T>(channel: string, message: T): Promise<void>;
-}

package/esm/live-query/ably.js

@@ -1,28 +0,0 @@
-export class AblySubscriptionClient {
-    constructor(ably) {
-        this.ably = ably;
-    }
-    async openConnection(onReconnect) {
-        return {
-            close: () => {
-                // Since we did not open the connection, we do not close it
-            },
-            subscribe: async (channel, handler) => {
-                let myHandler = (y) => handler(y.data);
-                await this.ably.channels.get(channel).subscribe(y => myHandler(y));
-                return () => {
-                    myHandler = () => { };
-                    this.ably.channels.get(channel).unsubscribe();
-                };
-            }
-        };
-    }
-}
-export class AblySubscriptionServer {
-    constructor(ably) {
-        this.ably = ably;
-    }
-    async publishMessage(channel, message) {
-        await this.ably.channels.get(channel).publish({ data: message });
-    }
-}

package/live-query/ably.d.ts

@@ -1,13 +0,0 @@
-import type * as Ably from 'ably';
-import type { SubscriptionServer } from '../src/live-query/SubscriptionServer';
-import type { SubscriptionClient, SubscriptionClientConnection } from '../src/live-query/SubscriptionChannel';
-export declare class AblySubscriptionClient implements SubscriptionClient {
-    private ably;
-    constructor(ably: Ably.Types.RealtimePromise);
-    openConnection(onReconnect: VoidFunction): Promise<SubscriptionClientConnection>;
-}
-export declare class AblySubscriptionServer implements SubscriptionServer {
-    private ably;
-    constructor(ably: Ably.Types.RestPromise);
-    publishMessage<T>(channel: string, message: T): Promise<void>;
-}

package/live-query/ably.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AblySubscriptionServer = exports.AblySubscriptionClient = void 0;
-var tslib_1 = require("tslib");
-var AblySubscriptionClient = /** @class */ (function () {
-    function AblySubscriptionClient(ably) {
-        this.ably = ably;
-    }
-    AblySubscriptionClient.prototype.openConnection = function (onReconnect) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _this = this;
-            return tslib_1.__generator(this, function (_a) {
-                return [2 /*return*/, {
-                        close: function () {
-                            // Since we did not open the connection, we do not close it
-                        },
-                        subscribe: function (channel, handler) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                            var myHandler;
-                            var _this = this;
-                            return tslib_1.__generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0:
-                                        myHandler = function (y) { return handler(y.data); };
-                                        return [4 /*yield*/, this.ably.channels.get(channel).subscribe(function (y) { return myHandler(y); })];
-                                    case 1:
-                                        _a.sent();
-                                        return [2 /*return*/, function () {
-                                                myHandler = function () { };
-                                                _this.ably.channels.get(channel).unsubscribe();
-                                            }];
-                                }
-                            });
-                        }); }
-                    }];
-            });
-        });
-    };
-    return AblySubscriptionClient;
-}());
-exports.AblySubscriptionClient = AblySubscriptionClient;
-var AblySubscriptionServer = /** @class */ (function () {
-    function AblySubscriptionServer(ably) {
-        this.ably = ably;
-    }
-    AblySubscriptionServer.prototype.publishMessage = function (channel, message) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.ably.channels.get(channel).publish({ data: message })];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    return AblySubscriptionServer;
-}());
-exports.AblySubscriptionServer = AblySubscriptionServer;