# twitch-toolkit
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat)](http://doge.mit-license.org)
[![Build Status](https://travis-ci.org/chriteixeira/twitch-toolkit.svg?branch=master)](https://travis-ci.org/chriteixeira/twitch-toolkit)

A set of tools to integrate with Twitch API, Twitch Chat and Twitch WebHooks. 

[![NPM](https://nodei.co/npm/twitch-toolkit.png?downloads=true&downloadRank=true)](https://nodei.co/npm/twitch-toolkit/)

To start to use this module, check the [project documentation](https://chriteixeira.github.io/twitch-toolkit/0.0.6/)

## Installation

Using npm:
```shell
$ npm i --save twitch-toolkit
```

## Usage

The library is composed by three modules:
* **api**: Provides access to the Helix API.
* **chat**: Provides access to the chat events through [tmi.js](https://github.com/tmijs) .
* **websub**: Provides access to the websubs topics and events.

You can use the toolkit just by creating a new instance with the configuration object:

```javascript
const twitch = require('twitch-toolkit');

var twitch = new Twitch(config);
```

The config object is described below:

| Attr          | Type                |  Description    |
| ------------- | ------------------- | --------------- |
| logger        | object            | The logger instance.    |
| debug         | bool             | A flag to enable the debug mode. `Default: false`    |
| client_id     | string              | The Twitch.tv client ID to be used to access the services.    |
| client_secret | string              | The Twitch.tv client secret to be used to use the private services.    |
| chatOptions   | object              | The chat configuration object    |
| chatOptions.reconnect | bool |  A flag to enable the auto-reconnect mode. `Default: false`    |
| chatOptions.ignoreSelf | bool | A flag to ignore the bots own messages. `Default: false`    |
| chatOptions.username | string | The bot's username.    |
| chatOptions.password | string | The bot's OAuth Token. You can get it at http://twitchapps.com/tmi/   |
| chatOptions.channels | array[string]       | The list os channels the bot will join and listen. |
| chatOptions.chatCommands | object | The object with the chatCommands, described below   |
| chatOptions.whisperCommands | object | The object with the whisperCommands, described below   |
| chatOptions.wordTriggers | object | The object with the wordTriggers, described below   |

### API

The API module will be created with the toolkit object and can be acessed by its name:
```javascript
var twitchAPI = twitch.api;
```
The methods are described in the [TwitchApi documentation page](https://chriteixeira.github.io/twitch-toolkit/0.0.6/TwitchApi.html)

### Chat

The chat module will be created with the toolkit new instance but, the user will only join and list to the chat when connect is executed: 

```javascript
var twitchChat = twitch.chat;

twitch.connect();
```

After that, you'll be able to listen to channel and chat events. You can also disconnect from the chat, if you wish:
```javascript
twitch.disconnect()
```

The methods and events are described in the [TwitchChatEmitter documentation page](https://chriteixeira.github.io/twitch-toolkit/0.0.6/TwitchChatEmitter.html)


### Webhooks

The Twitch Webhooks implementation, as described in https://dev.twitch.tv/docs/api/webhooks-guide/ .

To access the Webhook module:

The API module will be created with the toolkit object and can be acessed by its name:
```javascript
var twitchWebSub = twitch.websub;
```

The Webhook/WebSub requires a public endpoint on the running express server/application to receive the data from the hub. Without this, its impossible to make this work.

The methods and events are described in the [TwitchWebSub documentation page](https://chriteixeira.github.io/twitch-toolkit/0.0.6/TwitchWebSub.html)

## Tests

The module uses [Mocha](https://mochajs.org/) with [Chai](http://www.chaijs.com/) for unit tests and [Istanbul](https://istanbul.js.org/) for test coverage reports.

To run the mocha tests:

```shell
$ npm run test
```

To run the tests with the coverage report:

```shell
$ npm run test:coverage
```

To properly run the tests, the following Environment Variables must be set:

| Var Name      |  Value          |
| ------------- |---------------- |
| TWITCH_CLIENT_ID | The Client-ID to be used to make the API calls. |
| TWITCH_CLIENT_SECRET | The Client Secret to be used to make the API calls. |
| TWITCH_CLIENT_USERNAME | The Username related to the Client-ID |
| TWITCH_CLIENT_PASSWORD | The OAUTH password. It can be generated [here](https://twitchapps.com/tmi/). |

## License

Licensed under the [MIT](https://github.com/chriteixeira/twitch-toolkit/blob/master/LICENSE) License.