@pluv/crdt-yjs 5.0.1 → 5.0.2

package/dist/index.d.mts

@@ -0,0 +1,209 @@
+import { Array, Doc, Map as Map$1, Text, XmlElement, XmlFragment, XmlText } from "yjs";
+import { ObservableV2 } from "lib0/observable";
+import { AbstractCrdtDocFactory, CrdtType, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams, InferCrdtJson } from "@pluv/crdt";
+import { CrdtDocLike, CrdtType as CrdtType$1, IOLike, PluvRouterEventConfig, RoomLike } from "@pluv/types";
+//#region src/types.d.ts
+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;
+//#endregion
+//#region src/array/array.d.ts
+declare const array: <T extends unknown>(value?: T[] | readonly T[]) => YjsType<Array<T>, T[]>;
+//#endregion
+//#region src/awareness/PluvYjsAwareness.d.ts
+interface PluvYjsAwarenessParams<TIO extends IOLike<any, any, any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
+  presenceField?: 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<any, MetaClientState>;
+  readonly _checkInterval: number;
+}
+//#endregion
+//#region src/awareness/awareness.d.ts
+declare const awareness: <TIO extends IOLike<any, any, 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>;
+//#endregion
+//#region src/doc/builder.d.ts
+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$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>;
+  xmlText(name: string): YjsType<XmlText, string>;
+};
+//#endregion
+//#region src/doc/CrdtYjsDoc.d.ts
+type CrdtYjsDocParams<TStorage extends Record<string, YjsType<any, any>>> = (builder: YjsBuilder) => TStorage;
+declare class CrdtYjsDoc<TStorage extends Record<string, YjsType<any, any>>> implements CrdtDocLike<Doc, TStorage> {
+  #private;
+  value: Doc;
+  constructor(params?: CrdtYjsDocParams<TStorage>);
+  applyEncodedState(params: DocApplyEncodedStateParams): this;
+  batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
+  canRedo(): boolean;
+  canUndo(): boolean;
+  destroy(): void;
+  get(key?: undefined): TStorage;
+  get<TKey extends keyof TStorage>(type: TKey): TStorage[TKey];
+  getEncodedState(): string;
+  isEmpty(): boolean;
+  rebuildStorage(reference: TStorage): this;
+  redo(): this;
+  subscribe(listener: (params: DocSubscribeCallbackParams<Doc, TStorage>) => void): () => void;
+  track(): this;
+  transact(fn: () => void): this;
+  toJson(): InferCrdtJson<TStorage>;
+  toJson<TKey extends keyof TStorage>(type: TKey): InferCrdtJson<TStorage[TKey]>;
+  undo(): this;
+}
+//#endregion
+//#region src/doc/CrdtYjsDocFactory.d.ts
+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>;
+  getFactory(initialStorage: (builder: YjsBuilder) => TStorage): CrdtYjsDocFactory<TStorage>;
+  getInitialized(initialStorage?: (builder: YjsBuilder) => TStorage): CrdtYjsDoc<TStorage>;
+}
+//#endregion
+//#region src/doc/doc.d.ts
+declare const doc: <TStorage extends Record<string, YjsType<any, any>>>(value?: (buidler: YjsBuilder) => TStorage) => CrdtYjsDocFactory<TStorage>;
+//#endregion
+//#region src/map/map.d.ts
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => YjsType<Map$1<T>, Record<string, T>>;
+//#endregion
+//#region src/provider/PluvYjsProvider.d.ts
+interface PluvYjsProviderParams<TIO extends IOLike<any, any, any>, TPresence extends Record<string, any>, TStorage extends Record<string, CrdtType$1<any, any>>, TEvents extends PluvRouterEventConfig, TField extends keyof TPresence | null = null> {
+  presenceField?: 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, any, 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;
+}
+//#endregion
+//#region src/provider/provider.d.ts
+declare const provider: <TIO extends IOLike<any, any, 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>;
+//#endregion
+//#region src/text/text.d.ts
+declare const text: (value?: string) => YjsType<Text, string>;
+//#endregion
+//#region src/xmlElement/YjsXmlElement.d.ts
+declare class YjsXmlElement<T extends Record<string, any> = Record<string, any>> extends XmlElement<T> implements YjsType<XmlElement, string> {
+  initialValue?: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[];
+  constructor(name: string, value: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]);
+  __pluvType(): any;
+}
+//#endregion
+//#region src/xmlElement/xmlElement.d.ts
+declare const xmlElement: <T extends Record<string, any> = Record<string, any>>(name: string, children: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]) => YjsXmlElement<T>;
+//#endregion
+//#region src/xmlFragment/YjsXmlFragment.d.ts
+declare class YjsXmlFragment extends XmlFragment implements YjsType<XmlFragment, string> {
+  initialValue?: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[];
+  constructor(value: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]);
+  __pluvType(): any;
+}
+//#endregion
+//#region src/xmlFragment/xmlFragment.d.ts
+declare const xmlFragment: (children: (XmlElement | XmlText)[] | readonly (XmlElement | XmlText)[]) => YjsXmlFragment;
+//#endregion
+//#region src/xmlText/xmlText.d.ts
+declare const xmlText: () => YjsType<XmlText, string>;
+declare namespace yjs_d_exports {
+  export { YjsBuilder, YjsType, array, awareness, doc, kind, map, provider, text, xmlElement, xmlFragment, xmlText };
+}
+declare const kind: "yjs";
+//#endregion
+//#region src/index.d.ts
+type YjsLibraryType = typeof yjs_d_exports;
+//#endregion
+export { YjsLibraryType, yjs_d_exports as yjs };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/array/array.ts","../src/awareness/PluvYjsAwareness.ts","../src/awareness/awareness.ts","../src/doc/builder.ts","../src/doc/CrdtYjsDoc.ts","../src/doc/CrdtYjsDocFactory.ts","../src/doc/doc.ts","../src/map/map.ts","../src/provider/PluvYjsProvider.ts","../src/provider/provider.ts","../src/text/text.ts","../src/xmlElement/YjsXmlElement.ts","../src/xmlElement/xmlElement.ts","../src/xmlFragment/YjsXmlFragment.ts","../src/xmlFragment/xmlFragment.ts","../src/xmlText/xmlText.ts","../src/yjs.ts","../src/index.ts"],"mappings":";;;;;KAEY,QAAQ,wBAAwB,+BAA+B,SACvE,QACA;EAEA;EACA;;;;;;UAOa;EACb;EACA;EACA;;KAGQ;;;;;UAMK;EACb;EACA;;KAGQ,kBACR,kBAAkB,qBAClB,qBAAqB,oBACrB,sBAAsB,YAAY,qBAAqB,YAAY,UAAU;;;cC9BpE,QAAS,mBAClB,QAAO,eAAe,QACvB,QAAQ,MAAO,IAAI;;;UCOL,uBACb,YAAY,uBACZ,kBAAkB,qBAClB,iBAAiB,eAAe,uBAChC,gBAAgB,uBAChB,qBAAqB;EAErB,gBAAgB;EAChB,MAAM,SAAS,KAAK,KAAM,WAAW,UAAU;;cAGtC,iBACT,YAAY,QACZ,kBAAkB,qBAClB,iBAAiB,eAAe,uBAChC,gBAAgB,uBAChB,qBAAqB,iCACf;EACN,SAAS,SAAS,oBAAoB;EACtC,UAAU,WAAW,iBAAiB,KAAK,WAAW,UAAU,SAAS;EACzE,SAAS,SAAS,oBAAoB;;WAEtB,KAAK;mBAEJ;mBACA;mBACA;mBACA;MAEN;MAIA,UAAU,YAAY;EAIrB,YAAA,QAAQ,uBAAuB,KAAK,WAAW,UAAU,SAAS;EA8BvE;EAMA,iBAAiB,kBAAkB,WAAW;EAI9C,cAAc,OAAO,kBAAkB,WAAW;EAUlD,mBAAmB,0BAA0B,kBAAkB,WAAW,SAC7E,OAAO,aACP,OAAO,kBAAkB,WAAW,QAAQ;;;;;;;;EAsBzC,aAAa,YAAY,kBAAkB,WAAW;UAoBrD;UAOA;UA+CA;;;;;;;;WAmBQ,MAAI,SAAA;WACJ;;;;cCtNP,YACT,YAAY,uBACZ,kBAAkB,qBAClB,iBAAiB,eAAe,uBAChC,gBAAgB,uBAChB,qBAAqB,yBAErB,QAAQ,uBAAuB,KAAK,WAAW,UAAU,SAAS,YACnE,iBAAiB,KAAK,WAAW,UAAU,SAAS;;;KCD3C,aAAa,kBAAkB;cAE9B,UAAW,KAAK;EAEf,MAAA,mBAAiB,cACP,QACL,eAAe,MACvB,QAAQ,MAAO,IAAI;EAOlB,IAAA,mBAAiB,cACL,4BACe,aAAa,OAAO,QAChD,QAAQ,MAAK,IAAI,eAAe;EASxB,KAAA,cAAM,iBAAuB,QAAQ;EAQtC,WAAA,cAAM,YACD,aAAc,uBAAwB,aAAc,aAChE,QAAQ;EAQD,YAAA,cAAM,YACD,aAAc,uBAAwB,aAAc,aAChE,QAAQ;EAOG,QAAA,eAAS,QAAQ;;;;KCnC3B,iBAAiB,iBAAiB,eAAe,uBACzD,SAAS,eACR;cAEQ,WAAW,iBAAiB,eAAe,+BAA+B,YACnF,KACA;;EAEO,OAAO;EAKF,YAAA,SAAQ,iBAAiB;EAW9B,kBAAkB,QAAQ;EAY1B,uBAAuB,QAAQ;EA2B/B;EAIA;EAIA;EAKA,IAAI,kBAAkB;EACtB,IAAI,mBAAmB,UAAU,MAAM,OAAO,SAAS;EAOvD;EAIA;EAIA,eAAe,WAAW;EAgC1B;EAMA,UACH,WAAW,QAAQ,2BAA2B,KAAM;EAkBjD;EAiCA,SAAS;EAMT,UAAU,cAAc;EACxB,OAAO,mBAAmB,UAAU,MAAM,OAAO,cAAc,SAAS;EAUxE;;;;cC9NE,kBACT,iBAAiB,eAAe,iCAC1B,uBAAuB,KAAM;WACnB,kBAAkB,SAAS,eAAe;EAE9C,YAAA,kBAAiB,SAAS,eAAe;EAM9C,YAAY,WAAW;EAIvB,WACH,iBAAiB,SAAS,eAAe,WAC1C,kBAAkB;EAId,eACH,kBAAkB,SAAS,eAAe,WAC3C,WAAW;;;;cCzBL,MAAO,iBAAiB,eAAe,oBAChD,SAAQ,SAAS,eAAe,aACjC,kBAAkB;;;cCFR,MAAO,mBAChB,4BAA2B,aAAa,OAAO,UAChD,QAAQ,MAAK,IAAI,eAAe;;;UCElB,sBACb,YAAY,uBACZ,kBAAkB,qBAClB,iBAAiB,eAAe,uBAChC,gBAAgB,uBAChB,qBAAqB;EAErB,gBAAgB;EAChB,MAAM,SAAS,KAAK,KAAM,WAAW,UAAU;;;;;;;;cAStC,gBACT,YAAY,uBACZ,kBAAkB,qBAClB,iBAAiB,eAAe,uBAChC,gBAAgB,uBAChB,qBAAqB,iCACf;EACN,qBACI,OAAO,mBACP,UAAU,gBAAgB,KAAK,WAAW,UAAU,SAAS;EAEjE,qBACI,OAAO,OACP,UAAU,gBAAgB,KAAK,WAAW,UAAU,SAAS;EAEjE,SAAS;IAAS,QAAQ;;EAC1B,OAAO;EACP,SAAS;;WAEO,WAAW,iBAAiB,KAAK,WAAW,UAAU,SAAS;WAC/D,KAAK;mBAEJ;mBACA;UAET;EAEI,YAAA,QAAQ,sBAAsB,KAAK,WAAW,UAAU,SAAS;MAmClE;MAIA,OAAO;EAQX;UAMC;;;;;;;;EAwBD;EACA;;;;cC9HE,WACT,YAAY,uBACZ,kBAAkB,qBAClB,iBAAiB,eAAe,uBAChC,gBAAgB,uBAChB,qBAAqB,yBAErB,QAAQ,sBAAsB,KAAK,WAAW,UAAU,SAAS,YAAO,gBAAA,KAAA,WAAA,UAAA,SAAA;;;cCP/D,OAAQ,mBAAqB,QAAQ;;;cCArC,cAAc,UAAU,sBAAsB,6BAC/C,WAAY,cACT,QAAQ;EAEZ,gBAAgB,aAAc,uBAAwB,aAAc;EAGvE,YAAA,cACA,QAAQ,aAAc,uBAAwB,aAAc;EASzD;;;;cClBE,aAAc,UAAU,sBAAsB,qBACvD,cACA,WAAW,aAAc,uBAAwB,aAAc,eAChE,cAAc;;;cCFJ,uBAAuB,uBAAwB,QAAQ;EACzD,gBAAgB,aAAc,uBAAwB,aAAc;EAE/D,YAAA,QAAQ,aAAc,uBAAwB,aAAc;EAQjE;;;;cCZE,cACT,WAAW,aAAc,uBAAwB,aAAc,eAChE;;;cCDU,eAAc,QAAQ;;;;cCOtB;;;KCPD,wBAAwB"}