Class NextDrupalBase

constructor

• new NextDrupalBase(
      baseUrl: string,
      options?: NextDrupalBaseOptions,
  ): NextDrupalBase

• Instantiates a new NextDrupalBase.

  const client = new NextDrupalBase(baseUrl)

  Parameters

  • baseUrl: string

    The baseUrl of your Drupal site. Do not add the /jsonapi suffix.
  • options: NextDrupalBaseOptions = {}

    Options for NextDrupalBase.

  Returns NextDrupalBase

OptionalaccessToken

baseUrl

Optionalfetcher

frontPage

isDebugEnabled

logger

withAuth

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

  • auth: NextDrupalAuth

  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

  • token: AccessToken

  Returns void

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(
      options?: {
          locale?: string;
          path?: string;
          searchParams?: EndpointSearchParams;
      },
  ): Promise<string>

• Builds an endpoint URL with the given options.

  Parameters

  • options: { locale?: string; path?: string; searchParams?: EndpointSearchParams } = {}

    The options for building the endpoint.

    • Optionallocale?: string

      The locale.

    • Optionalpath?: string

      The path.

    • OptionalsearchParams?: EndpointSearchParams

      The search parameters.

  Returns Promise<string>

  The constructed endpoint URL.

buildUrl

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

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

  Parameters

  • path: string

    The path for the url. Example: "/example"
  • OptionalsearchParams: EndpointSearchParams

    Optional query parameters.

  Returns URL

  The constructed URL.

  Example

  const drupal = new DrupalClient("https://example.com")
  
  // https://drupal.org
  drupal.buildUrl("https://drupal.org").toString()
  
  // https://example.com/foo
  drupal.buildUrl("/foo").toString()
  
  // https://example.com/foo?bar=baz
  client.buildUrl("/foo", { bar: "baz" }).toString()
  Copy

  Build a URL from DrupalJsonApiParams

  const params = {
    getQueryObject: () => ({
      sort: "-created",
      "fields[node--article]": "title,path",
    }),
  }
  
  // https://example.com/jsonapi/node/article?sort=-created&fields%5Bnode--article%5D=title%2Cpath
  drupal.buildUrl("/jsonapi/node/article", params).toString()
  Copy

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.

debug

• debug(message: any): void

• Logs a debug message if debug mode is enabled.

  Parameters

  • message: any

    The debug message.

  Returns void

fetch

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

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

  Parameters

  • input: RequestInfo

    The url to fetch from.
  • init: FetchOptions = {}

    The fetch options with withAuth. If withAuth is set, fetch will fetch an Authorization header before making the request.

  Returns Promise<Response>

  The fetch response.

  Remarks

  To provide your own custom fetcher, see the fetcher docs.

  Example

  const url = drupal.buildUrl("/jsonapi/node/article", {
    sort: "-created",
    "fields[node--article]": "title,path",
  })
  
  const response = await drupal.fetch(url.toString())
  Copy

getAccessToken

• getAccessToken(
      clientIdSecret?: NextDrupalAuthClientIdSecret,
  ): Promise<AccessToken>

• Retrieve an access token.

  Parameters

  • OptionalclientIdSecret: NextDrupalAuthClientIdSecret

    The client ID and secret.

  Returns Promise<AccessToken>

  The access token.

  Remarks

  If options is not provided, DrupalClient will use the clientId and clientSecret configured in auth.

  Example

  const accessToken = await drupal.getAccessToken({
    clientId: "7034f4db-7151-466f-a711-8384bddb9e60",
    clientSecret: "d92Fm^ds",
  })
  Copy

getAuthorizationHeader

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

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

  Parameters

  • auth: NextDrupalAuth

    The auth configuration.

  Returns Promise<string>

  The authorization header value.

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.

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.

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.