feat: add initial version of createGetCentraWebhookEvents

.changeset/curvy-wombats-itch.md

@@ -0,0 +1,5 @@
+---
+'@noaignite/centra-types': minor
+---
+
+Add `Events` type for Centra Webhooks plugin

.changeset/shiny-kangaroos-dress.md

@@ -0,0 +1,5 @@
+---
+'@noaignite/next-centra-checkout': patch
+---
+
+Add initial version of `createGetCentraWebhookEvents`

packages/centra-types/src/models/Events.ts

@@ -0,0 +1,21 @@
+/**
+ * A webhook event, dispatched from the Centra Webhook plugin.
+ *
+ * @see https://centra.dev/docs/services/centra-webhooks
+ */
+export type Events =
+  | 'affiliates'
+  | 'brands'
+  | 'campaignSites'
+  | 'campaigns'
+  | 'categories'
+  | 'cmsArticles'
+  | 'giftCertificates'
+  | 'mapsLocations'
+  | 'mapsRegion'
+  | 'markets'
+  | 'pricelists'
+  | 'products'
+  | 'statics'
+  | 'warehouseGroups'
+  | 'warehouses'

packages/centra-types/src/models/index.ts

@@ -6,6 +6,7 @@ export * from './Category'
 export * from './Country'
 export * from './Currency'
 export * from './Discounts'
+export * from './Events'
 export * from './Filter'
 export * from './ImageAttribute'
 export * from './Item'

packages/next-centra-checkout/eslint.config.js

@@ -0,0 +1,3 @@
+import nextConfig from '@noaignite/style-guide/eslint/next'
+
+export default nextConfig

packages/next-centra-checkout/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@noaignite/next-centra-checkout",
+  "version": "0.0.0",
+  "private": false,
+  "description": "Next.js helpers for Centra checkout api",
+  "keywords": [
+    "backend",
+    "centra",
+    "nextjs",
+    "react",
+    "typescript",
+    "vercel"
+  ],
+  "bugs": {
+    "url": "https://github.com/noaignite/accelerator/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/noaignite/accelerator.git",
+    "directory": "packages/next-centra-checkout"
+  },
+  "license": "MIT",
+  "author": "NoA Ignite",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint src/ --ignore-pattern '**/*.test.*'",
+    "test:coverage": "vitest run --coverage",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest"
+  },
+  "dependencies": {
+    "@noaignite/utils": "workspace:*"
+  },
+  "devDependencies": {
+    "@noaignite/centra-types": "workspace:*",
+    "@noaignite/style-guide": "workspace:*",
+    "@types/react": "^19.1.2",
+    "next": "^15.0.0",
+    "nock": "14.0.1",
+    "react": "^19.1.0",
+    "tsup": "^8.3.5",
+    "typescript": "5.4.5"
+  },
+  "peerDependencies": {
+    "next": "^14.0.0 || ^15.0.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/next-centra-checkout/src/createGetCentraWebhookEvents.test.ts

@@ -0,0 +1,245 @@
+import type { NextApiRequest } from 'next'
+import crypto from 'node:crypto'
+import { describe, expect, it, vi } from 'vitest'
+import {
+  createGetCentraWebhookEvents,
+  nextAppRouterAdapter,
+  nextPagesRouterAdapter,
+} from './createGetCentraWebhookEvents'
+
+vi.mock('node:crypto', async () => {
+  return {
+    default: {
+      createHmac: vi.fn().mockReturnValue({
+        update: vi.fn(),
+        digest: vi.fn().mockReturnValue('valid-signature'),
+      }),
+    },
+  }
+})
+
+describe('createGetCentraWebhookEvents', () => {
+  describe('with secret', () => {
+    const mockSecret = 'test-secret'
+    const mockPayload = JSON.stringify({ products: ['product-1'] })
+    const mockTimestamp = '1234567890'
+    const mockSignature = `t=${mockTimestamp},v1=valid-signature`
+
+    it('validates signature correctly', async () => {
+      // Arrange
+      const mockRequest = {
+        method: 'POST',
+        headers: {
+          'x-centra-signature': mockSignature,
+        },
+        body: {
+          payload: mockPayload,
+        },
+      } as unknown as NextApiRequest // Only mocking the properties used internally of the function.
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: {
+          isRequestMethodPost: () => true,
+          getHeader: (req: NextApiRequest, key) => req.headers[key] as string,
+          getRawBody: () => Promise.resolve(mockRequest.body),
+        },
+        secret: mockSecret,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(crypto.createHmac).toHaveBeenCalledWith('sha256', mockSecret)
+      expect(result).toEqual([undefined, JSON.parse(mockPayload)])
+    })
+
+    it('returns error for invalid signature', async () => {
+      // Arrange
+      const mockRequest = {
+        method: 'POST',
+        headers: {
+          'x-centra-signature': 't=1234567890,v1=invalid-signature',
+        },
+        body: {
+          payload: mockPayload,
+        },
+      } as unknown as NextApiRequest // Only mocking the properties used internally of the function.
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: {
+          isRequestMethodPost: () => true,
+          getHeader: (req: NextApiRequest, key) => req.headers[key] as string,
+          getRawBody: () => Promise.resolve(mockRequest.body),
+        },
+        secret: mockSecret,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(result).toEqual([{ message: 'Invalid signature' }])
+    })
+
+    it('returns error when no signature is provided', async () => {
+      // Arrange
+      const mockRequest = {
+        method: 'POST',
+        headers: {},
+        body: {
+          payload: mockPayload,
+        },
+      }
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: {
+          isRequestMethodPost: () => true,
+          getHeader: () => undefined,
+          getRawBody: () => Promise.resolve(mockRequest.body),
+        },
+        secret: mockSecret,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(result).toEqual([{ message: 'No signature' }])
+    })
+  })
+
+  describe('without secret', () => {
+    it('skips signature validation when secret is null', async () => {
+      // Arrange
+      const mockPayload = JSON.stringify({ products: ['product-1'] })
+      const mockRequest = {
+        method: 'POST',
+        headers: {},
+        body: {
+          payload: mockPayload,
+        },
+      }
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: {
+          isRequestMethodPost: () => true,
+          getHeader: () => undefined,
+          getRawBody: () => Promise.resolve(mockRequest.body),
+        },
+        secret: null,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(result).toEqual([undefined, JSON.parse(mockPayload)])
+    })
+  })
+
+  describe('request validation', () => {
+    it('returns error for non-POST requests', async () => {
+      // Arrange
+      const mockRequest = {
+        method: 'GET',
+        headers: {},
+        body: {},
+      }
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: {
+          isRequestMethodPost: () => false,
+          getHeader: () => undefined,
+          getRawBody: () => Promise.resolve({}),
+        },
+        secret: null,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(result).toEqual([{ message: 'Invalid request method' }])
+    })
+
+    it('returns error for invalid request body', async () => {
+      // Arrange
+      const mockRequest = {
+        method: 'POST',
+        headers: {},
+        body: 'invalid-body',
+      }
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: {
+          isRequestMethodPost: () => true,
+          getHeader: () => undefined,
+          getRawBody: () => Promise.resolve('invalid-body'),
+        },
+        secret: null,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(result).toEqual([{ message: 'Invalid request body' }])
+    })
+  })
+
+  describe('adapters', () => {
+    it('nextAppRouterAdapter works correctly', async () => {
+      // Arrange
+      const mockFormData = new FormData()
+      mockFormData.append('payload', JSON.stringify({ products: ['product-1'] }))
+
+      const mockRequest = {
+        headers: new Headers({
+          'x-centra-signature': 't=1234567890,v1=valid-signature',
+        }),
+        formData: () => Promise.resolve(mockFormData),
+      }
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: nextAppRouterAdapter,
+        secret: null,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest as unknown as Request)
+
+      // Assert
+      expect(result[0]).toBeUndefined()
+      expect(result[1]).toEqual({ products: ['product-1'] })
+    })
+
+    it('nextPagesRouterAdapter works correctly', async () => {
+      // Arrange
+      const mockRequest = {
+        method: 'POST',
+        headers: {
+          'x-centra-signature': 't=1234567890,v1=valid-signature',
+        },
+        body: {
+          payload: JSON.stringify({ products: ['product-1'] }),
+        },
+      } as unknown as NextApiRequest // Only mocking the properties used internally of the function.
+
+      const getCentraWebhookEvents = createGetCentraWebhookEvents({
+        adapter: nextPagesRouterAdapter,
+        secret: null,
+      })
+
+      // Act
+      const result = await getCentraWebhookEvents(mockRequest)
+
+      // Assert
+      expect(nextPagesRouterAdapter.getHeader(mockRequest, 'x-centra-signature')).toBe(
+        't=1234567890,v1=valid-signature',
+      )
+      expect(result[0]).toBeUndefined()
+      expect(result[1]).toEqual({ products: ['product-1'] })
+    })
+  })
+})