@pluv/crdt-yjs 0.15.0 → 0.16.1

package/dist/index.d.ts

@@ -1,67 +1,164 @@
-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;
-
-interface TrackOriginOptions {
-    captureTimeout?: number;
-    trackedOrigins?: readonly string[];
+import { AbstractCrdtType, InferCrdtStorageJson, AbstractCrdtDoc, DocApplyEncodedStateParams, DocSubscribeCallbackParams, AbstractCrdtDocFactory } from '@pluv/crdt';
+import { Map, Text, XmlText, XmlElement, XmlFragment, Array, Doc } from 'yjs';
+import { Json } from '@pluv/types';
+
+declare class CrdtYjsMap<T extends unknown> extends AbstractCrdtType<Map<InferYjsType<T>>, Record<string, InferYjsJson<T>>> {
+    initialValue: readonly (readonly [
+        key: string,
+        value: InferYjsType<T>
+    ])[];
+    value: Map<InferYjsType<T>>;
+    constructor(value?: readonly (readonly [key: string, value: T])[]);
+    get size(): number;
+    delete(prop: string): this;
+    set(prop: string, value: T): this;
+    toJson(): InferCrdtStorageJson<Record<string, InferYjsJson<T>>>;
+}
+
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => CrdtYjsMap<T>;
+
+declare class CrdtYjsObject<T extends Record<string, any>> extends AbstractCrdtType<Map<InferYjsType<T[keyof T]>>, InferYjsJson<T>> {
+    initialValue: readonly (readonly [key: string, value: T[keyof T]])[];
+    value: Map<InferYjsType<T[keyof T]>>;
+    constructor(value?: T);
+    set<TProp extends keyof T>(prop: TProp, value: T[TProp]): this;
+    toJson(): InferCrdtStorageJson<InferYjsJson<T>>;
+}
+
+declare const object: <T extends Record<string, any>>(value: T) => CrdtYjsObject<T>;
+
+declare class CrdtYjsText extends AbstractCrdtType<Text, string> {
+    readonly initialValue: string;
+    value: Text;
+    constructor(value?: string);
+    get length(): number;
+    delete(index: number, length?: number): this;
+    insert(index: number, text: string): this;
+    toJson(): string;
+}
+
+declare class CrdtYjsXmlText extends AbstractCrdtType<XmlText, string> {
+    readonly initialValue: string;
+    value: XmlText;
+    constructor(value?: string);
+    get length(): number;
+    delete(index: number, length?: number): this;
+    insert(index: number, text: string, attributes?: Record<string, string>): this;
+    toJson(): string;
 }
-declare class YjsDoc<T extends Record<string, AbstractType<any>> = {}> {
+
+declare class CrdtYjsXmlElement extends AbstractCrdtType<XmlElement, string> {
+    readonly initialValue: readonly (XmlElement | XmlText)[];
+    readonly name: string;
+    value: XmlElement;
+    constructor(name: string, children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]);
+    get length(): number;
+    delete(index: number, length?: number): this;
+    insert(index: number, ...children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]): this;
+    push(...children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]): this;
+    unshift(...children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]): this;
+    toJson(): string;
+}
+
+declare const xmlText: (value?: string) => CrdtYjsXmlText;
+
+declare const xmlElement: (name: string, children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]) => CrdtYjsXmlElement;
+
+declare class CrdtYjsXmlFragment extends AbstractCrdtType<XmlFragment, string> {
+    readonly initialValue: readonly (XmlElement | XmlText)[];
+    value: XmlFragment;
+    constructor(children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]);
+    get length(): number;
+    delete(index: number, length?: number): this;
+    insert(index: number, ...children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]): this;
+    push(...children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]): this;
+    unshift(...children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]): this;
+    toJson(): string;
+}
+
+declare const xmlFragment: (children: readonly (CrdtYjsXmlElement | CrdtYjsXmlText)[]) => CrdtYjsXmlFragment;
+
+type InferYjsType<T extends unknown> = T extends CrdtYjsArray<infer IType> ? Array<IType> : T extends CrdtYjsMap<infer IType> ? Map<IType> : T extends CrdtYjsObject<infer IType> ? Map<IType[keyof IType]> : T extends CrdtYjsText ? Text : T extends CrdtYjsXmlElement ? XmlElement : T extends CrdtYjsXmlFragment ? XmlFragment : T extends CrdtYjsXmlText ? XmlText : T extends Json ? T : never;
+type InferYjsJson<T extends unknown> = T extends CrdtYjsArray<infer IType> ? InferYjsJson<IType>[] : T extends CrdtYjsMap<infer IType> ? Record<string, InferYjsJson<IType>> : T extends CrdtYjsObject<infer IType> ? {
+    [P in keyof IType]: InferYjsJson<IType[P]>;
+} : T extends CrdtYjsText | CrdtYjsXmlElement | CrdtYjsXmlFragment | CrdtYjsXmlText | Text | XmlElement | XmlFragment | XmlText ? string : T extends Array<infer IType> ? InferYjsJson<IType>[] : T extends Map<infer IType> ? Record<string, InferYjsJson<IType>> : T extends (infer IType)[] ? InferYjsJson<IType>[] : T extends Record<any, any> ? {
+    [P in keyof T]: InferYjsJson<T[P]>;
+} : T extends Json ? T : never;
+
+declare class CrdtYjsArray<T extends unknown> extends AbstractCrdtType<Array<InferYjsType<T>>, InferYjsJson<T>[]> {
+    readonly initialValue: InferYjsType<T>[] | readonly InferYjsType<T>[];
+    value: Array<InferYjsType<T>>;
+    constructor(value?: T[] | readonly T[]);
+    get length(): number;
+    delete(index: number, length?: number): this;
+    insert(index: number, ...items: T[]): this;
+    push(...items: T[]): this;
+    unshift(...items: T[]): this;
+    toJson(): InferCrdtStorageJson<InferYjsJson<T>>[];
+}
+
+declare const array: <T extends unknown>(value?: T[] | readonly T[]) => CrdtYjsArray<T>;
+
+declare class CrdtYjsDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDoc<TStorage> {
     value: Doc;
+    private _storage;
     private _undoManager;
-    get storage(): T;
-    private get _storage();
-    constructor(value?: T);
-    applyUpdate(update?: string | Uint8Array | null, origin?: string): this;
+    constructor(value?: TStorage);
+    applyEncodedState(params: DocApplyEncodedStateParams): this;
+    batchApplyEncodedState(updates: readonly (DocApplyEncodedStateParams | string | null | undefined)[]): this;
     canRedo(): boolean;
     canUndo(): boolean;
     destroy(): void;
-    encodeStateAsUpdate(): string;
-    get<TKey extends keyof T>(key: TKey): T[TKey];
-    getSharedTypes(): T;
-    redo(): void;
-    subscribe(fn: (update: string, origin: any, doc: Doc, transaction: Transaction) => void): () => void;
-    toJSON(): InferYjsDocJson<this>;
-    trackOrigins(options: TrackOriginOptions): void;
-    transact(fn: (transaction: Transaction) => void, origin?: any): void;
-    static fromUint8Array(u8a: Uint8Array): string;
-    static toUint8Array(str: string): Uint8Array;
-    undo(): void;
+    get(key?: undefined): TStorage;
+    get<TKey extends keyof TStorage>(key: TKey): TStorage[TKey];
+    getEncodedState(): string;
+    isEmpty(): boolean;
+    redo(): this;
+    subscribe(listener: (params: DocSubscribeCallbackParams<TStorage>) => void): () => void;
+    track(): this;
+    transact(fn: () => void): this;
+    toJson(): InferCrdtStorageJson<TStorage>;
+    undo(): this;
 }
-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 class CrdtYjsDocFactory<TStorage extends Record<string, AbstractCrdtType<any, any>>> extends AbstractCrdtDocFactory<TStorage> {
+    private _initialStorage;
+    constructor(initialStorage?: () => TStorage);
+    getEmpty(): CrdtYjsDoc<TStorage>;
+    getFactory(initialStorage?: (() => TStorage) | undefined): CrdtYjsDocFactory<TStorage>;
+    getFresh(): CrdtYjsDoc<TStorage>;
+    getInitialized(initialStorage?: () => TStorage): CrdtYjsDoc<TStorage>;
 }
-declare const xmlElement: (name: string, params?: XmlElementParams) => XmlElement;
 
-interface XmlFragmentParams {
-    children?: readonly (XmlElement | XmlText)[];
-}
-declare const xmlFragment: (params?: XmlFragmentParams) => XmlFragment;
+declare const doc: <TStorage extends Record<string, AbstractCrdtType<any, any>>>(value?: () => TStorage) => CrdtYjsDocFactory<TStorage>;
 
-declare const xmlText: (value?: string) => XmlText;
+type yjs_CrdtYjsArray<T extends unknown> = CrdtYjsArray<T>;
+declare const yjs_CrdtYjsArray: typeof CrdtYjsArray;
+type yjs_CrdtYjsDoc<TStorage extends Record<string, AbstractCrdtType<any, any>>> = CrdtYjsDoc<TStorage>;
+declare const yjs_CrdtYjsDoc: typeof CrdtYjsDoc;
+type yjs_CrdtYjsMap<T extends unknown> = CrdtYjsMap<T>;
+declare const yjs_CrdtYjsMap: typeof CrdtYjsMap;
+type yjs_CrdtYjsObject<T extends Record<string, any>> = CrdtYjsObject<T>;
+declare const yjs_CrdtYjsObject: typeof CrdtYjsObject;
+type yjs_CrdtYjsText = CrdtYjsText;
+declare const yjs_CrdtYjsText: typeof CrdtYjsText;
+type yjs_CrdtYjsXmlElement = CrdtYjsXmlElement;
+declare const yjs_CrdtYjsXmlElement: typeof CrdtYjsXmlElement;
+type yjs_CrdtYjsXmlFragment = CrdtYjsXmlFragment;
+declare const yjs_CrdtYjsXmlFragment: typeof CrdtYjsXmlFragment;
+type yjs_CrdtYjsXmlText = CrdtYjsXmlText;
+declare const yjs_CrdtYjsXmlText: typeof CrdtYjsXmlText;
+type yjs_InferYjsJson<T extends unknown> = InferYjsJson<T>;
+type yjs_InferYjsType<T extends unknown> = InferYjsType<T>;
+declare const yjs_array: typeof array;
+declare const yjs_doc: typeof doc;
+declare const yjs_map: typeof map;
+declare const yjs_object: typeof object;
+declare const yjs_xmlElement: typeof xmlElement;
+declare const yjs_xmlFragment: typeof xmlFragment;
+declare const yjs_xmlText: typeof xmlText;
+declare namespace yjs {
+  export { yjs_CrdtYjsArray as CrdtYjsArray, yjs_CrdtYjsDoc as CrdtYjsDoc, yjs_CrdtYjsMap as CrdtYjsMap, yjs_CrdtYjsObject as CrdtYjsObject, yjs_CrdtYjsText as CrdtYjsText, yjs_CrdtYjsXmlElement as CrdtYjsXmlElement, yjs_CrdtYjsXmlFragment as CrdtYjsXmlFragment, yjs_CrdtYjsXmlText as CrdtYjsXmlText, type yjs_InferYjsJson as InferYjsJson, type yjs_InferYjsType as InferYjsType, yjs_array as array, yjs_doc as doc, yjs_map as map, yjs_object as object, yjs_xmlElement as xmlElement, yjs_xmlFragment as xmlFragment, yjs_xmlText as xmlText };
+}
 
-export { type InferYjsDocJson, type InferYjsDocSharedType, type InferYjsDocSharedTypeJson, type InferYjsDocSharedTypes, type InferYjsSharedTypeJson, type TrackOriginOptions, type XmlElementParams, type XmlFragmentParams, type YObject, type YObjectValue, YjsDoc, array, doc, map, object, text, xmlElement, xmlFragment, xmlText };
+export { yjs };