From 5b65f5c2263ab40b576f84313b7230fb30098e40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20=C5=BBuraw?= <9116238+krzysztofzuraw@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:20:51 +0200 Subject: [PATCH] Deprecate `buildSyncWebhookResponsePayload` function in favor of new JSON schema for webhook response payloads --- .changeset/eight-files-relate.md | 5 +++++ src/handlers/shared/sync-webhook-response-builder.ts | 2 ++ 2 files changed, 7 insertions(+) create mode 100644 .changeset/eight-files-relate.md diff --git a/.changeset/eight-files-relate.md b/.changeset/eight-files-relate.md new file mode 100644 index 00000000..6ae10c5d --- /dev/null +++ b/.changeset/eight-files-relate.md @@ -0,0 +1,5 @@ +--- +"@saleor/app-sdk": patch +--- + +Deprecate `buildSyncWebhookResponsePayload` function. Saleor now exposes JSON schema for webhook response payloads that can be used to generate TypeScript types. See [Saleor docs](https://docs.saleor.io/developer/extending/apps/developing-apps/generating-types-for-sync-webhooks) for more info. diff --git a/src/handlers/shared/sync-webhook-response-builder.ts b/src/handlers/shared/sync-webhook-response-builder.ts index c5b6f798..3d71f618 100644 --- a/src/handlers/shared/sync-webhook-response-builder.ts +++ b/src/handlers/shared/sync-webhook-response-builder.ts @@ -258,6 +258,8 @@ export type SyncWebhookResponsesMap = CoreSync } & TransactionWebhookResponses; /** + * @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. + * * Identity function, but it works on Typescript level to pick right payload based on first param */ export const buildSyncWebhookResponsePayload = <