@bucketco/react-sdk - npm Package Compare versions

Comparing version 2.4.1 to 2.5.0

dist/src/index.d.ts

@@ -15,4 +15,14 @@ import { default as React, ReactNode } from 'react';
     feedback?: FeedbackOptions;
+    /**
+     * @deprecated
+     * Use `apiBaseUrl` instead.
+     */
     host?: string;
+    apiBaseUrl?: string;
+    /**
+     * @deprecated
+     * Use `sseBaseUrl` instead.
+     */
     sseHost?: string;
+    sseBaseUrl?: string;
     debug?: boolean;
@@ -90,2 +100,50 @@ enableTracking?: boolean;
 export declare function useSendFeedback(): (opts: UnassignedFeedback) => Promise<Response | undefined> | undefined;
+/**
+ * Returns a function to update the current user's information.
+ * For example, if the user changed role or opted into a beta-feature.
+ *
+ * The method returned is a function which returns a promise that
+ * resolves when after the features have been updated as a result
+ * of the user update.
+ *
+ * ```ts
+ * const updateUser = useUpdateUser();
+ * updateUser({ optInHuddles: "true" }).then(() => console.log("Features updated"));
+ * ```
+ */
+export declare function useUpdateUser(): (opts: {
+    [key: string]: string | number | undefined;
+}) => Promise<void> | undefined;
+/**
+ * Returns a function to update the current company's information.
+ * For example, if the company changed plan or opted into a beta-feature.
+ *
+ * The method returned is a function which returns a promise that
+ * resolves when after the features have been updated as a result
+ * of the company update.
+ *
+ * ```ts
+ * const updateCompany = useUpdateCompany();
+ * updateCompany({ plan: "enterprise" }).then(() => console.log("Features updated"));
+ *
+ */
+export declare function useUpdateCompany(): (opts: {
+    [key: string]: string | number | undefined;
+}) => Promise<void> | undefined;
+/**
+ * Returns a function to update the "other" context information.
+ * For example, if the user changed workspace, you can set the workspace id here.
+ *
+ * The method returned is a function which returns a promise that
+ * resolves when after the features have been updated as a result
+ * of the update to the "other" context.
+ *
+ * ```ts
+ * const updateOtherContext = useUpdateOtherContext();
+ * updateOtherContext({ workspaceId: newWorkspaceId })
+ *   .then(() => console.log("Features updated"));
+ */
+export declare function useUpdateOtherContext(): (opts: {
+    [key: string]: string | number | undefined;
+}) => Promise<void> | undefined;
 export {};

package.json

 {
   "name": "@bucketco/react-sdk",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "license": "MIT",
@@ -37,3 +37,3 @@ "repository": {
   "dependencies": {
-    "@bucketco/browser-sdk": "2.4.1",
+    "@bucketco/browser-sdk": "2.5.0",
     "canonical-json": "^0.0.4"
@@ -69,3 +69,3 @@ },
   },
-  "gitHead": "46c34835cf3059146a80f3eb0d419b9b81685996"
+  "gitHead": "75e512992a98b5a8ffad702b2cf483ee5215e436"
 }

README.md

@@ -109,3 +109,11 @@ # Bucket React SDK
       <button
-        onClick={() => requestFeedback({ title: "How do you like Huddles?" })}
+        onClick={(e) =>
+          requestFeedback({
+            title: "How do you like Huddles?",
+            position: {
+              type: "POPOVER",
+              anchor: e.currentTarget as HTMLElement,
+            },
+          })
+        }
       >
@@ -143,3 +151,6 @@ Give feedback!
 
-```ts
+When using the `useRequestFeedback` you must pass the feature key to `requestFeedback`.
+The example below shows how to use `position` to ensure the popover appears next to the "Give feedback!" button.
+
+```tsx
 import { useTrackEvent } from "@bucketco/react-sdk";
@@ -149,6 +160,16 @@
 
-requestFeedback({
-  featureId: "bucket-feature-id",
-  title: "How satisfied are you with file uploads?",
-});
+<button
+  onClick={(e) =>
+    requestFeedback({
+      featureKey: "huddle-feature-key",
+      title: "How satisfied are you with file uploads?",
+      position: {
+        type: "POPOVER",
+        anchor: e.currentTarget as HTMLElement,
+      },
+    })
+  }
+>
+  Give feedback!
+</button>;
 ```
@@ -175,4 +196,25 @@
 
-See https://github.com/bucketco/bucket-javascript-sdk/blob/main/packages/browser-sdk/FEEDBACK.md#manual-feedback-collection for more information on `sendFeedback`
+### `useUpdateUser()`, `useUpdateCompany()` and `useUpdateOtherContext()`
 
+`useUpdateUser()`, `useUpdateCompany()` and `useUpdateOtherContext()` all return
+a function that lets you update the attributes for the currently set user/company.
+
+Updates made to user/company are stored remotely and are used automatically
+for evaluating feature targeting in the future, while "other" context is only
+used in the current session.
+
+This is only useful for updating attributes for the already set user/company.
+If you want to change the user.id or company.id, you need to update the props
+given the `BucketProvider` instead.
+
+```ts
+import { useUpdateUser } from "@bucketco/react-sdk";
+
+const updateUser = useUpdateUser();
+
+updateUser({
+  huddlesOptIn: "true",
+});
+```
+
 # Content Security Policy (CSP)
@@ -179,0 +221,0 @@

No alert changes

Improved metrics

Total package byte prevSize

778725

3.79%

Lines of code

4388

4.4%

Number of lines in readme file

225

22.95%

Dependency changes

• + Added

  @bucketco/browser-sdk@2.5.0
  (transitive)

• - Removed

  @bucketco/browser-sdk@2.4.1
  (transitive)

• Updated

  @bucketco/browser-sdk@2.5.0