create-thally-docs 0.10.106 → 0.10.107

package/dist/{chunk-WV3IBK42.js → chunk-3XHWWST2.js}

@@ -124,15 +124,37 @@ function operationState(document, method, path, overrides) {
   const result = visibility(chain, operation, isObj(overrides) ? overrides[`${verb.toUpperCase()} ${path}`] : void 0);
   return result === "visible" ? "published" : result;
 }
-function webhookState(document, name, overrides) {
+function webhookState(document, name, overrides, method) {
   if (!isObj(document) || !isObj(document.webhooks) || !Object.hasOwn(document.webhooks, name)) return "unknown";
   const entry = document.webhooks[name];
   if (!isObj(entry)) return "unknown";
   const { chain, item } = viewEntry(document, entry);
-  const states = METHODS.filter((verb) => isObj(item[verb])).map((verb) => visibility(chain, item[verb], isObj(overrides) ? overrides[`WEBHOOK ${verb.toUpperCase()} ${name}`] : void 0));
+  const states = METHODS.filter((verb) => isObj(item[verb]) && (!method || verb === method.toLowerCase())).map((verb) => visibility(chain, item[verb], isObj(overrides) ? overrides[`WEBHOOK ${verb.toUpperCase()} ${name}`] : void 0));
   if (states.length === 0) return "unknown";
   return states.includes("visible") ? "published" : states[0];
 }
+var API_GROUPS_MAX_DEPTH = 32;
+function listedOperationKeys(groups, skipped, depth = 1) {
+  if (!Array.isArray(groups)) return [];
+  return groups.flatMap((group) => {
+    if (!isObj(group) || !Array.isArray(group.pages) || group.group !== void 0 && typeof group.group !== "string") {
+      if (skipped) skipped.malformed++;
+      return [];
+    }
+    if (depth > API_GROUPS_MAX_DEPTH) {
+      if (skipped) skipped.tooDeep = true;
+      return [];
+    }
+    if (skipped && group.icon !== void 0 && typeof group.icon !== "string") skipped.badIcon++;
+    return group.pages.flatMap((page) => typeof page === "string" ? [page] : listedOperationKeys([page], skipped, depth + 1));
+  });
+}
+function groupKeyState(document, key, overrides) {
+  const match = /^(WEBHOOK )?(\S+) (.+)$/i.exec(key.trim().replace(/\s+/g, " "));
+  if (!match) return "unknown";
+  const [, webhook, method, path] = match;
+  return webhook ? webhookState(document, path, overrides, method) : operationState(document, method, path, overrides);
+}
 
 // src/manual-api-check.ts
 import { unified } from "unified";
@@ -680,20 +702,78 @@ function checkPublicSpecs(projectDir, tabs, issues) {
     issues.push({ severity: "warning", file: path, message: `${path} is too large to inspect; if it is an OpenAPI file with hidden operations it is served as-is from public/` });
   }
 }
+function loadCheckSpec(projectDir, source, overrides) {
+  if (/^https?:/i.test(source)) return { source, overrides };
+  const specPath = source.startsWith("/") ? join(projectDir, "public", source.slice(1)) : join(projectDir, source);
+  try {
+    const raw = readFileSync(specPath, "utf8");
+    return { source, overrides, document: /\.json$/i.test(source) ? JSON.parse(raw) : parseYaml2(raw) };
+  } catch {
+    return { source, overrides };
+  }
+}
+function checkApiGroupKeys(projectDir, config, issues) {
+  const versions = config.navigation?.versions;
+  const seen = /* @__PURE__ */ new Set();
+  const scopes = [[void 0, config.tabs], ...Object.entries(config.i18n?.navigation ?? {})];
+  for (const [locale, tabs] of scopes) {
+    for (const tab of Array.isArray(tabs) ? tabs : []) {
+      if (!tab || typeof tab !== "object" || seen.has(tab)) continue;
+      seen.add(tab);
+      checkTabApiGroups(projectDir, tab, locale, versions, issues);
+    }
+  }
+}
+function checkTabApiGroups(projectDir, tab, locale, versions, issues) {
+  const name = `API tab "${tab.tab}"${locale ? ` (locale ${locale})` : ""}`;
+  const rendered = !tab.hidden || Boolean(tab.version && Array.isArray(versions) && versions.some((version) => version !== null && typeof version === "object" && version.label === tab.version));
+  if (!rendered || typeof tab.api?.source !== "string" || tab.api.navigation === false) return;
+  if (tab.api.groups !== void 0 && !Array.isArray(tab.api.groups)) {
+    issues.push({
+      severity: "warning",
+      file: "docs.json",
+      message: `${name}: api.groups must be a list of groups, so the tab shows the generated navigation. A list looks like [{ "group": "Name", "pages": ["GET /path"] }]`
+    });
+  }
+  const skipped = { malformed: 0, tooDeep: false, badIcon: 0 };
+  const keys = listedOperationKeys(tab.api.groups, skipped);
+  if (skipped.malformed > 0) {
+    issues.push({
+      severity: "warning",
+      file: "docs.json",
+      message: `${name}: api.groups has ${skipped.malformed} ${skipped.malformed === 1 ? "entry that is" : "entries that are"} not a group with a "pages" list or an operation key. ${skipped.malformed === 1 ? "It is" : "They are"} left out of the sidebar. A group looks like { "group": "Name", "pages": ["GET /path"] }`
+    });
+  }
+  if (skipped.badIcon > 0) {
+    issues.push({
+      severity: "warning",
+      file: "docs.json",
+      message: `${name}: api.groups has ${skipped.badIcon} ${skipped.badIcon === 1 ? "group" : "groups"} whose "icon" is not text. The icon is dropped and the group is still listed. Use an icon name or an image path`
+    });
+  }
+  if (skipped.tooDeep) {
+    issues.push({
+      severity: "warning",
+      file: "docs.json",
+      message: `${name}: api.groups nests groups deeper than ${API_GROUPS_MAX_DEPTH} levels. Groups beyond that level are left out of the sidebar`
+    });
+  }
+  if (keys.length === 0) return;
+  const spec = loadCheckSpec(projectDir, tab.api.source, tab.api.overrides);
+  if (!spec.document || typeof spec.document !== "object") return;
+  for (const key of keys) {
+    const state = groupKeyState(spec.document, key, spec.overrides);
+    if (state === "published") continue;
+    issues.push({
+      severity: "warning",
+      file: "docs.json",
+      message: `${name}: api.groups lists "${key}", which matches no published operation in ${spec.source}${state === "unknown" ? "" : ` (it is ${state})`}. It is left out of the sidebar. Check the method and path, or publish the operation`
+    });
+  }
+}
 function checkUnpublishedOperationPages(projectDir, tabs, pages, issues) {
   if (pages.length === 0) return;
-  const specs = tabs.filter((tab) => !tab.hidden && typeof tab.api?.source === "string").map((tab) => {
-    const source = tab.api.source;
-    const overrides = tab.api.overrides;
-    if (/^https?:/i.test(source)) return { source, overrides };
-    const specPath = source.startsWith("/") ? join(projectDir, "public", source.slice(1)) : join(projectDir, source);
-    try {
-      const raw = readFileSync(specPath, "utf8");
-      return { source, overrides, document: /\.json$/i.test(source) ? JSON.parse(raw) : parseYaml2(raw) };
-    } catch {
-      return { source, overrides };
-    }
-  });
+  const specs = tabs.filter((tab) => !tab.hidden && typeof tab.api?.source === "string").map((tab) => loadCheckSpec(projectDir, tab.api.source, tab.api.overrides));
   if (specs.length === 0) return;
   for (const { file, reference } of pages) {
     const state = pageState(reference, specs);
@@ -915,6 +995,7 @@ async function runCheck(projectDir, options) {
   }
   checkPublicSpecs(projectDir, config.tabs, issues);
   checkUnpublishedOperationPages(projectDir, config.tabs, operationPages, issues);
+  checkApiGroupKeys(projectDir, config, issues);
   if (options.external && externalLinks.length > 0) {
     issues.push(...await checkExternalLinks(externalLinks, options.externalLinkOptions));
   }

package/dist/index.js

@@ -5,7 +5,7 @@ import {
 import {
   parseFrontmatter,
   runCheck
-} from "./chunk-WV3IBK42.js";
+} from "./chunk-3XHWWST2.js";
 import "./chunk-KDLP27DS.js";
 import {
   logo,

package/dist/migration-worker.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   runCheck
-} from "./chunk-WV3IBK42.js";
+} from "./chunk-3XHWWST2.js";
 import "./chunk-KDLP27DS.js";
 import "./chunk-J7255UQA.js";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-thally-docs",
-  "version": "0.10.106",
+  "version": "0.10.107",
   "description": "Scaffold an open-source Thally docs site for people, search engines, and AI tools.",
   "type": "module",
   "engines": {
@@ -54,7 +54,7 @@
     "@clack/prompts": "^0.11.0",
     "@inquirer/prompts": "^7.0.0",
     "@thallylabs/core": "0.2.16",
-    "@thallylabs/migrate": "0.2.34",
+    "@thallylabs/migrate": "0.2.35",
     "p-limit": "^6.1.0",
     "remark-mdx": "^3.1.1",
     "remark-parse": "^11.0.0",