@yorkie-js/react 0.6.7 → 0.6.8

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

@@ -1,5 +1,6 @@
 import { ClientOptions } from '@yorkie-js/sdk';
 import { default as default_2 } from 'react';
+import { Document as Document_2 } from '@yorkie-js/sdk';
 import { Indexable } from '@yorkie-js/sdk';
 import { JSONArray } from '@yorkie-js/sdk';
 import { JSONObject } from '@yorkie-js/sdk';
@@ -8,6 +9,8 @@ import { Presence } from '@yorkie-js/sdk';
 import { PropsWithChildren } from 'react';
 import { StreamConnectionStatus } from '@yorkie-js/sdk';
 
+export { Document_2 as Document }
+
 /**
  * `DocumentProvider` is a component that provides a document to its children.
  * This component must be under a `YorkieProvider` component to initialize the
@@ -34,6 +37,7 @@ export declare const useConnection: () => StreamConnectionStatus;
  * This hook must be used within a `DocumentProvider`.
  */
 export declare const useDocument: <R, P extends Indexable = Indexable>() => {
+    doc: Document_2<R, P>;
     root: R;
     presences: {
         clientID: string;
@@ -50,7 +54,7 @@ export declare const useDocument: <R, P extends Indexable = Indexable>() => {
  */
 export declare const usePresences: () => {
     clientID: string;
-    presence: Indexable;
+    presence: any;
 }[];
 
 /**

package/dist/yorkie-js-react.es.js

@@ -5,7 +5,7 @@ var _a, _b, _c, _d, _e, _f, _g, _h, _i;
 import { jsx } from "react/jsx-runtime";
 import { createContext, useMemo, useState, useEffect, useContext, useCallback } from "react";
 const name$1 = "@yorkie-js/react";
-const version$1 = "0.6.7";
+const version$1 = "0.6.8";
 const pkg$1 = {
   name: name$1,
   version: version$1
@@ -7675,6 +7675,7 @@ class Presence {
   }
 }
 const InitialActorID = "000000000000000000000000";
+const TimeTicketSize = 8 + 4 + 12;
 class TimeTicket {
   constructor(lamport, delimiter, actorID) {
     __publicField(this, "lamport");
@@ -7893,6 +7894,22 @@ class CRDTElement {
   isRemoved() {
     return !!this.removedAt;
   }
+  /**
+   * `getMetaUsage` returns the meta usage of this element.
+   */
+  getMetaUsage() {
+    let meta = 0;
+    if (this.getCreatedAt()) {
+      meta += TimeTicketSize;
+    }
+    if (this.getMovedAt()) {
+      meta += TimeTicketSize;
+    }
+    if (this.getRemovedAt()) {
+      meta += TimeTicketSize;
+    }
+    return meta;
+  }
 }
 class CRDTContainer extends CRDTElement {
   constructor(createdAt) {
@@ -8125,6 +8142,15 @@ class CRDTObject extends CRDTContainer {
   has(key) {
     return this.memberNodes.has(key);
   }
+  /**
+   * `getDataSize` returns the data usage of this element.
+   */
+  getDataSize() {
+    return {
+      data: 0,
+      meta: this.getMetaUsage()
+    };
+  }
   /**
    * `toJSON` returns the JSON encoding of this object.
    */
@@ -9692,6 +9718,44 @@ class Primitive extends CRDTElement {
         );
     }
   }
+  /**
+   * `getValueSize` returns the size of the value. The size is similar to
+   * the size of primitives in JavaScript.
+   */
+  getValueSize() {
+    switch (this.valueType) {
+      case 0:
+        return 8;
+      case 1:
+        return 4;
+      case 2:
+        return 4;
+      case 3:
+        return 8;
+      case 4:
+        return 8;
+      case 5:
+        return this.value.length * 2;
+      case 6:
+        return this.value.length;
+      case 7:
+        return 8;
+      default:
+        throw new YorkieError(
+          Code.ErrUnimplemented,
+          `unimplemented type: ${this.valueType}`
+        );
+    }
+  }
+  /**
+   * `getDataSize` returns the data usage of this element.
+   */
+  getDataSize() {
+    return {
+      data: this.getValueSize(),
+      meta: this.getMetaUsage()
+    };
+  }
   /**
    * `toJSON` returns the JSON encoding of the value.
    */
@@ -10290,6 +10354,15 @@ class CRDTArray extends CRDTContainer {
       }
     }
   }
+  /**
+   * `getDataSize` returns the data usage of this element.
+   */
+  getDataSize() {
+    return {
+      data: 0,
+      meta: this.getMetaUsage()
+    };
+  }
   /**
    * `toJSON` returns the JSON encoding of this array.
    */
@@ -10757,6 +10830,15 @@ class RHTNode {
     }
     return void 0;
   }
+  /**
+   * `getDataSize` returns the size of this node.
+   */
+  getDataSize() {
+    return {
+      data: (this.key.length + this.value.length) * 2,
+      meta: TimeTicketSize
+    };
+  }
 }
 class RHT {
   constructor() {
@@ -10968,6 +11050,19 @@ class CRDTTextValue {
   toString() {
     return this.content;
   }
+  /**
+   * `getDataSize` returns the data usage of this value.
+   */
+  getDataSize() {
+    const dataSize = { data: 0, meta: 0 };
+    dataSize.data += this.content.length * 2;
+    for (const node of this.attributes) {
+      const size = node.getDataSize();
+      dataSize.meta += size.meta;
+      dataSize.data += size.data;
+    }
+    return dataSize;
+  }
   /**
    * `toJSON` returns the JSON encoding of this value.
    */
@@ -11159,6 +11254,24 @@ class CRDTText extends CRDTElement {
   getTreeByID() {
     return this.rgaTreeSplit.getTreeByID();
   }
+  /**
+   * `getDataSize` returns the data usage of this element.
+   */
+  getDataSize() {
+    const dataSize = { data: 0, meta: 0 };
+    for (const node of this.rgaTreeSplit) {
+      if (node.isRemoved()) {
+        continue;
+      }
+      const size = node.getDataSize();
+      dataSize.data += size.data;
+      dataSize.meta += size.meta;
+    }
+    return {
+      data: dataSize.data,
+      meta: dataSize.meta + this.getMetaUsage()
+    };
+  }
   /**
    * `toJSON` returns the JSON encoding of this text.
    */
@@ -12773,6 +12886,32 @@ class CRDTTreeNode extends IndexTreeNode {
       this.attrs.purge(node);
     }
   }
+  /**
+   * `getDataSize` returns the data size of the node.
+   */
+  getDataSize() {
+    const dataSize = { data: 0, meta: 0 };
+    if (this.isText) {
+      dataSize.data += this.size * 2;
+    }
+    if (this.id) {
+      dataSize.meta += TimeTicketSize;
+    }
+    if (this.removedAt) {
+      dataSize.meta += TimeTicketSize;
+    }
+    if (this.attrs) {
+      for (const node of this.attrs) {
+        if (node.getRemovedAt()) {
+          continue;
+        }
+        const size = node.getDataSize();
+        dataSize.meta += size.meta;
+        dataSize.data += size.data;
+      }
+    }
+    return dataSize;
+  }
   /**
    * `getGCPairs` returns the pairs of GC.
    */
@@ -13272,6 +13411,24 @@ class CRDTTree extends CRDTElement {
   toXML() {
     return toXML(this.indexTree.getRoot());
   }
+  /**
+   * `getDataSize` returns the data usage of this element.
+   */
+  getDataSize() {
+    const dataSize = { data: 0, meta: 0 };
+    this.indexTree.traverse((node) => {
+      if (node.getRemovedAt()) {
+        return;
+      }
+      const size = node.getDataSize();
+      dataSize.data += size.data;
+      dataSize.meta += size.meta;
+    });
+    return {
+      data: dataSize.data,
+      meta: dataSize.meta + this.getMetaUsage()
+    };
+  }
   /**
    * `toJSON` returns the JSON encoding of this tree.
    */
@@ -14628,6 +14785,19 @@ class RGATreeSplitNode extends SplayNode {
       RGATreeSplitPos.of(this.id, this.getLength())
     ];
   }
+  /**
+   * `getData` returns the data of this node.
+   */
+  getDataSize() {
+    const dataSize = this.value.getDataSize();
+    if (this.id) {
+      dataSize.meta += TimeTicketSize;
+    }
+    if (this.removedAt) {
+      dataSize.meta += TimeTicketSize;
+    }
+    return dataSize;
+  }
   /**
    * `deepcopy` returns a new instance of this RGATreeSplitNode without structural info.
    */
@@ -15056,8 +15226,8 @@ class RGATreeSplit {
 }
 const removeDecimal = (number) => number < 0 ? Math.ceil(number) : Math.floor(number);
 var CounterType = /* @__PURE__ */ ((CounterType2) => {
-  CounterType2[CounterType2["IntegerCnt"] = 0] = "IntegerCnt";
-  CounterType2[CounterType2["LongCnt"] = 1] = "LongCnt";
+  CounterType2[CounterType2["Int"] = 0] = "Int";
+  CounterType2[CounterType2["Long"] = 1] = "Long";
   return CounterType2;
 })(CounterType || {});
 class CRDTCounter extends CRDTElement {
@@ -15114,6 +15284,16 @@ class CRDTCounter extends CRDTElement {
         );
     }
   }
+  /**
+   * `getDataSize` returns the data usage of this element.
+   */
+  getDataSize() {
+    const data = this.valueType === 0 ? 4 : 8;
+    return {
+      data,
+      meta: this.getMetaUsage()
+    };
+  }
   /**
    * `toJSON` returns the JSON encoding of the value.
    */
@@ -15565,9 +15745,9 @@ function toValueType(valueType) {
 }
 function toCounterType(valueType) {
   switch (valueType) {
-    case CounterType.IntegerCnt:
+    case CounterType.Int:
       return ValueType.INTEGER_CNT;
-    case CounterType.LongCnt:
+    case CounterType.Long:
       return ValueType.LONG_CNT;
     default:
       throw new YorkieError(
@@ -16120,9 +16300,9 @@ function fromValueType(pbValueType) {
 function fromCounterType(pbValueType) {
   switch (pbValueType) {
     case ValueType.INTEGER_CNT:
-      return CounterType.IntegerCnt;
+      return CounterType.Int;
     case ValueType.LONG_CNT:
-      return CounterType.LongCnt;
+      return CounterType.Long;
   }
   throw new YorkieError(
     Code.ErrUnimplemented,
@@ -17221,6 +17401,27 @@ class CRDTRoot {
   getGarbageLen() {
     return this.getGarbageElementSetSize() + this.gcPairMap.size;
   }
+  /**
+   * `getDocSize` returns the size of the document.
+   */
+  getDocSize() {
+    const docSize = { live: { data: 0, meta: 0 }, gc: { data: 0, meta: 0 } };
+    for (const [createdAt, value] of this.elementPairMapByCreatedAt) {
+      if (this.gcElementSetByCreatedAt.has(createdAt)) {
+        docSize.gc.data += value.element.getDataSize().data;
+        docSize.gc.meta += value.element.getDataSize().meta;
+      } else {
+        docSize.live.data += value.element.getDataSize().data;
+        docSize.live.meta += value.element.getDataSize().meta;
+      }
+    }
+    for (const pair of this.gcPairMap.values()) {
+      const size = pair.child.getDataSize();
+      docSize.gc.data += size.data;
+      docSize.gc.meta += size.meta;
+    }
+    return docSize;
+  }
   /**
    * `deepcopy` copies itself deeply.
    */
@@ -18778,7 +18979,7 @@ function toWrappedElement(context, elem) {
   } else if (elem instanceof CRDTText) {
     return new Text(context, elem);
   } else if (elem instanceof CRDTCounter) {
-    const counter = new Counter(CounterType.IntegerCnt, 0);
+    const counter = new Counter(CounterType.Int, 0);
     counter.initialize(context, elem);
     return counter;
   } else if (elem instanceof CRDTTree) {
@@ -19531,6 +19732,12 @@ class Document {
     );
     return createJSON(context, this.clone.root.getObject());
   }
+  /**
+   * `getDocSize` returns the size of this document.
+   */
+  getDocSize() {
+    return this.root.getDocSize();
+  }
   /**
    * `garbageCollect` purges elements that were removed before the given time.
    *
@@ -20240,7 +20447,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name = "@yorkie-js/sdk";
-const version = "0.6.7";
+const version = "0.6.8";
 const pkg = {
   name,
   version
@@ -21085,8 +21292,8 @@ class Client {
   }
 }
 ({
-  IntType: CounterType.IntegerCnt,
-  LongType: CounterType.LongCnt
+  IntType: CounterType.Int,
+  LongType: CounterType.Long
 });
 if (typeof globalThis !== "undefined") {
   globalThis.yorkie = {
@@ -21098,8 +21305,8 @@ if (typeof globalThis !== "undefined") {
     Tree,
     LogLevel,
     setLogLevel,
-    IntType: CounterType.IntegerCnt,
-    LongType: CounterType.LongCnt
+    IntType: CounterType.Int,
+    LongType: CounterType.Long
   };
 }
 const YorkieContext = createContext({
@@ -21257,7 +21464,9 @@ function useYorkieDocument(client, clientLoading, clientError, docKey, initialRo
     error
   };
 }
-const DocumentContext = createContext(null);
+const DocumentContext = createContext(
+  null
+);
 const DocumentProvider = ({
   docKey,
   initialRoot = {},
@@ -21265,7 +21474,7 @@ const DocumentProvider = ({
   children
 }) => {
   const { client, loading: clientLoading, error: clientError } = useYorkie();
-  const { root, presences, connection, update, loading, error } = useYorkieDocument(
+  const { doc, root, presences, connection, update, loading, error } = useYorkieDocument(
     client,
     clientLoading,
     clientError,
@@ -21276,7 +21485,15 @@ const DocumentProvider = ({
   return /* @__PURE__ */ jsx(
     DocumentContext.Provider,
     {
-      value: { root, presences, connection, update, loading, error },
+      value: {
+        doc,
+        root,
+        presences,
+        connection,
+        update,
+        loading,
+        error
+      },
       children
     }
   );
@@ -21287,6 +21504,7 @@ const useDocument = () => {
     throw new Error("useDocument must be used within a DocumentProvider");
   }
   return {
+    doc: context.doc,
     root: context.root,
     presences: context.presences,
     connection: context.connection,