@angular-architects/ngrx-toolkit 20.6.0 → 20.7.0

package/index.d.ts

@@ -1,6 +1,7 @@
 import * as _ngrx_signals from '@ngrx/signals';
 import { StateSource, patchState as patchState$1, WritableStateSource, PartialStateUpdater, SignalStoreFeature, EmptyFeatureResult, SignalStoreFeatureResult, StateSignals } from '@ngrx/signals';
 import { ValueProvider, Signal, ProviderToken, WritableSignal, Injector, ResourceStatus, Resource, ResourceRef } from '@angular/core';
+import { EventCreator } from '@ngrx/signals/events';
 import { Observable, ObservableInput, OperatorFunction, ObservedValueOf } from 'rxjs';
 import { EntityId, NamedEntityState, EntityState as EntityState$1, EntityProps, NamedEntityProps } from '@ngrx/signals/entities';
 import { HttpHeaders, HttpContext, HttpParams, HttpProgressEvent } from '@angular/common/http';
@@ -42,6 +43,7 @@ type TrackerStores = Record<string, StateSource<object>>;
 declare const DEVTOOLS_FEATURE: unique symbol;
 type Mapper = (state: object) => object;
 type DevtoolsOptions = {
+    name?: string;
     indexNames?: boolean;
     map?: Mapper;
     tracker?: new () => Tracker;
@@ -192,6 +194,17 @@ declare function withDevtools(name: string, ...features: DevtoolsFeature[]): Sig
  */
 declare const withDevToolsStub: typeof withDevtools;
 
+declare function withTrackedReducer<State extends object>(...caseReducers: CaseReducerResult<State, any>[]): SignalStoreFeature<EmptyFeatureResult & {
+    state: State;
+}, EmptyFeatureResult>;
+type CaseReducerResult<State extends object, EventCreators extends any[]> = {
+    reducer: CaseReducer<State, EventCreators>;
+    events: EventCreators;
+};
+type CaseReducer<State extends object, EventCreators extends EventCreator<string, any>[]> = (event: {
+    [K in keyof EventCreators]: ReturnType<EventCreators[K]>;
+}[number], state: State) => Partial<State> | PartialStateUpdater<State> | Array<Partial<State> | PartialStateUpdater<State>>;
+
 /** Actions **/
 type Payload = Record<string, unknown>;
 type ActionFn<Type extends string = string, ActionPayload extends Payload = Payload> = ((payload: ActionPayload) => ActionPayload & {
@@ -337,6 +350,41 @@ declare function withRedux<Spec extends ActionsFnSpecs, Input extends SignalStor
     methods: PublicStoreActionFns;
 }>;
 
+type ClearUndoRedoOptions<TState extends object> = {
+    lastRecord: Partial<TState> | null;
+};
+declare function clearUndoRedo<TState extends object>(store: StateSource<TState>, opts?: ClearUndoRedoOptions<TState>): void;
+
+type StackItem = Record<string, unknown>;
+type NormalizedUndoRedoOptions = {
+    maxStackSize: number;
+    collections?: string[];
+    keys: string[];
+    skip: number;
+};
+declare function getUndoRedoKeys(collections?: string[]): string[];
+type NonNever<T> = T extends never ? never : T;
+type ExtractEntityCollection<T> = T extends `${infer U}Entities` ? U : never;
+type ExtractEntityCollections<Store extends SignalStoreFeatureResult> = NonNever<{
+    [K in keyof Store['props']]: ExtractEntityCollection<K>;
+}[keyof Store['props']]>;
+type OptionsForState<Store extends SignalStoreFeatureResult> = Partial<Omit<NormalizedUndoRedoOptions, 'collections' | 'keys'>> & {
+    collections?: ExtractEntityCollections<Store>[];
+    keys?: (keyof Store['state'])[];
+};
+declare function withUndoRedo<Input extends EmptyFeatureResult>(options?: OptionsForState<Input>): SignalStoreFeature<Input, EmptyFeatureResult & {
+    props: {
+        canUndo: Signal<boolean>;
+        canRedo: Signal<boolean>;
+    };
+    methods: {
+        undo: () => void;
+        redo: () => void;
+        /** @deprecated Use {@link clearUndoRedo} instead. */
+        clearStack: () => void;
+    };
+}>;
+
 type CallState = 'init' | 'loading' | 'loaded' | {
     error: string;
 };
@@ -415,10 +463,10 @@ type EntityState<Entity> = {
 };
 
 type Filter = Record<string, unknown>;
-type Entity = {
+type Entity$1 = {
     id: EntityId;
 };
-interface DataService<E extends Entity, F extends Filter> {
+interface DataService<E extends Entity$1, F extends Filter> {
     load(filter: F): Promise<E[]>;
     loadById(id: EntityId): Promise<E>;
     create(entity: E): Promise<E>;
@@ -447,25 +495,25 @@ declare function getDataServiceKeys(options: {
     updateAllKey: string;
     deleteKey: string;
 };
-type NamedDataServiceState<E extends Entity, F extends Filter, Collection extends string> = {
+type NamedDataServiceState<E extends Entity$1, F extends Filter, Collection extends string> = {
     [K in Collection as `${K}Filter`]: F;
 } & {
     [K in Collection as `selected${Capitalize<K>}Ids`]: Record<EntityId, boolean>;
 } & {
     [K in Collection as `current${Capitalize<K>}`]: E;
 };
-type DataServiceState<E extends Entity, F extends Filter> = {
+type DataServiceState<E extends Entity$1, F extends Filter> = {
     filter: F;
     selectedIds: Record<EntityId, boolean>;
     current: E;
 };
-type DataServiceComputed<E extends Entity> = {
+type DataServiceComputed<E extends Entity$1> = {
     selectedEntities: Signal<E[]>;
 };
-type NamedDataServiceComputed<E extends Entity, Collection extends string> = {
+type NamedDataServiceComputed<E extends Entity$1, Collection extends string> = {
     [K in Collection as `selected${Capitalize<K>}Entities`]: Signal<E[]>;
 };
-type NamedDataServiceMethods<E extends Entity, F extends Filter, Collection extends string> = {
+type NamedDataServiceMethods<E extends Entity$1, F extends Filter, Collection extends string> = {
     [K in Collection as `update${Capitalize<K>}Filter`]: (filter: F) => void;
 } & {
     [K in Collection as `updateSelected${Capitalize<K>}Entities`]: (id: EntityId, selected: boolean) => void;
@@ -484,7 +532,7 @@ type NamedDataServiceMethods<E extends Entity, F extends Filter, Collection exte
 } & {
     [K in Collection as `delete${Capitalize<K>}`]: (entity: E) => Promise<void>;
 };
-type DataServiceMethods<E extends Entity, F extends Filter> = {
+type DataServiceMethods<E extends Entity$1, F extends Filter> = {
     updateFilter: (filter: F) => void;
     updateSelected: (id: EntityId, selected: boolean) => void;
     load: () => Promise<void>;
@@ -495,7 +543,7 @@ type DataServiceMethods<E extends Entity, F extends Filter> = {
     updateAll(entities: E[]): Promise<void>;
     delete(entity: E): Promise<void>;
 };
-declare function withDataService<E extends Entity, F extends Filter, Collection extends string>(options: {
+declare function withDataService<E extends Entity$1, F extends Filter, Collection extends string>(options: {
     dataServiceType: ProviderToken<DataService<E, F>>;
     filter: F;
     collection: Collection;
@@ -506,7 +554,7 @@ declare function withDataService<E extends Entity, F extends Filter, Collection
     props: NamedDataServiceComputed<E, Collection>;
     methods: NamedDataServiceMethods<E, F, Collection>;
 }>;
-declare function withDataService<E extends Entity, F extends Filter>(options: {
+declare function withDataService<E extends Entity$1, F extends Filter>(options: {
     dataServiceType: ProviderToken<DataService<E, F>>;
     filter: F;
 }): SignalStoreFeature<EmptyFeatureResult & {
@@ -654,35 +702,6 @@ declare function withReset(): _ngrx_signals.SignalStoreFeature<_ngrx_signals.Emp
  */
 declare function setResetState<State extends object>(store: StateSource<State>, state: State): void;
 
-type StackItem = Record<string, unknown>;
-type NormalizedUndoRedoOptions = {
-    maxStackSize: number;
-    collections?: string[];
-    keys: string[];
-    skip: number;
-};
-declare function getUndoRedoKeys(collections?: string[]): string[];
-type NonNever<T> = T extends never ? never : T;
-type ExtractEntityCollection<T> = T extends `${infer U}Entities` ? U : never;
-type ExtractEntityCollections<Store extends SignalStoreFeatureResult> = NonNever<{
-    [K in keyof Store['props']]: ExtractEntityCollection<K>;
-}[keyof Store['props']]>;
-type OptionsForState<Store extends SignalStoreFeatureResult> = Partial<Omit<NormalizedUndoRedoOptions, 'collections' | 'keys'>> & {
-    collections?: ExtractEntityCollections<Store>[];
-    keys?: (keyof Store['state'])[];
-};
-declare function withUndoRedo<Input extends EmptyFeatureResult>(options?: OptionsForState<Input>): SignalStoreFeature<Input, EmptyFeatureResult & {
-    props: {
-        canUndo: Signal<boolean>;
-        canRedo: Signal<boolean>;
-    };
-    methods: {
-        undo: () => void;
-        redo: () => void;
-        clearStack: () => void;
-    };
-}>;
-
 /**
  * Starting from v20, the root properties of the state object
  * are all of type `WritableSignal`.
@@ -1065,9 +1084,9 @@ type ResourceResult<T> = {
     };
 };
 type ResourceDictionary = Record<string, ResourceRef<unknown>>;
-type NamedResourceResult<T extends ResourceDictionary> = {
+type NamedResourceResult<T extends ResourceDictionary, HasUndefinedErrorHandling extends boolean> = {
     state: {
-        [Prop in keyof T as `${Prop & string}Value`]: T[Prop]['value'] extends Signal<infer S> ? S : never;
+        [Prop in keyof T as `${Prop & string}Value`]: T[Prop]['value'] extends Signal<infer S> ? HasUndefinedErrorHandling extends true ? S | undefined : S : never;
     };
     props: {
         [Prop in keyof T as `${Prop & string}Status`]: Signal<ResourceStatus>;
@@ -1082,6 +1101,10 @@ type NamedResourceResult<T extends ResourceDictionary> = {
         [Prop in keyof T as `_${Prop & string}Reload`]: () => boolean;
     };
 };
+type ErrorHandling = 'native' | 'undefined value' | 'previous value';
+type ResourceOptions = {
+    errorHandling?: ErrorHandling;
+};
 /**
  * @experimental
  * @description
@@ -1089,7 +1112,7 @@ type NamedResourceResult<T extends ResourceDictionary> = {
  * Integrates a `Resource` into the SignalStore and makes the store instance
  * implement the `Resource` interface.
  *
- * The resource’s value is stored under the `value` key in the state
+ * The resource's value is stored under the `value` key in the state
  * and is exposed as a `DeepSignal`.
  *
  * It can also be updated via `patchState`.
@@ -1111,9 +1134,14 @@ type NamedResourceResult<T extends ResourceDictionary> = {
  * ```
  *
  * @param resourceFactory A factory function that receives the store's state signals,
- * methods, and props. Needs to return a `ResourceRef`.
+ * methods, and props.
+ * @param resourceOptions Allows configuration of the error handling behavior.
  */
-declare function withResource<Input extends SignalStoreFeatureResult, ResourceValue>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => ResourceRef<ResourceValue>): SignalStoreFeature<Input, ResourceResult<ResourceValue>>;
+declare function withResource<Input extends SignalStoreFeatureResult, ResourceValue>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => ResourceRef<ResourceValue>): SignalStoreFeature<Input, ResourceResult<ResourceValue | undefined>>;
+declare function withResource<Input extends SignalStoreFeatureResult, ResourceValue>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => ResourceRef<ResourceValue>, resourceOptions: {
+    errorHandling: 'undefined value';
+}): SignalStoreFeature<Input, ResourceResult<ResourceValue | undefined>>;
+declare function withResource<Input extends SignalStoreFeatureResult, ResourceValue>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => ResourceRef<ResourceValue>, resourceOptions?: ResourceOptions): SignalStoreFeature<Input, ResourceResult<ResourceValue>>;
 /**
  * @experimental
  * @description
@@ -1146,8 +1174,13 @@ declare function withResource<Input extends SignalStoreFeatureResult, ResourceVa
  *
  * @param resourceFactory A factory function that receives the store's props,
  * methods, and state signals. It must return a `Record<string, ResourceRef>`.
+ * @param resourceOptions Allows to configure the error handling behavior.
  */
-declare function withResource<Input extends SignalStoreFeatureResult, Dictionary extends ResourceDictionary>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => Dictionary): SignalStoreFeature<Input, NamedResourceResult<Dictionary>>;
+declare function withResource<Input extends SignalStoreFeatureResult, Dictionary extends ResourceDictionary>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => Dictionary): SignalStoreFeature<Input, NamedResourceResult<Dictionary, true>>;
+declare function withResource<Input extends SignalStoreFeatureResult, Dictionary extends ResourceDictionary>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => Dictionary, resourceOptions: {
+    errorHandling: 'undefined value';
+}): SignalStoreFeature<Input, NamedResourceResult<Dictionary, true>>;
+declare function withResource<Input extends SignalStoreFeatureResult, Dictionary extends ResourceDictionary>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => Dictionary, resourceOptions?: ResourceOptions): SignalStoreFeature<Input, NamedResourceResult<Dictionary, false>>;
 type NamedResource<Name extends string, T> = {
     [Prop in `${Name}Value`]: Signal<T>;
 } & {
@@ -1224,7 +1257,7 @@ declare function mapToResource<Name extends ResourceNames<Store>, Store extends
  * );
  *
  * const store = TestBed.inject(Store);
- * store.status();    // 'idle' | 'loading' | 'resolved' | 'error'
+ * store.status();    // 'idle' | 'loading' | 'resolved' | 'error' | 'local'
  * store.value();     // Todo[]
  * store.ids();       // EntityId[]
  * store.entityMap(); // Record<EntityId, Todo>
@@ -1257,7 +1290,7 @@ declare function mapToResource<Name extends ResourceNames<Store>, Store extends
  */
 declare function withEntityResources<Input extends SignalStoreFeatureResult, Entity extends {
     id: EntityId;
-}>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => ResourceRef<readonly Entity[] | Entity[] | undefined>): SignalStoreFeature<Input, EntityResourceResult<Entity>>;
+}>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => ResourceRef<TypedEntityResourceValue<Entity>>): SignalStoreFeature<Input, EntityResourceResult<Entity>>;
 declare function withEntityResources<Input extends SignalStoreFeatureResult, Dictionary extends EntityDictionary>(resourceFactory: (store: Input['props'] & Input['methods'] & StateSignals<Input['state']>) => Dictionary): SignalStoreFeature<Input, NamedEntityResourceResult<Dictionary>>;
 /**
  * @internal
@@ -1287,7 +1320,12 @@ type EntityResourceResult<Entity> = {
 type ArrayElement<T> = T extends readonly (infer E)[] | (infer E)[] ? E : never;
 type InferEntityFromSignal<T> = T extends Signal<infer V> ? ArrayElement<V> : never;
 type MergeUnion<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-type EntityDictionary = Record<string, ResourceRef<readonly unknown[] | unknown[] | undefined>>;
+type Entity = {
+    id: EntityId;
+};
+type EntityResourceValue = Entity[] | (Entity[] | undefined);
+type TypedEntityResourceValue<E extends Entity> = E[] | (E[] | undefined);
+type EntityDictionary = Record<string, ResourceRef<EntityResourceValue>>;
 type MergeNamedEntityStates<T extends EntityDictionary> = MergeUnion<{
     [Prop in keyof T]: Prop extends string ? InferEntityFromSignal<T[Prop]['value']> extends infer E ? E extends never ? never : NamedEntityState<E, Prop> : never : never;
 }[keyof T]>;
@@ -1295,9 +1333,9 @@ type MergeNamedEntityProps<T extends EntityDictionary> = MergeUnion<{
     [Prop in keyof T]: Prop extends string ? InferEntityFromSignal<T[Prop]['value']> extends infer E ? E extends never ? never : NamedEntityProps<E, Prop> : never : never;
 }[keyof T]>;
 type NamedEntityResourceResult<T extends EntityDictionary> = {
-    state: NamedResourceResult<T>['state'] & MergeNamedEntityStates<T>;
-    props: NamedResourceResult<T>['props'] & MergeNamedEntityProps<T>;
-    methods: NamedResourceResult<T>['methods'];
+    state: NamedResourceResult<T, false>['state'] & MergeNamedEntityStates<T>;
+    props: NamedResourceResult<T, false>['props'] & MergeNamedEntityProps<T>;
+    methods: NamedResourceResult<T, false>['methods'];
 };
 
 type MutationsDictionary = Record<string, Mutation<any, any>>;
@@ -1431,5 +1469,5 @@ type HttpMutation<Parameter, Result> = Mutation<Parameter, Result> & {
  */
 declare function httpMutation<Parameter, Result>(optionsOrRequest: HttpMutationOptions<Parameter, Result> | ((param: Parameter) => HttpMutationRequest)): HttpMutation<Parameter, Result>;
 
-export { capitalize, concatOp, createEffects, createPageArray, createReducer, deriveCallStateKeys, emptyFeature, exhaustOp, firstPage, getCallStateKeys, getCollectionArray, getDataServiceKeys, getUndoRedoKeys, gotoPage, httpMutation, mapToResource, mergeOp, nextPage, noPayload, patchState, payload, previousPage, provideDevtoolsConfig, renameDevtoolsName, rxMutation, setError, setLoaded, setLoading, setMaxPageNavigationArrayItems, setPageSize, setResetState, switchOp, updateState, withCallState, withConditional, withDataService, withDevToolsStub, withDevtools, withDisabledNameIndices, withEntityResources, withFeatureFactory, withGlitchTracking, withImmutableState, withIndexedDB, withIndexedDB as withIndexeddb, withLocalStorage, withMapper, withMutations, withPagination, withRedux, withReset, withResource, withSessionStorage, withStorageSync, withUndoRedo };
-export type { CallState, CallStateSignals, CallStateSlice, DataService, DataServiceComputed, DataServiceMethods, DataServiceState, DevtoolsFeature, Entity, EntityDictionary, EntityResourceResult, Filter, HttpMutation, HttpMutationOptions, HttpMutationRequest, MethodsDictionary, Mutation, MutationResult, MutationStatus, NamedCallStateSignals, NamedCallStateSlice, NamedDataServiceComputed, NamedDataServiceMethods, NamedDataServiceState, NamedEntityResourceResult, NamedMutationResult, NamedPaginationServiceSignals, NamedPaginationServiceState, NormalizedUndoRedoOptions, Operation, Page, PaginationServiceSignals, PaginationServiceState, ReduxDevtoolsConfig, RxMutationOptions, SetCallState, SetPaginationState, StackItem, SyncConfig };
+export { capitalize, clearUndoRedo, concatOp, createEffects, createPageArray, createReducer, deriveCallStateKeys, emptyFeature, exhaustOp, firstPage, getCallStateKeys, getCollectionArray, getDataServiceKeys, getUndoRedoKeys, gotoPage, httpMutation, mapToResource, mergeOp, nextPage, noPayload, patchState, payload, previousPage, provideDevtoolsConfig, renameDevtoolsName, rxMutation, setError, setLoaded, setLoading, setMaxPageNavigationArrayItems, setPageSize, setResetState, switchOp, updateState, withCallState, withConditional, withDataService, withDevToolsStub, withDevtools, withDisabledNameIndices, withEntityResources, withFeatureFactory, withGlitchTracking, withImmutableState, withIndexedDB, withIndexedDB as withIndexeddb, withLocalStorage, withMapper, withMutations, withPagination, withRedux, withReset, withResource, withSessionStorage, withStorageSync, withTrackedReducer, withUndoRedo };
+export type { CallState, CallStateSignals, CallStateSlice, DataService, DataServiceComputed, DataServiceMethods, DataServiceState, DevtoolsFeature, Entity$1 as Entity, EntityDictionary, EntityResourceResult, Filter, HttpMutation, HttpMutationOptions, HttpMutationRequest, MethodsDictionary, Mutation, MutationResult, MutationStatus, NamedCallStateSignals, NamedCallStateSlice, NamedDataServiceComputed, NamedDataServiceMethods, NamedDataServiceState, NamedEntityResourceResult, NamedMutationResult, NamedPaginationServiceSignals, NamedPaginationServiceState, NormalizedUndoRedoOptions, Operation, Page, PaginationServiceSignals, PaginationServiceState, ReduxDevtoolsConfig, RxMutationOptions, SetCallState, SetPaginationState, StackItem, SyncConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-architects/ngrx-toolkit",
-  "version": "20.6.0",
+  "version": "20.7.0",
   "license": "MIT",
   "repository": {
     "type": "GitHub",