@microsoft/agents-hosting-dialogs 0.1.49

package/src/waterfallDialog.ts

@@ -0,0 +1,215 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { v4 as uuidv4 } from 'uuid'
+import { ActivityTypes } from '@microsoft/agents-hosting'
+import { Dialog } from './dialog'
+import { DialogContext } from './dialogContext'
+import { WaterfallStepContext } from './waterfallStepContext'
+import { DialogTurnResult } from './dialogTurnResult'
+import { DialogReason } from './dialogReason'
+
+/**
+ * Function signature of an individual waterfall step.
+ *
+ * @param O (Optional) type of dialog options passed into the step.
+ * @param WaterfallStep.step Contextual information for the current step being executed.
+ */
+export type WaterfallStep<O extends object = {}> = (step: WaterfallStepContext<O>) => Promise<DialogTurnResult>
+
+/**
+ * A waterfall is a dialog that's optimized for prompting a user with a series of questions.
+ *
+ */
+export class WaterfallDialog<O extends object = {}> extends Dialog<O> {
+  private readonly steps: WaterfallStep<O>[]
+
+  /**
+     * Creates a new waterfall dialog containing the given array of steps.
+     *
+     * @remarks
+     * See the addstep function for details on creating a valid step function.
+     * @param dialogId Unique ID of the dialog within the component or set its being added to.
+     * @param steps (Optional) array of asynchronous waterfall step functions.
+     */
+  constructor (dialogId: string, steps?: WaterfallStep<O>[]) {
+    super(dialogId)
+    this.steps = []
+    if (steps) {
+      this.steps = steps.slice(0)
+    }
+  }
+
+  /**
+     * Gets the dialog version, composed of the ID and number of steps.
+     *
+     * @returns Dialog version, composed of the ID and number of steps.
+     */
+  getVersion (): string {
+    // Simply return the id + number of steps to help detect when new steps have
+    // been added to a given waterfall.
+    return `${this.id}:${this.steps.length}`
+  }
+
+  /**
+     * Adds a new step to the waterfall.
+     *
+     * @param step Asynchronous step function to call.
+     * @returns Waterfall dialog for fluent calls to `addStep()`.
+     */
+  addStep (step: WaterfallStep<O>): this {
+    this.steps.push(step)
+
+    return this
+  }
+
+  /**
+     * Called when the WaterfallDialog is started and pushed onto the dialog stack.
+     *
+     * @param dialogContext The DialogContext for the current turn of conversation.
+     * @param options Optional, initial information to pass to the Dialog.
+     * @returns A Promise representing the asynchronous operation.
+     * @remarks
+     * If the task is successful, the result indicates whether the Dialog is still
+     * active after the turn has been processed by the dialog.
+     */
+  async beginDialog (dialogContext: DialogContext, options?: O): Promise<DialogTurnResult> {
+    const state: WaterfallDialogState = dialogContext.activeDialog.state as WaterfallDialogState
+    state.options = options || {}
+    state.values = {
+      instanceId: uuidv4(),
+    }
+
+    // Run the first step
+    return await this.runStep(dialogContext, 0, DialogReason.beginCalled)
+  }
+
+  /**
+     * Called when the WaterfallDialog is _continued_, where it is the active dialog and the
+     * user replies with a new Activity.
+     *
+     * @param dialogContext The DialogContext for the current turn of conversation.
+     * @returns A Promise representing the asynchronous operation.
+     * @remarks
+     * If the task is successful, the result indicates whether the dialog is still
+     * active after the turn has been processed by the dialog. The result may also contain a
+     * return value.
+     */
+  async continueDialog (dialogContext: DialogContext): Promise<DialogTurnResult> {
+    // Don't do anything for non-message activities
+    if (dialogContext.context.activity.type !== ActivityTypes.Message) {
+      return Dialog.EndOfTurn
+    }
+
+    // Run next step with the message text as the result.
+    return await this.resumeDialog(dialogContext, DialogReason.continueCalled, dialogContext.context.activity.text)
+  }
+
+  /**
+     * Called when a child WaterfallDialog completed its turn, returning control to this dialog.
+     *
+     * @param dc The DialogContext for the current turn of the conversation.
+     * @param reason DialogReason why the dialog resumed.
+     * @param result Optional, value returned from the dialog that was called. The type
+     * of the value returned is dependent on the child dialog.
+     * @returns A Promise representing the asynchronous operation.
+     */
+  async resumeDialog (dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult> {
+    // Increment step index and run step
+    const state: WaterfallDialogState = dc.activeDialog.state as WaterfallDialogState
+
+    return await this.runStep(dc, state.stepIndex + 1, reason, result)
+  }
+
+  /**
+     * Called when an individual waterfall step is being executed.
+     *
+     * @remarks
+     * SHOULD be overridden by derived class that want to add custom logging semantics.
+     *
+     * @param step Context object for the waterfall step to execute.
+     * @returns A promise with the DialogTurnResult.
+     */
+  protected async onStep (step: WaterfallStepContext<O>): Promise<DialogTurnResult> {
+    return await this.steps[step.index](step)
+  }
+
+  /**
+     * Executes a step of the WaterfallDialog.
+     *
+     * @param dc The DialogContext for the current turn of conversation.
+     * @param index The index of the current waterfall step to execute.
+     * @param reason The DialogReason the waterfall step is being executed.
+     * @param result Optional, result returned by a dialog called in the previous waterfall step.
+     * @returns A Promise that represents the work queued to execute.
+     */
+  protected async runStep (
+    dc: DialogContext,
+    index: number,
+    reason: DialogReason,
+    result?: any
+  ): Promise<DialogTurnResult> {
+    if (index < this.steps.length) {
+      // Update persisted step index
+      const state: WaterfallDialogState = dc.activeDialog.state as WaterfallDialogState
+      state.stepIndex = index
+
+      // Create step context
+      let nextCalled = false
+      const step: WaterfallStepContext<O> = new WaterfallStepContext<O>(dc, {
+        index,
+        options: <O>state.options,
+        reason,
+        result,
+        values: state.values,
+        onNext: async (stepResult?: any): Promise<DialogTurnResult<any>> => {
+          if (nextCalled) {
+            throw new Error(
+                            `WaterfallStepContext.next(): method already called for dialog and step '${this.id}[${index}]'.`
+            )
+          }
+          nextCalled = true
+          return await this.resumeDialog(dc, DialogReason.nextCalled, stepResult)
+        },
+      })
+
+      // Execute step
+      return await this.onStep(step)
+    } else {
+      // End of waterfall so just return to parent
+      return await dc.endDialog(result)
+    }
+  }
+
+  /**
+     * Identifies the step name by its position index.
+     *
+     * @param index Step position
+     * @returns A string that identifies the step name.
+     */
+  private waterfallStepName (index: number): string {
+    // Log Waterfall Step event. Each event has a distinct name to hook up
+    // to the Application Insights funnel.
+    let stepName = ''
+    if (this.steps[index]) {
+      try {
+        stepName = this.steps[index].name
+      } finally {
+        if (stepName === undefined || stepName === '') {
+          stepName = 'Step' + (index + 1) + 'of' + this.steps.length
+        }
+      }
+    }
+    return stepName
+  }
+}
+
+/**
+ * @private
+ */
+interface WaterfallDialogState {
+  options: object;
+  stepIndex: number;
+  values: object;
+}

package/src/waterfallStepContext.ts

@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { DialogContext } from './dialogContext'
+import { DialogReason } from './dialogReason'
+import { DialogTurnResult } from './dialogTurnResult'
+
+/**
+ * Values passed to the `WaterfallStepContext` constructor.
+ */
+export interface WaterfallStepInfo<O extends object> {
+  index: number;
+  options: O;
+  reason: DialogReason;
+  result: any;
+  values: object;
+  onNext(result?: any): Promise<DialogTurnResult>;
+}
+
+/**
+ * Context object passed in to a `WaterfallStep`.
+ *
+ * @param O (Optional) type of options passed to the steps waterfall dialog in the call to `DialogContext.beginDialog()`.
+ */
+export class WaterfallStepContext<O extends object = {}> extends DialogContext {
+  private _stepInfo: WaterfallStepInfo<O>
+
+  /**
+     * Creates a new WaterfallStepContext instance.
+     *
+     * @param dialogContext The dialog context for the current turn of conversation.
+     * @param stepInfo Values to initialize the step context with.
+     */
+  constructor (dialogContext: DialogContext, stepInfo: WaterfallStepInfo<O>) {
+    super(dialogContext.dialogs, dialogContext, { dialogStack: dialogContext.stack })
+    this._stepInfo = stepInfo
+    this.parent = dialogContext.parent
+  }
+
+  /**
+     * The index of the current waterfall step being executed.
+     *
+     * @returns The index of the current waterfall step being executed.
+     */
+  get index (): number {
+    return this._stepInfo.index
+  }
+
+  /**
+     * Any options passed to the steps waterfall dialog when it was started with
+     * `DialogContext.beginDialog()`.
+     *
+     * @returns Any options the waterfall dialog was called with.
+     */
+  get options (): O {
+    return this._stepInfo.options
+  }
+
+  /**
+     * The reason the waterfall step is being executed.
+     *
+     * @returns The reason the waterfall step is being executed.
+     */
+  get reason (): DialogReason {
+    return this._stepInfo.reason
+  }
+
+  /**
+     * Results returned by a dialog or prompt that was called in the previous waterfall step.
+     *
+     * @returns The result from the previous waterfall step.
+     */
+  get result (): any {
+    return this._stepInfo.result
+  }
+
+  /**
+     * A dictionary of values which will be persisted across all waterfall steps.
+     *
+     * @returns A dictionary of values which will be persisted across all waterfall steps.
+     */
+  get values (): object {
+    return this._stepInfo.values
+  }
+
+  /**
+     * Skips to the next waterfall step.
+     *
+     * @param result (Optional) result to pass to the next step.
+     * @returns A promise with the DialogTurnResult.
+     */
+  async next (result?: any): Promise<DialogTurnResult> {
+    return await this._stepInfo.onNext(result)
+  }
+}

package/vendor/cldr-data/README.md

@@ -0,0 +1,5 @@
+All content in this directory (with the exception of this README.md) is derived from the [cldr-data](https://www.npmjs.com/package/cldr-data) package.
+
+See the [NOTICE](../../NOTICE) file for further attribution details.
+
+We are bundling a subset of the output of this dependency to reduce the install time and size.

package/vendor/cldr-data/main/de/numbers.json

@@ -0,0 +1,156 @@
+{
+  "main": {
+    "de": {
+      "identity": {
+        "version": {
+          "_number": "$Revision: 14842 $",
+          "_cldrVersion": "35.1"
+        },
+        "language": "de"
+      },
+      "numbers": {
+        "defaultNumberingSystem": "latn",
+        "otherNumberingSystems": {
+          "native": "latn"
+        },
+        "minimumGroupingDigits": "1",
+        "symbols-numberSystem-latn": {
+          "decimal": ",",
+          "group": ".",
+          "list": ";",
+          "percentSign": "%",
+          "plusSign": "+",
+          "minusSign": "-",
+          "exponential": "E",
+          "superscriptingExponent": "·",
+          "perMille": "‰",
+          "infinity": "∞",
+          "nan": "NaN",
+          "timeSeparator": ":"
+        },
+        "decimalFormats-numberSystem-latn": {
+          "standard": "#,##0.###",
+          "long": {
+            "decimalFormat": {
+              "1000-count-one": "0 Tausend",
+              "1000-count-other": "0 Tausend",
+              "10000-count-one": "00 Tausend",
+              "10000-count-other": "00 Tausend",
+              "100000-count-one": "000 Tausend",
+              "100000-count-other": "000 Tausend",
+              "1000000-count-one": "0 Million",
+              "1000000-count-other": "0 Millionen",
+              "10000000-count-one": "00 Millionen",
+              "10000000-count-other": "00 Millionen",
+              "100000000-count-one": "000 Millionen",
+              "100000000-count-other": "000 Millionen",
+              "1000000000-count-one": "0 Milliarde",
+              "1000000000-count-other": "0 Milliarden",
+              "10000000000-count-one": "00 Milliarden",
+              "10000000000-count-other": "00 Milliarden",
+              "100000000000-count-one": "000 Milliarden",
+              "100000000000-count-other": "000 Milliarden",
+              "1000000000000-count-one": "0 Billion",
+              "1000000000000-count-other": "0 Billionen",
+              "10000000000000-count-one": "00 Billionen",
+              "10000000000000-count-other": "00 Billionen",
+              "100000000000000-count-one": "000 Billionen",
+              "100000000000000-count-other": "000 Billionen"
+            }
+          },
+          "short": {
+            "decimalFormat": {
+              "1000-count-one": "0",
+              "1000-count-other": "0",
+              "10000-count-one": "0",
+              "10000-count-other": "0",
+              "100000-count-one": "0",
+              "100000-count-other": "0",
+              "1000000-count-one": "0 Mio'.'",
+              "1000000-count-other": "0 Mio'.'",
+              "10000000-count-one": "00 Mio'.'",
+              "10000000-count-other": "00 Mio'.'",
+              "100000000-count-one": "000 Mio'.'",
+              "100000000-count-other": "000 Mio'.'",
+              "1000000000-count-one": "0 Mrd'.'",
+              "1000000000-count-other": "0 Mrd'.'",
+              "10000000000-count-one": "00 Mrd'.'",
+              "10000000000-count-other": "00 Mrd'.'",
+              "100000000000-count-one": "000 Mrd'.'",
+              "100000000000-count-other": "000 Mrd'.'",
+              "1000000000000-count-one": "0 Bio'.'",
+              "1000000000000-count-other": "0 Bio'.'",
+              "10000000000000-count-one": "00 Bio'.'",
+              "10000000000000-count-other": "00 Bio'.'",
+              "100000000000000-count-one": "000 Bio'.'",
+              "100000000000000-count-other": "000 Bio'.'"
+            }
+          }
+        },
+        "scientificFormats-numberSystem-latn": {
+          "standard": "#E0"
+        },
+        "percentFormats-numberSystem-latn": {
+          "standard": "#,##0 %"
+        },
+        "currencyFormats-numberSystem-latn": {
+          "currencySpacing": {
+            "beforeCurrency": {
+              "currencyMatch": "[:^S:]",
+              "surroundingMatch": "[:digit:]",
+              "insertBetween": " "
+            },
+            "afterCurrency": {
+              "currencyMatch": "[:^S:]",
+              "surroundingMatch": "[:digit:]",
+              "insertBetween": " "
+            }
+          },
+          "standard": "#,##0.00 ¤",
+          "accounting": "#,##0.00 ¤",
+          "short": {
+            "standard": {
+              "1000-count-one": "0",
+              "1000-count-other": "0",
+              "10000-count-one": "0",
+              "10000-count-other": "0",
+              "100000-count-one": "0",
+              "100000-count-other": "0",
+              "1000000-count-one": "0 Mio'.' ¤",
+              "1000000-count-other": "0 Mio'.' ¤",
+              "10000000-count-one": "00 Mio'.' ¤",
+              "10000000-count-other": "00 Mio'.' ¤",
+              "100000000-count-one": "000 Mio'.' ¤",
+              "100000000-count-other": "000 Mio'.' ¤",
+              "1000000000-count-one": "0 Mrd'.' ¤",
+              "1000000000-count-other": "0 Mrd'.' ¤",
+              "10000000000-count-one": "00 Mrd'.' ¤",
+              "10000000000-count-other": "00 Mrd'.' ¤",
+              "100000000000-count-one": "000 Mrd'.' ¤",
+              "100000000000-count-other": "000 Mrd'.' ¤",
+              "1000000000000-count-one": "0 Bio'.' ¤",
+              "1000000000000-count-other": "0 Bio'.' ¤",
+              "10000000000000-count-one": "00 Bio'.' ¤",
+              "10000000000000-count-other": "00 Bio'.' ¤",
+              "100000000000000-count-one": "000 Bio'.' ¤",
+              "100000000000000-count-other": "000 Bio'.' ¤"
+            }
+          },
+          "unitPattern-count-one": "{0} {1}",
+          "unitPattern-count-other": "{0} {1}"
+        },
+        "miscPatterns-numberSystem-latn": {
+          "approximately": "≈{0}",
+          "atLeast": "{0}+",
+          "atMost": "≤{0}",
+          "range": "{0}–{1}"
+        },
+        "minimalPairs": {
+          "pluralMinimalPairs-count-one": "{0} Tag",
+          "pluralMinimalPairs-count-other": "{0} Tage",
+          "other": "{0}. Abzweigung nach rechts nehmen"
+        }
+      }
+    }
+  }
+}

package/vendor/cldr-data/main/en/numbers.json

@@ -0,0 +1,159 @@
+{
+  "main": {
+    "en": {
+      "identity": {
+        "version": {
+          "_number": "$Revision: 14865 $",
+          "_cldrVersion": "35.1"
+        },
+        "language": "en"
+      },
+      "numbers": {
+        "defaultNumberingSystem": "latn",
+        "otherNumberingSystems": {
+          "native": "latn"
+        },
+        "minimumGroupingDigits": "1",
+        "symbols-numberSystem-latn": {
+          "decimal": ".",
+          "group": ",",
+          "list": ";",
+          "percentSign": "%",
+          "plusSign": "+",
+          "minusSign": "-",
+          "exponential": "E",
+          "superscriptingExponent": "×",
+          "perMille": "‰",
+          "infinity": "∞",
+          "nan": "NaN",
+          "timeSeparator": ":"
+        },
+        "decimalFormats-numberSystem-latn": {
+          "standard": "#,##0.###",
+          "long": {
+            "decimalFormat": {
+              "1000-count-one": "0 thousand",
+              "1000-count-other": "0 thousand",
+              "10000-count-one": "00 thousand",
+              "10000-count-other": "00 thousand",
+              "100000-count-one": "000 thousand",
+              "100000-count-other": "000 thousand",
+              "1000000-count-one": "0 million",
+              "1000000-count-other": "0 million",
+              "10000000-count-one": "00 million",
+              "10000000-count-other": "00 million",
+              "100000000-count-one": "000 million",
+              "100000000-count-other": "000 million",
+              "1000000000-count-one": "0 billion",
+              "1000000000-count-other": "0 billion",
+              "10000000000-count-one": "00 billion",
+              "10000000000-count-other": "00 billion",
+              "100000000000-count-one": "000 billion",
+              "100000000000-count-other": "000 billion",
+              "1000000000000-count-one": "0 trillion",
+              "1000000000000-count-other": "0 trillion",
+              "10000000000000-count-one": "00 trillion",
+              "10000000000000-count-other": "00 trillion",
+              "100000000000000-count-one": "000 trillion",
+              "100000000000000-count-other": "000 trillion"
+            }
+          },
+          "short": {
+            "decimalFormat": {
+              "1000-count-one": "0K",
+              "1000-count-other": "0K",
+              "10000-count-one": "00K",
+              "10000-count-other": "00K",
+              "100000-count-one": "000K",
+              "100000-count-other": "000K",
+              "1000000-count-one": "0M",
+              "1000000-count-other": "0M",
+              "10000000-count-one": "00M",
+              "10000000-count-other": "00M",
+              "100000000-count-one": "000M",
+              "100000000-count-other": "000M",
+              "1000000000-count-one": "0B",
+              "1000000000-count-other": "0B",
+              "10000000000-count-one": "00B",
+              "10000000000-count-other": "00B",
+              "100000000000-count-one": "000B",
+              "100000000000-count-other": "000B",
+              "1000000000000-count-one": "0T",
+              "1000000000000-count-other": "0T",
+              "10000000000000-count-one": "00T",
+              "10000000000000-count-other": "00T",
+              "100000000000000-count-one": "000T",
+              "100000000000000-count-other": "000T"
+            }
+          }
+        },
+        "scientificFormats-numberSystem-latn": {
+          "standard": "#E0"
+        },
+        "percentFormats-numberSystem-latn": {
+          "standard": "#,##0%"
+        },
+        "currencyFormats-numberSystem-latn": {
+          "currencySpacing": {
+            "beforeCurrency": {
+              "currencyMatch": "[:^S:]",
+              "surroundingMatch": "[:digit:]",
+              "insertBetween": " "
+            },
+            "afterCurrency": {
+              "currencyMatch": "[:^S:]",
+              "surroundingMatch": "[:digit:]",
+              "insertBetween": " "
+            }
+          },
+          "standard": "¤#,##0.00",
+          "accounting": "¤#,##0.00;(¤#,##0.00)",
+          "short": {
+            "standard": {
+              "1000-count-one": "¤0K",
+              "1000-count-other": "¤0K",
+              "10000-count-one": "¤00K",
+              "10000-count-other": "¤00K",
+              "100000-count-one": "¤000K",
+              "100000-count-other": "¤000K",
+              "1000000-count-one": "¤0M",
+              "1000000-count-other": "¤0M",
+              "10000000-count-one": "¤00M",
+              "10000000-count-other": "¤00M",
+              "100000000-count-one": "¤000M",
+              "100000000-count-other": "¤000M",
+              "1000000000-count-one": "¤0B",
+              "1000000000-count-other": "¤0B",
+              "10000000000-count-one": "¤00B",
+              "10000000000-count-other": "¤00B",
+              "100000000000-count-one": "¤000B",
+              "100000000000-count-other": "¤000B",
+              "1000000000000-count-one": "¤0T",
+              "1000000000000-count-other": "¤0T",
+              "10000000000000-count-one": "¤00T",
+              "10000000000000-count-other": "¤00T",
+              "100000000000000-count-one": "¤000T",
+              "100000000000000-count-other": "¤000T"
+            }
+          },
+          "unitPattern-count-one": "{0} {1}",
+          "unitPattern-count-other": "{0} {1}"
+        },
+        "miscPatterns-numberSystem-latn": {
+          "approximately": "~{0}",
+          "atLeast": "{0}+",
+          "atMost": "≤{0}",
+          "range": "{0}–{1}"
+        },
+        "minimalPairs": {
+          "pluralMinimalPairs-count-one": "{0} day",
+          "pluralMinimalPairs-count-other": "{0} days",
+          "few": "Take the {0}rd right.",
+          "one": "Take the {0}st right.",
+          "other": "Take the {0}th right.",
+          "two": "Take the {0}nd right."
+        }
+      }
+    }
+  }
+}