@redocly/cli 2.36.0 → 2.38.0

package/lib/chunks/ZK3QRKL5.js

@@ -0,0 +1,129 @@
+import { createRequire as __createRequire } from 'node:module';
+const require = __createRequire(import.meta.url);
+import {
+  initRules,
+  require_graphql
+} from "./Z2I5YXYN.js";
+import {
+  __toESM
+} from "./5ILQMFXK.js";
+
+// ../core/lib/graphql/lint-graphql.js
+var import_graphql2 = __toESM(require_graphql(), 1);
+
+// ../core/lib/graphql/visitor.js
+var import_graphql = __toESM(require_graphql(), 1);
+function toAstVisitor(visitor, opts) {
+  const astVisitor = {};
+  for (const kind of Object.keys(visitor)) {
+    const handler = visitor[kind];
+    if (!handler)
+      continue;
+    const enter = typeof handler === "function" ? handler : handler.enter;
+    const leave = typeof handler === "function" ? void 0 : handler.leave;
+    astVisitor[kind] = {
+      ...enter ? { enter: wrap(enter, opts) } : {},
+      ...leave ? { leave: wrap(leave, opts) } : {}
+    };
+  }
+  return astVisitor;
+}
+function wrap(fn, opts) {
+  return (node, _key, _parent, _path, ancestors) => {
+    fn(node, makeContext(node, opts, ancestors));
+  };
+}
+function makeContext(currentNode, opts, rawAncestors = []) {
+  const { ruleId, severity, message, source, config, problems } = opts;
+  const ancestors = rawAncestors.filter((ancestor) => !Array.isArray(ancestor));
+  return {
+    source,
+    config,
+    ancestors,
+    report(problem) {
+      const node = problem.node ?? currentNode;
+      const loc = problem.loc ?? nodeToLoc(node);
+      const location = {
+        source,
+        pointer: void 0,
+        start: loc?.start ?? { line: 1, col: 1 },
+        end: loc?.end
+      };
+      problems.push({
+        ruleId: problem.ruleId ?? ruleId,
+        severity: problem.severity ?? severity,
+        message: message ? message.replace("{{message}}", problem.message) : problem.message,
+        suggest: problem.suggest ?? [],
+        location: [location]
+      });
+    }
+  };
+}
+function nodeToLoc(node) {
+  if (!node?.loc)
+    return void 0;
+  const start = (0, import_graphql.getLocation)(node.loc.source, node.loc.start);
+  const end = (0, import_graphql.getLocation)(node.loc.source, node.loc.end);
+  return {
+    start: { line: start.line, col: start.column },
+    end: { line: end.line, col: end.column }
+  };
+}
+
+// ../core/lib/graphql/lint-graphql.js
+function lintGraphqlDocument(opts) {
+  const { document, config } = opts;
+  const source = document.source;
+  if (source.body.trim() === "") {
+    return [
+      {
+        ruleId: "struct",
+        severity: "error",
+        message: "The GraphQL document is empty. Expected at least one type definition.",
+        suggest: [],
+        location: [{ source, pointer: void 0, start: { line: 1, col: 1 } }]
+      }
+    ];
+  }
+  let ast;
+  try {
+    ast = (0, import_graphql2.parse)(new import_graphql2.Source(source.body, source.absoluteRef));
+  } catch (e) {
+    if (e instanceof import_graphql2.GraphQLError) {
+      return [syntaxErrorToProblem(e, source)];
+    }
+    throw e;
+  }
+  const ruleSets = config.getRulesForSpecVersion("graphql") ?? [];
+  const rules = initRules(ruleSets, config, "rules", "graphql");
+  const problems = runGraphqlRules({ ast, source, config, rules });
+  return problems.map((problem) => config.addProblemToIgnore(problem));
+}
+function syntaxErrorToProblem(error, source) {
+  const loc = error.locations?.[0];
+  return {
+    ruleId: "struct",
+    severity: "error",
+    message: error.message,
+    suggest: [],
+    location: [
+      {
+        source,
+        pointer: void 0,
+        start: loc ? { line: loc.line, col: loc.column } : { line: 1, col: 1 }
+      }
+    ]
+  };
+}
+function runGraphqlRules(opts) {
+  const { ast, source, config, rules } = opts;
+  const problems = [];
+  const astVisitors = rules.map(({ ruleId, severity, message, visitor }) => toAstVisitor(visitor, { ruleId, severity, message, source, config, problems }));
+  if (astVisitors.length > 0) {
+    (0, import_graphql2.visit)(ast, (0, import_graphql2.visitInParallel)(astVisitors));
+  }
+  return problems;
+}
+export {
+  lintGraphqlDocument
+};

package/lib/index.js

@@ -6,12 +6,10 @@ import {
   ulid
 } from "./chunks/ICAVAH7N.js";
 import {
-  AbortFlowError,
   capitalize,
   cleanColors,
   dumpBundle,
   escapeLanguageName,
-  exitWithError,
   formatPath,
   getAliasOrPath,
   getAndValidateFileExtension,
@@ -30,7 +28,11 @@ import {
   saveBundle,
   sortTopLevelKeys,
   writeToFileByExtension
-} from "./chunks/R5E5LXAJ.js";
+} from "./chunks/QUMOPKXU.js";
+import {
+  AbortFlowError,
+  exitWithError
+} from "./chunks/FL4Q7PMA.js";
 import {
   RedoclyOAuthClient,
   ReuniteApi,
@@ -39,26 +41,29 @@ import {
   getDomain,
   getProxyUrl,
   getReuniteUrl,
-  require_undici,
   shouldBypassProxy
-} from "./chunks/FMJFZCNQ.js";
+} from "./chunks/K5FO6VRS.js";
 import {
   ANONYMOUS_ID_CACHE_FILE,
   DEFAULT_FETCH_TIMEOUT,
   OTEL_URL
 } from "./chunks/Y6DTFCLS.js";
-import "./chunks/SHVJYD75.js";
+import "./chunks/4FB5ZIPP.js";
 import {
   engines,
   name,
   version
-} from "./chunks/K6PX5SU7.js";
+} from "./chunks/PIMMKQJ7.js";
+import {
+  require_undici
+} from "./chunks/XB6C62FW.js";
 import {
   RESET_ESCAPE_CODE,
   calculateTotals,
   conditionallyMaskSecrets
-} from "./chunks/35B2IXV3.js";
+} from "./chunks/M5T4PDSH.js";
 import "./chunks/VXIQEZPR.js";
+import "./chunks/UUU33DK3.js";
 import {
   BaseResolver,
   HandledError,
@@ -109,7 +114,8 @@ import {
   white,
   xmlEscape,
   yellow
-} from "./chunks/UVIPIXTL.js";
+} from "./chunks/MIPR6NCD.js";
+import "./chunks/Z2I5YXYN.js";
 import {
   __commonJS,
   __require,
@@ -7703,7 +7709,7 @@ async function handleGenerateArazzo({
     config: config3
   };
   try {
-    const { generate } = await import("./chunks/4QGHXAYN.js");
+    const { generate } = await import("./chunks/EDHFTO4X.js");
     logger.info(gray("\n  Generating Arazzo description... \n"));
     const generatedArazzo = await generate(options);
     writeFileSync2(outputFile, stringifyYaml(generatedArazzo));
@@ -9179,7 +9185,7 @@ async function handleRespect({
   let mtlsCerts;
   let harLogs;
   try {
-    const { run, conditionallyMaskSecrets: conditionallyMaskSecrets2 } = await import("./chunks/4QGHXAYN.js");
+    const { run, conditionallyMaskSecrets: conditionallyMaskSecrets2 } = await import("./chunks/EDHFTO4X.js");
     const workingDir = config3.configPath ? dirname4(config3.configPath) : process.cwd();
     if (argv.mtls) {
       mtlsCerts = resolveMtlsCertificates(argv.mtls, workingDir);
@@ -12699,7 +12705,7 @@ async function sendTelemetry({
       $0: _,
       ...args
     } = argv;
-    const { RedoclyOAuthClient: RedoclyOAuthClient2 } = await import("./chunks/SBGJND3Q.js");
+    const { RedoclyOAuthClient: RedoclyOAuthClient2 } = await import("./chunks/N2TQJ4KM.js");
     const oauthClient = new RedoclyOAuthClient2();
     const reuniteUrl = getReuniteUrl(config3, args.residency);
     const logged_in = await oauthClient.isAuthorized(reuniteUrl);
@@ -12747,7 +12753,7 @@ async function sendTelemetry({
       category: "product",
       data: eventData
     });
-    const { otelTelemetry } = await import("./chunks/7PWB3SB5.js");
+    const { otelTelemetry } = await import("./chunks/G76UYYPW.js");
     otelTelemetry.send(cloudEvent);
   } catch (err) {
   }
@@ -13577,7 +13583,7 @@ yargs_default(hideBin(process.argv)).version("version", "Show version number.",
     return true;
   }),
   async (argv) => {
-    const { handlerBuildCommand } = await import("./chunks/XTSKVMID.js");
+    const { handlerBuildCommand } = await import("./chunks/OPV3WWWU.js");
     commandWrapper(handlerBuildCommand)(argv);
   }
 ).command(
@@ -13775,6 +13781,144 @@ yargs_default(hideBin(process.argv)).version("version", "Show version number.",
   async (argv) => {
     commandWrapper(handleScorecardClassic)(argv);
   }
+).command(
+  "drift <traffic>",
+  "Detect drift between recorded HTTP traffic and an OpenAPI description [experimental].",
+  (yargs) => yargs.env("REDOCLY_CLI_DRIFT").positional("traffic", {
+    describe: "Path to a traffic log file or folder (HAR, Kong, Nginx/Apache JSON, NDJSON).",
+    type: "string"
+  }).option({
+    api: {
+      describe: "OpenAPI description file or folder to validate against.",
+      type: "string",
+      demandOption: true
+    },
+    "traffic-format": {
+      describe: "Traffic input format.",
+      choices: [
+        "auto",
+        "har",
+        "kong",
+        "nginx-json",
+        "apache-json",
+        "ndjson"
+      ],
+      default: "auto"
+    },
+    "report-format": {
+      describe: "Output format.",
+      alias: "format",
+      choices: ["pretty", "json", "csv", "sarif"],
+      default: "pretty"
+    },
+    "match-mode": {
+      describe: "Endpoint matching mode (how requests are located via the description servers). Mutually exclusive with --server.",
+      choices: ["strict-host", "basepath"],
+      defaultDescription: "strict-host"
+    },
+    "ignore-cookies": {
+      describe: "Ignore cookie-based checks (useful for logs exported without cookies).",
+      type: "boolean",
+      default: false
+    },
+    "max-findings": {
+      describe: "Maximum findings shown in pretty output.",
+      type: "number",
+      default: 10
+    },
+    "min-severity": {
+      describe: "Discard findings below this severity from the report.",
+      choices: ["info", "warning", "error"],
+      default: "info"
+    },
+    rules: {
+      describe: "Comma-separated builtin rules to run.",
+      type: "string"
+    },
+    output: {
+      alias: "o",
+      describe: "Write the drift report (in the format selected with --format) to this file instead of stdout.",
+      type: "string"
+    },
+    server: {
+      describe: "Server URL the traffic was captured against: only requests under it are considered, and the rest of their URL is treated as the API path. It replaces the description servers and the remaining path is matched against the description paths directly. Mutually exclusive with --match-mode.",
+      type: "string"
+    },
+    config: { describe: "Path to the config file.", type: "string" },
+    "lint-config": {
+      describe: "Severity level for config file linting.",
+      choices: ["warn", "error", "off"],
+      default: "warn"
+    }
+  }),
+  async (argv) => {
+    const { handleDrift } = await import("./chunks/U2FUDUNT.js");
+    commandWrapper(handleDrift)(argv);
+  }
+).command(
+  "proxy",
+  "Capture live HTTP traffic through a reverse proxy into a HAR file, optionally validating it against an OpenAPI description [experimental].",
+  (yargs) => yargs.env("REDOCLY_CLI_PROXY").option({
+    target: {
+      describe: "Upstream base URL to forward captured requests to.",
+      type: "string",
+      demandOption: true
+    },
+    port: {
+      describe: "Port the proxy listens on.",
+      type: "number",
+      default: 4040
+    },
+    host: {
+      describe: "Host the proxy binds to.",
+      type: "string",
+      default: "127.0.0.1"
+    },
+    har: {
+      describe: "Path to the HAR file where captured traffic is written.",
+      type: "string",
+      demandOption: true
+    },
+    api: {
+      describe: "OpenAPI description file or folder to validate captured traffic against (live).",
+      type: "string"
+    },
+    "report-format": {
+      describe: "Output format for the validation report printed on shutdown.",
+      alias: "format",
+      choices: ["pretty", "json", "csv", "sarif"],
+      default: "pretty"
+    },
+    "match-mode": {
+      describe: "Endpoint matching mode.",
+      choices: ["strict-host", "basepath"],
+      default: "strict-host"
+    },
+    "ignore-cookies": {
+      describe: "Ignore cookie-based checks.",
+      type: "boolean",
+      default: false
+    },
+    "max-findings": {
+      describe: "Maximum findings shown in pretty output.",
+      type: "number",
+      default: 10
+    },
+    rules: {
+      describe: "Comma-separated builtin rules to run.",
+      type: "string"
+    },
+    config: { describe: "Path to the config file.", type: "string" },
+    "lint-config": {
+      describe: "Severity level for config file linting.",
+      choices: ["warn", "error", "off"],
+      default: "warn"
+    }
+  }),
+  async (argv) => {
+    const { handleProxy } = await import("./chunks/NPHT727D.js");
+    commandWrapper(handleProxy)(argv);
+  }
 ).completion("completion", "Generate autocomplete script for `redocly` command.").demandCommand(1).middleware([notifyUpdateCliVersion]).strict().argv;
 /*! Bundled license information:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "2.36.0",
+  "version": "2.38.0",
   "description": "",
   "license": "MIT",
   "type": "module",