@knocklabs/client 0.14.10 → 0.15.0

package/src/knock.ts

@@ -12,6 +12,8 @@ import {
   AuthenticateOptions,
   KnockOptions,
   LogLevel,
+  UserId,
+  UserIdOrUserWithProperties,
   UserTokenExpiringCallback,
 } from "./interfaces";
 
@@ -58,17 +60,32 @@ class Knock {
     return this.apiClient;
   }
 
-  /*
-    Authenticates the current user. In non-sandbox environments
-    the userToken must be specified.
-  */
+  /**
+   * @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
+   * knock.authenticate({ id: "user_123" });
+   * ```
+   */
+  authenticate(
+    userIdOrUserWithProperties: UserId,
+    userToken?: Knock["userToken"],
+    options?: AuthenticateOptions,
+  ): never;
+  authenticate(
+    userIdOrUserWithProperties: UserIdOrUserWithProperties,
+    userToken?: Knock["userToken"],
+    options?: AuthenticateOptions,
+  ): void;
   authenticate(
-    userId: Knock["userId"],
+    userIdOrUserWithProperties: UserIdOrUserWithProperties,
     userToken?: Knock["userToken"],
     options?: AuthenticateOptions,
   ) {
     let reinitializeApi = false;
     const currentApiClient = this.apiClient;
+    const userId = this.getUserId(userIdOrUserWithProperties);
 
     // If we've previously been initialized and the values have now changed, then we
     // need to reinitialize any stateful connections we have
@@ -103,6 +120,15 @@ class Knock {
       this.log("Reinitialized real-time connections");
     }
 
+    // Inline identify the user if we've been given an object with an id.
+    if (
+      typeof userIdOrUserWithProperties === "object" &&
+      userIdOrUserWithProperties?.id
+    ) {
+      const { id, ...properties } = userIdOrUserWithProperties;
+      this.user.identify(properties);
+    }
+
     return;
   }
 
@@ -177,6 +203,27 @@ class Knock {
       }, msInFuture);
     }
   }
+
+  /**
+   * Returns the user id from the given userIdOrUserWithProperties
+   * @param userIdOrUserWithProperties - The user id or user object
+   * @returns The user id
+   * @throws {Error} If the user object does not contain an `id` property
+   */
+  private getUserId(userIdOrUserWithProperties: UserIdOrUserWithProperties) {
+    if (
+      typeof userIdOrUserWithProperties === "string" ||
+      !userIdOrUserWithProperties
+    ) {
+      return userIdOrUserWithProperties;
+    }
+
+    if (userIdOrUserWithProperties?.id) {
+      return userIdOrUserWithProperties.id;
+    }
+
+    throw new Error("`user` object must contain an `id` property");
+  }
 }
 
 export default Knock;