next-sanity/src/webhook/parseBody.ts

Sanity.io toolkit for Next.js

import type {SanityDocument} from '@sanity/types'
import sanityWebhook from '@sanity/webhook'
import type {NextApiRequest} from 'next'

// As `@sanity/webhook` isn't shipping ESM, extracting from the default export have the best ecosystem support
const {isValidSignature, SIGNATURE_HEADER_NAME} = sanityWebhook

import {_readBody as readBody} from './readBody'

/** @public */
export type ParseBody = {
  /**
   * If a secret is given then it returns a boolean. If no secret is provided then no validation is done on the signature, and it'll return `null`
   */
  isValidSignature: boolean | null
  body: SanityDocument
}
/**
 * Handles parsing the body JSON, and validating its signature. Also waits for Content Lake eventual consistency so you can run your queries
 * without worrying about getting stale data.
 * @public
 */
export async function parseBody(
  req: NextApiRequest,
  secret?: string,
  waitForContentLakeEventualConsistency: boolean = true
): Promise<ParseBody> {
  let signature = req.headers[SIGNATURE_HEADER_NAME]!
  if (Array.isArray(signature)) {
    signature = signature[0]
  }

  // Read the body into a string
  const body = await readBody(req)
  // Then we're able to verify the checksum signature
  const validSignature = secret ? isValidSignature(body, signature, secret.trim()) : null

  if (validSignature !== false && waitForContentLakeEventualConsistency) {
    // Wait a second to give Elastic Search time to reach eventual consistency
    await new Promise((resolve) => setTimeout(resolve, 1000))
  }

  return {
    body: body.trim() && JSON.parse(body),
    isValidSignature: validSignature,
  }
}