General

The main purpose this module is integrate Microsoft SDKs to OneReach and share logic between steps. This package uses @microsoft/microsoft-graph-client and botbuilder SDKs to communicate with Microsoft services. Also watch MS Graph API.

This package can be used in steps after publishing in npm. So whenever you make some changes you must publish it in npm. Currently for development latest published version contains the --dev tag.

Structure

src/botframework - all required classes and functions to integrate Botbuilder with OneReach. Some of the used Botbuilder classes are already deprecated but working (it is desirable to update).

src/graph - all required classes and functions to integrate MS Graph SDK and some of the core logic for managing certificates and subscriptions. Subscriptions and certificates are used to be able to decrypt change-notification payload.

src/cache - MS Teams toolkit strongly relies on cache logic to link Graph and Botframework user's Ids, and store some bot, team, and group chats data. All data is stored in KeyValue storage. You can check names and collections in config files.

src/middlewares - are new way of composable parts of logic to be used in steps.

src/mixins - the old way to share logic between steps. Still used in some of the steps.

src/services - used in steps logic by mixins or middlewares.

src/typings - just some general typings.

src/utils - general utils. Helpful when middlewares is used.

or-config.[env].js - contains key-value storage collections names, adapter path, and expires for subscriptions and certificate.

Scripts

build - build the module into lib folder.

build-prod - build the module with prod config. Also automatically increments the package version.

build-dev - build the module with dev config. Also automatically increments the package version.

package-prod - build and create archive with prod config.

package-dev - build and create archive with dev config.

publish-prod - build and publish package.

publish-dev - build and publish package with --dev tag.

All those scripts must be run from the or-msteams package root directory.