crisp-api 10.0.8 → 10.0.10

package/CHANGELOG.md

@@ -1,17 +1,29 @@
 Changelog
 =========
 
+## v10.0.10
+
+### Changes
+
+* Allow any as return type to the Websocket .on() callback.
+
+## v10.0.9
+
+### Changes
+
+* Export missing types.
+
 ## v10.0.8
 
 ### Changes
 
-* `nickname` is now optional on ConversationMeta
+* `nickname` is now optional on ConversationMeta.
 
 ## v10.0.7
 
 ### Changes
 
-* Support types for `address`, `subject` and `origin` on ConversationMeta
+* Support types for `address`, `subject` and `origin` on ConversationMeta.
 
 ## v10.0.6
 

package/dist/crisp.d.ts

@@ -108,7 +108,7 @@ export declare class Crisp {
     /**
      * Binds RTM event
      */
-    on(event: string, callback: (data: any) => void): Promise<unknown>;
+    on(event: string, callback: (data: any) => any): Promise<unknown>;
     /**
      * Receives a raw event and dispatches it to the listener (used for Web Hooks)
      */

package/dist/crisp.js

@@ -45,7 +45,7 @@ const AVAILABLE_RTM_MODES = [
     "websockets",
     "webhooks"
 ];
-const VERSION = "10.0.8";
+const VERSION = "10.0.10";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;

package/dist/resources/WebsiteAvailability.d.ts

@@ -5,16 +5,16 @@ import BaseResource from "./BaseResource";
 /**************************************************************************
  * TYPES
  ***************************************************************************/
-type WebsiteAvailabilityStatus = {
+export type WebsiteAvailabilityStatus = {
     status?: string;
     since?: number;
 };
-type WebsiteAvailabilityOperator = {
+export type WebsiteAvailabilityOperator = {
     user_id?: string;
     type?: string;
     time?: WebsiteAvailabilityOperatorTime;
 };
-type WebsiteAvailabilityOperatorTime = {
+export type WebsiteAvailabilityOperatorTime = {
     for?: number;
     since?: number;
 };

package/dist/resources/WebsiteBase.d.ts

@@ -5,17 +5,17 @@ import BaseResource from "./BaseResource";
 /**************************************************************************
  * TYPES
  ***************************************************************************/
-type Website = {
+export type Website = {
     website_id?: string;
     name?: string;
     domain?: string;
     logo?: string;
 };
-type WebsiteCreate = {
+export type WebsiteCreate = {
     name?: string;
     domain?: string;
 };
-type WebsiteRemoveVerify = {
+export type WebsiteRemoveVerify = {
     method?: string;
     secret?: string;
 };

package/dist/resources/WebsiteBatch.d.ts

@@ -5,11 +5,11 @@ import BaseResource from "./BaseResource";
 /**************************************************************************
  * TYPES
  ***************************************************************************/
-type WebsiteBatchConversationsOperation = {
+export type WebsiteBatchConversationsOperation = {
     inbox_id?: string;
     sessions?: string[];
 };
-type WebsiteBatchPeopleOperationInner = {
+export type WebsiteBatchPeopleOperationInner = {
     profiles?: string[];
     search?: string;
 };

package/dist/resources/WebsiteCampaign.d.ts

@@ -6,7 +6,7 @@ import { WebsiteFilter } from "./WebsiteBase";
 /**************************************************************************
  * TYPES
  ***************************************************************************/
-type WebsiteCampaignExcerpt = {
+export type WebsiteCampaignExcerpt = {
     campaign_id?: string;
     type?: string;
     format?: string;
@@ -23,7 +23,7 @@ type WebsiteCampaignExcerpt = {
     updated_at: number;
     dispatched_at?: number;
 };
-type WebsiteCampaignTemplateExcerpt = {
+export type WebsiteCampaignTemplateExcerpt = {
     template_id?: string;
     type?: string;
     name?: string;
@@ -31,13 +31,13 @@ type WebsiteCampaignTemplateExcerpt = {
     created_at?: number;
     updated_at?: number;
 };
-type WebsiteCampaignTemplateNew = {
+export type WebsiteCampaignTemplateNew = {
     template_id?: string;
 };
-interface WebsiteCampaignTemplateItem extends WebsiteCampaignTemplateExcerpt {
+export interface WebsiteCampaignTemplateItem extends WebsiteCampaignTemplateExcerpt {
     content?: string;
 }
-interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
+export interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
     sender?: WebsiteCampaignItemSender;
     recipients?: WebsiteCampaignItemRecipients;
     flow?: WebsiteCampaignItemFlow;
@@ -45,67 +45,67 @@ interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
     options?: WebsiteCampaignItemOptions;
     statistics?: WebsiteCampaignItemStatistics;
 }
-type WebsiteCampaignItemSender = {
+export type WebsiteCampaignItemSender = {
     user_id?: string;
 };
-type WebsiteCampaignItemRecipients = {
+export type WebsiteCampaignItemRecipients = {
     type?: string;
     segments?: string[];
     people?: string[];
     filter?: WebsiteFilter[];
 };
-type WebsiteCampaignItemFlow = {
+export type WebsiteCampaignItemFlow = {
     launch_event?: string;
     assert_filter?: WebsiteFilter[];
     assert_delay?: number;
     deliver_once?: boolean;
     deliver_delay?: number;
 };
-type WebsiteCampaignItemOptions = {
+export type WebsiteCampaignItemOptions = {
     deliver_to_chatbox?: boolean;
     deliver_to_email?: boolean;
     sender_name_website?: boolean;
     sender_email_reply?: boolean;
     tracking?: boolean;
 };
-type WebsiteCampaignItemStatistics = {
+export type WebsiteCampaignItemStatistics = {
     opened?: number;
     clicked?: number;
     unsubscribed?: number;
 };
-type WebsiteCampaignRecipient = {
+export type WebsiteCampaignRecipient = {
     people_id?: string;
     email?: string;
     person?: WebsiteCampaignRecipientPerson;
     subscribed?: boolean;
 };
-type WebsiteCampaignRecipientPerson = {
+export type WebsiteCampaignRecipientPerson = {
     nickname?: string;
     avatar?: string;
 };
-type WebsiteCampaignStatistic = {
+export type WebsiteCampaignStatistic = {
     profile?: WebsiteCampaignStatisticProfile;
     data?: Record<string, unknown>;
     created_at?: number;
     updated_at?: number;
 };
-type WebsiteCampaignStatisticProfile = {
+export type WebsiteCampaignStatisticProfile = {
     people_id?: string;
     email?: string;
     person?: WebsiteCampaignStatisticProfilePerson;
 };
-type WebsiteCampaignStatisticProfilePerson = {
+export type WebsiteCampaignStatisticProfilePerson = {
     nickname?: string;
     avatar?: string;
     geolocation?: WebsiteCampaignStatisticProfilePersonGeolocation;
 };
-type WebsiteCampaignStatisticProfilePersonGeolocation = {
+export type WebsiteCampaignStatisticProfilePersonGeolocation = {
     country?: string;
     region?: string;
     city?: string;
     coordinates?: WebsiteCampaignStatisticProfilePersonGeolocationCoordinates;
 };
-type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
+export type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
     latitude?: number;
     longitude?: number;
 };

package/lib/crisp.ts

@@ -406,7 +406,7 @@ export class Crisp {
    * Binds RTM event
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
-  on(event: string, callback: (data: any) => void) {
+  on(event: string, callback: (data: any) => any) {
     // Ensure all input arguments are set
     if (typeof event !== "string") {
       throw new Error("[Crisp] on: parameter event should be a string");

package/lib/resources/WebsiteAvailability.ts

@@ -16,18 +16,18 @@ import BaseResource from "./BaseResource";
  * TYPES
  ***************************************************************************/
 
-type WebsiteAvailabilityStatus = {
+export type WebsiteAvailabilityStatus = {
   status?:  string;
   since?:   number;
 }
 
-type WebsiteAvailabilityOperator = {
+export type WebsiteAvailabilityOperator = {
   user_id?:  string;
   type?:     string;
   time?:     WebsiteAvailabilityOperatorTime;
 }
 
-type WebsiteAvailabilityOperatorTime = {
+export type WebsiteAvailabilityOperatorTime = {
   for?:   number;
   since?: number;
 }

package/lib/resources/WebsiteBase.ts

@@ -16,19 +16,19 @@ import BaseResource from "./BaseResource";
  * TYPES
  ***************************************************************************/
 
-type Website = {
+export type Website = {
   website_id?:  string;
   name?:        string;
   domain?:      string;
   logo?:        string;
 }
 
-type WebsiteCreate = {
+export type WebsiteCreate = {
   name?:        string;
   domain?:      string;
 }
 
-type WebsiteRemoveVerify = {
+export type WebsiteRemoveVerify = {
   method?:  string;
   secret?:  string;
 }

package/lib/resources/WebsiteBatch.ts

@@ -16,12 +16,12 @@ import BaseResource from "./BaseResource";
  * TYPES
  ***************************************************************************/
 
-type WebsiteBatchConversationsOperation = {
+export type WebsiteBatchConversationsOperation = {
   inbox_id?:  string;
   sessions?:  string[];
 }
 
-type WebsiteBatchPeopleOperationInner = {
+export type WebsiteBatchPeopleOperationInner = {
   profiles?:  string[];
   search?:    string;
 }

package/lib/resources/WebsiteCampaign.ts

@@ -17,7 +17,7 @@ import { WebsiteFilter } from "./WebsiteBase";
  * TYPES
  ***************************************************************************/
 
-type WebsiteCampaignExcerpt = {
+export type WebsiteCampaignExcerpt = {
   campaign_id?:  string;
   type?:         string;
   format?:       string;
@@ -35,7 +35,7 @@ type WebsiteCampaignExcerpt = {
   dispatched_at?: number;
 }
 
-type WebsiteCampaignTemplateExcerpt = {
+export type WebsiteCampaignTemplateExcerpt = {
   template_id?:  string;
   type?:         string;
   name?:         string;
@@ -44,15 +44,15 @@ type WebsiteCampaignTemplateExcerpt = {
   updated_at?:   number;
 }
 
-type WebsiteCampaignTemplateNew = {
+export type WebsiteCampaignTemplateNew = {
   template_id?:  string;
 }
 
-interface WebsiteCampaignTemplateItem extends WebsiteCampaignTemplateExcerpt {
+export interface WebsiteCampaignTemplateItem extends WebsiteCampaignTemplateExcerpt {
   content?:  string;
 }
 
-interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
+export interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
   sender?:      WebsiteCampaignItemSender;
   recipients?:  WebsiteCampaignItemRecipients;
   flow?:        WebsiteCampaignItemFlow;
@@ -61,18 +61,18 @@ interface WebsiteCampaignItem extends WebsiteCampaignExcerpt {
   statistics?:  WebsiteCampaignItemStatistics;
 }
 
-type WebsiteCampaignItemSender = {
+export type WebsiteCampaignItemSender = {
   user_id?:  string;
 }
 
-type WebsiteCampaignItemRecipients = {
+export type WebsiteCampaignItemRecipients = {
   type?:         string;
   segments?:     string[];
   people?:       string[];
   filter?:       WebsiteFilter[];
 }
 
-type WebsiteCampaignItemFlow = {
+export type WebsiteCampaignItemFlow = {
   launch_event?:   string;
   assert_filter?:  WebsiteFilter[];
   assert_delay?:   number;
@@ -80,7 +80,7 @@ type WebsiteCampaignItemFlow = {
   deliver_delay?:  number;
 }
 
-type WebsiteCampaignItemOptions = {
+export type WebsiteCampaignItemOptions = {
   deliver_to_chatbox?:  boolean;
   deliver_to_email?:    boolean;
   sender_name_website?:  boolean;
@@ -88,51 +88,51 @@ type WebsiteCampaignItemOptions = {
   tracking?:             boolean;
 }
 
-type WebsiteCampaignItemStatistics = {
+export type WebsiteCampaignItemStatistics = {
   opened?:        number;
   clicked?:       number;
   unsubscribed?:  number;
 }
 
-type WebsiteCampaignRecipient = {
+export type WebsiteCampaignRecipient = {
   people_id?:  string;
   email?:      string;
   person?:     WebsiteCampaignRecipientPerson;
   subscribed?:  boolean;
 }
 
-type WebsiteCampaignRecipientPerson = {
+export type WebsiteCampaignRecipientPerson = {
   nickname?:  string;
   avatar?:    string;
 }
 
-type WebsiteCampaignStatistic = {
+export type WebsiteCampaignStatistic = {
   profile?:    WebsiteCampaignStatisticProfile;
   data?:       Record<string, unknown>;
   created_at?:  number;
   updated_at?:  number;
 }
 
-type WebsiteCampaignStatisticProfile = {
+export type WebsiteCampaignStatisticProfile = {
   people_id?:  string;
   email?:      string;
   person?:     WebsiteCampaignStatisticProfilePerson;
 }
 
-type WebsiteCampaignStatisticProfilePerson = {
+export type WebsiteCampaignStatisticProfilePerson = {
   nickname?:  string;
   avatar?:    string;
   geolocation?:  WebsiteCampaignStatisticProfilePersonGeolocation;
 }
 
-type WebsiteCampaignStatisticProfilePersonGeolocation = {
+export type WebsiteCampaignStatisticProfilePersonGeolocation = {
   country?:      string;
   region?:      string;
   city?:        string;
   coordinates?:  WebsiteCampaignStatisticProfilePersonGeolocationCoordinates;
 }
 
-type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
+export type WebsiteCampaignStatisticProfilePersonGeolocationCoordinates = {
   latitude?:  number;
   longitude?: number;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "10.0.8",
+  "version": "10.0.10",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {
@@ -49,7 +49,7 @@
     "typescript": "5.9.2",
     "eslint": "9.29.0",
     "eslint-plugin-crisp": "1.1.13",
-    "eslint-plugin-jsdoc": "^54.1.0",
+    "eslint-plugin-jsdoc": "50.8.0",
     "globals": "15.15.0"
   },
   "dependencies": {