data-api-client 1.0.1 → 1.2.1

package/README.md

@@ -1,4 +1,4 @@
-# Aurora Serverless Data API Client
+![Aurora Serverless Data API Client](https://user-images.githubusercontent.com/2053544/79285017-44053500-7e8a-11ea-8515-998ccf9c2d2e.png)
 
 [![Build Status](https://travis-ci.org/jeremydaly/data-api-client.svg?branch=master)](https://travis-ci.org/jeremydaly/data-api-client)
 [![npm](https://img.shields.io/npm/v/data-api-client.svg)](https://www.npmjs.com/package/data-api-client)
@@ -24,16 +24,20 @@ const data = require('data-api-client')({
 
 // Simple SELECT
 let result = await data.query(`SELECT * FROM myTable`)
-// [ { id: 1, name: 'Alice', age: null },
-//   { id: 2, name: 'Mike', age: 52 },
-//   { id: 3, name: 'Carol', age: 50 } ]
+// {
+//   records: [
+//     { id: 1, name: 'Alice', age: null },
+//     { id: 2, name: 'Mike', age: 52 },
+//     { id: 3, name: 'Carol', age: 50 }
+//   ]
+// }
 
 // SELECT with named parameters
 let resultParams = await data.query(
   `SELECT * FROM myTable WHERE id = :id`,
   { id: 2 }
 )
-// [ { id: 2, name: 'Mike', age: 52 } ]
+// { records: [ { id: 2, name: 'Mike', age: 52 } ] }
 
 // INSERT with named parameters
 let insert = await data.query(
@@ -133,11 +137,17 @@ Below is a table containing all of the possible configuration options for the `d
 | resourceArn | `string` | The ARN of your Aurora Serverless Cluster. This value is *required*, but can be overridden when querying. |  |
 | secretArn | `string` | The ARN of the secret associated with your database credentials. This is *required*, but can be overridden when querying. |  |
 | database | `string` | *Optional* default database to use with queries. Can be overridden when querying. |  |
+| engine | `mysql` or `pg` | The type of database engine you're connecting to (MySQL or Postgres). | `mysql` |
 | hydrateColumnNames | `boolean` | When `true`, results will be returned as objects with column names as keys. If `false`, results will be returned as an array of values. | `true` |
-| keepAlive | `boolean` | Enables HTTP Keep-Alive for calls to the AWS SDK. This dramatically decreases the latency of subsequent calls. | `true` |
-| sslEnabled | `boolean` | *Optional* Enables SSL HTTP endpoint. Can be disable for local development. | `true` |
+| ~~keepAlive~~ (deprecated) | `boolean` | See [Connection Reuse](#connection-reuse) below. | |
+| ~~sslEnabled~~ (deprecated) | `boolean` | Set this in the `options` | `true` |
 | options | `object` | An *optional* configuration object that is passed directly into the RDSDataService constructor. See [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDSDataService.html#constructor-property) for available options.  | `{}` |
-| region | `string`  | *Optional* AWS region to use. | `aws-sdk default` |
+| ~~region~~ (deprecated) | `string`  | Set this in the `options` | |
+| formatOptions | `object`  | Formatting options to auto parse dates and coerce native JavaScript date objects to MySQL supported date formats. Valid keys are `deserializeDate` and `treatAsLocalDate`. Both accept boolean values. | Both `false` |
+
+### Connection Reuse
+It is recommended to enable connection reuse as this dramatically decreases the latency of subsequent calls to the AWS API. This can be done by setting an environment variable
+`AWS_NODEJS_CONNECTION_REUSE_ENABLED=1`. For more information see the [AWS SDK documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html).
 
 ## How to use this module
 
@@ -227,6 +237,35 @@ SELECT `id`, `name`, `created` FROM `table_123abc` WHERE id > :id LIMIT 10
 
 You'll notice that we leave the *named parameters* alone. Anything that Data API and the `RDSDataService` Class currently handles, we defer to them.
 
+### Type-Casting
+The Aurora Data API can sometimes give you trouble with certain data types, such as uuid, unless you explicitly cast them. While you can certainly do this manually in your SQL string, the Data API Client offers a really easy way to handle this for you.
+
+```javascript
+const result = await data.query(
+  'INSERT INTO users(id, email, full_name, metadata) VALUES(:id, :email, :fullName, :metadata)',
+  [
+    {
+      name: 'id',
+      value: newUserId,
+      cast: 'uuid'
+    },
+    {
+      name: 'email',
+      value: email
+    },
+    {
+      name: 'fullName',
+      value: fullName
+    },
+    {
+      name: 'metadata',
+      value: JSON.stringify(userMetadata),
+      cast: 'jsonb'
+    }
+  ]
+)
+```
+
 ### Batch Queries
 The `RDSDataService` Class provides a `batchExecuteStatement` method that allows you to execute a prepared statement multiple times using different parameter sets. This is only allowed for `INSERT`, `UPDATE` and `DELETE` queries, but is much more efficient than issuing multiple `executeStatement` calls. The Data API Client handles the switching for you based on *how* you send in your parameters.
 
@@ -285,7 +324,7 @@ The Data API Client exposes *promisified* versions of the five RDSDataService me
 - `executeStatement`
 - `rollbackTransaction`
 
-The default configuration information (`resourceArn`, `secretArn`, and `database`) are merge with your supplied parameters, so supplying those values are optional.
+The default configuration information (`resourceArn`, `secretArn`, and `database`) are merged with your supplied parameters, so supplying those values are optional.
 
 ```javascript
 let result = await data.executeStatement({
@@ -344,7 +383,7 @@ No worries! The Data API Client gives you the ability to parameterize identifier
 This one is a bit frustrating. If you execute a standard `executeStatement`, then it will return a `numberOfRecordsUpdated` field for `UPDATE` and `DELETE` queries. This is handy for knowing if your query succeeded. Unfortunately, a `batchExecuteStatement` does not return this field for you.
 
 ## Enabling Data API
-In order to use the Data API, you must enable it on your Aurora Serverless Cluster and create a Secret. You also musst grant your execution environment a number of permission as outlined in the following sections.
+In order to use the Data API, you must enable it on your Aurora Serverless Cluster and create a Secret. You also must grant your execution environment a number of permission as outlined in the following sections.
 
 ### Enable Data API on your Aurora Serverless Cluster
 
@@ -369,7 +408,7 @@ You can then configure your rotation settings, if you want, and then you review
 
 ### Required Permissions
 
-In order to use the Data API, your execution environment requires several IAM permissions. Below are the minimum permissions required.
+In order to use the Data API, your execution environment requires several IAM permissions. Below are the minimum permissions required. **Please Note:** The `Resource: "*"` permission for `rds-data` is recommended by AWS (see [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonrdsdataapi.html#amazonrdsdataapi-resources-for-iam-policies)) because Amazon RDS Data API does not support specifying a resource ARN. The credentials specified in Secrets Manager can be used to restrict access to specific databases.
 
 **YAML:**
 ```yaml
@@ -382,7 +421,7 @@ Statement:
       - "rds-data:BeginTransaction"
       - "rds-data:RollbackTransaction"
       - "rds-data:CommitTransaction"
-    Resource: "arn:aws:rds:{REGION}:{ACCOUNT-ID}:cluster:{YOUR-CLUSTER-NAME}"
+    Resource: "*"
   - Effect: "Allow"
     Action:
       - "secretsmanager:GetSecretValue"
@@ -402,7 +441,7 @@ Statement:
       "rds-data:RollbackTransaction",
       "rds-data:CommitTransaction"
     ],
-    "Resource": "arn:aws:rds:{REGION}:{ACCOUNT-ID}:cluster:{YOUR-CLUSTER-NAME}"
+    "Resource": "*"
   },
   {
     "Effect": "Allow",
@@ -412,5 +451,10 @@ Statement:
 ]
 ```
 
+## Sponsors
+
+[![New Relic](https://user-images.githubusercontent.com/2053544/96728664-55238700-1382-11eb-93cb-82fe7cb5e043.png)](https://ad.doubleclick.net/ddm/trackclk/N1116303.3950900PODSEARCH.COM/B24770737.285235234;dc_trk_aid=479074825;dc_trk_cid=139488579;dc_lat=;dc_rdid=;tag_for_child_directed_treatment=;tfua=;gdpr=${GDPR};gdpr_consent=${GDPR_CONSENT_755})
+<IMG SRC="https://ad.doubleclick.net/ddm/trackimp/N1116303.3950900PODSEARCH.COM/B24770737.285235234;dc_trk_aid=479074825;dc_trk_cid=139488579;ord=[timestamp];dc_lat=;dc_rdid=;tag_for_child_directed_treatment=;tfua=;gdpr=${GDPR};gdpr_consent=${GDPR_CONSENT_755}?" BORDER="0" HEIGHT="1" WIDTH="1" ALT="Advertisement">
+
 ## Contributions
 Contributions, ideas and bug reports are welcome and greatly appreciated. Please add [issues](https://github.com/jeremydaly/data-api-client/issues) for suggestions and bug reports or create a pull request. You can also contact me on Twitter: [@jeremy_daly](https://twitter.com/jeremy_daly).

package/index.js

@@ -8,7 +8,7 @@
  * https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
  *
  * @author Jeremy Daly <jeremy@jeremydaly.com>
- * @version 1.0.0-beta
+ * @version 1.2.0
  * @license MIT
  */
 
@@ -31,21 +31,6 @@ const supportedTypes = [
   'structValue'
 ]
 
-/**********************************************************************/
-/** Enable HTTP Keep-Alive per https://vimeo.com/287511222          **/
-/** This dramatically increases the speed of subsequent HTTP calls  **/
-/**********************************************************************/
-
-const https = require('https')
-
-const sslAgent = new https.Agent({
-  keepAlive: true,
-  maxSockets: 50, // same as aws-sdk
-  rejectUnauthorized: true  // same as aws-sdk
-})
-sslAgent.setMaxListeners(0) // same as aws-sdk
-
-
 /********************************************************************/
 /**  PRIVATE METHODS                                               **/
 /********************************************************************/
@@ -75,7 +60,7 @@ const parseDatabase = (config,args) =>
   : typeof args[0].database === 'string' ? args[0].database
   : args[0].database ? error('\'database\' must be a string.')
   : config.database ? config.database
-  : error('No \'database\' provided.')
+  : undefined // removed for #47 - error('No \'database\' provided.')
 
 // Parse the supplied hydrateColumnNames command, or default to config
 const parseHydrate = (config,args) =>
@@ -83,6 +68,19 @@ const parseHydrate = (config,args) =>
   : args[0].hydrateColumnNames ? error('\'hydrateColumnNames\' must be a boolean.')
   : config.hydrateColumnNames
 
+// Parse the supplied format options, or default to config
+const parseFormatOptions = (config,args) =>
+  typeof args[0].formatOptions === 'object' ? {
+    deserializeDate: typeof args[0].formatOptions.deserializeDate === 'boolean' ? args[0].formatOptions.deserializeDate
+    : args[0].formatOptions.deserializeDate ? error('\'formatOptions.deserializeDate\' must be a boolean.')
+    : config.formatOptions.deserializeDate,
+    treatAsLocalDate: typeof args[0].formatOptions.treatAsLocalDate == 'boolean' ? args[0].formatOptions.treatAsLocalDate
+    : args[0].formatOptions.treatAsLocalDate ? error('\'formatOptions.treatAsLocalDate\' must be a boolean.')
+    : config.formatOptions.treatAsLocalDate
+  }
+  : args[0].formatOptions ? error('\'formatOptions\' must be an object.')
+  : config.formatOptions
+
 // Prepare method params w/ supplied inputs if an object is passed
 const prepareParams = ({ secretArn,resourceArn },args) => {
   return Object.assign(
@@ -106,27 +104,38 @@ const pick = (obj,values) => Object.keys(obj).reduce((acc,x) =>
 const flatten = arr => arr.reduce((acc,x) => acc.concat(x),[])
 
 // Normize parameters so that they are all in standard format
-const normalizeParams = params => params.reduce((acc,p) =>
+const normalizeParams = params => params.reduce((acc, p) =>
   Array.isArray(p) ? acc.concat([normalizeParams(p)])
-  : Object.keys(p).length === 2 && p.name && p.value ? acc.concat(p)
-  : acc.concat(splitParams(p))
-,[]) // end reduce
-
+  : (
+    (Object.keys(p).length === 2 && p.name && typeof p.value !== 'undefined') ||
+    (Object.keys(p).length === 3 && p.name && typeof p.value !== 'undefined' && p.cast)
+  ) ? acc.concat(p)
+    : acc.concat(splitParams(p))
+, []) // end reduce
 
 // Prepare parameters
-const processParams = (sql,sqlParams,params,row=0) => {
+const processParams = (engine,sql,sqlParams,params,formatOptions,row=0) => {
   return {
     processedParams: params.reduce((acc,p) => {
       if (Array.isArray(p)) {
-        let result = processParams(sql,sqlParams,p,row)
+        const result = processParams(engine,sql,sqlParams,p,formatOptions,row)
         if (row === 0) { sql = result.escapedSql; row++ }
         return acc.concat([result.processedParams])
       } else if (sqlParams[p.name]) {
         if (sqlParams[p.name].type === 'n_ph') {
-          acc.push(formatParam(p.name,p.value))
+          if (p.cast) {
+            const regex = new RegExp(':' + p.name + '\\b', 'g')
+            sql = sql.replace(
+              regex,
+              engine === 'pg'
+                ? `:${p.name}::${p.cast}`
+                : `CAST(:${p.name} AS ${p.cast})`
+            )
+          }
+          acc.push(formatParam(p.name,p.value,formatOptions))
         } else if (row === 0) {
-          let regex = new RegExp('::' + p.name + '\\b','g')
-          sql = sql.replace(regex,sqlString.escapeId(p.value))
+          const regex = new RegExp('::' + p.name + '\\b', 'g')
+          sql = sql.replace(regex, sqlString.escapeId(p.value))
         }
         return acc
       } else {
@@ -138,7 +147,7 @@ const processParams = (sql,sqlParams,params,row=0) => {
 }
 
 // Converts parameter to the name/value format
-const formatParam = (n,v) => formatType(n,v,getType(v))
+const formatParam = (n,v,formatOptions) => formatType(n,v,getType(v),getTypeHint(v),formatOptions)
 
 // Converts object params into name/value format
 const splitParams = p => Object.keys(p).reduce((arr,x) =>
@@ -174,6 +183,7 @@ const getType = val =>
   : typeof val === 'number' && parseInt(val) === val ? 'longValue'
   : typeof val === 'number' && parseFloat(val) === val ? 'doubleValue'
   : val === null ? 'isNull'
+  : isDate(val) ? 'stringValue'
   : Buffer.isBuffer(val) ? 'blobValue'
   // : Array.isArray(val) ? 'arrayValue' This doesn't work yet
   // TODO: there is a 'structValue' now for postgres
@@ -182,20 +192,56 @@ const getType = val =>
     && supportedTypes.includes(Object.keys(val)[0]) ? null
   : undefined
 
+// Hint to specify the underlying object type for data type mapping
+const getTypeHint = val =>
+  isDate(val) ? 'TIMESTAMP' : undefined
+
+const isDate = val =>
+  val instanceof Date
+
 // Creates a standard Data API parameter using the supplied inputs
-const formatType = (name,value,type) => {
+const formatType = (name,value,type,typeHint,formatOptions) => {
   return Object.assign(
-    { name },
+    typeHint != null ? { name, typeHint } : { name },
     type === null ? { value }
     : {
       value: {
         [type ? type : error(`'${name}' is an invalid type`)]
-        : type === 'isNull' ? true : value
+        : type === 'isNull' ? true
+        : isDate(value) ? formatToTimeStamp(value, formatOptions && formatOptions.treatAsLocalDate)
+        : value
       }
     }
   )
 } // end formatType
 
+// Formats the (UTC) date to the AWS accepted YYYY-MM-DD HH:MM:SS[.FFF] format
+// See https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_SqlParameter.html
+const formatToTimeStamp = (date, treatAsLocalDate) => {
+  const pad = (val,num=2) => '0'.repeat(num-(val + '').length) + val
+
+  const year = treatAsLocalDate ? date.getFullYear() : date.getUTCFullYear()
+  const month = (treatAsLocalDate ? date.getMonth() : date.getUTCMonth()) + 1 // Convert to human month
+  const day = treatAsLocalDate ? date.getDate() : date.getUTCDate()
+
+  const hours = treatAsLocalDate ? date.getHours() : date.getUTCHours()
+  const minutes = treatAsLocalDate ? date.getMinutes() : date.getUTCMinutes()
+  const seconds = treatAsLocalDate ? date.getSeconds() : date.getUTCSeconds()
+  const ms = treatAsLocalDate ? date.getMilliseconds() : date.getUTCMilliseconds()
+
+  const fraction = ms <= 0 ? '' : `.${pad(ms,3)}`
+
+  return `${year}-${pad(month)}-${pad(day)} ${pad(hours)}:${pad(minutes)}:${pad(seconds)}${fraction}`
+}
+
+// Converts the string value to a Date object.
+// If standard TIMESTAMP format (YYYY-MM-DD[ HH:MM:SS[.FFF]]) without TZ + treatAsLocalDate=false then assume UTC Date
+// In all other cases convert value to datetime as-is (also values with TZ info)
+const formatFromTimeStamp = (value,treatAsLocalDate) =>
+  !treatAsLocalDate && /^\d{4}-\d{2}-\d{2}(\s\d{2}:\d{2}:\d{2}(\.\d{3})?)?$/.test(value) ?
+    new Date(value + 'Z') :
+    new Date(value)
+
 // Formats the results of a query response
 const formatResults = (
   { // destructure results
@@ -206,27 +252,27 @@ const formatResults = (
     updateResults // ONLY on batchExecuteStatement
   },
   hydrate,
-  includeMeta
-) =>
-  Object.assign(
-    includeMeta ? { columnMetadata } : {},
-    numberOfRecordsUpdated !== undefined && !records ? { numberOfRecordsUpdated } : {},
-    records ? {
-      records: formatRecords(records, hydrate ? columnMetadata : false)
-    } : {},
-    updateResults ? { updateResults: formatUpdateResults(updateResults) } : {},
-    generatedFields && generatedFields.length > 0 ?
-      { insertId: generatedFields[0].longValue } : {}
-  )
+  includeMeta,
+  formatOptions
+) => Object.assign(
+  includeMeta ? { columnMetadata } : {},
+  numberOfRecordsUpdated !== undefined && !records ? { numberOfRecordsUpdated } : {},
+  records ? {
+    records: formatRecords(records, columnMetadata, hydrate, formatOptions)
+  } : {},
+  updateResults ? { updateResults: formatUpdateResults(updateResults) } : {},
+  generatedFields && generatedFields.length > 0 ?
+    { insertId: generatedFields[0].longValue } : {}
+)
 
 // Processes records and either extracts Typed Values into an array, or
 // object with named column labels
-const formatRecords = (recs,columns) => {
+const formatRecords = (recs,columns,hydrate,formatOptions) => {
 
   // Create map for efficient value parsing
   let fmap = recs && recs[0] ? recs[0].map((x,i) => {
     return Object.assign({},
-      columns ? { label: columns[i].label } : {} ) // add column labels
+      columns ? { label: columns[i].label, typeName: columns[i].typeName } : {} ) // add column label and typeName
   }) : {}
 
   // Map over all the records (rows)
@@ -237,15 +283,16 @@ const formatRecords = (recs,columns) => {
 
       // If the field is null, always return null
       if (field.isNull === true) {
-        return columns ? // object if hydrate, else array
+        return hydrate ? // object if hydrate, else array
           Object.assign(acc,{ [fmap[i].label]: null })
           : acc.concat(null)
 
       // If the field is mapped, return the mapped field
       } else if (fmap[i] && fmap[i].field) {
-        return columns ? // object if hydrate, else array
-          Object.assign(acc,{ [fmap[i].label]: field[fmap[i].field] })
-          : acc.concat(field[fmap[i].field])
+        const value = formatRecordValue(field[fmap[i].field],fmap[i].typeName,formatOptions)
+        return hydrate ? // object if hydrate, else array
+          Object.assign(acc,{ [fmap[i].label]: value })
+          : acc.concat(value)
 
       // Else discover the field type
       } else {
@@ -258,15 +305,22 @@ const formatRecords = (recs,columns) => {
         })
 
         // Return the mapped field (this should NEVER be null)
-        return columns ? // object if hydrate, else array
-          Object.assign(acc,{ [fmap[i].label]: field[fmap[i].field] })
-          : acc.concat(field[fmap[i].field])
+        const value = formatRecordValue(field[fmap[i].field],fmap[i].typeName,formatOptions)
+        return hydrate ? // object if hydrate, else array
+          Object.assign(acc,{ [fmap[i].label]: value })
+          : acc.concat(value)
       }
 
-    }, columns ? {} : []) // init object if hydrate, else init array
+    }, hydrate ? {} : []) // init object if hydrate, else init array
   }) : [] // empty record set returns an array
 } // end formatRecords
 
+// Format record value based on its value, the database column's typeName and the formatting options
+const formatRecordValue = (value,typeName,formatOptions) => formatOptions && formatOptions.deserializeDate &&
+  ['DATE', 'DATETIME', 'TIMESTAMP', 'TIMESTAMP WITH TIME ZONE'].includes(typeName)
+  ? formatFromTimeStamp(value,(formatOptions && formatOptions.treatAsLocalDate) || typeName === 'TIMESTAMP WITH TIME ZONE')
+  : value
+
 // Format updateResults and extract insertIds
 const formatUpdateResults = res => res.map(x => {
   return x.generatedFields && x.generatedFields.length > 0 ?
@@ -286,7 +340,6 @@ const mergeConfig = (initialConfig,args) =>
 
 // Query function (use standard form for `this` context)
 const query = async function(config,..._args) {
-
   // Flatten array if nested arrays (fixes #30)
   const args = Array.isArray(_args[0]) ? flatten(_args) : _args
 
@@ -297,15 +350,18 @@ const query = async function(config,..._args) {
   // Parse hydration setting
   const hydrateColumnNames = parseHydrate(config,args)
 
+  // Parse data format settings
+  const formatOptions = parseFormatOptions(config,args)
+
   // Parse and normalize parameters
   const parameters = normalizeParams(parseParams(args))
 
   // Process parameters and escape necessary SQL
-  const { processedParams,escapedSql } = processParams(sql,sqlParams,parameters)
+  const { processedParams,escapedSql } = processParams(config.engine,sql,sqlParams,parameters,formatOptions)
 
   // Determine if this is a batch request
   const isBatch = processedParams.length > 0
-    && Array.isArray(processedParams[0]) ? true : false
+    && Array.isArray(processedParams[0])
 
   // Create/format the parameters
   const params = Object.assign(
@@ -324,7 +380,7 @@ const query = async function(config,..._args) {
     config.transactionId ? { transactionId: config.transactionId } : {}
   ) // end params
 
-  try { // attempt to run the query
+  try { // attempt to run the query  
 
     // Capture the result for debugging
     let result = await (isBatch ? config.RDS.batchExecuteStatement(params).promise()
@@ -334,7 +390,8 @@ const query = async function(config,..._args) {
     return formatResults(
       result,
       hydrateColumnNames,
-      args[0].includeResultMetadata === true ? true : false
+      args[0].includeResultMetadata === true,
+      formatOptions
     )
 
   } catch(e) {
@@ -370,6 +427,7 @@ const transaction = (config,_args) => {
     {
       database: parseDatabase(config,args), // add database
       hydrateColumnNames: parseHydrate(config,args), // add hydrate
+      formatOptions: parseFormatOptions(config,args), // add formatOptions
       RDS: config.RDS // reference the RDSDataService instance
     }
   )
@@ -429,32 +487,49 @@ const commit = async (config,queries,rollback) => {
 /********************************************************************/
 
 // Export main function
-module.exports = (params) => {
+/**
+ * Create a Data API client instance
+ * @param {object} params
+ * @param {'mysql'|'pg'} [params.engine=mysql] The type of database (MySQL or Postgres)
+ * @param {string} params.resourceArn The ARN of your Aurora Serverless Cluster
+ * @param {string} params.secretArn The ARN of the secret associated with your
+ *   database credentials
+ * @param {string} [params.database] The name of the database
+ * @param {boolean} [params.hydrateColumnNames=true] Return objects with column
+ *   names as keys
+ * @param {object} [params.options={}] Configuration object passed directly
+ *   into RDSDataService
+ * @param {object} [params.formatOptions] Date-related formatting options
+ * @param {boolean} [params.formatOptions.deserializeDate=false]
+ * @param {boolean} [params.formatOptions.treatAsLocalDate=false]
+ * @param {boolean} [params.keepAlive] DEPRECATED
+ * @param {boolean} [params.sslEnabled=true] DEPRECATED
+ * @param {string} [params.region] DEPRECATED
+ *
+ */
+const init = params => {
 
   // Set the options for the RDSDataService
   const options = typeof params.options === 'object' ? params.options
     : params.options !== undefined ? error('\'options\' must be an object')
     : {}
 
-  // Update the default AWS http agent with our new sslAgent
-  if (typeof params.keepAlive === 'boolean' ? params.keepAlive : true) {
-    AWS.config.update({ httpOptions: { agent: sslAgent } })
-  }
-
   // Update the AWS http agent with the region
   if (typeof params.region === 'string') {
-    AWS.config.update({ region: params.region })
+    options.region = params.region
   }
 
   // Disable ssl if wanted for local development
   if (params.sslEnabled === false) {
-    // AWS.config.update({ sslEnabled: false })
     options.sslEnabled = false
   }
 
-
   // Set the configuration for this instance
   const config = {
+    // Require engine
+    engine: typeof params.engine === 'string' ?
+      params.engine
+      : 'mysql',
 
     // Require secretArn
     secretArn: typeof params.secretArn === 'string' ?
@@ -482,6 +557,14 @@ module.exports = (params) => {
       typeof params.hydrateColumnNames === 'boolean' ?
         params.hydrateColumnNames : true,
 
+    // Value formatting options. For date the deserialization is enabled and (re)stored as UTC
+    formatOptions: {
+      deserializeDate:
+        typeof params.formatOptions === 'object' && params.formatOptions.deserializeDate === false ? false : true,
+      treatAsLocalDate:
+        typeof params.formatOptions === 'object' && params.formatOptions.treatAsLocalDate
+    },
+
     // TODO: Put this in a separate module for testing?
     // Create an instance of RDSDataService
     RDS: new AWS.RDSDataService(options)
@@ -519,3 +602,5 @@ module.exports = (params) => {
   }
 
 } // end exports
+
+module.exports = init

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-api-client",
-  "version": "1.0.1",
+  "version": "1.2.1",
   "description": "A lightweight wrapper that simplifies working with the Amazon Aurora Serverless Data API",
   "main": "index.js",
   "scripts": {
@@ -25,17 +25,15 @@
   },
   "homepage": "https://github.com/jeremydaly/data-api-client#readme",
   "devDependencies": {
-    "aws-sdk": "^2.588.0",
-    "eslint": "^6.7.2",
-    "jest": "^25.0.0",
-    "rewire": "^4.0.1"
+    "aws-sdk": "^2.811.0",
+    "eslint": "^6.8.0",
+    "jest": "^27.5.1",
+    "rewire": "^6.0.0"
   },
   "dependencies": {
-    "sqlstring": "^2.3.1"
+    "sqlstring": "^2.3.2"
   },
   "files": [
-    "LICENSE",
-    "README.md",
     "index.js"
   ]
 }