Skip to content

Comments

Deprecate buildSyncWebhookResponsePayload#444

Closed
kzuraw wants to merge 1 commit intomainfrom
deprecate-build-sync-webhook-response-payload
Closed

Deprecate buildSyncWebhookResponsePayload#444
kzuraw wants to merge 1 commit intomainfrom
deprecate-build-sync-webhook-response-payload

Conversation

@kzuraw
Copy link
Contributor

@kzuraw kzuraw commented Jun 17, 2025

Deprecate buildSyncWebhookResponsePayload function. Saleor now exposes JSON schema for webhook response payloads that can be used to generate TypeScript types. See Saleor docs for more info.

@kzuraw kzuraw requested a review from lkostrowski June 17, 2025 11:21
@changeset-bot
Copy link

changeset-bot bot commented Jun 17, 2025

🦋 Changeset detected

Latest commit: 5b65f5c

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

@kzuraw kzuraw marked this pull request as ready for review June 17, 2025 11:21
@codecov
Copy link

codecov bot commented Jun 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.87%. Comparing base (09345e3) to head (5b65f5c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #444   +/-   ##
=======================================
  Coverage   83.87%   83.87%           
=======================================
  Files         107      107           
  Lines        3511     3511           
  Branches      591      591           
=======================================
  Hits         2945     2945           
  Misses        555      555           
  Partials       11       11           

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

Comment on lines +261 to +262
* @deprecated Saleor now exposes JSON schema for webhook response payloads that can be used to generate TypeScript types. See https://docs.saleor.io/developer/extending/apps/developing-apps/generating-types-for-sync-webhooks for more details.
*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should generate types in SDK instead? So you don't have to regenerate them in every app?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can - but I think it will the best if we have app-sdk version connected to Saleor version. Then we can generate JSON schema types + GraphQL types as well

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so lets do it

@kzuraw kzuraw closed this Jun 24, 2025
@kzuraw kzuraw deleted the deprecate-build-sync-webhook-response-payload branch June 24, 2025 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants