{"id":15012126,"url":"https://github.com/microsoft/botbuilder-js","last_synced_at":"2025-05-13T17:06:52.054Z","repository":{"id":37798019,"uuid":"117021493","full_name":"microsoft/botbuilder-js","owner":"microsoft","description":"Welcome to the Bot Framework SDK for JavaScript repository, which is the home for the libraries and packages that enable developers to build sophisticated bot applications using JavaScript. ","archived":false,"fork":false,"pushed_at":"2025-04-16T16:10:13.000Z","size":52126,"stargazers_count":711,"open_issues_count":32,"forks_count":284,"subscribers_count":75,"default_branch":"main","last_synced_at":"2025-04-23T23:05:01.749Z","etag":null,"topics":["bot","bot-framework","bots","js","microsoft-bot-framework","microsoft-cognitive-services","nodejs","sdk"],"latest_commit_sha":null,"homepage":"https://github.com/Microsoft/botframework-sdk","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-10T23:01:21.000Z","updated_at":"2025-04-20T18:25:01.000Z","dependencies_parsed_at":"2024-01-16T18:06:00.793Z","dependency_job_id":"dd6a82c2-fe0d-4c2e-a9d3-8fec76d230c5","html_url":"https://github.com/microsoft/botbuilder-js","commit_stats":{"total_commits":3040,"total_committers":187,"mean_commits":16.25668449197861,"dds":0.9273026315789473,"last_synced_commit":"021429c1fa6465b447461232162b29bc7b9a1f41"},"previous_names":[],"tags_count":275,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fbotbuilder-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fbotbuilder-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fbotbuilder-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fbotbuilder-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/botbuilder-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250528732,"owners_count":21445516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","bot-framework","bots","js","microsoft-bot-framework","microsoft-cognitive-services","nodejs","sdk"],"created_at":"2024-09-24T19:42:07.897Z","updated_at":"2025-04-23T23:05:23.835Z","avatar_url":"https://github.com/microsoft.png","language":"TypeScript","readme":"# ![Bot Framework SDK v4 for JavaScript](./docs/media/BotFrameworkJavaScript_header.png)\n\nThis repository contains code for the JavaScript version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-sdk), which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences.\n\nThis SDK enables developers to model conversation and build sophisticated bot applications using JavaScript. SDKs for [.NET](https://github.com/Microsoft/botbuilder-dotnet), [Python](https://github.com/Microsoft/botbuilder-python) and [Java (preview)](https://github.com/Microsoft/botbuilder-java) are also available.\n\nTo get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).  If you are an existing user, then you can also [find out what's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0).\n\nFor more information jump to a section below.\n\n* [Build status](#build-status)\n* [Packages](#packages)\n* [Getting started](#getting-started)\n* [Getting support and providing feedback](#getting-support-and-providing-feedback)\n* [Contributing and our code of conduct](#contributing-and-our-code-of-conduct)\n* [Reporting security sssues](#reporting-security-issues)\n\n## Build Status\n\n| Branch    | Description  | Test Status                                                                                                                                                                    | Coverage Status                                                                                                                                                           | Windows Bot Test Status                                                                                                                                                                                                       | Linux Bot Test Status                                                                                                                                                                                                     | Browser Functional Tests\n|-----------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| main      | 4.15.x Tests | [![Test Status](https://github.com/microsoft/botbuilder-js/actions/workflows/tests.yml/badge.svg)](https://github.com/microsoft/botbuilder-js/actions/workflows/tests.yml)     | [![Coverage Status](https://coveralls.io/repos/github/microsoft/botbuilder-js/badge.svg?branch=main)](https://coveralls.io/github/microsoft/botbuilder-js?branch=main)    | [![Build Status](https://fuselabs.visualstudio.com/SDK_v4/_apis/build/status/js/run-js-functional-tests-windows?branchName=main)](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=548\u0026branchName=main)    | [![Build Status](https://fuselabs.visualstudio.com/SDK_v4/_apis/build/status/js/run-js-functional-tests-linux?branchName=main)](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=549\u0026branchName=main)  | [![Build Status](https://fuselabs.visualstudio.com/SDK_v4/_apis/build/status/SDK_v4-CI?branchName=main)](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=731\u0026branchName=main) |\n\n## Packages\n\n| Name                                                              | NPM Package                                                                                                                                                                                                                                                                                               |\n|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| adaptive-expressions                                              | [![BotBuilder Badge](https://img.shields.io/npm/dt/adaptive-expressions.svg?logo=npm\u0026label=adaptive-expressions)](https://www.npmjs.com/package/adaptive-expressions/)                                                                                                                                    |\n| adaptive-expressions-ie11                                         | [![BotBuilder Badge](https://img.shields.io/npm/dt/adaptive-expressions-ie11.svg?logo=npm\u0026label=adaptive-expressions-ie11)](https://www.npmjs.com/package/adaptive-expressions-ie11/)                                                                                                                          |\n| botbuilder                                                        | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder.svg?logo=npm\u0026label=botbuilder)](https://www.npmjs.com/package/botbuilder/)                                                                                                                                                                  |\n| botbuilder-ai                                                     | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-ai.svg?logo=npm\u0026label=botbuilder-ai)](https://www.npmjs.com/package/botbuilder-ai/)                                                                                                                                                         |\n| botbuilder-ai-orchestrator                                        | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-ai-orchestrator.svg?logo=npm\u0026label=botbuilder-ai-orchestrator)](https://www.npmjs.com/package/botbuilder-ai-orchestrator/)                                                                                                                  |\n| botbuilder-ai-luis                                                | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-ai-luis.svg?logo=npm\u0026label=botbuilder-ai-luis)](https://www.npmjs.com/package/botbuilder-ai-luis/)                                                                                                                                          |\n| botbuilder-ai-qna                                                 | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-ai-qna.svg?logo=npm\u0026label=botbuilder-ai-qna)](https://www.npmjs.com/package/botbuilder-ai-qna/)                                                                                                                                             |\n| botbuilder-applicationinsights                                    | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-applicationinsights.svg?logo=npm\u0026label=botbuilder-applicationinsights)](https://www.npmjs.com/package/botbuilder-applicationinsights/)                                                                                                      |\n| botbuilder-azure                                                  | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-azure.svg?logo=npm\u0026label=botbuilder-azure)](https://www.npmjs.com/package/botbuilder-azure/)                                                                                                                                                |\n| botbuilder-azure-blobs                                            | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-azure-blobs.svg?logo=npm\u0026label=botbuilder-azure-blobs)](https://www.npmjs.com/package/botbuilder-azure-blobs/)                                                                                                                              |\n| botbuilder-azure-queues                                           | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-azure-queues.svg?logo=npm\u0026label=botbuilder-azure-queues)](https://www.npmjs.com/package/botbuilder-azure-queues/)                                                                                                                           |\n| botbuilder-core                                                   | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-core.svg?logo=npm\u0026label=botbuilder-core)](https://www.npmjs.com/package/botbuilder-core/)                                                                                                                                                   |\n| botbuilder-dialogs                                                | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs.svg?logo=npm\u0026label=botbuilder-dialogs)](https://www.npmjs.com/package/botbuilder-dialogs/)                                                                                                                                          |\n| botbuilder-dialogs-adaptive                                       | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive/)                                                                                                               |\n| botbuilder-dialogs-adaptive-runtime                               | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive-runtime.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive-runtime)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive-runtime/)                                                                                       |\n| botbuilder-dialogs-adaptive-runtime-core                          | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive-runtime-core.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive-runtime-core)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive-runtime-core/)                                                                        |\n| botbuilder-dialogs-adaptive-runtime-integration-express           | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive-runtime-integration-express.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive-runtime-integration-express)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive-runtime-integration-express/)                           |\n| botbuilder-dialogs-adaptive-runtime-integration-azure-functions   | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive-runtime-integration-azure-functions.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive-runtime-integration-azure-functions)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive-runtime-integration-azure-functions/)   |\n| botbuilder-dialogs-adaptive-runtime-integration-restify           | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive-runtime-integration-restify.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive-runtime-integration-restify)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive-runtime-integration-restify/)                           |\n| botbuilder-dialogs-adaptive-testing                               | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-adaptive-testing.svg?logo=npm\u0026label=botbuilder-dialogs-adaptive-testing)](https://www.npmjs.com/package/botbuilder-dialogs-adaptive-testing/)                                                                                       |\n| botbuilder-dialogs-declarative                                    | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-dialogs-declarative.svg?logo=npm\u0026label=botbuilder-dialogs-declarative)](https://www.npmjs.com/package/botbuilder-dialogs-declarative/)                                                                                                      |\n| botbuilder-lg                                                     | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-lg.svg?logo=npm\u0026label=botbuilder-lg)](https://www.npmjs.com/package/botbuilder-lg/)                                                                                                                                                         |\n| botbuilder-stdlib                                                 | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-stdlib.svg?logo=npm\u0026label=botbuilder-stdlib)](https://www.npmjs.com/package/botbuilder-stdlib/)                                                                                                                                             |\n| botbuilder-testing                                                | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-testing.svg?logo=npm\u0026label=botbuilder-testing)](https://www.npmjs.com/package/botbuilder-testing/)                                                                                                                                          |\n| botframework-config                                               | [![BotBuilder Badge](https://img.shields.io/npm/dt/botbuilder-config.svg?logo=npm\u0026label=botframework-config)](https://www.npmjs.com/package/botframework-config/)                                                                                                                                         |\n| botframework-connector                                            | [![BotBuilder Badge](https://img.shields.io/npm/dt/botframework-connector.svg?logo=npm\u0026label=botframework-connector)](https://www.npmjs.com/package/botframework-connector/)                                                                                                                              |\n| botframework-schema                                               | [![BotBuilder Badge](https://img.shields.io/npm/dt/botframework-schema.svg?logo=npm\u0026label=botframework-schema)](https://www.npmjs.com/package/botframework-schema/)                                                                                                                                       |\n| botframework-streaming                                            | [![BotBuilder Badge](https://img.shields.io/npm/dt/botframework-streaming.svg?logo=npm\u0026label=botframework-streaming)](https://www.npmjs.com/package/botframework-streaming/)                                                                                                                              |\n\nTo view package interdependencies, see the [dependency graph](https://botbuildersdkblobstorag2.blob.core.windows.net/sdk-js-dependency-reports/latest/InterdependencyGraph.html).\n\n## Getting Started\n\nTo get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0).\n\nThe [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) includes a rich set of samples repository.\n\nIf you want to debug an issue, would like to [contribute](#Contributing-and-our-code-of-conduct), or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below.\n\n### Prerequisites\n- [Git](https://git-scm.com/downloads)\n- [Node.js](https://nodejs.org/en/)\n- [Yarn 1.x](https://classic.yarnpkg.com/)\n- [TypeScript](https://www.typescriptlang.org/) version \u003e= 3.8\n- Your favorite code-editor for example [VS Code](https://code.visualstudio.com/)\n\n### Clone\n\nClone a copy of the repo:\n\n```bash\ngit clone https://github.com/microsoft/botbuilder-js.git\n```\n\nChange to the SDK's directory:\n\n```bash\ncd botbuilder-js\n```\n\n### Build and test locally\n\nInstall the prerequisites.\n\n```bash\nyarn\n```\n\nThen use the following command to build the SDK.\n\n```bash\nyarn build\n```\n\n### Running unit tests\n\nUse the following command to run the unit tests.\n\n```bash\nyarn test\n```\n\nThe `prep-test.cmd` command is run to install test keys and start the [Azure Storage Emulator](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator) if its installed. Any unit tests needing test keys or the storage emulator are designed to be skipped if their dependencies are missing so most developers won't need to worry about running this command.\n\nIf you have a need to re-generate the LUIS or connector clients using the latest swagger you'll need to install `autorest` (requires Node 7.10.0 or higher), which you can do with the following command.\n\n```bash\nyarn global add global autorest\n```\n\n## Getting support and providing feedback\n\nBelow are the various channels that are available to you for obtaining support and providing feedback. Please pay carful attention to which channel should be used for which type of content. e.g. general \"how do I...\" questions should be asked on Stack Overflow, Twitter or Gitter, with GitHub issues being for feature requests and bug reports.\n\n### Github issues\n\n[Github issues](https://github.com/Microsoft/botbuilder-js/issues) should be used for bugs and feature requests.\n\n### Stack overflow\n\n[Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) is a great place for getting high-quality answers. Our support team, as well as many of our community members are already on Stack Overflow providing answers to 'how-to' questions.\n\n### Azure Support\n\nIf you issues relates to [Azure Bot Service](https://azure.microsoft.com/en-gb/services/bot-service/), you can take advantage of the available [Azure support options](https://azure.microsoft.com/en-us/support/options/).\n\n### Twitter\n\nWe use the [@msbotframework](https://twitter.com/msbotframework) account on twitter for announcements and members from the development team watch for tweets for [@msbotframework](https://twitter.com/msbotframework).\n\n### Gitter Chat Room\n\nThe [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) provides a place where the Community can get together and collaborate.\n\n## Contributing and our code of conduct\n\nWe welcome contributions and suggestions. Please see our [contributing guidelines](./Contributing.md) for more information.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact\n [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Reporting Security Issues\n\nSecurity issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC)\nat [secure@microsoft.com](mailto:secure@microsoft.com).  You should receive a response within 24 hours.  If for some\n reason you do not, please follow up via email to ensure we received your original message. Further information,\n including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the\n[Security TechCenter](https://technet.microsoft.com/en-us/security/default).\n\nCopyright (c) Microsoft Corporation. All rights reserved.\n\nLicensed under the [MIT](./LICENSE) License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fbotbuilder-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fbotbuilder-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fbotbuilder-js/lists"}