test: added missing custom queries to composables

Author: Marcin Kwiatkowski

packages/theme/composables/useConfig/index.ts

@@ -3,7 +3,7 @@ import {
 } from '@nuxtjs/composition-api';
 import { Logger } from '~/helpers/logger';
 import { useConfigStore } from '~/stores/config';
-import { UseConfigErrors, UseConfigInterface } from './useConfig';
+import type { UseConfigErrors, UseConfigInterface, UseConfigLoadParams } from './useConfig';
 
 /**
  * Allows interacting with the store configuration.
@@ -17,14 +17,14 @@ export function useConfig(): UseConfigInterface {
   const configStore = useConfigStore();
   const config = computed(() => configStore.storeConfig);
 
-  const load = async () => {
+  const load = async (params?: UseConfigLoadParams) => {
     error.value.load = null;
     loading.value = true;
 
     Logger.debug('useConfig/load');
 
     try {
-      const { data } = await app.$vsf.$magento.api.storeConfig();
+      const { data } = await app.$vsf.$magento.api.storeConfig(params?.customQuery ?? null);
       configStore.$patch((state) => {
         state.storeConfig = data.storeConfig || {};
       });

packages/theme/composables/useConfig/useConfig.ts

@@ -1,5 +1,6 @@
 import { ComputedRef, DeepReadonly, Ref } from '@nuxtjs/composition-api';
 import { StoreConfig } from '~/modules/GraphQL/types';
+import { ComposableFunctionArgs } from '~/composables';
 
 /**
  * Errors that occured in the {@link useConfig|useConfig()} composable
@@ -11,6 +12,11 @@ export interface UseConfigErrors {
   load: Error | null;
 }
 
+/**
+ * The params object accepted by the `load` method in the {@link useConfig|useConfig()} composable
+ */
+export type UseConfigLoadParams = ComposableFunctionArgs<{}>;
+
 /**
  * Data and methods returned from the {@link useConfig|useConfig()} composable
  */

packages/theme/composables/useContent/commands/loadBlocksCommand.ts

@@ -5,7 +5,7 @@ export const loadBlocksCommand = {
   execute: async (context: VsfContext, params) => {
     Logger.debug('[Magento]: Load CMS Blocks content', { params });
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-    const { data } = await context.$magento.api.cmsBlocks(params.identifiers);
+    const { data } = await context.$magento.api.cmsBlocks(params.identifiers, params.customQuery ?? null);
 
     Logger.debug('[Result]:', { data });
 

packages/theme/composables/useContent/commands/loadContentCommand.ts

@@ -5,7 +5,7 @@ export const loadContentCommand = {
   execute: async (context: VsfContext, params) => {
     Logger.debug('[Magento]: Load CMS Page content', { params });
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-    const { data } = await context.$magento.api.cmsPage(params.identifier);
+    const { data } = await context.$magento.api.cmsPage(params.identifier, params.customQuery ?? null);
 
     Logger.debug('[Result]:', { data });
 

packages/theme/composables/useCountrySearch/index.ts

@@ -25,7 +25,7 @@ export function useCountrySearch(): UseCountrySearchInterface {
 
       Logger.debug('[Magento]: Search country information based on', { params });
 
-      const { data } = await app.$vsf.$magento.api.country(params.id);
+      const { data } = await app.$vsf.$magento.api.country(params.id, params?.customQuery ?? null);
 
       Logger.debug('[Result]:', { data });
 

packages/theme/composables/useCurrency/__tests__/useCurrency.spec.ts

@@ -0,0 +1,66 @@
+import { defineComponent, onMounted, useContext } from '@nuxtjs/composition-api';
+import { createLocalVue } from '@vue/test-utils';
+import { PiniaVuePlugin, setActivePinia, createPinia } from 'pinia';
+import { createTestingPinia } from '@pinia/testing';
+import { render } from '@testing-library/vue';
+import { useCurrency } from '../index';
+
+const localVue = createLocalVue();
+localVue.use(PiniaVuePlugin);
+const pinia = createTestingPinia();
+const appMock = {
+  app: {
+    $vsf: {
+      $magento: {
+        api: {
+          currency: jest.fn(),
+        },
+      },
+    },
+  },
+};
+
+jest.mock('@nuxtjs/composition-api', () => {
+  const actual = jest.requireActual('@nuxtjs/composition-api');
+  return {
+    ...actual,
+    useContext: jest.fn(),
+  };
+});
+
+describe('useCurrency', () => {
+  beforeEach(() => {
+    setActivePinia(createPinia());
+  });
+
+  const MockComponent = defineComponent({
+    name: 'MockComponent',
+    setup() {
+      const { load } = useCurrency();
+
+      onMounted(async () => {
+        await load({
+          customQuery: {
+            currency: 'custom-currency-query',
+          },
+        });
+      });
+    },
+    template: '<div>mock</div>',
+  });
+
+  it('the load method should receive custom query', () => {
+    // given
+    (useContext as jest.Mock).mockReturnValue(appMock);
+
+    // when
+    render(MockComponent, {
+      localVue,
+      pinia,
+    });
+
+    // then
+    expect(appMock.app.$vsf.$magento.api.currency)
+      .toHaveBeenCalledWith({ currency: 'custom-currency-query' });
+  });
+});

packages/theme/composables/useNewsletter/commands/updateSubscriptionCommand.ts

@@ -6,7 +6,7 @@ export const updateSubscriptionCommand = {
   execute: async (context: UseContextReturn, params: UseNewsletterUpdateSubscriptionParams): Promise<SubscriptionStatusesEnum | null> => {
     const { data } = await context.app.$vsf.$magento.api.subscribeEmailToNewsletter({
       email: params.email,
-    });
+    }, params?.customQuery ?? null);
 
     return data?.subscribeEmailToNewsletter?.status ?? null;
   },

packages/theme/composables/useReview/commands/addReviewCommand.ts

@@ -12,7 +12,7 @@ export const addReviewCommand = {
       ...input
     } = params;
 
-    const { data } = await context.$magento.api.createProductReview(input);
+    const { data } = await context.$magento.api.createProductReview(input, params?.customQuery ?? null);
 
     Logger.debug('[Result]:', { data });
 

packages/theme/composables/useReview/commands/loadCustomerReviewsCommand.ts

@@ -11,7 +11,7 @@ export const loadCustomerReviewsCommand = {
   execute: async (context: VsfContext, params?: ComposableFunctionArgs<CustomerProductReviewParams>) => {
     Logger.debug('[Magento] load customer review based on:', { params });
 
-    const { data } = await context.$magento.api.customerProductReview(params);
+    const { data } = await context.$magento.api.customerProductReview(params, params?.customQuery ?? null);
 
     Logger.debug('[Result]:', { data });
 

packages/theme/composables/useReview/commands/loadReviewMetadataCommand.ts

@@ -1,11 +1,12 @@
 import { Logger } from '~/helpers/logger';
 import { VsfContext } from '~/composables/context';
+import { ComposableFunctionArgs } from '~/composables';
 
 export const loadReviewMetadataCommand = {
-  execute: async (context: VsfContext) => {
+  execute: async (context: VsfContext, params?: ComposableFunctionArgs<{}>) => {
     Logger.debug('[Magento] load review metadata');
 
-    const { data } = await context.$magento.api.productReviewRatingsMetadata();
+    const { data } = await context.$magento.api.productReviewRatingsMetadata(params?.customQuery ?? null);
 
     Logger.debug('[Result]:', { data });