datagrok-tools 4.1.13 → 4.1.17

package/README.md

@@ -67,7 +67,7 @@ Read more about package development in [Datagrok's documentation](https://datagr
   we recommend that you postfix them with 'View' and 'Viewer' respectively.
   Supported languages for scripts are `javascript`, `julia`, `node`, `octave`, `python`, `r`.
   Available function tags: `panel`, `init`.
-- `api` creates wrapper functions for package scripts. The output is stored in `/src/scripts-api.ts`.
+- `api` creates wrapper functions for package scripts and queries. The output is stored in files `/src/scripts-api.ts` and `/src/queries-api.ts` respectively.
 - `publish` uploads a package to the specified server (pass either a URL or a server alias from the `config.yaml` file).
   ```
   cd <package-name>

package/bin/_deprecated/migrate.js

@@ -14,7 +14,7 @@ const packDir = path.join(curDir, 'package.json');
 const grokDir = path.join(os.homedir(), '.grok');
 const confPath = path.join(grokDir, 'config.yaml');
 const confTemplateDir = path.join(path.dirname(path.dirname(__dirname)), 'config-template.yaml');
-const confTemplate = yaml.safeLoad(fs.readFileSync(confTemplateDir));
+const confTemplate = yaml.load(fs.readFileSync(confTemplateDir));
 
 const grokMap = {
   'datagrok-upload': 'grok publish',
@@ -34,9 +34,9 @@ function migrate(args) {
 
   // Create `config.yaml` if it doesn't exist yet
   if (!fs.existsSync(grokDir)) fs.mkdirSync(grokDir);
-  if (!fs.existsSync(confPath)) fs.writeFileSync(confPath, yaml.safeDump(confTemplate));
+  if (!fs.existsSync(confPath)) fs.writeFileSync(confPath, yaml.dump(confTemplate));
 
-  let config = yaml.safeLoad(fs.readFileSync(confPath));
+  let config = yaml.load(fs.readFileSync(confPath));
 
   // Copy keys to the `config.yaml` file
   if (fs.existsSync(keysDir)) {
@@ -54,7 +54,7 @@ function migrate(args) {
           console.log(`Skipping an invalid URL in \`upload.keys.json\`: ${url}`);
         }
       }
-      fs.writeFileSync(confPath, yaml.safeDump(config));
+      fs.writeFileSync(confPath, yaml.dump(config));
       console.log(`Migrated data from local \`upload.keys.json\` to ${confPath}`);
       fs.unlinkSync(keysDir);
       console.log('Successfully deleted the file');

package/bin/commands/add.js

@@ -271,7 +271,7 @@ function add(args) {
 
       var view = _fs["default"].readFileSync(_path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'entity-template', 'view.js'), 'utf8');
 
-      contents = insertName(name, "import {#{NAME}} from './#{NAME_LOWERCASE}';\n");
+      contents = insertName(name, "import {#{NAME}} from './".concat(utils.camelCaseToKebab(name), "';\n"));
       contents += _fs["default"].readFileSync(packageEntry, 'utf8');
       contents += insertName(name, view);
 
@@ -306,7 +306,7 @@ function add(args) {
 
       var viewer = _fs["default"].readFileSync(_path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'entity-template', 'viewer.js'), 'utf8');
 
-      contents = insertName(name, "import {#{NAME}} from './#{NAME_LOWERCASE}';\n");
+      contents = insertName(name, "import {#{NAME}} from './".concat(utils.camelCaseToKebab(name), "';\n"));
       contents += _fs["default"].readFileSync(packageEntry, 'utf8');
       contents += insertName(name, viewer);
 

package/bin/commands/api.js

@@ -37,6 +37,12 @@ function generateQueryWrappers() {
     return;
   }
 
+  var packagePath = _path["default"].join(curDir, 'package.json');
+
+  var _package = JSON.parse(_fs["default"].readFileSync(packagePath, {
+    encoding: 'utf-8'
+  }));
+
   var files = _ignoreWalk["default"].sync({
     path: './queries',
     ignoreFiles: ['.npmignore', '.gitignore']
@@ -71,36 +77,7 @@ function generateQueryWrappers() {
           var q = _step2.value;
           var name = utils.getScriptName(q, utils.commentMap[utils.queryExtension]);
           if (!name) continue;
-          var tb = new utils.TemplateBuilder(utils.queryWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name);
-          var connection = utils.getParam('connection', q, utils.commentMap[utils.queryExtension]);
-
-          if (!connection) {
-            // Use the name of the first found connection (either a field or file name)
-            var connectionsDir = _path["default"].join(curDir, 'connections');
-
-            if (_fs["default"].existsSync(connectionsDir) && _fs["default"].readdirSync(connectionsDir).length !== 0) {
-              var connectionFile = _fs["default"].readdirSync(connectionsDir).find(function (c) {
-                return /.+\.json$/.test(c);
-              });
-
-              if (!connectionFile) {
-                console.log("Connection for query \"".concat(name, "\" not found."));
-                continue;
-              }
-
-              try {
-                var paramString = _fs["default"].readFileSync(connectionFile, 'utf8');
-
-                var params = JSON.parse(paramString);
-                connection = params.name || connectionFile.slice(0, -5);
-              } catch (error) {
-                console.log("Connection for query \"".concat(name, "\" not found."));
-                continue;
-              }
-            }
-          }
-
-          tb.replace('NAME', connection);
+          var tb = new utils.TemplateBuilder(utils.queryWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package.name);
           var inputs = utils.getScriptInputs(q, utils.commentMap[utils.queryExtension]);
           var outputType = utils.getScriptOutputType(q, utils.commentMap[utils.queryExtension]);
           tb.replace('PARAMS_OBJECT', inputs).replace('TYPED_PARAMS', inputs) // The query output, if omitted, is a dataframe
@@ -142,6 +119,12 @@ function generateScriptWrappers() {
     return;
   }
 
+  var packagePath = _path["default"].join(curDir, 'package.json');
+
+  var _package = JSON.parse(_fs["default"].readFileSync(packagePath, {
+    encoding: 'utf-8'
+  }));
+
   var files = _ignoreWalk["default"].sync({
     path: './scripts',
     ignoreFiles: ['.npmignore', '.gitignore']
@@ -167,15 +150,7 @@ function generateScriptWrappers() {
       if (!script) return "continue";
       var name = utils.getScriptName(script, utils.commentMap[extension]);
       if (!name) return "continue";
-      var tb = new utils.TemplateBuilder(utils.scriptWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name);
-
-      var packagePath = _path["default"].join(curDir, 'package.json');
-
-      var _package = JSON.parse(_fs["default"].readFileSync(packagePath, {
-        encoding: 'utf-8'
-      }));
-
-      tb.replace('PACKAGE_NAMESPACE', _package.name);
+      var tb = new utils.TemplateBuilder(utils.scriptWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package.name);
       var inputs = utils.getScriptInputs(script);
       var outputType = utils.getScriptOutputType(script);
       tb.replace('PARAMS_OBJECT', inputs).replace('TYPED_PARAMS', inputs).replace('OUTPUT_TYPE', outputType);

package/bin/commands/create.js

@@ -13,8 +13,6 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 
 var _fs = _interopRequireDefault(require("fs"));
 
-var _inquirer = _interopRequireDefault(require("inquirer"));
-
 var _path = _interopRequireDefault(require("path"));
 
 var _os = _interopRequireDefault(require("os"));
@@ -93,7 +91,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
           _package['scripts']["release-".concat(name.toLowerCase(), "-").concat(server)] = "grok publish ".concat(server, " --rebuild --release");
         }
 
-        if (ts) Object.assign(_package.dependencies, {
+        if (ts) Object.assign(_package.devDependencies, {
           'ts-loader': 'latest',
           'typescript': 'latest'
         });
@@ -201,22 +199,11 @@ function create(args) {
     createDirectoryContents(name, config, templateDir, packageDir, args.ide, args.ts, args.eslint);
     console.log(_entHelpers.help["package"](name, args.ts));
     console.log("\nThe package has the following dependencies:\n".concat(dependencies.join(' '), "\n"));
-
-    _inquirer["default"].prompt({
-      name: 'run-npm-install',
-      type: 'confirm',
-      message: 'Would you like to install them now with `npm`?',
-      "default": false
-    }).then(function (answers) {
-      if (!answers['run-npm-install']) return;
-      console.log('\nRunning `npm install` to get the required dependencies...\n');
-      (0, _child_process.exec)('npm install', {
-        cwd: packageDir
-      }, function (err, stdout, stderr) {
-        if (err) throw err;else console.log(stderr, stdout);
-      });
-    })["catch"](function (err) {
-      return console.error(err);
+    console.log('Running `npm install` to get the required dependencies...\n');
+    (0, _child_process.exec)('npm install', {
+      cwd: packageDir
+    }, function (err, stdout, stderr) {
+      if (err) throw err;else console.log(stderr, stdout);
     });
   } else {
     console.log('Package name may only include letters, numbers, underscores, or hyphens');

package/bin/utils/ent-helpers.js

@@ -27,7 +27,7 @@ var query = function query(queryName) {
 };
 
 var script = function script(scriptName, packageName) {
-  return "\nThe script ".concat(scriptName, " has been created. To call it from a JavaScript file, use:\n\n  await grok.functions.call('").concat(packageName, ":").concat(scriptName, "', { params });\n  \nRead more at https://datagrok.ai/help/develop/scripting\nSee examples at https://public.datagrok.ai/scripts,\nhttps://public.datagrok.ai/js/samples/scripting/scripting");
+  return "\nThe script ".concat(scriptName, " has been created. To call it from a JavaScript file, use:\n\n  await grok.functions.call('").concat(packageName, ":").concat(scriptName, "', { params });\n  \nRead more at https://datagrok.ai/help/compute/scripting\nSee examples at https://public.datagrok.ai/scripts,\nhttps://public.datagrok.ai/js/samples/scripting/scripting");
 };
 
 var view = function view(viewName) {

package/bin/utils/utils.js

@@ -9,6 +9,7 @@ exports.TemplateBuilder = void 0;
 exports.camelCaseToKebab = camelCaseToKebab;
 exports.checkScriptLocation = checkScriptLocation;
 exports.dgToTsTypeMap = exports.dgImports = exports.commentMap = void 0;
+exports.friendlyNameToName = friendlyNameToName;
 exports.getParam = getParam;
 exports.getScriptInputs = getScriptInputs;
 exports.getScriptName = getScriptName;
@@ -17,7 +18,9 @@ exports.isEmpty = isEmpty;
 exports.isPackageDir = isPackageDir;
 exports.kebabToCamelCase = kebabToCamelCase;
 exports.mapURL = mapURL;
-exports.scriptWrapperTemplate = exports.scriptLangExtMap = exports.scriptExtensions = exports.replacers = exports.queryWrapperTemplate = exports.queryExtension = void 0;
+exports.queryWrapperTemplate = exports.queryExtension = void 0;
+exports.removeScope = removeScope;
+exports.scriptWrapperTemplate = exports.scriptLangExtMap = exports.scriptExtensions = exports.replacers = void 0;
 exports.spaceToCamelCase = spaceToCamelCase;
 exports.wordsToCamelCase = wordsToCamelCase;
 
@@ -75,6 +78,11 @@ function camelCaseToKebab(s) {
   });
 }
 
+function removeScope(name) {
+  var split = name.split('/');
+  return split[split.length - 1];
+}
+
 function mapURL(conf) {
   var urls = {};
 
@@ -85,6 +93,35 @@ function mapURL(conf) {
   return urls;
 }
 
+function friendlyNameToName(s) {
+  var _s;
+
+  var firstUpper = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+  var out = '';
+  var cap = true;
+  var firstWordUpperCase = false;
+  var start = true;
+  s = ((_s = s) !== null && _s !== void 0 ? _s : '').trim();
+  var letterRegex = /[A-Za-z]/;
+  var digitRegex = /\d/;
+
+  var isUpper = function isUpper(s) {
+    return /[A-Z]/.test(s);
+  };
+
+  for (var i = 0; i < s.length; i++) {
+    if (!letterRegex.test(s[i]) && !digitRegex.test(s[i])) cap = true;else {
+      if (start && digitRegex.test(s[i])) continue;
+      firstWordUpperCase = start ? isUpper(s[i]) : firstWordUpperCase && isUpper(s[i]);
+      out += !firstUpper && (start || firstWordUpperCase && !cap) ? s[i].toLowerCase() : cap ? s[i].toUpperCase() : s[i];
+      cap = false;
+      start = false;
+    }
+  }
+
+  return out;
+}
+
 var replacers = {
   NAME: function NAME(s, name) {
     return s.replace(/#{NAME}/g, name);
@@ -102,13 +139,13 @@ var replacers = {
     return s.replace(/#{PACKAGE_DETECTORS_NAME}/g, kebabToCamelCase(name));
   },
   PACKAGE_NAMESPACE: function PACKAGE_NAMESPACE(s, name) {
-    return s.replace(/#{PACKAGE_NAMESPACE}/g, kebabToCamelCase(name));
+    return s.replace(/#{PACKAGE_NAMESPACE}/g, kebabToCamelCase(removeScope(name)));
   },
   FUNC_NAME: function FUNC_NAME(s, name) {
-    return s.replace(/#{FUNC_NAME}/g, name.includes('-') ? kebabToCamelCase(name) : name.includes(' ') ? spaceToCamelCase(name) : name[0].toUpperCase() + name.slice(1));
+    return s.replace(/#{FUNC_NAME}/g, friendlyNameToName(name));
   },
   FUNC_NAME_LOWERCASE: function FUNC_NAME_LOWERCASE(s, name) {
-    return s.replace(/#{FUNC_NAME_LOWERCASE}/g, name.includes('-') ? kebabToCamelCase(name, false) : name.includes(' ') ? spaceToCamelCase(name, false) : wordsToCamelCase(name, false));
+    return s.replace(/#{FUNC_NAME_LOWERCASE}/g, friendlyNameToName(name, false));
   },
   PARAMS_OBJECT: function PARAMS_OBJECT(s, params) {
     return s.replace(/#{PARAMS_OBJECT}/g, params.length ? "{ ".concat(params.map(function (p) {
@@ -266,5 +303,5 @@ var dgImports = "import * as grok from 'datagrok-api/grok';\nimport * as DG from
 exports.dgImports = dgImports;
 var scriptWrapperTemplate = "export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {\n  return await grok.functions.call('#{PACKAGE_NAMESPACE}:#{FUNC_NAME}', #{PARAMS_OBJECT});\n}";
 exports.scriptWrapperTemplate = scriptWrapperTemplate;
-var queryWrapperTemplate = "export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {\n  return await grok.data.query('#{NAME}:#{FUNC_NAME}', #{PARAMS_OBJECT});\n}";
+var queryWrapperTemplate = "export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {\n  return await grok.data.query('#{PACKAGE_NAMESPACE}:#{FUNC_NAME}', #{PARAMS_OBJECT});\n}";
 exports.queryWrapperTemplate = queryWrapperTemplate;

package/entity-template/view-class.ts

@@ -22,7 +22,7 @@ export class #{NAME} extends DG.ViewBase {
   }
 
   get helpUrl() {
-    return '/help/develop/jupyter-notebook.md';
+    return '/help/compute/jupyter-notebook.md';
   }
 
   get name() {

package/package-template/.eslintrc.json

@@ -1,25 +1,26 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
-  "extends": [
-    "google"
-  ],
-  "parserOptions": {
-    "ecmaVersion": 12,
-    "sourceType": "module"
-  },
-  "rules": {
-    "indent": [
-      "error",
-      2
-    ],
-    "max-len": [
-      "error",
-      120
-    ],
-    "require-jsdoc": "off",
-    "spaced-comment": "off"
-  }
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "google"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": [
+      "error",
+      2
+    ],
+    "max-len": [
+      "error",
+      120
+    ],
+    "require-jsdoc": "off",
+    "spaced-comment": "off",
+    "linebreak-style": "off"
+  }
 }

package/package-template/ts.webpack.config.js

@@ -23,6 +23,7 @@ module.exports = {
     'rxjs/operators': 'rxjs.operators',
     'cash-dom': '$',
     'dayjs': 'dayjs',
+    'wu': 'wu',
   },
   output: {
     filename: '[name].js',

package/package-template/webpack.config.js

@@ -15,6 +15,7 @@ module.exports = {
     'rxjs/operators': 'rxjs.operators',
     'cash-dom': '$',
     'dayjs': 'dayjs',
+    'wu': 'wu',
   },
   output: {
     filename: '[name].js',

package/package.json

@@ -1,22 +1,24 @@
 {
   "name": "datagrok-tools",
-  "version": "4.1.13",
+  "version": "4.1.17",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {
-    "inquirer": "^7.1.0",
-    "minimist": "^1.2.5",
-    "node-fetch": "^2.6.0",
-    "fs": "latest",
-    "node-recursive-directory": "^1.2.0",
-    "path": "^0.12.7",
+    "@babel/runtime": "^7.16.0",
     "archiver": "^4.0.2",
     "archiver-promise": "^1.0.0",
+    "fs": "latest",
     "ignore-walk": "^3.0.3",
+    "inquirer": "^7.1.0",
     "js-yaml": "^4.1.0",
-    "os": "^0.1.1"
+    "minimist": "^1.2.5",
+    "node-fetch": "^2.6.0",
+    "node-recursive-directory": "^1.2.0",
+    "os": "^0.1.1",
+    "path": "^0.12.7"
   },
   "scripts": {
+    "link": "npm link",
     "prepublishOnly": "babel bin --extensions .ts -d bin",
     "babel": "babel bin --extensions .ts -d bin"
   },

package/src/test-utils.ts

@@ -1,84 +0,0 @@
-import * as path from "path";
-import * as os from "os";
-import * as fs from "fs";
-import * as yaml from 'js-yaml';
-import { Config, Indexable } from "../bin/utils/utils";
-const fetch = require('node-fetch');
-
-export async function getToken(url: string, key: string) {
-  let response = await fetch(`${url}/users/login/dev/${key}`, {method: 'POST'});
-  let json = await response.json();
-  if (json.isSuccess == true)
-    return json.token;
-  else
-    throw 'Unable to login to server. Check your dev key';
-}
-
-export async function getWebUrl(url: string, token: string) {
-  let response = await fetch(`${url}/admin/plugins/admin/settings`, {headers: {Authorization: token}});
-  let json = await response.json();
-  return json.settings.webRoot;
-}
-
-const grokDir = path.join(os.homedir(), '.grok');
-const confPath = path.join(grokDir, 'config.yaml');
-
-function mapURL(conf: Config): Indexable {
-  let urls: Indexable = {};
-  for (let server in conf.servers) {
-    urls[conf['servers'][server]['url']] = conf['servers'][server];
-  }
-  return urls;
-}
-
-export function getDevKey(hostKey: string): {url: string, key: string} {
-  let config = yaml.load(fs.readFileSync(confPath, 'utf8')) as any;
-  let host = hostKey == '' ? config.default : hostKey;
-  host = host.trim();
-  let urls = mapURL(config);
-  let key = '';
-  let url = '';
-  try {
-    let url = new URL(host).href;
-    if (url.endsWith('/')) url = url.slice(0, -1);
-    if (url in urls) key = config['servers'][urls[url]]['key'];
-  } catch (error) {
-    if (config['servers'][host] == null)
-      throw `Unknown server alias. Please add it to ${confPath}`;
-    url = config['servers'][host]['url'];
-    key = config['servers'][host]['key'];
-  }
-  return {url, key};
-}
-
-export async function getBrowserPage(puppeteer: any): Promise<{browser: any, page: any}> {
-  let url:string = process.env.HOST ?? '';
-  let cfg = getDevKey(url);
-  url = cfg.url;
-
-  let key = cfg.key;
-  let token = await getToken(url, key);
-  url = await getWebUrl(url, token);
-  console.log(`Using web root: ${url}`);
-
-  let browser = await puppeteer.launch({
-    args: ['--disable-dev-shm-usage', '--disable-features=site-per-process'],
-    ignoreHTTPSErrors: true,
-  });
-
-  let page = await browser.newPage();
-  await page.goto(`${url}/oauth/`);
-  await page.setCookie({name: 'auth', value: token});
-  await page.evaluate((token: any) => {
-    window.localStorage.setItem('auth', token);
-  }, token);
-  await page.goto(url);
-  try {
-    await page.waitForSelector('.grok-preloader');
-    console.log('got preloader');
-    await page.waitForFunction(() => document.querySelector('.grok-preloader') == null, {timeout: 100000});
-  } catch (error) {
-    throw error;
-  }
-  return {browser, page};
-}