feat: Refactor api generation

Author: stocaaro

src/components/ApiDocs/ReferencePage.tsx

@@ -2,10 +2,12 @@ import { Fragment } from 'react';
 
 import { FunctionReference } from './FunctionReference';
 import { Divider, View, Flex } from '@aws-amplify/ui-react';
-import { API_CATEGORIES, API_SUB_CATEGORIES } from '@/data/api-categories.mjs';
+import { packageCategories } 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,11 +1,26 @@
 // mapping of api categories coming in from libraries to the associated categories in the docs
-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 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'
+    }
+  },
+  'amplify-data': {
+    API_CATEGORIES: {
+      auth: 'auth',
+      storage: 'storage'
+    },
+    API_SUB_CATEGORIES: {
+      analytics: 'analytics',
+      'rest-api': 'api',
+      'in-app-messaging': 'in-app-messaging'
+    }
+  }
 };

src/data/process-typedoc.mjs

@@ -0,0 +1,70 @@
+export const 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;
+};

src/directory/apiReferences/amplify-data.json

@@ -0,0 +1,3 @@
+{
+  "categories": []
+}