@kubun/protocol 0.4.1 → 0.5.1

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 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';
 export * from './models/document.js';
 export * from './models/graph.js';
@@ -8,10 +9,10 @@ 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;
+export type Protocol = DocumentProtocol & GraphProtocol & SyncProtocol;
 export type ClientMessage = AnyClientMessageOf<Protocol>;
 export type ServerMessage = AnyServerMessageOf<Protocol>;
 export type ClientTransport = ClientTransportOf<Protocol>;
 export type ServerTransport = ServerTransportOf<Protocol>;
-//# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,8 +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 './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/document.js";export*from"./services/graph.js";export*from"./services/sync.js";export*from"./types.js";

package/lib/models/cluster.d.ts

@@ -329,6 +329,9 @@ export declare const clusterModel: {
                                             readonly type: "string";
                                             readonly const: "account";
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type"];
                                     readonly additionalProperties: false;
@@ -339,6 +342,9 @@ export declare const clusterModel: {
                                             readonly type: "string";
                                             readonly const: "attachment";
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type"];
                                     readonly additionalProperties: false;
@@ -356,6 +362,9 @@ export declare const clusterModel: {
                                                 readonly type: "null";
                                             }];
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type", "model"];
                                     readonly additionalProperties: false;
@@ -679,6 +688,9 @@ export declare const clusterModel: {
                                             readonly type: "string";
                                             readonly const: "account";
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type"];
                                     readonly additionalProperties: false;
@@ -689,6 +701,9 @@ export declare const clusterModel: {
                                             readonly type: "string";
                                             readonly const: "attachment";
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type"];
                                     readonly additionalProperties: false;
@@ -706,6 +721,9 @@ export declare const clusterModel: {
                                                 readonly type: "null";
                                             }];
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type", "model"];
                                     readonly additionalProperties: false;
@@ -1035,6 +1053,9 @@ export declare const clusterModel: {
                                             readonly type: "string";
                                             readonly const: "account";
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type"];
                                     readonly additionalProperties: false;
@@ -1045,6 +1066,9 @@ export declare const clusterModel: {
                                             readonly type: "string";
                                             readonly const: "attachment";
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type"];
                                     readonly additionalProperties: false;
@@ -1062,6 +1086,9 @@ export declare const clusterModel: {
                                                 readonly type: "null";
                                             }];
                                         };
+                                        readonly searchable: {
+                                            readonly type: "boolean";
+                                        };
                                     };
                                     readonly required: readonly ["type", "model"];
                                     readonly additionalProperties: false;
@@ -1169,10 +1196,13 @@ export declare const validateClusterModel: import("@enkaku/schema").Validator<{
         };
         fieldsMeta: {
             [x: string]: {
+                searchable?: boolean | undefined;
                 type: "account";
             } | {
+                searchable?: boolean | undefined;
                 type: "attachment";
             } | {
+                searchable?: boolean | undefined;
                 type: "document";
                 model: string | null;
             };
@@ -1257,10 +1287,13 @@ export declare const validateClusterModel: import("@enkaku/schema").Validator<{
         };
         fieldsMeta: {
             [x: string]: {
+                searchable?: boolean | undefined;
                 type: "account";
             } | {
+                searchable?: boolean | undefined;
                 type: "attachment";
             } | {
+                searchable?: boolean | undefined;
                 type: "document";
                 model: string | null;
             };
@@ -1345,10 +1378,13 @@ export declare const validateClusterModel: import("@enkaku/schema").Validator<{
         };
         fieldsMeta: {
             [x: string]: {
+                searchable?: boolean | undefined;
                 type: "account";
             } | {
+                searchable?: boolean | undefined;
                 type: "attachment";
             } | {
+                searchable?: boolean | undefined;
                 type: "document";
                 model: string | null;
             };
@@ -1363,6 +1399,7 @@ export declare const validateClusterModel: import("@enkaku/schema").Validator<{
 }>;
 export declare function verifyCluster(cluster: ClusterModel): DocumentModelsRecord;
 export type ClusterBuilderParams = {
+    externalModels?: Record<string, DocumentModel>;
     logger?: Logger;
 };
 export declare class ClusterBuilder {
@@ -1375,4 +1412,3 @@ export declare class ClusterBuilder {
     add(inputModel: DocumentModelInput): DocumentModelID;
     addAll(models: Array<DocumentModelInput>): Array<DocumentModelID>;
 }
-//# sourceMappingURL=cluster.d.ts.map

package/lib/models/cluster.js

@@ -1,132 +1 @@
-import { toB64 } from '@enkaku/codec';
-import { assertType, createValidator } from '@enkaku/schema';
-import { DocumentModelID, digestJSON } from '@kubun/id';
-import { getKubunLogger } from '@kubun/logger';
-import { DocumentModelNormalizer, documentModelsCluster } from './document.js';
-import { binaryStringValue } from './value.js';
-export const clusterModel = {
-    $id: 'urn:kubun:protocol:model:cluster',
-    type: 'object',
-    properties: {
-        digest: binaryStringValue,
-        models: documentModelsCluster,
-        record: {
-            type: 'object',
-            patternProperties: {
-                '^k[0-9a-z]{56}$': {
-                    type: 'integer',
-                    minimum: 0
-                }
-            },
-            additionalProperties: false
-        }
-    },
-    required: [
-        'digest',
-        'models',
-        'record'
-    ],
-    additionalProperties: false
-};
-export const validateClusterModel = createValidator(clusterModel);
-export function verifyCluster(cluster) {
-    assertType(validateClusterModel, cluster);
-    const digest = digestJSON(cluster.models);
-    if (cluster.digest !== toB64(digest)) {
-        throw new Error('Invalid cluster: digest mismatch');
-    }
-    const recordEntries = Object.entries(cluster.record);
-    if (recordEntries.length !== cluster.models.length) {
-        throw new Error('Invalid cluster: record length mismatch');
-    }
-    const record = {};
-    for (const [id, index] of recordEntries){
-        const expectedID = new DocumentModelID(digest, index).toString();
-        if (id !== expectedID) {
-            throw new Error(`Invalid cluster: record key mismatch, expected ${expectedID}, got ${id}`);
-        }
-        const model = cluster.models[index];
-        if (model == null) {
-            throw new Error(`Invalid cluster: missing model at index ${index}`);
-        }
-        record[id] = model;
-    }
-    return record;
-}
-export class ClusterBuilder {
-    #cluster = [];
-    #logger;
-    constructor(params = {}){
-        this.#logger = params.logger ?? getKubunLogger('protocol');
-    }
-    get cluster() {
-        return this.#cluster;
-    }
-    get length() {
-        return this.#cluster.length;
-    }
-    build() {
-        const models = this.#cluster;
-        if (models.length === 0) {
-            throw new Error('Cluster is empty');
-        }
-        const digest = digestJSON(models);
-        const record = {};
-        for(let index = 0; index < models.length; index++){
-            const id = new DocumentModelID(digest, index);
-            record[id.toString()] = index;
-        }
-        return {
-            digest: toB64(digest),
-            models,
-            record
-        };
-    }
-    get(id) {
-        let index;
-        if (typeof id === 'number') {
-            index = id;
-        } else if (typeof id === 'string' && id[0] === '#') {
-            index = Number.parseInt(id.slice(1), 10);
-            if (Number.isNaN(index)) {
-                throw new Error(`Invalid DocumentModelID: ${id}`);
-            }
-        } else {
-            const docID = typeof id === 'string' ? DocumentModelID.fromString(id) : id;
-            if (!docID.isLocal) {
-                throw new Error('Invalid DocumentModelID to access model in cluster: must be a local ID');
-            }
-            index = docID.index;
-        }
-        const model = this.#cluster[index];
-        if (model == null) {
-            throw new RangeError(`Invalid cluster index: ${index}`);
-        }
-        return model;
-    }
-    add(inputModel) {
-        const interfaceIDs = inputModel.interfaces ?? [];
-        const normalizedInterfaceIDs = interfaceIDs.map((id)=>{
-            if (id.startsWith('#')) {
-                const index = Number.parseInt(id.slice(1), 10);
-                if (Number.isNaN(index)) {
-                    throw new Error(`Invalid DocumentModelID: ${id}`);
-                }
-                return DocumentModelID.local(index).toString();
-            }
-            return id;
-        });
-        const model = new DocumentModelNormalizer({
-            inputModel,
-            interfaceModels: normalizedInterfaceIDs.map((id)=>this.get(id)),
-            logger: this.#logger,
-            normalizedInterfaceIDs
-        }).toDocumentModel();
-        const index = this.#cluster.length;
-        this.#cluster.push(model);
-        return DocumentModelID.local(index);
-    }
-    addAll(models) {
-        return models.map((input)=>this.add(input));
-    }
-}
+import{toB64 as e}from"@enkaku/codec";import{assertType as t,createValidator as r}from"@enkaku/schema";import{DocumentModelID as l,digestJSON as o}from"@kubun/id";import{getKubunLogger as i}from"@kubun/logger";import{DocumentModelNormalizer as s,documentModelsCluster as n}from"./document.js";import{binaryStringValue as d}from"./value.js";export const clusterModel={$id:"urn:kubun:protocol:model:cluster",type:"object",properties:{digest:d,models:n,record:{type:"object",patternProperties:{"^k[0-9a-z]{56}$":{type:"integer",minimum:0}},additionalProperties:!1}},required:["digest","models","record"],additionalProperties:!1};export const validateClusterModel=r(clusterModel);export function verifyCluster(r){t(validateClusterModel,r);let i=o(r.models);if(r.digest!==e(i))throw Error("Invalid cluster: digest mismatch");let s=Object.entries(r.record);if(s.length!==r.models.length)throw Error("Invalid cluster: record length mismatch");let n={};for(let[e,t]of s){let o=new l(i,t).toString();if(e!==o)throw Error(`Invalid cluster: record key mismatch, expected ${o}, got ${e}`);let s=r.models[t];if(null==s)throw Error(`Invalid cluster: missing model at index ${t}`);n[e]=s}return n}export class ClusterBuilder{#e=[];#t;#r;constructor(e={}){this.#t=e.externalModels??{},this.#r=e.logger??i("protocol")}get cluster(){return this.#e}get length(){return this.#e.length}build(){let t=this.#e;if(0===t.length)throw Error("Cluster is empty");let r=o(t),i={};for(let e=0;e<t.length;e++)i[new l(r,e).toString()]=e;return{digest:e(r),models:t,record:i}}get(e){let t;if("number"==typeof e)t=e;else if("string"==typeof e&&"#"===e[0]){if(Number.isNaN(t=Number.parseInt(e.slice(1),10)))throw Error(`Invalid DocumentModelID: ${e}`)}else{let r="string"==typeof e?l.fromString(e):e;if(!r.isLocal){let t="string"==typeof e?e:e.toString(),r=this.#t[t];if(null!=r)return r;throw Error(`External model not found: ${t}`)}t=r.index}let r=this.#e[t];if(null==r)throw RangeError(`Invalid cluster index: ${t}`);return r}add(e){let t=(e.interfaces??[]).map(e=>{if(e.startsWith("#")){let t=Number.parseInt(e.slice(1),10);if(Number.isNaN(t))throw Error(`Invalid DocumentModelID: ${e}`);return l.local(t).toString()}return e}),r=new s({inputModel:e,interfaceModels:t.map(e=>this.get(e)),logger:this.#r,normalizedInterfaceIDs:t}).toDocumentModel(),o=this.#e.length;return this.#e.push(r),l.local(o)}addAll(e){return e.map(e=>this.add(e))}}