Improved exported paths, added NextAppRouter specific platform #418

lkostrowski · 2025-03-04T09:55:00Z

add NextRequest and NextResponse generics

changeset-bot · 2025-03-04T09:55:03Z

🦋 Changeset detected

Latest commit: 79b58b8

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

This PR includes changesets to release 1 package

Name	Type
@saleor/app-sdk	Major

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

codecov · 2025-03-04T09:56:23Z

Codecov Report

Attention: Patch coverage is 36.36364% with 112 lines in your changes missing coverage. Please review.

Project coverage is 81.66%. Comparing base (5e4eb20) to head (79b58b8).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...tforms/next-app-router/create-protected-handler.ts	0.00%	24 Missing and 1 partial ⚠️
.../next-app-router/saleor-webhooks/saleor-webhook.ts	4.76%	20 Missing ⚠️
...-app-router/saleor-webhooks/saleor-sync-webhook.ts	7.69%	12 Missing ⚠️
...app-router/saleor-webhooks/saleor-async-webhook.ts	8.33%	11 Missing ⚠️
...rms/next-app-router/create-app-register-handler.ts	0.00%	9 Missing and 1 partial ⚠️
...atforms/next-app-router/create-manifest-handler.ts	9.09%	10 Missing ⚠️
src/handlers/platforms/next-app-router/index.ts	0.00%	6 Missing and 1 partial ⚠️
...lers/platforms/next-app-router/platform-adapter.ts	0.00%	6 Missing and 1 partial ⚠️
src/app-bridge/app-bridge.ts	66.66%	3 Missing ⚠️
src/util/public/browser/index.ts	0.00%	1 Missing and 1 partial ⚠️
... and 5 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #418      +/-   ##
==========================================
- Coverage   83.40%   81.66%   -1.74%     
==========================================
  Files          99      107       +8     
  Lines        3429     3502      +73     
  Branches      587      593       +6     
==========================================
  Hits         2860     2860              
- Misses        557      626      +69     
- Partials       12       16       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 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.

lkostrowski · 2025-03-04T14:48:01Z

package.json

+      "types": "./util/public/browser/index.d.ts",
+      "import": "./util/public/browser/index.mjs",
+      "require": "./util/public/browser/index.js"
+    },


chaned exports - marked these for browser and node specific, removed some because they didn't make sense anymore

lkostrowski · 2025-03-04T14:50:32Z

src/handlers/platforms/fetch-api/platform-adapter.ts

-  constructor(public request: Request) {}
+export class WebApiAdapter<
+  TRequest extends Request = Request,
+  TResponse extends Response = Response,


In general:

Before: Next App Router platform was 1:1 re-exported FetchApi. But this is not correct because Next is extending it's Request to NextREquest, so it was limiting the usage (and NextResponse too)

Now: I created separated code for Next, reused WebApi where possible and injected NextRequest and NextResponse as generics

github-actions · 2025-03-04T14:53:38Z

Released snapshot build with @dev tag in npm with version: 0.0.0-pr-20250304145310.

Install it with:

pnpm add @saleor/app-sdk@0.0.0-pr-20250304145310

krzysztofzuraw · 2025-03-04T14:59:55Z

package.json

-      "types": "./verify-jwt.d.ts",
-      "import": "./verify-jwt.mjs",
-      "require": "./verify-jwt.js"
+    "./auth/node": {


Question: do we support egde runtime as well or plan to do so?

I'm asking as if we don't plan to do this we can have auth/server instead 🤔

I think it's better if we keep node for compatibility (I dont know if it works with edge) and then if we decide to support edge, we can add alias node = edge or node = server

if we do other way around and start with "server" it will require a bc

update: I dogfood it in Adyen and realized there is no "browser" part. JWT is from browser but it's checked on the server 🤦

So I removed node and browser and left auth

krzysztofzuraw · 2025-03-04T15:04:55Z

src/handlers/platforms/next-app-router/create-protected-handler.ts

+    const context = validationResult.value;
+    try {
+      return await handlerFn(request, context);
+    } catch (err) {


Question: don't we want to log error here (even if it is in debug)?

github-actions · 2025-03-04T16:01:10Z

Released snapshot build with @dev tag in npm with version: 0.0.0-pr-20250304160045.

Install it with:

pnpm add @saleor/app-sdk@0.0.0-pr-20250304160045

github-actions · 2025-03-04T16:16:17Z

Released snapshot build with @dev tag in npm with version: 0.0.0-pr-20250304161552.

Install it with:

pnpm add @saleor/app-sdk@0.0.0-pr-20250304161552

github-actions · 2025-03-04T16:26:52Z

Released snapshot build with @dev tag in npm with version: 0.0.0-pr-20250304162628.

Install it with:

pnpm add @saleor/app-sdk@0.0.0-pr-20250304162628

export webApiWebhookHandler

28f5eec

github-actions bot assigned lkostrowski Mar 4, 2025

lkostrowski added 3 commits March 4, 2025 13:35

generics for next app router

bfc6130

auth/browser

0ce2325

new export paths

b7ac7d8

lkostrowski changed the title ~~WIP Missing exports~~ Improved exported paths, added NextAppRouter specific platform Mar 4, 2025

lkostrowski marked this pull request as ready for review March 4, 2025 14:47

lkostrowski requested a review from a team as a code owner March 4, 2025 14:47

lkostrowski commented Mar 4, 2025

View reviewed changes

lkostrowski added the release dev tag label Mar 4, 2025

krzysztofzuraw reviewed Mar 4, 2025

View reviewed changes

remove auth/browser

82fb0d1

lkostrowski added release dev tag and removed release dev tag labels Mar 4, 2025

lkostrowski added 2 commits March 4, 2025 17:08

update header name

24f721e

fix auth export

d5beb57

lkostrowski added release dev tag and removed release dev tag labels Mar 4, 2025

fix exports

7a49084

lkostrowski added release dev tag and removed release dev tag labels Mar 4, 2025

remove domain from app bridge state

79b58b8

krzysztofzuraw approved these changes Mar 5, 2025

View reviewed changes

lkostrowski merged commit 8dc8d4a into main Mar 6, 2025
8 checks passed

lkostrowski deleted the next-app-router-handlers branch March 6, 2025 06:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved exported paths, added NextAppRouter specific platform #418

Improved exported paths, added NextAppRouter specific platform #418

lkostrowski commented Mar 4, 2025 •

edited

Loading

changeset-bot bot commented Mar 4, 2025 •

edited

Loading

codecov bot commented Mar 4, 2025 •

edited

Loading

lkostrowski Mar 4, 2025

lkostrowski Mar 4, 2025

github-actions bot commented Mar 4, 2025

krzysztofzuraw Mar 4, 2025

lkostrowski Mar 4, 2025

lkostrowski Mar 4, 2025

krzysztofzuraw Mar 4, 2025

github-actions bot commented Mar 4, 2025

github-actions bot commented Mar 4, 2025

github-actions bot commented Mar 4, 2025

Improved exported paths, added NextAppRouter specific platform #418

Improved exported paths, added NextAppRouter specific platform #418

Conversation

lkostrowski commented Mar 4, 2025 • edited Loading

changeset-bot bot commented Mar 4, 2025 • edited Loading

🦋 Changeset detected

codecov bot commented Mar 4, 2025 • edited Loading

Codecov Report

lkostrowski Mar 4, 2025

Choose a reason for hiding this comment

lkostrowski Mar 4, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 4, 2025

krzysztofzuraw Mar 4, 2025

Choose a reason for hiding this comment

lkostrowski Mar 4, 2025

Choose a reason for hiding this comment

lkostrowski Mar 4, 2025

Choose a reason for hiding this comment

krzysztofzuraw Mar 4, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 4, 2025

github-actions bot commented Mar 4, 2025

github-actions bot commented Mar 4, 2025

lkostrowski commented Mar 4, 2025 •

edited

Loading

changeset-bot bot commented Mar 4, 2025 •

edited

Loading

codecov bot commented Mar 4, 2025 •

edited

Loading