@knocklabs/client 0.19.2 → 0.19.4

package/src/api.ts

@@ -6,6 +6,7 @@ type ApiClientOptions = {
   host: string;
   apiKey: string;
   userToken: string | undefined;
+  branch?: string;
 };
 
 export interface ApiResponse {
@@ -21,6 +22,7 @@ class ApiClient {
   private host: string;
   private apiKey: string;
   private userToken: string | null;
+  private branch: string | null;
   private axiosClient: AxiosInstance;
 
   public socket: Socket | undefined;
@@ -29,6 +31,7 @@ class ApiClient {
     this.host = options.host;
     this.apiKey = options.apiKey;
     this.userToken = options.userToken || null;
+    this.branch = options.branch || null;
 
     // Create a retryable axios client
     this.axiosClient = axios.create({
@@ -39,6 +42,7 @@ class ApiClient {
         Authorization: `Bearer ${this.apiKey}`,
         "X-Knock-User-Token": this.userToken,
         "X-Knock-Client": this.getKnockClientHeader(),
+        "X-Knock-Branch": this.branch,
       },
     });
 
@@ -47,6 +51,7 @@ class ApiClient {
         params: {
           user_token: this.userToken,
           api_key: this.apiKey,
+          branch_slug: this.branch,
         },
       });
     }

package/src/clients/guide/client.ts

@@ -848,7 +848,6 @@ export class KnockGuideClient {
       ...this.buildEngagementEventBaseParams(guide, updatedStep),
       content: updatedStep.content,
       data: this.targetParams.data,
-      tenant: this.targetParams.tenant,
     };
 
     this.knock.user.markGuideStepAs<MarkAsSeenParams, MarkGuideAsResponse>(
@@ -1076,6 +1075,8 @@ export class KnockGuideClient {
       guide_key: guide.key,
       guide_id: guide.id,
       guide_step_ref: step.ref,
+      // Can be used for scoping guide messages.
+      tenant: this.targetParams.tenant,
     };
   }
 

package/src/interfaces.ts

@@ -8,6 +8,7 @@ export type LogLevel = "debug";
 export interface KnockOptions {
   host?: string;
   logLevel?: LogLevel;
+  branch?: string;
 }
 
 export interface KnockObject<T = GenericData> {

package/src/knock.ts

@@ -25,6 +25,7 @@ class Knock {
   public userId: string | undefined | null;
   public userToken?: string;
   public logLevel?: LogLevel;
+  public readonly branch?: string;
   private tokenExpirationTimer: ReturnType<typeof setTimeout> | null = null;
   readonly feeds = new FeedClient(this);
   readonly objects = new ObjectClient(this);
@@ -40,6 +41,7 @@ class Knock {
   ) {
     this.host = options.host || DEFAULT_HOST;
     this.logLevel = options.logLevel;
+    this.branch = options.branch || undefined;
 
     this.log("Initialized Knock instance");
 
@@ -187,6 +189,7 @@ class Knock {
       apiKey: this.apiKey,
       host: this.host,
       userToken: this.userToken,
+      branch: this.branch,
     });
   }