From 92851d9adb9020dcbc625682819d6bdcb4905cfa Mon Sep 17 00:00:00 2001
From: Peter Smith <peter@blueoceancomputing.co.uk>
Date: Mon, 28 Oct 2024 11:01:12 +0000
Subject: [PATCH 1/2] Revert "chore: reinstate incorrectly removed code block
 (#45)"

This reverts commit a38e179e809698ed00bb5715db18edbf46b36675.
---
 docs-hub/vp-docs.js | 23 +----------------------
 1 file changed, 1 insertion(+), 22 deletions(-)

diff --git a/docs-hub/vp-docs.js b/docs-hub/vp-docs.js
index aa27c40..bd83b2e 100644
--- a/docs-hub/vp-docs.js
+++ b/docs-hub/vp-docs.js
@@ -10,7 +10,7 @@ const configPath = path.join(srcFolderPath, "../.vitepress/config.ts");
 
 const configFile = fs.readFileSync(configPath, "utf8");
 
-const subFolderExceptions = ["guide", "api"];
+const subFolderExceptions = ["guide"];
 
 function main() {
   checkForIndexFile(srcFolderPath);
@@ -91,27 +91,6 @@ function checkForUnusedFiles(srcFolderPath, subfolders) {
     const folderPath = path.join(srcFolderPath, folder);
     const subfolderNames = fs.readdirSync(folderPath);
     const parentFolder = folderPath.split("/").pop();
-    subfolderNames.forEach((subFile) => {
-      const actualPath = `${parentFolder}/${
-        subFile === "index.md" ? "" : subFile
-      }`;
-      assert(
-        configFile.includes(actualPath),
-        `${actualPath} missing in the nav config`
-      );
-      const fullPath = path.join(srcFolderPath, actualPath);
-      if (fs.statSync(fullPath).isDirectory()) {
-        const subFolderFiles = fs.readdirSync(fullPath);
-        subFolderFiles.forEach((file) => {
-          if (file !== "index.md") {
-            assert(
-              configFile.includes(file.replace(".md", "")),
-              `${file} missing in the nav config`
-            );
-          }
-        });
-      }
-    });
   });
 }
 

From 043f69d7ac2660bccd092bc08a55ed71862158cd Mon Sep 17 00:00:00 2001
From: Peter Smith <peter@blueoceancomputing.co.uk>
Date: Mon, 28 Oct 2024 11:01:24 +0000
Subject: [PATCH 2/2] Revert "chore: remove docs validation for ts sdk api docs
 (#43)"

This reverts commit 1c646b5c4f001052549747e2049b2425107f6b82.
---
 docs-hub/vp-docs.js | 48 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 46 insertions(+), 2 deletions(-)

diff --git a/docs-hub/vp-docs.js b/docs-hub/vp-docs.js
index bd83b2e..3636b78 100644
--- a/docs-hub/vp-docs.js
+++ b/docs-hub/vp-docs.js
@@ -7,10 +7,12 @@ const srcFolderPath = path.join(process.cwd(), `../../${process.argv[2]}`);
 const subfolders = getSubfolders(srcFolderPath);
 
 const configPath = path.join(srcFolderPath, "../.vitepress/config.ts");
+const apiOrderPath = path.join(srcFolderPath, "../.typedoc/api-links.json");
 
 const configFile = fs.readFileSync(configPath, "utf8");
+const apiOrderFile = fs.readFileSync(apiOrderPath, "utf8");
 
-const subFolderExceptions = ["guide"];
+const subFolderExceptions = ["guide", "api"];
 
 function main() {
   checkForIndexFile(srcFolderPath);
@@ -77,6 +79,7 @@ function checkForUnusedFiles(srcFolderPath, subfolders) {
   const fileNames = fs.readdirSync(srcFolderPath);
   fileNames.forEach((file) => {
     if (
+      file !== "api" &&
       file !== "public" &&
       file !== "index.md" &&
       (file.endsWith("md") || file.split(".").length === 1)
@@ -91,6 +94,29 @@ function checkForUnusedFiles(srcFolderPath, subfolders) {
     const folderPath = path.join(srcFolderPath, folder);
     const subfolderNames = fs.readdirSync(folderPath);
     const parentFolder = folderPath.split("/").pop();
+    subfolderNames.forEach((subFile) => {
+      if (parentFolder !== "api") {
+        const actualPath = `${parentFolder}/${
+          subFile === "index.md" ? "" : subFile
+        }`;
+        assert(
+          configFile.includes(actualPath),
+          `${actualPath} missing in the nav config`
+        );
+        const fullPath = path.join(srcFolderPath, actualPath);
+        if (fs.statSync(fullPath).isDirectory()) {
+          const subFolderFiles = fs.readdirSync(fullPath);
+          subFolderFiles.forEach((file) => {
+            if (file !== "index.md") {
+              assert(
+                configFile.includes(file.replace(".md", "")),
+                `${file} missing in the nav config`
+              );
+            }
+          });
+        }
+      }
+    });
   });
 }
 
@@ -173,7 +199,7 @@ function checkOrder(order, altSrcFolderPath = null) {
         }
         assert(
           fileExists,
-          `${item} doesn't exist. The file name must match the title in the nav config.`
+          `${item} doesn't exist. The file name must match the title in the nav config. If this file is in the API folder, something went wrong.`
         );
       });
     }
@@ -181,6 +207,7 @@ function checkOrder(order, altSrcFolderPath = null) {
 }
 
 function extractData(inputString) {
+  // used for api.json order
   const regex = /"([^"]+)":\s*"([^"]+)"/g;
   const match = regex.exec(inputString);
   if (match !== null) {
@@ -235,6 +262,23 @@ function handleVPLine(trimmedLine, lines, index, thisOrder, thisCat) {
         newVPOrder.menu.push(linkName);
       }
     }
+  } else if (trimmedLine.startsWith("apiLinks")) {
+    // handle API order
+    newVPOrder.menu.push("API");
+    const apiJSON = JSON.parse(apiOrderFile);
+    const apiLines = JSON.stringify(apiJSON, null, 2).split(EOL);
+    apiLines.forEach((apiLine, apiIndex) => {
+      const trimmedAPILine = apiLine.trimStart();
+      const results = handleVPLine(
+        trimmedAPILine,
+        apiLines,
+        apiIndex,
+        newVPOrder,
+        category
+      );
+      category = results.category;
+      newVPOrder = results.newVPOrder;
+    });
   }
 
   return { newVPOrder, category };