Release Notes

Bot Builder for Node.js is targeted at Node.js developers creating new bots from scratch. By building your bot using the Bot Builder framework you can easily adapt it to run on nearly any communication platform. This gives your bot the flexibility to be wherever your users are.

Install

Get the latest version of Bot Builder using npm.

npm install --save botbuilder
npm install --save botbuilder-calling

Release Notes

The framework is still in preview mode so developers should expect breaking changes in future versions of the framework. A list of current issues can be found on our GitHub Repository.

v3.7.0

Changes

  • Added prompt locale files for PT (Portuguese) language.
  • Added new Intent Forwarding feature that lets middleware forward intents to the message router.
  • Simplified the build process.
  • Fixed a bug in Session.validateDialogStack() that was causing it to always succeed.
  • Added a ducktyping check to the RegExpRecognizer to fix an issue on Node-RED.
  • Removed the deprecated node-uuid module that we weren’t even using anymore.
  • Added logic to Prompts to validate that the session object is passed in and throw a more meaningful error message when it’s not.
  • Updated package.json version.

v3.6.0

Changes

  • Fixed a bug causing global recognizers to be run twice..
  • Added a new UniversalBot.loadSession() method to let you load a session object for an address.
  • Added a new ChatConnector.onInvoke() callback for use with the protocols new invoke activity type..
  • Updated LKG build and package.json version.

v3.5.4

Bug Fixes

  • Fix bug where service url is modified in Teams, breaking even basic bots in Teams

v3.5.3

New Features

  • All new customizable routing system.
  • UniversalBot now derives from Library so you can easily aggregate child libraries and bots under a single parent bot.
  • Added support for registering recognizers globally.
  • Added new Dialog.triggerAction() for specifying rules that auto launch dialogs based on a users utterance.
  • All actions are now customizable.
  • Added confirmPrompt to Dialog.cancelAction().
  • New Session methods for saving and replacing dialog stacks.
  • Expanded IRecognizeContext object to be just a read-only version of the session.
  • Simplified creation of basic send/receive bot: Added ability to pass default dialog to UniversalBot constructor and deprecated passing of additional settings.
  • Added new UnoversalBot.onDisambiguateRoute hook.
  • Added new MediaCard classes for building media card attachments.
  • Added support for French to the built-in prompts.
  • Added support for cloning a library or bot.

Bug Fixes

  • Updated LuisRecognizer to support v2 URL’s.
  • Fixed issue with localization namespace not being found on macs.
  • Fixed an issue with the session always assuming ‘*’ as the root namespace.
  • Chat connector fix for case sensitive Authorization header.
  • Several localization related fixes uncovered by new unit tests.
  • Fix EntityRecognizer is very relaxed when parsing affirmative/negative.
  • Fix bug in url joining where the last part of the service uri gets lost due to url.resolve behavior.
  • Fixes related to the move to TypeScript 2.1.

Other Changes

  • Upgrade Node.js Bot Builder to v3.1 auth.
  • Added passing of user-agent header in ChatConnector calls.
  • Added several new feature specific examples.
  • Updated all examples to use new 3.5 features.
  • Added several new unit tests.
  • Updated Channel.ts to reflect latest capabilities.

v3.4.2

  • Fixed an exception being raised for bots without a default locale.
  • Fixed an inadvertent rename of Library.name to Library.namespace in the libraries typescript definition file.
  • Updated LKG build and package.json version.

v3.4.0

  • Fixed a bug where path to localization files was being lowercased.
  • Added support for localizing prompts on a per/library basis. Each library can now have it’s own /locale/ folder and prompts which can be overridden by the bot.
  • Removed a content.message.text guard from IntentDialog. Now you can recognize based on attachments as well as text.
  • Updated LKG build and package.json version.

v3.3.3

  • Removed requirement for IDialogResult.resumed.
  • Removed ability to pass in a custom localizer. The new localizer system should be used instead.
  • Changed a warning that was getting emitted from localizer to a debug statement.
  • Fixed a bug where the localizers path wasn’t defaulting to “./locale/”
  • Updated LKG build and package.json version.

v3.3.2

  • Fixed an issue with ordinal parsing in EntityRecognizer.parseNumber().
  • Fixed an issue with ListStyle.inline being used for Prompts.confirm() on text based channels.
  • Fixed a bug with localized Prompts.confirm() options not being recognized.
  • Updated LKG build and package.json version.

v3.3.1

  • Added new locals for Spanish, Italian, and Chinese.
  • Fixed an issue with the preferred local not being passed to LuisRecognizer class.
  • Fixed an issue with localizationNamespace param not being passed for prompts.
  • Fixed an issue with DefaultLocalizer class assuming it would always have a done callback.
  • Cleaned up passing of localizerSettings from bot to DefaultLocalizer.
  • Updated typescript definitions and docs.
  • Updated LKG build and package.json version.

v3.3.0

  • Added new prompt localization system.
  • Fixed an issue with callbacks passed to UniversalBot.send() not being called.
  • Added missing Keyboard class export.
  • Fixed a missing callback in Session.sendBatch().
  • Updated Session.sendTyping() to send the current batch immediately.
  • Fixed waterfall step count that’s logged to console.
  • Took a PR to prevent a server crash if request body has nothing.
  • Added a new IntentDialog.recognizer() method .
  • Added a new Session.preferredLocale() method.
  • Fixed a bug where a late bound connector wasn’t getting used as storage.
  • Updated reference docs.
  • Updated LKG build and package.json version.

v3.2.3

  • Moved setting of sessionState.lastAccess to happen after middleware runs. This lets you write middleware that expires old sessions.
  • Fixed a couple of issues with proactive conversations not working. Also should fix issues with proactive conversations for groups not working.
  • Updated LKG build and package.json version.

v3.2.2

  • Fixed undesired forward resume status in waterfall step.
  • Updated unit tests. Removed old deprecated ones.
  • Added missing export for RecognizeMode and fixed a type-o with RecognizeOrder export.
  • Updated score returned from LuisRecognizer for ‘none’ intent. It’s now a score of 0.1 so it will trigger but won’t stomp on other models.
  • Updated botbuilder.d.ts file bundled with npm.
  • Updated LKG build and package.json version.

v3.2.1

Breaking Changes

These changes will impact a small number of bots.

  • Updated IRecognizerActionResult.matched and IIntentRecognizerResult.matched to return all the matched results as an array versus just the text that matched. These changes shouldn’t effect many people as its likely you were already re-evaluating the matched expression if you needed the capture data.
  • Added a new RecognizeMode for IntentDialogs which solves in issue where launching an IntentDialog as a sub dialog would cause it to immediately process the last utterance. This should only be a breaking change if you are using multiple IntentDialogs to scope down from a general model to a more specialized model. In that case you’ll want to create your specialized IntentDialogs with a recognizeMode: builder.RecognizeMode.onBegin.

Other Changes

  • Added support for ordinal words to EntityRecognizer.parseNumber().
  • Added support for Facebook Quick Replies.
  • Added new Session.sendTyping() function.
  • Added optional callback param to sendBatch().
  • Added IntentDialog.matchesAny() method that takes an array of intents to match.
  • Fixed an issue for middleware that was causing session.beginDialog() calls to always run in the current dialogs library content which was often a system prompt. Now middleware assumes the default library context.
  • Added support for gzip your bot data.
  • Fixed an issue where storing too much bot data would get your bot into a stuck state.
  • Updated LKG build and package.json version.

v3.1.0

  • Removed try catches that were causing errors to be ate. Added logic to dump stack trace because node isn’t always dumping on uncaught exceptions.
  • Added NODE_DEBUG logging switch to enable logging of channels other than the emulator.
  • Implemented actions.
  • Updated reference docs.
  • Added keyboard concept and updated Prompts.choice() to use keyboards.
  • Added basic support for Facebook quick_replies using keyboards.
  • Fixed auth issues around ChatConnector.
  • Added new CardAction.dialogAction() type.
  • Removed ‘cancel’ checks from Prompts.
  • Updated prompts to not by default exit out after too many retries.
  • Added Session.sendTyping() method.
  • Updated LKG build and package.json version.

v3.0.1

  • Fixed an issue with channelData being sent for messages without channel data.
  • Fixed an issue where we weren’t reporting a lot of errors.
  • Added logic to properly verify the bots identity when called from the emulator.
  • Added console logging to report failures around security with recommendations.
  • Added a new tracing system that logs the bots session & dialog activity to the console for the emulator.
  • Updated LKG build and package.json version.

v3.0.0

  • See What’s New for a relatively complete list of changes.

v1.0.0

Breaking Changes

These changes will impact some bots.

  • Simple closure based handlers are now single step waterfalls.
  • If a dialog steps past the end of a waterfall the dialog is automatically ended.

Other Changes

  • Exposed SimpleDialog class from both module & docs.
  • DialogAction.validatedPrompt() now returns a Dialog which makes it more strongly typed.
  • Fixed an issue with the LuisDialog on() & onDefault() handlers eating exceptions.
  • Fixed issue with telegram not showing buttons on re-prompt.
  • Updated LKG build and package.json version.

v0.11.1

  • Fixed a bug causing multiple messages to get rejected by the live servers.
  • Updated LKG build and package.json version.

v0.11.0

  • 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.
  • Minor tweak to the way the emulators callback URL is calculated.
  • Updated LKG build and package.json version.

v0.10.2

  • Fixed a bug in CommandDialog preventing onDefault() handlers from resuming properly.
  • Updated LKG build and package.json version.

v0.10.1

  • Fixed a bug preventing BotConnectorBot configured greeting messages from being delivered.
  • Fixed a couple of issues with Prompts.choice() when not using ListStyle.auto.
  • Updated LKG build and package.json version.

v0.10.0

  • Added logic to automatically detect messages from the emulator. This removes the need to manually set an environment variable to configure talking to the emulator.
  • Added support for new Action attachment type (buttons.)
  • Exposed static LuisDialog.recognize() method. Can be used to manually call a LUIS model.
  • Added support to Prompts.choice() to render choices as buttons using ListStyle.button.
  • Added new ListStyle.auto option to Prompts.choice() which automatically selects the appropriate rendering option based on the channel and number of choices. This is the new default style.
  • Added support to all Prompts for passing in an array of prompt & re-prompt strings. A prompt will be selected at random.
  • Added support to all Prompts for passing in an IMessage. This lets you specify prompts containing images and other future attachment types.
  • Updated LKG build and package.json version.

v0.9.2

  • Fixed an undefined bug in Message.setText()
  • Updated LKG build and package.json version.

v0.9.1

  • Changed Math.round to Math.floor to fetch random array element
  • Updated LKG build and package.json version.

v0.9.0

Breaking Changes

None of these changes are likely to effect anyone but they could so here are the ones that may break things:

  • Updated arguments passed to BotConnectorBot.listen().
  • Renamed ISessionArgs to ISessionOptions and also renamed Session.args to Session.options.
  • Made Session.createMessage() private. It doesn’t need to be public now that we have new Message builder class.
  • Changed EntityRecognizer.parseNumber() to return Number.NaN instead of undefined when a number isn’t recognized.

Other Changes

  • Significant improvements to the Reference Docs.
  • Fixed a couple of bugs related to missing intents coming back from LUIS.
  • Fixed a deep copy bug in MemoryStorage class. I now use JSON.stringify() & JSON.parse() to ensure a deep copy.
  • Made dialogId passed to Session.reset() optional.
  • Updated Message.setText() to support passing an array of prompts that will be chosen at random.
  • Added methods to Message class to simplify building complex multi-part and randomized prompts.
  • BotConnectorBot changes needed to support continueDialog() method that’s in development.
  • Fixed a typo in the import of Consts.ts for Mac builds.
  • Updated LKG build and package.json version.

v0.8.0

  • Added minSendDelay option that slows down the rate at which a bot sends replies to the user. The default is 1 sec but can be set using an option passed to the bot. See TextBot.js unit test for an example of that.
  • Added support to SlackBot for sending an isTyping indicator. This goes along with the message slow down.
  • Added a new Message builder class to simplify returning messages with attachments. See the send-attachment.js test in TestBot for an example of using it.
  • Added a new DialogAction.validatedPrompt() method to simplify creating custom prompts with validation logic. See basics-validatedPrompt example for a sample of how to use it.
  • SlackBot didn’t support returning image attachments so I added that and fixed a couple of other issues with the SlackBot.
  • Updated the LKG build, unit tests, and package.json version.

v0.7.2

  • Fixed bugs preventing BotConnectorBot originated messages from working. Also resolved issues with sending multiple messages from a bot.
  • Fixed bugs preventing SlackBot originated messages from working.
  • Updated LKG build and package.json version.

v0.7.1

  • Fixed a critical bug in Session.endDialog() that was causing Session.dialogData to get corrupted.
  • Updated LKG build and package.json version.

v0.7.0

  • Making Node CommandDialog robust against undefined matched group.
  • Added the ability to send a message as part of ending a dialog..
  • Updated LKG build and package.json version.

v0.6.5

  • Fixed bad regular expressions used by Prompts.confirm() and adding missing unit tests for Prompts.confirm().
  • Updated LKG build and package.json version.

v0.6.4

  • LUIS changed their scheme for the prebuilt datetime entity and are no longer returning a resolution_type which caused issues for EntityRecognizer.resolveTime(). I know use either resolution_type or entity.type.
  • Updated LKG build and package.json version.

v0.6.3

  • LUIS changed their schema for the pre-built Cortana app which caused the basics.naturalLanguage example to stop working. This build fixes that issue.
  • Updated LKG build and package.json version.

v0.6.2

  • Fixed an issue where Session.endDialog() was eating error messages when a dialog throws an exception. Now exceptions result in the ‘error’ event being emitted as expected.
  • Updated BotConnectorBot.verifyBotFramework() to only verify authorization headers over HTTPS.
  • Removed some dead code from LuisDialog.ts.
  • Updated LKG build and package.json version.

v0.6.1

  • Fixed an issue with SlackBot & SkypeBot escapeText() and unescapeText() methods not doing a global replace.
  • Changed the URL that the BotConnectorBot sends outgoing bot originated messages to. We had an old server link.
  • Updated LKG build and package.json version.