From 1bd4bd0da2444d269d2c1be01887c5197d1f2ef9 Mon Sep 17 00:00:00 2001
From: Bartosz Herba <bherba@vuestorefront.io>
Date: Tue, 22 Mar 2022 11:32:17 +0100
Subject: [PATCH] refactor(composable): add missing depercated annotations

---
 .../src/composables/useAddresses/index.ts          | 14 +++++++-------
 .../src/composables/useCategory/index.ts           |  3 +++
 .../src/composables/useCategorySearch/index.ts     |  6 +++---
 .../src/composables/useCustomMutation/index.ts     |  3 +++
 .../src/composables/useCustomQuery/index.ts        |  8 ++++----
 .../src/composables/useExternalCheckout/index.ts   |  6 +++---
 .../src/composables/useForgotPassword/index.ts     |  6 +++---
 .../src/composables/useGetShippingMethods/index.ts |  1 -
 .../src/composables/useNewsletter/index.ts         |  2 +-
 .../src/composables/useRelatedProducts/index.ts    |  6 +++---
 .../composables/src/composables/useReview/index.ts |  2 --
 .../src/composables/useUpsellProducts/index.ts     |  6 +++---
 .../composables/src/composables/useUser/index.ts   |  7 +++----
 .../src/composables/useUserOrder/index.ts          |  4 +++-
 .../src/composables/useWishlist/index.ts           |  5 +++--
 .../src/factories/useAddressesFactory.ts           |  3 +++
 .../src/factories/useCategorySearchFactory.ts      |  7 ++++---
 .../src/factories/useCustomQueryFactory.ts         |  8 ++++----
 .../src/factories/useExternalCheckoutFactory.ts    |  6 +++---
 .../src/factories/useForgotPasswordFactory.ts      |  6 +++---
 .../src/factories/useGetShippingMethodsFactory.ts  |  3 +++
 .../src/factories/useMutationQueryFactory.ts       |  3 +++
 .../src/factories/useRelatedProductsFactory.ts     |  6 +++---
 .../src/factories/useUpsellProductsFactory.ts      |  6 +++---
 .../src/factories/useWishlistFactory.ts            |  3 +++
 .../composables/src/helpers/buildCategoryTree.ts   |  3 +++
 .../composables/src/helpers/compareWishlist.ts     |  3 +++
 .../composables/src/helpers/findItemOnWishlist.ts  |  3 +++
 packages/composables/src/helpers/htmlDecoder.ts    |  3 +++
 .../src/helpers/userAddressManipulator.ts          |  3 +++
 30 files changed, 89 insertions(+), 56 deletions(-)

diff --git a/packages/composables/src/composables/useAddresses/index.ts b/packages/composables/src/composables/useAddresses/index.ts
index 90ab389cd..5f697fad8 100644
--- a/packages/composables/src/composables/useAddresses/index.ts
+++ b/packages/composables/src/composables/useAddresses/index.ts
@@ -1,4 +1,7 @@
 /* eslint-disable no-param-reassign, consistent-return */
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   Context,
   Logger,
@@ -25,14 +28,11 @@ type RemoveAddressInput = {
   }
 } & CustomQueryParams;
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseAddressesParams<CustomerAddress,
-  CustomQueryParams,
-  SaveAddressInput,
-  UpdateAddressInput,
-  RemoveAddressInput> = {
+CustomQueryParams,
+SaveAddressInput,
+UpdateAddressInput,
+RemoveAddressInput> = {
   load: async (context: Context) => {
     Logger.debug('[Magento] load user addresses');
 
diff --git a/packages/composables/src/composables/useCategory/index.ts b/packages/composables/src/composables/useCategory/index.ts
index d5f33bee2..7df449a7b 100644
--- a/packages/composables/src/composables/useCategory/index.ts
+++ b/packages/composables/src/composables/useCategory/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   useCategoryFactory,
   Context,
diff --git a/packages/composables/src/composables/useCategorySearch/index.ts b/packages/composables/src/composables/useCategorySearch/index.ts
index 146ab3ef7..29c6eae27 100644
--- a/packages/composables/src/composables/useCategorySearch/index.ts
+++ b/packages/composables/src/composables/useCategorySearch/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   Context, Logger,
 } from '@vue-storefront/core';
@@ -5,9 +8,6 @@ import { Category, CategorySearchQueryVariables } from '@vue-storefront/magento-
 import { UseCategorySearchFactory, useCategorySearchFactory } from '../../factories/useCategorySearchFactory';
 import { UseCategorySearch } from '../../types/composables';
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseCategorySearchFactory<Category, CategorySearchQueryVariables> = {
   search: async (context: Context, params): Promise<Category[]> => {
     Logger.debug('[Magento]: Search for category using', { params });
diff --git a/packages/composables/src/composables/useCustomMutation/index.ts b/packages/composables/src/composables/useCustomMutation/index.ts
index 174a9f773..6e8d24632 100644
--- a/packages/composables/src/composables/useCustomMutation/index.ts
+++ b/packages/composables/src/composables/useCustomMutation/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { Context, Logger } from '@vue-storefront/core';
 import { FetchPolicy } from '../../types';
 import { useCustomMutationFactory } from '../../factories/useMutationQueryFactory';
diff --git a/packages/composables/src/composables/useCustomQuery/index.ts b/packages/composables/src/composables/useCustomQuery/index.ts
index f0cd387e9..766e0d46c 100644
--- a/packages/composables/src/composables/useCustomQuery/index.ts
+++ b/packages/composables/src/composables/useCustomQuery/index.ts
@@ -1,13 +1,13 @@
+/**
+ * @deprecated Will be removed in 1.1.0 release
+ * @use @vue-storefront/magento-theme/composables/useApi instead
+ */
 import { Context, Logger } from '@vue-storefront/core';
 import {
   useCustomQueryFactory,
 } from '../../factories/useCustomQueryFactory';
 import { FetchPolicy } from '../../types';
 
-/**
- * @deprecated Will be removed in 1.1.0 release
- * @use @vue-storefront/magento-theme/composables/useApi instead
- */
 export default useCustomQueryFactory({
   query: async (context: Context, {
     query,
diff --git a/packages/composables/src/composables/useExternalCheckout/index.ts b/packages/composables/src/composables/useExternalCheckout/index.ts
index 8ca249574..b42f4ca86 100644
--- a/packages/composables/src/composables/useExternalCheckout/index.ts
+++ b/packages/composables/src/composables/useExternalCheckout/index.ts
@@ -1,11 +1,11 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { Context, Logger } from '@vue-storefront/core';
 import { useExternalCheckoutFactory, UseExternalCheckoutFactoryParams } from '../../factories/useExternalCheckoutFactory';
 import useCart from '../useCart';
 // import useConfig from '../useConfig';
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseExternalCheckoutFactoryParams = {
   provide() {
     return {
diff --git a/packages/composables/src/composables/useForgotPassword/index.ts b/packages/composables/src/composables/useForgotPassword/index.ts
index 9ec109c9b..24133c018 100644
--- a/packages/composables/src/composables/useForgotPassword/index.ts
+++ b/packages/composables/src/composables/useForgotPassword/index.ts
@@ -1,12 +1,12 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   Context, Logger,
   useForgotPasswordFactory,
 } from '@vue-storefront/core';
 import { UseForgotPasswordFactoryParams } from '../../factories/useForgotPasswordFactory';
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseForgotPasswordFactoryParams<any> = {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   resetPassword: async (context: Context, params) => {
diff --git a/packages/composables/src/composables/useGetShippingMethods/index.ts b/packages/composables/src/composables/useGetShippingMethods/index.ts
index 0e089e89a..288df08bb 100644
--- a/packages/composables/src/composables/useGetShippingMethods/index.ts
+++ b/packages/composables/src/composables/useGetShippingMethods/index.ts
@@ -1,7 +1,6 @@
 /**
  * @deprecated since version 1.0.0
  */
-
 import {
   Context, Logger,
 } from '@vue-storefront/core';
diff --git a/packages/composables/src/composables/useNewsletter/index.ts b/packages/composables/src/composables/useNewsletter/index.ts
index de0354aae..10edf4d0b 100644
--- a/packages/composables/src/composables/useNewsletter/index.ts
+++ b/packages/composables/src/composables/useNewsletter/index.ts
@@ -1,5 +1,5 @@
 /**
- * @deprecated since version1.0.0
+ * @deprecated since version 1.0.0
  */
 import {
   Context, Logger,
diff --git a/packages/composables/src/composables/useRelatedProducts/index.ts b/packages/composables/src/composables/useRelatedProducts/index.ts
index b8c0bfdbb..89e02efb1 100644
--- a/packages/composables/src/composables/useRelatedProducts/index.ts
+++ b/packages/composables/src/composables/useRelatedProducts/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   ComposableFunctionArgs,
   Context,
@@ -14,9 +17,6 @@ import {
   UseRelatedProductsFactoryParams,
 } from '../../factories/useRelatedProductsFactory';
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseRelatedProductsFactoryParams<RelatedProductQuery['products']['items'][0]['related_products'], ProductsSearchParams> = {
   productsSearch: async (
     context: Context,
diff --git a/packages/composables/src/composables/useReview/index.ts b/packages/composables/src/composables/useReview/index.ts
index f020125b0..ee2b930c3 100644
--- a/packages/composables/src/composables/useReview/index.ts
+++ b/packages/composables/src/composables/useReview/index.ts
@@ -1,5 +1,3 @@
-/* istanbul ignore file */
-
 /**
  * @deprecated since version 1.0.0
  */
diff --git a/packages/composables/src/composables/useUpsellProducts/index.ts b/packages/composables/src/composables/useUpsellProducts/index.ts
index 5f5221a6b..81d5a812d 100644
--- a/packages/composables/src/composables/useUpsellProducts/index.ts
+++ b/packages/composables/src/composables/useUpsellProducts/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   ComposableFunctionArgs,
   Context,
@@ -14,9 +17,6 @@ import {
 } from '../../factories/useUpsellProductsFactory';
 import { UseUpsellProducts } from '../../types/composables';
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseUpsellProductsFactoryParams<UpsellProductsQuery['products']['items'][0]['upsell_products'], ProductsSearchParams> = {
   productsSearch: async (
     context: Context,
diff --git a/packages/composables/src/composables/useUser/index.ts b/packages/composables/src/composables/useUser/index.ts
index c3515d183..1542fbfb6 100644
--- a/packages/composables/src/composables/useUser/index.ts
+++ b/packages/composables/src/composables/useUser/index.ts
@@ -1,4 +1,6 @@
-/* istanbul ignore file */
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   Context,
   CustomQuery,
@@ -25,9 +27,6 @@ interface UseUserFactoryParams<USER, UPDATE_USER_PARAMS, REGISTER_USER_PARAMS>
   }) => Promise<USER>;
 }
 
-/**
- * @deprecated since version 1.0.0
- */
 const factoryParams: UseUserFactoryParams<
 any,
 UpdateCustomerEmailMutationVariables,
diff --git a/packages/composables/src/composables/useUserOrder/index.ts b/packages/composables/src/composables/useUserOrder/index.ts
index ac641d67b..24099be8d 100644
--- a/packages/composables/src/composables/useUserOrder/index.ts
+++ b/packages/composables/src/composables/useUserOrder/index.ts
@@ -1,4 +1,6 @@
-/* istanbul ignore file */
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   Context,
   Logger,
diff --git a/packages/composables/src/composables/useWishlist/index.ts b/packages/composables/src/composables/useWishlist/index.ts
index 1283b3c69..a238636aa 100644
--- a/packages/composables/src/composables/useWishlist/index.ts
+++ b/packages/composables/src/composables/useWishlist/index.ts
@@ -1,5 +1,6 @@
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/require-await */
-/* istanbul ignore file */
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   Context,
   Logger,
diff --git a/packages/composables/src/factories/useAddressesFactory.ts b/packages/composables/src/factories/useAddressesFactory.ts
index 218347c86..0ef63c9f1 100644
--- a/packages/composables/src/factories/useAddressesFactory.ts
+++ b/packages/composables/src/factories/useAddressesFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   configureFactoryParams,
   Context,
diff --git a/packages/composables/src/factories/useCategorySearchFactory.ts b/packages/composables/src/factories/useCategorySearchFactory.ts
index 12c654519..6d57e185a 100644
--- a/packages/composables/src/factories/useCategorySearchFactory.ts
+++ b/packages/composables/src/factories/useCategorySearchFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { computed } from '@vue/composition-api';
 import {
   configureFactoryParams,
@@ -13,9 +16,7 @@ import { UseCategorySearch, UseCategorySearchErrors } from '../types/composables
 export interface UseCategorySearchFactory<CATEGORY, CATEGORY_SEARCH_PARAMS, API extends PlatformApi = any> extends FactoryParams<API> {
   search: (context: Context, params: ComposableFunctionArgs<CATEGORY_SEARCH_PARAMS>) => Promise<CATEGORY[]>;
 }
-/**
- * @deprecated since version 1.0.0
- */
+
 export function useCategorySearchFactory<CATEGORY, CATEGORY_SEARCH_PARAMS, API extends PlatformApi = any>(
   factoryParams: UseCategorySearchFactory<CATEGORY, CATEGORY_SEARCH_PARAMS, API>,
 ) {
diff --git a/packages/composables/src/factories/useCustomQueryFactory.ts b/packages/composables/src/factories/useCustomQueryFactory.ts
index 109c4d405..ddfc88631 100644
--- a/packages/composables/src/factories/useCustomQueryFactory.ts
+++ b/packages/composables/src/factories/useCustomQueryFactory.ts
@@ -1,3 +1,7 @@
+/**
+ * @deprecated Will be removed in 1.1.0 release
+ * @use @vue-storefront/magento-theme/composables/useApi instead
+ */
 import {
   configureFactoryParams,
   Context,
@@ -10,10 +14,6 @@ import { computed } from '@vue/composition-api';
 import { FetchPolicy } from '../types';
 import { UseCustomQuery } from '../types/composables';
 
-/**
- * @deprecated Will be removed in 1.1.0 release
- * @use @vue-storefront/magento-theme/composables/useApi instead
- */
 export interface UseCustomQueryFactoryFactoryParams<QUERY_VARIABLES, QUERY_RETURN, API extends PlatformApi = any> extends FactoryParams<API> {
   query: (context: Context, {
     variables,
diff --git a/packages/composables/src/factories/useExternalCheckoutFactory.ts b/packages/composables/src/factories/useExternalCheckoutFactory.ts
index eb06a2ad1..fd8be7198 100644
--- a/packages/composables/src/factories/useExternalCheckoutFactory.ts
+++ b/packages/composables/src/factories/useExternalCheckoutFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   ComposableFunctionArgs,
   configureFactoryParams,
@@ -14,9 +17,6 @@ export interface UseExternalCheckoutFactoryParams<API extends PlatformApi = any>
   initializeCheckout: (context: Context, params: ComposableFunctionArgs<{ baseUrl: string }>) => Promise<string>;
 }
 
-/**
- * @deprecated since version 1.0.0
- */
 export const useExternalCheckoutFactory = <API extends PlatformApi = any>(
   factoryParams: UseExternalCheckoutFactoryParams<API>,
 ) => {
diff --git a/packages/composables/src/factories/useForgotPasswordFactory.ts b/packages/composables/src/factories/useForgotPasswordFactory.ts
index 9845ee4bc..d8414b60f 100644
--- a/packages/composables/src/factories/useForgotPasswordFactory.ts
+++ b/packages/composables/src/factories/useForgotPasswordFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { Ref, computed } from '@vue/composition-api';
 import {
   ComposableFunctionArgs,
@@ -27,9 +30,6 @@ export interface UseForgotPasswordFactoryParams<RESULT> extends FactoryParams {
   setNewPassword: (context: Context, params: ComposableFunctionArgs<SetNewPasswordParams & { currentResult: RESULT }>) => Promise<RESULT>;
 }
 
-/**
- * @deprecated since version 1.0.0
- */
 export function useForgotPasswordFactory<RESULT>(
   factoryParams: UseForgotPasswordFactoryParams<RESULT>,
 ) {
diff --git a/packages/composables/src/factories/useGetShippingMethodsFactory.ts b/packages/composables/src/factories/useGetShippingMethodsFactory.ts
index 2f3d8fa53..b76ec4fb2 100644
--- a/packages/composables/src/factories/useGetShippingMethodsFactory.ts
+++ b/packages/composables/src/factories/useGetShippingMethodsFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { computed, Ref } from '@vue/composition-api';
 import {
   ComposableFunctionArgs,
diff --git a/packages/composables/src/factories/useMutationQueryFactory.ts b/packages/composables/src/factories/useMutationQueryFactory.ts
index 4864c86ff..2fd03433d 100644
--- a/packages/composables/src/factories/useMutationQueryFactory.ts
+++ b/packages/composables/src/factories/useMutationQueryFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import {
   configureFactoryParams,
   Context,
diff --git a/packages/composables/src/factories/useRelatedProductsFactory.ts b/packages/composables/src/factories/useRelatedProductsFactory.ts
index 638cfb551..54e5bf676 100644
--- a/packages/composables/src/factories/useRelatedProductsFactory.ts
+++ b/packages/composables/src/factories/useRelatedProductsFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { computed, Ref } from '@vue/composition-api';
 import {
   configureFactoryParams,
@@ -11,9 +14,6 @@ import {
 } from '@vue-storefront/core';
 import { UseRelatedProducts, UseRelatedProductsErrors } from '../types/composables';
 
-/**
- * @deprecated since version 1.0.0
- */
 export interface UseRelatedProductsFactoryParams<
   PRODUCTS,
   RELATED_PRODUCTS_SEARCH_PARAMS extends ProductsSearchParams,
diff --git a/packages/composables/src/factories/useUpsellProductsFactory.ts b/packages/composables/src/factories/useUpsellProductsFactory.ts
index d740c1d4d..d73818778 100644
--- a/packages/composables/src/factories/useUpsellProductsFactory.ts
+++ b/packages/composables/src/factories/useUpsellProductsFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { computed, Ref } from '@vue/composition-api';
 import {
   configureFactoryParams,
@@ -20,9 +23,6 @@ export interface UseUpsellProductsFactoryParams<
   productsSearch: (context: Context, params: ComposableFunctionArgs<UPSELL_PRODUCTS_SEARCH_PARAMS>) => Promise<PRODUCTS>;
 }
 
-/**
- * @deprecated since version 1.0.0
- */
 export function useUpsellProductsFactory<PRODUCTS, UPSELL_PRODUCTS_SEARCH_PARAMS, API extends PlatformApi = any>(
   factoryParams: UseProductFactoryParams<PRODUCTS, UPSELL_PRODUCTS_SEARCH_PARAMS, API>,
 ) {
diff --git a/packages/composables/src/factories/useWishlistFactory.ts b/packages/composables/src/factories/useWishlistFactory.ts
index 302cd7b86..2bf155c17 100644
--- a/packages/composables/src/factories/useWishlistFactory.ts
+++ b/packages/composables/src/factories/useWishlistFactory.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { Ref } from '@vue/composition-api';
 import {
   configureFactoryParams,
diff --git a/packages/composables/src/helpers/buildCategoryTree.ts b/packages/composables/src/helpers/buildCategoryTree.ts
index 9f973ece6..272b5556a 100644
--- a/packages/composables/src/helpers/buildCategoryTree.ts
+++ b/packages/composables/src/helpers/buildCategoryTree.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { AgnosticCategoryTree } from '@vue-storefront/core';
 import { htmlDecode } from './htmlDecoder';
 
diff --git a/packages/composables/src/helpers/compareWishlist.ts b/packages/composables/src/helpers/compareWishlist.ts
index 6d7febe63..fedb79c66 100644
--- a/packages/composables/src/helpers/compareWishlist.ts
+++ b/packages/composables/src/helpers/compareWishlist.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 export const compareWishlistProduct = (
   productA,
   productB,
diff --git a/packages/composables/src/helpers/findItemOnWishlist.ts b/packages/composables/src/helpers/findItemOnWishlist.ts
index 8170d7088..a1b037688 100644
--- a/packages/composables/src/helpers/findItemOnWishlist.ts
+++ b/packages/composables/src/helpers/findItemOnWishlist.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { compareWishlistProduct } from './compareWishlist';
 
 export const findItemOnWishlist = (currentWishlist, product) => {
diff --git a/packages/composables/src/helpers/htmlDecoder.ts b/packages/composables/src/helpers/htmlDecoder.ts
index 577dec84b..2e23e5247 100644
--- a/packages/composables/src/helpers/htmlDecoder.ts
+++ b/packages/composables/src/helpers/htmlDecoder.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 export function htmlDecode(input) {
   const formatName = () => {
     try {
diff --git a/packages/composables/src/helpers/userAddressManipulator.ts b/packages/composables/src/helpers/userAddressManipulator.ts
index ebc2a9669..1219dad16 100644
--- a/packages/composables/src/helpers/userAddressManipulator.ts
+++ b/packages/composables/src/helpers/userAddressManipulator.ts
@@ -1,3 +1,6 @@
+/**
+ * @deprecated since version 1.0.0
+ */
 import { CustomerAddressInput } from '@vue-storefront/magento-api';
 
 export const transformUserCreateAddressInput = (addressInputParams): CustomerAddressInput => {