@monterosa/sdk-identify-kit 2.0.0-rc.1 → 2.0.0-rc.3

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.
package/dist/api.d.ts CHANGED
@@ -163,9 +163,12 @@ export declare function requestLogout(identify: IdentifyKit): Promise<void>;
163
163
  /**
164
164
  * @internal
165
165
  *
166
- * Internal function to get a fresh session signature.
167
- * This function does not handle errors callers are responsible
168
- * for catching and handling failures.
166
+ * Returns a signature for a user session. The signature is based on the
167
+ * user's identifying information provided in the `IdentifyKit` instance.
168
+ *
169
+ * @remarks
170
+ * This function does not handle errors. Callers are responsible for catching
171
+ * and handling failures.
169
172
  *
170
173
  * @param identify - An instance of the `IdentifyKit` class used for user
171
174
  * identification.
@@ -428,7 +431,7 @@ export declare function onUserDataUpdated(identify: IdentifyKit, callback: (user
428
431
  * @param identify - An instance of `IdentifyKit` that provides the user
429
432
  * identification functionality.
430
433
  * @param callback - The callback function to register. This function will
431
- * be called when a login is requested by an experience.
434
+ * be called when a login is requested by an Experience.
432
435
  * @returns An `Unsubscribe` function that can be called to unregister
433
436
  * the callback function.
434
437
  */
@@ -457,7 +460,7 @@ export declare function onLoginRequestedByExperience(identify: IdentifyKit, call
457
460
  * @param identify - An instance of `IdentifyKit` that provides the user
458
461
  * identification functionality.
459
462
  * @param callback - The callback function to register. This function will
460
- * be called when a logout is requested by an experience.
463
+ * be called when a logout is requested by an Experience.
461
464
  * @returns An `Unsubscribe` function that can be called to unregister
462
465
  * the callback function.
463
466
  */