mavenagi 1.2.10 → 1.2.11

package/core/websocket/ws.js

@@ -0,0 +1,444 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReconnectingWebSocket = void 0;
+const ws_1 = require("ws");
+const runtime_1 = require("../runtime");
+const qs_1 = require("../url/qs");
+const Events = __importStar(require("./events"));
+const getGlobalWebSocket = () => {
+    if (typeof WebSocket !== "undefined") {
+        // @ts-ignore
+        return WebSocket;
+    }
+    else if (runtime_1.RUNTIME.type === "node") {
+        return ws_1.WebSocket;
+    }
+    return undefined;
+};
+/**
+ * Returns true if given argument looks like a WebSocket class
+ */
+const isWebSocket = (w) => typeof w !== "undefined" && !!w && w.CLOSING === 2;
+const DEFAULT_OPTIONS = {
+    maxReconnectionDelay: 10000,
+    minReconnectionDelay: 1000 + Math.random() * 4000,
+    minUptime: 5000,
+    reconnectionDelayGrowFactor: 1.3,
+    connectionTimeout: 4000,
+    maxRetries: Infinity,
+    maxEnqueuedMessages: Infinity,
+    startClosed: false,
+    debug: false,
+};
+class ReconnectingWebSocket {
+    constructor({ url, protocols, options, headers, queryParameters }) {
+        this._listeners = {
+            error: [],
+            message: [],
+            open: [],
+            close: [],
+        };
+        this._retryCount = -1;
+        this._shouldReconnect = true;
+        this._connectLock = false;
+        this._binaryType = "blob";
+        this._closeCalled = false;
+        this._messageQueue = [];
+        this.CONNECTING = ReconnectingWebSocket.CONNECTING;
+        this.OPEN = ReconnectingWebSocket.OPEN;
+        this.CLOSING = ReconnectingWebSocket.CLOSING;
+        this.CLOSED = ReconnectingWebSocket.CLOSED;
+        /**
+         * An event listener to be called when the WebSocket connection's readyState changes to CLOSED
+         */
+        this.onclose = null;
+        /**
+         * An event listener to be called when an error occurs
+         */
+        this.onerror = null;
+        /**
+         * An event listener to be called when a message is received from the server
+         */
+        this.onmessage = null;
+        /**
+         * An event listener to be called when the WebSocket connection's readyState changes to OPEN;
+         * this indicates that the connection is ready to send and receive data
+         */
+        this.onopen = null;
+        this._handleOpen = (event) => {
+            this._debug("open event");
+            const { minUptime = DEFAULT_OPTIONS.minUptime } = this._options;
+            clearTimeout(this._connectTimeout);
+            this._uptimeTimeout = setTimeout(() => this._acceptOpen(), minUptime);
+            this._ws.binaryType = this._binaryType;
+            // send enqueued messages (messages sent before websocket open event)
+            this._messageQueue.forEach((message) => { var _a; return (_a = this._ws) === null || _a === void 0 ? void 0 : _a.send(message); });
+            this._messageQueue = [];
+            if (this.onopen) {
+                this.onopen(event);
+            }
+            this._listeners.open.forEach((listener) => this._callEventListener(event, listener));
+        };
+        this._handleMessage = (event) => {
+            this._debug("message event");
+            if (this.onmessage) {
+                this.onmessage(event);
+            }
+            this._listeners.message.forEach((listener) => this._callEventListener(event, listener));
+        };
+        this._handleError = (event) => {
+            this._debug("error event", event.message);
+            this._disconnect(undefined, event.message === "TIMEOUT" ? "timeout" : undefined);
+            if (this.onerror) {
+                this.onerror(event);
+            }
+            this._debug("exec error listeners");
+            this._listeners.error.forEach((listener) => this._callEventListener(event, listener));
+            this._connect();
+        };
+        this._handleClose = (event) => {
+            this._debug("close event");
+            this._clearTimeouts();
+            if (event.code === 1000) {
+                this._shouldReconnect = false;
+            }
+            if (this._shouldReconnect) {
+                this._connect();
+            }
+            if (this.onclose) {
+                this.onclose(event);
+            }
+            this._listeners.close.forEach((listener) => this._callEventListener(event, listener));
+        };
+        this._url = url;
+        this._protocols = protocols;
+        this._options = options !== null && options !== void 0 ? options : DEFAULT_OPTIONS;
+        this._headers = headers;
+        this._queryParameters = queryParameters;
+        if (this._options.startClosed) {
+            this._shouldReconnect = false;
+        }
+        this._connect();
+    }
+    get binaryType() {
+        return this._ws ? this._ws.binaryType : this._binaryType;
+    }
+    set binaryType(value) {
+        this._binaryType = value;
+        if (this._ws) {
+            this._ws.binaryType = value;
+        }
+    }
+    /**
+     * Returns the number or connection retries
+     */
+    get retryCount() {
+        return Math.max(this._retryCount, 0);
+    }
+    /**
+     * The number of bytes of data that have been queued using calls to send() but not yet
+     * transmitted to the network. This value resets to zero once all queued data has been sent.
+     * This value does not reset to zero when the connection is closed; if you keep calling send(),
+     * this will continue to climb. Read only
+     */
+    get bufferedAmount() {
+        const bytes = this._messageQueue.reduce((acc, message) => {
+            if (typeof message === "string") {
+                acc += message.length; // not byte size
+            }
+            else if (message instanceof Blob) {
+                acc += message.size;
+            }
+            else {
+                acc += message.byteLength;
+            }
+            return acc;
+        }, 0);
+        return bytes + (this._ws ? this._ws.bufferedAmount : 0);
+    }
+    /**
+     * The extensions selected by the server. This is currently only the empty string or a list of
+     * extensions as negotiated by the connection
+     */
+    get extensions() {
+        return this._ws ? this._ws.extensions : "";
+    }
+    /**
+     * A string indicating the name of the sub-protocol the server selected;
+     * this will be one of the strings specified in the protocols parameter when creating the
+     * WebSocket object
+     */
+    get protocol() {
+        return this._ws ? this._ws.protocol : "";
+    }
+    /**
+     * The current state of the connection; this is one of the Ready state constants
+     */
+    get readyState() {
+        if (this._ws) {
+            return this._ws.readyState;
+        }
+        return this._options.startClosed ? ReconnectingWebSocket.CLOSED : ReconnectingWebSocket.CONNECTING;
+    }
+    /**
+     * The URL as resolved by the constructor
+     */
+    get url() {
+        return this._ws ? this._ws.url : "";
+    }
+    /**
+     * Closes the WebSocket connection or connection attempt, if any. If the connection is already
+     * CLOSED, this method does nothing
+     */
+    close(code = 1000, reason) {
+        this._closeCalled = true;
+        this._shouldReconnect = false;
+        this._clearTimeouts();
+        if (!this._ws) {
+            this._debug("close enqueued: no ws instance");
+            return;
+        }
+        if (this._ws.readyState === this.CLOSED) {
+            this._debug("close: already closed");
+            return;
+        }
+        this._ws.close(code, reason);
+    }
+    /**
+     * Closes the WebSocket connection or connection attempt and connects again.
+     * Resets retry counter;
+     */
+    reconnect(code, reason) {
+        this._shouldReconnect = true;
+        this._closeCalled = false;
+        this._retryCount = -1;
+        if (!this._ws || this._ws.readyState === this.CLOSED) {
+            this._connect();
+        }
+        else {
+            this._disconnect(code, reason);
+            this._connect();
+        }
+    }
+    /**
+     * Enqueue specified data to be transmitted to the server over the WebSocket connection
+     */
+    send(data) {
+        if (this._ws && this._ws.readyState === this.OPEN) {
+            this._debug("send", data);
+            this._ws.send(data);
+        }
+        else {
+            const { maxEnqueuedMessages = DEFAULT_OPTIONS.maxEnqueuedMessages } = this._options;
+            if (this._messageQueue.length < maxEnqueuedMessages) {
+                this._debug("enqueue", data);
+                this._messageQueue.push(data);
+            }
+        }
+    }
+    /**
+     * Register an event handler of a specific event type
+     */
+    addEventListener(type, listener) {
+        if (this._listeners[type]) {
+            // @ts-ignore
+            this._listeners[type].push(listener);
+        }
+    }
+    dispatchEvent(event) {
+        const listeners = this._listeners[event.type];
+        if (listeners) {
+            for (const listener of listeners) {
+                this._callEventListener(event, listener);
+            }
+        }
+        return true;
+    }
+    /**
+     * Removes an event listener
+     */
+    removeEventListener(type, listener) {
+        if (this._listeners[type]) {
+            // @ts-ignore
+            this._listeners[type] = this._listeners[type].filter(
+            // @ts-ignore
+            (l) => l !== listener);
+        }
+    }
+    _debug(...args) {
+        if (this._options.debug) {
+            // not using spread because compiled version uses Symbols
+            // tslint:disable-next-line
+            // biome-ignore lint/suspicious/noConsole: allow console
+            console.log.apply(console, ["RWS>", ...args]);
+        }
+    }
+    _getNextDelay() {
+        const { reconnectionDelayGrowFactor = DEFAULT_OPTIONS.reconnectionDelayGrowFactor, minReconnectionDelay = DEFAULT_OPTIONS.minReconnectionDelay, maxReconnectionDelay = DEFAULT_OPTIONS.maxReconnectionDelay, } = this._options;
+        let delay = 0;
+        if (this._retryCount > 0) {
+            delay = minReconnectionDelay * Math.pow(reconnectionDelayGrowFactor, (this._retryCount - 1));
+            if (delay > maxReconnectionDelay) {
+                delay = maxReconnectionDelay;
+            }
+        }
+        this._debug("next delay", delay);
+        return delay;
+    }
+    _wait() {
+        return new Promise((resolve) => {
+            setTimeout(resolve, this._getNextDelay());
+        });
+    }
+    _getNextUrl(urlProvider) {
+        if (typeof urlProvider === "string") {
+            return Promise.resolve(urlProvider);
+        }
+        if (typeof urlProvider === "function") {
+            const url = urlProvider();
+            if (typeof url === "string") {
+                return Promise.resolve(url);
+            }
+            // @ts-ignore redundant check
+            if (url.then) {
+                return url;
+            }
+        }
+        throw Error("Invalid URL");
+    }
+    _connect() {
+        if (this._connectLock || !this._shouldReconnect) {
+            return;
+        }
+        this._connectLock = true;
+        const { maxRetries = DEFAULT_OPTIONS.maxRetries, connectionTimeout = DEFAULT_OPTIONS.connectionTimeout, WebSocket = getGlobalWebSocket(), } = this._options;
+        if (this._retryCount >= maxRetries) {
+            this._debug("max retries reached", this._retryCount, ">=", maxRetries);
+            return;
+        }
+        this._retryCount++;
+        this._debug("connect", this._retryCount);
+        this._removeListeners();
+        if (!isWebSocket(WebSocket)) {
+            throw Error("No valid WebSocket class provided");
+        }
+        this._wait()
+            .then(() => this._getNextUrl(this._url))
+            .then((url) => {
+            if (this._closeCalled) {
+                return;
+            }
+            const options = {};
+            if (this._headers) {
+                options.headers = this._headers;
+            }
+            if (this._queryParameters && Object.keys(this._queryParameters).length > 0) {
+                const queryString = (0, qs_1.toQueryString)(this._queryParameters, { arrayFormat: "repeat" });
+                if (queryString) {
+                    url = `${url}?${queryString}`;
+                }
+            }
+            this._ws = new WebSocket(url, this._protocols, options);
+            this._ws.binaryType = this._binaryType;
+            this._connectLock = false;
+            this._addListeners();
+            this._connectTimeout = setTimeout(() => this._handleTimeout(), connectionTimeout);
+        });
+    }
+    _handleTimeout() {
+        this._debug("timeout event");
+        this._handleError(new Events.ErrorEvent(Error("TIMEOUT"), this));
+    }
+    _disconnect(code = 1000, reason) {
+        this._clearTimeouts();
+        if (!this._ws) {
+            return;
+        }
+        this._removeListeners();
+        try {
+            this._ws.close(code, reason);
+            this._handleClose(new Events.CloseEvent(code, reason, this));
+        }
+        catch (_error) {
+            // ignore
+        }
+    }
+    _acceptOpen() {
+        this._debug("accept open");
+        this._retryCount = 0;
+    }
+    _callEventListener(event, listener) {
+        if ("handleEvent" in listener) {
+            // @ts-ignore
+            listener.handleEvent(event);
+        }
+        else {
+            // @ts-ignore
+            listener(event);
+        }
+    }
+    _removeListeners() {
+        if (!this._ws) {
+            return;
+        }
+        this._debug("removeListeners");
+        this._ws.removeEventListener("open", this._handleOpen);
+        this._ws.removeEventListener("close", this._handleClose);
+        this._ws.removeEventListener("message", this._handleMessage);
+        // @ts-ignore
+        this._ws.removeEventListener("error", this._handleError);
+    }
+    _addListeners() {
+        if (!this._ws) {
+            return;
+        }
+        this._debug("addListeners");
+        this._ws.addEventListener("open", this._handleOpen);
+        this._ws.addEventListener("close", this._handleClose);
+        this._ws.addEventListener("message", this._handleMessage);
+        // @ts-ignore
+        this._ws.addEventListener("error", this._handleError);
+    }
+    _clearTimeouts() {
+        clearTimeout(this._connectTimeout);
+        clearTimeout(this._uptimeTimeout);
+    }
+}
+exports.ReconnectingWebSocket = ReconnectingWebSocket;
+ReconnectingWebSocket.CONNECTING = 0;
+ReconnectingWebSocket.OPEN = 1;
+ReconnectingWebSocket.CLOSING = 2;
+ReconnectingWebSocket.CLOSED = 3;

package/dist/Client.d.ts

@@ -3,6 +3,7 @@ import { Agents } from "./api/resources/agents/client/Client";
 import { Analytics } from "./api/resources/analytics/client/Client";
 import { AppSettings } from "./api/resources/appSettings/client/Client";
 import { Assets } from "./api/resources/assets/client/Client";
+import { Auth } from "./api/resources/auth/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Customers } from "./api/resources/customers/client/Client";
 import { Events } from "./api/resources/events/client/Client";
@@ -13,6 +14,7 @@ import { Segments } from "./api/resources/segments/client/Client";
 import { Translations } from "./api/resources/translations/client/Client";
 import { Triggers } from "./api/resources/triggers/client/Client";
 import { Users } from "./api/resources/users/client/Client";
+import { Websockets } from "./api/resources/websockets/client/Client";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient";
 export declare namespace MavenAGIClient {
     interface Options extends BaseClientOptions {
@@ -27,6 +29,7 @@ export declare class MavenAGIClient {
     protected _analytics: Analytics | undefined;
     protected _appSettings: AppSettings | undefined;
     protected _assets: Assets | undefined;
+    protected _auth: Auth | undefined;
     protected _conversation: Conversation | undefined;
     protected _customers: Customers | undefined;
     protected _events: Events | undefined;
@@ -37,12 +40,14 @@ export declare class MavenAGIClient {
     protected _translations: Translations | undefined;
     protected _triggers: Triggers | undefined;
     protected _users: Users | undefined;
+    protected _websockets: Websockets | undefined;
     constructor(_options: MavenAGIClient.Options);
     get actions(): Actions;
     get agents(): Agents;
     get analytics(): Analytics;
     get appSettings(): AppSettings;
     get assets(): Assets;
+    get auth(): Auth;
     get conversation(): Conversation;
     get customers(): Customers;
     get events(): Events;
@@ -53,4 +58,5 @@ export declare class MavenAGIClient {
     get translations(): Translations;
     get triggers(): Triggers;
     get users(): Users;
+    get websockets(): Websockets;
 }

package/dist/Client.js

@@ -40,16 +40,18 @@ const Client_2 = require("./api/resources/agents/client/Client");
 const Client_3 = require("./api/resources/analytics/client/Client");
 const Client_4 = require("./api/resources/appSettings/client/Client");
 const Client_5 = require("./api/resources/assets/client/Client");
-const Client_6 = require("./api/resources/conversation/client/Client");
-const Client_7 = require("./api/resources/customers/client/Client");
-const Client_8 = require("./api/resources/events/client/Client");
-const Client_9 = require("./api/resources/inbox/client/Client");
-const Client_10 = require("./api/resources/knowledge/client/Client");
-const Client_11 = require("./api/resources/organizations/client/Client");
-const Client_12 = require("./api/resources/segments/client/Client");
-const Client_13 = require("./api/resources/translations/client/Client");
-const Client_14 = require("./api/resources/triggers/client/Client");
-const Client_15 = require("./api/resources/users/client/Client");
+const Client_6 = require("./api/resources/auth/client/Client");
+const Client_7 = require("./api/resources/conversation/client/Client");
+const Client_8 = require("./api/resources/customers/client/Client");
+const Client_9 = require("./api/resources/events/client/Client");
+const Client_10 = require("./api/resources/inbox/client/Client");
+const Client_11 = require("./api/resources/knowledge/client/Client");
+const Client_12 = require("./api/resources/organizations/client/Client");
+const Client_13 = require("./api/resources/segments/client/Client");
+const Client_14 = require("./api/resources/translations/client/Client");
+const Client_15 = require("./api/resources/triggers/client/Client");
+const Client_16 = require("./api/resources/users/client/Client");
+const Client_17 = require("./api/resources/websockets/client/Client");
 const core = __importStar(require("./core"));
 const headers_1 = require("./core/headers");
 class MavenAGIClient {
@@ -59,8 +61,8 @@ class MavenAGIClient {
                 "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "mavenagi",
-                "X-Fern-SDK-Version": "1.2.10",
-                "User-Agent": "mavenagi/1.2.10",
+                "X-Fern-SDK-Version": "1.2.11",
+                "User-Agent": "mavenagi/1.2.11",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -85,45 +87,53 @@ class MavenAGIClient {
         var _a;
         return ((_a = this._assets) !== null && _a !== void 0 ? _a : (this._assets = new Client_5.Assets(this._options)));
     }
+    get auth() {
+        var _a;
+        return ((_a = this._auth) !== null && _a !== void 0 ? _a : (this._auth = new Client_6.Auth(this._options)));
+    }
     get conversation() {
         var _a;
-        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_6.Conversation(this._options)));
+        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_7.Conversation(this._options)));
     }
     get customers() {
         var _a;
-        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_7.Customers(this._options)));
+        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_8.Customers(this._options)));
     }
     get events() {
         var _a;
-        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_8.Events(this._options)));
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_9.Events(this._options)));
     }
     get inbox() {
         var _a;
-        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_9.Inbox(this._options)));
+        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_10.Inbox(this._options)));
     }
     get knowledge() {
         var _a;
-        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_10.Knowledge(this._options)));
+        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_11.Knowledge(this._options)));
     }
     get organizations() {
         var _a;
-        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_11.Organizations(this._options)));
+        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_12.Organizations(this._options)));
     }
     get segments() {
         var _a;
-        return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_12.Segments(this._options)));
+        return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_13.Segments(this._options)));
     }
     get translations() {
         var _a;
-        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_13.Translations(this._options)));
+        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_14.Translations(this._options)));
     }
     get triggers() {
         var _a;
-        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_14.Triggers(this._options)));
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_15.Triggers(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_15.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_16.Users(this._options)));
+    }
+    get websockets() {
+        var _a;
+        return ((_a = this._websockets) !== null && _a !== void 0 ? _a : (this._websockets = new Client_17.Websockets(this._options)));
     }
 }
 exports.MavenAGIClient = MavenAGIClient;

package/dist/api/resources/auth/client/Client.d.ts

@@ -0,0 +1,33 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Auth {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Auth {
+    protected readonly _options: Auth.Options;
+    constructor(_options: Auth.Options);
+    /**
+     * Creates a short-lived session token that can be used to authenticate
+     * WebSocket connections. Session tokens are useful for client-side applications where
+     * you don’t want to expose your API key.
+     *
+     * @param {MavenAGI.SessionTokenRequest} request
+     * @param {Auth.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.auth.sessionToken({
+     *         ttlSeconds: 3600
+     *     })
+     */
+    sessionToken(request: MavenAGI.SessionTokenRequest, requestOptions?: Auth.RequestOptions): core.HttpResponsePromise<MavenAGI.SessionTokenResponse>;
+    private __sessionToken;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}