botbuilder-js/libraries/botbuilder-azure
Jhonatan Sandoval Velasco cd6cf6f9f8
bump: Update ESLint packages and migrate to eslint.config.cjs files (#4776)
* update eslint configurations

* show only eslint warnings

* add dependencies

* removed unused imports and add only warn to every library

* move eslint-plugin-only-warn to the right place

* fix import errors

* remove files config

* Update eslint.config

* Remove blank line and spaces

---------

Co-authored-by: Joel Mut <joel.mut@southworks.com>
Co-authored-by: CeciliaAvila <cecilia.avila@southworks.com>
2024-10-29 09:04:25 -05:00
..
etc port: [#4465][#6560] Allow TokenCredential authentication in CosmosDbPartitionedStorage (#4473) 2023-05-08 09:31:09 -05:00
src bump: [#4684] Update multiple dependencies inside public libraries to latest version (#4739) 2024-09-10 08:51:24 -05:00
tests Update @azure/cosmos and @azure/core-auth packages (#4748) 2024-09-17 16:18:45 -05:00
.gitignore updated project gitignore files 2018-08-13 17:17:16 -07:00
.nycrc Added code coverage analysis (#26) 2018-01-29 18:09:48 -08:00
LICENSE Add LICENCE to libraries (#4169) 2022-03-21 17:43:03 -04:00
README.md port: [#4272] SDK uses deprecated Microsoft.Azure.DocumentDB.Core library (#6370) (#4292) 2022-07-26 16:14:57 -05:00
api-extractor.json chore: add test:compat to CI tests (#3691) 2021-05-19 15:21:39 -07:00
eslint.config.cjs bump: Update ESLint packages and migrate to eslint.config.cjs files (#4776) 2024-10-29 09:04:25 -05:00
package.json bump: Update ESLint packages and migrate to eslint.config.cjs files (#4776) 2024-10-29 09:04:25 -05:00
tsconfig.json feat: [#4503] azure-storage deprecation (#4510) 2023-07-28 10:46:35 -05:00

README.md

Bot Builder Azure

Azure extensions for Microsoft BotBuilder.

Installing

To add the latest version of this package to your bot:

npm install --save botbuilder-azure

Use the Daily Build

To get access to the daily builds of this library, configure npm to use the MyGet feed before installing.

npm config set registry https://botbuilder.myget.org/F/botbuilder-v4-js-daily/npm/

To reset the registry in order to get the latest published version, run:

npm config set registry https://registry.npmjs.org/

What's Included

This module contains interfaces to use common Azure services to back Bot Builder's state storage. When used with UserState, ConversationState and BotState, these storage interfaces will automatically read and write values to the associated Azure service.

It currently supports Cosmos DB (CosmosDbPartitionedStorage()) and Azure Blob Storage (BlobStorage()).

Also included is an interface to store and retrieve chat transcripts in blog storage called AzureBlobTranscriptStore()

Use

Import the module into your app.

const { BlobStorage } = require('botbuilder-azure');

Configure the storage driver to work with your Azure resources.

const blobStorage = new BlobStorage(options);

Pass the storage driver into your state managers:

const userState = new UserState(blobStorage);
const conversationState = new ConverationState(blobStorage);