classy-lambda-common
Common configuration and tools for Classy Lambda modules.
installation
$ npm install --save classy-lambda-common
prerequisites
Minimally, you must have an environment.json and creds.example.json file in the root of your project. The JSON content provides a configuration based on which stage you are deployed to:
environment.json
creds.example.json
options
See prerequisites
supported toolset
Common.get(key): works for both static environment key/value pairs (i.e. environment.json), and also CredStash secrets. For static environment key/value pairs, you can specify nested keys in hierarchy via dot notation, i.e. Common.get('this.is.valid') returns "value" for:
For CredStash, keys are generally all uppercase with snake case between words, i.e. SOME_SECRET.
Common.get('Logger'): Logging facility which requires 'log' configuration. See example below.
Common.get('PayClient'): Client which can be used for requests to Classy Pay. Requires 'pay' configuration.
Common.get('ApiClient'): Client which can be used for requests to Classy API. Requires 'api' configuration.
Common.get('Replacer'): Obfuscator for use with JSON.stringify replacer. Requires 'security' configuration.
usage
Bootstrap: Common.load(callback)
const Common = ;Common;
Get static config: Common.get(key)
let value = Common;console;
Get CredStash secret: Common.get(key)
let value = Common;console;
Get Logger: See Bootstrap above
Get PayClient: Common.get(key)
let PayClient = Common; // PayClient.request(appId, method, resource, postBody, callback)PayClient;
Get ApiClient: Common.get(key)
let ApiClient = Common; // See classy-node for detailsApiClient;
Get Replacer: Common.get(key)
let Replacer = Commonreplacer;console;