# ac-koa-hipchat

> A Koa.js library for building Atlassian Connect HipChat add-ons

Latest version **0.2.20** (published 2016-05-30) · Apache 2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install ac-koa-hipchat
pnpm add ac-koa-hipchat
yarn add ac-koa-hipchat
bun add ac-koa-hipchat
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.20 |
| Published | 2016-05-30 |
| First published | 2014-07-28 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ~0.11.13 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Author | Atlassian |
| Maintainers | moates, rbergman, rmanalan |
| Keywords | atlassian, connect, atlassian-connect, hipchat, koa |

## Links

- npm: https://www.npmjs.com/package/ac-koa-hipchat
- Repository: https://bitbucket.org/atlassianlabs/ac-koa-hipchat
- Homepage: https://bitbucket.org/atlassianlabs/ac-koa-hipchat#readme
- npm.io page: https://npm.io/package/ac-koa-hipchat

## Dependencies (7)

- [ac-koa](https://npm.io/package/ac-koa.md) ^0.2.6
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [koa-mount](https://npm.io/package/koa-mount.md) ^1.3.0
- [koa-router](https://npm.io/package/koa-router.md) ^3.2.3
- [check-types](https://npm.io/package/check-types.md) ^1.3.1
- [ac-node-hipchat](https://npm.io/package/ac-node-hipchat.md) ^0.2.14
- [koa-body-parser](https://npm.io/package/koa-body-parser.md) ^1.1.0

## Recent versions

- 0.2.20 (latest) — 2016-05-30
- 0.2.19 — 2015-08-11
- 0.2.18 — 2015-06-22
- 0.2.17 — 2015-04-20
- 0.2.16 — 2014-11-09
- 0.2.15 — 2014-11-09
- 0.2.14 — 2014-10-06
- 0.2.13 — 2014-09-30
- 0.2.12 — 2014-09-26
- 0.2.11 — 2014-09-24
- 0.2.10 — 2014-09-23
- 0.2.9 — 2014-09-23
- 0.2.8 — 2014-09-11
- 0.2.7 — 2014-09-11
- 0.2.5 — 2014-09-07
- … 12 more at https://npm.io/package/ac-koa-hipchat/versions

## README

[ ![Codeship Status for atlassianlabs/ac-koa-hipchat](https://codeship.io/projects/22bfa080-fbc3-0131-d6f8-5a73486b8860/status)](https://codeship.io/projects/29249)

# What is this?

A [Node.js](http://nodejs.org) and [Koa.js](http://koajs.com)-based library for building [HipChat Connect add-ons](https://www.hipchat.com/docs/apiv2/addons).

While this is still a pre-1.0 release, the API has mostly stabilized.  Future versions may still include backward-incompatible changes, but the risk of that now is relatively low.

# Getting started

To create and install a simple HipChat add-on, please see our [Getting Started](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/Getting_Started) guide.

# Example Projects

The example illustrated in the [Getting Started](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/Getting_Started) guide comes from the following example project:

* [Greeter](https://bitbucket.org/atlassianlabs/ac-koa-hipchat-greeter)

See these additional add-ons for more complete examples:

* [Sassy](https://bitbucket.org/atlassianlabs/ac-koa-hipchat-sassy) (demonstrates multiple /commands)
* [Karma](https://bitbucket.org/atlassianlabs/ac-koa-hipchat-karma) (demonstrates group based data storage independent of installation type)
* [Hearsay](https://bitbucket.org/atlassianlabs/ac-koa-hipchat-hearsay) (demonstrates a configuration UI)
* [Mailroom](https://bitbucket.org/atlassianlabs/ac-koa-hipchat-mailroom) (demonstrates a complex third party webhook integration)
* [Untappd](https://bitbucket.org/atlassianlabs/ac-koa-hipchat-untappd) (demonstrates integrations with multiple third party services)

# Library Features

This library provides help with many aspects of add-on development, such as:

* [Creating an App](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/Creating_an_App) - including support for creating multiple addons in a single Koa app 
* [Multi-tenant](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/Multi-tenancy) registration and data partitioning
* High-level conveniences for [mounting webhook handlers](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/Webhooks)
* Configuration of commonly required Koa middleware
* A [REST API client](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/REST_Client) with built-in OAuth2 token acquisition and refresh
* JWT authentication validation, refresh, and token generation for web UI routes

In these documentation pages, we use the terms `ctx` and 'Koa context' interchangeably to refer to the context object that contains both standard Koa request/response data and objects and this library's request objects and services.

# FAQ

Frequently asked questions, helpers and tips: [FAQ](https://bitbucket.org/atlassianlabs/ac-koa-hipchat/wiki/FAQ)

---
_Source: https://npm.io/package/ac-koa-hipchat · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
