@kubun/plugin-p2p 0.10.0 → 0.11.0

package/lib/protocol.js

@@ -1 +1,251 @@
-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"},catalogIDs:{type:"array",items:{type:"string"},description:"Catalog IDs to resolve sync scope from criteria"},knownModelIDs:{type:"array",items:{type:"string"},description:"Model IDs the requester already has — used to identify missing clusters"},direction:{type:"string",enum:["push","pull","both"]}},required:["delegationTokens"],additionalProperties:!1},result:{type:"object",properties:{direction:{type:"string",enum:["push","pull","both"]},acceptedScopes:{type:"array",items:{type:"object",properties:{modelID:{type:"string"},ownerDID:{type:"string"}},required:["modelID","ownerDID"],additionalProperties:!1}},excludedDocumentIDs:{type:"array",items:{type:"string"}},missingClusters:{type:"object",description:"Cluster definitions for models the requester does not have yet",additionalProperties:!0}},required:["acceptedScopes","excludedDocumentIDs"],additionalProperties:!1}},"sync/merkle-sync":{type:"channel",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"}},direction:{type:"string",enum:["push","pull","both"]}},required:["scopes","excludedDocumentIDs","tree","direction"],additionalProperties:!1},send:{type:"object",properties:{type:{type:"string",enum:["mutations","complete"]},mutationJWTs:{type:"array",items:{type:"string"},description:"Signed mutation JWTs for divergent time buckets"}},required:["type"],additionalProperties:!1},receive:{type:"object",properties:{type:{type:"string",enum:["tree","mutations","complete"]},tree:{type:"object",description:"Responder merkle tree bucket hashes",additionalProperties:{type:"string"}},mutationJWTs:{type:"array",items:{type:"string"},description:"Signed mutation JWTs for divergent time buckets"}},required:["type"],additionalProperties:!1},result:{type:"object",properties:{success:{type:"boolean"},divergentBuckets:{type:"number"},mutationsSent:{type:"number"},mutationsReceived:{type:"number"}},required:["success","divergentBuckets","mutationsSent","mutationsReceived"],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: false
+                    },
+                    description: 'Requested sync scopes as (model, owner) pairs'
+                },
+                delegationTokens: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    description: 'JWT delegation tokens for authorization'
+                },
+                catalogIDs: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    description: 'Catalog IDs to resolve sync scope from criteria'
+                },
+                knownModelIDs: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    description: 'Model IDs the requester already has — used to identify missing clusters'
+                },
+                direction: {
+                    type: 'string',
+                    enum: [
+                        'push',
+                        'pull',
+                        'both'
+                    ]
+                }
+            },
+            required: [
+                'delegationTokens'
+            ],
+            additionalProperties: false
+        },
+        result: {
+            type: 'object',
+            properties: {
+                direction: {
+                    type: 'string',
+                    enum: [
+                        'push',
+                        'pull',
+                        'both'
+                    ]
+                },
+                acceptedScopes: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            modelID: {
+                                type: 'string'
+                            },
+                            ownerDID: {
+                                type: 'string'
+                            }
+                        },
+                        required: [
+                            'modelID',
+                            'ownerDID'
+                        ],
+                        additionalProperties: false
+                    }
+                },
+                excludedDocumentIDs: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    }
+                },
+                missingClusters: {
+                    type: 'object',
+                    description: 'Cluster definitions for models the requester does not have yet',
+                    additionalProperties: true
+                }
+            },
+            required: [
+                'acceptedScopes',
+                'excludedDocumentIDs'
+            ],
+            additionalProperties: false
+        }
+    },
+    'sync/merkle-sync': {
+        type: 'channel',
+        param: {
+            type: 'object',
+            properties: {
+                scopes: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            modelID: {
+                                type: 'string'
+                            },
+                            ownerDID: {
+                                type: 'string'
+                            }
+                        },
+                        required: [
+                            'modelID',
+                            'ownerDID'
+                        ],
+                        additionalProperties: false
+                    }
+                },
+                excludedDocumentIDs: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    }
+                },
+                tree: {
+                    type: 'object',
+                    description: 'Merkle tree bucket hashes from requester',
+                    additionalProperties: {
+                        type: 'string'
+                    }
+                },
+                direction: {
+                    type: 'string',
+                    enum: [
+                        'push',
+                        'pull',
+                        'both'
+                    ]
+                },
+                delegationTokens: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    description: 'Delegation JWTs authorizing the caller for non-owned scopes'
+                }
+            },
+            required: [
+                'scopes',
+                'excludedDocumentIDs',
+                'tree',
+                'direction'
+            ],
+            additionalProperties: false
+        },
+        send: {
+            type: 'object',
+            properties: {
+                type: {
+                    type: 'string',
+                    enum: [
+                        'mutations',
+                        'complete'
+                    ]
+                },
+                mutationJWTs: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    description: 'Signed mutation JWTs for divergent time buckets'
+                }
+            },
+            required: [
+                'type'
+            ],
+            additionalProperties: false
+        },
+        receive: {
+            type: 'object',
+            properties: {
+                type: {
+                    type: 'string',
+                    enum: [
+                        'tree',
+                        'mutations',
+                        'complete'
+                    ]
+                },
+                tree: {
+                    type: 'object',
+                    description: 'Responder merkle tree bucket hashes',
+                    additionalProperties: {
+                        type: 'string'
+                    }
+                },
+                mutationJWTs: {
+                    type: 'array',
+                    items: {
+                        type: 'string'
+                    },
+                    description: 'Signed mutation JWTs for divergent time buckets'
+                }
+            },
+            required: [
+                'type'
+            ],
+            additionalProperties: false
+        },
+        result: {
+            type: 'object',
+            properties: {
+                success: {
+                    type: 'boolean'
+                },
+                divergentBuckets: {
+                    type: 'number'
+                },
+                mutationsSent: {
+                    type: 'number'
+                },
+                mutationsReceived: {
+                    type: 'number'
+                }
+            },
+            required: [
+                'success',
+                'divergentBuckets',
+                'mutationsSent',
+                'mutationsReceived'
+            ],
+            additionalProperties: false
+        }
+    }
+};

package/lib/schema.d.ts

@@ -1,3 +1,4 @@
 import type { SchemaExtension } from '@kubun/engine';
+import { type Logger } from '@kubun/logger';
 import { type P2PEventEmitter } from './groups/events.js';
-export declare function createP2PSchemaExtension(emitter: P2PEventEmitter): SchemaExtension;
+export declare function createP2PSchemaExtension(emitter: P2PEventEmitter, logger?: Logger): SchemaExtension;