Cognigy Socket Client

This package is used to create a connection to Cognigy.AI via a Socket Endpoint.
You can read about setting up a Socket Endpoint in our platform documentation

Installation

Install this module using the following npm command

npm install @cognigy/socket-client

Usage

const { SocketClient } = require("@cognigy/socket-client");

(async () => {
  // create a client instance with a socket url and an url token
  const client = new SocketClient("https://socket.url", "socket-token", {
    // if you use node, internet explorer or safari, you need to enforce websockets
    forceWebsockets: true,
  });

  // register a handler for messages
  client.on("output", (output) => {
    console.log("Text: " + output.text + "   Data: " + output.data);
  });

  // establish a socket connection (returns a promise)
  await client.connect();

  // send a message with text, text and data, data only
  client.sendMessage("hello there");
  client.sendMessage("hello there", { color: "green" });
  client.sendMessage("", { color: "green" });
})();

In case you are using TypeScript in a frontend codebase, you may need to manually install @types/node to avoid transpilation errors regarding event-related code parts like e.g. client.on()

Compatibility

| SocketClient | Cognigy.AI | Note | | - | - | - | | >= v4.8.1 | >= v4.79.0 | Starting with SocketClient version v4.8.1, the client waits for an "endpoint-ready" event during connect() which is only emitted by Endpoints from Cognigy.AI version v4.79.0 or later! | <= v4.8.0 | * |

Socket Events

You can subscribe to the following events from the SocketClient:

client.on("finalPing", () => {
  console.log("bot is done processing a message");
});

| Name | Event Payload | Description | | ------------ | ----------------- | --------------------------------------------------- | | output | { text, data } | fires on every incoming message from the bot | | typingStatus | "on" or "off" | fires when the typing indicator should show or hide | | finalPing | - | fires when the bot is done processing a message | | error | { message } | fires when an error happened in the bot |

Options

You can pass a third argument to SocketClient to set additional options as follows:

const client = new SocketClient("https://socket.url", "socket-token", {
  userId: "user1234",
});

| Name | Type | Default | Description ' | | ---------------------------- | ------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | userId | string | random string | the user id for the conversation | | sessionId | string | random string | the session id for the conversation | | channel | string | "socket-client" | the name of the channel (can be used for analytics purposes) | | forceWebsockets | boolean | auto-determined by runtime-environment | If this is enabled, the client will only use websockets and not fall back to http polling (wins over disableWebsockets) | | disableWebsockets | boolean | false | If this is enabled, the client will only use http polling and will not try to upgrade to websockets | | interval | number | 10000 | the interval for polling if in http polling fallback | | reconnection | boolean | true | if enabled, will try to reconnect if the connection is aborted | | reconnectionLimit | number | 5 | limit the maximum number of reconnection attempts, 0 means no limit | | enableInnerSocketHandshake | boolean | false | If this is enabled, the session parameters (userId, sessionId, urlToken) will be transferred through the websocket instead of query params |