Intents and slots prompts confirmation

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [#352](https://github.com/alexa-js/alexa-app/pull/352): Allow utterance expansion in custom slot type synonyms - [@daanzu](https://github.com/daanzu).
 * [#361](https://github.com/alexa-js/alexa-app/pull/361): Fix object reference for dialogState in in doc - [@Sephtenen](https://github.com/Sephtenen).
 * [#364](https://github.com/alexa-js/alexa-app/pull/364): Fix reprompt() to concatenate multiple SSML prompts - [@andrewjhunt](https://github.com/andrewjhunt).
+* [#366](https://github.com/alexa-js/alexa-app/pull/358): Add support for including samples in slots and intents for confirmations - [@fabien88](https://github.com/fabien88).
 * Your contribution here.
 
 ### 4.2.2 (April 7, 2018)

README.md

@@ -622,16 +622,27 @@ The alexa-app module makes it easy to define your intent schema and generate man
 ### Schema Syntax
 
 Pass an object with two properties: slots and utterances.
+A third (optional) property : prompts. To confirm intent on alexa side with dialog delegate.
+slot prompts and intents prompts are working only with askcli command.
 
 ```javascript
 app.intent("sampleIntent", {
     "slots": {
       "NAME": "AMAZON.US_FIRST_NAME",
-      "AGE": "AMAZON.NUMBER"
+      "AGE": "AMAZON.NUMBER",
+      "CITY": {
+         "type": "AMAZON.US_CITY",
+         "elicitationPrompts": [
+          "Oh I forgot to ask you, in which city do you live ?",
+         ],
+         "samples": ['I live in {-|CITY}', '{in|at|near|} {-|CITY}'],
+         "confirmationPrompts": ['Ok so you live in {CITY} right ?'],
+      }
     },
     "utterances": [
       "my {name is|name's} {NAME} and {I am|I'm} {-|AGE}{ years old|}"
-    ]
+    ],
+    "prompts": ['Ok do you confirm your name is {NAME}, your age is {AGE} and that you live in {CITY} ?'],
   },
   function(request, response) { ... }
 );
@@ -747,7 +758,7 @@ WhatsMyColorIntent tell me what my favorite color is
 
 #### Skill Builder Syntax
 
-If you are using the Skill Builder Beta, the `schemas.skillBuilder()` function will generate a single schema JSON string
+If you are using the Skill Builder Beta, the `schemas.skillBuilder()` function will generate a single schema JSON string
 that includes your intents with all of their utterances
 
 ```javascript
@@ -1056,4 +1067,4 @@ All named apps can be found in the `alexa.apps` object, keyed by name. The value
 
 Copyright (c) 2016-2017 Matt Kruse
 
-MIT License, see [LICENSE](LICENSE.md) for details.
+MIT License, see [LICENSE](LICENSE.md) for details.

index.js

@@ -312,6 +312,7 @@ alexa.intent = function(name, schema, handler) {
   this.dialog = (schema && typeof schema.dialog !== "undefined") ? schema.dialog : {};
   this.slots = (schema && typeof schema["slots"] !== "undefined") ? schema["slots"] : null;
   this.utterances = (schema && typeof schema["utterances"] !== "undefined") ? schema["utterances"] : null;
+  this.prompts = schema && typeof schema["prompts"] !== "undefined" ? schema["prompts"] : null;
 
   this.isDelegatedDialog = function() {
     return this.dialog.type === "delegate";
@@ -684,12 +685,26 @@ alexa.app = function(name) {
       if (intent.slots && Object.keys(intent.slots).length > 0) {
         intentSchema["slots"] = [];
         for (key in intent.slots) {
-          //  It's unclear whether `samples` is actually used for slots,
-          // but the interaction model will not build without an (empty) array
+          const slot = intent.slots[key];
+          const type = slot.type ? slot.type : slot;
+          const samples = [];
+          if (slot.samples) {
+            slot.samples.forEach(function(sample) {
+              var list = AlexaUtterances(
+                sample,
+                intent.slots,
+                self.dictionary,
+                self.exhaustiveUtterances
+              );
+              list.forEach(function(utterance) {
+                samples.push(utterance);
+              });
+            });
+          }
           intentSchema.slots.push({
-            "name": key,
-            "type": intent.slots[key],
-            "samples": []
+            name: key,
+            type,
+            samples
           });
         }
       }
@@ -733,9 +748,13 @@ alexa.app = function(name) {
         if (intent.slots && Object.keys(intent.slots).length > 0) {
           intentSchema["slots"] = [];
           for (key in intent.slots) {
+            const slot = intent.slots[key];
+            const type = slot.type ? slot.type : slot;
+            const samples = slot.type ? slot.samples : [];
             intentSchema.slots.push({
               "name": key,
-              "type": intent.slots[key]
+              "type": type,
+              "samples": samples
             });
           }
         }
@@ -750,16 +769,92 @@ alexa.app = function(name) {
     },
     askcli: function(invocationName) {
       var model = skillBuilderSchema();
+      var { prompts, dialog } = skillBuilderDialog();
       model.invocationName = invocationName || self.invocationName || self.name;
       var schema = {
         interactionModel: {
-          languageModel: model
+          languageModel: model,
+          dialog,
+          prompts
         }
       };
       return JSON.stringify(schema, null, 3);
     }
   };
 
+  var skillBuilderDialog = function() {
+    var schema = {
+        dialog: {
+          intents: []
+        },
+        prompts: []
+      },
+      intentName,
+      intent,
+      key;
+
+    var creatPrompt = function(promptId, variations) {
+      return {
+        id: promptId,
+        variations: variations.map(prompt => ({
+          type: "SSML",
+          value: "<speak>" + prompt + "</speak>"
+        }))
+      };
+    };
+
+    for (intentName in self.intents) {
+      intent = self.intents[intentName];
+      var intentSchema = {
+        name: intent.name,
+        confirmationRequired: false,
+        prompts: {},
+        slots: []
+      };
+
+      if (intent.prompts) {
+        var intentConfirmPromptId = "Confirm.Intent." + schema.prompts.length;
+        schema.prompts.push(creatPrompt(intentConfirmPromptId, intent.prompts));
+        intentSchema.prompts.confirmation = intentConfirmPromptId;
+        intentSchema.confirmationRequired = true;
+      }
+
+      if (intent.slots && Object.keys(intent.slots).length > 0) {
+        for (key in intent.slots) {
+          var slot = intent.slots[key];
+          var dialogIntentSlot = {
+            name: key,
+            type: slot.type || slot,
+            prompts: {},
+            elicitationRequired: false,
+            confirmationRequired: false
+          };
+          if (slot.elicitationPrompts) {
+            var elicitPromptId = "Elicit.Slot." + schema.prompts.length;
+            schema.prompts.push(
+              creatPrompt(elicitPromptId, slot.elicitationPrompts)
+            );
+            dialogIntentSlot.elicitationRequired = true;
+            dialogIntentSlot.prompts.elicitation = elicitPromptId;
+            }
+          if (slot.confirmationPrompts) {
+            var confirmPromptId = "Confirm.Slot." + schema.prompts.length;
+            schema.prompts.push(
+              creatPrompt(confirmPromptId, slot.confirmationPrompts)
+            );
+            dialogIntentSlot.confirmationRequired = true;
+            dialogIntentSlot.prompts.confirmation = confirmPromptId;
+          }
+
+          intentSchema.slots.push(dialogIntentSlot);
+        }
+      }
+      schema.dialog.intents.push(intentSchema);
+    }
+
+    return schema;
+  };
+
   // extract the schema and generate a schema JSON object
   this.schema = function() {
     return this.schemas.intent();