feat: #56 (*) move metadata to api client

vuestorefront-community · Aug 25, 2021 · b6eebed · b6eebed
1 parent 46d9fa5
commit b6eebed
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 11 deletions.
diff --git a/packages/api-client/src/api/setPaymentMethod/index.ts b/packages/api-client/src/api/setPaymentMethod/index.ts
@@ -1,11 +1,16 @@
 import addPaymentToOrderMutation from './addPaymentToOrderMutation';
 import { CustomQuery } from '@vue-storefront/core';
 import gql from 'graphql-tag';
-import { Context, PaymentInput, SetShippingMethodResponse } from '../../types';
+import { AddPaymentToOrderParams, Context, PaymentInput, SetShippingMethodResponse } from '../../types';
 
-const setPaymentMethod = async (context: Context, params: PaymentInput, customQuery?: CustomQuery): Promise<SetShippingMethodResponse> => {
+const setPaymentMethod = async (context: Context, params: AddPaymentToOrderParams, customQuery?: CustomQuery): Promise<SetShippingMethodResponse> => {
   const setPaymentMethodVariables = {
-    input: params
+    input: {
+      method: params.method,
+      metadata: {
+        // Here you would pass data from an external Payment Provided after successful payment process like payment id.
+      }
+    } as PaymentInput,
   };
 
   const { addPaymentToOrder } = context.extendQuery(

diff --git a/packages/api-client/src/types/API.ts b/packages/api-client/src/types/API.ts
@@ -1,8 +1,8 @@
 import { CustomQuery } from '@vue-storefront/core';
 import { ApolloQueryResult } from 'apollo-client';
 import { FetchResult } from 'apollo-link';
-import { ActiveOrderResult, ApplyCouponCodeResult, CollectionList, CreateCustomerInput, Customer, Order, PaymentInput, PaymentMethodQuote, Product, RemoveOrderItemsResult, SearchResponse, SetCustomerForOrderResult, ShippingMethodQuote, UpdateOrderItemsResult } from './GraphQL';
-import { AddToCartParams, CartCouponParams, CollectionParams, ProductParams, RemoveFromCartParams, SearchParams, SetShippingMethodParams, TransitionOrderToStateParams, UpdateAddressDetailsParams, UpdateCartParams } from './types';
+import { ActiveOrderResult, ApplyCouponCodeResult, CollectionList, CreateCustomerInput, Customer, Order, PaymentMethodQuote, Product, RemoveOrderItemsResult, SearchResponse, SetCustomerForOrderResult, ShippingMethodQuote, UpdateOrderItemsResult } from './GraphQL';
+import { AddPaymentToOrderParams, AddToCartParams, CartCouponParams, CollectionParams, ProductParams, RemoveFromCartParams, SearchParams, SetShippingMethodParams, TransitionOrderToStateParams, UpdateAddressDetailsParams, UpdateCartParams } from './types';
 
 export type QueryResponse<K extends string, V> = ApolloQueryResult<Record<K, V>>;
 export type MutationResponse<K extends string, V> = FetchResult<Record<K, V>>;
@@ -41,7 +41,7 @@ export interface VendureApiMethods {
   removeCouponCode(params: CartCouponParams, customQuery?: CustomQuery): Promise<RemoveCouponCodeResponse>;
   updateAddressDetails(params: UpdateAddressDetailsParams, customQuery?: CustomQuery): Promise<UpdateAddressDetailsResponse>;
   setShippingMethod(params: SetShippingMethodParams, customQuery?: CustomQuery): Promise<SetShippingMethodResponse>;
-  setPaymentMethod(params: PaymentInput, customQuery?: CustomQuery): Promise<SetPaymentMethodResponse>;
+  setPaymentMethod(params: AddPaymentToOrderParams, customQuery?: CustomQuery): Promise<SetPaymentMethodResponse>;
   transitionOrderToState(params: TransitionOrderToStateParams, customQuery?: CustomQuery): Promise<TransitionOrderToState>;
   setCustomerForOrder(params: CreateCustomerInput, customQuery?: CustomQuery): Promise<SetCustomerForOrderResponse>;
 }
diff --git a/packages/api-client/src/types/types.ts b/packages/api-client/src/types/types.ts
@@ -84,8 +84,12 @@ export type UpdateAddressDetailsParams = {
 
 export type SetShippingMethodParams = {
   shippingMethodId: string;
-}
+};
 
 export type TransitionOrderToStateParams = {
   state: string;
-}
+};
+
+export type AddPaymentToOrderParams = {
+  method: string;
+};
diff --git a/packages/theme/pages/Checkout/Payment.vue b/packages/theme/pages/Checkout/Payment.vue
@@ -149,9 +149,6 @@ export default {
     const processOrder = async () => {
       const response = await $vendure.api.setPaymentMethod({
         method: paymentMethod?.value?.code,
-        metadata: {
-          // Here goes metadata from the payment provider. For security reasons it should be handled on the server!
-        }
       });
 
       const orderId = response?.data?.addPaymentToOrder?.id;