@coaction/redux 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,54 @@
+# @coaction/redux
+
+![Node CI](https://github.com/unadlib/coaction/workflows/Node%20CI/badge.svg)
+[![npm](https://img.shields.io/npm/v/@coaction/redux.svg)](https://www.npmjs.com/package/@coaction/redux)
+![license](https://img.shields.io/npm/l/@coaction/redux)
+
+A Coaction integration tool for Redux Toolkit.
+
+## Installation
+
+You can install it via npm, yarn or pnpm.
+
+```sh
+npm install coaction @coaction/redux @reduxjs/toolkit
+```
+
+## Usage
+
+```ts
+import { create } from 'coaction';
+import {
+  adapt,
+  bindRedux,
+  createSlice,
+  configureStore,
+  withCoactionReducer
+} from '@coaction/redux';
+
+const counterSlice = createSlice({
+  name: 'counter',
+  initialState: { count: 0 },
+  reducers: {
+    increment(state) {
+      state.count += 1;
+    }
+  }
+});
+
+const reduxStore = configureStore({
+  reducer: withCoactionReducer(counterSlice.reducer)
+});
+
+const store = create(() => adapt(bindRedux(reduxStore)));
+store.getState().dispatch(counterSlice.actions.increment());
+```
+
+## Limitations
+
+- `@coaction/redux` only supports binding a whole Redux store.
+- Coaction `Slices` mode is not supported in this adapter.
+
+## Documentation
+
+You can find the documentation [here](https://github.com/unadlib/coaction).

package/dist/index.d.mts

@@ -0,0 +1,27 @@
+import { AnyAction, Store, Reducer } from '@reduxjs/toolkit';
+export * from '@reduxjs/toolkit';
+
+declare const COACTION_REDUX_REPLACE = "@@coaction/redux/replace";
+type ReplaceStateAction<S> = {
+    type: typeof COACTION_REDUX_REPLACE;
+    payload: S;
+};
+declare function replaceStateAction<S>(payload: S): ReplaceStateAction<S>;
+declare const withCoactionReducer: <S, A extends AnyAction = AnyAction>(reducer: Reducer<S, A>) => Reducer<S, A | ReplaceStateAction<S>>;
+type BoundReduxStore<S extends object, A extends AnyAction> = Store<S, A> & {
+    getState: () => BoundReduxState<S, A>;
+};
+type BoundReduxState<S extends object, A extends AnyAction> = S & {
+    dispatch: Store<S, A>['dispatch'];
+};
+/**
+ * Bind a redux toolkit store to coaction.
+ */
+declare const bindRedux: <S extends object, A extends AnyAction = AnyAction>(reduxStore: Store<S, A>) => BoundReduxStore<S, A>;
+/**
+ * Adapt a redux store type to state type.
+ */
+declare function adapt<T extends object, A extends AnyAction = AnyAction>(store: BoundReduxStore<T, A>): BoundReduxState<T, A>;
+declare function adapt<T extends object>(store: Store<T>): T;
+
+export { COACTION_REDUX_REPLACE, type ReplaceStateAction, adapt, bindRedux, replaceStateAction, withCoactionReducer };

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { AnyAction, Store, Reducer } from '@reduxjs/toolkit';
+export * from '@reduxjs/toolkit';
+
+declare const COACTION_REDUX_REPLACE = "@@coaction/redux/replace";
+type ReplaceStateAction<S> = {
+    type: typeof COACTION_REDUX_REPLACE;
+    payload: S;
+};
+declare function replaceStateAction<S>(payload: S): ReplaceStateAction<S>;
+declare const withCoactionReducer: <S, A extends AnyAction = AnyAction>(reducer: Reducer<S, A>) => Reducer<S, A | ReplaceStateAction<S>>;
+type BoundReduxStore<S extends object, A extends AnyAction> = Store<S, A> & {
+    getState: () => BoundReduxState<S, A>;
+};
+type BoundReduxState<S extends object, A extends AnyAction> = S & {
+    dispatch: Store<S, A>['dispatch'];
+};
+/**
+ * Bind a redux toolkit store to coaction.
+ */
+declare const bindRedux: <S extends object, A extends AnyAction = AnyAction>(reduxStore: Store<S, A>) => BoundReduxStore<S, A>;
+/**
+ * Adapt a redux store type to state type.
+ */
+declare function adapt<T extends object, A extends AnyAction = AnyAction>(store: BoundReduxStore<T, A>): BoundReduxState<T, A>;
+declare function adapt<T extends object>(store: Store<T>): T;
+
+export { COACTION_REDUX_REPLACE, type ReplaceStateAction, adapt, bindRedux, replaceStateAction, withCoactionReducer };

package/dist/index.js

@@ -0,0 +1,141 @@
+"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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  COACTION_REDUX_REPLACE: () => COACTION_REDUX_REPLACE,
+  adapt: () => adapt,
+  bindRedux: () => bindRedux,
+  replaceStateAction: () => replaceStateAction,
+  withCoactionReducer: () => withCoactionReducer
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  COACTION_REDUX_REPLACE: () => COACTION_REDUX_REPLACE,
+  adapt: () => adapt,
+  bindRedux: () => bindRedux,
+  replaceStateAction: () => replaceStateAction,
+  withCoactionReducer: () => withCoactionReducer
+});
+var import_coaction = require("coaction");
+__reExport(src_exports, require("@reduxjs/toolkit"));
+var COACTION_REDUX_REPLACE = "@@coaction/redux/replace";
+function stripFunctions(value) {
+  if (Array.isArray(value)) {
+    return value.map((item) => stripFunctions(item));
+  }
+  if (typeof value === "object" && value !== null) {
+    const next = {};
+    for (const key in value) {
+      const child = value[key];
+      if (typeof child === "function") {
+        continue;
+      }
+      next[key] = stripFunctions(child);
+    }
+    return next;
+  }
+  return value;
+}
+function replaceStateAction(payload) {
+  return {
+    type: COACTION_REDUX_REPLACE,
+    payload
+  };
+}
+var withCoactionReducer = (reducer) => (state, action) => {
+  if (action.type === COACTION_REDUX_REPLACE) {
+    return stripFunctions(action.payload);
+  }
+  return reducer(state, action);
+};
+var bindRedux = (reduxStore) => {
+  const originalGetState = reduxStore.getState.bind(reduxStore);
+  let isReduxUpdating = false;
+  let isCoactionUpdating = false;
+  const bindState = (0, import_coaction.createBinder)({
+    handleStore: (coactionStore, rawState, state, internal) => {
+      if (coactionStore.share === "client") {
+        throw new Error("client redux store cannot be updated");
+      }
+      reduxStore.subscribe(() => {
+        if (isCoactionUpdating) {
+          return;
+        }
+        isReduxUpdating = true;
+        try {
+          coactionStore.setState(reduxStore.getState());
+        } finally {
+          isReduxUpdating = false;
+        }
+      });
+      internal.updateImmutable = (nextState) => {
+        if (isReduxUpdating) {
+          return;
+        }
+        isCoactionUpdating = true;
+        try {
+          reduxStore.dispatch(replaceStateAction(nextState));
+        } finally {
+          isCoactionUpdating = false;
+        }
+      };
+    },
+    handleState: ((state) => {
+      const copyState = Object.defineProperties(
+        {},
+        {
+          ...Object.getOwnPropertyDescriptors(state),
+          dispatch: {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: reduxStore.dispatch.bind(reduxStore)
+          }
+        }
+      );
+      return {
+        copyState,
+        bind: (rawState) => rawState
+      };
+    })
+  });
+  const store = reduxStore;
+  store.getState = () => bindState(originalGetState());
+  return store;
+};
+function adapt(store) {
+  return store;
+}
+
+// index.ts
+__reExport(index_exports, src_exports, module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  COACTION_REDUX_REPLACE,
+  adapt,
+  bindRedux,
+  replaceStateAction,
+  withCoactionReducer
+});

package/dist/index.mjs

@@ -0,0 +1,138 @@
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  COACTION_REDUX_REPLACE: () => COACTION_REDUX_REPLACE,
+  adapt: () => adapt,
+  bindRedux: () => bindRedux,
+  replaceStateAction: () => replaceStateAction,
+  withCoactionReducer: () => withCoactionReducer
+});
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  COACTION_REDUX_REPLACE: () => COACTION_REDUX_REPLACE,
+  adapt: () => adapt,
+  bindRedux: () => bindRedux,
+  replaceStateAction: () => replaceStateAction,
+  withCoactionReducer: () => withCoactionReducer
+});
+__reExport(src_exports, toolkit_star);
+import { createBinder } from "coaction";
+import * as toolkit_star from "@reduxjs/toolkit";
+var COACTION_REDUX_REPLACE = "@@coaction/redux/replace";
+function stripFunctions(value) {
+  if (Array.isArray(value)) {
+    return value.map((item) => stripFunctions(item));
+  }
+  if (typeof value === "object" && value !== null) {
+    const next = {};
+    for (const key in value) {
+      const child = value[key];
+      if (typeof child === "function") {
+        continue;
+      }
+      next[key] = stripFunctions(child);
+    }
+    return next;
+  }
+  return value;
+}
+function replaceStateAction(payload) {
+  return {
+    type: COACTION_REDUX_REPLACE,
+    payload
+  };
+}
+var withCoactionReducer = (reducer) => (state, action) => {
+  if (action.type === COACTION_REDUX_REPLACE) {
+    return stripFunctions(action.payload);
+  }
+  return reducer(state, action);
+};
+var bindRedux = (reduxStore) => {
+  const originalGetState = reduxStore.getState.bind(reduxStore);
+  let isReduxUpdating = false;
+  let isCoactionUpdating = false;
+  const bindState = createBinder({
+    handleStore: (coactionStore, rawState, state, internal) => {
+      if (coactionStore.share === "client") {
+        throw new Error("client redux store cannot be updated");
+      }
+      reduxStore.subscribe(() => {
+        if (isCoactionUpdating) {
+          return;
+        }
+        isReduxUpdating = true;
+        try {
+          coactionStore.setState(reduxStore.getState());
+        } finally {
+          isReduxUpdating = false;
+        }
+      });
+      internal.updateImmutable = (nextState) => {
+        if (isReduxUpdating) {
+          return;
+        }
+        isCoactionUpdating = true;
+        try {
+          reduxStore.dispatch(replaceStateAction(nextState));
+        } finally {
+          isCoactionUpdating = false;
+        }
+      };
+    },
+    handleState: ((state) => {
+      const copyState = Object.defineProperties(
+        {},
+        {
+          ...Object.getOwnPropertyDescriptors(state),
+          dispatch: {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: reduxStore.dispatch.bind(reduxStore)
+          }
+        }
+      );
+      return {
+        copyState,
+        bind: (rawState) => rawState
+      };
+    })
+  });
+  const store = reduxStore;
+  store.getState = () => bindState(originalGetState());
+  return store;
+};
+function adapt(store) {
+  return store;
+}
+
+// index.ts
+__reExport(index_exports, src_exports);
+export {
+  COACTION_REDUX_REPLACE,
+  adapt,
+  bindRedux,
+  replaceStateAction,
+  withCoactionReducer
+};

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@coaction/redux",
+  "version": "1.0.0",
+  "description": "A Coaction integration tool for Redux Toolkit",
+  "keywords": [
+    "state",
+    "coaction",
+    "redux",
+    "redux-toolkit"
+  ],
+  "authors": [
+    "Michael Lin <unadlib@gmail.com> (https://github.com/unadlib)"
+  ],
+  "homepage": "https://github.com/unadlib/coaction/tree/main/packages/coaction-redux#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-redux"
+  },
+  "bugs": {
+    "url": "https://github.com/unadlib/coaction/issues"
+  },
+  "peerDependencies": {
+    "@reduxjs/toolkit": "^2.0.0",
+    "coaction": "^0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "coaction": {
+      "optional": true
+    },
+    "@reduxjs/toolkit": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@reduxjs/toolkit": "^2.10.1",
+    "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"
+  }
+}