@angular-architects/ngrx-toolkit 0.1.0 → 0.1.2

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

@@ -1,184 +0,0 @@
-import { SignalStoreFeature, patchState, signalStoreFeature, withComputed, withHooks, withMethods } from "@ngrx/signals";
-import { EntityId, EntityMap, EntityState } from "@ngrx/signals/entities";
-import { Signal, effect, signal, untracked, isSignal } from "@angular/core";
-import { EntitySignals, NamedEntitySignals } from "@ngrx/signals/entities/src/models";
-import { Entity, capitalize } from "./with-data-service";
-import { Emtpy } from "./shared/empty";
-
-export type StackItem = Record<string, unknown>;
-
-export type NormalizedUndoRedoOptions = {
-    maxStackSize: number;
-    collections?: string[]
-}
-
-const defaultOptions: NormalizedUndoRedoOptions = {
-    maxStackSize: 100
-};
-
-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 function getUndoRedoKeys(collections?: string[]): string[] {
-    if (collections) {
-        return collections.flatMap(c => [`${c}EntityMap`, `${c}Ids`, `selected${capitalize(c)}Ids`, `${c}Filter`])
-    }
-    return ['entityMap', 'ids', 'selectedIds', 'filter'];
-}
-
-export function withUndoRedo<Collection extends string>(options?: { maxStackSize?: number; collections: Collection[] }): SignalStoreFeature<
-    {
-        state: Emtpy,
-        // This alternative breaks type inference:
-        // state: NamedEntityState<Entity, Collection>
-        signals: NamedEntitySignals<Entity, Collection>,
-        methods: Emtpy
-    },
-    {
-        state: Emtpy,
-        signals: {
-            canUndo: Signal<boolean>,
-            canRedo: Signal<boolean>
-        },
-        methods: {
-            undo: () => void,
-            redo: () => void
-        }
-    }>;
-
-export function withUndoRedo(options?: { maxStackSize?: number }): SignalStoreFeature<
-    {
-        state: EntityState<Entity>,
-        signals: EntitySignals<Entity>,
-        methods: Emtpy
-    },
-    {
-        state: Emtpy,
-        signals: {
-            canUndo: Signal<boolean>,
-            canRedo: Signal<boolean>
-        },
-        methods: {
-            undo: () => void,
-            redo: () => void
-        }
-    }>;
-
-export function withUndoRedo<Collection extends string>(options: {
-    maxStackSize?: number;
-    collections?: Collection[]
-} = {}): 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-SignalStoreFeature<any, any> {
-    let previous: StackItem | null = null;
-    let skipOnce = false;
-
-    const normalized = {
-        ...defaultOptions,
-        ...options
-    };
-
-    //
-    // Design Decision: This feature has its own
-    // internal state.
-    //
-
-    const undoStack: StackItem[] = [];
-    const redoStack: StackItem[] = [];
-
-    const canUndo = signal(false);
-    const canRedo = signal(false);
-
-    const updateInternal = () => {
-        canUndo.set(undoStack.length !== 0);
-        canRedo.set(redoStack.length !== 0);
-    };
-
-    const keys = getUndoRedoKeys(normalized?.collections);
-
-    return signalStoreFeature(
-
-        withComputed(() => ({
-            canUndo: canUndo.asReadonly(),
-            canRedo: canRedo.asReadonly()
-        })),
-        withMethods((store) => ({
-            undo(): void {
-                const item = undoStack.pop();
-
-                if (item && previous) {
-                    redoStack.push(previous);
-                }
-
-                if (item) {
-                    skipOnce = true;
-                    patchState(store, item);
-                    previous = item;
-                }
-
-                updateInternal();
-            },
-            redo(): void {
-                const item = redoStack.pop();
-
-                if (item && previous) {
-                    undoStack.push(previous);
-                }
-
-                if (item) {
-                    skipOnce = true;
-                    patchState(store, item);
-                    previous = item;
-                }
-
-                updateInternal();
-            }
-        })),
-        withHooks({
-            onInit(store: Record<string, unknown>) {
-                effect(() => {
-
-                    const cand = keys.reduce((acc, key) => {
-                        const s = store[key];
-                        if (s && isSignal(s)) {
-                            return {
-                                ...acc,
-                                [key]: s()
-                            }
-                        }
-                        return acc;
-                    }, {});
-
-                    if (skipOnce) {
-                        skipOnce = false;
-                        return;
-                    }
-
-                    // Clear redoStack after recorded action
-                    redoStack.splice(0);
-
-                    if (previous) {
-                        undoStack.push(previous);
-                    }
-
-                    if (redoStack.length > normalized.maxStackSize) {
-                        undoStack.unshift();
-                    }
-
-                    previous = cand;
-
-                    // Don't propogate current reactive context
-                    untracked(() => updateInternal());
-                })
-            }
-        })
-
-    )
-}

package/src/test-setup.ts

@@ -1,8 +0,0 @@
-// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
-globalThis.ngJest = {
-  testEnvironmentOptions: {
-    errorOnUnknownElements: true,
-    errorOnUnknownProperties: true,
-  },
-};
-import 'jest-preset-angular/setup-jest';

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2022",
-    "useDefineForClassFields": false,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ],
-  "extends": "../../tsconfig.base.json",
-  "angularCompilerOptions": {
-    "enableI18nLegacyMessageIdFormat": false,
-    "strictInjectionParameters": true,
-    "strictInputAccessModifiers": true,
-    "strictTemplates": true
-  }
-}

package/tsconfig.lib.json

@@ -1,17 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "declaration": true,
-    "declarationMap": true,
-    "inlineSources": true,
-    "types": []
-  },
-  "exclude": [
-    "src/**/*.spec.ts",
-    "src/test-setup.ts",
-    "jest.config.ts",
-    "src/**/*.test.ts"
-  ],
-  "include": ["src/**/*.ts"]
-}

package/tsconfig.lib.prod.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.lib.json",
-  "compilerOptions": {
-    "declarationMap": false
-  },
-  "angularCompilerOptions": {
-    "compilationMode": "partial"
-  }
-}

package/tsconfig.spec.json

@@ -1,16 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "module": "commonjs",
-    "target": "es2016",
-    "types": ["jest", "node"]
-  },
-  "files": ["src/test-setup.ts"],
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts"
-  ]
-}