presidium 1.3.1 → 1.4.0

package/ECR.js

@@ -217,7 +217,7 @@ class ECR {
    *
    * @docs
    * ```coffeescript [specscript]
-   * ecr.getAuthorizationToken() -> authToken Promise<string>
+   * getAuthorizationToken() -> authToken Promise<string>
    * ```
    *
    * Gets an authorization token from Amazon ECR.

package/README.md

@@ -7,6 +7,27 @@
 
 A library for creating web services.
 
+## Installation
+with [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm):
+```bash
+npm i presidium
+```
+
+require Presidium in [CommonJS](https://nodejs.org/docs/latest/api/modules.html#modules-commonjs-modules):
+```javascript
+// import Presidium globally
+require('presidium/global')
+
+// import Presidium
+const presidium = require('presidium')
+
+// import Presidium clients
+const DynamoDBTable = require('presidium/DynamoDBTable')
+const S3Bucket = require('presidium/S3Bucket')
+const WebSocket = require('presidium/WebSocket')
+const Readable = require('presidium/Readable')
+```
+
 ## Handle HTTP
 ```javascript
 const HTTP = require('presidium/HTTP')

package/Secrets.js

@@ -0,0 +1,36 @@
+require('rubico/global')
+const fs = require('fs')
+
+/**
+ * @name Secrets
+ *
+ * @docs
+ * ```coffeescript [specscript]
+ * Secrets() -> secrets Promise<Object>
+ * ```
+ *
+ * Presidium Secrets class. Consumes the `.secrets` file in the current directory.
+ *
+ * Arguments:
+ *   * (none)
+ *
+ * Return:
+ *   * `secrets` - a promise of an object of secret key-value pairs.
+ *
+ * ```javascript
+ * const secrets = await Secrets()
+ * console.log(secrets.mySecret) // ********
+ * ```
+ */
+async function Secrets() {
+  const secrets = pipe(fs.promises.readFile('.secrets'), [
+    content => content.toString('utf8').trim().split('\n'),
+    map(line => line.split('=')),
+    Object.fromEntries,
+  ])
+  await fs.promises.rm('.secrets')
+
+  return secrets
+}
+
+module.exports = Secrets

package/index.js

@@ -12,6 +12,7 @@ module.exports = {
   Password: require('./Password.js'),
   Readable: require('./Readable.js'),
   S3Bucket: require('./S3Bucket.js'),
+  Secrets: require('./Secrets.js'),
   SecretsManager: require('./SecretsManager.js'),
   StrictValidator: require('./StrictValidator.js'),
   TranscribeStream: require('./TranscribeStream.js'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",
@@ -26,6 +26,7 @@
     "Password.js",
     "Readable.js",
     "S3Bucket.js",
+    "Secrets.js",
     "SecretsManager.js",
     "StrictValidator.js",
     "TranscribeStream.js",