Add Chapter 05

README.md

@@ -22,3 +22,5 @@ Unofficial tutorials for [ask-sdk-controls](https://github.com/alexa/ask-sdk-con
     - Use `State` to store data for keeping context
   - [Chapter04](./chapter04)
     - Use `Initiative Phase` with multiple controls
+  - [Chapter05](./chapter05)
+    - Optimize response more contextual

chapter05/README.md

@@ -0,0 +1,88 @@
+# Chapter05
+
+## Optimize response more contextual
+
+In this chapter, you learn techniques to build response which is optimized to the context.
+
+## Check suggestedResponseStyle in ControlInput
+
+`suggestedResponseStyle` is the property in `ControlInput` class. It would be `VOICE`, `SCREEN` or `INDETERMINATE`.
+Recommend to just showing the screen without voice when `SCREEN`, respond with the voice and show screen optionaly if `VOICE`, `INDETERMINATE` means response type is not yet known.
+
+You can check it in `suggestedResponseStyle` property of the `ControlInput` when build response in the `Act`.
+Example is as follows (from `./src/acts/RootControlActs.ts`). Checking `suggestedResponseStyle` and add voice response if `modality` of it is `VOICE`.
+
+```typescript
+export class ChangeColorAct extends ContentAct {
+    render(input: ControlInput, responseBuilder: ControlResponseBuilder): void {
+        if (input.suggestedResponseStyle.modality === OutputModality.VOICE) {
+            responseBuilder.addPromptFragment('Okay, this is the new color');
+        }
+
+        const colors = ['black', 'white', 'red', 'blue', 'green'];
+
+        responseBuilder.addAPLExecuteCommandsDirective('BackgroundColorToken', [
+            {
+                type: 'SetValue',
+                componentId: 'BackgroundColorFrame',
+                property: 'colorName',
+                value: colors[getRandomInt(colors.length)],
+            },
+        ]);
+    }
+}
+```
+
+## Test
+
+As this test case shows, Alexa wouldn't say anything if sends request by touch interaction (from `./tests/index.test.ts`).
+
+```typescript
+describe('index', () => {
+    test('Change color by voice', async () => {
+        const invoker = new SkillInvoker(
+            new ControlHandler(new BackgroundColorControlManager()),
+        );
+
+        await testTurn(
+            invoker,
+            '',
+            TestInput.launchRequest(),
+            "a: Welcome to the color generator, I'll generate the color randomly. Please say 'generate new color' if you want to generate new one",
+        );
+
+        await testTurn(
+            invoker,
+            'u: Change color',
+            TestInput.intent('ChangeColorIntent'),
+            'a: Okay, this is the new color',
+        );
+    });
+
+    test('Change color by touch', async () => {
+        const invoker = new SkillInvoker(
+            new ControlHandler(new BackgroundColorControlManager()),
+        );
+
+        await testTurn(
+            invoker,
+            '',
+            TestInput.launchRequest(),
+            "a: Welcome to the color generator, I'll generate the color randomly. Please say 'generate new color' if you want to generate new one",
+        );
+
+        await testTurn(
+            invoker,
+            'u: Change color',
+            TestInput.simpleUserEvent(['RootControl']),
+            'a:',
+        );
+    });
+});
+```
+
+## Let's deploy and run it.
+
+See [chapter01](https://github.com/ysak-y/ask-sdk-controls-tutorial/tree/main/chapter01#lets-deploy-and-run-it).
+
+And I prepared the recognition model to `interactionModel.json`. You can build interaction model by using it.

chapter05/babel.config.js

@@ -0,0 +1,7 @@
+// babel.config.js
+module.exports = {
+    presets: [
+        ['@babel/preset-env', { targets: { node: 'current' } }],
+        '@babel/preset-typescript',
+    ],
+};

chapter05/interactionModel.json

@@ -0,0 +1,33 @@
+{
+    "interactionModel": {
+        "languageModel": {
+            "invocationName": "change color test",
+            "intents": [
+                {
+                    "name": "AMAZON.CancelIntent",
+                    "samples": []
+                },
+                {
+                    "name": "AMAZON.HelpIntent",
+                    "samples": []
+                },
+                {
+                    "name": "AMAZON.StopIntent",
+                    "samples": []
+                },
+                {
+                    "name": "ChangeColorIntent",
+                    "samples": ["Change color"]
+                },
+                {
+                    "name": "AMAZON.NavigateHomeIntent",
+                    "samples": []
+                },
+                {
+                    "name": "AMAZON.FallbackIntent",
+                    "samples": []
+                }
+            ]
+        }
+    }
+}

chapter05/jest.config.ts

@@ -0,0 +1,194 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/en/configuration.html
+ */
+
+export default {
+    // All imported modules in your tests should be mocked automatically
+    // automock: false,
+
+    // Stop running tests after `n` failures
+    // bail: 0,
+
+    // The directory where Jest should store its cached dependency information
+    // cacheDirectory: "/private/var/folders/_p/r21b9lq54713qfqnxhpsmpvr0000gn/T/jest_dx",
+
+    // Automatically clear mock calls and instances between every test
+    clearMocks: true,
+
+    // Indicates whether the coverage information should be collected while executing the test
+    // collectCoverage: false,
+
+    // An array of glob patterns indicating a set of files for which coverage information should be collected
+    // collectCoverageFrom: undefined,
+
+    // The directory where Jest should output its coverage files
+    coverageDirectory: 'coverage',
+
+    // An array of regexp pattern strings used to skip coverage collection
+    // coveragePathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // Indicates which provider should be used to instrument code for coverage
+    coverageProvider: 'v8',
+
+    // A list of reporter names that Jest uses when writing coverage reports
+    // coverageReporters: [
+    //   "json",
+    //   "text",
+    //   "lcov",
+    //   "clover"
+    // ],
+
+    // An object that configures minimum threshold enforcement for coverage results
+    // coverageThreshold: undefined,
+
+    // A path to a custom dependency extractor
+    // dependencyExtractor: undefined,
+
+    // Make calling deprecated APIs throw helpful error messages
+    // errorOnDeprecated: false,
+
+    // Force coverage collection from ignored files using an array of glob patterns
+    // forceCoverageMatch: [],
+
+    // A path to a module which exports an async function that is triggered once before all test suites
+    // globalSetup: undefined,
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    // globalTeardown: undefined,
+
+    // A set of global variables that need to be available in all test environments
+    // globals: {},
+
+    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+    // maxWorkers: "50%",
+
+    // An array of directory names to be searched recursively up from the requiring module's location
+    // moduleDirectories: [
+    //   "node_modules"
+    // ],
+
+    // An array of file extensions your modules use
+    // moduleFileExtensions: [
+    //   "js",
+    //   "json",
+    //   "jsx",
+    //   "ts",
+    //   "tsx",
+    //   "node"
+    // ],
+
+    // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+    // moduleNameMapper: {},
+
+    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+    // modulePathIgnorePatterns: [],
+
+    // Activates notifications for test results
+    // notify: false,
+
+    // An enum that specifies notification mode. Requires { notify: true }
+    // notifyMode: "failure-change",
+
+    // A preset that is used as a base for Jest's configuration
+    // preset: undefined,
+
+    // Run tests from one or more projects
+    // projects: undefined,
+
+    // Use this configuration option to add custom reporters to Jest
+    // reporters: undefined,
+
+    // Automatically reset mock state between every test
+    // resetMocks: false,
+
+    // Reset the module registry before running each individual test
+    // resetModules: false,
+
+    // A path to a custom resolver
+    // resolver: undefined,
+
+    // Automatically restore mock state between every test
+    // restoreMocks: false,
+
+    // The root directory that Jest should scan for tests and modules within
+    // rootDir: undefined,
+
+    // A list of paths to directories that Jest should use to search for files in
+    // roots: [
+    //   "<rootDir>"
+    // ],
+
+    // Allows you to use a custom runner instead of Jest's default test runner
+    // runner: "jest-runner",
+
+    // The paths to modules that run some code to configure or set up the testing environment before each test
+    // setupFiles: [],
+
+    // A list of paths to modules that run some code to configure or set up the testing framework before each test
+    // setupFilesAfterEnv: [],
+
+    // The number of seconds after which a test is considered as slow and reported as such in the results.
+    // slowTestThreshold: 5,
+
+    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+    // snapshotSerializers: [],
+
+    // The test environment that will be used for testing
+    testEnvironment: 'node',
+
+    // Options that will be passed to the testEnvironment
+    // testEnvironmentOptions: {},
+
+    // Adds a location field to test results
+    // testLocationInResults: false,
+
+    // The glob patterns Jest uses to detect test files
+    // testMatch: [
+    //   "**/__tests__/**/*.[jt]s?(x)",
+    //   "**/?(*.)+(spec|test).[tj]s?(x)"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    // testPathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // The regexp pattern or array of patterns that Jest uses to detect test files
+    // testRegex: [],
+
+    // This option allows the use of a custom results processor
+    // testResultsProcessor: undefined,
+
+    // This option allows use of a custom test runner
+    // testRunner: "jasmine2",
+
+    // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+    // testURL: "http://localhost",
+
+    // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+    // timers: "real",
+
+    // A map from regular expressions to paths to transformers
+    // transform: undefined,
+
+    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+    // transformIgnorePatterns: [
+    //   "/node_modules/",
+    //   "\\.pnp\\.[^\\/]+$"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+    // unmockedModulePathPatterns: undefined,
+
+    // Indicates whether each individual test should be reported during the run
+    // verbose: undefined,
+
+    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+    // watchPathIgnorePatterns: [],
+
+    // Whether to use watchman for file crawling
+    // watchman: true,
+};

chapter05/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "ask-sdk-controls-tutorial",
+    "version": "1.0.0",
+    "main": "index.js",
+    "repository": "https://github.com/ysak-y/ask-sdk-controls-tutorial.git",
+    "author": "ysak-y <[email protected]>",
+    "license": "MIT",
+    "scripts": {
+        "build": "tsc",
+        "test": "jest"
+    },
+    "dependencies": {
+        "ask-sdk-controls": "^0.9.0",
+        "ask-sdk-core": "^2.12.0",
+        "ask-sdk-model": "^1.38.0"
+    },
+    "devDependencies": {
+        "@babel/preset-env": "^7.13.12",
+        "@babel/preset-typescript": "^7.13.0",
+        "@types/jest": "^27.4.1",
+        "jest": "^27.5.1",
+        "prettier": "^2.6.0",
+        "ts-node": "^10.7.0",
+        "typescript": "^4.6.2"
+    }
+}