# ember-config-cat

> Ember addon to wrap a ConfigCat client.

Latest version **2.0.0** (published 2022-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-config-cat
pnpm add ember-config-cat
yarn add ember-config-cat
bun add ember-config-cat
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-07-20 |
| First published | 2021-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 12.* \|\| 14.* \|\| >= 16 |
| Dependencies | 7 |
| Unpacked size | 26.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | gabriel_cousin |
| Keywords | ember-addon, config-cat |

## Links

- npm: https://www.npmjs.com/package/ember-config-cat
- Repository: https://github.com/MakeMusicInc/ember-config-cat
- Homepage: https://github.com/MakeMusicInc/ember-config-cat#readme
- Issues: https://github.com/MakeMusicInc/ember-config-cat/issues
- npm.io page: https://npm.io/package/ember-config-cat

## Dependencies (7)

- [webpack](https://npm.io/package/webpack.md) ^5.65.0
- [configcat-js](https://npm.io/package/configcat-js.md) ^6.0.0
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^7.26.11
- [configcat-common](https://npm.io/package/configcat-common.md) ^6.0.0
- [ember-auto-import](https://npm.io/package/ember-auto-import.md) ^2.4.0
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^6.0.1
- [ember-cli-typescript](https://npm.io/package/ember-cli-typescript.md) ^5.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2022-07-20
- 1.1.0 — 2022-04-28
- 1.0.0 — 2022-02-22
- 0.1.2 — 2021-10-01
- 0.1.1 — 2021-09-30
- 0.1.0 — 2021-05-10
- 0.1.0-beta.2 — 2021-05-07
- 0.1.0-beta.1 — 2021-05-07

## README

# ember-config-cat

![Build](https://github.com/MakeMusicInc/ember-config-cat/actions/workflows/ci.yml/badge.svg?branch=main)

This addon includes a service which wraps a [ConfigCat](https://configcat.com/) client and aims at easing any feature flagging in your applications.

## Compatibility

- Ember.js v3.24 or above
- Ember CLI v3.24 or above
- Node.js v12 or above

## Installation

```
ember install ember-config-cat
```

## Usage

### Options

```js
# environment.js

module.exports = function (environment) {
  let ENV = {
    emberConfigCat: {
      // your options goes here
    }
  };
};
```

| Option                   | Default      | Description                                                             | Links                                                                  |
| ------------------------ | ------------ | ----------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `mode`                   | `'auto'`     | Polling mode: `'auto'`/`'lazy'`/`'manual'`                              | [🔗](https://configcat.com/docs/sdk-reference/js#polling-modes)        |
| `local`                  | `false`      | Enabling local mode: will only use default flag values                  | -                                                                      |
| `flags`                  | -            | Default values for feature-flags                                        | -                                                                      |
| `sdkKey`                 | –            | Your SDK Key                                                            | [🔗](https://app.configcat.com/sdkkey)                                 |
| `requestTimeoutMs`       | `30000`      | Amount of time the SDK waits before returning cached values             | [🔗](https://configcat.com/docs/sdk-reference/js#auto-polling-default) |
| `maxInitWaitTimeSeconds` | `5`          | Maximum waiting time between client init and config fetch               | [🔗](https://configcat.com/docs/sdk-reference/js#auto-polling-default) |
| `pollIntervalSeconds`    | `60`         | Polling interval                                                        | [🔗](https://configcat.com/docs/sdk-reference/js#auto-polling-default) |
| `cacheTimeToLiveSeconds` | `60`         | Cache TTL                                                               | [🔗](https://configcat.com/docs/sdk-reference/js#lazy-loading)         |
| `dataGovernance`         | `0` (Global) | Determine the CDN location of the data: `0` for Global / `1` for EuOnly | [🔗](https://configcat.com/docs/advanced/data-governance)              |
| `logLevel`               | -            | Set a custom log level                                                  | [🔗](https://configcat.com/docs/sdk-reference/js/#logging)             |

- `requestTimeoutMs` and `dataGovernance` are common polling options to the three available modes
- All default values except `mode`, `local` and `autoStart` are defined in the ConfigCat SDK
- You may define either `local` or `sdkKey` but the addon will fallback to `local` mode if no `sdkKey` is provided.

### Content Security Policy (CSP)

If your app is using [ember-cli-content-security-policy](https://github.com/rwjblue/ember-cli-content-security-policy), you may need to add this into `environment.js` to allow ConfigCat requests.

```js
module.exports = function (environment) {
  let ENV = {
    contentSecurityPolicy: {
      'connect-src': ['https://cdn-global.configcat.com'],
    },
  };
};
```

### Initializing the client

#### Without user identification

```js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class WhateverRoute extends Route {
  @service configCat;

  beforeModel() {
    return this.configCat.initClient();
  }
}
```

#### With user identification

A ConfigCat user object is made of four properties (identifier, email, country and custom): [structure](https://configcat.com/docs/advanced/user-object#user-objects-structure)
Calling `.identifyUser()` will initialize the client if needed.

```js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class WhateverRoute extends Route {
  @service configCat;

  async model() {
    const user = this.authenticate();
    await this.configCat.identifyUser({
      identifier: user.id,
      email: user.email,
    });
  }
}
```

### Using feature-flag values

```js
import Component from '@glimmer/component';
import { inject as service } from '@ember/service';

export default class WhateverComponent extends Component {
  @service configCat;

  get isEnabled() {
    return this.configCat.flags.isAwesomeFeatureEnabled;
  }
}
```

```hbs
{{#if this.isEnabled}}
  Enabled
{{else}}
  Disabled
{{/if}}
```

### Template helpers

| Name              | Parameters | Description                                                   |
| ----------------- | ---------- | ------------------------------------------------------------- |
| `is-flag-enabled` | key        | Checks if the flag is enabled                                 |
| `get-flag-value`  | key        | Gets the current flag value                                   |
| `has-flag-value`  | key, value | Compares the current flag value against a provided parameters |

### Clearing data

```js
import Component from '@glimmer/component';
import { inject as service } from '@ember/service';
import { action } from '@ember/object';

export default class WhateverComponent extends Component {
  @service configCat;

  @action onClear() {
    this.configCat.dispose();
  }
}
```

### Public methods and properties

| Name           | Type             | Description                                         |
| -------------- | ---------------- | --------------------------------------------------- |
| `flags`        | tracked property | Returns available feature-flags and values          |
| `identifyUser` | method           | Identifies user and update feature-flags values     |
| `update`       | method           | Updates feature-flags values                        |
| `dispose`      | method           | Releases everything related to the ConfigCat client |

## Testing

`ember-config-cat` comes with a couple of test-helpers:

```js
// ...
import { setupConfigCat, TestContext } from 'ember-config-cat/test-support';

module('...', function (hooks) {
  // ...
  setupConfigCat(hooks);

  test('...', async function (this: TestContext, assert) {
    // configuring one flag
    this.withFlag('featureA', true);

    // configuring several flags
    this.withFlags({ featureB: true, pricing: 10 });

    // ...
  });
});
```

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.

## References

We draw our inspiration from the `ember-launch-darkly` [addon](https://github.com/adopted-ember-addons/ember-launch-darkly)

## Docs

- [ConfigCat API](https://api.configcat.com/docs)
- Using ConfigCat in JavaScript [Documentation](https://configcat.com/docs/sdk-reference/js) - [SDK](https://github.com/configcat/js-sdk)
- [Browser compatibility](https://configcat.com/docs/sdk-reference/js/#browser-compatibility)

## License

This project is licensed under the [MIT License](LICENSE.md).

---
_Source: https://npm.io/package/ember-config-cat · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._