@coaction/yjs 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,40 @@
+# @coaction/yjs
+
+![Node CI](https://github.com/unadlib/coaction/workflows/Node%20CI/badge.svg)
+[![npm](https://img.shields.io/npm/v/@coaction/yjs.svg)](https://www.npmjs.com/package/@coaction/yjs)
+![license](https://img.shields.io/npm/l/@coaction/yjs)
+
+A Coaction integration tool for Yjs.
+
+## Installation
+
+You can install it via npm, yarn or pnpm.
+
+```sh
+npm install coaction @coaction/yjs
+```
+
+## Usage
+
+```ts
+import { create } from 'coaction';
+import { yjs } from '@coaction/yjs';
+
+const store = create(
+  (set) => ({
+    count: 0,
+    increment() {
+      set((draft) => {
+        draft.count += 1;
+      });
+    }
+  }),
+  {
+    middlewares: [yjs()]
+  }
+);
+```
+
+## Documentation
+
+You can find the documentation [here](https://github.com/unadlib/coaction).

package/dist/index.d.mts

@@ -0,0 +1,18 @@
+import { Store, Middleware } from 'coaction';
+import * as Y from 'yjs';
+export * from 'yjs';
+
+type YjsBindingOptions = {
+    doc?: Y.Doc;
+    key?: string;
+};
+type YjsBinding<T extends object> = {
+    doc: Y.Doc;
+    map: Y.Map<any>;
+    syncNow: () => void;
+    destroy: () => void;
+};
+declare const bindYjs: <T extends object>(store: Store<T>, options?: YjsBindingOptions) => YjsBinding<T>;
+declare const yjs: <T extends object>(options?: YjsBindingOptions) => Middleware<T>;
+
+export { type YjsBinding, type YjsBindingOptions, bindYjs, yjs };

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { Store, Middleware } from 'coaction';
+import * as Y from 'yjs';
+export * from 'yjs';
+
+type YjsBindingOptions = {
+    doc?: Y.Doc;
+    key?: string;
+};
+type YjsBinding<T extends object> = {
+    doc: Y.Doc;
+    map: Y.Map<any>;
+    syncNow: () => void;
+    destroy: () => void;
+};
+declare const bindYjs: <T extends object>(store: Store<T>, options?: YjsBindingOptions) => YjsBinding<T>;
+declare const yjs: <T extends object>(options?: YjsBindingOptions) => Middleware<T>;
+
+export { type YjsBinding, type YjsBindingOptions, bindYjs, yjs };

package/dist/index.js

@@ -0,0 +1,120 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  bindYjs: () => bindYjs,
+  yjs: () => yjs
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  bindYjs: () => bindYjs,
+  yjs: () => yjs
+});
+var Y = __toESM(require("yjs"));
+__reExport(src_exports, require("yjs"));
+var ORIGIN = /* @__PURE__ */ Symbol("coaction-yjs");
+function clone(value) {
+  if (typeof structuredClone === "function") {
+    return structuredClone(value);
+  }
+  return JSON.parse(JSON.stringify(value));
+}
+var bindYjs = (store, options = {}) => {
+  if (store.share === "client") {
+    throw new Error("Yjs binding is not supported in client store mode.");
+  }
+  const doc = options.doc ?? new Y.Doc();
+  const key = options.key ?? `coaction:${store.name}`;
+  const map = doc.getMap(key);
+  const syncNow = () => {
+    const pureState = clone(store.getPureState());
+    doc.transact(() => {
+      map.set("state", pureState);
+    }, ORIGIN);
+  };
+  const syncFromYjs = () => {
+    const incoming = map.get("state");
+    if (typeof incoming !== "object" || incoming === null) {
+      return;
+    }
+    store.setState(clone(incoming));
+  };
+  if (map.has("state")) {
+    syncFromYjs();
+  } else {
+    syncNow();
+  }
+  const observer = (event) => {
+    if (event.transaction.origin === ORIGIN) {
+      return;
+    }
+    if (event.keysChanged.has("state")) {
+      syncFromYjs();
+    }
+  };
+  map.observe(observer);
+  const unsubscribe = store.subscribe(() => {
+    syncNow();
+  });
+  return {
+    doc,
+    map,
+    syncNow,
+    destroy: () => {
+      unsubscribe();
+      map.unobserve(observer);
+      if (!options.doc) {
+        doc.destroy();
+      }
+    }
+  };
+};
+var yjs = (options = {}) => (store) => {
+  const binding = bindYjs(store, options);
+  const baseDestroy = store.destroy;
+  store.destroy = () => {
+    binding.destroy();
+    baseDestroy();
+  };
+  return store;
+};
+
+// index.ts
+__reExport(index_exports, src_exports, module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  bindYjs,
+  yjs
+});

package/dist/index.mjs

@@ -0,0 +1,107 @@
+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, {
+  bindYjs: () => bindYjs,
+  yjs: () => yjs
+});
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  bindYjs: () => bindYjs,
+  yjs: () => yjs
+});
+__reExport(src_exports, yjs_star);
+import * as Y from "yjs";
+import * as yjs_star from "yjs";
+var ORIGIN = /* @__PURE__ */ Symbol("coaction-yjs");
+function clone(value) {
+  if (typeof structuredClone === "function") {
+    return structuredClone(value);
+  }
+  return JSON.parse(JSON.stringify(value));
+}
+var bindYjs = (store, options = {}) => {
+  if (store.share === "client") {
+    throw new Error("Yjs binding is not supported in client store mode.");
+  }
+  const doc = options.doc ?? new Y.Doc();
+  const key = options.key ?? `coaction:${store.name}`;
+  const map = doc.getMap(key);
+  const syncNow = () => {
+    const pureState = clone(store.getPureState());
+    doc.transact(() => {
+      map.set("state", pureState);
+    }, ORIGIN);
+  };
+  const syncFromYjs = () => {
+    const incoming = map.get("state");
+    if (typeof incoming !== "object" || incoming === null) {
+      return;
+    }
+    store.setState(clone(incoming));
+  };
+  if (map.has("state")) {
+    syncFromYjs();
+  } else {
+    syncNow();
+  }
+  const observer = (event) => {
+    if (event.transaction.origin === ORIGIN) {
+      return;
+    }
+    if (event.keysChanged.has("state")) {
+      syncFromYjs();
+    }
+  };
+  map.observe(observer);
+  const unsubscribe = store.subscribe(() => {
+    syncNow();
+  });
+  return {
+    doc,
+    map,
+    syncNow,
+    destroy: () => {
+      unsubscribe();
+      map.unobserve(observer);
+      if (!options.doc) {
+        doc.destroy();
+      }
+    }
+  };
+};
+var yjs = (options = {}) => (store) => {
+  const binding = bindYjs(store, options);
+  const baseDestroy = store.destroy;
+  store.destroy = () => {
+    binding.destroy();
+    baseDestroy();
+  };
+  return store;
+};
+
+// index.ts
+__reExport(index_exports, src_exports);
+export {
+  bindYjs,
+  yjs
+};

package/package.json

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