Remove redundant types from tree (#666)

Co-authored-by: Youngteac Hong <susukang98@gmail.com>

src/document/crdt/tree.ts

@@ -25,7 +25,6 @@ import {
   IndexTree,
   TreePos,
   IndexTreeNode,
-  TreeNodeType,
   traverseAll,
   TagContained,
 } from '@yorkie-js-sdk/src/util/index_tree';
@@ -34,16 +33,29 @@ import { ActorID } from './../time/actor_id';
 import { LLRBTree } from '@yorkie-js-sdk/src/util/llrb_tree';
 import { Comparator } from '@yorkie-js-sdk/src/util/comparator';
 import { parseObjectValues } from '@yorkie-js-sdk/src/util/object';
+import type {
+  DefaultTextType,
+  TreeNodeType,
+} from '@yorkie-js-sdk/src/util/index_tree';
+import { Indexable } from '@yorkie-js-sdk/src/document/document';
+
+export type TreeNode = TextNode | ElementNode;
 
 /**
- * `TreeNode` represents the JSON representation of a node in the tree.
- * It is used to serialize and deserialize the tree.
+ * `ElementNode` represents an element node. It has an attributes and children.
  */
-export type TreeNode = {
+export type ElementNode<A extends Indexable = Indexable> = {
   type: TreeNodeType;
-  children?: Array<TreeNode>;
-  value?: string;
-  attributes?: { [key: string]: any };
+  attributes?: A;
+  children: Array<TreeNode>;
+};
+
+/**
+ * `TextNode` represents a text node. It has a string value.
+ */
+export type TextNode = {
+  type: typeof DefaultTextType;
+  value: string;
 };
 
 /**
@@ -461,7 +473,7 @@ function toTreeNode(node: CRDTTreeNode): TreeNode {
     return {
       type: currentNode.type,
       value: currentNode.value,
-    };
+    } as TextNode;
   }
 
   return {
@@ -498,7 +510,7 @@ function toTestTreeNode(node: CRDTTreeNode): TreeNodeForTest {
       value: currentNode.value,
       size: currentNode.size,
       isRemoved: currentNode.isRemoved,
-    };
+    } as TreeNodeForTest;
   }
 
   return {

src/document/json/tree.ts

@@ -14,51 +14,48 @@
  * limitations under the License.
  */
 
-import { Indexable } from '@yorkie-js-sdk/src/document/document';
 import { TimeTicket } from '@yorkie-js-sdk/src/document/time/ticket';
 import { ChangeContext } from '@yorkie-js-sdk/src/document/change/context';
 import {
   CRDTTree,
   CRDTTreeNodeID,
   CRDTTreeNode,
-  TreePosStructRange,
-  TreeChange,
   CRDTTreePos,
 } from '@yorkie-js-sdk/src/document/crdt/tree';
 
 import {
   IndexTree,
   DefaultRootType,
   DefaultTextType,
-  TreeNodeType,
 } from '@yorkie-js-sdk/src/util/index_tree';
 import { TreeEditOperation } from '@yorkie-js-sdk/src/document/operation/tree_edit_operation';
 import { isEmpty, stringifyObjectValues } from '@yorkie-js-sdk/src/util/object';
 import { RHT } from '../crdt/rht';
 import { TreeStyleOperation } from '../operation/tree_style_operation';
 import { logger } from '@yorkie-js-sdk/src/util/logger';
-
-export type TreeNode = TextNode | ElementNode;
-export type TreeChangeWithPath = Omit<TreeChange, 'from' | 'to'> & {
-  from: Array<number>;
-  to: Array<number>;
-};
-
-/**
- * `ElementNode` is a node that has children.
- */
-export type ElementNode<A extends Indexable = Indexable> = {
-  type: TreeNodeType;
-  attributes?: A;
-  children: Array<TreeNode>;
-};
+import type {
+  ElementNode,
+  TextNode,
+  TreeNode,
+  TreeChange,
+  TreeChangeType,
+  TreePosStructRange,
+  CRDTTreeNodeIDStruct,
+} from '@yorkie-js-sdk/src/document/crdt/tree';
 
 /**
- * `TextNode` is a node that has a value.
+ * NOTE(hackerwins): In normal case, we should define the following types in
+ * json package, because they are directly used by the user. However, we define
+ * them in crdt package to avoid circular dependency between json and crdt.
  */
-export type TextNode = {
-  type: typeof DefaultTextType;
-  value: string;
+export {
+  TreeNode,
+  ElementNode,
+  TextNode,
+  TreeChange,
+  TreeChangeType,
+  TreePosStructRange,
+  CRDTTreeNodeIDStruct,
 };
 
 /**

src/yorkie.ts

@@ -74,13 +74,6 @@ export type {
   StyleOpInfo,
 } from '@yorkie-js-sdk/src/document/operation/operation';
 
-export {
-  TreeChange,
-  TreeChangeType,
-  CRDTTreeNodeIDStruct,
-  TreePosStructRange as TreeRangeStruct,
-} from '@yorkie-js-sdk/src/document/crdt/tree';
-
 export {
   Primitive,
   PrimitiveValue,
@@ -104,6 +97,10 @@ export {
   TreeNode,
   ElementNode,
   TextNode,
+  TreeChange,
+  TreeChangeType,
+  CRDTTreeNodeIDStruct,
+  TreePosStructRange,
 } from '@yorkie-js-sdk/src/document/json/tree';
 export { Change } from '@yorkie-js-sdk/src/document/change/change';
 export { converter } from '@yorkie-js-sdk/src/api/converter';