postgresai 0.14.0-dev.86 → 0.14.0-dev.87

package/dist/bin/postgres-ai.js

@@ -13064,7 +13064,7 @@ var {
 // package.json
 var package_default = {
   name: "postgresai",
-  version: "0.14.0-dev.86",
+  version: "0.14.0-dev.87",
   description: "postgres_ai CLI",
   license: "Apache-2.0",
   private: false,
@@ -15889,7 +15889,7 @@ var Result = import_lib.default.Result;
 var TypeOverrides = import_lib.default.TypeOverrides;
 var defaults = import_lib.default.defaults;
 // package.json
-var version = "0.14.0-dev.86";
+var version = "0.14.0-dev.87";
 var package_default2 = {
   name: "postgresai",
   version,
@@ -28093,8 +28093,6 @@ function unwrapRpcResponse(parsed) {
 var HTTP_TIMEOUT_MS = 30000;
 async function postRpc(params) {
   const { apiKey, apiBaseUrl, rpcName, bodyObj, timeoutMs = HTTP_TIMEOUT_MS } = params;
-  if (!apiKey)
-    throw new Error("API key is required");
   const base = normalizeBaseUrl(apiBaseUrl);
   const url = new URL3(`${base}/rpc/${rpcName}`);
   const body = JSON.stringify(bodyObj);
@@ -28227,6 +28225,249 @@ async function uploadCheckupReportJson(params) {
   }
   return { reportChunkId: chunkId };
 }
+async function convertCheckupReportJsonToMarkdown(params) {
+  const { apiKey, apiBaseUrl, checkId, jsonPayload, reportType } = params;
+  const bodyObj = {
+    check_id: checkId,
+    json_payload: jsonPayload,
+    access_token: apiKey
+  };
+  if (reportType) {
+    bodyObj.report_type = reportType;
+  }
+  const resp = await postRpc({
+    apiKey,
+    apiBaseUrl,
+    rpcName: "checkup_report_json_to_markdown",
+    bodyObj
+  });
+  return resp;
+}
+
+// lib/checkup-summary.ts
+function generateCheckSummary(checkId, report) {
+  const nodeIds = Object.keys(report.results || {});
+  if (nodeIds.length === 0) {
+    return { status: "info", message: "No data" };
+  }
+  const nodeData = report.results[nodeIds[0]];
+  switch (checkId) {
+    case "H001":
+      return summarizeH001(nodeData);
+    case "H002":
+      return summarizeH002(nodeData);
+    case "H004":
+      return summarizeH004(nodeData);
+    case "A002":
+      return summarizeA002(nodeData);
+    case "A013":
+      return summarizeA013(nodeData);
+    case "A003":
+      return summarizeA003(nodeData);
+    case "A004":
+      return summarizeA004(nodeData);
+    case "A007":
+      return summarizeA007(nodeData);
+    case "D001":
+      return summarizeD001(nodeData);
+    case "D004":
+      return summarizeD004(nodeData);
+    case "F001":
+      return summarizeF001(nodeData);
+    case "G001":
+      return summarizeG001(nodeData);
+    case "G003":
+      return summarizeG003(nodeData);
+    default:
+      return { status: "info", message: "Check completed" };
+  }
+}
+function summarizeA003(nodeData) {
+  const data = nodeData?.data || {};
+  const settingsCount = Object.keys(data).length;
+  if (settingsCount === 0) {
+    return { status: "info", message: "No settings found" };
+  }
+  return {
+    status: "info",
+    message: `${settingsCount} setting${settingsCount > 1 ? "s" : ""} collected`
+  };
+}
+function summarizeA004(nodeData) {
+  const data = nodeData?.data;
+  if (!data) {
+    return { status: "info", message: "Cluster information collected" };
+  }
+  const dbCount = Object.keys(data.database_sizes || {}).length;
+  if (dbCount > 0) {
+    return { status: "info", message: `${dbCount} database${dbCount > 1 ? "s" : ""} analyzed` };
+  }
+  return { status: "info", message: "Cluster information collected" };
+}
+function summarizeA007(nodeData) {
+  const data = nodeData?.data || {};
+  const alteredCount = Object.keys(data).length;
+  if (alteredCount === 0) {
+    return { status: "ok", message: "No altered settings" };
+  }
+  return {
+    status: "info",
+    message: `${alteredCount} setting${alteredCount > 1 ? "s" : ""} altered from defaults`
+  };
+}
+function formatBytes2(bytes) {
+  if (bytes === 0)
+    return "0 B";
+  if (bytes < 1024)
+    return `${bytes} B`;
+  if (bytes < 1024 * 1024)
+    return `${(bytes / 1024).toFixed(0)} KiB`;
+  if (bytes < 1024 * 1024 * 1024)
+    return `${(bytes / (1024 * 1024)).toFixed(0)} MiB`;
+  return `${(bytes / (1024 * 1024 * 1024)).toFixed(1)} GiB`;
+}
+function summarizeH001(nodeData) {
+  const data = nodeData?.data || {};
+  let totalCount = 0;
+  let totalSize = 0;
+  for (const dbData of Object.values(data)) {
+    const dbEntry = dbData;
+    totalCount += dbEntry.total_count || 0;
+    totalSize += dbEntry.total_size_bytes || 0;
+  }
+  if (totalCount === 0) {
+    return { status: "ok", message: "No invalid indexes" };
+  }
+  return {
+    status: "warning",
+    message: `Found ${totalCount} invalid index${totalCount > 1 ? "es" : ""} (${formatBytes2(totalSize)})`
+  };
+}
+function summarizeH002(nodeData) {
+  const data = nodeData?.data || {};
+  let totalCount = 0;
+  let totalSize = 0;
+  for (const dbData of Object.values(data)) {
+    const dbEntry = dbData;
+    totalCount += dbEntry.total_count || 0;
+    totalSize += dbEntry.total_size_bytes || 0;
+  }
+  if (totalCount === 0) {
+    return { status: "ok", message: "All indexes utilized" };
+  }
+  return {
+    status: "warning",
+    message: `Found ${totalCount} unused index${totalCount > 1 ? "es" : ""} (${formatBytes2(totalSize)})`
+  };
+}
+function summarizeH004(nodeData) {
+  const data = nodeData?.data || {};
+  let totalCount = 0;
+  let totalSize = 0;
+  for (const dbData of Object.values(data)) {
+    const dbEntry = dbData;
+    totalCount += dbEntry.total_count || 0;
+    totalSize += dbEntry.total_size_bytes || 0;
+  }
+  if (totalCount === 0) {
+    return { status: "ok", message: "No redundant indexes" };
+  }
+  return {
+    status: "warning",
+    message: `Found ${totalCount} redundant index${totalCount > 1 ? "es" : ""} (${formatBytes2(totalSize)})`
+  };
+}
+function summarizeA002(nodeData) {
+  const ver = nodeData?.data?.version;
+  if (!ver) {
+    return { status: "info", message: "Version checked" };
+  }
+  const major = parseInt(ver.server_major_ver, 10);
+  if (major >= 17) {
+    return { status: "ok", message: `PostgreSQL ${major}` };
+  }
+  if (major >= 15) {
+    return { status: "info", message: `PostgreSQL ${major}` };
+  }
+  return {
+    status: "warning",
+    message: `PostgreSQL ${major} (consider upgrading)`
+  };
+}
+function summarizeA013(nodeData) {
+  const ver = nodeData?.data?.version;
+  if (!ver) {
+    return { status: "info", message: "Minor version checked" };
+  }
+  const current = ver.version || "";
+  return {
+    status: "info",
+    message: `Version ${current}`
+  };
+}
+function summarizeD001(nodeData) {
+  const data = nodeData?.data || {};
+  const settingsCount = Object.keys(data).length;
+  if (settingsCount === 0) {
+    return { status: "info", message: "No logging settings found" };
+  }
+  return {
+    status: "info",
+    message: `${settingsCount} logging setting${settingsCount > 1 ? "s" : ""} collected`
+  };
+}
+function summarizeD004(nodeData) {
+  const data = nodeData?.data || {};
+  const settingsCount = Object.keys(data).length;
+  if (settingsCount === 0) {
+    return { status: "info", message: "No pg_stat_statements settings found" };
+  }
+  return {
+    status: "info",
+    message: `${settingsCount} pg_stat_statements setting${settingsCount > 1 ? "s" : ""} collected`
+  };
+}
+function summarizeF001(nodeData) {
+  const data = nodeData?.data || {};
+  const settingsCount = Object.keys(data).length;
+  if (settingsCount === 0) {
+    return { status: "info", message: "No autovacuum settings found" };
+  }
+  return {
+    status: "info",
+    message: `${settingsCount} autovacuum setting${settingsCount > 1 ? "s" : ""} collected`
+  };
+}
+function summarizeG001(nodeData) {
+  const data = nodeData?.data || {};
+  const settingsCount = Object.keys(data).length;
+  if (settingsCount === 0) {
+    return { status: "info", message: "No memory settings found" };
+  }
+  return {
+    status: "info",
+    message: `${settingsCount} memory setting${settingsCount > 1 ? "s" : ""} collected`
+  };
+}
+function summarizeG003(nodeData) {
+  const data = nodeData?.data || {};
+  const settings = data.settings || {};
+  const deadlockStats = data.deadlock_stats;
+  const settingsCount = Object.keys(settings).length;
+  if (deadlockStats && typeof deadlockStats.deadlocks === "number" && deadlockStats.deadlocks > 0) {
+    return {
+      status: "warning",
+      message: `${deadlockStats.deadlocks} deadlock${deadlockStats.deadlocks > 1 ? "s" : ""} detected`
+    };
+  }
+  if (settingsCount === 0) {
+    return { status: "info", message: "No timeout/lock settings found" };
+  }
+  return {
+    status: "info",
+    message: `${settingsCount} timeout/lock setting${settingsCount > 1 ? "s" : ""} collected`
+  };
+}
 
 // bin/postgres-ai.ts
 var rl = null;
@@ -28427,7 +28668,6 @@ async function uploadCheckupReports(uploadCfg, reports, spinner, logUpload) {
     logUpload(`[Retry ${attempt}/3] createCheckupReport failed: ${errMsg}, retrying in ${delayMs}ms...`);
   });
   const reportId = created.reportId;
-  logUpload(`Created remote checkup report: ${reportId}`);
   const uploaded = [];
   for (const [checkId, report] of Object.entries(reports)) {
     spinner.update(`Uploading ${checkId}.json`);
@@ -28445,7 +28685,6 @@ async function uploadCheckupReports(uploadCfg, reports, spinner, logUpload) {
     });
     uploaded.push({ checkId, filename: `${checkId}.json`, chunkId: r.reportChunkId });
   }
-  logUpload("Upload completed");
   return { project: uploadCfg.project, reportId, uploaded };
 }
 function writeReportFiles(reports, outputPath) {
@@ -28455,7 +28694,7 @@ function writeReportFiles(reports, outputPath) {
     console.log(`\u2713 ${checkId}: ${filePath}`);
   }
 }
-function printUploadSummary(summary, projectWasGenerated, useStderr) {
+function printUploadSummary(summary, projectWasGenerated, useStderr, reports) {
   const out = useStderr ? console.error : console.log;
   out(`
 Checkup report uploaded`);
@@ -28467,11 +28706,28 @@ Checkup report uploaded`);
     out(`Project: ${summary.project}`);
   }
   out(`Report ID: ${summary.reportId}`);
-  out("View in Console: console.postgres.ai \u2192 Support \u2192 checkup reports");
+  out("View in Console: console.postgres.ai \u2192 Checkup \u2192 checkup reports");
   out("");
-  out("Files:");
+  const summaries = [];
+  let skippedCount = 0;
   for (const item of summary.uploaded) {
-    out(`- ${item.checkId}: ${item.filename}`);
+    const report = reports[item.checkId];
+    if (report) {
+      const { status, message } = generateCheckSummary(item.checkId, report);
+      const title = report.checkTitle || item.checkId;
+      const isSignificant = status !== "info" || /\d/.test(message) || message.includes("PostgreSQL") || message.includes("Version");
+      if (isSignificant) {
+        summaries.push({ checkId: item.checkId, title, status, message });
+      } else {
+        skippedCount++;
+      }
+    }
+  }
+  for (const { checkId, title, message } of summaries) {
+    out(`  ${checkId} (${title}): ${message}`);
+  }
+  if (skippedCount > 0) {
+    out(`  ${skippedCount} other check${skippedCount > 1 ? "s" : ""} completed`);
   }
 }
 function getDefaultMonitoringProjectDir() {
@@ -29498,7 +29754,7 @@ program2.command("unprepare-db [conn]").description("remove monitoring setup: dr
     closeReadline();
   }
 });
-program2.command("checkup [checkIdOrConn] [conn]").description("generate health check reports directly from PostgreSQL (express mode)").option("--check-id <id>", `specific check to run (see list below), or ALL`).option("--node-name <name>", "node name for reports", "node-01").option("--output <path>", "output directory for JSON files").option("--upload", "upload JSON results to PostgresAI (requires API key)").option("--no-upload", "disable upload to PostgresAI").option("--project <project>", "project name or ID for remote upload (used with --upload; defaults to config defaultProject; auto-generated on first run)").option("--json", "output JSON to stdout").addHelpText("after", [
+program2.command("checkup [checkIdOrConn] [conn]").description("generate health check reports directly from PostgreSQL (express mode)").option("--check-id <id>", `specific check to run (see list below), or ALL`).option("--node-name <name>", "node name for reports", "node-01").option("--output <path>", "output directory for JSON files").option("--upload", "upload JSON results to PostgresAI (requires API key)").option("--no-upload", "disable upload to PostgresAI").option("--project <project>", "project name or ID for remote upload (used with --upload; defaults to config defaultProject; auto-generated on first run)").option("--json", "output JSON to stdout").option("--markdown", "output markdown to stdout").addHelpText("after", [
   "",
   "Available checks:",
   ...Object.entries(CHECK_INFO).map(([id, title]) => `  ${id}: ${title}`),
@@ -29508,7 +29764,8 @@ program2.command("checkup [checkIdOrConn] [conn]").description("generate health
   "  postgresai checkup H002 postgresql://user:pass@host:5432/db",
   "  postgresai checkup postgresql://user:pass@host:5432/db --check-id H002",
   "  postgresai checkup postgresql://user:pass@host:5432/db --output ./reports",
-  "  postgresai checkup postgresql://user:pass@host:5432/db --no-upload --json"
+  "  postgresai checkup postgresql://user:pass@host:5432/db --no-upload --json",
+  "  postgresai checkup postgresql://user:pass@host:5432/db --no-upload --markdown"
 ].join(`
 `)).action(async (checkIdOrConn, connArg, opts, cmd) => {
   const checkIdPattern = /^[A-Z]\d{3}$/i;
@@ -29540,7 +29797,13 @@ Usage: postgresai checkup ${checkId} postgresql://user@host:5432/dbname
     return;
   }
   const shouldPrintJson = !!opts.json;
+  const shouldConvertMarkdown = !!opts.markdown;
   const uploadExplicitlyRequested = opts.upload === true;
+  if (shouldPrintJson && shouldConvertMarkdown) {
+    console.error("Error: --json and --markdown are mutually exclusive");
+    process.exitCode = 1;
+    return;
+  }
   const uploadExplicitlyDisabled = opts.upload === false;
   let shouldUpload = !uploadExplicitlyDisabled;
   const outputPath = prepareOutputDirectory(opts.output);
@@ -29562,7 +29825,7 @@ Usage: postgresai checkup ${checkId} postgresql://user@host:5432/dbname
     envPassword: process.env.PGPASSWORD
   });
   let client;
-  const spinnerEnabled = !!process.stdout.isTTY && shouldUpload;
+  const spinnerEnabled = !!process.stdout.isTTY && !shouldPrintJson;
   const spinner = createTtySpinner(spinnerEnabled, "Connecting to Postgres");
   try {
     spinner.update("Connecting to Postgres");
@@ -29603,11 +29866,100 @@ Usage: postgresai checkup ${checkId} postgresql://user@host:5432/dbname
       writeReportFiles(reports, outputPath);
     }
     if (uploadSummary) {
-      printUploadSummary(uploadSummary, projectWasGenerated, shouldPrintJson);
+      printUploadSummary(uploadSummary, projectWasGenerated, shouldPrintJson || shouldConvertMarkdown, reports);
     }
-    if (shouldPrintJson || !shouldUpload && !opts.output) {
+    if (shouldConvertMarkdown) {
+      let apiKey;
+      let apiBaseUrl;
+      try {
+        const configResult = getConfig(rootOpts);
+        apiKey = configResult.apiKey;
+        const cfg = readConfig();
+        apiBaseUrl = resolveBaseUrls2(rootOpts, cfg).apiBaseUrl;
+      } catch (error2) {
+        spinner.stop();
+        console.error("Error: Failed to read configuration for markdown conversion");
+        console.error(error2 instanceof Error ? error2.message : String(error2));
+        process.exitCode = 1;
+        return;
+      }
+      const markdownResults = [];
+      for (const [checkId2, report] of Object.entries(reports)) {
+        try {
+          spinner.update(`Converting ${checkId2} to markdown`);
+          const markdownResult = await convertCheckupReportJsonToMarkdown({
+            apiKey,
+            apiBaseUrl,
+            checkId: checkId2,
+            jsonPayload: report,
+            reportType: checkId2
+          });
+          const markdown = markdownResult?.reports?.[0]?.markdown || markdownResult?.markdown;
+          markdownResults.push({
+            checkId: checkId2,
+            markdown
+          });
+        } catch (error2) {
+          markdownResults.push({
+            checkId: checkId2,
+            error: error2 instanceof Error ? error2 : new Error(String(error2))
+          });
+        }
+      }
+      spinner.stop();
+      for (const result of markdownResults) {
+        if (result.error) {
+          if (result.error instanceof RpcError) {
+            console.error(`Error converting ${result.checkId} to markdown:`);
+            for (const line of formatRpcErrorForDisplay(result.error)) {
+              console.error(line);
+            }
+          } else {
+            console.error(`Error converting ${result.checkId} to markdown: ${result.error.message}`);
+          }
+        } else if (result.markdown) {
+          console.log(result.markdown);
+          if (!result.markdown.endsWith(`
+`)) {
+            console.log();
+          }
+        } else {
+          console.error(`Warning: No markdown content returned for ${result.checkId}`);
+        }
+      }
+    }
+    if (shouldPrintJson) {
       console.log(JSON.stringify(reports, null, 2));
     }
+    const hadOutput = shouldPrintJson || shouldConvertMarkdown || outputPath || uploadSummary;
+    if (!hadOutput) {
+      const checkCount = Object.keys(reports).length;
+      console.log(`Checkup completed: ${checkCount} check${checkCount > 1 ? "s" : ""}
+`);
+      const summaries = [];
+      let skippedCount = 0;
+      for (const [checkId2, report] of Object.entries(reports)) {
+        const { status, message } = generateCheckSummary(checkId2, report);
+        const title = report.checkTitle || checkId2;
+        const isSignificant = status !== "info" || /\d/.test(message) || message.includes("PostgreSQL") || message.includes("Version");
+        if (isSignificant) {
+          summaries.push({ checkId: checkId2, title, status, message });
+        } else {
+          skippedCount++;
+        }
+      }
+      for (const { checkId: checkId2, title, message } of summaries) {
+        console.log(`  ${checkId2} (${title}): ${message}`);
+      }
+      if (skippedCount > 0) {
+        console.log(`  ${skippedCount} other check${skippedCount > 1 ? "s" : ""} completed`);
+      }
+      console.log(`
+For details:`);
+      console.log("  --json          Output JSON");
+      console.log("  --markdown      Output markdown");
+      console.log("  --output <dir>  Save to directory");
+    }
   } catch (error2) {
     if (error2 instanceof RpcError) {
       for (const line of formatRpcErrorForDisplay(error2)) {

package/lib/checkup-api.ts

@@ -186,7 +186,11 @@ async function postRpc<T>(params: {
   timeoutMs?: number;
 }): Promise<T> {
   const { apiKey, apiBaseUrl, rpcName, bodyObj, timeoutMs = HTTP_TIMEOUT_MS } = params;
-  if (!apiKey) throw new Error("API key is required");
+
+  // NOTE: API key validation removed intentionally to allow markdown conversion without auth.
+  // When apiKey is empty, API returns partial markdown (observations only, no full reports).
+  // API will return 401/403 for endpoints that require authentication.
+
   const base = normalizeBaseUrl(apiBaseUrl);
   const url = new URL(`${base}/rpc/${rpcName}`);
   const body = JSON.stringify(bodyObj);
@@ -384,3 +388,45 @@ export async function uploadCheckupReportJson(params: {
   }
   return { reportChunkId: chunkId };
 }
+
+/**
+ * Convert a checkup report JSON to markdown format using the PostgresAI API.
+ * This calls the v1.checkup_report_json_to_markdown RPC function.
+ *
+ * @param params - Configuration for the conversion
+ * @param params.apiKey - PostgresAI API access token
+ * @param params.apiBaseUrl - Base URL of the PostgresAI API
+ * @param params.checkId - Check identifier (e.g., "H001", "A003")
+ * @param params.jsonPayload - The JSON data from the check report
+ * @param params.reportType - Optional report type parameter
+ * @returns Promise resolving to the markdown content as JSON
+ * @throws {RpcError} On API failures (4xx/5xx responses)
+ * @throws {Error} On network errors or unexpected response format
+ */
+export async function convertCheckupReportJsonToMarkdown(params: {
+  apiKey: string;
+  apiBaseUrl: string;
+  checkId: string;
+  jsonPayload: any;
+  reportType?: string;
+}): Promise<any> {
+  const { apiKey, apiBaseUrl, checkId, jsonPayload, reportType } = params;
+  const bodyObj: Record<string, unknown> = {
+    check_id: checkId,
+    json_payload: jsonPayload,
+    access_token: apiKey,
+  };
+
+  if (reportType) {
+    bodyObj.report_type = reportType;
+  }
+
+  const resp = await postRpc<any>({
+    apiKey,
+    apiBaseUrl,
+    rpcName: "checkup_report_json_to_markdown",
+    bodyObj,
+  });
+
+  return resp;
+}