datagrok-tools 6.1.9 → 6.1.11

package/bin/commands/help.js

@@ -13,7 +13,7 @@ Commands:
     add         Add an object template
     api         Create wrapper functions
     build       Build a package or multiple packages
-    check       Check package content (function signatures, etc.)
+    check       Check package content (function signatures, etgc.)
     claude      Launch Claude Code in a Datagrok dev container
     config      Create and manage config files
     create      Create a package
@@ -26,6 +26,7 @@ Commands:
     test        Run package tests
     testall     Run packages tests
     migrate     Migrate legacy tags to meta.role
+    server (s)  Manage a Datagrok server (list/get/delete entities, run functions)
 
 To get help on a particular command, use:
     grok <command> --help
@@ -343,22 +344,95 @@ Examples:
   grok run https://my.datagrok.ai/api --key abc123
 `;
 const HELP_REPORT = `
-Usage: grok report <subcommand> <instance> <id>
+Usage: grok report <subcommand> [args]
 
 Manage Datagrok user error reports
 
 Subcommands:
     fetch    Download a report zip from a managed instance
+    read     Normalize a report (zip or json) into one JSON object on stdout
     resolve  Mark a report as resolved
     ticket   Create a JIRA ticket for a report via the Datlas API
 
+Read flags:
+    --extract-screenshot <path>  Write the screenshot binary to <path>
+    --extract-d42 <dir>          Unpack .d42 sidecar tables into <dir>
+    --extract-actions            Write a sibling <stem>_actions.json
+
 Examples:
-  grok report fetch dev 1528         Download report #1528 from the 'dev' instance
-  grok report resolve dev 1528       Resolve report #1528 on the 'dev' instance
+  grok report fetch dev 1528             Download report #1528 from the 'dev' instance
+  grok report read /tmp/report.zip       Print normalized JSON for a local zip
+  grok report read /tmp/report.json      Print normalized JSON for a raw report.json
+  grok report read dev 1528              Fetch + normalize report #1528 from 'dev'
+  grok report read /tmp/report.zip --extract-screenshot ./shot.png
+  grok report resolve dev 1528           Resolve report #1528 on the 'dev' instance
   grok report ticket dev <report-uuid>   Create a JIRA ticket for a report
 
 The instance name must match a server alias in ~/.grok/config.yaml.
 `;
+const HELP_SERVER = `
+Usage: grok server <entity> <verb> [args] [options]
+       grok s <entity> <verb> [args] [options]
+
+Manage a Datagrok server from the command line.
+
+Entities:
+  users, groups, functions, connections, queries, scripts, packages, reports, files, tables
+
+Verbs:
+  list      List entities
+  get       Get a single entity by ID or name
+  delete    Delete an entity by ID
+
+Special commands:
+  grok s functions run <Name:func(args)>             Call a function
+  grok s functions list [--type <t>] [--language <l>] [--package <p>] [--filter <expr>]
+                                                     Type: script|query|function|package; language applies to scripts
+  grok s files list [path] [-r]                      List files (recursive with -r)
+  grok s shares add <entity> <group>[,<group>...] [--access View|Edit]
+                                                     Share an entity with groups
+  grok s shares list <entity-id>                     List who an entity (UUID) is shared with
+  grok s users save --json user.json                 Create or update a user from JSON
+  grok s users block <id-or-login>                   Block a user from the platform
+  grok s users unblock <id-or-login>                 Unblock a previously blocked user
+  grok s groups save --json group.json [--save-relations]
+                                                     Create or update a group from JSON
+  grok s connections save --json conn.json [--save-credentials]
+                                                     Create or update a connection from JSON
+  grok s connections test <id-or-name>               Test connectivity of an existing connection
+  grok s connections test --json conn.json           Test connectivity of a connection defined in JSON
+  grok s tables upload <name> <file.csv>             Upload a CSV as a Datagrok table
+  grok s tables download <name-or-id> [-O <file>]    Download a table as CSV (stdout by default)
+  grok s raw <METHOD> <path>                         Hit any API endpoint
+  grok s describe <entity-type>                      Show entity JSON schema
+
+Options:
+  --host <alias|url>    Server alias from config or full URL
+  --output <format>     Output format: table (default), json, csv, quiet
+  --filter <text>       Smart filter expression
+  --limit <n>           Page size (default: 50)
+  --offset <n>          Start offset (default: 0)
+  -r, --recursive       Recursive (for files list)
+  --json <file>         Read function parameters from JSON file
+
+Examples:
+  grok s users list
+  grok s connections list --filter "PostgreSQL" --output json
+  grok s connections get <id>
+  grok s connections delete <id>
+  grok s connections save --json conn.json --save-credentials
+  grok s connections test "JohnDoe:MyConnection"
+  grok s connections test --json conn.json
+  grok s users save --json user.json
+  grok s groups save --json group.json --save-relations
+  grok s shares add "JohnDoe:MyConnection" Chemists,Admins --access Edit
+  grok s shares list <entity-uuid>
+  grok s functions run 'Chem:smilesToMw("ccc")'
+  grok s files list "System:AppData" -r
+  grok s raw GET /api/users/current
+  grok s describe connections
+  grok s users list --host dev
+`;
 const help = exports.help = {
   add: HELP_ADD,
   api: HELP_API,
@@ -376,5 +450,7 @@ const help = exports.help = {
   test: HELP_TEST,
   testall: HELP_TESTALL,
   migrate: HELP_MIGRATE,
+  server: HELP_SERVER,
+  s: HELP_SERVER,
   help: HELP
 };

package/bin/commands/report.js

@@ -12,11 +12,14 @@ var color = _interopRequireWildcard(require("../utils/color-utils"));
 var _testUtils = require("../utils/test-utils");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 const fetch = require('node-fetch');
+const AdmZip = require('adm-zip');
 async function report(args) {
   const subcommand = args._[1];
   switch (subcommand) {
     case 'fetch':
       return await handleFetch(args);
+    case 'read':
+      return await handleRead(args);
     case 'resolve':
       return await handleResolve(args);
     case 'ticket':
@@ -25,6 +28,53 @@ async function report(args) {
       return false;
   }
 }
+async function fetchReportMeta(url, token, number) {
+  const resp = await fetch(`${url}/reports?text=number%3D${encodeURIComponent(number)}`, {
+    headers: {
+      Authorization: token
+    }
+  });
+  if (!resp.ok) return null;
+  const arr = await resp.json();
+  if (!Array.isArray(arr) || arr.length === 0) return null;
+  return arr[0];
+}
+async function fetchReportBundle(instance, number) {
+  const {
+    url,
+    key
+  } = (0, _testUtils.getDevKey)(instance);
+  const token = await (0, _testUtils.getToken)(url, key);
+  const byNumberResp = await fetch(`${url}/reports/by-number/${encodeURIComponent(number)}/zip`, {
+    headers: {
+      Authorization: token
+    }
+  });
+  if (byNumberResp.ok) {
+    const zipBuffer = await byNumberResp.buffer();
+    const metaJson = await fetchReportMeta(url, token, number);
+    return {
+      zipBuffer,
+      metaJson
+    };
+  }
+  if (byNumberResp.status !== 404 && byNumberResp.status !== 405) throw new Error(`HTTP ${byNumberResp.status} from /reports/by-number/${number}/zip`);
+  const metaJson = await fetchReportMeta(url, token, number);
+  if (metaJson == null) throw new Error(`Report #${number} not found`);
+  const reportId = metaJson.id || metaJson.Id;
+  if (!reportId) throw new Error('Report found but has no id field');
+  const downloadResp = await fetch(`${url}/reports/${reportId}/zip`, {
+    headers: {
+      Authorization: token
+    }
+  });
+  if (!downloadResp.ok) throw new Error(`Report download failed (HTTP ${downloadResp.status})`);
+  const zipBuffer = await downloadResp.buffer();
+  return {
+    zipBuffer,
+    metaJson
+  };
+}
 async function handleFetch(args) {
   const instance = args._[2];
   const number = args._[3];
@@ -33,49 +83,194 @@ async function handleFetch(args) {
     return false;
   }
   try {
+    console.log(`Fetching report #${number}...`);
     const {
-      url,
-      key
-    } = (0, _testUtils.getDevKey)(instance);
-    const token = await (0, _testUtils.getToken)(url, key);
-    console.log(`Searching for report #${number}...`);
-    const searchResp = await fetch(`${url}/reports?text=number%3D${encodeURIComponent(number)}`, {
-      headers: {
-        Authorization: token
-      }
-    });
-    if (!searchResp.ok) {
-      color.error(`Report search failed (HTTP ${searchResp.status})`);
-      return false;
+      zipBuffer,
+      metaJson
+    } = await fetchReportBundle(instance, number);
+    const outputPath = _path.default.join(_os.default.tmpdir(), `report_${instance}_${number}.zip`);
+    _fs.default.writeFileSync(outputPath, zipBuffer);
+    if (metaJson != null) {
+      const metaPath = outputPath.replace('.zip', '_meta.json');
+      _fs.default.writeFileSync(metaPath, JSON.stringify(metaJson, null, 2));
     }
-    const results = await searchResp.json();
-    if (!Array.isArray(results) || results.length === 0) {
-      color.error(`Report #${number} not found`);
-      return false;
+    color.success(`Report saved to: ${outputPath}`);
+    console.log(outputPath);
+    return true;
+  } catch (err) {
+    color.error(`Error: ${err.message}`);
+    return false;
+  }
+}
+function looksLikePath(s) {
+  return s.includes('/') || s.includes('\\') || /\.(zip|json)$/i.test(s) || _fs.default.existsSync(s);
+}
+function loadFromZip(z) {
+  const entries = z.getEntries();
+  const reportEntry = entries.find(e => e.entryName.toLowerCase().endsWith('report.json'));
+  if (reportEntry == null) {
+    const names = entries.map(e => e.entryName).join(', ');
+    throw new Error(`report.json not found in zip. Contents: ${names}`);
+  }
+  const data = JSON.parse(reportEntry.getData().toString('utf-8'));
+  const d42Names = entries.map(e => e.entryName).filter(n => n.toLowerCase().endsWith('.d42'));
+  return {
+    data,
+    zip: z,
+    d42Names
+  };
+}
+function loadFromBuffer(buf) {
+  try {
+    const z = new AdmZip(buf);
+    return loadFromZip(z);
+  } catch {
+    const text = buf.toString('utf-8');
+    return {
+      data: JSON.parse(text),
+      zip: null,
+      d42Names: []
+    };
+  }
+}
+function loadFromPath(p) {
+  if (p.toLowerCase().endsWith('.json')) {
+    const text = _fs.default.readFileSync(p, 'utf-8');
+    return {
+      data: JSON.parse(text),
+      zip: null,
+      d42Names: []
+    };
+  }
+  return loadFromBuffer(_fs.default.readFileSync(p));
+}
+function unwrapEnvelope(data) {
+  if (data && typeof data === 'object' && '#type' in data && 'data' in data && typeof data.data === 'object' && data.data != null) {
+    const meta = {};
+    if (data.id != null) meta.id = data.id;
+    if (data.createdOn != null) meta.createdOn = data.createdOn;
+    if (data['#type'] != null) meta['#type'] = data['#type'];
+    return {
+      meta,
+      body: data.data
+    };
+  }
+  return {
+    meta: {},
+    body: data
+  };
+}
+function loadSidecar(inputPath) {
+  const stem = inputPath.replace(/\.[^./\\]+$/, '');
+  const sidecar = `${stem}_meta.json`;
+  if (sidecar !== inputPath && _fs.default.existsSync(sidecar)) return JSON.parse(_fs.default.readFileSync(sidecar, 'utf-8'));
+  return null;
+}
+function ensureParentDir(p) {
+  const dir = _path.default.dirname(p);
+  if (dir && dir !== '.' && !_fs.default.existsSync(dir)) _fs.default.mkdirSync(dir, {
+    recursive: true
+  });
+}
+function extractScreenshot(zip, body, outPath) {
+  if (zip != null) {
+    const entries = zip.getEntries();
+    const e = entries.find(x => x.entryName.toLowerCase().endsWith('screenshot.png'));
+    if (e != null) {
+      ensureParentDir(outPath);
+      _fs.default.writeFileSync(outPath, e.getData());
+      return true;
     }
-    const reportData = results[0];
-    const reportId = reportData.id || reportData.Id;
-    if (!reportId) {
-      color.error('Report found but has no id field');
+  }
+  const b64 = body && body.screenshot;
+  if (typeof b64 === 'string' && b64.length > 0) {
+    const stripped = b64.includes(',') ? b64.slice(b64.indexOf(',') + 1) : b64;
+    try {
+      const buf = Buffer.from(stripped, 'base64');
+      ensureParentDir(outPath);
+      _fs.default.writeFileSync(outPath, buf);
+      return true;
+    } catch {
       return false;
     }
-    console.log(`Downloading report ${reportId}...`);
-    const downloadResp = await fetch(`${url}/reports/${reportId}/zip`, {
-      headers: {
-        Authorization: token
+  }
+  return false;
+}
+function extractD42(zip, names, outDir) {
+  if (zip == null || names.length === 0) return [];
+  _fs.default.mkdirSync(outDir, {
+    recursive: true
+  });
+  const written = [];
+  for (var name of names) {
+    const entry = zip.getEntry(name);
+    if (entry == null) continue;
+    const out = _path.default.join(outDir, _path.default.basename(name));
+    _fs.default.writeFileSync(out, entry.getData());
+    written.push(out);
+  }
+  return written;
+}
+async function handleRead(args) {
+  const positional = args._.slice(2);
+  if (positional.length === 0) {
+    color.error('Usage: grok report read <path> | <instance> <number>');
+    return false;
+  }
+  const screenshotOut = args['extract-screenshot'];
+  const d42Dir = args['extract-d42'];
+  const extractActions = args['extract-actions'] === true;
+  try {
+    let loaded;
+    let sidecarMeta = null;
+    let inputPath = null;
+    let networkBase = null;
+    if (positional.length >= 2 && !looksLikePath(positional[0])) {
+      const [instance, number] = positional;
+      const bundle = await fetchReportBundle(instance, number);
+      loaded = loadFromBuffer(bundle.zipBuffer);
+      sidecarMeta = bundle.metaJson;
+      networkBase = _path.default.join(_os.default.tmpdir(), `report_${instance}_${number}`);
+    } else {
+      inputPath = _path.default.resolve(positional[0]);
+      if (!_fs.default.existsSync(inputPath)) {
+        color.error(`File not found: ${inputPath}`);
+        return false;
       }
-    });
-    if (!downloadResp.ok) {
-      color.error(`Report download failed (HTTP ${downloadResp.status})`);
-      return false;
+      loaded = loadFromPath(inputPath);
+      sidecarMeta = loadSidecar(inputPath);
     }
-    const buffer = await downloadResp.buffer();
-    const outputPath = _path.default.join(_os.default.tmpdir(), `report_${instance}_${number}.zip`);
-    _fs.default.writeFileSync(outputPath, buffer);
-    const metaPath = outputPath.replace('.zip', '_meta.json');
-    _fs.default.writeFileSync(metaPath, JSON.stringify(reportData, null, 2));
-    color.success(`Report saved to: ${outputPath}`);
-    console.log(outputPath);
+    const {
+      meta: envelopeMeta,
+      body
+    } = unwrapEnvelope(loaded.data);
+    const meta = Object.assign({}, envelopeMeta, sidecarMeta || {});
+    const output = {
+      meta,
+      ...body
+    };
+    const files = {};
+    if (screenshotOut) {
+      if (extractScreenshot(loaded.zip, body, screenshotOut)) {
+        files.screenshot = screenshotOut;
+        output.screenshot = screenshotOut;
+      }
+    }
+    if (d42Dir) {
+      const written = extractD42(loaded.zip, loaded.d42Names, d42Dir);
+      if (written.length > 0) files.d42 = written;
+    }
+    if (extractActions && Array.isArray(body && body.actions)) {
+      const stem = inputPath != null ? inputPath.replace(/\.[^./\\]+$/, '') : networkBase;
+      if (stem != null) {
+        const actionsPath = `${stem}_actions.json`;
+        _fs.default.writeFileSync(actionsPath, JSON.stringify(body.actions, null, 2));
+        files.actions = actionsPath;
+      }
+    }
+    if (Object.keys(files).length > 0) output.files = files;
+    process.stdout.write(JSON.stringify(output));
+    process.stdout.write('\n');
     return true;
   } catch (err) {
     color.error(`Error: ${err.message}`);