@pluv/crdt-yjs 2.1.0 → 2.2.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/crdt-yjs@2.1.0 build /home/runner/work/pluv/pluv/packages/crdt-yjs
+> @pluv/crdt-yjs@2.2.1 build /home/runner/work/pluv/pluv/packages/crdt-yjs
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 15.47 KB
-ESM ⚡️ Build success in 86ms
-CJS dist/index.js 16.33 KB
-CJS ⚡️ Build success in 88ms
+CJS dist/index.js 23.15 KB
+CJS ⚡️ Build success in 110ms
+ESM dist/index.mjs 22.21 KB
+ESM ⚡️ Build success in 110ms
 DTS Build start
-DTS ⚡️ Build success in 4437ms
-DTS dist/index.d.mts 5.14 KB
-DTS dist/index.d.ts  5.14 KB
+DTS ⚡️ Build success in 4831ms
+DTS dist/index.d.mts 10.93 KB
+DTS dist/index.d.ts  10.93 KB

package/CHANGELOG.md

@@ -1,5 +1,89 @@
 # @pluv/crdt-yjs
 
+## 2.2.1
+
+### Patch Changes
+
+- @pluv/crdt@2.2.1
+- @pluv/types@2.2.1
+
+## 2.2.0
+
+### Minor Changes
+
+- 745f6df: Added a `provider` function that satisfies Yjs's provider interface.
+
+  ```ts
+  import { createClient } from "@pluv/client";
+  import { yjs } from "@pluv/crdt-yjs";
+
+  const client = createClient({
+    /* ... */
+  });
+  const room = client.createRoom("example-room");
+
+  // Yjs Provider
+  yjs.provider({ room });
+  ```
+
+- df4ceed: Update `yjs.awareness` and `yjs.provider` to allow for a `field` parameter to use awareness on a nested presence field.
+
+  ```ts
+  createClient({
+    presence: z.object({
+      topField: z.number(),
+      forAwareness: z.object({
+        nestedField: z.number(),
+      }),
+    }),
+  });
+
+  yjs.provider({
+    // ...
+    // Optional field to use a nested field, instead of the presence root
+    field: "forAwareness",
+  });
+
+  yjs.awareness({
+    // ...
+    // Optional field to use a nested field, instead of the presence root
+    field: "forAwareness",
+  });
+  ```
+
+  This allows better integrations with [lexical](https://lexical.dev), since they have their own presence types.
+
+  ```tsx
+  createClient({
+    presence: z.object({
+      topField: z.number(),
+      lexical: z.any(),
+    }),
+  });
+
+  yjs.provider({ field: "lexical" /* ... */ });
+  ```
+
+- 6323979: Added an `awareness` function that satisfies Yjs's [awareness interface](https://github.com/yjs/y-protocols/blob/master/awareness.js).
+
+  ```ts
+  import { createClient } from "@pluv/client";
+  import { yjs } from "@pluv/crdt-yjs";
+
+  const client = createClient({
+    /* ... */
+  });
+  const room = client.createRoom("example-room");
+
+  // Yjs Awareness
+  yjs.awareness({ room /* ... */ });
+  ```
+
+### Patch Changes
+
+- @pluv/crdt@2.2.0
+- @pluv/types@2.2.0
+
 ## 2.1.0
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,18 +1,83 @@
-import { Array, Doc, Map, Text, XmlElement, XmlText, XmlFragment } from 'yjs';
+import { Array, Doc, Map as Map$1, Text, XmlElement, XmlText, XmlFragment } from 'yjs';
 import { CrdtType, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams, InferCrdtJson, AbstractCrdtDocFactory } from '@pluv/crdt';
-import { CrdtDocLike } from '@pluv/types';
+import { IOLike, CrdtType as CrdtType$1, PluvRouterEventConfig, RoomLike, CrdtDocLike } from '@pluv/types';
+import { ObservableV2 } from 'lib0/observable';
 
 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
+ */
+interface YjsAwarenessUpdate {
+    added: number[];
+    updated: number[];
+    removed: number[];
+}
+type YjsProviderStatus = "connecting" | "connected" | "disconnected";
+/**
+ * @description Type internally defined by Yjs.Awareness
+ * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
+ */
+interface MetaClientState {
+    clock: number;
+    lastUpdated: number;
+}
+type AwarenessPresence<TPresence extends Record<string, any>, TField extends keyof TPresence | null> = TField extends null ? TPresence : TField extends keyof TPresence ? TPresence[TField] : never;
 
 declare const array: <T extends unknown>(value?: T[] | readonly T[]) => YjsType<Array<T>, T[]>;
 
+interface PluvYjsAwarenessParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
+    field?: TField;
+    room: RoomLike<TIO, Doc, TPresence, TStorage, TEvents>;
+}
+declare class PluvYjsAwareness<TIO extends IOLike, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> extends ObservableV2<{
+    change: (updates: YjsAwarenessUpdate, kind: "presence") => void;
+    destroy: (awareness: PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>) => void;
+    update: (updates: YjsAwarenessUpdate, kind: "local" | "presence") => void;
+}> {
+    readonly doc: Doc;
+    private readonly _field;
+    private readonly _idMap;
+    private readonly _room;
+    private readonly _unsubscribe;
+    get clientID(): number;
+    get states(): Map<number, TPresence>;
+    constructor(params: PluvYjsAwarenessParams<TIO, TPresence, TStorage, TEvents, TField>);
+    destroy(): void;
+    getLocalState(): AwarenessPresence<TPresence, TField>;
+    setLocalState(state: AwarenessPresence<TPresence, TField>): void;
+    setLocalStateField<TLocalField extends keyof AwarenessPresence<TPresence, TField>>(field: TLocalField, value: AwarenessPresence<TPresence, TField>[TLocalField]): void;
+    /**
+     * !HACK
+     * @description We're building the awareness presences from the states stored on the room's
+     * presense instead of using the map defined in the awareness interface.
+     * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
+     * @date May 13, 2025
+     */
+    getStates(): Map<number, AwarenessPresence<TPresence, TField>>;
+    private _adaptPresence;
+    private _deriveUpdates;
+    private _resetIdMap;
+    /**
+     * !HACK
+     * @description We dgaf about these. We're just mirroring the fields that exist in the
+     * og awareness to make sure everything aligns.
+     * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
+     * @date May 13, 2025
+     */
+    readonly meta: Map<string, MetaClientState>;
+    readonly _checkInterval: number;
+}
+
+declare const awareness: <TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null>(params: PluvYjsAwarenessParams<TIO, TPresence, TStorage, TEvents, TField>) => PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>;
+
 type YjsBuilder = ReturnType<typeof builder>;
 declare const builder: (doc: Doc) => {
     array<T extends unknown>(name: string, value?: T[] | readonly T[]): YjsType<Array<T>, T[]>;
-    map<T extends unknown>(name: string, value?: readonly (readonly [key: string, value: T])[]): YjsType<Map<T>, Record<string, T>>;
+    map<T extends unknown>(name: string, value?: readonly (readonly [key: string, value: T])[]): YjsType<Map$1<T>, Record<string, T>>;
     text(name: string, value?: string): YjsType<Text, string>;
     xmlElement(name: string, children?: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]): YjsType<XmlElement, string>;
     xmlFragment(name: string, children?: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]): YjsType<XmlFragment, string>;
@@ -20,7 +85,7 @@ declare const builder: (doc: Doc) => {
 };
 
 type CrdtYjsDocParams<TStorage extends Record<string, YjsType<any, any>>> = (builder: YjsBuilder) => TStorage;
-declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> implements CrdtDocLike<TStorage> {
+declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> implements CrdtDocLike<Doc, TStorage> {
     value: Doc;
     private _storage;
     private _undoManager;
@@ -36,7 +101,7 @@ declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> imp
     isEmpty(): boolean;
     rebuildStorage(reference: TStorage): this;
     redo(): this;
-    subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
+    subscribe(listener: (params: DocSubscribeCallbackParams<Doc, TStorage>) => void): () => void;
     track(): this;
     transact(fn: () => void): this;
     toJson(): InferCrdtJson<TStorage>;
@@ -45,7 +110,7 @@ declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> imp
     private _warn;
 }
 
-declare class CrdtYjsDocFactory<TStorage extends Record<string, YjsType<any, any>> = {}> extends AbstractCrdtDocFactory<TStorage> {
+declare class CrdtYjsDocFactory<TStorage extends Record<string, YjsType<any, any>> = {}> extends AbstractCrdtDocFactory<Doc, TStorage> {
     readonly _initialStorage: (builder: YjsBuilder) => TStorage;
     constructor(initialStorage?: (builder: YjsBuilder) => TStorage);
     getEmpty(): CrdtYjsDoc<TStorage>;
@@ -55,14 +120,56 @@ declare class CrdtYjsDocFactory<TStorage extends Record<string, YjsType<any, any
 
 declare const doc: <TStorage extends Record<string, YjsType<any, any>>>(value?: (buidler: YjsBuilder) => TStorage) => CrdtYjsDocFactory<TStorage>;
 
-declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => YjsType<Map<T>, Record<string, T>>;
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => YjsType<Map$1<T>, Record<string, T>>;
 
 /**
  * @deprecated This will be removed in v3.0.0. Use yjs.map instead
  * @description Creates a Yjs map, but declare it like it's an object
  * @date May 8, 2025
  */
-declare const object: <T extends Record<string, any>>(value?: T) => YjsType<Map<T[keyof T]>, T>;
+declare const object: <T extends Record<string, any>>(value?: T) => YjsType<Map$1<T[keyof T]>, T>;
+
+interface PluvYjsProviderParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
+    field?: TField;
+    room: RoomLike<TIO, Doc, 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
+ */
+declare class PluvYjsProvider<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<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;
+}> {
+    readonly awareness: PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>;
+    readonly doc: Doc;
+    private readonly _room;
+    private readonly _unsubscribe;
+    private _synced;
+    constructor(params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>);
+    get synced(): boolean;
+    set synced(state: boolean);
+    destroy(): void;
+    private _toProviderStatus;
+    /**
+     * !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
+     */
+    connect(): void;
+    disconnect(): void;
+}
+
+declare const provider: <TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null>(params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>) => PluvYjsProvider<TIO, TPresence, TStorage, TEvents, TField>;
 
 declare const text: (value?: string) => YjsType<Text, string>;
 
@@ -89,16 +196,18 @@ declare const kind: "yjs";
 type yjs_YjsBuilder = YjsBuilder;
 type yjs_YjsType<TValue extends unknown, TJson extends unknown = any> = YjsType<TValue, TJson>;
 declare const yjs_array: typeof array;
+declare const yjs_awareness: typeof awareness;
 declare const yjs_doc: typeof doc;
 declare const yjs_kind: typeof kind;
 declare const yjs_map: typeof map;
 declare const yjs_object: typeof object;
+declare const yjs_provider: typeof provider;
 declare const yjs_text: typeof text;
 declare const yjs_xmlElement: typeof xmlElement;
 declare const yjs_xmlFragment: typeof xmlFragment;
 declare const yjs_xmlText: typeof xmlText;
 declare namespace yjs {
-  export { type yjs_YjsBuilder as YjsBuilder, type yjs_YjsType as YjsType, yjs_array as array, yjs_doc as doc, yjs_kind as kind, yjs_map as map, yjs_object as object, yjs_text as text, yjs_xmlElement as xmlElement, yjs_xmlFragment as xmlFragment, yjs_xmlText as xmlText };
+  export { type yjs_YjsBuilder as YjsBuilder, type yjs_YjsType as YjsType, yjs_array as array, yjs_awareness as awareness, yjs_doc as doc, yjs_kind as kind, yjs_map as map, yjs_object as object, yjs_provider as provider, yjs_text as text, yjs_xmlElement as xmlElement, yjs_xmlFragment as xmlFragment, yjs_xmlText as xmlText };
 }
 
 export { yjs };

package/dist/index.d.ts

@@ -1,18 +1,83 @@
-import { Array, Doc, Map, Text, XmlElement, XmlText, XmlFragment } from 'yjs';
+import { Array, Doc, Map as Map$1, Text, XmlElement, XmlText, XmlFragment } from 'yjs';
 import { CrdtType, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams, InferCrdtJson, AbstractCrdtDocFactory } from '@pluv/crdt';
-import { CrdtDocLike } from '@pluv/types';
+import { IOLike, CrdtType as CrdtType$1, PluvRouterEventConfig, RoomLike, CrdtDocLike } from '@pluv/types';
+import { ObservableV2 } from 'lib0/observable';
 
 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
+ */
+interface YjsAwarenessUpdate {
+    added: number[];
+    updated: number[];
+    removed: number[];
+}
+type YjsProviderStatus = "connecting" | "connected" | "disconnected";
+/**
+ * @description Type internally defined by Yjs.Awareness
+ * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
+ */
+interface MetaClientState {
+    clock: number;
+    lastUpdated: number;
+}
+type AwarenessPresence<TPresence extends Record<string, any>, TField extends keyof TPresence | null> = TField extends null ? TPresence : TField extends keyof TPresence ? TPresence[TField] : never;
 
 declare const array: <T extends unknown>(value?: T[] | readonly T[]) => YjsType<Array<T>, T[]>;
 
+interface PluvYjsAwarenessParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
+    field?: TField;
+    room: RoomLike<TIO, Doc, TPresence, TStorage, TEvents>;
+}
+declare class PluvYjsAwareness<TIO extends IOLike, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> extends ObservableV2<{
+    change: (updates: YjsAwarenessUpdate, kind: "presence") => void;
+    destroy: (awareness: PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>) => void;
+    update: (updates: YjsAwarenessUpdate, kind: "local" | "presence") => void;
+}> {
+    readonly doc: Doc;
+    private readonly _field;
+    private readonly _idMap;
+    private readonly _room;
+    private readonly _unsubscribe;
+    get clientID(): number;
+    get states(): Map<number, TPresence>;
+    constructor(params: PluvYjsAwarenessParams<TIO, TPresence, TStorage, TEvents, TField>);
+    destroy(): void;
+    getLocalState(): AwarenessPresence<TPresence, TField>;
+    setLocalState(state: AwarenessPresence<TPresence, TField>): void;
+    setLocalStateField<TLocalField extends keyof AwarenessPresence<TPresence, TField>>(field: TLocalField, value: AwarenessPresence<TPresence, TField>[TLocalField]): void;
+    /**
+     * !HACK
+     * @description We're building the awareness presences from the states stored on the room's
+     * presense instead of using the map defined in the awareness interface.
+     * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
+     * @date May 13, 2025
+     */
+    getStates(): Map<number, AwarenessPresence<TPresence, TField>>;
+    private _adaptPresence;
+    private _deriveUpdates;
+    private _resetIdMap;
+    /**
+     * !HACK
+     * @description We dgaf about these. We're just mirroring the fields that exist in the
+     * og awareness to make sure everything aligns.
+     * @see https://github.com/yjs/y-protocols/blob/master/awareness.js
+     * @date May 13, 2025
+     */
+    readonly meta: Map<string, MetaClientState>;
+    readonly _checkInterval: number;
+}
+
+declare const awareness: <TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null>(params: PluvYjsAwarenessParams<TIO, TPresence, TStorage, TEvents, TField>) => PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>;
+
 type YjsBuilder = ReturnType<typeof builder>;
 declare const builder: (doc: Doc) => {
     array<T extends unknown>(name: string, value?: T[] | readonly T[]): YjsType<Array<T>, T[]>;
-    map<T extends unknown>(name: string, value?: readonly (readonly [key: string, value: T])[]): YjsType<Map<T>, Record<string, T>>;
+    map<T extends unknown>(name: string, value?: readonly (readonly [key: string, value: T])[]): YjsType<Map$1<T>, Record<string, T>>;
     text(name: string, value?: string): YjsType<Text, string>;
     xmlElement(name: string, children?: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]): YjsType<XmlElement, string>;
     xmlFragment(name: string, children?: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]): YjsType<XmlFragment, string>;
@@ -20,7 +85,7 @@ declare const builder: (doc: Doc) => {
 };
 
 type CrdtYjsDocParams<TStorage extends Record<string, YjsType<any, any>>> = (builder: YjsBuilder) => TStorage;
-declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> implements CrdtDocLike<TStorage> {
+declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> implements CrdtDocLike<Doc, TStorage> {
     value: Doc;
     private _storage;
     private _undoManager;
@@ -36,7 +101,7 @@ declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> imp
     isEmpty(): boolean;
     rebuildStorage(reference: TStorage): this;
     redo(): this;
-    subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
+    subscribe(listener: (params: DocSubscribeCallbackParams<Doc, TStorage>) => void): () => void;
     track(): this;
     transact(fn: () => void): this;
     toJson(): InferCrdtJson<TStorage>;
@@ -45,7 +110,7 @@ declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> imp
     private _warn;
 }
 
-declare class CrdtYjsDocFactory<TStorage extends Record<string, YjsType<any, any>> = {}> extends AbstractCrdtDocFactory<TStorage> {
+declare class CrdtYjsDocFactory<TStorage extends Record<string, YjsType<any, any>> = {}> extends AbstractCrdtDocFactory<Doc, TStorage> {
     readonly _initialStorage: (builder: YjsBuilder) => TStorage;
     constructor(initialStorage?: (builder: YjsBuilder) => TStorage);
     getEmpty(): CrdtYjsDoc<TStorage>;
@@ -55,14 +120,56 @@ declare class CrdtYjsDocFactory<TStorage extends Record<string, YjsType<any, any
 
 declare const doc: <TStorage extends Record<string, YjsType<any, any>>>(value?: (buidler: YjsBuilder) => TStorage) => CrdtYjsDocFactory<TStorage>;
 
-declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => YjsType<Map<T>, Record<string, T>>;
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => YjsType<Map$1<T>, Record<string, T>>;
 
 /**
  * @deprecated This will be removed in v3.0.0. Use yjs.map instead
  * @description Creates a Yjs map, but declare it like it's an object
  * @date May 8, 2025
  */
-declare const object: <T extends Record<string, any>>(value?: T) => YjsType<Map<T[keyof T]>, T>;
+declare const object: <T extends Record<string, any>>(value?: T) => YjsType<Map$1<T[keyof T]>, T>;
+
+interface PluvYjsProviderParams<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
+    field?: TField;
+    room: RoomLike<TIO, Doc, 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
+ */
+declare class PluvYjsProvider<TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<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;
+}> {
+    readonly awareness: PluvYjsAwareness<TIO, TPresence, TStorage, TEvents, TField>;
+    readonly doc: Doc;
+    private readonly _room;
+    private readonly _unsubscribe;
+    private _synced;
+    constructor(params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>);
+    get synced(): boolean;
+    set synced(state: boolean);
+    destroy(): void;
+    private _toProviderStatus;
+    /**
+     * !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
+     */
+    connect(): void;
+    disconnect(): void;
+}
+
+declare const provider: <TIO extends IOLike<any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null>(params: PluvYjsProviderParams<TIO, TPresence, TStorage, TEvents, TField>) => PluvYjsProvider<TIO, TPresence, TStorage, TEvents, TField>;
 
 declare const text: (value?: string) => YjsType<Text, string>;
 
@@ -89,16 +196,18 @@ declare const kind: "yjs";
 type yjs_YjsBuilder = YjsBuilder;
 type yjs_YjsType<TValue extends unknown, TJson extends unknown = any> = YjsType<TValue, TJson>;
 declare const yjs_array: typeof array;
+declare const yjs_awareness: typeof awareness;
 declare const yjs_doc: typeof doc;
 declare const yjs_kind: typeof kind;
 declare const yjs_map: typeof map;
 declare const yjs_object: typeof object;
+declare const yjs_provider: typeof provider;
 declare const yjs_text: typeof text;
 declare const yjs_xmlElement: typeof xmlElement;
 declare const yjs_xmlFragment: typeof xmlFragment;
 declare const yjs_xmlText: typeof xmlText;
 declare namespace yjs {
-  export { type yjs_YjsBuilder as YjsBuilder, type yjs_YjsType as YjsType, yjs_array as array, yjs_doc as doc, yjs_kind as kind, yjs_map as map, yjs_object as object, yjs_text as text, yjs_xmlElement as xmlElement, yjs_xmlFragment as xmlFragment, yjs_xmlText as xmlText };
+  export { type yjs_YjsBuilder as YjsBuilder, type yjs_YjsType as YjsType, yjs_array as array, yjs_awareness as awareness, yjs_doc as doc, yjs_kind as kind, yjs_map as map, yjs_object as object, yjs_provider as provider, yjs_text as text, yjs_xmlElement as xmlElement, yjs_xmlFragment as xmlFragment, yjs_xmlText as xmlText };
 }
 
 export { yjs };