@mdbase-dev/connect-protocol 0.1.0-beta.100

package/schemas/sync.v1.schema.json

@@ -0,0 +1,483 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mdbase.dev/connect/schemas/sync.v1.json",
+  "title": "mdbase connect replication protocol 1",
+  "oneOf": [
+    { "$ref": "#/$defs/session" },
+    { "$ref": "#/$defs/snapshotPage" },
+    { "$ref": "#/$defs/fileSnapshotPage" },
+    { "$ref": "#/$defs/changesPage" },
+    { "$ref": "#/$defs/mutation" },
+    { "$ref": "#/$defs/receipt" }
+  ],
+  "$defs": {
+    "uuid": { "type": "string", "format": "uuid" },
+    "semanticVersion": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
+    },
+    "digest": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$"
+    },
+    "fileDescriptor": {
+      "$ref": "https://mdbase.dev/connect/schemas/files.v1.json#/$defs/fileDescriptor"
+    },
+    "collectionType": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "schema", "extensions"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "version": { "type": "integer", "minimum": 1 },
+        "description": { "type": "string" },
+        "schema": { "type": "object" },
+        "collection": { "type": "object" },
+        "lifecycle": { "type": "object" },
+        "extensions": { "type": "object" }
+      }
+    },
+    "contract": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contract_type", "id", "version", "digest", "schema", "implementations"],
+      "properties": {
+        "contract_type": { "const": "record" },
+        "id": { "type": "string", "minLength": 1 },
+        "version": { "$ref": "#/$defs/semanticVersion" },
+        "digest": { "$ref": "#/$defs/digest" },
+        "schema": { "type": "object" },
+        "binding_schema": { "type": "object" },
+        "implementations": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/contractImplementation" }
+        }
+      }
+    },
+    "contractImplementation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type_name", "type_version", "digest", "fields"],
+      "properties": {
+        "type_name": { "type": "string", "minLength": 1 },
+        "type_version": { "type": "integer", "minimum": 1 },
+        "type_path": { "type": "string", "minLength": 1 },
+        "digest": { "$ref": "#/$defs/digest" },
+        "fields": {
+          "type": "object",
+          "additionalProperties": { "type": "string", "minLength": 1 }
+        },
+        "binding": { "type": "object" }
+      }
+    },
+    "resources": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["revision", "spec_version", "types", "contracts"],
+      "properties": {
+        "revision": { "type": "string", "minLength": 1 },
+        "spec_version": { "type": "string", "minLength": 1 },
+        "types": { "type": "array", "items": { "$ref": "#/$defs/collectionType" } },
+        "contracts": { "type": "array", "items": { "$ref": "#/$defs/contract" } },
+        "documents": { "type": "array", "items": { "$ref": "#/$defs/resourceDocument" } }
+      }
+    },
+    "resourceDocument": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "kind", "revision", "document"],
+      "properties": {
+        "path": { "type": "string", "minLength": 1 },
+        "kind": { "enum": ["configuration", "lock", "type", "contract", "schema", "view"] },
+        "revision": { "$ref": "#/$defs/digest" },
+        "document": { "type": "string" }
+      }
+    },
+    "record": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["record_id", "path", "document", "revision", "frontmatter", "body", "types"],
+      "properties": {
+        "record_id": { "$ref": "#/$defs/uuid" },
+        "path": { "type": "string", "minLength": 1 },
+        "document": { "type": "string" },
+        "revision": { "$ref": "#/$defs/digest" },
+        "frontmatter": { "type": "object" },
+        "body": { "type": "string" },
+        "types": { "type": "array", "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }
+      }
+    },
+    "snapshotRecord": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["record_id", "path", "document", "revision", "frontmatter", "body", "types"],
+      "properties": {
+        "record_id": { "$ref": "#/$defs/uuid" },
+        "path": { "type": "string", "minLength": 1 },
+        "revision": { "$ref": "#/$defs/digest" },
+        "frontmatter": { "type": "object" },
+        "body": { "type": "string" },
+        "types": { "type": "array", "uniqueItems": true, "items": { "type": "string", "minLength": 1 } },
+        "document": { "type": "string" }
+      }
+    },
+    "session": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["protocol_version", "protocol_profile", "session_id", "replica_id", "collection_id", "mode", "scope_epoch", "retained_after", "head", "snapshot_id", "resources"],
+      "properties": {
+        "protocol_version": { "const": 1 },
+        "protocol_profile": { "const": "exact_document_v1" },
+        "session_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "collection_id": { "$ref": "#/$defs/uuid" },
+        "mode": { "enum": ["read_only", "read_write"] },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "retained_after": { "type": "integer", "minimum": 0 },
+        "head": { "type": "integer", "minimum": 0 },
+        "snapshot_id": { "$ref": "#/$defs/uuid" },
+        "resources": { "$ref": "#/$defs/resources" }
+      }
+    },
+    "snapshotPage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["protocol_version", "snapshot_id", "scope_epoch", "cursor", "records"],
+      "properties": {
+        "protocol_version": { "const": 1 },
+        "snapshot_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "cursor": { "type": "integer", "minimum": 0 },
+        "records": { "type": "array", "items": { "$ref": "#/$defs/snapshotRecord" } },
+        "next_page": { "type": "string", "pattern": "^[1-9][0-9]*$" }
+      }
+    },
+    "fileSnapshotPage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["protocol_version", "type", "snapshot_id", "scope_epoch", "cursor", "files"],
+      "properties": {
+        "protocol_version": { "const": 1 },
+        "type": { "const": "file_snapshot_page" },
+        "snapshot_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "cursor": { "type": "integer", "minimum": 0 },
+        "files": { "type": "array", "items": { "$ref": "#/$defs/fileDescriptor" } },
+        "next_page": { "type": "string", "pattern": "^[1-9][0-9]*$" }
+      }
+    },
+    "put": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["sequence", "type", "record"],
+      "properties": {
+        "sequence": { "type": "integer", "minimum": 1 },
+        "type": { "const": "put" },
+        "record": { "$ref": "#/$defs/record" }
+      }
+    },
+    "remove": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["sequence", "type", "record_id", "previous_path", "revision"],
+      "properties": {
+        "sequence": { "type": "integer", "minimum": 1 },
+        "type": { "const": "remove" },
+        "record_id": { "$ref": "#/$defs/uuid" },
+        "previous_path": { "type": "string", "minLength": 1 },
+        "revision": { "type": "string", "minLength": 1 }
+      }
+    },
+    "filePut": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["sequence", "type", "file"],
+      "properties": {
+        "sequence": { "type": "integer", "minimum": 1 },
+        "type": { "const": "file_put" },
+        "file": { "$ref": "#/$defs/fileDescriptor" }
+      }
+    },
+    "fileRemove": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["sequence", "type", "file_id", "previous_path", "revision"],
+      "properties": {
+        "sequence": { "type": "integer", "minimum": 1 },
+        "type": { "const": "file_remove" },
+        "file_id": { "$ref": "#/$defs/uuid" },
+        "previous_path": { "type": "string", "minLength": 1 },
+        "revision": { "type": "string", "minLength": 1 }
+      }
+    },
+    "changesPage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["protocol_version", "scope_epoch", "events", "cursor", "head", "has_more", "reset_required"],
+      "properties": {
+        "protocol_version": { "const": 1 },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "events": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "$ref": "#/$defs/put" },
+              { "$ref": "#/$defs/remove" },
+              { "$ref": "#/$defs/filePut" },
+              { "$ref": "#/$defs/fileRemove" }
+            ]
+          }
+        },
+        "cursor": { "type": "integer", "minimum": 0 },
+        "head": { "type": "integer", "minimum": 0 },
+        "has_more": { "type": "boolean" },
+        "reset_required": { "type": "boolean" }
+      }
+    },
+    "recordPutMutation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mutation_id", "replica_id", "scope_epoch", "operation", "record_id", "path", "document", "created_at"],
+      "properties": {
+        "mutation_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "operation": { "const": "put" },
+        "record_id": { "$ref": "#/$defs/uuid" },
+        "base_revision": { "type": "string", "minLength": 1 },
+        "path": { "type": "string", "minLength": 1 },
+        "document": { "type": "string" },
+        "created_at": { "type": "string", "format": "date-time" },
+        "causal_predecessor": { "$ref": "#/$defs/uuid" }
+      }
+    },
+    "recordDeleteMutation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mutation_id", "replica_id", "scope_epoch", "operation", "record_id", "base_revision", "created_at"],
+      "properties": {
+        "mutation_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "operation": { "const": "delete" },
+        "record_id": { "$ref": "#/$defs/uuid" },
+        "base_revision": { "type": "string", "minLength": 1 },
+        "created_at": { "type": "string", "format": "date-time" },
+        "causal_predecessor": { "$ref": "#/$defs/uuid" }
+      }
+    },
+    "recordMoveMutation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mutation_id", "replica_id", "scope_epoch", "operation", "record_id", "base_revision", "path", "created_at"],
+      "properties": {
+        "mutation_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "operation": { "const": "move" },
+        "record_id": { "$ref": "#/$defs/uuid" },
+        "base_revision": { "type": "string", "minLength": 1 },
+        "path": { "type": "string", "minLength": 1 },
+        "created_at": { "type": "string", "format": "date-time" },
+        "causal_predecessor": { "$ref": "#/$defs/uuid" }
+      }
+    },
+    "filePutMutation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mutation_id", "replica_id", "scope_epoch", "operation", "file_id",
+        "path", "transfer_id", "content_digest", "size", "created_at"
+      ],
+      "properties": {
+        "mutation_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "operation": { "const": "file_put" },
+        "file_id": { "$ref": "#/$defs/uuid" },
+        "base_revision": { "type": "string", "minLength": 1 },
+        "path": { "type": "string", "minLength": 1 },
+        "transfer_id": { "$ref": "#/$defs/uuid" },
+        "content_digest": { "$ref": "#/$defs/digest" },
+        "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 },
+        "media_type": { "type": "string", "minLength": 1, "maxLength": 255 },
+        "created_at": { "type": "string", "format": "date-time" },
+        "causal_predecessor": { "$ref": "#/$defs/uuid" }
+      }
+    },
+    "fileMoveMutation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mutation_id", "replica_id", "scope_epoch", "operation", "file_id",
+        "base_revision", "path", "update_references", "created_at"
+      ],
+      "properties": {
+        "mutation_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "operation": { "const": "file_move" },
+        "file_id": { "$ref": "#/$defs/uuid" },
+        "base_revision": { "type": "string", "minLength": 1 },
+        "path": { "type": "string", "minLength": 1 },
+        "update_references": { "type": "boolean" },
+        "created_at": { "type": "string", "format": "date-time" },
+        "causal_predecessor": { "$ref": "#/$defs/uuid" }
+      }
+    },
+    "fileDeleteMutation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mutation_id", "replica_id", "scope_epoch", "operation", "file_id",
+        "base_revision", "created_at"
+      ],
+      "properties": {
+        "mutation_id": { "$ref": "#/$defs/uuid" },
+        "replica_id": { "$ref": "#/$defs/uuid" },
+        "scope_epoch": { "type": "integer", "minimum": 1 },
+        "operation": { "const": "file_delete" },
+        "file_id": { "$ref": "#/$defs/uuid" },
+        "base_revision": { "type": "string", "minLength": 1 },
+        "created_at": { "type": "string", "format": "date-time" },
+        "causal_predecessor": { "$ref": "#/$defs/uuid" }
+      }
+    },
+    "mutation": {
+      "oneOf": [
+        { "$ref": "#/$defs/recordPutMutation" },
+        { "$ref": "#/$defs/recordMoveMutation" },
+        { "$ref": "#/$defs/recordDeleteMutation" },
+        { "$ref": "#/$defs/filePutMutation" },
+        { "$ref": "#/$defs/fileMoveMutation" },
+        { "$ref": "#/$defs/fileDeleteMutation" }
+      ]
+    },
+    "recordReceipt": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mutation_id", "status", "sequence"],
+          "properties": {
+            "mutation_id": { "$ref": "#/$defs/uuid" },
+            "status": { "enum": ["applied", "previously_applied"] },
+            "sequence": { "type": "integer", "minimum": 1 },
+            "record": { "$ref": "#/$defs/record" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mutation_id", "status", "conflict"],
+          "properties": {
+            "mutation_id": { "$ref": "#/$defs/uuid" },
+            "status": { "const": "conflicted" },
+            "conflict": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["record_id", "mutation"],
+              "properties": {
+                "record_id": { "$ref": "#/$defs/uuid" },
+                "mutation": {
+                  "oneOf": [
+                    { "$ref": "#/$defs/recordPutMutation" },
+                    { "$ref": "#/$defs/recordMoveMutation" },
+                    { "$ref": "#/$defs/recordDeleteMutation" }
+                  ]
+                },
+                "current": { "$ref": "#/$defs/record" },
+                "current_revision": { "type": "string" }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mutation_id", "status", "error"],
+          "properties": {
+            "mutation_id": { "$ref": "#/$defs/uuid" },
+            "status": { "const": "rejected" },
+            "error": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["code", "message"],
+              "properties": {
+                "code": { "type": "string", "minLength": 1 },
+                "message": { "type": "string" }
+              }
+            }
+          }
+        }
+      ]
+    },
+    "fileConflict": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["file_id", "mutation"],
+      "properties": {
+        "file_id": { "$ref": "#/$defs/uuid" },
+        "mutation": {
+          "oneOf": [
+            { "$ref": "#/$defs/filePutMutation" },
+            { "$ref": "#/$defs/fileMoveMutation" },
+            { "$ref": "#/$defs/fileDeleteMutation" }
+          ]
+        },
+        "current": { "$ref": "#/$defs/fileDescriptor" },
+        "current_revision": { "type": "string", "minLength": 1 }
+      }
+    },
+    "fileReceipt": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mutation_id", "status", "sequence"],
+          "properties": {
+            "mutation_id": { "$ref": "#/$defs/uuid" },
+            "status": { "enum": ["file_applied", "file_previously_applied"] },
+            "sequence": { "type": "integer", "minimum": 1 },
+            "file": { "$ref": "#/$defs/fileDescriptor" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mutation_id", "status", "conflict"],
+          "properties": {
+            "mutation_id": { "$ref": "#/$defs/uuid" },
+            "status": { "const": "file_conflicted" },
+            "conflict": { "$ref": "#/$defs/fileConflict" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mutation_id", "status", "error"],
+          "properties": {
+            "mutation_id": { "$ref": "#/$defs/uuid" },
+            "status": { "const": "file_rejected" },
+            "error": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["code", "message"],
+              "properties": {
+                "code": { "type": "string", "minLength": 1 },
+                "message": { "type": "string" }
+              }
+            }
+          }
+        }
+      ]
+    },
+    "receipt": {
+      "oneOf": [
+        { "$ref": "#/$defs/recordReceipt" },
+        { "$ref": "#/$defs/fileReceipt" }
+      ]
+    }
+  }
+}