@geolonia/geonicdb-cli 0.1.0 → 0.3.0

package/README.md

@@ -77,6 +77,7 @@ geonic entities list --help
 | `-f, --format <fmt>` | Output format: `json`, `table`, `geojson` |
 | `--no-color` | Disable color output |
 | `-v, --verbose` | Verbose output |
+| `--dry-run` | Print the equivalent `curl` command without executing |
 
 Options are resolved in this order (first wins):
 
@@ -388,6 +389,31 @@ Specify the output format with `--format` or `geonic config set format <fmt>`.
 
 Use `--key-values` on `entities list` and `entities get` to request simplified key-value format from the API.
 
+## Dry Run
+
+Use `--dry-run` on any command to print the equivalent `curl` command instead of executing the request. The output can be copied and run directly in a terminal.
+
+```bash
+$ geonic entities list --type Sensor --dry-run
+curl \
+  -H 'Content-Type: application/ld+json' \
+  -H 'Accept: application/ld+json' \
+  -H 'Authorization: Bearer <token>' \
+  'http://localhost:3000/ngsi-ld/v1/entities?type=Sensor'
+```
+
+Works with all operations including POST with body:
+
+```bash
+$ geonic entities create '{"id":"Room1","type":"Room"}' --dry-run
+curl \
+  -X POST \
+  -H 'Content-Type: application/ld+json' \
+  -H 'Accept: application/ld+json' \
+  -d '{"id":"Room1","type":"Room"}' \
+  'http://localhost:3000/ngsi-ld/v1/entities'
+```
+
 ## Configuration
 
 The CLI stores configuration in `~/.config/geonic/config.json`.

package/dist/index.js

@@ -585,6 +585,12 @@ function registerConfigCommand(program2) {
 import { Command } from "commander";
 
 // src/client.ts
+var DryRunSignal = class extends Error {
+  constructor() {
+    super("dry-run");
+    this.name = "DryRunSignal";
+  }
+};
 var GdbClient = class _GdbClient {
   baseUrl;
   service;
@@ -593,6 +599,7 @@ var GdbClient = class _GdbClient {
   apiKey;
   onTokenRefresh;
   verbose;
+  dryRun;
   refreshPromise;
   constructor(options) {
     this.baseUrl = options.baseUrl.replace(/\/+$/, "");
@@ -602,6 +609,7 @@ var GdbClient = class _GdbClient {
     this.apiKey = options.apiKey;
     this.onTokenRefresh = options.onTokenRefresh;
     this.verbose = options.verbose ?? false;
+    this.dryRun = options.dryRun ?? false;
   }
   buildHeaders(extra) {
     const headers = {};
@@ -682,6 +690,28 @@ var GdbClient = class _GdbClient {
     });
     process.stderr.write("\n");
   }
+  static shellQuote(value) {
+    return `'${value.split("'").join(`'"'"'`)}'`;
+  }
+  static buildCurlCommand(method, url, headers, body) {
+    const parts = ["curl"];
+    if (method !== "GET") {
+      parts.push(`-X ${method}`);
+    }
+    for (const [key, value] of Object.entries(headers)) {
+      parts.push(`-H ${_GdbClient.shellQuote(`${key}: ${value}`)}`);
+    }
+    if (body) {
+      parts.push(`-d ${_GdbClient.shellQuote(body)}`);
+    }
+    parts.push(_GdbClient.shellQuote(url));
+    return parts.join(" \\\n  ");
+  }
+  handleDryRun(method, url, headers, body) {
+    if (!this.dryRun) return;
+    console.log(_GdbClient.buildCurlCommand(method, url, headers, body));
+    throw new DryRunSignal();
+  }
   canRefresh() {
     return !!this.refreshToken && !this.apiKey;
   }
@@ -721,6 +751,7 @@ var GdbClient = class _GdbClient {
     const headers = this.buildHeaders(options?.headers);
     const body = options?.body ? JSON.stringify(options.body) : void 0;
     this.logRequest(method, url, headers, body);
+    this.handleDryRun(method, url, headers, body);
     const response = await fetch(url, { method, headers, body });
     this.logResponse(response);
     const countHeader = response.headers.get("NGSILD-Results-Count");
@@ -745,6 +776,7 @@ var GdbClient = class _GdbClient {
     const headers = this.buildHeaders(options?.headers);
     const body = options?.body ? JSON.stringify(options.body) : void 0;
     this.logRequest(method, url, headers, body);
+    this.handleDryRun(method, url, headers, body);
     const response = await fetch(url, { method, headers, body });
     this.logResponse(response);
     let data;
@@ -826,7 +858,8 @@ function resolveOptions(cmd) {
     color: opts.color,
     verbose: opts.verbose,
     profile: opts.profile,
-    apiKey: opts.apiKey ?? process.env.GDB_API_KEY ?? config.apiKey
+    apiKey: opts.apiKey ?? process.env.GDB_API_KEY ?? config.apiKey,
+    dryRun: opts.dryRun
   };
 }
 function createClient(cmd) {
@@ -851,7 +884,8 @@ function createClient(cmd) {
       if (refreshToken) cfg.refreshToken = refreshToken;
       saveConfig(cfg, opts.profile);
     },
-    verbose: opts.verbose
+    verbose: opts.verbose,
+    dryRun: opts.dryRun
   });
 }
 function getFormat(cmd) {
@@ -871,6 +905,9 @@ function withErrorHandler(fn) {
     try {
       await fn(...args);
     } catch (err) {
+      if (err instanceof DryRunSignal) {
+        return;
+      }
       if (err instanceof GdbClientError && err.status === 401) {
         printError("Authentication failed. Please run `geonic login` to re-authenticate.");
       } else if (err instanceof Error) {
@@ -1052,7 +1089,6 @@ async function clientCredentialsGrant(options) {
 }
 
 // src/commands/auth.ts
-import chalk3 from "chalk";
 function createLoginCommand() {
   return new Command("login").description("Authenticate and save token").option("--client-credentials", "Use OAuth 2.0 Client Credentials flow").option("--client-id <id>", "OAuth client ID").option("--client-secret <secret>", "OAuth client secret").option("--scope <scopes>", "OAuth scopes (space-separated)").option("--tenant-id <id>", "Tenant ID for scoped authentication").action(
     withErrorHandler(async (...args) => {
@@ -1163,7 +1199,7 @@ function createMeAction() {
       const status = getTokenStatus(latestConfig.token);
       if (status.expiresAt) {
         if (status.isExpired) {
-          console.log(chalk3.red(`Token expires: ${status.expiresAt.toISOString()} (expired)`));
+          printError(`Token expires: ${status.expiresAt.toISOString()} (expired)`);
         } else if (status.isExpiringSoon) {
           printWarning(
             `Token expires: ${status.expiresAt.toISOString()} (${formatDuration(status.remainingMs)} remaining)`
@@ -1537,15 +1573,13 @@ function registerEntitiesCommand(program2) {
       if (opts.attrs) params.attrs = String(opts.attrs);
       if (opts.georel) params.georel = String(opts.georel);
       if (opts.geometry) params.geometry = String(opts.geometry);
-      if (opts.coords) params.coords = String(opts.coords);
+      if (opts.coords) params.coordinates = String(opts.coords);
       if (opts.spatialId) params.spatialId = String(opts.spatialId);
       if (opts.limit !== void 0) params.limit = String(opts.limit);
       if (opts.offset !== void 0) params.offset = String(opts.offset);
       if (opts.orderBy) params.orderBy = String(opts.orderBy);
-      if (opts.count) params.options = "count";
-      if (opts.keyValues) {
-        params.options = params.options ? `${params.options},keyValues` : "keyValues";
-      }
+      if (opts.count) params.count = "true";
+      if (opts.keyValues) params.options = "keyValues";
       const response = await client.get("/entities", params);
       outputResponse(response, format, !!opts.count);
     })
@@ -1861,7 +1895,7 @@ function registerSubscriptionsCommand(program2) {
       const params = {};
       if (cmdOpts.limit !== void 0) params["limit"] = String(cmdOpts.limit);
       if (cmdOpts.offset !== void 0) params["offset"] = String(cmdOpts.offset);
-      if (cmdOpts.count) params["options"] = "count";
+      if (cmdOpts.count) params["count"] = "true";
       const response = await client.get("/subscriptions", params);
       outputResponse(response, format, !!cmdOpts.count);
     })
@@ -1965,8 +1999,8 @@ function registerRegistrationsCommand(program2) {
       const params = {};
       if (cmdOpts.limit !== void 0) params["limit"] = String(cmdOpts.limit);
       if (cmdOpts.offset !== void 0) params["offset"] = String(cmdOpts.offset);
-      if (cmdOpts.count) params["options"] = "count";
-      const response = await client.get("/registrations", params);
+      if (cmdOpts.count) params["count"] = "true";
+      const response = await client.get("/csourceRegistrations", params);
       outputResponse(response, format, !!cmdOpts.count);
     })
   );
@@ -1985,7 +2019,7 @@ function registerRegistrationsCommand(program2) {
       const client = createClient(cmd);
       const format = getFormat(cmd);
       const response = await client.get(
-        `/registrations/${encodeURIComponent(String(id))}`
+        `/csourceRegistrations/${encodeURIComponent(String(id))}`
       );
       outputResponse(response, format);
     })
@@ -2001,7 +2035,7 @@ function registerRegistrationsCommand(program2) {
       const client = createClient(cmd);
       const format = getFormat(cmd);
       const data = await parseJsonInput(json);
-      const response = await client.post("/registrations", data);
+      const response = await client.post("/csourceRegistrations", data);
       outputResponse(response, format);
       printSuccess("Registration created.");
     })
@@ -2019,7 +2053,7 @@ function registerRegistrationsCommand(program2) {
         const format = getFormat(cmd);
         const data = await parseJsonInput(json);
         const response = await client.patch(
-          `/registrations/${encodeURIComponent(String(id))}`,
+          `/csourceRegistrations/${encodeURIComponent(String(id))}`,
           data
         );
         outputResponse(response, format);
@@ -2037,7 +2071,7 @@ function registerRegistrationsCommand(program2) {
     withErrorHandler(async (id, _opts, cmd) => {
       const client = createClient(cmd);
       await client.delete(
-        `/registrations/${encodeURIComponent(String(id))}`
+        `/csourceRegistrations/${encodeURIComponent(String(id))}`
       );
       printSuccess("Registration deleted.");
     })
@@ -2102,14 +2136,14 @@ function createListAction() {
     if (cmdOpts.query) params["q"] = cmdOpts.query;
     if (cmdOpts.georel) params["georel"] = cmdOpts.georel;
     if (cmdOpts.geometry) params["geometry"] = cmdOpts.geometry;
-    if (cmdOpts.coords) params["coords"] = cmdOpts.coords;
+    if (cmdOpts.coords) params["coordinates"] = cmdOpts.coords;
     if (cmdOpts.timeRel) params["timerel"] = cmdOpts.timeRel;
     if (cmdOpts.timeAt) params["timeAt"] = cmdOpts.timeAt;
     if (cmdOpts.endTimeAt) params["endTimeAt"] = cmdOpts.endTimeAt;
     if (cmdOpts.lastN !== void 0) params["lastN"] = String(cmdOpts.lastN);
     if (cmdOpts.limit !== void 0) params["limit"] = String(cmdOpts.limit);
     if (cmdOpts.offset !== void 0) params["offset"] = String(cmdOpts.offset);
-    if (cmdOpts.count) params["options"] = "count";
+    if (cmdOpts.count) params["count"] = "true";
     const response = await client.get("/temporal/entities", params);
     outputResponse(response, format, cmdOpts.count);
   });
@@ -3238,8 +3272,8 @@ function generateCompletions(program2, line, point) {
     i++;
   }
   if (currentCmd.name() === "help" && currentCmd.parent === program2) {
-    const helpIdx = walkTokens.findIndex((t) => t === "help");
-    const rawArgs = helpIdx >= 0 ? walkTokens.slice(helpIdx + 1) : [];
+    const helpIdx = walkTokens.indexOf("help");
+    const rawArgs = walkTokens.slice(helpIdx + 1);
     const helpArgs = [];
     for (let j = 0; j < rawArgs.length; j++) {
       const t = rawArgs[j];
@@ -3382,7 +3416,7 @@ function createProgram() {
   const require2 = createRequire3(import.meta.url);
   const pkg = require2("../package.json");
   const program2 = new Command2();
-  program2.name("geonic").description(pkg.description).option("-u, --url <url>", "Base URL of the GeonicDB server").option("-s, --service <name>", "NGSILD-Tenant header").option("--token <token>", "Authentication token").option("-p, --profile <name>", "Use a named profile").option("--api-key <key>", "API key for authentication").option("-f, --format <fmt>", "Output format: json, table, geojson").option("--no-color", "Disable color output").option("-v, --verbose", "Verbose output");
+  program2.name("geonic").description(pkg.description).option("-u, --url <url>", "Base URL of the GeonicDB server").option("-s, --service <name>", "NGSILD-Tenant header").option("--token <token>", "Authentication token").option("-p, --profile <name>", "Use a named profile").option("--api-key <key>", "API key for authentication").option("-f, --format <fmt>", "Output format: json, table, geojson").option("--no-color", "Disable color output").option("-v, --verbose", "Verbose output").option("--dry-run", "Print the equivalent curl command without executing");
   registerHelpCommand(program2);
   registerConfigCommand(program2);
   registerAuthCommands(program2);
@@ -3407,7 +3441,141 @@ function createProgram() {
   return program2;
 }
 
+// src/update-notifier.ts
+import { readFileSync as readFileSync3, writeFileSync as writeFileSync2 } from "fs";
+import { join as join2 } from "path";
+import chalk3 from "chalk";
+var PACKAGE_NAME = "@geolonia/geonicdb-cli";
+var REGISTRY_URL = `https://registry.npmjs.org/${PACKAGE_NAME}/latest`;
+var CHECK_INTERVAL_MS = 24 * 60 * 60 * 1e3;
+var FETCH_TIMEOUT_MS = 5e3;
+var CI_ENV_VARS = [
+  "CI",
+  "CONTINUOUS_INTEGRATION",
+  "BUILD_NUMBER",
+  "GITHUB_ACTIONS",
+  "GITLAB_CI",
+  "CIRCLECI",
+  "JENKINS_URL",
+  "HUDSON_URL",
+  "TRAVIS"
+];
+function getCacheFile() {
+  return join2(getConfigDir(), "update-check.json");
+}
+function isCheckDisabled() {
+  if (process.env.NO_UPDATE_NOTIFIER) return true;
+  if (!process.stdout.isTTY) return true;
+  for (const envVar of CI_ENV_VARS) {
+    if (process.env[envVar]) return true;
+  }
+  return false;
+}
+function loadCache() {
+  try {
+    const raw = readFileSync3(getCacheFile(), "utf-8");
+    return JSON.parse(raw);
+  } catch {
+    return null;
+  }
+}
+function saveCache(cache) {
+  try {
+    ensureConfigDir();
+    writeFileSync2(getCacheFile(), JSON.stringify(cache), "utf-8");
+  } catch {
+  }
+}
+function shouldCheck(cache) {
+  if (!cache) return true;
+  return Date.now() - cache.lastCheck >= CHECK_INTERVAL_MS;
+}
+function compareSemver(current, latest) {
+  const parse = (v) => v.replace(/^v/, "").split(".").map(Number);
+  const [cMajor, cMinor, cPatch] = parse(current);
+  const [lMajor, lMinor, lPatch] = parse(latest);
+  if (lMajor !== cMajor) return lMajor > cMajor;
+  if (lMinor !== cMinor) return lMinor > cMinor;
+  return lPatch > cPatch;
+}
+async function fetchLatestVersion() {
+  try {
+    const res = await fetch(REGISTRY_URL, {
+      signal: AbortSignal.timeout(FETCH_TIMEOUT_MS)
+    });
+    if (!res.ok) return null;
+    const data = await res.json();
+    return data.version ?? null;
+  } catch {
+    return null;
+  }
+}
+function getCurrentVersion() {
+  return process.env.npm_package_version ?? "0.0.0";
+}
+function formatUpdateBox(current, latest) {
+  const message = `Update available: ${current} \u2192 ${latest}`;
+  const install = `Run ${chalk3.cyan(`npm i -g ${PACKAGE_NAME}`)} to update`;
+  const lines = [message, install];
+  const maxLen = Math.max(
+    ...lines.map((l) => stripAnsi(l).length)
+  );
+  const pad = (line) => {
+    const visible = stripAnsi(line).length;
+    return line + " ".repeat(maxLen - visible);
+  };
+  const empty = " ".repeat(maxLen);
+  const top = `\u256D${"\u2500".repeat(maxLen + 4)}\u256E`;
+  const bottom = `\u2570${"\u2500".repeat(maxLen + 4)}\u256F`;
+  const boxLines = [
+    top,
+    `\u2502  ${empty}  \u2502`,
+    ...lines.map((l) => `\u2502  ${pad(l)}  \u2502`),
+    `\u2502  ${empty}  \u2502`,
+    bottom
+  ];
+  return chalk3.yellow(boxLines.join("\n"));
+}
+function stripAnsi(str) {
+  return str.replace(/\x1b\[[0-9;]*m/g, "");
+}
+async function startUpdateCheck() {
+  if (isCheckDisabled()) return null;
+  let currentVersion;
+  try {
+    const pkgPath = new URL("../package.json", import.meta.url);
+    const pkg = JSON.parse(readFileSync3(pkgPath, "utf-8"));
+    currentVersion = pkg.version;
+  } catch {
+    currentVersion = getCurrentVersion();
+  }
+  const cache = loadCache();
+  if (!shouldCheck(cache)) {
+    if (cache?.latestVersion && compareSemver(currentVersion, cache.latestVersion)) {
+      return { currentVersion, latestVersion: cache.latestVersion };
+    }
+    return null;
+  }
+  const latestVersion = await fetchLatestVersion();
+  saveCache({
+    lastCheck: Date.now(),
+    latestVersion: latestVersion ?? cache?.latestVersion
+  });
+  if (latestVersion && compareSemver(currentVersion, latestVersion)) {
+    return { currentVersion, latestVersion };
+  }
+  return null;
+}
+function printUpdateNotification(result) {
+  if (!result) return;
+  const box = formatUpdateBox(result.currentVersion, result.latestVersion);
+  process.stderr.write("\n" + box + "\n");
+}
+
 // src/index.ts
+var updateCheckPromise = startUpdateCheck();
 var program = createProgram();
-program.parse();
+await program.parseAsync();
+var updateResult = await updateCheckPromise;
+printUpdateNotification(updateResult);
 //# sourceMappingURL=index.js.map