api_refs[minor]: Typedoc monorepo support

Author: bracesproul

.gitignore

@@ -46,3 +46,4 @@ docs/api_refs/typedoc.json
 
 .tool-versions
 credentials.json
+**/typedoc.json

docs/api_refs/package.json

@@ -29,7 +29,7 @@
     "postcss": "^8",
     "prettier": "^2.8.3",
     "tailwindcss": "^3.3.0",
-    "typedoc": "^0.26.0",
+    "typedoc": "^0.26.1",
     "typescript": "~5.1.6"
   }
 }

docs/api_refs/scripts/create-entrypoints.js

@@ -26,6 +26,8 @@ const BASE_TYPEDOC_CONFIG = {
   skipErrorChecking: true,
   exclude: ["dist"],
   hostedBaseUrl: "https://v02.api.js.langchain.com/",
+  entryPointStrategy: "packages",
+  entryPoints: ["../../langchain", "../../langchain-core", "../../libs/*"]
 };
 
 /**
@@ -70,7 +72,7 @@ async function main() {
       langChainConfig.config.entrypoints === null ||
       langChainConfig.config.entrypoints === undefined
     ) {
-      return;
+      continue;
     }
     const { config } = langChainConfig;
 
@@ -82,7 +84,7 @@ async function main() {
     const deprecatedNodeOnly =
       "deprecatedNodeOnly" in config ? config.deprecatedNodeOnly : [];
 
-    Object.values(config.entrypoints)
+    const workspaceEntrypoints = Object.values(config.entrypoints)
       .filter((key) => !deprecatedNodeOnly.includes(key))
       .filter(
         (key) =>
@@ -91,16 +93,29 @@ async function main() {
               blacklistedItem === `${entrypointDir}/src/${key}.ts`
           )
       )
-      .map((key) => entrypoints.add(`${entrypointDir}/src/${key}.ts`));
+      .map((key) => `src/${key}.ts`);
+
+    const typedocPath = path.join(entrypointDir, "typedoc.json");
+    
+    if (!fs.existsSync(typedocPath)) {
+      fs.writeFileSync(typedocPath, "{}\n");
+    }
+
+    updateJsonFile(typedocPath, (existingConfig) => ({
+      ...existingConfig,
+      entryPoints: workspaceEntrypoints,
+      extends: typedocPath.includes("/libs/") ? ["../../docs/api_refs/typedoc.base.json"] : ["../docs/api_refs/typedoc.base.json"]
+    }));
   }
+
   // Check if the `./typedoc.json` file exists, since it is gitignored by default
   if (!fs.existsSync("./typedoc.json")) {
     fs.writeFileSync("./typedoc.json", "{}\n");
   }
 
   updateJsonFile("./typedoc.json", () => ({
     ...BASE_TYPEDOC_CONFIG,
-    entryPoints: Array.from(entrypoints),
+    // entryPoints: Array.from(entrypoints),
   }));
 }
 main();

docs/api_refs/typedoc.base.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true
+}

docs/api_refs/typedoc_plugins/hide_underscore_lc.js

@@ -99,26 +99,30 @@ function load(application) {
    * @returns {void}
    */
   function onBeginResolve(context) {
-    reflectionsToHide.forEach((reflection) => {
-      const { project } = context;
-      // Remove the property from documentation
-      project.removeReflection(reflection);
-    });
+    // reflectionsToHide.forEach((reflection) => {
+    //   const { project } = context;
+    //   // Remove the property from documentation
+    //   project.removeReflection(reflection);
+    // });
   }
 
   /**
    * @param {Context} _context
    * @param {DeclarationReflection} reflection
    * @returns {void}
    */
-  function resolveReflection(_context, reflection) {
+  function resolveReflection(context, reflection) {
+    const { project } = context;
+
     const reflectionKind = reflection.kind;
     if (reflectionKindsToHide.includes(reflectionKind)) {
       if (
         reflection.name.startsWith("_") ||
         reflection.name.startsWith("lc_")
       ) {
-        reflectionsToHide.push(reflection);
+        // Remove the property from documentation
+        project.removeReflection(reflection);
+        // reflectionsToHide.push(reflection);
       }
     }
     if (reflection.name.includes("/src")) {

yarn.lock

@@ -20486,7 +20486,7 @@ __metadata:
     react: ^18
     react-dom: ^18
     tailwindcss: ^3.3.0
-    typedoc: ^0.26.0
+    typedoc: ^0.26.1
     typescript: ~5.1.6
   languageName: unknown
   linkType: soft
@@ -41139,9 +41139,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"typedoc@npm:^0.26.0":
-  version: 0.26.3
-  resolution: "typedoc@npm:0.26.3"
+"typedoc@npm:^0.26.1":
+  version: 0.26.5
+  resolution: "typedoc@npm:0.26.5"
   dependencies:
     lunr: ^2.3.9
     markdown-it: ^14.1.0
@@ -41152,7 +41152,7 @@ __metadata:
     typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x
   bin:
     typedoc: bin/typedoc
-  checksum: 3e4fc7cbd455e2adf591b4d01f191fa9518e56a4a2ee659ba1d4d221902656dc1f3572a726443b91bb3586bb485e783d924670f7a9087602153ef04ea2dcbd82
+  checksum: 0587096c2b91536249d3aa9cc5e83a43086e318006ddeadc3c21c424d10a934b6bc19c56fda682d16a75f8133eb2730f54adace79996adeec89188fe331594c3
   languageName: node
   linkType: hard