datagrok-tools 4.3.0 → 4.4.2

package/bin/commands/create.js

@@ -55,6 +55,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
   var ide = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : '';
   var ts = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
   var eslint = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : false;
+  var jest = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : false;
 
   var filesToCreate = _fs["default"].readdirSync(templateDir);
 
@@ -108,6 +109,20 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
             'lint': "eslint src".concat(ts ? ' --ext .ts' : ''),
             'lint-fix': "eslint src".concat(ts ? ' --ext .ts' : '', " --fix")
           });
+        }
+
+        if (jest) {
+          Object.assign(_package.devDependencies, {
+            'jest-html-reporter': '^3.5.0',
+            'jest': '^27.0.0',
+            '@types/jest': '^27.0.0'
+          }, ts ? {
+            'ts-jest': '^27.0.0',
+            'puppeteer': 'latest'
+          } : {});
+          Object.assign(_package.scripts, {
+            'test': 'jest'
+          });
         } // Save module names for installation prompt
 
 
@@ -127,6 +142,9 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
       if (file === 'package-test.ts' && !ts) return false;
       if (file === 'tsconfig.json' && !ts) return false;
       if (file === 'ts.webpack.config.js') return false;
+      if (file === 'remote.test.ts' && (!ts || !jest)) return false;
+      if (file === 'test-node.ts' && (!ts || !jest)) return false;
+      if (file === 'jest.config.js' && !jest) return false;
 
       if (file === '.eslintrc.json') {
         if (!eslint) return false;
@@ -151,7 +169,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
       _fs["default"].mkdirSync(copyFilePath); // recursive call
 
 
-      createDirectoryContents(name, config, origFilePath, copyFilePath, ide, ts);
+      createDirectoryContents(name, config, origFilePath, copyFilePath, ide, ts, eslint, jest);
     }
   });
 }
@@ -161,7 +179,7 @@ function create(args) {
   var nArgs = args['_'].length;
   if (nArgs > 2 || nOptions > 3) return false;
   if (nOptions && !Object.keys(args).slice(1).every(function (op) {
-    return ['ide', 'ts', 'eslint'].includes(op);
+    return ['ide', 'ts', 'eslint', 'jest'].includes(op);
   })) return false; // Create `config.yaml` if it doesn't exist yet
 
   if (!_fs["default"].existsSync(grokDir)) _fs["default"].mkdirSync(grokDir);
@@ -198,7 +216,7 @@ function create(args) {
       return false;
     }
 
-    createDirectoryContents(name, config, templateDir, packageDir, args.ide, args.ts, args.eslint);
+    createDirectoryContents(name, config, templateDir, packageDir, args.ide, args.ts, args.eslint, args.jest);
     console.log(_entHelpers.help["package"](name, args.ts));
     console.log("\nThe package has the following dependencies:\n".concat(dependencies.join(' '), "\n"));
     console.log('Running `npm install` to get the required dependencies...\n');

package/bin/commands/help.js

@@ -8,7 +8,7 @@ var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCom
 var HELP_ADD = "\nUsage: grok add <entity> <name>\n\nAdd an object template to your package:\n\ngrok add app <name>\ngrok add connection <name>\ngrok add detector <semantic-type-name>\ngrok add function [tag] <name>\ngrok add query <name>\ngrok add script [tag] <language> <name>\ngrok add view <name>\ngrok add viewer <name>\n\nPlease note that entity names may only include letters and numbers\n\nSupported languages for scripts:\njavascript, julia, node, octave, python, r\n\nAvailable tags:\npanel, init\n";
 var HELP_API = "\nUsage: grok api\n\nCreate wrapper functions for package scripts and queries\n";
 var HELP_CONFIG = "\nUsage: grok config\n\nCreate or update a configuration file\n\nOptions:\n[--reset] [--server] [--alias] [--key]\n\n--reset     Restore the default config file template\n--server    Use to add a server to the config (`grok config add --alias alias --server url --key key`)\n--alias     Use in conjunction with the `server` option to set the server name\n--key       Use in conjunction with the `server` option to set the developer key\n--default   Use in conjunction with the `server` option to set the added server as default\n";
-var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--ts]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--ts        Create a TypeScript package\n";
+var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--ts] [--jest]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--ts        Create a TypeScript package\n--jest      Add a configuration for jest\n";
 var HELP_PUBLISH = "\nUsage: grok publish [host]\n\nUpload a package\n\nOptions:\n[--build|--rebuild] [--debug|--release] [--key] [--suffix]\n\nRunning `grok publish` is the same as running `grok publish defaultHost --build --debug`\n";
 var HELP_MIGRATE = "\nUsage: grok migrate\n\nSwitch to `grok` tools by copying your keys to the config\nfile and converting your scripts in the `package.json` file\n";
 var help = {

package/bin/grok.js

@@ -1,26 +1,26 @@
-#!/usr/bin/env node
-const argv = require('minimist')(process.argv.slice(2), {alias: {k: 'key'}});
-const help = require('./commands/help').help;
-
-const commands = {
-  add: require('./commands/add').add,
-  api: require('./commands/api').api,
-  config: require('./commands/config').config,
-  create: require('./commands/create').create,
-  publish: require('./commands/publish').publish,
-  migrate: require('./_deprecated/migrate').migrate
-};
-
-const command = argv['_'][0];
-if (command in commands) {
-  try {
-    if (!commands[command](argv)) {
-      console.log(help[command]);
-    }
-  } catch (err) {
-    console.error(err);
-    console.log(help[command]);
-  }
-} else {
-  console.log(help.help);
-}
+#!/usr/bin/env node
+const argv = require('minimist')(process.argv.slice(2), {alias: {k: 'key'}});
+const help = require('./commands/help').help;
+
+const commands = {
+  add: require('./commands/add').add,
+  api: require('./commands/api').api,
+  config: require('./commands/config').config,
+  create: require('./commands/create').create,
+  publish: require('./commands/publish').publish,
+  migrate: require('./_deprecated/migrate').migrate
+};
+
+const command = argv['_'][0];
+if (command in commands) {
+  try {
+    if (!commands[command](argv)) {
+      console.log(help[command]);
+    }
+  } catch (err) {
+    console.error(err);
+    console.log(help[command]);
+  }
+} else {
+  console.log(help.help);
+}

package/config-template.yaml

@@ -1,11 +1,11 @@
-servers:
-  dev:
-    url: 'https://dev.datagrok.ai/api'
-    key: ''
-  public:
-    url: 'https://public.datagrok.ai/api'
-    key: ''
-  local:
-    url: 'http://127.0.0.1:8080/api'
-    key: ''
-default: 'public'
+servers:
+  dev:
+    url: 'https://dev.datagrok.ai/api'
+    key: ''
+  public:
+    url: 'https://public.datagrok.ai/api'
+    key: ''
+  local:
+    url: 'http://127.0.0.1:8080/api'
+    key: ''
+default: 'public'

package/entity-template/app.js

@@ -1,6 +1,6 @@
-
-//name: #{NAME}
-//tags: app
-export function #{NAME}() {
-  grok.shell.info('Hello!');
-}
+
+//name: #{NAME}
+//tags: app
+export function #{NAME}() {
+  grok.shell.info('Hello!');
+}

package/entity-template/connection.json

@@ -1,17 +1,17 @@
-{
-    "name": "#{NAME}",
-    "#type": "DataConnection",
-    "parameters": {
-      "server": "#{GROK_DB_SERVER}",
-      "db": "#{DB_NAME}"
-    },
-    "credentials" : {
-      "parameters": {
-        "login": "#{LOGIN}",
-        "password": "#{PASSWORD}"
-      }
-    },
-    "dataSource": "PostgreSQL",
-    "description": "#{DB_NAME} db",
-    "tags": ["demo"]
-}
+{
+    "name": "#{NAME}",
+    "#type": "DataConnection",
+    "parameters": {
+      "server": "#{GROK_DB_SERVER}",
+      "db": "#{DB_NAME}"
+    },
+    "credentials" : {
+      "parameters": {
+        "login": "#{LOGIN}",
+        "password": "#{PASSWORD}"
+      }
+    },
+    "dataSource": "PostgreSQL",
+    "description": "#{DB_NAME} db",
+    "tags": ["demo"]
+}

package/entity-template/function.js

@@ -1,9 +1,9 @@
-
-//name: #{NAME}
-//input: string name
-//output: string greeting
-export function #{NAME}(name) {
-  let greeting = 'Hello, ' + name;
-  grok.shell.info(greeting);
-  return greeting;
-}
+
+//name: #{NAME}
+//input: string name
+//output: string greeting
+export function #{NAME}(name) {
+  let greeting = 'Hello, ' + name;
+  grok.shell.info(greeting);
+  return greeting;
+}

package/entity-template/function.ts

@@ -1,9 +1,9 @@
-
-//name: #{NAME}
-//input: string name
-//output: string greeting
-export function #{NAME}(name: string) {
-  let greeting = 'Hello, ' + name;
-  grok.shell.info(greeting);
-  return greeting;
-}
+
+//name: #{NAME}
+//input: string name
+//output: string greeting
+export function #{NAME}(name: string) {
+  let greeting = 'Hello, ' + name;
+  grok.shell.info(greeting);
+  return greeting;
+}

package/entity-template/init.js

@@ -1,4 +1,4 @@
-
-//tags: init
-export async function #{NAME}() {
-}
+
+//tags: init
+export async function #{NAME}() {
+}

package/entity-template/panel.js

@@ -1,11 +1,11 @@
-
-//name: #{NAME}
-//description: Creates an info panel
-//tags: panel
-//input: string smiles {semType: Molecule}
-//output: widget result
-//condition: true
-export function #{NAME}(smiles) {
-  let mol = ui.div(grok.chem.svgMol(smiles));
-  return DG.Widget.fromRoot(mol);
-}
+
+//name: #{NAME}
+//description: Creates an info panel
+//tags: panel
+//input: string smiles {semType: Molecule}
+//output: widget result
+//condition: true
+export function #{NAME}(smiles) {
+  let mol = ui.div(grok.chem.svgMol(smiles));
+  return DG.Widget.fromRoot(mol);
+}

package/entity-template/panel.ts

@@ -1,11 +1,11 @@
-
-//name: #{NAME}
-//description: Creates an info panel
-//tags: panel
-//input: string smiles {semType: Molecule}
-//output: widget result
-//condition: true
-export function #{NAME}(smiles: string) {
-  let mol = ui.div(grok.chem.svgMol(smiles));
-  return DG.Widget.fromRoot(mol);
-}
+
+//name: #{NAME}
+//description: Creates an info panel
+//tags: panel
+//input: string smiles {semType: Molecule}
+//output: widget result
+//condition: true
+export function #{NAME}(smiles: string) {
+  let mol = ui.div(grok.chem.svgMol(smiles));
+  return DG.Widget.fromRoot(mol);
+}

package/entity-template/queries.sql

@@ -1,7 +1,7 @@
-
---name: #{NAME}
---connection: #{CONNECTION}
---input: int id
---output: dataframe result
-select * from country where id = @id
---end
+
+--name: #{NAME}
+--connection: #{CONNECTION}
+--input: int id
+--output: dataframe result
+select * from country where id = @id
+--end

package/entity-template/sem-type-detector.js

@@ -1,11 +1,11 @@
-
-  //tags: semTypeDetector
-  //input: column col
-  //output: string semType
-  detect#{PACKAGE_DETECTORS_NAME}(col) {
-    if (col.name.startsWith('#{NAME_PREFIX}')) {
-      col.semType = '#{NAME}';
-      return col.semType;
-    }
-    return null;
-  }
+
+  //tags: semTypeDetector
+  //input: column col
+  //output: string semType
+  detect#{PACKAGE_DETECTORS_NAME}(col) {
+    if (col.name.startsWith('#{NAME_PREFIX}')) {
+      col.semType = '#{NAME}';
+      return col.semType;
+    }
+    return null;
+  }

package/entity-template/view-class.js

@@ -1,60 +1,60 @@
-import * as grok from 'datagrok-api/grok';
-import * as ui from 'datagrok-api/ui';
-import * as DG from 'datagrok-api/dg';
-
-// A sample class from the Notebooks package:
-// https://github.com/datagrok-ai/public/tree/master/packages/Notebooks
-// This class defines a new view for Jupyter Notebooks.
-export class #{NAME} extends DG.ViewBase {
-  constructor(params, path) {
-    super(params, path);
-    this.TYPE = 'Notebook';
-    this.PATH = '/notebook';
-  }
-
-  // Override basic methods
-  get type() {
-    return this.TYPE;
-  }
-
-  get helpUrl() {
-    return '/help/develop/jupyter-notebook.md';
-  }
-
-  get name() {
-    return 'Notebook';
-  }
-
-  get path() {
-    return `${this.PATH}/${this.notebookId}`;
-  }
-
-  // Icon
-  getIcon() {
-    let img = document.createElement('img');
-    img.src = '/images/entities/jupyter.png';
-    img.height = 18;
-    img.width = 18;
-    return img;
-  }
-
-  // View state serialization/deserialization
-  saveStateMap() {
-    return {'notebookId': this.notebookId};
-  }
-
-  loadStateMap(stateMap) {
-    open(stateMap['notebookId']);
-  }
-
-  // URL path handler
-  handlePath(path) {
-    let id = path.replace(`${this.PATH}/`, '');
-    open(id);
-  }
-
-  // URL path checker
-  acceptsPath(path) {
-    return path.startsWith(this.PATH);
-  }
-}
+import * as grok from 'datagrok-api/grok';
+import * as ui from 'datagrok-api/ui';
+import * as DG from 'datagrok-api/dg';
+
+// A sample class from the Notebooks package:
+// https://github.com/datagrok-ai/public/tree/master/packages/Notebooks
+// This class defines a new view for Jupyter Notebooks.
+export class #{NAME} extends DG.ViewBase {
+  constructor(params, path) {
+    super(params, path);
+    this.TYPE = 'Notebook';
+    this.PATH = '/notebook';
+  }
+
+  // Override basic methods
+  get type() {
+    return this.TYPE;
+  }
+
+  get helpUrl() {
+    return '/help/develop/jupyter-notebook.md';
+  }
+
+  get name() {
+    return 'Notebook';
+  }
+
+  get path() {
+    return `${this.PATH}/${this.notebookId}`;
+  }
+
+  // Icon
+  getIcon() {
+    let img = document.createElement('img');
+    img.src = '/images/entities/jupyter.png';
+    img.height = 18;
+    img.width = 18;
+    return img;
+  }
+
+  // View state serialization/deserialization
+  saveStateMap() {
+    return {'notebookId': this.notebookId};
+  }
+
+  loadStateMap(stateMap) {
+    open(stateMap['notebookId']);
+  }
+
+  // URL path handler
+  handlePath(path) {
+    let id = path.replace(`${this.PATH}/`, '');
+    open(id);
+  }
+
+  // URL path checker
+  acceptsPath(path) {
+    return path.startsWith(this.PATH);
+  }
+}

package/entity-template/view-class.ts

@@ -1,64 +1,64 @@
-import * as grok from 'datagrok-api/grok';
-import * as ui from 'datagrok-api/ui';
-import * as DG from 'datagrok-api/dg';
-
-// A sample class from the Notebooks package:
-// https://github.com/datagrok-ai/public/tree/master/packages/Notebooks
-// This class defines a new view for Jupyter Notebooks.
-export class #{NAME} extends DG.ViewBase {
-  TYPE: string;
-  PATH: string;
-  notebookId: any;
-
-  constructor(params: object | null, path: string) {
-    super(params, path);
-    this.TYPE = 'Notebook';
-    this.PATH = '/notebook';
-  }
-
-  // Override basic methods
-  get type() {
-    return this.TYPE;
-  }
-
-  get helpUrl() {
-    return '/help/compute/jupyter-notebook.md';
-  }
-
-  get name() {
-    return 'Notebook';
-  }
-
-  get path() {
-    return `${this.PATH}/${this.notebookId}`;
-  }
-
-  // Icon
-  getIcon() {
-    let img = document.createElement('img');
-    img.src = '/images/entities/jupyter.png';
-    img.height = 18;
-    img.width = 18;
-    return img;
-  }
-
-  // View state serialization/deserialization
-  saveStateMap() {
-    return {'notebookId': this.notebookId};
-  }
-
-  loadStateMap(stateMap: { [x: string]: string }) {
-    open(stateMap['notebookId']);
-  }
-
-  // URL path handler
-  handlePath(path: string) {
-    let id = path.replace(`${this.PATH}/`, '');
-    open(id);
-  }
-
-  // URL path checker
-  acceptsPath(path: string) {
-    return path.startsWith(this.PATH);
-  }
-}
+import * as grok from 'datagrok-api/grok';
+import * as ui from 'datagrok-api/ui';
+import * as DG from 'datagrok-api/dg';
+
+// A sample class from the Notebooks package:
+// https://github.com/datagrok-ai/public/tree/master/packages/Notebooks
+// This class defines a new view for Jupyter Notebooks.
+export class #{NAME} extends DG.ViewBase {
+  TYPE: string;
+  PATH: string;
+  notebookId: any;
+
+  constructor(params: object | null, path: string) {
+    super(params, path);
+    this.TYPE = 'Notebook';
+    this.PATH = '/notebook';
+  }
+
+  // Override basic methods
+  get type() {
+    return this.TYPE;
+  }
+
+  get helpUrl() {
+    return '/help/compute/jupyter-notebook.md';
+  }
+
+  get name() {
+    return 'Notebook';
+  }
+
+  get path() {
+    return `${this.PATH}/${this.notebookId}`;
+  }
+
+  // Icon
+  getIcon() {
+    let img = document.createElement('img');
+    img.src = '/images/entities/jupyter.png';
+    img.height = 18;
+    img.width = 18;
+    return img;
+  }
+
+  // View state serialization/deserialization
+  saveStateMap() {
+    return {'notebookId': this.notebookId};
+  }
+
+  loadStateMap(stateMap: { [x: string]: string }) {
+    open(stateMap['notebookId']);
+  }
+
+  // URL path handler
+  handlePath(path: string) {
+    let id = path.replace(`${this.PATH}/`, '');
+    open(id);
+  }
+
+  // URL path checker
+  acceptsPath(path: string) {
+    return path.startsWith(this.PATH);
+  }
+}

package/entity-template/view.js

@@ -1,10 +1,10 @@
-
-//name: #{NAME}
-//description: Creates #{NAME} view
-//tags: view
-//input: map params
-//input: string path
-//output: view result
-export function _#{NAME}(params = null, path = '') {
-  return new #{NAME}(params, path);
-}
+
+//name: #{NAME}
+//description: Creates #{NAME} view
+//tags: view
+//input: map params
+//input: string path
+//output: view result
+export function _#{NAME}(params = null, path = '') {
+  return new #{NAME}(params, path);
+}

package/entity-template/viewer-class.js

@@ -1,23 +1,23 @@
-import * as grok from 'datagrok-api/grok';
-import * as ui from 'datagrok-api/ui';
-import * as DG from 'datagrok-api/dg';
-
-// See also https://datagrok.ai/help/develop/how-to/develop-custom-viewer
-// This viewer does the following:
-// * listens to changes of filter and selection in the attached table,
-// * updates the number of filtered/selected rows accordingly.
-export class #{NAME} extends DG.JsViewer {
-  onTableAttached() {
-    this.subs.push(this.dataFrame.selection.onChanged.subscribe((_) => this.render()));
-    this.subs.push(this.dataFrame.filter.onChanged.subscribe((_) => this.render()));
-
-    this.render();
-  }
-
-  render() {
-    this.root.innerHTML =
-      `${this.dataFrame.toString()}<br>
-            Selected: ${this.dataFrame.selection.trueCount}<br>
-            Filtered: ${this.dataFrame.filter.trueCount}`;
-  }
-}
+import * as grok from 'datagrok-api/grok';
+import * as ui from 'datagrok-api/ui';
+import * as DG from 'datagrok-api/dg';
+
+// See also https://datagrok.ai/help/develop/how-to/develop-custom-viewer
+// This viewer does the following:
+// * listens to changes of filter and selection in the attached table,
+// * updates the number of filtered/selected rows accordingly.
+export class #{NAME} extends DG.JsViewer {
+  onTableAttached() {
+    this.subs.push(this.dataFrame.selection.onChanged.subscribe((_) => this.render()));
+    this.subs.push(this.dataFrame.filter.onChanged.subscribe((_) => this.render()));
+
+    this.render();
+  }
+
+  render() {
+    this.root.innerHTML =
+      `${this.dataFrame.toString()}<br>
+            Selected: ${this.dataFrame.selection.trueCount}<br>
+            Filtered: ${this.dataFrame.filter.trueCount}`;
+  }
+}