@bucketco/browser-sdk - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

dist/browser-sdk/src/client.d.ts

@@ -49,2 +49,3 @@ import { CheckEvent, FeaturesOptions, RawFeatures } from './feature/features';
     track: () => Promise<Response | undefined>;
+    requestFeedback: (options: Omit<RequestFeedbackData, "featureKey" | "featureId">) => void;
 }
@@ -51,0 +52,0 @@ export declare class BucketClient {

package.json

 {
   "name": "@bucketco/browser-sdk",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "packageManager": "yarn@4.1.1",
@@ -61,3 +61,3 @@ "license": "MIT",
   },
-  "gitHead": "d9d014536ef4e697c365af8c691a9398e647db03"
+  "gitHead": "6257e8777673dc46669235cc87da333342dc5dbd"
 }

README.md

@@ -7,2 +7,4 @@ # Bucket Browser SDK
 
+First find your `publishableKey` under [environment settings](https://app.bucket.co/envs/current/settings/app-environments) in Bucket.
+
 The package can be imported or used directly in a HTML script tag:
@@ -29,3 +31,3 @@
 
-const { isEnabled, track } = bucketClient.getFeature("huddle");
+const { isEnabled, track, requestFeedback } = bucketClient.getFeature("huddle");
 
@@ -37,4 +39,8 @@ if (isEnabled) {
 
-  // On usage, call `track` to let Bucket know that a user "used" the feature
+  // On usage, call `track` to let Bucket know that a user interacted with the feature
   track();
+
+  // Use `requestFeedback` to create "Send feedback" buttons easily for specific
+  // features. This is not related to `track` and you can call them individually.
+  requestFeedback({ title: "Tell us what you think of Huddles" });
 }
@@ -45,2 +51,6 @@
 bucketClient.track("huddle");
+
+// similarly, `requestFeedback` just calls `bucketClient.requestFeedback({featureKey: <featureKey>})`
+// which you can also call directly:
+bucketClient.requestFeedback({ featureKey: "huddle" });
 ```
@@ -53,6 +63,6 @@
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@bucketco/browser-sdk@1"></script>
+<script src="https://cdn.jsdelivr.net/npm/@bucketco/browser-sdk@2"></script>
 <script>
   const bucket = new BucketBrowserSDK.BucketClient({
-    publishableKey: "publishableKey"
+    publishableKey: "publishableKey",
     user: { id: "42" },
@@ -59,0 +69,0 @@ company: { id: "1" },

No alert changes

Improved metrics

Total package byte prevSize

890622

increased by0.2%

Lines of code

4575

increased by0.15%

Number of lines in readme file

250

increased by4.17%

No dependency changes