@yorkie-js/sdk 0.6.39 → 0.6.40

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

@@ -6101,6 +6101,10 @@ const _Project = class _Project extends Message {
      * @generated from field: bool remove_on_detach = 16;
      */
     __publicField(this, "removeOnDetach", false);
+    /**
+     * @generated from field: bool auto_revision_enabled = 27;
+     */
+    __publicField(this, "autoRevisionEnabled", false);
     /**
      * @generated from field: repeated string allowed_origins = 14;
      */
@@ -6280,6 +6284,13 @@ __publicField(_Project, "fields", proto3.util.newFieldList(() => [
     T: 8
     /* ScalarType.BOOL */
   },
+  {
+    no: 27,
+    name: "auto_revision_enabled",
+    kind: "scalar",
+    T: 8
+    /* ScalarType.BOOL */
+  },
   { no: 14, name: "allowed_origins", kind: "scalar", T: 9, repeated: true },
   { no: 12, name: "created_at", kind: "message", T: Timestamp },
   { no: 13, name: "updated_at", kind: "message", T: Timestamp }
@@ -6413,6 +6424,10 @@ const _UpdatableProjectFields = class _UpdatableProjectFields extends Message {
      * @generated from field: google.protobuf.BoolValue remove_on_detach = 11;
      */
     __publicField(this, "removeOnDetach");
+    /**
+     * @generated from field: google.protobuf.BoolValue auto_revision_enabled = 22;
+     */
+    __publicField(this, "autoRevisionEnabled");
     /**
      * @generated from field: yorkie.v1.UpdatableProjectFields.AllowedOrigins allowed_origins = 9;
      */
@@ -6455,6 +6470,7 @@ __publicField(_UpdatableProjectFields, "fields", proto3.util.newFieldList(() =>
   { no: 8, name: "max_attachments_per_document", kind: "message", T: Int32Value },
   { no: 10, name: "max_size_per_document", kind: "message", T: Int32Value },
   { no: 11, name: "remove_on_detach", kind: "message", T: BoolValue },
+  { no: 22, name: "auto_revision_enabled", kind: "message", T: BoolValue },
   { no: 9, name: "allowed_origins", kind: "message", T: UpdatableProjectFields_AllowedOrigins }
 ]));
 let UpdatableProjectFields = _UpdatableProjectFields;
@@ -6723,6 +6739,51 @@ __publicField(_Presence, "fields", proto3.util.newFieldList(() => [
   } }
 ]));
 let Presence = _Presence;
+const _ChannelSummary = class _ChannelSummary extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string key = 1;
+     */
+    __publicField(this, "key", "");
+    /**
+     * @generated from field: int32 presence_count = 2;
+     */
+    __publicField(this, "presenceCount", 0);
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _ChannelSummary().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _ChannelSummary().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _ChannelSummary().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_ChannelSummary, a, b);
+  }
+};
+__publicField(_ChannelSummary, "runtime", proto3);
+__publicField(_ChannelSummary, "typeName", "yorkie.v1.ChannelSummary");
+__publicField(_ChannelSummary, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "key",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "presence_count",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  }
+]));
+let ChannelSummary = _ChannelSummary;
 let Checkpoint$1 = (_g = class extends Message {
   constructor(data) {
     super();
@@ -7249,6 +7310,78 @@ __publicField(_Rule, "fields", proto3.util.newFieldList(() => [
   }
 ]));
 let Rule = _Rule;
+const _RevisionSummary = class _RevisionSummary extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string id = 1;
+     */
+    __publicField(this, "id", "");
+    /**
+     * @generated from field: string label = 2;
+     */
+    __publicField(this, "label", "");
+    /**
+     * @generated from field: string description = 3;
+     */
+    __publicField(this, "description", "");
+    /**
+     * @generated from field: string snapshot = 4;
+     */
+    __publicField(this, "snapshot", "");
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 5;
+     */
+    __publicField(this, "createdAt");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _RevisionSummary().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _RevisionSummary().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _RevisionSummary().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_RevisionSummary, a, b);
+  }
+};
+__publicField(_RevisionSummary, "runtime", proto3);
+__publicField(_RevisionSummary, "typeName", "yorkie.v1.RevisionSummary");
+__publicField(_RevisionSummary, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "label",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 3,
+    name: "description",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 4,
+    name: "snapshot",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  { no: 5, name: "created_at", kind: "message", T: Timestamp }
+]));
+let RevisionSummary = _RevisionSummary;
 const _ActivateClientRequest = class _ActivateClientRequest extends Message {
   constructor(data) {
     super();
@@ -7856,6 +7989,274 @@ __publicField(_PushPullChangesResponse, "fields", proto3.util.newFieldList(() =>
   { no: 1, name: "change_pack", kind: "message", T: ChangePack$1 }
 ]));
 let PushPullChangesResponse = _PushPullChangesResponse;
+const _CreateRevisionRequest = class _CreateRevisionRequest extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string client_id = 1;
+     */
+    __publicField(this, "clientId", "");
+    /**
+     * @generated from field: string document_id = 2;
+     */
+    __publicField(this, "documentId", "");
+    /**
+     * @generated from field: string label = 3;
+     */
+    __publicField(this, "label", "");
+    /**
+     * @generated from field: string description = 4;
+     */
+    __publicField(this, "description", "");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _CreateRevisionRequest().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _CreateRevisionRequest().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _CreateRevisionRequest().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_CreateRevisionRequest, a, b);
+  }
+};
+__publicField(_CreateRevisionRequest, "runtime", proto3);
+__publicField(_CreateRevisionRequest, "typeName", "yorkie.v1.CreateRevisionRequest");
+__publicField(_CreateRevisionRequest, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "client_id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "document_id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 3,
+    name: "label",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 4,
+    name: "description",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  }
+]));
+let CreateRevisionRequest = _CreateRevisionRequest;
+const _CreateRevisionResponse = class _CreateRevisionResponse extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: yorkie.v1.RevisionSummary revision = 1;
+     */
+    __publicField(this, "revision");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _CreateRevisionResponse().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _CreateRevisionResponse().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _CreateRevisionResponse().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_CreateRevisionResponse, a, b);
+  }
+};
+__publicField(_CreateRevisionResponse, "runtime", proto3);
+__publicField(_CreateRevisionResponse, "typeName", "yorkie.v1.CreateRevisionResponse");
+__publicField(_CreateRevisionResponse, "fields", proto3.util.newFieldList(() => [
+  { no: 1, name: "revision", kind: "message", T: RevisionSummary }
+]));
+let CreateRevisionResponse = _CreateRevisionResponse;
+const _ListRevisionsRequest = class _ListRevisionsRequest extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string project_id = 1;
+     */
+    __publicField(this, "projectId", "");
+    /**
+     * @generated from field: string document_id = 2;
+     */
+    __publicField(this, "documentId", "");
+    /**
+     * @generated from field: int32 page_size = 3;
+     */
+    __publicField(this, "pageSize", 0);
+    /**
+     * @generated from field: int32 offset = 4;
+     */
+    __publicField(this, "offset", 0);
+    /**
+     * @generated from field: bool is_forward = 5;
+     */
+    __publicField(this, "isForward", false);
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _ListRevisionsRequest().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _ListRevisionsRequest().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _ListRevisionsRequest().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_ListRevisionsRequest, a, b);
+  }
+};
+__publicField(_ListRevisionsRequest, "runtime", proto3);
+__publicField(_ListRevisionsRequest, "typeName", "yorkie.v1.ListRevisionsRequest");
+__publicField(_ListRevisionsRequest, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "project_id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "document_id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 3,
+    name: "page_size",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  },
+  {
+    no: 4,
+    name: "offset",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  },
+  {
+    no: 5,
+    name: "is_forward",
+    kind: "scalar",
+    T: 8
+    /* ScalarType.BOOL */
+  }
+]));
+let ListRevisionsRequest = _ListRevisionsRequest;
+const _ListRevisionsResponse = class _ListRevisionsResponse extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: repeated yorkie.v1.RevisionSummary revisions = 1;
+     */
+    __publicField(this, "revisions", []);
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _ListRevisionsResponse().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _ListRevisionsResponse().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _ListRevisionsResponse().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_ListRevisionsResponse, a, b);
+  }
+};
+__publicField(_ListRevisionsResponse, "runtime", proto3);
+__publicField(_ListRevisionsResponse, "typeName", "yorkie.v1.ListRevisionsResponse");
+__publicField(_ListRevisionsResponse, "fields", proto3.util.newFieldList(() => [
+  { no: 1, name: "revisions", kind: "message", T: RevisionSummary, repeated: true }
+]));
+let ListRevisionsResponse = _ListRevisionsResponse;
+const _RestoreRevisionRequest = class _RestoreRevisionRequest extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string client_id = 1;
+     */
+    __publicField(this, "clientId", "");
+    /**
+     * @generated from field: string revision_id = 2;
+     */
+    __publicField(this, "revisionId", "");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _RestoreRevisionRequest().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _RestoreRevisionRequest().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _RestoreRevisionRequest().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_RestoreRevisionRequest, a, b);
+  }
+};
+__publicField(_RestoreRevisionRequest, "runtime", proto3);
+__publicField(_RestoreRevisionRequest, "typeName", "yorkie.v1.RestoreRevisionRequest");
+__publicField(_RestoreRevisionRequest, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "client_id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "revision_id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  }
+]));
+let RestoreRevisionRequest = _RestoreRevisionRequest;
+const _RestoreRevisionResponse = class _RestoreRevisionResponse extends Message {
+  constructor(data) {
+    super();
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _RestoreRevisionResponse().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _RestoreRevisionResponse().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _RestoreRevisionResponse().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_RestoreRevisionResponse, a, b);
+  }
+};
+__publicField(_RestoreRevisionResponse, "runtime", proto3);
+__publicField(_RestoreRevisionResponse, "typeName", "yorkie.v1.RestoreRevisionResponse");
+__publicField(_RestoreRevisionResponse, "fields", proto3.util.newFieldList(() => []));
+let RestoreRevisionResponse = _RestoreRevisionResponse;
 const _AttachChannelRequest = class _AttachChannelRequest extends Message {
   constructor(data) {
     super();
@@ -8400,6 +8801,33 @@ const YorkieService = {
       O: WatchDocumentResponse,
       kind: MethodKind.ServerStreaming
     },
+    /**
+     * @generated from rpc yorkie.v1.YorkieService.CreateRevision
+     */
+    createRevision: {
+      name: "CreateRevision",
+      I: CreateRevisionRequest,
+      O: CreateRevisionResponse,
+      kind: MethodKind.Unary
+    },
+    /**
+     * @generated from rpc yorkie.v1.YorkieService.ListRevisions
+     */
+    listRevisions: {
+      name: "ListRevisions",
+      I: ListRevisionsRequest,
+      O: ListRevisionsResponse,
+      kind: MethodKind.Unary
+    },
+    /**
+     * @generated from rpc yorkie.v1.YorkieService.RestoreRevision
+     */
+    restoreRevision: {
+      name: "RestoreRevision",
+      I: RestoreRevisionRequest,
+      O: RestoreRevisionResponse,
+      kind: MethodKind.Unary
+    },
     /**
      * @generated from rpc yorkie.v1.YorkieService.AttachChannel
      */
@@ -17605,6 +18033,16 @@ function toChangePack(pack) {
     versionVector: toVersionVector(pack.getVersionVector())
   });
 }
+function toRevisionSummary(pbRevision) {
+  var _a2;
+  return {
+    id: pbRevision.id,
+    label: pbRevision.label,
+    description: pbRevision.description,
+    snapshot: pbRevision.snapshot,
+    createdAt: ((_a2 = pbRevision.createdAt) == null ? void 0 : _a2.toDate()) || /* @__PURE__ */ new Date()
+  };
+}
 function errorMetadataOf(error) {
   if (!(error instanceof ConnectError)) {
     return {};
@@ -18234,7 +18672,8 @@ const converter = {
   bytesToOperation,
   versionVectorToHex,
   hexToVersionVector,
-  fromSchemaRules
+  fromSchemaRules,
+  toRevisionSummary
 };
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
   LogLevel2[LogLevel2["Trivial"] = 0] = "Trivial";
@@ -22272,7 +22711,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name = "@yorkie-js/sdk";
-const version = "0.6.39";
+const version = "0.6.40";
 const pkg = {
   name,
   version
@@ -23130,6 +23569,131 @@ class Client {
   getCondition(condition) {
     return this.conditions[condition];
   }
+  /**
+   * `createRevision` creates a new revision for the given document.
+   */
+  async createRevision(doc, label, description) {
+    if (!this.isActive()) {
+      throw new YorkieError(
+        Code.ErrClientNotActivated,
+        `${this.key} is not active`
+      );
+    }
+    const attachment = this.attachmentMap.get(doc.getKey());
+    if (!attachment) {
+      throw new YorkieError(
+        Code.ErrNotAttached,
+        `${doc.getKey()} is not attached`
+      );
+    }
+    const task = async () => {
+      try {
+        const res = await this.rpcClient.createRevision(
+          {
+            clientId: this.id,
+            documentId: attachment.resourceID,
+            label,
+            description: description || ""
+          },
+          { headers: { "x-shard-key": `${this.apiKey}/${doc.getKey()}` } }
+        );
+        if (!res.revision) {
+          throw new YorkieError(
+            Code.ErrInvalidArgument,
+            "revision is not returned"
+          );
+        }
+        logger.info(
+          `[CR] c:"${this.getKey()}" creates revision d:"${doc.getKey()}" l:"${label}"`
+        );
+        return converter.toRevisionSummary(res.revision);
+      } catch (err) {
+        logger.error(`[CR] c:"${this.getKey()}" err :`, err);
+        await this.handleConnectError(err);
+        throw err;
+      }
+    };
+    return this.enqueueTask(task);
+  }
+  /**
+   * `listRevisions` lists all revisions for the given document.
+   */
+  async listRevisions(doc, options) {
+    if (!this.isActive()) {
+      throw new YorkieError(
+        Code.ErrClientNotActivated,
+        `${this.key} is not active`
+      );
+    }
+    const attachment = this.attachmentMap.get(doc.getKey());
+    if (!attachment) {
+      throw new YorkieError(
+        Code.ErrNotAttached,
+        `${doc.getKey()} is not attached`
+      );
+    }
+    const task = async () => {
+      try {
+        const res = await this.rpcClient.listRevisions(
+          {
+            projectId: "",
+            // Will be filled by server from auth context
+            documentId: attachment.resourceID,
+            pageSize: (options == null ? void 0 : options.pageSize) || 10,
+            offset: (options == null ? void 0 : options.offset) || 0,
+            isForward: (options == null ? void 0 : options.isForward) ?? false
+          },
+          { headers: { "x-shard-key": `${this.apiKey}/${doc.getKey()}` } }
+        );
+        logger.info(
+          `[LR] c:"${this.getKey()}" lists revisions d:"${doc.getKey()}" count:${res.revisions.length}`
+        );
+        return res.revisions.map(converter.toRevisionSummary);
+      } catch (err) {
+        logger.error(`[LR] c:"${this.getKey()}" err :`, err);
+        await this.handleConnectError(err);
+        throw err;
+      }
+    };
+    return this.enqueueTask(task);
+  }
+  /**
+   * `restoreRevision` restores the document to the given revision.
+   */
+  async restoreRevision(doc, revisionId) {
+    if (!this.isActive()) {
+      throw new YorkieError(
+        Code.ErrClientNotActivated,
+        `${this.key} is not active`
+      );
+    }
+    const attachment = this.attachmentMap.get(doc.getKey());
+    if (!attachment) {
+      throw new YorkieError(
+        Code.ErrNotAttached,
+        `${doc.getKey()} is not attached`
+      );
+    }
+    const task = async () => {
+      try {
+        await this.rpcClient.restoreRevision(
+          {
+            clientId: this.id,
+            revisionId
+          },
+          { headers: { "x-shard-key": `${this.apiKey}/${doc.getKey()}` } }
+        );
+        logger.info(
+          `[RR] c:"${this.getKey()}" restores revision d:"${doc.getKey()}" r:"${revisionId}"`
+        );
+      } catch (err) {
+        logger.error(`[RR] c:"${this.getKey()}" err :`, err);
+        await this.handleConnectError(err);
+        throw err;
+      }
+    };
+    return this.enqueueTask(task);
+  }
   /**
    * `broadcast` broadcasts the given payload to the given topic.
    */