From 39bcee04e7bdbda8880f606d6890049a9ca87679 Mon Sep 17 00:00:00 2001 From: Ron Cohen Date: Thu, 27 Feb 2025 13:29:20 +0100 Subject: [PATCH 1/4] upgrading docs --- packages/browser-sdk/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/browser-sdk/README.md b/packages/browser-sdk/README.md index 80ae6d2d..558c7bd0 100644 --- a/packages/browser-sdk/README.md +++ b/packages/browser-sdk/README.md @@ -320,6 +320,11 @@ The two cookies are: - `bucket-prompt-${userId}`: store the last automated feedback prompt message ID received to avoid repeating surveys - `bucket-token-${userId}`: caching a token used to connect to Bucket's live messaging infrastructure that is used to deliver automated feedback surveys in real time. +### Upgrading to 3.0 from 2.0 + +- `client.onFeatureUpdated()` is now replaced by [event listeners](#event-listeners) +- Arguments to the `BucketClient` constructor which were previously under `featureOptions` are now supplied directly in the root. + ### TypeScript Types are bundled together with the library and exposed automatically when importing through a package manager. From 4368c4832c2516e7502827abebbe43b40aa11165 Mon Sep 17 00:00:00 2001 From: Ron Cohen Date: Thu, 27 Feb 2025 13:33:24 +0100 Subject: [PATCH 2/4] update docs --- packages/browser-sdk/src/client.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/browser-sdk/src/client.ts b/packages/browser-sdk/src/client.ts index 789b80d4..d2bc9f6f 100644 --- a/packages/browser-sdk/src/client.ts +++ b/packages/browser-sdk/src/client.ts @@ -796,8 +796,6 @@ export class BucketClient { /** * Stop the SDK. * This will stop any automated feedback surveys. - * It will also stop the features client, including removing - * any onFeaturesUpdated listeners. * **/ async stop() { From 375dad90f757f74ba6e0e7b85761598a7a67a932 Mon Sep 17 00:00:00 2001 From: Ron Cohen Date: Thu, 27 Feb 2025 13:34:38 +0100 Subject: [PATCH 3/4] docs --- packages/browser-sdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/browser-sdk/README.md b/packages/browser-sdk/README.md index 558c7bd0..5f7f82cd 100644 --- a/packages/browser-sdk/README.md +++ b/packages/browser-sdk/README.md @@ -322,7 +322,7 @@ The two cookies are: ### Upgrading to 3.0 from 2.0 -- `client.onFeatureUpdated()` is now replaced by [event listeners](#event-listeners) +- `client.onFeaturesUpdated()` is now replaced by [event listeners](#event-listeners) - Arguments to the `BucketClient` constructor which were previously under `featureOptions` are now supplied directly in the root. ### TypeScript From d826c3957e239d8acfe7a9739caef2d99abf6339 Mon Sep 17 00:00:00 2001 From: Ron Cohen Date: Thu, 27 Feb 2025 13:37:49 +0100 Subject: [PATCH 4/4] docs --- packages/browser-sdk/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/browser-sdk/README.md b/packages/browser-sdk/README.md index 5f7f82cd..a64ad6dd 100644 --- a/packages/browser-sdk/README.md +++ b/packages/browser-sdk/README.md @@ -320,7 +320,9 @@ The two cookies are: - `bucket-prompt-${userId}`: store the last automated feedback prompt message ID received to avoid repeating surveys - `bucket-token-${userId}`: caching a token used to connect to Bucket's live messaging infrastructure that is used to deliver automated feedback surveys in real time. -### Upgrading to 3.0 from 2.0 +### Upgrading to 3.0 from 2.x + +Breaking changes: - `client.onFeaturesUpdated()` is now replaced by [event listeners](#event-listeners) - Arguments to the `BucketClient` constructor which were previously under `featureOptions` are now supplied directly in the root.