datagrok-tools 4.14.17 → 4.14.19

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Datagrok-tools changelog
 
+## 4.14.19 (2025-06-23)
+
+### Features
+
+* Grok Check added header tag validation
+* Grok Api added optional parameters
+
+
 ## 4.14.14 (2025-06-16)
 
 ### Features

package/bin/commands/api.js

@@ -43,7 +43,7 @@ function generateQueryWrappers() {
       const name = utils.getScriptName(q, utils.commentMap[utils.queryExtension]);
       if (!name) continue;
       checkNameColision(name);
-      const tb = new utils.TemplateBuilder(utils.queryWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package?.name ?? '');
+      const tb = new utils.TemplateBuilder(utils.queryWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package?.friendlyName ?? '');
       const description = utils.getScriptDescription(q, utils.commentMap[utils.queryExtension]);
       const inputs = utils.getScriptInputs(q, utils.commentMap[utils.queryExtension]);
       const outputType = utils.getScriptOutputType(q, utils.commentMap[utils.queryExtension]);
@@ -78,7 +78,7 @@ function generateScriptWrappers() {
       if (!name) continue;
       const description = utils.getScriptDescription(script);
       checkNameColision(name);
-      const tb = new utils.TemplateBuilder(utils.scriptWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package.name);
+      const tb = new utils.TemplateBuilder(utils.scriptWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package?.friendlyName ?? '');
       const inputs = utils.getScriptInputs(script);
       const outputType = utils.getScriptOutputType(script);
       tb.replace('PARAMS_OBJECT', inputs).replace('TYPED_PARAMS', inputs).replace('FUNC_DESCRIPTION', description).replace('OUTPUT_TYPE', outputType);
@@ -111,7 +111,7 @@ function generateFunctionWrappers() {
         outputType = utils.dgToTsTypeMap[outputAnnotation[1]] ?? 'any';
       }
       checkNameColision(name);
-      const tb = new utils.TemplateBuilder(utils.scriptWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package?.name ?? '').replace('PARAMS_OBJECT', annotationInputs).replace('FUNC_DESCRIPTION', description).replace('TYPED_PARAMS', annotationInputs).replace('OUTPUT_TYPE', outputType);
+      const tb = new utils.TemplateBuilder(utils.scriptWrapperTemplate).replace('FUNC_NAME', name).replace('FUNC_NAME_LOWERCASE', name).replace('PACKAGE_NAMESPACE', _package?.friendlyName ?? '').replace('PARAMS_OBJECT', annotationInputs).replace('FUNC_DESCRIPTION', description).replace('TYPED_PARAMS', annotationInputs).replace('OUTPUT_TYPE', outputType);
       wrappers.push(tb.build(1));
     }
   }
@@ -138,6 +138,7 @@ function api(args) {
   _package = JSON.parse(_fs.default.readFileSync(packagePath, {
     encoding: 'utf-8'
   }));
+  if (_package.friendlyName) _package.friendlyName = _package.friendlyName.replaceAll(' ', '');
   const nOptions = Object.keys(args).length - 1;
   if (args['_'].length !== 1 || nOptions > 0) return false;
   if (!utils.isPackageDir(process.cwd())) {

package/bin/commands/check.js

@@ -308,7 +308,7 @@ function checkFuncSignatures(packagePath, files) {
       encoding: 'utf-8'
     });
     const functions = getFuncMetadata(content, file.split('.').pop() ?? 'ts');
-    for (const f of functions) {
+    for (const f of functions.meta) {
       const paramsCheck = checkFunctions.params(f);
       if (!paramsCheck.value) warnings.push(`File ${file}, function ${f.name}:\n${paramsCheck.message}`);
       const roles = functionRoles.filter(role => f.tags?.includes(role));
@@ -327,6 +327,9 @@ function checkFuncSignatures(packagePath, files) {
       if (f.cache) if (!utils.cacheValues.includes(f.cache)) errors.push(`File ${file}, function ${f.name}: unsupposed variable for cache : ${f.cache}`);
       if (f.invalidateOn) if (!utils.isValidCron(f.invalidateOn)) errors.push(`File ${file}, function ${f.name}: unsupposed variable for invalidateOn : ${f.invalidateOn}`);
     }
+    functions.warnings.forEach(e => {
+      warnings.push(`${e} In the file: ${file}.`);
+    });
   }
   for (const [name, files] of namesInFiles) {
     if (files.length > 1) errors.push(`Duplicate names ('${name}'): \n  ${files.join('\n  ')}`);
@@ -515,6 +518,7 @@ function warn(warnings) {
 }
 function getFuncMetadata(script, fileExtention) {
   const funcData = [];
+  const warnings = [];
   let isHeader = false;
   let data = {
     name: '',
@@ -528,6 +532,10 @@ function getFuncMetadata(script, fileExtention) {
     if (match) {
       if (!isHeader) isHeader = true;
       const param = match[1];
+      if (!utils.headerTags.includes(param) && !param.includes('meta.')) {
+        warnings.push(`Unknown header tag: ${param},`);
+        continue;
+      }
       if (param === 'name') data.name = line.match(utils.nameAnnRegex)?.[2]?.toLocaleLowerCase();else if (param === 'description') data.description = match[2];else if (param === 'input') {
         data.inputs.push({
           type: match[2],
@@ -560,5 +568,8 @@ function getFuncMetadata(script, fileExtention) {
       }
     }
   }
-  return funcData;
+  return {
+    meta: funcData,
+    warnings
+  };
 }

package/bin/commands/help.js

@@ -106,7 +106,8 @@ Options:
 const HELP_PUBLISH = `
 Usage: grok publish [host]
 
-Upload a package
+Uploads a package
+Checks for errors before publishing — the package won't be published if there are any.
 
 Options:
 [--build|--rebuild] [--debug|--release] [-k | --key] [--suffix] [--all] [--refresh] [--link]
@@ -114,6 +115,7 @@ Options:
 --all             Publish all available packages 
 --refresh         Publish all available already loaded packages 
 --link  	        Link the package to local utils
+--skip-check      Skip check stage 
 
 Running \`grok publish\` is the same as running \`grok publish defaultHost --build --debug\`
 `;
@@ -124,6 +126,7 @@ Options:
 [-r | --recursive]
 
 --recursive       Check all packages in the current directory
+--soft            Even if an error occurs, it doesn't throw an exception
 
 Check package content (function signatures, import statements of external modules, etc.)
 `;

package/bin/utils/utils.js

@@ -109,7 +109,7 @@ const replacers = exports.replacers = {
   FUNC_NAME_LOWERCASE: (s, name) => s.replace(/#{FUNC_NAME_LOWERCASE}/g, friendlyNameToName(name, false)),
   PARAMS_OBJECT: (s, params) => s.replace(/#{PARAMS_OBJECT}/g, params.length ? `{ ${params.map(p => p.name).join(', ')} }` : `{}`),
   OUTPUT_TYPE: (s, type) => s.replace(/#{OUTPUT_TYPE}/g, type),
-  TYPED_PARAMS: (s, params) => s.replace(/#{TYPED_PARAMS}/g, params.map(p => `${p.name}: ${p.type}`).join(', '))
+  TYPED_PARAMS: (s, params) => s.replace(/#{TYPED_PARAMS}/g, params.map(p => `${p.name}${p.isOptional ? '?' : ''}: ${p.type}`).join(', '))
 };
 class TemplateBuilder {
   static sep = '\n';
@@ -185,10 +185,10 @@ const dgToTsTypeMap = exports.dgToTsTypeMap = {
 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'];
 const fileParamRegex = exports.fileParamRegex = {
-  py: new RegExp(`^\#\\s*((?:${headerTags.join('|')})[^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`),
-  ts: new RegExp(`^\/\/\\s*((?:${headerTags.join('|')})[^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`),
-  js: new RegExp(`^\/\/\\s*((?:${headerTags.join('|')})[^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`),
-  sql: new RegExp(`^--\\s*((?:${headerTags.join('|')})[^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`)
+  py: new RegExp(`^\#\\s*([^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`),
+  ts: new RegExp(`^\/\/\\s*([^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`),
+  js: new RegExp(`^\/\/\\s*([^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`),
+  sql: new RegExp(`^--\\s*([^:]*): *([^\\s\\[\\{]+) ?([^\\s\\[\\{]+)?[^\\n]*$`)
 };
 const nameAnnRegex = exports.nameAnnRegex = /\s*(name[^:]*): ([^\n\r\[\{]+)/;
 const nameRegex = exports.nameRegex = /(?:|(?:static)(?:export )(?:async ))\s+function\s+([a-zA-Z_][a-zA-Z0-9_$]*)\s*\((.*?).*/;
@@ -201,14 +201,16 @@ function getScriptOutputType(script, comment = '#') {
 }
 ;
 function getScriptInputs(script, comment = '#') {
-  const regex = new RegExp(`${comment}\\s*input:\\s?([a-z_]+)\\s+(\\w+)`, 'g');
+  const regex = new RegExp(`${comment}\\s*input:\\s?([a-z_]+)\\s+(\\w+)(?:[^{\\n]*{[^}\\n]*})?`, 'g');
   const inputs = [];
   for (const match of script.matchAll(regex)) {
+    const isOptional = /isOptional\s*:\s*true/.test(match[0]);
     const type = dgToTsTypeMap[match[1]] || 'any';
     const name = match[2];
     inputs.push({
       type,
-      name
+      name,
+      isOptional
     });
   }
   return inputs;

package/package-template/package.json

@@ -10,7 +10,7 @@
     "@datagrok-libraries/utils": "^4.5.7"
   },
   "devDependencies": {
-    "datagrok-tools": "^4.14.10",
+    "datagrok-tools": "^4.14.18",
     "webpack": "^5.95.0",
     "webpack-cli": "^5.1.4"
   },

package/package.json

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