crisp-api 10.10.6 → 10.11.0

package/eslint.config.mjs

@@ -10,199 +10,28 @@
  ***************************************************************************/
 
 // NPM
-import globals from "globals";
 import { defineConfig, globalIgnores } from "eslint/config";
 import crisp from "eslint-plugin-crisp";
-import tseslint from "@typescript-eslint/eslint-plugin";
-import tsparser from "@typescript-eslint/parser";
-import jsdoc from "eslint-plugin-jsdoc";
 
 /**************************************************************************
  * CONFIGURATION
  ***************************************************************************/
 
 export default defineConfig([
-  // Additional TypeScript configuration
-  {
-    files: ["lib/*.ts", "lib/**/*.ts"],
-    languageOptions: {
-      parser: tsparser,
-      sourceType: "module",
-      ecmaVersion: 2020,
-
-      globals: {
-        ...globals.browser,
-        ...globals.node
-      }
-    },
-    plugins: {
-      crisp: crisp,
-      "@typescript-eslint": tseslint,
-      jsdoc: jsdoc
-    },
-    rules: {
-      "@typescript-eslint/no-explicit-any": "error",
-
-      // General JS rules
-      "arrow-parens": ["error", "always"],
-      "brace-style": [
-        "error",
-        "1tbs",
-        {
-          "allowSingleLine": true
-        }
-      ],
-      "comma-dangle": ["error", "never"],
-      "comma-spacing": ["error", { "before": false, "after": true }],
-      "comma-style": ["error", "last"],
-      "curly": "error",
-      "computed-property-spacing": ["error", "never"],
-      "default-param-last": "error",
-      "default-case-last": "error",
-      "dot-notation": "error",
-      "eqeqeq": "error",
-      "eol-last": "error",
-      "for-direction": "error",
-      "indent": [
-        "error",
-        2,
-        {
-          "SwitchCase": 1,
-          "FunctionDeclaration": {
-            "parameters": "off"
-          },
-          "FunctionExpression": {
-            "parameters": "off"
-          },
-          "CallExpression": {
-            "arguments": "off"
-          },
-          "VariableDeclarator": 1,
-          "outerIIFEBody": 0,
-          "ArrayExpression": 1,
-          "ObjectExpression": 1,
-          "ImportDeclaration": 1,
-          "flatTernaryExpressions": false,
-          "offsetTernaryExpressions": true
-        }
-      ],
-      "key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
-      "keyword-spacing": "error",
-      "linebreak-style": ["error", "unix"],
-      "newline-per-chained-call": "error",
-      "no-console": "warn",
-      "no-debugger": "warn",
-      "no-eval": "error",
-      "no-implicit-coercion": "error",
-      "no-multi-str": "error",
-      "no-multiple-empty-lines": ["error", { max: 1 }],
-      "no-mixed-spaces-and-tabs": "error",
-      "no-restricted-syntax": [
-        "error",
-        {
-          "selector": "SwitchCase > *.consequent[type!='BlockStatement']",
-          "message": "Switch cases without braces are disallowed."
-        }
-      ],
-      "no-tabs": "error",
-      "no-trailing-spaces": "error",
-      "no-undef": "error",
-      "no-unused-vars": "warn",
-      "no-unsafe-optional-chaining": "error",
-      "object-curly-newline": [
-        "error",
-        {
-          "multiline": true, "consistent": true
-        }
-      ],
-      "object-curly-spacing": ["error", "always"],
-      "padded-blocks": ["error", "never"],
-      "padding-line-between-statements": [
-        "error",
-        { "blankLine": "always", "prev": "let", "next": "*" },
-        { "blankLine": "any", "prev": "let", "next": "let" },
-        { "blankLine": "always", "prev": "const", "next": "*" },
-        { "blankLine": "any", "prev": "const", "next": "const" },
-        { "blankLine": "always", "prev": "block-like", "next": "*" },
-        { "blankLine": "always", "prev": "*", "next": "break" },
-        { "blankLine": "any", "prev": "empty", "next": "break" },
-        { "blankLine": "always", "prev": "*", "next": "block-like" },
-        { "blankLine": "any", "prev": "case", "next": "case" },
-        { "blankLine": "always", "prev": "continue", "next": "*" },
-        { "blankLine": "always", "prev": "break", "next": "*" }
-      ],
-      "prefer-arrow-callback": "error",
-      "quotes": [
-        "error",
-        "double",
-        {
-          "avoidEscape": true, "allowTemplateLiterals": true
-        }
-      ],
-      "quote-props": ["error", "as-needed"],
-      "semi": ["error", "always"],
-      "semi-style": ["error", "last"],
-      "semi-spacing": ["error", { "before": false, "after": true }],
-      "space-before-blocks": "error",
-      "space-in-parens": ["error", "never"],
-      "space-infix-ops": "error",
-
-      // Crisp JS rules
-      "crisp/align-comments": "error",
-      "crisp/enforce-optional": "error",
-      "crisp/header-check": "error",
-      "crisp/header-comments-check": "error",
-      "crisp/import-group-comment": "error",
-      "crisp/import-group-order": "error",
-      "crisp/methods-naming": "error",
-      "crisp/methods-ordering": "error",
-      "crisp/multiline-comment-end-backslash": "error",
-      "crisp/newline-after-switch-case": "error",
-      "crisp/no-async": "off",
-      "crisp/no-extra-line-within-function": "error",
-      "crisp/no-short-parameters": [
-        "error",
-        {
-          "exceptions": ["_", "$", "x", "y"]
-        }
-      ],
-      "crisp/no-snake-case": "error",
-      "crisp/no-useless-template-literals": "error",
-      "crisp/no-var-in-blocks": "error",
-      "crisp/one-space-after-operator": [
-        "error",
-        {
-          "checkColon": false
-        }
-      ],
-      "crisp/regex-in-constructor": "error",
-      "crisp/ternary-parenthesis": "error",
-
-      // General JSDoc rules
-      "jsdoc/require-description": "error",
-      "jsdoc/require-param-description": "off",
-      "jsdoc/require-property-description": "off",
-      "jsdoc/require-jsdoc": [
-        "error",
-        {
-          "require": {
-            "FunctionDeclaration": true,
-            "MethodDefinition": true,
-            "ClassDeclaration": true,
-            "ArrowFunctionExpression": false,
-            "FunctionExpression": false
-          },
-          "contexts": [
-            "Property[key.name=\"getters\"] > ObjectExpression > Property",
-            "Property[key.name=\"methods\"] > ObjectExpression > Property"
-          ]
-        }
-      ]
-    }
-  },
-
   globalIgnores([
     "dist/*",
     "node_modules/*"
-  ])
+  ]),
+
+  {
+    files: ["lib/**/*.ts"],
+    extends: [crisp.configs["recommended-ts"]],
+    rules: {
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-redundant-type-constituents": "off"
+    }
+  }
 ]);

package/lib/crisp.ts

@@ -263,7 +263,7 @@ class Crisp {
 
   protected _brokerScheduler: typeof setTimeout | null = null;
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   protected _brokerBindHooks: ((modeInstance: any, emitter: any) => void)[] = [];
 
   protected _boundEvents = {};
@@ -431,7 +431,6 @@ class Crisp {
    * Binds RTM event (typed variant)
    */
   on<Name extends EventName>(
-    // eslint-disable-next-line no-unused-vars
     event: Name, callback: (data: EventsMap[Name]) => unknown
   ): Promise<unknown>;
 
@@ -439,14 +438,14 @@ class Crisp {
    * Binds RTM event (loose variant)
    */
   on(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     event: string, callback: (data: any) => unknown
   ): Promise<unknown>;
 
   /**
    * Binds RTM event
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   on(event: string, callback: (data: any) => any) {
     // Ensure all input arguments are set
     if (typeof event !== "string") {
@@ -481,7 +480,7 @@ class Crisp {
 
     // Subscribe event on the broker
     if (this._boundEvents[event] !== true) {
-      let rtmMode = this._rtm.mode;
+      const rtmMode = this._rtm.mode;
 
       // Mark event as bound
       this._boundEvents[event] = true;
@@ -676,7 +675,7 @@ class Crisp {
    * Binds broker to the main object
    */
   private __prepareBroker(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     fnBindHook: (modeInstance: any, emitter: any) => void
   ) {
     return new Promise((resolve, reject) => {
@@ -698,7 +697,7 @@ class Crisp {
           );
         }
 
-        // @ts-ignore
+        // @ts-expect-error - rtmMode is a string
         this._brokerScheduler = setTimeout(() => {
           switch (rtmMode) {
             case "websockets": {
@@ -723,7 +722,7 @@ class Crisp {
             default: {
               const unsupportedError = new Error(
                 "[Crisp] prepareBroker: mode of RTM broker unsupported "  +
-                  "('" + rtmMode + "')"
+                  "('" + String(rtmMode) + "')"
               );
 
               reject(unsupportedError);
@@ -798,7 +797,6 @@ class Crisp {
           });
       })
       .then((endpoints) => {
-        // @ts-ignore
         const rtmHostAffinity = (endpoints?.socket?.app || null);
 
         // No RTM API host acquired?
@@ -813,7 +811,6 @@ class Crisp {
         const rtmHostUrl = new URL(rtmHostAffinity);
 
         // Connect to socket
-        // @ts-ignore
         this._socket = socketio(rtmHostUrl.origin, {
           path: (rtmHostUrl.pathname || "/"),
           transports: ["websocket"],
@@ -902,12 +899,10 @@ class Crisp {
     method: string,
     query: object,
     body: object | null,
-    // eslint-disable-next-line no-unused-vars
     resolve: (value: unknown) => void,
-    // eslint-disable-next-line no-unused-vars
     reject: (reason?: unknown) => void
   ) {
-    let requestParameters = {
+    const requestParameters = {
       responseType: "json",
       timeout: DEFAULT_REQUEST_TIMEOUT,
 
@@ -922,13 +917,13 @@ class Crisp {
 
     // Add authorization?
     if (this.auth.token) {
-      // @ts-ignore
+      // @ts-expect-error - requestParameters.headers is a Record<string, string>
       requestParameters.headers.Authorization = ("Basic " + this.auth.token);
     }
 
     // Add body?
     if (body) {
-      // @ts-ignore
+      // @ts-expect-error - requestParameters.json is a Record<string, unknown>
       requestParameters.json = body;
     }
 
@@ -948,7 +943,7 @@ class Crisp {
         }
       });
 
-      // @ts-ignore
+      // @ts-expect-error - requestParameters.searchParams is a URLSearchParams
       requestParameters.searchParams = params;
     }
 
@@ -977,7 +972,7 @@ class Crisp {
 
         // Response error?
         if (response.statusCode >= 400) {
-          let reasonMessage = this.__readErrorResponseReason(
+          const reasonMessage = this.__readErrorResponseReason(
             method, response.statusCode, response
           );
 
@@ -1009,7 +1004,8 @@ class Crisp {
    * Reads reason for error response
    */
   private __readErrorResponseReason(
-    method: string, statusCode: number, response: object
+    method: string, statusCode: number,
+      response: { body?: { reason?: string } }
   ) {
     // HEAD method? As HEAD requests do not expect any response body, then we \
     //   cannot map a reason from the response.
@@ -1027,7 +1023,6 @@ class Crisp {
 
     // Other methods must hold a response body, therefore we can fallback on \
     //   an HTTP error if we fail to acquire any reason at all.
-    // @ts-ignore
     return ((response?.body?.reason || "http_error"));
   }
 
@@ -1044,15 +1039,15 @@ class Crisp {
     }
 
     // Compute local trace
-    let localTrace = ("[" + timestamp + ";" + JSON.stringify(body) + "]");
+    const localTrace = ("[" + timestamp + ";" + JSON.stringify(body) + "]");
 
     // Create local HMAC
-    let localMac = Crypto.createHmac("sha256", secret);
+    const localMac = Crypto.createHmac("sha256", secret);
 
     localMac.update(localTrace);
 
     // Compute local signature, and compare
-    let localSignature = localMac.digest("hex");
+    const localSignature = localMac.digest("hex");
 
     return (
       (signature === localSignature) ? true : false

package/lib/events/Events.ts

@@ -655,7 +655,7 @@ export interface EventsPlanSubscriptionUpdated extends EventsWebsiteGeneric {
  ***************************************************************************/
 
 /**
- * Maps each event name to the shape of the payload delivered to its listener,
+ * Maps each event name to the shape of the payload delivered to its listener, \
  *   whether received over WebSockets or Web Hooks.
  */
 export interface EventsMap {
@@ -780,7 +780,7 @@ export interface EventsMap {
 export type EventName = keyof EventsMap;
 
 /**
- * Shape of a Web Hook body, as received on the HTTP endpoint before being
+ * Shape of a Web Hook body, as received on the HTTP endpoint before being \
  *   dispatched with 'receiveHook'.
  */
 export type EventsWebHookBody<Name extends EventName = EventName> = {

package/lib/resources/PluginConnect.ts

@@ -83,7 +83,7 @@ class PluginConnect extends BaseResource {
     pageNumber: number, filterConfigured: boolean, includePlan: boolean
   ): Promise<PluginConnectWebsite[]> {
     // Generate query
-    let query = {
+    const query = {
       filter_configured: (
         (filterConfigured === true) ? "1" : "0"
       ),
@@ -109,7 +109,7 @@ class PluginConnect extends BaseResource {
     dateSince: string, filterConfigured: boolean, includePlan: boolean
   ): Promise<PluginConnectWebsite[]> {
     // Generate query
-    let query = {
+    const query = {
       filter_configured: (
         (filterConfigured === true) ? "1" : "0"
       ),
@@ -120,7 +120,7 @@ class PluginConnect extends BaseResource {
     };
 
     if (dateSince) {
-      // @ts-ignore
+      // @ts-expect-error - dateSince is a string
       query.date_since = dateSince;
     }
 

package/lib/resources/WebsiteBase.ts

@@ -52,11 +52,6 @@ export type WebsiteFilter = {
 class WebsiteBase extends BaseResource {
   /**
    * Check If Website Exists
-   * @memberof WebsiteBase
-   * @public
-   * @method checkWebsiteExists
-   * @param {string} domain
-   * @return {Promise}
    */
   checkWebsiteExists(domain: string) {
     return this.crisp.head(
@@ -79,11 +74,6 @@ class WebsiteBase extends BaseResource {
 
   /**
    * Get A Website
-   * @memberof WebsiteBase
-   * @public
-   * @method getWebsite
-   * @param {string} websiteID
-   * @return {Promise}
    */
   getWebsite(websiteID: string): Promise<Website> {
     return this.crisp.get(

package/lib/resources/WebsiteBatch.ts

@@ -98,12 +98,6 @@ class WebsiteBatch extends BaseResource {
 
   /**
    * Batch Read Conversations
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchReadConversations
-   * @param {string} websiteID
-   * @param {object} operation
-   * @return {Promise}
    */
   batchReadConversations(
     websiteID: string, operation: WebsiteBatchConversationsOperation
@@ -130,12 +124,6 @@ class WebsiteBatch extends BaseResource {
 
   /**
    * Batch Remove Conversations
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchRemoveConversations
-   * @param {string} websiteID
-   * @param {object} operation
-   * @return {Promise}
    */
   batchRemoveConversations(
     websiteID: string, operation: WebsiteBatchConversationsOperation
@@ -149,12 +137,6 @@ class WebsiteBatch extends BaseResource {
 
   /**
    * Batch Remove People
-   * @memberof WebsiteBatch
-   * @public
-   * @method batchRemovePeople
-   * @param {string} websiteID
-   * @param {object} people
-   * @return {Promise}
    */
   batchRemovePeople(
     websiteID: string, people: WebsiteBatchPeopleOperationInner

package/lib/resources/WebsiteCampaign.ts

@@ -339,7 +339,6 @@ class WebsiteCampaign extends BaseResource {
 
   /**
    * Dispatch A Campaign
-   * @return {Promise}
    */
   dispatchCampaign(websiteID: string, campaignID: string) {
     return this.crisp.post(

package/lib/resources/WebsiteConversation.ts

@@ -763,20 +763,17 @@ class WebsiteConversation extends BaseResource {
     timestampAfter?: string|number, timestampAround?: string|number
   ): Promise<ConversationMessage[]> {
     // Generate query
-    let query = {};
+    const query: Record<string, unknown> = {};
 
     if (timestampBefore) {
-      // @ts-ignore
       query.timestamp_before = String(timestampBefore);
     }
 
     if (timestampAfter) {
-      // @ts-ignore
       query.timestamp_after = String(timestampAfter);
     }
 
     if (timestampAround) {
-      // @ts-ignore
       query.timestamp_around = String(timestampAround);
     }
 
@@ -1074,13 +1071,13 @@ class WebsiteConversation extends BaseResource {
       user?: ConversationMessageUser, origin?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       state: state,
       user: user
     };
 
     if (origin) {
-      // @ts-ignore
+      // @ts-expect-error - origin is a string
       body.origin = origin;
     }
 
@@ -1155,13 +1152,13 @@ class WebsiteConversation extends BaseResource {
       user?: ConversationMessageUser, origin?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       blocked: (blocked || false),
       user: user
     };
 
     if (origin) {
-      // @ts-ignore
+      // @ts-expect-error - body is a Record<string, unknown>
       body.origin = origin;
     }
 
@@ -1246,12 +1243,12 @@ class WebsiteConversation extends BaseResource {
     websiteID: string, sessionID: string, to: string, email?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       to: to
     };
 
     if (email) {
-      // @ts-ignore
+      // @ts-expect-error - email is a string
       body.email = email;
     }
 
@@ -1367,13 +1364,13 @@ class WebsiteConversation extends BaseResource {
       user?: ConversationMessageUser, origin?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       mode: (mode || "audio"),
       user: user
     };
 
     if (origin) {
-      // @ts-ignore
+      // @ts-expect-error - origin is a string
       body.origin = origin;
     }
 
@@ -1407,12 +1404,12 @@ class WebsiteConversation extends BaseResource {
       user?: ConversationMessageUser, origin?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       user: user
     };
 
     if (origin) {
-      // @ts-ignore
+      // @ts-expect-error - origin is a string
       body.origin = origin;
     }
 
@@ -1447,12 +1444,12 @@ class WebsiteConversation extends BaseResource {
     websiteID: string, sessionID: string, command: string, payload?: object
   ) {
     // Generate body
-    let body = {
+    const body = {
       command: command
     };
 
     if (payload) {
-      // @ts-ignore
+      // @ts-expect-error - payload is a Record<string, unknown>
       body.payload = payload;
     }
 
@@ -1473,14 +1470,14 @@ class WebsiteConversation extends BaseResource {
       itemID: string, data: object, value?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       section_id: sectionID,
       item_id: itemID,
       data: data
     };
 
     if (typeof value !== "undefined") {
-      // @ts-ignore
+      // @ts-expect-error - value is a string
       body.value = value;
     }
 
@@ -1548,14 +1545,14 @@ class WebsiteConversation extends BaseResource {
       user?: ConversationMessageUser, origin?: string
   ) {
     // Generate body
-    let body = {
+    const body = {
       date: date,
       note: note,
       user: user
     };
 
     if (origin) {
-      // @ts-ignore
+      // @ts-expect-error - origin is a string
       body.origin = origin;
     }