feat: #56 (api) transitionOrderToState

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

@@ -0,0 +1,26 @@
+import transitionOrderToState from '../../src/api/transitionOrderToState';
+import transitionOrderToStateMutation from '../../src/api/transitionOrderToState/transitionOrderToStateMutation';
+import { Context } from '../../src/types';
+
+describe('[vendure-api-client] transitionOrderToState', () => {
+  it('sets payment method for certain order', async () => {
+    const givenVariables = { state: 'test' };
+
+    const context = {
+      config: {},
+      client: {
+        mutate: ({ variables, mutation }) => {
+          expect(variables).toEqual(givenVariables);
+          expect(mutation).toEqual(transitionOrderToStateMutation);
+
+          return { data: 'transition order to state response' };
+        }
+      },
+      extendQuery: (customQuery, args) => args
+    } as unknown as Context;
+
+    const { data } = await transitionOrderToState(context, { state: 'test' });
+
+    expect(data).toBe('transition order to state response');
+  });
+});

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

@@ -0,0 +1,24 @@
+import transitionOrderToStateMutation from './transitionOrderToStateMutation';
+import { CustomQuery } from '@vue-storefront/core';
+import gql from 'graphql-tag';
+import { Context, TransitionOrderToState, TransitionOrderToStateParams } from '../../types';
+
+const transitionOrderToState = async (context: Context, params: TransitionOrderToStateParams, customQuery?: CustomQuery): Promise<TransitionOrderToState> => {
+  const transitionOrderToStateVariables = {
+    ...params
+  };
+
+  const { transitionOrderToState } = context.extendQuery(
+    customQuery, { transitionOrderToState: { query: transitionOrderToStateMutation, variables: transitionOrderToStateVariables } }
+  );
+
+  const request = await context.client.mutate({
+    mutation: gql`${transitionOrderToState.query}`,
+    variables: transitionOrderToState.variables,
+    fetchPolicy: 'no-cache'
+  }) as TransitionOrderToState;
+
+  return request;
+};
+
+export default transitionOrderToState;

packages/api-client/src/api/transitionOrderToState/transitionOrderToStateMutation.ts

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

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

@@ -2,7 +2,7 @@ import { CustomQuery } from '@vue-storefront/core';
 import { ApolloQueryResult } from 'apollo-client';
 import { FetchResult } from 'apollo-link';
 import { ActiveOrderResult, ApplyCouponCodeResult, CollectionList, Customer, Order, PaymentInput, Product, RemoveOrderItemsResult, SearchResponse, ShippingMethodQuote, UpdateOrderItemsResult } from './GraphQL';
-import { AddToCartParams, CartCouponParams, CollectionParams, ProductParams, RemoveFromCartParams, SearchParams, SetShippingMethodParams, UpdateAddressDetailsParams, UpdateCartParams } from './types';
+import { 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>>;
@@ -22,6 +22,7 @@ export type RemoveCouponCodeResponse = MutationResponse<'removeCouponCode', Orde
 export type UpdateAddressDetailsResponse = MutationResponse<'setOrderShippingAddress' | 'setOrderBillingAddress', ActiveOrderResult>;
 export type SetShippingMethodResponse = MutationResponse<'setOrderShippingMethod', Order>;
 export type SetPaymentMethodResponse = MutationResponse<'setPaymentShippingMethod', Order>;
+export type TransitionOrderToState = MutationResponse<'transitionOrderToState', Order>;
 
 export interface VendureApiMethods {
   getProduct(params: ProductParams, customQuery?: CustomQuery): Promise<GetProductResponse>;
@@ -38,4 +39,5 @@ export interface VendureApiMethods {
   updateAddressDetails(params: UpdateAddressDetailsParams, customQuery?: CustomQuery): Promise<UpdateAddressDetailsResponse>;
   setShippingMethod(params: SetShippingMethodParams, customQuery?: CustomQuery): Promise<SetShippingMethodResponse>;
   setPaymentMethod(params: PaymentInput, customQuery?: CustomQuery): Promise<SetPaymentMethodResponse>;
+  transitionOrderToState(params: TransitionOrderToStateParams, customQuery?: CustomQuery): Promise<TransitionOrderToState>;
 }

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

@@ -85,3 +85,7 @@ export type UpdateAddressDetailsParams = {
 export type SetShippingMethodParams = {
   shippingMethodId: string;
 }
+
+export type TransitionOrderToStateParams = {
+  state: string;
+}