crisp-api 10.0.17 → 10.0.18

package/CHANGELOG.md

@@ -1,9 +1,13 @@
 Changelog
 =========
 
+## v10.0.18
+
+* Added the new `CrispClient.setCustomHeaders` method to set custom headers for all API requests.
+
 ## v10.0.17
 
-* Add `stamped` to `ConversationMessage`
+* Add `stamped` to `ConversationMessage`.
 
 ## v10.0.16
 

package/README.md

@@ -6,7 +6,7 @@ The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, ac
 
 Copyright 2025 Crisp IM SAS. See LICENSE for copying information.
 
-* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 17/03/2025
+* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 22/11/2025
 * **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
 
 ## Installation

package/dist/crisp.d.ts

@@ -22,9 +22,9 @@ interface CrispAuth {
  * CLASSES
  ***************************************************************************/
 /**
- *
+ * Crisp
  */
-export declare class Crisp {
+declare class Crisp {
     bucket: BucketServiceInterface;
     media: MediaServiceInterface;
     plugin: PluginServiceInterface;
@@ -46,6 +46,7 @@ export declare class Crisp {
         mode: RTM_MODES;
     };
     protected _useragent: string;
+    protected _customHeaders: Record<string, string>;
     protected _emitter: Emitter<Record<import("mitt").EventType, unknown>>;
     protected _socket: Socket | null;
     protected _loopback: Emitter<Record<string, unknown>> | null;
@@ -69,6 +70,10 @@ export declare class Crisp {
      * Sets the RTM channel mode (ie. WebSockets or Web Hooks)
      */
     setRtmMode(mode: "websockets" | "webhooks"): void;
+    /**
+     * Sets custom headers to be included in all API requests
+     */
+    setCustomHeaders(headers: Record<string, string>): void;
     /**
      * Sets the authentication tier
      */
@@ -176,4 +181,5 @@ export declare class Crisp {
  * EXPORTS
  ***************************************************************************/
 export * from "./resources";
+export { Crisp };
 export default Crisp;

package/dist/crisp.js

@@ -45,7 +45,7 @@ const AVAILABLE_RTM_MODES = [
     "websockets",
     "webhooks"
 ];
-const VERSION = "10.0.17";
+const VERSION = "10.0.18";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;
@@ -167,7 +167,7 @@ const services = {
  * CLASSES
  ***************************************************************************/
 /**
- *
+ * Crisp
  */
 class Crisp {
     /**
@@ -193,6 +193,7 @@ class Crisp {
             mode: DEFAULT_RTM_MODE
         };
         this._useragent = (DEFAULT_USERAGENT_PREFIX + VERSION);
+        this._customHeaders = {};
         this._emitter = (0, mitt_1.default)();
         this._socket = null;
         this._loopback = null;
@@ -237,6 +238,17 @@ class Crisp {
                 AVAILABLE_RTM_MODES.join(", "));
         }
     }
+    /**
+     * Sets custom headers to be included in all API requests
+     */
+    setCustomHeaders(headers) {
+        if (typeof headers === "object" && headers !== null) {
+            this._customHeaders = headers;
+        }
+        else {
+            throw new Error("[Crisp] setCustomHeaders: parameter headers should be an object");
+        }
+    }
     /**
      * Sets the authentication tier
      */
@@ -658,10 +670,7 @@ class Crisp {
         let requestParameters = {
             responseType: "json",
             timeout: DEFAULT_REQUEST_TIMEOUT,
-            headers: {
-                "User-Agent": this._useragent,
-                "X-Crisp-Tier": this.auth.tier
-            },
+            headers: Object.assign({ "User-Agent": this._useragent, "X-Crisp-Tier": this.auth.tier }, this._customHeaders),
             throwHttpErrors: false
         };
         // Add authorization?

package/dist/resources/PluginConnect.d.ts

@@ -21,10 +21,14 @@ export type PluginConnectWebsitesSince = {
 };
 export type PluginConnectEndpoints = {
     socket?: PluginConnectEndpointsSocket;
+    rescue?: PluginConnectEndpointsRescue;
 };
 export type PluginConnectEndpointsSocket = {
     app?: string;
 };
+export type PluginConnectEndpointsRescue = {
+    socket?: PluginConnectEndpointsSocket;
+};
 /**************************************************************************
  * CLASSES
  ***************************************************************************/

package/lib/crisp.ts

@@ -194,9 +194,9 @@ interface CrispAuth {
  ***************************************************************************/
 
 /**
- *
+ * Crisp
  */
-export class Crisp {
+class Crisp {
   public bucket: BucketServiceInterface = (
     new Bucket() as unknown as BucketServiceInterface
   );
@@ -240,6 +240,8 @@ export class Crisp {
 
   protected _useragent = (DEFAULT_USERAGENT_PREFIX + VERSION);
 
+  protected _customHeaders: Record<string, string> = {};
+
   protected _emitter = mitt();
 
   protected _socket: Socket | null = null;
@@ -297,6 +299,17 @@ export class Crisp {
     }
   }
 
+  /**
+   * Sets custom headers to be included in all API requests
+   */
+  setCustomHeaders(headers: Record<string, string>) {
+    if (typeof headers === "object" && headers !== null) {
+      this._customHeaders = headers;
+    } else {
+      throw new Error("[Crisp] setCustomHeaders: parameter headers should be an object");
+    }
+  }
+
   /**
    * Sets the authentication tier
    */
@@ -866,7 +879,8 @@ export class Crisp {
 
       headers: {
         "User-Agent": this._useragent,
-        "X-Crisp-Tier": this.auth.tier
+        "X-Crisp-Tier": this.auth.tier,
+        ...this._customHeaders
       },
 
       throwHttpErrors: false
@@ -1003,4 +1017,5 @@ export class Crisp {
  ***************************************************************************/
 
 export * from "@/resources";
+export { Crisp };
 export default Crisp;

package/lib/resources/PluginConnect.ts

@@ -35,12 +35,17 @@ export type PluginConnectWebsitesSince = {
 
 export type PluginConnectEndpoints = {
   socket?: PluginConnectEndpointsSocket;
+  rescue?: PluginConnectEndpointsRescue;
 }
 
 export type PluginConnectEndpointsSocket = {
   app?: string;
 }
 
+export type PluginConnectEndpointsRescue = {
+  socket?: PluginConnectEndpointsSocket;
+}
+
 /**************************************************************************
  * CLASSES
  ***************************************************************************/

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "10.0.17",
+  "version": "10.0.18",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {
@@ -53,9 +53,9 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "8.39.1",
     "tsc-alias": "1.8.16",
-    "typescript": "5.9.2",
+    "typescript": "5.9.3",
     "eslint": "9.29.0",
-    "eslint-plugin-crisp": "1.1.13",
+    "eslint-plugin-crisp": "1.2.12",
     "eslint-plugin-jsdoc": "50.8.0",
     "globals": "15.15.0"
   },