Project bringup

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+    "parserOptions": {
+        "ecmaVersion": 8
+    },
+    "env": {
+        "es6": true,
+        "browser": true
+    },
+    "extends": "eslint:recommended",
+    "rules": {
+        "quotes": "off",
+        "semi": [
+            "error",
+            "always"
+        ],
+        "no-console": "off",
+        "no-debugger": "off",
+        "no-unused-vars": [
+            "error",
+            {
+                "args": "none"
+            }
+        ],
+        "no-constant-condition": [
+            "error",
+            {
+                "checkLoops": false
+            }
+        ]
+    }
+}

.jsdoc-layout.tmpl

@@ -0,0 +1,4 @@
+<?js= this.partial('layout.tmpl', obj) ?>
+<link type="text/css" rel="stylesheet" href="../../css/jsdoc-overrides.css"/>
+<link id="favicon" rel="shortcut icon" href="../../images/icon_256.png"/>
+<script src="../../js/jsdoc-overrides.js"></script>

.jsdoc.conf

@@ -0,0 +1,21 @@
+{
+    "opts": {
+        "template": "node_modules/docdash",
+        "destination": "docs",
+        "recurse": true,
+        "verbose": true
+    },
+    "templates": {
+        "cleverLinks": true,
+        "monospaceLinks": false,
+        "default": {
+            "includeDate": false,
+            "layoutFile": ".jsdoc-layout.tmpl",
+            "staticFiles": {
+                "include": [
+                    "./docs/css/jsdoc-overrides.css"
+                ]
+            }
+        }
+    }
+}

.npmrc

@@ -0,0 +1 @@
+package-lock=false

docs/css/jsdoc-overrides.css

@@ -0,0 +1,240 @@
+
+body {
+    font-size: 14px;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+/* Reset */
+h1, h2, h3, h4, h5, h6 {
+    font-weight: bold;
+    line-height: normal;
+    letter-spacing: normal;
+}
+
+h1 {
+    font-size: 2em;
+}
+
+h2 {
+    font-size: 1.5em;
+}
+
+h3 {
+    font-size: 1.17em;
+}
+
+h4 {
+    font-size: 1em;
+}
+
+h5 {
+    font-size: 0.83em;
+}
+
+h1.page-title {
+    font-size: 3em;
+    font-weight: normal;
+}
+
+ul {
+    margin-top: 0;
+    padding-left: 2em;
+}
+
+nav {
+    padding-bottom: 2rem;
+}
+
+nav > h2 > a {
+    color: black !important;
+    font-size: 1.2em;
+    padding-bottom: 0.3em;
+}
+
+nav ul ul a,
+nav ul ul a:active {
+    color: #222;
+}
+
+nav ul ul a:hover {
+    color: black;
+}
+
+nav a:hover,
+nav a:active {
+    color: black;
+}
+
+h1.page-title {
+    margin: 1em 2rem;
+}
+
+#main section {
+    max-width: 60em;
+    padding: 0 1rem 0 2rem;
+}
+
+#main section .class-description {
+    font-size: 1.1em;
+}
+
+#main section .container-overview {
+    padding-left: 1rem;
+}
+
+#main section .container-overview h2 {
+    margin-left: -2rem;
+}
+
+#main section .container-overview h4.name {
+    margin-left: -1rem;
+}
+
+h4.name {
+    background: #424242;
+    margin-left: -1rem;
+    margin-top: 3rem;
+    border-radius: 0.2em;
+    border: none;
+}
+
+h4.name.target::before {
+    content: '';
+    position: absolute;
+    height: 2.5em;
+    border-left: 3px dotted #0088c7;
+    margin-left: -1.5em;
+    margin-top: -0.6em;
+}
+
+nav a {
+    transition: background 400ms, color 400ms, padding 400ms;
+}
+nav a.target {
+    background: #0088c7;
+    color: white;
+    padding-top: 0.5em;
+    padding-bottom: 0.5em;
+}
+nav a.target:hover {
+    color: white;
+    text-decoration: none;
+    cursor: initial;
+}
+
+h3.subsection-title + h4.name,
+.container-overview > h4.name {
+    margin-top: 0.5rem;
+}
+
+h4.name a {
+    border: none;
+}
+
+nav > ul > li > a {
+    color: black;
+}
+
+.signature {
+    color: #7ab4ff;
+    font-size: 0.85em;
+    font-weight: normal;
+}
+
+a, a.active,
+span.param-type,.params td .param-type, .param-type dd {
+    color: #458bfa;
+}
+
+table.params,
+table.props {
+    font-size: 0.9em;
+    margin: 0.5em 0;
+}
+
+table.params th,
+table.props th {
+    padding: 0.7em;
+}
+
+table.params td,
+table.props td {
+    padding: 0.7em;
+    border-top: 1px solid #eee;
+}
+
+table.params td > table.params,
+table.params td > table.props,
+table.props td > table.params,
+table.props td > table.props {
+    font-size: 0.8em;
+    border: none;
+    box-shadow: none;
+}
+
+table.params td > table.params thead,
+table.params td > table.props thead,
+table.props td > table.params thead,
+table.props td > table.props thead {
+    display: none;
+}
+
+#main > section > article {
+    padding-left: 1rem;
+}
+
+.container-overview > h2 {
+    font-size: 1.3em;
+    text-transform: uppercase;
+}
+
+#main > section > article > .subsection-title {
+    margin: 2rem 0 0 -1rem;
+    text-transform: uppercase;
+}
+
+article a {
+    border: none;
+}
+
+article a:hover, 
+article a:active {
+    color: #007aff;
+}
+
+article > h5 {
+    text-transform: uppercase;
+    font-size: 0.8em;
+}
+
+.type-signature,
+.type-signature a {
+    color: #ff9f48 !important;
+    font-size: 0.8em;
+    font-weight: normal;
+}
+.type-signature a {
+    border: none;
+}
+
+.tag-source {
+    font-size: 0.7em;
+    color: #999
+}
+
+.tag-source a {
+    color: #999;
+    border: none;
+}
+
+.tag-source a:hover {
+    color: #777;
+}
+
+dl.details {
+    margin-left: -1rem;
+    margin-top: -0.4rem;
+}

docs/index.html

@@ -0,0 +1,3 @@
+<script>
+    location.replace('./forsta-messenger-client/LATEST/index.html')
+</script>

docs/js/jsdoc-overrides.js

@@ -0,0 +1,35 @@
+(function() {
+    'use strict';
+
+    let _lastNavLink;
+    let _lastAnchor;
+    function highlightCurrentTarget(options) {
+        options = options || {};
+        if (_lastNavLink) {
+            _lastNavLink.classList.remove('target');
+        }
+        if (_lastAnchor) {
+            _lastAnchor.classList.remove('target');
+        }
+        const urn = location.pathname.split(/\//).slice(-1)[0] + location.hash;
+        if (urn === 'index.html') {
+            return;
+        }
+        const navLink = document.querySelector(`nav a[href="${urn}"`);
+        if (navLink) {
+            navLink.classList.add('target');
+            navLink.scrollIntoView({
+                block: 'center',
+                behavior: options.scrollSmooth ? 'smooth' : 'instant'
+            });
+            _lastNavLink = navLink;
+        }
+        const anchor = document.getElementById(location.hash.slice(1));
+        if (anchor) {
+            anchor.classList.add('target');
+        }
+    }
+
+    window.addEventListener('load', () => highlightCurrentTarget({scrollSmooth: false}));
+    window.addEventListener('hashchange', () => highlightCurrentTarget({scrollSmooth: true}));
+})();

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "forsta-messenger-client",
+  "version": "0.0.0",
+  "description": "Forsta Messenger Client",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ForstaLabs/forsta-messenger-client.git"
+  },
+  "author": "Forsta, Inc.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ForstaLabs/forsta-messenger-client/issues"
+  },
+  "homepage": "https://github.com/ForstaLabs/forsta-messenger-client#readme",
+  "scripts": {
+    "docs": "jsdoc -c .jsdoc.conf -P package.json -R README.md src"
+  },
+  "devDependencies": {
+    "docdash": "1.1.1",
+    "eslint": "6.1.0",
+    "jsdoc": "3.6.3"
+  }
+}