Twilio Functions Utils
About
This lib was created with the aim of simplifying the use of serverless Twilio, reducing the need to apply frequent try-catches and improving context management, making it no longer necessary to return the callback() method in all functions.
How it works
useInjection
The useInjection method takes two parameters. The first to apply as a handler and the last is an object of configuration options.
[useInjection] Options
Can contain providers that will be defined, which act as use cases to perform internal actions in the handler function through the "this" method.
You can pass validateToken equal true too, to force Token validation using Twilio Flex Token Validator
useInjection(yourFunction,
{
providers: { create, remove },
validateToken: true
}
);
Twilio Flex Token Validator
When using Token Validator, the Request body must contain a valid Token from Twilio.
// Event
{
Token: "Twilio-Token-Here"
}
Response
The responses coming from the function destined to the handler must be returned as an instance of Response.
Response recebe uma string e um number (status code):
return new Response('Your pretty answer.', 200);
There are two failure response models, BadRequest and NotFound. The use follows the same model.
const notFound = new NotFoundError('Your error message here.');
const badRequest = new BadRequestError('Your error message here.');
TwiMLResponse
There is an own response template to use with the TwiML format:
const twimlVoice = new Twilio.twiml
.VoiceResponse();
const enqueueVoice = twimlVoice
.enqueue({
action,
workflowSid,
})
.task('{}');
return new TwiMLResponse(twimlVoice, 201)
Install
npm install twilio-functions-utils
Usage
// File: assets/create.private.js
exports.create = async function (event) {
// Here you can acess Twilio Client as client and Context as props (so you can get env vars).
const { client, props } = this
return new Promise((resolve, reject) => {
const random = Math.random();
if (random >= 0.5) {
return resolve({ sucess: 'Resolved' });
}
return reject(new Error('Unresolved'));
});
};
// File: functions/create.js
const { useInjection, Response } = require('twilio-functions-utils');
const { create } = require(Runtime.getAssets()['/create.js'].path)
/**
* @param { Record<string, unknown> } event
* @this { {
* request: Record<string, unknown>,
* cookies: Record<string, string>,
* client: import('twilio').Twilio,
* props: {
* TWILIO_WORKFLOW_SID: string,
* TWILIO_WORKFLOW_SID: string,
* DOMAIN_NAME: string
* },
* providers: {
* create: create,
* } } }
* @returns { Promise<unknown> }
*/
async function createAction(event) {
// You can perform all your "controller" level actions, as you have access to the request headers and cookies.
const { cookies, request, client, props } = this
// Then just call the providers you provided to handler by using useInjection.
const providerResult = await this.providers.create(event)
// Just put it on a Response object and you are good to go!
return new Response(providerResult, 201);
}
exports.handler = useInjection(createAction, {
providers: {
create,
},
validateToken: true, // When using Token Validator, the Request body must contain a valid Token from Twilio.
});
Author
- Iago Calazans -
🛠 Senior Node.js Engineer at Stone
160 Jan 3, 2023
5 Sep 22, 2022
4 Nov 15, 2022
5 Dec 15, 2022
89 Jan 3, 2023
5 Aug 23, 2022
35 Dec 17, 2022
5 Dec 25, 2022
1 Dec 19, 2021
5 Nov 3, 2022