@un33k/ngx-cfg

An Angular Configuration Library - Handles local and remote configurations

Overview

@un33k/ngx-cfg attempts to streamline the app configuration while keeping it DRY.

How to install

npm i @un33k/ngx-cfg |OR| yarn add @un33k/ngx-cfg

How to use

// In your environment{prod,staging}.ts

import { ApplicationCfg, HttpMethod } from '@un33k/ngx-cfg';

export const environment: ApplicationCfg = {
  // production, staging or development
  production: true,
  // release version
  version: '1.0.0',
  // app name
  appName: 'WebApp'
  // one or more app specific field(s)
};

// In your app.module.ts

import { CfgModule } from '@un33k/ngx-cfg';
import { environment } from '../environments/environment';

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, CfgModule.forRoot(environment)],
  bootstrap: [AppComponent]
})
export class AppModule {}

// In your app.component.ts or (some.service.ts)

import { Component } from '@angular/core';
import { CfgService } from '@un33k/ngx-cfg';

@Component({
  selector: 'app-root'
})
export class AppComponent {
  title: string;

  constructor(public cfgService: CfgService) {
    this.title = this.cfgService.options.appName;
  }
}

Advanced usage:

• Remote configuration

@un33k/ngx-cfg can also be used to fetch remote configuration prior to start of an Angular app.

// In your environment{prod,staging}.ts

import { ApplicationCfg, HttpMethod } from '@un33k/ngx-cfg';

export const environment: ApplicationCfg = {
  // production, staging or development
  production: true,
  // release version
  version: '1.0.0',
  // app name
  appName: 'WebApp',
  // remote configuration (from the server prior to ng bootstrap)
  remoteCfg: {
    // server url to get remote config from (default = null)
    endpoint: '/api/cfg',
    // GET or POST http method to connect to remote server (default = get)
    method: HttpMethod.GET,
    // Max timeout of http connection to remote server (default = 2 seconds)
    timeout: 3,
    // http headers to include in http connection to remote server
    headers: { 'Content-Type': 'application/json' }
    // body of request when using http POST method (default = {})
    body: {
      // one or more app specific field(s)
    }
  }
  // one or more app specific field(s)
};

// In your app.module.ts

import { CfgModule } from '@un33k/ngx-cfg';
import { environment } from '../environments/environment';

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, CfgModule.forRoot(environment)],
  bootstrap: [AppComponent]
})
export class AppModule {}

// In your app.component.ts or (some.service.ts)

import { Component } from '@angular/core';
import { CfgService } from '@un33k/ngx-cfg';
import { merge } from 'lodash';

@Component({
  selector: 'app-root'
})
export class AppComponent {
  title: string;
  options = {};

  constructor(public cfgService: CfgService) {
    this.options = merge({ name: 'AppComponent' }, this.cfgService.options};
    const remoteCfgData = this.options.remoteData;
  }
}

Running the tests

To run the tests against the current environment:

npm run ci:all

License

Released under a (MIT) license.

Version

X.Y.Z Version

`MAJOR` version -- making incompatible API changes
`MINOR` version -- adding functionality in a backwards-compatible manner
`PATCH` version -- making backwards-compatible bug fixes

Sponsors

Surge