@botonic/core 0.19.0-beta.1 → 0.20.1

package/lib/esm/data-provider/local-data-provider.js

@@ -0,0 +1,133 @@
+import { JsonDB } from 'node-json-db';
+import { Config } from 'node-json-db/dist/lib/JsonDBConfig';
+export class LocalDevDataProvider {
+    constructor(url) {
+        this.DB_PATH = 'tmp/localDb';
+        this.SEPARATOR = '/';
+        this.paths = {
+            USERS: '/users',
+            EVENTS: '/events',
+            CONNECTIONS: '/connections',
+        };
+        const dbPath = url ? url.split('://')[1] : this.DB_PATH;
+        this.db = new JsonDB(new Config(dbPath, true, false, this.SEPARATOR));
+    }
+    getUsers(limit = 10, offset = 0) {
+        const path = this.paths.USERS;
+        this.db.reload();
+        const userList = this.db.getObject(path);
+        const users = Object.values(userList);
+        const to = limit !== 0 ? offset + limit : undefined;
+        return users.slice(offset, to);
+    }
+    getUser(userId) {
+        const path = this.createPath([this.paths.USERS, userId]);
+        this.db.reload();
+        return this.db.exists(path) ? this.db.getObject(path) : undefined;
+    }
+    getUserByWebsocketId(websocketId) {
+        return this.getUserByField('websocketId', websocketId);
+    }
+    getUserByField(field, value) {
+        const path = this.paths.USERS;
+        this.db.reload();
+        const dbUser = this.db.exists(path)
+            ? this.db.find(path, (user) => user[field] === value)
+            : undefined;
+        return dbUser;
+    }
+    saveUser(user) {
+        const path = this.createPath([this.paths.USERS, user.id]);
+        this.db.reload();
+        if (!this.db.exists(path)) {
+            this.db.push(path, user);
+        }
+        return user;
+    }
+    updateUser(user) {
+        const path = this.createPath([this.paths.USERS, user.id]);
+        this.db.reload();
+        if (this.db.exists(path)) {
+            this.db.push(path, user, true);
+        }
+        return user;
+    }
+    deleteUser(id) {
+        const path = this.createPath([this.paths.USERS, id]);
+        this.db.reload();
+        const user = this.db.exists(path)
+            ? this.db.getObject(path)
+            : undefined;
+        if (user) {
+            this.db.delete(path);
+            return user;
+        }
+        return undefined;
+    }
+    getEvents(limit = 10, offset = 0) {
+        const path = this.paths.EVENTS;
+        this.db.reload();
+        const eventList = this.db.getObject(path);
+        const events = Object.values(eventList);
+        const to = limit !== 0 ? offset + limit : undefined;
+        return events.slice(offset, to);
+    }
+    getEvent(id) {
+        const path = this.createPath([this.paths.EVENTS, id]);
+        this.db.reload();
+        return this.db.exists(path)
+            ? this.db.getObject(path)
+            : undefined;
+    }
+    saveEvent(event) {
+        const path = this.createPath([this.paths.EVENTS, event.eventId]);
+        this.db.reload();
+        if (!this.db.exists(path)) {
+            this.db.push(path, event);
+        }
+        return event;
+    }
+    updateEvent(event) {
+        const path = this.createPath([this.paths.EVENTS, event.eventId]);
+        this.db.reload();
+        if (this.db.exists(path)) {
+            this.db.push(path, event, true);
+        }
+        return event;
+    }
+    deleteEvent(id) {
+        const path = this.createPath([this.paths.EVENTS, id]);
+        this.db.reload();
+        const event = this.db.exists(path)
+            ? this.db.getObject(path)
+            : undefined;
+        if (event) {
+            this.db.delete(path);
+            return event;
+        }
+        return undefined;
+    }
+    addConnection(websocketId) {
+        const path = this.createPath([this.paths.CONNECTIONS, websocketId]);
+        this.db.reload();
+        if (!this.db.exists(path)) {
+            this.db.push(path, '', false);
+        }
+    }
+    updateConnection(websocketId, userId) {
+        const path = this.createPath([this.paths.CONNECTIONS, websocketId]);
+        this.db.reload();
+        if (this.db.exists(path)) {
+            this.db.push(path, userId, true);
+        }
+    }
+    deleteConnection(websocketId) {
+        const path = this.createPath([this.paths.CONNECTIONS, websocketId]);
+        this.db.reload();
+        this.db.delete(path);
+    }
+    createPath(urlChunks) {
+        return urlChunks.join(this.SEPARATOR);
+    }
+}
+//# sourceMappingURL=local-data-provider.js.map

package/lib/esm/data-provider/local-data-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-data-provider.js","sourceRoot":"","sources":["../../../src/data-provider/local-data-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAA;AAK3D,MAAM,OAAO,oBAAoB;IAU/B,YAAY,GAAY;QATP,YAAO,GAAG,aAAa,CAAA;QACvB,cAAS,GAAG,GAAG,CAAA;QACf,UAAK,GAAG;YACvB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,cAAc;SAC5B,CAAA;QAIC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAA;QACvD,IAAI,CAAC,EAAE,GAAG,IAAI,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;IACvE,CAAC;IAED,QAAQ,CAAC,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAA;QAC7B,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC,SAAS,CAAuB,IAAI,CAAC,CAAA;QAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,EAAE,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;QACnD,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAChC,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAO,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACzE,CAAC;IAED,oBAAoB,CAAC,WAAmB;QACtC,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED,cAAc,CAAC,KAAa,EAAE,KAAU;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAA;QAC7B,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;YACjC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAO,IAAI,EAAE,CAAC,IAAU,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;YACjE,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,CAAA;IACf,CAAC;IAED,QAAQ,CAAC,IAAU;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACzD,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;SACzB;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,UAAU,CAAC,IAAU;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACzD,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACxB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;SAC/B;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,UAAU,CAAC,EAAU;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;YAC/B,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAO,IAAI,CAAC;YAC/B,CAAC,CAAC,SAAS,CAAA;QACb,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACpB,OAAO,IAAI,CAAA;SACZ;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,SAAS,CAAC,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;QAC9B,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,SAAS,CAA+B,IAAI,CAAC,CAAA;QACvE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACvC,MAAM,EAAE,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;QACnD,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,QAAQ,CAAC,EAAU;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;QACrD,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;YACzB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAe,IAAI,CAAC;YACvC,CAAC,CAAC,SAAS,CAAA;IACf,CAAC;IAED,SAAS,CAAC,KAAmB;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;SAC1B;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,WAAW,CAAC,KAAmB;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;QAChE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACxB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;SAChC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,WAAW,CAAC,EAAU;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAA;QACrD,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;YAChC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAe,IAAI,CAAC;YACvC,CAAC,CAAC,SAAS,CAAA;QACb,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACpB,OAAO,KAAK,CAAA;SACb;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,aAAa,CAAC,WAAmB;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAA;QACnE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;SAC9B;IACH,CAAC;IAED,gBAAgB,CAAC,WAAmB,EAAE,MAAc;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAA;QACnE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YACxB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;SACjC;IACH,CAAC;IAED,gBAAgB,CAAC,WAAmB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAA;QACnE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAA;QAChB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtB,CAAC;IAEO,UAAU,CAAC,SAAmB;QACpC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACvC,CAAC;CACF"}

package/lib/esm/debug/index.d.ts

@@ -0,0 +1 @@
+export * from './inspector';

package/lib/esm/debug/index.js

@@ -0,0 +1,2 @@
+export * from './inspector';
+//# sourceMappingURL=index.js.map

package/lib/esm/debug/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/debug/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA"}

package/lib/esm/debug/inspector.d.ts

@@ -0,0 +1,24 @@
+import { Route, RouteMatcher } from '../models';
+export declare class RouteInspector {
+    routeMatched(_route: Route, _routeKey: string, _routeValue: RouteMatcher, _input: any): void;
+    routeNotMatched(_route: Route, _routeKey: string, _routeValue: RouteMatcher, _input: any): void;
+}
+export declare class FocusRouteInspector extends RouteInspector {
+    focusRoutePaths: string[] | null;
+    focusOnMatches: boolean;
+    constructor();
+    focusOnlyOnRoutes(focusRoutePaths: string[]): this;
+    focusOnlyOnMatches(): this;
+    _isOnFocus(route: Route): boolean;
+}
+export declare class LogRouteInspector extends FocusRouteInspector {
+    routeMatched(route: Route, routeKey: string, routeValue: RouteMatcher, inputValue: string): void;
+    routeNotMatched(route: Route, routeKey: string, routeValue: RouteMatcher, inputValue: string): void;
+    _routeName(obj: Route): string;
+    _log(message: string, ...optionalParams: string[]): void;
+}
+export declare class Inspector {
+    routeInspector: RouteInspector;
+    constructor(routeInspector?: RouteInspector | undefined);
+    getRouteInspector(): RouteInspector;
+}

package/lib/esm/debug/inspector.js

@@ -0,0 +1,65 @@
+export class RouteInspector {
+    routeMatched(_route, _routeKey, _routeValue, _input) { }
+    routeNotMatched(_route, _routeKey, _routeValue, _input) { }
+}
+export class FocusRouteInspector extends RouteInspector {
+    constructor() {
+        super();
+        this.focusRoutePaths = null;
+        this.focusOnMatches = false;
+    }
+    focusOnlyOnRoutes(focusRoutePaths) {
+        this.focusRoutePaths = focusRoutePaths;
+        return this;
+    }
+    focusOnlyOnMatches() {
+        this.focusOnMatches = true;
+        return this;
+    }
+    _isOnFocus(route) {
+        if (this.focusRoutePaths === null) {
+            return true;
+        }
+        // @ts-ignore
+        return this.focusRoutePaths.includes(route.path);
+    }
+}
+export class LogRouteInspector extends FocusRouteInspector {
+    routeMatched(route, routeKey, routeValue, inputValue) {
+        if (!this._isOnFocus(route)) {
+            return;
+        }
+        this._log(`Route ${this._routeName(route)} selected ` +
+            `because Input.${routeKey} (${inputValue}) matched '${routeValue}'`);
+    }
+    // @ts-ignore
+    routeNotMatched(route, routeKey, routeValue, inputValue) {
+        if (!this._isOnFocus(route) || this.focusOnMatches) {
+            return;
+        }
+        this._log(`Route ${this._routeName(route)} not selected ` +
+            `because Input.${routeKey} (${inputValue}) did not match '${routeValue}'`);
+    }
+    _routeName(obj) {
+        let name = obj.path || '<<no path defined>>';
+        if (obj.action) {
+            name = `'${name}' (to action '${obj.action.name}')`;
+        }
+        if (obj.redirect) {
+            name = `'${name}' (with redirect to '${obj.redirect}')`;
+        }
+        return name;
+    }
+    _log(message, ...optionalParams) {
+        console.log(message, ...optionalParams);
+    }
+}
+export class Inspector {
+    constructor(routeInspector = undefined) {
+        this.routeInspector = routeInspector || new RouteInspector();
+    }
+    getRouteInspector() {
+        return this.routeInspector;
+    }
+}
+//# sourceMappingURL=inspector.js.map

package/lib/esm/debug/inspector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspector.js","sourceRoot":"","sources":["../../../src/debug/inspector.ts"],"names":[],"mappings":"AACA,MAAM,OAAO,cAAc;IACzB,YAAY,CACV,MAAa,EACb,SAAiB,EACjB,WAAyB,EACzB,MAAW,IACJ,CAAC;IACV,eAAe,CACb,MAAa,EACb,SAAiB,EACjB,WAAyB,EACzB,MAAW,IACJ,CAAC;CACX;AAED,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IAGrD;QACE,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,eAAe,GAAG,IAAI,CAAA;QAC3B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAA;IAC7B,CAAC;IAED,iBAAiB,CAAC,eAAyB;QACzC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,kBAAkB;QAChB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;QAC1B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,UAAU,CAAC,KAAY;QACrB,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE;YACjC,OAAO,IAAI,CAAA;SACZ;QACD,aAAa;QACb,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,mBAAmB;IACxD,YAAY,CACV,KAAY,EACZ,QAAgB,EAChB,UAAwB,EACxB,UAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAM;SACP;QACD,IAAI,CAAC,IAAI,CACP,SAAS,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY;YACzC,iBAAiB,QAAQ,KAAK,UAAU,cAAc,UAAU,GAAG,CACtE,CAAA;IACH,CAAC;IAED,aAAa;IACb,eAAe,CACb,KAAY,EACZ,QAAgB,EAChB,UAAwB,EACxB,UAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE;YAClD,OAAM;SACP;QACD,IAAI,CAAC,IAAI,CACP,SAAS,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,gBAAgB;YAC7C,iBAAiB,QAAQ,KAAK,UAAU,oBAAoB,UAAU,GAAG,CAC5E,CAAA;IACH,CAAC;IAED,UAAU,CAAC,GAAU;QACnB,IAAI,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,qBAAqB,CAAA;QAC5C,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,IAAI,GAAG,IAAI,IAAI,iBAAiB,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,CAAA;SACpD;QACD,IAAI,GAAG,CAAC,QAAQ,EAAE;YAChB,IAAI,GAAG,IAAI,IAAI,wBAAwB,GAAG,CAAC,QAAQ,IAAI,CAAA;SACxD;QACD,OAAO,IAAc,CAAA;IACvB,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,cAAwB;QAC/C,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;IACzC,CAAC;CACF;AAED,MAAM,OAAO,SAAS;IAEpB,YAAY,iBAA6C,SAAS;QAChE,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI,IAAI,cAAc,EAAE,CAAA;IAC9D,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,cAAc,CAAA;IAC5B,CAAC;CACF"}

package/lib/esm/handoff.d.ts

@@ -0,0 +1,67 @@
+import { Session } from './models';
+export interface HubtypeAgentsInfo {
+    attending_count: number;
+    email: string;
+    idle_count: number;
+    last_message_sent: string;
+    status: string;
+}
+export interface HubtypeSession extends Session {
+    _hubtype_api?: string;
+    _access_token: string;
+}
+export interface SessionWithBotonicAction extends Session {
+    _botonic_action: string;
+}
+export interface BackendContext {
+    timeoutMs: number;
+}
+export interface VacationRange {
+    end_date: number;
+    id: number;
+    start_date: number;
+}
+export declare function getOpenQueues(session: HubtypeSession, context?: {}): Promise<{
+    queues: string[];
+}>;
+export declare class HandOffBuilder {
+    _session: SessionWithBotonicAction;
+    _queue: string;
+    _onFinish: string;
+    _email: string;
+    _agentId: string;
+    _note: string;
+    _caseInfo: string;
+    _shadowing: boolean;
+    constructor(session: SessionWithBotonicAction);
+    withQueue(queueNameOrId: string): this;
+    withOnFinishPayload(payload: string): this;
+    withOnFinishPath(path: string): this;
+    withAgentEmail(email: string): this;
+    withAgentId(agentId: string): this;
+    withNote(note: string): this;
+    withCaseInfo(caseInfo: string): this;
+    withShadowing(shadowing?: boolean): this;
+    handOff(): Promise<void>;
+}
+/**
+ * @deprecated use {@link HandOffBuilder} class instead
+ */
+export declare function humanHandOff(session: any, queueNameOrId: string | undefined, onFinish: any): Promise<void>;
+export declare function storeCaseRating(session: HubtypeSession, rating: number, context?: any): Promise<{
+    status: string;
+}>;
+export declare function getAvailableAgentsByQueue(session: HubtypeSession, queueId: string): Promise<{
+    agents: string[];
+}>;
+export declare function getAvailableAgents(session: HubtypeSession): Promise<{
+    agents: HubtypeAgentsInfo[];
+}>;
+export declare function getAgentVacationRanges(session: HubtypeSession, { agentId, agentEmail }: {
+    agentId?: string;
+    agentEmail?: string;
+}): Promise<{
+    vacation_ranges: VacationRange[];
+}>;
+export declare function cancelHandoff(session: SessionWithBotonicAction, typification?: string | null): void;
+export declare function deleteUser(session: SessionWithBotonicAction): void;

package/lib/esm/handoff.js

@@ -0,0 +1,171 @@
+import axios from 'axios';
+import { PATH_PAYLOAD_IDENTIFIER } from './constants';
+const HUBTYPE_API_URL = 'https://api.hubtype.com';
+function contextDefaults(context) {
+    return {
+        timeoutMs: context.timeoutMs || 10000,
+    };
+}
+export async function getOpenQueues(session, context = {}) {
+    //be aware of https://github.com/axios/axios/issues/1543
+    const baseUrl = session._hubtype_api || HUBTYPE_API_URL;
+    const endpointUrl = `${baseUrl}/v1/queues/get_open_queues/`;
+    context = contextDefaults(context);
+    const resp = await axios({
+        headers: {
+            Authorization: `Bearer ${session._access_token}`,
+        },
+        method: 'post',
+        url: endpointUrl,
+        data: { bot_id: session.bot.id },
+        timeout: context.timeoutMs,
+    });
+    return resp.data;
+}
+export class HandOffBuilder {
+    constructor(session) {
+        this._session = session;
+    }
+    withQueue(queueNameOrId) {
+        this._queue = queueNameOrId;
+        return this;
+    }
+    withOnFinishPayload(payload) {
+        this._onFinish = payload;
+        return this;
+    }
+    withOnFinishPath(path) {
+        this._onFinish = `${PATH_PAYLOAD_IDENTIFIER}${path}`;
+        return this;
+    }
+    withAgentEmail(email) {
+        this._email = email;
+        return this;
+    }
+    withAgentId(agentId) {
+        this._agentId = agentId;
+        return this;
+    }
+    withNote(note) {
+        this._note = note;
+        return this;
+    }
+    withCaseInfo(caseInfo) {
+        this._caseInfo = caseInfo;
+        return this;
+    }
+    withShadowing(shadowing = true) {
+        this._shadowing = shadowing;
+        return this;
+    }
+    async handOff() {
+        return _humanHandOff(this._session, this._queue, this._onFinish, this._email, this._agentId, this._caseInfo, this._note, this._shadowing);
+    }
+}
+/**
+ * @deprecated use {@link HandOffBuilder} class instead
+ */
+export async function humanHandOff(session, queueNameOrId = '', onFinish) {
+    const builder = new HandOffBuilder(session);
+    if (queueNameOrId) {
+        builder.withQueue(queueNameOrId);
+    }
+    if (onFinish) {
+        if (onFinish.path) {
+            builder.withOnFinishPath(onFinish.path);
+        }
+        else if (onFinish.payload) {
+            builder.withOnFinishPayload(onFinish.payload);
+        }
+        else {
+            throw new Error('onFinish requires payload or path field');
+        }
+    }
+    return builder.handOff();
+}
+async function _humanHandOff(session, queueNameOrId = '', onFinish, agentEmail = '', agentId = '', caseInfo = '', note = '', shadowing = false) {
+    const params = {};
+    if (queueNameOrId) {
+        params.queue = queueNameOrId;
+    }
+    if (agentEmail) {
+        params.agent_email = agentEmail;
+    }
+    if (agentId) {
+        params.agent_id = agentId;
+    }
+    if (caseInfo) {
+        params.case_info = caseInfo;
+    }
+    if (note) {
+        params.note = note;
+    }
+    if (shadowing) {
+        params.shadowing = shadowing;
+    }
+    if (onFinish) {
+        params.on_finish = onFinish;
+    }
+    session._botonic_action = `create_case:${JSON.stringify(params)}`;
+}
+export async function storeCaseRating(session, rating, context = {}) {
+    const baseUrl = session._hubtype_api || HUBTYPE_API_URL;
+    const chatId = session.user.id;
+    context = contextDefaults(context);
+    const resp = await axios({
+        headers: {
+            Authorization: `Bearer ${session._access_token}`,
+        },
+        method: 'post',
+        url: `${baseUrl}/v1/chats/${chatId}/store_case_rating/`,
+        data: { chat_id: chatId, rating },
+        timeout: context.timeoutMs,
+    });
+    return resp.data;
+}
+export async function getAvailableAgentsByQueue(session, queueId) {
+    const baseUrl = session._hubtype_api || HUBTYPE_API_URL;
+    const resp = await axios({
+        headers: {
+            Authorization: `Bearer ${session._access_token}`,
+        },
+        method: 'post',
+        url: `${baseUrl}/v1/queues/${queueId}/get_available_agents/`,
+    });
+    return resp.data;
+}
+export async function getAvailableAgents(session) {
+    const baseUrl = session._hubtype_api || HUBTYPE_API_URL;
+    const botId = session.bot.id;
+    const resp = await axios({
+        headers: {
+            Authorization: `Bearer ${session._access_token}`,
+        },
+        method: 'post',
+        url: `${baseUrl}/v1/bots/${botId}/get_agents/`,
+    });
+    return resp.data;
+}
+export async function getAgentVacationRanges(session, { agentId, agentEmail }) {
+    const baseUrl = session._hubtype_api || HUBTYPE_API_URL;
+    const botId = session.bot.id;
+    const resp = await axios({
+        headers: {
+            Authorization: `Bearer ${session._access_token}`,
+        },
+        method: 'get',
+        url: `${baseUrl}/v1/bots/${botId}/get_agent_vacation_ranges/`,
+        params: { agent_id: agentId, agent_email: agentEmail },
+    });
+    return resp.data;
+}
+export function cancelHandoff(session, typification = null) {
+    let action = 'discard_case';
+    if (typification)
+        action = `${action}:${JSON.stringify({ typification })}`;
+    session._botonic_action = action;
+}
+export function deleteUser(session) {
+    session._botonic_action = `delete_user`;
+}
+//# sourceMappingURL=handoff.js.map

package/lib/esm/handoff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handoff.js","sourceRoot":"","sources":["../../src/handoff.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGrD,MAAM,eAAe,GAAG,yBAAyB,CAAA;AA2BjD,SAAS,eAAe,CAAC,OAAY;IACnC,OAAO;QACL,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;KACtC,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,OAAuB,EACvB,OAAO,GAAG,EAAE;IAEZ,wDAAwD;IACxD,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,IAAI,eAAe,CAAA;IACvD,MAAM,WAAW,GAAG,GAAG,OAAO,6BAA6B,CAAA;IAC3D,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;IAClC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC;QACvB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,aAAa,EAAE;SACjD;QACD,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,WAAW;QAChB,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE;QAChC,OAAO,EAAG,OAA0B,CAAC,SAAS;KAC/C,CAAC,CAAA;IACF,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC;AAED,MAAM,OAAO,cAAc;IAUzB,YAAY,OAAiC;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED,SAAS,CAAC,aAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAA;QACxB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,gBAAgB,CAAC,IAAY;QAC3B,IAAI,CAAC,SAAS,GAAG,GAAG,uBAAuB,GAAG,IAAI,EAAE,CAAA;QACpD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,cAAc,CAAC,KAAa;QAC1B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,WAAW,CAAC,OAAe;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,YAAY,CAAC,QAAgB;QAC3B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,aAAa,CAAC,SAAS,GAAG,IAAI;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,OAAO;QACX,OAAO,aAAa,CAClB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,CAChB,CAAA;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,EAAE,EAAE,QAAQ;IACtE,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,aAAa,EAAE;QACjB,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;KACjC;IACD,IAAI,QAAQ,EAAE;QACZ,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;SACxC;aAAM,IAAI,QAAQ,CAAC,OAAO,EAAE;YAC3B,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;SAC9C;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;KACF;IACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;AAC1B,CAAC;AAWD,KAAK,UAAU,aAAa,CAC1B,OAAiC,EACjC,aAAa,GAAG,EAAE,EAClB,QAAgB,EAChB,UAAU,GAAG,EAAE,EACf,OAAO,GAAG,EAAE,EACZ,QAAQ,GAAG,EAAE,EACb,IAAI,GAAG,EAAE,EACT,SAAS,GAAG,KAAK;IAEjB,MAAM,MAAM,GAAyB,EAAE,CAAA;IACvC,IAAI,aAAa,EAAE;QACjB,MAAM,CAAC,KAAK,GAAG,aAAa,CAAA;KAC7B;IACD,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,WAAW,GAAG,UAAU,CAAA;KAChC;IACD,IAAI,OAAO,EAAE;QACX,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAA;KAC1B;IACD,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAA;KAC5B;IACD,IAAI,IAAI,EAAE;QACR,MAAM,CAAC,IAAI,GAAG,IAAI,CAAA;KACnB;IACD,IAAI,SAAS,EAAE;QACb,MAAM,CAAC,SAAS,GAAG,SAAS,CAAA;KAC7B;IACD,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAA;KAC5B;IACD,OAAO,CAAC,eAAe,GAAG,eAAe,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAA;AACnE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAuB,EACvB,MAAc,EACd,UAAe,EAAE;IAEjB,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,IAAI,eAAe,CAAA;IACvD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IAC9B,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;IAClC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC;QACvB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,aAAa,EAAE;SACjD;QACD,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,GAAG,OAAO,aAAa,MAAM,qBAAqB;QACvD,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE;QACjC,OAAO,EAAG,OAA0B,CAAC,SAAS;KAC/C,CAAC,CAAA;IACF,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,OAAuB,EACvB,OAAe;IAEf,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,IAAI,eAAe,CAAA;IACvD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC;QACvB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,aAAa,EAAE;SACjD;QACD,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,GAAG,OAAO,cAAc,OAAO,wBAAwB;KAC7D,CAAC,CAAA;IACF,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,OAAuB;IAEvB,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,IAAI,eAAe,CAAA;IACvD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAA;IAC5B,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC;QACvB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,aAAa,EAAE;SACjD;QACD,MAAM,EAAE,MAAM;QACd,GAAG,EAAE,GAAG,OAAO,YAAY,KAAK,cAAc;KAC/C,CAAC,CAAA;IACF,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAuB,EACvB,EAAE,OAAO,EAAE,UAAU,EAA6C;IAElE,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,IAAI,eAAe,CAAA;IACvD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAA;IAC5B,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC;QACvB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,aAAa,EAAE;SACjD;QACD,MAAM,EAAE,KAAK;QACb,GAAG,EAAE,GAAG,OAAO,YAAY,KAAK,6BAA6B;QAC7D,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE;KACvD,CAAC,CAAA;IACF,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,OAAiC,EACjC,eAA8B,IAAI;IAElC,IAAI,MAAM,GAAG,cAAc,CAAA;IAC3B,IAAI,YAAY;QAAE,MAAM,GAAG,GAAG,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAA;IAC1E,OAAO,CAAC,eAAe,GAAG,MAAM,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAiC;IAC1D,OAAO,CAAC,eAAe,GAAG,aAAa,CAAA;AACzC,CAAC"}

package/lib/esm/hubtype-service.d.ts

@@ -0,0 +1,69 @@
+import { AxiosResponse } from 'axios';
+import Pusher, { Channel } from 'pusher-js';
+import { Input, SessionUser } from './models';
+interface UnsentInput {
+    id: string;
+    ack: number;
+    unsentInput: Input;
+}
+interface BotonicHeaders {
+    'X-BOTONIC-USER-ID': string;
+    'X-BOTONIC-LAST-MESSAGE-ID': string;
+    'X-BOTONIC-LAST-MESSAGE-UPDATE-DATE': string;
+}
+interface ServerConfig {
+    activityTimeout?: number;
+    pongTimeout?: number;
+}
+interface HubtypeServiceArgs {
+    appId: string;
+    user: SessionUser;
+    lastMessageId: string;
+    lastMessageUpdateDate: string;
+    onEvent: any;
+    unsentInputs: () => UnsentInput[];
+    server: ServerConfig;
+}
+/**
+ * Calls Hubtype APIs from Webchat
+ */
+export declare class HubtypeService {
+    appId: string;
+    user: SessionUser;
+    lastMessageId: string;
+    lastMessageUpdateDate: string;
+    onEvent: any;
+    unsentInputs: () => UnsentInput[];
+    pusher: Pusher | null;
+    channel: Channel;
+    server: ServerConfig;
+    PUSHER_CONNECT_TIMEOUT_MS: number;
+    constructor({ appId, user, lastMessageId, lastMessageUpdateDate, onEvent, unsentInputs, server, }: HubtypeServiceArgs);
+    /**
+     * @returns {Promise<void>}
+     */
+    init(user: any, lastMessageId: any, lastMessageUpdateDate: any): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    _initPusher(): Promise<void>;
+    constructHeaders(): BotonicHeaders;
+    resolveServerConfig(): ServerConfig;
+    updateAuthHeaders(): void;
+    handleConnectionChange(online: boolean): void;
+    onPusherEvent(event: any): void;
+    get pusherChannel(): string;
+    handleSentInput(message: any): void;
+    handleUnsentInput(message: any): void;
+    /**
+     * @return {Promise<void>}
+     */
+    postMessage(user: SessionUser, message: any): Promise<void>;
+    static getWebchatVisibility({ appId, }: {
+        appId: string;
+    }): Promise<AxiosResponse<any>>;
+    destroyPusher(): void;
+    onConnectionRegained(): Promise<void>;
+    resendUnsentInputs(): Promise<void>;
+}
+export {};