@yorkie-js/sdk 0.6.9 → 0.6.11-rc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/yorkie-js-sdk.d.ts +22 -29
- package/dist/yorkie-js-sdk.es.js +89 -273
- package/dist/yorkie-js-sdk.es.js.map +1 -1
- package/dist/yorkie-js-sdk.js +89 -273
- package/dist/yorkie-js-sdk.js.map +1 -1
- package/package.json +1 -1
package/dist/yorkie-js-sdk.d.ts
CHANGED
|
@@ -503,21 +503,15 @@ declare class ChangePack<P extends Indexable> {
|
|
|
503
503
|
* `snapshot` is a byte array that encodes the document.
|
|
504
504
|
*/
|
|
505
505
|
private snapshot?;
|
|
506
|
-
/**
|
|
507
|
-
* `minSyncedTicket` is the minimum logical time taken by clients who attach
|
|
508
|
-
* to the document. It is used to collect garbage on the replica on the
|
|
509
|
-
* client.
|
|
510
|
-
*/
|
|
511
|
-
private minSyncedTicket?;
|
|
512
506
|
/**
|
|
513
507
|
* `versionVector` is the version vector current document
|
|
514
508
|
*/
|
|
515
509
|
private versionVector?;
|
|
516
|
-
constructor(key: string, checkpoint: Checkpoint, isRemoved: boolean, changes: Array<Change<P>>, versionVector?: VersionVector, snapshot?: Uint8Array
|
|
510
|
+
constructor(key: string, checkpoint: Checkpoint, isRemoved: boolean, changes: Array<Change<P>>, versionVector?: VersionVector, snapshot?: Uint8Array);
|
|
517
511
|
/**
|
|
518
512
|
* `create` creates a new instance of ChangePack.
|
|
519
513
|
*/
|
|
520
|
-
static create<P extends Indexable>(key: string, checkpoint: Checkpoint, isRemoved: boolean, changes: Array<Change<P>>, versionVector?: VersionVector, snapshot?: Uint8Array
|
|
514
|
+
static create<P extends Indexable>(key: string, checkpoint: Checkpoint, isRemoved: boolean, changes: Array<Change<P>>, versionVector?: VersionVector, snapshot?: Uint8Array): ChangePack<P>;
|
|
521
515
|
/**
|
|
522
516
|
* `getDocumentKey` returns the document key of this pack.
|
|
523
517
|
*/
|
|
@@ -550,10 +544,6 @@ declare class ChangePack<P extends Indexable> {
|
|
|
550
544
|
* `getSnapshot` returns the snapshot of this pack.
|
|
551
545
|
*/
|
|
552
546
|
getSnapshot(): Uint8Array | undefined;
|
|
553
|
-
/**
|
|
554
|
-
* `getMinSyncedTicket` returns the minimum synced ticket of this pack.
|
|
555
|
-
*/
|
|
556
|
-
getMinSyncedTicket(): TimeTicket | undefined;
|
|
557
547
|
/**
|
|
558
548
|
* `getVersionVector` returns the document's version vector of this pack
|
|
559
549
|
*/
|
|
@@ -584,6 +574,8 @@ declare class ChangePack_2 extends Message<ChangePack_2> {
|
|
|
584
574
|
*/
|
|
585
575
|
changes: Change_2[];
|
|
586
576
|
/**
|
|
577
|
+
* deprecated
|
|
578
|
+
*
|
|
587
579
|
* @generated from field: yorkie.v1.TimeTicket min_synced_ticket = 5;
|
|
588
580
|
*/
|
|
589
581
|
minSyncedTicket?: TimeTicket_2;
|
|
@@ -769,7 +761,6 @@ export declare class Client {
|
|
|
769
761
|
*/
|
|
770
762
|
detach<R, P extends Indexable>(doc: Document_2<R, P>, opts?: {
|
|
771
763
|
removeIfNotAttached?: boolean;
|
|
772
|
-
keepalive?: boolean;
|
|
773
764
|
}): Promise<Document_2<R, P>>;
|
|
774
765
|
/**
|
|
775
766
|
* `changeRealtimeSync` changes the synchronization mode of the given document.
|
|
@@ -1450,16 +1441,16 @@ declare class CRDTTree extends CRDTElement implements GCParent {
|
|
|
1450
1441
|
*/
|
|
1451
1442
|
style(range: [CRDTTreePos, CRDTTreePos], attributes: {
|
|
1452
1443
|
[key: string]: string;
|
|
1453
|
-
} | undefined, editedAt: TimeTicket,
|
|
1444
|
+
} | undefined, editedAt: TimeTicket, versionVector?: VersionVector): [Array<GCPair>, Array<TreeChange>];
|
|
1454
1445
|
/**
|
|
1455
1446
|
* `removeStyle` removes the given attributes of the given range.
|
|
1456
1447
|
*/
|
|
1457
|
-
removeStyle(range: [CRDTTreePos, CRDTTreePos], attributesToRemove: Array<string>, editedAt: TimeTicket,
|
|
1448
|
+
removeStyle(range: [CRDTTreePos, CRDTTreePos], attributesToRemove: Array<string>, editedAt: TimeTicket, versionVector?: VersionVector): [Array<GCPair>, Array<TreeChange>];
|
|
1458
1449
|
/**
|
|
1459
1450
|
* `edit` edits the tree with the given range and content.
|
|
1460
1451
|
* If the content is undefined, the range will be removed.
|
|
1461
1452
|
*/
|
|
1462
|
-
edit(range: [CRDTTreePos, CRDTTreePos], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: (() => TimeTicket) | undefined,
|
|
1453
|
+
edit(range: [CRDTTreePos, CRDTTreePos], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: (() => TimeTicket) | undefined, versionVector?: VersionVector): [Array<TreeChange>, Array<GCPair>];
|
|
1463
1454
|
/**
|
|
1464
1455
|
* `editT` edits the given range with the given value.
|
|
1465
1456
|
* This method uses indexes instead of a pair of TreePos for testing.
|
|
@@ -1666,11 +1657,11 @@ declare class CRDTTreeNode extends IndexTreeNode<CRDTTreeNode> implements GCPare
|
|
|
1666
1657
|
/**
|
|
1667
1658
|
* `canDelete` checks if node is able to delete.
|
|
1668
1659
|
*/
|
|
1669
|
-
canDelete(editedAt: TimeTicket,
|
|
1660
|
+
canDelete(editedAt: TimeTicket, clientLamportAtChange: bigint): boolean;
|
|
1670
1661
|
/**
|
|
1671
1662
|
* `canStyle` checks if node is able to style.
|
|
1672
1663
|
*/
|
|
1673
|
-
canStyle(editedAt: TimeTicket,
|
|
1664
|
+
canStyle(editedAt: TimeTicket, clientLamportAtChange: bigint): boolean;
|
|
1674
1665
|
/**
|
|
1675
1666
|
* `setAttrs` sets the attributes of the node.
|
|
1676
1667
|
*/
|
|
@@ -3723,6 +3714,8 @@ declare class Operation_Edit extends Message<Operation_Edit> {
|
|
|
3723
3714
|
*/
|
|
3724
3715
|
to?: TextNodePos;
|
|
3725
3716
|
/**
|
|
3717
|
+
* deprecated
|
|
3718
|
+
*
|
|
3726
3719
|
* @generated from field: map<string, yorkie.v1.TimeTicket> created_at_map_by_actor = 4;
|
|
3727
3720
|
*/
|
|
3728
3721
|
createdAtMapByActor: {
|
|
@@ -3926,6 +3919,8 @@ declare class Operation_Style extends Message<Operation_Style> {
|
|
|
3926
3919
|
*/
|
|
3927
3920
|
executedAt?: TimeTicket_2;
|
|
3928
3921
|
/**
|
|
3922
|
+
* deprecated
|
|
3923
|
+
*
|
|
3929
3924
|
* @generated from field: map<string, yorkie.v1.TimeTicket> created_at_map_by_actor = 6;
|
|
3930
3925
|
*/
|
|
3931
3926
|
createdAtMapByActor: {
|
|
@@ -3958,6 +3953,8 @@ declare class Operation_TreeEdit extends Message<Operation_TreeEdit> {
|
|
|
3958
3953
|
*/
|
|
3959
3954
|
to?: TreePos_2;
|
|
3960
3955
|
/**
|
|
3956
|
+
* deprecated
|
|
3957
|
+
*
|
|
3961
3958
|
* @generated from field: map<string, yorkie.v1.TimeTicket> created_at_map_by_actor = 4;
|
|
3962
3959
|
*/
|
|
3963
3960
|
createdAtMapByActor: {
|
|
@@ -4016,6 +4013,8 @@ declare class Operation_TreeStyle extends Message<Operation_TreeStyle> {
|
|
|
4016
4013
|
*/
|
|
4017
4014
|
attributesToRemove: string[];
|
|
4018
4015
|
/**
|
|
4016
|
+
* deprecated
|
|
4017
|
+
*
|
|
4019
4018
|
* @generated from field: map<string, yorkie.v1.TimeTicket> created_at_map_by_actor = 7;
|
|
4020
4019
|
*/
|
|
4021
4020
|
createdAtMapByActor: {
|
|
@@ -4434,15 +4433,9 @@ declare class RGATreeSplit<T extends RGATreeSplitValue> implements GCParent {
|
|
|
4434
4433
|
* @param range - range of RGATreeSplitNode
|
|
4435
4434
|
* @param editedAt - edited time
|
|
4436
4435
|
* @param value - value
|
|
4437
|
-
* @
|
|
4438
|
-
|
|
4439
|
-
|
|
4440
|
-
edit(range: RGATreeSplitPosRange, editedAt: TimeTicket, value?: T, maxCreatedAtMapByActor?: Map<string, TimeTicket>, versionVector?: VersionVector): [
|
|
4441
|
-
RGATreeSplitPos,
|
|
4442
|
-
Map<string, TimeTicket>,
|
|
4443
|
-
Array<GCPair>,
|
|
4444
|
-
Array<ValueChange<T>>
|
|
4445
|
-
];
|
|
4436
|
+
* @returns `[RGATreeSplitPos, Array<GCPair>, Array<Change>]`
|
|
4437
|
+
*/
|
|
4438
|
+
edit(range: RGATreeSplitPosRange, editedAt: TimeTicket, value?: T, versionVector?: VersionVector): [RGATreeSplitPos, Array<GCPair>, Array<ValueChange<T>>];
|
|
4446
4439
|
/**
|
|
4447
4440
|
* `indexToPos` finds RGATreeSplitPos of given offset.
|
|
4448
4441
|
*/
|
|
@@ -4618,11 +4611,11 @@ declare class RGATreeSplitNode<T extends RGATreeSplitValue> extends SplayNode<T>
|
|
|
4618
4611
|
/**
|
|
4619
4612
|
* `canDelete` checks if node is able to delete.
|
|
4620
4613
|
*/
|
|
4621
|
-
canDelete(editedAt: TimeTicket,
|
|
4614
|
+
canDelete(editedAt: TimeTicket, clientLamportAtChange: bigint): boolean;
|
|
4622
4615
|
/**
|
|
4623
4616
|
* `canStyle` checks if node is able to set style.
|
|
4624
4617
|
*/
|
|
4625
|
-
canStyle(editedAt: TimeTicket,
|
|
4618
|
+
canStyle(editedAt: TimeTicket, clientLamportAtChange: bigint): boolean;
|
|
4626
4619
|
/**
|
|
4627
4620
|
* `remove` removes node of given edited time.
|
|
4628
4621
|
*/
|