feat: #49 (api) create api-client function

packages/api-client/__tests__/api/updateAddressDetails.spec.ts

@@ -0,0 +1,77 @@
+import updateAddressDetails from '../../src/api/updateAddressDetails';
+import setOrderBillingAddressMutation from './../../src/api/updateAddressDetails/setOrderBillingAddressMutation';
+import setOrderShippingAddressMutation from './../../src/api/updateAddressDetails/setOrderShippingAddressMutation';
+import { Context } from '../../src/types';
+import { BILLING_TYPE } from '../../src/helpers/constants';
+
+describe('[vendure-api-client] updateAddressDetails', () => {
+  it('updates shipping details', async () => {
+    const givenVariables = {
+      input: {
+        fullName: 'Eliot Anderson',
+        company: 'F Society',
+        streetLine1: '1st Avenue',
+        streetLine2: '1st Avenue',
+        city: 'New York',
+        province: 'New York',
+        postalCode: '34-234',
+        countryCode: 'US',
+        phoneNumber: '123123123',
+        defaultShippingAddress: true,
+        defaultBillingAddress: false
+      }
+    };
+
+    const context = ({
+      config: {},
+      client: {
+        mutate: ({ variables, mutation }) => {
+          expect(variables).toEqual(givenVariables);
+          expect(mutation).toEqual(setOrderShippingAddressMutation);
+
+          return { data: 'update shipping details response' };
+        }
+      },
+      extendQuery: (customQuery, args) => args
+    } as unknown) as Context;
+
+    const { data } = await updateAddressDetails(context, { input: givenVariables.input });
+
+    expect(data).toBe('update shipping details response');
+  });
+
+  it('updates billing details', async () => {
+    const givenVariables = {
+      input: {
+        fullName: 'Eliot Anderson',
+        company: 'F Society',
+        streetLine1: '1st Avenue',
+        streetLine2: '1st Avenue',
+        city: 'New York',
+        province: 'New York',
+        postalCode: '34-234',
+        countryCode: 'US',
+        phoneNumber: '123123123',
+        defaultShippingAddress: false,
+        defaultBillingAddress: true
+      }
+    };
+
+    const context = ({
+      config: {},
+      client: {
+        mutate: ({ variables, mutation }) => {
+          expect(variables).toEqual(givenVariables);
+          expect(mutation).toEqual(setOrderBillingAddressMutation);
+
+          return { data: 'update billing details response' };
+        }
+      },
+      extendQuery: (customQuery, args) => args
+    } as unknown) as Context;
+
+    const { data } = await updateAddressDetails(context, { input: givenVariables.input, type: BILLING_TYPE });
+
+    expect(data).toBe('update billing details response');
+  });
+});

packages/api-client/src/api/index.ts

@@ -8,3 +8,4 @@ export { default as updateCartQuantity } from './updateCartQuantity';
 export { default as applyCartCoupon } from './applyCartCoupon';
 export { default as removeCartCoupon } from './removeCartCoupon';
 export { default as getMe } from './getMe';
+export { default as updateAddressDetails } from './updateAddressDetails';

packages/api-client/src/api/updateAddressDetails/index.ts

@@ -0,0 +1,27 @@
+import setOrderBillingAddressMutation from './setOrderBillingAddressMutation';
+import setOrderShippingAddressMutation from './setOrderShippingAddressMutation';
+import { CustomQuery } from '@vue-storefront/core';
+import gql from 'graphql-tag';
+import { Context, UpdateAddressDetailsParams, UpdateAddressDetailsResponse } from '../../types';
+import { BILLING_TYPE } from '../../helpers/constants';
+
+const updateAddressDetails = async (context: Context, params: UpdateAddressDetailsParams, customQuery?: CustomQuery): Promise<UpdateAddressDetailsResponse> => {
+  const { type, input } = params;
+  const updateAddressDetailsVariables = { input };
+
+  const updateAddressDetailsQuery = type === BILLING_TYPE ? setOrderBillingAddressMutation : setOrderShippingAddressMutation;
+
+  const { updateAddressDetails } = context.extendQuery(
+    customQuery, { updateAddressDetails: { query: updateAddressDetailsQuery, variables: updateAddressDetailsVariables } }
+  );
+
+  const request = await context.client.mutate({
+    mutation: gql`${updateAddressDetails.query}`,
+    variables: updateAddressDetails.variables,
+    fetchPolicy: 'no-cache'
+  }) as UpdateAddressDetailsResponse;
+
+  return request;
+};
+
+export default updateAddressDetails;

packages/api-client/src/api/updateAddressDetails/setOrderBillingAddressMutation.ts

@@ -0,0 +1,14 @@
+import gql from 'graphql-tag';
+import { CartFragment, ErrorResultFragment } from '../../fragments';
+
+export default gql`
+  ${CartFragment}
+  ${ErrorResultFragment}
+
+  mutation setOrderBillingAddress($input: CreateAddressInput!) {
+    setOrderBillingAddress(input: $input) {
+      ...Cart
+      ...ErrorResult
+    }
+  }
+`;

packages/api-client/src/api/updateAddressDetails/setOrderShippingAddressMutation.ts

@@ -0,0 +1,14 @@
+import gql from 'graphql-tag';
+import { CartFragment, ErrorResultFragment } from '../../fragments';
+
+export default gql`
+  ${CartFragment}
+  ${ErrorResultFragment}
+
+  mutation setOrderShippingAddress($input: CreateAddressInput!) {
+    setOrderShippingAddress(input: $input) {
+      ...Cart
+      ...ErrorResult
+    }
+  }
+`;

packages/api-client/src/helpers/constants.ts

@@ -1 +1,2 @@
 export const VENDURE_AUTH_TOKEN_NAME = 'vendure-auth-token';
+export const BILLING_TYPE = 'billing';

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 { ApplyCouponCodeResult, CollectionList, Customer, Order, Product, RemoveOrderItemsResult, SearchResponse, UpdateOrderItemsResult } from './GraphQL';
-import { AddToCartParams, CartCouponParams, CollectionParams, ProductParams, RemoveFromCartParams, SearchParams, UpdateCartParams } from './types';
+import { ActiveOrderResult, ApplyCouponCodeResult, CollectionList, Customer, Order, Product, RemoveOrderItemsResult, SearchResponse, UpdateOrderItemsResult } from './GraphQL';
+import { AddToCartParams, CartCouponParams, CollectionParams, ProductParams, RemoveFromCartParams, SearchParams, 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>>;
@@ -18,6 +18,7 @@ export type RemoveFromCartResponse = MutationResponse<'removeOrderLine', RemoveO
 export type UpdateCartQuantityResponse = MutationResponse<'adjustOrderLine', UpdateOrderItemsResult>;
 export type ApplyCouponCodeResponse = MutationResponse<'applyCouponCode', ApplyCouponCodeResult>;
 export type RemoveCouponCodeResponse = MutationResponse<'removeCouponCode', Order>;
+export type UpdateAddressDetailsResponse = MutationResponse<'setOrderShippingAddress' | 'setOrderBilliingAddress', ActiveOrderResult>;
 
 export interface VendureApiMethods {
   getProduct(params: ProductParams, customQuery?: CustomQuery): Promise<GetProductResponse>;
@@ -28,6 +29,7 @@ export interface VendureApiMethods {
   addToCart(params: AddToCartParams, customQuery?: CustomQuery): Promise<AddToCartResponse>;
   removeFromCart(params: RemoveFromCartParams, customQuery?: CustomQuery): Promise<RemoveFromCartResponse>;
   updateCartQuantity(params: UpdateCartParams, customQuery?: CustomQuery): Promise<UpdateCartQuantityResponse>;
-  applyCouponCode(params: CartCouponParams, customQuery?:CustomQuery): Promise<ApplyCouponCodeResponse>;
-  removeCouponCode(params: CartCouponParams, customQuery?:CustomQuery): Promise<RemoveCouponCodeResponse>;
+  applyCouponCode(params: CartCouponParams, customQuery?: CustomQuery): Promise<ApplyCouponCodeResponse>;
+  removeCouponCode(params: CartCouponParams, customQuery?: CustomQuery): Promise<RemoveCouponCodeResponse>;
+  updateAddressDetails(params: UpdateAddressDetailsParams, customQuery?: CustomQuery): Promise<UpdateAddressDetailsResponse>;
 }

packages/api-client/src/types/types.ts

@@ -1,4 +1,4 @@
-import { CollectionListOptions, SearchInput } from './GraphQL';
+import { CollectionListOptions, CreateAddressInput, SearchInput } from './GraphQL';
 
 export type TODO = unknown;
 
@@ -76,3 +76,8 @@ export type UpdateCartParams = {
 export type CartCouponParams = {
   couponCode: string;
 };
+
+export type UpdateAddressDetailsParams = {
+  input: CreateAddressInput;
+  type?: string;
+};