@pluv/crdt-yjs 0.1.2 → 0.2.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/crdt-yjs@0.1.2 build /home/runner/work/pluv/pluv/packages/crdt-yjs
+> @pluv/crdt-yjs@0.2.0 build /home/runner/work/pluv/pluv/packages/crdt-yjs
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 2.88 KB
+ESM dist/index.mjs 3.52 KB
 ESM ⚡️ Build success in 65ms
-CJS dist/index.js 4.01 KB
-CJS ⚡️ Build success in 68ms
+CJS dist/index.js 4.73 KB
+CJS ⚡️ Build success in 76ms
 DTS Build start
-DTS ⚡️ Build success in 1783ms
-DTS dist/index.d.ts 2.61 KB
+DTS ⚡️ Build success in 1515ms
+DTS dist/index.d.ts 3.11 KB

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @pluv/crdt-yjs
 
+## 0.2.0
+
+### Minor Changes
+
+- 6858682: Added support for yjs xml types including XmlElement, XmlFragment and XmlText
+
+### Patch Changes
+
+- @pluv/types@0.1.2
+
+## 0.1.3
+
+### Patch Changes
+
+- fe80d7b: added preview disclaimer about breaking changes in the readme
+- Updated dependencies [fe80d7b]
+  - @pluv/types@0.1.2
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -1,3 +1,6 @@
+> **Disclaimer:**
+> This package is currently in preview and may have breaking changes between versions. Please wait for a `v1.0.0` stable release before using this in production.
+
 <h1 align="center">
   <br>
   <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="180" style="border-radius:16px">
@@ -23,7 +26,9 @@
   <img src="https://img.shields.io/badge/docs-coming%20soon!-blue" alt="Docs coming soon!" />
 </p>
 
-<img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
+<p align="center">
+  <img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
+</p>
 
 ## `@pluv/crdt-yjs`
 
@@ -49,6 +54,11 @@ pnpm add @pluv/crdt-yjs yjs
 
 ```ts
 import { createClient, y } from "@pluv/client";
+import type {
+    Array as YArray,
+    Map as YMap,
+    XmlFragment as YXmlFragment,
+} from "yjs";
 import { z } from "zod";
 // Import the PluvIO instance as a type from your server file
 import { type io } from "./server";
@@ -58,13 +68,21 @@ const client = createClient<typeof io>({ /* client config here */ });
 type Presence = {};
 
 interface Storage {
-    groceryList: { [food: string]: number };
-    messages: readonly { name: string; message: string }[]
+    editor: YXmlFragment;
+    groceryList: YMap<string, number>;
+    messages: YArray<{ name: string; message: string }>;
 }
 
 // Create a room to join
 const room = client.createRoom<Presence, Storage>("my-room", {
     initialStorage: () => ({
+        editor: y.xmlFragment({
+            children: [
+                y.xmlElement("paragraph", {
+                  children: [y.xmlText("Hello World!")],
+                }),
+            ]
+        }),
         groceryList: y.map([
             ["apricots", 2],
             ["bread", 3],

package/dist/index.d.ts

@@ -1,9 +1,25 @@
-import { Array, AbstractType, Doc, Transaction, Map, Text } from 'yjs';
+import { Array, Map, AbstractType, Text, XmlElement, XmlFragment, XmlText, Doc, Transaction } from 'yjs';
 export { AbstractType, Array, Map, Text } from 'yjs';
-import { JsonObject, JsonPrimitive } from '@pluv/types';
+import { JsonPrimitive } from '@pluv/types';
 
 declare const array: <T extends unknown>(value?: readonly T[]) => Array<T>;
 
+type unstable__YObjectValue = Record<string, NonNullable<JsonPrimitive> | AbstractType<any>>;
+type unstable__YObject<T extends unstable__YObjectValue> = Map<T[keyof T]> & {
+    __$type: T;
+};
+declare const unstable__object: <T extends unstable__YObjectValue = {}>(value: T) => unstable__YObject<T>;
+
+type InferYjsDocJson<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<infer ITypes> ? {
+    [P in keyof ITypes]: InferYjsSharedTypeJson<ITypes[P]>;
+} : never;
+type InferYjsDocSharedType<TDoc extends YjsDoc<any>, TKey extends keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>> = InferYjsDocSharedTypes<TDoc>[TKey];
+type InferYjsDocSharedTypeJson<TDoc extends YjsDoc<any>, TKey extends keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>> = InferYjsSharedTypeJson<InferYjsDocSharedTypes<TDoc>[TKey]>;
+type InferYjsDocSharedTypes<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<infer ITypes> ? ITypes : never;
+type InferYjsSharedTypeJson<TShared extends unknown> = TShared extends AbstractType<any> ? TShared extends Array<infer IItem> ? readonly InferYjsSharedTypeJson<IItem>[] : TShared extends unstable__YObject<infer IObject> ? {
+    [P in keyof IObject]: InferYjsSharedTypeJson<IObject[P]>;
+} : TShared extends Map<infer IItem> ? Record<string, InferYjsSharedTypeJson<IItem>> : TShared extends Text | XmlElement | XmlFragment | XmlText ? string : never : TShared;
+
 declare class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
     value: Doc;
     private get _storage();
@@ -14,7 +30,7 @@ declare class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
     get<TKey extends keyof T>(key: TKey): T[TKey];
     getSharedTypes(): T;
     subscribe(fn: (update: string, origin: string, doc: Doc, transaction: Transaction) => void): () => void;
-    toJSON(): JsonObject;
+    toJSON(): InferYjsDocJson<this>;
     static fromUint8Array(u8a: Uint8Array): string;
     static toUint8Array(str: string): Uint8Array;
 }
@@ -22,22 +38,18 @@ declare const doc: <T extends Record<string, AbstractType<any>> = {}>(value?: T
 
 declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => Map<T>;
 
-type unstable__YObjectValue = Record<string, NonNullable<JsonPrimitive> | AbstractType<any>>;
-type unstable__YObject<T extends unstable__YObjectValue> = Map<T[keyof T]> & {
-    __$type: T;
-};
-declare const unstable__object: <T extends unstable__YObjectValue = {}>(value: T) => unstable__YObject<T>;
-
 declare const text: (value?: string) => Text;
 
-type InferYjsDocJson<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<infer ITypes> ? {
-    [P in keyof ITypes]: InferYjsSharedTypeJson<ITypes[P]>;
-} : never;
-type InferYjsDocSharedType<TDoc extends YjsDoc<any>, TKey extends keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>> = InferYjsDocSharedTypes<TDoc>[TKey];
-type InferYjsDocSharedTypeJson<TDoc extends YjsDoc<any>, TKey extends keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>> = InferYjsSharedTypeJson<InferYjsDocSharedTypes<TDoc>[TKey]>;
-type InferYjsDocSharedTypes<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<infer ITypes> ? ITypes : never;
-type InferYjsSharedTypeJson<TShared extends unknown> = TShared extends AbstractType<any> ? TShared extends Array<infer IItem> ? readonly InferYjsSharedTypeJson<IItem>[] : TShared extends unstable__YObject<infer IObject> ? {
-    [P in keyof IObject]: InferYjsSharedTypeJson<IObject[P]>;
-} : TShared extends Map<infer IItem> ? Record<string, InferYjsSharedTypeJson<IItem>> : TShared extends Text ? string : never : TShared;
+interface XmlElementParams {
+    children?: readonly (XmlElement | XmlText)[];
+}
+declare const xmlElement: (name: string, params?: XmlElementParams) => XmlElement;
+
+interface XmlFragmentParams {
+    children?: readonly (XmlElement | XmlText)[];
+}
+declare const xmlFragment: (params?: XmlFragmentParams) => XmlFragment;
+
+declare const xmlText: (value?: string) => XmlText;
 
-export { InferYjsDocJson, InferYjsDocSharedType, InferYjsDocSharedTypeJson, InferYjsDocSharedTypes, InferYjsSharedTypeJson, YjsDoc, array, doc, map, text, unstable__YObject, unstable__object };
+export { InferYjsDocJson, InferYjsDocSharedType, InferYjsDocSharedTypeJson, InferYjsDocSharedTypes, InferYjsSharedTypeJson, XmlElementParams, XmlFragmentParams, YjsDoc, array, doc, map, text, unstable__YObject, unstable__object, xmlElement, xmlFragment, xmlText };

package/dist/index.js

@@ -42,7 +42,10 @@ __export(src_exports, {
   doc: () => doc,
   map: () => map,
   text: () => text,
-  unstable__object: () => unstable__object
+  unstable__object: () => unstable__object,
+  xmlElement: () => xmlElement,
+  xmlFragment: () => xmlFragment,
+  xmlText: () => xmlText
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -128,6 +131,30 @@ var import_yjs5 = require("yjs");
 var text = (value = "") => {
   return new import_yjs5.Text(value);
 };
+
+// src/xmlElement.ts
+var import_yjs6 = require("yjs");
+var xmlElement = (name, params = {}) => {
+  const { children = [] } = params;
+  const element = new import_yjs6.XmlElement(name);
+  element.push(children.slice());
+  return element;
+};
+
+// src/xmlFragment.ts
+var import_yjs7 = require("yjs");
+var xmlFragment = (params = {}) => {
+  const { children = [] } = params;
+  const fragment = new import_yjs7.XmlFragment();
+  fragment.push(children.slice());
+  return fragment;
+};
+
+// src/xmlText.ts
+var import_yjs8 = require("yjs");
+var xmlText = (value = "") => {
+  return new import_yjs8.XmlText(value);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   YjsDoc,
@@ -135,5 +162,8 @@ var text = (value = "") => {
   doc,
   map,
   text,
-  unstable__object
+  unstable__object,
+  xmlElement,
+  xmlFragment,
+  xmlText
 });

package/dist/index.mjs

@@ -100,11 +100,38 @@ import { Text as YText } from "yjs";
 var text = (value = "") => {
   return new YText(value);
 };
+
+// src/xmlElement.ts
+import { XmlElement as YXmlElement } from "yjs";
+var xmlElement = (name, params = {}) => {
+  const { children = [] } = params;
+  const element = new YXmlElement(name);
+  element.push(children.slice());
+  return element;
+};
+
+// src/xmlFragment.ts
+import { XmlFragment as YXmlFragment } from "yjs";
+var xmlFragment = (params = {}) => {
+  const { children = [] } = params;
+  const fragment = new YXmlFragment();
+  fragment.push(children.slice());
+  return fragment;
+};
+
+// src/xmlText.ts
+import { XmlText as YXmlText } from "yjs";
+var xmlText = (value = "") => {
+  return new YXmlText(value);
+};
 export {
   YjsDoc,
   array,
   doc,
   map,
   text,
-  unstable__object
+  unstable__object,
+  xmlElement,
+  xmlFragment,
+  xmlText
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/crdt-yjs",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "yjs for @pluv/io",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,18 +17,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@pluv/types": "^0.1.1",
-    "js-base64": "^3.7.4"
+    "js-base64": "^3.7.4",
+    "@pluv/types": "^0.1.2"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "@pluv/tsconfig": "^0.1.1",
-    "eslint-config-pluv": "^0.1.1",
     "tsup": "^6.5.0",
     "typescript": "^4.9.4",
-    "yjs": "^13.5.44"
+    "yjs": "^13.5.44",
+    "@pluv/tsconfig": "^0.1.2",
+    "eslint-config-pluv": "^0.1.3"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/doc.ts

@@ -1,7 +1,7 @@
-import type { JsonObject } from "@pluv/types";
 import { fromUint8Array, toUint8Array } from "js-base64";
 import type { AbstractType, Map as YMap, Transaction } from "yjs";
 import { applyUpdate, Doc as YDoc, encodeStateAsUpdate } from "yjs";
+import type { InferYjsDocJson } from "./types";
 
 export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
     public value: YDoc = new YDoc();
@@ -70,8 +70,8 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
         };
     }
 
-    public toJSON(): JsonObject {
-        return this._storage.toJSON();
+    public toJSON(): InferYjsDocJson<this> {
+        return this._storage.toJSON() as InferYjsDocJson<this>;
     }
 
     public static fromUint8Array(u8a: Uint8Array): string {

package/src/index.ts

@@ -5,6 +5,11 @@ export { map } from "./map";
 export type { unstable__YObject } from "./object";
 export { unstable__object } from "./object";
 export { text } from "./text";
+export type { XmlElementParams } from "./xmlElement";
+export { xmlElement } from "./xmlElement";
+export type { XmlFragmentParams } from "./xmlFragment";
+export { xmlFragment } from "./xmlFragment";
+export { xmlText } from "./xmlText";
 export type {
     InferYjsDocJson,
     InferYjsDocSharedType,

package/src/types.ts

@@ -3,6 +3,9 @@ import type {
     Array as YArray,
     Map as YMap,
     Text as YText,
+    XmlElement as YXmlElement,
+    XmlFragment as YXmlFragment,
+    XmlText as YXmlText,
 } from "yjs";
 import type { YjsDoc } from "./doc";
 import type { unstable__YObject } from "./object";
@@ -34,7 +37,7 @@ export type InferYjsSharedTypeJson<TShared extends unknown> =
             ? { [P in keyof IObject]: InferYjsSharedTypeJson<IObject[P]> }
             : TShared extends YMap<infer IItem>
             ? Record<string, InferYjsSharedTypeJson<IItem>>
-            : TShared extends YText
+            : TShared extends YText | YXmlElement | YXmlFragment | YXmlText
             ? string
             : never
         : TShared;

package/src/xmlElement.ts

@@ -0,0 +1,19 @@
+import type { XmlText as YXmlText } from "yjs";
+import { XmlElement as YXmlElement } from "yjs";
+
+export interface XmlElementParams {
+    children?: readonly (YXmlElement | YXmlText)[];
+}
+
+export const xmlElement = (
+    name: string,
+    params: XmlElementParams = {}
+): YXmlElement => {
+    const { children = [] } = params;
+
+    const element = new YXmlElement(name);
+
+    element.push(children.slice());
+
+    return element;
+};

package/src/xmlFragment.ts

@@ -0,0 +1,16 @@
+import type { XmlElement as YXmlElement, XmlText as YXmlText } from "yjs";
+import { XmlFragment as YXmlFragment } from "yjs";
+
+export interface XmlFragmentParams {
+    children?: readonly (YXmlElement | YXmlText)[];
+}
+
+export const xmlFragment = (params: XmlFragmentParams = {}): YXmlFragment => {
+    const { children = [] } = params;
+
+    const fragment = new YXmlFragment();
+
+    fragment.push(children.slice());
+
+    return fragment;
+};

package/src/xmlText.ts

@@ -0,0 +1,5 @@
+import { XmlText as YXmlText } from "yjs";
+
+export const xmlText = (value: string = ""): YXmlText => {
+    return new YXmlText(value);
+};