@yorkie-js/sdk 0.7.2 → 0.7.3

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

@@ -2398,7 +2398,7 @@ export { Devtools }
  * `DocEvent` is an event that occurs in `Document`. It can be delivered
  * using `Document.subscribe()`.
  */
-export declare type DocEvent<P extends Indexable = Indexable, T = OpInfo> = StatusChangedEvent_2 | ConnectionChangedEvent | SyncStatusChangedEvent | SnapshotEvent | LocalChangeEvent<T, P> | RemoteChangeEvent<T, P> | PresenceEvent_2<P> | AuthErrorEvent_2;
+export declare type DocEvent<P extends Indexable = Indexable, T = OpInfo> = StatusChangedEvent_2 | ConnectionChangedEvent | SyncStatusChangedEvent | SnapshotEvent | LocalChangeEvent<T, P> | RemoteChangeEvent<T, P> | PresenceEvent_2<P> | AuthErrorEvent_2 | EpochMismatchEvent;
 
 /**
  * `DocEvent` is an event that occurs in `Document`. It can be delivered
@@ -2412,7 +2412,8 @@ declare type DocEvent_2<P extends Indexable_2 = Indexable_2, T = OpInfo_2> =
 | LocalChangeEvent_2<T, P>
 | RemoteChangeEvent_2<T, P>
 | PresenceEvent<P>
-| AuthErrorEvent;
+| AuthErrorEvent
+| EpochMismatchEvent_2;
 
 declare type DocEventCallbackMap<P extends Indexable> = {
     default: NextFn<LocalChangeEvent<OpInfo, P> | RemoteChangeEvent<OpInfo, P> | SnapshotEvent>;
@@ -2423,6 +2424,7 @@ declare type DocEventCallbackMap<P extends Indexable> = {
     status: NextFn<StatusChangedEvent_2>;
     sync: NextFn<SyncStatusChangedEvent>;
     'auth-error': NextFn<AuthErrorEvent_2>;
+    'epoch-mismatch': NextFn<EpochMismatchEvent>;
     all: NextFn<DocEvents<P>>;
 };
 
@@ -2508,7 +2510,12 @@ export declare enum DocEventType {
     /**
      * `AuthError` indicates an authorization failure in syncLoop or watchLoop.
      */
-    AuthError = "auth-error"
+    AuthError = "auth-error",
+    /**
+     * `EpochMismatch` indicates the document was compacted on the server
+     * and this client must detach and reattach to recover.
+     */
+    EpochMismatch = "epoch-mismatch"
 }
 
 /**
@@ -2570,6 +2577,12 @@ declare enum DocEventType_2 {
      * `AuthError` indicates an authorization failure in syncLoop or watchLoop.
      */
     AuthError = 'auth-error',
+
+    /**
+     * `EpochMismatch` indicates the document was compacted on the server
+     * and this client must detach and reattach to recover.
+     */
+    EpochMismatch = 'epoch-mismatch',
 }
 
 /**
@@ -2762,6 +2775,11 @@ declare class Document_2<R, P extends Indexable = Indexable> implements Attachab
      * The callback will be called when the authentification error occurs.
      */
     subscribe(type: 'auth-error', next: DocEventCallbackMap<P>['auth-error'], error?: ErrorFn): Unsubscribe;
+    /**
+     * `subscribe` registers a callback to subscribe to events on the document.
+     * The callback will be called when an epoch mismatch error occurs.
+     */
+    subscribe(type: 'epoch-mismatch', next: DocEventCallbackMap<P>['epoch-mismatch'], error?: ErrorFn): Unsubscribe;
     /**
      * `subscribe` registers a callback to subscribe to events on the document.
      */
@@ -3154,6 +3172,20 @@ declare interface Entry<K, V> {
     value: V;
 }
 
+export declare interface EpochMismatchEvent extends BaseDocEvent_2 {
+    type: DocEventType.EpochMismatch;
+    value: {
+        method: 'PushPull';
+    };
+}
+
+declare interface EpochMismatchEvent_2 extends BaseDocEvent {
+    type: DocEventType_2.EpochMismatch;
+    value: {
+        method: 'PushPull';
+    };
+}
+
 export declare type ErrorFn = (error: Error) => void;
 
 /**
@@ -6231,11 +6263,19 @@ export declare class Tree {
      */
     mergeByPath(path: Array<number>): void;
     /**
-     * `styleByPath` sets the attributes to the elements of the given path.
+     * `styleByPath` sets the attributes to the element at the given
+     * path.
      */
     styleByPath(path: Array<number>, attributes: {
         [key: string]: any;
     }): void;
+    /**
+     * `styleByPath` sets the attributes to the elements in the given
+     * path range.
+     */
+    styleByPath(fromPath: Array<number>, toPath: Array<number>, attributes: {
+        [key: string]: any;
+    }): void;
     /**
      * `style` sets the attributes to the elements of the given range.
      */
@@ -6246,6 +6286,11 @@ export declare class Tree {
      * `removeStyle` removes the attributes to the elements of the given range.
      */
     removeStyle(fromIdx: number, toIdx: number, attributesToRemove: Array<string>): void;
+    /**
+     * `removeStyleByPath` removes the attributes of the elements in
+     * the given path range.
+     */
+    removeStyleByPath(fromPath: Array<number>, toPath: Array<number>, attributesToRemove: Array<string>): void;
     private editInternal;
     /**
      * `editByPath` edits this tree with the given node and path.

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

@@ -5495,6 +5495,7 @@ var Code = /* @__PURE__ */ ((Code2) => {
   Code2["ErrUnauthenticated"] = "ErrUnauthenticated";
   Code2["ErrTooManySubscribers"] = "ErrTooManySubscribers";
   Code2["ErrTooManyAttachments"] = "ErrTooManyAttachments";
+  Code2["ErrEpochMismatch"] = "ErrEpochMismatch";
   return Code2;
 })(Code || {});
 class YorkieError extends Error {
@@ -17217,22 +17218,49 @@ class Tree {
     }
   }
   /**
-   * `styleByPath` sets the attributes to the elements of the given path.
+   * `styleByPath` sets the attributes to the elements of the given
+   * path. When called with two paths, it styles the range between
+   * them.
    */
-  styleByPath(path, attributes) {
+  styleByPath(fromPathOrPath, toPathOrAttrs, maybeAttrs) {
     if (!this.context || !this.tree) {
       throw new YorkieError(
         Code.ErrNotInitialized,
         "Tree is not initialized yet"
       );
     }
-    if (!path.length) {
-      throw new YorkieError(
-        Code.ErrInvalidArgument,
-        "path should not be empty"
-      );
+    let fromPos;
+    let toPos;
+    let attributes;
+    if (Array.isArray(toPathOrAttrs)) {
+      const fromPath = fromPathOrPath;
+      const toPath = toPathOrAttrs;
+      attributes = maybeAttrs;
+      if (fromPath.length !== toPath.length) {
+        throw new YorkieError(
+          Code.ErrInvalidArgument,
+          "path length should be equal"
+        );
+      }
+      if (!fromPath.length || !toPath.length) {
+        throw new YorkieError(
+          Code.ErrInvalidArgument,
+          "path should not be empty"
+        );
+      }
+      fromPos = this.tree.pathToPos(fromPath);
+      toPos = this.tree.pathToPos(toPath);
+    } else {
+      const path = fromPathOrPath;
+      attributes = toPathOrAttrs;
+      if (!path.length) {
+        throw new YorkieError(
+          Code.ErrInvalidArgument,
+          "path should not be empty"
+        );
+      }
+      [fromPos, toPos] = this.tree.pathToPosRange(path);
     }
-    const [fromPos, toPos] = this.tree.pathToPosRange(path);
     const ticket = this.context.issueTimeTicket();
     const attrs = attributes ? stringifyObjectValues(attributes) : void 0;
     const [pairs, , diff] = this.tree.style([fromPos, toPos], attrs, ticket);
@@ -17323,6 +17351,51 @@ class Tree {
       )
     );
   }
+  /**
+   * `removeStyleByPath` removes the attributes of the elements in
+   * the given path range.
+   */
+  removeStyleByPath(fromPath, toPath, attributesToRemove) {
+    if (!this.context || !this.tree) {
+      throw new YorkieError(
+        Code.ErrNotInitialized,
+        "Tree is not initialized yet"
+      );
+    }
+    if (fromPath.length !== toPath.length) {
+      throw new YorkieError(
+        Code.ErrInvalidArgument,
+        "path length should be equal"
+      );
+    }
+    if (!fromPath.length || !toPath.length) {
+      throw new YorkieError(
+        Code.ErrInvalidArgument,
+        "path should not be empty"
+      );
+    }
+    const fromPos = this.tree.pathToPos(fromPath);
+    const toPos = this.tree.pathToPos(toPath);
+    const ticket = this.context.issueTimeTicket();
+    const [pairs, , diff] = this.tree.removeStyle(
+      [fromPos, toPos],
+      attributesToRemove,
+      ticket
+    );
+    this.context.acc(diff);
+    for (const pair of pairs) {
+      this.context.registerGCPair(pair);
+    }
+    this.context.push(
+      TreeStyleOperation.createTreeRemoveStyleOperation(
+        this.tree.getCreatedAt(),
+        fromPos,
+        toPos,
+        attributesToRemove,
+        ticket
+      )
+    );
+  }
   editInternal(fromPos, toPos, contents, splitLevel = 0) {
     if (contents.length !== 0 && contents[0]) {
       validateTreeNodes(contents);
@@ -18707,6 +18780,7 @@ var DocEventType = /* @__PURE__ */ ((DocEventType2) => {
   DocEventType2["Unwatched"] = "unwatched";
   DocEventType2["PresenceChanged"] = "presence-changed";
   DocEventType2["AuthError"] = "auth-error";
+  DocEventType2["EpochMismatch"] = "epoch-mismatch";
   return DocEventType2;
 })(DocEventType || {});
 var StreamConnectionStatus = /* @__PURE__ */ ((StreamConnectionStatus2) => {
@@ -18996,6 +19070,17 @@ class Document {
           }
         }, arg3);
       }
+      if (arg1 === "epoch-mismatch") {
+        const callback2 = arg2;
+        return this.eventStream.subscribe((event) => {
+          for (const docEvent of event) {
+            if (docEvent.type !== "epoch-mismatch") {
+              continue;
+            }
+            callback2(docEvent);
+          }
+        }, arg3);
+      }
       if (arg1 === "all") {
         const callback2 = arg2;
         return this.eventStream.subscribe(callback2, arg3, arg4);
@@ -19943,7 +20028,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name = "@yorkie-js/sdk";
-const version = "0.7.2";
+const version = "0.7.3";
 const pkg = {
   name,
   version
@@ -20744,6 +20829,16 @@ class Client {
         ).catch(
           async (err) => {
             logger.error(`[SY] c:"${this.getKey()}" err :`, err);
+            if (isErrorCode(err, Code.ErrEpochMismatch)) {
+              attachment.resource.publish([
+                {
+                  type: DocEventType.EpochMismatch,
+                  value: {
+                    method: "PushPull"
+                  }
+                }
+              ]);
+            }
             await this.handleConnectError(err);
             throw err;
           }
@@ -21127,6 +21222,16 @@ class Client {
                     }
                   ]);
                 }
+                if (isErrorCode(e, Code.ErrEpochMismatch)) {
+                  attachment.resource.publish([
+                    {
+                      type: DocEventType.EpochMismatch,
+                      value: {
+                        method: "PushPull"
+                      }
+                    }
+                  ]);
+                }
                 throw e;
               })
             );
@@ -21556,6 +21661,9 @@ class Client {
     if (errorCodeOf(err) === Code.ErrTooManyAttachments) {
       return false;
     }
+    if (errorCodeOf(err) === Code.ErrEpochMismatch) {
+      return false;
+    }
     if (errorCodeOf(err) === Code.ErrClientNotActivated || errorCodeOf(err) === Code.ErrClientNotFound) {
       this.deactivateInternal();
     }