Make all helper functions publicly accessible & add documentation todo

TelemetryDeck · Dec 25, 2024 · c98fd6e · c98fd6e
1 parent b91f46b
commit c98fd6e
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/...ryDeck/PirateMetrics/SessionManager.swift → ...elemetryDeck/Helpers/SessionManager.swift b/...ryDeck/PirateMetrics/SessionManager.swift → ...elemetryDeck/Helpers/SessionManager.swift
diff --git a/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Acquisition.swift b/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Acquisition.swift
@@ -1,7 +1,8 @@
 import Foundation
 
-public extension TelemetryDeck {
-    static func acquiredUser(
+extension TelemetryDeck {
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func acquiredUser(
         channel: String,
         parameters: [String: String] = [:],
         customUserID: String? = nil
@@ -17,7 +18,8 @@ public extension TelemetryDeck {
         )
     }
 
-    static func leadStarted(
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func leadStarted(
         leadID: String,
         parameters: [String: String] = [:],
         customUserID: String? = nil
@@ -31,7 +33,8 @@ public extension TelemetryDeck {
         )
     }
 
-    static func leadConverted(
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func leadConverted(
         leadID: String,
         parameters: [String: String] = [:],
         customUserID: String? = nil

diff --git a/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Activation.swift b/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Activation.swift
@@ -1,7 +1,8 @@
 import Foundation
 
 extension TelemetryDeck {
-    static func onboardingCompleted(
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func onboardingCompleted(
         parameters: [String: String] = [:],
         customUserID: String? = nil
     ) {
@@ -14,7 +15,8 @@ extension TelemetryDeck {
         )
     }
 
-    static func coreFeatureUsed(
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func coreFeatureUsed(
         featureName: String,
         parameters: [String: String] = [:],
         customUserID: String? = nil

diff --git a/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Referral.swift b/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Referral.swift
@@ -1,7 +1,8 @@
 import Foundation
 
 extension TelemetryDeck {
-    static func referralSent(
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func referralSent(
         receiversCount: Int = 1,
         kind: String? = nil,
         parameters: [String: String] = [:],
@@ -21,8 +22,9 @@ extension TelemetryDeck {
         )
     }
 
+    // TODO: add documentation comment with common/recommended usage examples
     // TODO: explicitly mention how this can be used for NPS Score or for App Store like ratings
-    static func userRatingSubmitted(
+    public static func userRatingSubmitted(
         rating: Int,
         comment: String? = nil,
         parameters: [String: String] = [:],

diff --git a/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Revenue.swift b/Sources/TelemetryDeck/PirateMetrics/TelemetryDeck+Revenue.swift
@@ -1,7 +1,8 @@
 import Foundation
 
 extension TelemetryDeck {
-    static func paywallShown(
+    // TODO: add documentation comment with common/recommended usage examples
+    public static func paywallShown(
         reason: String,
         parameters: [String: String] = [:],
         customUserID: String? = nil