npm - deploy.sh - Versions diffs - 0.2.0 → 2.0.0 - Mend

deploy.sh 0.2.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (147) hide show

package/.eslintignore +1 -0
package/.eslintrc +7 -9
package/.github/workflows/ci.yml +48 -0
package/.husky/pre-commit +5 -0
package/{test/fixtures/unknown/.gitkeep → .prettierrc} +0 -0
package/.release-it.json +5 -0
package/CHANGELOG.md +26 -0
package/README.md +5 -6
package/__tests__/fixtures/unknown/.gitkeep +0 -0
package/__tests__/lib/classifier.test.js +49 -0
package/__tests__/lib/helpers/util.test.js +57 -0
package/bin/deploy-delete.js +14 -0
package/bin/deploy-deploy.js +34 -59
package/bin/deploy-list.js +25 -52
package/bin/deploy-login.js +36 -52
package/bin/deploy-logout.js +9 -40
package/bin/deploy-logs.js +22 -48
package/bin/deploy-open.js +14 -37
package/bin/deploy-register.js +37 -50
package/bin/deploy-server.js +8 -5
package/bin/deploy-whoami.js +8 -37
package/bin/deploy.js +145 -19
package/{test/fixtures → examples}/docker/Dockerfile +0 -0
package/examples/docker/index.js +12 -0
package/examples/node/index.js +8 -0
package/{test/fixtures → examples}/node/package.json +0 -0
package/examples/static/index.html +22 -0
package/{test/fixtures → examples}/static/main.css +4 -2
package/examples/static/out.gifcd +0 -0
package/generate-docs.js +55 -0
package/index.js +54 -55
package/jsdoc.json +6 -3
package/lib/classifier.js +24 -17
package/lib/deploy.js +56 -64
package/lib/helpers/cli.js +178 -207
package/lib/helpers/util.js +94 -21
package/lib/models/deployment.js +415 -474
package/lib/models/request.js +77 -66
package/lib/models/user.js +119 -144
package/lib/server.js +187 -97
package/lib/static/not-found.html +30 -0
package/lib/static/page-could-not-load.html +30 -0
package/lib/static/static-server.js +70 -0
package/package.json +47 -34
package/website/README.md +41 -0
package/website/babel.config.js +3 -0
package/website/docs/api/_category_.yml +1 -0
package/website/docs/api/lib/classifier.js.md +11 -0
package/website/docs/api/lib/deploy.js.md +13 -0
package/website/docs/api/lib/helpers/cli.js.md +193 -0
package/website/docs/api/lib/helpers/util.js.md +65 -0
package/website/docs/api/lib/models/deployment.js.md +171 -0
package/website/docs/api/lib/models/request.js.md +67 -0
package/website/docs/api/lib/models/user.js.md +92 -0
package/website/docs/api/lib/server.js.md +0 -0
package/website/docs/api/lib/static/static-server.js.md +0 -0
package/website/docs/intro.md +57 -0
package/website/docusaurus.config.js +82 -0
package/website/package-lock.json +25218 -0
package/website/package.json +39 -0
package/website/sidebars.js +31 -0
package/website/src/components/HomepageFeatures/index.js +79 -0
package/website/src/components/HomepageFeatures/styles.module.css +11 -0
package/website/src/css/custom.css +39 -0
package/website/src/pages/index.js +57 -0
package/website/src/pages/index.module.css +23 -0
package/website/static/.nojekyll +0 -0
package/website/static/example.gif +0 -0
package/website/static/example.mov +0 -0
package/website/static/img/favicon.ico +0 -0
package/website/static/img/intro/deploy.png +0 -0
package/website/static/img/intro/logs.png +0 -0
package/{docs → website/static/img}/logo.png +0 -0
package/{docs → website/static/img}/logo.pxm +0 -0
package/{docs → website/static/img}/logo@2x.png +0 -0
package/.npmignore +0 -9
package/.travis.yml +0 -9
package/TODO.md +0 -12
package/docs/code/classifier.js.html +0 -116
package/docs/code/deploy.js.html +0 -138
package/docs/code/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docs/code/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docs/code/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docs/code/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/code/global.html +0 -325
package/docs/code/helpers_cli.js.html +0 -351
package/docs/code/helpers_util.js.html +0 -127
package/docs/code/index.html +0 -81
package/docs/code/models_deployment.js.html +0 -593
package/docs/code/models_request.js.html +0 -150
package/docs/code/models_user.js.html +0 -232
package/docs/code/module-lib_classifier.html +0 -246
package/docs/code/module-lib_deploy.html +0 -350
package/docs/code/module-lib_helpers_cli.html +0 -2067
package/docs/code/module-lib_helpers_util.html +0 -608
package/docs/code/module-models_deployment-Deployment.html +0 -359
package/docs/code/module-models_deployment-DeploymentSchema.html +0 -359
package/docs/code/module-models_deployment.Deployment.html +0 -359
package/docs/code/module-models_deployment.html +0 -1851
package/docs/code/module-models_request-Request.html +0 -409
package/docs/code/module-models_request-RequestSchema.html +0 -359
package/docs/code/module-models_request.html +0 -446
package/docs/code/module-models_user-User.html +0 -306
package/docs/code/module-models_user-UserSchema.html +0 -306
package/docs/code/module-models_user.User.html +0 -306
package/docs/code/module-models_user.html +0 -1200
package/docs/code/scripts/linenumber.js +0 -25
package/docs/code/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/code/scripts/prettify/lang-css.js +0 -2
package/docs/code/scripts/prettify/prettify.js +0 -28
package/docs/code/styles/jsdoc-default.css +0 -692
package/docs/code/styles/prettify-jsdoc.css +0 -111
package/docs/code/styles/prettify-tomorrow.css +0 -132
package/docs/example-docker.gif +0 -0
package/docs/example-node.gif +0 -0
package/docs/example-static.gif +0 -0
package/docs/index.html +0 -50
package/docs/main.css +0 -12
package/docs/psychic-min.css +0 -1
package/lib/helpers/static-server.js +0 -69
package/test/fixtures/docker/index.js +0 -12
package/test/fixtures/node/index.js +0 -8
package/test/fixtures/static/index.html +0 -14
package/test/lib/classifier.js +0 -51
package/test/lib/helpers/util.js +0 -30

package/docs/code/module-models_user.html DELETED Viewed

@@ -1,1200 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>models/user - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav>
-    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-models_deployment.Deployment.html">Deployment</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-models_request-Request.html">Request</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-models_user.User.html">User</a></span></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_classifier.html">lib/classifier</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_deploy.html">lib/deploy</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html">lib/helpers/cli</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~cacheCredentials">cacheCredentials</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~createBundle">createBundle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~getCredentials">getCredentials</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~getDeployments">getDeployments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~getLogs">getLogs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~login">login</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~logout">logout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~register">register</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_cli.html#~uploadBundle">uploadBundle</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_helpers_util.html">lib/helpers/util</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~contains">contains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~getPort">getPort</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~hash">hash</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-models_deployment.html">models/deployment</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~decorate">decorate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~getAll">getAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~proxy">proxy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~remove">remove</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~start">start</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~stop">stop</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_deployment.html#~update">update</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-models_request.html">models/request</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_request.html#~count">count</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_request.html#~log">log</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-models_user.html">models/user</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_user.html#~authenticate">authenticate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_user.html#~authenticateMiddleware">authenticateMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_user.html#~get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_user.html#~login">login</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_user.html#~logout">logout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-models_user.html#~register">register</a></span></li>
-</nav>
-<div id="main">
-    <h1 class="page-title">models/user</h1>
-<section>
-<header>
-</header>
-<article>
-    <div class="container-overview">
-    </div>
-        <h3 class="subsection-title">Classes</h3>
-        <dl>
-            <dt><a href="module-models_user.User.html">User</a></dt>
-            <dd></dd>
-        </dl>
-        <h3 class="subsection-title">Methods</h3>
-<div class="section-method">
-    <h4 class="name" id="~authenticate"><span class="type-signature">(inner) </span>authenticate<span class="signature">(token, username)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>verify the username and token are valid</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line56">line 56</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token associated with the username</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username of the user</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="~authenticateMiddleware"><span class="type-signature">(inner) </span>authenticateMiddleware<span class="signature">(req, res, next)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>middleware to verify the username and token are valid, will then set the user to req.user</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line34">line 34</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>req</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-                <p>express request</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>res</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-                <p>express response</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>next</code></td>
-            <td class="type">
-<span class="param-type"><code>function</code></span>
-            </td>
-            <td class="description last">
-                <p>callback to go to next middleware</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-<div class="section-method">
-    <h4 class="name" id="~get"><span class="type-signature">(inner) </span>get<span class="signature">(token, username)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>returns the user if token and username are valid</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line154">line 154</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token associated with the username</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username of the user</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="~login"><span class="type-signature">(inner) </span>login<span class="signature">(username, password)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>logs in a user and returns</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line103">line 103</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username of the user who is logging in</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>password</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the password associated with the user</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="~logout"><span class="type-signature">(inner) </span>logout<span class="signature">(token, username)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>logs out a user by deleting their token</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line80">line 80</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the token associated with the username</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username of the user</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="~register"><span class="type-signature">(inner) </span>register<span class="signature">(username, password)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>registers a user</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="models_user.js.html">models/user.js</a>, <a href="models_user.js.html#line129">line 129</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the username of the user who is logging in</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>password</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the password associated with the user</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Mon Aug 14 2017 00:16:03 GMT-0700 (PDT) using the Minami theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>