PR cleanup

Author: stocaaro

src/components/ApiDocs/ReferencePage.tsx

@@ -2,12 +2,10 @@ import { Fragment } from 'react';
 
 import { FunctionReference } from './FunctionReference';
 import { Divider, View, Flex } from '@aws-amplify/ui-react';
-import { packageCategories } from '@/data/api-categories.mjs';
+import { API_CATEGORIES, API_SUB_CATEGORIES } from '@/data/api-categories.mjs';
 import references from '@/directory/apiReferences/amplify-js.json';
 import { MDXHeading } from '../MDXComponents';
 
-const { API_CATEGORIES, API_SUB_CATEGORIES } = packageCategories['amplify-js'];
-
 export const ReferencePage = ({ category }) => {
   category = API_CATEGORIES[category] || API_SUB_CATEGORIES[category];
   const cat = references['categories'].find(

src/data/api-categories.mjs

@@ -1,15 +1,13 @@
 // mapping of api categories coming in from libraries to the associated categories in the docs
-export const packageCategories = {
-  'amplify-js': {
-    ROOT_PACKAGE: 'aws-amplify',
-    API_CATEGORIES: {
-      auth: 'auth',
-      storage: 'storage'
-    },
-    API_SUB_CATEGORIES: {
-      analytics: 'analytics',
-      'rest-api': 'api',
-      'in-app-messaging': 'in-app-messaging'
-    }
-  }
+export const API_CATEGORIES = {
+  auth: 'auth',
+  storage: 'storage'
 };
+
+export const API_SUB_CATEGORIES = {
+  analytics: 'analytics',
+  'rest-api': 'api',
+  'in-app-messaging': 'in-app-messaging'
+};
+
+export const ROOT_PACKAGE = 'amplify-js';

src/data/process-typedoc.mjs

@@ -6,9 +6,7 @@ import JSON5 from 'json5';
 import { directory } from './directory.mjs';
 import { writeFile } from 'fs/promises';
 import { getLastModifiedDate } from 'git-jiggy';
-import { packageCategories } from '../data/api-categories.mjs';
-
-const { API_CATEGORIES, API_SUB_CATEGORIES } = packageCategories['amplify-js'];
+import { API_CATEGORIES, API_SUB_CATEGORIES } from '../data/api-categories.mjs';
 
 // Set up the root path so that we can get the correct path from the current working directory
 const rootPath = path.resolve(cwd(), 'src/pages');

src/directory/generateDirectory.mjs

@@ -1,8 +1,6 @@
-import { packageCategories } from '@/data/api-categories';
+import { API_CATEGORIES, API_SUB_CATEGORIES } from '@/data/api-categories.mjs';
 import { JS_PLATFORMS } from '@/data/platforms';
 
-const { API_CATEGORIES, API_SUB_CATEGORIES } = packageCategories['amplify-js'];
-
 export const getApiStaticPath = (sub) => {
   const paths: any = [];
 

src/utils/getApiStaticPath.ts

@@ -1,6 +1,9 @@
 import { writeFileSync, readFileSync } from 'fs';
-import { packageCategories } from '../src/data/api-categories.mjs';
-import { processReferences } from '../src/data/process-typedoc.mjs';
+import {
+  API_CATEGORIES,
+  API_SUB_CATEGORIES,
+  ROOT_PACKAGE
+} from '../src/data/api-categories.mjs';
 
 /**
  * The purpose of this script is to create generate an object that only contains
@@ -28,9 +31,6 @@ const packageName = process.argv[packageIndex + 1];
 
 const referencesFile = readFileSync(`../${packageName}/docs/reference.json`);
 
-const { API_CATEGORIES, API_SUB_CATEGORIES, ROOT_PACKAGE } =
-  packageCategories[packageName];
-
 const references = processReferences(JSON.parse(referencesFile), ROOT_PACKAGE);
 const cleanReferences = {};
 const categoryNodes = [];
@@ -155,6 +155,77 @@ function recursivelyPopulateNodes(node) {
   }
 }
 
+function processReferences(references, rootPackage) {
+  // build flat object for easier faster lookups
+  const flatReferences = {};
+
+  const recursivelyPopulateFlatObject = (referenceObject) => {
+    if (!referenceObject) return;
+    if (referenceObject['id']) {
+      const copy = recursivelyStripObject(structuredClone(referenceObject));
+      flatReferences[referenceObject['id']] = copy;
+    }
+
+    for (let key in referenceObject) {
+      if (referenceObject.hasOwnProperty(key)) {
+        if (Array.isArray(referenceObject[key])) {
+          referenceObject[key].forEach((child) => {
+            recursivelyPopulateFlatObject(child);
+          });
+        } else if (
+          typeof referenceObject[key] === 'object' &&
+          referenceObject[key] !== null
+        ) {
+          recursivelyPopulateFlatObject(referenceObject[key]);
+        }
+      }
+    }
+  };
+
+  const recursivelyStripObject = (referenceObject) => {
+    for (let key in referenceObject) {
+      if (referenceObject.hasOwnProperty(key)) {
+        if (Array.isArray(referenceObject[key])) {
+          referenceObject[key] = referenceObject[key].map((child) => {
+            return child.id || child;
+          });
+        } else if (
+          typeof referenceObject[key] === 'object' &&
+          referenceObject[key] !== null
+        ) {
+          recursivelyStripObject(referenceObject[key]);
+        }
+      }
+    }
+    return referenceObject;
+  };
+
+  const isFunctionObject = (obj) => {
+    return obj.kind === 64 && obj.variant === 'declaration';
+  };
+  recursivelyPopulateFlatObject(references);
+
+  const rootId = Object.keys(flatReferences).find(
+    (id) => flatReferences[id].name == rootPackage
+  );
+
+  flatReferences['categories'] = flatReferences[rootId]?.children?.map(
+    (catId) => {
+      const cat = structuredClone(flatReferences[catId]);
+      if (cat.children && Array.isArray(cat.children)) {
+        cat.children = cat.children
+          .map((childId) => flatReferences[childId])
+          .filter((child) => {
+            return isFunctionObject(child);
+          });
+      }
+      return cat;
+    }
+  );
+
+  return flatReferences;
+}
+
 const categories = Object.values(API_CATEGORIES).concat(
   Object.values(API_SUB_CATEGORIES)
 );