@launchdarkly/cloudflare-server-sdk 2.4.1 → 2.5.0

package/CHANGELOG.md

@@ -15,6 +15,26 @@ All notable changes to the LaunchDarkly SDK for Cloudflare Workers will be docum
   * devDependencies
     * @launchdarkly/js-server-sdk-common-edge bumped from 2.1.1 to 2.1.2
 
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @launchdarkly/js-server-sdk-common-edge bumped from 2.2.1 to 2.2.2
+
+## [2.5.0](https://github.com/launchdarkly/js-core/compare/cloudflare-server-sdk-v2.4.2...cloudflare-server-sdk-v2.5.0) (2024-04-09)
+
+
+### Features
+
+* JSR support for Cloudflare SDK. ([#415](https://github.com/launchdarkly/js-core/issues/415)) ([30866f3](https://github.com/launchdarkly/js-core/commit/30866f34a41b74e2cf08457f2382c647bc37bd64))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @launchdarkly/js-server-sdk-common-edge bumped from 2.2.2 to 2.2.3
+
 ## [2.4.1](https://github.com/launchdarkly/js-core/compare/cloudflare-server-sdk-v2.4.0...cloudflare-server-sdk-v2.4.1) (2024-03-15)
 
 

package/README.md

@@ -15,7 +15,14 @@ For more information, see the [complete reference guide for this SDK](https://do
 ## Install
 
 ```shell
+# npm
 npm i @launchdarkly/cloudflare-server-sdk
+
+# yarn
+yarn add @launchdarkly/cloudflare-server-sdk
+
+# jsr
+npx jsr add @launchdarkly/cloudflare-server-sdk
 ```
 
 Then turn on the Node.js compatibility flag in your `wrangler.toml`. This allows the SDK to use `node:events`:
@@ -24,6 +31,10 @@ Then turn on the Node.js compatibility flag in your `wrangler.toml`. This allows
 compatibility_flags = [ "nodejs_compat" ]
 ```
 
+## Additional JSR setup
+
+If you want to install this package as a JSR package, you will need to use [`esbuild` version >= 19.7](https://github.com/evanw/esbuild/releases/tag/v0.19.7) to enable support for `import attributes`.
+
 ## Quickstart
 
 Initialize the ldClient with your client side sdk key and the [Cloudflare KV namespace](https://developers.cloudflare.com/workers/runtime-apis/kv#kv-bindings):
@@ -33,12 +44,12 @@ import { init as initLD } from '@launchdarkly/cloudflare-server-sdk';
 
 export default {
   async fetch(request: Request, env: Bindings): Promise<Response> {
-    const sdkKey = 'test-sdk-key';
+    const clientSideID = 'test-client-side-id';
     const flagKey = 'testFlag1';
     const context = { kind: 'user', key: 'test-user-key-1' };
 
     // init the ldClient, wait and finally evaluate
-    const client = initLD(sdkKey, env.LD_KV);
+    const client = initLD(clientSideID, env.LD_KV);
     await client.waitForInitialization();
     const flagValue = await client.variation(flagKey, context, false);
 
@@ -69,7 +80,8 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply
   - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
   - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
   - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
-  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). 
+  - Disable parts of your application to facilitate maintenance, without taking everything offline.
 - LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
 - Explore LaunchDarkly
   - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information