datagrok-tools 4.14.42 → 4.14.43

package/bin/utils/func-generation.js

@@ -3,13 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.dgAnnotationTypes = exports.FUNC_TYPES = void 0;
+exports.dgAnnotationTypes = exports.decoratorOptionToAnnotation = exports.FUNC_TYPES = void 0;
 exports.generateClassFunc = generateClassFunc;
 exports.generateExport = generateExport;
 exports.generateFunc = generateFunc;
 exports.generateImport = generateImport;
 exports.getFuncAnnotation = getFuncAnnotation;
-exports.typesToAny = exports.typesToAnnotation = exports.reservedDecorators = exports.pseudoParams = exports.headerParams = void 0;
+exports.typesToAny = exports.typesToAnnotation = exports.reservedDecorators = exports.pseudoParams = exports.primitives = exports.inputOptionsNames = exports.headerParams = void 0;
 /* eslint-disable no-unused-vars */
 /* eslint-disable valid-jsdoc */
 
@@ -20,8 +20,8 @@ let pseudoParams = exports.pseudoParams = /*#__PURE__*/function (pseudoParams) {
   pseudoParams["INPUT_TYPE"] = "inputType";
   return pseudoParams;
 }({});
-const nonMetaData = ['sidebar', 'editor', 'friendlyName', 'helpUrl', 'help-url', 'condition', 'top-menu', 'cache', 'cache.invalidateOn', 'test'];
-const decoratorOptionToAnnotation = new Map([['initialValue', 'default']]);
+const nonMetaData = ['sidebar', 'editor', 'friendlyName', 'helpUrl', 'help-url', 'condition', 'connection', 'top-menu', 'cache', 'cache.invalidateOn', 'test'];
+const decoratorOptionToAnnotation = exports.decoratorOptionToAnnotation = new Map([['initialValue', 'default'], ['helpUrl', 'help-url'], ['topMenu', 'top-menu'], ['metaUrl', 'meta.url'], ['optionsType', 'type'], ['cacheInvalidateOn', 'cache.invalidateOn'], ['scriptHandlerLanguage', 'scriptHandler.language'], ['scriptHandlerExtensions', 'scriptHandler.extensions'], ['scriptHandlerCommentStart', 'scriptHandler.commentStart'], ['scriptHandlerTemplateScript', 'scriptHandler.templateScript'], ['scriptHandlerCodeEditorMode', 'scriptHandler.codeEditorMode'], ['scriptHandlerVectorizationFunction', 'scriptHandler.vectorizationFunction']]);
 const dgAnnotationTypes = exports.dgAnnotationTypes = {
   INT: 'int',
   BIG_INT: 'bigint',
@@ -88,6 +88,7 @@ let FUNC_TYPES = exports.FUNC_TYPES = /*#__PURE__*/function (FUNC_TYPES) {
   FUNC_TYPES["FUNCTION_ANALYSIS"] = "functionAnalysis";
   FUNC_TYPES["CONVERTER"] = "converter";
   FUNC_TYPES["MODEL"] = "model";
+  FUNC_TYPES["APP_TREE_BROWSER"] = "appTreeBrowser";
   return FUNC_TYPES;
 }({});
 const typesToAnnotation = exports.typesToAnnotation = {
@@ -95,6 +96,8 @@ const typesToAnnotation = exports.typesToAnnotation = {
   'DG.DataFrame': 'dataframe',
   'Column': 'column',
   'DG.Column': 'column',
+  'Column<any>': 'column',
+  'DG.Column<any>': 'column',
   'ColumnList': 'column_list',
   'DG.ColumnList': 'column_list',
   'FileInfo': 'file',
@@ -143,7 +146,7 @@ function getFuncAnnotation(data, comment = '//', sep = '\n') {
     if (input?.options?.type) type = input?.options?.type;else if (annotationType) {
       if (isArray) type = `list<${annotationType}>`;else type = annotationType;
     } else type = 'dynamic';
-    const options = input?.options?.options ? buildStringOfOptions(input.options.options ?? {}) : '';
+    const options = input?.options?.options ? buildStringOfOptions(input.options ?? {}) : '';
     const functionName = (input.options?.name ? input?.options?.name : ` ${input.name?.replaceAll('.', '')}`)?.trim();
 
     // eslint-disable-next-line max-len
@@ -158,11 +161,11 @@ function getFuncAnnotation(data, comment = '//', sep = '\n') {
     }
   }
   if (data.meta) {
-    for (const entry of Object.entries(data.meta)) s += `${comment}meta.${entry[0]}: ${entry[1]}${sep}`;
+    for (const entry of Object.entries(data.meta)) s += `${comment}meta.${decoratorOptionToAnnotation.get(entry[0]) ?? entry[0]}: ${entry[1]}${sep}`;
   }
   for (const parameter in data) {
     // eslint-disable-next-line max-len
-    if (parameter === pseudoParams.EXTENSION || parameter === pseudoParams.INPUT_TYPE || parameter === 'meta' || parameter === 'isAsync' || parameter === 'test') continue;else if (parameter === pseudoParams.EXTENSIONS) {
+    if (parameter === pseudoParams.EXTENSION || parameter === pseudoParams.INPUT_TYPE || parameter === 'meta' || parameter === 'isAsync' || parameter === 'test' || parameter === 'actualTypeObj') continue;else if (parameter === pseudoParams.EXTENSIONS) {
       if (isFileViewer) continue;
       s += `${comment}meta.ext: ${data[parameter]}${sep}`;
     } else if (!headerParams.includes(parameter)) {
@@ -180,9 +183,10 @@ function getFuncAnnotation(data, comment = '//', sep = '\n') {
   }
   return s;
 }
-function buildStringOfOptions(options) {
+const inputOptionsNames = exports.inputOptionsNames = ['semType', 'category', 'optional', 'editor', 'nullable', 'separators', 'choices', 'format', 'min', 'max', 'caption', 'description', 'initialValue', 'viewer', 'units', 'type', 'optionsType', 'step', 'meta.url', 'metaUrl'];
+function buildStringOfOptions(input) {
   const optionsInString = [];
-  for (const [key, value] of Object.entries(options ?? {})) {
+  for (const [key, value] of Object.entries(input.options ?? {})) {
     let val = value;
     let option = key;
     option = decoratorOptionToAnnotation.get(option) ?? option;
@@ -225,6 +229,21 @@ const reservedDecorators = exports.reservedDecorators = {
     },
     genFunc: generateClassFunc
   },
+  appTreeBrowser: {
+    metadata: {
+      tags: [],
+      role: FUNC_TYPES.APP_TREE_BROWSER,
+      inputs: [{
+        type: 'dynamic',
+        name: 'treeNode'
+      }, {
+        type: 'view',
+        name: 'browseView'
+      }],
+      outputs: []
+    },
+    genFunc: generateFunc
+  },
   fileExporter: {
     metadata: {
       tags: [FUNC_TYPES.FILE_EXPORTER],
@@ -435,16 +454,16 @@ const reservedDecorators = exports.reservedDecorators = {
 function generateClassFunc(annotation, className, sep = '\n') {
   return annotation + `export function _${className}() {${sep}  return new ${className}();${sep}}${sep.repeat(2)}`;
 }
-const primitives = new Set(['string', 'string[]', 'number', 'number[]', 'boolean', 'boolean[]']);
+const primitives = exports.primitives = new Set(['string', 'string[]', 'number', 'number[]', 'boolean', 'boolean[]', 'any', 'Uint8Array', 'Uint8Array[]', 'void']);
 
 /** Generates a DG function. */
-function generateFunc(annotation, funcName, sep = '\n', className = '', inputs = [], isAsync = false) {
+function generateFunc(annotation, funcName, sep = '\n', className = '', inputs = [], output, isAsync = false) {
   // eslint-disable-next-line max-len
   const funcSigNature = inputs.map(e => `${e.name}${e.optional ? '?' : ''}: ${primitives.has(e.type ?? '') && !typesToAny.includes(e.type ?? '') ? e.type : typesToAnnotation[e.type?.replace('[]', '') ?? ''] && !typesToAny.includes(e.type ?? '') ? e.type : 'any'}`).join(', ');
   const funcArguments = inputs.map(e => e.name).join(', ');
-
+  const returnType = output ? primitives.has(output) ? !isAsync ? `: ${output} ` : `: Promise<${output}> ` : !isAsync ? `: any ` : `: Promise<any> ` : '';
   // eslint-disable-next-line max-len
-  return sep + annotation + `export ${isAsync ? 'async ' : ''}function ${funcName}(${funcSigNature}) {${sep}  return ${className.length > 0 ? `${className}.` : ''}${funcName}(${funcArguments});${sep}}${sep}`;
+  return sep + annotation + `export ${isAsync ? 'async ' : ''}function ${funcName}(${funcSigNature}) ${returnType}{${sep}  ${output !== 'void' ? 'return ' : ''}${className.length > 0 ? `${className}.` : ''}${funcName}(${funcArguments});${sep}}${sep}`;
 }
 function generateImport(className, path, sep = '\n') {
   return `import {${className}} from '${path}';${sep}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.14.42",
+  "version": "4.14.43",
   "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

@@ -11,6 +11,7 @@ const {
   generateExport,
   typesToAnnotation,
   dgAnnotationTypes,
+  decoratorOptionToAnnotation,
 } = require('../bin/utils/func-generation');
 
 const {api} = require('../bin/commands/api');
@@ -19,6 +20,30 @@ const baseImport = 'import * as DG from \'datagrok-api/dg\';\n';
 // eslint-disable-next-line max-len
 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`;
 
+
+const inputOptionsNames = [
+  'semType',
+  'category',
+  'optional',
+  'editor',
+  'nullable',
+  'separators',
+  'choices',
+  'format',
+  'min',
+  'max',
+  'caption',
+  'description',
+  'initialValue',
+  'viewer',
+  'units',
+  'optionsType',
+  'step',
+  'meta.url',
+  'metaUrl',
+];
+
+
 class FuncGeneratorPlugin {
   constructor(options = {outputPath: './src/package.g.ts'}) {
     this.options = options;
@@ -130,9 +155,19 @@ class FuncGeneratorPlugin {
       ...(reservedDecorators[name]['metadata']['tags'] ?? []),
       ...(decoratorOptions.get('tags') ?? []),
     ]);
+
+    if ((reservedDecorators[name]['metadata']['role']?.length > 0) ) {
+      if (!decoratorOptions.get('meta'))
+        decoratorOptions.set('meta', {roles: reservedDecorators[name]['metadata']['role']});
+      else if (!decoratorOptions.get('meta')['role']) 
+        decoratorOptions.get('meta')['role'] = reservedDecorators[name]['metadata']['role'];
+      delete reservedDecorators[name]['metadata']['role'];
+    }
+
     const functionParams =
       node?.type === 'MethodDefinition' ? this._readMethodParamas(node) : [];
     const annotationByReturnObj = node?.type === 'MethodDefinition' ? this._readOutputsFromReturnType(node) : undefined;
+    
     const isMethodAsync = this._isMethodAsync(node);
     const importString = generateImport(
       node?.type === 'MethodDefinition' ? className : identifierName,
@@ -151,6 +186,15 @@ class FuncGeneratorPlugin {
       ...{inputs: functionParams},
       ...{isAsync: isMethodAsync},
     };
+
+    let actualType = undefined;
+    if (annotationByReturnObj?.length > 1)
+      actualType = 'any';
+    else if (annotationByReturnObj?.length === 1 && annotationByReturnObj[0]?.actualType)
+      actualType = annotationByReturnObj[0].actualType;
+    else if (funcAnnotaionOptions.outputs?.length === 0)
+      actualType = 'void';
+
     if (!funcAnnotaionOptions.name) funcAnnotaionOptions.name = identifierName;
     functions.push(
       reservedDecorators[name]['genFunc'](
@@ -159,6 +203,7 @@ class FuncGeneratorPlugin {
         '\n',
         className ?? '',
         functionParams,
+        actualType,
         funcAnnotaionOptions.isAsync ?? false,
       ),
     );
@@ -188,11 +233,28 @@ class FuncGeneratorPlugin {
     return results;
   }
 
-  _readDecoratorOptions(properties) {
+  _readDecoratorOptions(properties, readForParams= false) {
     const resultMap = new Map();
-
-    for (const prop of properties)
-      resultMap.set(prop.key.name ?? prop.key.value, this._evalLiteral(prop.value));
+    let resultObj = undefined;
+    // for (const prop of properties)
+    //   resultMap.set(prop.key.name ?? prop.key.value, this._evalLiteral(prop.value));
+    const optionsToAdd = new Map();
+    for (const prop of properties) {
+      const key = decoratorOptionToAnnotation.get(prop.key.name ?? prop.key.value ?? '') ?? prop.key.name ?? prop.key.value;
+      if (!readForParams && key === 'result')
+        resultObj = this._evalLiteral(prop.value);
+      else if (readForParams && inputOptionsNames.includes( prop.key.name ?? prop.key.value)) 
+        optionsToAdd.set(key, this._evalLiteral(prop.value));
+      else
+        resultMap.set(key, this._evalLiteral(prop.value));
+      
+    }
+    
+    if (optionsToAdd.size > 0)
+      resultMap.set('options', {...(resultMap.get('options') ?? {}), ...Object.fromEntries(optionsToAdd)});
+    if (resultObj)
+      resultMap.set('outputs', [resultObj]);
+      
     return resultMap;
   }
 
@@ -228,11 +290,10 @@ class FuncGeneratorPlugin {
         param.decorators?.length > 0 ?
           Object.fromEntries(
             this._readDecoratorOptions(
-              param.decorators[0]?.expression?.arguments[0].properties,
-            ),
+              param.decorators[0]?.expression?.arguments[0].properties, true),
           ) :
           undefined;
-
+        
       // Commented code finds value by default of function's variable
       // let defaultValue = undefined;
       if (baseParam.type === 'AssignmentPattern') {
@@ -241,7 +302,6 @@ class FuncGeneratorPlugin {
         baseParam = baseParam?.left;
       }
       const optional = param.optional;
-
       if (baseParam.type === 'RestElement' || baseParam.type === 'Identifier') {
         let name =
           baseParam.type === 'RestElement' ?
@@ -297,6 +357,7 @@ class FuncGeneratorPlugin {
 
       //   return { name: name, type: type, options: options };
       // }
+
       return {name: 'value', type: 'any', options: undefined, optional: optional};
     });
     return params;
@@ -380,9 +441,9 @@ class FuncGeneratorPlugin {
           nodeAnnotation?.elementType?.typeName?.right?.name;
       } 
     }
-    resultType = typesToAnnotation[resultType];
-    if (isArray && resultType) resultType = `list<${resultType}>`;
-    return resultType ?? 'dynamic';
+    let anotationType = typesToAnnotation[resultType];
+    if (isArray && anotationType) anotationType = `list<${anotationType}>`;
+    return [anotationType ?? 'dynamic', `${resultType}${isArray? '[]': ''}` ?? 'any'];
   }
 
   _readOutputsFromReturnType(node) {
@@ -402,9 +463,14 @@ class FuncGeneratorPlugin {
     if (annotation?.type === 'TSTypeLiteral') 
       results = this._readOutputsFromReturnTypeObject(annotation);
     else {
-      const resultType = this._readReturnType(annotation);
-      if (resultType !== 'void')
-        results.push({name: 'result', type: resultType});
+      const [annotationType, resultType] = this._readReturnType(annotation);
+      if (annotationType !== 'void') {
+        results.push({
+          name: 'result', 
+          type: annotationType,
+          actualType: resultType,
+        });
+      }
     }
     return results;
   }
@@ -413,9 +479,11 @@ class FuncGeneratorPlugin {
     let i = 0;
     const results = [];
     for (const member of node.members) {
+      const [annotationType, resultType] = this._readReturnType(annotation);
       results.push({
         name: member?.key?.name ?? `result${i}`,
-        type: this._readReturnType(member.typeAnnotation.typeAnnotation),
+        type: annotationType,
+        actualType: resultType,
       });
       i++;
     }