Remove unused functions from the slice and the reducer extenders

Author: tommasoberlose

src/reducer.ts

@@ -6,7 +6,7 @@ import {
 import { Builder } from './extraReducersBuilder';
 import { listenerMiddleware } from './middleware';
 import Settings from './settings';
-import { DEFAULT_INIT_ACTION_TYPE, NotFunction, PersistedReducer } from './types';
+import { DEFAULT_INIT_ACTION_TYPE, NotFunction, ReducerWithInitialState } from './types';
 import UpdatedAtHelper from './updatedAtHelper';
 import { getStorageName } from './utils';
 
@@ -79,7 +79,15 @@ const { reducer } = createPersistedReducer(
 ```
  * @public
  */
-export const createPersistedReducer: <ReducerName extends string, S extends NotFunction<any>>(reducerName: ReducerName, initialState: S | (() => S), mapOrBuilderCallback: (builder: ActionReducerMapBuilder<S>) => void, filtersSlice?: (state: S) => Partial<S>) => PersistedReducer<ReducerName, S> = <ReducerName extends string, S extends NotFunction<any>>(
+export const createPersistedReducer: <
+  ReducerName extends string,
+  S extends NotFunction<any>
+>(
+  reducerName: ReducerName,
+  initialState: S | (() => S),
+  mapOrBuilderCallback: (builder: ActionReducerMapBuilder<S>) => void,
+  filtersSlice?: (state: S) => Partial<S>
+) => ReducerWithInitialState<S> = <ReducerName extends string, S extends NotFunction<any>>(
   reducerName: ReducerName,
   initialState: S | (() => S),
   mapOrBuilderCallback: (builder: ActionReducerMapBuilder<S>) => void,
@@ -113,15 +121,6 @@ export const createPersistedReducer: <ReducerName extends string, S extends NotF
     UpdatedAtHelper.onSave(reducerName);
   }
 
-  /**
-   * Clears the stored data from the selected storage
-   *
-   * @public
-   */
-  async function clearPersistedStorage() {
-    await Settings.storageHandler.removeItem(storageName);
-  }
-
   /**
    * Creates the reducer using the default options passed by the user.
    *
@@ -163,5 +162,5 @@ export const createPersistedReducer: <ReducerName extends string, S extends NotF
     },
   });
 
-  return { reducer, reducerName, listenerMiddleware, clearPersistedStorage };
+  return reducer;
 };

src/slice.ts

@@ -1,18 +1,17 @@
 import {
   createSlice,
   CreateSliceOptions,
-  ListenerMiddlewareInstance,
   PayloadAction,
   Slice,
   SliceCaseReducers,
-  SliceSelectors,
+  SliceSelectors
 } from '@reduxjs/toolkit';
 import { Builder } from './extraReducersBuilder';
 import { listenerMiddleware } from './middleware';
 import Settings from './settings';
 import { DEFAULT_INIT_ACTION_TYPE } from './types';
 import UpdatedAtHelper from './updatedAtHelper';
-import { getStorageName, getStoredState } from './utils';
+import { getStorageName } from './utils';
 
 /**
  * A function that accepts an initial state, an object full of reducer
@@ -45,14 +44,7 @@ export const createPersistedSlice: <
     PeristedSelectors
   >,
   filtersSlice?: (state: SliceState) => Partial<SliceState>,
-) => Omit<
-  Slice<SliceState, PCR, Name, ReducerPath, PeristedSelectors>,
-  'getInitialState'
-> & {
-  getInitialState: () => Promise<SliceState>;
-  listenerMiddleware: ListenerMiddlewareInstance;
-  clearPersistedStorage: () => void;
-} = <
+) => Slice<SliceState, PCR, Name, ReducerPath, PeristedSelectors> = <
   SliceState,
   Name extends string = string,
   PCR extends
@@ -83,24 +75,6 @@ export const createPersistedSlice: <
       Record<Name, SliceState>
     >();
 
-  /**
-   * Overrides the getInitialState function to return the stored data
-   *
-   * @returns The initial state of the slice merged with the stored data
-   *
-   * @public
-   */
-  // TODO: verify if we should inject the persisted state when reinizializing (I think we should remove this override)
-  async function getInitialState(): Promise<SliceState> {
-    let storage: Partial<SliceState> = slice.getInitialState();
-    try {
-      storage = await getStoredState(sliceOptions.name) ?? storage;
-    } catch (e) {
-      // console.error(e);
-    }
-    return { ...slice.getInitialState(), ...storage };
-  }
-
   /**
    * Writes the updated state to the selected storage
    *
@@ -116,15 +90,6 @@ export const createPersistedSlice: <
     UpdatedAtHelper.onSave(sliceOptions.name);
   }
 
-  /**
-   * Clears the stored data from the selected storage
-   *
-   * @public
-   */
-  async function clearPersistedStorage() {
-    await Settings.storageHandler.removeItem(storageName);
-  }
-
   /**
    * Creates the slice using the default options passed by the user.
    *
@@ -184,10 +149,5 @@ export const createPersistedSlice: <
     },
   });
 
-  return {
-    ...slice,
-    getInitialState,
-    listenerMiddleware,
-    clearPersistedStorage,
-  };
+  return slice;
 };

src/types.ts

@@ -1,4 +1,4 @@
-import { ActionCreatorInvariantMiddlewareOptions, Draft, ImmutableStateInvariantMiddlewareOptions, ListenerMiddlewareInstance, Middleware, SerializableStateInvariantMiddlewareOptions, StoreEnhancer, ThunkMiddleware, Tuple, UnknownAction } from "@reduxjs/toolkit";
+import { ActionCreatorInvariantMiddlewareOptions, Draft, ImmutableStateInvariantMiddlewareOptions, Middleware, SerializableStateInvariantMiddlewareOptions, StoreEnhancer, ThunkMiddleware, Tuple, UnknownAction } from "@reduxjs/toolkit";
 
 /**
  * This is the description of the storage handler used to persist the data
@@ -119,13 +119,7 @@ type CaseReducer<S = any, A extends Action = UnknownAction> = (state: Draft<S>,
 
 export type NotFunction<T> = T extends Function ? never : T;
 export type ReducerWithInitialState<S extends NotFunction<any>> = Reducer<S> & {
-    getInitialState: () => S;
-};
-export type PersistedReducer<ReducerName extends String, S extends NotFunction<any>> = {
-  reducer: ReducerWithInitialState<S>;
-  reducerName: ReducerName;
-  listenerMiddleware: ListenerMiddlewareInstance;
-  clearPersistedStorage: () => void;
+  getInitialState: () => S;
 };
 
 interface TypeGuard<T> {

src/utils.ts

@@ -18,4 +18,16 @@ export async function getStoredState<T>(name: string): Promise<Partial<T> | null
     // console.error(e);
   }
   return null;
-}
+}
+
+/**
+ * Clears the stored data from the selected storage
+ *
+ * @param name - string: a uniq name for the state slice implemented.
+ *
+ * @public
+ */
+export async function clearPersistedStorage(name: string) {
+  const storageName = getStorageName(name);
+  await Settings.storageHandler.removeItem(storageName);
+}