Entry widget and secure conversations v2

GliaWidgets/Asset.swift

@@ -65,6 +65,7 @@ public enum Asset {
       public static let uploadRemove = ImageAsset(name: "uploadRemove")
     public static let chatPickMedia = ImageAsset(name: "chatPickMedia")
     public static let chatSend = ImageAsset(name: "chatSend")
+    public static let sendMessageUnavailableInfo = ImageAsset(name: "send-message-unavailable-info")
     public static let unreadMessageIndicator = ImageAsset(name: "unreadMessageIndicator")
     public static let back = ImageAsset(name: "back")
     public static let close = ImageAsset(name: "close")
@@ -109,6 +110,7 @@ public enum Asset {
       uploadRemove,
       chatPickMedia,
       chatSend,
+      sendMessageUnavailableInfo,
       unreadMessageIndicator,
       back,
       close,

GliaWidgets/Localization.swift

@@ -432,14 +432,88 @@ internal enum Localization {
       internal static var message: String { Localization.tr("Localizable", "engagement.queue_wait.message", fallback: "You can continue browsing and we will connect you automatically.") }
     }
     internal enum SecureMessaging {
-      /// Messaging
-      internal static var title: String { Localization.tr("Localizable", "engagement.secure_messaging.title", fallback: "Messaging") }
+      /// Secure Messaging
+      internal static var title: String { Localization.tr("Localizable", "engagement.secure_messaging.title", fallback: "Secure Messaging") }
     }
     internal enum Video {
       /// Video
       internal static var title: String { Localization.tr("Localizable", "engagement.video.title", fallback: "Video") }
     }
   }
+  internal enum EntryWidget {
+    internal enum Audio {
+      internal enum Button {
+        /// Speak through your device
+        internal static var description: String { Localization.tr("Localizable", "entry_widget.audio.button.description", fallback: "Speak through your device") }
+        /// Audio
+        internal static var label: String { Localization.tr("Localizable", "entry_widget.audio.button.label", fallback: "Audio") }
+        internal enum Accessibility {
+          /// Starts a call
+          internal static var hint: String { Localization.tr("Localizable", "entry_widget.audio.button.accessibility.hint", fallback: "Starts a call") }
+        }
+      }
+    }
+    internal enum EmptyState {
+      /// We are here to assist you during our business hours.
+      internal static var description: String { Localization.tr("Localizable", "entry_widget.empty_state.description", fallback: "We are here to assist you during our business hours.") }
+      /// Support team is currently offline
+      internal static var title: String { Localization.tr("Localizable", "entry_widget.empty_state.title", fallback: "Support team is currently offline") }
+    }
+    internal enum ErrorState {
+      /// We could not load the contacts at this time. This may be due to a temporary syncing issue or network problem.
+      internal static var description: String { Localization.tr("Localizable", "entry_widget.error_state.description", fallback: "We could not load the contacts at this time. This may be due to a temporary syncing issue or network problem.") }
+      /// Could not load the contacts
+      internal static var title: String { Localization.tr("Localizable", "entry_widget.error_state.title", fallback: "Could not load the contacts") }
+      internal enum TryAgain {
+        internal enum Button {
+          /// Try again
+          internal static var label: String { Localization.tr("Localizable", "entry_widget.error_state.try_again.button.label", fallback: "Try again") }
+        }
+      }
+    }
+    internal enum LiveChat {
+      internal enum Button {
+        /// For the texter in all of us
+        internal static var description: String { Localization.tr("Localizable", "entry_widget.live_chat.button.description", fallback: "For the texter in all of us") }
+        /// Live Chat
+        internal static var label: String { Localization.tr("Localizable", "entry_widget.live_chat.button.label", fallback: "Live Chat") }
+        internal enum Accessibility {
+          /// Starts a chat
+          internal static var hint: String { Localization.tr("Localizable", "entry_widget.live_chat.button.accessibility.hint", fallback: "Starts a chat") }
+        }
+      }
+    }
+    internal enum Loading {
+      internal enum Accessibility {
+        /// Loading indicator. Waiting for available options.
+        internal static var label: String { Localization.tr("Localizable", "entry_widget.loading.accessibility.label", fallback: "Loading indicator. Waiting for available options.") }
+      }
+    }
+    internal enum SecureMessaging {
+      internal enum Button {
+        /// Start a conversation, we’ll get back to you
+        internal static var description: String { Localization.tr("Localizable", "entry_widget.secure_messaging.button.description", fallback: "Start a conversation, we’ll get back to you") }
+        /// Secure Messaging
+        internal static var label: String { Localization.tr("Localizable", "entry_widget.secure_messaging.button.label", fallback: "Secure Messaging") }
+        internal enum Accessibility {
+          /// Starts messaging with us
+          internal static var hint: String { Localization.tr("Localizable", "entry_widget.secure_messaging.button.accessibility.hint", fallback: "Starts messaging with us") }
+        }
+      }
+    }
+    internal enum Video {
+      internal enum Button {
+        /// Face-to-face, just like in person
+        internal static var description: String { Localization.tr("Localizable", "entry_widget.video.button.description", fallback: "Face-to-face, just like in person") }
+        /// Video
+        internal static var label: String { Localization.tr("Localizable", "entry_widget.video.button.label", fallback: "Video") }
+        internal enum Accessibility {
+          /// Starts a video call
+          internal static var hint: String { Localization.tr("Localizable", "entry_widget.video.button.accessibility.hint", fallback: "Starts a video call") }
+        }
+      }
+    }
+  }
   internal enum Error {
     /// Something went wrong.
     internal static var general: String { Localization.tr("Localizable", "error.general", fallback: "Something went wrong.") }
@@ -563,11 +637,11 @@ internal enum Localization {
     }
   }
   internal enum MessageCenter {
-    /// Messaging
-    internal static var header: String { Localization.tr("Localizable", "message_center.header", fallback: "Messaging") }
+    /// Secure Messaging
+    internal static var header: String { Localization.tr("Localizable", "message_center.header", fallback: "Secure Messaging") }
     internal enum Confirmation {
-      /// Your message has been sent. We will get back to you within 48 hours.
-      internal static var subtitle: String { Localization.tr("Localizable", "message_center.confirmation.subtitle", fallback: "Your message has been sent. We will get back to you within 48 hours.") }
+      /// Your message has been sent. We will get back to you within 1 business day.
+      internal static var subtitle: String { Localization.tr("Localizable", "message_center.confirmation.subtitle", fallback: "Your message has been sent. We will get back to you within 1 business day.") }
       internal enum CheckMessages {
         internal enum Accessibility {
           /// Navigates you to the chat transcript.
@@ -592,10 +666,10 @@ internal enum Localization {
       internal static var checkMessages: String { Localization.tr("Localizable", "message_center.welcome.check_messages", fallback: "Check messages") }
       /// Your message
       internal static var messageTitle: String { Localization.tr("Localizable", "message_center.welcome.message_title", fallback: "Your message") }
-      /// Send a message and we will get back to you within 48 hours.
-      internal static var subtitle: String { Localization.tr("Localizable", "message_center.welcome.subtitle", fallback: "Send a message and we will get back to you within 48 hours.") }
-      /// Welcome to Message Center
-      internal static var title: String { Localization.tr("Localizable", "message_center.welcome.title", fallback: "Welcome to Message Center") }
+      /// Send a message and we will get back to you within 1 business day.
+      internal static var subtitle: String { Localization.tr("Localizable", "message_center.welcome.subtitle", fallback: "Send a message and we will get back to you within 1 business day.") }
+      /// Welcome to Secure Messaging
+      internal static var title: String { Localization.tr("Localizable", "message_center.welcome.title", fallback: "Welcome to Secure Messaging") }
       internal enum CheckMessages {
         internal enum Accessibility {
           /// Navigates you to the chat transcript.
@@ -611,8 +685,8 @@ internal enum Localization {
         }
       }
       internal enum MessageInput {
-        /// Enter your message
-        internal static var placeholder: String { Localization.tr("Localizable", "message_center.welcome.message_input.placeholder", fallback: "Enter your message") }
+        /// Enter message
+        internal static var placeholder: String { Localization.tr("Localizable", "message_center.welcome.message_input.placeholder", fallback: "Enter message") }
       }
       internal enum MessageLength {
         /// The message cannot exceed 10,000 characters.
@@ -644,6 +718,32 @@ internal enum Localization {
       }
     }
   }
+  internal enum SecureMessaging {
+    internal enum Chat {
+      internal enum Banner {
+        /// Secure messaging has an expected response time of 1 business day.
+        internal static var bottom: String { Localization.tr("Localizable", "secure_messaging.chat.banner.bottom", fallback: "Secure messaging has an expected response time of 1 business day.") }
+        /// Need live support?
+        internal static var top: String { Localization.tr("Localizable", "secure_messaging.chat.banner.top", fallback: "Need live support?") }
+      }
+      internal enum LeaveCurrentConversation {
+        /// You have an ongoing conversation. Starting a new conversation before ongoing ones are resolved may lead to our agents overlooking your current query.
+        internal static var message: String { Localization.tr("Localizable", "secure_messaging.chat.leave_current_conversation.message", fallback: "You have an ongoing conversation. Starting a new conversation before ongoing ones are resolved may lead to our agents overlooking your current query.") }
+        /// Leave Current Conversation?
+        internal static var title: String { Localization.tr("Localizable", "secure_messaging.chat.leave_current_conversation.title", fallback: "Leave Current Conversation?") }
+        internal enum Button {
+          /// Leave
+          internal static var negative: String { Localization.tr("Localizable", "secure_messaging.chat.leave_current_conversation.button.negative", fallback: "Leave") }
+          /// Stay
+          internal static var positive: String { Localization.tr("Localizable", "secure_messaging.chat.leave_current_conversation.button.positive", fallback: "Stay") }
+        }
+      }
+      internal enum Unavailable {
+        /// Sending messages is currently not available.
+        internal static var message: String { Localization.tr("Localizable", "secure_messaging.chat.unavailable.message", fallback: "Sending messages is currently not available.") }
+      }
+    }
+  }
   internal enum Survey {
     internal enum Action {
       /// Please provide an answer.

GliaWidgets/Public/Glia/Glia+EngagementLauncher.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+extension Glia {
+    /// Retrieves an instance of `EngagementLauncher`.
+    ///
+    /// - Parameters:
+    ///   - queueIds: A list of queue IDs to be used for the engagement launcher. When nil, the default queues will be used.
+    ///
+    /// - Returns:
+    ///   - `EngagementLauncher` instance.
+    public func getEngagementLauncher(queueIds: [String]) throws -> EngagementLauncher {
+        let parameters = try getEngagementParameters(in: queueIds)
+        return try EngagementLauncher { [weak self] engagementKind, sceneProvider in
+            try self?.resolveEngangementState(
+                engagementKind: engagementKind,
+                sceneProvider: sceneProvider,
+                configuration: parameters.configuration,
+                interactor: parameters.interactor,
+                features: parameters.features,
+                viewFactory: parameters.viewFactory,
+                ongoingEngagementMediaStreams: parameters.ongoingEngagementMediaStreams
+            )
+        }
+    }
+}

GliaWidgets/Public/Glia/Glia+EntryWidget.swift

@@ -0,0 +1,22 @@
+import Foundation
+
+extension Glia {
+    /// Retrieves an instance of `EntryWidget`.
+    ///
+    /// - Parameters:
+    ///   - queueIds: A list of queue IDs to be used for the engagement launcher. When nil, the default queues will be used.
+    ///
+    /// - Returns:
+    ///   - `EntryWidget` instance.
+    public func getEntryWidget(queueIds: [String]) throws -> EntryWidget {
+        EntryWidget(
+            queueIds: queueIds,
+            environment: .init(
+                queuesMonitor: environment.queuesMonitor,
+                engagementLauncher: try getEngagementLauncher(queueIds: queueIds),
+                theme: theme,
+                isAuthenticated: environment.isAuthenticated
+            )
+        )
+    }
+}

GliaWidgets/Public/Glia/Glia+StartEngagement.swift

@@ -24,40 +24,40 @@ extension Glia {
         in queueIds: [String] = [],
         sceneProvider: SceneProvider? = nil
     ) throws {
+        let parameters = try getEngagementParameters(in: queueIds)
+
+        try resolveEngangementState(
+            engagementKind: engagementKind,
+            sceneProvider: sceneProvider,
+            configuration: parameters.configuration,
+            interactor: parameters.interactor,
+            features: parameters.features,
+            viewFactory: parameters.viewFactory,
+            ongoingEngagementMediaStreams: parameters.ongoingEngagementMediaStreams
+        )
+    }
+
+    /// Set up and returns parameters needed to start or restore engagement
+    func getEngagementParameters(in queueIds: [String] = []) throws -> EngagementParameters {
         // In order to align behaviour between platforms,
         // `GliaError.engagementExists` is no longer thrown,
         // instead engagement is getting restored.
-        guard let configuration = self.configuration else { throw GliaError.sdkIsNotConfigured }
+        guard let configuration else {
+            throw GliaError.sdkIsNotConfigured
+        }
+
+        guard let interactor else {
+            loggerPhase.logger.prefixed(Self.self).warning("Interactor is missing")
+            throw GliaError.sdkIsNotConfigured
+        }
 
         // Interactor is initialized during configuration, which means that queueIds need
         // to be set in interactor when startEngagement is called.
-        self.interactor?.setQueuesIds(queueIds)
+        interactor.setQueuesIds(queueIds)
+
         // It is assumed that `features` to be provided from `configure` or via deprecated `startEngagement` method.
         let features = self.features ?? []
 
-        if let engagement = environment.coreSdk.getCurrentEngagement() {
-            if engagement.source == .callVisualizer {
-                throw GliaError.callVisualizerEngagementExists
-            } else {
-                guard let interactor else {
-                    loggerPhase.logger.prefixed(Self.self).warning("Interactor is missing")
-                    return
-                }
-                if let rootCoordinator {
-                    rootCoordinator.maximize()
-                } else {
-                    self.restoreOngoingEngagement(
-                        configuration: configuration,
-                        currentEngagement: engagement,
-                        interactor: interactor,
-                        features: features,
-                        maximize: true
-                    )
-                }
-                return
-            }
-        }
-
         // Apply company name to theme and get the modified theme
         let modifiedTheme = applyCompanyName(using: configuration, theme: theme)
 
@@ -78,10 +78,44 @@ extension Glia {
             ongoingEngagementMediaStreams = .init(audio: media.audio, video: nil)
         }
 
-        guard let interactor else {
-            loggerPhase.logger.prefixed(Self.self).warning("Interactor is missing")
-            return
+        return EngagementParameters(
+            viewFactory: viewFactory,
+            interactor: interactor,
+            ongoingEngagementMediaStreams: ongoingEngagementMediaStreams,
+            features: features,
+            configuration: configuration
+        )
+    }
+
+    func resolveEngangementState(
+        engagementKind: EngagementKind,
+        sceneProvider: SceneProvider?,
+        configuration: Configuration,
+        interactor: Interactor,
+        features: Features,
+        viewFactory: ViewFactory,
+        ongoingEngagementMediaStreams: Engagement.Media?
+    ) throws {
+        if let engagement = environment.coreSdk.getCurrentEngagement() {
+            if engagement.source == .callVisualizer {
+                throw GliaError.callVisualizerEngagementExists
+            } else {
+                if let rootCoordinator {
+                    rootCoordinator.maximize()
+                } else {
+                    self.restoreOngoingEngagement(
+                        configuration: configuration,
+                        currentEngagement: engagement,
+                        interactor: interactor,
+                        features: features,
+                        maximize: true
+                    )
+                }
+                loggerPhase.logger.prefixed(Self.self).info("Engagement was restored")
+                return
+            }
         }
+
         startRootCoordinator(
             with: interactor,
             viewFactory: viewFactory,
@@ -175,4 +209,13 @@ extension Glia {
             onEvent?(.maximized)
         }
     }
+
+    /// The `EngagementParameters` encapsulates all parameters required to initiate or restore the coordinator
+    struct EngagementParameters {
+        let viewFactory: ViewFactory
+        let interactor: Interactor
+        let ongoingEngagementMediaStreams: Engagement.Media?
+        let features: Features
+        let configuration: Configuration
+    }
 }

GliaWidgets/Resources/Assets.xcassets/Chat/send-message-unavailable-info.imageset/Contents.json

@@ -0,0 +1,16 @@
+{
+  "images" : [
+    {
+      "filename" : "send-message-unavailable-info.pdf",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "preserves-vector-representation" : true,
+    "template-rendering-intent" : "template"
+  }
+}