@kubun/plugin-rpc 0.8.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/lib/handlers.d.ts

@@ -0,0 +1,18 @@
+import type { GetRandomValues } from '@enkaku/runtime';
+import type { ProcedureHandlers } from '@enkaku/server';
+import type { SigningIdentity } from '@enkaku/token';
+import type { Engine, GraphInternals } from '@kubun/engine';
+import type { HLC } from '@kubun/hlc';
+import type { GraphProtocol } from '@kubun/protocol';
+import type { TransactionManager } from './transaction-manager.js';
+export type CreateHandlersParams = {
+    allowDelegatedMutations: boolean;
+    defaultDID: string;
+    engine: Engine;
+    getRandomValues: GetRandomValues;
+    graph: GraphInternals;
+    hlc: HLC;
+    signingIdentity: SigningIdentity | null;
+    transactionManager: TransactionManager;
+};
+export declare function createGraphHandlers(params: CreateHandlersParams): ProcedureHandlers<GraphProtocol>;

package/lib/handlers.js

@@ -0,0 +1 @@
+import{consume as a}from"@enkaku/generator";import{stringifyToken as t}from"@enkaku/token";import{DocumentID as e}from"@kubun/id";import{convertPatchInput as r,createMutationOperations as n}from"@kubun/mutation";function i(a){let t={data:a.data};return null!=a.errors&&(t.errors=a.errors.map(a=>a.toJSON())),null!=a.extensions&&(t.extensions=a.extensions),t}function o(a,t){let e=a.message?.payload,r=e?.sub??e?.iss??t;return{id:a.param.id,text:a.param.text,variables:a.param.variables??{},viewerDID:r}}export function createGraphHandlers(s){let{allowDelegatedMutations:u,engine:l,getRandomValues:p,graph:c,defaultDID:m,hlc:d,signingIdentity:g,transactionManager:h}=s;return{"graph/deploy":async a=>await l.deployGraph({clusters:a.param.clusters,id:a.param.id,name:a.param.name,plugins:a.param.plugins}),"graph/list":async()=>await l.listGraphs(),"graph/load":async a=>await l.loadGraph({id:a.param.id}),"graph/mutate":async a=>{let{viewerDID:s}=o(a,m);if(null!=a.param.mutations){let t=a.param.mutations,e=Object.keys(t),r=e.map(a=>t[a]),{results:n}=await c.applyVerifiedMutations({tokens:r,graphID:a.param.id}),o={};for(let a=0;a<e.length;a++)o[e[a]]=n[a].document;return i(await c.execute({graphID:a.param.id,text:a.param.text,variables:a.param.variables??{},viewerDID:s,contextExtensions:{executeCreateMutation:async a=>o[a.info.path.key],executeSetMutation:async a=>o[a.info.path.key],executeUpdateMutation:async a=>o[a.info.path.key],executeRemoveMutation:async()=>{}}}))}if(!u)throw Error("Delegated mutations not enabled. Set allowDelegatedMutations: true or provide pre-signed mutations.");if(null==g)throw Error("Delegated mutations require a SigningIdentity on the engine");let y=a.param.transactionID??null;if(null==y)return i(await l.mutateGraph({id:a.param.id,text:a.param.text,variables:a.param.variables??{},viewerDID:s}));let w=async a=>{let r=t(await g.signToken(a)),n=h.getTransaction(y);if(null==n)throw Error(`Transaction not found or expired: ${y}`);let i=e.fromString(a.sub),o="change"===a.typ,s={id:a.sub,model:i.model.toString(),owner:a.aud??a.iss,data:o?null:a.data,createdAt:new Date,updatedAt:o?new Date:null};return n.mutations.push({mutation:a,jwt:r,authorDID:a.iss,documentID:s.id,result:s}),s},D=n({issuer:g.id,hlc:d,getRandomValues:p,processSetMutation:async a=>await w(a),processChangeMutation:async a=>await w(a)});return i(await c.execute({graphID:a.param.id,text:a.param.text,variables:a.param.variables??{},viewerDID:s,contextExtensions:{executeCreateMutation:async a=>await D.createDocument({modelID:a.modelID,data:a.data}),executeSetMutation:async a=>await D.setDocument({modelID:a.modelID,unique:a.unique,data:a.data}),executeUpdateMutation:async a=>await D.updateDocument({docID:a.input.id,patch:r(a.input.patch)}),executeRemoveMutation:async a=>{await D.removeDocument({docID:a.id})}}}))},"graph/query":async a=>i(await l.queryGraph(o(a,m))),"graph/subscribe":async t=>{let e=await l.subscribeToGraph(o(t,m));if(t.signal.aborted)return null;if("errors"in e)return i(e);let r=t.writable.getWriter();try{await a(e,async a=>{await r.write(i(a))},t.signal)}catch(a){if(!t.signal.aborted)throw a}finally{try{await r.close()}catch{}}return null},"graph/beginTransaction":async a=>{let t=a.message?.payload,e=t?.iss??m;return await l.loadGraph({id:a.param.id}),{transactionID:h.beginTransaction(e,a.param.id).id}},"graph/commitTransaction":async a=>{let t=h.getTransaction(a.param.transactionID);if(null==t)throw Error(`Transaction not found or expired: ${a.param.transactionID}`);if(t.mutations.length>0){let a=t.mutations.map(a=>a.jwt);await c.applyVerifiedMutations({tokens:a,graphID:t.graphID})}return h.markCommitted(a.param.transactionID),{success:!0}},"graph/rollbackTransaction":async a=>(h.rollbackTransaction(a.param.transactionID),{success:!0})}}

package/lib/index.d.ts

@@ -0,0 +1,35 @@
+import type { ServerTransportOf } from '@enkaku/protocol';
+import { type Server } from '@enkaku/server';
+import type { KubunPlugin, PluginFactoryParams } from '@kubun/engine';
+import type { GraphProtocol } from '@kubun/protocol';
+import { type TransactionManagerOptions } from './transaction-manager.js';
+export type { TransactionManagerOptions };
+export type ServerTransport = ServerTransportOf<GraphProtocol>;
+/**
+ * Options for the RPC plugin.
+ */
+export type RPCPluginOptions = {
+    /** Enkaku protocol access control. Default: true. */
+    accessControl?: false | true | Record<string, boolean | Array<string>>;
+    /** Allow the engine to sign mutations on behalf of clients (delegated mode). Default: false. */
+    allowDelegatedMutations?: boolean;
+    /** Configuration for the transaction manager. */
+    transactionConfig?: TransactionManagerOptions;
+};
+/**
+ * API provided by the RPC plugin.
+ */
+export type RPCPluginAPI = {
+    serve: (transport: ServerTransport, signal?: AbortSignal) => Server<GraphProtocol>;
+};
+/**
+ * Creates the RPC plugin.
+ *
+ * The RPC plugin exposes the engine over transport. It optionally depends
+ * on the HTTP plugin for registering a /graphql route. Even without HTTP,
+ * the RPC plugin provides status tracking and a GraphQL query for server status.
+ *
+ * Creates Enkaku protocol handlers backed by the engine's Core interface
+ * (queryGraph/mutateGraph/subscribeToGraph via GraphInternals). Clients connect via `serve()` on any transport.
+ */
+export declare function createRPCPlugin(options?: RPCPluginOptions): (params: PluginFactoryParams) => KubunPlugin;

package/lib/index.js

@@ -0,0 +1 @@
+import{serve as e}from"@enkaku/server";import{isSigningIdentity as t}from"@enkaku/token";import{createGraphHandlers as n}from"./handlers.js";import{TransactionManager as i}from"./transaction-manager.js";export function createRPCPlugin(r){return o=>{let a=[],s=t(o.identity)?o.identity:null,g=new i({getRandomID:o.runtime.getRandomID,...r?.transactionConfig}),d=n({allowDelegatedMutations:r?.allowDelegatedMutations??!1,defaultDID:o.identity.id,engine:o.engine,getRandomValues:o.runtime.getRandomValues,graph:o.graph,signingIdentity:s,hlc:o.hlc,transactionManager:g});return{name:"rpc",api:{serve:(t,n)=>{let i=r?.accessControl??!0,s=e({accessControl:i,getRandomID:o.runtime.getRandomID,handlers:d,identity:!1!==i?o.identity:void 0,logger:o.getLogger("rpc-server"),signal:n,transport:t});return a.push(s),s}},dispose:async()=>{for(let e of(g.dispose(),a))await e.dispose()}}}}

package/lib/transaction-manager.d.ts

@@ -0,0 +1,32 @@
+import type { DocumentMutation, DocumentNode } from '@kubun/protocol';
+export type BufferedMutation = {
+    mutation: DocumentMutation;
+    jwt: string;
+    authorDID: string;
+    documentID: string;
+    result: DocumentNode;
+};
+export type TransactionStatus = 'open' | 'committing' | 'committed' | 'rolledBack';
+export type TransactionContext = {
+    id: string;
+    callerDID: string;
+    graphID: string;
+    mutations: Array<BufferedMutation>;
+    createdAt: number;
+    status: TransactionStatus;
+};
+export type TransactionManagerOptions = {
+    getRandomID: () => string;
+    perDIDLimit?: number;
+    globalLimit?: number;
+    timeoutMS?: number;
+};
+export declare class TransactionManager {
+    #private;
+    constructor(options: TransactionManagerOptions);
+    beginTransaction(callerDID: string, graphID: string): TransactionContext;
+    getTransaction(transactionID: string): TransactionContext | null;
+    rollbackTransaction(transactionID: string): void;
+    markCommitted(transactionID: string): void;
+    dispose(): void;
+}

package/lib/transaction-manager.js

@@ -0,0 +1 @@
+export class TransactionManager{#t;#e;#a;#i;#s=new Map;#n=null;constructor(t){this.#t=t.getRandomID,this.#e=t.globalLimit??20,this.#a=t.perDIDLimit??3,this.#i=t.timeoutMS??3e4,this.#o()}beginTransaction(t,e){if(this.#s.size>=this.#e)throw Error(`Global transaction limit reached (${this.#e}). Cannot create new transaction.`);let a=0;for(let e of this.#s.values())e.callerDID===t&&a++;if(a>=this.#a)throw Error(`Per-DID transaction limit reached (${this.#a}) for ${t}. Cannot create new transaction.`);let i={id:this.#t(),callerDID:t,graphID:e,mutations:[],createdAt:Date.now(),status:"open"};return this.#s.set(i.id,i),i}getTransaction(t){let e=this.#s.get(t);return null==e?null:Date.now()-e.createdAt>this.#i?(e.status="rolledBack",this.#s.delete(t),null):e}rollbackTransaction(t){let e=this.#s.get(t);if(null==e)throw Error(`Transaction not found: ${t}`);if("committed"===e.status)throw Error(`Cannot rollback committed transaction: ${t}`);e.status="rolledBack",this.#s.delete(t)}markCommitted(t){let e=this.#s.get(t);null!=e&&(e.status="committed",this.#s.delete(t))}dispose(){for(let[t,e]of this.#s)("open"===e.status||"committing"===e.status)&&(e.status="rolledBack");this.#s.clear(),null!=this.#n&&(clearInterval(this.#n),this.#n=null)}#o(){this.#n=setInterval(()=>{let t=Date.now();for(let[e,a]of this.#s)t-a.createdAt>this.#i&&(a.status="rolledBack",this.#s.delete(e))},Math.min(this.#i,1e4));let t=this.#n;"object"==typeof t&&"function"==typeof t.unref&&t.unref()}}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@kubun/plugin-rpc",
+  "version": "0.8.0",
+  "license": "see LICENSE.md",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@enkaku/generator": "^0.14.0",
+    "@enkaku/runtime": "^0.14.0",
+    "@enkaku/server": "^0.14.3",
+    "@enkaku/token": "0.14.1",
+    "graphql": "^16.13.2",
+    "@kubun/db": "^0.8.0",
+    "@kubun/engine": "^0.8.0",
+    "@kubun/graphql": "^0.8.0",
+    "@kubun/mutation": "^0.8.0",
+    "@kubun/protocol": "^0.8.0",
+    "@kubun/hlc": "^0.8.0"
+  },
+  "devDependencies": {
+    "@enkaku/transport": "0.14.0",
+    "@kubun/id": "^0.8.0",
+    "@kubun/client": "^0.8.0",
+    "@kubun/test-utils": "^0.8.0"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "test:types": "tsc --noEmit -p tsconfig.test.json",
+    "test:unit": "vitest run",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}