feat: add initial version of createGetCentraWebhookEvents

Author: adamsoderstrom

packages/react-centra-checkout/package.json

@@ -37,7 +37,8 @@
   },
   "dependencies": {
     "@noaignite/utils": "workspace:*",
-    "js-cookie": "^3.0.1"
+    "js-cookie": "^3.0.1",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@noaignite/centra-mocks": "workspace:*",
@@ -51,6 +52,7 @@
     "@types/react": "^18.3.12",
     "@vitest/coverage-v8": "^2.1.3",
     "jsdom": "^25.0.1",
+    "next": "^14.2.15",
     "nock": "14.0.0-beta.15",
     "tsup": "^8.3.0",
     "typescript": "5.4.5",

packages/react-centra-checkout/src/server/createGetCentraWebhookEvents.ts

@@ -0,0 +1,159 @@
+import type { NextApiRequest } from 'next'
+import crypto from 'node:crypto'
+import { z } from 'zod'
+
+const sign = (secret: string, dataString: string) => {
+  const hmac = crypto.createHmac('sha256', secret)
+
+  hmac.update(dataString)
+
+  return hmac.digest('hex')
+}
+
+/**
+ * Parse a named parameters string into an object.
+ * @example
+ * parseNamedParametersString('foo=bar,baz=qux') // \{ foo: 'bar', baz: 'qux' \}
+ */
+const parseNamedParametersString = (input: string): Record<string, string> => {
+  return input.split(',').reduce((acc, pair) => {
+    const [key, value] = pair.split('=')
+    if (!key) {
+      return acc
+    }
+
+    return { ...acc, [key]: value }
+  }, {})
+}
+
+const bodyParserSchema = z
+  .object({ payload: z.string() })
+  .nullable()
+  .catch(() => null)
+
+type EventTypes =
+  | 'affiliates'
+  | 'brands'
+  | 'campaignSites'
+  | 'campaigns'
+  | 'categories'
+  | 'cmsArticles'
+  | 'giftCertificates'
+  | 'mapsLocations'
+  | 'mapsRegion'
+  | 'markets'
+  | 'pricelists'
+  | 'products'
+  | 'statics'
+  | 'warehouseGroups'
+  | 'warehouses'
+
+type CreateGetCentraWebhookEventsConfig<TRequest> = {
+  adapter: {
+    getHeader: (request: TRequest, headerKey: string) => string | null | undefined
+
+    getRawBody: (request: TRequest) => unknown
+  }
+  secret?: string
+}
+
+/**
+ * Create get Centra webhook events.
+ * Parses and returns the events passed from Centra.
+ *
+ * @see https://centra.dev/docs/services/centra-webhooks
+ * @example
+ * ```typescript
+ * const getCentraWebhookEvents = createGetCentraWebhookEvents({
+ *   adapter: nextAppRouterAdapter
+ * })
+ *
+ * const POST = async (req: Request) => {
+ *   const [error, results] = await getCentraWebhookEvents(req)
+ *
+ *   if (error) {
+ *     // Handle error codes
+ *     return Response.json({ message: 'Error' }, { status: 500 })
+ *   }
+ *
+ *   if ('products' in results) {
+ *     return Response.json({ products: results.products }, { status: 200 })
+ *   }
+ * }
+ * ```
+ */
+export function createGetCentraWebhookEvents<TRequest>(
+  config: CreateGetCentraWebhookEventsConfig<TRequest>,
+) {
+  const { adapter, secret } = config
+  const { getHeader, getRawBody } = adapter
+
+  return async (request: TRequest) => {
+    const rawBody = await getRawBody(request)
+    const body = bodyParserSchema.parse(rawBody)
+
+    if (!body) {
+      return [
+        {
+          message: 'Invalid request body' as const,
+        },
+      ] as const
+    }
+
+    if (secret) {
+      const signature = getHeader(request, 'x-centra-signature')
+
+      if (!signature) {
+        return [
+          {
+            message: 'No signature' as const,
+          },
+        ] as const
+      }
+
+      const parameters = parseNamedParametersString(signature)
+
+      // @see https://centra.dev/docs/extend-with-plugins/integrations/centra-webhooks#signature-verification
+      if (
+        sign(secret, `${parameters.t}.payload=${encodeURIComponent(body.payload)}`) !==
+        parameters.v1
+      ) {
+        console.error('Invalid signature')
+
+        return [{ message: 'Invalid signature' as const }] as const
+      }
+    }
+
+    const payloadParsed = JSON.parse(body.payload) as Partial<Record<EventTypes, string[]>>
+
+    return [undefined, payloadParsed] as const
+  }
+}
+
+export const nextAppRouterAdapter: CreateGetCentraWebhookEventsConfig<Request>['adapter'] = {
+  getHeader: (request, headerKey) => {
+    return request.headers.get(headerKey)
+  },
+  getRawBody: async (request) => {
+    const formData = await request.formData()
+
+    // Returning an object representation of `FormData`
+    return Object.fromEntries([...formData.entries()])
+  },
+}
+
+export const nextPagesRouterAdapter: CreateGetCentraWebhookEventsConfig<NextApiRequest>['adapter'] =
+  {
+    getHeader: (request, headerKey) => {
+      const header = request.headers[headerKey]
+
+      if (Array.isArray(header)) {
+        throw new Error('Multiple headers with same key passed.')
+      }
+
+      return header
+    },
+    getRawBody: (req) => {
+      return req.body as unknown
+    },
+  }

packages/react-centra-checkout/src/server/index.ts

@@ -0,0 +1 @@
+export * from './createGetCentraWebhookEvents'