.github/workflows/release.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: New version semver
+        description: New version semver (e.g. 3.7.0)
         required: true
         type: string
       tag:
@@ -15,10 +15,11 @@ on:
 
 jobs:
   from-template:
-    uses: Unleash/.github/.github/workflows/npm-release.yml@v1.1.0
+    uses: Unleash/.github/.github/workflows/npm-release.yml@v2.0.0
     with:
       version: ${{ github.event.inputs.version }}
       tag: ${{ github.event.inputs.tag }}
     secrets:
-      GH_ACCESS_TOKEN: ${{ secrets.GH_TOKEN }}
       NPM_ACCESS_TOKEN: ${{ secrets.NPM_TOKEN }}
+      UNLEASH_BOT_APP_ID: ${{ secrets.UNLEASH_BOT_APP_ID }}
+      UNLEASH_BOT_PRIVATE_KEY: ${{ secrets.UNLEASH_BOT_PRIVATE_KEY }}

.gitignore

@@ -3,3 +3,4 @@ node_modules/
 .vscode/
 coverage/
 .idea
+.DS_Store

README.md

@@ -1,15 +1,14 @@
 # Unleash Proxy Client for the browser (JS)
 
-The JavaScript proxy client is a tiny Unleash client written in JavaScript without any external dependencies (except from browser APIs). This client stores toggles relevant for the current user in `localStorage` and synchronizes with Unleash (the [Unleash front-end API](https://docs.getunleash.io/reference/front-end-api) _or_ the [Unleash proxy](https://docs.getunleash.io/reference/unleash-proxy)) in the background. Because toggles are stored in the user's browser, the client can use them to bootstrap itself the next time the user visits the same web page.
+The JavaScript client is a tiny Unleash client written in JavaScript without any external dependencies (except from browser APIs). This client stores toggles relevant for the current user in `localStorage` and synchronizes with Unleash (the [Unleash front-end API](https://docs.getunleash.io/reference/front-end-api) _or_ [Unleash edge](https://docs.getunleash.io/reference/unleash-edge)) in the background. Because toggles are stored in the user's browser, the client can use them to bootstrap itself the next time the user visits the same web page.
 
-This client expect `fetch` to be available. If you need to support older
-browsers you should probably use the [fetch polyfill](https://github.com/github/fetch). 
+This client expect `fetch` to be available. 
 
 ## Frameworks supported
 
 This package is not tied to any framework, but can be used together most popular frameworks, examples:
 
-- [Unleash React SDK](https://docs.getunleash.io/sdks/proxy-react)
+- [Unleash React SDK](https://docs.getunleash.io/reference/sdks/react)
 - [React](https://reactjs.org/)
 - [React Native](https://reactnative.dev/) 
 - [Angular JS](https://angularjs.org/)
@@ -28,7 +27,7 @@ npm install unleash-proxy-client
 
 ---
 
-💡 **TIP**: As a client-side SDK, this SDK requires you to connect to either an Unleash proxy or to the Unleash front-end API. Refer to the [connection options section](#connection-options) for more information.
+💡 **TIP**: As a client-side SDK, this SDK requires you to connect to either Unleash Edge or to the Unleash front-end API. Refer to the [connection options section](#connection-options) for more information.
 
 ---
 
@@ -51,18 +50,18 @@ unleash.start();
 
 To connect this SDK to your Unleash instance's [front-end API](https://docs.getunleash.io/reference/front-end-api), use the URL to your Unleash instance's front-end API (`<unleash-url>/api/frontend`) as the `url` parameter. For the `clientKey` parameter, use a `FRONTEND` token generated from your Unleash instance. Refer to the [_how to create API tokens_](https://docs.getunleash.io/how-to/how-to-create-api-tokens) guide for the necessary steps.
 
-To connect this SDK to the [Unleash proxy](https://docs.getunleash.io/reference/unleash-proxy), use the proxy's URL and a [proxy client key](https://docs.getunleash.io/reference/api-tokens-and-client-keys#proxy-client-keys). The [_configuration_ section of the Unleash proxy docs](https://docs.getunleash.io/reference/unleash-proxy#configuration) contains more info on how to configure client keys for your proxy.
+This SDK can also be used with [Unleash Edge](https://docs.getunleash.io/reference/unleash-edge).
 
 ### Step 3: Let the client synchronize
 
 You should wait for the client's `ready` or `initialized` events before you start working with it. Before it's ready, the client might not report the correct state for your features.
 
 ```js
 unleash.on('ready', () => {
-    if (unleash.isEnabled('proxy.demo')) {
-        console.log('proxy.demo is enabled');
+    if (unleash.isEnabled('js.demo')) {
+        console.log('js.demo is enabled');
     } else {
-        console.log('proxy.demo is disabled');
+        console.log('js.demo is disabled');
     }
 });
 ```
@@ -74,7 +73,7 @@ The difference between the events is described in the [section on available even
 Once the client is ready, you can start checking features in your application. Use the `isEnabled` method to check the state of any feature you want:
 
 ```js
-unleash.isEnabled('proxy.demo');
+unleash.isEnabled('js.demo');
 ```
 
 You can use the `getVariant` method to get the variant of an **enabled feature that has variants**. If the feature is disabled or if it has no variants, then you will get back the [**disabled variant**](https://docs.getunleash.io/reference/feature-toggle-variants#the-disabled-variant)
@@ -117,26 +116,26 @@ The Unleash SDK takes the following options:
 
 | option            | required | default | description                                                                                                                                      |
 |-------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------|
-| url               | yes | n/a | The Unleash Proxy URL to connect to. E.g.: `https://examples.com/proxy`                                                                         |
-| clientKey         | yes | n/a | The Unleash Proxy Secret to be used                                                                                                             | 
-| appName           | yes | n/a | The name of the application using this SDK. Will be used as part of the metrics sent to Unleash Proxy. Will also be part of the Unleash Context. | 
+| url               | yes | n/a | The Unleash URL to connect to. E.g.: `https://examples.com/api/front-end`                                                                         |
+| clientKey         | yes | n/a | The Unleash API Secret to be used                                                                                                             | 
+| appName           | yes | n/a | The name of the application using this SDK. Will be used as part of the metrics sent to Unleash. Will also be part of the Unleash Context. | 
 | context           | no | `{}` | The initial Unleash context. This will be used as the initial context for all feature toggle evaluations. The `appName` and `environment` options will automatically be populated with the values you pass for those options. |
 | refreshInterval   | no | `30` | How often, in seconds, the SDK should check for updated toggle configuration. If set to 0 will disable checking for updates                 |
 | disableRefresh    | no | `false` | If set to true, the client will not check for updated toggle configuration                                                                |
-| metricsInterval   | no | `60` | How often, in seconds, the SDK should send usage metrics back to Unleash Proxy. It will be started after the initial metrics report, which is sent after the configured `metricsIntervalInitial` | 
+| metricsInterval   | no | `60` | How often, in seconds, the SDK should send usage metrics back to Unleash. It will be started after the initial metrics report, which is sent after the configured `metricsIntervalInitial` | 
 | metricsIntervalInitial | no | `2` | How long the SDK should wait for the first metrics report back to the Unleash API. If you want to disable the initial metrics call you can set it to 0. | 
 | disableMetrics    | no | `false` | Set this option to `true` if you want to disable usage metrics                                                                           |
 | storageProvider   | no | `LocalStorageProvider` in browser, `InMemoryStorageProvider` otherwise | Allows you to inject a custom storeProvider                                                                              |
 | fetch | no | `window.fetch` or global `fetch` | Allows you to override the fetch implementation to use. Useful in Node.js environments where you can inject `node-fetch` |
 | createAbortController | no | `() => new AbortController()` | Allows you to override the default `AbortController` creation. Used to cancel requests with outdated context. Set it to `() => null` if you don't want to handle it. | 
 | bootstrap         | no | `[]` | Allows you to bootstrap the cached feature toggle configuration.                                                                               | 
 | bootstrapOverride | no| `true` | Should the bootstrap automatically override cached data in the local-storage. Will only be used if bootstrap is not an empty array.     | 
-| headerName        | no| `Authorization` | Which header the SDK should use to authorize with Unleash / Unleash Proxy. The header will be given the `clientKey` as its value. |
-| customHeaders     | no| `{}` | Additional headers to use when making HTTP requests to the Unleash proxy. In case of name collisions with the default headers, the `customHeaders` value will be used if it is not `null` or `undefined`. `customHeaders` values that are `null` or `undefined` will be ignored. |
+| headerName        | no| `Authorization` | Which header the SDK should use to authorize with Unleash / Unleash Edge. The header will be given the `clientKey` as its value. |
+| customHeaders     | no| `{}` | Additional headers to use when making HTTP requests to Unleash. In case of name collisions with the default headers, the `customHeaders` value will be used if it is not `null` or `undefined`. `customHeaders` values that are `null` or `undefined` will be ignored. |
 | impressionDataAll | no| `false` | Allows you to trigger "impression" events for **all** `getToggle` and `getVariant` invocations. This is particularly useful for "disabled" feature toggles that are not visible to frontend SDKs. |
 | environment | no | `default` | Sets the `environment` option of the [Unleash context](https://docs.getunleash.io/reference/unleash-context). This does **not** affect the SDK's [Unleash environment](https://docs.getunleash.io/reference/environments). |
 | usePOSTrequests | no | `false` | Configures the client to use POST requests instead of GET when requesting enabled features. This is helpful when sensitive information (like user email, when used as a user ID) is passed in the context to avoid leaking it in the URL. NOTE: Post requests are not supported by the frontend api built into Unleash. |
-
+| experimental | no | `{}` | Enabling optional experimentation. `togglesStorageTTL` : How long (Time To Live), in seconds, the toggles in storage are considered valid and should not be fetched on start. If set to 0 will disable expiration checking and will be considered always expired.                 |
 
 ### Listen for updates via the EventEmitter
 
@@ -145,7 +144,7 @@ This is a neat way to update a single page app when toggle state updates.
 
 ```js
 unleash.on('update', () => {
-    const myToggle = unleash.isEnabled('proxy.demo');
+    const myToggle = unleash.isEnabled('js.demo');
     //do something useful
 });
 ```
@@ -155,7 +154,7 @@ unleash.on('update', () => {
 - **error** - emitted when an error occurs on init, or when fetch function fails, or when fetch receives a non-ok response object. The error object is sent as payload.
 - **initialized** - emitted after the SDK has read local cached data in the storageProvider. 
 - **ready** - emitted after the SDK has successfully started and performed the initial fetch of flags via the network (Edge, proxy, or front-end API). When bootstrapping, the client can emit this event twice: once when the bootstrapped flags are loaded, and once on first successful connection to Unleash.
-- **update** - emitted every time the Unleash Proxy return a new feature toggle configuration. The SDK will emit this event as part of the initial fetch from the SDK.  
+- **update** - emitted every time Unleash returns a new feature toggle configuration. The SDK will emit this event as part of the initial fetch from the SDK.  
 - **recovered** - emitted when the SDK has recovered from an error. This event will only be emitted if the SDK has previously emitted an error.
 - **sent** - emitted when the SDK has successfully sent metrics to Unleash.
 
@@ -293,3 +292,9 @@ const unleash = new UnleashClient({
 **NOTES: ⚠️**
 If `bootstrapOverride` is `true` (by default), any local cached data will be overridden with the bootstrap specified.   
 If `bootstrapOverride` is `false` any local cached data will not be overridden unless the local cache is empty.
+
+## Manage your own refresh mechanism
+
+You can opt out of the Unleash feature flag auto-refresh mechanism and metrics update by settings the `refreshInterval` and/or `metricsInterval` options to `0`. 
+In this case, it becomes your responsibility to call `updateToggles` and/or `sendMetrics` methods.
+This approach is useful in environments that do not support the `setInterval` API, such as service workers.

examples/README.md

@@ -1,3 +1,3 @@
 ## Examples
 
-Moved to [unleash-sdk-examples](https://github.com/Unleash/unleash-sdk-examples/tree/main/JavaScript%20Proxy%20SDK)
+Moved to [unleash-sdk-examples](https://github.com/Unleash/unleash-sdk-examples/tree/main/JavaScript)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "unleash-proxy-client",
-  "version": "3.5.1",
-  "description": "A browser client that can be used together with the unleash-proxy.",
+  "version": "3.7.3",
+  "description": "A browser client that can be used together with Unleash Edge or the Unleash Frontend API.",
   "type": "module",
   "main": "./build/index.cjs",
   "types": "./build/cjs/index.d.ts",
@@ -46,6 +46,7 @@
     "@babel/runtime": "^7.23.1",
     "@rollup/plugin-commonjs": "^25.0.5",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^6.0.2",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.5",
     "@types/jest": "^29.5.5",
@@ -86,5 +87,6 @@
     "rules": {
       "@typescript-eslint/no-explicit-any": "off"
     }
-  }
+  },
+  "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
 }

rollup.config.mjs

@@ -3,6 +3,10 @@ import nodeResolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
 import terser from '@rollup/plugin-terser';
 import nodePolyfills from 'rollup-plugin-node-polyfills';
+import replace from '@rollup/plugin-replace';
+import fs from 'fs';
+
+const version = JSON.parse(fs.readFileSync('./package.json', 'UTF-8')).version;
 
 export default {
     input: './src/index.ts',
@@ -25,6 +29,10 @@ export default {
         }
     ],
     plugins: [
+        replace({
+            '__VERSION__': version,
+            preventAssignment: true
+        }),
         typescript({
             compilerOptions: {
                 lib: ['es5', 'es6', 'dom'],