docs(next-drupal): updated docs

www/config/docs.ts

@@ -49,8 +49,8 @@ export const docsConfig: DocsConfig = {
           href: "/docs/environment-variables",
         },
         {
-          title: "Preview Mode",
-          href: "/docs/preview-mode",
+          title: "Draft Mode",
+          href: "/docs/draft-mode",
         },
         {
           title: "TypeScript",
@@ -108,8 +108,8 @@ export const docsConfig: DocsConfig = {
           href: "/docs/fetcher",
         },
         {
-          title: "Serializer",
-          href: "/docs/serializer",
+          title: "Deserializer",
+          href: "/docs/deserializer",
         },
         {
           title: "Caching",
@@ -124,10 +124,6 @@ export const docsConfig: DocsConfig = {
           title: "getResource",
           href: "/docs/reference/getresource",
         },
-        {
-          title: "getResourceFromContext",
-          href: "/docs/reference/getresourcefromcontext",
-        },
         {
           title: "getResourceByPath",
           href: "/docs/reference/getresourcebypath",
@@ -136,10 +132,6 @@ export const docsConfig: DocsConfig = {
           title: "getResourceCollection",
           href: "/docs/reference/getresourcecollection",
         },
-        {
-          title: "getResourceCollectionFromContext",
-          href: "/docs/reference/getresourcecollectionfromcontext",
-        },
         {
           title: "createResource",
           href: "/docs/reference/createresource",
@@ -157,28 +149,20 @@ export const docsConfig: DocsConfig = {
           href: "/docs/reference/deleteresource",
         },
         {
-          title: "getStaticPathsFromContext",
-          href: "/docs/reference/getstaticpathsfromcontext",
+          title: "getResourceCollectionPathSegments",
+          href: "/docs/reference/getresourcecollectionpathsegments",
         },
         {
           title: "translatePath",
           href: "/docs/reference/translatepath",
         },
         {
-          title: "translatePathFromContext",
-          href: "/docs/reference/translatepathfromcontext",
-        },
-        {
-          title: "getPathFromContext",
-          href: "/docs/reference/getpathfromcontext",
-        },
-        {
-          title: "getEntryForResourceType",
-          href: "/docs/reference/getentryforresourcetype",
+          title: "constructPathFromSegment",
+          href: "/docs/reference/constructpathfromsegment",
         },
         {
-          title: "preview",
-          href: "/docs/reference/preview",
+          title: "buildEndpoint",
+          href: "/docs/reference/buildendpoint",
         },
         {
           title: "getAccessToken",
@@ -208,6 +192,10 @@ export const docsConfig: DocsConfig = {
           title: "deserialize",
           href: "/docs/reference/deserialize",
         },
+        {
+          title: "getAuthorizationHeader",
+          href: "/docs/reference/getauthorizationheader",
+        },
       ],
     },
     {

www/config/tutorials.ts

@@ -12,9 +12,9 @@ export const tutorialsConfig = [
     items: [],
   },
   {
-    title: "Preview Mode",
-    excerpt: "Implement Preview Mode for Entity Types.",
-    url: "/learn/preview-mode",
+    title: "Draft Mode",
+    excerpt: "Implement Draft Mode for Entity Types.",
+    url: "/learn/draft-mode",
     items: [],
   },
   {

www/content/docs/authentication.mdx

@@ -1,9 +1,9 @@
 ---
 title: Authentication
-excerpt: Making authenticated requests with DrupalClient.
+excerpt: Making authenticated requests with NextDrupal.
 ---
 
-The `DrupalClient` works with several auth types. You can use **Bearer** tokens, **Basic** tokens or bring your own authorization headers.
+The `NextDrupal` client works with several auth types. You can use **Bearer** tokens, **Basic** tokens or bring your own authorization headers.
 
 Authentication can be set globally on the client or custom per method.
 
@@ -16,9 +16,9 @@ This is the default authentication configured on the client.
 **This is used most of the time for fetching and building static pages.**
 
 ```ts title=lib/drupal.ts
-import { DrupalClient } from "next-drupal"
+import { NextDrupal } from "next-drupal"
 
-export const drupal = new DrupalClient(
+export const drupal = new NextDrupal(
   process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
   {
     auth: // Configure the global auth here.
@@ -59,15 +59,12 @@ You need to enable the `simple_oauth` module on Drupal.
 
 ```ts title=lib/drupal.ts
 // Client
-export const drupal = new DrupalClient(
-  process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
-  {
-    auth: {
-      clientId: process.env.DRUPAL_CLIENT_ID,
-      clientSecret: process.env.DRUPAL_CLIENT_SECRET,
-    },
-  }
-)
+export const drupal = new NextDrupal(process.env.NEXT_PUBLIC_DRUPAL_BASE_URL, {
+  auth: {
+    clientId: process.env.DRUPAL_CLIENT_ID,
+    clientSecret: process.env.DRUPAL_CLIENT_SECRET,
+  },
+})
 
 // Method
 const article = drupal.getResource(
@@ -82,26 +79,23 @@ const article = drupal.getResource(
 )
 ```
 
-`DrupalClient` will fetch **Bearer** token and handle expiration for you.
+`NextDrupal` client will fetch **Bearer** token and handle expiration for you.
 
 If you need to customize the OAuth URL you can use the `url` option.
 
 ```ts title=lib/drupal.ts
-export const drupal = new DrupalClient(
-  process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
-  {
-    auth: {
-      clientId: process.env.DRUPAL_CLIENT_ID,
-      clientSecret: process.env.DRUPAL_CLIENT_SECRET,
-      // highlight-start
-      url: `/oauth2/token`,
-      // highlight-end
-    },
-  }
-)
+export const drupal = new NextDrupal(process.env.NEXT_PUBLIC_DRUPAL_BASE_URL, {
+  auth: {
+    clientId: process.env.DRUPAL_CLIENT_ID,
+    clientSecret: process.env.DRUPAL_CLIENT_SECRET,
+    // highlight-start
+    url: `/oauth2/token`,
+    // highlight-end
+  },
+})
 ```
 
-By default, `DrupalClient` uses `/oauth/token` as the default URL.
+By default, `NextDrupal` uses `/oauth/token` as the default URL.
 
 ---
 
@@ -117,15 +111,12 @@ You need to enable the `basic_auth` module on Drupal.
 
 ```ts
 // Client.
-export const drupal = new DrupalClient(
-  process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
-  {
-    auth: {
-      username: process.env.DRUPAL_USERNAME,
-      password: process.env.DRUPAL_PASSWORD,
-    },
-  }
-)
+export const drupal = new NextDrupal(process.env.NEXT_PUBLIC_DRUPAL_BASE_URL, {
+  auth: {
+    username: process.env.DRUPAL_USERNAME,
+    password: process.env.DRUPAL_PASSWORD,
+  },
+})
 
 // Method
 const articles = await drupal.getResourceCollection("node--article", {
@@ -144,14 +135,11 @@ You can also provide a custom callback for authentication. The callback must ret
 
 ```ts
 // Client
-export const drupal = new DrupalClient(
-  process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
-  {
-    auth: () => {
-      // Do something and return an Authorization header.
-    },
-  }
-)
+export const drupal = new NextDrupal(process.env.NEXT_PUBLIC_DRUPAL_BASE_URL, {
+  auth: () => {
+    // Do something and return an Authorization header.
+  },
+})
 
 // Method
 const users = await drupal.getResourceCollection("user--user", {
@@ -167,16 +155,13 @@ You can also pass in an access token.
 
 ```ts
 // Client
-export const drupal = new DrupalClient(
-  process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
-  {
-    auth: {
-      access_token: "ECYM594IlARGc3S8KgBHvTpki0rDtWx6...",
-      token_type: "Bearer",
-      expires_in: 3600,
-    },
-  }
-)
+export const drupal = new NextDrupal(process.env.NEXT_PUBLIC_DRUPAL_BASE_URL, {
+  auth: {
+    access_token: "ECYM594IlARGc3S8KgBHvTpki0rDtWx6...",
+    token_type: "Bearer",
+    expires_in: 3600,
+  },
+})
 
 // Method
 const articles = await drupal.getResourceCollection("node--article", {
@@ -198,7 +183,7 @@ import { getSession } from "next-auth/react"
 const session = getSession(...)
 
 // Client
-export const drupal = new DrupalClient(
+export const drupal = new NextDrupal(
   process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
   {
     auth: session.accessToken,

www/content/docs/cache.mdx

@@ -3,7 +3,7 @@ title: Caching
 excerpt: Using a custom cache for resources.
 ---
 
-The `DrupalClient` has support for caching resources.
+The `NextDrupal` client has support for caching resources.
 
 This is handy when dealing with global data: you can fetch data once and re-use during builds.
 
@@ -22,7 +22,7 @@ Note: as of `next-drupal 1.3.0`, only `getResource` and `getMenu` support cachin
 </Callout>
 
 ```ts title=lib/drupal.ts
-import { DrupalClient, DataCache } from "next-drupal"
+import { NextDrupal, DataCache } from "next-drupal"
 import Redis from "ioredis"
 
 const redis = new Redis(process.env.REDIS_URL)
@@ -37,12 +37,9 @@ export const redisCache: DataCache = {
   },
 }
 
-export const drupal = new DrupalClient(
-  process.env.NEXT_PUBLIC_DRUPAL_BASE_URL,
-  {
-    cache: redisCache,
-  }
-)
+export const drupal = new NextDrupal(process.env.NEXT_PUBLIC_DRUPAL_BASE_URL, {
+  cache: redisCache,
+})
 ```
 
 Now when you make a `getResource` or `getMenu` call you can tell the client to cache and re-use responses.

www/content/docs/client.mdx

@@ -1,11 +1,11 @@
 ---
-title: Drupal Client
+title: NextDrupal Client
 excerpt: A powerful JSON:API client for Drupal.
 ---
 
-The `DrupalClient` is a powerful JSON:API client that ships with helpers for working with Drupal data.
+The `NextDrupal` client is a powerful JSON:API client that ships with helpers for working with Drupal data.
 
-You can use the `DrupalClient` to fetch JSON:API data from Drupal to build static pages.
+You can use the `NextDrupal` client to fetch JSON:API data from Drupal to build static pages in advance, or server render pages on-demand.
 
 It also comes with full support for JSON:API write operations which means you can create JSON:API resources from Next.js to Drupal.
 
@@ -27,10 +27,10 @@ It also comes with full support for JSON:API write operations which means you ca
 ## Usage
 
 ```ts
-import { DrupalClient } from "next-drupal"
+import { NextDrupal } from "next-drupal"
 
-// Create a new DrupalClient.
-const drupal = new DrupalClient("https://example.com")
+// Create a new NextDrupal client.
+const drupal = new NextDrupal("https://example.com")
 
 // Fetch articles.
 const articles = await drupal.getResourceCollection("node--article")