@botonic/core 0.19.0-beta.1 → 0.20.1

package/lib/cjs/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const NOT_FOUND_PATH = "404";
+export declare const EMPTY_ACTION_PATH = "";
+export declare const PATH_PAYLOAD_IDENTIFIER = "__PATH_PAYLOAD__";
+export declare const PATH_PAYLOAD_REGEXP: RegExp;

package/lib/cjs/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PATH_PAYLOAD_REGEXP = exports.PATH_PAYLOAD_IDENTIFIER = exports.EMPTY_ACTION_PATH = exports.NOT_FOUND_PATH = void 0;
+exports.NOT_FOUND_PATH = '404';
+exports.EMPTY_ACTION_PATH = '';
+exports.PATH_PAYLOAD_IDENTIFIER = '__PATH_PAYLOAD__';
+exports.PATH_PAYLOAD_REGEXP = new RegExp(`\\b^${exports.PATH_PAYLOAD_IDENTIFIER}(.*)\\b`);
+//# sourceMappingURL=constants.js.map

package/lib/cjs/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,KAAK,CAAA;AACtB,QAAA,iBAAiB,GAAG,EAAE,CAAA;AACtB,QAAA,uBAAuB,GAAG,kBAAkB,CAAA;AAC5C,QAAA,mBAAmB,GAAG,IAAI,MAAM,CAC3C,OAAO,+BAAuB,SAAS,CACxC,CAAA"}

package/lib/cjs/core-bot.d.ts

@@ -0,0 +1,36 @@
+import { Inspector } from './debug';
+import { BotRequest, BotResponse, Locales, Route, Routes, Session } from './models';
+import { BotonicOutputParser } from './output-parser';
+import { Router } from './routing';
+interface CoreBotConfig {
+    appId?: string;
+    defaultDelay?: number;
+    defaultRoutes?: Route[];
+    defaultTyping?: number;
+    inspector?: Inspector;
+    locales: Locales;
+    plugins?: any;
+    renderer: any;
+    routes: Routes;
+    theme?: any;
+}
+export declare class CoreBot {
+    appId?: string;
+    defaultDelay?: number;
+    defaultRoutes: Route[];
+    defaultTyping?: number;
+    inspector: Inspector;
+    locales: Locales;
+    plugins?: Record<string, Plugin>;
+    renderer: any;
+    rootElement: any;
+    router: Router | null;
+    routes: Routes;
+    theme?: any;
+    botonicOutputParser: BotonicOutputParser;
+    constructor({ renderer, routes, locales, theme, plugins, appId, defaultTyping, defaultDelay, defaultRoutes, inspector, }: CoreBotConfig);
+    getString(id: string, session: Session): string;
+    setLocale(locale: string, session: Session): void;
+    input({ input, session, lastRoutePath, dataProvider, }: BotRequest): Promise<BotResponse>;
+}
+export {};

package/lib/cjs/core-bot.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreBot = void 0;
+const ulid_1 = require("ulid");
+const debug_1 = require("./debug");
+const i18n_1 = require("./i18n");
+const models_1 = require("./models");
+const output_parser_1 = require("./output-parser");
+const plugins_1 = require("./plugins");
+const routing_1 = require("./routing");
+class CoreBot {
+    constructor({ 
+    // TODO: Receives dataProvider
+    renderer, routes, locales, theme, plugins, appId, defaultTyping, defaultDelay, defaultRoutes, inspector, }) {
+        this.botonicOutputParser = new output_parser_1.BotonicOutputParser();
+        this.renderer = renderer;
+        this.plugins = plugins_1.loadPlugins(plugins);
+        this.theme = theme || {};
+        this.defaultTyping =
+            typeof defaultTyping !== 'undefined' ? defaultTyping : 0.6;
+        this.defaultDelay = typeof defaultDelay !== 'undefined' ? defaultDelay : 0.4;
+        this.locales = locales;
+        if (appId) {
+            this.appId = appId;
+            return;
+        }
+        this.rootElement = null;
+        this.inspector = inspector || new debug_1.Inspector();
+        this.routes = routes;
+        this.defaultRoutes = defaultRoutes || [];
+        this.router =
+            this.routes instanceof Function
+                ? null
+                : new routing_1.Router([...this.routes, ...this.defaultRoutes], this.inspector.routeInspector);
+    }
+    getString(id, session) {
+        // @ts-ignore
+        return i18n_1.getString(this.locales, session.__locale, id);
+    }
+    setLocale(locale, session) {
+        session.__locale = locale;
+    }
+    async input({ input, session, lastRoutePath, dataProvider, }) {
+        session = session || {};
+        if (!session.__locale)
+            session.__locale = 'en';
+        const parsedUserEvent = this.botonicOutputParser.parseFromUserInput(input);
+        const userId = session.user.id;
+        if (dataProvider) {
+            // TODO: Next iterations. Review cycle of commited events to DB when messages change their ACK
+            // @ts-ignore
+            const userEvent = await dataProvider.saveEvent(Object.assign(Object.assign({}, parsedUserEvent), { userId, eventId: ulid_1.ulid(), createdAt: new Date().toISOString(), from: models_1.MessageEventFrom.USER, ack: models_1.MessageEventAck.RECEIVED }));
+        }
+        if (this.plugins) {
+            await plugins_1.runPlugins(this.plugins, 'pre', input, session, lastRoutePath, undefined, undefined, dataProvider);
+        }
+        if (this.routes instanceof Function) {
+            this.router = new routing_1.Router([
+                ...(await routing_1.getComputedRoutes(this.routes, {
+                    input,
+                    session,
+                    lastRoutePath,
+                })),
+                ...this.defaultRoutes,
+            ], this.inspector.routeInspector);
+        }
+        const output = this.router.processInput(input, session, lastRoutePath);
+        const request = {
+            getString: stringId => this.getString(stringId, session),
+            setLocale: locale => this.setLocale(locale, session),
+            session: session || {},
+            params: output.params || {},
+            input: input,
+            plugins: this.plugins,
+            defaultTyping: this.defaultTyping,
+            defaultDelay: this.defaultDelay,
+            lastRoutePath,
+            dataProvider,
+        };
+        const response = await this.renderer({
+            request,
+            actions: [output.fallbackAction, output.action, output.emptyAction],
+        });
+        let messageEvents = [];
+        try {
+            messageEvents = this.botonicOutputParser.xmlToMessageEvents(response);
+        }
+        catch (e) {
+            // Disabling Botonic 1.0 error log for LTS version:
+            // console.error(e)
+        }
+        lastRoutePath = output.lastRoutePath;
+        if (this.plugins) {
+            await plugins_1.runPlugins(this.plugins, 'post', input, session, lastRoutePath, response, messageEvents, dataProvider);
+        }
+        if (dataProvider) {
+            // TODO: save bot responses to db and update user with new session and new params
+            for (const messageEvent of messageEvents) {
+                // @ts-ignore
+                const botEvent = await dataProvider.saveEvent(Object.assign(Object.assign({}, messageEvent), { userId, eventId: ulid_1.ulid(), createdAt: new Date().toISOString(), from: models_1.MessageEventFrom.BOT, ack: models_1.MessageEventAck.SENT }));
+            }
+        }
+        session.is_first_interaction = false;
+        return {
+            input,
+            response,
+            messageEvents,
+            session,
+            lastRoutePath,
+            dataProvider,
+        };
+    }
+}
+exports.CoreBot = CoreBot;
+//# sourceMappingURL=core-bot.js.map

package/lib/cjs/core-bot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-bot.js","sourceRoot":"","sources":["../../src/core-bot.ts"],"names":[],"mappings":";;;AAAA,+BAA2B;AAE3B,mCAAmC;AACnC,iCAAkC;AAClC,qCAUiB;AACjB,mDAAqD;AACrD,uCAAmD;AACnD,uCAAqD;AAcrD,MAAa,OAAO;IAelB,YAAY;IACV,8BAA8B;IAC9B,QAAQ,EACR,MAAM,EACN,OAAO,EACP,KAAK,EACL,OAAO,EACP,KAAK,EACL,aAAa,EACb,YAAY,EACZ,aAAa,EACb,SAAS,GACK;QAdhB,wBAAmB,GAAG,IAAI,mCAAmB,EAAE,CAAA;QAe7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,qBAAW,CAAC,OAAO,CAAC,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;QACxB,IAAI,CAAC,aAAa;YAChB,OAAO,aAAa,KAAK,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAA;QAC5D,IAAI,CAAC,YAAY,GAAG,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAA;QAC5E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;YAClB,OAAM;SACP;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,IAAI,iBAAS,EAAE,CAAA;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,EAAE,CAAA;QACxC,IAAI,CAAC,MAAM;YACT,IAAI,CAAC,MAAM,YAAY,QAAQ;gBAC7B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,IAAI,gBAAM,CACR,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,EACvC,IAAI,CAAC,SAAS,CAAC,cAAc,CAC9B,CAAA;IACT,CAAC;IAED,SAAS,CAAC,EAAU,EAAE,OAAgB;QACpC,aAAa;QACb,OAAO,gBAAS,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACtD,CAAC;IAED,SAAS,CAAC,MAAc,EAAE,OAAgB;QACxC,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAA;IAC3B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,EACV,KAAK,EACL,OAAO,EACP,aAAa,EACb,YAAY,GACD;QACX,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QACvB,IAAI,CAAC,OAAO,CAAC,QAAQ;YAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAA;QAE9C,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;QAC1E,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;QAC9B,IAAI,YAAY,EAAE;YAChB,8FAA8F;YAC9F,aAAa;YACb,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,SAAS,iCACzC,eAAe,KAClB,MAAM,EACN,OAAO,EAAE,WAAI,EAAE,EACf,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACnC,IAAI,EAAE,yBAAgB,CAAC,IAAI,EAC3B,GAAG,EAAE,wBAAe,CAAC,QAAQ,IAC7B,CAAA;SACH;QAED,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,oBAAU,CACd,IAAI,CAAC,OAAO,EACZ,KAAK,EACL,KAAK,EACL,OAAO,EACP,aAAa,EACb,SAAS,EACT,SAAS,EACT,YAAY,CACb,CAAA;SACF;QAED,IAAI,IAAI,CAAC,MAAM,YAAY,QAAQ,EAAE;YACnC,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CACtB;gBACE,GAAG,CAAC,MAAM,2BAAiB,CAAC,IAAI,CAAC,MAAM,EAAE;oBACvC,KAAK;oBACL,OAAO;oBACP,aAAa;iBACd,CAAC,CAAC;gBACH,GAAG,IAAI,CAAC,aAAa;aACtB,EACD,IAAI,CAAC,SAAS,CAAC,cAAc,CAC9B,CAAA;SACF;QAED,MAAM,MAAM,GAAI,IAAI,CAAC,MAAiB,CAAC,YAAY,CACjD,KAAK,EACL,OAAO,EACP,aAAa,CACd,CAAA;QACD,MAAM,OAAO,GAAG;YACd,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;YACxD,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;YACpD,OAAO,EAAE,OAAO,IAAI,EAAE;YACtB,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE;YAC3B,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,aAAa;YACb,YAAY;SACb,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC;YACnC,OAAO;YACP,OAAO,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;SACpE,CAAC,CAAA;QACF,IAAI,aAAa,GAA4B,EAAE,CAAA;QAC/C,IAAI;YACF,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;SACtE;QAAC,OAAO,CAAC,EAAE;YACV,mDAAmD;YACnD,mBAAmB;SACpB;QAED,aAAa,GAAG,MAAM,CAAC,aAAa,CAAA;QACpC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,oBAAU,CACd,IAAI,CAAC,OAAO,EACZ,MAAM,EACN,KAAK,EACL,OAAO,EACP,aAAa,EACb,QAAQ,EACR,aAAa,EACb,YAAY,CACb,CAAA;SACF;QAED,IAAI,YAAY,EAAE;YAChB,iFAAiF;YACjF,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;gBACxC,aAAa;gBACb,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,SAAS,iCACxC,YAAY,KACf,MAAM,EACN,OAAO,EAAE,WAAI,EAAE,EACf,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACnC,IAAI,EAAE,yBAAgB,CAAC,GAAG,EAC1B,GAAG,EAAE,wBAAe,CAAC,IAAI,IACzB,CAAA;aACH;SACF;QAED,OAAO,CAAC,oBAAoB,GAAG,KAAK,CAAA;QACpC,OAAO;YACL,KAAK;YACL,QAAQ;YACR,aAAa;YACb,OAAO;YACP,aAAa;YACb,YAAY;SACb,CAAA;IACH,CAAC;CACF;AArLD,0BAqLC"}

package/lib/cjs/data-provider/dynamodb-data-provider.d.ts

@@ -0,0 +1,26 @@
+import { Entity, Table } from 'dynamodb-toolbox';
+import { BotonicEvent, User } from '../models';
+import { DataProvider } from './factory';
+export declare class DynamoDBDataProvider implements DataProvider {
+    region: string;
+    tableName: string;
+    userEventsTable: Table;
+    userEntity: Entity<any>;
+    eventEntity: Entity<any>;
+    messageEventEntities: Record<string, Entity<any>>;
+    textMessageEventEntity: Entity<any>;
+    connectionEventEntity: Entity<any>;
+    constructor(url: string);
+    getUsers(limit?: number, offset?: number): Promise<User[]>;
+    getUser(id: string): Promise<User | undefined>;
+    getUserByWebsocketId(websocketId: string): Promise<User | undefined>;
+    getUserByField(field: string, value: any): Promise<User | undefined>;
+    saveUser(user: User): Promise<User>;
+    updateUser(user: User): Promise<User>;
+    deleteUser(id: string): Promise<User | undefined>;
+    getEvents(limit?: number, offset?: number): Promise<BotonicEvent[]>;
+    getEvent(id: string): Promise<BotonicEvent | undefined>;
+    saveEvent(event: BotonicEvent): Promise<BotonicEvent>;
+    updateEvent(event: BotonicEvent): Promise<BotonicEvent>;
+    deleteEvent(id: string): Promise<BotonicEvent | undefined>;
+}

package/lib/cjs/data-provider/dynamodb-data-provider.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamoDBDataProvider = void 0;
+const models_1 = require("../models");
+const dynamodb_utils_1 = require("./dynamodb-utils");
+class DynamoDBDataProvider {
+    constructor(url) {
+        try {
+            ;
+            [this.tableName, this.region] = url.split('://')[1].split('.');
+            this.userEventsTable = dynamodb_utils_1.getUserEventsTable(this.tableName, this.region);
+            this.userEntity = dynamodb_utils_1.getUserEntity(this.userEventsTable);
+            this.connectionEventEntity = dynamodb_utils_1.getConnectionEventEntity(this.userEventsTable);
+            this.messageEventEntities = dynamodb_utils_1.getMessageEventEntities(this.userEventsTable);
+        }
+        catch (e) {
+            console.log({ e });
+        }
+    }
+    // @ts-ignore
+    async getUsers(limit = 10, offset = 0) {
+        // TODO: finish to implement with offset
+        const result = await this.userEventsTable.scan({
+            filters: { attr: dynamodb_utils_1.SORT_KEY_NAME, beginsWith: dynamodb_utils_1.USER_PREFIX },
+            limit,
+        });
+        return result.Items;
+    }
+    async getUser(id) {
+        const userById = {
+            id: id,
+            SK: id,
+        };
+        const result = await this.userEntity.get(userById);
+        if (Object.keys(result).length === 0)
+            return undefined;
+        return result.Item;
+    }
+    async getUserByWebsocketId(websocketId) {
+        const result = await this.userEventsTable.query(websocketId, {
+            index: dynamodb_utils_1.GLOBAL_SECONDARY_INDEX_NAME,
+        });
+        if (result.Count === 0)
+            return undefined;
+        return result.Items[0];
+    }
+    // @ts-ignore
+    async getUserByField(field, value) { } //TODO: Implement
+    async saveUser(user) {
+        const putUser = Object.assign(Object.assign({}, user), { id: user.id, userId: user.id });
+        await this.userEntity.put(putUser);
+        return user;
+    }
+    async updateUser(user) {
+        const updateUser = Object.assign(Object.assign({}, user), { id: user.id, userId: user.id });
+        const res = await this.userEntity.update(updateUser);
+        return user;
+    }
+    // @ts-ignore
+    async deleteUser(id) { } // TODO: Implement
+    // @ts-ignore
+    async getEvents(limit = 10, offset = 0) { } // TODO: Implement
+    // @ts-ignore
+    async getEvent(id) { } // TODO: Implement
+    async saveEvent(event) {
+        if (event.eventType === models_1.EventTypes.CONNECTION) {
+            await this.connectionEventEntity.put(event);
+        }
+        if (event.eventType === models_1.EventTypes.MESSAGE) {
+            await this.messageEventEntities[event.type].put(event);
+        }
+        // TODO: Implementation of other event types
+        return event;
+    }
+    // @ts-ignore
+    async updateEvent(event) { } // TODO: Implement
+    // @ts-ignore
+    async deleteEvent(id) { } // TODO: Implement
+}
+exports.DynamoDBDataProvider = DynamoDBDataProvider;
+//# sourceMappingURL=dynamodb-data-provider.js.map

package/lib/cjs/data-provider/dynamodb-data-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamodb-data-provider.js","sourceRoot":"","sources":["../../../src/data-provider/dynamodb-data-provider.ts"],"names":[],"mappings":";;;AAEA,sCAA0D;AAC1D,qDAQyB;AAGzB,MAAa,oBAAoB;IAS/B,YAAY,GAAW;QACrB,IAAI;YACF,CAAC;YAAA,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC/D,IAAI,CAAC,eAAe,GAAG,mCAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;YACtE,IAAI,CAAC,UAAU,GAAG,8BAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;YACrD,IAAI,CAAC,qBAAqB,GAAG,yCAAwB,CACnD,IAAI,CAAC,eAAe,CACrB,CAAA;YACD,IAAI,CAAC,oBAAoB,GAAG,wCAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;SAC1E;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;SACnB;IACH,CAAC;IAED,aAAa;IACb,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC;QACnC,wCAAwC;QACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;YAC7C,OAAO,EAAE,EAAE,IAAI,EAAE,8BAAa,EAAE,UAAU,EAAE,4BAAW,EAAE;YACzD,KAAK;SACN,CAAC,CAAA;QACF,OAAO,MAAM,CAAC,KAAK,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,MAAM,QAAQ,GAAG;YACf,EAAE,EAAE,EAAE;YACN,EAAE,EAAE,EAAE;SACP,CAAA;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAClD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAA;QACtD,OAAO,MAAM,CAAC,IAAI,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,WAAmB;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE;YAC3D,KAAK,EAAE,4CAA2B;SACnC,CAAC,CAAA;QACF,IAAI,MAAM,CAAC,KAAK,KAAK,CAAC;YAAE,OAAO,SAAS,CAAA;QACxC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxB,CAAC;IACD,aAAa;IACb,KAAK,CAAC,cAAc,CAAC,KAAa,EAAE,KAAU,IAA8B,CAAC,CAAC,iBAAiB;IAE/F,KAAK,CAAC,QAAQ,CAAC,IAAU;QACvB,MAAM,OAAO,mCAAQ,IAAI,KAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAE,CAAA;QACzD,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,KAAK,CAAC,UAAU,CAAC,IAAU;QACzB,MAAM,UAAU,mCAAQ,IAAI,KAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAE,CAAA;QAC5D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACpD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,aAAa;IACb,KAAK,CAAC,UAAU,CAAC,EAAU,IAA8B,CAAC,CAAC,kBAAkB;IAE7E,aAAa;IACb,KAAK,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,IAA4B,CAAC,CAAC,kBAAkB;IAEtF,aAAa;IACb,KAAK,CAAC,QAAQ,CAAC,EAAU,IAAsC,CAAC,CAAC,kBAAkB;IAEnF,KAAK,CAAC,SAAS,CAAC,KAAmB;QACjC,IAAI,KAAK,CAAC,SAAS,KAAK,mBAAU,CAAC,UAAU,EAAE;YAC7C,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;SAC5C;QACD,IAAI,KAAK,CAAC,SAAS,KAAK,mBAAU,CAAC,OAAO,EAAE;YAC1C,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;SACvD;QACD,4CAA4C;QAC5C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,aAAa;IACb,KAAK,CAAC,WAAW,CAAC,KAAmB,IAA0B,CAAC,CAAC,kBAAkB;IAEnF,aAAa;IACb,KAAK,CAAC,WAAW,CAAC,EAAU,IAAsC,CAAC,CAAC,kBAAkB;CACvF;AAxFD,oDAwFC"}

package/lib/cjs/data-provider/dynamodb-utils.d.ts

@@ -0,0 +1,11 @@
+import { Entity, Table } from 'dynamodb-toolbox';
+export declare const GLOBAL_SECONDARY_INDEX_NAME = "GSI1";
+export declare const GLOBAL_SECONDARY_INDEX_ATTR = "websocketId";
+export declare const PARTITION_KEY_NAME = "PK";
+export declare const SORT_KEY_NAME = "SK";
+export declare const USER_PREFIX = "USR#";
+export declare const EVENT_PREFIX = "EVT#";
+export declare function getUserEventsTable(tableName: string, region: string): Table;
+export declare function getUserEntity(table: Table): Entity<any>;
+export declare function getConnectionEventEntity(table: Table): Entity<any>;
+export declare function getMessageEventEntities(table: Table): Record<string, Entity<any>>;

package/lib/cjs/data-provider/dynamodb-utils.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMessageEventEntities = exports.getConnectionEventEntity = exports.getUserEntity = exports.getUserEventsTable = exports.EVENT_PREFIX = exports.USER_PREFIX = exports.SORT_KEY_NAME = exports.PARTITION_KEY_NAME = exports.GLOBAL_SECONDARY_INDEX_ATTR = exports.GLOBAL_SECONDARY_INDEX_NAME = void 0;
+const aws_sdk_1 = require("aws-sdk");
+const dynamodb_toolbox_1 = require("dynamodb-toolbox");
+const models_1 = require("../models");
+// Table Definitions
+exports.GLOBAL_SECONDARY_INDEX_NAME = 'GSI1';
+exports.GLOBAL_SECONDARY_INDEX_ATTR = 'websocketId';
+exports.PARTITION_KEY_NAME = 'PK';
+exports.SORT_KEY_NAME = 'SK';
+// Entities Definitions
+exports.USER_PREFIX = 'USR#';
+exports.EVENT_PREFIX = 'EVT#';
+function capitalize(string) {
+    return string.charAt(0).toUpperCase() + string.slice(1);
+}
+function getUserEventsTable(tableName, region) {
+    const documentClient = new aws_sdk_1.DynamoDB.DocumentClient({
+        apiVersion: '2012-08-10',
+        region: region,
+    });
+    return new dynamodb_toolbox_1.Table({
+        name: tableName,
+        partitionKey: exports.PARTITION_KEY_NAME,
+        sortKey: exports.SORT_KEY_NAME,
+        entityField: true,
+        indexes: {
+            GSI1: {
+                partitionKey: exports.GLOBAL_SECONDARY_INDEX_ATTR,
+            },
+        },
+        DocumentClient: documentClient,
+    });
+}
+exports.getUserEventsTable = getUserEventsTable;
+function getUserEntity(table) {
+    return new dynamodb_toolbox_1.Entity({
+        name: 'User',
+        attributes: {
+            id: { partitionKey: true, prefix: exports.USER_PREFIX },
+            [`${exports.SORT_KEY_NAME}`]: {
+                hidden: true,
+                sortKey: true,
+                prefix: exports.USER_PREFIX,
+            },
+            userId: [exports.SORT_KEY_NAME, 0],
+            websocketId: 'string',
+            isOnline: 'boolean',
+            route: 'string',
+            session: 'string',
+        },
+        table,
+    });
+}
+exports.getUserEntity = getUserEntity;
+function getConnectionEventEntity(table) {
+    return new dynamodb_toolbox_1.Entity({
+        name: 'Connection Event',
+        attributes: {
+            userId: { partitionKey: true, prefix: exports.USER_PREFIX },
+            [`${exports.SORT_KEY_NAME}`]: {
+                hidden: true,
+                sortKey: true,
+                prefix: exports.EVENT_PREFIX,
+            },
+            eventId: [exports.SORT_KEY_NAME, 0],
+            eventType: 'string',
+            createdAt: 'string',
+            modifiedAt: 'string',
+            status: 'string',
+        },
+        table,
+    });
+}
+exports.getConnectionEventEntity = getConnectionEventEntity;
+function getMessageEventEntities(table) {
+    const textAttributes = {
+        text: 'string',
+        markdown: 'boolean',
+        buttons: 'list',
+        replies: 'list',
+    };
+    const mediaAttributes = {
+        src: 'string',
+        buttons: 'list',
+    };
+    const locationAttributes = {
+        lat: 'number',
+        long: 'number',
+    };
+    const carouselAttributes = {
+        elements: 'list',
+    };
+    const customAttributes = {
+        json: 'map',
+        replies: 'list',
+    };
+    const entityWithAttributes = (type, attributes) => new dynamodb_toolbox_1.Entity({
+        name: `${capitalize(type)} Message Event`,
+        attributes: Object.assign({ userId: { partitionKey: true, prefix: exports.USER_PREFIX }, [`${exports.SORT_KEY_NAME}`]: {
+                hidden: true,
+                sortKey: true,
+                prefix: exports.EVENT_PREFIX,
+            }, eventId: [exports.SORT_KEY_NAME, 0], eventType: 'string', createdAt: 'string', modifiedAt: 'string', from: 'string', ack: 'string', typing: 'number', delay: 'number', type: 'string' }, attributes),
+        table,
+    });
+    return {
+        text: entityWithAttributes(models_1.MessageEventTypes.TEXT, textAttributes),
+        audio: entityWithAttributes(models_1.MessageEventTypes.AUDIO, mediaAttributes),
+        image: entityWithAttributes(models_1.MessageEventTypes.IMAGE, mediaAttributes),
+        document: entityWithAttributes(models_1.MessageEventTypes.DOCUMENT, mediaAttributes),
+        video: entityWithAttributes(models_1.MessageEventTypes.VIDEO, mediaAttributes),
+        location: entityWithAttributes(models_1.MessageEventTypes.LOCATION, locationAttributes),
+        carousel: entityWithAttributes(models_1.MessageEventTypes.CAROUSEL, carouselAttributes),
+        custom: entityWithAttributes(models_1.MessageEventTypes.CUSTOM, customAttributes),
+    };
+}
+exports.getMessageEventEntities = getMessageEventEntities;
+//# sourceMappingURL=dynamodb-utils.js.map

package/lib/cjs/data-provider/dynamodb-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamodb-utils.js","sourceRoot":"","sources":["../../../src/data-provider/dynamodb-utils.ts"],"names":[],"mappings":";;;AAAA,qCAAkC;AAClC,uDAAgD;AAGhD,sCAA6C;AAE7C,oBAAoB;AACP,QAAA,2BAA2B,GAAG,MAAM,CAAA;AACpC,QAAA,2BAA2B,GAAG,aAAa,CAAA;AAC3C,QAAA,kBAAkB,GAAG,IAAI,CAAA;AACzB,QAAA,aAAa,GAAG,IAAI,CAAA;AAEjC,uBAAuB;AACV,QAAA,WAAW,GAAG,MAAM,CAAA;AACpB,QAAA,YAAY,GAAG,MAAM,CAAA;AAElC,SAAS,UAAU,CAAC,MAAc;IAChC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACzD,CAAC;AAED,SAAgB,kBAAkB,CAAC,SAAiB,EAAE,MAAc;IAClE,MAAM,cAAc,GAAG,IAAI,kBAAQ,CAAC,cAAc,CAAC;QACjD,UAAU,EAAE,YAAY;QACxB,MAAM,EAAE,MAAM;KACf,CAAC,CAAA;IACF,OAAO,IAAI,wBAAK,CAAC;QACf,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,0BAAkB;QAChC,OAAO,EAAE,qBAAa;QACtB,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE;YACP,IAAI,EAAE;gBACJ,YAAY,EAAE,mCAA2B;aAC1C;SACF;QACD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAA;AACJ,CAAC;AAjBD,gDAiBC;AAED,SAAgB,aAAa,CAAC,KAAY;IACxC,OAAO,IAAI,yBAAM,CAAC;QAChB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAW,EAAE;YAC/C,CAAC,GAAG,qBAAa,EAAE,CAAC,EAAE;gBACpB,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,mBAAW;aACpB;YACD,MAAM,EAAE,CAAC,qBAAa,EAAE,CAAC,CAAC;YAC1B,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,SAAS;YACnB,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,QAAQ;SAClB;QACD,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAlBD,sCAkBC;AAED,SAAgB,wBAAwB,CAAC,KAAY;IACnD,OAAO,IAAI,yBAAM,CAAC;QAChB,IAAI,EAAE,kBAAkB;QACxB,UAAU,EAAE;YACV,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAW,EAAE;YACnD,CAAC,GAAG,qBAAa,EAAE,CAAC,EAAE;gBACpB,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,oBAAY;aACrB;YACD,OAAO,EAAE,CAAC,qBAAa,EAAE,CAAC,CAAC;YAC3B,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE,QAAQ;YACpB,MAAM,EAAE,QAAQ;SACjB;QACD,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAlBD,4DAkBC;AAED,SAAgB,uBAAuB,CACrC,KAAY;IAEZ,MAAM,cAAc,GAAqB;QACvC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,MAAM;QACf,OAAO,EAAE,MAAM;KAChB,CAAA;IAED,MAAM,eAAe,GAAqB;QACxC,GAAG,EAAE,QAAQ;QACb,OAAO,EAAE,MAAM;KAChB,CAAA;IAED,MAAM,kBAAkB,GAAqB;QAC3C,GAAG,EAAE,QAAQ;QACb,IAAI,EAAE,QAAQ;KACf,CAAA;IAED,MAAM,kBAAkB,GAAqB;QAC3C,QAAQ,EAAE,MAAM;KACjB,CAAA;IAED,MAAM,gBAAgB,GAAqB;QACzC,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,MAAM;KAChB,CAAA;IAED,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,UAA4B,EAAE,EAAE,CAC1E,IAAI,yBAAM,CAAC;QACT,IAAI,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,gBAAgB;QACzC,UAAU,kBACR,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAW,EAAE,EACnD,CAAC,GAAG,qBAAa,EAAE,CAAC,EAAE;gBACpB,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,oBAAY;aACrB,EACD,OAAO,EAAE,CAAC,qBAAa,EAAE,CAAC,CAAC,EAC3B,SAAS,EAAE,QAAQ,EACnB,SAAS,EAAE,QAAQ,EACnB,UAAU,EAAE,QAAQ,EACpB,IAAI,EAAE,QAAQ,EACd,GAAG,EAAE,QAAQ,EACb,MAAM,EAAE,QAAQ,EAChB,KAAK,EAAE,QAAQ,EACf,IAAI,EAAE,QAAQ,IACX,UAAU,CACd;QACD,KAAK;KACN,CAAC,CAAA;IAEJ,OAAO;QACL,IAAI,EAAE,oBAAoB,CAAC,0BAAiB,CAAC,IAAI,EAAE,cAAc,CAAC;QAClE,KAAK,EAAE,oBAAoB,CAAC,0BAAiB,CAAC,KAAK,EAAE,eAAe,CAAC;QACrE,KAAK,EAAE,oBAAoB,CAAC,0BAAiB,CAAC,KAAK,EAAE,eAAe,CAAC;QACrE,QAAQ,EAAE,oBAAoB,CAAC,0BAAiB,CAAC,QAAQ,EAAE,eAAe,CAAC;QAC3E,KAAK,EAAE,oBAAoB,CAAC,0BAAiB,CAAC,KAAK,EAAE,eAAe,CAAC;QACrE,QAAQ,EAAE,oBAAoB,CAC5B,0BAAiB,CAAC,QAAQ,EAC1B,kBAAkB,CACnB;QACD,QAAQ,EAAE,oBAAoB,CAC5B,0BAAiB,CAAC,QAAQ,EAC1B,kBAAkB,CACnB;QACD,MAAM,EAAE,oBAAoB,CAAC,0BAAiB,CAAC,MAAM,EAAE,gBAAgB,CAAC;KACzE,CAAA;AACH,CAAC;AArED,0DAqEC"}

package/lib/cjs/data-provider/factory.d.ts

@@ -0,0 +1,25 @@
+import { BotonicEvent, User } from '../models';
+export declare const dataProviderProtocols: {
+    DYNAMO_DB: string;
+    FILE: string;
+};
+export interface DataProvider {
+    getUsers(limit?: number, offset?: number): User[] | Promise<User[]>;
+    getUser(id: string): User | Promise<User | undefined> | undefined;
+    getUserByWebsocketId(websocketId: string): User | Promise<User | undefined> | undefined;
+    getUserByField(field: string, value: any): User | Promise<User | undefined> | undefined;
+    saveUser(user: User): User | Promise<User>;
+    updateUser(user: User): User | Promise<User>;
+    deleteUser(id: string): User | Promise<User | undefined> | undefined;
+    getEvents(limit?: number, offset?: number): BotonicEvent[] | Promise<BotonicEvent[]>;
+    getEvent(id: string): BotonicEvent | Promise<BotonicEvent | undefined> | undefined;
+    saveEvent(event: BotonicEvent): BotonicEvent | Promise<BotonicEvent>;
+    updateEvent(event: BotonicEvent): BotonicEvent | Promise<BotonicEvent>;
+    deleteEvent(id: string): BotonicEvent | Promise<BotonicEvent | undefined> | undefined;
+}
+/** URL examples:
+ * dynamodb://my-table.my-region.aws.com
+ * postgresql://my-database.my-db-provider.com
+ * file://path/to/local/db.json
+ */
+export declare function dataProviderFactory(url?: string): DataProvider;

package/lib/cjs/data-provider/factory.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dataProviderFactory = exports.dataProviderProtocols = void 0;
+const dynamodb_data_provider_1 = require("./dynamodb-data-provider");
+const local_data_provider_1 = require("./local-data-provider");
+exports.dataProviderProtocols = {
+    DYNAMO_DB: 'dynamodb',
+    FILE: 'file',
+};
+/** URL examples:
+ * dynamodb://my-table.my-region.aws.com
+ * postgresql://my-database.my-db-provider.com
+ * file://path/to/local/db.json
+ */
+function dataProviderFactory(url) {
+    if (!url) {
+        return new local_data_provider_1.LocalDevDataProvider();
+    }
+    const protocol = url.split('://')[0];
+    switch (protocol) {
+        case exports.dataProviderProtocols.DYNAMO_DB:
+            return new dynamodb_data_provider_1.DynamoDBDataProvider(url);
+        case exports.dataProviderProtocols.FILE:
+            return new local_data_provider_1.LocalDevDataProvider(url);
+        default:
+            console.error(`Protocol ${protocol} not implemented, using local DB instead.`);
+            return new local_data_provider_1.LocalDevDataProvider();
+    }
+}
+exports.dataProviderFactory = dataProviderFactory;
+//# sourceMappingURL=factory.js.map

package/lib/cjs/data-provider/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../src/data-provider/factory.ts"],"names":[],"mappings":";;;AACA,qEAA+D;AAC/D,+DAA4D;AAE/C,QAAA,qBAAqB,GAAG;IACnC,SAAS,EAAE,UAAU;IACrB,IAAI,EAAE,MAAM;CACb,CAAA;AA8BD;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,GAAY;IAC9C,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,IAAI,0CAAoB,EAAE,CAAA;KAClC;IAED,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACpC,QAAQ,QAAQ,EAAE;QAChB,KAAK,6BAAqB,CAAC,SAAS;YAClC,OAAO,IAAI,6CAAoB,CAAC,GAAG,CAAC,CAAA;QACtC,KAAK,6BAAqB,CAAC,IAAI;YAC7B,OAAO,IAAI,0CAAoB,CAAC,GAAG,CAAC,CAAA;QACtC;YACE,OAAO,CAAC,KAAK,CACX,YAAY,QAAQ,2CAA2C,CAChE,CAAA;YACD,OAAO,IAAI,0CAAoB,EAAE,CAAA;KACpC;AACH,CAAC;AAjBD,kDAiBC"}

package/lib/cjs/data-provider/index.d.ts

@@ -0,0 +1,4 @@
+export * from './dynamodb-data-provider';
+export * from './dynamodb-utils';
+export * from './factory';
+export * from './local-data-provider';

package/lib/cjs/data-provider/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./dynamodb-data-provider"), exports);
+tslib_1.__exportStar(require("./dynamodb-utils"), exports);
+tslib_1.__exportStar(require("./factory"), exports);
+tslib_1.__exportStar(require("./local-data-provider"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/data-provider/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/data-provider/index.ts"],"names":[],"mappings":";;;AAAA,mEAAwC;AACxC,2DAAgC;AAChC,oDAAyB;AACzB,gEAAqC"}

package/lib/cjs/data-provider/local-data-provider.d.ts

@@ -0,0 +1,26 @@
+import { JsonDB } from 'node-json-db';
+import { BotonicEvent, User } from '../models';
+import { DataProvider } from './factory';
+export declare class LocalDevDataProvider implements DataProvider {
+    private readonly DB_PATH;
+    private readonly SEPARATOR;
+    private readonly paths;
+    db: JsonDB;
+    constructor(url?: string);
+    getUsers(limit?: number, offset?: number): User[];
+    getUser(userId: string): User | undefined;
+    getUserByWebsocketId(websocketId: string): User | undefined;
+    getUserByField(field: string, value: any): User | undefined;
+    saveUser(user: User): User;
+    updateUser(user: User): User;
+    deleteUser(id: string): User | undefined;
+    getEvents(limit?: number, offset?: number): BotonicEvent[];
+    getEvent(id: string): BotonicEvent | undefined;
+    saveEvent(event: BotonicEvent): BotonicEvent;
+    updateEvent(event: BotonicEvent): BotonicEvent;
+    deleteEvent(id: string): BotonicEvent | undefined;
+    addConnection(websocketId: string): void;
+    updateConnection(websocketId: string, userId: string): void;
+    deleteConnection(websocketId: string): void;
+    private createPath;
+}