@deepdesk/deepdesk-sdk 17.0.1-beta.7 → 17.0.1-beta.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/index.cjs.js +7 -7
  2. package/dist/index.d.mts +50 -102
  3. package/dist/index.d.ts +50 -102
  4. package/dist/index.esm.js +7 -7
  5. package/dist/index.iife.js +22 -22
  6. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -594,64 +594,10 @@ declare namespace Server {
594
594
  suggestion: string;
595
595
  }[];
596
596
  };
597
- enum EventType {
598
- SEND_MESSAGE = "Send Message",
599
- HANDLING_TIME = "Handling Time",
600
- ADD_TO_PERSONAL_COLLECTION = "Add to personal collection",
601
- DELETE_FROM_PERSONAL_COLLECTION = "Delete from personal collection"
602
- }
603
- type UsedSuggestion = {
604
- ab_test_name?: string | null;
605
- ab_variant?: string | null;
606
- input_type: string;
607
- source?: string;
608
- source_text?: string;
609
- text: string;
610
- training_jobs?: string[];
611
- };
612
- /**
613
- * Abstract API object for event data
614
- * @deprecated in favor of EventDataV2
615
- * @see EventV2Data
616
- */
617
- type EventData = {
618
- conversation_id: string;
619
- client_version: string;
620
- source: 'agent' | 'visitor';
621
- pastes: string[];
622
- cuts: string[];
623
- deletions: string[];
624
- len_text_typed: number;
625
- len_text_total: number;
626
- len_text_assisted: number;
627
- len_text_pasted: number;
628
- len_text_cut: number;
629
- len_text_deleted: number;
630
- time_total_seconds: number;
631
- chars_per_second: number;
632
- text: string;
633
- num_pastes: number;
634
- text_suggestions_v2: UsedSuggestion[];
635
- url_suggestions_v2: UsedSuggestion[];
636
- url_link_suggestions_v2: UsedSuggestion[];
637
- suggestions_counters: {
638
- source: Sources;
639
- count_offered: number;
640
- }[];
641
- time_start: string;
642
- time_stop: string;
643
- agent_id?: string;
644
- agent_name?: string;
645
- agent_email?: string;
646
- platform: string;
647
- backend_version: string;
648
- engine_version: string;
649
- gpt_version: string;
650
- };
651
597
  /**
652
598
  * Backend API object for event data v2
653
599
  */
654
- type EventV2Data = {
600
+ type EventData = {
655
601
  name: string;
656
602
  platform?: string;
657
603
  conversation_id?: string;
@@ -702,15 +648,28 @@ declare namespace Server {
702
648
  /**
703
649
  * Handling time event data
704
650
  */
705
- type HandlingTimeEventData = Pick<EventData, 'conversation_id' | 'client_version' | 'time_start' | 'time_stop'> & Partial<Pick<EventData, 'agent_id' | 'agent_name' | 'agent_email'>>;
651
+ type HandlingTimeEventData = {
652
+ client_version: string;
653
+ time_start: string;
654
+ time_stop: string;
655
+ };
706
656
  /**
707
657
  * Send message event data
708
658
  */
709
- type SendMessageEventData = Pick<EventData, 'client_version' | 'conversation_id' | 'source' | 'pastes' | 'cuts' | 'deletions' | 'len_text_typed' | 'len_text_total' | 'len_text_assisted' | 'len_text_pasted' | 'len_text_cut' | 'len_text_deleted' | 'time_total_seconds' | 'chars_per_second' | 'num_pastes' | 'text' | 'text_suggestions_v2' | 'suggestions_counters'> & Partial<Pick<EventData, 'agent_id' | 'agent_name' | 'agent_email'>>;
710
- /**
711
- * PersonalCollection event data
712
- */
713
- type PersonalCollectionEventData = Pick<EventData, 'text' | 'platform'>;
659
+ type SendMessageEventData = {
660
+ client_version: string;
661
+ source: string;
662
+ len_text_total: number;
663
+ pastes: string[];
664
+ num_pastes: number;
665
+ suggestions: Array<{
666
+ input_type: string;
667
+ source?: Sources;
668
+ source_text?: string;
669
+ text: string;
670
+ training_jobs?: Array<string>;
671
+ }>;
672
+ };
714
673
  /**
715
674
  * Search results data
716
675
  */
@@ -908,15 +867,15 @@ type CreateConversationOptions = {
908
867
  */
909
868
  type SendMessageEventData = CamelCaseKeys<Server.SendMessageEventData>;
910
869
  /**
911
- * Event v2 payload
870
+ * Event payload
912
871
  */
913
- type EventV2<T = unknown> = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
872
+ type Event$1<T = unknown> = CamelCaseKeys<Omit<Server.EventData, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
914
873
  data: T;
915
874
  };
916
875
  /**
917
876
  * Handling time event data
918
877
  */
919
- type HandlingTimeEventData = CamelCaseKeys<Pick<Server.HandlingTimeEventData, 'conversation_id' | 'client_version' | 'time_start' | 'time_stop'>>;
878
+ type HandlingTimeEventData = CamelCaseKeys<Server.HandlingTimeEventData>;
920
879
  /**
921
880
  * Rule event meta data
922
881
  */
@@ -926,67 +885,61 @@ type RuleEventMeta = {
926
885
  group: string;
927
886
  };
928
887
  /**
929
- * Map the send event name to the data value in the payload. (V1)
930
- * @deprecated
931
- */
932
- type SendEventV1ArgumentMap = {
933
- 'Send Message': SendMessageEventData;
934
- 'Handling Time': HandlingTimeEventData;
935
- };
936
- /**
937
- * Map the send event name to the data value in the payload. (V2)
888
+ * Map the send event name to the data value in the payload
938
889
  */
939
- type SendEventV2ArgumentMap = {
940
- 'Add to personal collection': EventV2<{
890
+ type SendEventArgumentMap = {
891
+ 'Send Message': Event$1<SendMessageEventData>;
892
+ 'Handling Time': Event$1<HandlingTimeEventData>;
893
+ 'Add to personal collection': Event$1<{
941
894
  text: string;
942
895
  }>;
943
- 'Delete from personal collection': EventV2<{
896
+ 'Delete from personal collection': Event$1<{
944
897
  text: string;
945
898
  }>;
946
- 'entities found': EventV2<{
899
+ 'entities found': Event$1<{
947
900
  entities: Entity[];
948
901
  }>;
949
- 'conversation summarized': EventV2<{
902
+ 'conversation summarized': Event$1<{
950
903
  summary: string;
951
904
  assistant?: string;
952
905
  }>;
953
- 'style suggested': EventV2<{
906
+ 'style suggested': Event$1<{
954
907
  keywordMatches: {
955
908
  keyword: string;
956
909
  suggestion: string;
957
910
  }[];
958
911
  }>;
959
- 'Image attached': EventV2<{
912
+ 'Image attached': Event$1<{
960
913
  path: string;
961
914
  title: string;
962
915
  }>;
963
- 'Assistant response displayed': EventV2<RuleEventMeta & {
916
+ 'Assistant response displayed': Event$1<RuleEventMeta & {
964
917
  cueText: string;
965
918
  }>;
966
- 'Assistant response closed': EventV2<RuleEventMeta & {
919
+ 'Assistant response closed': Event$1<RuleEventMeta & {
967
920
  cueText: string;
968
921
  }>;
969
- 'Assistant response feedback': EventV2<RuleEventMeta & {
922
+ 'Assistant response feedback': Event$1<RuleEventMeta & {
970
923
  rating: 'up' | 'down';
971
924
  cueText: string;
972
925
  }>;
973
- 'Assistant response used': EventV2<RuleEventMeta & {
926
+ 'Assistant response used': Event$1<RuleEventMeta & {
974
927
  usedText: string;
975
928
  }>;
976
- 'Assistant response copied': EventV2<RuleEventMeta & {
929
+ 'Assistant response copied': Event$1<RuleEventMeta & {
977
930
  copiedText: string;
978
931
  }>;
979
- 'Assistant call to action': EventV2<RuleEventMeta & {
932
+ 'Assistant call to action': Event$1<RuleEventMeta & {
980
933
  eventName: string;
981
934
  value: string;
982
935
  }>;
983
- 'knowledge assist feedback': EventV2<{
936
+ 'knowledge assist feedback': Event$1<{
984
937
  question: string;
985
938
  isFollowUpQuestion: boolean;
986
939
  isAgent: boolean;
987
940
  answer: Server.KnowledgeResponse['answer'];
988
941
  }>;
989
- 'knowledge assist question answered': EventV2<{
942
+ 'knowledge assist question answered': Event$1<{
990
943
  question: string;
991
944
  answer: string;
992
945
  sources: {
@@ -996,32 +949,32 @@ type SendEventV2ArgumentMap = {
996
949
  isFollowUpQuestion: boolean;
997
950
  isAutoInitiated: boolean;
998
951
  }>;
999
- 'knowledge assist source viewed': EventV2<{
952
+ 'knowledge assist source viewed': Event$1<{
1000
953
  question: string;
1001
954
  sourceViewed: string;
1002
955
  }>;
1003
- 'knowledge assist reset': EventV2<{
956
+ 'knowledge assist reset': Event$1<{
1004
957
  threadId?: number;
1005
958
  }>;
1006
- 'summary feedback': EventV2<{
959
+ 'summary feedback': Event$1<{
1007
960
  summary: string;
1008
961
  rating: 'up' | 'down';
1009
962
  }>;
1010
- 'summary copied to clipboard': EventV2<{
963
+ 'summary copied to clipboard': Event$1<{
1011
964
  originalText: string;
1012
965
  finalText: string;
1013
966
  assistant: string;
1014
967
  }>;
1015
- 'open search': EventV2<{
968
+ 'open search': Event$1<{
1016
969
  via: 'ctrl+k' | 'autocomplete-overlay' | 'widget-shortcut';
1017
970
  }>;
1018
- 'open knowledge assistant': EventV2<{
971
+ 'open knowledge assistant': Event$1<{
1019
972
  via: 'ctrl+k' | 'widget-shortcut' | 'search-command';
1020
973
  }>;
1021
- 'open my deepdesk': EventV2<{
974
+ 'open my deepdesk': Event$1<{
1022
975
  via: 'widget-shortcut';
1023
976
  }>;
1024
- 'trigger on demand assistant': EventV2<{
977
+ 'trigger on demand assistant': Event$1<{
1025
978
  assistantCode: string;
1026
979
  }>;
1027
980
  };
@@ -1086,12 +1039,7 @@ declare class DeepdeskAPI {
1086
1039
  /**
1087
1040
  * Send event with meta data for analytics
1088
1041
  */
1089
- sendEvent<T extends keyof SendEventV2ArgumentMap>(event: T, payload: SendEventV2ArgumentMap[T]): Promise<void>;
1090
- /**
1091
- * Send event with meta data for analytics
1092
- * @deprecated
1093
- */
1094
- sendEventV1<T extends keyof SendEventV1ArgumentMap>(event: T, payload: SendEventV1ArgumentMap[T]): Promise<void>;
1042
+ sendEvent<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
1095
1043
  getEntities(messages: Array<{
1096
1044
  text: string;
1097
1045
  }>): Promise<Entity[]>;
package/dist/index.d.ts CHANGED
@@ -594,64 +594,10 @@ declare namespace Server {
594
594
  suggestion: string;
595
595
  }[];
596
596
  };
597
- enum EventType {
598
- SEND_MESSAGE = "Send Message",
599
- HANDLING_TIME = "Handling Time",
600
- ADD_TO_PERSONAL_COLLECTION = "Add to personal collection",
601
- DELETE_FROM_PERSONAL_COLLECTION = "Delete from personal collection"
602
- }
603
- type UsedSuggestion = {
604
- ab_test_name?: string | null;
605
- ab_variant?: string | null;
606
- input_type: string;
607
- source?: string;
608
- source_text?: string;
609
- text: string;
610
- training_jobs?: string[];
611
- };
612
- /**
613
- * Abstract API object for event data
614
- * @deprecated in favor of EventDataV2
615
- * @see EventV2Data
616
- */
617
- type EventData = {
618
- conversation_id: string;
619
- client_version: string;
620
- source: 'agent' | 'visitor';
621
- pastes: string[];
622
- cuts: string[];
623
- deletions: string[];
624
- len_text_typed: number;
625
- len_text_total: number;
626
- len_text_assisted: number;
627
- len_text_pasted: number;
628
- len_text_cut: number;
629
- len_text_deleted: number;
630
- time_total_seconds: number;
631
- chars_per_second: number;
632
- text: string;
633
- num_pastes: number;
634
- text_suggestions_v2: UsedSuggestion[];
635
- url_suggestions_v2: UsedSuggestion[];
636
- url_link_suggestions_v2: UsedSuggestion[];
637
- suggestions_counters: {
638
- source: Sources;
639
- count_offered: number;
640
- }[];
641
- time_start: string;
642
- time_stop: string;
643
- agent_id?: string;
644
- agent_name?: string;
645
- agent_email?: string;
646
- platform: string;
647
- backend_version: string;
648
- engine_version: string;
649
- gpt_version: string;
650
- };
651
597
  /**
652
598
  * Backend API object for event data v2
653
599
  */
654
- type EventV2Data = {
600
+ type EventData = {
655
601
  name: string;
656
602
  platform?: string;
657
603
  conversation_id?: string;
@@ -702,15 +648,28 @@ declare namespace Server {
702
648
  /**
703
649
  * Handling time event data
704
650
  */
705
- type HandlingTimeEventData = Pick<EventData, 'conversation_id' | 'client_version' | 'time_start' | 'time_stop'> & Partial<Pick<EventData, 'agent_id' | 'agent_name' | 'agent_email'>>;
651
+ type HandlingTimeEventData = {
652
+ client_version: string;
653
+ time_start: string;
654
+ time_stop: string;
655
+ };
706
656
  /**
707
657
  * Send message event data
708
658
  */
709
- type SendMessageEventData = Pick<EventData, 'client_version' | 'conversation_id' | 'source' | 'pastes' | 'cuts' | 'deletions' | 'len_text_typed' | 'len_text_total' | 'len_text_assisted' | 'len_text_pasted' | 'len_text_cut' | 'len_text_deleted' | 'time_total_seconds' | 'chars_per_second' | 'num_pastes' | 'text' | 'text_suggestions_v2' | 'suggestions_counters'> & Partial<Pick<EventData, 'agent_id' | 'agent_name' | 'agent_email'>>;
710
- /**
711
- * PersonalCollection event data
712
- */
713
- type PersonalCollectionEventData = Pick<EventData, 'text' | 'platform'>;
659
+ type SendMessageEventData = {
660
+ client_version: string;
661
+ source: string;
662
+ len_text_total: number;
663
+ pastes: string[];
664
+ num_pastes: number;
665
+ suggestions: Array<{
666
+ input_type: string;
667
+ source?: Sources;
668
+ source_text?: string;
669
+ text: string;
670
+ training_jobs?: Array<string>;
671
+ }>;
672
+ };
714
673
  /**
715
674
  * Search results data
716
675
  */
@@ -908,15 +867,15 @@ type CreateConversationOptions = {
908
867
  */
909
868
  type SendMessageEventData = CamelCaseKeys<Server.SendMessageEventData>;
910
869
  /**
911
- * Event v2 payload
870
+ * Event payload
912
871
  */
913
- type EventV2<T = unknown> = CamelCaseKeys<Omit<Server.EventV2Data, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
872
+ type Event$1<T = unknown> = CamelCaseKeys<Omit<Server.EventData, 'name' | 'backend_version' | 'engine_version' | 'gpt_version' | 'data'>> & {
914
873
  data: T;
915
874
  };
916
875
  /**
917
876
  * Handling time event data
918
877
  */
919
- type HandlingTimeEventData = CamelCaseKeys<Pick<Server.HandlingTimeEventData, 'conversation_id' | 'client_version' | 'time_start' | 'time_stop'>>;
878
+ type HandlingTimeEventData = CamelCaseKeys<Server.HandlingTimeEventData>;
920
879
  /**
921
880
  * Rule event meta data
922
881
  */
@@ -926,67 +885,61 @@ type RuleEventMeta = {
926
885
  group: string;
927
886
  };
928
887
  /**
929
- * Map the send event name to the data value in the payload. (V1)
930
- * @deprecated
931
- */
932
- type SendEventV1ArgumentMap = {
933
- 'Send Message': SendMessageEventData;
934
- 'Handling Time': HandlingTimeEventData;
935
- };
936
- /**
937
- * Map the send event name to the data value in the payload. (V2)
888
+ * Map the send event name to the data value in the payload
938
889
  */
939
- type SendEventV2ArgumentMap = {
940
- 'Add to personal collection': EventV2<{
890
+ type SendEventArgumentMap = {
891
+ 'Send Message': Event$1<SendMessageEventData>;
892
+ 'Handling Time': Event$1<HandlingTimeEventData>;
893
+ 'Add to personal collection': Event$1<{
941
894
  text: string;
942
895
  }>;
943
- 'Delete from personal collection': EventV2<{
896
+ 'Delete from personal collection': Event$1<{
944
897
  text: string;
945
898
  }>;
946
- 'entities found': EventV2<{
899
+ 'entities found': Event$1<{
947
900
  entities: Entity[];
948
901
  }>;
949
- 'conversation summarized': EventV2<{
902
+ 'conversation summarized': Event$1<{
950
903
  summary: string;
951
904
  assistant?: string;
952
905
  }>;
953
- 'style suggested': EventV2<{
906
+ 'style suggested': Event$1<{
954
907
  keywordMatches: {
955
908
  keyword: string;
956
909
  suggestion: string;
957
910
  }[];
958
911
  }>;
959
- 'Image attached': EventV2<{
912
+ 'Image attached': Event$1<{
960
913
  path: string;
961
914
  title: string;
962
915
  }>;
963
- 'Assistant response displayed': EventV2<RuleEventMeta & {
916
+ 'Assistant response displayed': Event$1<RuleEventMeta & {
964
917
  cueText: string;
965
918
  }>;
966
- 'Assistant response closed': EventV2<RuleEventMeta & {
919
+ 'Assistant response closed': Event$1<RuleEventMeta & {
967
920
  cueText: string;
968
921
  }>;
969
- 'Assistant response feedback': EventV2<RuleEventMeta & {
922
+ 'Assistant response feedback': Event$1<RuleEventMeta & {
970
923
  rating: 'up' | 'down';
971
924
  cueText: string;
972
925
  }>;
973
- 'Assistant response used': EventV2<RuleEventMeta & {
926
+ 'Assistant response used': Event$1<RuleEventMeta & {
974
927
  usedText: string;
975
928
  }>;
976
- 'Assistant response copied': EventV2<RuleEventMeta & {
929
+ 'Assistant response copied': Event$1<RuleEventMeta & {
977
930
  copiedText: string;
978
931
  }>;
979
- 'Assistant call to action': EventV2<RuleEventMeta & {
932
+ 'Assistant call to action': Event$1<RuleEventMeta & {
980
933
  eventName: string;
981
934
  value: string;
982
935
  }>;
983
- 'knowledge assist feedback': EventV2<{
936
+ 'knowledge assist feedback': Event$1<{
984
937
  question: string;
985
938
  isFollowUpQuestion: boolean;
986
939
  isAgent: boolean;
987
940
  answer: Server.KnowledgeResponse['answer'];
988
941
  }>;
989
- 'knowledge assist question answered': EventV2<{
942
+ 'knowledge assist question answered': Event$1<{
990
943
  question: string;
991
944
  answer: string;
992
945
  sources: {
@@ -996,32 +949,32 @@ type SendEventV2ArgumentMap = {
996
949
  isFollowUpQuestion: boolean;
997
950
  isAutoInitiated: boolean;
998
951
  }>;
999
- 'knowledge assist source viewed': EventV2<{
952
+ 'knowledge assist source viewed': Event$1<{
1000
953
  question: string;
1001
954
  sourceViewed: string;
1002
955
  }>;
1003
- 'knowledge assist reset': EventV2<{
956
+ 'knowledge assist reset': Event$1<{
1004
957
  threadId?: number;
1005
958
  }>;
1006
- 'summary feedback': EventV2<{
959
+ 'summary feedback': Event$1<{
1007
960
  summary: string;
1008
961
  rating: 'up' | 'down';
1009
962
  }>;
1010
- 'summary copied to clipboard': EventV2<{
963
+ 'summary copied to clipboard': Event$1<{
1011
964
  originalText: string;
1012
965
  finalText: string;
1013
966
  assistant: string;
1014
967
  }>;
1015
- 'open search': EventV2<{
968
+ 'open search': Event$1<{
1016
969
  via: 'ctrl+k' | 'autocomplete-overlay' | 'widget-shortcut';
1017
970
  }>;
1018
- 'open knowledge assistant': EventV2<{
971
+ 'open knowledge assistant': Event$1<{
1019
972
  via: 'ctrl+k' | 'widget-shortcut' | 'search-command';
1020
973
  }>;
1021
- 'open my deepdesk': EventV2<{
974
+ 'open my deepdesk': Event$1<{
1022
975
  via: 'widget-shortcut';
1023
976
  }>;
1024
- 'trigger on demand assistant': EventV2<{
977
+ 'trigger on demand assistant': Event$1<{
1025
978
  assistantCode: string;
1026
979
  }>;
1027
980
  };
@@ -1086,12 +1039,7 @@ declare class DeepdeskAPI {
1086
1039
  /**
1087
1040
  * Send event with meta data for analytics
1088
1041
  */
1089
- sendEvent<T extends keyof SendEventV2ArgumentMap>(event: T, payload: SendEventV2ArgumentMap[T]): Promise<void>;
1090
- /**
1091
- * Send event with meta data for analytics
1092
- * @deprecated
1093
- */
1094
- sendEventV1<T extends keyof SendEventV1ArgumentMap>(event: T, payload: SendEventV1ArgumentMap[T]): Promise<void>;
1042
+ sendEvent<T extends keyof SendEventArgumentMap>(event: T, payload: SendEventArgumentMap[T]): Promise<void>;
1095
1043
  getEntities(messages: Array<{
1096
1044
  text: string;
1097
1045
  }>): Promise<Entity[]>;