Fix webhook response builder params for transaction events to align with Saleor documentation (#429)

Author: kzuraw

.changeset/shy-pigs-appear.md

@@ -0,0 +1,5 @@
+---
+"@saleor/app-sdk": patch
+---
+
+Fixed `TRANSACTION_CHARGE_REQUESTED`, `TRANSACTION_REFUND_REQUESTED`, `TRANSACTION_CANCELATION_REQUESTED`, `TRANSACTION_INITIALIZE_SESSION` and `TRANSACTION_PROCESS_SESSION` webhook response builder params. After this change `buildSyncWebhookResponsePayload` for those events should be the same as in Saleor docs.

src/handlers/shared/sync-webhook-response-builder.ts

@@ -29,66 +29,76 @@ export type SyncWebhookResponsesMap = {
      */
     maximum_delivery_days?: number;
   }>;
+  // https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response
   TRANSACTION_CHARGE_REQUESTED: {
-    pspReference: string;
-    result?: "CHARGE_SUCCESS" | "CHARGE_FAILURE";
-    amount?: number;
+    result: "CHARGE_SUCCESS" | "CHARGE_FAILURE";
+    amount: number;
+    pspReference?: string;
     time?: string;
     externalUrl?: string;
     message?: string;
+    actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
   };
+  // https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#sync-flow-2
   TRANSACTION_REFUND_REQUESTED: {
-    pspReference: string;
-    result?: "REFUND_SUCCESS" | "REFUND_FAILURE";
-    amount?: number;
+    result: "REFUND_SUCCESS" | "REFUND_FAILURE";
+    amount: number;
+    pspReference?: string;
     time?: string;
     externalUrl?: string;
     message?: string;
+    actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
   };
+  // https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response-1
   TRANSACTION_CANCELATION_REQUESTED: {
-    pspReference: string;
-    result?: "CANCEL_SUCCESS" | "CANCEL_FAILURE";
-    amount?: number;
+    result: "CANCEL_SUCCESS" | "CANCEL_FAILURE";
+    amount: number;
+    pspReference?: string;
     time?: string;
     externalUrl?: string;
     message?: string;
+    actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
   };
   PAYMENT_GATEWAY_INITIALIZE_SESSION: {
     data: unknown;
   };
+  // https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response-4
   TRANSACTION_INITIALIZE_SESSION: {
-    pspReference?: string;
-    data?: unknown;
     result:
       | "CHARGE_SUCCESS"
       | "CHARGE_FAILURE"
       | "CHARGE_REQUEST"
       | "CHARGE_ACTION_REQUIRED"
       | "AUTHORIZATION_SUCCESS"
       | "AUTHORIZATION_FAILURE"
-      | "AUTHORIZATION_REQUESTED"
+      | "AUTHORIZATION_REQUEST"
       | "AUTHORIZATION_ACTION_REQUIRED";
     amount: number;
+    pspReference?: string;
+    data?: unknown;
     time?: string;
     externalUrl?: string;
     message?: string;
+    actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
   };
+  // https://docs.saleor.io/developer/extending/webhooks/synchronous-events/transaction#response-5
   TRANSACTION_PROCESS_SESSION: {
-    pspReference?: string;
-    data?: unknown;
     result:
       | "CHARGE_SUCCESS"
       | "CHARGE_FAILURE"
       | "CHARGE_REQUEST"
       | "CHARGE_ACTION_REQUIRED"
       | "AUTHORIZATION_SUCCESS"
       | "AUTHORIZATION_FAILURE"
-      | "AUTHORIZATION_REQUESTED"
+      | "AUTHORIZATION_REQUEST"
       | "AUTHORIZATION_ACTION_REQUIRED";
     amount: number;
+    pspReference?: string;
+    data?: unknown;
     time?: string;
     externalUrl?: string;
     message?: string;
+    actions?: Array<"CHARGE" | "REFUND" | "CANCEL">;
   };
   PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION:
     | {