Merge pull request #37 from eapearson/master

Added notification support (but not used!)

Author: eapearson

build/Gruntfile.js

@@ -5,12 +5,12 @@ module.exports = function (grunt) {
     grunt.initConfig({
         pkg: grunt.file.readJSON('package.json'),
         copy: {
-            'pure-uuid': {
-                expand: true,
-                flatten: true,
-                src: 'node_modules/pure-uuid/uuid.js',
-                dest: '../src/plugin/iframe_root/modules/vendor/pure-uuid'
-            }
+            // 'pure-uuid': {
+            //     expand: true,
+            //     flatten: true,
+            //     src: 'node_modules/pure-uuid/uuid.js',
+            //     dest: '../src/plugin/iframe_root/modules/vendor/pure-uuid'
+            // }
         },
         clean: {
             options: {

build/README.md

@@ -13,6 +13,13 @@ yarn install
 yarn install-bower
 yarn install-npm
 yarn remove-source-maps
+yarn install-dist
 ```
 
-> Only use yarn clean if you want to clean out the stuff installed in vendor, as well as the node and bower packages installed in build.
+> Only use yarn clean if you want to clean out the stuff installed in vendor, as well as the node and bower packages installed in build.
+
+## Preparing for a new release
+
+This plugin provides itself in the `dist` directory. In order to ensure that the dist directory is up-to-date with the source, run `yarn install-dist`.
+
+You can iterate on the raw source locally with `kbase-ui` by removing the dist directory temporarily, and supplying the plugin via the `plugins` option to kbase-ui's `make dev-start` task. kbase-ui will detect the absence of a dist directory and use the src directory instead.

build/bower.json

@@ -46,16 +46,21 @@
         "requirejs": "2.3.6",
         "require-css": "0.1.10",
         "kbase-common-js": "2.18.1",
-        "kbase-common-es6": "0.10.23",
+        "kbase-common-es6": "0.11.1",
         "js-yaml": "3.13.1",
         "requirejs-text": "2.0.16",
         "requirejs-yaml": "eapearson/requirejs-yaml#1.0.5",
         "kbase-service-clients-js": "3.3.6",
         "nunjucks": "3.1.2",
+        "pure-uuid": "1.5.8",
         "spark-md5": "3.0.0",
         "font-awesome": "4.7.0",
         "datatables-bootstrap3-plugin": "eapearson/datatables-bootstrap3-plugin#1.0.1",
         "datatables": "1.10.19"
     },
+    "resolutions": {
+        "kbase-common-es6": "0.11.1",
+        "pure-uuid": "1.5.8"
+    },
     "license": "SEE LICENSE IN ../LICENSE"
 }

build/package.json

@@ -4,7 +4,8 @@
         "clean": "grunt clean",
         "install-bower": "bower-installer",
         "install-npm": "grunt copy",
-        "remove-source-maps": "node scripts/remove-source-maps.js"
+        "remove-source-maps": "node scripts/remove-source-maps.js",
+        "install-dist": "node scripts/install-dist.js"
     },
     "author": "KBase Developers",
     "license": "SEE LICENSE IN LICENSE",
@@ -21,6 +22,6 @@
         "grunt-contrib-copy": "1.0.0",
         "js-yaml": "3.13.1",
         "numeral": "2.0.6",
-        "pure-uuid": "1.5.7"
+        "terser": "4.4.3"
     }
 }

build/scripts/install-dist.js

@@ -0,0 +1,78 @@
+const bluebird = require('bluebird');
+const glob = bluebird.promisify(require('glob').Glob);
+const fs = bluebird.promisifyAll(require('fs-extra'));
+const Terser = require('terser');
+const path = require('path');
+
+async function copyFiles(rootDir) {
+    const root = rootDir.split('/');
+    const source = root.concat(['src', 'plugin']).join('/');
+    const dest = root.concat(['dist', 'plugin']).join('/');
+    try {
+        await fs.removeAsync(dest);
+    } catch (ex) {
+        console.warn('WARNING removing dest', ex.message);
+    }
+    await fs.ensureDirAsync(dest);
+    await fs.copyAsync(source, dest);
+}
+
+async function minify(rootDir) {
+    const root = rootDir.split('/');
+
+    // remove mapping from css files.
+    const matches = await glob(
+        root
+            .concat(['dist', 'plugin', 'iframe_root', '**', '*.js'])
+            .join('/'),
+        {
+            nodir: true
+        }
+    );
+    console.log(`minifying ${matches.length} files...`);
+
+    return Promise.all(
+        matches.map(async (match) => {
+            // console.log(`minifying ${match}...`);
+            const contents = await fs.readFileAsync(match, 'utf8');
+            const result = Terser.minify(contents, {
+                output: {
+                    beautify: false,
+                    max_line_len: 80,
+                    quote_style: 0
+                },
+                compress: {
+                    // required in uglify-es 3.3.10 in order to work
+                    // around a bug in the inline implementation.
+                    // it should be fixed in an upcoming release.
+                    inline: 1
+                },
+                safari10: true
+            });
+            if (result.error) {
+                console.error('Error minifying file: ' + match, result);
+                throw new Error('Error minifying file ' + match) + ':' + result.error;
+            } else if (result.code.length === 0) {
+                console.warn('Skipping empty file: ' + match);
+            } else {
+                return fs.writeFileAsync(match, result.code);
+            }
+        })
+    );
+}
+
+async function main() {
+    const cwd = process.cwd().split('/');
+    cwd.push('..');
+    const projectPath = path.normalize(cwd.join('/'));
+    console.log(`Project path: ${projectPath}`);
+    console.log('Copying files to dist...');
+    await copyFiles(projectPath);
+    console.log('Minifying dist...');
+    await minify(projectPath);
+    console.log('done');
+}
+
+
+
+main();

build/yarn.lock

@@ -96,7 +96,7 @@ async@~1.5.2:
   resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a"
   integrity sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo=
 
-atob@^2.1.1:
+atob@^2.1.2:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/atob/-/atob-2.1.2.tgz#6d9517eb9e030d2436666651e86bd9f6f13533c9"
   integrity sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg==
@@ -167,6 +167,11 @@ braces@^2.3.1:
     split-string "^3.0.2"
     to-regex "^3.0.1"
 
+buffer-from@^1.0.0:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.1.tgz#32713bc028f75c02fdb710d7c7bcec1f2c6070ef"
+  integrity sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==
+
 cache-base@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/cache-base/-/cache-base-1.0.1.tgz#0a7f46416831c8b662ee36fe4e7c59d76f666ab2"
@@ -280,6 +285,11 @@ colors@~1.1.2:
   resolved "https://registry.yarnpkg.com/colors/-/colors-1.1.2.tgz#168a4701756b6a7f51a12ce0c97bfa28c084ed63"
   integrity sha1-FopHAXVran9RoSzgyXv6KMCE7WM=
 
+commander@^2.20.0:
+  version "2.20.3"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
+  integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==
+
 component-emitter@^1.2.1:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.3.0.tgz#16e4070fba8ae29b679f2215853ee181ab2eabc0"
@@ -1339,11 +1349,6 @@ posix-character-classes@^0.1.0:
   resolved "https://registry.yarnpkg.com/posix-character-classes/-/posix-character-classes-0.1.1.tgz#01eac0fe3b5af71a2a6c02feabb8c1fef7e00eab"
   integrity sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=
 
-[email protected]:
-  version "1.5.7"
-  resolved "https://registry.yarnpkg.com/pure-uuid/-/pure-uuid-1.5.7.tgz#c089845d85e3b33a070bf4dc8cce30906880e9bd"
-  integrity sha512-g8kcLZcJi1ePpuNxrnI6a4re2ze89FPnV6dXaDuW4K9+n+SzvolhR2uoZhHJvz1Ilba0U8hvb1clxTLN49EvuQ==
-
 read-pkg-up@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/read-pkg-up/-/read-pkg-up-1.0.1.tgz#9d63c13276c065918d57f002a57f40a1b643fb02"
@@ -1415,9 +1420,9 @@ resolve-url@^0.2.1:
   integrity sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo=
 
 resolve@^1.1.6, resolve@^1.1.7, resolve@^1.10.0:
-  version "1.13.1"
-  resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.13.1.tgz#be0aa4c06acd53083505abb35f4d66932ab35d16"
-  integrity sha512-CxqObCX8K8YtAhOBRg+lrcdn+LK+WYOS8tSjqSFbjtrI5PnS63QPhZl4+yKfrU9tdsbMu9Anr/amegT87M9Z6w==
+  version "1.14.1"
+  resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.14.1.tgz#9e018c540fcf0c427d678b9931cbf45e984bcaff"
+  integrity sha512-fn5Wobh4cxbLzuHaE+nphztHy43/b++4M6SsGFC2gB8uYwf0C8LcarfCz1un7UTW8OFQg9iNjZ4xpcFVGebDPg==
   dependencies:
     path-parse "^1.0.6"
 
@@ -1508,16 +1513,24 @@ snapdragon@^0.8.1:
     use "^3.1.0"
 
 source-map-resolve@^0.5.0:
-  version "0.5.2"
-  resolved "https://registry.yarnpkg.com/source-map-resolve/-/source-map-resolve-0.5.2.tgz#72e2cc34095543e43b2c62b2c4c10d4a9054f259"
-  integrity sha512-MjqsvNwyz1s0k81Goz/9vRBe9SZdB09Bdw+/zYyO+3CuPk6fouTaxscHkgtE8jKvf01kVfl8riHzERQ/kefaSA==
+  version "0.5.3"
+  resolved "https://registry.yarnpkg.com/source-map-resolve/-/source-map-resolve-0.5.3.tgz#190866bece7553e1f8f267a2ee82c606b5509a1a"
+  integrity sha512-Htz+RnsXWk5+P2slx5Jh3Q66vhQj1Cllm0zvnaY98+NFx+Dv2CF/f5O/t8x+KaNdrdIAsruNzoh/KpialbqAnw==
   dependencies:
-    atob "^2.1.1"
+    atob "^2.1.2"
     decode-uri-component "^0.2.0"
     resolve-url "^0.2.1"
     source-map-url "^0.4.0"
     urix "^0.1.0"
 
+source-map-support@~0.5.12:
+  version "0.5.16"
+  resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.16.tgz#0ae069e7fe3ba7538c64c98515e35339eac5a042"
+  integrity sha512-efyLRJDr68D9hBBNIPWFjhpFzURh+KJykQwvMyW5UiZzYwoF6l4YMMDIJJEyFWxWCqfyxLzz6tSfUFR+kXXsVQ==
+  dependencies:
+    buffer-from "^1.0.0"
+    source-map "^0.6.0"
+
 source-map-url@^0.4.0:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/source-map-url/-/source-map-url-0.4.0.tgz#3e935d7ddd73631b97659956d55128e87b5084a3"
@@ -1528,6 +1541,11 @@ source-map@^0.5.6:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc"
   integrity sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=
 
+source-map@^0.6.0, source-map@~0.6.1:
+  version "0.6.1"
+  resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
+  integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
+
 spdx-correct@^3.0.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-3.1.0.tgz#fb83e504445268f154b074e218c87c003cd31df4"
@@ -1619,6 +1637,15 @@ supports-color@^7.1.0:
   dependencies:
     has-flag "^4.0.0"
 
+[email protected]:
+  version "4.4.3"
+  resolved "https://registry.yarnpkg.com/terser/-/terser-4.4.3.tgz#401abc52b88869cf904412503b1eb7da093ae2f0"
+  integrity sha512-0ikKraVtRDKGzHrzkCv5rUNDzqlhmhowOBqC0XqUHFpW+vJ45+20/IFBcebwKfiS2Z9fJin6Eo+F1zLZsxi8RA==
+  dependencies:
+    commander "^2.20.0"
+    source-map "~0.6.1"
+    source-map-support "~0.5.12"
+
 to-object-path@^0.3.0:
   version "0.3.0"
   resolved "https://registry.yarnpkg.com/to-object-path/-/to-object-path-0.3.0.tgz#297588b7b0e7e0ac08e04e672f85c1f4999e17af"

dist/plugin/config.yml

@@ -0,0 +1,57 @@
+## YAML Template.
+---
+package:
+    author: Erik Pearson
+    name: dashboard
+    description: The dashboard panel and associated widgets
+    date: August 6, 2015
+    version: 0.0.1
+source:
+    ## sources are relative to build/plugins/PACKAGE/source/javascript
+    ## NB: need to quote file names, otherwise
+    modules:
+    styles:
+        # - file: styles.css
+install:
+    widgets:
+        - module: ./panel
+          id: kb_plugin_dashboard
+          type: es6
+        # -
+        #     module: ./dashboardPanel
+        #     id: dashboardPanel
+        #     type: factory
+        # -
+        #     module: ./widgets/CollaboratorsWidget
+        #     id: dashboardCollaborators
+        #     type: object
+        # -
+        #     module: ./widgets/MetricsWidget
+        #     id: dashboardMetrics
+        #     type: object
+        # -
+        #     module: ./widgets/NarrativesWidget
+        #     id: dashboardNarratives
+        #     type: object
+        # -
+        #     module: ./widgets/PublicNarrativesWidget
+        #     id: dashboardPublicNarratives
+        #     type: object
+        # -
+        #     module: ./widgets/NarratorialsWidget
+        #     id: dashboardNarratorials
+        #     type: object
+        # -
+        #     module: ./widgets/SharedNarrativesWidget
+        #     id: dashboardSharedNarratives
+        #     type: object
+    routes:
+        - path: ["dashboard"]
+          widget: kb_plugin_dashboard
+          authorization: true
+    menu:
+        - name: dashboard
+          definition:
+              path: ["dashboard"]
+              label: Dashboard
+              icon: dashboard

dist/plugin/iframe_root/.bowerrc

@@ -0,0 +1,3 @@
+{
+    "directory": "modules/bower_components"
+}

dist/plugin/iframe_root/bower.json

@@ -0,0 +1,37 @@
+{
+    "name": "kbase-ui-plugin-dashboard",
+    "description": "A primary view (panel) for the KBase UI to provide a user with a summary of their Narratives, relationships, and status",
+    "keywords": ["kbase", "widget"],
+    "author": ["[email protected]"],
+    "moduleType": "kbase-ui-plugin",
+    "main": "src/plugin/config.yml",
+    "ignore": [".gitignore"],
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/kbase/kbase-ui-plugin-dashboard"
+    },
+    "dependencies": {
+        "bluebird": "3.5.3",
+        "bootstrap": "3.4.1",
+        "nunjucks": "^3.0.0",
+        "jquery": "^2.1.0",
+        "kbase-service-clients-js": "^3.3.5",
+        "requirejs": "2.3.6",
+        "require-css": "0.1.10",
+        "kbase-common-js": "2.18.1",
+        "kbase-common-es6": "0.10.14",
+        "kbase-ui-widget": "1.3.0",
+        "js-yaml": "3.12.1",
+        "requirejs-text": "2.0.15",
+        "requirejs-yaml": "eapearson/requirejs-yaml#1.0.5",
+        "pure-uuid": "eapearson/pure-uuid#1.1.1",
+        "kbase-service-clients-js": "3.3.5",
+        "nunjucks": "3.1.2",
+        "spark-md5": "3.0.0",
+        "font-awesome": "4.7.0",
+        "datatables-bootstrap3-plugin": "eapearson/datatables-bootstrap3-plugin#1.0.1",
+        "datatables": "1.10.19"
+    },
+    "devDependencies": {},
+    "license": "SEE LICENSE IN LICENSE.md"
+}