feat!: implement config cat web provider (#918)

Signed-off-by: Lukas Reining <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: Michael Beemer <[email protected]>

Author: 3 people

libs/providers/config-cat-web/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/providers/config-cat-web/CHANGELOG.md

@@ -0,0 +1,144 @@
+# ConfigCat Web Provider
+
+This provider is an implementation for [ConfigCat](https://configcat.com) a managed feature flag service.
+
+## Installation
+
+```
+$ npm install @openfeature/config-cat-web-provider
+```
+
+#### Required peer dependencies
+
+The OpenFeature SDK is required as peer dependency.
+
+The minimum required version of `@openfeature/web-sdk` currently is `1.0.0`.
+
+The minimum required version of `configcat-js-ssr` currently is `7.1.2`.
+
+```
+$ npm install @openfeature/client-sdk configcat-js-ssr
+```
+
+## Usage
+
+The ConfigCat provider uses the [ConfigCat JavaScript SSR SDK](https://configcat.com/docs/sdk-reference/js-ssr/).
+
+It can be created by passing the ConfigCat SDK options to ```ConfigCatProvider.create```.
+The available options can be found in the [ConfigCat JavaScript SSR SDK](https://configcat.com/docs/sdk-reference/js-ssr/).
+
+The ConfigCat Web Provider only supports the `AutoPolling` mode because it caches all evaluation data to support synchronous evaluation of feature flags.
+
+### Example using the default configuration
+
+```javascript
+import { ConfigCatProvider } from '@openfeature/config-cat-web-provider';
+
+const provider = ConfigCatProvider.create('<sdk_key>');
+OpenFeature.setProvider(provider);
+```
+
+### Example using different polling options and a setupHook
+
+```javascript
+import { ConfigCatProvider } from '@openfeature/config-cat-web-provider';
+
+const provider = ConfigCatProvider.create('<sdk_key>', {
+  setupHooks: (hooks) => hooks.on('clientReady', () => console.log('Client is ready!')),
+});
+
+OpenFeature.setProvider(provider);
+```
+
+## Evaluation Context
+
+The OpenFeature Evaluation Context is mapped to the [ConfigCat user object](https://configcat.com/docs/advanced/user-object/).
+
+The [ConfigCat user object](https://configcat.com/docs/advanced/user-object/) has three known attributes,
+and allows for additional attributes.
+The following shows how the attributes are mapped:
+
+| OpenFeature EvaluationContext Field | ConfigCat User Field | Required |
+|-------------------------------------|----------------------|----------|
+| targetingKey                        | identifier           | yes      |
+| email                               | email                | no       |
+| country                             | country              | no       |
+| _Any Other_                         | custom               | no       |
+
+The custom types are mapped the following way:
+
+| OpenFeature EvaluationContext Field Type | ConfigCat User Field Type |
+|------------------------------------------|---------------------------|
+| string                                   | string                    |
+| number                                   | number                    |
+| boolean                                  | string                    |
+| Array<string>                            | Array<string>             |
+| Array                                    | Array                     |
+| object                                   | string                    |
+
+The following example shows the conversion between an OpenFeature Evaluation Context and the corresponding ConfigCat
+User:
+
+#### OpenFeature
+
+```json
+{
+  "targetingKey": "test",
+  "email": "email",
+  "country": "country",
+  "customString": "customString",
+  "customNumber": 1,
+  "customBoolean": true,
+  "customObject": {
+    "prop1": "1",
+    "prop2": 2
+  },
+  "customStringArray": [
+    "one",
+    "two"
+  ],
+  "customArray": [
+    1,
+    "2",
+    false
+  ]
+}
+```
+
+#### ConfigCat
+
+```json
+{
+  "identifier": "test",
+  "email": "email",
+  "country": "country",
+  "custom": {
+    "customString": "customString",
+    "customBoolean": "true",
+    "customNumber": 1,
+    "customObject": "{\"prop1\":\"1\",\"prop2\":2}",
+    "customStringArray": [
+      "one",
+      "two"
+    ],
+    "customArray": "[1,\"2\",false]"
+  }
+}
+```
+
+## Events
+
+The ConfigCat provider emits the
+following [OpenFeature events](https://openfeature.dev/specification/types#provider-events):
+
+- PROVIDER_READY
+- PROVIDER_ERROR
+- PROVIDER_CONFIGURATION_CHANGED
+
+## Building
+
+Run `nx package providers-config-cat-web` to build the library.
+
+## Running unit tests
+
+Run `nx test providers-config-cat-web` to execute the unit tests via [Jest](https://jestjs.io).

libs/providers/config-cat-web/README.md

@@ -0,0 +1,3 @@
+{
+  "presets": [["minify", { "builtIns": false }]]
+}

libs/providers/config-cat-web/babel.config.json

@@ -0,0 +1,10 @@
+/* eslint-disable */
+export default {
+  displayName: 'providers-config-cat-web',
+  preset: '../../../jest.preset.js',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/providers/config-cat',
+};

libs/providers/config-cat-web/jest.config.ts

@@ -0,0 +1,12 @@
+{
+  "name": "@openfeature/config-cat-web-provider",
+  "version": "0.6.1",
+  "scripts": {
+    "publish-if-not-exists": "cp $NPM_CONFIG_USERCONFIG .npmrc && if [ \"$(npm show $npm_package_name@$npm_package_version version)\" = \"$(npm run current-version -s)\" ]; then echo 'already published, skipping'; else npm publish --access public; fi",
+    "current-version": "echo $npm_package_version"
+  },
+  "peerDependencies": {
+    "@openfeature/web-sdk": "^1.0.0",
+    "configcat-js-ssr": "^8.4.1"
+  }
+}