@checkdigit/eslint-plugin 7.17.1 → 7.18.0-PR.143-8290

package/dist-mjs/openapi/service-schema-generator.mjs

@@ -0,0 +1,147 @@
+// src/openapi/service-schema-generator.ts
+import { execFileSync } from "node:child_process";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import debug from "debug";
+import { buildApiSchemaFromYaml } from "./generate-schema.mjs";
+var log = debug("eslint-plugin:athena:service-schema-generator");
+var GITHUB_ORGANIZATIONS = ["checkdigit", "rebolt-checkdigit"];
+var SWAGGER_SCHEMA_DEREF_FILENAME = "swagger.schema.deref.json";
+function derefApiSchemas(schemas) {
+  const definitions = schemas.definitions ?? {};
+  function derefValue(value, resolving = /* @__PURE__ */ new Set()) {
+    if (value === null || typeof value !== "object") {
+      return value;
+    }
+    if (Array.isArray(value)) {
+      return value.map((item) => derefValue(item, resolving));
+    }
+    const obj = value;
+    if (typeof obj["$ref"] === "string") {
+      const refName = /\/definitions\/(?<name>[^/]+)$/u.exec(obj["$ref"])?.groups?.["name"];
+      if (refName !== void 0 && !resolving.has(refName)) {
+        return derefValue(definitions[refName], /* @__PURE__ */ new Set([...resolving, refName]));
+      }
+    }
+    return Object.fromEntries(Object.entries(obj).map(([key, val]) => [key, derefValue(val, resolving)]));
+  }
+  const resolvedApis = derefValue(schemas.apis);
+  if (schemas.definitions !== void 0) {
+    return {
+      apis: resolvedApis,
+      definitions: derefValue(schemas.definitions)
+    };
+  }
+  return { apis: resolvedApis };
+}
+function fetchUrlSync(url) {
+  try {
+    return execFileSync(process.execPath, ["--input-type=module"], {
+      input: `const r=await fetch(${JSON.stringify(url)});if(!r.ok)process.exit(1);process.stdout.write(await r.text());`,
+      encoding: "utf-8",
+      timeout: 15e3
+    });
+  } catch {
+    return null;
+  }
+}
+function readServiceConfig(packageJsonContent, org, serviceName) {
+  const packageJson = JSON.parse(packageJsonContent);
+  const apiRoot = packageJson.service?.api?.root;
+  const apiEndpoints = packageJson.service?.api?.endpoints;
+  if (apiRoot === void 0 || apiEndpoints === void 0 || apiEndpoints.length === 0) {
+    return null;
+  }
+  const pkgOrg = packageJson.name?.slice(1).split("/")[0] ?? org;
+  const pkgServiceName = packageJson.name?.slice(1).split("/")[1] ?? serviceName;
+  return { organization: pkgOrg, serviceName: pkgServiceName, apiRoot, endpoints: apiEndpoints };
+}
+function findServiceInNodeModules(serviceName) {
+  for (const org of GITHUB_ORGANIZATIONS) {
+    const packageDir = `node_modules/@${org}/${serviceName}`;
+    const packageJsonPath = `${packageDir}/package.json`;
+    if (!existsSync(packageJsonPath)) {
+      continue;
+    }
+    try {
+      const config = readServiceConfig(readFileSync(packageJsonPath, "utf-8"), org, serviceName);
+      if (config === null) {
+        continue;
+      }
+      const endpoints = [];
+      for (const endpoint of config.endpoints) {
+        const swaggerPath = `${packageDir}/${config.apiRoot}/${endpoint}/swagger.yml`;
+        if (existsSync(swaggerPath)) {
+          endpoints.push({ path: endpoint, yamlContent: readFileSync(swaggerPath, "utf-8") });
+        }
+      }
+      if (endpoints.length > 0) {
+        return { organization: config.organization, serviceName: config.serviceName, endpoints };
+      }
+    } catch {
+    }
+  }
+  return null;
+}
+function findServiceOnGitHub(serviceName) {
+  for (const org of GITHUB_ORGANIZATIONS) {
+    const pkgUrl = `https://raw.githubusercontent.com/${org}/${serviceName}/main/package.json`;
+    log(`fetching package.json from ${pkgUrl}`);
+    const pkgContent = fetchUrlSync(pkgUrl);
+    if (pkgContent === null) {
+      continue;
+    }
+    try {
+      const config = readServiceConfig(pkgContent, org, serviceName);
+      if (config === null) {
+        continue;
+      }
+      const endpoints = [];
+      for (const endpoint of config.endpoints) {
+        const swaggerUrl = `https://raw.githubusercontent.com/${org}/${serviceName}/main/${config.apiRoot}/${endpoint}/swagger.yml`;
+        log(`fetching swagger.yml from ${swaggerUrl}`);
+        const yamlContent = fetchUrlSync(swaggerUrl);
+        if (yamlContent !== null) {
+          endpoints.push({ path: endpoint, yamlContent });
+        }
+      }
+      if (endpoints.length > 0) {
+        return { organization: config.organization, serviceName: config.serviceName, endpoints };
+      }
+    } catch {
+    }
+  }
+  return null;
+}
+function generateSchemasForService(serviceName, outputDir) {
+  log("generating schemas for service", serviceName);
+  const source = findServiceInNodeModules(serviceName) ?? findServiceOnGitHub(serviceName);
+  if (source === null) {
+    log("no swagger source found for service", serviceName);
+    return [];
+  }
+  const results = [];
+  for (const { path: endpoint, yamlContent } of source.endpoints) {
+    try {
+      const rawSchema = buildApiSchemaFromYaml(yamlContent, source.organization, source.serviceName);
+      if (rawSchema === null) {
+        continue;
+      }
+      const schema = derefApiSchemas(rawSchema);
+      results.push({ schema, endpoint });
+      if (outputDir !== void 0) {
+        const versionFolder = endpoint.split("/").at(-1) ?? endpoint;
+        const dir = `${outputDir}/${versionFolder}`;
+        mkdirSync(dir, { recursive: true });
+        writeFileSync(`${dir}/${SWAGGER_SCHEMA_DEREF_FILENAME}`, JSON.stringify(schema, void 0, 2));
+        log(`cached schema to ${dir}/${SWAGGER_SCHEMA_DEREF_FILENAME}`);
+      }
+    } catch (error) {
+      log("error generating schema for endpoint", endpoint, error);
+    }
+  }
+  return results;
+}
+export {
+  generateSchemasForService
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vc3JjL29wZW5hcGkvc2VydmljZS1zY2hlbWEtZ2VuZXJhdG9yLnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQUVBLFNBQVMsb0JBQW9CO0FBQzdCLFNBQVMsWUFBWSxXQUFXLGNBQWMscUJBQXFCO0FBRW5FLE9BQU8sV0FBVztBQUVsQixTQUEwQiw4QkFBOEI7QUFFeEQsSUFBTSxNQUFNLE1BQU0sK0NBQStDO0FBRWpFLElBQU0sdUJBQXVCLENBQUMsY0FBYyxtQkFBbUI7QUFDL0QsSUFBTSxnQ0FBZ0M7QUFhdEMsU0FBUyxnQkFBZ0IsU0FBaUM7QUFDeEQsUUFBTSxjQUFjLFFBQVEsZUFBZSxDQUFDO0FBRTVDLFdBQVMsV0FBVyxPQUFnQixZQUF5QixvQkFBSSxJQUFZLEdBQVk7QUFDdkYsUUFBSSxVQUFVLFFBQVEsT0FBTyxVQUFVLFVBQVU7QUFDL0MsYUFBTztBQUFBLElBQ1Q7QUFDQSxRQUFJLE1BQU0sUUFBUSxLQUFLLEdBQUc7QUFDeEIsYUFBTyxNQUFNLElBQUksQ0FBQyxTQUFTLFdBQVcsTUFBTSxTQUFTLENBQUM7QUFBQSxJQUN4RDtBQUNBLFVBQU0sTUFBTTtBQUNaLFFBQUksT0FBTyxJQUFJLE1BQU0sTUFBTSxVQUFVO0FBQ25DLFlBQU0sVUFBVSxrQ0FBa0MsS0FBSyxJQUFJLE1BQU0sQ0FBQyxHQUFHLFNBQVMsTUFBTTtBQUNwRixVQUFJLFlBQVksVUFBYSxDQUFDLFVBQVUsSUFBSSxPQUFPLEdBQUc7QUFDcEQsZUFBTyxXQUFXLFlBQVksT0FBTyxHQUFHLG9CQUFJLElBQVksQ0FBQyxHQUFHLFdBQVcsT0FBTyxDQUFDLENBQUM7QUFBQSxNQUNsRjtBQUFBLElBQ0Y7QUFDQSxXQUFPLE9BQU8sWUFBWSxPQUFPLFFBQVEsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDLEtBQUssR0FBRyxNQUFNLENBQUMsS0FBSyxXQUFXLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQztBQUFBLEVBQ3RHO0FBRUEsUUFBTSxlQUFlLFdBQVcsUUFBUSxJQUFJO0FBQzVDLE1BQUksUUFBUSxnQkFBZ0IsUUFBVztBQUNyQyxXQUFPO0FBQUEsTUFDTCxNQUFNO0FBQUEsTUFDTixhQUFhLFdBQVcsUUFBUSxXQUFXO0FBQUEsSUFDN0M7QUFBQSxFQUNGO0FBQ0EsU0FBTyxFQUFFLE1BQU0sYUFBYTtBQUM5QjtBQUVBLFNBQVMsYUFBYSxLQUE0QjtBQUNoRCxNQUFJO0FBQ0YsV0FBTyxhQUFhLFFBQVEsVUFBVSxDQUFDLHFCQUFxQixHQUFHO0FBQUEsTUFDN0QsT0FBTyx1QkFBdUIsS0FBSyxVQUFVLEdBQUcsQ0FBQztBQUFBLE1BQ2pELFVBQVU7QUFBQSxNQUNWLFNBQVM7QUFBQSxJQUNYLENBQUM7QUFBQSxFQUNILFFBQVE7QUFDTixXQUFPO0FBQUEsRUFDVDtBQUNGO0FBRUEsU0FBUyxrQkFDUCxvQkFDQSxLQUNBLGFBQzRGO0FBQzVGLFFBQU0sY0FBYyxLQUFLLE1BQU0sa0JBQWtCO0FBSWpELFFBQU0sVUFBVSxZQUFZLFNBQVMsS0FBSztBQUMxQyxRQUFNLGVBQWUsWUFBWSxTQUFTLEtBQUs7QUFDL0MsTUFBSSxZQUFZLFVBQWEsaUJBQWlCLFVBQWEsYUFBYSxXQUFXLEdBQUc7QUFDcEYsV0FBTztBQUFBLEVBQ1Q7QUFDQSxRQUFNLFNBQVMsWUFBWSxNQUFNLE1BQU0sQ0FBQyxFQUFFLE1BQU0sR0FBRyxFQUFFLENBQUMsS0FBSztBQUMzRCxRQUFNLGlCQUFpQixZQUFZLE1BQU0sTUFBTSxDQUFDLEVBQUUsTUFBTSxHQUFHLEVBQUUsQ0FBQyxLQUFLO0FBQ25FLFNBQU8sRUFBRSxjQUFjLFFBQVEsYUFBYSxnQkFBZ0IsU0FBUyxXQUFXLGFBQWE7QUFDL0Y7QUFFQSxTQUFTLHlCQUF5QixhQUEyQztBQUMzRSxhQUFXLE9BQU8sc0JBQXNCO0FBQ3RDLFVBQU0sYUFBYSxpQkFBaUIsR0FBRyxJQUFJLFdBQVc7QUFDdEQsVUFBTSxrQkFBa0IsR0FBRyxVQUFVO0FBQ3JDLFFBQUksQ0FBQyxXQUFXLGVBQWUsR0FBRztBQUNoQztBQUFBLElBQ0Y7QUFFQSxRQUFJO0FBQ0YsWUFBTSxTQUFTLGtCQUFrQixhQUFhLGlCQUFpQixPQUFPLEdBQUcsS0FBSyxXQUFXO0FBQ3pGLFVBQUksV0FBVyxNQUFNO0FBQ25CO0FBQUEsTUFDRjtBQUVBLFlBQU0sWUFBK0IsQ0FBQztBQUN0QyxpQkFBVyxZQUFZLE9BQU8sV0FBVztBQUN2QyxjQUFNLGNBQWMsR0FBRyxVQUFVLElBQUksT0FBTyxPQUFPLElBQUksUUFBUTtBQUMvRCxZQUFJLFdBQVcsV0FBVyxHQUFHO0FBQzNCLG9CQUFVLEtBQUssRUFBRSxNQUFNLFVBQVUsYUFBYSxhQUFhLGFBQWEsT0FBTyxFQUFFLENBQUM7QUFBQSxRQUNwRjtBQUFBLE1BQ0Y7QUFFQSxVQUFJLFVBQVUsU0FBUyxHQUFHO0FBQ3hCLGVBQU8sRUFBRSxjQUFjLE9BQU8sY0FBYyxhQUFhLE9BQU8sYUFBYSxVQUFVO0FBQUEsTUFDekY7QUFBQSxJQUNGLFFBQVE7QUFBQSxJQUVSO0FBQUEsRUFDRjtBQUNBLFNBQU87QUFDVDtBQUVBLFNBQVMsb0JBQW9CLGFBQTJDO0FBQ3RFLGFBQVcsT0FBTyxzQkFBc0I7QUFDdEMsVUFBTSxTQUFTLHFDQUFxQyxHQUFHLElBQUksV0FBVztBQUN0RSxRQUFJLDhCQUE4QixNQUFNLEVBQUU7QUFDMUMsVUFBTSxhQUFhLGFBQWEsTUFBTTtBQUN0QyxRQUFJLGVBQWUsTUFBTTtBQUN2QjtBQUFBLElBQ0Y7QUFFQSxRQUFJO0FBQ0YsWUFBTSxTQUFTLGtCQUFrQixZQUFZLEtBQUssV0FBVztBQUM3RCxVQUFJLFdBQVcsTUFBTTtBQUNuQjtBQUFBLE1BQ0Y7QUFFQSxZQUFNLFlBQStCLENBQUM7QUFDdEMsaUJBQVcsWUFBWSxPQUFPLFdBQVc7QUFDdkMsY0FBTSxhQUFhLHFDQUFxQyxHQUFHLElBQUksV0FBVyxTQUFTLE9BQU8sT0FBTyxJQUFJLFFBQVE7QUFDN0csWUFBSSw2QkFBNkIsVUFBVSxFQUFFO0FBQzdDLGNBQU0sY0FBYyxhQUFhLFVBQVU7QUFDM0MsWUFBSSxnQkFBZ0IsTUFBTTtBQUN4QixvQkFBVSxLQUFLLEVBQUUsTUFBTSxVQUFVLFlBQVksQ0FBQztBQUFBLFFBQ2hEO0FBQUEsTUFDRjtBQUVBLFVBQUksVUFBVSxTQUFTLEdBQUc7QUFDeEIsZUFBTyxFQUFFLGNBQWMsT0FBTyxjQUFjLGFBQWEsT0FBTyxhQUFhLFVBQVU7QUFBQSxNQUN6RjtBQUFBLElBQ0YsUUFBUTtBQUFBLElBRVI7QUFBQSxFQUNGO0FBQ0EsU0FBTztBQUNUO0FBRU8sU0FBUywwQkFDZCxhQUNBLFdBQzRDO0FBQzVDLE1BQUksa0NBQWtDLFdBQVc7QUFFakQsUUFBTSxTQUFTLHlCQUF5QixXQUFXLEtBQUssb0JBQW9CLFdBQVc7QUFDdkYsTUFBSSxXQUFXLE1BQU07QUFDbkIsUUFBSSx1Q0FBdUMsV0FBVztBQUN0RCxXQUFPLENBQUM7QUFBQSxFQUNWO0FBRUEsUUFBTSxVQUFzRCxDQUFDO0FBQzdELGFBQVcsRUFBRSxNQUFNLFVBQVUsWUFBWSxLQUFLLE9BQU8sV0FBVztBQUM5RCxRQUFJO0FBQ0YsWUFBTSxZQUFZLHVCQUF1QixhQUFhLE9BQU8sY0FBYyxPQUFPLFdBQVc7QUFDN0YsVUFBSSxjQUFjLE1BQU07QUFDdEI7QUFBQSxNQUNGO0FBQ0EsWUFBTSxTQUFTLGdCQUFnQixTQUFTO0FBQ3hDLGNBQVEsS0FBSyxFQUFFLFFBQVEsU0FBUyxDQUFDO0FBRWpDLFVBQUksY0FBYyxRQUFXO0FBQzNCLGNBQU0sZ0JBQWdCLFNBQVMsTUFBTSxHQUFHLEVBQUUsR0FBRyxFQUFFLEtBQUs7QUFDcEQsY0FBTSxNQUFNLEdBQUcsU0FBUyxJQUFJLGFBQWE7QUFDekMsa0JBQVUsS0FBSyxFQUFFLFdBQVcsS0FBSyxDQUFDO0FBQ2xDLHNCQUFjLEdBQUcsR0FBRyxJQUFJLDZCQUE2QixJQUFJLEtBQUssVUFBVSxRQUFRLFFBQVcsQ0FBQyxDQUFDO0FBQzdGLFlBQUksb0JBQW9CLEdBQUcsSUFBSSw2QkFBNkIsRUFBRTtBQUFBLE1BQ2hFO0FBQUEsSUFDRixTQUFTLE9BQU87QUFDZCxVQUFJLHdDQUF3QyxVQUFVLEtBQUs7QUFBQSxJQUM3RDtBQUFBLEVBQ0Y7QUFFQSxTQUFPO0FBQ1Q7IiwKICAibmFtZXMiOiBbXQp9Cg==