presidium 1.4.7 → 1.4.9

package/DynamoDBGlobalSecondaryIndex.js

@@ -24,6 +24,7 @@ const createExpressionAttributeValues =
 const createKeyConditionExpression =
   require('./internal/createKeyConditionExpression')
 const createFilterExpression = require('./internal/createFilterExpression')
+const AwsError = require('./internal/AwsError')
 
 /**
  * @name DynamoDBGlobalSecondaryIndex

package/DynamoDBStream.js

@@ -51,8 +51,12 @@ const SymbolUpdateShards = Symbol('UpdateShards')
  *     * `region` - the AWS region.
  *     * `autoReady` - whether to automatically create the DynamoDB Stream if it doesn't exist. Defaults to `true`.
  *     * `StreamViewType` - determines what information is written to the DynamoDB Stream.
- *     * `ShardIteratorType` - determines how the shard iterator is used to start reading stream records from a shard of the stream. A shard is a replica of a stream for enhanced throughput purposes.
- *     * `JSON` - replaces `NewImage` in DynamoDB JSON format with `NewImageJSON` in JSON format and `OldImage` in DynamoDB JSON format with `OldImageJSON` in JSON format for all stream records.
+ *     * `ShardIteratorType` - determines how the shard iterator is used to start reading stream records from a shard of the stream. A shard is a replica of a stream for enhanced throughput purposes. Defaults to `'LATEST'`.
+ *     * `GetRecordsLimit` - number of records to fetch per DynamoDB Streams GetRecords operation. Defaults to `1000`.
+ *     * `GetRecordsInterval` - number of milliseconds to wait between DynamoDB Streams GetRecords calls. Defaults to `1000`.
+ *     * `ShardUpdatePeriod` - number of milliseconds to wait between shard updates. Defaults to `15000`.
+ *     * `ListStreamsLimit` - number of streams to list per DynamoDB Streams ListStreams calls. Defaults to `100`.
+ *     * `JSON` - replaces `NewImage` in DynamoDB JSON format with `NewImageJSON` in JSON format and `OldImage` in DynamoDB JSON format with `OldImageJSON` in JSON format for all stream records. Defaults to `false`.
  *
  * `StreamViewType` values:
  *   * `KEYS_ONLY` - only the key attributes of the modified item are written to the DynamoDB Stream.

package/Password.js

@@ -13,7 +13,7 @@ const Password = {}
  *
  * @docs
  * ```coffeescript [specscript]
- * Password.hash(plaintext string) -> hash string
+ * Password.hash(plaintext string) -> hash Promise<string>
  * ```
  *
  * Creates a hash of the plaintext password.
@@ -30,7 +30,7 @@ const Password = {}
  * const myPasswordHash = await Password.hash(myPassword)
  * ```
  */
-Password.hash = async function (plaintext) {
+Password.hash = async function hash(plaintext) {
   const salt = await bcrypt.genSalt(10)
   const hashed = await bcrypt.hash(plaintext, salt)
   return hashed
@@ -67,7 +67,7 @@ Password.hash = async function (plaintext) {
  * ```
  */
 
-Password.verify = async function (plaintext, hashed) {
+Password.verify = async function verify(plaintext, hashed) {
   const isValid = await bcrypt.compare(plaintext, hashed)
   if (!isValid) {
     throw new Error('Invalid password')

package/internal/handleDynamoDBStreamGetRecordsError.js

@@ -8,7 +8,7 @@
  */
 function handleDynamoDBStreamGetRecordsError(error) {
   if (error.message.includes('Shard iterator has expired')) {
-    return []
+    return { Records: [] }
   }
   throw error
 }

package/internal/handleDynamoDBStreamGetRecordsError.test.js

@@ -4,7 +4,7 @@ const handleDynamoDBStreamGetRecordsError =
 
 const test = new Test('handleDynamoDBStreamGetRecordsError', handleDynamoDBStreamGetRecordsError)
 
-test.case(new Error('Shard iterator has expired'), [])
+test.case(new Error('Shard iterator has expired'), { Records: [] })
 test.throws(new Error('other'), new Error('other'))
 
 if (process.argv[1] == __filename) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "1.4.7",
+  "version": "1.4.9",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",