@mdbase-dev/connect-protocol 0.1.0-beta.38 → 0.1.0-beta.40

package/dist/index.d.ts

@@ -279,9 +279,14 @@ export type EncryptedRelayOperation = CollectionOperation | "file_control";
 export interface SyncRecord<Frontmatter extends JsonObject = JsonObject> {
     record_id: string;
     path: string;
+    /** Exact authoritative Markdown bytes. `revision` is the SHA-256 digest of this value. */
+    document: string;
     revision: string;
+    /** Derived query projection. It never participates in mirror materialization. */
     frontmatter: Frontmatter;
+    /** Derived query projection. It never participates in mirror materialization. */
     body: string;
+    /** Derived authority projection used for scope checks. */
     types: string[];
 }
 export interface SyncCollectionResources {
@@ -298,10 +303,7 @@ export interface SyncResourceDocument {
     revision: string;
     document: string;
 }
-export interface AuthoritySnapshotRecord<Frontmatter extends JsonObject = JsonObject> {
-    record: SyncRecord<Frontmatter>;
-    document: string;
-}
+export type AuthoritySnapshotRecord<Frontmatter extends JsonObject = JsonObject> = SyncRecord<Frontmatter>;
 export interface AuthoritySnapshot<Frontmatter extends JsonObject = JsonObject> {
     protocol_version: 1;
     collection_id: string;
@@ -345,6 +347,8 @@ export interface AuthorityImportRecordPage {
 }
 export interface SyncSession {
     protocol_version: 1;
+    /** Exact-document prerelease v1. Missing or different profiles are incompatible. */
+    protocol_profile: "exact_document_v1";
     session_id: string;
     replica_id: string;
     collection_id: string;
@@ -363,10 +367,7 @@ export interface SyncSnapshotPage<Frontmatter extends JsonObject = JsonObject> {
     records: Array<SyncSnapshotRecord<Frontmatter>>;
     next_page?: string;
 }
-export interface SyncSnapshotRecord<Frontmatter extends JsonObject = JsonObject> extends SyncRecord<Frontmatter> {
-    /** Exact bytes whose SHA-256 revision and parsed metadata match this record. */
-    document: string;
-}
+export type SyncSnapshotRecord<Frontmatter extends JsonObject = JsonObject> = SyncRecord<Frontmatter>;
 /** Manifest-only snapshot page. File bytes are fetched by digest via the file data plane. */
 export interface SyncFileSnapshotPage {
     protocol_version: 1;
@@ -407,17 +408,28 @@ export interface SyncChangesPage<Frontmatter extends JsonObject = JsonObject> {
     has_more: boolean;
     reset_required: boolean;
 }
-export interface SyncMutation {
+interface SyncMutationBase {
     mutation_id: string;
     replica_id: string;
     scope_epoch: number;
-    operation: "create" | "update" | "rename" | "delete";
     record_id: string;
-    base_revision?: string;
-    input: JsonObject;
     created_at: string;
     causal_predecessor?: string;
 }
+export type SyncMutation = (SyncMutationBase & {
+    operation: "put";
+    /** Omitted only when creating this stable identity. */
+    base_revision?: string;
+    path: string;
+    document: string;
+}) | (SyncMutationBase & {
+    operation: "move";
+    base_revision: string;
+    path: string;
+}) | (SyncMutationBase & {
+    operation: "delete";
+    base_revision: string;
+});
 interface SyncFileMutationBase {
     mutation_id: string;
     replica_id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/connect-protocol",
-  "version": "0.1.0-beta.38",
+  "version": "0.1.0-beta.40",
   "private": false,
   "type": "module",
   "license": "MIT",

package/schemas/sync.v1.schema.json

@@ -97,11 +97,12 @@
     "record": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["record_id", "path", "revision", "frontmatter", "body", "types"],
+      "required": ["record_id", "path", "document", "revision", "frontmatter", "body", "types"],
       "properties": {
         "record_id": { "$ref": "#/$defs/uuid" },
         "path": { "type": "string", "minLength": 1 },
-        "revision": { "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 } }
@@ -110,7 +111,7 @@
     "snapshotRecord": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["record_id", "path", "revision", "frontmatter", "body", "types", "document"],
+      "required": ["record_id", "path", "document", "revision", "frontmatter", "body", "types"],
       "properties": {
         "record_id": { "$ref": "#/$defs/uuid" },
         "path": { "type": "string", "minLength": 1 },
@@ -124,9 +125,10 @@
     "session": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["protocol_version", "session_id", "replica_id", "collection_id", "mode", "scope_epoch", "retained_after", "head", "snapshot_id", "resources"],
+      "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" },
@@ -233,18 +235,50 @@
         "reset_required": { "type": "boolean" }
       }
     },
-    "recordMutation": {
+    "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", "input", "created_at"],
+      "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": { "enum": ["create", "update", "rename", "delete"] },
+        "operation": { "const": "move" },
         "record_id": { "$ref": "#/$defs/uuid" },
         "base_revision": { "type": "string", "minLength": 1 },
-        "input": { "type": "object" },
+        "path": { "type": "string", "minLength": 1 },
         "created_at": { "type": "string", "format": "date-time" },
         "causal_predecessor": { "$ref": "#/$defs/uuid" }
       }
@@ -312,7 +346,9 @@
     },
     "mutation": {
       "oneOf": [
-        { "$ref": "#/$defs/recordMutation" },
+        { "$ref": "#/$defs/recordPutMutation" },
+        { "$ref": "#/$defs/recordMoveMutation" },
+        { "$ref": "#/$defs/recordDeleteMutation" },
         { "$ref": "#/$defs/filePutMutation" },
         { "$ref": "#/$defs/fileMoveMutation" },
         { "$ref": "#/$defs/fileDeleteMutation" }
@@ -344,7 +380,13 @@
               "required": ["record_id", "mutation"],
               "properties": {
                 "record_id": { "$ref": "#/$defs/uuid" },
-                "mutation": { "$ref": "#/$defs/recordMutation" },
+                "mutation": {
+                  "oneOf": [
+                    { "$ref": "#/$defs/recordPutMutation" },
+                    { "$ref": "#/$defs/recordMoveMutation" },
+                    { "$ref": "#/$defs/recordDeleteMutation" }
+                  ]
+                },
                 "current": { "$ref": "#/$defs/record" },
                 "current_revision": { "type": "string" }
               }