chore: add action to publish API doc (#7)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>

Author: zhu-xiaowei

.github/workflows/jzaay_doc_gen.yml

@@ -0,0 +1,22 @@
+name: Jazzy doc generate
+
+on:
+  push:
+    branches: [ "main" ]
+env:
+  GIT_USER_NAME: clickstream-android-dev+ghops
+  GIT_USER_EMAIL: no-reply@amazon.com
+jobs:
+  deploy:
+    runs-on: macos-12
+    steps:
+      - uses: actions/checkout@v3
+      - name: Generate docs
+        run: jazzy
+      - name: add images to docs
+        run: mkdir -p docs/images | cp -R images/. docs/images/
+      - name: commit code
+        run: |
+          git add docs
+          git commit -m "chore: update API docs"
+          git push origin HEAD:gh-pages -f

.jazzy.yaml

@@ -0,0 +1,15 @@
+module: Clickstream
+author: Amazon Web Services
+github_url: https://github.com/awslabs/clickstream-swift
+
+swift-build-tool: spm
+clean: true
+skip_undocumented: false
+undocumented_text: ""
+hide_documentation_coverage: true
+sdk: iphone
+theme: apple
+build_tool_arguments:
+  - -Xswiftc
+  - -swift-version
+  - "5"

README.md

@@ -10,6 +10,8 @@ The SDK relies on the Amplify for Swift Core Library and is developed according
 
 The Clickstream SDK supports iOS 13+.
 
+[**API Documentation**](https://awslabs.github.io/clickstream-swift/)
+
 ## Integrate SDK
 
 Clickstream requires Xcode 13.4 or higher to build.

Sources/Clickstream/ClickstreamAttribute.swift

@@ -11,6 +11,7 @@ import Amplify
 public typealias ClickstreamAttribute = AnalyticsProperties
 
 typealias AttributeValue = AnalyticsPropertyValue
+/// for support Int64 attribute value
 extension Int64: AnalyticsPropertyValue {}
 
 struct BaseClickstreamEvent: AnalyticsEvent {

Sources/Clickstream/Dependency/Clickstream/ActivityTracking/UIViewController+Swizzle.swift

@@ -6,8 +6,7 @@
 //
 
 #if canImport(UIKit)
-    import UIKit
-#endif
+import UIKit
 
 private var hasSwizzled = false
 private var viewDidAppearFunc: ((String, String) -> Void)?
@@ -47,3 +46,4 @@ extension UIViewController {
         hasSwizzled = true
     }
 }
+#endif

Sources/Clickstream/Dependency/Clickstream/AutoRecord/AutoRecordEventClient.swift

@@ -8,6 +8,7 @@
 #if canImport(UIKit)
     import UIKit
 #endif
+import Foundation
 
 class AutoRecordEventClient {
     private let clickstream: ClickstreamContext
@@ -21,7 +22,9 @@ class AutoRecordEventClient {
         self.clickstream = clickstream
         self.isFirstOpen = UserDefaultsUtil.getIsFirstOpen(storage: clickstream.storage)
         if clickstream.configuration.isTrackScreenViewEvents {
-            UIViewController.swizzle(viewDidAppear: onViewDidAppear)
+            #if canImport(UIKit)
+                UIViewController.swizzle(viewDidAppear: onViewDidAppear)
+            #endif
         }
     }
 

Sources/Clickstream/Support/Utils/UserDefaultsUtil.swift

@@ -16,7 +16,10 @@ enum UserDefaultsUtil {
             return deviceId
         }
         var newDeviceId = ""
-        let idfv = UIDevice.current.identifierForVendor?.uuidString ?? ""
+        var idfv = ""
+        #if canImport(UIKit)
+            idfv = UIDevice.current.identifierForVendor?.uuidString ?? ""
+        #endif
         if idfv != "" {
             newDeviceId = idfv
         } else {