datagrok-tools 6.1.9 → 6.1.10

package/bin/commands/server.js

@@ -0,0 +1,520 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildInlineManifest = buildInlineManifest;
+exports.parseFuncCall = parseFuncCall;
+exports.resolveManifestSources = resolveManifestSources;
+exports.server = server;
+var fs = _interopRequireWildcard(require("fs"));
+var _nodeDapi = require("../utils/node-dapi");
+var _serverClient = require("../utils/server-client");
+var _serverOutput = require("../utils/server-output");
+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); }
+/// Docs: [Grok Dapi](/docs/plans/grok-dapi/)
+
+const ENTITIES = ['users', 'groups', 'functions', 'connections', 'queries', 'scripts', 'packages', 'reports', 'files'];
+const VERBS = ['list', 'get', 'delete'];
+async function server(argv) {
+  const args = argv['_'].slice(1);
+  const entity = args[0];
+  const verb = args[1];
+  const rest = args.slice(2);
+  const output = argv.output ?? argv.o ?? 'table';
+  const limit = Number(argv.limit ?? argv.l ?? 50);
+  const offset = Number(argv.offset ?? 0);
+  const filter = argv.filter ?? argv.f ?? '';
+  const host = argv.host;
+  const recursive = !!(argv.r ?? argv.recursive);
+  if (!entity || argv.help) {
+    console.log(HELP_SERVER);
+    return true;
+  }
+  let client;
+  try {
+    client = await (0, _serverClient.createClient)(host);
+  } catch (err) {
+    (0, _serverOutput.printError)(err);
+    return false;
+  }
+  const dapi = new _nodeDapi.NodeDapi(client);
+  try {
+    if (entity === 'batch') return handleBatch(dapi, argv, verb, rest, output);
+    if (entity === 'raw') return handleRaw(dapi, verb, rest, output);
+    if (entity === 'describe') return handleDescribe(dapi, verb ?? rest[0], output);
+    if (entity === 'functions' && verb === 'run') return handleFuncRun(dapi, rest, argv, output);
+    if (entity === 'files' && verb === 'list') {
+      const path = rest[0] ?? '';
+      const result = await dapi.files.list(path, recursive);
+      (0, _serverOutput.printOutput)(result, output);
+      return true;
+    }
+    if (entity === 'files' && verb === 'get') {
+      const result = await dapi.files.get(rest[0]);
+      (0, _serverOutput.printOutput)(result, output);
+      return true;
+    }
+    if (entity === 'files' && verb === 'delete') {
+      await dapi.files.delete(rest[0]);
+      if (output !== 'quiet') console.log(`Deleted ${rest[0]}`);
+      return true;
+    }
+    if (entity === 'shares' && verb === 'add') return handleSharesAdd(dapi, rest, argv, output);
+    if (entity === 'shares' && verb === 'list') return handleSharesList(dapi, rest, output);
+    if (entity === 'users' && verb === 'save') return handleUserSave(dapi, argv, output);
+    if (entity === 'groups' && verb === 'save') return handleGroupSave(dapi, argv, output);
+    if (entity === 'connections' && verb === 'save') return handleConnSave(dapi, argv, output);
+    if (entity === 'connections' && verb === 'test') return handleConnTest(dapi, rest, argv, output);
+    if (entity === 'groups' && verb === 'add-members') return handleGroupAddMembers(dapi, rest, argv, output);
+    if (entity === 'groups' && verb === 'remove-members') return handleGroupRemoveMembers(dapi, rest, argv, output);
+    if (entity === 'groups' && verb === 'list-members') return handleGroupListMembers(dapi, rest, argv, output);
+    if (entity === 'groups' && verb === 'list-memberships') return handleGroupListMemberships(dapi, rest, argv, output);
+    const source = dapi[entity];
+    if (!source || !ENTITIES.includes(entity)) {
+      (0, _serverOutput.printError)(new Error(`Unknown entity type: '${entity}'. Valid: ${ENTITIES.join(', ')}`));
+      return false;
+    }
+    if (!verb) {
+      console.log(`Usage: grok s ${entity} <${VERBS.join('|')}> [args]`);
+      return true;
+    }
+    if (verb === 'list') {
+      const page = Math.floor(offset / limit);
+      const results = await source.filter(filter).by(limit).page(page).list();
+      (0, _serverOutput.printOutput)(results, output);
+      return true;
+    }
+    if (verb === 'get') {
+      if (!rest[0]) {
+        (0, _serverOutput.printError)(new Error('Usage: grok s <entity> get <id>'));
+        return false;
+      }
+      const result = await source.find(rest[0]);
+      (0, _serverOutput.printOutput)(result, output);
+      return true;
+    }
+    if (verb === 'delete') {
+      if (!rest[0]) {
+        (0, _serverOutput.printError)(new Error('Usage: grok s <entity> delete <id>'));
+        return false;
+      }
+      await source.delete(rest[0]);
+      if (output !== 'quiet') console.log(`Deleted ${entity}/${rest[0]}`);
+      return true;
+    }
+    (0, _serverOutput.printError)(new Error(`Unknown verb: '${verb}'. Valid: ${VERBS.join(', ')}`));
+    return false;
+  } catch (err) {
+    (0, _serverOutput.printError)(err);
+    return false;
+  }
+}
+async function handleRaw(dapi, method, rest, output) {
+  if (!method || !rest[0]) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s raw <METHOD> <path>'));
+    return false;
+  }
+  const path = rest[0];
+  const result = await dapi.raw(method, path);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleDescribe(dapi, entityType, output) {
+  if (!entityType) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s describe <entity-type>'));
+    return false;
+  }
+  const result = await dapi.describe(entityType);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleFuncRun(dapi, rest, argv, output) {
+  let funcName = rest[0];
+  if (!funcName) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s functions run <Name:function(args...)> [--json params.json]'));
+    return false;
+  }
+  let params = {};
+  if (argv.json) {
+    const fs = require('fs');
+    try {
+      params = JSON.parse(fs.readFileSync(argv.json, 'utf8'));
+    } catch (err) {
+      (0, _serverOutput.printError)(new Error(`Cannot read params file: ${err.message}`));
+      return false;
+    }
+  } else {
+    const parsed = parseFuncCall(funcName);
+    funcName = parsed.name;
+    params = parsed.params;
+  }
+  const result = await dapi.functions.run(funcName, params);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+function readJsonFile(jsonPath) {
+  return JSON.parse(fs.readFileSync(jsonPath, 'utf8'));
+}
+function readJsonBody(argv, entity) {
+  if (!argv.json) throw new Error(`Usage: grok s ${entity} save --json ${entity}.json`);
+  try {
+    return readJsonFile(argv.json);
+  } catch (err) {
+    throw new Error(`Cannot read ${entity} file '${argv.json}': ${err.message}`);
+  }
+}
+async function handleSharesAdd(dapi, rest, argv, output) {
+  const [entity, ...groupArgs] = rest;
+  if (!entity || !groupArgs.length) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s shares add <entity-id-or-name> <group>[,<group>...] [--access View|Edit]'));
+    return false;
+  }
+  const groups = groupArgs.flatMap(g => g.split(',')).map(g => g.trim()).filter(Boolean).join(',');
+  const access = typeof argv.access === 'string' ? argv.access : 'View';
+  if (access !== 'View' && access !== 'Edit') {
+    (0, _serverOutput.printError)(new Error(`Invalid --access '${access}'. Use 'View' or 'Edit'.`));
+    return false;
+  }
+  const result = await dapi.shares.share(entity, groups, access);
+  (0, _serverOutput.printOutput)(result, output);
+  if (result?.status === 'failed') process.exitCode = 1;
+  return true;
+}
+async function handleSharesList(dapi, rest, output) {
+  const entityId = rest[0];
+  if (!entityId) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s shares list <entity-id>   (entity id must be a UUID)'));
+    return false;
+  }
+  const perms = await dapi.shares.list(entityId);
+  const flat = (Array.isArray(perms) ? perms : []).map(p => ({
+    group: p?.userGroup?.friendlyName ?? p?.userGroup?.name ?? p?.userGroup?.id ?? '',
+    groupId: p?.userGroup?.id ?? '',
+    access: p?.permission?.name ?? p?.permission?.friendlyName ?? '',
+    personal: p?.userGroup?.personal ?? false
+  }));
+  (0, _serverOutput.printOutput)(flat, output);
+  return true;
+}
+async function handleUserSave(dapi, argv, output) {
+  let body;
+  try {
+    body = readJsonBody(argv, 'users');
+  } catch (err) {
+    (0, _serverOutput.printError)(err);
+    return false;
+  }
+  const result = await dapi.users.save(body);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleGroupSave(dapi, argv, output) {
+  let body;
+  try {
+    body = readJsonBody(argv, 'groups');
+  } catch (err) {
+    (0, _serverOutput.printError)(err);
+    return false;
+  }
+  const saveRelations = argv['save-relations'] === true || argv.saveRelations === true;
+  const result = await dapi.groups.save(body, saveRelations);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleConnSave(dapi, argv, output) {
+  if (!argv.json) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s connections save --json conn.json [--save-credentials]'));
+    return false;
+  }
+  let body;
+  try {
+    body = readJsonFile(argv.json);
+  } catch (err) {
+    (0, _serverOutput.printError)(new Error(`Cannot read connection file '${argv.json}': ${err.message}`));
+    return false;
+  }
+  const saveCredentials = argv['save-credentials'] === true || argv.saveCredentials === true;
+  const result = await dapi.connections.save(body, saveCredentials);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleConnTest(dapi, rest, argv, output) {
+  let body;
+  if (argv.json) {
+    try {
+      body = readJsonFile(argv.json);
+    } catch (err) {
+      (0, _serverOutput.printError)(new Error(`Cannot read connection file '${argv.json}': ${err.message}`));
+      return false;
+    }
+  } else if (rest[0]) {
+    body = await dapi.connections.find(rest[0]);
+  } else {
+    (0, _serverOutput.printError)(new Error('Usage: grok s connections test <id-or-name> | --json conn.json'));
+    return false;
+  }
+  await dapi.connections.test(body);
+  if (output !== 'quiet') console.log('ok');
+  return true;
+}
+async function handleGroupAddMembers(dapi, rest, argv, output) {
+  const [group, ...members] = rest;
+  if (!group || !members.length) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s groups add-members <group> <member> [<member> ...] [--admin] [--user]'));
+    return false;
+  }
+  const isAdmin = argv.admin === true;
+  const personalOnly = argv.user === true;
+  const results = await dapi.groups.addMembers(group, members, isAdmin, personalOnly);
+  (0, _serverOutput.printOutput)(results, output);
+  const anyError = results.some(r => r.status === 'error');
+  if (anyError) process.exitCode = 1;
+  return true;
+}
+async function handleGroupRemoveMembers(dapi, rest, argv, output) {
+  const [group, ...members] = rest;
+  if (!group || !members.length) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s groups remove-members <group> <member> [<member> ...] [--user]'));
+    return false;
+  }
+  const personalOnly = argv.user === true;
+  const results = await dapi.groups.removeMembers(group, members, personalOnly);
+  (0, _serverOutput.printOutput)(results, output);
+  const anyError = results.some(r => r.status === 'error');
+  if (anyError) process.exitCode = 1;
+  return true;
+}
+async function handleGroupListMembers(dapi, rest, argv, output) {
+  if (!rest[0]) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s groups list-members <group> [--admin | --no-admin]'));
+    return false;
+  }
+  const admin = typeof argv.admin === 'boolean' ? argv.admin : undefined;
+  const result = await dapi.groups.getMembers(rest[0], admin);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleGroupListMemberships(dapi, rest, argv, output) {
+  if (!rest[0]) {
+    (0, _serverOutput.printError)(new Error('Usage: grok s groups list-memberships <group> [--admin | --no-admin]'));
+    return false;
+  }
+  const admin = typeof argv.admin === 'boolean' ? argv.admin : undefined;
+  const result = await dapi.groups.getMemberships(rest[0], admin);
+  (0, _serverOutput.printOutput)(result, output);
+  return true;
+}
+async function handleBatch(dapi, argv, verb, rest, output) {
+  let request;
+  if (verb?.endsWith('.json') && rest.length === 0) {
+    // grok s batch manifest.json
+    let raw;
+    try {
+      raw = JSON.parse(fs.readFileSync(verb, 'utf8'));
+    } catch (err) {
+      (0, _serverOutput.printError)(new Error(`Cannot read manifest file '${verb}': ${err.message}`));
+      return false;
+    }
+    request = resolveManifestSources(raw);
+  } else if (verb && ENTITIES.includes(verb)) {
+    const batchVerb = rest[0];
+    if (!batchVerb) {
+      (0, _serverOutput.printError)(new Error(`Usage: grok s batch ${verb} <verb> [args...]`));
+      return false;
+    }
+    if (argv.json) {
+      // grok s batch users create --json users.json
+      let paramsArray;
+      try {
+        const raw = JSON.parse(fs.readFileSync(argv.json, 'utf8'));
+        paramsArray = Array.isArray(raw) ? raw : [raw];
+      } catch (err) {
+        (0, _serverOutput.printError)(new Error(`Cannot read params file '${argv.json}': ${err.message}`));
+        return false;
+      }
+      request = buildInlineManifest(verb, batchVerb, paramsArray);
+    } else {
+      // grok s batch files delete path1 path2 ...
+      const batchArgs = rest.slice(1);
+      if (!batchArgs.length) {
+        (0, _serverOutput.printError)(new Error(`Usage: grok s batch ${verb} ${batchVerb} <arg1> [arg2 ...]`));
+        return false;
+      }
+      request = buildInlineManifest(verb, batchVerb, batchArgs);
+    }
+  } else {
+    (0, _serverOutput.printError)(new Error('Usage: grok s batch <entity> <verb> [args]\n       grok s batch <entity> <verb> --json params.json\n       grok s batch manifest.json'));
+    return false;
+  }
+  const result = await dapi.batch(request);
+  (0, _serverOutput.printBatchOutput)(result, output);
+  return result.summary.failed === 0 && result.summary.partial === 0;
+}
+function buildInlineManifest(entity, verb, args) {
+  const action = `${entity}.${verb}`;
+  let operations;
+  if (args.length > 0 && typeof args[0] === 'object') {
+    // Array of param objects (from --json array)
+    operations = args.map((p, i) => ({
+      id: `op${i}`,
+      action,
+      params: p
+    }));
+  } else {
+    // Array of string args — map to appropriate param key
+    const paramKey = entity === 'files' ? 'path' : 'id';
+    operations = args.map((arg, i) => ({
+      id: `op${i}`,
+      action,
+      params: {
+        [paramKey]: arg
+      }
+    }));
+  }
+  return {
+    operations
+  };
+}
+function resolveManifestSources(manifest) {
+  if (!manifest.operations) return manifest;
+  const operations = manifest.operations.map(op => {
+    if (op.action === 'files.put' && op.params?.source) {
+      const sourcePath = op.params.source;
+      const content = fs.readFileSync(sourcePath).toString('base64');
+      const {
+        source: _dropped,
+        ...rest
+      } = op.params;
+      return {
+        ...op,
+        params: {
+          ...rest,
+          content
+        }
+      };
+    }
+    return op;
+  });
+  return {
+    ...manifest,
+    operations
+  };
+}
+function parseFuncCall(expr) {
+  const parenIdx = expr.indexOf('(');
+  if (parenIdx === -1) return {
+    name: expr,
+    params: {}
+  };
+  const name = expr.slice(0, parenIdx);
+  const inner = expr.slice(parenIdx + 1, expr.lastIndexOf(')')).trim();
+  if (!inner) return {
+    name,
+    params: {}
+  };
+  if (inner.startsWith('{')) {
+    try {
+      const params = JSON.parse(inner.replace(/([{,]\s*)([a-zA-Z_]\w*)(\s*:)/g, '$1"$2"$3'));
+      return {
+        name,
+        params
+      };
+    } catch {
+      return {
+        name,
+        params: {}
+      };
+    }
+  }
+  const positional = inner.split(',').map(s => {
+    s = s.trim();
+    if (s.startsWith('"') && s.endsWith('"') || s.startsWith("'") && s.endsWith("'")) return s.slice(1, -1);
+    const n = Number(s);
+    return isNaN(n) ? s : n;
+  });
+  return {
+    name,
+    params: Object.fromEntries(positional.map((v, i) => [String(i), v]))
+  };
+}
+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
+
+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 files list [path] [-r]                       List files (recursive with -r)
+  grok s raw <METHOD> <path>                          Hit any API endpoint
+  grok s describe <entity-type>                       Show entity JSON schema
+  grok s shares add <entity> <group>[,<group>...] [--access View|Edit]
+                                                      Share an entity with one or more 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 a JSON file
+  grok s groups save --json group.json [--save-relations]
+                                                      Create or update a group from a JSON file
+  grok s connections save --json conn.json [--save-credentials]
+                                                      Create or update a connection from a JSON file
+  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 groups add-members <group> <m>... [--admin]  Add one or more users/groups as members
+  grok s groups remove-members <group> <m>...         Remove members (no-op if not a member)
+  grok s groups list-members <group> [--admin]        List members (optionally filter by admin)
+  grok s groups list-memberships <group> [--admin]    List parent groups
+  grok s batch <entity> <verb> arg1 [arg2 ...]        Batch operation (one round-trip)
+  grok s batch <entity> <verb> --json params.json     Batch from JSON array
+  grok s batch manifest.json                          Run a workflow manifest
+
+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 or batch params from JSON file
+
+Batch manifest options (in manifest.json):
+  stopOnError           Stop on first failure (default: true)
+  transaction           Wrap DB ops in transaction (default: false)
+  concurrency           Accepted (always treated as 1)
+
+Examples:
+  grok s users list
+  grok s users list --output json --limit 10
+  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 connections list --filter "PostgreSQL"
+  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 functions run 'Chem:smilesToMw("ccc")'
+  grok s functions run Chem:test --json params.json
+  grok s files list "System:AppData" -r
+  grok s raw GET /api/users/current
+  grok s describe connections
+  grok s users list --host dev
+  grok s users list --host "https://mygrok.com/api"
+  grok s groups add-members Admins alice bob --admin
+  grok s groups remove-members Admins alice
+  grok s groups list-members Admins --admin
+  grok s groups list-memberships alice
+  grok s batch files delete "System:AppData/old.txt" "System:AppData/tmp.txt"
+  grok s batch users create --json users.json
+  grok s batch manifest.json
+  grok s batch files delete "System:AppData/a" "System:AppData/b" --output json
+`;

package/bin/grok.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 const argv = require('minimist')(process.argv.slice(2), {
-  alias: {k: 'key', h: 'help', r: 'recursive', s: 'silent'},
+  alias: {k: 'key', h: 'help', r: 'recursive'},
   boolean: ['dartium'],
 });
 const help = require('./commands/help').help;
@@ -24,6 +24,8 @@ const commands = {
   testall: require('./commands/test-all').testAll,
   stresstest: require('./commands/stress-tests').stressTests,
   migrate: require('./commands/migrate').migrate,
+  server: require('./commands/server').server,
+  s: require('./commands/server').server,
 };
 
 const onPackageCommandNames = ['api', 'check', 'link', 'publish', 'test'];