@knocklabs/react-core 0.6.14 → 0.7.0

package/src/modules/core/hooks/useAuthenticatedKnockClient.ts

@@ -1,15 +1,20 @@
-import Knock, { AuthenticateOptions, KnockOptions } from "@knocklabs/client";
+import Knock, {
+  AuthenticateOptions,
+  KnockOptions,
+  UserId,
+  UserIdOrUserWithProperties,
+} from "@knocklabs/client";
 import React from "react";
 
 import { useStableOptions } from "../../core";
 
 function authenticateWithOptions(
   knock: Knock,
-  userId: Knock["userId"],
+  userIdOrUserWithProperties: UserIdOrUserWithProperties,
   userToken?: Knock["userToken"],
   options: AuthenticateOptions = {},
 ) {
-  knock.authenticate(userId, userToken, {
+  knock.authenticate(userIdOrUserWithProperties, userToken, {
     onUserTokenExpiring: options?.onUserTokenExpiring,
     timeBeforeExpirationInMs: options?.timeBeforeExpirationInMs,
   });
@@ -18,9 +23,29 @@ function authenticateWithOptions(
 export type AuthenticatedKnockClientOptions = KnockOptions &
   AuthenticateOptions;
 
+/**
+ * @deprecated Passing `userId` as a `string` is deprecated and will be removed in a future version.
+ * Please pass a `user` object instead containing an `id` value.
+ * example:
+ * ```ts
+ * useAuthenticatedKnockClient("pk_test_12345", { id: "user_123" });
+ * ```
+ */
 function useAuthenticatedKnockClient(
   apiKey: string,
-  userId: Knock["userId"],
+  userIdOrUserWithProperties: UserId,
+  userToken?: Knock["userToken"],
+  options?: AuthenticatedKnockClientOptions,
+): Knock;
+function useAuthenticatedKnockClient(
+  apiKey: string,
+  userIdOrUserWithProperties: UserIdOrUserWithProperties,
+  userToken?: Knock["userToken"],
+  options?: AuthenticatedKnockClientOptions,
+): Knock;
+function useAuthenticatedKnockClient(
+  apiKey: string,
+  userIdOrUserWithProperties: UserIdOrUserWithProperties,
   userToken?: Knock["userToken"],
   options: AuthenticatedKnockClientOptions = {},
 ) {
@@ -28,6 +53,11 @@ function useAuthenticatedKnockClient(
   const stableOptions = useStableOptions(options);
 
   return React.useMemo(() => {
+    const userId =
+      typeof userIdOrUserWithProperties === "string"
+        ? userIdOrUserWithProperties
+        : userIdOrUserWithProperties?.id;
+
     const currentKnock = knockRef.current;
 
     // If the userId and the userToken changes then just reauth
@@ -36,7 +66,12 @@ function useAuthenticatedKnockClient(
       currentKnock.isAuthenticated() &&
       (currentKnock.userId !== userId || currentKnock.userToken !== userToken)
     ) {
-      authenticateWithOptions(currentKnock, userId, userToken, stableOptions);
+      authenticateWithOptions(
+        currentKnock,
+        userIdOrUserWithProperties,
+        userToken,
+        stableOptions,
+      );
       return currentKnock;
     }
 
@@ -50,11 +85,16 @@ function useAuthenticatedKnockClient(
       logLevel: stableOptions.logLevel,
     });
 
-    authenticateWithOptions(knock, userId, userToken, stableOptions);
+    authenticateWithOptions(
+      knock,
+      userIdOrUserWithProperties,
+      userToken,
+      stableOptions,
+    );
     knockRef.current = knock;
 
     return knock;
-  }, [apiKey, userId, userToken, stableOptions]);
+  }, [apiKey, userIdOrUserWithProperties, userToken, stableOptions]);
 }
 
 export default useAuthenticatedKnockClient;