@launchdarkly/cloudflare-server-sdk 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to the LaunchDarkly SDK for Cloudflare Workers will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org).
 
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @launchdarkly/js-server-sdk-common-edge bumped from 0.0.2 to 0.0.3
+
+## [0.0.4](https://github.com/launchdarkly/js-core/compare/cloudflare-server-sdk-v0.0.3...cloudflare-server-sdk-v0.0.4) (2023-04-26)
+
+
+### Bug Fixes
+
+* Improve readme. ([50d8556](https://github.com/launchdarkly/js-core/commit/50d85561c5f7577e1ecdc64f919d753c5df66b39))
+
 ## [0.0.2](https://github.com/launchdarkly/js-core/compare/cloudflare-server-sdk-v0.0.1...cloudflare-server-sdk-v0.0.2) (2023-04-20)
 
 

package/README.md

@@ -2,26 +2,23 @@
 
 [![NPM][sdk-cloudflare-npm-badge]][sdk-cloudflare-npm-link]
 [![Actions Status][sdk-cloudflare-ci-badge]][sdk-cloudflare-ci]
-[![Documentation](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://launchdarkly.github.io/js-core/packages/sdk/cloudflare/docs/)
+[![Documentation][sdk-cloudflare-ghp-badge]][sdk-cloudflare-ghp-link]
+[![NPM][sdk-cloudflare-dm-badge]][sdk-cloudflare-npm-link]
+[![NPM][sdk-cloudflare-dt-badge]][sdk-cloudflare-npm-link]
 
-This library supports using Cloudflare [Workers KV](https://developers.cloudflare.com/workers/learning/how-kv-works) to replace the default in-memory feature store of the [LaunchDarkly Node.js SDK](https://github.com/launchdarkly/cloudflare-server-sdk).
+The LaunchDarkly Cloudflare SDK is designed primarily for use in multi-user Cloudflare workers. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
 
-For more information, see the [SDK features guide](https://docs.launchdarkly.com/sdk/features/storing-data).
+For more information, see the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/cloudflare).
 
-## Installation
+This SDK is a beta version and should not be considered ready for production use while this message is visible.
 
-```shell
-npm i @launchdarkly/cloudflare-server-sdk
-```
-
-or yarn:
+## Install
 
 ```shell
-yarn add @launchdarkly/cloudflare-server-sdk
+npm i @launchdarkly/cloudflare-server-sdk
 ```
 
-In `wrangler.toml` in your worker project turn on the Node.js compatibility flag.
-This allows the SDK to use `node:events`:
+Then turn on the Node.js compatibility flag in your `wrangler.toml`. This allows the SDK to use `node:events`:
 
 ```toml
 compatibility_flags = [ "nodejs_compat" ]
@@ -29,15 +26,30 @@ compatibility_flags = [ "nodejs_compat" ]
 
 ## Quickstart
 
-Initialize the ldClient with the [Cloudflare KV namespace](https://developers.cloudflare.com/workers/runtime-apis/kv#kv-bindings) and your client side sdk key:
+Initialize the ldClient with your client side sdk key and the [Cloudflare KV namespace](https://developers.cloudflare.com/workers/runtime-apis/kv#kv-bindings):
 
 ```typescript
-import { init } from '@launchdarkly/cloudflare-server-sdk';
-
-const ldClient = init(KV_NAMESPACE, 'YOUR CLIENT-SIDE SDK KEY');
+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 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);
+    await client.waitForInitialization();
+    const flagValue = await client.variation(flagKey, context, false);
+
+    return new Response(`${flagKey}: ${flagValue}`);
+  },
+};
 ```
 
-To learn more, head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/cloudflare).
+See the full [example app](https://github.com/launchdarkly/js-core/tree/main/packages/sdk/cloudflare/example).
+
+Read the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/cloudflare).
 
 ## Developing this SDK
 
@@ -67,3 +79,7 @@ yarn test
 [sdk-cloudflare-ci]: https://github.com/launchdarkly/js-core/actions/workflows/cloudflare.yml
 [sdk-cloudflare-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/cloudflare-server-sdk.svg?style=flat-square
 [sdk-cloudflare-npm-link]: https://www.npmjs.com/package/@launchdarkly/cloudflare-server-sdk
+[sdk-cloudflare-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
+[sdk-cloudflare-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/cloudflare/docs/
+[sdk-cloudflare-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/cloudflare-server-sdk.svg?style=flat-square
+[sdk-cloudflare-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/cloudflare-server-sdk.svg?style=flat-square

package/dist/cjs/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@launchdarkly/cloudflare-server-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "commonjs"
 }

package/dist/esm/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@launchdarkly/cloudflare-server-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/cloudflare-server-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Cloudflare LaunchDarkly SDK",
   "packageManager": "yarn@3.4.1",
   "keywords": [
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "@cloudflare/workers-types": "^4.20230321.0",
-    "@launchdarkly/js-server-sdk-common-edge": "0.0.2",
+    "@launchdarkly/js-server-sdk-common-edge": "0.0.3",
     "crypto-js": "^4.1.1"
   },
   "devDependencies": {