@yorkie-js/sdk 0.6.41-rc2 → 0.6.41

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

@@ -281,6 +281,7 @@ export declare class Change<P extends Indexable> {
      * `execute` executes the operations of this change to the given root.
      */
     execute(root: CRDTRoot, presences: Map<ActorID, P>, source: OpSource): {
+        operations: Array<Operation>;
         opInfos: Array<OpInfo>;
         reverseOps: Array<HistoryOperation<P>>;
     };
@@ -1712,7 +1713,13 @@ declare class CRDTText<A extends Indexable = Indexable> extends CRDTElement {
     /**
      * `edit` edits the given range with the given value and attributes.
      */
-    edit(range: RGATreeSplitPosRange, content: string, editedAt: TimeTicket, attributes?: Record<string, string>, versionVector?: VersionVector): [Array<TextChange<A>>, Array<GCPair>, DataSize, RGATreeSplitPosRange];
+    edit(range: RGATreeSplitPosRange, content: string, editedAt: TimeTicket, attributes?: Record<string, string>, versionVector?: VersionVector): [
+    Array<TextChange<A>>,
+    Array<GCPair>,
+    DataSize,
+    RGATreeSplitPosRange,
+    Array<CRDTTextValue>
+    ];
     /**
      * `setStyle` applies the style of the given range.
      * 01. split nodes with from and to
@@ -1739,6 +1746,14 @@ declare class CRDTText<A extends Indexable = Indexable> extends CRDTElement {
      * `getTreeByID` returns the tree by ID for debugging.
      */
     getTreeByID(): LLRBTree<RGATreeSplitNodeID, RGATreeSplitNode<CRDTTextValue>>;
+    /**
+     * `refinePos` refines the given RGATreeSplitPos.
+     */
+    refinePos(pos: RGATreeSplitPos): RGATreeSplitPos;
+    /**
+     * `normalizePos` normalizes the given RGATreeSplitPos.
+     */
+    normalizePos(pos: RGATreeSplitPos): RGATreeSplitPos;
     /**
      * `getDataSize` returns the data usage of this element.
      */
@@ -1780,6 +1795,10 @@ declare class CRDTText<A extends Indexable = Indexable> extends CRDTElement {
      * `findIndexesFromRange` returns pair of integer offsets of the given range.
      */
     findIndexesFromRange(range: RGATreeSplitPosRange): [number, number];
+    /**
+     * `posToIndex` converts the given position to index.
+     */
+    posToIndex(pos: RGATreeSplitPos, preferToLeft?: boolean): number;
     /**
      * `getGCPairs` returns the pairs of GC.
      */
@@ -2895,6 +2914,7 @@ declare class Document_2<R, P extends Indexable = Indexable> implements Attachab
      * `applySnapshot` applies the given snapshot into this document.
      */
     applySnapshot(serverSeq: bigint, snapshotVector: VersionVector, snapshot?: Uint8Array, clientSeq?: number): void;
+    private clearHistory;
     /**
      * `applyChanges` applies the given changes into this document.
      */
@@ -4534,9 +4554,13 @@ export declare type PanelToSDKMessage =
  * ```typescript
  * const data = parse('{"content":Text([{"val":"Hi"}])}');
  * // { content: { type: 'Text', nodes: [{ val: 'Hi' }] } }
+ *
+ * // With type parameter:
+ * const data = parse<{ content: YSONText }>('{"content":Text([{"val":"Hi"}])}');
+ * // data.content is now typed as YSONText
  * ```
  */
-declare function parse(yson: string): YSONValue {
+declare function parse<T = YSONValue>(yson: string): T {
     try {
         // Preprocess YSON string to handle special types
         const processed = preprocessYSON(yson);
@@ -4545,7 +4569,7 @@ declare function parse(yson: string): YSONValue {
         const parsed = JSON.parse(processed);
 
         // Post-process to restore type information
-        return postprocessValue(parsed);
+        return postprocessValue(parsed) as T;
     } catch (err) {
         throw new YorkieError(
         Code.ErrInvalidArgument,
@@ -4940,9 +4964,15 @@ declare class RGATreeSplit<T extends RGATreeSplitValue> implements GCParent {
      * @param range - range of RGATreeSplitNode
      * @param editedAt - edited time
      * @param value - value
-     * @returns `[RGATreeSplitPos, Array<GCPair>, Array<Change>]`
-     */
-    edit(range: RGATreeSplitPosRange, editedAt: TimeTicket, value?: T, versionVector?: VersionVector): [RGATreeSplitPos, Array<GCPair>, DataSize, Array<ValueChange<T>>];
+     * @returns `[RGATreeSplitPos, Array<GCPair>, DataSize, Array<ValueChange<T>>, Array<T>]`
+     */
+    edit(range: RGATreeSplitPosRange, editedAt: TimeTicket, value?: T, versionVector?: VersionVector): [
+    RGATreeSplitPos,
+    Array<GCPair>,
+    DataSize,
+    Array<ValueChange<T>>,
+    Array<T>
+    ];
     /**
      * `indexToPos` finds RGATreeSplitPos of given offset.
      */
@@ -4984,6 +5014,32 @@ declare class RGATreeSplit<T extends RGATreeSplitValue> implements GCParent {
      * `deepcopy` copies itself deeply.
      */
     deepcopy(): RGATreeSplit<T>;
+    /**
+     * `normalizePos` converts a local position `(id, rel)` into a single
+     * absolute offset measured from the head `(0:0)` of the physical chain.
+     */
+    normalizePos(pos: RGATreeSplitPos): RGATreeSplitPos;
+    /**
+     * `refinePos` remaps the given pos to the current split chain.
+     *
+     * - Traverses the physical `next` chain (not `insNext`).
+     * - Counts only live characters: removed nodes are treated as length 0.
+     * - If the given offset exceeds the length of the current node,
+     *   it moves forward through `next` nodes, subtracting lengths,
+     *   until the offset fits in a live node.
+     * - If it runs out of nodes, it snaps to the end of the last node.
+     *
+     * Example:
+     *   Before split: ["12345"](1:2:0), pos = (1:2:0, rel=5)
+     *   After split : ["1"](1:2:0) - ["23"](1:2:1) - ["45"](1:2:3)
+     *   refinePos(pos) -> (1:2:3, rel=2)
+     *
+     * Example:
+     *   ["12"](1:2:0, live) and pos = (1:2:0, rel=4)
+     *   refinePos(pos) -> points two chars after "12",
+     *   i.e. advances into following nodes, skipping removed ones.
+     */
+    refinePos(pos: RGATreeSplitPos): RGATreeSplitPos;
     /**
      * `toTestString` returns a String containing the meta data of the node
      * for debugging purpose.
@@ -6752,15 +6808,15 @@ export declare type WrappedElement<T = unknown, A extends Indexable = Indexable>
 declare namespace YSON {
     export {
         YSONValue,
-        YSONText,
-        YSONTree,
-        YSONTextNode,
-        YSONTreeNode,
-        YSONInt,
-        YSONLong,
-        YSONDate,
-        YSONBinData,
-        YSONCounter,
+        YSONText as Text,
+        YSONTree as Tree,
+        YSONTextNode as TextNode,
+        YSONTreeNode as TreeNode,
+        YSONInt as Int,
+        YSONLong as Long,
+        YSONDate as Date,
+        YSONBinData as BinData,
+        YSONCounter as Counter,
         isText,
         isTree,
         isInt,
@@ -6774,6 +6830,7 @@ declare namespace YSON {
         treeToXML
     }
 }
+export { YSON }
 
 /**
  * `YSONBinData` represents Base64-encoded binary data.