@pluv/crdt-yjs 5.0.0 → 5.0.2

package/src/provider/PluvYjsProvider.ts

@@ -1,132 +0,0 @@
-import type { CrdtType, IOLike, PluvRouterEventConfig, RoomLike } from "@pluv/types";
-import { StorageState } from "@pluv/types";
-import { ObservableV2 } from "lib0/observable";
-import type { Doc as YDoc } from "yjs";
-import type { PluvYjsAwareness } from "../awareness";
-import { awareness } from "../awareness";
-import type { YjsProviderStatus } from "../types";
-
-export interface PluvYjsProviderParams<
-    TIO extends IOLike<any, any, any>,
-    TPresence extends Record<string, any>,
-    TStorage extends Record<string, CrdtType<any, any>>,
-    TEvents extends PluvRouterEventConfig,
-    TField extends keyof TPresence | null = null,
-> {
-    presenceField?: TField;
-    room: RoomLike<TIO, YDoc, TPresence, TStorage, TEvents>;
-}
-
-/**
- * !HACK
- * @description This doesn't really do anything but emit states in a Yjs.Provider compatible way.
- * Connections and document syncing are handled by the PluvRoom already.
- * @date May 13, 2025
- */
-export class PluvYjsProvider<
-    TIO extends IOLike<any, any, any>,
-    TPresence extends Record<string, any>,
-    TStorage extends Record<string, CrdtType<any, any>>,
-    TEvents extends PluvRouterEventConfig,
-    TField extends keyof TPresence | null = null,
-> extends ObservableV2<{
-    "connection-close": (
-        event: CloseEvent | null,
-        provider: PluvYjsProvider<TIO, TPresence, TStorage, TEvents, TField>,
-    ) => void;
-    "connection-error": (
-        event: Event,
-        provider: PluvYjsProvider<TIO, TPresence, TStorage, TEvents, TField>,
-    ) => void;
-    status: (event: { status: YjsProviderStatus }) => void;
-    sync: (state: boolean) => void;
-    synced: (state: boolean) => void;
-}> {
-    public readonly awareness: PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>;
-    public readonly doc: YDoc;
-
-    private readonly _room: RoomLike<TIO, YDoc, TPresence, TStorage, TEvents>;
-    private readonly _unsubscribe: () => void;
-
-    private _synced: boolean = false;
-
-    constructor(params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>) {
-        super();
-
-        const { presenceField, room } = params;
-
-        this.awareness = awareness({ presenceField, room });
-        this.doc = room.getDoc().value;
-
-        this._room = room;
-
-        const subscriptions = [
-            this._room.subscribe.connection(({ storage }) => {
-                const status = this._toProviderStatus(storage.state);
-
-                if (!status) return;
-
-                this.emit("status", [{ status }]);
-            }),
-            this._room.addEventListener("close", (event) => {
-                this.emit("connection-close", [event, this]);
-            }),
-            this._room.addEventListener("error", (event) => {
-                this.emit("connection-error", [event, this]);
-            }),
-        ];
-
-        this._unsubscribe = subscriptions.reduce(
-            (fn, unsubscribe) => () => {
-                fn();
-                unsubscribe();
-            },
-            () => undefined,
-        );
-    }
-
-    public get synced(): boolean {
-        return this._synced;
-    }
-
-    public set synced(state: boolean) {
-        if (this._synced === state) return;
-
-        this._synced = state;
-        this.emit("sync", [state]);
-        this.emit("synced", [state]);
-    }
-
-    public destroy(): void {
-        this.awareness.destroy();
-        this._unsubscribe();
-        super.destroy();
-    }
-
-    private _toProviderStatus(state: StorageState): YjsProviderStatus | null {
-        switch (state) {
-            case StorageState.Loading: {
-                return "connecting";
-            }
-            case StorageState.Unavailable: {
-                return "disconnected";
-            }
-            case StorageState.Offline:
-            case StorageState.Synced: {
-                return "connected";
-            }
-            default:
-                return null;
-        }
-    }
-
-    /**
-     * !HACK
-     * @description We dgaf about these, since the room manages these already. We're just mirroring
-     * the fields that exist in the og provider to make sure everything aligns.
-     * @see https://github.com/yjs/y-websocket/blob/master/src/y-websocket.js
-     * @date May 13, 2025
-     */
-    public connect(): void {}
-    public disconnect(): void {}
-}

package/src/provider/index.ts

@@ -1,2 +0,0 @@
-export type { PluvYjsProvider } from "./PluvYjsProvider";
-export { provider } from "./provider";

package/src/provider/provider.ts

@@ -1,15 +0,0 @@
-import type { CrdtType, IOLike, PluvRouterEventConfig } from "@pluv/types";
-import type { PluvYjsProviderParams } from "./PluvYjsProvider";
-import { PluvYjsProvider } from "./PluvYjsProvider";
-
-export const provider = <
-    TIO extends IOLike<any, any, any>,
-    TPresence extends Record<string, any>,
-    TStorage extends Record<string, CrdtType<any, any>>,
-    TEvents extends PluvRouterEventConfig,
-    TField extends keyof TPresence | null = null,
->(
-    params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>,
-) => {
-    return new PluvYjsProvider(params);
-};

package/src/text/YjsText.ts

@@ -1,16 +0,0 @@
-import { Text as YText } from "yjs";
-import type { YjsType } from "../types";
-
-export class YjsText extends YText implements YjsType<YText, string> {
-    public initialValue?: string;
-
-    constructor(value: string = "") {
-        super();
-
-        this.initialValue = value;
-    }
-
-    public __pluvType() {
-        return {} as unknown as any;
-    }
-}

package/src/text/index.ts

@@ -1,2 +0,0 @@
-export { text } from "./text";
-export type { YjsText } from "./YjsText";

package/src/text/text.ts

@@ -1,7 +0,0 @@
-import type { Text as YText } from "yjs";
-import type { YjsType } from "../types";
-import { YjsText } from "./YjsText";
-
-export const text = (value: string = ""): YjsType<YText, string> => {
-    return new YjsText(value);
-};

package/src/types.ts

@@ -1,35 +0,0 @@
-import type { CrdtType } from "@pluv/crdt";
-
-export type YjsType<TValue extends unknown, TJson extends unknown = any> = CrdtType<
-    TValue,
-    TJson
-> & {
-    initialValue?: any;
-    toJSON: () => any;
-};
-
-/**
- * @description Type internally defined by Yjs.Awareness
- * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
- */
-export interface YjsAwarenessUpdate {
-    added: number[];
-    updated: number[];
-    removed: number[];
-}
-
-export type YjsProviderStatus = "connecting" | "connected" | "disconnected";
-
-/**
- * @description Type internally defined by Yjs.Awareness
- * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
- */
-export interface MetaClientState {
-    clock: number;
-    lastUpdated: number;
-}
-
-export type AwarenessPresence<
-    TPresence extends Record<string, any>,
-    TField extends keyof TPresence | null,
-> = TField extends null ? TPresence : TField extends keyof TPresence ? TPresence[TField] : never;

package/src/utils/index.ts

@@ -1 +0,0 @@
-export { oneLine } from "./oneLine";

package/src/utils/oneLine.ts

@@ -1,7 +0,0 @@
-export const oneLine = (strings: TemplateStringsArray, ...values: unknown[]): string => {
-    return strings
-        .map((str) => str.replace(/\s+/g, " "))
-        .reduce((acc, str, i) => acc + str + (i < values.length ? values[i] : ""), "")
-        .replace(/\s+/g, " ")
-        .trim();
-};

package/src/xmlElement/YjsXmlElement.ts

@@ -1,25 +0,0 @@
-import type { XmlText as YXmlText } from "yjs";
-import { XmlElement as YXmlElement } from "yjs";
-import type { YjsType } from "../types";
-
-export class YjsXmlElement<T extends Record<string, any> = Record<string, any>>
-    extends YXmlElement<T>
-    implements YjsType<YXmlElement, string>
-{
-    public initialValue?: (YXmlElement | YXmlText)[] | readonly (YXmlElement | YXmlText)[];
-
-    constructor(
-        name: string,
-        value: (YXmlElement | YXmlText)[] | readonly (YXmlElement | YXmlText)[],
-    ) {
-        super(name);
-
-        if (!!value.length) this.insert(0, value as (YXmlElement | YXmlText)[]);
-
-        this.initialValue = value;
-    }
-
-    public __pluvType() {
-        return {} as unknown as any;
-    }
-}

package/src/xmlElement/index.ts

@@ -1,2 +0,0 @@
-export { xmlElement } from "./xmlElement";
-export type { YjsXmlElement } from "./YjsXmlElement";

package/src/xmlElement/xmlElement.ts

@@ -1,9 +0,0 @@
-import type { XmlText as YXmlText, XmlElement as YXmlElement } from "yjs";
-import { YjsXmlElement } from "./YjsXmlElement";
-
-export const xmlElement = <T extends Record<string, any> = Record<string, any>>(
-    name: string,
-    children: (YXmlElement | YXmlText)[] | readonly (YXmlElement | YXmlText)[],
-): YjsXmlElement<T> => {
-    return new YjsXmlElement<T>(name, children);
-};

package/src/xmlFragment/YjsXmlFragment.ts

@@ -1,19 +0,0 @@
-import type { XmlText as YXmlText, XmlElement as YXmlElement } from "yjs";
-import { XmlFragment as YXmlFragment } from "yjs";
-import type { YjsType } from "../types";
-
-export class YjsXmlFragment extends YXmlFragment implements YjsType<YXmlFragment, string> {
-    public initialValue?: (YXmlElement | YXmlText)[] | readonly (YXmlElement | YXmlText)[];
-
-    constructor(value: (YXmlElement | YXmlText)[] | readonly (YXmlElement | YXmlText)[]) {
-        super();
-
-        if (!!value.length) this.insert(0, value as (YXmlElement | YXmlText)[]);
-
-        this.initialValue = value;
-    }
-
-    public __pluvType() {
-        return {} as unknown as any;
-    }
-}

package/src/xmlFragment/index.ts

@@ -1,2 +0,0 @@
-export { xmlFragment } from "./xmlFragment";
-export type { YjsXmlFragment } from "./YjsXmlFragment";

package/src/xmlFragment/xmlFragment.ts

@@ -1,8 +0,0 @@
-import type { XmlElement as YXmlElement, XmlText as YXmlText } from "yjs";
-import { YjsXmlFragment } from "./YjsXmlFragment";
-
-export const xmlFragment = (
-    children: (YXmlElement | YXmlText)[] | readonly (YXmlElement | YXmlText)[],
-): YjsXmlFragment => {
-    return new YjsXmlFragment(children);
-};

package/src/xmlText/YjsXmlText.ts

@@ -1,16 +0,0 @@
-import { XmlText as YXmlText } from "yjs";
-import type { YjsType } from "../types";
-
-export class YjsXmlText extends YXmlText implements YjsType<YXmlText, string> {
-    public initialValue?: string;
-
-    constructor(value: string = "") {
-        super();
-
-        this.initialValue = value;
-    }
-
-    public __pluvType() {
-        return {} as unknown as any;
-    }
-}

package/src/xmlText/index.ts

@@ -1,2 +0,0 @@
-export { xmlText } from "./xmlText";
-export type { YjsXmlText } from "./YjsXmlText";

package/src/xmlText/xmlText.ts

@@ -1,7 +0,0 @@
-import type { XmlText as YXmlText } from "yjs";
-import { YjsType } from "../types";
-import { YjsXmlText } from "./YjsXmlText";
-
-export const xmlText = (): YjsType<YXmlText, string> => {
-    return new YjsXmlText();
-};

package/src/yjs.ts

@@ -1,12 +0,0 @@
-export { array } from "./array";
-export { awareness } from "./awareness";
-export { doc } from "./doc";
-export type { YjsBuilder } from "./doc";
-export { map } from "./map";
-export { provider } from "./provider";
-export { text } from "./text";
-export type { YjsType } from "./types";
-export { xmlElement } from "./xmlElement";
-export { xmlFragment } from "./xmlFragment";
-export { xmlText } from "./xmlText";
-export const kind = "yjs" as const;

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-	"extends": "@pluv/tsconfig/library.json",
-	"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
-	"exclude": ["node_modules"],
-	"compilerOptions": {
-		"lib": ["dom", "esnext"]
-	}
-}

package/tsdown.config.ts

@@ -1,14 +0,0 @@
-import { defineConfig } from "tsdown";
-
-export default defineConfig({
-    format: ["esm"],
-    dts: true,
-    outDir: "dist",
-    entry: "src/index.ts",
-    target: "esnext",
-    sourcemap: true,
-    clean: true,
-    exports: {
-        all: true,
-    },
-});