Export Entity types as part of the public API

Author: markerikson

etc/redux-toolkit.api.md

@@ -77,6 +77,9 @@ export type CaseReducerWithPrepare<State, Action extends PayloadAction> = {
     prepare: PrepareAction<Action['payload']>;
 };
 
+// @public (undocumented)
+export type Comparer<T> = ComparerNum<T> | ComparerStr<T>;
+
 // @public
 export type ConfigureEnhancersCallback = (defaultEnhancers: StoreEnhancer[]) => StoreEnhancer[];
 
@@ -98,6 +101,12 @@ export function createAction<P = void, T extends string = string>(type: T): Payl
 // @public
 export function createAction<PA extends PrepareAction<any>, T extends string = string>(type: T, prepareAction: PA): PayloadActionCreator<ReturnType<PA>['payload'], T, PA>;
 
+// @public (undocumented)
+export function createEntityAdapter<T>(options?: {
+    selectId?: IdSelector<T>;
+    sortComparer?: false | Comparer<T>;
+}): EntityAdapter<T>;
+
 export { createNextState }
 
 // @public
@@ -122,13 +131,46 @@ export interface CreateSliceOptions<State = any, CR extends SliceCaseReducers<St
     reducers: ValidateSliceCaseReducers<State, CR>;
 }
 
+// @public (undocumented)
+export abstract class Dictionary<T> implements DictionaryNum<T> {
+    // (undocumented)
+    [id: string]: T | undefined;
+}
+
 export { Draft }
 
 // @public
 export interface EnhancedStore<S = any, A extends Action = AnyAction, M extends Middlewares<S> = Middlewares<S>> extends Store<S, A> {
     dispatch: DispatchForMiddlewares<M> & Dispatch<A>;
 }
 
+// @public (undocumented)
+export interface EntityAdapter<T> extends EntityStateAdapter<T> {
+    // (undocumented)
+    getInitialState(): EntityState<T>;
+    // (undocumented)
+    getInitialState<S extends object>(state: S): EntityState<T> & S;
+    // (undocumented)
+    getSelectors(): EntitySelectors<T, EntityState<T>>;
+    // (undocumented)
+    getSelectors<V>(selectState: (state: V) => EntityState<T>): EntitySelectors<T, V>;
+    // (undocumented)
+    selectId: IdSelector<T>;
+    // (undocumented)
+    sortComparer: false | Comparer<T>;
+}
+
+// @public (undocumented)
+export type EntityMap<T> = (entity: T) => T;
+
+// @public (undocumented)
+export interface EntityState<T> {
+    // (undocumented)
+    entities: Dictionary<T>;
+    // (undocumented)
+    ids: string[] | number[];
+}
+
 // @public (undocumented)
 export function findNonSerializableValue(value: unknown, path?: ReadonlyArray<string>, isSerializable?: (value: unknown) => boolean, getEntries?: (value: unknown) => [string, any][], ignoredPaths?: string[]): NonSerializableValue | false;
 
@@ -142,6 +184,9 @@ export function getDefaultMiddleware<S = any, O extends Partial<GetDefaultMiddle
 // @public
 export function getType<T extends string>(actionCreator: PayloadActionCreator<any, T>): T;
 
+// @public (undocumented)
+export type IdSelector<T> = IdSelectorStr<T> | IdSelectorNum<T>;
+
 // @public
 export function isPlain(val: any): boolean;
 
@@ -158,6 +203,9 @@ export type PayloadAction<P = void, T extends string = string, M = never, E = ne
 // @public
 export type PayloadActionCreator<P = void, T extends string = string, PA extends PrepareAction<P> | void = void> = IfPrepareActionMethodProvided<PA, _ActionCreatorWithPreparedPayload<PA, T>, IsAny<P, ActionCreatorWithPayload<any, T>, IsUnknownOrNonInferrable<P, ActionCreatorWithNonInferrablePayload<T>, IfVoid<P, ActionCreatorWithoutPayload<T>, IfMaybeUndefined<P, ActionCreatorWithOptionalPayload<P, T>, ActionCreatorWithPayload<P, T>>>>>>;
 
+// @public (undocumented)
+export type Predicate<T> = (entity: T) => boolean;
+
 // @public
 export type PrepareAction<P> = ((...args: any[]) => {
     payload: P;
@@ -199,6 +247,9 @@ export type SliceCaseReducers<State> = {
 
 export { ThunkAction }
 
+// @public (undocumented)
+export type Update<T> = UpdateStr<T> | UpdateNum<T>;
+
 // @public
 export type ValidateSliceCaseReducers<S, ACR extends SliceCaseReducers<S>> = ACR & {
     [P in keyof ACR]: ACR[P] extends {

src/index.ts

@@ -61,3 +61,15 @@ export {
   // types
   ActionReducerMapBuilder
 } from './mapBuilders'
+
+export { createEntityAdapter } from './entities/create_adapter'
+export {
+  Dictionary,
+  EntityState,
+  EntityAdapter,
+  Update,
+  EntityMap,
+  Predicate,
+  IdSelector,
+  Comparer
+} from './entities/models'