@coaction/history 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Michael Lin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# @coaction/history
+
+![Node CI](https://github.com/unadlib/coaction/workflows/Node%20CI/badge.svg)
+[![npm](https://img.shields.io/npm/v/@coaction/history.svg)](https://www.npmjs.com/package/@coaction/history)
+![license](https://img.shields.io/npm/l/@coaction/history)
+
+A undo/redo middleware for Coaction.
+
+## Installation
+
+You can install it via npm, yarn or pnpm.
+
+```sh
+npm install coaction @coaction/history
+```
+
+## Usage
+
+```ts
+import { create } from 'coaction';
+import { history } from '@coaction/history';
+
+const store = create(
+  (set) => ({
+    count: 0,
+    increment() {
+      set((draft) => {
+        draft.count += 1;
+      });
+    }
+  }),
+  {
+    middlewares: [history()]
+  }
+);
+
+store.getState().increment();
+(store as any).history.undo();
+```
+
+## Documentation
+
+You can find the documentation [here](https://github.com/unadlib/coaction).

package/dist/index.d.mts

@@ -0,0 +1,18 @@
+import { Middleware } from 'coaction';
+
+type HistoryOptions<T extends object> = {
+    limit?: number;
+    partialize?: (state: T) => object;
+};
+type HistoryApi<T extends object> = {
+    undo: () => boolean;
+    redo: () => boolean;
+    clear: () => void;
+    canUndo: () => boolean;
+    canRedo: () => boolean;
+    getPast: () => object[];
+    getFuture: () => object[];
+};
+declare const history: <T extends object>({ limit, partialize }?: HistoryOptions<T>) => Middleware<T>;
+
+export { type HistoryApi, type HistoryOptions, history };

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { Middleware } from 'coaction';
+
+type HistoryOptions<T extends object> = {
+    limit?: number;
+    partialize?: (state: T) => object;
+};
+type HistoryApi<T extends object> = {
+    undo: () => boolean;
+    redo: () => boolean;
+    clear: () => void;
+    canUndo: () => boolean;
+    canRedo: () => boolean;
+    getPast: () => object[];
+    getFuture: () => object[];
+};
+declare const history: <T extends object>({ limit, partialize }?: HistoryOptions<T>) => Middleware<T>;
+
+export { type HistoryApi, type HistoryOptions, history };

package/dist/index.js

@@ -0,0 +1,122 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  history: () => history
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/index.ts
+var toSnapshot = (state) => {
+  if (Array.isArray(state)) {
+    return state.map((item) => toSnapshot(item));
+  }
+  if (typeof state === "object" && state !== null) {
+    const next = {};
+    for (const key in state) {
+      const value = state[key];
+      if (typeof value === "function") {
+        continue;
+      }
+      next[key] = toSnapshot(value);
+    }
+    return next;
+  }
+  return state;
+};
+var isEqual = (a, b) => JSON.stringify(a) === JSON.stringify(b);
+var history = ({
+  limit = 100,
+  partialize = (state) => state
+} = {}) => (store) => {
+  const past = [];
+  const future = [];
+  let isTimeTraveling = false;
+  const getSnapshot = () => toSnapshot(partialize(store.getPureState()));
+  const pushPast = (snapshot) => {
+    past.push(snapshot);
+    if (past.length > limit) {
+      past.shift();
+    }
+  };
+  const baseSetState = store.setState;
+  store.setState = (next, updater) => {
+    const previous = getSnapshot();
+    const result = baseSetState(next, updater);
+    if (isTimeTraveling) {
+      return result;
+    }
+    const current = getSnapshot();
+    if (!isEqual(previous, current)) {
+      pushPast(previous);
+      future.length = 0;
+    }
+    return result;
+  };
+  const api = {
+    undo: () => {
+      const previous = past.pop();
+      if (!previous) {
+        return false;
+      }
+      const current = getSnapshot();
+      future.push(current);
+      isTimeTraveling = true;
+      try {
+        baseSetState(previous);
+      } finally {
+        isTimeTraveling = false;
+      }
+      return true;
+    },
+    redo: () => {
+      const next = future.pop();
+      if (!next) {
+        return false;
+      }
+      const current = getSnapshot();
+      past.push(current);
+      isTimeTraveling = true;
+      try {
+        baseSetState(next);
+      } finally {
+        isTimeTraveling = false;
+      }
+      return true;
+    },
+    clear: () => {
+      past.length = 0;
+      future.length = 0;
+    },
+    canUndo: () => past.length > 0,
+    canRedo: () => future.length > 0,
+    getPast: () => [...past],
+    getFuture: () => [...future]
+  };
+  Object.assign(store, {
+    history: api
+  });
+  return store;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  history
+});

package/dist/index.mjs

@@ -0,0 +1,95 @@
+// src/index.ts
+var toSnapshot = (state) => {
+  if (Array.isArray(state)) {
+    return state.map((item) => toSnapshot(item));
+  }
+  if (typeof state === "object" && state !== null) {
+    const next = {};
+    for (const key in state) {
+      const value = state[key];
+      if (typeof value === "function") {
+        continue;
+      }
+      next[key] = toSnapshot(value);
+    }
+    return next;
+  }
+  return state;
+};
+var isEqual = (a, b) => JSON.stringify(a) === JSON.stringify(b);
+var history = ({
+  limit = 100,
+  partialize = (state) => state
+} = {}) => (store) => {
+  const past = [];
+  const future = [];
+  let isTimeTraveling = false;
+  const getSnapshot = () => toSnapshot(partialize(store.getPureState()));
+  const pushPast = (snapshot) => {
+    past.push(snapshot);
+    if (past.length > limit) {
+      past.shift();
+    }
+  };
+  const baseSetState = store.setState;
+  store.setState = (next, updater) => {
+    const previous = getSnapshot();
+    const result = baseSetState(next, updater);
+    if (isTimeTraveling) {
+      return result;
+    }
+    const current = getSnapshot();
+    if (!isEqual(previous, current)) {
+      pushPast(previous);
+      future.length = 0;
+    }
+    return result;
+  };
+  const api = {
+    undo: () => {
+      const previous = past.pop();
+      if (!previous) {
+        return false;
+      }
+      const current = getSnapshot();
+      future.push(current);
+      isTimeTraveling = true;
+      try {
+        baseSetState(previous);
+      } finally {
+        isTimeTraveling = false;
+      }
+      return true;
+    },
+    redo: () => {
+      const next = future.pop();
+      if (!next) {
+        return false;
+      }
+      const current = getSnapshot();
+      past.push(current);
+      isTimeTraveling = true;
+      try {
+        baseSetState(next);
+      } finally {
+        isTimeTraveling = false;
+      }
+      return true;
+    },
+    clear: () => {
+      past.length = 0;
+      future.length = 0;
+    },
+    canUndo: () => past.length > 0,
+    canRedo: () => future.length > 0,
+    getPast: () => [...past],
+    getFuture: () => [...future]
+  };
+  Object.assign(store, {
+    history: api
+  });
+  return store;
+};
+export {
+  history
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@coaction/history",
+  "version": "1.0.0",
+  "description": "A undo/redo middleware for Coaction",
+  "keywords": [
+    "state",
+    "coaction",
+    "middleware",
+    "history",
+    "undo",
+    "redo"
+  ],
+  "authors": [
+    "Michael Lin <unadlib@gmail.com> (https://github.com/unadlib)"
+  ],
+  "homepage": "https://github.com/unadlib/coaction/tree/main/packages/coaction-history#readme",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/unadlib/coaction.git",
+    "directory": "packages/coaction-history"
+  },
+  "bugs": {
+    "url": "https://github.com/unadlib/coaction/issues"
+  },
+  "peerDependencies": {
+    "coaction": "^0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "coaction": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "coaction": "^0.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "author": "unadlib",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "test": "vitest run test",
+    "build": "tsup index.ts --format cjs,esm --dts --clean --out-dir dist",
+    "dev": "tsup index.ts --format cjs,esm --dts --watch --out-dir dist"
+  }
+}