Improvements to API Reference

packages/next-drupal/src/deprecated/get-access-token.ts

@@ -3,6 +3,7 @@ import type { AccessToken } from "../types"
 
 const CACHE_KEY = "NEXT_DRUPAL_ACCESS_TOKEN"
 
+/** @deprecated */
 export async function getAccessToken(): Promise<AccessToken> {
   if (!process.env.DRUPAL_CLIENT_ID || !process.env.DRUPAL_CLIENT_SECRET) {
     return null

packages/next-drupal/src/jsonapi-errors.ts

@@ -13,6 +13,7 @@ export interface JsonApiLinks {
   [key: string]: string | Record<string, string>
 }
 
+/** @hidden */
 export class JsonApiErrors extends Error {
   errors: JsonApiError[] | string
   statusCode: number

packages/next-drupal/src/next-drupal.ts

@@ -294,6 +294,62 @@ export class NextDrupal extends NextDrupalBase {
    * @param {string} uuid The UUID of the resource.
    * @param {JsonApiOptions & JsonApiWithCacheOptions & JsonApiWithNextFetchOptions} options Options for the request.
    * @returns {Promise<T>} The fetched resource.
+   * @examples
+   * Get a page by uuid.
+   * ```ts
+   * const node = await drupal.getResource(
+   *  "node--page",
+   *  "07464e9f-9221-4a4f-b7f2-01389408e6c8"
+   * )
+   * ```
+   * Get the es translation for a page by uuid.
+   * ```ts
+   * const node = await drupal.getResource(
+   *   "node--page",
+   *   "07464e9f-9221-4a4f-b7f2-01389408e6c8",
+   *   {
+   *     locale: "es",
+   *     defaultLocale: "en",
+   *   }
+   * )
+   * ```
+   * Get the raw JSON:API response.
+   * ```ts
+   * const { data, meta, links } = await drupal.getResource(
+   *   "node--page",
+   *   "07464e9f-9221-4a4f-b7f2-01389408e6c8",
+   *   {
+   *     deserialize: false,
+   *   }
+   * )
+   * ```
+   * Get a node--article resource using cache.
+   * ```ts
+   * const id = "07464e9f-9221-4a4f-b7f2-01389408e6c8"
+   *
+   * const article = await drupal.getResource("node--article", id, {
+   *   withCache: true,
+   *   cacheKey: `node--article:${id}`,
+   * })
+   * ```
+   * Using DrupalNode for a node entity type.
+   * ```ts
+   * import { DrupalNode } from "next-drupal"
+   *
+   * const node = await drupal.getResource<DrupalNode>(
+   *   "node--page",
+   *   "07464e9f-9221-4a4f-b7f2-01389408e6c8"
+   * )
+   * ```
+   * Using DrupalTaxonomyTerm for a taxonomy term entity type.
+   * ```ts
+   * import { DrupalTaxonomyTerm } from "next-drupal"
+   *
+   * const term = await drupal.getResource<DrupalTaxonomyTerm>(
+   *   "taxonomy_term--tags",
+   *   "7b47d7cc-9b1b-4867-a909-75dc1d61dfd3"
+   * )
+   * ```
    */
   async getResource<T extends JsonApiResource>(
     type: string,

www/.gitignore

@@ -13,7 +13,7 @@
 /cypress/videos
 
 # Files generated automatically by typedoc
-/content/docs/api
+/public/api
 
 # next.js
 /.next/

www/config/docs.ts

@@ -121,15 +121,6 @@ export const docsConfig: DocsConfig = {
         },
       ],
     },
-    {
-      title: "API",
-      items: [
-        {
-          title: "API Reference",
-          href: "/docs/api/globals",
-        },
-      ],
-    },
     {
       title: "Drupal",
       items: [

www/config/site.ts

@@ -26,6 +26,10 @@ export const site: SiteConfig = {
       href: "/guides",
       activePathNames: ["/guides/[...slug]"],
     },
+    {
+      title: "API",
+      href: "/api/modules.html",
+    },
     {
       title: "Blog",
       href: "/blog",

www/typedoc.json

@@ -1,7 +1,7 @@
 {
-  "plugin": ["typedoc-plugin-markdown"],
   "entryPoints": ["../packages/next-drupal/src/index.ts"],
-  "out": "content/docs/api",
-  "fileExtension": ".mdx",
-  "hidePageHeader": true
+  "out": "public/api",
+  "navigationLinks": {
+    "Back to Docs": "/docs"
+  }
 }