@legendapp/state 3.0.0-alpha.0 → 3.0.0-alpha.2

package/helpers/pageHash.mjs

@@ -1,38 +1,33 @@
 import { observable } from '@legendapp/state';
 
-let _options = { setter: 'hash' };
+// src/helpers/pageHash.ts
+var _options = { setter: "hash" };
 function configurePageHash(options) {
-    _options = options;
+  _options = options;
 }
-const hasWindow = typeof window !== 'undefined';
-const pageHash = observable(hasWindow ? window.location.hash.slice(1) : '');
+var hasWindow = typeof window !== "undefined";
+var pageHash = observable(hasWindow ? window.location.hash.slice(1) : "");
 if (hasWindow) {
-    let isSetting = false;
-    // Set the page hash when the observable changes
-    pageHash.onChange(({ value }) => {
-        if (!isSetting) {
-            const hash = '#' + value;
-            const setter = (_options === null || _options === void 0 ? void 0 : _options.setter) || 'hash';
-            if (setter === 'pushState') {
-                history.pushState(null, null, hash);
-            }
-            else if (setter === 'replaceState') {
-                history.replaceState(null, null, hash);
-            }
-            else {
-                location.hash = hash;
-            }
-        }
-    });
-    // Update the observable whenever the hash changes
-    const cb = () => {
-        isSetting = true;
-        pageHash.set(window.location.hash.slice(1));
-        isSetting = false;
-    };
-    // Subscribe to window hashChange event
-    window.addEventListener('hashchange', cb);
+  let isSetting = false;
+  pageHash.onChange(({ value }) => {
+    if (!isSetting) {
+      const hash = "#" + value;
+      const setter = (_options == null ? void 0 : _options.setter) || "hash";
+      if (setter === "pushState") {
+        history.pushState(null, null, hash);
+      } else if (setter === "replaceState") {
+        history.replaceState(null, null, hash);
+      } else {
+        location.hash = hash;
+      }
+    }
+  });
+  const cb = () => {
+    isSetting = true;
+    pageHash.set(window.location.hash.slice(1));
+    isSetting = false;
+  };
+  window.addEventListener("hashchange", cb);
 }
 
 export { configurePageHash, pageHash };
-//# sourceMappingURL=pageHash.mjs.map

package/helpers/pageHashParams.d.mts

@@ -0,0 +1,9 @@
+import { Observable } from '@legendapp/state';
+
+interface Options {
+    setter: 'pushState' | 'replaceState' | 'hash';
+}
+declare function configurePageHashParams(options: Options): void;
+declare const pageHashParams: Observable<Record<string, string>>;
+
+export { configurePageHashParams, pageHashParams };

package/helpers/pageHashParams.d.ts

@@ -1,7 +1,9 @@
 import { Observable } from '@legendapp/state';
+
 interface Options {
     setter: 'pushState' | 'replaceState' | 'hash';
 }
 declare function configurePageHashParams(options: Options): void;
 declare const pageHashParams: Observable<Record<string, string>>;
+
 export { configurePageHashParams, pageHashParams };

package/helpers/pageHashParams.js

@@ -2,51 +2,48 @@
 
 var state = require('@legendapp/state');
 
-let _options = { setter: 'hash' };
+// src/helpers/pageHashParams.ts
+var _options = { setter: "hash" };
 function configurePageHashParams(options) {
-    _options = options;
+  _options = options;
 }
 function toParams(str) {
-    const ret = {};
-    const searchParams = new URLSearchParams(str);
-    for (const [key, value] of searchParams) {
-        ret[key] = value;
-    }
-    return ret;
+  const ret = {};
+  const searchParams = new URLSearchParams(str);
+  for (const [key, value] of searchParams) {
+    ret[key] = value;
+  }
+  return ret;
 }
 function toString(params) {
-    return new URLSearchParams(params).toString().replace(/=$/, '');
+  return new URLSearchParams(params).toString().replace(/=$/, "");
 }
-const hasWindow = typeof window !== 'undefined';
-const pageHashParams = state.observable(hasWindow ? toParams(window.location.hash.slice(1)) : {});
+var hasWindow = typeof window !== "undefined";
+var pageHashParams = state.observable(
+  hasWindow ? toParams(window.location.hash.slice(1)) : {}
+);
 if (hasWindow) {
-    let isSetting = false;
-    // Set the page hash when the observable changes
-    pageHashParams.onChange(({ value }) => {
-        if (!isSetting) {
-            const hash = '#' + toString(value);
-            const setter = (_options === null || _options === void 0 ? void 0 : _options.setter) || 'hash';
-            if (setter === 'pushState') {
-                history.pushState(null, null, hash);
-            }
-            else if (setter === 'replaceState') {
-                history.replaceState(null, null, hash);
-            }
-            else {
-                location.hash = hash;
-            }
-        }
-    });
-    // Update the observable whenever the hash changes
-    const cb = () => {
-        isSetting = true;
-        pageHashParams.set(toParams(window.location.hash.slice(1)));
-        isSetting = false;
-    };
-    // Subscribe to window hashChange event
-    window.addEventListener('hashchange', cb);
+  let isSetting = false;
+  pageHashParams.onChange(({ value }) => {
+    if (!isSetting) {
+      const hash = "#" + toString(value);
+      const setter = (_options == null ? void 0 : _options.setter) || "hash";
+      if (setter === "pushState") {
+        history.pushState(null, null, hash);
+      } else if (setter === "replaceState") {
+        history.replaceState(null, null, hash);
+      } else {
+        location.hash = hash;
+      }
+    }
+  });
+  const cb = () => {
+    isSetting = true;
+    pageHashParams.set(toParams(window.location.hash.slice(1)));
+    isSetting = false;
+  };
+  window.addEventListener("hashchange", cb);
 }
 
 exports.configurePageHashParams = configurePageHashParams;
 exports.pageHashParams = pageHashParams;
-//# sourceMappingURL=pageHashParams.js.map

package/helpers/pageHashParams.mjs

@@ -1,49 +1,46 @@
 import { observable } from '@legendapp/state';
 
-let _options = { setter: 'hash' };
+// src/helpers/pageHashParams.ts
+var _options = { setter: "hash" };
 function configurePageHashParams(options) {
-    _options = options;
+  _options = options;
 }
 function toParams(str) {
-    const ret = {};
-    const searchParams = new URLSearchParams(str);
-    for (const [key, value] of searchParams) {
-        ret[key] = value;
-    }
-    return ret;
+  const ret = {};
+  const searchParams = new URLSearchParams(str);
+  for (const [key, value] of searchParams) {
+    ret[key] = value;
+  }
+  return ret;
 }
 function toString(params) {
-    return new URLSearchParams(params).toString().replace(/=$/, '');
+  return new URLSearchParams(params).toString().replace(/=$/, "");
 }
-const hasWindow = typeof window !== 'undefined';
-const pageHashParams = observable(hasWindow ? toParams(window.location.hash.slice(1)) : {});
+var hasWindow = typeof window !== "undefined";
+var pageHashParams = observable(
+  hasWindow ? toParams(window.location.hash.slice(1)) : {}
+);
 if (hasWindow) {
-    let isSetting = false;
-    // Set the page hash when the observable changes
-    pageHashParams.onChange(({ value }) => {
-        if (!isSetting) {
-            const hash = '#' + toString(value);
-            const setter = (_options === null || _options === void 0 ? void 0 : _options.setter) || 'hash';
-            if (setter === 'pushState') {
-                history.pushState(null, null, hash);
-            }
-            else if (setter === 'replaceState') {
-                history.replaceState(null, null, hash);
-            }
-            else {
-                location.hash = hash;
-            }
-        }
-    });
-    // Update the observable whenever the hash changes
-    const cb = () => {
-        isSetting = true;
-        pageHashParams.set(toParams(window.location.hash.slice(1)));
-        isSetting = false;
-    };
-    // Subscribe to window hashChange event
-    window.addEventListener('hashchange', cb);
+  let isSetting = false;
+  pageHashParams.onChange(({ value }) => {
+    if (!isSetting) {
+      const hash = "#" + toString(value);
+      const setter = (_options == null ? void 0 : _options.setter) || "hash";
+      if (setter === "pushState") {
+        history.pushState(null, null, hash);
+      } else if (setter === "replaceState") {
+        history.replaceState(null, null, hash);
+      } else {
+        location.hash = hash;
+      }
+    }
+  });
+  const cb = () => {
+    isSetting = true;
+    pageHashParams.set(toParams(window.location.hash.slice(1)));
+    isSetting = false;
+  };
+  window.addEventListener("hashchange", cb);
 }
 
 export { configurePageHashParams, pageHashParams };
-//# sourceMappingURL=pageHashParams.mjs.map

package/helpers/time.d.mts

@@ -0,0 +1,6 @@
+import * as _legendapp_state from '@legendapp/state';
+
+declare const currentTime: _legendapp_state.ObservablePrimitive<Date>;
+declare const currentDay: _legendapp_state.ObservablePrimitive<Date>;
+
+export { currentDay, currentTime };

package/helpers/time.d.ts

@@ -1,3 +1,6 @@
-declare const currentTime: import("@legendapp/state").ObservablePrimitive<Date>;
-declare const currentDay: import("@legendapp/state").ObservablePrimitive<Date>;
-export { currentTime, currentDay };
+import * as _legendapp_state from '@legendapp/state';
+
+declare const currentTime: _legendapp_state.ObservablePrimitive<Date>;
+declare const currentDay: _legendapp_state.ObservablePrimitive<Date>;
+
+export { currentDay, currentTime };

package/helpers/time.js

@@ -2,29 +2,29 @@
 
 var state = require('@legendapp/state');
 
-const MSPerMinute = 60000;
+// src/helpers/time.ts
+var MSPerMinute = 6e4;
 function clearTime(date) {
-    date = new Date(date);
-    date.setHours(0, 0, 0, 0);
-    return date;
+  date = new Date(date);
+  date.setHours(0, 0, 0, 0);
+  return date;
 }
-let time = new Date();
-const currentTime = state.observable(time);
-const currentDay = state.observable(clearTime(time));
-const timeToSecond = (60 - time.getSeconds() + 1) * 1000;
+var time = /* @__PURE__ */ new Date();
+var currentTime = state.observable(time);
+var currentDay = state.observable(clearTime(time));
+var timeToSecond = (60 - time.getSeconds() + 1) * 1e3;
 function update() {
-    const now = new Date();
-    currentTime.set(now);
-    if (now.getDate() !== time.getDate()) {
-        currentDay.set(clearTime(now));
-    }
-    time = now;
+  const now = /* @__PURE__ */ new Date();
+  currentTime.set(now);
+  if (now.getDate() !== time.getDate()) {
+    currentDay.set(clearTime(now));
+  }
+  time = now;
 }
 setTimeout(() => {
-    update();
-    setInterval(update, MSPerMinute);
+  update();
+  setInterval(update, MSPerMinute);
 }, timeToSecond);
 
 exports.currentDay = currentDay;
 exports.currentTime = currentTime;
-//# sourceMappingURL=time.js.map

package/helpers/time.mjs

@@ -1,27 +1,27 @@
 import { observable } from '@legendapp/state';
 
-const MSPerMinute = 60000;
+// src/helpers/time.ts
+var MSPerMinute = 6e4;
 function clearTime(date) {
-    date = new Date(date);
-    date.setHours(0, 0, 0, 0);
-    return date;
+  date = new Date(date);
+  date.setHours(0, 0, 0, 0);
+  return date;
 }
-let time = new Date();
-const currentTime = observable(time);
-const currentDay = observable(clearTime(time));
-const timeToSecond = (60 - time.getSeconds() + 1) * 1000;
+var time = /* @__PURE__ */ new Date();
+var currentTime = observable(time);
+var currentDay = observable(clearTime(time));
+var timeToSecond = (60 - time.getSeconds() + 1) * 1e3;
 function update() {
-    const now = new Date();
-    currentTime.set(now);
-    if (now.getDate() !== time.getDate()) {
-        currentDay.set(clearTime(now));
-    }
-    time = now;
+  const now = /* @__PURE__ */ new Date();
+  currentTime.set(now);
+  if (now.getDate() !== time.getDate()) {
+    currentDay.set(clearTime(now));
+  }
+  time = now;
 }
 setTimeout(() => {
-    update();
-    setInterval(update, MSPerMinute);
+  update();
+  setInterval(update, MSPerMinute);
 }, timeToSecond);
 
 export { currentDay, currentTime };
-//# sourceMappingURL=time.mjs.map

package/helpers/trackHistory.d.mts

@@ -0,0 +1,6 @@
+import { ObservableParam } from '@legendapp/state';
+
+type TimestampAsString = string;
+declare function trackHistory<T>(value$: ObservableParam<T>, targetObservable?: ObservableParam<Record<TimestampAsString, Partial<T>>>): ObservableParam<Record<TimestampAsString, any>>;
+
+export { trackHistory };

package/helpers/trackHistory.d.ts

@@ -0,0 +1,6 @@
+import { ObservableParam } from '@legendapp/state';
+
+type TimestampAsString = string;
+declare function trackHistory<T>(value$: ObservableParam<T>, targetObservable?: ObservableParam<Record<TimestampAsString, Partial<T>>>): ObservableParam<Record<TimestampAsString, any>>;
+
+export { trackHistory };

package/helpers/trackHistory.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var state = require('@legendapp/state');
+
+// src/helpers/trackHistory.ts
+function trackHistory(value$, targetObservable) {
+  const history = targetObservable != null ? targetObservable : state.observable();
+  value$.onChange(({ loading, remote, changes }) => {
+    if (!loading && !remote) {
+      const time = Date.now().toString();
+      for (let i = 0; i < changes.length; i++) {
+        const { path, prevAtPath, pathTypes } = changes[i];
+        const obj = state.constructObjectWithPath(path, pathTypes, prevAtPath);
+        state.mergeIntoObservable(history[time], obj);
+      }
+    }
+  });
+  return history;
+}
+
+exports.trackHistory = trackHistory;

package/helpers/trackHistory.mjs

@@ -0,0 +1,19 @@
+import { observable, constructObjectWithPath, mergeIntoObservable } from '@legendapp/state';
+
+// src/helpers/trackHistory.ts
+function trackHistory(value$, targetObservable) {
+  const history = targetObservable != null ? targetObservable : observable();
+  value$.onChange(({ loading, remote, changes }) => {
+    if (!loading && !remote) {
+      const time = Date.now().toString();
+      for (let i = 0; i < changes.length; i++) {
+        const { path, prevAtPath, pathTypes } = changes[i];
+        const obj = constructObjectWithPath(path, pathTypes, prevAtPath);
+        mergeIntoObservable(history[time], obj);
+      }
+    }
+  });
+  return history;
+}
+
+export { trackHistory };

package/helpers/undoRedo.d.mts

@@ -0,0 +1,37 @@
+import { ObservablePrimitive } from '@legendapp/state';
+
+type UndoRedoOptions = {
+    limit?: number;
+};
+/**
+ * Usage:
+ *
+ * Use this function to add undo/redo functionality to an observable.
+ *
+ * You can monitor how many undos or redos are available to enable/disable undo/redo
+ * UI elements with undo$ and redo$.
+ *
+ * If you undo and then make a change, it'll delete any redos and add the change, as expected.
+ *
+ * If you don't pass in a limit, it will keep all history. This means it can grow indefinitely.
+ *
+ * ```typescript
+ * const obs$ = observable({ test: 'hi', test2: 'a' });
+ * const { undo, redo, undos$, redos$, getHistory } = undoRedo(obs$, { limit: 40 });
+ * obs$.test.set('hello');
+ * undo();
+ * redo();
+ * // observables for # of undos/redos available
+ * undos$.get();
+ * redos$.get();
+ * ```
+ */
+declare function undoRedo<T>(obs$: ObservablePrimitive<T>, options?: UndoRedoOptions): {
+    undo(): void;
+    redo(): void;
+    undos$: ObservablePrimitive<number>;
+    redos$: ObservablePrimitive<number>;
+    getHistory: () => T[];
+};
+
+export { undoRedo };

package/helpers/undoRedo.d.ts

@@ -0,0 +1,37 @@
+import { ObservablePrimitive } from '@legendapp/state';
+
+type UndoRedoOptions = {
+    limit?: number;
+};
+/**
+ * Usage:
+ *
+ * Use this function to add undo/redo functionality to an observable.
+ *
+ * You can monitor how many undos or redos are available to enable/disable undo/redo
+ * UI elements with undo$ and redo$.
+ *
+ * If you undo and then make a change, it'll delete any redos and add the change, as expected.
+ *
+ * If you don't pass in a limit, it will keep all history. This means it can grow indefinitely.
+ *
+ * ```typescript
+ * const obs$ = observable({ test: 'hi', test2: 'a' });
+ * const { undo, redo, undos$, redos$, getHistory } = undoRedo(obs$, { limit: 40 });
+ * obs$.test.set('hello');
+ * undo();
+ * redo();
+ * // observables for # of undos/redos available
+ * undos$.get();
+ * redos$.get();
+ * ```
+ */
+declare function undoRedo<T>(obs$: ObservablePrimitive<T>, options?: UndoRedoOptions): {
+    undo(): void;
+    redo(): void;
+    undos$: ObservablePrimitive<number>;
+    redos$: ObservablePrimitive<number>;
+    getHistory: () => T[];
+};
+
+export { undoRedo };

package/helpers/undoRedo.js

@@ -0,0 +1,68 @@
+'use strict';
+
+var state = require('@legendapp/state');
+
+// src/helpers/undoRedo.ts
+function undoRedo(obs$, options) {
+  let history = [];
+  let historyPointer = 0;
+  let restoringFromHistory = false;
+  const undos$ = state.observable(0);
+  const redos$ = state.observable(0);
+  function updateUndoRedo() {
+    undos$.set(historyPointer);
+    redos$.set(history.length - historyPointer - 1);
+  }
+  obs$.onChange(({ getPrevious }) => {
+    if (restoringFromHistory)
+      return;
+    if (state.internal.globalState.isLoadingRemote || state.internal.globalState.isLoadingLocal)
+      return;
+    if (!history.length) {
+      const previous = getPrevious();
+      if (previous)
+        history.push(state.internal.clone(previous));
+      historyPointer = 0;
+    }
+    const snapshot = state.internal.clone(obs$.get());
+    if (options == null ? void 0 : options.limit) {
+      history = history.slice(Math.max(0, history.length - options.limit));
+    } else {
+      history = history.slice(0, historyPointer + 1);
+    }
+    history.push(snapshot);
+    historyPointer = history.length - 1;
+    updateUndoRedo();
+  });
+  return {
+    undo() {
+      if (historyPointer > 0) {
+        historyPointer--;
+        const snapshot = state.internal.clone(history[historyPointer]);
+        restoringFromHistory = true;
+        obs$.set(snapshot);
+        restoringFromHistory = false;
+      } else {
+        console.warn("Already at the beginning of undo history");
+      }
+      updateUndoRedo();
+    },
+    redo() {
+      if (historyPointer < history.length - 1) {
+        historyPointer++;
+        const snapshot = state.internal.clone(history[historyPointer]);
+        restoringFromHistory = true;
+        obs$.set(snapshot);
+        restoringFromHistory = false;
+      } else {
+        console.warn("Already at the end of undo history");
+      }
+      updateUndoRedo();
+    },
+    undos$,
+    redos$,
+    getHistory: () => history
+  };
+}
+
+exports.undoRedo = undoRedo;

package/helpers/undoRedo.mjs

@@ -0,0 +1,66 @@
+import { observable, internal } from '@legendapp/state';
+
+// src/helpers/undoRedo.ts
+function undoRedo(obs$, options) {
+  let history = [];
+  let historyPointer = 0;
+  let restoringFromHistory = false;
+  const undos$ = observable(0);
+  const redos$ = observable(0);
+  function updateUndoRedo() {
+    undos$.set(historyPointer);
+    redos$.set(history.length - historyPointer - 1);
+  }
+  obs$.onChange(({ getPrevious }) => {
+    if (restoringFromHistory)
+      return;
+    if (internal.globalState.isLoadingRemote || internal.globalState.isLoadingLocal)
+      return;
+    if (!history.length) {
+      const previous = getPrevious();
+      if (previous)
+        history.push(internal.clone(previous));
+      historyPointer = 0;
+    }
+    const snapshot = internal.clone(obs$.get());
+    if (options == null ? void 0 : options.limit) {
+      history = history.slice(Math.max(0, history.length - options.limit));
+    } else {
+      history = history.slice(0, historyPointer + 1);
+    }
+    history.push(snapshot);
+    historyPointer = history.length - 1;
+    updateUndoRedo();
+  });
+  return {
+    undo() {
+      if (historyPointer > 0) {
+        historyPointer--;
+        const snapshot = internal.clone(history[historyPointer]);
+        restoringFromHistory = true;
+        obs$.set(snapshot);
+        restoringFromHistory = false;
+      } else {
+        console.warn("Already at the beginning of undo history");
+      }
+      updateUndoRedo();
+    },
+    redo() {
+      if (historyPointer < history.length - 1) {
+        historyPointer++;
+        const snapshot = internal.clone(history[historyPointer]);
+        restoringFromHistory = true;
+        obs$.set(snapshot);
+        restoringFromHistory = false;
+      } else {
+        console.warn("Already at the end of undo history");
+      }
+      updateUndoRedo();
+    },
+    undos$,
+    redos$,
+    getHistory: () => history
+  };
+}
+
+export { undoRedo };