refactor(next-drupal)!: move non-DrupalClient code to src/deprecated

BREAKING CHANGE:
The JsonApiWithAuthOptions type has been renamed to JsonApiWithAuthOption. The
JsonApiWithLocaleOptions type is now considered deprecated for DrupalClient
usage and can be replaced with the JsonApiOptions type.

examples/example-search-api/pages/advanced.tsx

@@ -6,7 +6,7 @@ import {
   DrupalNode,
   getSearchIndexFromContext,
   deserialize,
-  JsonApiSearchApiResponse,
+  DrupalSearchApiJsonApiResponse,
   DrupalSearchApiFacet,
 } from "next-drupal"
 import { GetStaticPropsResult } from "next"
@@ -209,14 +209,15 @@ export default function AdvancedPage({
 export async function getStaticProps(
   context
 ): Promise<GetStaticPropsResult<AdvancedPageProps>> {
-  const results = await getSearchIndexFromContext<JsonApiSearchApiResponse>(
-    "property",
-    context,
-    {
-      deserialize: false,
-      params,
-    }
-  )
+  const results =
+    await getSearchIndexFromContext<DrupalSearchApiJsonApiResponse>(
+      "property",
+      context,
+      {
+        deserialize: false,
+        params,
+      }
+    )
 
   return {
     props: {

packages/next-drupal/jest.config.cjs

@@ -13,15 +13,19 @@ module.exports = {
   coverageProvider: "v8",
   collectCoverage: true,
   collectCoverageFrom: ["./src/**"],
-  coveragePathIgnorePatterns: ["./src/get-*"],
+  coveragePathIgnorePatterns: [
+    "./src/deprecated/*",
+    "./src/deprecated.ts",
+    "./src/navigation.ts",
+    "./src/types/*",
+  ],
   coverageReporters: ["lcov", "text", "text-summary"],
   coverageThreshold: {
     global: {
-      // @TODO Make these thresholds strict once #608 is completed.
-      statements: 50, // 55.1,
-      branches: 80, // 84.16,
-      functions: 70, // 72.41,
-      lines: 50, // 55.1,
+      statements: 82.07,
+      branches: 86.9,
+      functions: 80.76,
+      lines: 82.07,
     },
   },
 }

packages/next-drupal/src/client.ts

@@ -23,14 +23,14 @@ import type {
   FetchOptions,
   JsonApiCreateFileResourceBody,
   JsonApiCreateResourceBody,
+  JsonApiOptions,
   JsonApiParams,
   JsonApiResource,
   JsonApiResourceWithPath,
   JsonApiResponse,
   JsonApiUpdateResourceBody,
-  JsonApiWithAuthOptions,
+  JsonApiWithAuthOption,
   JsonApiWithCacheOptions,
-  JsonApiWithLocaleOptions,
   Locale,
   PathAlias,
   PathPrefix,
@@ -312,7 +312,7 @@ export class DrupalClient {
   async createResource<T extends JsonApiResource>(
     type: string,
     body: JsonApiCreateResourceBody,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<T> {
     options = {
       deserialize: true,
@@ -350,7 +350,7 @@ export class DrupalClient {
   async createFileResource<T = DrupalFile>(
     type: string,
     body: JsonApiCreateFileResourceBody,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<T> {
     options = {
       deserialize: true,
@@ -396,7 +396,7 @@ export class DrupalClient {
     type: string,
     uuid: string,
     body: JsonApiUpdateResourceBody,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<T> {
     options = {
       deserialize: true,
@@ -435,7 +435,7 @@ export class DrupalClient {
   async deleteResource(
     type: string,
     uuid: string,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<boolean> {
     options = {
       withAuth: true,
@@ -467,9 +467,7 @@ export class DrupalClient {
   async getResource<T extends JsonApiResource>(
     type: string,
     uuid: string,
-    options?: JsonApiWithLocaleOptions &
-      JsonApiWithAuthOptions &
-      JsonApiWithCacheOptions
+    options?: JsonApiOptions & JsonApiWithCacheOptions
   ): Promise<T> {
     options = {
       deserialize: true,
@@ -523,8 +521,7 @@ export class DrupalClient {
     options?: {
       pathPrefix?: PathPrefix
       isVersionable?: boolean
-    } & JsonApiWithLocaleOptions &
-      JsonApiWithAuthOptions
+    } & JsonApiOptions
   ): Promise<T> {
     const type = typeof input === "string" ? input : input.jsonapi.resourceName
 
@@ -605,8 +602,7 @@ export class DrupalClient {
     path: string,
     options?: {
       isVersionable?: boolean
-    } & JsonApiWithLocaleOptions &
-      JsonApiWithAuthOptions
+    } & JsonApiOptions
   ): Promise<T> {
     options = {
       deserialize: true,
@@ -716,8 +712,7 @@ export class DrupalClient {
     type: string,
     options?: {
       deserialize?: boolean
-    } & JsonApiWithLocaleOptions &
-      JsonApiWithAuthOptions
+    } & JsonApiOptions
   ): Promise<T> {
     options = {
       withAuth: this.withAuth,
@@ -754,8 +749,7 @@ export class DrupalClient {
     context: GetStaticPropsContext,
     options?: {
       deserialize?: boolean
-    } & JsonApiWithLocaleOptions &
-      JsonApiWithAuthOptions
+    } & JsonApiOptions
   ): Promise<T> {
     options = {
       deserialize: true,
@@ -778,7 +772,7 @@ export class DrupalClient {
     options?: {
       params?: JsonApiParams
       pathPrefix?: PathPrefix
-    } & JsonApiWithAuthOptions
+    } & JsonApiWithAuthOption
   ): Promise<GetStaticPathsResult<{ slug: string[] }>["paths"]> {
     options = {
       withAuth: this.withAuth,
@@ -893,7 +887,7 @@ export class DrupalClient {
 
   async translatePath(
     path: string,
-    options?: JsonApiWithAuthOptions
+    options?: JsonApiWithAuthOption
   ): Promise<DrupalTranslatedPath | null> {
     options = {
       withAuth: this.withAuth,
@@ -926,7 +920,7 @@ export class DrupalClient {
     context: GetStaticPropsContext,
     options?: {
       pathPrefix?: PathPrefix
-    } & JsonApiWithAuthOptions
+    } & JsonApiWithAuthOption
   ): Promise<DrupalTranslatedPath | null> {
     options = {
       pathPrefix: "/",
@@ -1160,9 +1154,7 @@ export class DrupalClient {
 
   async getMenu<T = DrupalMenuLinkContent>(
     name: string,
-    options?: JsonApiWithLocaleOptions &
-      JsonApiWithAuthOptions &
-      JsonApiWithCacheOptions
+    options?: JsonApiOptions & JsonApiWithCacheOptions
   ): Promise<{
     items: T[]
     tree: T[]
@@ -1246,7 +1238,7 @@ export class DrupalClient {
 
   async getView<T = JsonApiResource>(
     name: string,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<DrupalView<T>> {
     options = {
       withAuth: this.withAuth,
@@ -1291,7 +1283,7 @@ export class DrupalClient {
 
   async getSearchIndex<T = JsonApiResource[]>(
     name: string,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<T> {
     options = {
       withAuth: this.withAuth,
@@ -1327,7 +1319,7 @@ export class DrupalClient {
   async getSearchIndexFromContext<T = JsonApiResource[]>(
     name: string,
     context: GetStaticPropsContext,
-    options?: JsonApiWithLocaleOptions & JsonApiWithAuthOptions
+    options?: JsonApiOptions
   ): Promise<T> {
     return await this.getSearchIndex<T>(name, {
       ...options,
@@ -1493,7 +1485,7 @@ export class DrupalClient {
 
   private getAuthFromContextAndOptions(
     context: GetStaticPropsContext,
-    options: JsonApiWithAuthOptions
+    options: JsonApiWithAuthOption
   ) {
     // If not in preview or withAuth is provided, use that.
     if (!context.preview) {

packages/next-drupal/src/deprecated.ts

@@ -0,0 +1,19 @@
+export * from "./deprecated/get-access-token"
+export * from "./deprecated/get-menu"
+export * from "./deprecated/get-paths"
+export * from "./deprecated/get-resource-collection"
+export * from "./deprecated/preview"
+export * from "./deprecated/get-resource-type"
+export * from "./deprecated/get-resource"
+export * from "./deprecated/get-search-index"
+export * from "./deprecated/get-view"
+export * from "./deprecated/translate-path"
+export {
+  deserialize,
+  buildUrl,
+  getJsonApiIndex,
+  getJsonApiPathForResourceType,
+  syncDrupalPreviewRoutes,
+} from "./deprecated/utils"
+
+export type * from "./types/deprecated"

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

@@ -1,5 +1,5 @@
 import { cache } from "./get-cache"
-import type { AccessToken } from "./types"
+import type { AccessToken } from "../types"
 
 const CACHE_KEY = "NEXT_DRUPAL_ACCESS_TOKEN"
 

packages/next-drupal/src/get-menu.ts → packages/next-drupal/src/deprecated/get-menu.ts

@@ -1,9 +1,6 @@
 import { buildHeaders, buildUrl, deserialize } from "./utils"
-import type {
-  AccessToken,
-  DrupalMenuLinkContent,
-  JsonApiWithLocaleOptions,
-} from "./types"
+import type { AccessToken, DrupalMenuLinkContent } from "../types"
+import type { JsonApiWithLocaleOptions } from "../types/deprecated"
 
 export async function getMenu<T extends DrupalMenuLinkContent>(
   name: string,

packages/next-drupal/src/get-paths.ts → packages/next-drupal/src/deprecated/get-paths.ts

@@ -1,6 +1,6 @@
 import { getResourceCollection } from "./get-resource-collection"
 import type { GetStaticPathsContext, GetStaticPathsResult } from "next"
-import type { AccessToken, JsonApiParams, Locale } from "./types"
+import type { AccessToken, JsonApiParams, Locale } from "../types"
 
 export async function getPathsFromContext(
   types: string | string[],

packages/next-drupal/src/get-resource-collection.ts → packages/next-drupal/src/deprecated/get-resource-collection.ts

@@ -5,12 +5,8 @@ import {
   getJsonApiPathForResourceType,
 } from "./utils"
 import type { GetStaticPropsContext } from "next"
-import type {
-  AccessToken,
-  JsonApiParams,
-  JsonApiResource,
-  JsonApiWithLocaleOptions,
-} from "./types"
+import type { AccessToken, JsonApiParams, JsonApiResource } from "../types"
+import type { JsonApiWithLocaleOptions } from "../types/deprecated"
 
 export async function getResourceCollection<T = JsonApiResource[]>(
   type: string,

packages/next-drupal/src/get-resource-type.ts → packages/next-drupal/src/deprecated/get-resource-type.ts

@@ -1,6 +1,6 @@
 import { translatePathFromContext } from "./translate-path"
 import type { GetStaticPropsContext } from "next"
-import type { AccessToken } from "./types"
+import type { AccessToken } from "../types"
 
 export async function getResourceTypeFromContext(
   context: GetStaticPropsContext,

packages/next-drupal/src/get-resource.ts → packages/next-drupal/src/deprecated/get-resource.ts

@@ -7,12 +7,8 @@ import {
   getPathFromContext,
 } from "./utils"
 import type { GetStaticPropsContext } from "next"
-import type {
-  AccessToken,
-  JsonApiParams,
-  JsonApiResource,
-  JsonApiWithLocaleOptions,
-} from "./types"
+import type { AccessToken, JsonApiParams, JsonApiResource } from "../types"
+import type { JsonApiWithLocaleOptions } from "../types/deprecated"
 
 export async function getResourceFromContext<T extends JsonApiResource>(
   type: string,

packages/next-drupal/src/get-search-index.ts → packages/next-drupal/src/deprecated/get-search-index.ts

@@ -1,10 +1,7 @@
 import { buildHeaders, buildUrl, deserialize } from "./utils"
 import type { GetStaticPropsContext } from "next"
-import type {
-  AccessToken,
-  JsonApiResource,
-  JsonApiWithLocaleOptions,
-} from "./types"
+import type { AccessToken, JsonApiResource } from "../types"
+import type { JsonApiWithLocaleOptions } from "../types/deprecated"
 
 export async function getSearchIndex<T = JsonApiResource[]>(
   name: string,

packages/next-drupal/src/get-view.ts → packages/next-drupal/src/deprecated/get-view.ts

@@ -1,5 +1,6 @@
 import { buildHeaders, buildUrl, deserialize } from "./utils"
-import type { AccessToken, JsonApiWithLocaleOptions } from "./types"
+import type { AccessToken } from "../types"
+import type { JsonApiWithLocaleOptions } from "../types/deprecated"
 
 export async function getView<T>(
   name: string,

packages/next-drupal/src/preview.ts → packages/next-drupal/src/deprecated/preview.ts

@@ -1,6 +1,6 @@
 import { getResourceByPath } from "./get-resource"
 import type { NextApiRequest, NextApiResponse } from "next"
-import type { JsonApiWithLocaleOptions } from "./types"
+import type { JsonApiWithLocaleOptions } from "../types/deprecated"
 
 interface PreviewOptions {
   errorMessages?: {

packages/next-drupal/src/translate-path.ts → packages/next-drupal/src/deprecated/translate-path.ts

@@ -1,6 +1,6 @@
 import { buildHeaders, buildUrl, getPathFromContext } from "./utils"
 import type { GetStaticPropsContext } from "next"
-import type { AccessToken, DrupalTranslatedPath } from "./types"
+import type { AccessToken, DrupalTranslatedPath } from "../types"
 
 export async function translatePath(
   path: string,

packages/next-drupal/src/navigation/use-menu.ts → packages/next-drupal/src/deprecated/use-menu.ts

@@ -1,6 +1,6 @@
 import { useRouter } from "next/router"
 import { useEffect, useState } from "react"
-import { getMenu } from "../get-menu"
+import { getMenu } from "./get-menu"
 import type { DrupalMenuLinkContent } from "../types"
 
 export function useMenu<T extends DrupalMenuLinkContent>(

packages/next-drupal/src/utils.ts → packages/next-drupal/src/deprecated/utils.ts

@@ -2,7 +2,7 @@ import { Jsona } from "jsona"
 import { stringify } from "qs"
 import { getAccessToken } from "./get-access-token"
 import type { GetStaticPropsContext } from "next"
-import type { AccessToken, Locale } from "./types"
+import type { AccessToken, Locale } from "../types"
 
 const JSONAPI_PREFIX = process.env.DRUPAL_JSONAPI_PREFIX || "/jsonapi"