@qrvey/sms 0.0.1

package/README.md

@@ -0,0 +1,74 @@
+# @qrvey/sms
+
+![install size](https://packagephobia.now.sh/badge?p=%40qrvey%2Fsms)
+![coverage](https://img.shields.io/badge/unit_test_coverage-87%25-brightgreen)
+
+**@qrvey/sms** is a lightweight and reliable library to send manage sms messages. It supports different clients such SNS (AWS), ACS (Azure), Twilio, and Vonage.
+
+## Installation
+
+You can install the **@qrvey/sms** package via npm. Run the following command in your terminal:
+
+```bash
+npm install @qrvey/sms
+```
+
+## Configuration
+
+To work properly, the package need some env variables. To set the sms provider, you must set the `SMS_PROVIDER` env variable with one of these values:
+- `AWS`
+- `AZURE`
+- `TWILIO`
+- `VONAGE`
+
+In case the `SMS_PROVIDER` env variable is set with an unknown value, you will get a `UnknownProvider` error. Depending on the provider you must set some variables:
+
+### AWS
+If you set `SMS_PROVIDER = AWS`, the following env variables are required:
+- `SMS_PROVIDER_USERNAME` which is `AWS_ACCESS_KEY_ID` in aws context.
+- `SMS_PROVIDER_PASSWORD` which is `AWS_SECRET_ACCESS_KEY` in aws context.
+- `SMS_PROVIDER_REGION` which is `AWS_REGION` in aws context.
+
+### AZURE
+If you set `SMS_PROVIDER = AZURE`, the following env variables are required:
+- `SMS_PROVIDER_USERNAME` which is `resource-name` in azure `connectionString` context.
+- `SMS_PROVIDER_PASSWORD` which is `access-key` in azure `connectionString` context.
+- `SMS_PROVIDER_FROM_NUMBER` which is the ACS-registered number in azure context. This must be in E.164 format, example: "+123456789"
+
+**Note**: The azure `connectionString` for `Azure Communication Services` looks like this: `endpoint=https://<resource-name>.communication.azure.com/;accesskey=<access-key>`.
+
+### TWILIO
+If you set `SMS_PROVIDER = TWILIO`, the following env variables are required:
+- `SMS_PROVIDER_USERNAME` which is `TWILIO_ACCOUNT_SID` in twilio context.
+- `SMS_PROVIDER_PASSWORD` which is `TWILIO_AUTH_TOKEN` in twilio context.
+
+### VONAGE
+If you set `SMS_PROVIDER = VONAGE`, the following env variables are required:
+- `SMS_PROVIDER_USERNAME` which is `VONAGE_API_KEY` in vonage context.
+- `SMS_PROVIDER_PASSWORD` which is `VONAGE_API_SECRET` in vonage context.
+- `SMS_PROVIDER_FROM_NUMBER` which can be one of the next: 
+    - An alphanumeric ID. Example: "MyCompanyBrand"
+    - A Vonage-registered number in E.164 format. Example: "+123456789".
+    - A local-registered short number. Example: "12345".
+
+## API Documentation
+
+### Available Methods
+
+```ts
+send: (phones: string[], message: string) => Promise<SendResult>;
+```
+
+
+## Example Usage
+
+```ts
+const phones: string[] = [
+    "+123456789",
+    "+9876543210"
+];
+const message = "Hello world!";
+
+const smsSenderService = new SMSSenderService();
+await smsSenderService.send(phones, message);
+```

package/__tests__/__mocks__/SMSSender.mock.ts

@@ -0,0 +1,10 @@
+import { ISMSSender } from '../../src/interfaces';
+import { SendResult } from '../../src/types';
+
+export class SMSSender implements ISMSSender {
+    send = (phones: string[], message: string): Promise<SendResult> =>
+        Promise.resolve({
+            sent: phones.map((phone) => ({phone})),
+            failed: [{phone: '+0987654321', error: "Something went wrong"}],
+        });
+}

package/coverageReader.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+lcovFilePath="./coverage/lcov.info"
+
+# Read lcov.info
+if [ ! -f "$lcovFilePath" ]; then
+    echo "Error: $lcovFilePath not found."
+    exit 1
+fi
+
+totalLines=0
+coveredLines=0
+
+while read -r line; do
+    if [[ "$line" == "LF:"* ]]; then
+        found=$(echo "$line" | cut -d':' -f2)
+        totalLines=$((totalLines + found))
+    elif [[ "$line" == "LH:"* ]]; then
+        hit=$(echo "$line" | cut -d':' -f2)
+        coveredLines=$((coveredLines + hit))
+    fi
+done <"$lcovFilePath"
+
+# Calculate coverage percent
+if [ "$totalLines" -ne 0 ]; then
+    coveragePercentage=$(echo "scale=2; ($coveredLines / $totalLines) * 100" | bc)
+    coveragePercentage=$(printf "%.0f" "$coveragePercentage")
+else
+    coveragePercentage=0
+fi
+
+# Update README.md
+updateReadme() {
+    local readmePath="./README.md"
+    local badgeRegex="(https://img.shields.io/badge/unit_test_coverage-)[0-9.]+(%25-brightgreen)"
+    local badgeURL="https://img.shields.io/badge/unit_test_coverage-${coveragePercentage}%25-brightgreen"
+
+    # Read current content of README.md
+    readmeContent=$(<"$readmePath")
+
+    # Replace coverage percent before the '%' character in the badge
+    newReadmeContent=$(echo "$readmeContent" | sed -E "s|${badgeRegex}|${badgeURL}|")
+
+    # Overwrite README.md file with the modified content
+    echo "$newReadmeContent" >"$readmePath"
+}
+
+updateReadme
+
+echo "Coverage percent: ${coveragePercentage}%"

package/dist/cjs/errors/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./unknownProvider.error"), exports);
+__exportStar(require("./notProvidedCredentials.error"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,iEAA+C"}

package/dist/cjs/errors/notProvidedCredentials.error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotProvidedCredentialsError = void 0;
+class NotProvidedCredentialsError extends Error {
+    constructor() {
+        super('SMS sender credentials not provided.');
+        this.name = 'NotProvidedCredentialsError';
+    }
+}
+exports.NotProvidedCredentialsError = NotProvidedCredentialsError;
+//# sourceMappingURL=notProvidedCredentials.error.js.map

package/dist/cjs/errors/notProvidedCredentials.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notProvidedCredentials.error.js","sourceRoot":"","sources":["../../../src/errors/notProvidedCredentials.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,2BAA4B,SAAQ,KAAK;IAClD;QACI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAC;IAC9C,CAAC;CACJ;AALD,kEAKC"}

package/dist/cjs/errors/unknownProvider.error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnknownProviderError = void 0;
+class UnknownProviderError extends Error {
+    constructor() {
+        super('Unknown provider. Set PROVIDER env variable');
+        this.name = 'UnknownProviderError';
+    }
+}
+exports.UnknownProviderError = UnknownProviderError;
+//# sourceMappingURL=unknownProvider.error.js.map

package/dist/cjs/errors/unknownProvider.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unknownProvider.error.js","sourceRoot":"","sources":["../../../src/errors/unknownProvider.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,oBAAqB,SAAQ,KAAK;IAC3C;QACI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACrD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACvC,CAAC;CACJ;AALD,oDAKC"}

package/dist/cjs/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMSSenderService = void 0;
+var services_1 = require("./services");
+Object.defineProperty(exports, "SMSSenderService", { enumerable: true, get: function () { return services_1.SMSSenderService; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAA8C;AAArC,4GAAA,gBAAgB,OAAA"}

package/dist/cjs/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./smsSender.interface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC"}

package/dist/cjs/interfaces/smsSender.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=smsSender.interface.js.map

package/dist/cjs/interfaces/smsSender.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smsSender.interface.js","sourceRoot":"","sources":["../../../src/interfaces/smsSender.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/services/clients/awsSmsSender.client.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const errors_1 = require("../../errors");
+const constants_1 = require("../../utils/constants");
+const client_sns_1 = require("@aws-sdk/client-sns");
+class AwsSMSSenderClient {
+    constructor() {
+        this._send = async (phone, message) => {
+            const command = new client_sns_1.PublishCommand({
+                Message: message,
+                PhoneNumber: phone,
+            });
+            return await this.client.send(command);
+        };
+        if (!(constants_1.USERNAME && constants_1.PASSWORD))
+            throw new errors_1.NotProvidedCredentialsError();
+        this.client = new client_sns_1.SNSClient({
+            region: constants_1.REGION,
+            credentials: {
+                accessKeyId: constants_1.USERNAME,
+                secretAccessKey: constants_1.PASSWORD,
+            },
+        });
+    }
+    async send(phones = [], message) {
+        const result = {
+            sent: [],
+            failed: [],
+        };
+        await Promise.all(phones.map((phone) => this._send(phone, message)
+            .then(() => result.sent.push({ phone }))
+            .catch((error) => result.failed.push({ phone, error: error.message }))));
+        return result;
+    }
+}
+exports.default = AwsSMSSenderClient;
+//# sourceMappingURL=awsSmsSender.client.js.map

package/dist/cjs/services/clients/awsSmsSender.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"awsSmsSender.client.js","sourceRoot":"","sources":["../../../../src/services/clients/awsSmsSender.client.ts"],"names":[],"mappings":";;AAAA,yCAA2D;AAG3D,qDAAmE;AACnE,oDAI6B;AAE7B,MAAqB,kBAAkB;IAEnC;QAiCQ,UAAK,GAAG,KAAK,EACjB,KAAa,EACb,OAAe,EACc,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,2BAAc,CAAC;gBAC/B,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE,KAAK;aACrB,CAAC,CAAC;YAEH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC,CAAC;QA1CE,IAAI,CAAC,CAAC,oBAAQ,IAAI,oBAAQ,CAAC;YAAE,MAAM,IAAI,oCAA2B,EAAE,CAAC;QACrE,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAS,CAAC;YACxB,MAAM,EAAE,kBAAM;YACd,WAAW,EAAE;gBACT,WAAW,EAAE,oBAAQ;gBACrB,eAAe,EAAE,oBAAQ;aAC5B;SACJ,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,IAAI,CACb,SAAmB,EAAE,EACrB,OAAe;QAEf,MAAM,MAAM,GAAe;YACvB,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,EAAE;SACb,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CACb,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACjB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC;aACrB,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;aACvC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CACtD,CACR,CACJ,CAAC;QAEF,OAAO,MAAM,CAAC;IAClB,CAAC;CAaJ;AA9CD,qCA8CC"}

package/dist/cjs/services/clients/azureSmsSender.client.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const errors_1 = require("../../errors");
+const constants_1 = require("../../utils/constants");
+const communication_sms_1 = require("@azure/communication-sms");
+class AzureSMSSenderClient {
+    constructor() {
+        if (!(constants_1.USERNAME && constants_1.PASSWORD && constants_1.FROM))
+            throw new errors_1.NotProvidedCredentialsError();
+        const connectionString = `endpoint=https://${constants_1.USERNAME}.communication.azure.com/;accesskey=${constants_1.PASSWORD}`;
+        this.client = new communication_sms_1.SmsClient(connectionString);
+    }
+    async send(phones, message) {
+        const result = {
+            sent: [],
+            failed: [],
+        };
+        const smsResults = await this.client.send({
+            from: constants_1.FROM,
+            to: phones,
+            message: message,
+        });
+        smsResults.forEach((smsResult) => {
+            if (smsResult.errorMessage)
+                result.failed.push({
+                    phone: smsResult.to,
+                    error: smsResult.errorMessage,
+                });
+            else
+                result.sent.push({ phone: smsResult.to });
+        });
+        return result;
+    }
+}
+exports.default = AzureSMSSenderClient;
+//# sourceMappingURL=azureSmsSender.client.js.map

package/dist/cjs/services/clients/azureSmsSender.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"azureSmsSender.client.js","sourceRoot":"","sources":["../../../../src/services/clients/azureSmsSender.client.ts"],"names":[],"mappings":";;AAAA,yCAA2D;AAG3D,qDAAiE;AACjE,gEAAqD;AAErD,MAAqB,oBAAoB;IAErC;QACI,IAAI,CAAC,CAAC,oBAAQ,IAAI,oBAAQ,IAAI,gBAAI,CAAC;YAC/B,MAAM,IAAI,oCAA2B,EAAE,CAAC;QAC5C,MAAM,gBAAgB,GAAG,oBAAoB,oBAAQ,uCAAuC,oBAAQ,EAAE,CAAC;QACvG,IAAI,CAAC,MAAM,GAAG,IAAI,6BAAS,CAAC,gBAAgB,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAAgB,EAAE,OAAe;QAC/C,MAAM,MAAM,GAAe;YACvB,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,EAAE;SACb,CAAC;QACF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACtC,IAAI,EAAE,gBAAc;YACpB,EAAE,EAAE,MAAM;YACV,OAAO,EAAE,OAAO;SACnB,CAAC,CAAC;QAEH,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC7B,IAAI,SAAS,CAAC,YAAY;gBACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,SAAS,CAAC,EAAE;oBACnB,KAAK,EAAE,SAAS,CAAC,YAAY;iBAChC,CAAC,CAAC;;gBACF,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AA/BD,uCA+BC"}

package/dist/cjs/services/clients/twilioSmsSender.client.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const twilio_1 = require("twilio");
+const constants_1 = require("../../utils/constants");
+const errors_1 = require("../../errors");
+class TwilioSMSSenderClient {
+    constructor() {
+        this._send = (phone, message) => this.client.messages.create({
+            from: constants_1.FROM,
+            to: phone,
+            body: message,
+        });
+        if (constants_1.USERNAME && constants_1.PASSWORD)
+            this.client = new twilio_1.Twilio(constants_1.USERNAME, constants_1.PASSWORD);
+        else
+            throw new errors_1.NotProvidedCredentialsError();
+    }
+    async send(phones = [], message) {
+        const sentMessages = await Promise.all(phones.map((phone) => this._send(phone, message)));
+        const result = {
+            sent: [],
+            failed: [],
+        };
+        sentMessages.forEach((message) => {
+            if (message.errorMessage) {
+                result.failed.push({
+                    phone: message.to,
+                    error: message.errorMessage,
+                });
+            }
+            else {
+                result.sent.push({
+                    phone: message.to,
+                });
+            }
+        });
+        return result;
+    }
+}
+exports.default = TwilioSMSSenderClient;
+//# sourceMappingURL=twilioSmsSender.client.js.map

package/dist/cjs/services/clients/twilioSmsSender.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"twilioSmsSender.client.js","sourceRoot":"","sources":["../../../../src/services/clients/twilioSmsSender.client.ts"],"names":[],"mappings":";;AACA,mCAAgC;AAChC,qDAAiE;AAGjE,yCAA2D;AAE3D,MAAqB,qBAAqB;IAEtC;QAiCQ,UAAK,GAAG,CACZ,KAAa,EACb,OAAe,EACS,EAAE,CAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YACxB,IAAI,EAAE,gBAAI;YACV,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,OAAO;SAChB,CAAC,CAAC;QAxCH,IAAI,oBAAQ,IAAI,oBAAQ;YAAE,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,oBAAQ,EAAE,oBAAQ,CAAC,CAAC;;YAClE,MAAM,IAAI,oCAA2B,EAAE,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,IAAI,CACb,SAAmB,EAAE,EACrB,OAAe;QAEf,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CACpD,CAAC;QAEF,MAAM,MAAM,GAAe;YACvB,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,EAAE;SACb,CAAC;QACF,YAAY,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,OAAO,CAAC,YAAY,EAAE;gBACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,OAAO,CAAC,EAAE;oBACjB,KAAK,EAAE,OAAO,CAAC,YAAY;iBAC9B,CAAC,CAAC;aACN;iBAAM;gBACH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;oBACb,KAAK,EAAE,OAAO,CAAC,EAAE;iBACpB,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;CAWJ;AA5CD,wCA4CC"}

package/dist/cjs/services/clients/vonageSmsSender.client.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const server_sdk_1 = require("@vonage/server-sdk");
+const auth_1 = require("@vonage/auth");
+const constants_1 = require("../../utils/constants");
+const errors_1 = require("../../errors");
+class VonageSMSSenderClient {
+    constructor() {
+        this.send = async (phones, message) => {
+            const result = {
+                sent: [],
+                failed: [],
+            };
+            await Promise.all(phones.map((phone) => this._send(phone, message)
+                .then(() => result.sent.push({ phone }))
+                .catch((error) => result.failed.push({ phone, error: error.message }))));
+            return result;
+        };
+        this._send = (phone, message) => this.client.sms.send({
+            to: phone,
+            text: message,
+            from: constants_1.FROM,
+        });
+        if (!(constants_1.USERNAME && constants_1.PASSWORD && constants_1.FROM))
+            throw new errors_1.NotProvidedCredentialsError();
+        const vonageAuth = new auth_1.Auth({
+            apiKey: constants_1.USERNAME,
+            apiSecret: constants_1.PASSWORD,
+        });
+        this.client = new server_sdk_1.Vonage(vonageAuth);
+    }
+}
+exports.default = VonageSMSSenderClient;
+//# sourceMappingURL=vonageSmsSender.client.js.map

package/dist/cjs/services/clients/vonageSmsSender.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vonageSmsSender.client.js","sourceRoot":"","sources":["../../../../src/services/clients/vonageSmsSender.client.ts"],"names":[],"mappings":";;AAEA,mDAA4C;AAC5C,uCAAoC;AACpC,qDAAiE;AACjE,yCAA2D;AAG3D,MAAqB,qBAAqB;IAEtC;QAUO,SAAI,GAAG,KAAK,EACf,MAAgB,EAChB,OAAe,EACI,EAAE;YACrB,MAAM,MAAM,GAAe;gBACvB,IAAI,EAAE,EAAE;gBACR,MAAM,EAAE,EAAE;aACb,CAAC;YAEF,MAAM,OAAO,CAAC,GAAG,CACb,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACjB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC;iBACrB,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;iBACvC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CACb,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CACtD,CACR,CACJ,CAAC;YAEF,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC;QAEM,UAAK,GAAG,CAAC,KAAa,EAAE,OAAe,EAAwB,EAAE,CACrE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YACjB,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,gBAAc;SACvB,CAAC,CAAC;QApCH,IAAI,CAAC,CAAC,oBAAQ,IAAI,oBAAQ,IAAI,gBAAI,CAAC;YAC/B,MAAM,IAAI,oCAA2B,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,WAAI,CAAC;YACxB,MAAM,EAAE,oBAAQ;YAChB,SAAS,EAAE,oBAAQ;SACtB,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAM,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;CA8BJ;AAxCD,wCAwCC"}

package/dist/cjs/services/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./smsSender.service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC"}

package/dist/cjs/services/smsSender.service.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMSSenderService = void 0;
+const smsSenderFactory_service_1 = require("./smsSenderFactory.service");
+class SMSSenderService {
+    constructor() {
+        /**
+         * Send a message to one or more phones.
+         * @param phones - phone numbers to send to
+         * @param message - message to send
+         * @returns {Promise<SendResult>} Send result.
+         */
+        this.send = async (phones, message) => (await smsSenderFactory_service_1.SMSSenderFactory.getSMSSender()).send(phones, message);
+    }
+}
+exports.SMSSenderService = SMSSenderService;
+//# sourceMappingURL=smsSender.service.js.map

package/dist/cjs/services/smsSender.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smsSender.service.js","sourceRoot":"","sources":["../../../src/services/smsSender.service.ts"],"names":[],"mappings":";;;AACA,yEAA8D;AAE9D,MAAa,gBAAgB;IAA7B;QACI;;;;;WAKG;QACI,SAAI,GAAG,KAAK,EACf,MAAgB,EAChB,OAAe,EACI,EAAE,CACrB,CAAC,MAAM,2CAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CAAA;AAZD,4CAYC"}

package/dist/cjs/services/smsSenderFactory.service.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMSSenderFactory = void 0;
+const errors_1 = require("../errors");
+const constants_1 = require("../utils/constants");
+class SMSSenderFactory {
+    static async getSMSSender() {
+        const provider = constants_1.SMS_PROVIDER === null || constants_1.SMS_PROVIDER === void 0 ? void 0 : constants_1.SMS_PROVIDER.toLowerCase();
+        if (!provider)
+            throw new errors_1.UnknownProviderError();
+        const { default: SMSSender } = await this.providerModules[provider]();
+        return new SMSSender();
+    }
+}
+exports.SMSSenderFactory = SMSSenderFactory;
+SMSSenderFactory.providerModules = {
+    twilio: () => Promise.resolve().then(() => __importStar(require('./clients/twilioSmsSender.client'))),
+    aws: () => Promise.resolve().then(() => __importStar(require('./clients/awsSmsSender.client'))),
+    azure: () => Promise.resolve().then(() => __importStar(require('./clients/azureSmsSender.client'))),
+    vonage: () => Promise.resolve().then(() => __importStar(require('./clients/vonageSmsSender.client'))),
+};
+//# sourceMappingURL=smsSenderFactory.service.js.map

package/dist/cjs/services/smsSenderFactory.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smsSenderFactory.service.js","sourceRoot":"","sources":["../../../src/services/smsSenderFactory.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sCAAiD;AAGjD,kDAAkD;AAElD,MAAa,gBAAgB;IAWzB,MAAM,CAAC,KAAK,CAAC,YAAY;QACrB,MAAM,QAAQ,GAAG,wBAAY,aAAZ,wBAAY,uBAAZ,wBAAY,CAAE,WAAW,EAAE,CAAC;QAC7C,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,6BAAoB,EAAE,CAAC;QAEhD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,OAAO,IAAI,SAAS,EAAE,CAAC;IAC3B,CAAC;;AAjBL,4CAkBC;AAjBkB,gCAAe,GAG1B;IACA,MAAM,EAAE,GAAG,EAAE,mDAAQ,kCAAkC,GAAC;IACxD,GAAG,EAAE,GAAG,EAAE,mDAAQ,+BAA+B,GAAC;IAClD,KAAK,EAAE,GAAG,EAAE,mDAAQ,iCAAiC,GAAC;IACtD,MAAM,EAAE,GAAG,EAAE,mDAAQ,kCAAkC,GAAC;CAC3D,CAAC"}

package/dist/cjs/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./sendResult.type"), exports);
+__exportStar(require("./smsProviderModule.type"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,2DAAyC"}

package/dist/cjs/types/sendResult.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sendResult.type.js.map

package/dist/cjs/types/sendResult.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendResult.type.js","sourceRoot":"","sources":["../../../src/types/sendResult.type.ts"],"names":[],"mappings":""}

package/dist/cjs/types/smsProviderModule.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=smsProviderModule.type.js.map

package/dist/cjs/types/smsProviderModule.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smsProviderModule.type.js","sourceRoot":"","sources":["../../../src/types/smsProviderModule.type.ts"],"names":[],"mappings":""}

package/dist/cjs/utils/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REGION = exports.FROM = exports.PASSWORD = exports.USERNAME = exports.SMS_PROVIDER = void 0;
+exports.SMS_PROVIDER = process.env.SMS_PROVIDER;
+exports.USERNAME = process.env.SMS_PROVIDER_USERNAME;
+exports.PASSWORD = process.env.SMS_PROVIDER_PASSWORD;
+exports.FROM = process.env.SMS_PROVIDER_FROM_NUMBER;
+exports.REGION = process.env.SMS_PROVIDER_REGION;
+//# sourceMappingURL=constants.js.map

package/dist/cjs/utils/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;AAExC,QAAA,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;AAC7C,QAAA,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;AAC7C,QAAA,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;AAC5C,QAAA,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC"}

package/dist/esm/awsSmsSender.client-DGZ2JYIG.mjs

@@ -0,0 +1,41 @@
+import { USERNAME, PASSWORD, NotProvidedCredentialsError, REGION } from './chunk-NCQDKWNI.mjs';
+import { PublishCommand, SNSClient } from '@aws-sdk/client-sns';
+
+var AwsSMSSenderClient = class {
+  constructor() {
+    this._send = async (phone, message) => {
+      const command = new PublishCommand({
+        Message: message,
+        PhoneNumber: phone
+      });
+      return await this.client.send(command);
+    };
+    if (!(USERNAME && PASSWORD))
+      throw new NotProvidedCredentialsError();
+    this.client = new SNSClient({
+      region: REGION,
+      credentials: {
+        accessKeyId: USERNAME,
+        secretAccessKey: PASSWORD
+      }
+    });
+  }
+  async send(phones = [], message) {
+    const result = {
+      sent: [],
+      failed: []
+    };
+    await Promise.all(
+      phones.map(
+        (phone) => this._send(phone, message).then(() => result.sent.push({ phone })).catch(
+          (error) => result.failed.push({ phone, error: error.message })
+        )
+      )
+    );
+    return result;
+  }
+};
+
+export { AwsSMSSenderClient as default };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=awsSmsSender.client-DGZ2JYIG.mjs.map

package/dist/esm/awsSmsSender.client-DGZ2JYIG.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/clients/awsSmsSender.client.ts"],"names":[],"mappings":";;;;;;;;AAIA;AAAA,EACI;AAAA,EAEA;AAAA,OACG;AAEP,IAAqB,qBAArB,MAA8D;AAAA,EAE1D,cAAc;AAiCd,SAAQ,QAAQ,OACZ,OACA,YACgC;AAChC,YAAM,UAAU,IAAI,eAAe;AAAA,QAC/B,SAAS;AAAA,QACT,aAAa;AAAA,MACjB,CAAC;AAED,aAAO,MAAM,KAAK,OAAO,KAAK,OAAO;AAAA,IACzC;AA1CI,QAAI,EAAE,YAAY;AAAW,YAAM,IAAI,4BAA4B;AACnE,SAAK,SAAS,IAAI,UAAU;AAAA,MACxB,QAAQ;AAAA,MACR,aAAa;AAAA,QACT,aAAa;AAAA,QACb,iBAAiB;AAAA,MACrB;AAAA,IACJ,CAAC;AAAA,EACL;AAAA,EAEA,MAAa,KACT,SAAmB,CAAC,GACpB,SACmB;AACnB,UAAM,SAAqB;AAAA,MACvB,MAAM,CAAC;AAAA,MACP,QAAQ,CAAC;AAAA,IACb;AAEA,UAAM,QAAQ;AAAA,MACV,OAAO;AAAA,QAAI,CAAC,UACR,KAAK,MAAM,OAAO,OAAO,EACpB,KAAK,MAAM,OAAO,KAAK,KAAK,EAAE,MAAM,CAAC,CAAC,EACtC;AAAA,UAAM,CAAC,UACJ,OAAO,OAAO,KAAK,EAAE,OAAO,OAAO,MAAM,QAAQ,CAAC;AAAA,QACtD;AAAA,MACR;AAAA,IACJ;AAEA,WAAO;AAAA,EACX;AAaJ","sourcesContent":["import { NotProvidedCredentialsError } from '../../errors';\nimport { ISMSSender } from '../../interfaces';\nimport { SendResult } from '../../types';\nimport { PASSWORD, REGION, USERNAME } from '../../utils/constants';\nimport {\n    PublishCommand,\n    PublishCommandOutput,\n    SNSClient,\n} from '@aws-sdk/client-sns';\n\nexport default class AwsSMSSenderClient implements ISMSSender {\n    private client: SNSClient;\n    constructor() {\n        if (!(USERNAME && PASSWORD)) throw new NotProvidedCredentialsError();\n        this.client = new SNSClient({\n            region: REGION,\n            credentials: {\n                accessKeyId: USERNAME,\n                secretAccessKey: PASSWORD,\n            },\n        });\n    }\n\n    public async send(\n        phones: string[] = [],\n        message: string,\n    ): Promise<SendResult> {\n        const result: SendResult = {\n            sent: [],\n            failed: [],\n        };\n\n        await Promise.all(\n            phones.map((phone) =>\n                this._send(phone, message)\n                    .then(() => result.sent.push({ phone }))\n                    .catch((error) =>\n                        result.failed.push({ phone, error: error.message }),\n                    ),\n            ),\n        );\n\n        return result;\n    }\n\n    private _send = async (\n        phone: string,\n        message: string,\n    ): Promise<PublishCommandOutput> => {\n        const command = new PublishCommand({\n            Message: message,\n            PhoneNumber: phone,\n        });\n\n        return await this.client.send(command);\n    };\n}\n"]}