@angular-architects/ngrx-toolkit 0.4.0 → 18.0.0

package/lib/with-data-service.d.ts

@@ -1,9 +1,8 @@
-import { ProviderToken, Signal } from "@angular/core";
-import { SignalStoreFeature } from "@ngrx/signals";
-import { CallState } from "./with-call-state";
-import { EntityId } from "@ngrx/signals/entities";
-import { EntityState, NamedEntitySignals } from "@ngrx/signals/entities/src/models";
-import { Emtpy } from "./shared/empty";
+import { ProviderToken, Signal } from '@angular/core';
+import { SignalStoreFeature, EmptyFeatureResult } from '@ngrx/signals';
+import { CallState } from './with-call-state';
+import { EntityId } from '@ngrx/signals/entities';
+import { EntityState, NamedEntityComputed } from './shared/signal-store-models';
 export type Filter = Record<string, unknown>;
 export type Entity = {
     id: EntityId;
@@ -49,12 +48,12 @@ export type DataServiceState<E extends Entity, F extends Filter> = {
     selectedIds: Record<EntityId, boolean>;
     current: E;
 };
-export type NamedDataServiceSignals<E extends Entity, Collection extends string> = {
-    [K in Collection as `selected${Capitalize<K>}Entities`]: Signal<E[]>;
-};
-export type DataServiceSignals<E extends Entity> = {
+export type DataServiceComputed<E extends Entity> = {
     selectedEntities: Signal<E[]>;
 };
+export type NamedDataServiceComputed<E extends Entity, Collection extends string> = {
+    [K in Collection as `selected${Capitalize<K>}Entities`]: Signal<E[]>;
+};
 export type NamedDataServiceMethods<E extends Entity, F extends Filter, Collection extends string> = {
     [K in Collection as `update${Capitalize<K>}Filter`]: (filter: F) => void;
 } & {
@@ -85,31 +84,26 @@ export type DataServiceMethods<E extends Entity, F extends Filter> = {
     updateAll(entities: E[]): Promise<void>;
     delete(entity: E): Promise<void>;
 };
-export type Empty = Record<string, never>;
 export declare function withDataService<E extends Entity, F extends Filter, Collection extends string>(options: {
     dataServiceType: ProviderToken<DataService<E, F>>;
     filter: F;
     collection: Collection;
-}): SignalStoreFeature<{
-    state: Emtpy;
-    signals: NamedEntitySignals<E, Collection>;
-    methods: Emtpy;
+}): SignalStoreFeature<EmptyFeatureResult & {
+    computed: NamedEntityComputed<E, Collection>;
 }, {
     state: NamedDataServiceState<E, F, Collection>;
-    signals: NamedDataServiceSignals<E, Collection>;
+    computed: NamedDataServiceComputed<E, Collection>;
     methods: NamedDataServiceMethods<E, F, Collection>;
 }>;
 export declare function withDataService<E extends Entity, F extends Filter>(options: {
     dataServiceType: ProviderToken<DataService<E, F>>;
     filter: F;
-}): SignalStoreFeature<{
+}): SignalStoreFeature<EmptyFeatureResult & {
     state: {
         callState: CallState;
     } & EntityState<E>;
-    signals: Emtpy;
-    methods: Emtpy;
 }, {
     state: DataServiceState<E, F>;
-    signals: DataServiceSignals<E>;
+    computed: DataServiceComputed<E>;
     methods: DataServiceMethods<E, F>;
 }>;

package/lib/with-devtools.d.ts

@@ -1,5 +1,5 @@
-import { patchState as originalPatchState, SignalStoreFeature } from '@ngrx/signals';
-import { SignalStoreFeatureResult } from '@ngrx/signals/src/signal-store-models';
+import { EmptyFeatureResult, PartialStateUpdater, patchState as originalPatchState, SignalStoreFeature, WritableStateSource } from '@ngrx/signals';
+import { Prettify } from './shared/prettify';
 declare global {
     interface Window {
         __REDUX_DEVTOOLS_EXTENSION__: {
@@ -11,11 +11,6 @@ declare global {
         } | undefined;
     }
 }
-type EmptyFeatureResult = {
-    state: {};
-    signals: {};
-    methods: {};
-};
 export type Action = {
     type: string;
 };
@@ -26,7 +21,7 @@ export declare function reset(): void;
 /**
  * @param name store's name as it should appear in the DevTools
  */
-export declare function withDevtools<Input extends SignalStoreFeatureResult>(name: string): SignalStoreFeature<Input, EmptyFeatureResult>;
+export declare function withDevtools<Input extends EmptyFeatureResult>(name: string): SignalStoreFeature<Input, EmptyFeatureResult>;
 type PatchFn = typeof originalPatchState extends (arg1: infer First, ...args: infer Rest) => infer Returner ? (state: First, action: string, ...rest: Rest) => Returner : never;
 /**
  * @deprecated Has been renamed to `updateState`
@@ -35,9 +30,9 @@ export declare const patchState: PatchFn;
 /**
  * Wrapper of `patchState` for DevTools integration. Next to updating the state,
  * it also sends the action to the DevTools.
- * @param state state of Signal Store
+ * @param stateSource state of Signal Store
  * @param action name of action how it will show in DevTools
  * @param updaters updater functions or objects
  */
-export declare const updateState: PatchFn;
+export declare function updateState<State extends object>(stateSource: WritableStateSource<State>, action: string, ...updaters: Array<Partial<Prettify<State>> | PartialStateUpdater<Prettify<State>>>): void;
 export {};

package/lib/with-pagination.d.ts

@@ -6,15 +6,13 @@
  * This feature implements the local pagination.
  */
 import { Signal } from '@angular/core';
-import { SignalStoreFeature } from '@ngrx/signals';
-import { Emtpy } from './shared/empty';
-import { EntitySignals, EntityState, NamedEntitySignals } from '@ngrx/signals/entities/src/models';
-import { Entity } from './with-data-service';
+import { SignalStoreFeature, EmptyFeatureResult } from '@ngrx/signals';
+import { EntityComputed, EntityState, NamedEntityComputed } from './shared/signal-store-models';
 export type Page = {
     label: string | number;
     value: number;
 };
-export type NamedPaginationServiceState<E extends Entity, Collection extends string> = {
+export type NamedPaginationServiceState<E, Collection extends string> = {
     [K in Collection as `selectedPage${Capitalize<K>}Entities`]: Array<E>;
 } & {
     [K in Collection as `${Lowercase<K>}CurrentPage`]: number;
@@ -29,7 +27,7 @@ export type NamedPaginationServiceState<E extends Entity, Collection extends str
 } & {
     [K in Collection as `${Lowercase<K>}PageNavigationArrayMax`]: number;
 };
-export type NamedPaginationServiceSignals<E extends Entity, Collection extends string> = {
+export type NamedPaginationServiceSignals<E, Collection extends string> = {
     [K in Collection as `selectedPage${Capitalize<K>}Entities`]: Signal<E[]>;
 } & {
     [K in Collection as `${Lowercase<K>}CurrentPage`]: Signal<number>;
@@ -43,8 +41,25 @@ export type NamedPaginationServiceSignals<E extends Entity, Collection extends s
     [K in Collection as `${Lowercase<K>}PageNavigationArray`]: Signal<Page[]>;
 } & {
     [K in Collection as `${Lowercase<K>}PageNavigationArrayMax`]: Signal<number>;
+} & {
+    [K in Collection as `hasNext${Capitalize<K>}Page`]: Signal<boolean>;
+} & {
+    [K in Collection as `hasPrevious${Capitalize<K>}Page`]: Signal<boolean>;
 };
-export type PaginationServiceState<E extends Entity> = {
+export type NamedPaginationServiceMethods<Collection extends string> = {
+    [K in Collection as `set${Capitalize<K>}PageSize`]: (size: number) => void;
+} & {
+    [K in Collection as `next${Capitalize<K>}Page`]: () => void;
+} & {
+    [K in Collection as `previous${Capitalize<K>}Page`]: () => void;
+} & {
+    [K in Collection as `last${Capitalize<K>}Page`]: () => void;
+} & {
+    [K in Collection as `first${Capitalize<K>}Page`]: () => void;
+} & {
+    [K in Collection as `goto${Capitalize<K>}Page`]: (page: number) => void;
+};
+export type PaginationServiceState<E> = {
     selectedPageEntities: Array<E>;
     currentPage: number;
     pageSize: number;
@@ -53,7 +68,7 @@ export type PaginationServiceState<E extends Entity> = {
     pageNavigationArray: Page[];
     pageNavigationArrayMax: number;
 };
-export type PaginationServiceSignals<E extends Entity> = {
+export type PaginationServiceSignals<E> = {
     selectedPageEntities: Signal<E[]>;
     currentPage: Signal<number>;
     pageSize: Signal<number>;
@@ -61,44 +76,52 @@ export type PaginationServiceSignals<E extends Entity> = {
     pageCount: Signal<number>;
     pageNavigationArray: Signal<Page[]>;
     pageNavigationArrayMax: Signal<number>;
+    hasNextPage: Signal<boolean>;
+    hasPreviousPage: Signal<boolean>;
+};
+export type PaginationServiceMethods = {
+    setPageSize: (size: number) => void;
+    nextPageKey: () => void;
+    previousPage: () => void;
+    lastPage: () => void;
+    firstPage: () => void;
+    gotoPage: (page: number) => void;
 };
-export type SetPaginationState<E extends Entity, Collection extends string | undefined> = Collection extends string ? NamedPaginationServiceState<E, Collection> : PaginationServiceState<E>;
-export declare function withPagination<E extends Entity, Collection extends string>(options: {
+export type SetPaginationState<E, Collection extends string | undefined> = Collection extends string ? NamedPaginationServiceState<E, Collection> : PaginationServiceState<E>;
+export declare function withPagination<E, Collection extends string>(options: {
+    entity: E;
     collection: Collection;
-}): SignalStoreFeature<{
-    state: Emtpy;
-    signals: NamedEntitySignals<E, Collection>;
-    methods: Emtpy;
+}): SignalStoreFeature<EmptyFeatureResult & {
+    computed: NamedEntityComputed<E, Collection>;
 }, {
     state: NamedPaginationServiceState<E, Collection>;
-    signals: NamedPaginationServiceSignals<E, Collection>;
-    methods: Emtpy;
+    computed: NamedPaginationServiceSignals<E, Collection>;
+    methods: NamedPaginationServiceMethods<Collection>;
 }>;
-export declare function withPagination<E extends Entity>(): SignalStoreFeature<{
+export declare function withPagination<E>(): SignalStoreFeature<EmptyFeatureResult & {
     state: EntityState<E>;
-    signals: EntitySignals<E>;
-    methods: Emtpy;
+    computed: EntityComputed<E>;
 }, {
     state: PaginationServiceState<E>;
-    signals: PaginationServiceSignals<E>;
-    methods: Emtpy;
+    computed: PaginationServiceSignals<E>;
+    methods: PaginationServiceMethods;
 }>;
-export declare function gotoPage<E extends Entity, Collection extends string>(page: number, options?: {
+export declare function gotoPage<E, Collection extends string>(page: number, options?: {
     collection: Collection;
 }): Partial<SetPaginationState<E, Collection>>;
-export declare function setPageSize<E extends Entity, Collection extends string>(pageSize: number, options?: {
+export declare function setPageSize<E, Collection extends string>(pageSize: number, options?: {
     collection: Collection;
 }): Partial<SetPaginationState<E, Collection>>;
-export declare function nextPage<E extends Entity, Collection extends string>(options?: {
+export declare function nextPage<E, Collection extends string>(options?: {
     collection: Collection;
 }): Partial<SetPaginationState<E, Collection>>;
-export declare function previousPage<E extends Entity, Collection extends string>(options?: {
+export declare function previousPage<E, Collection extends string>(options?: {
     collection: Collection;
 }): Partial<SetPaginationState<E, Collection>>;
-export declare function firstPage<E extends Entity, Collection extends string>(options?: {
+export declare function firstPage<E, Collection extends string>(options?: {
     collection: Collection;
 }): Partial<SetPaginationState<E, Collection>>;
-export declare function setMaxPageNavigationArrayItems<E extends Entity, Collection extends string>(maxPageNavigationArrayItems: number, options?: {
+export declare function setMaxPageNavigationArrayItems<E, Collection extends string>(maxPageNavigationArrayItems: number, options?: {
     collection: Collection;
 }): Partial<SetPaginationState<E, Collection>>;
 export declare function createPageArray(currentPage: number, itemsPerPage: number, totalItems: number, paginationRange: number): Page[];

package/lib/with-redux.d.ts

@@ -1,7 +1,5 @@
 import { Observable } from 'rxjs';
-import { SignalStoreFeature } from '@ngrx/signals';
-import { EmptyFeatureResult, SignalStoreFeatureResult } from '@ngrx/signals/src/signal-store-models';
-import { StateSignal } from '@ngrx/signals/src/state-signal';
+import { EmptyFeatureResult, SignalStoreFeature, SignalStoreFeatureResult, WritableStateSource } from '@ngrx/signals';
 /** Actions **/
 type Payload = Record<string, unknown>;
 type ActionFn<Type extends string = string, ActionPayload extends Payload = Payload> = ((payload: ActionPayload) => ActionPayload & {
@@ -51,7 +49,7 @@ type EffectsFactory<StateActionFns extends ActionFns> = (actions: StateActionFns
  */
 export declare function withRedux<Spec extends ActionsFnSpecs, Input extends SignalStoreFeatureResult, StateActionFns extends ActionFnsCreator<Spec> = ActionFnsCreator<Spec>, PublicStoreActionFns extends PublicActionFns<Spec> = PublicActionFns<Spec>>(redux: {
     actions: Spec;
-    reducer: ReducerFactory<StateActionFns, StateSignal<Input['state']>>;
+    reducer: ReducerFactory<StateActionFns, WritableStateSource<Input['state']>>;
     effects: EffectsFactory<StateActionFns>;
 }): SignalStoreFeature<Input, EmptyFeatureResult & {
     methods: PublicStoreActionFns;

package/lib/with-storage-sync.d.ts

@@ -1,11 +1,5 @@
-import { SignalStoreFeature } from '@ngrx/signals';
-import { Emtpy } from './shared/empty';
-type SignalStoreFeatureInput<State> = Pick<Parameters<SignalStoreFeature>[0], 'signals' | 'methods'> & {
-    state: State;
-};
-type WithStorageSyncFeatureResult = {
-    state: Emtpy;
-    signals: Emtpy;
+import { SignalStoreFeature, SignalStoreFeatureResult, EmptyFeatureResult } from '@ngrx/signals';
+type WithStorageSyncFeatureResult = EmptyFeatureResult & {
     methods: {
         clearStorage(): void;
         readFromStorage(): void;
@@ -53,6 +47,6 @@ export type SyncConfig<State> = {
  *
  * Only works on browser platform.
  */
-export declare function withStorageSync<State extends object, Input extends SignalStoreFeatureInput<State>>(key: string): SignalStoreFeature<Input, WithStorageSyncFeatureResult>;
-export declare function withStorageSync<State extends object, Input extends SignalStoreFeatureInput<State>>(config: SyncConfig<Input['state']>): SignalStoreFeature<Input, WithStorageSyncFeatureResult>;
+export declare function withStorageSync<State extends object, Input extends SignalStoreFeatureResult>(key: string): SignalStoreFeature<Input, WithStorageSyncFeatureResult>;
+export declare function withStorageSync<State extends object, Input extends SignalStoreFeatureResult>(config: SyncConfig<Input['state']>): SignalStoreFeature<Input, WithStorageSyncFeatureResult>;
 export {};

package/lib/with-undo-redo.d.ts

@@ -1,33 +1,21 @@
-import { SignalStoreFeature } from "@ngrx/signals";
-import { EntityId, EntityMap, EntityState } from "@ngrx/signals/entities";
-import { Signal } from "@angular/core";
-import { EntitySignals, NamedEntitySignals } from "@ngrx/signals/entities/src/models";
-import { Entity } from "./with-data-service";
-import { Emtpy } from "./shared/empty";
+import { SignalStoreFeature, EmptyFeatureResult } from '@ngrx/signals';
+import { EntityState } from '@ngrx/signals/entities';
+import { Signal } from '@angular/core';
+import { Entity } from './with-data-service';
+import { EntityComputed, NamedEntityComputed } from './shared/signal-store-models';
 export type StackItem = Record<string, unknown>;
 export type NormalizedUndoRedoOptions = {
     maxStackSize: number;
     collections?: string[];
 };
-export type NamedUndoRedoState<Collection extends string> = {
-    [K in Collection as `${K}EntityMap`]: EntityMap<Entity>;
-} & {
-    [K in Collection as `${K}Ids`]: EntityId[];
-};
-export type NamedUndoRedoSignals<Collection extends string> = {
-    [K in Collection as `${K}Entities`]: Signal<Entity[]>;
-};
 export declare function getUndoRedoKeys(collections?: string[]): string[];
 export declare function withUndoRedo<Collection extends string>(options?: {
     maxStackSize?: number;
     collections: Collection[];
-}): SignalStoreFeature<{
-    state: Emtpy;
-    signals: NamedEntitySignals<Entity, Collection>;
-    methods: Emtpy;
-}, {
-    state: Emtpy;
-    signals: {
+}): SignalStoreFeature<EmptyFeatureResult & {
+    computed: NamedEntityComputed<Entity, Collection>;
+}, EmptyFeatureResult & {
+    computed: {
         canUndo: Signal<boolean>;
         canRedo: Signal<boolean>;
     };
@@ -38,13 +26,11 @@ export declare function withUndoRedo<Collection extends string>(options?: {
 }>;
 export declare function withUndoRedo(options?: {
     maxStackSize?: number;
-}): SignalStoreFeature<{
+}): SignalStoreFeature<EmptyFeatureResult & {
     state: EntityState<Entity>;
-    signals: EntitySignals<Entity>;
-    methods: Emtpy;
-}, {
-    state: Emtpy;
-    signals: {
+    computed: EntityComputed<Entity>;
+}, EmptyFeatureResult & {
+    computed: {
         canUndo: Signal<boolean>;
         canRedo: Signal<boolean>;
     };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@angular-architects/ngrx-toolkit",
-  "version": "0.4.0",
+  "version": "18.0.0",
   "license": "MIT",
   "repository": {
     "type": "GitHub",
     "url": "https://github.com/angular-architects/ngrx-toolkit"
   },
   "peerDependencies": {
-    "@ngrx/signals": "^17.2.0"
+    "@ngrx/signals": "18.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/esm2022/lib/shared/empty.mjs

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW1wdHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi9saWJzL25ncngtdG9vbGtpdC9zcmMvbGliL3NoYXJlZC9lbXB0eS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9iYW4tdHlwZXNcbmV4cG9ydCB0eXBlIEVtdHB5ID0ge307Il19

package/lib/shared/empty.d.ts

@@ -1 +0,0 @@
-export type Emtpy = {};