move numberOfAttempts to state from options

libraries/botbuilder-ai/package.json

@@ -28,7 +28,7 @@
     "botbuilder-core": "~4.1.6",
     "html-entities": "^1.2.1",
     "moment": "^2.20.1",
-    "@azure/ms-rest-js": "1.8.1",
+    "@azure/ms-rest-js": "1.8.2",
     "request": "^2.87.0",
     "request-promise-native": "1.0.5",
     "url-parse": "^1.4.4"

libraries/botbuilder-dialogs/src/prompts/activityPrompt.ts

@@ -55,14 +55,19 @@ export class ActivityPrompt extends Dialog {
         const state: any = dc.activeDialog.state as ActivityPromptState;
         const recognized: PromptRecognizerResult<Activity> = await this.onRecognize(dc.context, state.state, state.options);
 
+        if (state.state['attemptCount'] === undefined) {
+            state.state['attemptCount'] = 1;
+        }
+
         // Validate the return value
         // - Unlike the other prompts a validator is required for an ActivityPrompt so we don't
         //   need to check for its existence before calling it.
         const isValid: boolean = await this.validator({
             context: dc.context,
             recognized: recognized,
             state: state.state,
-            options: state.options
+            options: state.options,
+            attemptCount: state.state['attemptCount']
         });
 
         // Return recognized value or re-prompt

libraries/botbuilder-dialogs/src/prompts/oauthPrompt.ts

@@ -157,14 +157,20 @@ export class OAuthPrompt extends Dialog {
         if (hasTimedOut) {
             return await dc.endDialog(undefined);
         } else {
+
+            if (state.state['attemptCount'] === undefined) {
+                state.state['attemptCount'] = 1;
+            }
+
             // Validate the return value
             let isValid = false;
             if (this.validator) {
                 isValid = await this.validator({
                     context: dc.context,
                     recognized: recognized,
                     state: state.state,
-                    options: state.options
+                    options: state.options,
+                    attemptCount: state.state['attemptCount']
                 });
             } else if (recognized.succeeded) {
                 isValid = true;

libraries/botbuilder-dialogs/src/prompts/prompt.ts

@@ -75,11 +75,6 @@ export interface PromptOptions {
      * (Optional) Additional validation rules to pass the prompts validator routine.
      */
     validations?: object;
-
-    /**
-     * (Optional) Count of the number of times the prompt has retried.
-     */
-    numberOfAttempts?: number;
 }
 
 /**
@@ -156,6 +151,13 @@ export interface PromptValidatorContext<T> {
      * The validator can extend this interface to support additional prompt options.
      */
     readonly options: PromptOptions;
+
+    /**
+     * A count of the number of times the prompt has been executed.
+     * 
+     * A number indicating how many times the prompt was invoked (starting at 1 for the first time it was invoked).
+     */
+    readonly attemptCount: number;
 }
 
 /**
@@ -206,17 +208,18 @@ export abstract class Prompt<T> extends Dialog {
         // Validate the return value
         let isValid = false;
         if (this.validator) {
-            if (state.options.numberOfAttempts === undefined) {
-                state.options.numberOfAttempts = 0;
+            if (state.state['attemptCount'] === undefined) {
+                state.state['attemptCount'] = 1;
             }
             isValid = await this.validator({
                 context: dc.context,
                 recognized: recognized,
                 state: state.state,
-                options: state.options
+                options: state.options,
+                attemptCount: state.state['attemptCount']
             });
-            if (state.options.numberOfAttempts !== undefined) {
-                state.options.numberOfAttempts++;
+            if (state.state['attemptCount'] !== undefined) {
+                state.state['attemptCount']++;
             }
         } else if (recognized.succeeded) {
             isValid = true;

libraries/botbuilder-dialogs/tests/numberPrompt.test.js

@@ -202,7 +202,7 @@ describe('NumberPrompt', function () {
             .assertReply('0')
     });
 
-    it ('should see numberOfAttempts counter increment', async function() {
+    it ('should see attemptCount increment', async function() {
         const adapter = new TestAdapter(async (turnContext) => {
             const dc = await dialogs.createContext(turnContext);
 
@@ -222,7 +222,7 @@ describe('NumberPrompt', function () {
 
         dialogs.add(new NumberPrompt('prompt', async (prompt) => {
             if (prompt.recognized.value !== 0) {
-                prompt.context.sendActivity(`numberOfAttempts ${prompt.options.numberOfAttempts}`);
+                prompt.context.sendActivity(`attemptCount ${prompt.attemptCount}`);
                 return false;
             }
             return true;
@@ -231,21 +231,21 @@ describe('NumberPrompt', function () {
         await adapter.send('Hello')
             .assertReply('Send me a zero')
             .send('100')
-            .assertReply('numberOfAttempts 0')
+            .assertReply('attemptCount 1')
             .send('200')
-            .assertReply('numberOfAttempts 1')
+            .assertReply('attemptCount 2')
             .send('300')
-            .assertReply('numberOfAttempts 2')
+            .assertReply('attemptCount 3')
             .send('0')
             .assertReply('ok')
             .send('Another!')
             .assertReply('Send me a zero')
             .send('100')
-            .assertReply('numberOfAttempts 0')
+            .assertReply('attemptCount 1')
             .send('200')
-            .assertReply('numberOfAttempts 1')
+            .assertReply('attemptCount 2')
             .send('300')
-            .assertReply('numberOfAttempts 2')
+            .assertReply('attemptCount 3')
             .send('0')
             .assertReply('ok')
     });