ask-sdk-runtime

ASK SDK Runtime package contains generic components and implementations of ASK SDK v2 for Node.js.

What is ASK SDK v2 for Node.js

The ASK SDK v2 for Node.js is an open-source Alexa Skill Development Kit. ASK SDK v2 for Node.js makes it easier for you to build highly engaging skills, by allowing you to spend more time on implementing features and less on writing boiler-plate code.

Installing

To use the ASK SDK Runtime pacakge, simply run the following command in terminal:

npm install --save ask-sdk-runtime

Usage and Getting Started

You can find a getting started guide here.

Usage with TypeScript

The SDK runtime package for Node.js bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files. Our goal is to keep these TypeScript definition files updated with each release for any public api.

Pre-requisites

Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:

• Use TypeScript v2.x
• Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:

npm install --save-dev @types/node

In Node.js

To use the TypeScript definition files within a Node.js project, simply import ask-sdk-core as below:

In a TypeScript file:

import * as Runtime from 'ask-sdk-runtime';

In a JavaScript file:

const Runtime = require('ask-sdk-runtime');

Opening Issues

For bug reports, feature requests and questions, we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of the SDK, Node.js or browser environment and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Changelog

2.10.0 (2020-10-08)

Bug Fixes

• Add .withApiResponse() to ControlResponseBuilder (#636) (752b17c)
• Addded new line at end of each workflows (4f562fe)
• Addded new line at end of tsconfig.json files (d94a1c6)
• added commitlint and husky package config for commit rules and removed alexa-apis-for-nodejs reference (f857438)
• fix linting violations (c7e23e7)
• fix the github action workflow and compilation making relative require fail issue (#658) (895c88e)
• Fix(controls) launch.json to work out-of-box in vscode (#637) (24afdf8)
• removed unused dependencies from ask-sdk-control (8120f93)
• throw if createControlTree returns undefined (d7506e9)
• Update ask-sdk-core package.json dependencies (752d6ec)
• update rootDir to point to the right root dir in tsconfig file in tst (66ca284)
• update SMAPI SDK Readme for generate-lwa-tokens usage (279d96d)
• update the script of the mono project (148fad2)
• Updated all packages .npmignore files (de76a18)
• Updated all packages package.json (#656) (c27c3e6)
• updated ControlManager responseBuilder type (1dd13a8)
• Updated lerna.json and use installed typedoc module (a115b58)
• Windows failures on path separtor issue on ask-sdk-s3-persistence-adapter (1bd1a15)

Features

• Add special timestamp verification for skill event requests (#651) (9b0dd9f)
• add UserAgentManager (bc03b55)
• Adding individual workflows to be triggered on subdir changes (c5eb69f)
• eslint migration and fixes, git workflows and updates on package.json for ask-sdk-dynamodb-persistence-adapter (0e29817)
• eslint migration and fixes, git workflows and updates on package.json for ask-sdk-runtime (7265239)
• eslint migration and fixes, git workflows and updates on package.json for ask-sdk-s3-persistence-adapter (2789886)
• eslint migration and fixes, github actions workflows and updates on package.json for ask-sdk (89560a6)
• eslint migration and fixes, github actions workflows and updates on package.json for ask-sdk-express-adapter (e944476)
• eslint migration and fixes, github actions workflows and updates on package.json for ask-sdk-v1adapter (a76053a)
• eslint migration and fixes, github actions workflows and updates on package.json for ask-smapi-sdk (4d3f9b2)
• Update root package.json to fix doc generation (4bf482b)