@coaction/xstate 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,57 @@
+# @coaction/xstate
+
+![Node CI](https://github.com/unadlib/coaction/workflows/Node%20CI/badge.svg)
+[![npm](https://img.shields.io/npm/v/@coaction/xstate.svg)](https://www.npmjs.com/package/@coaction/xstate)
+![license](https://img.shields.io/npm/l/@coaction/xstate)
+
+A Coaction integration tool for XState.
+
+## Installation
+
+You can install it via npm, yarn or pnpm.
+
+```sh
+npm install coaction @coaction/xstate xstate
+```
+
+## Usage
+
+```ts
+import { create } from 'coaction';
+import {
+  adapt,
+  assign,
+  bindXState,
+  createActor,
+  createMachine
+} from '@coaction/xstate';
+
+const machine = createMachine({
+  context: {
+    count: 0
+  },
+  on: {
+    increment: {
+      actions: assign({
+        count: ({ context }) => context.count + 1
+      })
+    }
+  }
+});
+
+const actor = createActor(machine);
+actor.start();
+
+const store = create(() => adapt(bindXState(actor)));
+store.getState().send({ type: 'increment' });
+```
+
+## Limitations
+
+- `@coaction/xstate` only supports binding a whole XState actor.
+- Coaction `Slices` mode is not supported in this adapter.
+- `setState()` is blocked; update state through actor events.
+
+## Documentation
+
+You can find the documentation [here](https://github.com/unadlib/coaction).

package/dist/index.d.mts

@@ -0,0 +1,25 @@
+export * from 'xstate';
+
+type XStateActor<TContext extends object = object, TEvent = any> = {
+    getSnapshot: () => {
+        context: TContext;
+    };
+    subscribe: (observer: (snapshot: {
+        context: TContext;
+    }) => void) => {
+        unsubscribe: () => void;
+    };
+    send: (event: TEvent) => void;
+};
+/**
+ * Bind an XState actor to Coaction.
+ */
+declare const bindXState: <TContext extends object, TEvent>(actor: XStateActor<TContext, TEvent>) => { [K in keyof TContext]: TContext[K]; } & {
+    send: (event: TEvent) => void;
+};
+/**
+ * Adapt a state type for Coaction create function.
+ */
+declare const adapt: <T extends object>(store: T) => T;
+
+export { adapt, bindXState };

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+export * from 'xstate';
+
+type XStateActor<TContext extends object = object, TEvent = any> = {
+    getSnapshot: () => {
+        context: TContext;
+    };
+    subscribe: (observer: (snapshot: {
+        context: TContext;
+    }) => void) => {
+        unsubscribe: () => void;
+    };
+    send: (event: TEvent) => void;
+};
+/**
+ * Bind an XState actor to Coaction.
+ */
+declare const bindXState: <TContext extends object, TEvent>(actor: XStateActor<TContext, TEvent>) => { [K in keyof TContext]: TContext[K]; } & {
+    send: (event: TEvent) => void;
+};
+/**
+ * Adapt a state type for Coaction create function.
+ */
+declare const adapt: <T extends object>(store: T) => T;
+
+export { adapt, bindXState };

package/dist/index.js

@@ -0,0 +1,91 @@
+"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, {
+  adapt: () => adapt,
+  bindXState: () => bindXState
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  adapt: () => adapt,
+  bindXState: () => bindXState
+});
+var import_coaction = require("coaction");
+__reExport(src_exports, require("xstate"));
+var actorMap = /* @__PURE__ */ new WeakMap();
+var bindXState = (0, import_coaction.createBinder)({
+  handleStore: (store, rawState) => {
+    const actor = actorMap.get(rawState);
+    if (!actor) {
+      throw new Error("xstate actor is not found");
+    }
+    let isFromActor = false;
+    const baseSetState = store.setState;
+    store.setState = (next, updater) => {
+      if (!isFromActor) {
+        throw new Error(
+          "setState is not supported with xstate binding. Please use actor events."
+        );
+      }
+      return baseSetState(next, updater);
+    };
+    const subscription = actor.subscribe((snapshot) => {
+      isFromActor = true;
+      try {
+        baseSetState(snapshot.context);
+      } finally {
+        isFromActor = false;
+      }
+    });
+    const baseDestroy = store.destroy;
+    store.destroy = () => {
+      subscription.unsubscribe();
+      baseDestroy();
+    };
+  },
+  handleState: ((actor) => {
+    const snapshot = actor.getSnapshot();
+    const state = Object.assign({}, snapshot.context, {
+      send: actor.send.bind(actor)
+    });
+    const descriptors = Object.getOwnPropertyDescriptors(state);
+    const copyState = Object.defineProperties({}, descriptors);
+    const rawState = Object.defineProperties({}, descriptors);
+    actorMap.set(rawState, actor);
+    return {
+      copyState,
+      bind: () => rawState
+    };
+  })
+});
+var adapt = (store) => store;
+
+// index.ts
+__reExport(index_exports, src_exports, module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  adapt,
+  bindXState
+});

package/dist/index.mjs

@@ -0,0 +1,88 @@
+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, {
+  adapt: () => adapt,
+  bindXState: () => bindXState
+});
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  adapt: () => adapt,
+  bindXState: () => bindXState
+});
+__reExport(src_exports, xstate_star);
+import { createBinder } from "coaction";
+import * as xstate_star from "xstate";
+var actorMap = /* @__PURE__ */ new WeakMap();
+var bindXState = createBinder({
+  handleStore: (store, rawState) => {
+    const actor = actorMap.get(rawState);
+    if (!actor) {
+      throw new Error("xstate actor is not found");
+    }
+    let isFromActor = false;
+    const baseSetState = store.setState;
+    store.setState = (next, updater) => {
+      if (!isFromActor) {
+        throw new Error(
+          "setState is not supported with xstate binding. Please use actor events."
+        );
+      }
+      return baseSetState(next, updater);
+    };
+    const subscription = actor.subscribe((snapshot) => {
+      isFromActor = true;
+      try {
+        baseSetState(snapshot.context);
+      } finally {
+        isFromActor = false;
+      }
+    });
+    const baseDestroy = store.destroy;
+    store.destroy = () => {
+      subscription.unsubscribe();
+      baseDestroy();
+    };
+  },
+  handleState: ((actor) => {
+    const snapshot = actor.getSnapshot();
+    const state = Object.assign({}, snapshot.context, {
+      send: actor.send.bind(actor)
+    });
+    const descriptors = Object.getOwnPropertyDescriptors(state);
+    const copyState = Object.defineProperties({}, descriptors);
+    const rawState = Object.defineProperties({}, descriptors);
+    actorMap.set(rawState, actor);
+    return {
+      copyState,
+      bind: () => rawState
+    };
+  })
+});
+var adapt = (store) => store;
+
+// index.ts
+__reExport(index_exports, src_exports);
+export {
+  adapt,
+  bindXState
+};

package/package.json

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