Git Product home page Git Product logo

botbuilder-composer's Introduction

WARNING! The Library still in active research & development be warned that interfaces will be changed in minor versions before 1.0 release!

Glossary

  • theme - a function or object which will be called to produce/enhance a bot instance. Integrated with event emitter, so able to produce custom events for external subcriber;
  • plugin - a callback function that used to extend a bot instance produced from template. Use to be smaller than theme, but to contain generic reusable logic.

Description

The Library used to compose chatbots from components that leverage Microsoft Bot Framework.

Quick Start

Installation

npm install --save-dev botbuilder-composer

Documentation

Build Sequence

Chatbot build sequence diagram

composer.compose(config)

Returns a Universal bot instance. Config fields:

  • theme function(Universalbot bot, EventEmitter buildEventManager)|ThemeObject
  • plugins function[], array of callback. Every plugin should return a Promise, once all plugin resolved event init will be executed
  • (optional) bot UniversalBot - if empty, compose will create instance of UniversalBot and will pass it to theme and callbacks.

ThemeObject

  • beforeInit: function( bot, buildEventManager)
  • build: function( bot, buildEventManager). Value returned by function will be resolved as a promise.

Standard Events

  • init - called when theme and all plugin callbacks executed
  • complete - called after

Example

Changelog

  • 0.1.0 - initial release

botbuilder-composer's People

Contributors

gudwin avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.