@hexagramio/saga-ts 0.9.293

package/dist/cjs/commands/user.js

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveUserCommand = exports.JoinUserCommand = exports.AddUserPropertyCommand = exports.UpdateUserCommand = exports.GetDeleteCommand = exports.RefreshTokenCommand = exports.GetUserCommand = exports.ListUsersCommand = exports.CreateTestUserCommand = exports.CreateGenerateBasicUserCommand = exports.RegisterUserCommand = exports.LoginUserCommand = exports.WhoAmICommand = void 0;
+/**
+ * Creates a command to get the user associated with the given accessToken
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const WhoAmICommand = (accessToken) => {
+    return {
+        method: "GET",
+        path: "/users/whoami",
+        accessToken
+    };
+};
+exports.WhoAmICommand = WhoAmICommand;
+/**
+ * Command to login a user
+ * @param username string
+ * @param password string
+ * @group HTTP Commands
+ */
+const LoginUserCommand = (data) => {
+    return {
+        method: "POST",
+        path: "/users/login",
+        data
+    };
+};
+exports.LoginUserCommand = LoginUserCommand;
+/**
+ * Create command to register a user
+ * @param username string
+ * @param password string
+ * @group HTTP Commands
+ */
+const RegisterUserCommand = (data) => {
+    return {
+        method: "POST",
+        path: "/users",
+        data
+    };
+};
+exports.RegisterUserCommand = RegisterUserCommand;
+/**
+ * Command to create a generated user
+ * @param basicUser an optional model
+ * @group HTTP Commands
+ */
+const CreateGenerateBasicUserCommand = (data = {}) => {
+    return {
+        method: "POST",
+        path: "/users/generate/basic",
+        data
+    };
+};
+exports.CreateGenerateBasicUserCommand = CreateGenerateBasicUserCommand;
+/**
+ * Command to create a test user
+ * @param basicUser an optional model
+ * @group HTTP Commands
+ */
+const CreateTestUserCommand = (username) => {
+    return {
+        method: "POST",
+        path: "/users/generate/test",
+        data: {
+            username
+        }
+    };
+};
+exports.CreateTestUserCommand = CreateTestUserCommand;
+/**
+ * List Users command
+ * @param search search criteria for ysers
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const ListUsersCommand = (accessToken, search) => {
+    return {
+        method: "GET",
+        path: "/users",
+        params: search ? new URLSearchParams({ search }) : undefined,
+        accessToken
+    };
+};
+exports.ListUsersCommand = ListUsersCommand;
+/**
+ * Get a user command
+ * @param id the id of the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const GetUserCommand = (accessToken, id) => {
+    return {
+        method: "GET",
+        path: `/users/${id}`,
+        accessToken
+    };
+};
+exports.GetUserCommand = GetUserCommand;
+/**
+ * Refresh token command
+ * @param id the id of the user
+ * @param refreshToken the refresh token
+  * @group HTTP Commands
+ */
+const RefreshTokenCommand = (refreshToken, id) => {
+    return {
+        method: "POST",
+        path: `/users/${id}/refresh_token`,
+        data: { refreshToken }
+    };
+};
+exports.RefreshTokenCommand = RefreshTokenCommand;
+/**
+ * Delete a user command
+ * @param id the id of the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const GetDeleteCommand = (accessToken, id) => {
+    return {
+        method: "DELETE",
+        path: `/users/${id}`,
+        accessToken
+    };
+};
+exports.GetDeleteCommand = GetDeleteCommand;
+/**
+ * Update the user command
+ * @param data the user needing to be updated, the _id of the user is used to select the user
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const UpdateUserCommand = (accessToken, data) => {
+    return {
+        method: "PUT",
+        path: `/users/${data._id}`,
+        data,
+        accessToken
+    };
+};
+exports.UpdateUserCommand = UpdateUserCommand;
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+const AddUserPropertyCommand = (accessToken, data) => {
+    return {
+        method: "POST",
+        path: `/users/${data.parent_id}/properties`,
+        data,
+        accessToken
+    };
+};
+exports.AddUserPropertyCommand = AddUserPropertyCommand;
+/**
+ * A command to join a users realtime socket
+ * @param _id the id of the user
+ * @group Socket Commands
+ */
+const JoinUserCommand = (_id) => {
+    return {
+        method: "/users",
+        join: true,
+        id: _id
+    };
+};
+exports.JoinUserCommand = JoinUserCommand;
+/**
+ * A command to leave a users realtime socket
+ * @param _id the id of the user
+ * @group Socket Commands
+ */
+const LeaveUserCommand = (_id) => {
+    return {
+        method: "/users",
+        join: false,
+        id: _id
+    };
+};
+exports.LeaveUserCommand = LeaveUserCommand;
+//# sourceMappingURL=user.js.map

package/dist/cjs/commands/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/commands/user.ts"],"names":[],"mappings":";;;AA8DA;;;;GAIG;AACI,MAAM,aAAa,GAAE,CAAC,WAAmB,EAAwB,EAAE;IACxE,OAAO;QACL,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,eAAe;QACrB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,aAAa,iBAMzB;AAED;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,IAAe,EAA0C,EAAE;IAC1F,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,cAAc;QACpB,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AANY,QAAA,gBAAgB,oBAM5B;AAED;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,IAAkB,EAA0C,EAAE;IAChG,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,QAAQ;QACd,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AANY,QAAA,mBAAmB,uBAM/B;AAED;;;;GAIG;AACI,MAAM,8BAA8B,GAAG,CAAC,OAAe,EAAE,EAAuB,EAAE;IACvF,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,uBAAuB;QAC7B,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AANY,QAAA,8BAA8B,kCAM1C;AACD;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAuB,EAAE;IAC7E,OAAO;QACL,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE;YACJ,QAAQ;SACT;KACF,CAAA;AACH,CAAC,CAAA;AARY,QAAA,qBAAqB,yBAQjC;AAED;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAC,MAAe,EAA+B,EAAE;IACnG,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,QAAQ;QACb,MAAM,EAAC,MAAM,CAAA,CAAC,CAAA,IAAI,eAAe,CAAC,EAAC,MAAM,EAAC,CAAC,CAAA,CAAC,CAAA,SAAS;QACrD,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,gBAAgB,oBAO5B;AAED;;;;;GAKG;AACI,MAAM,cAAc,GAAG,CAAC,WAAmB,EAAC,EAAU,EAAuB,EAAE;IACpF,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,UAAU,EAAE,EAAE;QACnB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,cAAc,kBAM1B;AAED;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,YAAoB,EAAE,EAAU,EAA6B,EAAE;IACjG,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,UAAU,EAAE,gBAAgB;QACjC,IAAI,EAAC,EAAC,YAAY,EAAC;KACpB,CAAA;AACH,CAAC,CAAA;AANY,QAAA,mBAAmB,uBAM/B;AAED;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAC,EAAU,EAAuB,EAAE;IACtF,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,UAAU,EAAE,EAAE;QACnB,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AANY,QAAA,gBAAgB,oBAM5B;AAED;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,WAAmB,EAAC,IAAgB,EAAuB,EAAE;IAC7F,OAAO;QACL,MAAM,EAAC,KAAK;QACZ,IAAI,EAAC,UAAU,IAAI,CAAC,GAAG,EAAE;QACzB,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,iBAAiB,qBAO7B;AAED;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAC,IAAmB,EAA2B,EAAE;IACzG,OAAO;QACL,MAAM,EAAC,MAAM;QACb,IAAI,EAAC,UAAU,IAAI,CAAC,SAAS,aAAa;QAC1C,IAAI;QACJ,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,sBAAsB,0BAOlC;AAED;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,GAAU,EAAiB,EAAE;IAC3D,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,IAAI;QACT,EAAE,EAAC,GAAG;KACP,CAAA;AACH,CAAC,CAAA;AANY,QAAA,eAAe,mBAM3B;AAED;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,GAAU,EAAiB,EAAE;IAC5D,OAAO;QACL,MAAM,EAAC,QAAQ;QACf,IAAI,EAAC,KAAK;QACV,EAAE,EAAC,GAAG;KACP,CAAA;AACH,CAAC,CAAA;AANY,QAAA,gBAAgB,oBAM5B"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Central Module that contains the methods to issue
+ * HTTPCommands and SocketCommands to a SAGA host
+ * @packageDocumentation
+ */
+/// <reference types="node" />
+import { URLSearchParams } from "url";
+import { ReadMessage, ReadProperty } from "./lib/shared_types";
+/**
+ * The APIError is thrown when a HTTPCommand or SocketCommands fails to execute
+ */
+export declare class APIError extends Error {
+    /**
+     * a saga status code as explained in the actual saga documentation,
+     * very much aligned to HTTP Status codes
+     */
+    statusCode: number;
+    /**
+     * The path of the HTTPCommand or SocketCommand that caused the error
+     */
+    path?: string;
+    /**
+     * Details on what field were not permitted
+     */
+    errors?: Record<string, string>;
+    /**
+     * Create a
+     * @param message the error message
+     * @param statusCode a saga status code as explained in the actual saga documentation, very much aligned to HTTP Status codes
+     * @param errors list of field names and the reason why the field wasn't permitted
+     * @param path The path of the HTTPCommand or SocketCommand that caused the error
+     */
+    constructor(message: string, statusCode: number, errors?: Record<string, string>, path?: string);
+}
+/**
+ * Encapsulates authentication tokens. An authentication object is returned i.e. from {@link LoginUserCommand} It's required for most HTTP Commands.
+ */
+export interface Authentication {
+    /**
+     * Required access token
+     */
+    accessToken: string;
+    /**
+     * Used to retrieve a new access token using {@link RefreshTokenCommand}
+     */
+    refreshToken: string;
+}
+/**
+ * Interface to represent the various mutations of a HTTP Command profile.
+ */
+export interface HTTPCommand<T> {
+    method: "GET" | "PUT" | "POST" | "DELETE";
+    path: string;
+    params?: URLSearchParams;
+    data?: any;
+    accessToken?: string;
+}
+/**
+ * Send the HTTP Command to the host with the given baseURL
+ * @param baseURL the baseURL of the HTTP Api, i.e 'https://example.api.hexagram.io'
+ * @param command the actual command to send
+ * @return a promise containing the response from the command
+ * @throws an APIError if the operations fails
+ */
+export declare const sendHTTPCommand: <T>(baseURL: URL, command: HTTPCommand<T>) => Promise<T>;
+/**
+ * The events a socket session can receive.
+ */
+export interface EventMap {
+    "/properties": ReadProperty;
+    "/messages": ReadMessage;
+    "authenticated": any;
+}
+/**
+ * A socket join command
+ */
+export interface SocketJoinCommand {
+    method: "/users" | "/bots" | "/globals" | "/jobs/runnable_calls" | "/jobs/versions" | "/scripts/runnable_calls" | "/scripts/versions" | "/system" | "/npm_packages";
+    id: string;
+    join: boolean;
+}
+/**
+ * The discriminating union type of socket commands,
+ * for it just contains the join commands, but the
+ * intent is to hold other socket commands as well
+ */
+export type SocketCommand = SocketJoinCommand;
+/**
+ * Class that wraps saga socket connection logic and manages realtime saga socket events. The
+ */
+export declare class SocketSession {
+    private socket;
+    private readonly maxRetries;
+    private commandStack;
+    private ready;
+    /**
+     * Set connection parameters.
+     * @param host the host to connect to
+     * @param accessToken the access token to authenticate
+     * @param errorNotify callback function that will be called when errors occur
+     */
+    constructor(host: URL, accessToken: string, errorNotify: (error: APIError) => any, options?: {
+        delayAuthentication?: number;
+        triggerDisconnectAndConnect?: number;
+    });
+    private emitStackedCommands;
+    on<E extends keyof EventMap>(type: E, listener: (ev: EventMap[E]) => undefined): void;
+    off<E extends keyof EventMap>(type: E, listener?: (ev: EventMap[E]) => undefined): void;
+    /**
+     * Send commands to the server
+     * @param command
+     * @throws APIError if error ack is send back from server
+     */
+    emitCommand(command: SocketCommand): Promise<unknown>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AAIH,OAAO,EAAC,eAAe,EAAC,MAAM,KAAK,CAAC;AACpC,OAAO,EAAC,WAAW,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAQ7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACjC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IAEH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE/B;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM;CAM/F;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,IAAI,CAAC,EAAE,GAAG,CAAE;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAGD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,eAAsB,GAAG,wCAwCpD,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,aAAa,EAAE,YAAY,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,GAAG,CAAC;CAEtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,GACrC,sBAAsB,GAAG,gBAAgB,GACzC,yBAAyB,GAAG,mBAAmB,GAC/C,SAAS,GAAG,eAAe,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAG9C;;GAEG;AACH,qBAAa,aAAa;IAExB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAO;IAClC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;;OAKG;gBAED,IAAI,EAAE,GAAG,EACT,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,GAAG,EACrC,OAAO,CAAC,EAAC;QAAC,mBAAmB,CAAC,EAAC,MAAM,CAAC;QAAA,2BAA2B,CAAC,EAAC,MAAM,CAAA;KAAC;IAyD7E,OAAO,CAAC,mBAAmB;IAW1B,EAAE,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,IAAI;IAKrF,GAAG,CAAC,CAAC,SAAS,MAAM,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,IAAI;IAKvF;;;;OAIG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa;CA0BzC"}

package/dist/cjs/index.js

@@ -0,0 +1,205 @@
+"use strict";
+/**
+ * Central Module that contains the methods to issue
+ * HTTPCommands and SocketCommands to a SAGA host
+ * @packageDocumentation
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketSession = exports.sendHTTPCommand = exports.APIError = void 0;
+const axios_1 = __importDefault(require("axios"));
+const socket_io_client_1 = __importDefault(require("socket.io-client"));
+const parse_link_header_1 = __importDefault(require("parse-link-header"));
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)("saga-ts");
+/**
+ * The APIError is thrown when a HTTPCommand or SocketCommands fails to execute
+ */
+class APIError extends Error {
+    /**
+     * Create a
+     * @param message the error message
+     * @param statusCode a saga status code as explained in the actual saga documentation, very much aligned to HTTP Status codes
+     * @param errors list of field names and the reason why the field wasn't permitted
+     * @param path The path of the HTTPCommand or SocketCommand that caused the error
+     */
+    constructor(message, statusCode, errors, path) {
+        super(message);
+        this.statusCode = statusCode;
+        this.errors = errors;
+        this.path = path;
+    }
+}
+exports.APIError = APIError;
+/**
+ * Send the HTTP Command to the host with the given baseURL
+ * @param baseURL the baseURL of the HTTP Api, i.e 'https://example.api.hexagram.io'
+ * @param command the actual command to send
+ * @return a promise containing the response from the command
+ * @throws an APIError if the operations fails
+ */
+const sendHTTPCommand = (baseURL, command) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e;
+    const headers = { 'Content-Type': 'application/json' };
+    if (command.accessToken) {
+        headers.Authorization = `Bearer ${command.accessToken}`;
+    }
+    const response = yield (0, axios_1.default)({
+        headers,
+        baseURL: baseURL.toString(),
+        validateStatus: () => true,
+        method: command.method,
+        url: command.path,
+        params: command.params,
+        data: command.data
+    });
+    if (response.status !== 200) {
+        throw new APIError(response.data.toString(), response.status, (_a = response.data) === null || _a === void 0 ? void 0 : _a.errors, command.path);
+    }
+    else if (response.headers['link'] || response.headers['link'] === '') {
+        const parsed = (0, parse_link_header_1.default)(response.headers['link']);
+        const list = (url) => {
+            return {
+                method: "GET",
+                path: url.pathname,
+                params: url.searchParams,
+                accessToken: command.accessToken
+            };
+        };
+        return {
+            result: response.data,
+            prevCommand: ((_b = parsed === null || parsed === void 0 ? void 0 : parsed.prev) === null || _b === void 0 ? void 0 : _b.url) ? list(new URL((_c = parsed === null || parsed === void 0 ? void 0 : parsed.prev) === null || _c === void 0 ? void 0 : _c.url)) : undefined,
+            nextCommand: ((_d = parsed === null || parsed === void 0 ? void 0 : parsed.next) === null || _d === void 0 ? void 0 : _d.url) ? list(new URL((_e = parsed === null || parsed === void 0 ? void 0 : parsed.next) === null || _e === void 0 ? void 0 : _e.url)) : undefined
+        };
+    }
+    else {
+        return response.data;
+    }
+});
+exports.sendHTTPCommand = sendHTTPCommand;
+/**
+ * Class that wraps saga socket connection logic and manages realtime saga socket events. The
+ */
+class SocketSession {
+    /**
+     * Set connection parameters.
+     * @param host the host to connect to
+     * @param accessToken the access token to authenticate
+     * @param errorNotify callback function that will be called when errors occur
+     */
+    constructor(host, accessToken, errorNotify, options) {
+        this.maxRetries = 100;
+        this.commandStack = [];
+        this.ready = false;
+        this.socket = (0, socket_io_client_1.default)(host.toString(), {
+            transports: ['websocket', 'polling'],
+            reconnection: true,
+            reconnectionDelay: 1000,
+            reconnectionDelayMax: 5000,
+            reconnectionAttempts: this.maxRetries,
+        })
+            .on('connect', () => {
+            debug('connect');
+            if ((options === null || options === void 0 ? void 0 : options.delayAuthentication) && (options === null || options === void 0 ? void 0 : options.delayAuthentication) > 0) {
+                setTimeout(() => this.socket.emit('authentication', { accessToken }), options.delayAuthentication);
+            }
+            else {
+                this.socket.emit('authentication', { accessToken });
+            }
+            if ((options === null || options === void 0 ? void 0 : options.triggerDisconnectAndConnect) && options.triggerDisconnectAndConnect > 0) {
+                setTimeout(() => {
+                    options.triggerDisconnectAndConnect = 0;
+                    this.socket.disconnect();
+                    this.socket.connect();
+                    this.emitStackedCommands();
+                }, options.triggerDisconnectAndConnect);
+            }
+            //this.socket.emit('authentication', {accessToken});
+        })
+            .on('disconnect', err => {
+            this.ready = false;
+            debug(`disconnect ${err}`);
+        })
+            .on('error', err => {
+            debug(`error ${err}`);
+            errorNotify(new APIError(err.message, 500));
+        })
+            .on('unauthorized', (err) => {
+            debug('unauthorized');
+            errorNotify(new APIError(err.message, 401));
+        })
+            .on('authenticated', () => {
+            debug('authenticated');
+            this.ready = true;
+            this.emitStackedCommands();
+        });
+        this.socket.io.on('reconnect', () => {
+            debug('reconnect');
+            this.emitStackedCommands();
+        });
+    }
+    emitStackedCommands() {
+        debug(`emitStackedCommands ${this.commandStack.length}`);
+        for (const command of this.commandStack) {
+            debug(`send queued ${command.method} ${command.join} ${command.id}`);
+            this.socket.emit(`${command.method}/${command.join ? "join" : "leave"}`, command.id, (response) => {
+                debug(`queued command response ${response.status_code}`);
+            });
+        }
+        this.commandStack = this.commandStack.filter(command => command.join !== undefined);
+    }
+    on(type, listener) {
+        //@ts-ignore
+        this.socket.on(type, listener);
+    }
+    off(type, listener) {
+        //@ts-ignore
+        this.socket.off(type, listener);
+    }
+    /**
+     * Send commands to the server
+     * @param command
+     * @throws APIError if error ack is send back from server
+     */
+    emitCommand(command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                if (!this.ready) {
+                    debug(`command queued ${command.method} ${command.join} ${command.id}`);
+                    this.commandStack.push(command);
+                }
+                else {
+                    debug(`sending ${command.method}`);
+                    const path = `${command.method}/${command.join ? "join" : "leave"}`;
+                    this.socket.emit(path, command.id, (response) => {
+                        debug(`received ack ${response.status_code} for ${command.method} `);
+                        if (response.status_code !== 200) {
+                            reject(new APIError(response.body.name.toString(), response.status_code, response.body.errors, path));
+                        }
+                        else {
+                            //we only need to queue messages that join/leave
+                            //for replay when the socket reconnects
+                            if (command.join !== undefined) {
+                                this.commandStack.push(command);
+                            }
+                            resolve(response);
+                        }
+                    });
+                }
+            });
+        });
+    }
+}
+exports.SocketSession = SocketSession;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;AAEH,kDAA4C;AAC5C,wEAAkD;AAGlD,0EAAgD;AAChD,kDAA0B;AAG1B,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,SAAS,CAAC,CAAC;AAG/B;;GAEG;AACH,MAAa,QAAS,SAAQ,KAAK;IAiBjC;;;;;;OAMG;IACH,YAAY,OAAe,EAAE,UAAkB,EAAE,MAA8B,EAAE,IAAa;QAC5F,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AA9BD,4BA8BC;AA4BD;;;;;;GAMG;AACI,MAAM,eAAe,GAAG,CAAU,OAAY,EAAE,OAAuB,EAAc,EAAE;;IAE5F,MAAM,OAAO,GAA2B,EAAC,cAAc,EAAE,kBAAkB,EAAC,CAAA;IAC5E,IAAI,OAAO,CAAC,WAAW,EAAE;QACvB,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,CAAC,WAAW,EAAE,CAAC;KACzD;IAED,MAAM,QAAQ,GAAkB,MAAM,IAAA,eAAK,EAAI;QAC7C,OAAO;QACP,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;QAC3B,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;QAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,GAAG,EAAE,OAAO,CAAC,IAAI;QACjB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC,CAAA;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;QAC3B,MAAM,IAAI,QAAQ,CAAG,QAAQ,CAAC,IAAe,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAA,QAAQ,CAAC,IAAI,0CAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;KACjH;SAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE;QACtE,MAAM,MAAM,GAAG,IAAA,2BAAe,EAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;QAExD,MAAM,IAAI,GAAG,CAAI,GAAQ,EAAkB,EAAE;YAC3C,OAAO;gBACL,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,GAAG,CAAC,QAAQ;gBAClB,MAAM,EAAE,GAAG,CAAC,YAAY;gBACxB,WAAW,EAAE,OAAO,CAAC,WAAW;aACjC,CAAA;QACH,CAAC,CAAA;QAED,OAAU;YACR,MAAM,EAAE,QAAQ,CAAC,IAAI;YACrB,WAAW,EAAE,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,0CAAE,GAAG,EAAC,CAAC,CAAC,IAAI,CAAI,IAAI,GAAG,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,0CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;YAChF,WAAW,EAAE,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,0CAAE,GAAG,EAAC,CAAC,CAAC,IAAI,CAAI,IAAI,GAAG,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,0CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACjF,CAAA;KACF;SAAM;QACL,OAAO,QAAQ,CAAC,IAAI,CAAA;KACrB;AAEH,CAAC,CAAA,CAAA;AAxCY,QAAA,eAAe,mBAwC3B;AAgCD;;GAEG;AACH,MAAa,aAAa;IAOxB;;;;;OAKG;IACH,YACE,IAAS,EACT,WAAmB,EACnB,WAAqC,EACrC,OAA0E;QAd3D,eAAU,GAAG,GAAG,CAAC;QAC1B,iBAAY,GAAoB,EAAE,CAAC;QACnC,UAAK,GAAG,KAAK,CAAC;QAgBpB,IAAI,CAAC,MAAM,GAAG,IAAA,0BAAQ,EAAC,IAAI,CAAC,QAAQ,EAAE,EAAE;YACtC,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YACpC,YAAY,EAAE,IAAI;YAClB,iBAAiB,EAAE,IAAI;YACvB,oBAAoB,EAAE,IAAI;YAC1B,oBAAoB,EAAE,IAAI,CAAC,UAAU;SACtC,CAAC;aACC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAClB,KAAK,CAAC,SAAS,CAAC,CAAC;YACjB,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,KAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,IAAG,CAAC,EAAE;gBACpE,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAC,WAAW,EAAC,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;aAClG;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAC,WAAW,EAAC,CAAC,CAAA;aAClD;YACD,IAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,2BAA2B,KAAI,OAAO,CAAC,2BAA2B,GAAC,CAAC,EAAC;gBAC/E,UAAU,CAAC,GAAG,EAAE;oBACd,OAAO,CAAC,2BAA2B,GAAC,CAAC,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;oBACxB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACtB,IAAI,CAAC,mBAAmB,EAAE,CAAA;gBAC5B,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;aACzC;YACD,oDAAoD;QAEtD,CAAC,CAAC;aACD,EAAE,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE;YACtB,IAAI,CAAC,KAAK,GAAC,KAAK,CAAC;YACjB,KAAK,CAAC,cAAc,GAAG,EAAE,CAAC,CAAC;QAE7B,CAAC,CAAC;aACD,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;YACjB,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;YACtB,WAAW,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QAC7C,CAAC,CAAC;aACD,EAAE,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1B,KAAK,CAAC,cAAc,CAAC,CAAC;YACtB,WAAW,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QAC7C,CAAC,CAAC;aACD,EAAE,CAAC,eAAe,EAAE,GAAG,EAAE;YACxB,KAAK,CAAC,eAAe,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAClC,KAAK,CAAC,WAAW,CAAC,CAAC;YACnB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;IAGJ,CAAC;IAGM,mBAAmB;QACxB,KAAK,CAAC,uBAAuB,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QACzD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,EAAE;YACvC,KAAK,CAAC,eAAe,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAa,EAAE,EAAE;gBACrG,KAAK,CAAC,2BAA2B,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAA;SACH;QACF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAE,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;IACrF,CAAC;IAED,EAAE,CAA2B,IAAO,EAAE,QAAwC;QAC5E,YAAY;QACZ,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED,GAAG,CAA2B,IAAO,EAAE,QAAyC;QAC9E,YAAY;QACZ,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACG,WAAW,CAAC,OAAsB;;YACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAErC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACf,KAAK,CAAC,kBAAkB,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;oBACxE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;iBAChC;qBAAM;oBACL,KAAK,CAAC,WAAW,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;oBACnC,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAA;oBACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,QAAa,EAAE,EAAE;wBACjD,KAAK,CAAC,gBAAgB,QAAQ,CAAC,WAAW,QAAQ,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;wBACrE,IAAI,QAAQ,CAAC,WAAW,KAAK,GAAG,EAAE;4BAC/B,MAAM,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;yBACxG;6BAAM;4BACL,gDAAgD;4BAChD,uCAAuC;4BACvC,IAAG,OAAO,CAAC,IAAI,KAAK,SAAS,EAAC;gCAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;6BAChC;4BACD,OAAO,CAAC,QAAQ,CAAC,CAAA;yBAClB;oBACH,CAAC,CACF,CAAA;iBACF;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;CACF;AA9HD,sCA8HC"}

package/dist/cjs/lib/shared_types.d.ts

@@ -0,0 +1,58 @@
+import { HTTPCommand } from "../index";
+/**
+ * Will be used in Read* Objects that have a timestamp
+ * @hidden
+ */
+export interface TimeStamp {
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * For read* Objects that have an _id
+ * @hidden
+ */
+export interface Id {
+    _id: string;
+}
+/**
+ * For read* Objects that have an _id
+ * @hidden
+ */
+export interface TestData {
+    /**
+     * Is true when the data is for testing only
+     */
+    test_data?: boolean;
+}
+export interface Tags {
+    tags?: [string];
+}
+/**
+ * For read* Objects that have an _id
+ */
+export interface List<T> {
+    prevCommand?: HTTPCommand<List<T>>;
+    nextCommand?: HTTPCommand<List<T>>;
+    result: T[];
+}
+/**
+ * Create Property Interface
+ */
+export interface CreateProperty extends TestData {
+    name: string;
+    value: any;
+    parent_id?: string;
+}
+export interface ReadProperty extends CreateProperty {
+    _id: string;
+    createdAt: Date;
+}
+export interface CreateMessage extends TestData {
+    body: string;
+    from: "user" | "bot";
+    user_id: string;
+    bot_id: string;
+}
+export interface ReadMessage extends CreateMessage, Id, TimeStamp {
+}
+//# sourceMappingURL=shared_types.d.ts.map

package/dist/cjs/lib/shared_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared_types.d.ts","sourceRoot":"","sources":["../../../src/lib/shared_types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,UAAU,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,EAAE;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,WAAW,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAClC,WAAW,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,EAAE,CAAC,EAAE,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAY,SAAQ,aAAa,EAAE,EAAE,EAAE,SAAS;CAEhE"}

package/dist/cjs/lib/shared_types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared_types.js.map

package/dist/cjs/lib/shared_types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared_types.js","sourceRoot":"","sources":["../../../src/lib/shared_types.ts"],"names":[],"mappings":""}

package/dist/commands/bots.d.ts

@@ -0,0 +1,74 @@
+import { HTTPCommand, SocketCommand } from "../index";
+import { CreateProperty, Id, List, ReadProperty, Tags, TestData, TimeStamp } from "../lib/shared_types";
+export interface CreateBot extends TestData, Tags {
+    name: string;
+}
+export interface UpdateBot extends CreateBot, Id {
+}
+export interface ReadBot extends UpdateBot, TimeStamp {
+    properties: Record<string, ReadProperty>;
+}
+/**
+ * List Bots command
+ * @param search search criteria for bots
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const ListBotsCommand: (accessToken: string, search?: string) => HTTPCommand<List<ReadBot>>;
+/**
+ * Create a new bot command
+ * @param data a CreateBot Object
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare function CreateBotCommand(accessToken: string, data: CreateBot): HTTPCommand<ReadBot>;
+/**
+ * Create an array of bots command
+ * @param data a CreateBot Object array
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare function CreateBotsCommand(accessToken: string, data: CreateBot[]): HTTPCommand<ReadBot[]>;
+/**
+ * Get a bot command
+ * @param id the id of the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const GetBotCommand: (accessToken: string, id: string) => HTTPCommand<ReadBot>;
+/**
+ * Update the bot command
+ * @param data the bot needing to be updated, the _id of the bot is used to select the bot
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const UpdateBotCommand: (accessToken: string, data: UpdateBot) => HTTPCommand<ReadBot>;
+/**
+ * Delete a bot command
+ * @param id the id of the bot to delete
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const DeleteBotCommand: (accessToken: string, _id: string) => HTTPCommand<{
+    ok: true;
+}>;
+/**
+ * Add a bot property command
+ * @param data the property
+ * @param accessToken the required accessToken
+ * @group HTTP Commands
+ */
+export declare const AddBotPropertyCommand: (accessToken: string, data: CreateProperty) => HTTPCommand<ReadProperty>;
+/**
+ * A command to join a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+export declare const JoinBotCommand: (_id: string) => SocketCommand;
+/**
+ * A command to leave a bots realtime socket
+ * @param _id id of the bot
+ * @group Socket Commands
+ */
+export declare const LeaveBotCommand: (_id: string) => SocketCommand;
+//# sourceMappingURL=bots.d.ts.map