@microsoft/omnichannel-chat-sdk 0.2.1-main.f5ff432 → 0.3.1-main.577db56

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 (132) hide show
  1. package/CHANGELOG.md +34 -1
  2. package/README.md +165 -9
  3. package/lib/OmnichannelChatSDK.d.ts +39 -22
  4. package/lib/OmnichannelChatSDK.js +1032 -335
  5. package/lib/OmnichannelChatSDK.js.map +1 -1
  6. package/lib/api/createVoiceVideoCalling.d.ts +1 -0
  7. package/lib/api/createVoiceVideoCalling.js +91 -83
  8. package/lib/api/createVoiceVideoCalling.js.map +1 -1
  9. package/lib/config/settings.d.ts +4 -3
  10. package/lib/config/settings.js +5 -3
  11. package/lib/config/settings.js.map +1 -1
  12. package/lib/core/{IAuthSettings.d.ts → AuthSettings.d.ts} +1 -1
  13. package/lib/core/{IAuthSettings.js → AuthSettings.js} +1 -1
  14. package/lib/core/AuthSettings.js.map +1 -0
  15. package/lib/core/{IChatConfig.d.ts → ChatConfig.d.ts} +1 -1
  16. package/lib/core/{IChatConfig.js → ChatConfig.js} +1 -1
  17. package/lib/core/ChatConfig.js.map +1 -0
  18. package/lib/core/ChatReconnectContext.d.ts +4 -0
  19. package/lib/core/ChatReconnectContext.js +3 -0
  20. package/lib/core/ChatReconnectContext.js.map +1 -0
  21. package/lib/core/ChatReconnectOptionalParams.d.ts +3 -0
  22. package/lib/core/ChatReconnectOptionalParams.js +3 -0
  23. package/lib/core/ChatReconnectOptionalParams.js.map +1 -0
  24. package/lib/core/{IChatSDKConfig.d.ts → ChatSDKConfig.d.ts} +11 -7
  25. package/lib/core/{IChatSDKConfig.js → ChatSDKConfig.js} +1 -1
  26. package/lib/core/ChatSDKConfig.js.map +1 -0
  27. package/lib/core/{IChatTranscriptBody.d.ts → ChatTranscriptBody.d.ts} +1 -1
  28. package/lib/core/ChatTranscriptBody.js +3 -0
  29. package/lib/core/ChatTranscriptBody.js.map +1 -0
  30. package/lib/core/{ILiveChatContext.d.ts → LiveChatContext.d.ts} +1 -1
  31. package/lib/core/LiveChatContext.js +3 -0
  32. package/lib/core/LiveChatContext.js.map +1 -0
  33. package/lib/core/LiveChatVersion.d.ts +5 -0
  34. package/lib/core/LiveChatVersion.js +9 -0
  35. package/lib/core/LiveChatVersion.js.map +1 -0
  36. package/lib/core/{IOmnichannelConfig.d.ts → OmnichannelConfig.d.ts} +1 -1
  37. package/lib/core/OmnichannelConfig.js +3 -0
  38. package/lib/core/OmnichannelConfig.js.map +1 -0
  39. package/lib/core/{IStartChatOptionalParams.d.ts → StartChatOptionalParams.d.ts} +4 -3
  40. package/lib/core/StartChatOptionalParams.js +3 -0
  41. package/lib/core/StartChatOptionalParams.js.map +1 -0
  42. package/lib/core/messaging/ACSChatMessageType.d.ts +7 -0
  43. package/lib/core/messaging/ACSChatMessageType.js +11 -0
  44. package/lib/core/messaging/ACSChatMessageType.js.map +1 -0
  45. package/lib/core/messaging/ACSClient.d.ts +44 -0
  46. package/lib/core/messaging/ACSClient.js +588 -0
  47. package/lib/core/messaging/ACSClient.js.map +1 -0
  48. package/lib/core/messaging/ACSClientConfig.d.ts +4 -0
  49. package/lib/core/messaging/ACSClientConfig.js +3 -0
  50. package/lib/core/messaging/ACSClientConfig.js.map +1 -0
  51. package/lib/core/messaging/ACSParticipantDisplayName.d.ts +6 -0
  52. package/lib/core/messaging/ACSParticipantDisplayName.js +10 -0
  53. package/lib/core/messaging/ACSParticipantDisplayName.js.map +1 -0
  54. package/lib/core/messaging/ACSSessionInfo.d.ts +5 -0
  55. package/lib/core/messaging/ACSSessionInfo.js +3 -0
  56. package/lib/core/messaging/ACSSessionInfo.js.map +1 -0
  57. package/lib/core/{ChatAdapterConfig.d.ts → messaging/ChatAdapterConfig.d.ts} +2 -0
  58. package/lib/core/{ChatAdapterConfig.js → messaging/ChatAdapterConfig.js} +0 -0
  59. package/lib/core/messaging/ChatAdapterConfig.js.map +1 -0
  60. package/lib/core/{ChatAdapterProtocols.d.ts → messaging/ChatAdapterProtocols.d.ts} +1 -0
  61. package/lib/core/{ChatAdapterProtocols.js → messaging/ChatAdapterProtocols.js} +3 -1
  62. package/lib/core/messaging/ChatAdapterProtocols.js.map +1 -0
  63. package/lib/core/{IChatSDKMessage.d.ts → messaging/ChatSDKMessage.d.ts} +2 -1
  64. package/lib/core/messaging/ChatSDKMessage.js +3 -0
  65. package/lib/core/messaging/ChatSDKMessage.js.map +1 -0
  66. package/lib/core/{IC3Config.d.ts → messaging/IC3Config.d.ts} +0 -0
  67. package/lib/core/{IC3Config.js → messaging/IC3Config.js} +0 -0
  68. package/lib/core/messaging/IC3Config.js.map +1 -0
  69. package/lib/core/messaging/MessageTags.d.ts +1 -0
  70. package/lib/core/messaging/MessageTags.js +5 -0
  71. package/lib/core/messaging/MessageTags.js.map +1 -0
  72. package/lib/core/messaging/OmnichannelMessage.d.ts +64 -0
  73. package/lib/core/messaging/OmnichannelMessage.js +52 -0
  74. package/lib/core/messaging/OmnichannelMessage.js.map +1 -0
  75. package/lib/core/{OnNewMessageOptionalParams.d.ts → messaging/OnNewMessageOptionalParams.d.ts} +0 -0
  76. package/lib/core/{OnNewMessageOptionalParams.js → messaging/OnNewMessageOptionalParams.js} +0 -0
  77. package/lib/core/messaging/OnNewMessageOptionalParams.js.map +1 -0
  78. package/lib/external/ACSAdapter/AMSFileManager.d.ts +39 -0
  79. package/lib/external/ACSAdapter/AMSFileManager.js +306 -0
  80. package/lib/external/ACSAdapter/AMSFileManager.js.map +1 -0
  81. package/lib/external/IC3Adapter/IChatToken.d.ts +2 -0
  82. package/lib/index.d.ts +2 -2
  83. package/lib/telemetry/AriaTelemetry.d.ts +4 -0
  84. package/lib/telemetry/AriaTelemetry.js +150 -13
  85. package/lib/telemetry/AriaTelemetry.js.map +1 -1
  86. package/lib/telemetry/EventMarker.d.ts +3 -0
  87. package/lib/telemetry/EventMarker.js +13 -0
  88. package/lib/telemetry/EventMarker.js.map +1 -0
  89. package/lib/telemetry/ScenarioMarker.d.ts +9 -7
  90. package/lib/telemetry/ScenarioMarker.js +12 -7
  91. package/lib/telemetry/ScenarioMarker.js.map +1 -1
  92. package/lib/telemetry/ScenarioType.d.ts +2 -0
  93. package/lib/telemetry/ScenarioType.js +2 -0
  94. package/lib/telemetry/ScenarioType.js.map +1 -1
  95. package/lib/telemetry/TelemetryEvent.d.ts +10 -4
  96. package/lib/telemetry/TelemetryEvent.js +9 -10
  97. package/lib/telemetry/TelemetryEvent.js.map +1 -1
  98. package/lib/tsconfig.tsbuildinfo +5378 -1320
  99. package/lib/utils/createOmnichannelMessage.d.ts +11 -0
  100. package/lib/utils/createOmnichannelMessage.js +63 -0
  101. package/lib/utils/createOmnichannelMessage.js.map +1 -0
  102. package/lib/utils/libraries.d.ts +3 -1
  103. package/lib/utils/libraries.js +9 -2
  104. package/lib/utils/libraries.js.map +1 -1
  105. package/lib/utils/loggers.d.ts +42 -6
  106. package/lib/utils/loggers.js +197 -2
  107. package/lib/utils/loggers.js.map +1 -1
  108. package/lib/utils/utilities.js +10 -3
  109. package/lib/utils/utilities.js.map +1 -1
  110. package/lib/validators/OmnichannelConfigValidator.d.ts +2 -2
  111. package/lib/validators/OmnichannelConfigValidator.js.map +1 -1
  112. package/lib/validators/SDKConfigValidators.d.ts +3 -3
  113. package/lib/validators/SDKConfigValidators.js +11 -0
  114. package/lib/validators/SDKConfigValidators.js.map +1 -1
  115. package/package.json +14 -10
  116. package/lib/core/ChatAdapterConfig.js.map +0 -1
  117. package/lib/core/ChatAdapterProtocols.js.map +0 -1
  118. package/lib/core/IAuthSettings.js.map +0 -1
  119. package/lib/core/IC3Config.js.map +0 -1
  120. package/lib/core/IChatConfig.js.map +0 -1
  121. package/lib/core/IChatSDKConfig.js.map +0 -1
  122. package/lib/core/IChatSDKMessage.js +0 -3
  123. package/lib/core/IChatSDKMessage.js.map +0 -1
  124. package/lib/core/IChatTranscriptBody.js +0 -3
  125. package/lib/core/IChatTranscriptBody.js.map +0 -1
  126. package/lib/core/ILiveChatContext.js +0 -3
  127. package/lib/core/ILiveChatContext.js.map +0 -1
  128. package/lib/core/IOmnichannelConfig.js +0 -3
  129. package/lib/core/IOmnichannelConfig.js.map +0 -1
  130. package/lib/core/IStartChatOptionalParams.js +0 -3
  131. package/lib/core/IStartChatOptionalParams.js.map +0 -1
  132. package/lib/core/OnNewMessageOptionalParams.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export default interface IAuthSettings {
1
+ export default interface AuthSettings {
2
2
  msdyn_authenticationtype: string;
3
3
  msdyn_javascriptclientfunction: string;
4
4
  msdyn_publickeyurl: string;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IAuthSettings.js.map
3
+ //# sourceMappingURL=AuthSettings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AuthSettings.js","sourceRoot":"","sources":["../../src/core/AuthSettings.ts"],"names":[],"mappings":""}
@@ -1,4 +1,4 @@
1
- export default interface IChatConfig {
1
+ export default interface ChatConfig {
2
2
  DataMaskingInfo: unknown;
3
3
  LiveChatConfigAuthSettings: unknown;
4
4
  LiveWSAndLiveChatEngJoin: any;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IChatConfig.js.map
3
+ //# sourceMappingURL=ChatConfig.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ChatConfig.js","sourceRoot":"","sources":["../../src/core/ChatConfig.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export default interface ChatReconnectContext {
2
+ redirectURL: string | null;
3
+ reconnectId: string | null;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ChatReconnectContext.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ChatReconnectContext.js","sourceRoot":"","sources":["../../src/core/ChatReconnectContext.ts"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ export default interface ChatReconnectOptionalParams {
2
+ reconnectId?: string;
3
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ChatReconnectOptionalParams.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ChatReconnectOptionalParams.js","sourceRoot":"","sources":["../../src/core/ChatReconnectOptionalParams.ts"],"names":[],"mappings":""}
@@ -1,6 +1,6 @@
1
- import ChatAdapterConfig from "./ChatAdapterConfig";
2
- import IC3Config from "./IC3Config";
3
- interface IDataMaskingSDKConfig {
1
+ import ChatAdapterConfig from "./messaging/ChatAdapterConfig";
2
+ import IC3Config from "./messaging/IC3Config";
3
+ interface DataMaskingSDKConfig {
4
4
  disable: boolean;
5
5
  maskingCharacter: string;
6
6
  }
@@ -12,13 +12,17 @@ interface PersistentChatConfig {
12
12
  disable: boolean;
13
13
  tokenUpdateTime: number;
14
14
  }
15
- interface IChatSDKConfig {
16
- dataMasking?: IDataMaskingSDKConfig;
15
+ interface ChatReconnectConfig {
16
+ disable: boolean;
17
+ }
18
+ interface ChatSDKConfig {
19
+ dataMasking?: DataMaskingSDKConfig;
17
20
  telemetry?: TelemetrySDKConfig;
18
21
  persistentChat?: PersistentChatConfig;
22
+ chatReconnect?: ChatReconnectConfig;
19
23
  getAuthToken?: () => Promise<string | null>;
20
24
  ic3Config?: IC3Config;
21
25
  chatAdapterConfig?: ChatAdapterConfig;
22
26
  }
23
- export { IDataMaskingSDKConfig };
24
- export default IChatSDKConfig;
27
+ export { DataMaskingSDKConfig, PersistentChatConfig };
28
+ export default ChatSDKConfig;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IChatSDKConfig.js.map
3
+ //# sourceMappingURL=ChatSDKConfig.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ChatSDKConfig.js","sourceRoot":"","sources":["../../src/core/ChatSDKConfig.ts"],"names":[],"mappings":""}
@@ -1,4 +1,4 @@
1
- export default interface IChatTranscriptBody {
1
+ export default interface ChatTranscriptBody {
2
2
  emailAddress: string;
3
3
  attachmentMessage: string;
4
4
  locale: string;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ChatTranscriptBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ChatTranscriptBody.js","sourceRoot":"","sources":["../../src/core/ChatTranscriptBody.ts"],"names":[],"mappings":""}
@@ -1,5 +1,5 @@
1
1
  import IChatToken from "../external/IC3Adapter/IChatToken";
2
- export default interface ILiveChatContext {
2
+ export default interface LiveChatContext {
3
3
  chatToken: IChatToken;
4
4
  requestId: string;
5
5
  }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=LiveChatContext.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"LiveChatContext.js","sourceRoot":"","sources":["../../src/core/LiveChatContext.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ declare enum LiveChatVersion {
2
+ V1 = 1,
3
+ V2 = 2
4
+ }
5
+ export default LiveChatVersion;
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var LiveChatVersion;
4
+ (function (LiveChatVersion) {
5
+ LiveChatVersion[LiveChatVersion["V1"] = 1] = "V1";
6
+ LiveChatVersion[LiveChatVersion["V2"] = 2] = "V2";
7
+ })(LiveChatVersion || (LiveChatVersion = {}));
8
+ exports.default = LiveChatVersion;
9
+ //# sourceMappingURL=LiveChatVersion.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"LiveChatVersion.js","sourceRoot":"","sources":["../../src/core/LiveChatVersion.ts"],"names":[],"mappings":";;AAAA,IAAK,eAGJ;AAHD,WAAK,eAAe;IAChB,iDAAM,CAAA;IACN,iDAAM,CAAA;AACV,CAAC,EAHI,eAAe,KAAf,eAAe,QAGnB;AAED,kBAAe,eAAe,CAAC"}
@@ -1,4 +1,4 @@
1
- export default interface IOmnichannelConfig {
1
+ export default interface OmnichannelConfig {
2
2
  orgId: string;
3
3
  orgUrl: string;
4
4
  widgetId: string;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=OmnichannelConfig.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"OmnichannelConfig.js","sourceRoot":"","sources":["../../src/core/OmnichannelConfig.ts"],"names":[],"mappings":""}
@@ -1,7 +1,7 @@
1
1
  import InitContext from "@microsoft/ocsdk/lib/Model/InitContext";
2
- import ILiveChatContext from "./ILiveChatContext";
3
- export default interface IStartChatOptionalParams {
4
- liveChatContext?: ILiveChatContext;
2
+ import LiveChatContext from "./LiveChatContext";
3
+ export default interface StartChatOptionalParams {
4
+ liveChatContext?: LiveChatContext;
5
5
  preChatResponse?: object;
6
6
  customContext?: object;
7
7
  browser?: string;
@@ -9,4 +9,5 @@ export default interface IStartChatOptionalParams {
9
9
  locale?: string;
10
10
  device?: string;
11
11
  initContext?: InitContext;
12
+ reconnectId?: string;
12
13
  }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=StartChatOptionalParams.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StartChatOptionalParams.js","sourceRoot":"","sources":["../../src/core/StartChatOptionalParams.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ declare enum ACSChatMessageType {
2
+ Text = "text",
3
+ TopicUpdated = "topicUpdated",
4
+ ParticipantAdded = "participantAdded",
5
+ ParticipantRemoved = "participantRemoved"
6
+ }
7
+ export default ACSChatMessageType;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var ACSChatMessageType;
4
+ (function (ACSChatMessageType) {
5
+ ACSChatMessageType["Text"] = "text";
6
+ ACSChatMessageType["TopicUpdated"] = "topicUpdated";
7
+ ACSChatMessageType["ParticipantAdded"] = "participantAdded";
8
+ ACSChatMessageType["ParticipantRemoved"] = "participantRemoved";
9
+ })(ACSChatMessageType || (ACSChatMessageType = {}));
10
+ exports.default = ACSChatMessageType;
11
+ //# sourceMappingURL=ACSChatMessageType.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ACSChatMessageType.js","sourceRoot":"","sources":["../../../src/core/messaging/ACSChatMessageType.ts"],"names":[],"mappings":";;AAAA,IAAK,kBAKJ;AALD,WAAK,kBAAkB;IACnB,mCAAa,CAAA;IACb,mDAA6B,CAAA;IAC7B,2DAAqC,CAAA;IACrC,+DAAyC,CAAA;AAC7C,CAAC,EALI,kBAAkB,KAAlB,kBAAkB,QAKtB;AAED,kBAAe,kBAAkB,CAAC"}
@@ -0,0 +1,44 @@
1
+ import ACSClientConfig from "./ACSClientConfig";
2
+ import { ACSClientLogger } from "../../utils/loggers";
3
+ import ACSSessionInfo from "./ACSSessionInfo";
4
+ import { ChatClient, ChatParticipant } from "@azure/communication-chat";
5
+ import { AzureCommunicationTokenCredential } from "@azure/communication-common";
6
+ import ChatSDKMessage from "./ChatSDKMessage";
7
+ import OmnichannelMessage from "./OmnichannelMessage";
8
+ export interface ParticipantMapping {
9
+ [key: string]: ChatParticipant;
10
+ }
11
+ export declare class ACSConversation {
12
+ private logger;
13
+ private tokenCredential;
14
+ private chatClient;
15
+ private chatThreadClient?;
16
+ private sessionInfo?;
17
+ private participantsMapping?;
18
+ private eventListeners;
19
+ constructor(tokenCredential: AzureCommunicationTokenCredential, chatClient: ChatClient, logger?: ACSClientLogger | null);
20
+ initialize(sessionInfo: ACSSessionInfo): Promise<void>;
21
+ getMessages(): Promise<OmnichannelMessage[]>;
22
+ getParticipants(): Promise<ChatParticipant[]>;
23
+ registerOnNewMessage(onNewMessageCallback: CallableFunction): Promise<void>;
24
+ registerOnThreadUpdate(onThreadUpdateCallback: CallableFunction): Promise<void>;
25
+ onTypingEvent(onTypingEventCallback: CallableFunction): Promise<void>;
26
+ sendMessage(message: ChatSDKMessage): Promise<void>;
27
+ sendTyping(): Promise<void>;
28
+ sendFileMessage(): Promise<void>;
29
+ sendFileData(): Promise<void>;
30
+ uploadFile(): Promise<void>;
31
+ downloadFile(): Promise<void>;
32
+ disconnect(): Promise<void>;
33
+ private createParticipantsMapping;
34
+ private trackListener;
35
+ }
36
+ declare class ACSClient {
37
+ private logger;
38
+ private tokenCredential;
39
+ private chatClient;
40
+ constructor(logger?: ACSClientLogger | null);
41
+ initialize(acsClientConfig: ACSClientConfig): Promise<void>;
42
+ joinConversation(sessionInfo: ACSSessionInfo): Promise<ACSConversation>;
43
+ }
44
+ export default ACSClient;