From f04de7f05aeef9ba5f4d4a921195d133f156c59c Mon Sep 17 00:00:00 2001
From: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com>
Date: Tue, 8 Oct 2024 15:53:29 -0700
Subject: [PATCH 1/3] chore: Prepare for browser client releases.

---
 .github/workflows/release-please.yml      | 22 ++++++++
 .release-please-manifest.json             |  3 +-
 packages/sdk/browser/README.md            |  5 +-
 packages/sdk/browser/src/BrowserClient.ts | 13 +++--
 packages/sdk/browser/src/index.ts         | 65 ++++++++++++++++++++++-
 release-please-config.json                |  3 +-
 6 files changed, 102 insertions(+), 9 deletions(-)

diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
index 08f1798d68..8c799cef53 100644
--- a/.github/workflows/release-please.yml
+++ b/.github/workflows/release-please.yml
@@ -24,6 +24,7 @@ jobs:
       package-node-server-sdk-otel-release: ${{ steps.release.outputs['packages/telemetry/node-server-sdk-otel--release_created'] }}
       package-tooling-jest-release: ${{ steps.release.outputs['packages/tooling/jest--release_created'] }}
       package-react-universal-release: ${{ steps.release.outputs['packages/sdk/react-universal--release_created'] }}
+      package-browser-released: ${{ steps.release.outputs['packages/sdk/browser--release_created'] }}
     steps:
       - uses: googleapis/release-please-action@v4
         id: release
@@ -170,6 +171,27 @@ jobs:
           workspace_path: packages/sdk/react-native
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
 
+  release-browser:
+    runs-on: ubuntu-latest
+    needs: ['release-please', 'release-sdk-client']
+    permissions:
+      id-token: write
+      contents: write
+    if: ${{ always() && !failure() && !cancelled() && needs.release-please.outputs.package-browser-released == 'true'}}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          registry-url: 'https://registry.npmjs.org'
+      - id: release-react-native
+        name: Full release of packages/sdk/browser
+        uses: ./actions/full-release
+        with:
+          workspace_path: packages/sdk/browser
+          aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
+
+
   release-server-node:
     runs-on: ubuntu-latest
     needs: ['release-please', 'release-sdk-server']
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
index d72084814b..562e475e0e 100644
--- a/.release-please-manifest.json
+++ b/.release-please-manifest.json
@@ -12,5 +12,6 @@
   "packages/store/node-server-sdk-redis": "4.1.22",
   "packages/shared/sdk-client": "1.8.0",
   "packages/sdk/react-native": "10.7.0",
-  "packages/telemetry/node-server-sdk-otel": "1.0.14"
+  "packages/telemetry/node-server-sdk-otel": "1.0.14",
+  "packages/sdk/browser": "0.0.0"
 }
diff --git a/packages/sdk/browser/README.md b/packages/sdk/browser/README.md
index d171ca1d92..bb6bc6e99f 100644
--- a/packages/sdk/browser/README.md
+++ b/packages/sdk/browser/README.md
@@ -8,8 +8,11 @@
 [![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link]
 -->
 
+# ⛔️⛔️⛔️⛔️
 > [!CAUTION]
-> This library is a beta version and should not be considered ready for production use while this message is visible.
+> This library is a alpha version and should not be considered ready for production use while this message is visible.
+
+# ☝️☝️☝️☝️☝️☝️
 
 <!--
 ## Install
diff --git a/packages/sdk/browser/src/BrowserClient.ts b/packages/sdk/browser/src/BrowserClient.ts
index 43ec5eb884..11b4c886ed 100644
--- a/packages/sdk/browser/src/BrowserClient.ts
+++ b/packages/sdk/browser/src/BrowserClient.ts
@@ -31,16 +31,19 @@ import BrowserPlatform from './platform/BrowserPlatform';
  * Applications should configure the client at page load time and reuse the same instance.
  *
  * For more information, see the [SDK Reference Guide](https://docs.launchdarkly.com/sdk/client-side/javascript).
- *
- * @ignore Implementation Note: We are not supporting dynamically setting the connection mode on the LDClient.
- * @ignore Implementation Note: The SDK does not support offline mode. Instead bootstrap data can be used.
- * @ignore Implementation Note: The browser SDK has different identify options, so omits the base implementation
- * @ignore from the interface.
  */
 export type LDClient = Omit<
   CommonClient,
   'setConnectionMode' | 'getConnectionMode' | 'getOffline' | 'identify'
 > & {
+  /**
+   * @ignore
+   * Implementation Note: We are not supporting dynamically setting the connection mode on the LDClient.
+   * Implementation Note: The SDK does not support offline mode. Instead bootstrap data can be used.
+   * Implementation Note: The browser SDK has different identify options, so omits the base implementation
+   * from the interface.
+   */
+
   /**
    * Specifies whether or not to open a streaming connection to LaunchDarkly for live flag updates.
    *
diff --git a/packages/sdk/browser/src/index.ts b/packages/sdk/browser/src/index.ts
index b90c3a2eb5..be8b10b080 100644
--- a/packages/sdk/browser/src/index.ts
+++ b/packages/sdk/browser/src/index.ts
@@ -1,5 +1,18 @@
+/**
+ * This is the API reference for the LaunchDarkly Client-Side SDK for JavaScript.
+ *
+ * This SDK is intended for use in browser environments.
+ *
+ * In typical usage, you will call {@link initialize} once at startup time to obtain an instance of
+ * {@link LDClient}, which provides access to all of the SDK's functionality.
+ *
+ * For more information, see the SDK reference guide.
+ *
+ * @packageDocumentation
+ */
 import {
   AutoEnvAttributes,
+  BasicLogger,
   EvaluationSeriesContext,
   EvaluationSeriesData,
   Hook,
@@ -52,7 +65,57 @@ export type {
   IdentifySeriesStatus,
 };
 
-export function init(clientSideId: string, options?: LDOptions): LDClient {
+/**
+ * Creates an instance of the LaunchDarkly client.
+ *
+ * The client will begin attempting to connect to LaunchDarkly as soon as it is created. To
+ * determine when it is ready to use, call [[LDClient.waitForInitialization]], or register an
+ * event listener for the `"ready"` event using [[LDClient.on]].
+ *
+ * Usage:
+ * ```
+ * import { initialize } from 'launchdarkly-js-client-sdk';
+ * const client = initialize(envKey, context, options);
+ * ```
+ *
+ * @param clientSideId
+ *   The client-side id, also known as the environment ID.
+ * @param options
+ *   Optional configuration settings.
+ * @return
+ *   The new client instance.
+ */
+export function initialize(clientSideId: string, options?: LDOptions): LDClient {
   // AutoEnvAttributes are not supported yet in the browser SDK.
   return new BrowserClient(clientSideId, AutoEnvAttributes.Disabled, options);
 }
+
+/**
+ * Provides a simple {@link LDLogger} implementation.
+ *
+ * This logging implementation uses a simple format that includes only the log level
+ * and the message text. By default, output is written to `console` methods (`console.info`
+ * for normal informational messages, `console.warn` for warnings, `console.error` for
+ * errors, and `console.log` for debug output) and the default minimum level is `info`
+ * (that is, debug output is suppressed). You can filter by log level or change the output
+ * destination with [[BasicLoggerOptions]].
+ *
+ * To use the logger created by this function, put it into [[LDOptions.logger]]. If
+ * you do not set [[LDOptions.logger]] to anything, the SDK uses a default logger
+ * that is equivalent to `ld.basicLogger({ level: 'info' })`.
+ *
+ * @param options Configuration for the logger. If no options are specified, the
+ *   logger uses `{ level: 'info' }`.
+ *
+ * @example
+ * This example shows how to use `basicLogger` in your SDK options to enable console
+ * logging only at `warn` and `error` levels.
+ * ```javascript
+ *   const ldOptions = {
+ *     logger: ld.basicLogger({ level: 'warn' }),
+ *   };
+ * ```
+ */
+export function basicLogger(options: BasicLoggerOptions): LDLogger {
+  return new BasicLogger(options);
+}
diff --git a/release-please-config.json b/release-please-config.json
index 9fd8fffd09..7c5c33ee76 100644
--- a/release-please-config.json
+++ b/release-please-config.json
@@ -28,7 +28,8 @@
     },
     "packages/store/node-server-sdk-dynamodb": {},
     "packages/store/node-server-sdk-redis": {},
-    "packages/telemetry/node-server-sdk-otel": {}
+    "packages/telemetry/node-server-sdk-otel": {},
+    "packages/sdk/browser": {}
   },
   "plugins": [
     {

From 4f03a7643926cb3b0ec88526e2a530d045380c68 Mon Sep 17 00:00:00 2001
From: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com>
Date: Wed, 9 Oct 2024 10:32:11 -0700
Subject: [PATCH 2/3] Use correct initialization function for contract tests.

---
 .../contract-tests/entity/src/ClientEntity.ts |  5 ++-
 .../browser/contract-tests/entity/src/main.ts |  2 --
 packages/sdk/browser/src/index.ts             | 31 -------------------
 3 files changed, 2 insertions(+), 36 deletions(-)

diff --git a/packages/sdk/browser/contract-tests/entity/src/ClientEntity.ts b/packages/sdk/browser/contract-tests/entity/src/ClientEntity.ts
index d5175cd128..7e69fb857e 100644
--- a/packages/sdk/browser/contract-tests/entity/src/ClientEntity.ts
+++ b/packages/sdk/browser/contract-tests/entity/src/ClientEntity.ts
@@ -1,4 +1,4 @@
-import { init, LDClient, LDLogger, LDOptions } from '@launchdarkly/js-client-sdk';
+import { initialize, LDClient, LDLogger, LDOptions } from '@launchdarkly/js-client-sdk';
 
 import { CommandParams, CommandType, ValueType } from './CommandParams';
 import { CreateInstanceParams, SDKConfigParams } from './ConfigParams';
@@ -19,7 +19,6 @@ function makeSdkConfig(options: SDKConfigParams, tag: string) {
     withReasons: options.clientSide.evaluationReasons,
     logger: makeLogger(`${tag}.sdk`),
     // useReport: options.clientSide.useReport,
-    // sendEventsOnlyForVariation: true,
   };
 
   if (options.serviceEndpoints) {
@@ -198,7 +197,7 @@ export async function newSdkClientEntity(options: CreateInstanceParams) {
     options.configuration.clientSide?.initialUser ||
     options.configuration.clientSide?.initialContext ||
     makeDefaultInitialContext();
-  const client = init(options.configuration.credential || 'unknown-env-id', sdkConfig);
+  const client = initialize(options.configuration.credential || 'unknown-env-id', sdkConfig);
   let failed = false;
   try {
     await Promise.race([
diff --git a/packages/sdk/browser/contract-tests/entity/src/main.ts b/packages/sdk/browser/contract-tests/entity/src/main.ts
index 671ce48d48..9869306e36 100644
--- a/packages/sdk/browser/contract-tests/entity/src/main.ts
+++ b/packages/sdk/browser/contract-tests/entity/src/main.ts
@@ -2,8 +2,6 @@
 import './style.css';
 import TestHarnessWebSocket from './TestHarnessWebSocket';
 
-// const client = init('618959580d89aa15579acf1d', AutoEnvAttributes.Enabled);
-
 async function runContractTests() {
   const ws = new TestHarnessWebSocket('ws://localhost:8001');
   ws.connect();
diff --git a/packages/sdk/browser/src/index.ts b/packages/sdk/browser/src/index.ts
index be8b10b080..9d094e28b9 100644
--- a/packages/sdk/browser/src/index.ts
+++ b/packages/sdk/browser/src/index.ts
@@ -12,7 +12,6 @@
  */
 import {
   AutoEnvAttributes,
-  BasicLogger,
   EvaluationSeriesContext,
   EvaluationSeriesData,
   Hook,
@@ -89,33 +88,3 @@ export function initialize(clientSideId: string, options?: LDOptions): LDClient
   // AutoEnvAttributes are not supported yet in the browser SDK.
   return new BrowserClient(clientSideId, AutoEnvAttributes.Disabled, options);
 }
-
-/**
- * Provides a simple {@link LDLogger} implementation.
- *
- * This logging implementation uses a simple format that includes only the log level
- * and the message text. By default, output is written to `console` methods (`console.info`
- * for normal informational messages, `console.warn` for warnings, `console.error` for
- * errors, and `console.log` for debug output) and the default minimum level is `info`
- * (that is, debug output is suppressed). You can filter by log level or change the output
- * destination with [[BasicLoggerOptions]].
- *
- * To use the logger created by this function, put it into [[LDOptions.logger]]. If
- * you do not set [[LDOptions.logger]] to anything, the SDK uses a default logger
- * that is equivalent to `ld.basicLogger({ level: 'info' })`.
- *
- * @param options Configuration for the logger. If no options are specified, the
- *   logger uses `{ level: 'info' }`.
- *
- * @example
- * This example shows how to use `basicLogger` in your SDK options to enable console
- * logging only at `warn` and `error` levels.
- * ```javascript
- *   const ldOptions = {
- *     logger: ld.basicLogger({ level: 'warn' }),
- *   };
- * ```
- */
-export function basicLogger(options: BasicLoggerOptions): LDLogger {
-  return new BasicLogger(options);
-}

From f7e571d0ba536017ec72d403d08c381c127581fa Mon Sep 17 00:00:00 2001
From: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com>
Date: Wed, 9 Oct 2024 15:14:41 -0700
Subject: [PATCH 3/3] Remove incorrect comment.

---
 packages/sdk/browser/src/index.ts | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/packages/sdk/browser/src/index.ts b/packages/sdk/browser/src/index.ts
index 9d094e28b9..6fe3a53a7f 100644
--- a/packages/sdk/browser/src/index.ts
+++ b/packages/sdk/browser/src/index.ts
@@ -67,10 +67,6 @@ export type {
 /**
  * Creates an instance of the LaunchDarkly client.
  *
- * The client will begin attempting to connect to LaunchDarkly as soon as it is created. To
- * determine when it is ready to use, call [[LDClient.waitForInitialization]], or register an
- * event listener for the `"ready"` event using [[LDClient.on]].
- *
  * Usage:
  * ```
  * import { initialize } from 'launchdarkly-js-client-sdk';