react-native-hubspot-wrapper 0.1.0

package/ios/HubspotMobileSDK/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Hubspot, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/ios/HubspotMobileSDK/PushNotificationChatData.swift

@@ -0,0 +1,63 @@
+// PushNotificationChatData.swift
+// Hubspot Mobile SDK
+//
+// Copyright © 2024 Hubspot, Inc.
+
+import Foundation
+import UserNotifications
+
+/// Holds all the data that is hubspot specific, extracted from a push notification collection. A convenient way to bundle all the known parameters together for passing along from notification delegate to the chat view
+///
+/// Push messages contain additional keys like so:
+///
+/// ```json
+/// "hsPortalId": "abc123",
+/// "hsChatflowId": "id",
+/// "hsThreadId": "threadId",
+/// "hsChatflowParam": "sales"
+/// ```
+/// These keys are also defined as constants here, ``chatflowKey`` , ``chatflowIdKey``, ``threadIdKey`` , ``portalIdKey``
+///
+/// The presence of any of these keys is use to indicate that the push message is for a hubspot chat. They are used by the helper method ``HubspotManager/isHubspotNotification(notification:)`` or ``HubspotManager/isHubspotNotification(notificationData:)``
+///
+public struct PushNotificationChatData: Sendable {
+
+    /// Push messages contain the portal id in the payload, with the key `hsPortalId`
+    public static let portalIdKey = "hsPortalId"
+
+    /// Push messages contain the chat flow id in the payload, with the key `hsChatflowId`
+    public static let chatflowIdKey = "hsChatflowId"
+
+    /// Push messages contain the thread id in the payload, with the key `hsThreadId'`
+    public static let threadIdKey = "hsThreadId"
+
+    /// Push messages contain the chat flow name in the payload, with the key `hsChatflowParam`
+    public static let chatflowKey = "hsChatflowParam"
+
+    /// The portal id, if present. Can be used for validation.
+    public let portalId: String?
+    /// The chatflow id , if present. unused currently.
+    public let chatflowId: String?
+    /// The thread id, if present - not currently used in the embedded chat.
+    public let threadId: String?
+    /// The chatflow to open when handling the notification
+    public let chatflow: String?
+
+    /// Create instance using the notification if any key is present, or returns nil when no keys are present
+    public init?(notification: UNNotification) {
+        self.init(notificationData: notification.request.content.userInfo)
+    }
+
+    /// Create instance using the user info dictionary if any key is present, or returns nil when no keys are present
+    public init?(notificationData: [AnyHashable: Any]) {
+        portalId = notificationData[Self.portalIdKey] as? String
+        chatflow = notificationData[Self.chatflowKey] as? String
+        chatflowId = notificationData[Self.chatflowIdKey] as? String
+        threadId = notificationData[Self.threadIdKey] as? String
+
+        // We want at least one key to be set, otherwise return nil
+        if portalId == nil, chatflow == nil, chatflowId == nil, threadId == nil {
+            return nil
+        }
+    }
+}

package/ios/HubspotMobileSDK/Resources/Images.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

package/ios/HubspotMobileSDK/Resources/Images.xcassets/GenericChatIcon.imageset/Contents.json

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

package/ios/HubspotMobileSDK/Resources/Images.xcassets/GenericChatIcon.imageset/chat-open-svg.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="32" height="30" viewBox="0 0 39 37" class="conversations-visitor-open-icon"><defs><path id="conversations-visitor-open-icon-path-1:r0:" d="M31.4824242 24.6256121L31.4824242 0.501369697 0.476266667 0.501369697 0.476266667 24.6256121z"></path></defs><g fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><g transform="translate(-1432 -977) translate(1415.723 959.455)"><g transform="translate(17 17)"><g transform="translate(6.333 .075)"><path fill="#ffffff" d="M30.594 4.773c-.314-1.943-1.486-3.113-3.374-3.38C27.174 1.382 22.576.5 15.36.5c-7.214 0-11.812.882-11.843.889-1.477.21-2.507.967-3.042 2.192a83.103 83.103 0 019.312-.503c6.994 0 11.647.804 12.33.93 3.079.462 5.22 2.598 5.738 5.728.224 1.02.932 4.606.932 8.887 0 2.292-.206 4.395-.428 6.002 1.22-.516 1.988-1.55 2.23-3.044.008-.037.893-3.814.893-8.415 0-4.6-.885-8.377-.89-8.394"></path></g><g fill="#ffffff" transform="translate(0 5.832)"><path d="M31.354 4.473c-.314-1.944-1.487-3.114-3.374-3.382-.046-.01-4.644-.89-11.859-.89-7.214 0-11.813.88-11.843.888-1.903.27-3.075 1.44-3.384 3.363C.884 4.489 0 8.266 0 12.867c0 4.6.884 8.377.889 8.393.314 1.944 1.486 3.114 3.374 3.382.037.007 3.02.578 7.933.801l2.928 5.072a1.151 1.151 0 001.994 0l2.929-5.071c4.913-.224 7.893-.794 7.918-.8 1.902-.27 3.075-1.44 3.384-3.363.01-.037.893-3.814.893-8.414 0-4.601-.884-8.378-.888-8.394"></path></g></g></g></g></svg>

package/ios/HubspotMobileSDK/Resources/Localizable.xcstrings

@@ -0,0 +1,28 @@
+{
+  "sourceLanguage" : "en",
+  "strings" : {
+    "%@" : {
+
+    },
+    "chat.label" : {
+      "localizations" : {
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Start Chat"
+          }
+        }
+      }
+    },
+    "Failed to load chat" : {
+
+    },
+    "Missing Chat Flow" : {
+
+    },
+    "Missing Configuration" : {
+
+    }
+  },
+  "version" : "1.0"
+}

package/ios/HubspotMobileSDK/Resources/PrivacyInfo.xcprivacy

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>NSPrivacyAccessedAPITypes</key>
+	<array/>
+	<key>NSPrivacyTracking</key>
+	<false/>
+	<key>NSPrivacyCollectedDataTypes</key>
+	<array>
+		<dict>
+			<key>NSPrivacyCollectedDataType</key>
+			<string>NSPrivacyCollectedDataTypeOtherDiagnosticData</string>
+			<key>NSPrivacyCollectedDataTypeLinked</key>
+			<true/>
+			<key>NSPrivacyCollectedDataTypeTracking</key>
+			<false/>
+			<key>NSPrivacyCollectedDataTypePurposes</key>
+			<array>
+				<string>NSPrivacyCollectedDataTypePurposeAnalytics</string>
+				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
+			</array>
+		</dict>
+		<dict>
+			<key>NSPrivacyCollectedDataType</key>
+			<string>NSPrivacyCollectedDataTypeUserID</string>
+			<key>NSPrivacyCollectedDataTypeLinked</key>
+			<true/>
+			<key>NSPrivacyCollectedDataTypeTracking</key>
+			<false/>
+			<key>NSPrivacyCollectedDataTypePurposes</key>
+			<array>
+				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
+			</array>
+		</dict>
+		<dict>
+			<key>NSPrivacyCollectedDataType</key>
+			<string>NSPrivacyCollectedDataTypeEmailAddress</string>
+			<key>NSPrivacyCollectedDataTypeLinked</key>
+			<true/>
+			<key>NSPrivacyCollectedDataTypeTracking</key>
+			<false/>
+			<key>NSPrivacyCollectedDataTypePurposes</key>
+			<array>
+				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
+			</array>
+		</dict>
+		<dict>
+			<key>NSPrivacyCollectedDataType</key>
+			<string>NSPrivacyCollectedDataTypeName</string>
+			<key>NSPrivacyCollectedDataTypeLinked</key>
+			<true/>
+			<key>NSPrivacyCollectedDataTypeTracking</key>
+			<false/>
+			<key>NSPrivacyCollectedDataTypePurposes</key>
+			<array>
+				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
+			</array>
+		</dict>
+	</array>
+</dict>
+</plist>

package/ios/HubspotMobileSDK/Views/Buttons/FloatingActionButton.swift

@@ -0,0 +1,126 @@
+// FloatingActionButton.swift
+// Hubspot Mobile SDK
+//
+// Copyright © 2024 Hubspot, Inc.
+
+import SwiftUI
+
+/// This is a pre-configured button for opening a chat session. The button manages its own state and presents a ``HubspotChatView`` as a sheet type modal.
+///
+/// It can be placed anywhere that suits your application, but its ideally intended to be floating in a corner over your main content. You can overlay it however you like, for example using a z-stack or an overlay modifier like so:
+/// ```swift
+/// content.overlay(alignment: .bottomTrailing, content: {
+///    FloatingActionButton()
+///     .padding()
+/// })
+/// ```
+///
+/// If you want to use a specific chat flow for this part of the application , for example a flow specific to an account section, or support section, you can provide a chat flow id for the button to open:
+///
+/// ```swift
+/// content.overlay(alignment: .bottomLeading) {
+///    FloatingActionButton(chatFlow: "marketing")
+///       .tint(.yellow)
+///       .padding()
+/// }
+/// ```
+///
+/// This will overlay the button like this:
+/// ![Demo screenshot](floating-button-example-a)
+///
+/// You can also add the button using the ``overlayHubspotFloatingActionButton(manager:chatFlow:)`` view modifier
+///
+/// The background color can be customed by setting the accent / tint colour on the view
+public struct FloatingActionButton: View {
+    private let manager: HubspotManager
+    private let chatFlow: String?
+
+    @State var showingChat: Bool = false
+
+    /// Create the button, optionally specifying the chatflow or manager to use.
+    /// - Parameters:
+    ///   - manager: The manager to use for getting a chat session. By defautl the shared manager is used.
+    ///   - chatFlow: The specific chat flow to open. Optional.
+    public init(
+        manager: HubspotManager? = nil,
+        chatFlow: String? = nil
+    ) {
+        self.manager = manager ?? HubspotManager.shared
+        self.chatFlow = chatFlow
+    }
+
+    public var body: some View {
+        Button(
+            action: showChat,
+            label: {
+                Image.hubspotChat
+                    .foregroundColor(.white)
+                    .padding()
+                    .background(
+                        Circle()
+                            .fill()
+                    )
+            }
+        )
+        .sheet(
+            isPresented: $showingChat,
+            content: {
+                HubspotChatView(manager: manager, chatFlow: chatFlow)
+            }
+        )
+        .onAppear {
+            manager.prepareForPotentialChat()
+        }
+    }
+
+    func showChat() {
+        withAnimation {
+            showingChat = true
+        }
+    }
+}
+
+/// Convenient helper for overlaying the action button in the bottom right of a view, with default padding. You can use this directly, but its intended instead to be used with ``overlayHubspotFloatingActionButton(manager:chatFlow:)``
+struct FloatingActionButtonOverlayModifier: ViewModifier {
+    let manager: HubspotManager
+    let chatFlow: String?
+
+    init(manager: HubspotManager? = nil, chatFlow: String? = nil) {
+        self.manager = manager ?? HubspotManager.shared
+        self.chatFlow = chatFlow
+    }
+
+    func body(content: Content) -> some View {
+        content.overlay(
+            alignment: .bottomTrailing,
+            content: {
+                FloatingActionButton(manager: manager, chatFlow: chatFlow)
+                    .padding()
+            }
+        )
+    }
+}
+
+extension View {
+    /// Convenience to overlay a floating action button - call on your main content view to overlay button at bottom trailing position with default padding. Set the `chatFlow` property to use a specific flow, otherwise the default flow from your configuration file will be used.
+    /// - Parameters:
+    ///     - manager: The hubspot manager to use
+    ///     - chatFlow: the chat flow targeting parameter to use
+    public func overlayHubspotFloatingActionButton(manager: HubspotManager? = nil, chatFlow: String? = nil) -> some View {
+        modifier(FloatingActionButtonOverlayModifier(manager: manager, chatFlow: chatFlow))
+    }
+}
+
+struct ButtonPreviewProvider: PreviewProvider {
+    static var previews: some View {
+        FloatingActionButton()
+
+        HStack {
+            FloatingActionButton()
+            FloatingActionButton()
+                .tint(.orange)
+        }
+        .previewLayout(.sizeThatFits)
+        .previewDisplayName("Colors")
+    }
+}

package/ios/HubspotMobileSDK/Views/Buttons/TextChatButtonChatButton.swift

@@ -0,0 +1,78 @@
+// TextChatButtonChatButton.swift
+// Hubspot Mobile SDK
+//
+// Copyright © 2024 Hubspot, Inc.
+
+import SwiftUI
+
+/// This is another button what displays an icon as well as text for starting a chat. Similar to ``FloatingActionButton`` , it can be placed anywhere in your UI that makes sense for you, and it will present the chat view modally with a `.sheet` modifier
+///
+///
+///
+/// Warning: This UI element was created for another proof of concept - it may or may not be included in the final release.
+///
+public struct TextChatButton: View {
+    private let customText: LocalizedStringKey?
+    private let manager: HubspotManager
+    private let chatFlow: String?
+
+    @State var showingChat: Bool = false
+
+    /// Create button, optionally specifying the manager to use
+    ///
+    /// - Parameters:
+    ///   - text: The text in the button - if nil, default text is used.
+    ///   - manager: The manager to use for getting a chat session. By defautl the shared manager is used.
+    ///   - chatFlow: The specific chat flow to open. Optional.
+    public init(text: LocalizedStringKey? = nil, manager: HubspotManager? = nil, chatFlow: String? = nil) {
+        customText = text
+        self.manager = manager ?? .shared
+        self.chatFlow = chatFlow
+    }
+
+    public var body: some View {
+        Button(
+            action: {
+                withAnimation {
+                    showingChat = true
+                }
+            },
+            label: {
+                HStack {
+                    Image.hubspotChat
+                    if let customText {
+                        Text(customText)
+                    } else {
+                        Text("chat.label", bundle: .hubspotResources)
+                    }
+                }
+
+            }
+        )
+        .labelStyle(.titleAndIcon)
+        .buttonStyle(TextChatButtonStyle())
+        .sheet(
+            isPresented: $showingChat,
+            content: {
+                HubspotChatView(manager: manager, chatFlow: chatFlow)
+            })
+    }
+}
+
+private struct TextChatButtonStyle: ButtonStyle {
+    func makeBody(configuration: Configuration) -> some View {
+        configuration.label
+            .padding(.horizontal)
+            .frame(minHeight: 44)
+            .frame(maxWidth: .infinity)
+            .foregroundColor(.white)
+            .background(
+                RoundedRectangle(cornerRadius: 8)
+                    .fill(.tint)
+            )
+    }
+}
+
+#Preview {
+    TextChatButton().fixedSize(horizontal: true, vertical: false)
+}