valtio-history 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "valtio-history",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Daishi Kato",
   "repository": {
     "type": "git",

package/src/index.d.ts

@@ -1 +1,232 @@
-export * from './history-utility';
+import type { INTERNAL_Snapshot as Snapshot } from 'valtio/vanilla';
+export type HistoryNode<T> = {
+    /**
+     * The snapshot being tracked
+     */
+    snapshot: Snapshot<T>;
+    /**
+     * The date when the node was created
+     */
+    createdAt: Date;
+    /**
+     * The date when the node was updated. Will be undefined if
+     * the node was never updated.
+     */
+    updatedAt?: Date;
+};
+export type History<T> = {
+    /**
+     * field for holding sandbox changes; used to avoid infinite loops
+     */
+    wip?: Snapshot<T>;
+    /**
+     * the nodes of the history for each change
+     */
+    nodes: HistoryNode<T>[];
+    /**
+     * the history index of the current snapshot
+     */
+    index: number;
+};
+export type HistoryOptions = {
+    /**
+     * determines if the internal subscribe behaviour should be skipped.
+     */
+    skipSubscribe?: boolean;
+};
+/**
+ * This creates a new proxy with history support (ProxyHistoryObject).
+ * It includes following main properties:<br>
+ * - value: any value (does not have to be an object)<br>
+ * - history: an object holding the history of snapshots and other metadata<br>
+ *   - history.index: the history index of the current snapshot<br>
+ *   - history.nodes: the nodes of the history for each change<br>
+ *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
+ * - canUndo: a function to return true if undo is available <br>
+ * - undo: a function to go back history <br>
+ * - canRedo: a function to return true if redo is available <br>
+ * - redo: a function to go forward history <br>
+ * - saveHistory: a function to save history <br>
+ * - getCurrentChangeDate: gets the date of the current change <br>
+ * - remove: a function to remove a specified history index <br>
+ * - replace: a function to replace a snapshot at a specified history index <br>
+ * - getNode: a function to get the node at a specified history index <br>
+ *
+ * <br>
+ * Notes: <br>
+ * - Suspense/promise is not supported. <br>
+ *
+ * @param initialValue - any value to be tracked
+ * @param options - use to configure the proxyWithHistory utility.
+ * @returns  proxyObject
+ *
+ * @example
+ * import { proxyWithHistory } from 'valtio-history'
+ * const state = proxyWithHistory({
+ *   count: 1,
+ * })
+ */
+export declare function proxyWithHistory<V>(initialValue: V, options?: HistoryOptions | boolean): {
+    /**
+     * any value to be tracked (does not have to be an object)
+     */
+    value: V;
+    /**
+     * an object holding the history of snapshots and other metadata <br>
+     *   - history.index: the history index to the current snapshot <br>
+     *   - history.nodes: the nodes of the history for each change <br>
+     *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
+     */
+    history: History<V> & {
+        $$valtioRef: true;
+    };
+    /**
+     * get the date when a node was entered into history.
+     *
+     * @deprecated @see {@link https://github.com/valtiojs/valtio-history/issues/10}
+     * @returns date
+     */
+    getCurrentChangeDate: () => Date | undefined;
+    /**
+     * get the date when a node was entered into history.
+     *
+     * @returns date
+     */
+    readonly currentChangeDate: Date | undefined;
+    /**
+     * the current history node index.
+     *
+     * @returns number
+     */
+    readonly currentIndex: number;
+    /**the total number of the history nodes.
+     *
+     * @returns number
+     */
+    readonly historyNodeCount: number;
+    /**
+     * utility method to get a history node.
+     * The snapshot within this node is already cloned and
+     * will not affect the original value if updated.
+     *
+     * @param index
+     * @returns historyNode
+     */
+    getNode: (index: number) => {
+        snapshot: V extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? V : V extends Promise<unknown> ? Awaited<V> : V extends object ? { readonly [K in keyof V]: V[K] extends infer T ? T extends V[K] ? T extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T : T extends Promise<unknown> ? Awaited<T> : T extends object ? { readonly [K_1 in keyof T]: T[K_1] extends infer T_1 ? T_1 extends T[K_1] ? T_1 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_1 : T_1 extends Promise<unknown> ? Awaited<T_1> : T_1 extends object ? { readonly [K_2 in keyof T_1]: T_1[K_2] extends infer T_2 ? T_2 extends T_1[K_2] ? T_2 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_2 : T_2 extends Promise<unknown> ? Awaited<T_2> : T_2 extends object ? { readonly [K_3 in keyof T_2]: T_2[K_3] extends infer T_3 ? T_3 extends T_2[K_3] ? T_3 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_3 : T_3 extends Promise<unknown> ? Awaited<T_3> : T_3 extends object ? { readonly [K_4 in keyof T_3]: T_3[K_4] extends infer T_4 ? T_4 extends T_3[K_4] ? T_4 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_4 : T_4 extends Promise<unknown> ? Awaited<T_4> : T_4 extends object ? { readonly [K_5 in keyof T_4]: T_4[K_5] extends infer T_5 ? T_5 extends T_4[K_5] ? T_5 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_5 : T_5 extends Promise<unknown> ? Awaited<T_5> : T_5 extends object ? { readonly [K_6 in keyof T_5]: T_5[K_6] extends infer T_6 ? T_6 extends T_5[K_6] ? T_6 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_6 : T_6 extends Promise<unknown> ? Awaited<T_6> : T_6 extends object ? { readonly [K_7 in keyof T_6]: T_6[K_7] extends infer T_7 ? T_7 extends T_6[K_7] ? T_7 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_7 : T_7 extends Promise<unknown> ? Awaited<T_7> : T_7 extends object ? { readonly [K_8 in keyof T_7]: T_7[K_8] extends infer T_8 ? T_8 extends T_7[K_8] ? T_8 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_8 : T_8 extends Promise<unknown> ? Awaited<T_8> : T_8 extends object ? { readonly [K_9 in keyof T_8]: T_8[K_9] extends infer T_9 ? T_9 extends T_8[K_9] ? T_9 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
+            $$valtioRef: true;
+        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_9 : T_9 extends Promise<unknown> ? Awaited<T_9> : T_9 extends object ? { readonly [K_10 in keyof T_9]: any; } : T_9 : never : never; } : T_8 : never : never; } : T_7 : never : never; } : T_6 : never : never; } : T_5 : never : never; } : T_4 : never : never; } : T_3 : never : never; } : T_2 : never : never; } : T_1 : never : never; } : T : never : never; } : V;
+        /**
+         * The date when the node was created
+         */
+        createdAt: Date;
+        /**
+         * The date when the node was updated. Will be undefined if
+         * the node was never updated.
+         */
+        updatedAt?: Date | undefined;
+    } | undefined;
+    /**
+     * utility to clone a snapshot
+     */
+    clone: <T_10>(value: T_10) => T_10;
+    /**
+     * a function to go to a specific index in history
+     */
+    goTo: (index: number) => void;
+    /**
+     * a getter to return true if undo is available
+     * @returns boolean
+     */
+    readonly isUndoEnabled: boolean;
+    /**
+     * a getter to return true if redo is available
+     * @returns boolean
+     */
+    readonly isRedoEnabled: boolean;
+    /**
+     * a function to return true if undo is available
+     *
+     * @deprecated @see {@link https://github.com/valtiojs/valtio-history/issues/10}
+     * @returns boolean
+     */
+    canUndo: () => boolean;
+    /**
+     * a function to go back in history
+     */
+    undo: () => void;
+    /**
+     * a function to return true if redo is available
+     *
+     * @deprecated @see {@link https://github.com/valtiojs/valtio-history/issues/10}
+     * @returns boolean
+     */
+    canRedo: () => boolean;
+    /**
+     * a function to go forward in history
+     */
+    redo: () => void;
+    /**
+     * a function to execute saving history when changes are made to `value`
+     */
+    saveHistory: () => void;
+    /**
+     * a function that returns true when the history should be updated
+     *
+     * @param ops - subscribeOps from subscribe callback
+     * @returns boolean
+     */
+    shouldSaveHistory: (ops: ([op: "set", path: (string | symbol)[], value: unknown, prevValue: unknown] | [op: "delete", path: (string | symbol)[], prevValue: unknown] | [op: "resolve", path: (string | symbol)[], value: unknown] | [op: "reject", path: (string | symbol)[], error: unknown])[]) => boolean;
+    /**
+     * a function to subscribe to changes made to `value`
+     */
+    subscribe: () => () => void;
+    /**
+     * The remove method is only invoked when there are
+     * more than one nodes and when a valid index is provided.
+     * If the current index is removed,
+     * An index greater than the current index will be preferred as the next
+     * value.
+     *
+     * @param index - index of the node to remove
+     * @returns removedNode
+     */
+    remove: (index: number) => HistoryNode<V> | undefined;
+    /**
+     * utility to replace a value in history. The history
+     * changes will not be affected, only the value to be replaced.
+     * If a base value is needed to operate on,
+     * the `getNode` utility can be used to retrieve
+     * a cloned historyNode.
+     *
+     * <br> <br>
+     * Notes: <br>
+     * - No operations are done on the value provided to this utility. <br>
+     * - This is an advanced method, please ensure the value provided
+     *   is a snapshot of the same type of the value being tracked. <br>
+     *
+     * @param index - index to replace value for
+     * @param value - the updated snapshot to be stored at the index
+     */
+    replace: (index: number, value: Snapshot<V>) => void;
+};

package/src/index.js

@@ -1,2 +1,295 @@
-export * from './history-utility';
+import { unstable_buildProxyFunction as buildProxyFunction, proxy, ref, snapshot, subscribe, } from 'valtio/vanilla';
+const isObject = (value) => !!value && typeof value === 'object';
+let refSet;
+const deepClone = (value) => {
+    if (!refSet) {
+        refSet = buildProxyFunction()[2];
+    }
+    if (!isObject(value) || refSet.has(value)) {
+        return value;
+    }
+    const baseObject = Array.isArray(value)
+        ? []
+        : Object.create(Object.getPrototypeOf(value));
+    Reflect.ownKeys(value).forEach((key) => {
+        baseObject[key] = deepClone(value[key]);
+    });
+    return baseObject;
+};
+const normalizeOptions = (options) => {
+    if (typeof options === 'boolean') {
+        if (import.meta.env?.MODE !== 'production') {
+            console.warn(`The second parameter of 'proxyWithHistory' as boolean is deprecated and support for boolean will be removed
+      in the next major version. Please use the object syntax instead:
+  
+      { skipSubscribe: boolean }
+      `);
+        }
+        return { skipSubscribe: options };
+    }
+    const defaultOptions = {
+        skipSubscribe: false,
+    };
+    if (!options)
+        return defaultOptions;
+    return {
+        ...defaultOptions,
+        ...options,
+    };
+};
+/**
+ * This creates a new proxy with history support (ProxyHistoryObject).
+ * It includes following main properties:<br>
+ * - value: any value (does not have to be an object)<br>
+ * - history: an object holding the history of snapshots and other metadata<br>
+ *   - history.index: the history index of the current snapshot<br>
+ *   - history.nodes: the nodes of the history for each change<br>
+ *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
+ * - canUndo: a function to return true if undo is available <br>
+ * - undo: a function to go back history <br>
+ * - canRedo: a function to return true if redo is available <br>
+ * - redo: a function to go forward history <br>
+ * - saveHistory: a function to save history <br>
+ * - getCurrentChangeDate: gets the date of the current change <br>
+ * - remove: a function to remove a specified history index <br>
+ * - replace: a function to replace a snapshot at a specified history index <br>
+ * - getNode: a function to get the node at a specified history index <br>
+ *
+ * <br>
+ * Notes: <br>
+ * - Suspense/promise is not supported. <br>
+ *
+ * @param initialValue - any value to be tracked
+ * @param options - use to configure the proxyWithHistory utility.
+ * @returns  proxyObject
+ *
+ * @example
+ * import { proxyWithHistory } from 'valtio-history'
+ * const state = proxyWithHistory({
+ *   count: 1,
+ * })
+ */
+export function proxyWithHistory(initialValue, options) {
+    const utilOptions = normalizeOptions(options);
+    const proxyObject = proxy({
+        /**
+         * any value to be tracked (does not have to be an object)
+         */
+        value: initialValue,
+        /**
+         * an object holding the history of snapshots and other metadata <br>
+         *   - history.index: the history index to the current snapshot <br>
+         *   - history.nodes: the nodes of the history for each change <br>
+         *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
+         */
+        history: ref({
+            wip: undefined,
+            nodes: [],
+            index: -1,
+        }),
+        /**
+         * get the date when a node was entered into history.
+         *
+         * @deprecated @see {@link https://github.com/valtiojs/valtio-history/issues/10}
+         * @returns date
+         */
+        getCurrentChangeDate: () => {
+            const node = proxyObject.history.nodes[proxyObject.history.index];
+            return node?.createdAt;
+        },
+        /**
+         * get the date when a node was entered into history.
+         *
+         * @returns date
+         */
+        get currentChangeDate() {
+            const node = this.history.nodes[this.history.index];
+            return node?.createdAt;
+        },
+        /**
+         * the current history node index.
+         *
+         * @returns number
+         */
+        get currentIndex() {
+            return this.history.index;
+        },
+        /**the total number of the history nodes.
+         *
+         * @returns number
+         */
+        get historyNodeCount() {
+            return this.history.nodes.length;
+        },
+        /**
+         * utility method to get a history node.
+         * The snapshot within this node is already cloned and
+         * will not affect the original value if updated.
+         *
+         * @param index
+         * @returns historyNode
+         */
+        getNode: (index) => {
+            const node = proxyObject.history.nodes[index];
+            return node
+                ? { ...node, snapshot: proxyObject.clone(node.snapshot) }
+                : undefined;
+        },
+        /**
+         * utility to clone a snapshot
+         */
+        clone: deepClone,
+        /**
+         * a function to go to a specific index in history
+         */
+        goTo: (index) => {
+            const node = proxyObject.history.nodes[index];
+            if (!node)
+                return;
+            proxyObject.history.wip = proxyObject.clone(node.snapshot);
+            proxyObject.value = proxyObject.history.wip;
+            proxyObject.history.index = index;
+        },
+        /**
+         * a getter to return true if undo is available
+         * @returns boolean
+         */
+        get isUndoEnabled() {
+            return this.history.index > 0;
+        },
+        /**
+         * a getter to return true if redo is available
+         * @returns boolean
+         */
+        get isRedoEnabled() {
+            return this.history.index < this.history.nodes.length - 1;
+        },
+        /**
+         * a function to return true if undo is available
+         *
+         * @deprecated @see {@link https://github.com/valtiojs/valtio-history/issues/10}
+         * @returns boolean
+         */
+        canUndo: () => proxyObject.history.index > 0,
+        /**
+         * a function to go back in history
+         */
+        undo: () => {
+            if (proxyObject.canUndo()) {
+                proxyObject.history.wip = proxyObject.clone(proxyObject.history.nodes[--proxyObject.history.index]?.snapshot);
+                proxyObject.value = proxyObject.history.wip;
+            }
+        },
+        /**
+         * a function to return true if redo is available
+         *
+         * @deprecated @see {@link https://github.com/valtiojs/valtio-history/issues/10}
+         * @returns boolean
+         */
+        canRedo: () => proxyObject.history.index < proxyObject.history.nodes.length - 1,
+        /**
+         * a function to go forward in history
+         */
+        redo: () => {
+            if (proxyObject.canRedo()) {
+                proxyObject.history.wip = proxyObject.clone(proxyObject.history.nodes[++proxyObject.history.index]?.snapshot);
+                proxyObject.value = proxyObject.history.wip;
+            }
+        },
+        /**
+         * a function to execute saving history when changes are made to `value`
+         */
+        saveHistory: () => {
+            proxyObject.history.nodes.splice(proxyObject.history.index + 1);
+            proxyObject.history.nodes.push({
+                createdAt: new Date(),
+                snapshot: snapshot(proxyObject).value,
+            });
+            ++proxyObject.history.index;
+        },
+        /**
+         * a function that returns true when the history should be updated
+         *
+         * @param ops - subscribeOps from subscribe callback
+         * @returns boolean
+         */
+        shouldSaveHistory: (ops) => ops.every((op) => op[1][0] === 'value' &&
+            (op[0] !== 'set' || op[2] !== proxyObject.history.wip)),
+        /**
+         * a function to subscribe to changes made to `value`
+         */
+        subscribe: () => subscribe(proxyObject, (ops) => {
+            if (proxyObject.shouldSaveHistory(ops))
+                proxyObject.saveHistory();
+        }),
+        // history rewrite utilities
+        /**
+         * The remove method is only invoked when there are
+         * more than one nodes and when a valid index is provided.
+         * If the current index is removed,
+         * An index greater than the current index will be preferred as the next
+         * value.
+         *
+         * @param index - index of the node to remove
+         * @returns removedNode
+         */
+        remove: (index) => {
+            const node = proxyObject.history.nodes[index];
+            const isCurrentIndex = proxyObject.history.index === index;
+            const lastIndex = proxyObject.history.nodes.length - 1;
+            const isLastIndex = lastIndex === index;
+            if (!node || proxyObject.history.nodes.length < 2)
+                return;
+            if (isCurrentIndex) {
+                const resolvedIndex = isLastIndex ? index - 1 : index + 1;
+                const resolvedNode = proxyObject.history.nodes[resolvedIndex];
+                proxyObject.history.wip = proxyObject.clone(resolvedNode?.snapshot);
+                proxyObject.value = proxyObject.history.wip;
+                if (isLastIndex)
+                    proxyObject.history.index--;
+            }
+            proxyObject.history.nodes.splice(index, 1);
+            if (!isCurrentIndex && proxyObject.history.index > index) {
+                proxyObject.history.index--;
+            }
+            return node;
+        },
+        /**
+         * utility to replace a value in history. The history
+         * changes will not be affected, only the value to be replaced.
+         * If a base value is needed to operate on,
+         * the `getNode` utility can be used to retrieve
+         * a cloned historyNode.
+         *
+         * <br> <br>
+         * Notes: <br>
+         * - No operations are done on the value provided to this utility. <br>
+         * - This is an advanced method, please ensure the value provided
+         *   is a snapshot of the same type of the value being tracked. <br>
+         *
+         * @param index - index to replace value for
+         * @param value - the updated snapshot to be stored at the index
+         */
+        replace: (index, value) => {
+            const node = proxyObject.history.nodes[index];
+            const isCurrentIndex = proxyObject.history.index === index;
+            if (!node)
+                return;
+            proxyObject.history.nodes[index] = {
+                ...node,
+                snapshot: value,
+                updatedAt: new Date(),
+            };
+            if (isCurrentIndex) {
+                proxyObject.history.wip = value;
+                proxyObject.value = proxyObject.history.wip;
+            }
+        },
+    });
+    proxyObject.saveHistory();
+    if (!utilOptions.skipSubscribe) {
+        proxyObject.subscribe();
+    }
+    return proxyObject;
+}
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/history-utility/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/history-utility/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,IAAI,kBAAkB,EACjD,KAAK,EACL,GAAG,EACH,QAAQ,EACR,SAAS,GACV,MAAM,gBAAgB,CAAC;AA2CxB,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CACnD,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAEvC,IAAI,MAAmC,CAAC;AAExC,MAAM,SAAS,GAAG,CAAI,KAAQ,EAAK,EAAE;IACnC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAC;KAClC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACzC,OAAO,KAAK,CAAC;KACd;IACD,MAAM,UAAU,GAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACxC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACrC,UAAU,CAAC,GAAc,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAc,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,OAAkC,EAClB,EAAE;IAClB,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;QAChC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,KAAK,YAAY,EAAE;YAC1C,OAAO,CAAC,IAAI,CAAC;;;;OAIZ,CAAC,CAAC;SACJ;QACD,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;KACnC;IAED,MAAM,cAAc,GAAG;QACrB,aAAa,EAAE,KAAK;KACrB,CAAC;IAEF,IAAI,CAAC,OAAO;QAAE,OAAO,cAAc,CAAC;IAEpC,OAAO;QACL,GAAG,cAAc;QACjB,GAAG,OAAO;KACX,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,gBAAgB,CAC9B,YAAe,EACf,OAAkC;IAElC,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,KAAK,CAAC;QACxB;;WAEG;QACH,KAAK,EAAE,YAAY;QACnB;;;;;WAKG;QACH,OAAO,EAAE,GAAG,CAAa;YACvB,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC,CAAC;SACV,CAAC;QACF;;;;;WAKG;QACH,oBAAoB,EAAE,GAAG,EAAE;YACzB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClE,OAAO,IAAI,EAAE,SAAS,CAAC;QACzB,CAAC;QACD;;;;WAIG;QACH,IAAI,iBAAiB;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACpD,OAAO,IAAI,EAAE,SAAS,CAAC;QACzB,CAAC;QACD;;;;WAIG;QACH,IAAI,YAAY;YACd,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAC5B,CAAC;QACD;;;WAGG;QACH,IAAI,gBAAgB;YAClB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;QACnC,CAAC;QACD;;;;;;;WAOG;QACH,OAAO,EAAE,CAAC,KAAa,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,OAAO,IAAI;gBACT,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACzD,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;QACD;;WAEG;QACH,KAAK,EAAE,SAAS;QAChB;;WAEG;QACH,IAAI,EAAE,CAAC,KAAa,EAAE,EAAE;YACtB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAE9C,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3D,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;YACjD,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;QACpC,CAAC;QACD;;;WAGG;QACH,IAAI,aAAa;YACf,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;QAChC,CAAC;QACD;;;WAGG;QACH,IAAI,aAAa;YACf,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5D,CAAC;QACD;;;;;WAKG;QACH,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC;QAC5C;;WAEG;QACH,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;gBACzB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CACzC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CACjE,CAAC;gBACF,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;aAClD;QACH,CAAC;QACD;;;;;WAKG;QACH,OAAO,EAAE,GAAG,EAAE,CACZ,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAClE;;WAEG;QACH,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;gBACzB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CACzC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CACjE,CAAC;gBACF,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;aAClD;QACH,CAAC;QACD;;WAEG;QACH,WAAW,EAAE,GAAG,EAAE;YAChB,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YAChE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,QAAQ,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK;aACtC,CAAC,CAAC;YACH,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9B,CAAC;QACD;;;;;WAKG;QACH,iBAAiB,EAAE,CAAC,GAAiB,EAAE,EAAE,CACvC,GAAG,CAAC,KAAK,CACP,CAAC,EAAE,EAAE,EAAE,CACL,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO;YACpB,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CACzD;QACH;;WAEG;QACH,SAAS,EAAE,GAAG,EAAE,CACd,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;YAC7B,IAAI,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC;gBAAE,WAAW,CAAC,WAAW,EAAE,CAAC;QACpE,CAAC,CAAC;QAEJ,4BAA4B;QAE5B;;;;;;;;;WASG;QACH,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACxB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;YAC3D,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,SAAS,KAAK,KAAK,CAAC;YAExC,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO;YAE1D,IAAI,cAAc,EAAE;gBAClB,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;gBAC1D,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAE9D,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;gBACpE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;gBAEjD,IAAI,WAAW;oBAAE,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aAC9C;YAED,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAE3C,IAAI,CAAC,cAAc,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,EAAE;gBACxD,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aAC7B;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;;;;;;;;;;;;;WAeG;QACH,OAAO,EAAE,CAAC,KAAa,EAAE,KAAkB,EAAE,EAAE;YAC7C,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;YAE3D,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG;gBACjC,GAAG,IAAI;gBACP,QAAQ,EAAE,KAAK;gBACf,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,CAAC;YAEF,IAAI,cAAc,EAAE;gBAClB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC;gBAChC,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;aAClD;QACH,CAAC;KACF,CAAC,CAAC;IAEH,WAAW,CAAC,WAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;QAC9B,WAAW,CAAC,SAAS,EAAE,CAAC;KACzB;IAED,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/src/history-utility.d.ts

@@ -1,200 +0,0 @@
-import type { INTERNAL_Snapshot as Snapshot } from 'valtio/vanilla';
-export type HistoryNode<T> = {
-    /**
-     * The snapshot being tracked
-     */
-    snapshot: Snapshot<T>;
-    /**
-     * The date when the node was created
-     */
-    createdAt: Date;
-    /**
-     * The date when the node was updated. Will be undefined if
-     * the node was never updated.
-     */
-    updatedAt?: Date;
-};
-export type History<T> = {
-    /**
-     * field for holding sandbox changes; used to avoid infinite loops
-     */
-    wip?: Snapshot<T>;
-    /**
-     * the nodes of the history for each change
-     */
-    nodes: HistoryNode<T>[];
-    /**
-     * the history index of the current snapshot
-     */
-    index: number;
-};
-export type HistoryOptions = {
-    /**
-     * determines if the internal subscribe behaviour should be skipped.
-     */
-    skipSubscribe?: boolean;
-};
-/**
- * This creates a new proxy with history support (ProxyHistoryObject).
- * It includes following main properties:<br>
- * - value: any value (does not have to be an object)<br>
- * - history: an object holding the history of snapshots and other metadata<br>
- *   - history.index: the history index of the current snapshot<br>
- *   - history.nodes: the nodes of the history for each change<br>
- *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
- * - canUndo: a function to return true if undo is available <br>
- * - undo: a function to go back history <br>
- * - canRedo: a function to return true if redo is available <br>
- * - redo: a function to go forward history <br>
- * - saveHistory: a function to save history <br>
- * - getCurrentChangeDate: gets the date of the current change <br>
- * - remove: a function to remove a specified history index <br>
- * - replace: a function to replace a snapshot at a specified history index <br>
- * - getNode: a function to get the node at a specified history index <br>
- *
- * <br>
- * Notes: <br>
- * - Suspense/promise is not supported. <br>
- *
- * @param initialValue - any value to be tracked
- * @param options - use to configure the proxyWithHistory utility.
- * @returns  proxyObject
- *
- * @example
- * import { proxyWithHistory } from 'valtio-history'
- * const state = proxyWithHistory({
- *   count: 1,
- * })
- */
-export declare function proxyWithHistory<V>(initialValue: V, options?: HistoryOptions | boolean): {
-    /**
-     * any value to be tracked (does not have to be an object)
-     */
-    value: V;
-    /**
-     * an object holding the history of snapshots and other metadata <br>
-     *   - history.index: the history index to the current snapshot <br>
-     *   - history.nodes: the nodes of the history for each change <br>
-     *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
-     */
-    history: History<V> & {
-        $$valtioRef: true;
-    };
-    /**
-     * get the date when a node was entered into history.
-     *
-     * @returns date
-     */
-    getCurrentChangeDate: () => Date | undefined;
-    /**
-     * utility method to get a history node.
-     * The snapshot within this node is already cloned and
-     * will not affect the original value if updated.
-     *
-     * @param index
-     * @returns historyNode
-     */
-    getNode: (index: number) => {
-        snapshot: V extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? V : V extends Promise<unknown> ? Awaited<V> : V extends object ? { readonly [K in keyof V]: V[K] extends infer T ? T extends V[K] ? T extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T : T extends Promise<unknown> ? Awaited<T> : T extends object ? { readonly [K_1 in keyof T]: T[K_1] extends infer T_1 ? T_1 extends T[K_1] ? T_1 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_1 : T_1 extends Promise<unknown> ? Awaited<T_1> : T_1 extends object ? { readonly [K_2 in keyof T_1]: T_1[K_2] extends infer T_2 ? T_2 extends T_1[K_2] ? T_2 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_2 : T_2 extends Promise<unknown> ? Awaited<T_2> : T_2 extends object ? { readonly [K_3 in keyof T_2]: T_2[K_3] extends infer T_3 ? T_3 extends T_2[K_3] ? T_3 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_3 : T_3 extends Promise<unknown> ? Awaited<T_3> : T_3 extends object ? { readonly [K_4 in keyof T_3]: T_3[K_4] extends infer T_4 ? T_4 extends T_3[K_4] ? T_4 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_4 : T_4 extends Promise<unknown> ? Awaited<T_4> : T_4 extends object ? { readonly [K_5 in keyof T_4]: T_4[K_5] extends infer T_5 ? T_5 extends T_4[K_5] ? T_5 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_5 : T_5 extends Promise<unknown> ? Awaited<T_5> : T_5 extends object ? { readonly [K_6 in keyof T_5]: T_5[K_6] extends infer T_6 ? T_6 extends T_5[K_6] ? T_6 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_6 : T_6 extends Promise<unknown> ? Awaited<T_6> : T_6 extends object ? { readonly [K_7 in keyof T_6]: T_6[K_7] extends infer T_7 ? T_7 extends T_6[K_7] ? T_7 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_7 : T_7 extends Promise<unknown> ? Awaited<T_7> : T_7 extends object ? { readonly [K_8 in keyof T_7]: T_7[K_8] extends infer T_8 ? T_8 extends T_7[K_8] ? T_8 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_8 : T_8 extends Promise<unknown> ? Awaited<T_8> : T_8 extends object ? { readonly [K_9 in keyof T_8]: T_8[K_9] extends infer T_9 ? T_9 extends T_8[K_9] ? T_9 extends RegExp | Date | Map<any, any> | Set<any> | WeakMap<any, any> | WeakSet<any> | {
-            $$valtioRef: true;
-        } | Error | ((...args: any[]) => any) | (string | number | bigint | boolean | symbol | null | undefined) ? T_9 : T_9 extends Promise<unknown> ? Awaited<T_9> : T_9 extends object ? { readonly [K_10 in keyof T_9]: any; } : T_9 : never : never; } : T_8 : never : never; } : T_7 : never : never; } : T_6 : never : never; } : T_5 : never : never; } : T_4 : never : never; } : T_3 : never : never; } : T_2 : never : never; } : T_1 : never : never; } : T : never : never; } : V;
-        /**
-         * The date when the node was created
-         */
-        createdAt: Date;
-        /**
-         * The date when the node was updated. Will be undefined if
-         * the node was never updated.
-         */
-        updatedAt?: Date | undefined;
-    } | undefined;
-    /**
-     * utility to clone a snapshot
-     */
-    clone: <T_10>(value: T_10) => T_10;
-    /**
-     * a function to go to a specific index in history
-     */
-    goTo: (index: number) => void;
-    /**
-     * a function to return true if undo is available
-     * @returns boolean
-     */
-    canUndo: () => boolean;
-    /**
-     * a function to go back in history
-     */
-    undo: () => void;
-    /**
-     * a function to return true if redo is available
-     * @returns boolean
-     */
-    canRedo: () => boolean;
-    /**
-     * a function to go forward in history
-     */
-    redo: () => void;
-    /**
-     * a function to execute saving history when changes are made to `value`
-     */
-    saveHistory: () => void;
-    /**
-     * a function that returns true when the history should be updated
-     *
-     * @param ops - subscribeOps from subscribe callback
-     * @returns boolean
-     */
-    shouldSaveHistory: (ops: ([op: "set", path: (string | symbol)[], value: unknown, prevValue: unknown] | [op: "delete", path: (string | symbol)[], prevValue: unknown] | [op: "resolve", path: (string | symbol)[], value: unknown] | [op: "reject", path: (string | symbol)[], error: unknown])[]) => boolean;
-    /**
-     * a function to subscribe to changes made to `value`
-     */
-    subscribe: () => () => void;
-    /**
-     * The remove method is only invoked when there are
-     * more than one nodes and when a valid index is provided.
-     * If the current index is removed,
-     * An index greater than the current index will be preferred as the next
-     * value.
-     *
-     * @param index - index of the node to remove
-     * @returns removedNode
-     */
-    remove: (index: number) => HistoryNode<V> | undefined;
-    /**
-     * utility to replace a value in history. The history
-     * changes will not be affected, only the value to be replaced.
-     * If a base value is needed to operate on,
-     * the `getNode` utility can be used to retrieve
-     * a cloned historyNode.
-     *
-     * <br> <br>
-     * Notes: <br>
-     * - No operations are done on the value provided to this utility. <br>
-     * - This is an advanced method, please ensure the value provided
-     *   is a snapshot of the same type of the value being tracked. <br>
-     *
-     * @param index - index to replace value for
-     * @param value - the updated snapshot to be stored at the index
-     */
-    replace: (index: number, value: Snapshot<V>) => void;
-};

package/src/history-utility.js

@@ -1,252 +0,0 @@
-import { unstable_buildProxyFunction as buildProxyFunction, proxy, ref, snapshot, subscribe, } from 'valtio/vanilla';
-const isObject = (value) => !!value && typeof value === 'object';
-let refSet;
-const deepClone = (value) => {
-    if (!refSet) {
-        refSet = buildProxyFunction()[2];
-    }
-    if (!isObject(value) || refSet.has(value)) {
-        return value;
-    }
-    const baseObject = Array.isArray(value)
-        ? []
-        : Object.create(Object.getPrototypeOf(value));
-    Reflect.ownKeys(value).forEach((key) => {
-        baseObject[key] = deepClone(value[key]);
-    });
-    return baseObject;
-};
-const normalizeOptions = (options) => {
-    if (typeof options === 'boolean') {
-        if (import.meta.env?.MODE !== 'production') {
-            console.warn(`The second parameter of 'proxyWithHistory' as boolean is deprecated and support for boolean will be removed
-    in the next major version. Please use the object syntax instead:
-
-    { skipSubscribe: boolean }
-    `);
-        }
-        return { skipSubscribe: options };
-    }
-    const defaultOptions = {
-        skipSubscribe: false,
-    };
-    if (!options)
-        return defaultOptions;
-    return {
-        ...defaultOptions,
-        ...options,
-    };
-};
-/**
- * This creates a new proxy with history support (ProxyHistoryObject).
- * It includes following main properties:<br>
- * - value: any value (does not have to be an object)<br>
- * - history: an object holding the history of snapshots and other metadata<br>
- *   - history.index: the history index of the current snapshot<br>
- *   - history.nodes: the nodes of the history for each change<br>
- *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
- * - canUndo: a function to return true if undo is available <br>
- * - undo: a function to go back history <br>
- * - canRedo: a function to return true if redo is available <br>
- * - redo: a function to go forward history <br>
- * - saveHistory: a function to save history <br>
- * - getCurrentChangeDate: gets the date of the current change <br>
- * - remove: a function to remove a specified history index <br>
- * - replace: a function to replace a snapshot at a specified history index <br>
- * - getNode: a function to get the node at a specified history index <br>
- *
- * <br>
- * Notes: <br>
- * - Suspense/promise is not supported. <br>
- *
- * @param initialValue - any value to be tracked
- * @param options - use to configure the proxyWithHistory utility.
- * @returns  proxyObject
- *
- * @example
- * import { proxyWithHistory } from 'valtio-history'
- * const state = proxyWithHistory({
- *   count: 1,
- * })
- */
-export function proxyWithHistory(initialValue, options) {
-    const utilOptions = normalizeOptions(options);
-    const proxyObject = proxy({
-        /**
-         * any value to be tracked (does not have to be an object)
-         */
-        value: initialValue,
-        /**
-         * an object holding the history of snapshots and other metadata <br>
-         *   - history.index: the history index to the current snapshot <br>
-         *   - history.nodes: the nodes of the history for each change <br>
-         *   - history.wip: field for holding sandbox changes; used to avoid infinite loops<br>
-         */
-        history: ref({
-            wip: undefined,
-            nodes: [],
-            index: -1,
-        }),
-        /**
-         * get the date when a node was entered into history.
-         *
-         * @returns date
-         */
-        getCurrentChangeDate: () => {
-            const node = proxyObject.history.nodes[proxyObject.history.index];
-            return node?.createdAt;
-        },
-        /**
-         * utility method to get a history node.
-         * The snapshot within this node is already cloned and
-         * will not affect the original value if updated.
-         *
-         * @param index
-         * @returns historyNode
-         */
-        getNode: (index) => {
-            const node = proxyObject.history.nodes[index];
-            return node
-                ? { ...node, snapshot: proxyObject.clone(node.snapshot) }
-                : undefined;
-        },
-        /**
-         * utility to clone a snapshot
-         */
-        clone: deepClone,
-        /**
-         * a function to go to a specific index in history
-         */
-        goTo: (index) => {
-            const node = proxyObject.history.nodes[index];
-            if (!node)
-                return;
-            proxyObject.history.wip = proxyObject.clone(node.snapshot);
-            proxyObject.value = proxyObject.history.wip;
-            proxyObject.history.index = index;
-        },
-        /**
-         * a function to return true if undo is available
-         * @returns boolean
-         */
-        canUndo: () => proxyObject.history.index > 0,
-        /**
-         * a function to go back in history
-         */
-        undo: () => {
-            if (proxyObject.canUndo()) {
-                proxyObject.history.wip = proxyObject.clone(proxyObject.history.nodes[--proxyObject.history.index]?.snapshot);
-                proxyObject.value = proxyObject.history.wip;
-            }
-        },
-        /**
-         * a function to return true if redo is available
-         * @returns boolean
-         */
-        canRedo: () => proxyObject.history.index < proxyObject.history.nodes.length - 1,
-        /**
-         * a function to go forward in history
-         */
-        redo: () => {
-            if (proxyObject.canRedo()) {
-                proxyObject.history.wip = proxyObject.clone(proxyObject.history.nodes[++proxyObject.history.index]?.snapshot);
-                proxyObject.value = proxyObject.history.wip;
-            }
-        },
-        /**
-         * a function to execute saving history when changes are made to `value`
-         */
-        saveHistory: () => {
-            proxyObject.history.nodes.splice(proxyObject.history.index + 1);
-            proxyObject.history.nodes.push({
-                createdAt: new Date(),
-                snapshot: snapshot(proxyObject).value,
-            });
-            ++proxyObject.history.index;
-        },
-        /**
-         * a function that returns true when the history should be updated
-         *
-         * @param ops - subscribeOps from subscribe callback
-         * @returns boolean
-         */
-        shouldSaveHistory: (ops) => ops.every((op) => op[1][0] === 'value' &&
-            (op[0] !== 'set' || op[2] !== proxyObject.history.wip)),
-        /**
-         * a function to subscribe to changes made to `value`
-         */
-        subscribe: () => subscribe(proxyObject, (ops) => {
-            if (proxyObject.shouldSaveHistory(ops))
-                proxyObject.saveHistory();
-        }),
-        // history rewrite utilities
-        /**
-         * The remove method is only invoked when there are
-         * more than one nodes and when a valid index is provided.
-         * If the current index is removed,
-         * An index greater than the current index will be preferred as the next
-         * value.
-         *
-         * @param index - index of the node to remove
-         * @returns removedNode
-         */
-        remove: (index) => {
-            const node = proxyObject.history.nodes[index];
-            const isCurrentIndex = proxyObject.history.index === index;
-            const lastIndex = proxyObject.history.nodes.length - 1;
-            const isLastIndex = lastIndex === index;
-            if (!node || proxyObject.history.nodes.length < 2)
-                return;
-            if (isCurrentIndex) {
-                const resolvedIndex = isLastIndex ? index - 1 : index + 1;
-                const resolvedNode = proxyObject.history.nodes[resolvedIndex];
-                proxyObject.history.wip = proxyObject.clone(resolvedNode?.snapshot);
-                proxyObject.value = proxyObject.history.wip;
-                if (isLastIndex)
-                    proxyObject.history.index--;
-            }
-            proxyObject.history.nodes.splice(index, 1);
-            if (!isCurrentIndex && proxyObject.history.index > index) {
-                proxyObject.history.index--;
-            }
-            return node;
-        },
-        /**
-         * utility to replace a value in history. The history
-         * changes will not be affected, only the value to be replaced.
-         * If a base value is needed to operate on,
-         * the `getNode` utility can be used to retrieve
-         * a cloned historyNode.
-         *
-         * <br> <br>
-         * Notes: <br>
-         * - No operations are done on the value provided to this utility. <br>
-         * - This is an advanced method, please ensure the value provided
-         *   is a snapshot of the same type of the value being tracked. <br>
-         *
-         * @param index - index to replace value for
-         * @param value - the updated snapshot to be stored at the index
-         */
-        replace: (index, value) => {
-            const node = proxyObject.history.nodes[index];
-            const isCurrentIndex = proxyObject.history.index === index;
-            if (!node)
-                return;
-            proxyObject.history.nodes[index] = {
-                ...node,
-                snapshot: value,
-                updatedAt: new Date(),
-            };
-            if (isCurrentIndex) {
-                proxyObject.history.wip = value;
-                proxyObject.value = proxyObject.history.wip;
-            }
-        },
-    });
-    proxyObject.saveHistory();
-    if (!utilOptions.skipSubscribe) {
-        proxyObject.subscribe();
-    }
-    return proxyObject;
-}
-//# sourceMappingURL=history-utility.js.map

package/src/history-utility.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"history-utility.js","sourceRoot":"","sources":["../../../../packages/history-utility/src/history-utility.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,IAAI,kBAAkB,EACjD,KAAK,EACL,GAAG,EACH,QAAQ,EACR,SAAS,GACV,MAAM,gBAAgB,CAAC;AA2CxB,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CACnD,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAEvC,IAAI,MAAmC,CAAC;AAExC,MAAM,SAAS,GAAG,CAAI,KAAQ,EAAK,EAAE;IACnC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAC;KAClC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QACzC,OAAO,KAAK,CAAC;KACd;IACD,MAAM,UAAU,GAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACxC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACrC,UAAU,CAAC,GAAc,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAc,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,OAAkC,EAClB,EAAE;IAClB,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE;QAChC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,KAAK,YAAY,EAAE;YAC1C,OAAO,CAAC,IAAI,CAAC;;;;KAId,CAAC,CAAC;SACF;QACD,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;KACnC;IAED,MAAM,cAAc,GAAG;QACrB,aAAa,EAAE,KAAK;KACrB,CAAC;IAEF,IAAI,CAAC,OAAO;QAAE,OAAO,cAAc,CAAC;IAEpC,OAAO;QACL,GAAG,cAAc;QACjB,GAAG,OAAO;KACX,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,gBAAgB,CAC9B,YAAe,EACf,OAAkC;IAElC,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,KAAK,CAAC;QACxB;;WAEG;QACH,KAAK,EAAE,YAAY;QACnB;;;;;WAKG;QACH,OAAO,EAAE,GAAG,CAAa;YACvB,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC,CAAC;SACV,CAAC;QACF;;;;WAIG;QACH,oBAAoB,EAAE,GAAG,EAAE;YACzB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClE,OAAO,IAAI,EAAE,SAAS,CAAC;QACzB,CAAC;QACD;;;;;;;WAOG;QACH,OAAO,EAAE,CAAC,KAAa,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,OAAO,IAAI;gBACT,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACzD,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;QACD;;WAEG;QACH,KAAK,EAAE,SAAS;QAChB;;WAEG;QACH,IAAI,EAAE,CAAC,KAAa,EAAE,EAAE;YACtB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAE9C,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3D,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;YACjD,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;QACpC,CAAC;QACD;;;WAGG;QACH,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC;QAC5C;;WAEG;QACH,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;gBACzB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CACzC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CACjE,CAAC;gBACF,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;aAClD;QACH,CAAC;QACD;;;WAGG;QACH,OAAO,EAAE,GAAG,EAAE,CACZ,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAClE;;WAEG;QACH,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;gBACzB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CACzC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CACjE,CAAC;gBACF,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;aAClD;QACH,CAAC;QACD;;WAEG;QACH,WAAW,EAAE,GAAG,EAAE;YAChB,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YAChE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC7B,SAAS,EAAE,IAAI,IAAI,EAAE;gBACrB,QAAQ,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK;aACtC,CAAC,CAAC;YACH,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9B,CAAC;QACD;;;;;WAKG;QACH,iBAAiB,EAAE,CAAC,GAAiB,EAAE,EAAE,CACvC,GAAG,CAAC,KAAK,CACP,CAAC,EAAE,EAAE,EAAE,CACL,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO;YACpB,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CACzD;QACH;;WAEG;QACH,SAAS,EAAE,GAAG,EAAE,CACd,SAAS,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE;YAC7B,IAAI,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC;gBAAE,WAAW,CAAC,WAAW,EAAE,CAAC;QACpE,CAAC,CAAC;QAEJ,4BAA4B;QAE5B;;;;;;;;;WASG;QACH,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACxB,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;YAC3D,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,SAAS,KAAK,KAAK,CAAC;YAExC,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO;YAE1D,IAAI,cAAc,EAAE;gBAClB,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;gBAC1D,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAE9D,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;gBACpE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;gBAEjD,IAAI,WAAW;oBAAE,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aAC9C;YAED,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAE3C,IAAI,CAAC,cAAc,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,EAAE;gBACxD,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aAC7B;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;;;;;;;;;;;;;WAeG;QACH,OAAO,EAAE,CAAC,KAAa,EAAE,KAAkB,EAAE,EAAE;YAC7C,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;YAE3D,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG;gBACjC,GAAG,IAAI;gBACP,QAAQ,EAAE,KAAK;gBACf,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,CAAC;YAEF,IAAI,cAAc,EAAE;gBAClB,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC;gBAChC,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAQ,CAAC;aAClD;QACH,CAAC;KACF,CAAC,CAAC;IAEH,WAAW,CAAC,WAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;QAC9B,WAAW,CAAC,SAAS,EAAE,CAAC;KACzB;IAED,OAAO,WAAW,CAAC;AACrB,CAAC"}