docs: add bridge submodules

Author: gregfromstl

apps/portal/src/app/connect/pay/guides/build-a-custom-experience/page.mdx

@@ -36,7 +36,7 @@ In this guide, we'll show you how to purchase 0.01 Base ETH from USD in Typescri
 <Step title='Install the Connect SDK'>
 <InstallTabs
 	npm="npm i thirdweb"
-	yarn="yarn install thirdweb"
+	yarn="yarn add thirdweb"
 	pnpm="pnpm i thirdweb"
 />
 <Step title='Get Your Client ID'>

apps/portal/src/app/connect/pay/guides/cross-chain-swapping/page.mdx

@@ -30,7 +30,7 @@ In this guide, we'll show you how to purchase 10 USDC on Optimism in Typescript.
 <Step title='Install the Connect SDK'>
 <InstallTabs
 	npm="npm i thirdweb"
-	yarn="yarn install thirdweb"
+	yarn="yarn add thirdweb"
 	pnpm="pnpm i thirdweb"
 />
 <Step title='Get Your Client ID'>
@@ -79,7 +79,7 @@ In this example, we'll use the `Buy.quote` function to get a quote for buying 10
 <Callout variant="info">
   The `Buy` namespace is purpose-built for when you want to obtain a specific amount of the output token.
   If you have a specific input amount and are flexible on the output amount, you can use the `Sell` namespace.
-  Learn more about sells [here](
+  Learn more about sells [here](https://portal.thirdweb.com/references/typescript/v5/sell/prepare).
 </Callout>
 
 Quote allows us to get an expected amount before the user has connected their wallet. This quote won't come with executable transactions, and won't be a guaranteed price.

apps/portal/src/app/references/components/TDoc/utils/getSidebarLinkgroups.ts

@@ -167,6 +167,11 @@ export function getSidebarLinkGroups(doc: TransformedDoc, path: string) {
       return tag === "@modules";
     });
 
+    const bridge = docs.filter((d) => {
+      const [tag] = getCustomTag(d) || [];
+      return tag === "@bridge";
+    });
+
     // sort extensions into their own groups
     if (extensions.length) {
       const extensionGroups = extensions.reduce(
@@ -247,9 +252,67 @@ export function getSidebarLinkGroups(doc: TransformedDoc, path: string) {
       }
     }
 
+    if (bridge.length) {
+      const bridgeGroups = bridge.reduce(
+        (acc, d) => {
+          const [, moduleName] = getCustomTag(d) || [];
+          if (moduleName) {
+            if (!acc[moduleName]) {
+              acc[moduleName] = [];
+            }
+            acc[moduleName]?.push(d);
+          }
+          return acc;
+        },
+        {} as Record<string, SomeDoc[]>,
+      );
+      const bridgeLinkGroups: {
+        name: string;
+        href: string;
+        links?: { name: string; href?: string }[];
+      }[] = Object.entries(bridgeGroups)
+        .filter(([namespaceName]) => namespaceName.toLowerCase() !== "common")
+        .map(([namespaceName, docs]) => {
+          const links = docs.map((d) => ({
+            name: d.name,
+            href: getLink(`${path}/${namespaceName.toLowerCase()}/${d.name}`),
+          }));
+          return {
+            name: namespaceName,
+            href: "",
+            links,
+          };
+        });
+
+      // Add the top-level functions
+      for (const [_, docs] of Object.entries(bridgeGroups).filter(
+        ([namespaceName]) => namespaceName.toLowerCase() === "common",
+      )) {
+        for (const doc of docs) {
+          bridgeLinkGroups.push({
+            name: doc.name,
+            href: getLink(`${path}/${doc.name}`),
+          });
+        }
+      }
+
+      if (!linkGroups.find((group) => group.name === name)) {
+        linkGroups.push({
+          name: name,
+          href: getLink(`${path}/${key}`),
+          links: [{ name: "Universal Bridge", links: bridgeLinkGroups }],
+          isCollapsible: false,
+        });
+      } else {
+        linkGroups
+          .find((group) => group.name === name)
+          ?.links.push({ name: "Universal Bridge", links: bridgeLinkGroups });
+      }
+    }
+
     const nonExtensions = docs.filter((d) => {
       const [tag] = getCustomTag(d) || [];
-      return tag !== "@extension" && tag !== "@modules";
+      return tag !== "@extension" && tag !== "@modules" && tag !== "@bridge";
     });
 
     // sort into groups

apps/portal/src/app/references/components/TDoc/utils/slugs.ts

@@ -36,11 +36,17 @@ export function getSlugToDocMap(doc: TransformedDoc) {
           const extensionBlockTag = v.signatures
             ?.find((s) =>
               s.blockTags?.some(
-                (tag) => tag.tag === "@extension" || tag.tag === "@modules",
+                (tag) =>
+                  tag.tag === "@extension" ||
+                  tag.tag === "@modules" ||
+                  tag.tag === "@bridge",
               ),
             )
             ?.blockTags?.find(
-              (tag) => tag.tag === "@extension" || tag.tag === "@modules",
+              (tag) =>
+                tag.tag === "@extension" ||
+                tag.tag === "@modules" ||
+                tag.tag === "@bridge",
             );
 
           if (extensionBlockTag) {

packages/thirdweb/src/bridge/Buy.ts

@@ -55,7 +55,7 @@ import type { PreparedQuote, Quote } from "./types/Quote.js";
  * @returns A promise that resolves to a non-finalized quote for the requested buy.
  *
  * @throws Will throw an error if there is an issue fetching the quote.
- * @bridge
+ * @bridge Buy
  * @beta
  */
 export async function quote(options: quote.Options): Promise<quote.Result> {
@@ -188,7 +188,7 @@ export declare namespace quote {
  * @returns A promise that resolves to a non-finalized quote for the requested buy.
  *
  * @throws Will throw an error if there is an issue fetching the quote.
- * @bridge
+ * @bridge Buy
  * @beta
  */
 export async function prepare(

packages/thirdweb/src/bridge/Sell.ts

@@ -55,7 +55,7 @@ import type { PreparedQuote, Quote } from "./types/Quote.js";
  * @returns A promise that resolves to a non-finalized quote for the requested sell.
  *
  * @throws Will throw an error if there is an issue fetching the quote.
- * @bridge
+ * @bridge Sell
  * @beta
  */
 export async function quote(options: quote.Options): Promise<quote.Result> {
@@ -188,7 +188,7 @@ export declare namespace quote {
  * @returns A promise that resolves to a non-finalized quote for the requested buy.
  *
  * @throws Will throw an error if there is an issue fetching the quote.
- * @bridge
+ * @bridge Sell
  * @beta
  */
 export async function prepare(

packages/thirdweb/src/bridge/Status.ts

@@ -7,7 +7,7 @@ import type { Status } from "./types/Status.js";
 /**
  * Retrieves a Universal Bridge quote for the provided sell intent. The quote will specify the expected `destinationAmount` that will be received in exchange for the specified `originAmount`, which is specified with the `sellAmountWei` option.
  *
-+ * The returned status will include both the origin and destination transactions and any finalized amounts for the route.
+ * The returned status will include both the origin and destination transactions and any finalized amounts for the route.
  *
  * @example
  * ```typescript