@pluv/crdt-yjs 0.4.0 → 0.4.2

package/.turbo/turbo-build.log

@@ -1,17 +1,18 @@
 
-> @pluv/crdt-yjs@0.4.0 build /home/runner/work/pluv/pluv/packages/crdt-yjs
+> @pluv/crdt-yjs@0.4.2 build /home/runner/work/pluv/pluv/packages/crdt-yjs
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
-CLI tsup v7.0.0
+CLI tsup v7.1.0
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 3.68 KB
-ESM ⚡️ Build success in 95ms
 CJS dist/index.js 4.87 KB
-CJS ⚡️ Build success in 96ms
+CJS ⚡️ Build success in 73ms
+ESM dist/index.mjs 3.68 KB
+ESM ⚡️ Build success in 74ms
 DTS Build start
-DTS ⚡️ Build success in 2333ms
-DTS dist/index.d.ts 3.17 KB
+DTS ⚡️ Build success in 1374ms
+DTS dist/index.d.mts 3.11 KB
+DTS dist/index.d.ts  3.11 KB

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @pluv/crdt-yjs
 
+## 0.4.2
+
+### Patch Changes
+
+- f4317ba: \* Renamed type `unstable_YObjectValue` to `YObjectValue`;
+
+  - Renamed type `unstable_YObject` to `YObject`.
+  - Re-exported `xmlElement`, `xmlFragment` and `xmlText` from `@pluv/client`.
+
+    ```ts
+    import { y } from "@pluv/client";
+    // or
+    import { y } from "@pluv/react";
+
+    y.xmlElement("MyElement", {});
+    y.xmlFragment({});
+    y.xmlText("hello world");
+    ```
+
+## 0.4.1
+
+### Patch Changes
+
+- 8fba48b: fix including incorrect dependency
+- 8997c65: bumped dependencies
+- Updated dependencies [8fba48b]
+- Updated dependencies [8997c65]
+  - @pluv/types@0.2.2
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -0,0 +1,56 @@
+import { Array, AbstractType, Map, Text, XmlElement, XmlFragment, XmlText, Doc, Transaction } from 'yjs';
+export { AbstractType, Array, Map, Text } from 'yjs';
+import { JsonPrimitive } from '@pluv/types';
+
+declare const array: <T extends unknown>(value?: readonly T[]) => Array<T>;
+
+type YObjectValue = Record<string, NonNullable<JsonPrimitive> | AbstractType<any>>;
+type YObject<T extends YObjectValue> = Map<T[keyof T]> & {
+    __$type: T;
+};
+declare const object: <T extends YObjectValue = {}>(value: T) => 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 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();
+    constructor(value?: T);
+    applyUpdate(update?: string | Uint8Array | null, origin?: string): this;
+    destroy(): void;
+    encodeStateAsUpdate(): string;
+    get<TKey extends keyof T>(key: TKey): T[TKey];
+    getSharedTypes(): T;
+    subscribe(fn: (update: string, origin: any, doc: Doc, transaction: Transaction) => void): () => void;
+    toJSON(): InferYjsDocJson<this>;
+    transact(fn: (transaction: Transaction) => void, origin?: any): void;
+    static fromUint8Array(u8a: Uint8Array): string;
+    static toUint8Array(str: string): Uint8Array;
+}
+declare const doc: <T extends Record<string, AbstractType<any>> = {}>(value?: T | undefined) => YjsDoc<T>;
+
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => Map<T>;
+
+declare const text: (value?: string) => Text;
+
+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, XmlElementParams, XmlFragmentParams, YObject, YObjectValue, YjsDoc, array, doc, map, object, text, xmlElement, xmlFragment, xmlText };

package/dist/index.d.ts

@@ -1,14 +1,14 @@
-import { Array, Map, AbstractType, Text, XmlElement, XmlFragment, XmlText, Doc, Transaction } from 'yjs';
+import { Array, AbstractType, Map, Text, XmlElement, XmlFragment, XmlText, Doc, Transaction } from 'yjs';
 export { AbstractType, Array, Map, Text } from 'yjs';
 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 YObjectValue = Record<string, NonNullable<JsonPrimitive> | AbstractType<any>>;
+type YObject<T extends YObjectValue> = Map<T[keyof T]> & {
     __$type: T;
 };
-declare const object: <T extends unstable__YObjectValue = {}>(value: T) => unstable__YObject<T>;
+declare const object: <T extends YObjectValue = {}>(value: T) => YObject<T>;
 
 type InferYjsDocJson<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<infer ITypes> ? {
     [P in keyof ITypes]: InferYjsSharedTypeJson<ITypes[P]>;
@@ -16,7 +16,7 @@ type InferYjsDocJson<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<infer IType
 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> ? {
+type InferYjsSharedTypeJson<TShared extends unknown> = TShared extends AbstractType<any> ? TShared extends Array<infer IItem> ? readonly InferYjsSharedTypeJson<IItem>[] : TShared extends 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;
 
@@ -53,4 +53,4 @@ declare const xmlFragment: (params?: XmlFragmentParams) => XmlFragment;
 
 declare const xmlText: (value?: string) => XmlText;
 
-export { InferYjsDocJson, InferYjsDocSharedType, InferYjsDocSharedTypeJson, InferYjsDocSharedTypes, InferYjsSharedTypeJson, XmlElementParams, XmlFragmentParams, YjsDoc, array, doc, map, object, text, unstable__YObject, xmlElement, xmlFragment, xmlText };
+export { InferYjsDocJson, InferYjsDocSharedType, InferYjsDocSharedTypeJson, InferYjsDocSharedTypes, InferYjsSharedTypeJson, XmlElementParams, XmlFragmentParams, YObject, YObjectValue, YjsDoc, array, doc, map, object, text, xmlElement, xmlFragment, xmlText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/crdt-yjs",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "yjs for @pluv/io",
   "author": "leedavidcs",
   "license": "MIT",
@@ -17,20 +17,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@playwright/test": "^1.35.1",
-    "@types/react": "^18.2.13",
+    "@types/react": "^18.2.15",
     "js-base64": "^3.7.5",
-    "@pluv/types": "^0.2.1"
+    "@pluv/types": "^0.2.2"
   },
   "peerDependencies": {
     "yjs": "^13.0.0"
   },
   "devDependencies": {
-    "tsup": "^7.0.0",
-    "typescript": "^5.1.3",
-    "yjs": "^13.6.4",
-    "@pluv/tsconfig": "^0.1.7",
-    "eslint-config-pluv": "^0.1.13"
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "yjs": "^13.6.7",
+    "@pluv/tsconfig": "^0.2.0",
+    "eslint-config-pluv": "^0.1.14"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/array.ts

@@ -1,7 +1,7 @@
 import { Array as YArray } from "yjs";
 
 export const array = <T extends unknown>(
-    value: readonly T[] = []
+    value: readonly T[] = [],
 ): YArray<T> => {
     const yarray = new YArray<T>();
 

package/src/doc.ts

@@ -28,7 +28,7 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
 
     public applyUpdate(
         update?: string | Uint8Array | null,
-        origin?: string
+        origin?: string,
     ): this {
         if (update === null || typeof update === "undefined") return this;
 
@@ -55,7 +55,7 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
     public getSharedTypes(): T {
         return Array.from(this._storage.keys()).reduce(
             (acc, key) => ({ ...acc, [key]: this._storage.get(key) }),
-            {} as T
+            {} as T,
         );
     }
 
@@ -64,14 +64,14 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
             update: string,
             origin: any,
             doc: YDoc,
-            transaction: Transaction
-        ) => void
+            transaction: Transaction,
+        ) => void,
     ): () => void {
         const _fn = (
             update: Uint8Array,
             origin: any,
             doc: YDoc,
-            transaction: Transaction
+            transaction: Transaction,
         ) => fn(YjsDoc.fromUint8Array(update), origin, doc, transaction);
 
         this.value.on("update", _fn);
@@ -87,7 +87,7 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
 
     public transact(
         fn: (transaction: Transaction) => void,
-        origin?: any
+        origin?: any,
     ): void {
         this.value.transact((tx) => {
             fn(tx);
@@ -104,7 +104,7 @@ export class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
 }
 
 export const doc = <T extends Record<string, AbstractType<any>> = {}>(
-    value?: T
+    value?: T,
 ): YjsDoc<T> => {
     return new YjsDoc(value);
 };

package/src/index.ts

@@ -1,15 +1,10 @@
 export type { AbstractType, Array, Map, Text } from "yjs";
 export { array } from "./array";
-export { doc, YjsDoc } from "./doc";
+export { YjsDoc, doc } from "./doc";
 export { map } from "./map";
-export type { unstable__YObject } from "./object";
 export { object } from "./object";
+export type { YObject, YObjectValue } 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,
@@ -17,3 +12,8 @@ export type {
     InferYjsDocSharedTypes,
     InferYjsSharedTypeJson,
 } from "./types";
+export { xmlElement } from "./xmlElement";
+export type { XmlElementParams } from "./xmlElement";
+export { xmlFragment } from "./xmlFragment";
+export type { XmlFragmentParams } from "./xmlFragment";
+export { xmlText } from "./xmlText";

package/src/map.ts

@@ -1,7 +1,7 @@
 import { Map as YMap } from "yjs";
 
 export const map = <T extends unknown>(
-    value: readonly (readonly [key: string, value: T])[] = []
+    value: readonly (readonly [key: string, value: T])[] = [],
 ): YMap<T> => {
     return new YMap(value);
 };

package/src/object.ts

@@ -2,17 +2,15 @@ import type { JsonPrimitive } from "@pluv/types";
 import type { AbstractType } from "yjs";
 import { Map as YMap } from "yjs";
 
-export type unstable__YObjectValue = Record<
+export type YObjectValue = Record<
     string,
     NonNullable<JsonPrimitive> | AbstractType<any>
 >;
 
-export type unstable__YObject<T extends unstable__YObjectValue> = YMap<
-    T[keyof T]
-> & { __$type: T };
+export type YObject<T extends YObjectValue> = YMap<T[keyof T]> & {
+    __$type: T;
+};
 
-export const object = <T extends unstable__YObjectValue = {}>(
-    value: T
-): unstable__YObject<T> => {
-    return new YMap(Object.entries(value)) as unstable__YObject<T>;
+export const object = <T extends YObjectValue = {}>(value: T): YObject<T> => {
+    return new YMap(Object.entries(value)) as YObject<T>;
 };

package/src/types.ts

@@ -8,7 +8,7 @@ import type {
     XmlText as YXmlText,
 } from "yjs";
 import type { YjsDoc } from "./doc";
-import type { unstable__YObject } from "./object";
+import type { YObject } from "./object";
 
 export type InferYjsDocJson<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<
     infer ITypes
@@ -18,12 +18,14 @@ export type InferYjsDocJson<TDoc extends YjsDoc<any>> = TDoc extends YjsDoc<
 
 export type InferYjsDocSharedType<
     TDoc extends YjsDoc<any>,
-    TKey extends keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>
+    TKey extends
+        keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>,
 > = InferYjsDocSharedTypes<TDoc>[TKey];
 
 export type InferYjsDocSharedTypeJson<
     TDoc extends YjsDoc<any>,
-    TKey extends keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>
+    TKey extends
+        keyof InferYjsDocSharedTypes<TDoc> = keyof InferYjsDocSharedTypes<TDoc>,
 > = InferYjsSharedTypeJson<InferYjsDocSharedTypes<TDoc>[TKey]>;
 
 export type InferYjsDocSharedTypes<TDoc extends YjsDoc<any>> =
@@ -33,7 +35,7 @@ export type InferYjsSharedTypeJson<TShared extends unknown> =
     TShared extends AbstractType<any>
         ? TShared extends YArray<infer IItem>
             ? readonly InferYjsSharedTypeJson<IItem>[]
-            : TShared extends unstable__YObject<infer IObject>
+            : TShared extends YObject<infer IObject>
             ? { [P in keyof IObject]: InferYjsSharedTypeJson<IObject[P]> }
             : TShared extends YMap<infer IItem>
             ? Record<string, InferYjsSharedTypeJson<IItem>>

package/src/xmlElement.ts

@@ -7,7 +7,7 @@ export interface XmlElementParams {
 
 export const xmlElement = (
     name: string,
-    params: XmlElementParams = {}
+    params: XmlElementParams = {},
 ): YXmlElement => {
     const { children = [] } = params;