datagrok-tools 6.1.10 → 6.1.11

package/bin/utils/node-dapi.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.NodeUsersDataSource = exports.NodeSharesDataSource = exports.NodeHttpDataSource = exports.NodeGroupsDataSource = exports.NodeFuncsDataSource = exports.NodeFilesDataSource = exports.NodeDapi = exports.NodeConnectionsDataSource = exports.NodeApiClient = void 0;
+exports.NodeUsersDataSource = exports.NodeTablesDataSource = exports.NodeSharesDataSource = exports.NodeHttpDataSource = exports.NodeGroupsDataSource = exports.NodeFuncsDataSource = exports.NodeFilesDataSource = exports.NodeDapi = exports.NodeConnectionsDataSource = exports.NodeApiClient = void 0;
 exports.ensureBodyId = ensureBodyId;
 var _crypto = require("crypto");
 /// Docs: [Grok Dapi](/docs/plans/grok-dapi/)
@@ -72,6 +72,45 @@ class NodeApiClient {
   del(path) {
     return this.request('DELETE', path);
   }
+
+  /**
+   * POST raw bytes — used for file/table uploads where the body must be the content
+   * itself, not JSON. Defaults to `application/octet-stream`; pass `text/csv` (or
+   * similar) when the server demands a specific content type.
+   */
+  async putBytes(path, bytes, contentType = 'application/octet-stream') {
+    const res = await fetch(`${this.baseUrl}${path}`, {
+      method: 'POST',
+      headers: {
+        'Authorization': this.token,
+        'Content-Type': contentType
+      },
+      body: bytes
+    });
+    if (!res.ok) {
+      const rawText = await res.text();
+      let errBody;
+      try {
+        errBody = JSON.parse(rawText);
+      } catch {
+        errBody = {
+          error: rawText || `HTTP ${res.status}`
+        };
+      }
+      const err = {
+        error: errBody?.message ?? errBody?.error ?? `HTTP ${res.status}`,
+        source: errBody?.source ?? 'Server',
+        errorCode: errBody?.errorCode ?? res.status,
+        stackTrace: errBody?.stackTrace
+      };
+      throw Object.assign(new Error(err.error), {
+        apiError: err
+      });
+    }
+    const ct = res.headers.get('content-type') ?? '';
+    if (ct.includes('application/json')) return res.json();
+    return res.text();
+  }
 }
 exports.NodeApiClient = NodeApiClient;
 function buildQuery(params) {
@@ -162,7 +201,10 @@ class NodeGroupsDataSource extends NodeHttpDataSource {
     return candidates[0];
   }
   async addMembers(group, members, isAdmin = false, personalOnly = false) {
-    const parent = await this.resolve(group);
+    // Always fetch via find() so parent.children comes back expanded; lookup() returns a
+    // pruned projection and replacing that empty list on save would drop existing members.
+    const resolved = await this.resolve(group);
+    const parent = await this.find(resolved.id);
     const children = Array.isArray(parent.children) ? parent.children : [];
     const results = [];
     let mutated = false;
@@ -182,7 +224,9 @@ class NodeGroupsDataSource extends NodeHttpDataSource {
       }
       const existing = children.find(r => r?.child?.id === child.id);
       if (existing) {
-        if (existing.isAdmin === isAdmin) {
+        // Server returns isAdmin as null/undefined for non-admin relations; normalize
+        // the comparison so re-runs report `noop` instead of `updated`.
+        if ((existing.isAdmin ?? false) === isAdmin) {
           results.push({
             member: m,
             status: 'noop'
@@ -196,7 +240,9 @@ class NodeGroupsDataSource extends NodeHttpDataSource {
           });
         }
       } else {
+        // Each GroupRelation row needs a non-null id; the server rejects the save otherwise.
         children.push({
+          id: (0, _crypto.randomUUID)(),
           parent: {
             id: parent.id
           },
@@ -219,7 +265,8 @@ class NodeGroupsDataSource extends NodeHttpDataSource {
     return results;
   }
   async removeMembers(group, members, personalOnly = false) {
-    const parent = await this.resolve(group);
+    const resolved = await this.resolve(group);
+    const parent = await this.find(resolved.id);
     const results = [];
     const children = Array.isArray(parent.children) ? parent.children : [];
     let mutated = false;
@@ -301,6 +348,12 @@ class NodeUsersDataSource extends NodeHttpDataSource {
   async save(user) {
     return this.client.post('/public/v1/users', ensureBodyId(user));
   }
+  async block(user) {
+    await this.client.post('/public/v1/users/block', user);
+  }
+  async unblock(user) {
+    await this.client.post('/public/v1/users/unblock', user);
+  }
 }
 exports.NodeUsersDataSource = NodeUsersDataSource;
 class NodeConnectionsDataSource extends NodeHttpDataSource {
@@ -351,14 +404,25 @@ class NodeFilesDataSource {
   constructor(client) {
     this.client = client;
   }
+
+  /**
+   * Split a user-facing file path into {connector, path}.
+   *
+   * Input format: `<connector>/<file-path>` where `<connector>` is the connection's
+   * full name — including namespace — e.g. `System:DemoFiles/smiles_1M.csv`.
+   * The connector can contain colons (the namespace separator); the file path
+   * starts after the first `/`. Colons in the connector segment are converted
+   * to `.` so it forms a single URL path segment (the Dart server reverses
+   * this with `replaceAll('.', ':')`).
+   */
   splitPath(filePath) {
-    const colonIdx = filePath.indexOf(':');
-    if (colonIdx === -1) return {
-      connector: filePath.replace(':', '.'),
+    const slashIdx = filePath.indexOf('/');
+    if (slashIdx === -1) return {
+      connector: filePath.replace(/:/g, '.'),
       path: ''
     };
-    const connector = filePath.slice(0, colonIdx).replace(':', '.');
-    const path = filePath.slice(colonIdx + 1).replace(/^\//, '');
+    const connector = filePath.slice(0, slashIdx).replace(/:/g, '.');
+    const path = filePath.slice(slashIdx + 1);
     return {
       connector,
       path
@@ -380,17 +444,73 @@ class NodeFilesDataSource {
       connector,
       path
     } = this.splitPath(filePath);
-    return this.client.get(`/public/v1/files/${connector}/${path}`);
+    const seg = path ? `${connector}/${path}` : connector;
+    return this.client.get(`/public/v1/files/${seg}`);
   }
   async delete(filePath) {
     const {
       connector,
       path
     } = this.splitPath(filePath);
-    await this.client.del(`/public/v1/files/${connector}/${path}`);
+    const seg = path ? `${connector}/${path}` : connector;
+    await this.client.del(`/public/v1/files/${seg}`);
+  }
+
+  /**
+   * Upload a local file to a Datagrok file share.
+   * Streams raw bytes to POST `/public/v1/files/<connector>/<path>` — no base64,
+   * no JSON wrapping — so it handles large files without blowing up memory.
+   */
+  async put(localPath, remotePath) {
+    const fs = require('fs');
+    const {
+      connector,
+      path
+    } = this.splitPath(remotePath);
+    if (!path) throw new Error(`Remote path must include a file name after the connector: got '${remotePath}'`);
+    const bytes = fs.readFileSync(localPath);
+    const res = await this.client.putBytes(`/public/v1/files/${connector}/${path}`, bytes);
+    return {
+      path: remotePath,
+      size: bytes.length,
+      response: res
+    };
   }
 }
 exports.NodeFilesDataSource = NodeFilesDataSource;
+class NodeTablesDataSource {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /** GET /public/v1/tables/{name} — returns CSV text. Name accepts UUID or `namespace:name`. */
+  async download(name) {
+    const seg = encodeURIComponent(name.replace(/:/g, '.'));
+    const result = await this.client.get(`/public/v1/tables/${seg}`);
+    // Datagrok returns HTTP 200 + ApiError JSON when the table isn't found.
+    const parsed = typeof result === 'string' ? tryParseJson(result) : result;
+    if (parsed && typeof parsed === 'object' && parsed['#type'] === 'ApiError') {
+      const err = {
+        error: parsed.message ?? 'Table download failed',
+        errorCode: parsed.errorCode,
+        stackTrace: parsed.stackTrace
+      };
+      throw Object.assign(new Error(err.error), {
+        apiError: err
+      });
+    }
+    return result;
+  }
+
+  /** POST /public/v1/tables/{name} with raw CSV bytes. Returns `{ID, Grok name, Markup, URL}`. */
+  async upload(name, localPath) {
+    const fs = require('fs');
+    const bytes = fs.readFileSync(localPath);
+    const seg = encodeURIComponent(name.replace(/:/g, '.'));
+    return this.client.putBytes(`/public/v1/tables/${seg}`, bytes, 'text/csv');
+  }
+}
+exports.NodeTablesDataSource = NodeTablesDataSource;
 class NodeDapi {
   constructor(client) {
     this.client = client;
@@ -425,6 +545,9 @@ class NodeDapi {
   get shares() {
     return new NodeSharesDataSource(this.client);
   }
+  get tables() {
+    return new NodeTablesDataSource(this.client);
+  }
   async raw(method, path, body) {
     // Raw paths are relative to server root (e.g. /api/users/current).
     // Strip the trailing /api from baseUrl to avoid double prefix.

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.json

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