@kubun/engine 0.8.3 → 0.9.0

package/lib/access-control.d.ts

@@ -1,20 +1,20 @@
 import type { DocumentNode } from '@kubun/protocol';
+import type { AccessLevel, StoredAccessRule } from '@kubun/store-graph';
 /**
  * Minimal database interface required by the access control system.
  * Decoupled from KubunDB so any store implementation can provide these methods.
  */
 export type AccessControlDB = {
-    getUserModelAccessDefault(ownerDID: string, modelID: string, permissionType: 'read' | 'write'): Promise<{
-        level: string;
-        allowedDIDs: Array<string> | null;
-    } | null>;
+    getUserModelAccessDefault(ownerDID: string, modelID: string, permissionType: 'read' | 'write'): Promise<StoredAccessRule | null>;
     isMemberOfAnyCircle(viewerDID: string, circleIDs: Array<string>): Promise<boolean>;
+    isMemberOfAnyGroup(viewerDID: string, groupIDs: Array<string>): Promise<boolean>;
 };
-export type AccessLevel = 'only_owner' | 'anyone' | 'allowed_dids';
+export type { AccessLevel };
 export type AccessRule = {
     level: AccessLevel;
     allowedDIDs: Array<string> | null;
     allowedCircles: Array<string> | null;
+    allowedGroups: Array<string> | null;
 };
 export type AccessPermissions = {
     read?: AccessRule;
@@ -22,17 +22,48 @@ export type AccessPermissions = {
 };
 export type DefaultAccessLevel = {
     read: AccessLevel;
-    write: 'only_owner' | 'allowed_dids';
+    write: 'only_owner' | 'restricted';
 };
 export type AccessChecker = (doc: DocumentNode, permissionType: 'read' | 'write') => Promise<boolean>;
 /**
  * Parse and validate access permissions from document data.
+ *
+ * Ensures every returned rule carries the `allowedGroups` field (defaulting
+ * to `null` when absent on input) and rejects rules with unknown `level`
+ * tokens.
  */
 export declare function parseDocumentAccessPermissions(data: unknown): AccessPermissions | null;
 /**
  * Validate that DIDs have the correct format.
  */
 export declare function validateDIDs(dids: Array<string>): void;
+/**
+ * Validate that an identifier (circle or group ID) is a non-empty,
+ * non-whitespace string. There is no canonical format helper for circle and
+ * group IDs in `@kubun/id` (they are app-supplied opaque strings — `@kubun/id`
+ * helpers cover content-addressed Kubun IDs only), so this check rejects only
+ * obvious garbage. Downstream membership checks won't match if the format is
+ * malformed beyond this — callers should treat malformed IDs as an empty
+ * scope.
+ */
+export declare function validateID(id: string, kind: 'circle' | 'group'): void;
+/**
+ * Apply {@link validateID} to every entry of an array.
+ */
+export declare function validateIDs(ids: Array<string>, kind: 'circle' | 'group'): void;
+/**
+ * Resolve the effective access rule for a document and permission type.
+ *
+ * Order of precedence:
+ * 1. Document accessPermissions override
+ * 2. User's model default from database
+ * 3. Server configuration default
+ *
+ * Document overrides with `'anyone'` on a `write` permission are rejected
+ * (anyone-write is not a valid configuration) and fall through to the next
+ * tier.
+ */
+export declare function resolveAccessRule(document: DocumentNode, modelID: string, ownerDID: string, permissionType: 'read' | 'write', db: AccessControlDB, defaultAccessLevel: DefaultAccessLevel): Promise<AccessRule>;
 /**
  * Create an access checker function bound to specific viewer, delegation tokens,
  * database instance, and server default access level.

package/lib/access-control.js

@@ -1 +1 @@
-import{checkCapability as e}from"@enkaku/capability";export function parseDocumentAccessPermissions(e){try{if(!e||"object"!=typeof e||!("accessPermissions"in e))return null;let l=e.accessPermissions;if("object"!=typeof l)return null;return l}catch{return null}}export function validateDIDs(e){for(let l of e)if(!l.startsWith("did:"))throw Error(`Invalid DID format: ${l}`)}async function l(e,l,r,n,t,o){let a=parseDocumentAccessPermissions(e.data);if(a?.[n]){var i;let e=a[n];if(e&&(i=e.level,"read"===n?"only_owner"===i||"anyone"===i||"allowed_dids"===i:"only_owner"===i||"allowed_dids"===i))return{level:e.level,allowedDIDs:e.allowedDIDs||null,allowedCircles:e.allowedCircles||null}}let s=await t.getUserModelAccessDefault(r,l,n);return s?{level:s.level,allowedDIDs:s.allowedDIDs,allowedCircles:null}:{level:o[n],allowedDIDs:null,allowedCircles:null}}async function r(l,r,n,t,o){if(!o||0===o.length)return!1;let a=[`urn:kubun:document:${n.id}`,`urn:kubun:model:${n.model}`,"*"],i=`document/${t}`;for(let n of a)try{return await e({act:i,res:n},{iss:l,sub:r,cap:o}),!0}catch{}for(let n of o)for(let t of a)try{return await e({act:i,res:t},{iss:l,sub:r,cap:n}),!0}catch{}return!1}async function n(e,n,t,o,a,i){if(!n.owner)throw Error("Document missing owner field");if(e===n.owner)return!0;let s=await l(n,n.model,n.owner,t,o,a);if("anyone"===s.level)return!0;if(!e)return!1;if("only_owner"===s.level)return await r(e,n.owner,n,t,i);if("allowed_dids"===s.level){let l=s.allowedDIDs||[];if(l.includes(e)||"read"===t&&null!=s.allowedCircles&&s.allowedCircles.length>0&&await o.isMemberOfAnyCircle(e,s.allowedCircles))return!0;for(let o of l)if(await r(e,o,n,t,i))return!0}return!1}export function createAccessChecker(e){return async(l,r)=>await n(e.viewerDID,l,r,e.db,e.defaultAccessLevel,e.delegationTokens)}
+import{checkCapability as e}from"@enkaku/capability";function l(e){return Array.isArray(e)&&e.every(e=>"string"==typeof e)?e:null}function r(e){var r;return e&&"object"==typeof e?"only_owner"!==(r=e.level)&&"anyone"!==r&&"restricted"!==r?null:{level:e.level,allowedDIDs:l(e.allowedDIDs),allowedCircles:l(e.allowedCircles),allowedGroups:l(e.allowedGroups)}:null}export function parseDocumentAccessPermissions(e){try{if(!e||"object"!=typeof e||!("accessPermissions"in e))return null;let l=e.accessPermissions;if(!l||"object"!=typeof l)return null;let t={},o=r(l.read);o&&(t.read=o);let n=r(l.write);return n&&(t.write=n),t}catch{return null}}export function validateDIDs(e){for(let l of e)if("string"!=typeof l||!l.startsWith("did:"))throw Error(`Invalid DID format: ${String(l)}`)}export function validateID(e,l){if("string"!=typeof e||0===e.trim().length)throw Error(`Invalid ${l} ID: must be a non-empty string`)}export function validateIDs(e,l){for(let r of e)validateID(r,l)}export async function resolveAccessRule(e,l,r,t,o,n){let a=parseDocumentAccessPermissions(e.data),i=a?.[t];if(null!=i&&("write"!==t||"anyone"!==i.level))return i;let s=await o.getUserModelAccessDefault(r,l,t);return s?{level:s.level,allowedDIDs:s.allowedDIDs,allowedCircles:s.allowedCircles,allowedGroups:s.allowedGroups}:{level:n[t],allowedDIDs:null,allowedCircles:null,allowedGroups:null}}async function t(l,r,t,o,n){if(!n||0===n.length)return!1;let a=[`urn:kubun:document:${t.id}`,`urn:kubun:model:${t.model}`,"*"],i=`document/${o}`;for(let t of a)try{return await e({act:i,res:t},{iss:l,sub:r,cap:n}),!0}catch{}for(let t of n)for(let o of a)try{return await e({act:i,res:o},{iss:l,sub:r,cap:t}),!0}catch{}return!1}async function o(e,l,r,o,n,a){if(!l.owner)throw Error("Document missing owner field");if(e===l.owner)return!0;let i=await resolveAccessRule(l,l.model,l.owner,r,o,n);if("anyone"===i.level)return!0;if(!e)return!1;if("only_owner"===i.level)return await t(e,l.owner,l,r,a);if("restricted"===i.level){let n=i.allowedDIDs||[];if(n.includes(e)||"read"===r&&null!=i.allowedCircles&&i.allowedCircles.length>0&&await o.isMemberOfAnyCircle(e,i.allowedCircles)||"read"===r&&null!=i.allowedGroups&&i.allowedGroups.length>0&&await o.isMemberOfAnyGroup(e,i.allowedGroups))return!0;for(let o of n)if(await t(e,o,l,r,a))return!0}return!1}export function createAccessChecker(e){return async(l,r)=>await o(e.viewerDID,l,r,e.db,e.defaultAccessLevel,e.delegationTokens)}

package/lib/engine-events.d.ts

@@ -21,9 +21,34 @@ export type EngineEvents = {
         documentID: string;
         viewerDID: string;
     };
-    'engine:mutation:applied': {
+    /**
+     * Emitted when a mutation signed locally (authored on this peer) is applied.
+     * Fires exactly once per local-origin mutation, regardless of classification.
+     */
+    'engine:mutation:authored': {
         type: 'create' | 'update' | 'remove';
         documentID: string;
         viewerDID: string;
+        /** Signed mutation JWT — consumed by broadcast senders to route to peers. */
+        mutationJWT: string;
+        /** HLC string identifying this mutation's version. */
+        version: string;
+        /** Document model ID — stable across a batch of mutations on the same doc. */
+        modelID: string;
+    };
+    /**
+     * Emitted when a mutation received from a peer (authored elsewhere) is applied.
+     * Fires exactly once per peer-origin mutation, regardless of classification.
+     */
+    'engine:mutation:received': {
+        type: 'create' | 'update' | 'remove';
+        documentID: string;
+        viewerDID: string;
+        /** Signed mutation JWT — same shape as `engine:mutation:authored`. */
+        mutationJWT: string;
+        /** HLC string identifying this mutation's version. */
+        version: string;
+        /** Document model ID. */
+        modelID: string;
     };
 };

package/lib/engine.d.ts

@@ -33,28 +33,74 @@ export type EngineParams = {
     plugins?: Array<(params: PluginFactoryParams) => KubunPlugin>;
     eventBus?: EngineEventBus<EngineEvents>;
 };
+/**
+ * Optional pre-persist gate. Receives the synthesized post-apply
+ * `DocumentNode` after the mutation's effect has been computed in memory but
+ * before any write to the store (no `saveDocument`/`createDocument`/log
+ * insert). Returning `false` causes the engine to skip persist + event emit
+ * and report the mutation as `dropped: true`. Returning `true` (or no gate
+ * provided) lets the existing apply flow proceed.
+ *
+ * The gate is intentionally generic — it is not access-control-aware. Q4.1b
+ * composes `resolveAccessRule`/`checkAccess` in the receive wiring and passes
+ * the resulting decision through this hook.
+ */
+export type AccessGate = (postState: DocumentNode) => boolean | Promise<boolean>;
 export type ApplyVerifiedMutationParams = {
     /** The signed mutation JWT token */
     token: string;
-    /** The graph ID (needed to resolve validators for the document model) */
-    graphID: string;
+    /**
+     * Source of the mutation.
+     * - `'local'` (default): authored on this peer — emits `engine:mutation:authored`.
+     * - `'peer'`: received from another peer — emits `engine:mutation:received`.
+     */
+    origin?: 'local' | 'peer';
+    /**
+     * Optional gate evaluated after compute, before persist + event emit.
+     * On deny: no DB write, no events, result returns `dropped: true`.
+     */
+    accessGate?: AccessGate;
 };
 export type ApplyVerifiedMutationResult = {
-    /** The resulting document after mutation */
-    document: DocumentNode;
+    /** The resulting document after mutation. Null when the gate denied — the
+     *  pre-state is preserved on disk and the post-state was discarded. */
+    document: DocumentNode | null;
+    /** The document snapshot before the mutation was applied, or null if it did not exist */
+    previousDoc: DocumentNode | null;
     /** The verified mutation payload */
     mutation: DocumentMutation;
     /** The DID of the mutation author (from JWT issuer) */
     authorDID: string;
     /** BLAKE3 hash of the mutation JWT */
     hash: string;
+    /** The signed mutation JWT — retained so downstream consumers (e.g. broadcast
+     *  senders) can route the mutation to peers without re-signing. */
+    token: string;
+    /**
+     * `true` only when an `accessGate` denied this mutation post-compute.
+     * `false` otherwise (including verify-failure scenarios — those throw
+     *  before this result is constructed).
+     */
+    dropped: boolean;
 };
 export type ApplyVerifiedMutationsParams = {
     tokens: Array<string>;
-    graphID: string;
+    /**
+     * Source of the mutations in this batch.
+     * - `'local'` (default): authored on this peer — emits `engine:mutation:authored`.
+     * - `'peer'`: received from another peer — emits `engine:mutation:received`.
+     */
+    origin?: 'local' | 'peer';
+    /**
+     * Optional gate evaluated per entry. Each entry's gate decision is
+     * independent — some entries may be applied while others are dropped.
+     */
+    accessGate?: AccessGate;
 };
 export type ApplyVerifiedMutationsResult = {
     results: Array<ApplyVerifiedMutationResult>;
+    /** Count of entries dropped via the access gate. */
+    dropped: number;
 };
 export type ExecuteParams = {
     graphID: string;

package/lib/engine.js

@@ -1 +1 @@
-import{createRuntime as e}from"@enkaku/runtime";import{asType as t,createValidator as i}from"@enkaku/schema";import{isSigningIdentity as s,stringifyToken as a,verifyToken as r}from"@enkaku/token";import{KubunDB as n}from"@kubun/db";import{createReadContext as o,createSchema as l}from"@kubun/graphql";import{HLC as u}from"@kubun/hlc";import{getKubunLogger as h}from"@kubun/logger";import{applyMutation as c,convertPatchInput as d,createMutationOperations as p}from"@kubun/mutation";import{clusterToRecord as g,documentMutation as m,GraphModel as y}from"@kubun/protocol";import{GRAPH_STORE as v,getGraphStore as w,graphStoreDefinition as f}from"@kubun/store-graph";import{execute as x,GraphQLError as b,Kind as D,parse as I,subscribe as E}from"graphql";import{EngineEventBus as M}from"./events.js";import{computeMutationHash as G}from"./mutation-hash.js";import{runPolicies as C}from"./policies.js";import{createRegistry as S}from"./registry.js";let k=i(m);function F(){throw Error("Graph mutations require mutateGraph() — the core context does not sign or log writes. Use KubunEngine.mutateGraph() instead.")}function O(){throw Error("Access control mutations are not supported by the engine core — plugin override required.")}function j(){throw Error("Transaction mutations are not supported by the engine core — plugin override required (see plugin-rpc).")}let q={executeCreateMutation:F,executeSetMutation:F,executeUpdateMutation:F,executeRemoveMutation:F,executeSetModelAccessDefaults:O,executeRemoveModelAccessDefaults:O,executeSetDocumentAccessOverride:O,executeRemoveDocumentAccessOverride:O,beginTransaction:j,commitTransaction:j,rollbackTransaction:j};export class KubunEngine{#e=[];#t=[];#i;#s;#a={};#r;#n;#o;#l={};#u=new Map;#h=[];#c;#d;#p={};#g={};constructor(t){this.#i=t.db instanceof n?t.db:new n({adapter:t.db}),this.#i.register(f),this.#n=t.identity,this.#r=new u({nodeID:t.identity.id}),this.#o=t.logger??h("engine"),this.#s=t.eventBus??new M({logger:this.#o.getChild("events")}),this.#d=e(t.runtime),this.#c=S();let i=t.plugins??[],s={engine:this,graph:{execute:e=>this.#m(e),subscribe:e=>this.#y(e),applyVerifiedMutation:e=>this.#v(e),applyVerifiedMutations:e=>this.#w(e)},db:this.#i,runtime:this.#d,identity:this.#n,eventBus:this.#s,hlc:this.#r,getLogger:e=>this.#o.getChild(e)};for(let e of i){let t=e(s);this.#h.push(t),null!=t.api&&this.#c.registerPlugin(t.name,t.api)}this.#c.closeGate();let a=new Set;for(let e of this.#h){if(null!=e.schemaExtension&&this.#u.set(e.name,e.schemaExtension),null!=e.createContextFactory){if(a.has(e.name))throw Error(`Duplicate plugin namespace: ${e.name}`);a.add(e.name),this.#e.push({name:e.name,factory:e.createContextFactory()})}if(null!=e.policies)for(let[t,i]of Object.entries(e.policies)){null==this.#l[t]&&(this.#l[t]={sync:[],async:[]});let e=this.#l[t];null!=i.sync&&(e.sync=[...e.sync??[],...i.sync]),null!=i.async&&(e.async=[...e.async??[],...i.async])}}this.#o.info("engine initialized with {count} plugins",{count:this.#h.length})}get did(){return this.#n.id}get identity(){return this.#n}get eventBus(){return this.#s}async dispose(){await Promise.all(this.#h.filter(e=>null!=e.dispose).map(e=>e.dispose?.()))}getGraphQLSource(e){let{graphID:t}=e,i=e.getViewerDID??(()=>this.#n.id);return{query:async e=>await this.queryGraph({id:t,text:e.text,variables:e.variables,viewerDID:i()??void 0}),mutate:async e=>await this.mutateGraph({id:t,text:e.text,variables:e.variables,viewerDID:i()??void 0}),subscribe:e=>this.#y({graphID:t,text:e.text,variables:e.variables,viewerDID:i()??void 0})}}registerContextFactory(e){this.#t.push(e)}async #f(){return await w(this.#i)}async #x(e){var t;let i,s=e.viewerDID??this.#n.id,a=this.#b(s),r=e.stores??this.#i,n={};for(let{name:e,factory:t}of this.#e)n[e]=t(a,r);for(let e of this.#t)n={...n,...e(a,r)};null!=e.contextExtensions&&(n={...n,...e.contextExtensions});let l=e.graphID;return this.#g[l]??={},i={...o({store:(t={store:await w(r),viewerDID:s,eventBus:this.#s,contextExtensions:Object.keys(n).length>0?n:void 0}).store,viewerDID:t.viewerDID,events:t.eventBus}),...q},null!=t.contextExtensions?{...i,...t.contextExtensions}:i}#b(e){return{viewerDID:e}}async #D(e){return null==this.#a[e]&&(this.#a[e]=this.#f().then(async t=>{let i=await t.getGraph(e);if(null==i)throw this.#o.warn("graph {id} not found",{id:e}),delete this.#a[e],Error(`Graph not found: ${e}`);return this.#o.debug("cached model for graph {id}",{id:e}),{aliases:i.aliases,record:i.record,extensionSDL:i.extension_sdl??void 0,pluginConfig:i.plugin_config??void 0}})),await this.#a[e]}async getGraphQLSchema(e){return null==this.#p[e]&&(this.#p[e]=this.#D(e).then(t=>{let i;if(null!=t.pluginConfig){let e={},s={},a={},r={},n={};for(let[i,o]of Object.entries(t.pluginConfig)){let t=this.#u.get(i);if(null!=t){let i=t(o);if(Object.assign(e,i.resolvers.queryFields??{}),Object.assign(s,i.resolvers.mutationFields??{}),Object.assign(a,i.resolvers.subscriptionFields??{}),Object.assign(n,i.resolvers.nodeResolvers??{}),null!=i.resolvers.typeFields)for(let[e,t]of Object.entries(i.resolvers.typeFields))r[e]={...r[e],...t}}}i={queryFields:e,mutationFields:s,subscriptionFields:a,typeFields:r,nodeResolvers:n}}let s=l({...t,extensionResolvers:i});return this.#o.debug("cached schema for graph {id}",{id:e}),s}).catch(t=>{throw delete this.#p[e],t})),await this.#p[e]}async #I(e,t){let i=t??I(e.text);if(null==i.definitions[0])throw Error("Missing GraphQL document definition");return{schema:await this.getGraphQLSchema(e.graphID),document:i,contextValue:await this.#x(e),variableValues:e.variables}}#E(e){let t=e.definitions[0];return null!=t&&t.kind===D.OPERATION_DEFINITION?t.operation:"query"}async #M(e,t){let i=await C(this.#l,e,{viewerDID:t});return"issues"in i&&null!=i.issues&&i.issues.length>0?{errors:i.issues.map(e=>new b(e.message,{extensions:null!=e.path?{path:e.path}:void 0}))}:null}async listGraphs(){let e=await this.#f();return{graphs:(await e.listGraphs()).map(e=>({id:e.id,name:e.name}))}}async loadGraph(e){let t=await this.#D(e.id);return{aliases:t.aliases,record:t.record,extensionSDL:t.extensionSDL}}async deployGraph(e){let t,i,s={};for(let t of e.clusters)Object.assign(s,g(t));let a=y.fromClusters({clusters:s});if(null!=e.plugins){i=e.plugins;let s=[];for(let[e,t]of Object.entries(i)){let i=this.#u.get(e);if(null==i)throw Error(`Plugin "${e}" not found or does not provide schema extensions`);let a=i(t);s.push(a.sdl)}s.length>0&&(t=s.join("\n"))}let r=await this.#f(),n=await r.createGraph({id:e.id??this.#d.getRandomID(),name:e.name,record:a.record,extensionSDL:t,pluginConfig:i}),o=a.toJSON();return this.#a[n]=Promise.resolve({...o,extensionSDL:t,pluginConfig:i}),delete this.#p[n],delete this.#g[n],this.#o.info("deployed graph {id}",{id:n}),{id:n,...o}}async #G(e){for(let{document:t,mutation:i,authorDID:s}of e){let e="set"===i.typ?"create":"update",a={type:e,document:t,previous:{data:null},getCursor:()=>t.id};await this.#s.emit("document:saved",a),"create"===e?await this.#s.emit("engine:document:created",{documentID:t.id,modelID:t.model,viewerDID:s}):await this.#s.emit("engine:document:updated",{documentID:t.id,modelID:t.model,viewerDID:s}),await this.#s.emit("engine:mutation:applied",{type:e,documentID:t.id,viewerDID:s})}}async #v(e,i){let{token:s,graphID:a}=e,n=t(k,(await r(s)).payload);this.#g[a]??={};let o=null!=i?await w(i):await this.#f(),l={store:o,validators:this.#g[a],hlc:this.#r},u=await c(l,n),h=G(s),d=n.iss;await o.insertMutationLogEntry({mutation_hash:h,model_id:u.model,document_id:u.id,author_did:d,hlc:n.hlc,mutation_jwt:s,status:"applied"});let p={document:u,mutation:n,authorDID:d,hash:h};return null==i&&await this.#G([p]),p}async #w(e){let{tokens:i,graphID:s}=e;this.#g[s]??={};let a=await Promise.all(i.map(async e=>{let i=t(k,(await r(e)).payload);return{token:e,mutation:i}})),n=[];return await this.#i.withTransaction(async e=>{let t=await e.getStore(v);for(let{token:e,mutation:i}of a){let a={store:t,validators:this.#g[s],hlc:this.#r},r=await c(a,i),o=G(e);await t.insertMutationLogEntry({mutation_hash:o,model_id:r.model,document_id:r.id,author_did:i.iss,hlc:i.hlc,mutation_jwt:e,status:"applied"}),n.push({document:r,mutation:i,authorDID:i.iss,hash:o})}}),await this.#G(n),{results:n}}async #m(e){let t=I(e.text),i=this.#E(t),s=await this.#M(i,e.viewerDID??this.#n.id);if(null!=s)return s;let a=await this.#I(e,t);return await x(a)}async #y(e){let t=await this.#I(e);return await E(t)}async queryGraph(e){let t=I(e.text);if("mutation"===this.#E(t))throw Error("queryGraph() does not accept mutation operations. Use mutateGraph() instead.");return await this.#m({graphID:e.id,text:e.text,variables:e.variables??{},viewerDID:e.viewerDID})}async mutateGraph(e){if(!s(this.#n))throw Error("mutateGraph requires a SigningIdentity");let t=this.#n,i=e.id,r=[],n=await this.#i.withTransaction(async s=>{let n=async e=>{let n=a(await t.signToken(e)),o=await this.#v({token:n,graphID:i},s);return r.push(o),o.document},o=p({issuer:t.id,hlc:this.#r,getRandomValues:this.#d.getRandomValues,processSetMutation:e=>n(e),processChangeMutation:e=>n(e)});return await this.#m({graphID:i,text:e.text,variables:e.variables??{},viewerDID:e.viewerDID??t.id,stores:s,contextExtensions:{executeCreateMutation:async e=>await o.createDocument({modelID:e.modelID,data:e.data}),executeSetMutation:async e=>await o.setDocument({modelID:e.modelID,unique:e.unique,data:e.data}),executeUpdateMutation:async e=>await o.updateDocument({docID:e.input.id,patch:d(e.input.patch)}),executeRemoveMutation:async e=>{await o.removeDocument({docID:e.id})}}})});return await this.#G(r),n}async subscribeToGraph(e){return await this.#y({graphID:e.id,text:e.text,variables:e.variables??{},viewerDID:e.viewerDID})}async getAPI(e){return await this.#c.getAPI(e)}}
+import{createRuntime as e}from"@enkaku/runtime";import{asType as t,createValidator as i}from"@enkaku/schema";import{isSigningIdentity as s,stringifyToken as a,verifyToken as n}from"@enkaku/token";import{KubunDB as r}from"@kubun/db";import{createReadContext as o,createSchema as l}from"@kubun/graphql";import{HLC as u}from"@kubun/hlc";import{DocumentID as d}from"@kubun/id";import{getKubunLogger as c}from"@kubun/logger";import{applyMutation as h,convertPatchInput as p,createMutationOperations as m}from"@kubun/mutation";import{clusterToRecord as g,documentMutation as v,GraphModel as f}from"@kubun/protocol";import{GRAPH_STORE as w,getGraphStore as y,graphStoreDefinition as D}from"@kubun/store-graph";import{execute as x,GraphQLError as b,Kind as I,parse as E,subscribe as M}from"graphql";import{EngineEventBus as G}from"./events.js";import{computeMutationHash as R}from"./mutation-hash.js";import{runPolicies as C}from"./policies.js";import{createRegistry as S}from"./registry.js";let k=i(v);function F(){throw Error("Graph mutations require mutateGraph() — the core context does not sign or log writes. Use KubunEngine.mutateGraph() instead.")}function O(){throw Error("Access control mutations are not supported by the engine core — plugin override required.")}function j(){throw Error("Transaction mutations are not supported by the engine core — plugin override required (see plugin-rpc).")}let q={executeCreateMutation:F,executeSetMutation:F,executeUpdateMutation:F,executeRemoveMutation:F,executeSetModelAccessDefaults:O,executeRemoveModelAccessDefaults:O,executeSetDocumentAccessOverride:O,executeRemoveDocumentAccessOverride:O,beginTransaction:j,commitTransaction:j,rollbackTransaction:j};export class KubunEngine{#e=[];#t=[];#i;#s;#a={};#n;#r;#o;#l={};#u=new Map;#d=[];#c;#h;#p={};#m={};constructor(t){this.#i=t.db instanceof r?t.db:new r({adapter:t.db}),this.#i.register(D),this.#r=t.identity,this.#n=new u({nodeID:t.identity.id}),this.#o=t.logger??c("engine"),this.#s=t.eventBus??new G({logger:this.#o.getChild("events")}),this.#h=e(t.runtime),this.#c=S();let i=t.plugins??[],s={engine:this,graph:{execute:e=>this.#g(e),subscribe:e=>this.#v(e),applyVerifiedMutation:e=>this.#f(e),applyVerifiedMutations:e=>this.#w(e)},db:this.#i,runtime:this.#h,identity:this.#r,eventBus:this.#s,hlc:this.#n,getLogger:e=>this.#o.getChild(e)};for(let e of i){let t=e(s);this.#d.push(t),null!=t.api&&this.#c.registerPlugin(t.name,t.api)}this.#c.closeGate();let a=new Set;for(let e of this.#d){if(null!=e.schemaExtension&&this.#u.set(e.name,e.schemaExtension),null!=e.createContextFactory){if(a.has(e.name))throw Error(`Duplicate plugin namespace: ${e.name}`);a.add(e.name),this.#e.push({name:e.name,factory:e.createContextFactory()})}if(null!=e.policies)for(let[t,i]of Object.entries(e.policies)){null==this.#l[t]&&(this.#l[t]={sync:[],async:[]});let e=this.#l[t];null!=i.sync&&(e.sync=[...e.sync??[],...i.sync]),null!=i.async&&(e.async=[...e.async??[],...i.async])}}this.#o.info("engine initialized with {count} plugin(s)",{count:this.#d.length})}get did(){return this.#r.id}get identity(){return this.#r}get eventBus(){return this.#s}async dispose(){await Promise.all(this.#d.filter(e=>null!=e.dispose).map(e=>e.dispose?.()))}getGraphQLSource(e){let{graphID:t}=e,i=e.getViewerDID??(()=>this.#r.id);return{query:async e=>await this.queryGraph({id:t,text:e.text,variables:e.variables,viewerDID:i()??void 0}),mutate:async e=>await this.mutateGraph({id:t,text:e.text,variables:e.variables,viewerDID:i()??void 0}),subscribe:e=>this.#v({graphID:t,text:e.text,variables:e.variables,viewerDID:i()??void 0})}}registerContextFactory(e){this.#t.push(e)}async #y(){return await y(this.#i)}async #D(e){var t;let i,s=e.viewerDID??this.#r.id,a=this.#x(s),n=e.stores??this.#i,r={};for(let{name:e,factory:t}of this.#e)r[e]=t(a,n);for(let e of this.#t)r={...r,...e(a,n)};return null!=e.contextExtensions&&(r={...r,...e.contextExtensions}),i={...o({store:(t={store:await y(n),viewerDID:s,eventBus:this.#s,contextExtensions:Object.keys(r).length>0?r:void 0}).store,viewerDID:t.viewerDID,events:t.eventBus}),...q},null!=t.contextExtensions?{...i,...t.contextExtensions}:i}#x(e){return{viewerDID:e}}async #b(e){return null==this.#a[e]&&(this.#a[e]=this.#y().then(async t=>{let i=await t.getGraph(e);if(null==i)throw this.#o.warn("graph {id} not found",{id:e}),delete this.#a[e],Error(`Graph not found: ${e}`);return this.#o.debug("cached model for graph {id}",{id:e}),{aliases:i.aliases,record:i.record,extensionSDL:i.extension_sdl??void 0,pluginConfig:i.plugin_config??void 0}})),await this.#a[e]}async getGraphQLSchema(e){return null==this.#p[e]&&(this.#p[e]=this.#b(e).then(t=>{let i;if(null!=t.pluginConfig){let e={},s={},a={},n={},r={};for(let[i,o]of Object.entries(t.pluginConfig)){let t=this.#u.get(i);if(null!=t){let i=t(o);if(Object.assign(e,i.resolvers.queryFields??{}),Object.assign(s,i.resolvers.mutationFields??{}),Object.assign(a,i.resolvers.subscriptionFields??{}),Object.assign(r,i.resolvers.nodeResolvers??{}),null!=i.resolvers.typeFields)for(let[e,t]of Object.entries(i.resolvers.typeFields))n[e]={...n[e],...t}}}i={queryFields:e,mutationFields:s,subscriptionFields:a,typeFields:n,nodeResolvers:r}}let s=l({...t,extensionResolvers:i});return this.#o.debug("cached schema for graph {id}",{id:e}),s}).catch(t=>{throw delete this.#p[e],t})),await this.#p[e]}async #I(e,t){let i=t??E(e.text);if(null==i.definitions[0])throw Error("Missing GraphQL document definition");return{schema:await this.getGraphQLSchema(e.graphID),document:i,contextValue:await this.#D(e),variableValues:e.variables}}#E(e){let t=e.definitions[0];return null!=t&&t.kind===I.OPERATION_DEFINITION?t.operation:"query"}async #M(e,t){let i=await C(this.#l,e,{viewerDID:t});return"issues"in i&&null!=i.issues&&i.issues.length>0?{errors:i.issues.map(e=>new b(e.message,{extensions:null!=e.path?{path:e.path}:void 0}))}:null}async listGraphs(){let e=await this.#y();return{graphs:(await e.listGraphs()).map(e=>({id:e.id,name:e.name}))}}async loadGraph(e){let t=await this.#b(e.id);return{aliases:t.aliases,record:t.record,extensionSDL:t.extensionSDL}}async deployGraph(e){let t,i,s={};for(let t of e.clusters)Object.assign(s,g(t));let a=f.fromClusters({clusters:s});if(null!=e.plugins){i=e.plugins;let s=[];for(let[e,t]of Object.entries(i)){let i=this.#u.get(e);if(null==i)throw Error(`Plugin "${e}" not found or does not provide schema extensions`);let a=i(t);s.push(a.sdl)}s.length>0&&(t=s.join("\n"))}let n=await this.#y(),r=await n.createGraph({id:e.id??this.#h.getRandomID(),name:e.name,record:a.record,extensionSDL:t,pluginConfig:i}),o=a.toJSON();return this.#a[r]=Promise.resolve({...o,extensionSDL:t,pluginConfig:i}),delete this.#p[r],this.#o.info("deployed graph {id}",{id:r}),{id:r,...o}}async #G(e,t){let i="local"===t?"engine:mutation:authored":"engine:mutation:received",s=e.filter(e=>!e.dropped),a=new Map,n=[];for(let e of s){let t=function(e){if(null==e.document)throw Error("Cannot classify a dropped mutation result");return null==e.previousDoc?"create":null===e.document.data?"remove":"update"}(e);n.push(t);let i=e.document.id,s=a.get(i);null==s&&(s={docID:i,hasCreate:!1,hasUpdate:!1,hasRemove:!1,lastUpdateResult:null,lastRemoveResult:null,lastResult:e},a.set(i,s)),s.lastResult=e,"create"===t?s.hasCreate=!0:"update"===t?(s.hasUpdate=!0,s.lastUpdateResult=e):(s.hasRemove=!0,s.lastRemoveResult=e)}for(let e of a.values()){if(e.hasCreate&&e.hasRemove)continue;let t=e.lastResult.document;if(e.hasRemove){let t=e.lastRemoveResult??e.lastResult,i=t.document;await this.#s.emit("engine:document:removed",{documentID:i.id,viewerDID:t.authorDID});continue}if(e.hasCreate&&await this.#s.emit("engine:document:created",{documentID:t.id,modelID:t.model,viewerDID:e.lastResult.authorDID}),e.hasUpdate){let t=e.lastUpdateResult??e.lastResult,i=t.document;await this.#s.emit("engine:document:updated",{documentID:i.id,modelID:i.model,viewerDID:t.authorDID})}let i={type:e.hasCreate&&!e.hasUpdate?"create":"update",document:t,previous:{data:e.lastResult.previousDoc?.data??null},getCursor:()=>t.id};await this.#s.emit("document:saved",i)}for(let e=0;e<s.length;e++){let t=s[e],a=t.document;await this.#s.emit(i,{type:n[e],documentID:a.id,viewerDID:t.authorDID,mutationJWT:t.token,version:t.mutation.hlc,modelID:a.model})}}async #f(e,i){let{token:s,accessGate:a}=e,r=e.origin??"local",o=t(k,(await n(s)).payload),l=null!=i?await y(i):await this.#y(),u={store:l,validators:this.#m,hlc:this.#n,postStateGate:a},c=await l.getDocument(d.fromString(o.sub)),p=await h(u,o),m=R(s),g=o.iss;if(null==p)return{document:null,previousDoc:c,mutation:o,authorDID:g,hash:m,token:s,dropped:!0};await l.insertMutationLogEntry({mutation_hash:m,model_id:p.model,document_id:p.id,author_did:g,hlc:o.hlc,mutation_jwt:s,status:"applied"});let v={document:p,previousDoc:c,mutation:o,authorDID:g,hash:m,token:s,dropped:!1};return null==i&&await this.#G([v],r),v}async #w(e){let{tokens:i,accessGate:s}=e,a=e.origin??"local",r=await Promise.all(i.map(async e=>{let i=t(k,(await n(e)).payload);return{token:e,mutation:i}})),o=[];return await this.#i.withTransaction(async e=>{let t=await e.getStore(w);for(let{token:e,mutation:i}of r){let a={store:t,validators:this.#m,hlc:this.#n,postStateGate:s},n=await t.getDocument(d.fromString(i.sub)),r=await h(a,i),l=R(e);if(null==r){o.push({document:null,previousDoc:n,mutation:i,authorDID:i.iss,hash:l,token:e,dropped:!0});continue}await t.insertMutationLogEntry({mutation_hash:l,model_id:r.model,document_id:r.id,author_did:i.iss,hlc:i.hlc,mutation_jwt:e,status:"applied"}),o.push({document:r,previousDoc:n,mutation:i,authorDID:i.iss,hash:l,token:e,dropped:!1})}}),await this.#G(o,a),{results:o,dropped:o.filter(e=>e.dropped).length}}async #g(e){let t=E(e.text),i=this.#E(t),s=await this.#M(i,e.viewerDID??this.#r.id);if(null!=s)return s;let a=await this.#I(e,t);return await x(a)}async #v(e){let t=await this.#I(e);return await M(t)}async queryGraph(e){let t=E(e.text);if("mutation"===this.#E(t))throw Error("queryGraph() does not accept mutation operations. Use mutateGraph() instead.");return await this.#g({graphID:e.id,text:e.text,variables:e.variables??{},viewerDID:e.viewerDID})}async mutateGraph(e){if(!s(this.#r))throw Error("mutateGraph requires a SigningIdentity");let t=this.#r,i=e.id,n=[],r=await this.#i.withTransaction(async s=>{let r=async e=>{let i=a(await t.signToken(e)),r=await this.#f({token:i},s);if(n.push(r),null==r.document)throw Error("Unexpected dropped mutation in mutateGraph (no gate configured)");return r.document},o=m({issuer:t.id,hlc:this.#n,getRandomValues:this.#h.getRandomValues,processSetMutation:e=>r(e),processChangeMutation:e=>r(e)});return await this.#g({graphID:i,text:e.text,variables:e.variables??{},viewerDID:e.viewerDID??t.id,stores:s,contextExtensions:{executeCreateMutation:async e=>await o.createDocument({modelID:e.modelID,data:e.data}),executeSetMutation:async e=>await o.setDocument({modelID:e.modelID,unique:e.unique,data:e.data}),executeUpdateMutation:async e=>await o.updateDocument({docID:e.input.id,patch:p(e.input.patch)}),executeRemoveMutation:async e=>{await o.removeDocument({docID:e.id})}}})});return await this.#G(n,"local"),r}async subscribeToGraph(e){return await this.#v({graphID:e.id,text:e.text,variables:e.variables??{},viewerDID:e.viewerDID})}async getAPI(e){return await this.#c.getAPI(e)}}

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 export type { AccessChecker, AccessControlDB, AccessLevel, AccessPermissions, AccessRule, DefaultAccessLevel, } from './access-control.js';
-export { createAccessChecker, parseDocumentAccessPermissions, validateDIDs, } from './access-control.js';
-export type { ApplyVerifiedMutationParams, ApplyVerifiedMutationResult, ApplyVerifiedMutationsParams, ApplyVerifiedMutationsResult, ContextFactory, EngineParams, ExecuteParams, ExecutionContext, } from './engine.js';
+export { createAccessChecker, parseDocumentAccessPermissions, resolveAccessRule, validateDIDs, validateID, validateIDs, } from './access-control.js';
+export type { AccessGate, ApplyVerifiedMutationParams, ApplyVerifiedMutationResult, ApplyVerifiedMutationsParams, ApplyVerifiedMutationsResult, ContextFactory, EngineParams, ExecuteParams, ExecutionContext, } from './engine.js';
 export { KubunEngine } from './engine.js';
 export type { EngineEvents } from './engine-events.js';
 export { EngineEventBus } from './events.js';

package/lib/index.js

@@ -1 +1 @@
-export{createAccessChecker,parseDocumentAccessPermissions,validateDIDs}from"./access-control.js";export{KubunEngine}from"./engine.js";export{EngineEventBus}from"./events.js";export{computeMutationHash}from"./mutation-hash.js";export{runPolicies}from"./policies.js";export{createRegistry}from"./registry.js";
+export{createAccessChecker,parseDocumentAccessPermissions,resolveAccessRule,validateDIDs,validateID,validateIDs}from"./access-control.js";export{KubunEngine}from"./engine.js";export{EngineEventBus}from"./events.js";export{computeMutationHash}from"./mutation-hash.js";export{runPolicies}from"./policies.js";export{createRegistry}from"./registry.js";

package/lib/plugin.d.ts

@@ -6,6 +6,7 @@ import type { HLC } from '@kubun/hlc';
 import type { Logger } from '@kubun/logger';
 import type { ExecutionResult } from 'graphql';
 import type { ApplyVerifiedMutationParams, ApplyVerifiedMutationResult, ApplyVerifiedMutationsParams, ApplyVerifiedMutationsResult, ContextFactory, ExecuteParams } from './engine.js';
+import type { EngineEvents } from './engine-events.js';
 import type { EngineEventBus } from './events.js';
 import type { Engine } from './executor.js';
 import type { PolicyGateMap } from './policies.js';
@@ -35,7 +36,7 @@ export type PluginFactoryParams = {
     db: KubunDB;
     runtime: Runtime;
     identity: Identity;
-    eventBus: EngineEventBus;
+    eventBus: EngineEventBus<EngineEvents>;
     hlc: HLC;
     getLogger: (name: string) => Logger;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/engine",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -15,29 +15,29 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@enkaku/async": "^0.14.1",
-    "@enkaku/capability": "^0.14.0",
-    "@enkaku/event": "^0.14.1",
-    "@enkaku/runtime": "^0.14.0",
-    "@enkaku/schema": "^0.14.0",
-    "@enkaku/token": "0.14.1",
+    "@enkaku/async": "^0.15.0",
+    "@enkaku/capability": "^0.15.0",
+    "@enkaku/event": "^0.15.0",
+    "@enkaku/runtime": "^0.15.0",
+    "@enkaku/schema": "^0.15.0",
+    "@enkaku/token": "^0.15.0",
     "@noble/hashes": "^2.2.0",
     "graphql": "^16.13.2",
-    "@kubun/hlc": "^0.8.0",
-    "@kubun/db": "^0.8.1",
-    "@kubun/db-adapter": "^0.8.1",
-    "@kubun/graphql": "^0.8.2",
-    "@kubun/logger": "^0.8.0",
-    "@kubun/mutation": "^0.8.1",
-    "@kubun/protocol": "^0.8.1",
-    "@kubun/store-graph": "^0.8.1"
+    "@kubun/db": "^0.9.0",
+    "@kubun/graphql": "^0.9.0",
+    "@kubun/db-adapter": "^0.9.0",
+    "@kubun/protocol": "^0.9.0",
+    "@kubun/logger": "^0.9.0",
+    "@kubun/hlc": "^0.9.0",
+    "@kubun/mutation": "^0.9.0",
+    "@kubun/store-graph": "^0.9.0"
   },
   "devDependencies": {
     "@testcontainers/postgresql": "^11.14.0",
-    "@kubun/db-postgres": "^0.8.1",
-    "@kubun/id": "^0.8.0",
-    "@kubun/store-p2p": "^0.8.0",
-    "@kubun/test-utils": "^0.8.0"
+    "@kubun/id": "^0.9.0",
+    "@kubun/db-postgres": "^0.9.0",
+    "@kubun/store-p2p": "^0.9.0",
+    "@kubun/test-utils": "^0.9.0"
   },
   "scripts": {
     "build:clean": "del lib",