@yorkie-js/sdk 0.6.11-rc → 0.6.13

package/dist/yorkie-js-sdk.d.ts

@@ -285,7 +285,8 @@ declare class Change_2 extends Message<Change_2> {
  * Finally returns a Change after the modification has been completed.
  */
 declare class ChangeContext<P extends Indexable = Indexable> {
-    private id;
+    private prevID;
+    private nextID;
     private delimiter;
     private message?;
     private root;
@@ -301,11 +302,11 @@ declare class ChangeContext<P extends Indexable = Indexable> {
      * presence changes.
      */
     private reversePresenceKeys;
-    constructor(id: ChangeID, root: CRDTRoot, presence: P, message?: string);
+    constructor(prevID: ChangeID, root: CRDTRoot, presence: P, message?: string);
     /**
      * `create` creates a new instance of ChangeContext.
      */
-    static create<P extends Indexable>(id: ChangeID, root: CRDTRoot, presence: P, message?: string): ChangeContext<P>;
+    static create<P extends Indexable>(prevID: ChangeID, root: CRDTRoot, presence: P, message?: string): ChangeContext<P>;
     /**
      * `push` pushes the given operation to this context.
      */
@@ -323,9 +324,19 @@ declare class ChangeContext<P extends Indexable = Indexable> {
      */
     registerGCPair(pair: GCPair): void;
     /**
-     * `getChange` creates a new instance of Change in this context.
+     * `getNextID` returns the next ID of this context. It will be set to the
+     * document for the next change.returns the next ID of this context.
+     */
+    getNextID(): ChangeID;
+    /**
+     * `toChange` creates a new instance of Change in this context.
      */
-    getChange(): Change<P>;
+    toChange(): Change<P>;
+    /**
+     * `isPresenceOnlyChange` returns whether this context is only for presence
+     * change or not.
+     */
+    isPresenceOnlyChange(): boolean;
     /**
      * `hasChange` returns whether this context has change or not.
      */
@@ -352,6 +363,10 @@ declare class ChangeContext<P extends Indexable = Indexable> {
      * `getLastTimeTicket` returns the last time ticket issued in this context.
      */
     getLastTimeTicket(): TimeTicket;
+    /**
+     * `acc` accumulates the given DataSize to Live size of the root.
+     */
+    acc(diff: DataSize): void;
 }
 
 /**
@@ -360,10 +375,14 @@ declare class ChangeContext<P extends Indexable = Indexable> {
 declare class ChangeID {
     private clientSeq;
     private serverSeq?;
-    private lamport;
     private actor;
+    private lamport;
     private versionVector;
     constructor(clientSeq: number, lamport: bigint, actor: ActorID, vector: VersionVector, serverSeq?: bigint);
+    /**
+     * `hasClocks` returns true if this ID has logical clocks.
+     */
+    hasClocks(): boolean;
     /**
      * `of` creates a new instance of ChangeID.
      */
@@ -371,9 +390,10 @@ declare class ChangeID {
     /**
      * `next` creates a next ID of this ID.
      */
-    next(): ChangeID;
+    next(excludeClocks?: boolean): ChangeID;
     /**
-     * `syncClocks` syncs logical clocks with the given ID.
+     * `syncClocks` syncs logical clocks with the given ID. If the given ID
+     * doesn't have logical clocks, this ID is returned.
      */
     syncClocks(other: ChangeID): ChangeID;
     /**
@@ -389,6 +409,10 @@ declare class ChangeID {
      * `setActor` sets the given actor.
      */
     setActor(actorID: ActorID): ChangeID;
+    /**
+     * `setLamport` sets the given lamport clock.
+     */
+    setLamport(lamport: bigint): ChangeID;
     /**
      * `setVersionVector` sets the given version vector.
      */
@@ -761,6 +785,7 @@ export declare class Client {
      */
     detach<R, P extends Indexable>(doc: Document_2<R, P>, opts?: {
         removeIfNotAttached?: boolean;
+        keepalive?: boolean;
     }): Promise<Document_2<R, P>>;
     /**
      * `changeRealtimeSync` changes the synchronization mode of the given document.
@@ -1191,6 +1216,10 @@ declare class CRDTRoot {
      * element itself and its parent.
      */
     private gcPairMap;
+    /**
+     * `docSize` is a structure that represents the size of the document.
+     */
+    private docSize;
     constructor(rootObject: CRDTObject);
     /**
      * `create` creates a new instance of Root.
@@ -1270,6 +1299,10 @@ declare class CRDTRoot {
      * This includes counts of various types of elements and structural information.
      */
     getStats(): RootStats;
+    /**
+     * `acc` accumulates the given DataSize to Live.
+     */
+    acc(diff: DataSize): void;
 }
 
 /**
@@ -1435,22 +1468,22 @@ declare class CRDTTree extends CRDTElement implements GCParent {
      * If `editedAt` is given, then it is used to find the appropriate left node
      * for concurrent insertion.
      */
-    findNodesAndSplitText(pos: CRDTTreePos, editedAt?: TimeTicket): TreeNodePair;
+    findNodesAndSplitText(pos: CRDTTreePos, editedAt?: TimeTicket): [TreeNodePair, DataSize];
     /**
      * `style` applies the given attributes of the given range.
      */
     style(range: [CRDTTreePos, CRDTTreePos], attributes: {
         [key: string]: string;
-    } | undefined, editedAt: TimeTicket, versionVector?: VersionVector): [Array<GCPair>, Array<TreeChange>];
+    } | undefined, editedAt: TimeTicket, versionVector?: VersionVector): [Array<GCPair>, Array<TreeChange>, DataSize];
     /**
      * `removeStyle` removes the given attributes of the given range.
      */
-    removeStyle(range: [CRDTTreePos, CRDTTreePos], attributesToRemove: Array<string>, editedAt: TimeTicket, versionVector?: VersionVector): [Array<GCPair>, Array<TreeChange>];
+    removeStyle(range: [CRDTTreePos, CRDTTreePos], attributesToRemove: Array<string>, editedAt: TimeTicket, versionVector?: VersionVector): [Array<GCPair>, Array<TreeChange>, DataSize];
     /**
      * `edit` edits the tree with the given range and content.
      * If the content is undefined, the range will be removed.
      */
-    edit(range: [CRDTTreePos, CRDTTreePos], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: (() => TimeTicket) | undefined, versionVector?: VersionVector): [Array<TreeChange>, Array<GCPair>];
+    edit(range: [CRDTTreePos, CRDTTreePos], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: (() => TimeTicket) | undefined, versionVector?: VersionVector): [Array<TreeChange>, Array<GCPair>, DataSize];
     /**
      * `editT` edits the given range with the given value.
      * This method uses indexes instead of a pair of TreePos for testing.
@@ -1645,7 +1678,7 @@ declare class CRDTTreeNode extends IndexTreeNode<CRDTTreeNode> implements GCPare
     /**
      * `split` splits the given offset of this node.
      */
-    split(tree: CRDTTree, offset: number, issueTimeTicket?: () => TimeTicket): CRDTTreeNode | undefined;
+    split(tree: CRDTTree, offset: number, issueTimeTicket?: () => TimeTicket): [CRDTTreeNode | undefined, DataSize];
     /**
      * `getCreatedAt` returns the creation time of this element.
      */
@@ -2283,6 +2316,7 @@ declare class Document_2<R, P extends Indexable = Indexable> {
     private changeID;
     private checkpoint;
     private localChanges;
+    private maxSizeLimit;
     private root;
     private clone?;
     private eventStream;
@@ -2414,6 +2448,13 @@ declare class Document_2<R, P extends Indexable = Indexable> {
      * `getStatus` returns the status of this document.
      */
     getStatus(): DocStatus;
+    /**
+     * `getClone` returns this clone.
+     */
+    getClone(): {
+        root: CRDTRoot;
+        presences: Map<string, P>;
+    } | undefined;
     /* Excluded from this release type: getCloneRoot */
     /**
      * `getRoot` returns a new proxy of cloned root.
@@ -2423,6 +2464,14 @@ declare class Document_2<R, P extends Indexable = Indexable> {
      * `getDocSize` returns the size of this document.
      */
     getDocSize(): DocSize;
+    /**
+     * `getMaxSizePerDocument` gets the maximum size of this document.
+     */
+    getMaxSizePerDocument(): number;
+    /**
+     * `setMaxSizePerDocument` sets the maximum size of this document.
+     */
+    setMaxSizePerDocument(size: number): void;
     /* Excluded from this release type: garbageCollect */
     /* Excluded from this release type: getRootObject */
     /* Excluded from this release type: getGarbageLen */
@@ -2505,10 +2554,6 @@ declare class Document_2<R, P extends Indexable = Indexable> {
      * `canUndo` returns whether there are any operations to undo.
      */
     private canUndo;
-    /**
-     * 'filterVersionVector' filters detached client's lamport from version vector.
-     */
-    private filterVersionVector;
     /**
      * `canRedo` returns whether there are any operations to redo.
      */
@@ -2976,10 +3021,14 @@ declare abstract class IndexTreeNode<T extends IndexTreeNode<T>> {
      * `value` sets the value of the node.
      */
     abstract set value(v: string);
+    /**
+     * `getDataSize` returns the size of the node.
+     */
+    abstract getDataSize(): DataSize;
     /**
      * `splitText` splits the given node at the given offset.
      */
-    splitText(offset: number, absOffset: number): T | undefined;
+    splitText(offset: number, absOffset: number): [T | undefined, DataSize];
     /**
      * `children` returns the children of the node.
      */
@@ -3025,7 +3074,7 @@ declare abstract class IndexTreeNode<T extends IndexTreeNode<T>> {
     /**
      * `splitElement` splits the given element at the given offset.
      */
-    splitElement(offset: number, issueTimeTicket: () => TimeTicket): T | undefined;
+    splitElement(offset: number, issueTimeTicket: () => TimeTicket): [T | undefined, DataSize];
     /**
      * `insertAfterInternal` inserts the given node after the given child.
      * This method does not update the size of the ancestors.
@@ -4435,7 +4484,7 @@ declare class RGATreeSplit<T extends RGATreeSplitValue> implements GCParent {
      * @param value - value
      * @returns `[RGATreeSplitPos, Array<GCPair>, Array<Change>]`
      */
-    edit(range: RGATreeSplitPosRange, editedAt: TimeTicket, value?: T, versionVector?: VersionVector): [RGATreeSplitPos, Array<GCPair>, Array<ValueChange<T>>];
+    edit(range: RGATreeSplitPosRange, editedAt: TimeTicket, value?: T, versionVector?: VersionVector): [RGATreeSplitPos, Array<GCPair>, DataSize, Array<ValueChange<T>>];
     /**
      * `indexToPos` finds RGATreeSplitPos of given offset.
      */
@@ -4489,7 +4538,7 @@ declare class RGATreeSplit<T extends RGATreeSplitValue> implements GCParent {
     /**
      * `findNodeWithSplit` splits and return nodes of the given position.
      */
-    findNodeWithSplit(pos: RGATreeSplitPos, editedAt: TimeTicket): [RGATreeSplitNode<T>, RGATreeSplitNode<T>];
+    findNodeWithSplit(pos: RGATreeSplitPos, editedAt: TimeTicket): [RGATreeSplitNode<T>, DataSize, RGATreeSplitNode<T>];
     private findFloorNodePreferToLeft;
     private findFloorNode;
     /**