react-native-clarity 4.0.3 → 4.0.4

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 (10) hide show
  1. package/android/build.gradle +1 -1
  2. package/lib/commonjs/index.js +9 -8
  3. package/lib/commonjs/index.js.map +1 -1
  4. package/lib/module/index.js +9 -8
  5. package/lib/module/index.js.map +1 -1
  6. package/lib/typescript/index.d.ts +9 -8
  7. package/lib/typescript/index.d.ts.map +1 -1
  8. package/package.json +1 -1
  9. package/react-native-clarity.podspec +1 -1
  10. package/src/index.tsx +9 -8
package/android/build.gradle CHANGED
@@ -69,7 +69,7 @@ def kotlin_version = getExtOrDefault("kotlinVersion")
69
69
  dependencies {
70
70
  implementation "com.facebook.react:react-native:+"
71
71
  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
72
- implementation "com.microsoft.clarity:clarity:3.0.0"
72
+ implementation "com.microsoft.clarity:clarity:3.0.1"
73
73
  }
74
74
 
75
75
  if (isNewArchitectureEnabled()) {
package/lib/commonjs/index.js CHANGED
@@ -278,19 +278,20 @@ function setOnSessionStartedCallback(callback) {
278
278
  }
279
279
 
280
280
  /**
281
- * This function allows you to provide a custom screen name tag that's added as a suffix to the base screen name. The base name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
281
+ * This function allows you to provide a custom screen name that replaces the default screen name. The default name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
282
282
  *
283
- * @param screenName - The desired screen name tag. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace nor contain `/` character. Set to `null` to reset.
284
- * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name tag was set successfully; otherwise `false`.
283
+ * @param screenName - The desired screen name. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace. Set to `null` to reset.
284
+ *
285
+ * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name was set successfully; otherwise `false`.
285
286
  *
286
287
  * **Example:**
287
- * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "UIViewController/Settings".
288
- * - If `setCurrentScreenName(nil)` is called on the same view controller, the screen name is tracked as "UIViewController".
288
+ * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "Settings".
289
+ * - If `setCurrentScreenName(null)` is called on the same view controller, the screen name is tracked as "UIViewController".
289
290
  *
290
291
  * **Notes:**
291
- * - Clarity starts a new page whenever either the base screen name (generated from the Android activity or iOS view controller) or the custom name tag changes.
292
- * - To mask or disallow a screen, specify the base screen name without the custom tag suffix. For example, to mask the iOS view controller in the previous example, mask the "UIViewController" screen instead of "UIViewController/Settings".
293
- * - The screen name tag is set globally and persists across all subsequent Android activities or iOS view controllers until explicitly reset.
292
+ * - Clarity starts a new page whenever the screen name changes.
293
+ * - To mask or disallow a screen, specify the view controller's type that is displayed as "ViewController" custom tag of the page visit on the Clarity dashboard's recordings. For example, to mask the iOS view controller in the previous example, mask the "&TabBarController" screen instead of "&Settings".
294
+ * - The custom screen name is set globally and persists across all subsequent view controllers until explicitly reset.
294
295
  */
295
296
  function setCurrentScreenName(screenName) {
296
297
  if (isClarityUnavailable()) {
package/lib/commonjs/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"names":["_reactNative","require","LINKING_ERROR","Platform","select","ios","default","ReferToDocs","Clarity","NativeModules","ClarityEmitter","NativeEventEmitter","SupportedPlatforms","SupportWarningWasShown","ValidConfigKeys","Set","Object","keys","userId","undefined","logLevel","RemovedDynamicConfigKeys","LogLevel","exports","ClarityError","Error","constructor","message","name","isClarityUnavailable","includes","OS","console","warn","join","error","validateClarityConfig","config","values","key","has","errorMessage","enableIOS_experimental","initialize","projectId","None","pause","Promise","resolve","resume","isPaused","startNewSession","callback","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","value","sendCustomEvent","onSessionStartedSubscription","onSessionStartedCallback","setOnSessionStartedCallback","addListener","sessionId","setCurrentScreenName","screenName","getCurrentSessionId","getCurrentSessionUrl"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAOA,MAAMC,aAAa,GACjB,+EAA+E,GAC/EC,qBAAQ,CAACC,MAAM,CAAC;EACdC,GAAG,EAAE,8CAA8C;EACnDC,OAAO,EAAE;AACX,CAAC,CAAC,GACF,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,WAAW,GACf,6FAA6F;AAE/F,MAAMC,OAAO,GAAGC,0BAAa,CAACD,OAAO;AACrC,MAAME,cAAc,GAAG,IAAIC,+BAAkB,CAACF,0BAAa,CAACC,cAAc,CAAC;AAE3E,MAAME,kBAAkB,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC;AAE7C,IAAIC,sBAAsB,GAAG,KAAK;;AAElC;AACA;AACA;;AAuBA,MAAMC,eAAe,GAAG,IAAIC,GAAG,CAC7BC,MAAM,CAACC,IAAI,CAAC;EACVC,MAAM,EAAEC,SAAS;EAAE;EACnBC,QAAQ,EAAED;AACZ,CAAkB,CACpB,CAAC;AAED,MAAME,wBAAwB,GAAG,IAAIN,GAAG,CAAC,CACvC,0BAA0B,EAC1B,sBAAsB,EACtB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,CAC/B,CAAC;;AAEF;AACA;AACA;AAFA,IAGYO,QAAQ,GAAAC,OAAA,CAAAD,QAAA,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AASpB,MAAME,YAAY,SAASC,KAAK,CAAC;EAC/BC,WAAWA,CAACC,OAAe,EAAE;IAC3B,KAAK,CAACA,OAAO,CAAC;IACd,IAAI,CAACC,IAAI,GAAG,cAAc;EAC5B;AACF;AAEA,SAASC,oBAAoBA,CAAA,EAAY;EACvC,IAAI,CAACjB,kBAAkB,CAACkB,QAAQ,CAAC3B,qBAAQ,CAAC4B,EAAE,CAAC,EAAE;IAC7C,IAAI,CAAClB,sBAAsB,EAAE;MAC3BmB,OAAO,CAACC,IAAI,CACV,mBAAmB,GAAGrB,kBAAkB,CAACsB,IAAI,CAAC,IAAI,CAAC,GAAG,gBACxD,CAAC;MACDrB,sBAAsB,GAAG,IAAI;IAC/B;IAEA,OAAO,IAAI;EACb;EAEA,IAAIL,OAAO,KAAK,IAAI,EAAE;IACpBwB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEjC,aAAa,CAAC;IACpE,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd;AAEA,SAASkC,qBAAqBA,CAACC,MAAsB,EAAE;EACrD,IAAI,OAAOA,MAAM,KAAK,WAAW,EAAE;IACjC;IACA;EACF;EAEA,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;IAC9B,MAAM,IAAIb,YAAY,CACpB,wFAAwF,OAAOa,MAAM,KAAK9B,WAAW,EACvH,CAAC;EACH;EAEA,IAAI8B,MAAM,aAANA,MAAM,eAANA,MAAM,CAAEjB,QAAQ,IAAI,CAACJ,MAAM,CAACsB,MAAM,CAAChB,QAAQ,CAAC,CAACQ,QAAQ,CAACO,MAAM,CAACjB,QAAQ,CAAC,EAAE;IAC1EY,OAAO,CAACG,KAAK,CACX,sDACEE,MAAM,CAACjB,QAAQ,uBACMJ,MAAM,CAACsB,MAAM,CAAChB,QAAQ,CAAC,CAACY,IAAI,CACjD,IACF,CAAC,KAAK3B,WAAW,EACnB,CAAC;EACH;EAEA,KAAK,MAAMgC,GAAG,IAAIF,MAAM,EAAE;IACxB,IAAIhB,wBAAwB,CAACmB,GAAG,CAACD,GAAG,CAAC,EAAE;MACrC,MAAM,IAAIf,YAAY,CACpB,uBAAuBe,GAAG,sEAC5B,CAAC;IACH,CAAC,MAAM,IAAIA,GAAG,KAAK,wBAAwB,EAAE;MAC3C,MAAME,YAAY,GAChB,iGAAiG;MACnG,IAAKJ,MAAM,CAASK,sBAAsB,EAAE;QAC1C;QACAV,OAAO,CAACG,KAAK,CAACM,YAAY,CAAC;MAC7B,CAAC,MAAM;QACL,MAAM,IAAIjB,YAAY,CAACiB,YAAY,CAAC;MACtC;IACF,CAAC,MAAM,IAAIF,GAAG,KAAK,QAAQ,EAAE;MAC3BP,OAAO,CAACC,IAAI,CACV,oIACF,CAAC;IACH,CAAC,MAAM,IAAI,CAACnB,eAAe,CAAC0B,GAAG,CAACD,GAAG,CAAC,EAAE;MACpCP,OAAO,CAACC,IAAI,CAAC,qCAAqCM,GAAG,KAAK,CAAC;IAC7D;EACF;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASI,UAAUA,CAACC,SAAiB,EAAEP,MAAsB,EAAE;EACpE,IAAI,OAAOO,SAAS,KAAK,QAAQ,EAAE;IACjC,MAAM,IAAIpB,YAAY,CACpB,0FAA0F,OAAOoB,SAAS,KAAKrC,WAAW,EAC5H,CAAC;EACH;EAEA6B,qBAAqB,CAACC,MAAM,CAAC;;EAE7B;EACA,IAAI;IAAEnB,MAAM,GAAG,IAAI;IAAEE,QAAQ,GAAGE,QAAQ,CAACuB;EAAK,CAAC,GAAGR,MAAM,IAAI,CAAC,CAAC;EAE9D,IAAIR,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEArB,OAAO,CAACmC,UAAU,CAACC,SAAS,EAAE1B,MAAM,EAAEE,QAAQ,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACO,SAAS0B,KAAKA,CAAA,EAAqB;EACxC,IAAIjB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACsC,KAAK,CAAC,CAAC;AACxB;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASG,MAAMA,CAAA,EAAqB;EACzC,IAAIpB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACyC,MAAM,CAAC,CAAC;AACzB;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,QAAQA,CAAA,EAAqB;EAC3C,IAAIrB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAAC0C,QAAQ,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAACC,QAAqC,EAAQ;EAC3E,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEArB,OAAO,CAAC2C,eAAe,CAACC,QAAQ,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAACC,YAAoB,EAAoB;EACtE,IAAIzB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAAC6C,eAAe,CAACC,YAAY,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,kBAAkBA,CAACC,eAAuB,EAAoB;EAC5E,IAAI3B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAAC+C,kBAAkB,CAACC,eAAe,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAAClB,GAAW,EAAEmB,KAAa,EAAoB;EACzE,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACiD,YAAY,CAAClB,GAAG,EAAEmB,KAAK,CAAC;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAACD,KAAa,EAAoB;EAC/D,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACmD,eAAe,CAACD,KAAK,CAAC;AACvC;AAEA,IAAIE,4BAAwD,GAAG,IAAI;AACnE,IAAIC,wBAA8D,GAAG,IAAI;;AAEzE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,2BAA2BA,CACzCV,QAAqC,EAC5B;EACT,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAO,KAAK;EACd;EAEAgC,wBAAwB,GAAGT,QAAQ;EAEnC,IAAIQ,4BAA4B,KAAK,IAAI,EAAE;IACzCA,4BAA4B,GAAGlD,cAAc,CAACqD,WAAW,CACvD,gBAAgB,EAChB,CAAC;MAAEC;IAAU,CAAC,KAAK;MACjB,IAAIH,wBAAwB,KAAK,IAAI,EAAE;QACrCA,wBAAwB,CAACG,SAAS,CAAC;MACrC;IACF,CACF,CAAC;EACH;EAEA,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,oBAAoBA,CAClCC,UAAyB,EACP;EAClB,IAAIrC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACyD,oBAAoB,CAACC,UAAU,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,mBAAmBA,CAAA,EAAgC;EACjE,IAAItC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC7B,SAAS,CAAC;EACnC;EAEA,OAAOX,OAAO,CAAC2D,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,oBAAoBA,CAAA,EAAgC;EAClE,IAAIvC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC7B,SAAS,CAAC;EACnC;EAEA,OAAOX,OAAO,CAAC4D,oBAAoB,CAAC,CAAC;AACvC","ignoreList":[]}
1
+ {"version":3,"names":["_reactNative","require","LINKING_ERROR","Platform","select","ios","default","ReferToDocs","Clarity","NativeModules","ClarityEmitter","NativeEventEmitter","SupportedPlatforms","SupportWarningWasShown","ValidConfigKeys","Set","Object","keys","userId","undefined","logLevel","RemovedDynamicConfigKeys","LogLevel","exports","ClarityError","Error","constructor","message","name","isClarityUnavailable","includes","OS","console","warn","join","error","validateClarityConfig","config","values","key","has","errorMessage","enableIOS_experimental","initialize","projectId","None","pause","Promise","resolve","resume","isPaused","startNewSession","callback","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","value","sendCustomEvent","onSessionStartedSubscription","onSessionStartedCallback","setOnSessionStartedCallback","addListener","sessionId","setCurrentScreenName","screenName","getCurrentSessionId","getCurrentSessionUrl"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAOA,MAAMC,aAAa,GACjB,+EAA+E,GAC/EC,qBAAQ,CAACC,MAAM,CAAC;EACdC,GAAG,EAAE,8CAA8C;EACnDC,OAAO,EAAE;AACX,CAAC,CAAC,GACF,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,WAAW,GACf,6FAA6F;AAE/F,MAAMC,OAAO,GAAGC,0BAAa,CAACD,OAAO;AACrC,MAAME,cAAc,GAAG,IAAIC,+BAAkB,CAACF,0BAAa,CAACC,cAAc,CAAC;AAE3E,MAAME,kBAAkB,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC;AAE7C,IAAIC,sBAAsB,GAAG,KAAK;;AAElC;AACA;AACA;;AAuBA,MAAMC,eAAe,GAAG,IAAIC,GAAG,CAC7BC,MAAM,CAACC,IAAI,CAAC;EACVC,MAAM,EAAEC,SAAS;EAAE;EACnBC,QAAQ,EAAED;AACZ,CAAkB,CACpB,CAAC;AAED,MAAME,wBAAwB,GAAG,IAAIN,GAAG,CAAC,CACvC,0BAA0B,EAC1B,sBAAsB,EACtB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,CAC/B,CAAC;;AAEF;AACA;AACA;AAFA,IAGYO,QAAQ,GAAAC,OAAA,CAAAD,QAAA,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AASpB,MAAME,YAAY,SAASC,KAAK,CAAC;EAC/BC,WAAWA,CAACC,OAAe,EAAE;IAC3B,KAAK,CAACA,OAAO,CAAC;IACd,IAAI,CAACC,IAAI,GAAG,cAAc;EAC5B;AACF;AAEA,SAASC,oBAAoBA,CAAA,EAAY;EACvC,IAAI,CAACjB,kBAAkB,CAACkB,QAAQ,CAAC3B,qBAAQ,CAAC4B,EAAE,CAAC,EAAE;IAC7C,IAAI,CAAClB,sBAAsB,EAAE;MAC3BmB,OAAO,CAACC,IAAI,CACV,mBAAmB,GAAGrB,kBAAkB,CAACsB,IAAI,CAAC,IAAI,CAAC,GAAG,gBACxD,CAAC;MACDrB,sBAAsB,GAAG,IAAI;IAC/B;IAEA,OAAO,IAAI;EACb;EAEA,IAAIL,OAAO,KAAK,IAAI,EAAE;IACpBwB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAEjC,aAAa,CAAC;IACpE,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd;AAEA,SAASkC,qBAAqBA,CAACC,MAAsB,EAAE;EACrD,IAAI,OAAOA,MAAM,KAAK,WAAW,EAAE;IACjC;IACA;EACF;EAEA,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;IAC9B,MAAM,IAAIb,YAAY,CACpB,wFAAwF,OAAOa,MAAM,KAAK9B,WAAW,EACvH,CAAC;EACH;EAEA,IAAI8B,MAAM,aAANA,MAAM,eAANA,MAAM,CAAEjB,QAAQ,IAAI,CAACJ,MAAM,CAACsB,MAAM,CAAChB,QAAQ,CAAC,CAACQ,QAAQ,CAACO,MAAM,CAACjB,QAAQ,CAAC,EAAE;IAC1EY,OAAO,CAACG,KAAK,CACX,sDACEE,MAAM,CAACjB,QAAQ,uBACMJ,MAAM,CAACsB,MAAM,CAAChB,QAAQ,CAAC,CAACY,IAAI,CACjD,IACF,CAAC,KAAK3B,WAAW,EACnB,CAAC;EACH;EAEA,KAAK,MAAMgC,GAAG,IAAIF,MAAM,EAAE;IACxB,IAAIhB,wBAAwB,CAACmB,GAAG,CAACD,GAAG,CAAC,EAAE;MACrC,MAAM,IAAIf,YAAY,CACpB,uBAAuBe,GAAG,sEAC5B,CAAC;IACH,CAAC,MAAM,IAAIA,GAAG,KAAK,wBAAwB,EAAE;MAC3C,MAAME,YAAY,GAChB,iGAAiG;MACnG,IAAKJ,MAAM,CAASK,sBAAsB,EAAE;QAC1C;QACAV,OAAO,CAACG,KAAK,CAACM,YAAY,CAAC;MAC7B,CAAC,MAAM;QACL,MAAM,IAAIjB,YAAY,CAACiB,YAAY,CAAC;MACtC;IACF,CAAC,MAAM,IAAIF,GAAG,KAAK,QAAQ,EAAE;MAC3BP,OAAO,CAACC,IAAI,CACV,oIACF,CAAC;IACH,CAAC,MAAM,IAAI,CAACnB,eAAe,CAAC0B,GAAG,CAACD,GAAG,CAAC,EAAE;MACpCP,OAAO,CAACC,IAAI,CAAC,qCAAqCM,GAAG,KAAK,CAAC;IAC7D;EACF;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASI,UAAUA,CAACC,SAAiB,EAAEP,MAAsB,EAAE;EACpE,IAAI,OAAOO,SAAS,KAAK,QAAQ,EAAE;IACjC,MAAM,IAAIpB,YAAY,CACpB,0FAA0F,OAAOoB,SAAS,KAAKrC,WAAW,EAC5H,CAAC;EACH;EAEA6B,qBAAqB,CAACC,MAAM,CAAC;;EAE7B;EACA,IAAI;IAAEnB,MAAM,GAAG,IAAI;IAAEE,QAAQ,GAAGE,QAAQ,CAACuB;EAAK,CAAC,GAAGR,MAAM,IAAI,CAAC,CAAC;EAE9D,IAAIR,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEArB,OAAO,CAACmC,UAAU,CAACC,SAAS,EAAE1B,MAAM,EAAEE,QAAQ,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACO,SAAS0B,KAAKA,CAAA,EAAqB;EACxC,IAAIjB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACsC,KAAK,CAAC,CAAC;AACxB;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASG,MAAMA,CAAA,EAAqB;EACzC,IAAIpB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACyC,MAAM,CAAC,CAAC;AACzB;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASC,QAAQA,CAAA,EAAqB;EAC3C,IAAIrB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAAC0C,QAAQ,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAACC,QAAqC,EAAQ;EAC3E,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEArB,OAAO,CAAC2C,eAAe,CAACC,QAAQ,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAACC,YAAoB,EAAoB;EACtE,IAAIzB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAAC6C,eAAe,CAACC,YAAY,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,kBAAkBA,CAACC,eAAuB,EAAoB;EAC5E,IAAI3B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAAC+C,kBAAkB,CAACC,eAAe,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAAClB,GAAW,EAAEmB,KAAa,EAAoB;EACzE,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACiD,YAAY,CAAClB,GAAG,EAAEmB,KAAK,CAAC;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,eAAeA,CAACD,KAAa,EAAoB;EAC/D,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACmD,eAAe,CAACD,KAAK,CAAC;AACvC;AAEA,IAAIE,4BAAwD,GAAG,IAAI;AACnE,IAAIC,wBAA8D,GAAG,IAAI;;AAEzE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,2BAA2BA,CACzCV,QAAqC,EAC5B;EACT,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAO,KAAK;EACd;EAEAgC,wBAAwB,GAAGT,QAAQ;EAEnC,IAAIQ,4BAA4B,KAAK,IAAI,EAAE;IACzCA,4BAA4B,GAAGlD,cAAc,CAACqD,WAAW,CACvD,gBAAgB,EAChB,CAAC;MAAEC;IAAU,CAAC,KAAK;MACjB,IAAIH,wBAAwB,KAAK,IAAI,EAAE;QACrCA,wBAAwB,CAACG,SAAS,CAAC;MACrC;IACF,CACF,CAAC;EACH;EAEA,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,oBAAoBA,CAClCC,UAAyB,EACP;EAClB,IAAIrC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOxC,OAAO,CAACyD,oBAAoB,CAACC,UAAU,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,mBAAmBA,CAAA,EAAgC;EACjE,IAAItC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC7B,SAAS,CAAC;EACnC;EAEA,OAAOX,OAAO,CAAC2D,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,oBAAoBA,CAAA,EAAgC;EAClE,IAAIvC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC7B,SAAS,CAAC;EACnC;EAEA,OAAOX,OAAO,CAAC4D,oBAAoB,CAAC,CAAC;AACvC","ignoreList":[]}
package/lib/module/index.js CHANGED
@@ -259,19 +259,20 @@ export function setOnSessionStartedCallback(callback) {
259
259
  }
260
260
 
261
261
  /**
262
- * This function allows you to provide a custom screen name tag that's added as a suffix to the base screen name. The base name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
262
+ * This function allows you to provide a custom screen name that replaces the default screen name. The default name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
263
263
  *
264
- * @param screenName - The desired screen name tag. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace nor contain `/` character. Set to `null` to reset.
265
- * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name tag was set successfully; otherwise `false`.
264
+ * @param screenName - The desired screen name. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace. Set to `null` to reset.
265
+ *
266
+ * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name was set successfully; otherwise `false`.
266
267
  *
267
268
  * **Example:**
268
- * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "UIViewController/Settings".
269
- * - If `setCurrentScreenName(nil)` is called on the same view controller, the screen name is tracked as "UIViewController".
269
+ * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "Settings".
270
+ * - If `setCurrentScreenName(null)` is called on the same view controller, the screen name is tracked as "UIViewController".
270
271
  *
271
272
  * **Notes:**
272
- * - Clarity starts a new page whenever either the base screen name (generated from the Android activity or iOS view controller) or the custom name tag changes.
273
- * - To mask or disallow a screen, specify the base screen name without the custom tag suffix. For example, to mask the iOS view controller in the previous example, mask the "UIViewController" screen instead of "UIViewController/Settings".
274
- * - The screen name tag is set globally and persists across all subsequent Android activities or iOS view controllers until explicitly reset.
273
+ * - Clarity starts a new page whenever the screen name changes.
274
+ * - To mask or disallow a screen, specify the view controller's type that is displayed as "ViewController" custom tag of the page visit on the Clarity dashboard's recordings. For example, to mask the iOS view controller in the previous example, mask the "&TabBarController" screen instead of "&Settings".
275
+ * - The custom screen name is set globally and persists across all subsequent view controllers until explicitly reset.
275
276
  */
276
277
  export function setCurrentScreenName(screenName) {
277
278
  if (isClarityUnavailable()) {
package/lib/module/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"names":["NativeModules","NativeEventEmitter","Platform","LINKING_ERROR","select","ios","default","ReferToDocs","Clarity","ClarityEmitter","SupportedPlatforms","SupportWarningWasShown","ValidConfigKeys","Set","Object","keys","userId","undefined","logLevel","RemovedDynamicConfigKeys","LogLevel","ClarityError","Error","constructor","message","name","isClarityUnavailable","includes","OS","console","warn","join","error","validateClarityConfig","config","values","key","has","errorMessage","enableIOS_experimental","initialize","projectId","None","pause","Promise","resolve","resume","isPaused","startNewSession","callback","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","value","sendCustomEvent","onSessionStartedSubscription","onSessionStartedCallback","setOnSessionStartedCallback","addListener","sessionId","setCurrentScreenName","screenName","getCurrentSessionId","getCurrentSessionUrl"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":"AAAA,SACEA,aAAa,EACbC,kBAAkB,EAClBC,QAAQ,QAEH,cAAc;AAErB,MAAMC,aAAa,GACjB,+EAA+E,GAC/ED,QAAQ,CAACE,MAAM,CAAC;EACdC,GAAG,EAAE,8CAA8C;EACnDC,OAAO,EAAE;AACX,CAAC,CAAC,GACF,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,WAAW,GACf,6FAA6F;AAE/F,MAAMC,OAAO,GAAGR,aAAa,CAACQ,OAAO;AACrC,MAAMC,cAAc,GAAG,IAAIR,kBAAkB,CAACD,aAAa,CAACS,cAAc,CAAC;AAE3E,MAAMC,kBAAkB,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC;AAE7C,IAAIC,sBAAsB,GAAG,KAAK;;AAElC;AACA;AACA;;AAuBA,MAAMC,eAAe,GAAG,IAAIC,GAAG,CAC7BC,MAAM,CAACC,IAAI,CAAC;EACVC,MAAM,EAAEC,SAAS;EAAE;EACnBC,QAAQ,EAAED;AACZ,CAAkB,CACpB,CAAC;AAED,MAAME,wBAAwB,GAAG,IAAIN,GAAG,CAAC,CACvC,0BAA0B,EAC1B,sBAAsB,EACtB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,CAC/B,CAAC;;AAEF;AACA;AACA;AACA,WAAYO,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AASpB,MAAMC,YAAY,SAASC,KAAK,CAAC;EAC/BC,WAAWA,CAACC,OAAe,EAAE;IAC3B,KAAK,CAACA,OAAO,CAAC;IACd,IAAI,CAACC,IAAI,GAAG,cAAc;EAC5B;AACF;AAEA,SAASC,oBAAoBA,CAAA,EAAY;EACvC,IAAI,CAAChB,kBAAkB,CAACiB,QAAQ,CAACzB,QAAQ,CAAC0B,EAAE,CAAC,EAAE;IAC7C,IAAI,CAACjB,sBAAsB,EAAE;MAC3BkB,OAAO,CAACC,IAAI,CACV,mBAAmB,GAAGpB,kBAAkB,CAACqB,IAAI,CAAC,IAAI,CAAC,GAAG,gBACxD,CAAC;MACDpB,sBAAsB,GAAG,IAAI;IAC/B;IAEA,OAAO,IAAI;EACb;EAEA,IAAIH,OAAO,KAAK,IAAI,EAAE;IACpBqB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAE7B,aAAa,CAAC;IACpE,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd;AAEA,SAAS8B,qBAAqBA,CAACC,MAAsB,EAAE;EACrD,IAAI,OAAOA,MAAM,KAAK,WAAW,EAAE;IACjC;IACA;EACF;EAEA,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;IAC9B,MAAM,IAAIb,YAAY,CACpB,wFAAwF,OAAOa,MAAM,KAAK3B,WAAW,EACvH,CAAC;EACH;EAEA,IAAI2B,MAAM,aAANA,MAAM,eAANA,MAAM,CAAEhB,QAAQ,IAAI,CAACJ,MAAM,CAACqB,MAAM,CAACf,QAAQ,CAAC,CAACO,QAAQ,CAACO,MAAM,CAAChB,QAAQ,CAAC,EAAE;IAC1EW,OAAO,CAACG,KAAK,CACX,sDACEE,MAAM,CAAChB,QAAQ,uBACMJ,MAAM,CAACqB,MAAM,CAACf,QAAQ,CAAC,CAACW,IAAI,CACjD,IACF,CAAC,KAAKxB,WAAW,EACnB,CAAC;EACH;EAEA,KAAK,MAAM6B,GAAG,IAAIF,MAAM,EAAE;IACxB,IAAIf,wBAAwB,CAACkB,GAAG,CAACD,GAAG,CAAC,EAAE;MACrC,MAAM,IAAIf,YAAY,CACpB,uBAAuBe,GAAG,sEAC5B,CAAC;IACH,CAAC,MAAM,IAAIA,GAAG,KAAK,wBAAwB,EAAE;MAC3C,MAAME,YAAY,GAChB,iGAAiG;MACnG,IAAKJ,MAAM,CAASK,sBAAsB,EAAE;QAC1C;QACAV,OAAO,CAACG,KAAK,CAACM,YAAY,CAAC;MAC7B,CAAC,MAAM;QACL,MAAM,IAAIjB,YAAY,CAACiB,YAAY,CAAC;MACtC;IACF,CAAC,MAAM,IAAIF,GAAG,KAAK,QAAQ,EAAE;MAC3BP,OAAO,CAACC,IAAI,CACV,oIACF,CAAC;IACH,CAAC,MAAM,IAAI,CAAClB,eAAe,CAACyB,GAAG,CAACD,GAAG,CAAC,EAAE;MACpCP,OAAO,CAACC,IAAI,CAAC,qCAAqCM,GAAG,KAAK,CAAC;IAC7D;EACF;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,UAAUA,CAACC,SAAiB,EAAEP,MAAsB,EAAE;EACpE,IAAI,OAAOO,SAAS,KAAK,QAAQ,EAAE;IACjC,MAAM,IAAIpB,YAAY,CACpB,0FAA0F,OAAOoB,SAAS,KAAKlC,WAAW,EAC5H,CAAC;EACH;EAEA0B,qBAAqB,CAACC,MAAM,CAAC;;EAE7B;EACA,IAAI;IAAElB,MAAM,GAAG,IAAI;IAAEE,QAAQ,GAAGE,QAAQ,CAACsB;EAAK,CAAC,GAAGR,MAAM,IAAI,CAAC,CAAC;EAE9D,IAAIR,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEAlB,OAAO,CAACgC,UAAU,CAACC,SAAS,EAAEzB,MAAM,EAAEE,QAAQ,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASyB,KAAKA,CAAA,EAAqB;EACxC,IAAIjB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACmC,KAAK,CAAC,CAAC;AACxB;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,MAAMA,CAAA,EAAqB;EACzC,IAAIpB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACsC,MAAM,CAAC,CAAC;AACzB;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAAA,EAAqB;EAC3C,IAAIrB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACuC,QAAQ,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,QAAqC,EAAQ;EAC3E,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEAlB,OAAO,CAACwC,eAAe,CAACC,QAAQ,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,YAAoB,EAAoB;EACtE,IAAIzB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAAC0C,eAAe,CAACC,YAAY,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,eAAuB,EAAoB;EAC5E,IAAI3B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAAC4C,kBAAkB,CAACC,eAAe,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAAClB,GAAW,EAAEmB,KAAa,EAAoB;EACzE,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAAC8C,YAAY,CAAClB,GAAG,EAAEmB,KAAK,CAAC;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACD,KAAa,EAAoB;EAC/D,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACgD,eAAe,CAACD,KAAK,CAAC;AACvC;AAEA,IAAIE,4BAAwD,GAAG,IAAI;AACnE,IAAIC,wBAA8D,GAAG,IAAI;;AAEzE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CACzCV,QAAqC,EAC5B;EACT,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAO,KAAK;EACd;EAEAgC,wBAAwB,GAAGT,QAAQ;EAEnC,IAAIQ,4BAA4B,KAAK,IAAI,EAAE;IACzCA,4BAA4B,GAAGhD,cAAc,CAACmD,WAAW,CACvD,gBAAgB,EAChB,CAAC;MAAEC;IAAU,CAAC,KAAK;MACjB,IAAIH,wBAAwB,KAAK,IAAI,EAAE;QACrCA,wBAAwB,CAACG,SAAS,CAAC;MACrC;IACF,CACF,CAAC;EACH;EAEA,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAClCC,UAAyB,EACP;EAClB,IAAIrC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACsD,oBAAoB,CAACC,UAAU,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAgC;EACjE,IAAItC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC5B,SAAS,CAAC;EACnC;EAEA,OAAOT,OAAO,CAACwD,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAAA,EAAgC;EAClE,IAAIvC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC5B,SAAS,CAAC;EACnC;EAEA,OAAOT,OAAO,CAACyD,oBAAoB,CAAC,CAAC;AACvC","ignoreList":[]}
1
+ {"version":3,"names":["NativeModules","NativeEventEmitter","Platform","LINKING_ERROR","select","ios","default","ReferToDocs","Clarity","ClarityEmitter","SupportedPlatforms","SupportWarningWasShown","ValidConfigKeys","Set","Object","keys","userId","undefined","logLevel","RemovedDynamicConfigKeys","LogLevel","ClarityError","Error","constructor","message","name","isClarityUnavailable","includes","OS","console","warn","join","error","validateClarityConfig","config","values","key","has","errorMessage","enableIOS_experimental","initialize","projectId","None","pause","Promise","resolve","resume","isPaused","startNewSession","callback","setCustomUserId","customUserId","setCustomSessionId","customSessionId","setCustomTag","value","sendCustomEvent","onSessionStartedSubscription","onSessionStartedCallback","setOnSessionStartedCallback","addListener","sessionId","setCurrentScreenName","screenName","getCurrentSessionId","getCurrentSessionUrl"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":"AAAA,SACEA,aAAa,EACbC,kBAAkB,EAClBC,QAAQ,QAEH,cAAc;AAErB,MAAMC,aAAa,GACjB,+EAA+E,GAC/ED,QAAQ,CAACE,MAAM,CAAC;EACdC,GAAG,EAAE,8CAA8C;EACnDC,OAAO,EAAE;AACX,CAAC,CAAC,GACF,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,WAAW,GACf,6FAA6F;AAE/F,MAAMC,OAAO,GAAGR,aAAa,CAACQ,OAAO;AACrC,MAAMC,cAAc,GAAG,IAAIR,kBAAkB,CAACD,aAAa,CAACS,cAAc,CAAC;AAE3E,MAAMC,kBAAkB,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC;AAE7C,IAAIC,sBAAsB,GAAG,KAAK;;AAElC;AACA;AACA;;AAuBA,MAAMC,eAAe,GAAG,IAAIC,GAAG,CAC7BC,MAAM,CAACC,IAAI,CAAC;EACVC,MAAM,EAAEC,SAAS;EAAE;EACnBC,QAAQ,EAAED;AACZ,CAAkB,CACpB,CAAC;AAED,MAAME,wBAAwB,GAAG,IAAIN,GAAG,CAAC,CACvC,0BAA0B,EAC1B,sBAAsB,EACtB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,CAC/B,CAAC;;AAEF;AACA;AACA;AACA,WAAYO,QAAQ,0BAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAARA,QAAQ;EAAA,OAARA,QAAQ;AAAA;AASpB,MAAMC,YAAY,SAASC,KAAK,CAAC;EAC/BC,WAAWA,CAACC,OAAe,EAAE;IAC3B,KAAK,CAACA,OAAO,CAAC;IACd,IAAI,CAACC,IAAI,GAAG,cAAc;EAC5B;AACF;AAEA,SAASC,oBAAoBA,CAAA,EAAY;EACvC,IAAI,CAAChB,kBAAkB,CAACiB,QAAQ,CAACzB,QAAQ,CAAC0B,EAAE,CAAC,EAAE;IAC7C,IAAI,CAACjB,sBAAsB,EAAE;MAC3BkB,OAAO,CAACC,IAAI,CACV,mBAAmB,GAAGpB,kBAAkB,CAACqB,IAAI,CAAC,IAAI,CAAC,GAAG,gBACxD,CAAC;MACDpB,sBAAsB,GAAG,IAAI;IAC/B;IAEA,OAAO,IAAI;EACb;EAEA,IAAIH,OAAO,KAAK,IAAI,EAAE;IACpBqB,OAAO,CAACG,KAAK,CAAC,sCAAsC,EAAE7B,aAAa,CAAC;IACpE,OAAO,IAAI;EACb;EAEA,OAAO,KAAK;AACd;AAEA,SAAS8B,qBAAqBA,CAACC,MAAsB,EAAE;EACrD,IAAI,OAAOA,MAAM,KAAK,WAAW,EAAE;IACjC;IACA;EACF;EAEA,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;IAC9B,MAAM,IAAIb,YAAY,CACpB,wFAAwF,OAAOa,MAAM,KAAK3B,WAAW,EACvH,CAAC;EACH;EAEA,IAAI2B,MAAM,aAANA,MAAM,eAANA,MAAM,CAAEhB,QAAQ,IAAI,CAACJ,MAAM,CAACqB,MAAM,CAACf,QAAQ,CAAC,CAACO,QAAQ,CAACO,MAAM,CAAChB,QAAQ,CAAC,EAAE;IAC1EW,OAAO,CAACG,KAAK,CACX,sDACEE,MAAM,CAAChB,QAAQ,uBACMJ,MAAM,CAACqB,MAAM,CAACf,QAAQ,CAAC,CAACW,IAAI,CACjD,IACF,CAAC,KAAKxB,WAAW,EACnB,CAAC;EACH;EAEA,KAAK,MAAM6B,GAAG,IAAIF,MAAM,EAAE;IACxB,IAAIf,wBAAwB,CAACkB,GAAG,CAACD,GAAG,CAAC,EAAE;MACrC,MAAM,IAAIf,YAAY,CACpB,uBAAuBe,GAAG,sEAC5B,CAAC;IACH,CAAC,MAAM,IAAIA,GAAG,KAAK,wBAAwB,EAAE;MAC3C,MAAME,YAAY,GAChB,iGAAiG;MACnG,IAAKJ,MAAM,CAASK,sBAAsB,EAAE;QAC1C;QACAV,OAAO,CAACG,KAAK,CAACM,YAAY,CAAC;MAC7B,CAAC,MAAM;QACL,MAAM,IAAIjB,YAAY,CAACiB,YAAY,CAAC;MACtC;IACF,CAAC,MAAM,IAAIF,GAAG,KAAK,QAAQ,EAAE;MAC3BP,OAAO,CAACC,IAAI,CACV,oIACF,CAAC;IACH,CAAC,MAAM,IAAI,CAAClB,eAAe,CAACyB,GAAG,CAACD,GAAG,CAAC,EAAE;MACpCP,OAAO,CAACC,IAAI,CAAC,qCAAqCM,GAAG,KAAK,CAAC;IAC7D;EACF;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,UAAUA,CAACC,SAAiB,EAAEP,MAAsB,EAAE;EACpE,IAAI,OAAOO,SAAS,KAAK,QAAQ,EAAE;IACjC,MAAM,IAAIpB,YAAY,CACpB,0FAA0F,OAAOoB,SAAS,KAAKlC,WAAW,EAC5H,CAAC;EACH;EAEA0B,qBAAqB,CAACC,MAAM,CAAC;;EAE7B;EACA,IAAI;IAAElB,MAAM,GAAG,IAAI;IAAEE,QAAQ,GAAGE,QAAQ,CAACsB;EAAK,CAAC,GAAGR,MAAM,IAAI,CAAC,CAAC;EAE9D,IAAIR,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEAlB,OAAO,CAACgC,UAAU,CAACC,SAAS,EAAEzB,MAAM,EAAEE,QAAQ,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASyB,KAAKA,CAAA,EAAqB;EACxC,IAAIjB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACmC,KAAK,CAAC,CAAC;AACxB;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,MAAMA,CAAA,EAAqB;EACzC,IAAIpB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACsC,MAAM,CAAC,CAAC;AACzB;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,QAAQA,CAAA,EAAqB;EAC3C,IAAIrB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACuC,QAAQ,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,QAAqC,EAAQ;EAC3E,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B;EACF;EAEAlB,OAAO,CAACwC,eAAe,CAACC,QAAQ,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,YAAoB,EAAoB;EACtE,IAAIzB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAAC0C,eAAe,CAACC,YAAY,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,kBAAkBA,CAACC,eAAuB,EAAoB;EAC5E,IAAI3B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAAC4C,kBAAkB,CAACC,eAAe,CAAC;AACpD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAAClB,GAAW,EAAEmB,KAAa,EAAoB;EACzE,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAAC8C,YAAY,CAAClB,GAAG,EAAEmB,KAAK,CAAC;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACD,KAAa,EAAoB;EAC/D,IAAI7B,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACgD,eAAe,CAACD,KAAK,CAAC;AACvC;AAEA,IAAIE,4BAAwD,GAAG,IAAI;AACnE,IAAIC,wBAA8D,GAAG,IAAI;;AAEzE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CACzCV,QAAqC,EAC5B;EACT,IAAIvB,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAO,KAAK;EACd;EAEAgC,wBAAwB,GAAGT,QAAQ;EAEnC,IAAIQ,4BAA4B,KAAK,IAAI,EAAE;IACzCA,4BAA4B,GAAGhD,cAAc,CAACmD,WAAW,CACvD,gBAAgB,EAChB,CAAC;MAAEC;IAAU,CAAC,KAAK;MACjB,IAAIH,wBAAwB,KAAK,IAAI,EAAE;QACrCA,wBAAwB,CAACG,SAAS,CAAC;MACrC;IACF,CACF,CAAC;EACH;EAEA,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAClCC,UAAyB,EACP;EAClB,IAAIrC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC,KAAK,CAAC;EAC/B;EAEA,OAAOrC,OAAO,CAACsD,oBAAoB,CAACC,UAAU,CAAC;AACjD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAAA,EAAgC;EACjE,IAAItC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC5B,SAAS,CAAC;EACnC;EAEA,OAAOT,OAAO,CAACwD,mBAAmB,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAAA,EAAgC;EAClE,IAAIvC,oBAAoB,CAAC,CAAC,EAAE;IAC1B,OAAOkB,OAAO,CAACC,OAAO,CAAC5B,SAAS,CAAC;EACnC;EAEA,OAAOT,OAAO,CAACyD,oBAAoB,CAAC,CAAC;AACvC","ignoreList":[]}
package/lib/typescript/index.d.ts CHANGED
@@ -127,19 +127,20 @@ export declare function sendCustomEvent(value: string): Promise<boolean>;
127
127
  */
128
128
  export declare function setOnSessionStartedCallback(callback: (sessionId: String) => void): boolean;
129
129
  /**
130
- * This function allows you to provide a custom screen name tag that's added as a suffix to the base screen name. The base name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
130
+ * This function allows you to provide a custom screen name that replaces the default screen name. The default name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
131
131
  *
132
- * @param screenName - The desired screen name tag. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace nor contain `/` character. Set to `null` to reset.
133
- * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name tag was set successfully; otherwise `false`.
132
+ * @param screenName - The desired screen name. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace. Set to `null` to reset.
133
+ *
134
+ * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name was set successfully; otherwise `false`.
134
135
  *
135
136
  * **Example:**
136
- * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "UIViewController/Settings".
137
- * - If `setCurrentScreenName(nil)` is called on the same view controller, the screen name is tracked as "UIViewController".
137
+ * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "Settings".
138
+ * - If `setCurrentScreenName(null)` is called on the same view controller, the screen name is tracked as "UIViewController".
138
139
  *
139
140
  * **Notes:**
140
- * - Clarity starts a new page whenever either the base screen name (generated from the Android activity or iOS view controller) or the custom name tag changes.
141
- * - To mask or disallow a screen, specify the base screen name without the custom tag suffix. For example, to mask the iOS view controller in the previous example, mask the "UIViewController" screen instead of "UIViewController/Settings".
142
- * - The screen name tag is set globally and persists across all subsequent Android activities or iOS view controllers until explicitly reset.
141
+ * - Clarity starts a new page whenever the screen name changes.
142
+ * - To mask or disallow a screen, specify the view controller's type that is displayed as "ViewController" custom tag of the page visit on the Clarity dashboard's recordings. For example, to mask the iOS view controller in the previous example, mask the "&TabBarController" screen instead of "&Settings".
143
+ * - The custom screen name is set globally and persists across all subsequent view controllers until explicitly reset.
143
144
  */
144
145
  export declare function setCurrentScreenName(screenName: string | null): Promise<boolean>;
145
146
  /**
package/lib/typescript/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AA0BA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAiBD;;GAEG;AACH,oBAAY,QAAQ;IAClB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AA2ED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,QAiBnE;AAED;;;;GAIG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAMxC;AAED;;;;GAIG;AACH,wBAAgB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAMzC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAM3C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAM3E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAMtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAM5E;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAMzE;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAM/D;AAKD;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GACpC,OAAO,CAmBT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GAAG,IAAI,GACxB,OAAO,CAAC,OAAO,CAAC,CAMlB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAMjE;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAMlE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AA0BA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAiBD;;GAEG;AACH,oBAAY,QAAQ;IAClB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AA2ED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,QAiBnE;AAED;;;;GAIG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAMxC;AAED;;;;GAIG;AACH,wBAAgB,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAMzC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAM3C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAM3E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAMtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAM5E;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAMzE;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAM/D;AAKD;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GACpC,OAAO,CAmBT;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GAAG,IAAI,GACxB,OAAO,CAAC,OAAO,CAAC,CAMlB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAMjE;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAMlE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-native-clarity",
3
- "version": "4.0.3",
3
+ "version": "4.0.4",
4
4
  "description": "A plugin to provide the Clarity experience for the React Native applications.",
5
5
  "main": "lib/commonjs/index",
6
6
  "module": "lib/module/index",
package/react-native-clarity.podspec CHANGED
@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
17
17
  s.source_files = "ios/**/*.{h,m,mm}"
18
18
 
19
19
  s.dependency "React-Core"
20
- s.dependency "Clarity", '3.0.1'
20
+ s.dependency "Clarity", '3.0.2'
21
21
 
22
22
  # Don't install the dependencies when we run `pod install` in the old architecture.
23
23
  if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
package/src/index.tsx CHANGED
@@ -343,19 +343,20 @@ export function setOnSessionStartedCallback(
343
343
  }
344
344
 
345
345
  /**
346
- * This function allows you to provide a custom screen name tag that's added as a suffix to the base screen name. The base name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
346
+ * This function allows you to provide a custom screen name that replaces the default screen name. The default name is automatically generated based on the current activity in Android, or the currently presented view controller's title or type in iOS.
347
347
  *
348
- * @param screenName - The desired screen name tag. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace nor contain `/` character. Set to `null` to reset.
349
- * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name tag was set successfully; otherwise `false`.
348
+ * @param screenName - The desired screen name. The value must be a nonempty string, with a maximum length of 255 characters, and can't consist only of whitespace. Set to `null` to reset.
349
+ *
350
+ * @returns {Promise<boolean>} A Promise that resolves with `true` if the specified screen name was set successfully; otherwise `false`.
350
351
  *
351
352
  * **Example:**
352
- * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "UIViewController/Settings".
353
- * - If `setCurrentScreenName(nil)` is called on the same view controller, the screen name is tracked as "UIViewController".
353
+ * - If the presented iOS view controller is a `UIViewController`, and `setCurrentScreenName("Settings")` is called, the screen name is tracked as "Settings".
354
+ * - If `setCurrentScreenName(null)` is called on the same view controller, the screen name is tracked as "UIViewController".
354
355
  *
355
356
  * **Notes:**
356
- * - Clarity starts a new page whenever either the base screen name (generated from the Android activity or iOS view controller) or the custom name tag changes.
357
- * - To mask or disallow a screen, specify the base screen name without the custom tag suffix. For example, to mask the iOS view controller in the previous example, mask the "UIViewController" screen instead of "UIViewController/Settings".
358
- * - The screen name tag is set globally and persists across all subsequent Android activities or iOS view controllers until explicitly reset.
357
+ * - Clarity starts a new page whenever the screen name changes.
358
+ * - To mask or disallow a screen, specify the view controller's type that is displayed as "ViewController" custom tag of the page visit on the Clarity dashboard's recordings. For example, to mask the iOS view controller in the previous example, mask the "&TabBarController" screen instead of "&Settings".
359
+ * - The custom screen name is set globally and persists across all subsequent view controllers until explicitly reset.
359
360
  */
360
361
  export function setCurrentScreenName(
361
362
  screenName: string | null