Alexa Skill With TypeScript
Join the DZone community and get the full member experience.Join For Free
Alexa Skills can be developed using Alexa Lambda functions or a REST API endpoint. A Lambda Function is Amazon's implementation of serverless functions available in AWS. Amazon recommends using Lambda Functions despite the fact that they are not easy to debug. While you can log to a CloudWatch log, you can't hit a breakpoint and step into the code.
This makes the live-debugging of Alexa requests a very hard task. In this post, we will implement a custom Skill for Amazon Alexa by using TypeScript, npm, and AWS Lambda Functions. This skill is basically a Hello World example. With this post, you will be able to create a custom Skill for Amazon Alexa, implement functionality by using TypeScript, and start your custom Skill both from your local computer and from AWS. This post contains materials from different resources that can be seen in the Resources section.
Here you have the technologies used in this project
- Amazon Developer Account - How to get it.
- AWS Account - Sign up here for free.
- ASK CLI - Install and configure ASK CLI.
- Node.js v10.x.
- TypeScript (Version >3.0.0).
- Visual Studio Code.
- npm Package Manager.
- Alexa ASK for Node.js (Version >2.7.0).
The Alexa Skills Kit Command Line Interface (ASK CLI) is a tool for you to manage your Alexa Skills and related resources, such as AWS Lambda functions. With ASK CLI, you have access to the Skill Management API, which allows you to manage Alexa skills programmatically from the command line. We will use this powerful tool to create, build, deploy, and manage our Hello World Skill, but now, with TypeScript. Let's start!
If you want how to create your Skill with the ASK CLI, please follow the first step explained in my Node.js Skill sample.
Once we have created the Skill in Node.js, we have to rewrite, or transpile, our code to TypeScript. I have made that work for you. Let's take a look at it!
These are the main files of the project:
- .ask: Folder that contains the ASK CLI's config file. This config files will remain empty until we execute the command
.vscode/launch.json: Launch preferences to run locally your Skill for local testing. This setting launch
lambda/custom/src/local-debugger.js. This script runs a server on http://localhost:3001 for debugging the Skill. It is not traspilled to TypeScript because it is not a part of our Lambda. It is a local tool.
- hooks: A folder that contains the hook scripts. Amazon provides two hooks,
post_new_hook: executes after Skill creation. Node.js runs
npm installin each sourceDir in
pre_deploy_hook: executed before the Skill deployment. Node.js runs
npm installin each sourceDir in
- lambda/custom/src: A folder that contains the source code for the skill's AWS Lambda function:
index.ts: the lambda main entry point.
package.json: this file is core to the Node.js ecosystem and is a basic part of understanding and working with Node.js, npm, and even modern TypeScript.
tsconfig.json: configuration file that we are going to use for compiling our TypeScript code.
tslint.json: configuration file used by
gts(Google TypeScript Style) to check the style of our TypeScript code.
local-debugger.js: used for debugging our Skill locally.
errors: Folder that contains all error handlers.
intents: This one contains all the intent handlers.
interceptors: Interceptors' folder with the i18n initialization.
utilities: This folder contains the i18n strings, helper functions, constants and TypeScript interfaces.
build: The output folder after compiling the TypeScript code.
- models – A folder that contains interaction models for the skill. Each interaction model is defined in a JSON file named according to the locale. For example, es-ES.json.
skill.json– The Skill manifest. One of the most important files in our project.
The ASK SDK for Node.js makes it easier for you to build highly engaging Skills by allowing you to spend more time implementing features and less time writing boilerplate code.
We are going to use this SDK in TypeScript!
You can find documentation, samples, and helpful links in their official GitHub repository.
The main TypeScript file in our Lambda project is
index.ts, located in the
lambda/custom/src folder. This file contains all handlers, interceptors, and exports the Skill handler in
exports.handler function is executed every time AWS Lambda is initiated for this particular function. In theory, an AWS Lambda function is just a single function. This means that we need to define dispatching logic so a single function request can route to appropriate code, hence the handlers.
It is important to take a look into the
Launch.ts, imported as
Launch above, which is the
LaunchRequestHandler handler located in the
intents folder as an example of Alexa Skill handler written in TypeScript:
package.json, we will almost always find metadata specific to the project. This metadata helps identify the project and acts as a baseline for users and contributors to get information about the project.
Here is how this file looks:
This command will execute these actions:
- Remove the
buildfolder located in
lambda/customwith the command
rimraf build. This folder contains the output of compiling the TypeScript code.
- Check the style of our TypeScript code with the command
gts checkusing the file
lambda/custom/buildusing the command
tsc --build tsconfig.json --pretty
- Copy the
buildfolder because is needed to generate the final Lambda code
- Finally, it will run the
npm install --productionin
buildfolder to get the final lambda code that we are going to upload to AWS with the ASK CLI.
launch.json file in
.vscode folder has the configuration for Visual Studio Code, which allows us to run our Lambda locally:
This configuration file will execute the following command:
For a new incoming Skill request, a new socket connection is established. From the data received on the socket, the request body is extracted, parsed into JSON, and passed to the Skill invoker's Lambda handler. The response from the Lambda handler is parsed as an HTTP 200 message format, as specified here. The response is written onto the socket connection and returned.
After configuring our launch.json file and understanding how the local debugger works, it is time to click on the play button:
After executing it, you can send an Alexa POST requests to http://localhost:3001.
Following the steps before, now you can set up breakpoints wherever you want inside all TypeScript files in order to debug your Skill.
I'm sure you already know the famous tool, Postman. REST APIs have become the new standard in providing a public and secure interface for your service. Though REST has become ubiquitous, it's not always easy to test. Postman makes it easier to test and manage HTTP REST APIs. Postman gives us multiple features to import, test, and share APIs, which will help you and your team be more productive in the long run.
After running your application, you will have an endpoint available at http://localhost:3001. With Postman, you can emulate any Alexa Request.
For example, you can test a
With the code ready to go, we need to deploy it on AWS Lambda, so it can be connected to Alexa. Before deploying the Alexa Skill, we can show the
config file in the
.ask folder. It is empty:
Deploy Alexa Skill with ASK CLI:
As the official documentation says:
When the local skill project has never been deployed, ASK CLI creates a new Skill in the development stage for your account, then deploys the Skill project. If applicable, ASK CLI creates one or more new AWS Lambda functions in your AWS account and uploads the Lambda function code. Specifically, ASK CLI does the following:
- Looks in your skill project's config file (in the .ask folder, which is in the skill project folder) for an existing skill ID. If the config file does not contain a Skill Id, ASK CLI creates a new Skill using the Skill manifest in the Skill project's skill.json file. Then, it adds the Skill Id to the Skill project's config file.
- Looks in your Skill project's manifest (skill.json file) for the Skill's published locales. These are listed in the
manifest.publishingInformation.localesobject. For each locale, ASK CLI looks in the Skill project's models folder for a corresponding model file (for example, es-ES.json). It then uploads the model to your Skill. ASK CLI waits for the uploaded models to build and then adds each model's eTag to the skill project's config file.
- Looks in your Skill project's manifest (skill.json file) for AWS Lambda endpoints. These are listed in the
manifest.apis..regions..endpointobjects (for example,
Each endpoint object contains a
sourceDirvalue and optionally a URI value. ASK CLI uploads the contents of the sourceDir folder to the corresponding AWS Lambda function and names the Lambda Function the same as the URI value. For more details about how ASK CLI performs uploads to Lambda, see AWS Lambda deployment details.
- Looks in your Skill project folder for in-skill products, and if it finds any, uploads them to your Skill. For more information about in-skill products, see the In-Skill Purchasing Overview.
After the execution of the above command, we will have the
config file properly filled:
Note: after rewriting our code to TypeScript, we need to change the
Ngrok is a very cool, lightweight tool that creates a secure tunnel on your local machine, along with a public URL you can use for browsing your local site or APIs.
When ngrok is running, it listens on the same port that your local web server is running on and proxies external requests to your local machine
From there, it’s a simple step to get it to listen to your web server. Say you’re running your local web server on port 3001. In terminal, you’d type in:
ngrok http 3001. This starts ngrok listening on port 3001 and creates the secure tunnel:
Select the My development endpoint as a sub-domain option from the dropdown and click save endpoint at the top of the page.
Go to the Test tab in the Alexa Developer Console and launch your Skill.
- Official Alexa Skills Kit Node.js SDK - The Official Node.js SDK Documentation.
- Official Alexa Skills Kit Documentation - Official Alexa Skills Kit Documentation.
This was a basic tutorial to learn Alexa Skills using Node.js and TypeScript. As you have seen in this example, the Alexa Skill Kit for Node.js and the Alexa Tools like ASK CLI can help us a lot. They also give us the ability to create Skills in TypeScript in an easy way. I hope this example project is useful to you.
That’s all, folks! You can find all the code in my GitHub.
I hope it will be useful! If you have any doubts or questions, do not hesitate to contact me or put a comment below!
Opinions expressed by DZone contributors are their own.