Update CHANGELOG.md for v0.4.4 (#563)

* Update CHANGELOG.md for v0.4.4

* Add missing comments to exposed interfaces

CHANGELOG.md

@@ -7,6 +7,12 @@ and Yorkie JS SDK adheres to [Semantic Versioning](https://semver.org/spec/v2.0.
 
 ## [Unreleased]
 
+## [0.4.4] - 2023-07-05
+
+### Changed
+* Cleanup of test-related terminology by @chacha912 in https://github.com/yorkie-team/yorkie-js-sdk/pull/562
+* Use TreeRangeStruct to represent tree selection by @chacha912 in https://github.com/yorkie-team/yorkie-js-sdk/pull/561
+
 ## [0.4.3] - 2023-06-29
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yorkie-js-sdk",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Yorkie JS SDK",
   "main": "./dist/yorkie-js-sdk.js",
   "typings": "./dist/yorkie-js-sdk.d.ts",

package.publish.json

@@ -1,6 +1,6 @@
 {
   "name": "yorkie-js-sdk",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Yorkie JS SDK",
   "main": "./dist/yorkie-js-sdk.js",
   "typings": "./dist/yorkie-js-sdk.d.ts",

src/document/json/tree.ts

@@ -163,7 +163,8 @@ export class Tree {
   }
 
   /**
-   * `getInitialRoot` returns the root node of this tree.
+   * `buildRoot` builds the root of this tree with the given initial root
+   * which set by the user.
    */
   public buildRoot(context: ChangeContext): CRDTTreeNode {
     if (!this.initialRoot) {
@@ -438,7 +439,7 @@ export class Tree {
   }
 
   /**
-   * `createRange` returns pair of CRDTTreePos of the given integer offsets.
+   * `createRangeByPath` returns pair of CRDTTreePos of the given path.
    */
   createRangeByPath(fromPath: Array<number>, toPath: Array<number>): TreeRange {
     if (!this.context || !this.tree) {

src/document/operation/operation.ts

@@ -36,33 +36,57 @@ export type CounterOperationInfo = IncreaseOpInfo;
 export type ArrayOperationInfo = AddOpInfo | RemoveOpInfo | MoveOpInfo;
 export type ObjectOperationInfo = SetOpInfo | RemoveOpInfo;
 export type TreeOperationInfo = TreeEditOpInfo | TreeStyleOpInfo;
+
+/**
+ * `AddOpInfo` represents the information of the add operation.
+ */
 export type AddOpInfo = {
   type: 'add';
   path: string;
   index: number;
 };
+
+/**
+ * `MoveOpInfo` represents the information of the move operation.
+ */
 export type MoveOpInfo = {
   type: 'move';
   path: string;
   previousIndex: number;
   index: number;
 };
+
+/**
+ * `SetOpInfo` represents the information of the set operation.
+ */
 export type SetOpInfo = {
   type: 'set';
   path: string;
   key: string;
 };
+
+/**
+ * `RemoveOpInfo` represents the information of the remove operation.
+ */
 export type RemoveOpInfo = {
   type: 'remove';
   path: string;
   key?: string;
   index?: number;
 };
+
+/**
+ * `IncreaseOpInfo` represents the information of the increase operation.
+ */
 export type IncreaseOpInfo = {
   type: 'increase';
   path: string;
   value: number;
 };
+
+/**
+ * `EditOpInfo` represents the information of the edit operation.
+ */
 export type EditOpInfo = {
   type: 'edit';
   from: number;
@@ -73,6 +97,10 @@ export type EditOpInfo = {
     content: string;
   };
 };
+
+/**
+ * `StyleOpInfo` represents the information of the style operation.
+ */
 export type StyleOpInfo = {
   type: 'style';
   from: number;
@@ -82,12 +110,20 @@ export type StyleOpInfo = {
     attributes: Indexable;
   };
 };
+
+/**
+ * `SelectOpInfo` represents the information of the select operation.
+ */
 export type SelectOpInfo = {
   type: 'select';
   from: number;
   to: number;
   path: string;
 };
+
+/**
+ * `TreeEditOpInfo` represents the information of the tree edit operation.
+ */
 export type TreeEditOpInfo = {
   type: 'tree-edit';
   from: number;
@@ -97,6 +133,10 @@ export type TreeEditOpInfo = {
   value: TreeNode;
   path: string;
 };
+
+/**
+ * `TreeStyleOpInfo` represents the information of the tree style operation.
+ */
 export type TreeStyleOpInfo = {
   type: 'tree-style';
   from: number;

src/yorkie.ts

@@ -55,7 +55,10 @@ export {
   CompleteFn,
   Unsubscribe,
 } from '@yorkie-js-sdk/src/util/observable';
-export { TimeTicket, TimeTicketStruct } from '@yorkie-js-sdk/src/document/time/ticket';
+export {
+  TimeTicket,
+  TimeTicketStruct,
+} from '@yorkie-js-sdk/src/document/time/ticket';
 export { ActorID } from '@yorkie-js-sdk/src/document/time/actor_id';
 export type {
   OperationInfo,