sqs-producer 2.2.0 → 3.0.0-alpha.1

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+coverage
+bake-scripts
+dist

package/.github/ISSUE_TEMPLATE/bug-report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: ''
-
 ---
 
 **Describe the bug**
@@ -12,6 +11,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behaviour:
+
 1. Go to '...'
 2. Select '....'
 3. Scroll down to '....'
@@ -24,4 +24,4 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Additional context**
-Add any other context about the problem here, such as specific device information.
+Add any other context about the problem here, such as specific device information.

package/.github/ISSUE_TEMPLATE/feature-request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: feature-request
 assignees: ''
-
 ---
 
 **The problem**

package/.github/ISSUE_TEMPLATE/technical-question.md

@@ -4,7 +4,6 @@ about: Want to ask a technical question about the project
 title: ''
 labels: 'question'
 assignees: ''
-
 ---
 
 **Question**

package/.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+coverage
+bake-scripts
+dist

package/.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  arrowParens: 'always',
+  trailingComma: 'none'
+};

package/README.md

@@ -1,9 +1,8 @@
-sqs-producer
-====================
+# sqs-producer
 
 [![NPM downloads](https://img.shields.io/npm/dm/sqs-producer.svg?style=flat)](https://npmjs.org/package/sqs-producer)
 [![Build Status](https://github.com/bbc/sqs-producer/actions/workflows/test.yml/badge.svg)](https://github.com/bbc/sqs-producer/actions/workflows/test.yml)
-[![Code Climate](https://codeclimate.com/github/BBC/sqs-producer/badges/gpa.svg)](https://codeclimate.com/github/BBC/sqs-producer) 
+[![Code Climate](https://codeclimate.com/github/BBC/sqs-producer/badges/gpa.svg)](https://codeclimate.com/github/BBC/sqs-producer)
 [![Test Coverage](https://codeclimate.com/github/BBC/sqs-producer/badges/coverage.svg)](https://codeclimate.com/github/BBC/sqs-producer)
 
 Enqueues messages onto a given SQS queue
@@ -13,11 +12,19 @@ Enqueues messages onto a given SQS queue
 ```
 npm install sqs-producer
 ```
+
+> **Note**
+> This library assumes you are using [AWS SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/index.html). If you are using v2, please install v2.2.0:
+>
+> ```bash
+> npm install sqs-producer@5.8.0 --save-dev
+> ```
+
 ## Usage
 
 ```js
-const { Producer } = require('sqs-producer');
-import AWS from 'aws-sdk'
+import { Producer } from 'sqs-producer';
+import { SQSClient } from '@aws-sdk/client-sqs';
 
 // create simple producer
 const producer = Producer.create({
@@ -25,19 +32,6 @@ const producer = Producer.create({
   region: 'eu-west-1'
 });
 
-// create custom producer (supporting all opts as per the API docs: http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html#constructor-property)
-AWS.config.update({
-  accessKeyId: 'yourAccessKey',
-  secretAccessKey: 'yourSecret',
-  region: 'eu-west-1',
-});
-
-const producer = Producer.create({
-  queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
-  region: 'eu-west-1',
-  sqs: new AWS.SQS(),
-});
-
 // send messages to the queue
 await producer.send(['msg1', 'msg2']);
 
@@ -46,10 +40,12 @@ const size = await producer.queueSize();
 console.log(`There are ${size} messages on the queue.`);
 
 // send a message to the queue with a specific ID (by default the body is used as the ID)
-await producer.send([{
-  id: 'id1',
-  body: 'Hello world'
-}]);
+await producer.send([
+  {
+    id: 'id1',
+    body: 'Hello world'
+  }
+]);
 
 // send a message to the queue with
 // - delaySeconds (must be an number contained within 0 and 900)
@@ -80,13 +76,45 @@ await producer.send([
 //
 // http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html
 await producer.send({
-  id: "testId",
+  id: 'testId',
   body: 'Hello world from our FIFO queue!',
   groupId: 'group1234',
   deduplicationId: 'abcdef123456' // typically a hash of the message body
 });
 ```
 
+### Credentials
+
+By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:
+
+```bash
+export AWS_SECRET_ACCESS_KEY=...
+export AWS_ACCESS_KEY_ID=...
+```
+
+If you need to specify your credentials manually, you can use a pre-configured instance of the [SQS Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) client.
+
+```js
+import { Producer } from 'sqs-producer';
+import { SQSClient } from '@aws-sdk/client-sqs';
+
+// create simple producer
+const producer = Producer.create({
+  queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
+  region: 'eu-west-1',
+  sqs: new SQSClient({
+    region: 'my-region',
+    credentials: {
+      accessKeyId: 'yourAccessKey',
+      secretAccessKey: 'yourSecret'
+    }
+  })
+});
+
+// send messages to the queue
+await producer.send(['msg1', 'msg2']);
+```
+
 ## Development
 
 ### Test
@@ -96,6 +124,7 @@ npm test
 ```
 
 ### Coverage
+
 For coverage report, run the command:
 
 ```
@@ -103,6 +132,7 @@ npm run coverage
 ```
 
 ### Lint
+
 To check for problems using ESLint
 
 ```
@@ -110,4 +140,5 @@ npm run lint
 ```
 
 ## Contributing
+
 See [contributing guildlines](./.github/CONTRIBUTING.md)

package/dist/producer.d.ts

@@ -1,21 +1,20 @@
-import { SQS } from 'aws-sdk';
-import { SendMessageBatchResultEntryList } from 'aws-sdk/clients/sqs';
+import { SQSClient, SendMessageBatchResultEntry } from '@aws-sdk/client-sqs';
 import { Message } from './types';
 interface ProducerOptions {
     queueUrl?: string;
     batchSize?: number;
-    sqs?: SQS;
+    sqs?: SQSClient;
     region?: string;
 }
 export declare class Producer {
     static create: (options: ProducerOptions) => Producer;
     queueUrl: string;
     batchSize: number;
-    sqs: SQS;
+    sqs: SQSClient;
     region?: string;
     constructor(options: ProducerOptions);
     queueSize(): Promise<number>;
-    send(messages: string | Message | (string | Message)[]): Promise<SendMessageBatchResultEntryList>;
+    send(messages: string | Message | (string | Message)[]): Promise<SendMessageBatchResultEntry[]>;
     private validate;
     private sendBatch;
 }

package/dist/producer.js

@@ -1,24 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Producer = void 0;
-const aws_sdk_1 = require("aws-sdk");
+const client_sqs_1 = require("@aws-sdk/client-sqs");
 const types_1 = require("./types");
-const requiredOptions = [
-    'queueUrl'
-];
+const requiredOptions = ['queueUrl'];
 class Producer {
     constructor(options) {
         this.validate(options);
         this.queueUrl = options.queueUrl;
         this.batchSize = options.batchSize || 10;
-        this.sqs = options.sqs || new aws_sdk_1.SQS(Object.assign(Object.assign({}, options), { region: options.region || 'eu-west-1' }));
+        this.sqs =
+            options.sqs ||
+                new client_sqs_1.SQSClient(Object.assign(Object.assign({}, options), { region: options.region || 'eu-west-1' }));
     }
     async queueSize() {
-        const result = await this.sqs.getQueueAttributes({
+        const command = new client_sqs_1.GetQueueAttributesCommand({
             QueueUrl: this.queueUrl,
             AttributeNames: ['ApproximateNumberOfMessages']
-        }).promise();
-        return Number(result && result.Attributes && result.Attributes.ApproximateNumberOfMessages);
+        });
+        const result = await this.sqs.send(command);
+        return Number(result &&
+            result.Attributes &&
+            result.Attributes.ApproximateNumberOfMessages);
     }
     async send(messages) {
         const failedMessages = [];
@@ -44,7 +47,8 @@ class Producer {
             QueueUrl: this.queueUrl,
             Entries: batch.map(types_1.toEntry)
         };
-        const result = await this.sqs.sendMessageBatch(params).promise();
+        const command = new client_sqs_1.SendMessageBatchCommand(params);
+        const result = await this.sqs.send(command);
         const failedMessagesBatch = failedMessages.concat(result.Failed.map((entry) => entry.Id));
         const successfulMessagesBatch = successfulMessages.concat(result.Successful);
         if (endIndex < messages.length) {

package/dist/types.d.ts

@@ -1,11 +1,12 @@
-import { SQS } from 'aws-sdk';
-import { SendMessageBatchRequestEntry } from 'aws-sdk/clients/sqs';
+import { SendMessageBatchRequestEntry, MessageAttributeValue } from '@aws-sdk/client-sqs';
 export interface Message {
     id: string;
     body: string;
     groupId?: string;
     deduplicationId?: string;
     delaySeconds?: number;
-    messageAttributes?: SQS.MessageBodyAttributeMap;
+    messageAttributes?: {
+        [key: string]: MessageAttributeValue;
+    };
 }
 export declare function toEntry(message: string | Message): SendMessageBatchRequestEntry;

package/dist/types.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toEntry = void 0;
-const { isObject, isString, isMessageAttributeValid } = require('./validation');
+const validation_1 = require("./validation");
 function entryFromObject(message) {
     if (!message.body) {
         throw new Error(`Object messages must have 'body' prop`);
@@ -13,7 +13,7 @@ function entryFromObject(message) {
         throw new Error(`FIFO Queue messages must have 'groupId' prop`);
     }
     if (message.id) {
-        if (!isString(message.id)) {
+        if (!(0, validation_1.isString)(message.id)) {
             throw new Error('Message.id value must be a string');
         }
     }
@@ -22,27 +22,28 @@ function entryFromObject(message) {
         MessageBody: message.body
     };
     if (message.delaySeconds) {
-        if ((typeof message.delaySeconds !== 'number') ||
-            (message.delaySeconds < 0 || message.delaySeconds > 900)) {
+        if (typeof message.delaySeconds !== 'number' ||
+            message.delaySeconds < 0 ||
+            message.delaySeconds > 900) {
             throw new Error('Message.delaySeconds value must be a number contained within [0 - 900]');
         }
         entry.DelaySeconds = message.delaySeconds;
     }
     if (message.messageAttributes) {
-        if (!isObject(message.messageAttributes)) {
+        if (!(0, validation_1.isObject)(message.messageAttributes)) {
             throw new Error('Message.messageAttributes must be an object');
         }
-        Object.values(message.messageAttributes).every(isMessageAttributeValid);
+        Object.values(message.messageAttributes).every(validation_1.isMessageAttributeValid);
         entry.MessageAttributes = message.messageAttributes;
     }
     if (message.groupId) {
-        if (!isString(message.groupId)) {
+        if (!(0, validation_1.isString)(message.groupId)) {
             throw new Error('Message.groupId value must be a string');
         }
         entry.MessageGroupId = message.groupId;
     }
     if (message.deduplicationId) {
-        if (!isString(message.deduplicationId)) {
+        if (!(0, validation_1.isString)(message.deduplicationId)) {
             throw new Error('Message.deduplicationId value must be a string');
         }
         entry.MessageDeduplicationId = message.deduplicationId;
@@ -56,10 +57,10 @@ function entryFromString(message) {
     };
 }
 function toEntry(message) {
-    if (isString(message)) {
+    if ((0, validation_1.isString)(message)) {
         return entryFromString(message);
     }
-    if (isObject(message)) {
+    if ((0, validation_1.isObject)(message)) {
         return entryFromObject(message);
     }
     throw new Error('A message can either be an object or a string');

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "sqs-producer",
-  "version": "2.2.0",
+  "version": "3.0.0-alpha.1",
   "description": "Enqueues messages onto a given SQS queue",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "mocha --recursive --full-trace --exit",
-    "posttest": "npm run lint",
+    "posttest": "npm run lint && npm run format:check",
     "coverage": "nyc mocha && nyc report --reporter=html && nyc report --reporter=json-summary",
     "lcov": "nyc mocha && nyc report --reporter=lcov",
-    "lint": "tsc --noEmit",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --loglevel warn --write \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
+    "format:check": "prettier --check \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
     "build": "npm run clean && tsc",
     "prepublish": "npm run build",
     "pretest": "npm run build",
@@ -41,17 +44,21 @@
     "@types/node": "^18.11.12",
     "@types/sinon": "^10.0.13",
     "chai": "^4.3.7",
+    "eslint": "^8.29.0",
+    "eslint-config-iplayer-ts": "^4.1.0",
+    "eslint-config-prettier": "^4.3.0",
     "mocha": "^10.1.0",
     "nyc": "^15.1.0",
+    "prettier": "^2.8.1",
     "sinon": "^15.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
   },
   "dependencies": {
-    "aws-sdk": "^2.1271.0"
+    "@aws-sdk/client-sqs": "^3.226.0"
   },
   "peerDependencies": {
-    "aws-sdk": "^2.1271.0"
+    "@aws-sdk/client-sqs": "^3.226.0"
   },
   "mocha": {
     "spec": "test/**/**/*.test.ts",
@@ -69,5 +76,30 @@
     ],
     "sourceMap": true,
     "instrument": true
+  },
+  "eslintConfig": {
+    "extends": [
+      "iplayer-ts",
+      "prettier",
+      "prettier/react",
+      "prettier/@typescript-eslint"
+    ],
+    "parserOptions": {
+      "sourceType": "module"
+    },
+    "rules": {
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          "selector": "variable",
+          "format": [
+            "camelCase",
+            "UPPER_CASE",
+            "PascalCase"
+          ],
+          "leadingUnderscore": "allow"
+        }
+      ]
+    }
   }
 }

package/src/producer.ts

@@ -1,14 +1,16 @@
-import { SQS } from 'aws-sdk';
-import { SendMessageBatchResultEntryList } from 'aws-sdk/clients/sqs';
+import {
+  SQSClient,
+  SendMessageBatchResultEntry,
+  SendMessageBatchCommand,
+  GetQueueAttributesCommand
+} from '@aws-sdk/client-sqs';
 import { Message, toEntry } from './types';
-const requiredOptions = [
-  'queueUrl'
-];
+const requiredOptions = ['queueUrl'];
 
 interface ProducerOptions {
   queueUrl?: string;
   batchSize?: number;
-  sqs?: SQS;
+  sqs?: SQSClient;
   region?: string;
 }
 
@@ -16,35 +18,50 @@ export class Producer {
   static create: (options: ProducerOptions) => Producer;
   queueUrl: string;
   batchSize: number;
-  sqs: SQS;
+  sqs: SQSClient;
   region?: string;
 
   constructor(options: ProducerOptions) {
     this.validate(options);
     this.queueUrl = options.queueUrl;
     this.batchSize = options.batchSize || 10;
-    this.sqs = options.sqs || new SQS({
-      ...options,
-      region: options.region || 'eu-west-1'
-    });
+    this.sqs =
+      options.sqs ||
+      new SQSClient({
+        ...options,
+        region: options.region || 'eu-west-1'
+      });
   }
 
   async queueSize(): Promise<number> {
-    const result = await this.sqs.getQueueAttributes({
+    const command = new GetQueueAttributesCommand({
       QueueUrl: this.queueUrl,
       AttributeNames: ['ApproximateNumberOfMessages']
-    }).promise();
+    });
 
-    return Number(result && result.Attributes && result.Attributes.ApproximateNumberOfMessages);
+    const result = await this.sqs.send(command);
+
+    return Number(
+      result &&
+        result.Attributes &&
+        result.Attributes.ApproximateNumberOfMessages
+    );
   }
 
-  async send(messages: string | Message | (string | Message)[]): Promise<SendMessageBatchResultEntryList> {
+  async send(
+    messages: string | Message | (string | Message)[]
+  ): Promise<SendMessageBatchResultEntry[]> {
     const failedMessages = [];
     const successfulMessages = [];
     const startIndex = 0;
     const messagesArr = !Array.isArray(messages) ? [messages] : messages;
 
-    return this.sendBatch(failedMessages, successfulMessages, messagesArr, startIndex);
+    return this.sendBatch(
+      failedMessages,
+      successfulMessages,
+      messagesArr,
+      startIndex
+    );
   }
 
   private validate(options: ProducerOptions): void {
@@ -58,7 +75,12 @@ export class Producer {
     }
   }
 
-  private async sendBatch(failedMessages?: string[], successfulMessages?: SendMessageBatchResultEntryList, messages?: (string | Message)[], startIndex?: number): Promise<SendMessageBatchResultEntryList> {
+  private async sendBatch(
+    failedMessages?: string[],
+    successfulMessages?: SendMessageBatchResultEntry[],
+    messages?: (string | Message)[],
+    startIndex?: number
+  ): Promise<SendMessageBatchResultEntry[]> {
     const endIndex = startIndex + this.batchSize;
     const batch = messages.slice(startIndex, endIndex);
     const params = {
@@ -66,20 +88,31 @@ export class Producer {
       Entries: batch.map(toEntry)
     };
 
-    const result = await this.sqs.sendMessageBatch(params).promise();
-    const failedMessagesBatch = failedMessages.concat(result.Failed.map((entry) => entry.Id));
-    const successfulMessagesBatch = successfulMessages.concat(result.Successful);
+    const command = new SendMessageBatchCommand(params);
+    const result = await this.sqs.send(command);
+    const failedMessagesBatch = failedMessages.concat(
+      result.Failed.map((entry) => entry.Id)
+    );
+    const successfulMessagesBatch = successfulMessages.concat(
+      result.Successful
+    );
 
     if (endIndex < messages.length) {
-      return this.sendBatch(failedMessagesBatch, successfulMessagesBatch, messages, endIndex);
+      return this.sendBatch(
+        failedMessagesBatch,
+        successfulMessagesBatch,
+        messages,
+        endIndex
+      );
     }
 
     if (failedMessagesBatch.length === 0) {
       return successfulMessagesBatch;
     }
-    throw new Error(`Failed to send messages: ${failedMessagesBatch.join(', ')}`);
+    throw new Error(
+      `Failed to send messages: ${failedMessagesBatch.join(', ')}`
+    );
   }
-
 }
 
 Producer.create = (options: ProducerOptions): Producer => {

package/src/types.ts

@@ -1,88 +1,101 @@
-import { SQS } from 'aws-sdk';
-import { SendMessageBatchRequestEntry } from 'aws-sdk/clients/sqs';
-const { isObject, isString, isMessageAttributeValid } = require('./validation');
+import {
+  SendMessageBatchRequestEntry,
+  MessageAttributeValue
+} from '@aws-sdk/client-sqs';
+import { isObject, isString, isMessageAttributeValid } from './validation';
 
 export interface Message {
-    id: string;
-    body: string;
-    groupId?: string;
-    deduplicationId?: string;
-    delaySeconds?: number;
-    messageAttributes?: SQS.MessageBodyAttributeMap;
+  id: string;
+  body: string;
+  groupId?: string;
+  deduplicationId?: string;
+  delaySeconds?: number;
+  messageAttributes?: { [key: string]: MessageAttributeValue };
 }
 
 function entryFromObject(message: Message): SendMessageBatchRequestEntry {
-    if (!message.body) {
-        throw new Error(`Object messages must have 'body' prop`);
-    }
+  if (!message.body) {
+    throw new Error(`Object messages must have 'body' prop`);
+  }
 
-    if (!message.groupId && !message.deduplicationId && !message.id) {
-        throw new Error(`Object messages must have 'id' prop`);
-    }
+  if (!message.groupId && !message.deduplicationId && !message.id) {
+    throw new Error(`Object messages must have 'id' prop`);
+  }
 
-    if (message.deduplicationId && !message.groupId) {
-        throw new Error(`FIFO Queue messages must have 'groupId' prop`);
-    }
+  if (message.deduplicationId && !message.groupId) {
+    throw new Error(`FIFO Queue messages must have 'groupId' prop`);
+  }
 
-    if (message.id) {
-        if (!isString(message.id)) {
-            throw new Error('Message.id value must be a string');
-        }
+  if (message.id) {
+    if (!isString(message.id)) {
+      throw new Error('Message.id value must be a string');
+    }
+  }
+
+  const entry: SendMessageBatchRequestEntry = {
+    Id: message.id,
+    MessageBody: message.body
+  };
+
+  if (message.delaySeconds) {
+    if (
+      typeof message.delaySeconds !== 'number' ||
+      message.delaySeconds < 0 ||
+      message.delaySeconds > 900
+    ) {
+      throw new Error(
+        'Message.delaySeconds value must be a number contained within [0 - 900]'
+      );
     }
 
-    const entry: SendMessageBatchRequestEntry = {
-        Id: message.id,
-        MessageBody: message.body
-    };
-
-    if (message.delaySeconds) {
-        if ((typeof message.delaySeconds !== 'number') ||
-            (message.delaySeconds < 0 || message.delaySeconds > 900)) {
-            throw new Error('Message.delaySeconds value must be a number contained within [0 - 900]');
-        }
+    entry.DelaySeconds = message.delaySeconds;
+  }
 
-        entry.DelaySeconds = message.delaySeconds;
+  if (message.messageAttributes) {
+    if (!isObject(message.messageAttributes)) {
+      throw new Error('Message.messageAttributes must be an object');
     }
 
-    if (message.messageAttributes) {
-        if (!isObject(message.messageAttributes)) {
-            throw new Error('Message.messageAttributes must be an object');
-        }
+    Object.values(message.messageAttributes).every(isMessageAttributeValid);
 
-        Object.values(message.messageAttributes).every(isMessageAttributeValid);
+    entry.MessageAttributes = message.messageAttributes;
+  }
 
-        entry.MessageAttributes = message.messageAttributes;
+  if (message.groupId) {
+    if (!isString(message.groupId)) {
+      throw new Error('Message.groupId value must be a string');
     }
 
-    if (message.groupId) {
-        if (!isString(message.groupId)) {
-            throw new Error('Message.groupId value must be a string');
-        }
+    entry.MessageGroupId = message.groupId;
+  }
 
-        entry.MessageGroupId = message.groupId;
+  if (message.deduplicationId) {
+    if (!isString(message.deduplicationId)) {
+      throw new Error('Message.deduplicationId value must be a string');
     }
 
-    if (message.deduplicationId) {
-        if (!isString(message.deduplicationId)) {
-            throw new Error('Message.deduplicationId value must be a string');
-        }
-
-        entry.MessageDeduplicationId = message.deduplicationId;
-    }
+    entry.MessageDeduplicationId = message.deduplicationId;
+  }
 
-    return entry;
+  return entry;
 }
 
 function entryFromString(message: string): SendMessageBatchRequestEntry {
-    return {
-        Id: message,
-        MessageBody: message
-    };
+  return {
+    Id: message,
+    MessageBody: message
+  };
 }
 
-export function toEntry(message: string | Message): SendMessageBatchRequestEntry {
-    if (isString(message)) { return entryFromString(<string>message); }
-    if (isObject(message)) { return entryFromObject(<Message>message); }
-
-    throw new Error('A message can either be an object or a string');
+export function toEntry(
+  message: string | Message
+): SendMessageBatchRequestEntry {
+  if (isString(message)) {
+    return entryFromString(message as string);
+  }
+  if (isObject(message)) {
+    return entryFromObject(message as Message);
+  }
+
+  throw new Error('A message can either be an object or a string');
 }

package/src/validation.ts

@@ -1,18 +1,17 @@
-
 export function isString(value: any): boolean {
-    return typeof value === 'string' || value instanceof String;
+  return typeof value === 'string' || value instanceof String;
 }
 
 export function isObject(value: any): boolean {
-    return value && typeof value === 'object' && value instanceof Object;
+  return value && typeof value === 'object' && value instanceof Object;
 }
 
 export function isMessageAttributeValid(messageAttribute: any): boolean {
-    if (!messageAttribute.DataType) {
-        throw new Error('A MessageAttribute must have a DataType key');
-    }
-    if (!isString(messageAttribute.DataType)) {
-        throw new Error('The DataType key of a MessageAttribute must be a String');
-    }
-    return true;
+  if (!messageAttribute.DataType) {
+    throw new Error('A MessageAttribute must have a DataType key');
+  }
+  if (!isString(messageAttribute.DataType)) {
+    throw new Error('The DataType key of a MessageAttribute must be a String');
+  }
+  return true;
 }

package/tsconfig.json

@@ -9,11 +9,6 @@
     "noUnusedLocals": true,
     "declaration": true
   },
-  "include": [
-    "src/**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
 }