@kubun/protocol 0.7.0 → 0.8.0

package/lib/errors.d.ts

@@ -0,0 +1,10 @@
+export declare const KubunErrorCodes: {
+    readonly KB01: "Validation error";
+    readonly KB02: "Not found";
+    readonly KB03: "Unauthorized";
+    readonly KB04: "Invalid operation";
+    readonly KB05: "Transaction error";
+    readonly KB06: "Internal error";
+    readonly KB07: "Access denied";
+};
+export type KubunErrorCode = keyof typeof KubunErrorCodes;

package/lib/errors.js

@@ -0,0 +1 @@
+export const KubunErrorCodes={KB01:"Validation error",KB02:"Not found",KB03:"Unauthorized",KB04:"Invalid operation",KB05:"Transaction error",KB06:"Internal error",KB07:"Access denied"};

package/lib/executor.d.ts

@@ -0,0 +1,48 @@
+import type { ExecutionResult } from 'graphql';
+import type { DeployGraphParams, DeployGraphResult, ExecuteGraphParams, ExecuteGraphResult, ListGraphResult, LoadGraphParams, LoadGraphResult } from './services/graph.js';
+/**
+ * Parameters for a single GraphQL operation (query, mutation, or subscription).
+ * Does not include graphID or viewerDID --
+ * those are captured by the GraphQLSource at construction time.
+ */
+export type GraphQLOperationParams = {
+    text: string;
+    variables?: Record<string, unknown>;
+};
+/**
+ * A bound GraphQL execution target for a specific graph (and optionally a viewer).
+ * Obtained from GraphQLSourceProvider.getGraphQLSource().
+ */
+export type GraphQLSource = {
+    query<Data extends Record<string, unknown> = Record<string, unknown>>(params: GraphQLOperationParams): Promise<ExecutionResult<Data>>;
+    mutate<Data extends Record<string, unknown> = Record<string, unknown>>(params: GraphQLOperationParams): Promise<ExecutionResult<Data>>;
+    subscribe<Data extends Record<string, unknown> = Record<string, unknown>>(params: GraphQLOperationParams): Promise<AsyncGenerator<ExecutionResult<Data>> | ExecutionResult<Data>>;
+};
+/**
+ * Parameters for obtaining a GraphQLSource.
+ */
+export type GraphQLSourceParams = {
+    graphID: string;
+    getViewerDID?: () => string | null;
+};
+/**
+ * Provides bound GraphQLSource instances for a given graph.
+ * KubunEngine and KubunClient both implement this interface.
+ */
+export type GraphQLSourceProvider = {
+    getGraphQLSource(params: GraphQLSourceParams): GraphQLSource;
+};
+/**
+ * Shared interface for graph management and execution.
+ * Implemented by KubunEngine (local) and KubunClient (remote).
+ * Consumers that need graph operations (MCP, CLI, etc.) depend on this
+ * interface rather than a specific implementation.
+ */
+export type GraphsProvider = GraphQLSourceProvider & {
+    listGraphs(): Promise<ListGraphResult>;
+    loadGraph(params: LoadGraphParams): Promise<LoadGraphResult>;
+    deployGraph(params: DeployGraphParams): Promise<DeployGraphResult>;
+    queryGraph<Data extends Record<string, unknown> = Record<string, unknown>>(params: ExecuteGraphParams): Promise<ExecuteGraphResult<Data>>;
+    mutateGraph<Data extends Record<string, unknown> = Record<string, unknown>>(params: ExecuteGraphParams): Promise<ExecuteGraphResult<Data>>;
+    subscribeToGraph<Data extends Record<string, unknown> = Record<string, unknown>>(params: ExecuteGraphParams): Promise<AsyncGenerator<ExecuteGraphResult<Data>> | ExecuteGraphResult<Data>>;
+};

package/lib/executor.js

@@ -0,0 +1 @@
+export{};

package/lib/index.d.ts

@@ -1,15 +1,19 @@
 import type { AnyClientMessageOf, AnyServerMessageOf, ClientTransportOf, ServerTransportOf } from '@enkaku/protocol';
 import type { GraphProtocol } from './services/graph.js';
-import type { SyncProtocol } from './services/sync.js';
+export { type KubunErrorCode, KubunErrorCodes } from './errors.js';
+export type { GraphQLOperationParams, GraphQLSource, GraphQLSourceParams, GraphQLSourceProvider, GraphsProvider, } from './executor.js';
+export * from './models/catalog.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/optimal-clusters.js';
+export * from './models/space.js';
 export * from './models/value.js';
+export { KubunAttributeKeys, KubunSpanNames } from './semantic.js';
 export * from './services/graph.js';
-export * from './services/sync.js';
 export * from './types.js';
-export type Protocol = GraphProtocol & SyncProtocol;
+export type Protocol = GraphProtocol;
 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/graph.js";export*from"./services/sync.js";export*from"./types.js";
+export{KubunErrorCodes}from"./errors.js";export*from"./models/catalog.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/optimal-clusters.js";export*from"./models/space.js";export*from"./models/value.js";export{KubunAttributeKeys,KubunSpanNames}from"./semantic.js";export*from"./services/graph.js";export*from"./types.js";

package/lib/models/catalog.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Declarative filter criteria for a catalog.
+ * All fields are optional — omitted fields mean "no constraint on this dimension."
+ * Multiple values in an array are OR'd (any match).
+ * Multiple fields are AND'd (all must match).
+ */
+export type CatalogFilterCriteria = {
+    /** Filter by model IDs — documents must be of one of these models */
+    models?: Array<string>;
+    /** Filter by owner DIDs — documents must be owned by one of these DIDs */
+    owners?: Array<string>;
+    /** Filter by circle IDs — documents must grant access to one of these circles */
+    circles?: Array<string>;
+};
+export type CatalogRecord = {
+    id: string;
+    ownerDID: string;
+    name: string;
+    description: string;
+    filterCriteria: CatalogFilterCriteria;
+    hlc: string;
+};

package/lib/models/catalog.js

@@ -0,0 +1 @@
+export{};

package/lib/models/cluster.d.ts

@@ -1116,6 +1116,8 @@ export declare const clusterModel: {
     readonly additionalProperties: false;
 };
 export type ClusterModel = FromSchema<typeof clusterModel>;
+export type ClustersRecord = Record<string, ClusterModel>;
+export declare function clusterToRecord(cluster: ClusterModel): ClustersRecord;
 export declare const validateClusterModel: import("@enkaku/schema").Validator<{
     digest: string;
     models: ({
@@ -1399,7 +1401,7 @@ export declare const validateClusterModel: import("@enkaku/schema").Validator<{
 }>;
 export declare function verifyCluster(cluster: ClusterModel): DocumentModelsRecord;
 export type ClusterBuilderParams = {
-    externalClusters?: Array<ClusterModel>;
+    externalClusters?: ClustersRecord;
     logger?: Logger;
 };
 export declare class ClusterBuilder {

package/lib/models/cluster.js

@@ -1 +1 @@
-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=new Map;#l;constructor(e={}){for(let t of(this.#l=e.logger??i("protocol"),e.externalClusters??[])){let e=verifyCluster(t),r={};for(let t of Object.keys(e)){let e=l.fromString(t);r[l.local(e.index).toString()]=t}for(let[t,l]of Object.entries(e))this.#t[t]=l,this.#r.set(t,r)}}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=>{let t=this.get(e),r=this.#r.get(e);return null!=r?this.#o(t,r):t}),logger:this.#l,normalizedInterfaceIDs:t}).toDocumentModel(),o=this.#e.length;return this.#e.push(r),l.local(o)}#o(e,t){let r=e.interfaces.map(e=>t[e]??e),l={...e.fieldsMeta};for(let[e,r]of Object.entries(l))"document"===r.type&&null!=r.model&&null!=t[r.model]&&(l[e]={...r,model:t[r.model]});return{...e,interfaces:r,fieldsMeta:l}}addAll(e){return e.map(e=>this.add(e))}}
+import{fromB64 as e,toB64 as t}from"@enkaku/codec";import{assertType as r,createValidator as l}from"@enkaku/schema";import{ClusterModelID as o,DocumentModelID as i,digestJSON as s}from"@kubun/id";import{getKubunLogger as n}from"@kubun/logger";import{DocumentModelNormalizer as u,documentModelsCluster as d}from"./document.js";import{binaryStringValue as a}from"./value.js";export const clusterModel={$id:"urn:kubun:protocol:model:cluster",type:"object",properties:{digest:a,models:d,record:{type:"object",patternProperties:{"^k[0-9a-z]{56}$":{type:"integer",minimum:0}},additionalProperties:!1}},required:["digest","models","record"],additionalProperties:!1};export function clusterToRecord(t){let r=e(t.digest);return{[o.fromDigest(r).toString()]:t}}export const validateClusterModel=l(clusterModel);export function verifyCluster(e){r(validateClusterModel,e);let l=s(e.models);if(e.digest!==t(l))throw Error("Invalid cluster: digest mismatch");let o=Object.entries(e.record);if(o.length!==e.models.length)throw Error("Invalid cluster: record length mismatch");let n={};for(let[t,r]of o){let o=new i(l,r).toString();if(t!==o)throw Error(`Invalid cluster: record key mismatch, expected ${o}, got ${t}`);let s=e.models[r];if(null==s)throw Error(`Invalid cluster: missing model at index ${r}`);n[t]=s}return n}export class ClusterBuilder{#e=[];#t={};#r=new Map;#l;constructor(e={}){for(let t of(this.#l=e.logger??n("protocol"),Object.values(e.externalClusters??{}))){let e=verifyCluster(t),r={};for(let t of Object.keys(e)){let e=i.fromString(t);r[i.local(e.index).toString()]=t}for(let[t,l]of Object.entries(e))this.#t[t]=l,this.#r.set(t,r)}}get cluster(){return this.#e}get length(){return this.#e.length}build(){let e=this.#e;if(0===e.length)throw Error("Cluster is empty");let r=s(e),l={};for(let t=0;t<e.length;t++)l[new i(r,t).toString()]=t;return{digest:t(r),models:e,record:l}}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?i.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 i.local(t).toString()}return e}),r=new u({inputModel:e,interfaceModels:t.map(e=>{let t=this.get(e),r=this.#r.get(e);return null!=r?this.#o(t,r):t}),logger:this.#l,normalizedInterfaceIDs:t}).toDocumentModel(),l=this.#e.length;return this.#e.push(r),i.local(l)}#o(e,t){let r=e.interfaces.map(e=>t[e]??e),l={...e.fieldsMeta};for(let[e,r]of Object.entries(l))"document"===r.type&&null!=r.model&&null!=t[r.model]&&(l[e]={...r,model:t[r.model]});return{...e,interfaces:r,fieldsMeta:l}}addAll(e){return e.map(e=>this.add(e))}}

package/lib/models/graph.d.ts

@@ -1,8 +1,8 @@
-import { type ClusterModel } from './cluster.js';
+import type { ClustersRecord } from './cluster.js';
 import type { DocumentModel, DocumentModelsRecord } from './document.js';
 export type FromClustersParams = {
     aliases?: Record<string, string>;
-    clusters: Array<ClusterModel>;
+    clusters: ClustersRecord;
 };
 export type GraphModelParams = {
     aliases?: Record<string, string>;
@@ -11,6 +11,7 @@ export type GraphModelParams = {
 export type GraphModelJSON = {
     aliases: Record<string, string>;
     record: DocumentModelsRecord;
+    extensionSDL?: string;
 };
 export declare class GraphModel {
     #private;

package/lib/models/graph.js

@@ -1 +1 @@
-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}}}
+import{verifyCluster as e}from"./cluster.js";export class GraphModel{static fromClusters(s){let r={};for(let a of Object.values(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/models/optimal-clusters.d.ts

@@ -0,0 +1,44 @@
+import { type ClustersRecord } from './cluster.js';
+import type { DocumentModelInput } from './document.js';
+/**
+ * Extract fieldsMeta document reference dependencies for each model.
+ * Returns directed edges only (A→B does not imply B→A).
+ * Used for SCC grouping — only circular fieldsMeta forces co-location.
+ */
+export declare function extractFieldsMetaDeps(models: Array<DocumentModelInput>): Array<Set<number>>;
+/**
+ * Extract interface implementation dependencies for each model.
+ * These form a DAG (no circular interfaces). Used for ordering
+ * within a cluster so ClusterBuilder can resolve interfaces eagerly.
+ */
+export declare function extractInterfaceDeps(models: Array<DocumentModelInput>): Array<Set<number>>;
+/**
+ * Find strongly connected components using Tarjan's algorithm.
+ * Used on fieldsMeta directed graph — only circular references (A→B→A)
+ * force models into the same cluster. One-way refs don't group.
+ * Returns arrays of model indices, one per SCC.
+ */
+export declare function findStronglyConnectedComponents(deps: Array<Set<number>>): Array<Array<number>>;
+/**
+ * Find cluster groups from model definitions.
+ * Groups are determined by strongly connected components in the
+ * fieldsMeta directed graph. Only circular fieldsMeta references
+ * force models into the same cluster.
+ */
+export declare function findClusters(models: Array<DocumentModelInput>): Array<Array<number>>;
+export type GraphBuilderParams = {
+    externalClusters?: ClustersRecord;
+};
+/**
+ * Higher-level builder that produces optimally-split clusters from model
+ * definitions. Independent models get their own cluster; cross-referencing
+ * models are grouped together. This maximizes content-addressed
+ * deduplication while keeping the ClusterBuilder as an internal detail.
+ */
+export declare class GraphBuilder {
+    #private;
+    constructor(params?: GraphBuilderParams);
+    add(model: DocumentModelInput): this;
+    addAll(models: Array<DocumentModelInput>): this;
+    build(): ClustersRecord;
+}

package/lib/models/optimal-clusters.js

@@ -0,0 +1 @@
+import{DocumentModelID as e,digestJSON as t}from"@kubun/id";import{ClusterBuilder as l,clusterToRecord as n}from"./cluster.js";function r(e){if(!e.startsWith("#"))return null;let t=Number.parseInt(e.slice(1),10);return Number.isNaN(t)?null:t}export function extractFieldsMetaDeps(e){return e.map(e=>{let t=new Set;for(let l of Object.values(e.fieldsMeta??{}))if("document"===l.type&&null!=l.model){let e=r(l.model);null!=e&&t.add(e)}return t})}export function extractInterfaceDeps(e){return e.map(e=>{let t=new Set;for(let l of e.interfaces??[]){let e=r(l);null!=e&&t.add(e)}return t})}export function findStronglyConnectedComponents(e){let t=e.length,l=Array(t).fill(-1),n=Array(t).fill(-1),r=Array(t).fill(!1),o=[],s=[],f=0;for(let i=0;i<t;i++)-1===l[i]&&function i(a){for(let s of(l[a]=f,n[a]=f,f++,o.push(a),r[a]=!0,e[a]))!(s>=t)&&(-1===l[s]?(i(s),n[a]=Math.min(n[a],n[s])):r[s]&&(n[a]=Math.min(n[a],l[s])));if(n[a]===l[a]){let e=[],t=o.pop();for(;null!=t&&(r[t]=!1,e.push(t),t!==a);)t=o.pop();s.push(e)}}(i);return s.map(e=>e.sort((e,t)=>e-t)).sort((e,t)=>e[0]-t[0])}export function findClusters(e){return findStronglyConnectedComponents(extractFieldsMetaDeps(e))}export class GraphBuilder{#e=[];#t;constructor(e={}){this.#t=e.externalClusters??{}}add(e){return this.#e.push(e),this}addAll(e){return this.#e.push(...e),this}build(){let o=Object.keys(this.#t).length>0?this.#t:void 0,s=function(o,s){if(0===o.length)return[];let f=extractFieldsMetaDeps(o),i=extractInterfaceDeps(o),a=findStronglyConnectedComponents(f),u=function(e,t,l){let n=new Map;for(let t=0;t<e.length;t++)for(let l of e[t])n.set(l,t);let r=Array.from({length:e.length},()=>new Set);for(let o=0;o<e.length;o++)for(let s of e[o]){for(let e of t[s]){let t=n.get(e);null!=t&&t!==o&&r[o].add(t)}for(let e of l[s]){let t=n.get(e);null!=t&&t!==o&&r[o].add(t)}}let o=r.map(e=>e.size),s=o.map((e,t)=>0===e?t:-1).filter(e=>e>=0),f=[];for(;s.length>0;){let e=s.shift();if(null==e)break;f.push(e);for(let t=0;t<r.length;t++)r[t].has(e)&&(o[t]--,0===o[t]&&s.push(t))}return f}(a,i,f),d=new Map,p={...s??{}},m=[];for(let s of u){let f=a[s],u=function(e,t,l,n){let o=new Set(t),s=new Map;for(let e of t){let t=new Set;for(let n of l[e])o.has(n)&&t.add(n);s.set(e,t)}let f=new Map;for(let e of t)f.set(e,s.get(e)?.size??0);let i=[],a=t.filter(e=>(f.get(e)??0)===0).map(t=>({originalIndex:t,model:e[t]})).sort((e,t)=>e.model.name.localeCompare(t.model.name));for(;a.length>0;){let t=a.shift();if(null==t)break;for(let[l,n]of(i.push(t),s))if(n.has(t.originalIndex)){let t=(f.get(l)??1)-1;if(f.set(l,t),0===t){let t={originalIndex:l,model:e[l]},n=a.findIndex(e=>e.model.name.localeCompare(t.model.name)>0);-1===n?a.push(t):a.splice(n,0,t)}}}let u=new Map;for(let e=0;e<i.length;e++)u.set(i[e].originalIndex,e);return i.map(({model:e})=>{let t={...e};if(null!=t.interfaces&&(t.interfaces=t.interfaces.map(e=>{let t=r(e);if(null==t)return e;let l=n.get(t);if(null!=l)return l;let o=u.get(t);return null!=o?`#${o}`:e})),null!=t.fieldsMeta){let e={...t.fieldsMeta};for(let[t,l]of Object.entries(e))if("document"===l.type&&null!=l.model){let o=r(l.model);if(null==o)continue;let s=n.get(o);if(null!=s){e[t]={...l,model:s};continue}let f=u.get(o);null!=f&&(e[t]={...l,model:`#${f}`})}t.fieldsMeta=e}return t})}(o,f,i,d),c=new l({externalClusters:Object.keys(p).length>0?p:void 0});c.addAll(u);let h=c.build();m.push(h);let g=t(h.models);for(let t=0;t<f.length;t++){let l=f[t],n=o[l].name,r=h.models.findIndex(e=>e.name===n);if(-1!==r){let t=new e(g,r);d.set(l,t.toString())}}Object.assign(p,n(h))}return m}(this.#e,o),f={};for(let e of s)Object.assign(f,n(e));return f}}

package/lib/models/space.d.ts

@@ -0,0 +1,21 @@
+export type SpaceRecord = {
+    id: string;
+    name: string;
+    description: string;
+    createdBy: string;
+    hlc: string;
+};
+export type CircleRecord = {
+    id: string;
+    spaceID: string;
+    name: string;
+    description: string;
+    catalogIDs: Array<string>;
+    hlc: string;
+};
+export type CircleMemberRecord = {
+    circleID: string;
+    memberDID: string;
+    role: 'admin' | 'member';
+    hlc: string;
+};

package/lib/models/space.js

@@ -0,0 +1 @@
+export{};

package/lib/semantic.d.ts

@@ -0,0 +1,23 @@
+export declare const KubunSpanNames: {
+    readonly GRAPH_QUERY: "kubun.graph.query";
+    readonly GRAPH_MUTATE: "kubun.graph.mutate";
+    readonly GRAPH_SUBSCRIBE: "kubun.graph.subscribe";
+    readonly GRAPH_DEPLOY: "kubun.graph.deploy";
+    readonly GRAPHQL_EXECUTE: "kubun.graphql.execute";
+    readonly DATA_QUERY: "kubun.data.query";
+    readonly DATA_MUTATE: "kubun.data.mutate";
+    readonly DATA_TRANSACTION: "kubun.data.transaction";
+};
+export declare const KubunAttributeKeys: {
+    readonly GRAPH_ID: "kubun.graph.id";
+    readonly GRAPHQL_OPERATION_TYPE: "graphql.operation.type";
+    readonly GRAPHQL_DOCUMENT: "graphql.document";
+    readonly GRAPHQL_VARIABLES: "graphql.variables";
+    readonly MODEL_ID: "kubun.model.id";
+    readonly DOCUMENT_ID: "kubun.document.id";
+    readonly DOCUMENTS_COUNT: "kubun.documents.count";
+    readonly MUTATION_TYPE: "kubun.mutation.type";
+    readonly MUTATION_DATA: "kubun.mutation.data";
+    readonly QUERY_FILTER: "kubun.query.filter";
+    readonly ERROR_CODE: "kubun.error.code";
+};

package/lib/semantic.js

@@ -0,0 +1 @@
+export const KubunSpanNames={GRAPH_QUERY:"kubun.graph.query",GRAPH_MUTATE:"kubun.graph.mutate",GRAPH_SUBSCRIBE:"kubun.graph.subscribe",GRAPH_DEPLOY:"kubun.graph.deploy",GRAPHQL_EXECUTE:"kubun.graphql.execute",DATA_QUERY:"kubun.data.query",DATA_MUTATE:"kubun.data.mutate",DATA_TRANSACTION:"kubun.data.transaction"};export const KubunAttributeKeys={GRAPH_ID:"kubun.graph.id",GRAPHQL_OPERATION_TYPE:"graphql.operation.type",GRAPHQL_DOCUMENT:"graphql.document",GRAPHQL_VARIABLES:"graphql.variables",MODEL_ID:"kubun.model.id",DOCUMENT_ID:"kubun.document.id",DOCUMENTS_COUNT:"kubun.documents.count",MUTATION_TYPE:"kubun.mutation.type",MUTATION_DATA:"kubun.mutation.data",QUERY_FILTER:"kubun.query.filter",ERROR_CODE:"kubun.error.code"};

package/lib/services/graph.d.ts

@@ -1152,6 +1152,13 @@ export declare const deployGraphParams: {
         readonly name: {
             readonly type: "string";
         };
+        readonly plugins: {
+            readonly type: "object";
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly additionalProperties: true;
+            };
+        };
         readonly search: {
             readonly type: "object";
             readonly additionalProperties: {
@@ -3428,6 +3435,9 @@ export declare const loadGraphResult: {
                 readonly type: "string";
             };
         };
+        readonly extensionSDL: {
+            readonly type: "string";
+        };
     };
     readonly required: readonly ["record", "aliases"];
     readonly additionalProperties: false;
@@ -3445,6 +3455,9 @@ export declare const executeGraphParams: {
         readonly variables: {
             readonly type: "object";
         };
+        readonly catalogID: {
+            readonly type: "string";
+        };
     };
     readonly required: readonly ["id", "text"];
     readonly additionalProperties: false;
@@ -3578,6 +3591,9 @@ export declare const mutateGraphParams: {
         readonly variables: {
             readonly type: "object";
         };
+        readonly catalogID: {
+            readonly type: "string";
+        };
     };
     readonly required: readonly ["id", "text", "mutations"];
     readonly additionalProperties: false;
@@ -4755,6 +4771,13 @@ export declare const graphProtocol: {
                 readonly name: {
                     readonly type: "string";
                 };
+                readonly plugins: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    };
+                };
                 readonly search: {
                     readonly type: "object";
                     readonly additionalProperties: {
@@ -7033,6 +7056,9 @@ export declare const graphProtocol: {
                         readonly type: "string";
                     };
                 };
+                readonly extensionSDL: {
+                    readonly type: "string";
+                };
             };
             readonly required: readonly ["record", "aliases"];
             readonly additionalProperties: false;
@@ -7075,6 +7101,9 @@ export declare const graphProtocol: {
                 readonly variables: {
                     readonly type: "object";
                 };
+                readonly catalogID: {
+                    readonly type: "string";
+                };
             };
             readonly required: readonly ["id", "text", "mutations"];
             readonly additionalProperties: false;
@@ -7148,6 +7177,9 @@ export declare const graphProtocol: {
                 readonly variables: {
                     readonly type: "object";
                 };
+                readonly catalogID: {
+                    readonly type: "string";
+                };
             };
             readonly required: readonly ["id", "text"];
             readonly additionalProperties: false;
@@ -7221,6 +7253,9 @@ export declare const graphProtocol: {
                 readonly variables: {
                     readonly type: "object";
                 };
+                readonly catalogID: {
+                    readonly type: "string";
+                };
             };
             readonly required: readonly ["id", "text"];
             readonly additionalProperties: false;

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:{anyOf:[{type:"object",additionalProperties:a},{type:"null"}]},attachments:{type:"object",additionalProperties:r},transactionID:{type:"string"}},required:[...executeGraphParams.required,"mutations"],additionalProperties:!1};export const beginTransactionParams={type:"object",properties:{id:{type:"string"}},required:["id"],additionalProperties:!1};export const beginTransactionResult={type:"object",properties:{transactionID:{type:"string"}},required:["transactionID"],additionalProperties:!1};export const transactionParams={type:"object",properties:{transactionID:{type:"string"}},required:["transactionID"],additionalProperties:!1};export const transactionResult={type:"object",properties:{success:{type:"boolean"}},required:["success"],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"}]}},"graph/beginTransaction":{type:"request",param:beginTransactionParams,result:beginTransactionResult},"graph/commitTransaction":{type:"request",param:transactionParams,result:transactionResult},"graph/rollbackTransaction":{type:"request",param:transactionParams,result:transactionResult}};
+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"},plugins:{type:"object",additionalProperties:{type:"object",additionalProperties:!0}},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"}},extensionSDL:{type:"string"}},required:["record","aliases"],additionalProperties:!1};export const executeGraphParams={type:"object",properties:{id:{type:"string"},text:{type:"string"},variables:{type:"object"},catalogID:{type:"string"}},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},transactionID:{type:"string"}},required:[...executeGraphParams.required,"mutations"],additionalProperties:!1};export const beginTransactionParams={type:"object",properties:{id:{type:"string"}},required:["id"],additionalProperties:!1};export const beginTransactionResult={type:"object",properties:{transactionID:{type:"string"}},required:["transactionID"],additionalProperties:!1};export const transactionParams={type:"object",properties:{transactionID:{type:"string"}},required:["transactionID"],additionalProperties:!1};export const transactionResult={type:"object",properties:{success:{type:"boolean"}},required:["success"],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"}]}},"graph/beginTransaction":{type:"request",param:beginTransactionParams,result:beginTransactionResult},"graph/commitTransaction":{type:"request",param:transactionParams,result:transactionResult},"graph/rollbackTransaction":{type:"request",param:transactionParams,result:transactionResult}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/protocol",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -19,10 +19,11 @@
     "@enkaku/protocol": "^0.14.0",
     "@enkaku/schema": "^0.14.0",
     "change-case": "^5.4.4",
-    "@kubun/id": "^0.7.0",
-    "@kubun/logger": "^0.7.0"
+    "@kubun/logger": "^0.8.0",
+    "@kubun/id": "^0.8.0"
   },
   "devDependencies": {
+    "graphql": "^16.13.2",
     "json-schema-typed": "^8.0.2"
   },
   "scripts": {
@@ -31,7 +32,7 @@
     "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
     "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
     "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
-    "test:types": "tsc --noEmit",
+    "test:types": "tsc --noEmit -p tsconfig.test.json",
     "test:unit": "vitest run",
     "test": "pnpm run test:types && pnpm run test:unit"
   }

package/lib/services/sync.d.ts

@@ -1,153 +0,0 @@
-import type { FromSchema } from '@enkaku/schema';
-export declare const syncProtocol: {
-    readonly 'sync/negotiate': {
-        readonly type: "request";
-        readonly param: {
-            readonly type: "object";
-            readonly properties: {
-                readonly scopes: {
-                    readonly type: "array";
-                    readonly items: {
-                        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: "Requested sync scopes as (model, owner) pairs";
-                };
-                readonly delegationTokens: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
-                    readonly description: "JWT delegation tokens for authorization";
-                };
-            };
-            readonly required: readonly ["scopes", "delegationTokens"];
-            readonly additionalProperties: false;
-        };
-        readonly result: {
-            readonly type: "object";
-            readonly properties: {
-                readonly acceptedScopes: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "object";
-                        readonly properties: {
-                            readonly modelID: {
-                                readonly type: "string";
-                            };
-                            readonly ownerDID: {
-                                readonly type: "string";
-                            };
-                        };
-                        readonly required: readonly ["modelID", "ownerDID"];
-                        readonly additionalProperties: false;
-                    };
-                };
-                readonly excludedDocumentIDs: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
-                };
-            };
-            readonly required: readonly ["acceptedScopes", "excludedDocumentIDs"];
-            readonly additionalProperties: false;
-        };
-    };
-    readonly 'sync/merkle-sync': {
-        readonly type: "stream";
-        readonly param: {
-            readonly type: "object";
-            readonly properties: {
-                readonly scopes: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "object";
-                        readonly properties: {
-                            readonly modelID: {
-                                readonly type: "string";
-                            };
-                            readonly ownerDID: {
-                                readonly type: "string";
-                            };
-                        };
-                        readonly required: readonly ["modelID", "ownerDID"];
-                        readonly additionalProperties: false;
-                    };
-                };
-                readonly excludedDocumentIDs: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
-                };
-                readonly tree: {
-                    readonly type: "object";
-                    readonly description: "Merkle tree bucket hashes from requester";
-                    readonly additionalProperties: {
-                        readonly type: "string";
-                    };
-                };
-            };
-            readonly required: readonly ["scopes", "excludedDocumentIDs", "tree"];
-            readonly additionalProperties: false;
-        };
-        readonly receive: {
-            readonly type: "object";
-            readonly properties: {
-                readonly type: {
-                    readonly type: "string";
-                    readonly enum: readonly ["mutations", "complete"];
-                };
-                readonly mutationJWTs: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
-                    readonly description: "Signed mutation JWTs for divergent time buckets";
-                };
-                readonly divergentBuckets: {
-                    readonly type: "number";
-                    readonly description: "Number of divergent minute buckets found";
-                };
-                readonly totalMutations: {
-                    readonly type: "number";
-                    readonly description: "Total mutations sent";
-                };
-            };
-            readonly required: readonly ["type"];
-            readonly additionalProperties: false;
-        };
-        readonly result: {
-            readonly type: "object";
-            readonly properties: {
-                readonly success: {
-                    readonly type: "boolean";
-                };
-                readonly divergentBuckets: {
-                    readonly type: "number";
-                };
-                readonly mutationsSent: {
-                    readonly type: "number";
-                };
-            };
-            readonly required: readonly ["success", "divergentBuckets", "mutationsSent"];
-            readonly additionalProperties: false;
-        };
-    };
-};
-export type SyncProtocol = typeof syncProtocol;
-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 +0,0 @@
-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}}};