@kubun/protocol 0.5.2 → 0.6.0

package/lib/index.d.ts

@@ -1,5 +1,4 @@
 import type { AnyClientMessageOf, AnyServerMessageOf, ClientTransportOf, ServerTransportOf } from '@enkaku/protocol';
-import type { DocumentProtocol } from './services/document.js';
 import type { GraphProtocol } from './services/graph.js';
 import type { SyncProtocol } from './services/sync.js';
 export * from './models/cluster.js';
@@ -7,11 +6,10 @@ export * from './models/document.js';
 export * from './models/graph.js';
 export * from './models/json-schema.js';
 export * from './models/value.js';
-export * from './services/document.js';
 export * from './services/graph.js';
 export * from './services/sync.js';
 export * from './types.js';
-export type Protocol = DocumentProtocol & GraphProtocol & SyncProtocol;
+export type Protocol = GraphProtocol & SyncProtocol;
 export type ClientMessage = AnyClientMessageOf<Protocol>;
 export type ServerMessage = AnyServerMessageOf<Protocol>;
 export type ClientTransport = ClientTransportOf<Protocol>;

package/lib/index.js

@@ -1 +1 @@
-export*from"./models/cluster.js";export*from"./models/document.js";export*from"./models/graph.js";export*from"./models/json-schema.js";export*from"./models/value.js";export*from"./services/document.js";export*from"./services/graph.js";export*from"./services/sync.js";export*from"./types.js";
+export*from"./models/cluster.js";export*from"./models/document.js";export*from"./models/graph.js";export*from"./models/json-schema.js";export*from"./models/value.js";export*from"./services/graph.js";export*from"./services/sync.js";export*from"./types.js";

package/lib/models/document.d.ts

@@ -5178,13 +5178,11 @@ export declare const setDocumentMutation: {
             readonly type: "string";
         };
         readonly data: {
-            readonly anyOf: readonly [{
-                readonly title: "KubunBinaryValue";
-                readonly type: "string";
-                readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-            }, {
-                readonly type: "null";
-            }];
+            readonly type: "object";
+            readonly additionalProperties: true;
+        };
+        readonly hlc: {
+            readonly type: "string";
         };
         readonly unq: {
             readonly title: "KubunBinaryValue";
@@ -5202,10 +5200,27 @@ export declare const setDocumentMutation: {
             }];
         };
     };
-    readonly required: readonly ["iss", "sub", "typ", "data", "unq"];
+    readonly required: readonly ["iss", "sub", "typ", "data", "hlc", "unq"];
     readonly additionalProperties: false;
 };
 export type SetDocumentMutation = FromSchema<typeof setDocumentMutation>;
+export declare const patchOperationSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly op: {
+            readonly type: "string";
+        };
+        readonly path: {
+            readonly type: "string";
+        };
+        readonly value: {};
+        readonly from: {
+            readonly type: "string";
+        };
+    };
+    readonly required: readonly ["op", "path"];
+    readonly additionalProperties: false;
+};
 export declare const changeDocumentMutation: {
     readonly $id: "urn:kubun:protocol:mutation:change";
     readonly type: "object";
@@ -5222,17 +5237,28 @@ export declare const changeDocumentMutation: {
         readonly sub: {
             readonly type: "string";
         };
-        readonly data: {
-            readonly anyOf: readonly [{
-                readonly title: "KubunBinaryValue";
-                readonly type: "string";
-                readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-            }, {
-                readonly type: "null";
-            }];
+        readonly patch: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly op: {
+                        readonly type: "string";
+                    };
+                    readonly path: {
+                        readonly type: "string";
+                    };
+                    readonly value: {};
+                    readonly from: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["op", "path"];
+                readonly additionalProperties: false;
+            };
         };
-        readonly inc: {
-            readonly type: "boolean";
+        readonly hlc: {
+            readonly type: "string";
         };
         readonly cap: {
             readonly anyOf: readonly [{
@@ -5245,7 +5271,7 @@ export declare const changeDocumentMutation: {
             }];
         };
     };
-    readonly required: readonly ["iss", "sub", "typ", "data", "inc"];
+    readonly required: readonly ["iss", "sub", "typ", "patch", "hlc"];
     readonly additionalProperties: false;
 };
 export type ChangeDocumentMutation = FromSchema<typeof changeDocumentMutation>;
@@ -5273,13 +5299,11 @@ export declare const documentMutation: {
                 readonly type: "string";
             };
             readonly data: {
-                readonly anyOf: readonly [{
-                    readonly title: "KubunBinaryValue";
-                    readonly type: "string";
-                    readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-                }, {
-                    readonly type: "null";
-                }];
+                readonly type: "object";
+                readonly additionalProperties: true;
+            };
+            readonly hlc: {
+                readonly type: "string";
             };
             readonly unq: {
                 readonly title: "KubunBinaryValue";
@@ -5297,7 +5321,7 @@ export declare const documentMutation: {
                 }];
             };
         };
-        readonly required: readonly ["iss", "sub", "typ", "data", "unq"];
+        readonly required: readonly ["iss", "sub", "typ", "data", "hlc", "unq"];
         readonly additionalProperties: false;
     }, {
         readonly $id: "urn:kubun:protocol:mutation:change";
@@ -5315,17 +5339,28 @@ export declare const documentMutation: {
             readonly sub: {
                 readonly type: "string";
             };
-            readonly data: {
-                readonly anyOf: readonly [{
-                    readonly title: "KubunBinaryValue";
-                    readonly type: "string";
-                    readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-                }, {
-                    readonly type: "null";
-                }];
+            readonly patch: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly op: {
+                            readonly type: "string";
+                        };
+                        readonly path: {
+                            readonly type: "string";
+                        };
+                        readonly value: {};
+                        readonly from: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly required: readonly ["op", "path"];
+                    readonly additionalProperties: false;
+                };
             };
-            readonly inc: {
-                readonly type: "boolean";
+            readonly hlc: {
+                readonly type: "string";
             };
             readonly cap: {
                 readonly anyOf: readonly [{
@@ -5338,7 +5373,7 @@ export declare const documentMutation: {
                 }];
             };
         };
-        readonly required: readonly ["iss", "sub", "typ", "data", "inc"];
+        readonly required: readonly ["iss", "sub", "typ", "patch", "hlc"];
         readonly additionalProperties: false;
     }];
 };

package/lib/models/document.js

@@ -1 +1 @@
-import{asType as e,createValidator as t}from"@enkaku/schema";import{DocumentModelID as r,ScalarModelID as o,ShapeModelID as i}from"@kubun/id";import{pascalCase as s}from"change-case";import{baseObjectModel as n,nameString as a,referencesRecordModel as d}from"./json-schema.js";import{binaryStringValue as c,didStringValue as l}from"./value.js";export const documentModelVersion={type:"string",const:"1.0"};export const documentFieldMetaAccount={type:"object",properties:{type:{type:"string",const:"account"},searchable:{type:"boolean"}},required:["type"],additionalProperties:!1};export const documentFieldMetaAttachment={type:"object",properties:{type:{type:"string",const:"attachment"},searchable:{type:"boolean"}},required:["type"],additionalProperties:!1};export const documentFieldMetaDocument={type:"object",properties:{type:{type:"string",const:"document"},model:{anyOf:[{type:"string"},{type:"null"}]},searchable:{type:"boolean"}},required:["type","model"],additionalProperties:!1};export const documentFieldMeta={anyOf:[documentFieldMetaAccount,documentFieldMetaAttachment,documentFieldMetaDocument]};export const documentFieldsMeta={type:"object",additionalProperties:documentFieldMeta};export const documentModelSchema={type:"object",properties:{...n.properties,$defs:d},required:[...n.required,"$defs"],additionalProperties:!1};export const documentModelBase={type:"object",properties:{name:a,version:documentModelVersion,interfaces:{type:"array",items:{type:"string"}},schema:documentModelSchema,fieldsMeta:documentFieldsMeta},required:["name","version","interfaces","schema","fieldsMeta"],additionalProperties:!1};export const documentModelDefault={type:"object",properties:{...documentModelBase.properties,behavior:{type:"string",const:"default"}},required:[...documentModelBase.required,"behavior"],additionalProperties:!1};export const documentModelInterface={type:"object",properties:{...documentModelBase.properties,behavior:{type:"string",const:"interface"}},required:[...documentModelBase.required,"behavior"],additionalProperties:!1};export const documentModelUnique={type:"object",properties:{...documentModelBase.properties,behavior:{type:"string",const:"unique"},uniqueFields:{type:"array",items:{type:"string"}}},required:[...documentModelBase.required,"behavior","uniqueFields"],additionalProperties:!1};export const documentModel={$id:"urn:kubun:protocol:model:document",anyOf:[documentModelDefault,documentModelInterface,documentModelUnique]};export const documentModelsCluster={type:"array",items:documentModel};export const documentModelsRecord={type:"object",additionalProperties:documentModel};export const setDocumentMutation={$id:"urn:kubun:protocol:mutation:set",type:"object",properties:{typ:{type:"string",const:"set"},iss:l,aud:l,sub:{type:"string"},data:{anyOf:[c,{type:"null"}]},unq:c,cap:{anyOf:[{type:"string"},{type:"array",items:{type:"string"}}]}},required:["iss","sub","typ","data","unq"],additionalProperties:!1};export const changeDocumentMutation={$id:"urn:kubun:protocol:mutation:change",type:"object",properties:{typ:{type:"string",const:"change"},iss:l,sub:{type:"string"},data:{anyOf:[c,{type:"null"}]},inc:{type:"boolean"},cap:{anyOf:[{type:"string"},{type:"array",items:{type:"string"}}]}},required:["iss","sub","typ","data","inc"],additionalProperties:!1};export const documentMutation={$id:"urn:kubun:protocol:mutation",anyOf:[setDocumentMutation,changeDocumentMutation]};export const validateDocumentModel=t(documentModel);export const REFERENCE_PREFIX="#/$defs/";let p={type:"object",title:"JSONObject",additionalProperties:!0},u=/^#([0-9]+)$/;export class DocumentModelNormalizer{#e;#t=new Set;#r;#o;#i;#s;#n={};#a={};#d=new Set;#c={};constructor(e){this.#e=e.inputModel,this.#r=e.logger;let t=e.inputModel.schema??{};this.#l(e.interfaceModels),this.#p(t,e.normalizedInterfaceIDs),this.#i=t.$defs??{},this.#s={...t,type:"object",properties:this.#n,required:Array.from(this.#d),additionalProperties:!1,$defs:{...t.$defs,...this.#a}},this.#o=this.#u(),this.#m()}#l(e){for(let t of e){for(let e of t.interfaces)this.#t.add(e);for(let e of t.schema.required)this.#d.add(e);Object.assign(this.#n,t.schema.properties),Object.assign(this.#a,t.schema.$defs),Object.assign(this.#c,t.fieldsMeta??{})}}#p(e,t){for(let e of t)this.#t.add(e);for(let t of e.required??[])this.#d.add(t);Object.assign(this.#n,e.properties??{}),Object.assign(this.#c,this.#e.fieldsMeta??{})}#u(){let e=this.#s,t=Object.entries(e.properties??{});if(0===t.length)throw Error("Document schema must contain at least one property");let r={};for(let[e,o]of t)r[e]={$ref:this.#h(e,o)};return{type:"object",properties:r,additionalProperties:!1,required:e.required??[],$defs:this.#i}}#h(e,t){if(null!=t.$ref){let r=this.#f(t.$ref);return this.#h(e,r)}let r=t.type;if(null==r)throw Error("Invalid schema: missing type");switch(r){case"array":{if(null==t.title)throw Error("Invalid array schema: missing title");if(null==t.items)throw Error("Invalid array schema: missing items");let{default:r,...o}=t;return this.#y({...o,title:s(t.title),items:{$ref:this.#h(e,t.items)}})}case"object":{if(t.additionalProperties)return this.#y(p);if(null==t.title)throw Error("Invalid object schema: missing title");let e=Object.entries(t.properties??{});if(0===e.length)throw Error("Invalid object schema: must contain at least one property");let r={};for(let[t,o]of e)r[t]={$ref:this.#h(t,o)};return this.#y({type:"object",title:s(t.title),properties:r,required:t.required??[],additionalProperties:!1})}default:return this.#M(e,t)}}#f(e){if(!e.startsWith("#"))throw Error(`Invalid reference format: ${e}`);if(e.startsWith(REFERENCE_PREFIX)){let t=e.slice(REFERENCE_PREFIX.length),r=this.#s.$defs?.[t];if(null==r)throw Error(`Reference not found: ${e}`);return r}let t=e.split("/").slice(1),r=this.#s;for(let o of t){if(null==r||"object"!=typeof r)throw Error(`Invalid reference path: ${e}`);if(null==(r=r[o]))throw Error(`Reference not found: ${e}`)}return r}#M(e,t){let r=o.create(t),i=t;if("boolean"===t.type){let{title:e,...r}=t;i=r}else if(null!=t.title){let r=t.title.toLowerCase();"attachmentid"===r?(this.#c[e]={type:"attachment"},i={...t,title:"attachmentid"}):"did"===r?(this.#c[e]={type:"account"},i={...t,title:"did"}):"docid"===r?(null==this.#c[e]&&(this.#r.warn("Missing fieldMeta entry for document reference {fieldKey} of model {inputModel}",{fieldKey:e,inputModel:this.#e}),this.#c[e]={type:"document",model:null}),i={...t,title:"docid"}):i={...t,title:s(t.title)}}return this.#i[r.toString()]=i,`${REFERENCE_PREFIX}${r}`}#y(e){let t=i.create(e);return this.#i[t.toString()]=e,`${REFERENCE_PREFIX}${t}`}#m(){for(let[e,t]of Object.entries(this.#c)){if("document"!==t.type||null===t.model)continue;let o=t.model.match(u);null!=o&&(this.#c[e]={...t,model:r.local(Number.parseInt(o[1],10)).toString()})}}toDocumentModel(){return e(validateDocumentModel,{version:"1.0",behavior:"default",...this.#e,interfaces:Array.from(this.#t),schema:this.#o,fieldsMeta:this.#c})}}
+import{asType as e,createValidator as t}from"@enkaku/schema";import{DocumentModelID as r,ScalarModelID as o,ShapeModelID as i}from"@kubun/id";import{pascalCase as s}from"change-case";import{baseObjectModel as n,nameString as a,referencesRecordModel as d}from"./json-schema.js";import{binaryStringValue as c,didStringValue as l}from"./value.js";export const documentModelVersion={type:"string",const:"1.0"};export const documentFieldMetaAccount={type:"object",properties:{type:{type:"string",const:"account"},searchable:{type:"boolean"}},required:["type"],additionalProperties:!1};export const documentFieldMetaAttachment={type:"object",properties:{type:{type:"string",const:"attachment"},searchable:{type:"boolean"}},required:["type"],additionalProperties:!1};export const documentFieldMetaDocument={type:"object",properties:{type:{type:"string",const:"document"},model:{anyOf:[{type:"string"},{type:"null"}]},searchable:{type:"boolean"}},required:["type","model"],additionalProperties:!1};export const documentFieldMeta={anyOf:[documentFieldMetaAccount,documentFieldMetaAttachment,documentFieldMetaDocument]};export const documentFieldsMeta={type:"object",additionalProperties:documentFieldMeta};export const documentModelSchema={type:"object",properties:{...n.properties,$defs:d},required:[...n.required,"$defs"],additionalProperties:!1};export const documentModelBase={type:"object",properties:{name:a,version:documentModelVersion,interfaces:{type:"array",items:{type:"string"}},schema:documentModelSchema,fieldsMeta:documentFieldsMeta},required:["name","version","interfaces","schema","fieldsMeta"],additionalProperties:!1};export const documentModelDefault={type:"object",properties:{...documentModelBase.properties,behavior:{type:"string",const:"default"}},required:[...documentModelBase.required,"behavior"],additionalProperties:!1};export const documentModelInterface={type:"object",properties:{...documentModelBase.properties,behavior:{type:"string",const:"interface"}},required:[...documentModelBase.required,"behavior"],additionalProperties:!1};export const documentModelUnique={type:"object",properties:{...documentModelBase.properties,behavior:{type:"string",const:"unique"},uniqueFields:{type:"array",items:{type:"string"}}},required:[...documentModelBase.required,"behavior","uniqueFields"],additionalProperties:!1};export const documentModel={$id:"urn:kubun:protocol:model:document",anyOf:[documentModelDefault,documentModelInterface,documentModelUnique]};export const documentModelsCluster={type:"array",items:documentModel};export const documentModelsRecord={type:"object",additionalProperties:documentModel};export const setDocumentMutation={$id:"urn:kubun:protocol:mutation:set",type:"object",properties:{typ:{type:"string",const:"set"},iss:l,aud:l,sub:{type:"string"},data:{type:"object",additionalProperties:!0},hlc:{type:"string"},unq:c,cap:{anyOf:[{type:"string"},{type:"array",items:{type:"string"}}]}},required:["iss","sub","typ","data","hlc","unq"],additionalProperties:!1};export const patchOperationSchema={type:"object",properties:{op:{type:"string"},path:{type:"string"},value:{},from:{type:"string"}},required:["op","path"],additionalProperties:!1};export const changeDocumentMutation={$id:"urn:kubun:protocol:mutation:change",type:"object",properties:{typ:{type:"string",const:"change"},iss:l,sub:{type:"string"},patch:{type:"array",items:patchOperationSchema},hlc:{type:"string"},cap:{anyOf:[{type:"string"},{type:"array",items:{type:"string"}}]}},required:["iss","sub","typ","patch","hlc"],additionalProperties:!1};export const documentMutation={$id:"urn:kubun:protocol:mutation",anyOf:[setDocumentMutation,changeDocumentMutation]};export const validateDocumentModel=t(documentModel);export const REFERENCE_PREFIX="#/$defs/";let p={type:"object",title:"JSONObject",additionalProperties:!0},u=/^#([0-9]+)$/;export class DocumentModelNormalizer{#e;#t=new Set;#r;#o;#i;#s;#n={};#a={};#d=new Set;#c={};constructor(e){this.#e=e.inputModel,this.#r=e.logger;let t=e.inputModel.schema??{};this.#l(e.interfaceModels),this.#p(t,e.normalizedInterfaceIDs),this.#i=t.$defs??{},this.#s={...t,type:"object",properties:this.#n,required:Array.from(this.#d),additionalProperties:!1,$defs:{...t.$defs,...this.#a}},this.#o=this.#u(),this.#m()}#l(e){for(let t of e){for(let e of t.interfaces)this.#t.add(e);for(let e of t.schema.required)this.#d.add(e);Object.assign(this.#n,t.schema.properties),Object.assign(this.#a,t.schema.$defs),Object.assign(this.#c,t.fieldsMeta??{})}}#p(e,t){for(let e of t)this.#t.add(e);for(let t of e.required??[])this.#d.add(t);Object.assign(this.#n,e.properties??{}),Object.assign(this.#c,this.#e.fieldsMeta??{})}#u(){let e=this.#s,t=Object.entries(e.properties??{});if(0===t.length)throw Error("Document schema must contain at least one property");let r={};for(let[e,o]of t)r[e]={$ref:this.#h(e,o)};return{type:"object",properties:r,additionalProperties:!1,required:e.required??[],$defs:this.#i}}#h(e,t){if(null!=t.$ref){let r=this.#f(t.$ref);return this.#h(e,r)}let r=t.type;if(null==r)throw Error("Invalid schema: missing type");switch(r){case"array":{if(null==t.title)throw Error("Invalid array schema: missing title");if(null==t.items)throw Error("Invalid array schema: missing items");let{default:r,...o}=t;return this.#y({...o,title:s(t.title),items:{$ref:this.#h(e,t.items)}})}case"object":{if(t.additionalProperties)return this.#y(p);if(null==t.title)throw Error("Invalid object schema: missing title");let e=Object.entries(t.properties??{});if(0===e.length)throw Error("Invalid object schema: must contain at least one property");let r={};for(let[t,o]of e)r[t]={$ref:this.#h(t,o)};return this.#y({type:"object",title:s(t.title),properties:r,required:t.required??[],additionalProperties:!1})}default:return this.#M(e,t)}}#f(e){if(!e.startsWith("#"))throw Error(`Invalid reference format: ${e}`);if(e.startsWith(REFERENCE_PREFIX)){let t=e.slice(REFERENCE_PREFIX.length),r=this.#s.$defs?.[t];if(null==r)throw Error(`Reference not found: ${e}`);return r}let t=e.split("/").slice(1),r=this.#s;for(let o of t){if(null==r||"object"!=typeof r)throw Error(`Invalid reference path: ${e}`);if(null==(r=r[o]))throw Error(`Reference not found: ${e}`)}return r}#M(e,t){let r=o.create(t),i=t;if("boolean"===t.type){let{title:e,...r}=t;i=r}else if(null!=t.title){let r=t.title.toLowerCase();"attachmentid"===r?(this.#c[e]={type:"attachment"},i={...t,title:"attachmentid"}):"did"===r?(this.#c[e]={type:"account"},i={...t,title:"did"}):"docid"===r?(null==this.#c[e]&&(this.#r.warn("Missing fieldMeta entry for document reference {fieldKey} of model {inputModel}",{fieldKey:e,inputModel:this.#e}),this.#c[e]={type:"document",model:null}),i={...t,title:"docid"}):i={...t,title:s(t.title)}}return this.#i[r.toString()]=i,`${REFERENCE_PREFIX}${r}`}#y(e){let t=i.create(e);return this.#i[t.toString()]=e,`${REFERENCE_PREFIX}${t}`}#m(){for(let[e,t]of Object.entries(this.#c)){if("document"!==t.type||null===t.model)continue;let o=t.model.match(u);null!=o&&(this.#c[e]={...t,model:r.local(Number.parseInt(o[1],10)).toString()})}}toDocumentModel(){return e(validateDocumentModel,{version:"1.0",behavior:"default",...this.#e,interfaces:Array.from(this.#t),schema:this.#o,fieldsMeta:this.#c})}}

package/lib/models/graph.js

@@ -1 +1 @@
-import{verifyCluster as e}from"./cluster.js";export class GraphModel{static fromClusters(r){let s={};for(let t of r.clusters.map(e))Object.assign(s,t);return new GraphModel({aliases:r.aliases,record:s})}#e;#r;constructor(e){this.#e=e.aliases??Object.entries(e.record).reduce((e,[r,s])=>(null==e[s.name]?e[s.name]=r:console.warn(`Duplicate model name ${s.name} in GraphModel record, ignoring model ID ${r} in aliases`),e),{}),this.#r=e.record}get aliases(){return this.#e}get record(){return this.#r}getAlias(e){for(let[r,s]of Object.entries(this.#e))if(s===e)return r;return null}getModel(e){let r=this.#e[e]??e;return this.#r[r]??null}toJSON(){return{aliases:this.#e,record:this.#r}}}
+import{verifyCluster as e}from"./cluster.js";export class GraphModel{static fromClusters(s){let r={};for(let a of s.clusters.map(e))Object.assign(r,a);return new GraphModel({aliases:s.aliases,record:r})}#e;#s;constructor(e){null!=e.aliases&&0!==Object.keys(e.aliases).length?this.#e=e.aliases:this.#e=Object.entries(e.record).reduce((e,[s,r])=>(null==e[r.name]?e[r.name]=s:console.warn(`Duplicate model name ${r.name} in GraphModel record, ignoring model ID ${s} in aliases`),e),{}),this.#s=e.record}get aliases(){return this.#e}get record(){return this.#s}getAlias(e){for(let[s,r]of Object.entries(this.#e))if(r===e)return s;return null}getModel(e){let s=this.#e[e]??e;return this.#s[s]??null}toJSON(){return{aliases:this.#e,record:this.#s}}}

package/lib/services/graph.d.ts

@@ -3547,12 +3547,16 @@ export declare const mutateGraphParams: {
     readonly type: "object";
     readonly properties: {
         readonly mutations: {
-            readonly type: "object";
-            readonly additionalProperties: {
-                readonly title: "KubunSignedJWTValue";
-                readonly type: "string";
-                readonly pattern: "^[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+$";
-            };
+            readonly anyOf: readonly [{
+                readonly type: "object";
+                readonly additionalProperties: {
+                    readonly title: "KubunSignedJWTValue";
+                    readonly type: "string";
+                    readonly pattern: "^[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+$";
+                };
+            }, {
+                readonly type: "null";
+            }];
         };
         readonly attachments: {
             readonly type: "object";
@@ -6993,12 +6997,16 @@ export declare const graphProtocol: {
             readonly type: "object";
             readonly properties: {
                 readonly mutations: {
-                    readonly type: "object";
-                    readonly additionalProperties: {
-                        readonly title: "KubunSignedJWTValue";
-                        readonly type: "string";
-                        readonly pattern: "^[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+$";
-                    };
+                    readonly anyOf: readonly [{
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly title: "KubunSignedJWTValue";
+                            readonly type: "string";
+                            readonly pattern: "^[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+$";
+                        };
+                    }, {
+                        readonly type: "null";
+                    }];
                 };
                 readonly attachments: {
                     readonly type: "object";

package/lib/services/graph.js

@@ -1 +1 @@
-import{clusterModel as e}from"../models/cluster.js";import{documentModelsRecord as t}from"../models/document.js";import{binaryStringValue as r,signedJWTStringValue as a}from"../models/value.js";export const searchModelConfig={type:"object",properties:{fields:{type:"array",items:{type:"string"}}},additionalProperties:!1};export const searchConfig={type:"object",additionalProperties:searchModelConfig};export const deployGraphParams={type:"object",properties:{clusters:{type:"array",items:e},id:{type:"string"},name:{type:"string"},search:searchConfig},required:["clusters"],additionalProperties:!1};export const deployGraphResult={type:"object",properties:{id:{type:"string"},record:t,aliases:{type:"object",additionalProperties:{type:"string"}},search:searchConfig},required:["id","record","aliases"],additionalProperties:!1};export const listGraphResult={type:"object",properties:{graphs:{type:"array",items:{type:"object",properties:{id:{type:"string"},name:{type:"string"}},required:["id","name"],additionalProperties:!1}}},required:["graphs"],additionalProperties:!1};export const loadGraphParams={type:"object",properties:{id:{type:"string"}},required:["id"],additionalProperties:!1};export const loadGraphResult={type:"object",properties:{record:t,aliases:{type:"object",additionalProperties:{type:"string"}}},required:["record","aliases"],additionalProperties:!1};export const executeGraphParams={type:"object",properties:{id:{type:"string"},text:{type:"string"},variables:{type:"object"}},required:["id","text"],additionalProperties:!1};export const executeGraphError={type:"object",properties:{message:{type:"string"},locations:{type:"array",items:{type:"object",properties:{line:{type:"integer"},column:{type:"integer"}},required:["line","column"],additionalProperties:!1}},path:{type:"array",items:{type:"string"}},extensions:{type:"object"}},required:["message"],additionalProperties:!1};export const executeGraphResult={type:"object",properties:{data:{anyOf:[{type:"object"},{type:"null"}]},errors:{type:"array",items:executeGraphError},extensions:{type:"object"}},additionalProperties:!1};export const mutateGraphParams={type:"object",properties:{...executeGraphParams.properties,mutations:{type:"object",additionalProperties:a},attachments:{type:"object",additionalProperties:r}},required:[...executeGraphParams.required,"mutations"],additionalProperties:!1};export const graphProtocol={"graph/deploy":{type:"request",param:deployGraphParams,result:deployGraphResult},"graph/list":{type:"request",result:listGraphResult},"graph/load":{type:"request",param:loadGraphParams,result:loadGraphResult},"graph/mutate":{type:"request",param:mutateGraphParams,result:executeGraphResult},"graph/query":{type:"request",param:executeGraphParams,result:executeGraphResult},"graph/subscribe":{type:"stream",param:executeGraphParams,receive:executeGraphResult,result:{anyOf:[executeGraphResult,{type:"null"}]}}};
+import{clusterModel as e}from"../models/cluster.js";import{documentModelsRecord as t}from"../models/document.js";import{binaryStringValue as r,signedJWTStringValue as a}from"../models/value.js";export const searchModelConfig={type:"object",properties:{fields:{type:"array",items:{type:"string"}}},additionalProperties:!1};export const searchConfig={type:"object",additionalProperties:searchModelConfig};export const deployGraphParams={type:"object",properties:{clusters:{type:"array",items:e},id:{type:"string"},name:{type:"string"},search:searchConfig},required:["clusters"],additionalProperties:!1};export const deployGraphResult={type:"object",properties:{id:{type:"string"},record:t,aliases:{type:"object",additionalProperties:{type:"string"}},search:searchConfig},required:["id","record","aliases"],additionalProperties:!1};export const listGraphResult={type:"object",properties:{graphs:{type:"array",items:{type:"object",properties:{id:{type:"string"},name:{type:"string"}},required:["id","name"],additionalProperties:!1}}},required:["graphs"],additionalProperties:!1};export const loadGraphParams={type:"object",properties:{id:{type:"string"}},required:["id"],additionalProperties:!1};export const loadGraphResult={type:"object",properties:{record:t,aliases:{type:"object",additionalProperties:{type:"string"}}},required:["record","aliases"],additionalProperties:!1};export const executeGraphParams={type:"object",properties:{id:{type:"string"},text:{type:"string"},variables:{type:"object"}},required:["id","text"],additionalProperties:!1};export const executeGraphError={type:"object",properties:{message:{type:"string"},locations:{type:"array",items:{type:"object",properties:{line:{type:"integer"},column:{type:"integer"}},required:["line","column"],additionalProperties:!1}},path:{type:"array",items:{type:"string"}},extensions:{type:"object"}},required:["message"],additionalProperties:!1};export const executeGraphResult={type:"object",properties:{data:{anyOf:[{type:"object"},{type:"null"}]},errors:{type:"array",items:executeGraphError},extensions:{type:"object"}},additionalProperties:!1};export const mutateGraphParams={type:"object",properties:{...executeGraphParams.properties,mutations:{anyOf:[{type:"object",additionalProperties:a},{type:"null"}]},attachments:{type:"object",additionalProperties:r}},required:[...executeGraphParams.required,"mutations"],additionalProperties:!1};export const graphProtocol={"graph/deploy":{type:"request",param:deployGraphParams,result:deployGraphResult},"graph/list":{type:"request",result:listGraphResult},"graph/load":{type:"request",param:loadGraphParams,result:loadGraphResult},"graph/mutate":{type:"request",param:mutateGraphParams,result:executeGraphResult},"graph/query":{type:"request",param:executeGraphParams,result:executeGraphResult},"graph/subscribe":{type:"stream",param:executeGraphParams,receive:executeGraphResult,result:{anyOf:[executeGraphResult,{type:"null"}]}}};

package/lib/services/sync.d.ts

@@ -1,16 +1,26 @@
 import type { FromSchema } from '@enkaku/schema';
 export declare const syncProtocol: {
-    readonly 'sync/discovery': {
+    readonly 'sync/negotiate': {
         readonly type: "request";
         readonly param: {
             readonly type: "object";
             readonly properties: {
-                readonly userIDs: {
+                readonly scopes: {
                     readonly type: "array";
                     readonly items: {
-                        readonly type: "string";
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly modelID: {
+                                readonly type: "string";
+                            };
+                            readonly ownerDID: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly required: readonly ["modelID", "ownerDID"];
+                        readonly additionalProperties: false;
                     };
-                    readonly description: "User accounts to sync";
+                    readonly description: "Requested sync scopes as (model, owner) pairs";
                 };
                 readonly delegationTokens: {
                     readonly type: "array";
@@ -20,67 +30,75 @@ export declare const syncProtocol: {
                     readonly description: "JWT delegation tokens for authorization";
                 };
             };
-            readonly required: readonly ["userIDs", "delegationTokens"];
+            readonly required: readonly ["scopes", "delegationTokens"];
             readonly additionalProperties: false;
         };
         readonly result: {
             readonly type: "object";
             readonly properties: {
-                readonly documents: {
+                readonly acceptedScopes: {
                     readonly type: "array";
                     readonly items: {
                         readonly type: "object";
                         readonly properties: {
-                            readonly documentID: {
-                                readonly type: "string";
-                            };
                             readonly modelID: {
                                 readonly type: "string";
                             };
-                            readonly lastMutationTimestamp: {
-                                readonly type: "number";
-                            };
-                            readonly checkpointHash: {
+                            readonly ownerDID: {
                                 readonly type: "string";
                             };
-                            readonly sequenceNumber: {
-                                readonly type: "string";
-                            };
-                            readonly priority: {
-                                readonly type: "number";
-                                readonly description: "Sync priority (higher = more recent activity)";
-                            };
                         };
-                        readonly required: readonly ["documentID", "modelID", "lastMutationTimestamp", "checkpointHash", "sequenceNumber", "priority"];
+                        readonly required: readonly ["modelID", "ownerDID"];
                         readonly additionalProperties: false;
                     };
                 };
+                readonly excludedDocumentIDs: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
             };
-            readonly required: readonly ["documents"];
+            readonly required: readonly ["acceptedScopes", "excludedDocumentIDs"];
             readonly additionalProperties: false;
         };
     };
-    readonly 'sync/stream': {
+    readonly 'sync/merkle-sync': {
         readonly type: "stream";
         readonly param: {
             readonly type: "object";
             readonly properties: {
-                readonly documentIDs: {
+                readonly scopes: {
                     readonly type: "array";
                     readonly items: {
-                        readonly type: "string";
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly modelID: {
+                                readonly type: "string";
+                            };
+                            readonly ownerDID: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly required: readonly ["modelID", "ownerDID"];
+                        readonly additionalProperties: false;
                     };
-                    readonly description: "List of document IDs to sync";
                 };
-                readonly delegationTokens: {
+                readonly excludedDocumentIDs: {
                     readonly type: "array";
                     readonly items: {
                         readonly type: "string";
                     };
-                    readonly description: "JWT delegation tokens for authorization";
+                };
+                readonly tree: {
+                    readonly type: "object";
+                    readonly description: "Merkle tree bucket hashes from requester";
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                    };
                 };
             };
-            readonly required: readonly ["documentIDs", "delegationTokens"];
+            readonly required: readonly ["scopes", "excludedDocumentIDs", "tree"];
             readonly additionalProperties: false;
         };
         readonly receive: {
@@ -88,31 +106,25 @@ export declare const syncProtocol: {
             readonly properties: {
                 readonly type: {
                     readonly type: "string";
-                    readonly enum: readonly ["document", "complete", "skipped"];
-                };
-                readonly documentID: {
-                    readonly type: "string";
-                };
-                readonly syncMode: {
-                    readonly type: "string";
-                    readonly enum: readonly ["incremental", "full"];
+                    readonly enum: readonly ["mutations", "complete"];
                 };
                 readonly mutationJWTs: {
                     readonly type: "array";
                     readonly items: {
                         readonly type: "string";
                     };
-                    readonly description: "For incremental sync";
+                    readonly description: "Signed mutation JWTs for divergent time buckets";
                 };
-                readonly fullState: {
-                    readonly type: "string";
-                    readonly description: "Base64 encoded Automerge document for full sync";
+                readonly divergentBuckets: {
+                    readonly type: "number";
+                    readonly description: "Number of divergent minute buckets found";
                 };
-                readonly reason: {
-                    readonly type: "string";
-                    readonly description: "Reason for skipping document (when type is skipped)";
+                readonly totalMutations: {
+                    readonly type: "number";
+                    readonly description: "Total mutations sent";
                 };
             };
+            readonly required: readonly ["type"];
             readonly additionalProperties: false;
         };
         readonly result: {
@@ -121,62 +133,21 @@ export declare const syncProtocol: {
                 readonly success: {
                     readonly type: "boolean";
                 };
-                readonly syncedDocuments: {
+                readonly divergentBuckets: {
                     readonly type: "number";
-                    readonly description: "Number of documents synced";
                 };
-            };
-            readonly required: readonly ["success", "syncedDocuments"];
-            readonly additionalProperties: false;
-        };
-    };
-    readonly 'sync/checkpoint': {
-        readonly type: "request";
-        readonly param: {
-            readonly type: "object";
-            readonly properties: {
-                readonly peerServerID: {
-                    readonly type: "string";
-                };
-                readonly checkpointData: {
-                    readonly type: "object";
-                    readonly properties: {
-                        readonly userID: {
-                            readonly type: "string";
-                        };
-                        readonly lastSyncTimestamp: {
-                            readonly type: "number";
-                        };
-                        readonly documentCheckpoints: {
-                            readonly type: "object";
-                        };
-                        readonly vectorClock: {
-                            readonly type: "object";
-                        };
-                    };
-                    readonly required: readonly ["userID", "lastSyncTimestamp", "documentCheckpoints", "vectorClock"];
-                };
-            };
-            readonly required: readonly ["peerServerID", "checkpointData"];
-            readonly additionalProperties: false;
-        };
-        readonly result: {
-            readonly type: "object";
-            readonly properties: {
-                readonly success: {
-                    readonly type: "boolean";
+                readonly mutationsSent: {
+                    readonly type: "number";
                 };
             };
-            readonly required: readonly ["success"];
+            readonly required: readonly ["success", "divergentBuckets", "mutationsSent"];
             readonly additionalProperties: false;
         };
     };
 };
 export type SyncProtocol = typeof syncProtocol;
-export type SyncDiscoveryParams = FromSchema<SyncProtocol['sync/discovery']['param']>;
-export type SyncDiscoveryResult = FromSchema<SyncProtocol['sync/discovery']['result']>;
-export type SyncStreamParams = FromSchema<SyncProtocol['sync/stream']['param']>;
-export type SyncStreamReceive = FromSchema<SyncProtocol['sync/stream']['receive']>;
-export type SyncStreamResult = FromSchema<SyncProtocol['sync/stream']['result']>;
-export type SyncCheckpointParams = FromSchema<SyncProtocol['sync/checkpoint']['param']>;
-export type SyncCheckpointResult = FromSchema<SyncProtocol['sync/checkpoint']['result']>;
+export type SyncNegotiateParams = FromSchema<SyncProtocol['sync/negotiate']['param']>;
+export type SyncNegotiateResult = FromSchema<SyncProtocol['sync/negotiate']['result']>;
+export type SyncMerkleSyncParams = FromSchema<SyncProtocol['sync/merkle-sync']['param']>;
+export type SyncMerkleSyncReceive = FromSchema<SyncProtocol['sync/merkle-sync']['receive']>;
+export type SyncMerkleSyncResult = FromSchema<SyncProtocol['sync/merkle-sync']['result']>;

package/lib/services/sync.js

@@ -1 +1 @@
-export const syncProtocol={"sync/discovery":{type:"request",param:{type:"object",properties:{userIDs:{type:"array",items:{type:"string"},description:"User accounts to sync"},delegationTokens:{type:"array",items:{type:"string"},description:"JWT delegation tokens for authorization"}},required:["userIDs","delegationTokens"],additionalProperties:!1},result:{type:"object",properties:{documents:{type:"array",items:{type:"object",properties:{documentID:{type:"string"},modelID:{type:"string"},lastMutationTimestamp:{type:"number"},checkpointHash:{type:"string"},sequenceNumber:{type:"string"},priority:{type:"number",description:"Sync priority (higher = more recent activity)"}},required:["documentID","modelID","lastMutationTimestamp","checkpointHash","sequenceNumber","priority"],additionalProperties:!1}}},required:["documents"],additionalProperties:!1}},"sync/stream":{type:"stream",param:{type:"object",properties:{documentIDs:{type:"array",items:{type:"string"},description:"List of document IDs to sync"},delegationTokens:{type:"array",items:{type:"string"},description:"JWT delegation tokens for authorization"}},required:["documentIDs","delegationTokens"],additionalProperties:!1},receive:{type:"object",properties:{type:{type:"string",enum:["document","complete","skipped"]},documentID:{type:"string"},syncMode:{type:"string",enum:["incremental","full"]},mutationJWTs:{type:"array",items:{type:"string"},description:"For incremental sync"},fullState:{type:"string",description:"Base64 encoded Automerge document for full sync"},reason:{type:"string",description:"Reason for skipping document (when type is skipped)"}},additionalProperties:!1},result:{type:"object",properties:{success:{type:"boolean"},syncedDocuments:{type:"number",description:"Number of documents synced"}},required:["success","syncedDocuments"],additionalProperties:!1}},"sync/checkpoint":{type:"request",param:{type:"object",properties:{peerServerID:{type:"string"},checkpointData:{type:"object",properties:{userID:{type:"string"},lastSyncTimestamp:{type:"number"},documentCheckpoints:{type:"object"},vectorClock:{type:"object"}},required:["userID","lastSyncTimestamp","documentCheckpoints","vectorClock"]}},required:["peerServerID","checkpointData"],additionalProperties:!1},result:{type:"object",properties:{success:{type:"boolean"}},required:["success"],additionalProperties:!1}}};
+export const syncProtocol={"sync/negotiate":{type:"request",param:{type:"object",properties:{scopes:{type:"array",items:{type:"object",properties:{modelID:{type:"string"},ownerDID:{type:"string"}},required:["modelID","ownerDID"],additionalProperties:!1},description:"Requested sync scopes as (model, owner) pairs"},delegationTokens:{type:"array",items:{type:"string"},description:"JWT delegation tokens for authorization"}},required:["scopes","delegationTokens"],additionalProperties:!1},result:{type:"object",properties:{acceptedScopes:{type:"array",items:{type:"object",properties:{modelID:{type:"string"},ownerDID:{type:"string"}},required:["modelID","ownerDID"],additionalProperties:!1}},excludedDocumentIDs:{type:"array",items:{type:"string"}}},required:["acceptedScopes","excludedDocumentIDs"],additionalProperties:!1}},"sync/merkle-sync":{type:"stream",param:{type:"object",properties:{scopes:{type:"array",items:{type:"object",properties:{modelID:{type:"string"},ownerDID:{type:"string"}},required:["modelID","ownerDID"],additionalProperties:!1}},excludedDocumentIDs:{type:"array",items:{type:"string"}},tree:{type:"object",description:"Merkle tree bucket hashes from requester",additionalProperties:{type:"string"}}},required:["scopes","excludedDocumentIDs","tree"],additionalProperties:!1},receive:{type:"object",properties:{type:{type:"string",enum:["mutations","complete"]},mutationJWTs:{type:"array",items:{type:"string"},description:"Signed mutation JWTs for divergent time buckets"},divergentBuckets:{type:"number",description:"Number of divergent minute buckets found"},totalMutations:{type:"number",description:"Total mutations sent"}},required:["type"],additionalProperties:!1},result:{type:"object",properties:{success:{type:"boolean"},divergentBuckets:{type:"number"},mutationsSent:{type:"number"}},required:["success","divergentBuckets","mutationsSent"],additionalProperties:!1}}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/protocol",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -19,8 +19,8 @@
     "@enkaku/protocol": "^0.13.0",
     "@enkaku/schema": "^0.13.0",
     "change-case": "^5.4.4",
-    "@kubun/logger": "^0.5.0",
-    "@kubun/id": "^0.5.0"
+    "@kubun/id": "^0.6.0",
+    "@kubun/logger": "^0.6.0"
   },
   "devDependencies": {
     "json-schema-typed": "^8.0.2"

package/lib/services/document.d.ts

@@ -1,85 +0,0 @@
-import type { FromSchema } from '@enkaku/schema';
-export declare const documentSyncParams: {
-    readonly type: "object";
-    readonly properties: {
-        readonly documents: {
-            readonly type: "object";
-            readonly additionalProperties: {
-                readonly oneOf: readonly [{
-                    readonly title: "KubunBinaryValue";
-                    readonly type: "string";
-                    readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-                }, {
-                    readonly type: "null";
-                }];
-            };
-        };
-    };
-    readonly required: readonly ["documents"];
-    readonly additionalProperties: false;
-};
-export type DocumentSyncParams = FromSchema<typeof documentSyncParams>;
-export declare const documentSyncResult: {
-    readonly type: "object";
-    readonly properties: {
-        readonly states: {
-            readonly type: "object";
-            readonly additionalProperties: {
-                readonly oneOf: readonly [{
-                    readonly title: "KubunBinaryValue";
-                    readonly type: "string";
-                    readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-                }, {
-                    readonly type: "null";
-                }];
-            };
-        };
-    };
-    readonly required: readonly ["states"];
-    readonly additionalProperties: false;
-};
-export type DocumentSyncResult = FromSchema<typeof documentSyncResult>;
-export declare const documentProtocol: {
-    readonly 'document/sync': {
-        readonly type: "request";
-        readonly param: {
-            readonly type: "object";
-            readonly properties: {
-                readonly documents: {
-                    readonly type: "object";
-                    readonly additionalProperties: {
-                        readonly oneOf: readonly [{
-                            readonly title: "KubunBinaryValue";
-                            readonly type: "string";
-                            readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-                        }, {
-                            readonly type: "null";
-                        }];
-                    };
-                };
-            };
-            readonly required: readonly ["documents"];
-            readonly additionalProperties: false;
-        };
-        readonly result: {
-            readonly type: "object";
-            readonly properties: {
-                readonly states: {
-                    readonly type: "object";
-                    readonly additionalProperties: {
-                        readonly oneOf: readonly [{
-                            readonly title: "KubunBinaryValue";
-                            readonly type: "string";
-                            readonly pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$";
-                        }, {
-                            readonly type: "null";
-                        }];
-                    };
-                };
-            };
-            readonly required: readonly ["states"];
-            readonly additionalProperties: false;
-        };
-    };
-};
-export type DocumentProtocol = typeof documentProtocol;

package/lib/services/document.js

@@ -1 +0,0 @@
-import{binaryStringValue as e}from"../models/value.js";export const documentSyncParams={type:"object",properties:{documents:{type:"object",additionalProperties:{oneOf:[e,{type:"null"}]}}},required:["documents"],additionalProperties:!1};export const documentSyncResult={type:"object",properties:{states:{type:"object",additionalProperties:{oneOf:[e,{type:"null"}]}}},required:["states"],additionalProperties:!1};export const documentProtocol={"document/sync":{type:"request",param:documentSyncParams,result:documentSyncResult}};