added documentation, extended rather than duplicate unleash config options

Signed-off-by: jarebudev <[email protected]>

Author: jarebudev

libs/providers/unleash-web/README.md

@@ -1,15 +1,82 @@
 # unleash-web Provider
 
+## About this provider
+
+This provider is a community-developed implementation for Unleash which uses the official [Unleash Proxy Client for the browser Client Side SDK](https://docs.getunleash.io/reference/sdks/javascript-browser).
+
+This provider uses a **static evaluation context** suitable for client-side implementation.
+
+Suitable for connecting to an Unleash instance
+
+* Via the [Unleash front-end API](https://docs.getunleash.io/reference/front-end-api).
+* Via [Unleash Edge](https://docs.getunleash.io/reference/unleash-edge).
+* Via [Unleash Proxy](https://docs.getunleash.io/reference/unleash-proxy).
+
+[Gitlab Feature Flags](https://docs.gitlab.com/ee/operations/feature_flags.html) can also be used with this provider - although note that Unleash Edge is not currently supported by Gitlab.
+
+### Concepts
+* Boolean evaluation gets feature enabled status.
+* String, Number, and Object evaluation gets feature variant value.
+* Object evaluation should be used for JSON/CSV payloads in variants.
+
 ## Installation
 
+```shell
+$ npm install @openfeature/unleash-web-provider @openfeature/web-sdk
+```
+
+## Usage
+
+To initialize the OpenFeature client with Unleash, you can use the following code snippet:
+
+```ts
+import { UnleashWebProvider } from '@openfeature/unleash-web-provider';
+
+const provider = new UnleashWebProvider({
+      url: 'http://your.upstream.unleash.instance',
+      clientKey: 'theclientkey',
+      appName: 'your app',
+  });
+  
+await OpenFeature.setProviderAndWait(provider);
 ```
-$ npm install @openfeature/unleash-web-provider
+
+After the provider gets initialized, you can start evaluations of feature flags like so:
+
+```ts
+// Note - this can also be set within the contructor
+const evaluationCtx: EvaluationContext = {
+  usedId: 'theuser',
+  currentTime: 'time',
+  sessionId: 'theSessionId',
+  remoteAddress: 'theRemoteAddress',
+  environment: 'theEnvironment',
+  appName: 'theAppName',
+  aCustomProperty: 'itsValue',
+  anotherCustomProperty: 'somethingForIt',
+};
+
+// Set the static context for OpenFeature
+await OpenFeature.setContext(evaluationCtx);
+
+// Get the client 
+const client = await OpenFeature.getClient();
+
+// You can now use the client to evaluate your flags
+const details = client.getBooleanValue('my-feature', false);
 ```
+### Available Options
+
+Unleash has a variety of configuration options that can be provided to the the `UnleashWebProvider` constructor.
+
+Please refer to the options described in the official [Unleash Proxy Client for the browser Client Side SDK](https://docs.getunleash.io/reference/sdks/javascript-browser#available-options).
+
+## Contribute
 
-## Building
+### Building
 
 Run `nx package providers-unleash-web` to build the library.
 
-## Running unit tests
+### Running unit tests
 
 Run `nx test providers-unleash-web` to execute the unit tests via [Jest](https://jestjs.io).

libs/providers/unleash-web/src/lib/options.ts

@@ -0,0 +1,6 @@
+import {
+  IConfig
+} from 'unleash-proxy-client';
+
+export interface UnleashConfig extends IConfig {
+}

libs/providers/unleash-web/src/lib/unleash-web-provider-config.ts

@@ -17,9 +17,8 @@ import {
   IMutableContext
 } from 'unleash-proxy-client';
 import {
-  UnleashOptions,
-  UnleashContextOptions
-} from './options';
+  UnleashConfig
+} from './unleash-web-provider-config';
 
 export class UnleashWebProvider implements Provider {
   metadata = {
@@ -31,24 +30,17 @@ export class UnleashWebProvider implements Provider {
   // logger is the OpenFeature logger to use
   private _logger?: Logger;
 
-  // options is the Unleash options provided to the provider
-  private _options?: UnleashOptions;
+  // config is the Unleash config provided to the provider
+  private _config?: UnleashConfig;
 
   // client is the Unleash client reference
   private _client?: UnleashClient;
 
   readonly runsOn = 'client';
 
-  constructor(options: UnleashOptions, logger?: Logger) {
-    this._options = options;
+  constructor(config: UnleashConfig, logger?: Logger) {
+    this._config = config;
     this._logger = logger;
-    // TODO map all available options to unleash config - done minimum for now
-    let config : IConfig = {
-      url: options.url,
-      clientKey: options.clientKey,
-      appName: options.appName,
-      refreshInterval: options.refreshInterval,
-    };
     this._client = new UnleashClient(config);
   }
 
@@ -149,7 +141,6 @@ export class UnleashWebProvider implements Provider {
     const evaluatedVariant = this._client?.getVariant(flagKey);
     let value;
     let variant
-    this._logger?.debug("evaluatedVariant = " + JSON.stringify(evaluatedVariant));
     if (typeof evaluatedVariant === 'undefined') {
       throw new FlagNotFoundError();
     }