Merge pull request #28 from RonasIT/prd-1563-resolve-deps-errors

PRD-1563: Resolve dependency issues

Author: ipakhomov

README.md

@@ -10,14 +10,6 @@ Wrapper utilities for CRUD operations in REST APIs entities using [RTK Query](ht
 npm i @ronas-it/rtkq-entity-api
 ```
 
-If your app uses `axios-observable`, install it along with `rxjs`:
-
-```sh
-npm i axios-observable rxjs
-```
-
-Note that support of `axios-observable` will be removed in upcoming major release.
-
 2. Create base query with your API configuration, for example [using Axios](https://redux-toolkit.js.org/rtk-query/usage/customizing-queries#axios-basequery):
 
 ```ts
@@ -298,14 +290,21 @@ npm i @react-native-community/netinfo
 Example
 
 ```tsx
+import { addEventListener, fetch } from '@react-native-community/netinfo';
 import { setupRefetchListeners } from '@ronas-it/rtkq-entity-api';
+import ReactNative from 'react-native';
 import { useDispatch } from 'react-redux';
 
 function App(): ReactElement {
    const dispatch = useDispatch();
 
    useEffect(() => {
-      const unsubscribeRefetchListeners = setupRefetchListeners(dispatch);
+      const unsubscribeRefetchListeners = setupRefetchListeners(
+        dispatch,
+        { refetchOnFocus: true, refetchOnReconnect: true },
+        { addEventListener, fetch },
+        ReactNative,
+      );
 
       return unsubscribeRefetchListeners;
    }, []);

package-lock.json

@@ -47,9 +47,12 @@
     "type-fest": "^3.13.1"
   },
   "peerDependencies": {
-    "@react-native-community/netinfo": "^11.4.0",
-    "axios-observable": "^2.1.0",
-    "rxjs": "^7.8.1"
+    "@react-native-community/netinfo": "^11.4.0"
+  },
+  "peerDependenciesMeta": {
+    "@react-native-community/netinfo": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@eslint/compat": "^1.2.4",

package.json

@@ -3,9 +3,6 @@ import { BaseQueryApi, BaseQueryFn } from '@reduxjs/toolkit/dist/query/index.d';
 import { MaybePromise } from '@reduxjs/toolkit/src/query/tsHelpers';
 import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from 'axios';
 import { merge } from 'lodash';
-// TODO: Drop support for axios-observable in next major version
-import type { Axios as AxiosObservableInstance } from 'axios-observable';
-import type { lastValueFrom as lastValueFromType } from 'rxjs';
 
 export type BaseQueryFunction = BaseQueryFn<
   AxiosRequestConfig,
@@ -16,14 +13,11 @@ export type BaseQueryFunction = BaseQueryFn<
 >;
 
 export type AxiosBaseQueryArgs = {
-  getHttpClient: (api: BaseQueryApi & { extra?: any }) => AxiosObservableInstance | AxiosInstance;
+  getHttpClient: (api: BaseQueryApi & { extra?: any }) => AxiosInstance;
   prepareHeaders?: (api: BaseQueryApi & { extra?: any }) => MaybePromise<RawAxiosRequestHeaders>;
 };
 
 export const createAxiosBaseQuery = ({ getHttpClient, prepareHeaders }: AxiosBaseQueryArgs): BaseQueryFunction => {
-  const isDevEnvironment = (typeof __DEV__ !== 'undefined' && __DEV__) || process?.env?.NODE_ENV === 'development';
-  let isDeprecationWarningShown = false;
-
   return async (requestConfig, api: BaseQueryApi) => {
     const extraHeaders: RawAxiosRequestHeaders = prepareHeaders
       ? await prepareHeaders(api as BaseQueryApi & { extra?: any })
@@ -33,20 +27,7 @@ export const createAxiosBaseQuery = ({ getHttpClient, prepareHeaders }: AxiosBas
     const httpClient = getHttpClient(api as BaseQueryApi & { extra?: any });
 
     try {
-      const AxiosObservable = require('axios-observable').Axios as typeof AxiosObservableInstance;
-      const usesAxiosObservable = httpClient instanceof AxiosObservable;
-      const lastValueFrom = require('rxjs').lastValueFrom as typeof lastValueFromType;
-
-      if (!isDeprecationWarningShown && usesAxiosObservable && isDevEnvironment) {
-        isDeprecationWarningShown = true;
-        console.warn(
-          'Support of Axios Observable is deprecated and will be removed in the next major version. Please use Axios instead.',
-        );
-      }
-
-      const response = usesAxiosObservable
-        ? await lastValueFrom(httpClient.request(requestConfig))
-        : await httpClient.request(requestConfig);
+      const response = await httpClient.request(requestConfig);
 
       return {
         data: response.data,

src/utils/create-axios-base-query.ts

@@ -9,25 +9,17 @@ export function setupRefetchListeners(
     refetchOnReconnect: true,
     refetchOnFocus: true,
   },
+  netInfoRef: {
+    fetch: typeof fetch;
+    addEventListener: typeof addEventListener;
+  },
+  reactNativeRef: {
+    AppState: RNAppState;
+    Platform: RNPlatform;
+  },
 ): () => void {
   return setupListeners(storeDispatch, (dispatch, actions) => {
-    let ReactNative: { AppState: RNAppState; Platform: RNPlatform };
-
-    let NetInfo: {
-      addEventListener: typeof addEventListener;
-      fetch: typeof fetch;
-    };
-
-    try {
-      NetInfo = require('@react-native-community/netinfo');
-      ReactNative = require('react-native');
-    } catch (error) {
-      throw new Error(
-        'To use \'refetchOnReconnect\' and \'refetchOnFocus\' you must setup @react-native-community/netinfo and react-native package.',
-      );
-    }
-
-    const { AppState, Platform } = ReactNative;
+    const { AppState, Platform } = reactNativeRef;
 
     if (!Platform?.OS || Platform.OS === 'web') {
       throw new Error(
@@ -39,7 +31,7 @@ export function setupRefetchListeners(
 
     if (options.refetchOnFocus) {
       const { remove: appStateUnsubscribe } = AppState.addEventListener('change', async (state) => {
-        const { isConnected, isInternetReachable } = await NetInfo.fetch();
+        const { isConnected, isInternetReachable } = await netInfoRef.fetch();
         const hasConnection = isConnected && isInternetReachable;
 
         if (hasConnection) {
@@ -51,7 +43,7 @@ export function setupRefetchListeners(
     }
 
     if (options.refetchOnReconnect) {
-      const netInfoUnsubscribe = NetInfo.addEventListener(({ isConnected, isInternetReachable }: NetInfoState) => {
+      const netInfoUnsubscribe = netInfoRef.addEventListener(({ isConnected, isInternetReachable }: NetInfoState) => {
         const hasConnection = !!(isConnected && isInternetReachable);
 
         dispatch(hasConnection ? actions.onOnline() : actions.onOffline());