feat: add initial version of `createGetCentraWebhookEvents` #319

adamsoderstrom · 2024-10-28T20:07:01Z

No description provided.

changeset-bot · 2024-10-28T20:07:08Z

🦋 Changeset detected

Latest commit: 1c87da3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@noaignite/centra-types	Minor
@noaignite/next-centra-checkout	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2024-10-28T20:07:09Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
docs	Ready	Preview	Comment	Oct 2, 2025 7:21am

packages/react-centra-checkout/package.json

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

Copilot

Pull Request Overview

This PR adds initial support for handling Centra webhook events in Next.js applications by introducing the createGetCentraWebhookEvents function and related utilities.

Implements webhook event parsing with signature validation for security
Provides adapters for both Next.js App Router and Pages Router
Adds comprehensive type definitions for webhook events and error handling

Reviewed Changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/next-centra-checkout/src/createGetCentraWebhookEvents.ts	Core implementation of webhook event parser with signature validation and router adapters
packages/next-centra-checkout/src/createGetCentraWebhookEvents.test.ts	Comprehensive test suite covering all validation scenarios and adapter functionality
packages/centra-types/src/models/Events.ts	Type definitions for Centra webhook events
packages/next-centra-checkout/package.json	Package configuration and dependencies for the new library
packages/next-centra-checkout/tsup.config.ts	Build configuration for TypeScript compilation
packages/next-centra-checkout/tsconfig.json	TypeScript compiler configuration
packages/next-centra-checkout/src/index.ts	Package exports
packages/next-centra-checkout/eslint.config.js	ESLint configuration
packages/centra-types/src/models/index.ts	Export addition for Events type
.changeset/shiny-kangaroos-dress.md	Changeset for next-centra-checkout package
.changeset/curvy-wombats-itch.md	Changeset for centra-types package

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

Copilot · 2025-09-24T17:24:13Z

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

+export const nextAppRouterAdapter = {
+  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()])
+  },
+} satisfies CreateGetCentraWebhookEventsConfig<Request>['adapter']


The adapter functions lack proper type annotations for their parameters. Consider adding explicit types: getHeader: (request: Request, headerKey: string) => {...} and getRawBody: async (request: Request) => {...} for better type safety and IDE support.

I do enjoy the satisfies expression more.

Copilot · 2025-09-24T17:24:13Z

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

+export const nextPagesRouterAdapter = {
+  isRequestMethodPost: (request) => {
+    return request.method === 'POST'
+  },
+  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
+  },
+} satisfies CreateGetCentraWebhookEventsConfig<NextApiRequest>['adapter']


The adapter functions lack proper type annotations for their parameters. Consider adding explicit types: isRequestMethodPost: (request: NextApiRequest) => boolean, getHeader: (request: NextApiRequest, headerKey: string) => {...}, and getRawBody: (req: NextApiRequest) => {...} for better type safety and IDE support.

I do enjoy the satisfies expression more.

Copilot

Pull Request Overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-24T17:51:52Z

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

+        sign(secret, `${parameters.t}.payload=${encodeURIComponent(body.payload)}`) !==
+        parameters.v1
+      ) {
+        console.error('Invalid signature')


The console.error call should be removed or made configurable. Logging to console directly in a library function can interfere with application logging strategies and may not be appropriate for all environments.

Copilot · 2025-09-24T17:51:53Z

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

+      }
+    }
+
+    const payloadParsed = JSON.parse(body.payload) as unknown


JSON.parse can throw a SyntaxError if the payload is not valid JSON. This should be wrapped in a try-catch block and return an appropriate error response if parsing fails.

Suggested change

const payloadParsed = JSON.parse(body.payload) as unknown

let payloadParsed: unknown

try {

payloadParsed = JSON.parse(body.payload)

} catch (err) {

return [

{

message: 'Invalid payload JSON',

},

] satisfies CentraWebhookEventsError

}

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

codecov · 2025-09-24T17:53:29Z

Codecov Report

❌ Patch coverage is 89.24731% with 10 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...entra-checkout/src/createGetCentraWebhookEvents.ts	90.21%	9 Missing ⚠️
packages/next-centra-checkout/src/index.ts	0.00%	0 Missing and 1 partial ⚠️

@@            Coverage Diff             @@
##             main     #319      +/-   ##
==========================================
+ Coverage   73.81%   74.46%   +0.65%     
==========================================
  Files          62       64       +2     
  Lines        2112     2205      +93     
  Branches      295      320      +25     
==========================================
+ Hits         1559     1642      +83     
- Misses        541      550       +9     
- Partials       12       13       +1

Files with missing lines	Coverage Δ
packages/next-centra-checkout/src/index.ts	`0.00% <0.00%> (ø)`
...entra-checkout/src/createGetCentraWebhookEvents.ts	`90.21% <90.21%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull Request Overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-24T18:26:31Z

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

+        parameters.v1
+      ) {
+        console.error('Invalid signature')
+


[nitpick] Consider making the error logging configurable or removing it entirely. Console.error calls in library code can clutter application logs and should ideally be handled by the consuming application.

Copilot · 2025-09-24T18:26:31Z

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

+      return [undefined, payloadParsed] as CentraWebhookEventsData
+    } catch (e) {
+      console.error(e)
+


[nitpick] Consider making the error logging configurable or removing it entirely. Console.error calls in library code can clutter application logs and should ideally be handled by the consuming application.

Copilot · 2025-09-24T18:26:31Z

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

+      return acc
+    }
+
+    return { ...acc, [key]: value }


Using object spread operator in reduce creates a new object on each iteration. Consider using a more efficient approach like acc[key] = value; return acc to avoid unnecessary object creation.

Suggested change

return { ...acc, [key]: value }

acc[key] = value

return acc

adamsoderstrom requested review from alexanderflink, aron-b and maeertin October 28, 2024 20:07

adamsoderstrom self-assigned this Oct 28, 2024

vercel bot deployed to Preview October 28, 2024 20:07 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from c21121a to 5c7f9d7 Compare October 28, 2024 20:16

vercel bot deployed to Preview October 28, 2024 20:17 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 5c7f9d7 to 0c4ec16 Compare October 28, 2024 20:18

vercel bot had a problem deploying to Preview October 28, 2024 20:18 Failure

adamsoderstrom commented Oct 28, 2024

View reviewed changes

packages/react-centra-checkout/package.json Outdated Show resolved Hide resolved

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 0c4ec16 to 863ab63 Compare October 28, 2024 20:22

vercel bot deployed to Preview October 28, 2024 20:24 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 863ab63 to 03f2d5d Compare October 28, 2024 20:25

vercel bot deployed to Preview October 28, 2024 20:26 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 03f2d5d to ebefd03 Compare October 29, 2024 06:21

vercel bot deployed to Preview October 29, 2024 06:22 View deployment

adamsoderstrom requested a review from ptrl October 31, 2024 13:23

Dashice reviewed Nov 18, 2024

View reviewed changes

packages/react-centra-checkout/src/server/createGetCentraWebhookEvents.ts Outdated Show resolved Hide resolved

Dashice reviewed Nov 18, 2024

View reviewed changes

packages/react-centra-checkout/src/server/createGetCentraWebhookEvents.ts Outdated Show resolved Hide resolved

maeertin reviewed Nov 18, 2024

View reviewed changes

packages/react-centra-checkout/src/server/createGetCentraWebhookEvents.ts Outdated Show resolved Hide resolved

Dashice reviewed Nov 18, 2024

View reviewed changes

packages/react-centra-checkout/src/server/createGetCentraWebhookEvents.ts Outdated Show resolved Hide resolved

maeertin reviewed Nov 18, 2024

View reviewed changes

packages/react-centra-checkout/src/server/createGetCentraWebhookEvents.ts Outdated Show resolved Hide resolved

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from ebefd03 to 2382b52 Compare December 2, 2024 14:31

vercel bot deployed to Preview December 2, 2024 14:32 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 2382b52 to 25207a4 Compare December 2, 2024 14:50

vercel bot deployed to Preview December 2, 2024 14:51 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 25207a4 to c052d71 Compare December 2, 2024 15:03

vercel bot deployed to Preview December 2, 2024 15:04 View deployment

vercel bot deployed to Preview April 27, 2025 22:20 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch 2 times, most recently from f30d3cc to 23b1375 Compare May 1, 2025 11:26

vercel bot deployed to Preview May 1, 2025 11:27 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 23b1375 to 7de2df1 Compare May 24, 2025 22:01

vercel bot deployed to Preview May 24, 2025 22:02 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 7de2df1 to b9cbe8b Compare July 2, 2025 11:52

vercel bot deployed to Preview July 2, 2025 11:53 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from b9cbe8b to a64f348 Compare July 2, 2025 11:53

vercel bot deployed to Preview July 2, 2025 11:55 View deployment

maeertin requested a review from Copilot September 24, 2025 17:23

Copilot AI reviewed Sep 24, 2025

View reviewed changes

feat(centra-types): add Events type

6a3314d

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from a64f348 to a81618d Compare September 24, 2025 17:48

vercel bot deployed to Preview September 24, 2025 17:49 View deployment

Copilot AI review requested due to automatic review settings September 24, 2025 17:50

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from a81618d to c9a892d Compare September 24, 2025 17:50

Copilot AI reviewed Sep 24, 2025

View reviewed changes

vercel bot deployed to Preview September 24, 2025 17:52 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from c9a892d to 068abe7 Compare September 24, 2025 18:12

vercel bot deployed to Preview September 24, 2025 18:12 View deployment

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from 068abe7 to db0f6fc Compare September 24, 2025 18:25

Copilot AI review requested due to automatic review settings September 24, 2025 18:25

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from db0f6fc to a340428 Compare September 24, 2025 18:26

Copilot AI reviewed Sep 24, 2025

View reviewed changes

vercel bot deployed to Preview September 24, 2025 18:27 View deployment

feat(next-centra-checkout): create initial version of package

1c87da3

adamsoderstrom force-pushed the feature/create-get-centra-webhook-events branch from a340428 to 1c87da3 Compare October 2, 2025 07:20

vercel bot deployed to Preview October 2, 2025 07:21 View deployment

-    const payloadParsed = JSON.parse(body.payload) as unknown
+    let payloadParsed: unknown
+    try {
+      payloadParsed = JSON.parse(body.payload)
+    } catch (err) {
+      return [
+        {
+          message: 'Invalid payload JSON',
+        },
+      ] satisfies CentraWebhookEventsError
+    }

feat: add initial version of createGetCentraWebhookEvents #319

Are you sure you want to change the base?

feat: add initial version of createGetCentraWebhookEvents #319

Uh oh!

Conversation

adamsoderstrom commented Oct 28, 2024

Uh oh!

changeset-bot bot commented Oct 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Oct 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

adamsoderstrom Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

adamsoderstrom Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add initial version of `createGetCentraWebhookEvents` #319

feat: add initial version of `createGetCentraWebhookEvents` #319

changeset-bot bot commented Oct 28, 2024 •

edited

Loading

vercel bot commented Oct 28, 2024 •

edited

Loading

codecov bot commented Sep 24, 2025 •

edited

Loading