* Added Prompts.attachment() method.

* Updated Message.randomPrompt() to take a string or an array.
* Updated Session to clone() raw IMessage entries before sending (fixes a serialization bug)
* Fixed issue where configured BotConnectorBot endpoint wasn't getting used in production.
* Tweaked the way built-in dialogs get registered.
* Added support for showing Prompts.confirm() using buttons.
* Improved the way re-prompting works.
* Created type specific default re-prompts.

Author: Stevenic

Node/src/Channel.ts

@@ -33,15 +33,20 @@
 
 import ses = require('./Session');
 
-export function maxButtons(session: ses.Session): number {
-    var account = session.message.from || session.message.to;
-    switch (account.channelId.toLowerCase()) {
+export function preferButtons(session: ses.Session, choiceCnt: number, rePrompt: boolean): boolean {
+    switch (getChannelId(session)) {
         case 'facebook':
-            return 3;
+            return (choiceCnt <= 3);
         case 'telegram':
+            return !rePrompt;
         case 'kik':
-            return 100;
+            return true;
         default:
-            return 0;
+            return false;
     }
-}
+}
+
+export function getChannelId(session: ses.Session): string {
+    var account = session.message.from || session.message.to;
+    return account.channelId.toLowerCase();    
+}

Node/src/Message.ts

@@ -78,9 +78,13 @@ export class Message implements IMessage {
         return this;
     }
 
-    static randomPrompt(prompts: string[]): string {
-        var i = Math.floor(Math.random() * prompts.length);
-        return prompts[i];
+    static randomPrompt(prompts: string|string[]): string {
+        if (Array.isArray(prompts)) {
+            var i = Math.floor(Math.random() * prompts.length);
+            return prompts[i];
+        } else {
+            return prompts;
+        }
     }
 
     static composePrompt(ses: session.Session, prompts: string[][], args?: any[]): string {

Node/src/Session.ts

@@ -36,6 +36,7 @@ import dialog = require('./dialogs/Dialog');
 import consts = require('./consts');
 import sprintf = require('sprintf-js');
 import events = require('events');
+import utils = require('./utils');
 
 export interface ISessionOptions {
     dialogs: collection.DialogCollection;
@@ -114,10 +115,7 @@ export class Session extends events.EventEmitter implements ISession {
         return sprintf.sprintf(tmpl, count);
     }
 
-    public send(): ISession;
-    public send(msg: string, ...args: any[]): ISession;
-    public send(msg: IMessage): ISession;
-    public send(msg?: any, ...args: any[]): ISession {
+    public send(msg?: string|IMessage, ...args: any[]): ISession {
         // Update dialog state
         // - Deals with a situation where the user assigns a whole new object to dialogState.
         var ss = this.sessionState;
@@ -126,7 +124,7 @@ export class Session extends events.EventEmitter implements ISession {
         }
 
         // Compose message
-        var message: IMessage = typeof msg == 'string' ? this.createMessage(msg, args) : msg;
+        var message: IMessage = typeof msg == 'string' ? this.createMessage(<string>msg, args) : msg;
         this.delayedEmit('send', message);
         return this;
     }
@@ -173,10 +171,7 @@ export class Session extends events.EventEmitter implements ISession {
         return this;
     }
 
-    public endDialog(msg: string, ...args: any[]): ISession;
-    public endDialog(msg: IMessage): ISession;
-    public endDialog(result?: dialog.IDialogResult<any>): ISession;
-    public endDialog(result?: any, ...args: any[]): ISession {
+    public endDialog(result?: string|IMessage|dialog.IDialogResult<any>, ...args: any[]): ISession {
         // Validate callstack
         // - Protect against too many calls to endDialog()
         var ss = this.sessionState;
@@ -191,10 +186,10 @@ export class Session extends events.EventEmitter implements ISession {
         if (result) {
             if (typeof result === 'string') {
                 m = this.createMessage(result, args);
-            } else if (result.hasOwnProperty('text') || result.hasOwnProperty('channelData')) {
+            } else if (result.hasOwnProperty('text') || result.hasOwnProperty('attachments') || result.hasOwnProperty('channelData')) {
                 m = result;
             } else {
-                r = result;
+                r = <any>result;
             }
         }
         if (!r.hasOwnProperty('resumed')) {
@@ -300,7 +295,7 @@ export class Session extends events.EventEmitter implements ISession {
             setTimeout(() => {
                 var entry = this.sendQueue.shift();
                 this.lastSendTime = now = new Date().getTime();
-                this.emit(entry.event, entry.msg);
+                this.emit(entry.event, utils.clone(entry.msg));
                 if (this.sendQueue.length > 0) {
                     delaySend();
                 }
@@ -311,7 +306,7 @@ export class Session extends events.EventEmitter implements ISession {
             this.msgSent = true;
             if ((now - this.lastSendTime) >= this.options.minSendDelay) {
                 this.lastSendTime = now;
-                this.emit(event, message);
+                this.emit(event, utils.clone(message));
             } else {
                 this.sendQueue.push({ event: event, msg: message });
                 delaySend();

Node/src/botbuilder.d.ts

@@ -305,8 +305,12 @@ export interface IDialogResult<T> {
 export interface IPromptOptions {
     /** 
      * Optional retry prompt to send if the users response isn't understood. Default is to just 
-     * reprompt with the configured [defaultRetryPrompt](http://docs.botframework.com/sdkreference/nodejs/interfaces/_botbuilder_d_.ipromptsoptions.html#defaultretryprompt) plus the original prompt. Note that if the original 
-     * prompt is an _IMessage_ the default behaviour is to simply re-send the original prompt.
+     * reprompt with the configured [defaultRetryPrompt](http://docs.botframework.com/sdkreference/nodejs/interfaces/_botbuilder_d_.ipromptsoptions.html#defaultretryprompt) 
+     * plus the original prompt. 
+     * 
+     * Note that if the original prompt is an _IMessage_ the retry prompt will be sent as a seperate 
+     * message followed by the original message. If the retryPrompt is also an _IMessage_ it will 
+     * instead be sent in place of the original message. 
      * * _{string}_ - Initial message to send the user.
      * * _{string[]}_ - Array of possible messages to send user. One will be chosen at random. 
      * * _{IMessage}_ - Initial message to send the user. Message can contain attachments. 
@@ -367,6 +371,9 @@ export interface IPromptChoiceResult extends IPromptResult<IFindMatchResult> { }
 /** Strongly typed Time Prompt Result. */
 export interface IPromptTimeResult extends IPromptResult<IEntity> { }
 
+/** Strongly typed Attachment Prompt Result. */
+export interface IPromptAttachmentResult extends IPromptResult<IAttachment[]> { }
+
 /** Plugin for recognizing prompt responses recieved by a user. */
 export interface IPromptRecognizer {
     /**
@@ -412,40 +419,6 @@ export interface IPromptRecognizerArgs {
 export interface IPromptsOptions {
     /** Replaces the default recognizer (SimplePromptRecognizer) used to recognize prompt replies. */
     recognizer?: IPromptRecognizer
-
-    /** The default retry prompt to use. The default value is "I didn't understand." */    
-    defaultRetryPrompt?: string;
-}
-
-/** Context information passed to field related handlers. */
-export interface IFieldConext {
-    userData: any;
-    form: any;
-    field: string;
-}
-
-/**
- * Handler that gets called anytime a field is about to invoke a prompt.
- */
-export interface IFieldPromptHandler {
-    /**
-     * @param context Contextual information related to the current field.
-     * @param next Function to call to continue execution of the prompt. 
-     * Passing _true_ for __skip__ will cause the current field to be skipped.
-     */
-    (context: IFieldConext, next: (skip: boolean) => void): void;
-}
-
-/** Options passed to form fields. */
-export interface IFieldOptions extends IPromptOptions {
-    /** 
-     * Called anytime a given field is about to invoke the prompt. This function lets the 
-     * developer progromatically determine if a prompt should be skipped or not. 
-     * 
-     * The handler can also manipulate the forms current values. For instance a fields value 
-     * could be pulled from context.userData if not already specified on the form.
-     */
-    onPrompt?: IFieldPromptHandler;
 }
 
 /** A recognized intent. */
@@ -1149,9 +1122,9 @@ export class Message implements IMessage {
 
     /**
      * Selects a prompt at random.
-     * @param prompts Array of prompts to choose from.
+     * @param prompts Array of prompts to choose from. When prompts is type _string_ the prompt will simply be returned unmodified.
      */
-    static randomPrompt(prompts: string[]): string;
+    static randomPrompt(prompts: string|string[]): string;
 
     /**
      * Combines an array of prompts into a single localized prompt and then optionally fills the
@@ -1389,84 +1362,17 @@ export class Prompts extends Dialog {
      * @param options Optional parameters to control the behaviour of the prompt.
      */
     static time(session: Session, prompt: string|string[]|IMessage, options?: IPromptOptions): void;
-}
-
-/**
- * Fields that can be added as setps to a waterfall to create a form.
- */
-export class Fields {
-    /**
-     * Captures from the user a raw string of text and saves it to a field on a form. 
-     * @param field Name of the field to save the users response to.
-     * @param prompt 
-     * * __prompt:__ _{string}_ - Initial message to send the user.
-     * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. 
-     * @param options Optional parameters to control the behaviour of the field.
-     */
-    static text(field: string, prompt: string|string[], options?: IFieldOptions): IDialogWaterfallStep;
-    
-    /**
-     * Prompts the user to enter a number and saves it to a field on a form.
-     * @param field Name of the field to save the users response to.
-     * @param prompt 
-     * * __prompt:__ _{string}_ - Initial message to send the user.
-     * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. 
-     * @param options Optional parameters to control the behaviour of the field.
-     */
-    static number(field: string, prompt: string|string[], options?: IFieldOptions): IDialogWaterfallStep;
-
-    /**
-     * Prompts the user to enter a boolean yes/no response and saves their answer to a field on a form.
-     * @param field Name of the field to save the users response to.
-     * @param prompt 
-     * * __prompt:__ _{string}_ - Initial message to send the user.
-     * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. 
-     * @param options Optional parameters to control the behaviour of the field.
-     */
-    static confirm(field: string, prompt: string|string[], options?: IFieldOptions): IDialogWaterfallStep;
-
-    /**
-     * Prompts the user to choose from a list of options and saves their selection to a field on a form.
-     * @param field Name of the field to save the users response to.
-     * @param prompt 
-     * * __prompt:__ _{string}_ - Initial message to send the user.
-     * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. 
-     * @param choices 
-     * * __choices:__ _{string}_ - List of choices as a pipe ('|') delimted string.
-     * * __choices:__ _{Object}_ - List of choices expressed as an Object map. The objects field names will be used to build the list of values.
-     * * __choices:__ _{string[]}_ - List of choices as an array of strings. 
-     * @param options Optional parameters to control the behaviour of the field.
-     */
-    static choice(field: string, prompt: string|string[], choices: string|Object|string[], options?: IFieldOptions): IDialogWaterfallStep;
 
     /**
-     * Prompts the user to enter a time saves it to a field on a form as a timestamp.
-     * @param field Name of the field to save the users response to.
+     * Prompts the user to upload a file attachment.
+     * @param session Session object for the current conversation.
      * @param prompt 
      * * __prompt:__ _{string}_ - Initial message to send the user.
      * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. 
-     * @param options Optional parameters to control the behaviour of the field.
-     */
-    static time(field: string, prompt: string|string[], options?: IPromptOptions): IDialogWaterfallStep;
-    
-    /** 
-     * Finalizes the form by saving the response from the last prompt and then passes the completed
-     * form to the next step of the waterfall for processing. 
-     */
-    static endForm(): IDialogWaterfallStep;
-    
-    /** 
-     * Finalizes the form by saving the response from the last prompt and then returns the completed
-     * form to the parent dialog by calling [endDialog()](http://docs.botframework.com/sdkreference/nodejs/classes/_botbuilder_d_.session.html#enddialog). 
-     */
-    static returnForm(): IDialogWaterfallStep;
-
-    /**
-     * Handler for IFieldOptions.onPrompt that will copy a default value from Session.userData if 
-     * a field is empty. The default value must be in a property with the same name as the field. 
-     * If successfully copied the prompt will be skipped. 
+     * * __prompt:__ _{IMessage}_ - Initial message to send the user. Message can contain attachments. 
+     * @param options Optional parameters to control the behaviour of the prompt.
      */
-    static onPromptUseDefault(): IFieldPromptHandler
+    static attachment(session: Session, prompt: string|string[]|IMessage, options?: IPromptOptions): void;
 }
 
 /**

Node/src/botbuilder.ts

@@ -39,7 +39,6 @@ import dialog = require('./dialogs/Dialog');
 import actions = require('./dialogs/DialogAction');
 import collection = require('./dialogs/DialogCollection');
 import prompts = require('./dialogs/Prompts');
-import fields = require('./dialogs/Fields');
 import intent = require('./dialogs/IntentDialog');
 import luis = require('./dialogs/LuisDialog');
 import command = require('./dialogs/CommandDialog');
@@ -62,7 +61,6 @@ exports.DialogCollection = collection.DialogCollection;
 exports.PromptType = prompts.PromptType;
 exports.ListStyle = prompts.ListStyle;
 exports.Prompts = prompts.Prompts;
-exports.Fields = fields.Fields;
 exports.SimplePromptRecognizer = prompts.SimplePromptRecognizer;
 exports.IntentDialog = intent.IntentDialog;
 exports.IntentGroup = intent.IntentGroup;

Node/src/bots/BotConnectorBot.ts

@@ -295,7 +295,7 @@ export class BotConnectorBot extends collection.DialogCollection {
                         if (ses.message.to.channelId == 'emulator') {
                             endpoint = this.options.endpoint || 'http://localhost:9000';
                         } else {
-                            endpoint = 'https://api.botframework.com';
+                            endpoint = this.options.endpoint || 'https://api.botframework.com';
                         }
 
                         // Send message

Node/src/dialogs/DialogCollection.ts

@@ -35,20 +35,21 @@ import dialog = require('./Dialog');
 import actions = require('./DialogAction');
 import simpleDialog = require('./SimpleDialog');
 import events = require('events');
-import prompts = require('./Prompts');
 import consts = require('../consts');
 
-interface IDialogMap {
+export interface IDialogMap {
     [id: string]: dialog.IDialog;
 }
 
+export var systemDialogs: IDialogMap = {};
+
 export class DialogCollection extends events.EventEmitter {
     private middleware: { (session: ISession, next: Function): void; }[] = []; 
     private dialogs: IDialogMap = {};
 
     constructor() {
         super();
-        this.add(consts.DialogId.Prompts, new prompts.Prompts())
+        this.add(systemDialogs);
     }
 
     public add(dialogs: { [id: string]: dialog.IDialog; }): DialogCollection;

Node/src/dialogs/EntityRecognizer.ts

@@ -62,8 +62,8 @@ export interface IFindMatchResult {
 
 export class EntityRecognizer {
     static dateExp = /^\d{4}-\d{2}-\d{2}/i;
-    static yesExp = /^(1|y|yes|yep|sure|ok|true)/i;
-    static noExp = /^(0|n|no|nope|not|false)/i;
+    static yesExp = /^(y|yes|yep|sure|ok|true)/i;
+    static noExp = /^(n|no|nope|not|false)/i;
     static numberExp = /[+-]?(?:\d+\.?\d*|\d*\.?\d+)/;
 
     static findEntity(entities: IEntity[], type: string): IEntity {