Merge branch 'main' into cloudflare

Author: roncohen

packages/node-sdk/examples/express/yarn.lock

@@ -1186,11 +1186,11 @@ __metadata:
   linkType: hard
 
 "brace-expansion@npm:^2.0.1":
-  version: 2.0.1
-  resolution: "brace-expansion@npm:2.0.1"
+  version: 2.0.2
+  resolution: "brace-expansion@npm:2.0.2"
   dependencies:
     balanced-match: "npm:^1.0.0"
-  checksum: 10c0/b358f2fe060e2d7a87aa015979ecea07f3c37d4018f8d6deb5bd4c229ad3a0384fe6029bb76cd8be63c81e516ee52d1a0673edbe2023d53a5191732ae3c3e49f
+  checksum: 10c0/6d117a4c793488af86b83172deb6af143e94c17bc53b0b3cec259733923b4ca84679d506ac261f4ba3c7ed37c46018e2ff442f9ce453af8643ecd64f4a54e6cf
   languageName: node
   linkType: hard
 
@@ -3357,8 +3357,8 @@ __metadata:
   linkType: hard
 
 "vite@npm:^5.0.0":
-  version: 5.4.18
-  resolution: "vite@npm:5.4.18"
+  version: 5.4.19
+  resolution: "vite@npm:5.4.19"
   dependencies:
     esbuild: "npm:^0.21.3"
     fsevents: "npm:~2.3.3"
@@ -3395,7 +3395,7 @@ __metadata:
       optional: true
   bin:
     vite: bin/vite.js
-  checksum: 10c0/a8cbbec6bdf399e62c386d70b8485e4f2f1b427beb19bc7c5d52b402a0c3750b7ff469fc20a8333755ea13bc1b0af5df3f22c8fd37d1739ee51d709b7a4740b6
+  checksum: 10c0/c97601234dba482cea5290f2a2ea0fcd65e1fab3df06718ea48adc8ceb14bc3129508216c4989329c618f6a0470b42f439677a207aef62b0c76f445091c2d89e
   languageName: node
   linkType: hard
 

packages/vue-sdk/README.md

@@ -40,15 +40,18 @@ If using Nuxt, wrap `<BucketProvider>` in `<ClientOnly>`. `<BucketProvider>` onl
 <script setup lang="ts">
 import { useFeature } from "@bucketco/vue-sdk";
 
-const huddle = useFeature("huddle");
+const { isEnabled } = useFeature("huddle");
 </script>
 
 <template>
-  <div v-if="huddle.isEnabled">
-    <button @click="huddle.track()">Start huddle!</button>
+  <div v-if="isEnabled">
+    <button>Start huddle!</button>
+  </div>
 </template>
 ```
 
+See [useFeature()](#usefeature) for a full example
+
 ## Setting `user` and `company`
 
 Bucket determines which features are active for a given `user`, `company`, or `otherContext`.
@@ -70,7 +73,9 @@ A number of special attributes exist:
   :publishable-key="publishableKey"
   :user="{ id: 'user_123', name: 'John Doe', email: 'john@acme.com' }"
   :company="{ id: 'acme_inc', plan: 'pro' }"
-></BucketProvider>
+>
+  <!-- your app -->
+</BucketProvider>
 ```
 
 To retrieve features along with their targeting information, use `useFeature(key: string)` hook (described in a section below).
@@ -149,26 +154,40 @@ If you want more control over loading screens, `useIsLoading()` returns a Ref<bo
 
 ### `useFeature()`
 
-Returns the state of a given feature for the current context. The composable provides type-safe access to feature flags and their configurations.
+Returns the state of a given feature for the current context. The composable provides access to feature flags and their configurations.
+
+`useFeature()` returns an object with this shape:
+
+```ts
+{
+  isEnabled: boolean, // is the feature enabled
+  track: () => void, // send a track event when the feature is used
+  requestFeedback: (...) => void // open up a feedback dialog
+  config: {key: string, payload: any},  // remote configuration for this feature
+  isLoading: boolean // if you want to manage loading state at the feature level
+}
+```
+
+Example:
 
 ```vue
 <script setup lang="ts">
 import { useFeature } from "@bucketco/vue-sdk";
 
-const huddle = useFeature("huddle");
+const { isEnabled, track, requestFeedback, config } = useFeature("huddle");
 </script>
 
 <template>
-  <div v-if="huddle.isLoading">Loading...</div>
-  <div v-else-if="!huddle.isEnabled">Feature not available</div>
+  <div v-if="isLoading">Loading...</div>
+  <div v-else-if="!isEnabled">Feature not available</div>
   <div v-else>
-    <button @click="huddle.track()">Start huddle!</button>
+    <button @click="track()">Start huddle!</button>
     <button
       @click="
         (e) =>
-          huddle.requestFeedback({
+          requestFeedback({
             title:
-              huddle.config.payload?.question ??
+              config.payload?.question ??
               'How do you like the Huddles feature?',
             position: {
               type: 'POPOVER',
@@ -187,7 +206,9 @@ See the reference docs for details.
 
 ### `useTrack()`
 
-`useTrack()` lets you send custom events to Bucket. Use this whenever a user _uses_ a feature.
+`useTrack()` returns a function which lets you send custom events to Bucket. It takes a string argument with the event name and optionally an object with properties to attach the event.
+
+Using `track` returned from `useFeature()` calles this track function with the feature key as the event name.
 
 ```vue
 <script setup lang="ts">

packages/vue-sdk/dev/plain/components/StartHuddleButton.vue

@@ -3,26 +3,25 @@ import { useFeature } from "../../../src";
 
 import Section from "./Section.vue";
 
-const huddle = useFeature("huddle");
+const { isLoading, isEnabled, config, requestFeedback, track } =
+  useFeature("huddle");
 </script>
 <template>
   <Section title="Huddle">
     <div style="display: flex; gap: 10px; flex-wrap: wrap">
-      <div>Huddle enabled: {{ huddle.isEnabled }}</div>
-      <div v-if="huddle.isLoading">Loading...</div>
+      <div>Huddle enabled: {{ isEnabled }}</div>
+      <div v-if="isLoading">Loading...</div>
       <div v-else style="display: flex; gap: 10px; flex-wrap: wrap">
         <div>
-          <button @click="huddle.track()">
-            {{
-              huddle.config.payload?.buttonTitle ?? "Start Huddle (track event)"
-            }}
+          <button @click="track()">
+            {{ config?.payload?.buttonTitle ?? "Start Huddle (track event)" }}
           </button>
         </div>
         <div>
           <button
             @click="
               (e) =>
-                huddle.requestFeedback({
+                requestFeedback({
                   title: 'Do you like huddles?',
                 })
             "

packages/vue-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bucketco/vue-sdk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",

packages/vue-sdk/src/hooks.ts

@@ -1,48 +1,45 @@
-import { inject, InjectionKey, onBeforeUnmount, ref } from "vue";
+import { computed, inject, InjectionKey, onBeforeUnmount, ref } from "vue";
 
 import { RequestFeedbackData, UnassignedFeedback } from "@bucketco/browser-sdk";
 
 import {
-  FeatureKey,
+  Feature,
   ProviderContextType,
   RequestFeatureFeedbackOptions,
 } from "./types";
 
 export const ProviderSymbol: InjectionKey<ProviderContextType> =
   Symbol("BucketProvider");
 
-export function useFeature<TKey extends FeatureKey>(key: TKey) {
+export function useFeature(key: string): Feature<any> {
   const client = useClient();
   const ctx = injectSafe();
 
   const track = () => client?.value.track(key);
   const requestFeedback = (opts: RequestFeatureFeedbackOptions) =>
     client.value.requestFeedback({ ...opts, featureKey: key });
 
-  function getFeature() {
-    const f = client.value.getFeature(key);
-    return {
-      isEnabled: f.isEnabled,
-      config: f.config,
-      track,
-      requestFeedback,
-      key,
-      isLoading: ctx.isLoading,
-    };
-  }
+  const feature = ref(client.value.getFeature(key));
 
-  const feature = ref(getFeature());
+  updateFeature();
 
   function updateFeature() {
-    feature.value = getFeature();
+    feature.value = client.value.getFeature(key);
   }
 
   client.value.on("featuresUpdated", updateFeature);
   onBeforeUnmount(() => {
     client.value.off("featuresUpdated", updateFeature);
   });
 
-  return feature;
+  return {
+    key,
+    isEnabled: computed(() => feature.value.isEnabled),
+    config: computed(() => feature.value.config),
+    track,
+    requestFeedback,
+    isLoading: computed(() => ctx.isLoading.value),
+  };
 }
 
 /**

packages/vue-sdk/src/index.ts

@@ -9,7 +9,12 @@ import {
 } from "@bucketco/browser-sdk";
 
 import BucketProvider from "./BucketProvider.vue";
-import { BucketProps } from "./types";
+import {
+  BucketProps,
+  EmptyFeatureRemoteConfig,
+  Feature,
+  FeatureType,
+} from "./types";
 
 export {
   useClient,
@@ -29,6 +34,9 @@ export { BucketProvider };
 export type {
   CheckEvent,
   CompanyContext,
+  EmptyFeatureRemoteConfig,
+  Feature,
+  FeatureType,
   RawFeatures,
   TrackEvent,
   UserContext,

packages/vue-sdk/src/types.ts

@@ -28,7 +28,7 @@ export interface Feature<
   key: string;
   isEnabled: Ref<boolean>;
   isLoading: Ref<boolean>;
-  config: ({ key: string } & TConfig) | EmptyFeatureRemoteConfig;
+  config: Ref<({ key: string } & TConfig) | EmptyFeatureRemoteConfig>;
   track(): Promise<Response | undefined> | undefined;
   requestFeedback: (opts: RequestFeatureFeedbackOptions) => void;
 }