# auto-config-updater

> Things on internet move fast. New versions are being deployed all the time and it is hard to keep track of them. If you have hundreds of services running and some of them requires a specific version of an API you have to either put it in a config file, or

Latest version **1.1.0** (published 2020-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install auto-config-updater
pnpm add auto-config-updater
yarn add auto-config-updater
bun add auto-config-updater
```

## 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 | 1.1.0 |
| Published | 2020-06-15 |
| First published | 2019-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jacques Sirot |
| Maintainers | samsoul007 |
| Keywords | auto, updater, config |

## Links

- npm: https://www.npmjs.com/package/auto-config-updater
- Repository: https://github.com/samsoul007/auto-config-updater
- Homepage: https://github.com/samsoul007/auto-config-updater#readme
- Issues: https://github.com/samsoul007/auto-config-updater/issues
- npm.io page: https://npm.io/package/auto-config-updater

## Dependencies (2)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.559.0
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) ^7.7.1

## Recent versions

- 1.1.0 (latest) — 2020-06-15
- 1.0.0 — 2019-10-29

## README

Things on internet move fast. New versions are being deployed all the time and it is hard to keep track of them. If you have hundreds of services running and some of them requires a specific version of an API you have to either put it in a config file, or in the process ENV.

This is not optimal when new versions of your API provider are available weekly or monthly (ex: Facebook Marketing API) and that they retire the old version shortly after. How do you reliably change those versions without redeploying everything.

Well with this module you can now "listen" to changes in a remote file and act accordingly. No need to redeploy anything, just make sure to update your code to handle the changes. It can be in auth keys or versions or whatever you see fit.

# installation

`npm install --save auto-config-updater`

# usage

## before you start

This module only currently supports JSON data. Upon being received the JSON object will be flattened:

```javascript
//If you have this file
{
  "test": 123,
  "val": {
    "a": "value"
  }
}

//It will be converted to
{
  "test":123,
  "val.a": "value"
}
```

When you setup the handler you need to do it on the flat key (ex: if you want to get the `a` value when you need to enter `val.a`)

## setting up a configuration

This module allows multiple variable files to be loaded.


### Amazon S3

```javascript
const CU = require("auto-config-updater")
const AWS = require("aws-sdk");
//setup your AWS SDK
AWS.config.update({...});

/**
 * @param {object}  s3_object AWS s3 object (new AWS.S3()).
 * @param {string}  bucket Name of S3 bucket.
 * @param {string}  key path to file in S3 bucket.
 * @param {integer} [refresh=60000] refresh time to look in ms.
 * @param {string}  [config='default'] name of the config
 */
CU.config.fromS3(new AWS.S3(), "mybucket", "mykey", 5000, "my-versions")
```

### ElasticSearch

```javascript
const CU = require("auto-config-updater")
const { Client } = require('@elastic/elasticsearch')
//setup your ElasticSearch client
const client = new Client({ node: '...:9200' });

/**
 * @param {object}  client ElasticSearch client.
 * @param {string}  index Index in ElasticSearch.
 * @param {string}  type Type in index.
 * @param {string}  id Id in index and type.
 * @param {integer} [refresh=60000] refresh time to look in ms.
 * @param {string}  [config='default'] name of the config
 */

CU.config.fromES(client, "index", "type", "id", 5000, "my-versions")
```

## Value change handler

When a value has changed this handler will be triggered. You can add as many handlers as you want on each key

```javascript
const CU = require("auto-config-updater")

/**
 * @param {string}    key Key to check on the value of the file.
 * @param {function}  handler Callback function for the handler.
 * @param {string}    [config='default'] name of the config
 */
CU.handler.onChange("key",handler, config)

CU.handler.onChange("version",(value, key) => {
  console.log("the value has changed:", value, key)
},"my-versions")
```

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