datagrok-tools 6.1.9 → 6.1.11

package/bin/utils/server-output.js

@@ -0,0 +1,127 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cellStr = cellStr;
+exports.csvCell = csvCell;
+exports.getKeys = getKeys;
+exports.printBatchOutput = printBatchOutput;
+exports.printError = printError;
+exports.printOutput = printOutput;
+/// Docs: [Grok Dapi](/docs/plans/grok-dapi/)
+
+function printOutput(data, format) {
+  if (data === null || data === undefined) {
+    if (format !== 'quiet') console.log('(empty)');
+    return;
+  }
+  const rows = Array.isArray(data) ? data : [data];
+  switch (format) {
+    case 'json':
+      console.log(JSON.stringify(data, null, 2));
+      break;
+    case 'csv':
+      printCsv(rows);
+      break;
+    case 'quiet':
+      for (const row of rows) {
+        if (typeof row === 'object' && row !== null) console.log(row.id ?? row.name ?? JSON.stringify(row));else console.log(row);
+      }
+      break;
+    default:
+      printTable(rows);
+  }
+}
+function cellStr(v) {
+  if (v === null || v === undefined) return '';
+  if (typeof v === 'object') {
+    if (v.name) return v.name;
+    if (v.id) return v.id;
+    return JSON.stringify(v).slice(0, 40);
+  }
+  return String(v);
+}
+function printTable(rows) {
+  if (!rows.length) {
+    console.log('(no results)');
+    return;
+  }
+  if (typeof rows[0] !== 'object' || rows[0] === null) {
+    for (const r of rows) console.log(r);
+    return;
+  }
+  const keys = getKeys(rows);
+  const widths = {};
+  for (const k of keys) widths[k] = k.length;
+  for (const row of rows) for (const k of keys) widths[k] = Math.max(widths[k], cellStr(row[k]).length);
+  const header = keys.map(k => k.padEnd(widths[k])).join('  ');
+  const sep = keys.map(k => '-'.repeat(widths[k])).join('  ');
+  console.log(header);
+  console.log(sep);
+  for (const row of rows) console.log(keys.map(k => cellStr(row[k]).padEnd(widths[k])).join('  '));
+}
+function printCsv(rows) {
+  if (!rows.length) return;
+  if (typeof rows[0] !== 'object' || rows[0] === null) {
+    for (const r of rows) console.log(csvCell(String(r)));
+    return;
+  }
+  const keys = getKeys(rows);
+  console.log(keys.map(csvCell).join(','));
+  for (const row of rows) console.log(keys.map(k => csvCell(cellStr(row[k]))).join(','));
+}
+function csvCell(s) {
+  return s.includes(',') || s.includes('"') || s.includes('\n') ? `"${s.replace(/"/g, '""')}"` : s;
+}
+function getKeys(rows) {
+  const seen = new Set();
+  const keys = [];
+  for (const row of rows) for (const k of Object.keys(row)) if (!seen.has(k)) {
+    seen.add(k);
+    keys.push(k);
+  }
+  return keys.slice(0, 12);
+}
+function printBatchOutput(response, format) {
+  if (format === 'json') {
+    console.log(JSON.stringify(response, null, 2));
+    return;
+  }
+  if (format === 'quiet') {
+    const s = response.summary;
+    console.log(`${s.total} total: ${s.succeeded} succeeded, ${s.failed} failed, ${s.partial} partial, ${s.skipped} skipped`);
+    return;
+  }
+
+  // table and csv: print summary then per-op rows
+  const s = response.summary;
+  console.log(`Summary: ${s.total} total  ${s.succeeded} succeeded  ${s.failed} failed  ${s.partial} partial  ${s.skipped} skipped`);
+  if (!response.results.length) return;
+  console.log('');
+  const rows = response.results.map(r => {
+    const brief = r.status === 'error' ? r.error?.error ?? 'error' : r.status === 'skipped' ? r.reason ?? 'skipped' : r.status === 'partial' ? `${r.summary?.succeeded}/${r.summary?.total} succeeded` : '';
+    return {
+      id: r.id ?? '',
+      action: r.action,
+      status: r.status,
+      detail: brief
+    };
+  });
+  if (format === 'csv') printCsv(rows);else printTable(rows);
+
+  // Write per-op errors to stderr
+  const errors = response.results.filter(r => r.status === 'error');
+  if (errors.length) process.stderr.write(JSON.stringify(errors.map(r => ({
+    id: r.id,
+    action: r.action,
+    error: r.error
+  })), null, 2) + '\n');
+}
+function printError(err) {
+  const apiErr = err?.apiError;
+  const out = apiErr ?? {
+    error: String(err?.message ?? err)
+  };
+  process.stderr.write(JSON.stringify(out, null, 2) + '\n');
+}

package/bin/utils/utils.js

@@ -4,7 +4,9 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.cacheValues = exports.absUrlRegex = exports.TemplateBuilder = void 0;
+exports.absUrlRegex = exports.TemplateBuilder = void 0;
+exports.buildJsDoc = buildJsDoc;
+exports.cacheValues = void 0;
 exports.camelCaseToKebab = camelCaseToKebab;
 exports.checkScriptLocation = checkScriptLocation;
 exports.commentMap = void 0;
@@ -58,6 +60,26 @@ function descriptionToComment(s) {
   if (s.length === 0) return '';
   return '/**\n' + s + '\n*/\n';
 }
+const JSDOC_META_KEYS = ['choices', 'suggestions', 'semType'];
+function buildJsDoc(opts) {
+  const {
+    description,
+    inputs
+  } = opts;
+  const lines = [];
+  if (description) lines.push(` * ${description}`);
+  for (const {
+    name,
+    type,
+    options = {}
+  } of inputs) {
+    const metaLines = JSDOC_META_KEYS.filter(k => options[k]).map(k => ` *   ${k}: ${options[k]}`);
+    if (!options.description && !metaLines.length) continue;
+    const desc = options.description ? ` - ${options.description}` : '';
+    lines.push(` * @param {${type}} ${name}${desc}`, ...metaLines);
+  }
+  return lines.length ? `/**\n${lines.join('\n')}\n */\n` : '';
+}
 function spaceToCamelCase(s, firstUpper = true) {
   s = s.replace(/\s+./g, x => x[x.length - 1].toUpperCase());
   return (firstUpper ? s[0].toUpperCase() : s[0].toLowerCase()) + s.slice(1);
@@ -107,6 +129,7 @@ const replacers = exports.replacers = {
   PACKAGE_DETECTORS_NAME: (s, name) => s.replace(/#{PACKAGE_DETECTORS_NAME}/g, kebabToCamelCase(name)),
   PACKAGE_NAMESPACE: (s, name) => s.replace(/#{PACKAGE_NAMESPACE}/g, name),
   FUNC_DESCRIPTION: (s, desc) => s.replace(/#{FUNC_DESCRIPTION}/g, descriptionToComment(desc)),
+  FUNC_JSDOC: (s, opts) => s.replace(/#{FUNC_JSDOC}/g, buildJsDoc(opts)),
   FUNC_NAME: (s, name) => s.replace(/#{FUNC_NAME}/g, friendlyNameToName(name)),
   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(', ')} }` : `{}`),
@@ -219,7 +242,7 @@ function getScriptOutputType(script, comment = '#') {
 }
 ;
 function getScriptInputs(script, comment = '#') {
-  const regex = new RegExp(`${comment}\\s*input:\\s?([a-z_]+)(?:<[^>]*>)?\\s+(\\w+)(?:[^{\\n]*{[^}\\n]*})?`, 'g');
+  const regex = new RegExp(`${comment}\\s*input:\\s?([a-z_]+)(?:<[^>]*>)?\\s+(\\w+)(?:[^{\\n]*\\{([^}\\n]*)\\})?`, 'g');
   const testOptional = inputAnnotation => /isOptional\s*:\s*true/.test(inputAnnotation) || /optional\s*:\s*true/.test(inputAnnotation);
   const inputAnnotations = [...script.matchAll(regex)];
   let firstTsValidOptionalIdx = inputAnnotations.length - 1;
@@ -235,12 +258,19 @@ function getScriptInputs(script, comment = '#') {
     const nullable = /nullable\s*:\s*true/.test(match[0]);
     const type = dgToTsTypeMap[match[1]] || 'any';
     const name = match[2];
+    const options = {};
+    for (const part of (match[3] ?? '').split(';')) {
+      const i = part.indexOf(':');
+      if (i < 0) continue;
+      options[part.slice(0, i).trim()] = part.slice(i + 1).trim();
+    }
     inputs.push({
       type,
       name,
       isOptional,
       undefinable,
-      nullable
+      nullable,
+      options
     });
   }
   return inputs;
@@ -254,10 +284,10 @@ function getScriptDescription(script, comment = '#') {
 }
 ;
 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}> {
+const scriptWrapperTemplate = exports.scriptWrapperTemplate = `#{FUNC_JSDOC}export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {
   return await grok.functions.call('#{PACKAGE_NAMESPACE}:#{FUNC_NAME}', #{PARAMS_OBJECT});
 }`;
-const queryWrapperTemplate = exports.queryWrapperTemplate = `#{FUNC_DESCRIPTION}export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {
+const queryWrapperTemplate = exports.queryWrapperTemplate = `#{FUNC_JSDOC}export async function #{FUNC_NAME_LOWERCASE}(#{TYPED_PARAMS}): Promise<#{OUTPUT_TYPE}> {
   return await grok.data.query('#{PACKAGE_NAMESPACE}:#{FUNC_NAME}', #{PARAMS_OBJECT});
 }`;
 const namespaceTemplate = exports.namespaceTemplate = `export namespace #{PACKAGE_NAMESPACE} {\n#{NAME}\n}`;

package/package-template/package.json

@@ -1,6 +1,6 @@
 {
   "name": "#{PACKAGE_NAME_LOWERCASE}",
-  "friendlyName": "#{PACKAGE_NAME}",
+  "friendlyName": "#{PACKAGE_FRIENDLY_NAME}",
   "version": "0.0.1",
   "description": "#{PACKAGE_NAME} package",
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "6.1.9",
+  "version": "6.1.11",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {
@@ -9,6 +9,7 @@
     "@babel/traverse": "^7.23.7",
     "@typescript-eslint/typescript-estree": "^8.31.1",
     "@typescript-eslint/visitor-keys": "^8.31.1",
+    "adm-zip": "^0.5.17",
     "archiver": "^4.0.2",
     "archiver-promise": "^1.0.0",
     "datagrok-api": "^1.26.0",
@@ -32,7 +33,11 @@
     "prepublishOnly": "babel bin --extensions .ts -d bin",
     "babel": "babel bin --extensions .ts -d bin",
     "build": "babel bin --extensions .ts -d bin",
-    "debug-source-map": "babel bin --extensions .ts -d bin --source-maps true"
+    "debug-source-map": "babel bin --extensions .ts -d bin --source-maps true",
+    "test": "vitest run --project unit",
+    "test:watch": "vitest --project unit",
+    "test:integration": "vitest run --project integration",
+    "test:all": "vitest run"
   },
   "bin": {
     "datagrok-upload": "./bin/_deprecated/upload.js",
@@ -66,16 +71,18 @@
     "@babel/preset-env": "^7.23.8",
     "@babel/preset-typescript": "7.15.0",
     "@datagrok-misc/eslint-plugin-config": "^1.0.0",
+    "@types/adm-zip": "^0.5.8",
     "@types/ignore-walk": "^4.0.3",
     "@types/inquirer": "^8.2.10",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^16.18.70",
+    "@types/node": "^18.0.0",
     "@types/papaparse": "^5.3.15",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "eslint": "^8.56.0",
     "eslint-config-google": "^0.14.0",
     "typescript": "^5.3.3",
+    "vitest": "^3.2.4",
     "webpack": "^5.89.0",
     "webpack-cli": "^5.1.4"
   }

package/vitest.config.ts

@@ -0,0 +1,25 @@
+import {defineConfig} from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    projects: [
+      {
+        test: {
+          name: 'unit',
+          environment: 'node',
+          include: ['bin/**/*.test.ts'],
+          exclude: ['bin/**/*.integration.test.ts'],
+        },
+      },
+      {
+        test: {
+          name: 'integration',
+          environment: 'node',
+          include: ['bin/**/*.integration.test.ts'],
+          testTimeout: 30_000,
+          hookTimeout: 30_000,
+        },
+      },
+    ],
+  },
+});