Add token server documentation (#9)

* Initial commit

* Initial commit

* Move helpers folder

* Revert "Move helpers folder"

This reverts commit d37d82b.

* Update package name

* Add error codes to function

* Fix bugs

* Update some copy

* Update function responses

* Update function responses

* Fix json response in function

* Apply PR feedback

* Rename token server again

* Rename destroy to delete-app

* Add delete-app

* More changes

* Fix asset issue

* Copy update

* Add getPin test

* Add default Circle CI node config

* Trigger build

* Add deps to fix cli errors with brew

* Fix Object.assign issues

* Delete refresh command

* Remove code for refreshing passcodes

* Deploy-app will redeploy app if one already exists

* Remove unused variable

* Update package-lock

* Install jest

* Add some tests for helpers

* Add tests for video-token-server

* Add e2e tests

* Fix some things

* Add --override flag to deploy-app command

* AHOYAPPS-426 Add command documentation (#4)

* Add command documentation

* Add override example

* Fix typo

* Fix copy

* Add prettier and husky

* Run prettier

* Remove static class properties

* Add more unit tests

* Add e2e test

* Add eslint

* Fix tests

* Fix tests

* Update command usage

* Add error messages to token server

* Completely redo e2e tests

* Update some tests

* Update error codes

* Remove newlines

* Update lint script

* Rename commands

* Add function to validate app-directory

* Add tests for app-directory validation

* Remove .only from test

* Fix e2e test

* Add readme (#5)

* Get started on readme

* Make override flag optional

* Update readme sections

* Update readme with new commands

* Add VS code rulers

* Address feedback

Co-authored-by: Aaron Alaniz <[email protected]>

* Use readdirSync in verifyAppDirectory

* Add token server documentation

* Update README.md

Co-Authored-By: John Qualls <[email protected]>

* Fix broken link

* Update README.md

Co-Authored-By: timmydoza <[email protected]>

* Fix success response docs

* Address feedback

* Update table bg

* Fix bg one more time

* Update Circle CI badge syntax

Co-authored-by: Tim Mendoza <[email protected]>
Co-authored-by: John Qualls <[email protected]>

Author: 3 people

README.md

@@ -1,16 +1,16 @@
 # @twilio-labs/plugin-rtc
 
-[![CircleCI](https://circleci.com/gh/twilio-labs/plugin-rtc/tree/master.svg?style=svg&circle-token=df6c2750596f1000c1cf13e45dc314e00f0a2204)](https://circleci.com/gh/twilio-labs/plugin-rtc/tree/master)
+[![CircleCI](https://circleci.com/gh/twilio-labs/plugin-rtc.svg?style=svg)](https://circleci.com/gh/twilio-labs/plugin-rtc)
 
 This plugin adds functionality to the [Twilio CLI](https://github.com/twilio/twilio-cli) which supports developing and deploying real-time communication apps.
 
 * [Getting Started](#getting-started)
 * [Supported Apps](#supported-apps)
 * [Commands](#commands)
 
-# Getting Started 
+## Getting Started
 
-## Install the Twilio CLI
+### Install the Twilio CLI
 
 Via `npm` or `yarn`:
 
@@ -27,25 +27,127 @@ $ brew tap twilio/brew && brew install twilio
 
 See the [Twilio CLI documentation](https://www.twilio.com/docs/twilio-cli/quickstart) for more information.
 
-##  Install the plugin
+### Install the plugin
 
 ```sh-session
 $ twilio plugins:install @twilio-labs/plugin-rtc
 ```
 
-# Supported Apps
+## Supported Apps
 
 This plugin currently supports the following applications:
 
-## Twilio Video App
-A mobile and web collaboration application built with Programmable Video. Visit the projects below for instructions on how to use this plugin to build and deploy the Twilio Video app.
+### Twilio Video App
+
+A mobile and web collaboration application built with Twilio Programmable Video. Visit the projects below for instructions on how to use this plugin to build and deploy the Twilio Video app.
 
   * [React App](https://github.com/twilio/twilio-video-app-react)
   * [iOS App](https://github.com/twilio/twilio-video-app-ios)
   * [Android App](https://github.com/twilio/twilio-video-app-android)
 
+#### Token Server API Documentation
+
+The following section documents the application [token server](/src/video-token-server.js) used to provide [Programable Video access tokens](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens) to supported Twilio Video applications. The token server is deployed as a [Twilio Function](https://www.twilio.com/docs/runtime/functions).
+
+| Method | URL |
+| --- | --- |
+| POST | [`/token`](#token) |
+
+##### Authentication
+
+The application token server requires an [authentication mechanism](#twilio-rtcappsvideodeploy---authentication-auth) to be specified when deploying. The following section documents each support authentication mechanism.
+
+###### Passcode
+
+Each request is verified using a passcode generated at deploy time. Passcodes remain valid for one week. After the passcode expires, users can redeploy an application and a new passcode will be generated. The snippet below provides an example request body used by a supported application.
+
+```
+{
+  "passcode": "1234564321",
+  "user_identity": "User",
+  "room_name": "Demo",
+}
+```
+
+##### Token
+
+Returns a Programmable Video Access token.
+
+```shell
+POST /token
+```
+
+###### Parameters
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `passcode` | `string` | **Required**. The application passcode. |
+| `user_identity` | `string` | **Required**. The user's identity. |
+| `room_name` | `string` | A room name that will be used to create a token scoped to connecting to only one room.  |
+
+###### Success Responses
+
+<table>
+<tr>
+<td> <b>Status</b> </td> <td> <b>Response</b> </td>
+</tr>
+<tr>
+<td> 200 </td>
+<td>
+
+```json
+{
+    "token": "0000000000000000.0000000000000000000000.00000000000000000"
+}
+```
+
+</td>
+</tr>
+
+</table>
+
+###### Error Responses
+
+<table>
+<tr>
+<td> <b>Status</b> </td> <td> <b>Response</b> </td>
+</tr>
+
+<tr>
+<td> 401 </td>
+<td>
+
+```json
+{
+    "error": {
+      "message": "passcode expired",
+      "explanation": "The passcode used to validate application users has expired. Re-deploy the application to refresh the passcode."
+    }
+}
+```
+
+</td>
+</tr>
+
+<tr>
+<td> 401 </td>
+<td>
+
+```json
+{
+    "error": {
+      "message": "passcode incorrect",
+      "explanation": "The passcode used to validate application users is incorrect."
+    }
+}
+```
+
+</td>
+</tr>
+
+</table>
 
-# Commands
+## Commands
   <!-- commands -->
 * [`twilio rtc:apps:video:delete`](#twilio-rtcappsvideodelete)
 * [`twilio rtc:apps:video:deploy --authentication <auth>`](#twilio-rtcappsvideodeploy---authentication-auth)