Merge branch 'main' into fail_on_docs_warnings

Author: roncohen

packages/browser-sdk/README.md

@@ -274,8 +274,7 @@ See details in [Feedback HTTP API](https://docs.bucket.co/reference/http-trackin
 
 Event listeners allow for capturing various events occurring in the `BucketClient`. This is useful to build integrations with other system or for various debugging purposes. There are 5 kinds of events:
 
-- `configCheck`: Your code used a feature config
-- `enabledCheck`: Your code checked whether a specific feature should be enabled
+- `check`: Your code used `isEnabled` or `config` for a feature
 - `featuresUpdated`: Features were updated. Either because they were loaded as part of initialization or because the user/company updated
 - `user`: User information updated (similar to the `identify` call used in tracking terminology)
 - `company`: Company information updated (sometimes to the `group` call used in tracking terminology)

packages/browser-sdk/index.html

@@ -54,7 +54,7 @@
         document.getElementById("loading").style.display = "none";
       });
 
-      bucket.on("enabledCheck", (check) =>
+      bucket.on("check", (check) =>
         console.log(`Check event for ${check.key}`),
       );
 

packages/browser-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bucketco/browser-sdk",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "packageManager": "yarn@4.1.1",
   "license": "MIT",
   "repository": {

packages/browser-sdk/src/client.ts

@@ -480,28 +480,32 @@ export class BucketClient {
   }
 
   /**
-   * Add a hook to the client.
+   * Add an event listener
    *
+   * @param type Type of events to listen for
+   * @param handler The function to call when the event is triggered.
    * @returns A function to remove the hook.
    */
   on<THookType extends keyof HookArgs>(
     type: THookType,
     handler: (args0: HookArgs[THookType]) => void,
   ) {
-    this.hooks.addHook(type, handler);
-    return () => this.hooks.removeHook(type, handler);
+    return this.hooks.addHook(type, handler);
   }
 
   /**
-   * Remove a hook from the client.
+   * Remove an event listener
+   *
+   * @param type Type of event to remove.
+   * @param handler The same function that was passed to `on`.
    *
    * @returns A function to remove the hook.
    */
   off<THookType extends keyof HookArgs>(
     type: THookType,
     handler: (args0: HookArgs[THookType]) => void,
   ) {
-    return this.hooks.removeHook(type, handler);
+    this.hooks.removeHook(type, handler);
   }
 
   /**
@@ -797,6 +801,7 @@ export class BucketClient {
         checkEvent.action == "check-config" ? "configCheck" : "enabledCheck",
         checkEvent,
       );
+      this.hooks.trigger("check", checkEvent);
     });
   }
 

packages/browser-sdk/src/hooksManager.ts

@@ -2,8 +2,17 @@ import { CheckEvent, RawFeatures } from "./feature/features";
 import { CompanyContext, UserContext } from "./context";
 
 export interface HookArgs {
+  /**
+   * Deprecated: Use `check` instead.
+   * @deprecated
+   */
   configCheck: CheckEvent;
+  /**
+   * Deprecated: Use `check` instead.
+   * @deprecated
+   */
   enabledCheck: CheckEvent;
+  check: CheckEvent;
   featuresUpdated: RawFeatures;
   user: UserContext;
   company: CompanyContext;
@@ -25,13 +34,15 @@ export class HooksManager {
   private hooks: {
     enabledCheck: ((arg0: CheckEvent) => void)[];
     configCheck: ((arg0: CheckEvent) => void)[];
+    check: ((arg0: CheckEvent) => void)[];
     featuresUpdated: ((arg0: RawFeatures) => void)[];
     user: ((arg0: UserContext) => void)[];
     company: ((arg0: CompanyContext) => void)[];
     track: ((arg0: TrackEvent) => void)[];
   } = {
     enabledCheck: [],
     configCheck: [],
+    check: [],
     featuresUpdated: [],
     user: [],
     company: [],

packages/browser-sdk/test/client.test.ts

@@ -80,13 +80,15 @@ describe("BucketClient", () => {
       const trackHook = vi.fn();
       const userHook = vi.fn();
       const companyHook = vi.fn();
+      const checkHook = vi.fn();
       const checkHookIsEnabled = vi.fn();
       const checkHookConfig = vi.fn();
       const featuresUpdated = vi.fn();
 
       client.on("track", trackHook);
       client.on("user", userHook);
       client.on("company", companyHook);
+      client.on("check", checkHook);
       client.on("configCheck", checkHookConfig);
       client.on("enabledCheck", checkHookIsEnabled);
       client.on("featuresUpdated", featuresUpdated);
@@ -108,10 +110,14 @@ describe("BucketClient", () => {
       // eslint-disable-next-line @typescript-eslint/no-unused-expressions -- special getter triggering event
       client.getFeature("featureA").isEnabled;
       expect(checkHookIsEnabled).toHaveBeenCalled();
+      expect(checkHook).toHaveBeenCalled();
+
+      checkHook.mockReset();
 
       // eslint-disable-next-line @typescript-eslint/no-unused-expressions -- special getter triggering event
       client.getFeature("featureA").config;
       expect(checkHookConfig).toHaveBeenCalled();
+      expect(checkHook).toHaveBeenCalled();
 
       expect(featuresUpdated).not.toHaveBeenCalled();
       await client.updateOtherContext({ key: "value" });
@@ -121,6 +127,7 @@ describe("BucketClient", () => {
       client.off("track", trackHook);
       client.off("user", userHook);
       client.off("company", companyHook);
+      client.off("check", checkHook);
       client.off("configCheck", checkHookConfig);
       client.off("enabledCheck", checkHookIsEnabled);
       client.off("featuresUpdated", featuresUpdated);
@@ -129,6 +136,7 @@ describe("BucketClient", () => {
       trackHook.mockReset();
       userHook.mockReset();
       companyHook.mockReset();
+      checkHook.mockReset();
       checkHookIsEnabled.mockReset();
       checkHookConfig.mockReset();
       featuresUpdated.mockReset();
@@ -147,6 +155,7 @@ describe("BucketClient", () => {
       expect(trackHook).not.toHaveBeenCalled();
       expect(userHook).not.toHaveBeenCalled();
       expect(companyHook).not.toHaveBeenCalled();
+      expect(checkHook).not.toHaveBeenCalled();
       expect(checkHookIsEnabled).not.toHaveBeenCalled();
       expect(checkHookConfig).not.toHaveBeenCalled();
       expect(featuresUpdated).not.toHaveBeenCalled();

packages/browser-sdk/test/hooksManager.test.ts

@@ -11,7 +11,21 @@ describe("HookManager", () => {
     hookManager = new HooksManager();
   });
 
-  it("should add and trigger check-is-enabled hooks", () => {
+  it("should add and trigger `check` hooks", () => {
+    const callback = vi.fn();
+    hookManager.addHook("check", callback);
+
+    const checkEvent: CheckEvent = {
+      action: "check-is-enabled",
+      key: "test-key",
+      value: true,
+    };
+    hookManager.trigger("check", checkEvent);
+
+    expect(callback).toHaveBeenCalledWith(checkEvent);
+  });
+
+  it("should add and trigger `enabledCheck` hooks", () => {
     const callback = vi.fn();
     hookManager.addHook("enabledCheck", callback);
 
@@ -25,7 +39,7 @@ describe("HookManager", () => {
     expect(callback).toHaveBeenCalledWith(checkEvent);
   });
 
-  it("should add and trigger configCheck hooks", () => {
+  it("should add and trigger `configCheck` hooks", () => {
     const callback = vi.fn();
     hookManager.addHook("configCheck", callback);
 
@@ -39,7 +53,7 @@ describe("HookManager", () => {
     expect(callback).toHaveBeenCalledWith(checkEvent);
   });
 
-  it("should add and trigger features-updated hooks", () => {
+  it("should add and trigger `featuresUpdated` hooks", () => {
     const callback = vi.fn();
     hookManager.addHook("featuresUpdated", callback);
 
@@ -51,7 +65,7 @@ describe("HookManager", () => {
     expect(callback).toHaveBeenCalledWith(features);
   });
 
-  it("should add and trigger track hooks", () => {
+  it("should add and trigger `track` hooks", () => {
     const callback = vi.fn();
     const user: UserContext = { id: "user-id", name: "user-name" };
     const company: CompanyContext = { id: "company-id", name: "company-name" };
@@ -69,7 +83,7 @@ describe("HookManager", () => {
     });
   });
 
-  it("should add and trigger user hooks", () => {
+  it("should add and trigger `user` hooks", () => {
     const callback = vi.fn();
 
     hookManager.addHook("user", callback);
@@ -80,7 +94,7 @@ describe("HookManager", () => {
     expect(callback).toHaveBeenCalledWith(user);
   });
 
-  it("should add and trigger company hooks", () => {
+  it("should add and trigger `company` hooks", () => {
     const callback = vi.fn();
     hookManager.addHook("company", callback);
 
@@ -94,15 +108,15 @@ describe("HookManager", () => {
     const callback1 = vi.fn();
     const callback2 = vi.fn();
 
-    hookManager.addHook("enabledCheck", callback1);
-    hookManager.addHook("enabledCheck", callback2);
+    hookManager.addHook("check", callback1);
+    hookManager.addHook("check", callback2);
 
     const checkEvent: CheckEvent = {
       action: "check-is-enabled",
       key: "test-key",
       value: true,
     };
-    hookManager.trigger("enabledCheck", checkEvent);
+    hookManager.trigger("check", checkEvent);
 
     expect(callback1).toHaveBeenCalledWith(checkEvent);
     expect(callback2).toHaveBeenCalledWith(checkEvent);
@@ -112,16 +126,16 @@ describe("HookManager", () => {
     const callback1 = vi.fn();
     const callback2 = vi.fn();
 
-    hookManager.addHook("enabledCheck", callback1);
-    hookManager.addHook("enabledCheck", callback2);
-    hookManager.removeHook("enabledCheck", callback1);
+    hookManager.addHook("check", callback1);
+    hookManager.addHook("check", callback2);
+    hookManager.removeHook("check", callback1);
 
     const checkEvent: CheckEvent = {
       action: "check-is-enabled",
       key: "test-key",
       value: true,
     };
-    hookManager.trigger("enabledCheck", checkEvent);
+    hookManager.trigger("check", checkEvent);
 
     expect(callback1).not.toHaveBeenCalled();
     expect(callback2).toHaveBeenCalledWith(checkEvent);
@@ -131,16 +145,16 @@ describe("HookManager", () => {
     const callback1 = vi.fn();
     const callback2 = vi.fn();
 
-    const removeHook1 = hookManager.addHook("enabledCheck", callback1);
-    hookManager.addHook("enabledCheck", callback2);
+    const removeHook1 = hookManager.addHook("check", callback1);
+    hookManager.addHook("check", callback2);
     removeHook1();
 
     const checkEvent: CheckEvent = {
       action: "check-is-enabled",
       key: "test-key",
       value: true,
     };
-    hookManager.trigger("enabledCheck", checkEvent);
+    hookManager.trigger("check", checkEvent);
 
     expect(callback1).not.toHaveBeenCalled();
     expect(callback2).toHaveBeenCalledWith(checkEvent);

packages/openfeature-browser-provider/package.json

@@ -29,9 +29,9 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/bucket-openfeature-browser-provider.mjs",
-      "require": "./dist/bucket-openfeature-browser-provider.umd.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/bucket-openfeature-browser-provider.umd.js"
     }
   },
   "dependencies": {

packages/react-sdk/README.md

@@ -409,7 +409,7 @@ function LoggingWrapper({ children }: { children: ReactNode }) {
   const client = useClient();
 
   useEffect(() => {
-    client.on("enabledCheck", (evt) => {
+    client.on("check", (evt) => {
       console.log(`The feature ${evt.key} is ${evt.value} for user.`);
     });
   }, [client]);

packages/react-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bucketco/react-sdk",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     }
   },
   "dependencies": {
-    "@bucketco/browser-sdk": "3.1.0",
+    "@bucketco/browser-sdk": "3.1.1",
     "canonical-json": "^0.0.4",
     "rollup": "^4.2.0"
   },