@angular-architects/ngrx-toolkit 0.3.1 → 18.0.0-rc.2.0

package/lib/with-pagination.d.ts

@@ -0,0 +1,130 @@
+/** With pagination comes in two flavors the first one is local pagination or in memory pagination. For example we have 2000 items which we want
+ * to display in a table and the response payload is small enough to be stored in the memory. But we can not display all 2000 items at once
+ * so we need to paginate the data. The second flavor is server side pagination where the response payload is too large to be stored in the memory
+ * and we need to fetch the data from the server in chunks. In the second case we 'could' also cache the data in the memory but that could lead to
+ * other problems like memory leaks and stale data. So we will not cache the data in the memory in the second case.
+ * This feature implements the local pagination.
+ */
+import { Signal } from '@angular/core';
+import { SignalStoreFeature } from '@ngrx/signals';
+import { EntityComputed, EntityState, NamedEntityComputed } from './shared/signal-store-models';
+export type Page = {
+    label: string | number;
+    value: number;
+};
+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;
+} & {
+    [K in Collection as `${Lowercase<K>}PageSize`]: number;
+} & {
+    [K in Collection as `${Lowercase<K>}TotalCount`]: number;
+} & {
+    [K in Collection as `${Lowercase<K>}PageCount`]: number;
+} & {
+    [K in Collection as `${Lowercase<K>}PageNavigationArray`]: number;
+} & {
+    [K in Collection as `${Lowercase<K>}PageNavigationArrayMax`]: number;
+};
+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>;
+} & {
+    [K in Collection as `${Lowercase<K>}PageSize`]: Signal<number>;
+} & {
+    [K in Collection as `${Lowercase<K>}TotalCount`]: Signal<number>;
+} & {
+    [K in Collection as `${Lowercase<K>}PageCount`]: Signal<number>;
+} & {
+    [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 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;
+    totalCount: number;
+    pageCount: number;
+    pageNavigationArray: Page[];
+    pageNavigationArrayMax: number;
+};
+export type PaginationServiceSignals<E> = {
+    selectedPageEntities: Signal<E[]>;
+    currentPage: Signal<number>;
+    pageSize: Signal<number>;
+    totalCount: Signal<number>;
+    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, 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: {};
+    computed: NamedEntityComputed<E, Collection>;
+    methods: {};
+}, {
+    state: NamedPaginationServiceState<E, Collection>;
+    computed: NamedPaginationServiceSignals<E, Collection>;
+    methods: NamedPaginationServiceMethods<Collection>;
+}>;
+export declare function withPagination<E>(): SignalStoreFeature<{
+    state: EntityState<E>;
+    computed: EntityComputed<E>;
+    methods: {};
+}, {
+    state: PaginationServiceState<E>;
+    computed: PaginationServiceSignals<E>;
+    methods: PaginationServiceMethods;
+}>;
+export declare function gotoPage<E, Collection extends string>(page: number, options?: {
+    collection: Collection;
+}): Partial<SetPaginationState<E, Collection>>;
+export declare function setPageSize<E, Collection extends string>(pageSize: number, options?: {
+    collection: Collection;
+}): Partial<SetPaginationState<E, Collection>>;
+export declare function nextPage<E, Collection extends string>(options?: {
+    collection: Collection;
+}): Partial<SetPaginationState<E, Collection>>;
+export declare function previousPage<E, Collection extends string>(options?: {
+    collection: Collection;
+}): Partial<SetPaginationState<E, Collection>>;
+export declare function firstPage<E, Collection extends string>(options?: {
+    collection: Collection;
+}): Partial<SetPaginationState<E, Collection>>;
+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,6 @@
 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 { SignalStoreFeature, StateSignal } from '@ngrx/signals';
+import { EmptyFeatureResult, SignalStoreFeatureResult } from './shared/signal-store-models';
 /** Actions **/
 type Payload = Record<string, unknown>;
 type ActionFn<Type extends string = string, ActionPayload extends Payload = Payload> = ((payload: ActionPayload) => ActionPayload & {

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

@@ -1,11 +1,9 @@
 import { SignalStoreFeature } from '@ngrx/signals';
-import { Emtpy } from './shared/empty';
-type SignalStoreFeatureInput<State> = Pick<Parameters<SignalStoreFeature>[0], 'signals' | 'methods'> & {
-    state: State;
-};
+import { Empty } from './shared/empty';
+import { SignalStoreFeatureResult } from './shared/signal-store-models';
 type WithStorageSyncFeatureResult = {
-    state: Emtpy;
-    signals: Emtpy;
+    state: Empty;
+    computed: Empty;
     methods: {
         clearStorage(): void;
         readFromStorage(): void;
@@ -53,6 +51,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,9 +1,8 @@
-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 } from '@ngrx/signals';
+import { EntityId, EntityMap, 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;
@@ -22,12 +21,12 @@ export declare function withUndoRedo<Collection extends string>(options?: {
     maxStackSize?: number;
     collections: Collection[];
 }): SignalStoreFeature<{
-    state: Emtpy;
-    signals: NamedEntitySignals<Entity, Collection>;
-    methods: Emtpy;
+    state: {};
+    computed: NamedEntityComputed<Entity, Collection>;
+    methods: {};
 }, {
-    state: Emtpy;
-    signals: {
+    state: {};
+    computed: {
         canUndo: Signal<boolean>;
         canRedo: Signal<boolean>;
     };
@@ -40,11 +39,11 @@ export declare function withUndoRedo(options?: {
     maxStackSize?: number;
 }): SignalStoreFeature<{
     state: EntityState<Entity>;
-    signals: EntitySignals<Entity>;
-    methods: Emtpy;
+    computed: EntityComputed<Entity>;
+    methods: {};
 }, {
-    state: Emtpy;
-    signals: {
+    state: {};
+    computed: {
         canUndo: Signal<boolean>;
         canRedo: Signal<boolean>;
     };

package/package.json

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