Merge pull request #30 from NYPL/NOREF-node20

Updates for v2.0 Node 20

Author: nonword

.nvmrc

@@ -1 +1 @@
-14
+20

.travis.yml

@@ -1,3 +1,4 @@
 language: node_js
-node_js:
-- '6.11'
+install: npm install
+script: npm test
+dist: jammy

README.md

@@ -14,30 +14,38 @@ npm i @nypl/nypl-streams-client --save
 
 ```js
 const NyplStreamsClient = require('@nypl/nypl-Streams-client')
-var streamsClient = new NyplStreamsClient({ nyplDataApiClientBase: 'http://example.com/api/v0.1/' })
+const streamsClient = new NyplStreamsClient({ nyplDataApiClientBase: 'https://example.com/api/v0.1/' })
 ```
 
 See [docs/usage.md](docs/usage.md) for complete documentation of Client methods and use.
 
 ### Example 1: Writing data to a stream
 
 To write a single record to a stream (encoded to "MyStream" schema):
+
 ```js
-streamsClient.write('MyStream', { id: 'id1', field1: 1, field2: 2 }).then((resp) => {
-  console.log('Finished writing to stream ' + resp.Records.length)
-}).catch((e) => console.error('Error writing to stream: ', e))
+try {
+  const response = await streamsClient.write('MyStream', { id: 'id1', field1: 1, field2: 2 })
+  console.log('Finished writing to stream ' + response.Records.length)
+} catch (e) {
+  console.error('Error writing to stream: ', e)
+}
 ```
 
 To write multiple records to a stream, batched and rate-limited to avoid write errors:
+
 ```js
-var records = [ { id: 'id1', field1: 1, field2: 2 }, { id: 'id2', field1: 1 }, ... ] // Array of any length
-var options = {
+const records = [ { id: 'id1', field1: 1, field2: 2 }, { id: 'id2', field1: 1 }, ... ] // Array of any length
+const options = {
   recordsPerSecond: 500 // This is the default and well below the 1000/s AWS constraint
 }
-streamsClient.write('MyStream', records, options).then((resp) => {
+try {
+  const response = await streamsClient.write('MyStream', records, options)
   console.log('Finished writing to stream ' + resp.Records.length)
   console.log(`Failed to write: ${resp.FailedRecordCount} record(s)`)
-}).catch((e) => console.error('Error writing to stream: ', e))
+} catch (e) {
+  console.error('Error writing to stream: ', e)
+}
 ```
 
 Above will resolve after `records.length / 500` seconds. The resolved value is a hash merged from the hashes returned from each putRecords call.
@@ -49,18 +57,19 @@ The streams client can be used for decoding data obtained directly from a stream
 Example lambda handler with a kinesis trigger:
 
 ```js
-exports.handler = function (event, context, callback) {
+exports.handler = async (event, context, callback) => {
   // Initialize streams client:
   const streamsClient = new NyplStreamsClient({ nyplDataApiClientBase: 'http://example.com/api/v0.1/' })
   const record = event.Records[0]
 
   if (record.kinesis) {
-    const decodedKinesisData = streamsClient.decodeData('SchemaName', event.Records.map(record => record.kinesis.data));
+    const encoded = event.Records.map(record => record.kinesis.data)
 
-    // Resolve the Promise and do something with the decoded data
-    return decodedKinesisData
-      .then((result) => console.log('result:', result))
-      .catch((err) => console.log('rejected:', err));
+    try {
+      const decoded = await streamsClient.decodeData('SchemaName', encoded)
+    } catch (e) => {
+      console.error('Error decoding event: ', e)
+    }
   }
 }
 ```
@@ -71,13 +80,13 @@ The library includes a CLI for writing arbitary events to streams. Care should b
 
 For example, to write a `SierraBibRetrievalRequest` encoded event to the `SierraBibRetriever-qa` stream:
 ```
-cli/nypl-streams.js --envfile config/qa.env --profile nypl-digital-dev write SierraBibRetriever-qa --schemaName SierraBibRetrievalRequest '{ "id": "21747246" }'
+./cli/nypl-streams.js --envfile config/qa.env --profile nypl-digital-dev write SierraBibRetriever-qa --schemaName SierraBibRetrievalRequest '{ "id": "21747246" }'
 ```
 
 ## Git workflow
 
- - Cut feature branch from master.
- - Create PR to merge feature branch into master
+ - Cut feature branch from main.
+ - Create PR to merge feature branch into main
  - After PR approved by multiple co-workers, the author merges the PR.
 
 ### Publishing to NPMJS

cli/nypl-streams.js

@@ -12,7 +12,7 @@
  */
 
 const dotenv = require('dotenv')
-const aws = require('aws-sdk')
+const { fromIni } = require('@aws-sdk/credential-providers')
 
 const Client = require('../index')
 const argv = require('minimist')(process.argv.slice(2))
@@ -21,20 +21,8 @@ if (!argv.envfile) throw new Error('Must specify --envfile; See config/sample.en
 
 if (!argv.profile) throw new Error('Must specify --profile')
 
-function setProfile (profile) {
-  // Set aws creds:
-  aws.config.credentials = new aws.SharedIniFileCredentials({
-    profile
-  })
-
-  // Set aws region:
-  let awsSecurity = { region: 'us-east-1' }
-  aws.config.update(awsSecurity)
-}
-
 function writeToStream (streamName, data) {
-  // Schema name is the stream name minus the env suffix:
-  const schemaName = argv.schemaName || streamName.replace(/-.*/, '')
+  const schemaName = argv.schemaName
 
   data = JSON.parse(data)
 
@@ -48,9 +36,10 @@ function writeToStream (streamName, data) {
 
 dotenv.config({ path: argv.envfile })
 
-setProfile(argv.profile)
-
-const client = new Client({ nyplDataApiClientBase: process.env.NYPL_API_BASE_URL })
+const client = new Client({
+  nyplDataApiClientBase: process.env.NYPL_API_BASE_URL,
+  awsClientOptions: { credentials: fromIni({ profile: argv.profile }) }
+})
 
 switch (argv._[0]) {
   case 'write':

docs/usage.md

@@ -5,19 +5,25 @@
 <dd></dd>
 </dl>
 
+## Functions
+
+<dl>
+<dt><a href="#AvroValidationError">AvroValidationError()</a></dt>
+<dd><p>A AvroValidationError is thrown when avsc fails to encode/decode data.</p>
+</dd>
+</dl>
+
 ## Typedefs
 
 <dl>
 <dt><a href="#ClientConstructorOptions">ClientConstructorOptions</a> : <code>Object</code></dt>
 <dd></dd>
+<dt><a href="#AwsClientOptions">AwsClientOptions</a> : <code>Object</code></dt>
+<dd></dd>
 <dt><a href="#WriteOptions">WriteOptions</a> : <code>Object</code></dt>
 <dd></dd>
 <dt><a href="#WriteResponse">WriteResponse</a> : <code>Object</code></dt>
 <dd></dd>
-<dt><a href="#CreateStreamOptions">CreateStreamOptions</a> : <code>Object</code></dt>
-<dd></dd>
-<dt><a href="#DeleteStreamOptions">DeleteStreamOptions</a> : <code>Object</code></dt>
-<dd></dd>
 </dl>
 
 <a name="Client"></a>
@@ -28,14 +34,13 @@
 * [Client](#Client)
     * [new Client(options)](#new_Client_new)
     * [.write(streamName, data, options)](#Client+write) ⇒ <code>Promise.&lt;WriteReponse&gt;</code>
-    * [.createStream(name, options)](#Client+createStream) ⇒ <code>Promise</code>
-    * [.deleteStream(name, options)](#Client+deleteStream) ⇒ <code>Promise</code>
     * [.kinesisClient()](#Client+kinesisClient) ⇒ <code>Promise.&lt;AWS.Kinesis&gt;</code>
     * [.dataApiClient()](#Client+dataApiClient) ⇒ <code>Promise.&lt;NyplClient&gt;</code>
     * [.encodeData(schemaName, data)](#Client+encodeData) ⇒ <code>Promise</code>
     * [.decodeData(schemaName, data)](#Client+decodeData) ⇒ <code>Promise</code>
     * [.decodeAvroBufferString(bufferString, avroObject, encodeType)](#Client+decodeAvroBufferString) ⇒
     * [.getAvroType()](#Client+getAvroType) ⇒ <code>Promise.&lt;avsc.Type&gt;</code>
+    * [._defaultSchema()](#Client+_defaultSchema)
 
 <a name="new_Client_new"></a>
 
@@ -61,32 +66,6 @@ Note, the `data` arg can be an object or array of objects.
 | data | <code>Object</code> \| <code>Array</code> | Object (or array of objects) to write. |
 | options | [<code>WriteOptions</code>](#WriteOptions) |  |
 
-<a name="Client+createStream"></a>
-
-### client.createStream(name, options) ⇒ <code>Promise</code>
-Create a stream by name
-
-**Kind**: instance method of [<code>Client</code>](#Client)  
-**Returns**: <code>Promise</code> - A promise that resolves on success.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>string</code> | Name of stream |
-| options | [<code>CreateStreamOptions</code>](#CreateStreamOptions) |  |
-
-<a name="Client+deleteStream"></a>
-
-### client.deleteStream(name, options) ⇒ <code>Promise</code>
-Delete a stream by name
-
-**Kind**: instance method of [<code>Client</code>](#Client)  
-**Returns**: <code>Promise</code> - A promise that resolves on success.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>string</code> | Name of stream |
-| options | <code>CreateOptions</code> |  |
-
 <a name="Client+kinesisClient"></a>
 
 ### client.kinesisClient() ⇒ <code>Promise.&lt;AWS.Kinesis&gt;</code>
@@ -145,6 +124,18 @@ Returns an avro type instance by schema name
 
 **Kind**: instance method of [<code>Client</code>](#Client)  
 **Returns**: <code>Promise.&lt;avsc.Type&gt;</code> - A Promise that resolves an avsc.Type instance  
+<a name="Client+_defaultSchema"></a>
+
+### client.\_defaultSchema()
+Given a stream name (e.g. MyEventStream-qa) returns the conventional schema name (MyEventStream)
+
+**Kind**: instance method of [<code>Client</code>](#Client)  
+<a name="AvroValidationError"></a>
+
+## AvroValidationError()
+A AvroValidationError is thrown when avsc fails to encode/decode data.
+
+**Kind**: global function  
 <a name="ClientConstructorOptions"></a>
 
 ## ClientConstructorOptions : <code>Object</code>
@@ -159,7 +150,18 @@ Returns an avro type instance by schema name
 | waitBetweenDescribeCallsInSeconds | <code>number</code> | How many seconds to    pause between describe calls (i.e. when waiting for active stream).    Default 4 |
 | maxDescribeCallRetries | <code>number</code> | Maximum describe calls to make    before giving up (i.e. when waiting for active stream). Default 10. |
 | logLevel | <code>string</code> | Set [log level](https://github.com/pimterry/loglevel)    (i.e. info, error, warn, debug). Default env.LOG_LEVEL or 'error' |
-| awsRegion | <code>string</code> | AWS region to use. Default us-east-1 |
+| awsClientOptions | [<code>AwsClientOptions</code>](#AwsClientOptions) | AWS client options |
+
+<a name="AwsClientOptions"></a>
+
+## AwsClientOptions : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| region | <code>string</code> | AWS region to use. Default us-east-1 |
+| profile | <code>string</code> | Named profile to use for from local credentials file. |
 
 <a name="WriteOptions"></a>
 
@@ -170,7 +172,7 @@ Returns an avro type instance by schema name
 | Name | Type | Description |
 | --- | --- | --- |
 | avroEncode | <code>boolean</code> | Whether or not to Name of avro schema to use to encode. |
-| avroSchemaName | <code>string</code> | Name of avro schema to use to encode.     Defaults to `streamName`. |
+| avroSchemaName | <code>string</code> | Name of avro schema to use to encode.     Defaults to `streamName` (with -qa/-production suffix removed). |
 
 <a name="WriteResponse"></a>
 
@@ -184,24 +186,3 @@ Returns an avro type instance by schema name
 | FailedRecordCount | <code>number</code> | Number of records that failed |
 | unmergedResponses | <code>Array</code> | Raw AWS responses (for debugging     mult. batch jobs) |
 
-<a name="CreateStreamOptions"></a>
-
-## CreateStreamOptions : <code>Object</code>
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| shards | <code>number</code> | <code>1</code> | Number of shards to attach to stream |
-| failIfExists | <code>boolean</code> | <code>false</code> | Whether to throw error if stream     already exists. |
-
-<a name="DeleteStreamOptions"></a>
-
-## DeleteStreamOptions : <code>Object</code>
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Default | Description |
-| --- | --- | --- | --- |
-| yesIKnowThisIsPotentiallyDisastrous | <code>boolean</code> | <code>false</code> | Flag that     must be set to true to allow call to succeed. |
-