@yorkie-js/react 0.6.15 → 0.6.18

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.15";
+const version$1 = "0.6.18";
 const pkg$1 = {
   name: name$1,
   version: version$1
@@ -6020,11 +6020,15 @@ const _User = class _User extends Message {
      */
     __publicField(this, "id", "");
     /**
-     * @generated from field: string username = 2;
+     * @generated from field: string auth_provider = 2;
+     */
+    __publicField(this, "authProvider", "");
+    /**
+     * @generated from field: string username = 3;
      */
     __publicField(this, "username", "");
     /**
-     * @generated from field: google.protobuf.Timestamp created_at = 3;
+     * @generated from field: google.protobuf.Timestamp created_at = 4;
      */
     __publicField(this, "createdAt");
     proto3.util.initPartial(data, this);
@@ -6054,12 +6058,19 @@ __publicField(_User, "fields", proto3.util.newFieldList(() => [
   },
   {
     no: 2,
+    name: "auth_provider",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 3,
     name: "username",
     kind: "scalar",
     T: 9
     /* ScalarType.STRING */
   },
-  { no: 3, name: "created_at", kind: "message", T: Timestamp }
+  { no: 4, name: "created_at", kind: "message", T: Timestamp }
 ]));
 let User = _User;
 const _Project = class _Project extends Message {
@@ -6220,6 +6231,51 @@ __publicField(_Project, "fields", proto3.util.newFieldList(() => [
   { no: 13, name: "updated_at", kind: "message", T: Timestamp }
 ]));
 let Project = _Project;
+const _MetricPoint = class _MetricPoint extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: int64 timestamp = 1;
+     */
+    __publicField(this, "timestamp", protoInt64.zero);
+    /**
+     * @generated from field: int32 value = 2;
+     */
+    __publicField(this, "value", 0);
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _MetricPoint().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _MetricPoint().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _MetricPoint().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_MetricPoint, a, b);
+  }
+};
+__publicField(_MetricPoint, "runtime", proto3);
+__publicField(_MetricPoint, "typeName", "yorkie.v1.MetricPoint");
+__publicField(_MetricPoint, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "timestamp",
+    kind: "scalar",
+    T: 3
+    /* ScalarType.INT64 */
+  },
+  {
+    no: 2,
+    name: "value",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  }
+]));
+let MetricPoint = _MetricPoint;
 const _UpdatableProjectFields = class _UpdatableProjectFields extends Message {
   constructor(data) {
     super();
@@ -6392,6 +6448,18 @@ const _DocumentSummary = class _DocumentSummary extends Message {
      * @generated from field: string snapshot = 3;
      */
     __publicField(this, "snapshot", "");
+    /**
+     * @generated from field: int32 attached_clients = 7;
+     */
+    __publicField(this, "attachedClients", 0);
+    /**
+     * @generated from field: yorkie.v1.DocSize document_size = 8;
+     */
+    __publicField(this, "documentSize");
+    /**
+     * @generated from field: string schema_key = 9;
+     */
+    __publicField(this, "schemaKey", "");
     /**
      * @generated from field: google.protobuf.Timestamp created_at = 4;
      */
@@ -6443,6 +6511,21 @@ __publicField(_DocumentSummary, "fields", proto3.util.newFieldList(() => [
     T: 9
     /* ScalarType.STRING */
   },
+  {
+    no: 7,
+    name: "attached_clients",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  },
+  { no: 8, name: "document_size", kind: "message", T: DocSize },
+  {
+    no: 9,
+    name: "schema_key",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
   { no: 4, name: "created_at", kind: "message", T: Timestamp },
   { no: 5, name: "accessed_at", kind: "message", T: Timestamp },
   { no: 6, name: "updated_at", kind: "message", T: Timestamp }
@@ -6754,6 +6837,206 @@ __publicField(_DocEvent, "fields", proto3.util.newFieldList(() => [
   { no: 3, name: "body", kind: "message", T: DocEventBody }
 ]));
 let DocEvent = _DocEvent;
+const _DataSize = class _DataSize extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: int32 data = 1;
+     */
+    __publicField(this, "data", 0);
+    /**
+     * @generated from field: int32 meta = 2;
+     */
+    __publicField(this, "meta", 0);
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _DataSize().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _DataSize().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _DataSize().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_DataSize, a, b);
+  }
+};
+__publicField(_DataSize, "runtime", proto3);
+__publicField(_DataSize, "typeName", "yorkie.v1.DataSize");
+__publicField(_DataSize, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "data",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  },
+  {
+    no: 2,
+    name: "meta",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  }
+]));
+let DataSize = _DataSize;
+const _DocSize = class _DocSize extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: yorkie.v1.DataSize live = 1;
+     */
+    __publicField(this, "live");
+    /**
+     * @generated from field: yorkie.v1.DataSize gc = 2;
+     */
+    __publicField(this, "gc");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _DocSize().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _DocSize().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _DocSize().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_DocSize, a, b);
+  }
+};
+__publicField(_DocSize, "runtime", proto3);
+__publicField(_DocSize, "typeName", "yorkie.v1.DocSize");
+__publicField(_DocSize, "fields", proto3.util.newFieldList(() => [
+  { no: 1, name: "live", kind: "message", T: DataSize },
+  { no: 2, name: "gc", kind: "message", T: DataSize }
+]));
+let DocSize = _DocSize;
+const _Schema = class _Schema extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string id = 1;
+     */
+    __publicField(this, "id", "");
+    /**
+     * @generated from field: string name = 2;
+     */
+    __publicField(this, "name", "");
+    /**
+     * @generated from field: int32 version = 3;
+     */
+    __publicField(this, "version", 0);
+    /**
+     * @generated from field: string body = 4;
+     */
+    __publicField(this, "body", "");
+    /**
+     * @generated from field: repeated yorkie.v1.Rule rules = 5;
+     */
+    __publicField(this, "rules", []);
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 6;
+     */
+    __publicField(this, "createdAt");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _Schema().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _Schema().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _Schema().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_Schema, a, b);
+  }
+};
+__publicField(_Schema, "runtime", proto3);
+__publicField(_Schema, "typeName", "yorkie.v1.Schema");
+__publicField(_Schema, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "id",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "name",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 3,
+    name: "version",
+    kind: "scalar",
+    T: 5
+    /* ScalarType.INT32 */
+  },
+  {
+    no: 4,
+    name: "body",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  { no: 5, name: "rules", kind: "message", T: Rule, repeated: true },
+  { no: 6, name: "created_at", kind: "message", T: Timestamp }
+]));
+let Schema = _Schema;
+const _Rule = class _Rule extends Message {
+  constructor(data) {
+    super();
+    /**
+     * @generated from field: string path = 1;
+     */
+    __publicField(this, "path", "");
+    /**
+     * @generated from field: string type = 2;
+     */
+    __publicField(this, "type", "");
+    proto3.util.initPartial(data, this);
+  }
+  static fromBinary(bytes, options) {
+    return new _Rule().fromBinary(bytes, options);
+  }
+  static fromJson(jsonValue, options) {
+    return new _Rule().fromJson(jsonValue, options);
+  }
+  static fromJsonString(jsonString, options) {
+    return new _Rule().fromJsonString(jsonString, options);
+  }
+  static equals(a, b) {
+    return proto3.util.equals(_Rule, a, b);
+  }
+};
+__publicField(_Rule, "runtime", proto3);
+__publicField(_Rule, "typeName", "yorkie.v1.Rule");
+__publicField(_Rule, "fields", proto3.util.newFieldList(() => [
+  {
+    no: 1,
+    name: "path",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "type",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  }
+]));
+let Rule = _Rule;
 const _ActivateClientRequest = class _ActivateClientRequest extends Message {
   constructor(data) {
     super();
@@ -6898,6 +7181,10 @@ const _AttachDocumentRequest = class _AttachDocumentRequest extends Message {
      * @generated from field: yorkie.v1.ChangePack change_pack = 2;
      */
     __publicField(this, "changePack");
+    /**
+     * @generated from field: string schema_key = 3;
+     */
+    __publicField(this, "schemaKey", "");
     proto3.util.initPartial(data, this);
   }
   static fromBinary(bytes, options) {
@@ -6923,7 +7210,14 @@ __publicField(_AttachDocumentRequest, "fields", proto3.util.newFieldList(() => [
     T: 9
     /* ScalarType.STRING */
   },
-  { no: 2, name: "change_pack", kind: "message", T: ChangePack$1 }
+  { no: 2, name: "change_pack", kind: "message", T: ChangePack$1 },
+  {
+    no: 3,
+    name: "schema_key",
+    kind: "scalar",
+    T: 9
+    /* ScalarType.STRING */
+  }
 ]));
 let AttachDocumentRequest = _AttachDocumentRequest;
 const _AttachDocumentResponse = class _AttachDocumentResponse extends Message {
@@ -6933,14 +7227,18 @@ const _AttachDocumentResponse = class _AttachDocumentResponse extends Message {
      * @generated from field: string document_id = 1;
      */
     __publicField(this, "documentId", "");
+    /**
+     * @generated from field: yorkie.v1.ChangePack change_pack = 2;
+     */
+    __publicField(this, "changePack");
     /**
      * @generated from field: int32 max_size_per_document = 3;
      */
     __publicField(this, "maxSizePerDocument", 0);
     /**
-     * @generated from field: yorkie.v1.ChangePack change_pack = 2;
+     * @generated from field: repeated yorkie.v1.Rule schema_rules = 4;
      */
-    __publicField(this, "changePack");
+    __publicField(this, "schemaRules", []);
     proto3.util.initPartial(data, this);
   }
   static fromBinary(bytes, options) {
@@ -6966,6 +7264,7 @@ __publicField(_AttachDocumentResponse, "fields", proto3.util.newFieldList(() =>
     T: 9
     /* ScalarType.STRING */
   },
+  { no: 2, name: "change_pack", kind: "message", T: ChangePack$1 },
   {
     no: 3,
     name: "max_size_per_document",
@@ -6973,7 +7272,7 @@ __publicField(_AttachDocumentResponse, "fields", proto3.util.newFieldList(() =>
     T: 5
     /* ScalarType.INT32 */
   },
-  { no: 2, name: "change_pack", kind: "message", T: ChangePack$1 }
+  { no: 4, name: "schema_rules", kind: "message", T: Rule, repeated: true }
 ]));
 let AttachDocumentResponse = _AttachDocumentResponse;
 const _DetachDocumentRequest = class _DetachDocumentRequest extends Message {
@@ -7744,6 +8043,7 @@ var Code = /* @__PURE__ */ ((Code2) => {
   Code2["ErrDocumentNotDetached"] = "ErrDocumentNotDetached";
   Code2["ErrDocumentRemoved"] = "ErrDocumentRemoved";
   Code2["ErrDocumentSizeExceedsLimit"] = "ErrDocumentSizeExceedsLimit";
+  Code2["ErrDocumentSchemaValidationFailed"] = "ErrDocumentSchemaValidationFailed";
   Code2["ErrInvalidObjectKey"] = "ErrInvalidObjectKey";
   Code2["ErrInvalidArgument"] = "ErrInvalidArgument";
   Code2["ErrNotInitialized"] = "ErrNotInitialized";
@@ -16797,6 +17097,14 @@ function fromElement(pbElement) {
     throw new YorkieError(Code.ErrUnimplemented, `unimplemented element`);
   }
 }
+function fromSchemaRules(pbRules) {
+  return pbRules.map((pbRule) => {
+    return {
+      path: pbRule.path,
+      type: pbRule.type
+    };
+  });
+}
 function bytesToSnapshot(bytes) {
   if (!bytes) {
     return {
@@ -16894,7 +17202,8 @@ const converter = {
   bytesToChangeID,
   bytesToOperation,
   versionVectorToHex,
-  hexToVersionVector
+  hexToVersionVector,
+  fromSchemaRules
 };
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
   LogLevel2[LogLevel2["Trivial"] = 0] = "Trivial";
@@ -17054,6 +17363,156 @@ class Attachment {
     this.watchLoopTimerID = void 0;
   }
 }
+function validateYorkieRuleset(data, ruleset) {
+  const errors = [];
+  for (const rule of ruleset) {
+    const value = getValueByPath(data, rule.path);
+    const result = validateValue(value, rule);
+    if (!result.valid) {
+      for (const error of result.errors || []) {
+        errors.push(error);
+      }
+    }
+  }
+  return {
+    valid: errors.length === 0,
+    errors
+  };
+}
+function getValueByPath(obj, path) {
+  if (!path.startsWith("$")) {
+    throw new Error(`Path must start with $, got ${path}`);
+  }
+  const keys = path.split(".");
+  let current = obj;
+  for (let i = 1; i < keys.length; i++) {
+    const key = keys[i];
+    if (!(current instanceof CRDTObject)) {
+      return void 0;
+    }
+    current = current.get(key);
+  }
+  return current;
+}
+function validateValue(value, rule) {
+  switch (rule.type) {
+    case "string":
+    case "boolean":
+    case "integer":
+    case "double":
+    case "long":
+    case "date":
+    case "bytes":
+    case "null":
+      return validatePrimitiveValue(value, rule);
+    case "object":
+      if (!(value instanceof CRDTObject)) {
+        return {
+          valid: false,
+          errors: [
+            {
+              path: rule.path,
+              message: `Expected object at path ${rule.path}`
+            }
+          ]
+        };
+      }
+      break;
+    case "array":
+      if (!(value instanceof CRDTArray)) {
+        return {
+          valid: false,
+          errors: [
+            {
+              path: rule.path,
+              message: `Expected array at path ${rule.path}`
+            }
+          ]
+        };
+      }
+      break;
+    case "yorkie.Text":
+      if (!(value instanceof CRDTText)) {
+        return {
+          valid: false,
+          errors: [
+            {
+              path: rule.path,
+              message: `Expected yorkie.Text at path ${rule.path}`
+            }
+          ]
+        };
+      }
+      break;
+    case "yorkie.Tree":
+      if (!(value instanceof CRDTTree)) {
+        return {
+          valid: false,
+          errors: [
+            {
+              path: rule.path,
+              message: `Expected yorkie.Tree at path ${rule.path}`
+            }
+          ]
+        };
+      }
+      break;
+    case "yorkie.Counter":
+      if (!(value instanceof CRDTCounter)) {
+        return {
+          valid: false,
+          errors: [
+            {
+              path: rule.path,
+              message: `Expected yorkie.Counter at path ${rule.path}`
+            }
+          ]
+        };
+      }
+      break;
+    default:
+      throw new Error(`Unknown rule type: ${rule.type}`);
+  }
+  return {
+    valid: true
+  };
+}
+function getPrimitiveType(type) {
+  switch (type) {
+    case "null":
+      return PrimitiveType.Null;
+    case "boolean":
+      return PrimitiveType.Boolean;
+    case "integer":
+      return PrimitiveType.Integer;
+    case "long":
+      return PrimitiveType.Long;
+    case "double":
+      return PrimitiveType.Double;
+    case "string":
+      return PrimitiveType.String;
+    case "bytes":
+      return PrimitiveType.Bytes;
+    case "date":
+      return PrimitiveType.Date;
+    default:
+      throw new Error(`Unknown primitive type: ${type}`);
+  }
+}
+function validatePrimitiveValue(value, rule) {
+  if (value instanceof Primitive && value.getType() === getPrimitiveType(rule.type)) {
+    return { valid: true };
+  }
+  return {
+    valid: false,
+    errors: [
+      {
+        path: rule.path,
+        message: `Expected ${rule.type} at path ${rule.path}`
+      }
+    ]
+  };
+}
 const Noop = () => {
 };
 class ObserverProxy {
@@ -19514,6 +19973,7 @@ class Document {
     __publicField(this, "checkpoint");
     __publicField(this, "localChanges");
     __publicField(this, "maxSizeLimit");
+    __publicField(this, "schemaRules");
     __publicField(this, "root");
     __publicField(this, "clone");
     __publicField(this, "eventStream");
@@ -19547,6 +20007,7 @@ class Document {
     this.checkpoint = InitialCheckpoint;
     this.localChanges = [];
     this.maxSizeLimit = 0;
+    this.schemaRules = [];
     this.eventStream = createObservable((observer) => {
       this.eventStreamObserver = observer;
     });
@@ -19566,7 +20027,7 @@ class Document {
    * `update` executes the given updater to update this document.
    */
   update(updater, message) {
-    var _a2;
+    var _a2, _b2, _c2;
     if (this.getStatus() === "removed") {
       throw new YorkieError(Code.ErrDocumentRemoved, `${this.key} is removed`);
     }
@@ -19597,7 +20058,21 @@ class Document {
     } finally {
       this.isUpdating = false;
     }
-    const size = totalDocSize((_a2 = this.clone) == null ? void 0 : _a2.root.getDocSize());
+    const schemaRules = this.getSchemaRules();
+    if (!context.isPresenceOnlyChange() && schemaRules.length > 0) {
+      const result = validateYorkieRuleset(
+        (_a2 = this.clone) == null ? void 0 : _a2.root.getObject(),
+        schemaRules
+      );
+      if (!result.valid) {
+        this.clone = void 0;
+        throw new YorkieError(
+          Code.ErrDocumentSchemaValidationFailed,
+          `schema validation failed: ${(_b2 = result.errors) == null ? void 0 : _b2.map((error) => error.message).join(", ")}`
+        );
+      }
+    }
+    const size = totalDocSize((_c2 = this.clone) == null ? void 0 : _c2.root.getDocSize());
     if (!context.isPresenceOnlyChange() && this.maxSizeLimit > 0 && this.maxSizeLimit < size) {
       this.clone = void 0;
       throw new YorkieError(
@@ -20045,6 +20520,18 @@ class Document {
   setMaxSizePerDocument(size) {
     this.maxSizeLimit = size;
   }
+  /**
+   * `getSchemaRules` gets the schema rules of this document.
+   */
+  getSchemaRules() {
+    return this.schemaRules;
+  }
+  /**
+   * `setSchemaRules` sets the schema rules of this document.
+   */
+  setSchemaRules(rules) {
+    this.schemaRules = rules;
+  }
   /**
    * `garbageCollect` purges elements that were removed before the given time.
    *
@@ -20746,7 +21233,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name = "@yorkie-js/sdk";
-const version = "0.6.15";
+const version = "0.6.18";
 const pkg = {
   name,
   version
@@ -20972,7 +21459,8 @@ class Client {
         const res = await this.rpcClient.attachDocument(
           {
             clientId: this.id,
-            changePack: converter.toChangePack(doc.createChangePack())
+            changePack: converter.toChangePack(doc.createChangePack()),
+            schemaKey: opts.schema
           },
           { headers: { "x-shard-key": `${this.apiKey}/${doc.getKey()}` } }
         );
@@ -20980,6 +21468,9 @@ class Client {
         if (maxSize > 0) {
           doc.setMaxSizePerDocument(res.maxSizePerDocument);
         }
+        if (res.schemaRules.length > 0) {
+          doc.setSchemaRules(converter.fromSchemaRules(res.schemaRules));
+        }
         const pack = converter.fromChangePack(res.changePack);
         doc.applyChangePack(pack);
         if (doc.getStatus() === DocStatus.Removed) {