crisp-api 10.0.11 → 10.0.13

package/CHANGELOG.md

@@ -1,17 +1,25 @@
 Changelog
 =========
 
+## v10.0.13
+
+Rename `ConversationContent` to `ConversationMessageContent`
+
+## v10.0.12
+
+* Commonize `Message` types.
+
 ## v10.0.11
 
 ### Changes
 
-* Fix Conversation Custom data type.
+* Fix `Conversation` custom data type.
 
 ## v10.0.10
 
 ### Changes
 
-* Allow any as return type to the Websocket .on() callback.
+* Allow `any` as return type to the WebSocket `.on()` callback.
 
 ## v10.0.9
 

package/dist/crisp.js

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

package/dist/resources/WebsiteConversation.d.ts

@@ -135,16 +135,16 @@ export interface BrowserInfo {
     version?: string;
     name?: string;
 }
-export type ConversationMessageType = "text" | "file" | "animation" | "audio" | "carousel" | "note" | "picker" | "field";
+export type ConversationMessageType = "text" | "file" | "animation" | "audio" | "carousel" | "note" | "picker" | "field" | "event";
 export type ConversationState = "pending" | "unresolved" | "resolved";
-export type ConversationContent = (string | ConversationFileMessageContent | ConversationAnimationMessageContent | ConversationAudioMessageContent | ConversationPickerMessageContent | ConversationFieldMessageContent | ConversationCarouselMessageContent | ConversationEventMessageContent);
+export type ConversationMessageContent = (string | ConversationFileMessageContent | ConversationAnimationMessageContent | ConversationAudioMessageContent | ConversationPickerMessageContent | ConversationFieldMessageContent | ConversationCarouselMessageContent | ConversationEventMessageContent);
 export interface ConversationMessage {
     session_id?: string;
     website_id?: string;
     type?: ConversationMessageType;
     from?: string;
     origin?: string;
-    content?: ConversationContent;
+    content?: ConversationMessageContent;
     preview?: ConversationMessagePreview[];
     mentions?: string[];
     read?: string;
@@ -245,13 +245,12 @@ export interface ConversationMessageReference {
 export interface ConversationMessageOriginal {
     original_id?: string;
 }
-export type ConversationMessageNew = (ConversationTextMessageNew | ConversationFileMessageNew | ConversationAnimationMessageNew | ConversationAudioMessageNew | ConversationPickerMessageNew | ConversationFieldMessageNew | ConversationCarouselMessageNew | ConversationNoteMessageNew | ConversationEventMessageNew);
-export interface ConversationTextMessageNew {
-    type: "text" | "note";
+export type ConversationMessageNew = ConversationTextMessageNew | ConversationNoteMessageNew | ConversationFileMessageNew | ConversationAnimationMessageNew | ConversationAudioMessageNew | ConversationPickerMessageNew | ConversationFieldMessageNew | ConversationCarouselMessageNew | ConversationEventMessageNew;
+export interface ConversationMessageNewBase {
+    type: ConversationMessageType;
     from: string;
     origin: string;
     content: unknown;
-    mentions?: string[];
     fingerprint?: number;
     user?: ConversationMessageUser;
     references?: ConversationMessageReference[];
@@ -261,116 +260,44 @@ export interface ConversationTextMessageNew {
     translated?: boolean;
     automated?: boolean;
 }
-export interface ConversationFileMessageNew {
-    type: "file";
-    from?: string;
-    origin?: string;
-    content?: ConversationFileMessageContent;
+export interface ConversationTextMessageNew extends ConversationMessageNewBase {
+    type: "text" | "note";
+    content: string;
+}
+export interface ConversationNoteMessageNew extends ConversationTextMessageNew {
+    type: "note";
     mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
 }
-export interface ConversationAnimationMessageNew {
+export interface ConversationFileMessageNew extends ConversationMessageNewBase {
+    type: "file";
+    content: ConversationFileMessageContent;
+}
+export interface ConversationAnimationMessageNew extends ConversationMessageNewBase {
     type: "animation";
-    from?: string;
-    origin?: string;
-    content?: ConversationAnimationMessageContent;
-    mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
+    content: ConversationAnimationMessageContent;
 }
-export interface ConversationAudioMessageNew {
+export interface ConversationAudioMessageNew extends ConversationMessageNewBase {
     type: "audio";
-    from?: string;
-    origin?: string;
-    content?: ConversationAudioMessageContent;
-    mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
+    content: ConversationAudioMessageContent;
 }
-export interface ConversationPickerMessageNew {
+export interface ConversationPickerMessageNew extends ConversationMessageNewBase {
     type: "picker";
-    from?: string;
-    origin?: string;
-    content?: ConversationPickerMessageContent;
-    mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
+    content: ConversationPickerMessageContent;
 }
-export interface ConversationFieldMessageNew {
+export interface ConversationFieldMessageNew extends ConversationMessageNewBase {
     type: "field";
-    from?: string;
-    origin?: string;
-    content?: ConversationFieldMessageContent;
-    mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
+    content: ConversationFieldMessageContent;
 }
-export interface ConversationCarouselMessageNew {
+export interface ConversationCarouselMessageNew extends ConversationMessageNewBase {
     type: "carousel";
-    from?: string;
-    origin?: string;
-    content?: ConversationCarouselMessageContent;
-    mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
-}
-export interface ConversationNoteMessageNew extends ConversationTextMessageNew {
-    type: "note";
+    content: ConversationCarouselMessageContent;
 }
-export interface ConversationEventMessageNew {
+export interface ConversationEventMessageNew extends ConversationMessageNewBase {
     type: "event";
-    from?: string;
-    origin?: string;
-    content?: ConversationEventMessageContent;
-    mentions?: string[];
-    fingerprint?: number;
-    user?: ConversationMessageUser;
-    references?: ConversationMessageReference[];
-    original?: ConversationMessageOriginal;
-    timestamp?: number;
-    stealth?: boolean;
-    translated?: boolean;
-    automated?: boolean;
+    content: ConversationEventMessageContent;
 }
 export interface ConversationComposeMessageNew {
-    type: string;
+    type: "start" | "stop";
     from: string;
     excerpt?: string;
     stealth?: boolean;
@@ -541,7 +468,7 @@ declare class WebsiteConversation extends BaseResource {
     /**
      * Update A Message In Conversation
      */
-    updateMessageInConversation(websiteID: string, sessionID: string, fingerprint: number, content: ConversationContent): Promise<any>;
+    updateMessageInConversation(websiteID: string, sessionID: string, fingerprint: number, content: ConversationMessageContent): Promise<any>;
     /**
      * Remove A Message In Conversation
      */

package/lib/resources/WebsiteConversation.ts

@@ -176,11 +176,12 @@ export type ConversationMessageType =
   | "carousel"
   | "note"
   | "picker"
-  | "field";
+  | "field"
+  | "event";
 
 export type ConversationState = "pending" | "unresolved" | "resolved";
 
-export type ConversationContent = (
+export type ConversationMessageContent = (
   string |
   ConversationFileMessageContent |
   ConversationAnimationMessageContent |
@@ -197,7 +198,7 @@ export interface ConversationMessage {
   type?: ConversationMessageType;
   from?: string;
   origin?: string;
-  content?: ConversationContent;
+  content?: ConversationMessageContent;
   preview?: ConversationMessagePreview[];
   mentions?: string[];
   read?: string;
@@ -316,24 +317,22 @@ export interface ConversationMessageOriginal {
   original_id?: string;
 }
 
-export type ConversationMessageNew = (
-  ConversationTextMessageNew |
-  ConversationFileMessageNew |
-  ConversationAnimationMessageNew |
-  ConversationAudioMessageNew |
-  ConversationPickerMessageNew |
-  ConversationFieldMessageNew |
-  ConversationCarouselMessageNew |
-  ConversationNoteMessageNew |
-  ConversationEventMessageNew
-)
+export type ConversationMessageNew  =
+  | ConversationTextMessageNew
+  | ConversationNoteMessageNew
+  | ConversationFileMessageNew
+  | ConversationAnimationMessageNew
+  | ConversationAudioMessageNew
+  | ConversationPickerMessageNew
+  | ConversationFieldMessageNew
+  | ConversationCarouselMessageNew
+  | ConversationEventMessageNew;
 
-export interface ConversationTextMessageNew {
-  type: "text" | "note";
+export interface ConversationMessageNewBase {
+  type: ConversationMessageType;
   from: string;
   origin: string;
   content: unknown;
-  mentions?: string[];
   fingerprint?: number;
   user?: ConversationMessageUser;
   references?: ConversationMessageReference[];
@@ -344,124 +343,53 @@ export interface ConversationTextMessageNew {
   automated?: boolean;
 }
 
-export interface ConversationFileMessageNew {
-  type: "file";
-  from?: string;
-  origin?: string;
-  content?: ConversationFileMessageContent;
+export interface ConversationTextMessageNew extends ConversationMessageNewBase {
+  type: "text" | "note";
+  content: string;
+}
+
+export interface ConversationNoteMessageNew extends ConversationTextMessageNew {
+  type: "note";
   mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
 }
 
-export interface ConversationAnimationMessageNew {
+export interface ConversationFileMessageNew extends ConversationMessageNewBase {
+  type: "file";
+  content: ConversationFileMessageContent;
+}
+
+export interface ConversationAnimationMessageNew extends ConversationMessageNewBase {
   type: "animation";
-  from?: string;
-  origin?: string;
-  content?: ConversationAnimationMessageContent;
-  mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
+  content: ConversationAnimationMessageContent;
 }
 
-export interface ConversationAudioMessageNew {
+export interface ConversationAudioMessageNew extends ConversationMessageNewBase {
   type: "audio";
-  from?: string;
-  origin?: string;
-  content?: ConversationAudioMessageContent;
-  mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
+  content: ConversationAudioMessageContent;
 }
 
-export interface ConversationPickerMessageNew {
+export interface ConversationPickerMessageNew extends ConversationMessageNewBase {
   type: "picker";
-  from?: string;
-  origin?: string;
-  content?: ConversationPickerMessageContent;
-  mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
+  content: ConversationPickerMessageContent;
 }
 
-export interface ConversationFieldMessageNew {
+export interface ConversationFieldMessageNew extends ConversationMessageNewBase {
   type: "field";
-  from?: string;
-  origin?: string;
-  content?: ConversationFieldMessageContent;
-  mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
+  content: ConversationFieldMessageContent;
 }
 
-export interface ConversationCarouselMessageNew {
+export interface ConversationCarouselMessageNew extends ConversationMessageNewBase {
   type: "carousel";
-  from?: string;
-  origin?: string;
-  content?: ConversationCarouselMessageContent;
-  mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
-}
-
-export interface ConversationNoteMessageNew extends ConversationTextMessageNew {
-  type: "note";
+  content: ConversationCarouselMessageContent;
 }
 
-export interface ConversationEventMessageNew {
+export interface ConversationEventMessageNew extends ConversationMessageNewBase {
   type: "event";
-  from?: string;
-  origin?: string;
-  content?: ConversationEventMessageContent;
-  mentions?: string[];
-  fingerprint?: number;
-  user?: ConversationMessageUser;
-  references?: ConversationMessageReference[];
-  original?: ConversationMessageOriginal;
-  timestamp?: number;
-  stealth?: boolean;
-  translated?: boolean;
-  automated?: boolean;
+  content: ConversationEventMessageContent;
 }
 
 export interface ConversationComposeMessageNew {
-  type: string;
+  type: "start" | "stop";
   from: string;
   excerpt?: string;
   stealth?: boolean;
@@ -819,7 +747,7 @@ class WebsiteConversation extends BaseResource {
    * Update A Message In Conversation
    */
   updateMessageInConversation(
-    websiteID: string, sessionID: string, fingerprint: number, content: ConversationContent
+    websiteID: string, sessionID: string, fingerprint: number, content: ConversationMessageContent
   ) {
     return this.crisp.patch(
       this.crisp.prepareRestUrl([

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "crisp-api",
   "description": "Crisp API wrapper for Node - official, maintained by Crisp",
-  "version": "10.0.11",
+  "version": "10.0.13",
   "homepage": "https://github.com/crisp-im/node-crisp-api",
   "license": "MIT",
   "author": {