Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: make private undo/redo state instance-specific #22

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: make private undo/redo state instance-specific #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 105 additions & 98 deletions libs/ngrx-toolkit/src/lib/with-undo-redo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ export function getUndoRedoKeys(collections?: string[]): string[] {
return ['entityMap', 'ids', 'selectedIds', 'filter'];
}

type InnerSignalStore = Parameters<ReturnType<typeof signalStoreFeature>>[0];

export function withUndoRedo<Collection extends string>(options?: { maxStackSize?: number; collections: Collection[] }): SignalStoreFeature<
{
state: Emtpy,
Expand Down Expand Up @@ -77,108 +79,113 @@ export function withUndoRedo<Collection extends string>(options: {
} = {}):
// 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;
return (store: InnerSignalStore) => {
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);

const feature = signalStoreFeature(

withComputed(() => ({
canUndo: canUndo.asReadonly(),
canRedo: canRedo.asReadonly()
})),
withMethods((store) => ({
undo(): void {
const item = undoStack.pop();

if (item && previous) {
redoStack.push(previous);
}

// Clear redoStack after recorded action
redoStack.splice(0);

if (previous) {

if (item) {
skipOnce = true;
patchState(store, item);
previous = item;
}

updateInternal();
},
redo(): void {
const item = redoStack.pop();

if (item && previous) {
undoStack.push(previous);
}

if (redoStack.length > normalized.maxStackSize) {
undoStack.unshift();

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());
})
}
})

);

previous = cand;

// Don't propogate current reactive context
untracked(() => updateInternal());
})
}
})

)
return feature(store);
}
}
Loading