Class NextDrupalPages

The NextDrupalPages class extends the NextDrupal class and provides methods for interacting with a Drupal backend in the context of Next.js pages.

Hierarchy (View Summary)

Constructors

constructor

Properties

accessToken? baseUrl cache? deserializer fetcher? frontPage getPathsFromContext isDebugEnabled logger throwJsonApiErrors useDefaultEndpoints withAuth

Accessors

apiPrefix auth headers token

Methods

addLocalePrefix buildEndpoint buildMenuTree buildStaticPathsFromResources buildStaticPathsParamsFromPaths buildUrl constructPathFromSegment createFileResource createResource debug deleteResource deserialize fetch fetchResourceEndpoint getAccessToken getAuthFromContextAndOptions getAuthorizationHeader getEntryForResourceType getErrorsFromResponse getIndex getMenu getPathFromContext getResource getResourceByPath getResourceCollection getResourceCollectionFromContext getResourceCollectionPathSegments getResourceFromContext getSearchIndex getSearchIndexFromContext getStaticPathsFromContext getView logOrThrowError preview previewDisable throwIfJsonErrors translatePath translatePathFromContext updateResource validateDraftUrl

Constructors

constructor

  • new NextDrupalPages(
        baseUrl: string,
        options?: DrupalClientOptions,
    ): NextDrupalPages

  • Instantiates a new NextDrupalPages.

    const client = new NextDrupalPages(baseUrl)

    Parameters

    • baseUrl: string

      The baseUrl of your Drupal site. Do not add the /jsonapi suffix.

    • options: DrupalClientOptions = {}

      Options for the client. See Experiment_DrupalClientOptions.

    Returns NextDrupalPages

Properties

OptionalaccessToken

accessToken?: AccessToken

baseUrl

baseUrl: string

Optionalcache

cache?: DataCache

deserializer

deserializer: JsonDeserializer

Optionalfetcher

fetcher?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

frontPage

frontPage: string

getPathsFromContext

getPathsFromContext: (
    types: string | string[],
    context: GetStaticPathsContext,
    options?: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption,
) => Promise<(string | { locale?: string; params: { slug: string[] } })[]> = ...

Type declaration

    • (
          types: string | string[],
          context: GetStaticPathsContext,
          options?: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption,
      ): Promise<(string | { locale?: string; params: { slug: string[] } })[]>

    • Gets static paths from the context.

      Parameters

      • types: string | string[]

        The types of the resources.

      • context: GetStaticPathsContext

        The static paths context.

      • Optionaloptions: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption

        Options for the request.

      Returns Promise<(string | { locale?: string; params: { slug: string[] } })[]>

      The fetched static paths.

isDebugEnabled

isDebugEnabled: boolean

logger

logger: Logger

throwJsonApiErrors

throwJsonApiErrors: boolean

useDefaultEndpoints

useDefaultEndpoints: boolean

withAuth

withAuth: boolean

Accessors

apiPrefix

  • get apiPrefix(): string

  • Returns string

  • set apiPrefix(apiPrefix: string): void

  • Parameters

    • apiPrefix: string

    Returns void

auth

  • get auth(): NextDrupalAuth

  • Returns NextDrupalAuth

  • set auth(auth: NextDrupalAuth): void

  • Parameters

    Returns void

headers

  • get headers(): HeadersInit

  • Returns HeadersInit

  • set headers(headers: HeadersInit): void

  • Parameters

    • headers: HeadersInit

    Returns void

token

  • get token(): AccessToken

  • Returns AccessToken

  • set token(token: AccessToken): void

  • Parameters

    Returns void

Methods

addLocalePrefix

  • addLocalePrefix(
        path: string,
        options?: { defaultLocale?: string; locale?: string },
    ): string

  • Adds a locale prefix to the given path.

    Parameters

    • path: string

      The path.

    • options: { defaultLocale?: string; locale?: string } = {}

      The options for adding the locale prefix.

      • OptionaldefaultLocale?: string

        The default locale.

      • Optionallocale?: string

        The locale.

    Returns string

    The path with the locale prefix.

buildEndpoint

  • buildEndpoint(
        params?: {
            locale?: string;
            path?: string;
            searchParams?: EndpointSearchParams;
        } & { resourceType?: string },
    ): Promise<string>

  • Builds an endpoint URL for the specified parameters.

    Parameters

    • params: { locale?: string; path?: string; searchParams?: EndpointSearchParams } & {
          resourceType?: string;
      } = {}

      The parameters for the endpoint.

    Returns Promise<string>

    The built endpoint URL.

buildMenuTree

  • buildMenuTree(links: DrupalMenuItem[], parent?: string): DrupalMenuTree

  • Parameters

    Returns DrupalMenuTree

buildStaticPathsFromResources

  • buildStaticPathsFromResources(
        resources: { path: DrupalPathAlias }[],
        options?: { locale?: string; pathPrefix?: string },
    ): { params: { slug: string[] } }[]

  • Builds static paths from resources.

    Parameters

    • resources: { path: DrupalPathAlias }[]

      The resources.

    • Optionaloptions: { locale?: string; pathPrefix?: string }

      Options for the request.

    Returns { params: { slug: string[] } }[]

    The built static paths.

buildStaticPathsParamsFromPaths

  • buildStaticPathsParamsFromPaths(
        paths: string[],
        options?: { locale?: string; pathPrefix?: string },
    ): { params: { slug: string[] } }[]

  • Builds static paths parameters from paths.

    Parameters

    • paths: string[]

      The paths.

    • Optionaloptions: { locale?: string; pathPrefix?: string }

      Options for the request.

    Returns { params: { slug: string[] } }[]

    The built static paths parameters.

buildUrl

  • buildUrl(path: string, searchParams?: EndpointSearchParams): URL

  • Builds a URL with the given path and search parameters.

    Parameters

    Returns URL

    The constructed URL.

constructPathFromSegment

  • constructPathFromSegment(
        segment: string | string[],
        options?: { defaultLocale?: string; locale?: string; pathPrefix?: string },
    ): string

  • Constructs a path from the given segment and options.

    Parameters

    • segment: string | string[]

      The path segment.

    • options: { defaultLocale?: string; locale?: string; pathPrefix?: string } = {}

      The options for constructing the path.

      • OptionaldefaultLocale?: string

        The default locale.

      • Optionallocale?: string

        The locale.

      • OptionalpathPrefix?: string

        The path prefix.

    Returns string

    The constructed path.

createFileResource

createResource

debug

  • debug(message: any): void

  • Logs a debug message if debug mode is enabled.

    Parameters

    • message: any

      The debug message.

    Returns void

deleteResource

  • deleteResource(
        type: string,
        uuid: string,
        options?: JsonApiOptions & JsonApiWithNextFetchOptions,
    ): Promise<boolean>

  • Deletes an existing resource of the specified type.

    Parameters

    Returns Promise<boolean>

    True if the resource was deleted, false otherwise.

deserialize

  • deserialize(body: any, options?: any): TJsonaModel | TJsonaModel[]

  • Deserializes the response body.

    Parameters

    • body: any

      The response body.

    • Optionaloptions: any

      Options for deserialization.

    Returns TJsonaModel | TJsonaModel[]

    The deserialized response body.

fetch

  • fetch(input: RequestInfo, init?: FetchOptions): Promise<Response>

  • Fetches a resource from the given input URL or path.

    Parameters

    • input: RequestInfo

      The input URL or path.

    • init: FetchOptions = {}

      The fetch options.

    Returns Promise<Response>

    The fetch response.

fetchResourceEndpoint

  • fetchResourceEndpoint(type: string, locale?: string): Promise<URL>

  • Fetches the endpoint URL for the specified resource type.

    Parameters

    • type: string

      The type of the resource.

    • Optionallocale: string

      The locale for the request.

    Returns Promise<URL>

    The fetched endpoint URL.

getAccessToken

getAuthFromContextAndOptions

  • getAuthFromContextAndOptions(
        context: GetStaticPropsContext,
        options: JsonApiWithAuthOption,
    ): boolean | NextDrupalAuth

  • Gets the authentication configuration from the context and options.

    Parameters

    • context: GetStaticPropsContext

      The static props context.

    • options: JsonApiWithAuthOption

      Options for the request.

    Returns boolean | NextDrupalAuth

    The authentication configuration.

getAuthorizationHeader

  • getAuthorizationHeader(auth: NextDrupalAuth): Promise<string>

  • Gets the authorization header value based on the provided auth configuration.

    Parameters

    Returns Promise<string>

    The authorization header value.

getEntryForResourceType

  • getEntryForResourceType(resourceType: string, locale?: string): Promise<string>

  • Gets the entry point for a given resource type.

    Parameters

    • resourceType: string

      The resource type.

    • Optionallocale: string

      The locale.

    Returns Promise<string>

    The entry point URL.

getErrorsFromResponse

  • getErrorsFromResponse(response: Response): Promise<string | JsonApiError[]>

  • Extracts errors from the fetch response.

    Parameters

    • response: Response

      The fetch response.

    Returns Promise<string | JsonApiError[]>

    The extracted errors.

getIndex

getMenu

getPathFromContext

  • getPathFromContext(
        context: GetStaticPropsContext,
        options?: { pathPrefix?: string },
    ): string

  • Gets the path from the context.

    Parameters

    • context: GetStaticPropsContext

      The static props context.

    • Optionaloptions: { pathPrefix?: string }

      Options for the request.

    Returns string

    The constructed path.

getResource

  • getResource<T extends JsonApiResource>(
        type: string,
        uuid: string,
        options?: JsonApiOptions & JsonApiWithCacheOptions & JsonApiWithNextFetchOptions,
    ): Promise<T>

  • Fetches a resource of the specified type by its UUID.

    Type Parameters

    Parameters

    Returns Promise<T>

    The fetched resource.

    Examples

    Get a page by uuid.

    const node = await drupal.getResource(
     "node--page",
     "07464e9f-9221-4a4f-b7f2-01389408e6c8"
    )

    Get the es translation for a page by uuid.

    const node = await drupal.getResource(
      "node--page",
      "07464e9f-9221-4a4f-b7f2-01389408e6c8",
      {
        locale: "es",
        defaultLocale: "en",
      }
    )

    Get the raw JSON:API response.

    const { data, meta, links } = await drupal.getResource(
      "node--page",
      "07464e9f-9221-4a4f-b7f2-01389408e6c8",
      {
        deserialize: false,
      }
    )

    Get a node--article resource using cache.

    const id = "07464e9f-9221-4a4f-b7f2-01389408e6c8"

    const article = await drupal.getResource("node--article", id, {
      withCache: true,
      cacheKey: `node--article:${id}`,
    })

    Get a page resource with time-based revalidation.

    const node = await drupal.getResource(
      "node--page",
      "07464e9f-9221-4a4f-b7f2-01389408e6c8",
      { next: { revalidate: 3600 } }
    )

    Get a page resource with tag-based revalidation.

    const {slug} = params;
    const path = drupal.translatePath(slug)

    const type = path.jsonapi.resourceName
    const tag = `${path.entity.type}:${path.entity.id}`

    const node = await drupal.getResource(path, path.entity.uuid, {
      params: params.getQueryObject(),
      tags: [tag]
    })

    Using DrupalNode for a node entity type.

    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.

    import { DrupalTaxonomyTerm } from "next-drupal"

    const term = await drupal.getResource<DrupalTaxonomyTerm>(
      "taxonomy_term--tags",
      "7b47d7cc-9b1b-4867-a909-75dc1d61dfd3"
    )

getResourceByPath

getResourceCollection

getResourceCollectionFromContext

  • getResourceCollectionFromContext<T = JsonApiResource[]>(
        type: string,
        context: GetStaticPropsContext,
        options?: { deserialize?: boolean } & JsonApiOptions,
    ): Promise<T>

  • Gets a collection of resources from the context.

    Type Parameters

    Parameters

    • type: string

      The type of the resources.

    • context: GetStaticPropsContext

      The static props context.

    • Optionaloptions: { deserialize?: boolean } & JsonApiOptions

      Options for the request.

    Returns Promise<T>

    The fetched collection of resources.

getResourceCollectionPathSegments

  • getResourceCollectionPathSegments(
        types: string | string[],
        options?: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption & (
            JsonApiWithNextFetchOptions & ({ locales: string[]; defaultLocale: string; } | { locales?: undefined; defaultLocale?: never; })
        ),
    ): Promise<
        { locale: string; path: string; segments: string[]; type: string }[],
    >

  • Fetches path segments for a collection of resources of the specified types.

    Parameters

    • types: string | string[]

      The types of the resources.

    • Optionaloptions: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption & (
          JsonApiWithNextFetchOptions & ({ locales: string[]; defaultLocale: string; } | { locales?: undefined; defaultLocale?: never; })
      )

      Options for the request.

    Returns Promise<{ locale: string; path: string; segments: string[]; type: string }[]>

    The fetched path segments.

getResourceFromContext

  • getResourceFromContext<T extends JsonApiResource>(
        input: string | DrupalTranslatedPath,
        context: GetStaticPropsContext,
        options?: { isVersionable?: boolean; pathPrefix?: string } & JsonApiOptions,
    ): Promise<T>

  • Gets a resource from the context.

    Type Parameters

    Parameters

    • input: string | DrupalTranslatedPath

      The input path or translated path.

    • context: GetStaticPropsContext

      The static props context.

    • Optionaloptions: { isVersionable?: boolean; pathPrefix?: string } & JsonApiOptions

      Options for the request.

    Returns Promise<T>

    The fetched resource.

getSearchIndex

getSearchIndexFromContext

  • getSearchIndexFromContext<T = JsonApiResource[]>(
        name: string,
        context: GetStaticPropsContext,
        options?: JsonApiOptions,
    ): Promise<T>

  • Gets a search index from the context.

    Type Parameters

    Parameters

    • name: string

      The name of the search index.

    • context: GetStaticPropsContext

      The static props context.

    • Optionaloptions: JsonApiOptions

      Options for the request.

    Returns Promise<T>

    The fetched search index.

getStaticPathsFromContext

  • getStaticPathsFromContext(
        types: string | string[],
        context: GetStaticPathsContext,
        options?: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption,
    ): Promise<(string | { locale?: string; params: { slug: string[] } })[]>

  • Gets static paths from the context.

    Parameters

    • types: string | string[]

      The types of the resources.

    • context: GetStaticPathsContext

      The static paths context.

    • Optionaloptions: { params?: JsonApiParams; pathPrefix?: string } & JsonApiWithAuthOption

      Options for the request.

    Returns Promise<(string | { locale?: string; params: { slug: string[] } })[]>

    The fetched static paths.

getView

logOrThrowError

  • logOrThrowError(error: Error): void

  • Logs or throws an error based on the throwJsonApiErrors flag.

    Parameters

    • error: Error

      The error to log or throw.

    Returns void

preview

  • preview(
        request: NextApiRequest,
        response: NextApiResponse,
        options?: { enable: boolean },
    ): Promise<void | NextApiResponse>

  • Handles preview mode.

    Parameters

    • request: NextApiRequest

      The API request.

    • response: NextApiResponse

      The API response.

    • Optionaloptions: { enable: boolean }

      Options for the request.

    Returns Promise<void | NextApiResponse>

previewDisable

  • previewDisable(
        request: NextApiRequest,
        response: NextApiResponse,
    ): Promise<void>

  • Disables preview mode.

    Parameters

    • request: NextApiRequest

      The API request.

    • response: NextApiResponse

      The API response.

    Returns Promise<void>

throwIfJsonErrors

  • throwIfJsonErrors(response: Response, messagePrefix?: string): Promise<void>

  • Throws an error if the response contains JSON:API errors.

    Parameters

    • response: Response

      The fetch response.

    • messagePrefix: string = ""

      The error message prefix.

    Returns Promise<void>

    Throws

    The JSON:API errors.

translatePath

translatePathFromContext

  • translatePathFromContext(
        context: GetStaticPropsContext,
        options?: { pathPrefix?: string } & JsonApiWithAuthOption,
    ): Promise<DrupalTranslatedPath>

  • Translates a path from the context.

    Parameters

    • context: GetStaticPropsContext

      The static props context.

    • Optionaloptions: { pathPrefix?: string } & JsonApiWithAuthOption

      Options for the request.

    Returns Promise<DrupalTranslatedPath>

    The translated path.

updateResource

validateDraftUrl

  • validateDraftUrl(searchParams: URLSearchParams): Promise<Response>

  • Validates the draft URL using the provided search parameters.

    Parameters

    • searchParams: URLSearchParams

      The search parameters.

    Returns Promise<Response>

    The validation response.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods