datagrok-tools 4.14.24 → 4.14.26

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Datagrok-tools changelog
 
+## 4.14.26 (2025-07-10)
+
+### Features
+
+* Grok Decorators added support for ViewBase type
+* Grok Decorators updated comments and line feeds
+* Grok Api updated comments and line feeds
+* Grok Api minor type update
+
 ## 4.14.19 (2025-06-23)
 
 ### Features

package/bin/commands/api.js

@@ -12,6 +12,7 @@ var utils = _interopRequireWildcard(require("../utils/utils"));
 var color = _interopRequireWildcard(require("../utils/color-utils"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+const annotationForApiFile = `/**\nThis file is auto-generated by the grok api command.\nIf you notice any changes, please push them to the repository.\nDo not edit this file manually.\n*/\n`;
 const sep = '\n';
 const packageFuncDirs = ['package.ts', 'package.g.ts'];
 const apiFile = 'package-api.ts';
@@ -112,6 +113,7 @@ function generateFunctionWrappers() {
   saveWrappersToFile('funcs', wrappers);
 }
 function saveWrappersToFile(namespaceName, wrappers) {
+  if (wrappers.length === 0) return;
   if (!_fs.default.existsSync(funcFilePath)) createApiFile();
   const scriptApi = new utils.TemplateBuilder(utils.namespaceTemplate).replace('PACKAGE_NAMESPACE', namespaceName).replace('NAME', wrappers.join(sep.repeat(2)));
   _fs.default.appendFileSync(funcFilePath, sep + scriptApi.build() + sep);
@@ -122,7 +124,7 @@ function createApiFile() {
     color.warn(`The file ${funcFilePath} already exists`);
     console.log('Rewriting its contents...');
   }
-  _fs.default.writeFileSync(funcFilePath, utils.dgImports + sep, 'utf8');
+  _fs.default.writeFileSync(funcFilePath, annotationForApiFile + utils.dgImports + sep, 'utf8');
 }
 function checkNameColision(name) {
   if (names.has(name)) console.log('There is collision in name ' + name);

package/bin/commands/check.js

@@ -40,7 +40,7 @@ function runChecks(packagePath, soft = false) {
     path: packagePath,
     ignoreFiles: ['.npmignore', '.gitignore']
   }).filter(e => !e.includes('node_modules'));
-  const jsTsFiles = files.filter(f => !f.startsWith('dist/') && (f.endsWith('.js') || f.endsWith('.ts') || f.endsWith('.sql') || f.endsWith('.py')));
+  const jsTsFiles = files.filter(f => (f.startsWith('src' + _path.default.sep) || f.startsWith('queries' + _path.default.sep) || f.startsWith('scripts' + _path.default.sep)) && (f.endsWith('.js') || f.endsWith('.ts') || f.endsWith('.sql') || f.endsWith('.py')));
   const packageFiles = ['src/package.ts', 'src/detectors.ts', 'src/package.js', 'src/detectors.js', 'src/package-test.ts', 'src/package-test.js', 'package.js', 'detectors.js'];
   // const funcFiles = jsTsFiles.filter((f) => packageFiles.includes(f)); 
   const errors = [];
@@ -305,6 +305,7 @@ function checkFuncSignatures(packagePath, files) {
   };
   const functionRoles = Object.keys(checkFunctions);
   for (const file of files) {
+    if (file.includes('.min.')) continue;
     const content = _fs.default.readFileSync(_path.default.join(packagePath, file), {
       encoding: 'utf-8'
     });
@@ -557,6 +558,15 @@ function getFuncMetadata(script, fileExtention) {
     }
     if (isHeader) {
       const nm = line.match(utils.nameRegex);
+      if (data.name === '') {
+        data = {
+          name: '',
+          inputs: [],
+          outputs: []
+        };
+        isHeader = false;
+        continue;
+      }
       if (nm) data.name = nm[1]?.toLocaleLowerCase();
       if (data.name && !match) {
         funcData.push(data);

package/bin/commands/publish.js

@@ -207,13 +207,14 @@ async function processPackage(debug, rebuild, host, devKey, packageName, suffix)
   return 0;
 }
 async function publish(args) {
-  if (!args['skip-check']) (0, _check.check)({
+  console.log('publish');
+  if (!args['skip-check'] && !args['all']) (0, _check.check)({
     _: ['check']
   });
   config = _jsYaml.default.load(_fs.default.readFileSync(confPath, {
     encoding: 'utf-8'
   }));
-  if (args.refresh || args.all) {
+  if (args.refresh) {
     if (_path.default.basename(curDir) !== 'packages') curDir = _path.default.dirname(curDir);
     let host = config.default;
     if (args['_'].length === 2) host = args['_'][1];
@@ -249,6 +250,8 @@ async function publishPackage(args) {
   if (nArgs > 2 || nOptions > 5) return false;
   if (!Object.keys(args).slice(1).every(option => ['build', 'rebuild', 'debug', 'release', 'k', 'key', 'suffix'].includes(option))) return false;
   if (args.build && args.rebuild) {
+    utils.runScript('npm install', curDir, false);
+    utils.runScript('npm run build', curDir, false);
     color.error('Incompatible options: --build and --rebuild');
     return false;
   }

package/bin/grok.js

@@ -3,6 +3,7 @@ const argv = require('minimist')(process.argv.slice(2), {
   alias: {k: 'key', h: 'help', r: 'recursive'},
 });
 const help = require('./commands/help').help;
+const runAllCommand = require('./utils/utils').runAll;
 
 const commands = {
   add: require('./commands/add').add,
@@ -17,13 +18,18 @@ const commands = {
   testall: require('./commands/test-all').testAll, 
 };
 
-const command = argv['_'][0];
+const onPackageCommandNames = ['api', 'check', 'link', 'publish', 'test']; 
+
+const command = argv['_'][0]; 
 if (command in commands) {
   try { 
     if(argv["help"]){ 
       console.log(help[command]);
       exitWithCode(1);
     }
+    else if (argv.all && onPackageCommandNames.includes(command)){
+      runAllCommand(process.cwd(), `grok ${process.argv.slice(2).join(' ')}`.replace('--all', ''), {});
+    }
     else if (!commands[command](argv)) { 
       console.log(help[command]);
       exitWithCode(1);

package/bin/utils/func-generation.js

@@ -106,7 +106,9 @@ const typesToAnnotation = exports.typesToAnnotation = {
   'Dayjs': 'datetime',
   'graphics': 'graphics',
   'DG.View': 'view',
+  'DG.ViewBase': 'view',
   'View': 'view',
+  'ViewBase': 'view',
   'DG.Widget': 'widget',
   'Widget': 'widget',
   'DG.FuncCall': 'funccall',
@@ -428,7 +430,7 @@ const primitives = new Set(['string', 'string[]', 'number', 'number[]', 'boolean
 function generateFunc(annotation, funcName, sep = '\n', className = '', inputs = [], isAsync = false) {
   let funcSigNature = inputs.map(e => `${e.name}: ${primitives.has(e.type ?? '') ? e.type : typesToAnnotation[e.type?.replace('[]', '') ?? ''] ? e.type : 'any'}`).join(', ');
   let funcArguments = inputs.map(e => e.name).join(', ');
-  return annotation + `export ${isAsync ? 'async ' : ''}function ${funcName}(${funcSigNature}) {${sep}  return ${className.length > 0 ? `${className}.` : ''}${funcName}(${funcArguments});${sep}}${sep.repeat(2)}`;
+  return sep + annotation + `export ${isAsync ? 'async ' : ''}function ${funcName}(${funcSigNature}) {${sep}  return ${className.length > 0 ? `${className}.` : ''}${funcName}(${funcArguments});${sep}}${sep}`;
 }
 function generateImport(className, path, sep = '\n') {
   return `import {${className}} from '${path}';${sep}`;

package/bin/utils/utils.js

@@ -27,6 +27,7 @@ exports.mapURL = mapURL;
 exports.queryWrapperTemplate = exports.queryExtension = exports.propertyTypes = exports.namespaceTemplate = exports.nameRegex = exports.nameAnnRegex = void 0;
 exports.removeScope = removeScope;
 exports.replacers = void 0;
+exports.runAll = runAll;
 exports.runScript = runScript;
 exports.scriptWrapperTemplate = exports.scriptLangExtMap = exports.scriptExtensions = void 0;
 exports.setHost = setHost;
@@ -54,7 +55,7 @@ function kebabToCamelCase(s, firstUpper = true) {
 }
 function descriptionToComment(s) {
   if (s.length === 0) return '';
-  return '//' + s + '\n';
+  return '/**\n' + s + '\n*/\n';
 }
 function spaceToCamelCase(s, firstUpper = true) {
   s = s.replace(/\s+./g, x => x[x.length - 1].toUpperCase());
@@ -180,7 +181,8 @@ const dgToTsTypeMap = exports.dgToTsTypeMap = {
   column: 'DG.Column',
   column_list: 'string[]',
   file: 'DG.FileInfo',
-  view: 'DG.View'
+  view: 'DG.View',
+  void: 'void'
 };
 const propertyTypes = exports.propertyTypes = ['bool', 'int', 'double', 'string', 'datetime', 'object', 'column', 'dataframe', 'bitset', 'cell', 'string_list', 'map'];
 const headerTags = exports.headerTags = ['name', 'description', 'help-url', 'input', 'output', 'tags', 'sample', 'language', 'returns', 'test', 'sidebar', 'condition', 'top-menu', 'environment', 'require', 'editor-for', 'schedule', 'reference', 'editor', 'meta', 'connection', 'friendlyName'];
@@ -240,7 +242,7 @@ function getScriptDescription(script, comment = '#') {
   return desc;
 }
 ;
-const dgImports = exports.dgImports = `import * as grok from 'datagrok-api/grok';\nimport * as DG from 'datagrok-api/dg';\n\n`;
+const dgImports = exports.dgImports = `import * as grok from 'datagrok-api/grok';\nimport * as DG from 'datagrok-api/dg';\n`;
 const scriptWrapperTemplate = exports.scriptWrapperTemplate = `#{FUNC_DESCRIPTION}export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {
   return await grok.functions.call('#{PACKAGE_NAMESPACE}:#{FUNC_NAME}', #{PARAMS_OBJECT});
 }`;
@@ -280,4 +282,37 @@ function setHost(host, configFile) {
     process.env.HOST = configFile.default;
     console.log('Environment variable `HOST` is set to', configFile.default);
   }
+}
+async function runAll(packagesDir, command, options, packagesToLoad = ['all']) {
+  const packages = _fs.default.readdirSync(packagesDir);
+  const commandToRun = `${command} ${optionsToString(options)}`;
+  for (const packageName of packages) {
+    const packagePath = _path.default.join(...[packagesDir, packageName]);
+    const packageJsonPath = _path.default.join(...[packagesDir, packageName, 'package.json']);
+    if (_fs.default.statSync(packagePath).isDirectory() && _fs.default.existsSync(packageJsonPath)) {
+      try {
+        console.log(`${packagePath}: ${commandToRun} - Started`);
+        await runScript(commandToRun, packagePath, options.verbose);
+        console.log(`${packagePath}: ${commandToRun} - Finished`);
+      } catch (e) {
+        console.log(`${packagePath}: ${commandToRun} - Error`);
+        break;
+      }
+    }
+  }
+  return;
+}
+function optionsToString(options) {
+  const parts = [];
+  for (const [key, value] of Object.entries(options)) {
+    if (key === '_' || key === 'all') continue;
+    if (typeof value === 'boolean') {
+      if (value) {
+        parts.push(`--${key}`);
+      }
+    } else if (value !== undefined && value !== null) {
+      parts.push(`--${key}="${value}"`);
+    }
+  }
+  return parts.join(' ');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.14.24",
+  "version": "4.14.26",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {

package/plugins/func-gen-plugin.js

@@ -14,6 +14,7 @@ const {
 } = require("../bin/utils/func-generation");
 
 const baseImport = "import * as DG from 'datagrok-api/dg';\n";
+const annotationForGeneratedFile = `/**\nThis file is auto-generated by the webpack command.\nIf you notice any changes, please push them to the repository.\nDo not edit this file manually.\n*/\n`;
 
 class FuncGeneratorPlugin {
   constructor(options = { outputPath: "./src/package.g.ts" }) {
@@ -445,7 +446,7 @@ class FuncGeneratorPlugin {
       const importStatement = imports[i];
       const exportStatement = exp[i];
       if (!content.includes(importStatement.trim()))
-        content = importStatement + content + exportStatement;
+        content = annotationForGeneratedFile + importStatement + content + exportStatement;
     }
     fs.writeFileSync(filePath, content, "utf-8");
   }