@kubun/mutation 0.7.0 → 0.8.0

package/lib/apply.d.ts

@@ -1,7 +1,7 @@
 import { type Validator } from '@enkaku/schema';
 import type { WritableDB } from '@kubun/db';
+import { HLC } from '@kubun/hlc';
 import type { ChangeDocumentMutation, DocumentData, DocumentMutation, DocumentNode, SetDocumentMutation } from '@kubun/protocol';
-import { HLC } from './hlc.js';
 export type DocumentValidator = Validator<DocumentData>;
 export type ValidatorsRecord = Record<string, Promise<DocumentValidator>>;
 export type AccessChecker = (doc: {
@@ -18,6 +18,7 @@ export type MutationContext = {
     maxDriftMS?: number;
 };
 export declare function getDocumentValidator(ctx: MutationContext, id: string): Promise<DocumentValidator>;
+export declare function getTopLevelField(path: string): string;
 export declare function applyChangeMutation(ctx: MutationContext, mutation: ChangeDocumentMutation): Promise<DocumentNode>;
 export declare function applySetMutation(ctx: MutationContext, mutation: SetDocumentMutation): Promise<DocumentNode>;
 export declare function applyMutation(ctx: MutationContext, mutation: DocumentMutation): Promise<DocumentNode>;

package/lib/apply.js

@@ -1 +1 @@
-import{fromB64 as t}from"@enkaku/codec";import{asType as e,createValidator as a}from"@enkaku/schema";import{DocumentID as r}from"@kubun/id";import{HLC as i}from"./hlc.js";export function getDocumentValidator(t,e){return null==t.validators[e]&&(t.validators[e]=t.db.getDocumentModel(e).then(t=>a({...t.schema,$id:e}))),t.validators[e]}function n(t,e,a){let r=i.parse(t),n=Date.now(),o=r.wallTime-n;if(o>e)throw Error(`HLC timestamp too far in the future: ${o}ms drift exceeds ${e}ms limit`);a&&a.receive(r)}export async function applyChangeMutation(t,a){let i=r.fromString(a.sub),o=i.toString(),l=await t.db.getDocument(i);if(null==l)throw Error(`Document not found: ${o}`);if(a.iss!==l.owner)throw Error("Invalid mutation issuer");if(t.accessChecker&&!await t.accessChecker(l,"write"))throw Error(`Access denied: cannot write document ${o}`);null!=t.maxDriftMS&&n(a.hlc,t.maxDriftMS,t.hlc);let c=i.model.toString(),u=await t.db.getFieldHLCs(o)??{};if(1===a.patch.length&&"replace"===a.patch[0].op&&"/"===a.patch[0].path&&null===a.patch[0].value){let e={...u,"/":a.hlc},r=Object.entries(e).every(([t,e])=>"/"===t||a.hlc>=e);return(await t.db.updateFieldHLCs(i,e),r)?await t.db.saveDocument({id:i,existing:l,data:null}):l}if(null!=u["/"]&&null===l.data)return l;let s=await getDocumentValidator(t,c),d=a.patch.filter(t=>"value"in t),h={...l.data??{}},m={...u},f=!1;for(let t of d){let e=u[t.path];(null==e||a.hlc>e)&&(h[t.path.slice(1)]=t.value,m[t.path]=a.hlc,f=!0)}if(!f)return l;await t.db.updateFieldHLCs(i,m);let p=e(s,h);return await t.db.saveDocument({id:i,existing:l,data:p})}export async function applySetMutation(a,i){let o=i.aud??i.iss;if(i.iss!==o)throw Error("Invalid mutation issuer");let l=r.fromString(i.sub),c=l.toString(),u=l.model.toString();null!=a.maxDriftMS&&n(i.hlc,a.maxDriftMS,a.hlc);let[s,d]=await Promise.all([a.db.getDocument(l),getDocumentValidator(a,u)]),h=e(d,i.data),m={};for(let t of Object.keys(h))m[`/${t}`]=i.hlc;if(null===s){let e=await a.db.createDocument({id:l,owner:o,data:h,unique:t(i.unq)});return await a.db.updateFieldHLCs(l,m),e}if(s.owner!==o)throw Error(`Cannot change owner from ${s.owner} to ${o} in document: ${l.toString()}`);if(a.accessChecker&&!await a.accessChecker(s,"write"))throw Error(`Access denied: cannot write document ${l.toString()}`);let f=await a.db.getFieldHLCs(c)??{},p={...s.data??{}},w={...f},g=!1;for(let[t,e]of Object.entries(h)){let a=`/${t}`,r=f[a];(null==r||i.hlc>r)&&(p[t]=e,w[a]=i.hlc,g=!0)}if(!g)return s;await a.db.updateFieldHLCs(l,w);let b=e(d,p);return await a.db.saveDocument({id:l,existing:s,data:b})}export async function applyMutation(t,e){switch(e.typ){case"change":return await applyChangeMutation(t,e);case"set":return await applySetMutation(t,e);default:throw Error("Unsupported mutation type")}}
+import{fromB64 as t}from"@enkaku/codec";import{applyPatches as e}from"@enkaku/patch";import{asType as a,createValidator as r}from"@enkaku/schema";import{HLC as i}from"@kubun/hlc";import{DocumentID as n}from"@kubun/id";export function getDocumentValidator(t,e){return null==t.validators[e]&&(t.validators[e]=t.db.getDocumentModel(e).then(t=>r({...t.schema,$id:e}))),t.validators[e]}function o(t,e,a){let r=i.parse(t),n=Date.now(),o=r.wallTime-n;if(o>e)throw Error(`HLC timestamp too far in the future: ${o}ms drift exceeds ${e}ms limit`);a&&a.receive(r)}export function getTopLevelField(t){let e=t.indexOf("/",1);return -1===e?t:t.slice(0,e)}export async function applyChangeMutation(t,r){let i=n.fromString(r.sub),l=i.toString(),u=await t.db.getDocument(i);if(null==u)throw Error(`Document not found: ${l}`);if(r.iss!==u.owner)throw Error("Invalid mutation issuer");if(t.accessChecker&&!await t.accessChecker(u,"write"))throw Error(`Access denied: cannot write document ${l}`);null!=t.maxDriftMS&&o(r.hlc,t.maxDriftMS,t.hlc);let c=i.model.toString(),s=await t.db.getFieldHLCs(l)??{};if(1===r.patch.length&&"replace"===r.patch[0].op&&"/"===r.patch[0].path&&null===r.patch[0].value){let e={...s,"/":r.hlc},a=Object.entries(e).every(([t,e])=>"/"===t||r.hlc>=e);return(await t.db.updateFieldHLCs(i,e),a)?await t.db.saveDocument({id:i,existing:u,data:null}):u}if(null!=s["/"]&&null===u.data)return u;let d=await getDocumentValidator(t,c),h=new Map;for(let t of r.patch){let e=getTopLevelField(t.path),a=h.get(e);null!=a?a.push(t):h.set(e,[t])}let m={...s},p=[];for(let[t,e]of h){let a=s[t];(null==a||r.hlc>a)&&(p.push(...e),m[t]=r.hlc)}if(0===p.length)return u;let f=structuredClone(u.data??{});e(f,p,!1),await t.db.updateFieldHLCs(i,m);let w=a(d,f);return await t.db.saveDocument({id:i,existing:u,data:w})}export async function applySetMutation(e,r){let i=r.aud??r.iss;if(r.iss!==i)throw Error("Invalid mutation issuer");let l=n.fromString(r.sub),u=l.toString(),c=l.model.toString();null!=e.maxDriftMS&&o(r.hlc,e.maxDriftMS,e.hlc);let[s,d]=await Promise.all([e.db.getDocument(l),getDocumentValidator(e,c)]),h=a(d,r.data),m={};for(let t of Object.keys(h))m[`/${t}`]=r.hlc;if(null===s){let a=await e.db.createDocument({id:l,owner:i,data:h,unique:t(r.unq)});return await e.db.updateFieldHLCs(l,m),a}if(s.owner!==i)throw Error(`Cannot change owner from ${s.owner} to ${i} in document: ${l.toString()}`);if(e.accessChecker&&!await e.accessChecker(s,"write"))throw Error(`Access denied: cannot write document ${l.toString()}`);let p=await e.db.getFieldHLCs(u)??{},f={...s.data??{}},w={...p},g=!1;for(let[t,e]of Object.entries(h)){let a=`/${t}`,i=p[a];(null==i||r.hlc>i)&&(f[t]=e,w[a]=r.hlc,g=!0)}if(!g)return s;await e.db.updateFieldHLCs(l,w);let b=a(d,f);return await e.db.saveDocument({id:l,existing:s,data:b})}export async function applyMutation(t,e){switch(e.typ){case"change":return await applyChangeMutation(t,e);case"set":return await applySetMutation(t,e);default:throw Error("Unsupported mutation type")}}

package/lib/create.d.ts

@@ -1,7 +1,7 @@
 import type { PatchOperation } from '@kubun/graphql';
+import { HLC } from '@kubun/hlc';
 import { DocumentID, type DocumentModelID } from '@kubun/id';
 import type { ChangeDocumentMutation, DocumentData, SetDocumentMutation } from '@kubun/protocol';
-import { HLC } from './hlc.js';
 export type CreateSetMutationParams<Data extends DocumentData = DocumentData> = {
     data: Data;
     hlc: HLC;

package/lib/create.js

@@ -1 +1 @@
-import{toB64 as e}from"@enkaku/codec";import{DocumentID as t}from"@kubun/id";import{HLC as r}from"./hlc.js";export async function createSetMutation(a){let n=a.issuer,o=a.owner??n,i=await t.create(a.modelID,o,a.unique);return{typ:"set",iss:n,aud:o,sub:i.toString(),data:a.data,hlc:r.serialize(a.hlc.now()),unq:e(a.unique)}}export function createChangeMutation(e){return{typ:"change",iss:e.issuer,sub:t.from(e.docID).toString(),patch:e.patch,hlc:r.serialize(e.hlc.now())}}export function createRemoveMutation(e){return{typ:"change",iss:e.issuer,sub:e.docID,patch:[{op:"replace",path:"/",value:null}],hlc:r.serialize(e.hlc.now())}}
+import{toB64 as e}from"@enkaku/codec";import{HLC as t}from"@kubun/hlc";import{DocumentID as r}from"@kubun/id";export async function createSetMutation(n){let a=n.issuer,o=n.owner??a,u=await r.create(n.modelID,o,n.unique);return{typ:"set",iss:a,aud:o,sub:u.toString(),data:n.data,hlc:t.serialize(n.hlc.now()),unq:e(n.unique)}}export function createChangeMutation(e){return{typ:"change",iss:e.issuer,sub:r.from(e.docID).toString(),patch:e.patch,hlc:t.serialize(e.hlc.now())}}export function createRemoveMutation(e){return{typ:"change",iss:e.issuer,sub:e.docID,patch:[{op:"replace",path:"/",value:null}],hlc:t.serialize(e.hlc.now())}}

package/lib/index.d.ts

@@ -1,7 +1,7 @@
+export { HLC, type HLCTimestamp } from '@kubun/hlc';
 export type { DocumentValidator, MutationContext, ValidatorsRecord } from './apply.js';
-export { applyChangeMutation, applyMutation, applySetMutation } from './apply.js';
+export { applyChangeMutation, applyMutation, applySetMutation, getTopLevelField } from './apply.js';
 export type { CreateChangeMutationParams, CreateRemoveMutationParams, CreateSetMutationParams, } from './create.js';
 export { createChangeMutation, createRemoveMutation, createSetMutation } from './create.js';
-export { HLC, type HLCTimestamp } from './hlc.js';
-export type { CreateDocumentParams, CreateMutationOperationsParams, GetRandomValues, MutationOperations, RemoveDocumentParams, SetDocumentParams, UpdateDocumentParams, } from './operations.js';
+export type { CreateDocumentParams, CreateMutationOperationsParams, MutationOperations, RemoveDocumentParams, SetDocumentParams, UpdateDocumentParams, } from './operations.js';
 export { convertPatchInput, createMutationOperations } from './operations.js';

package/lib/index.js

@@ -1 +1 @@
-export{applyChangeMutation,applyMutation,applySetMutation}from"./apply.js";export{createChangeMutation,createRemoveMutation,createSetMutation}from"./create.js";export{HLC}from"./hlc.js";export{convertPatchInput,createMutationOperations}from"./operations.js";
+export{HLC}from"@kubun/hlc";export{applyChangeMutation,applyMutation,applySetMutation,getTopLevelField}from"./apply.js";export{createChangeMutation,createRemoveMutation,createSetMutation}from"./create.js";export{convertPatchInput,createMutationOperations}from"./operations.js";

package/lib/operations.d.ts

@@ -1,11 +1,11 @@
+import type { GetRandomValues } from '@enkaku/runtime';
 import type { PatchOperation } from '@kubun/graphql';
+import type { HLC } from '@kubun/hlc';
 import type { ChangeDocumentMutation, DocumentData, SetDocumentMutation } from '@kubun/protocol';
-import type { HLC } from './hlc.js';
-export type GetRandomValues = <T extends ArrayBufferView>(array: T) => T;
 export type CreateMutationOperationsParams<T> = {
     issuer: string;
     hlc: HLC;
-    getRandomValues?: GetRandomValues;
+    getRandomValues: GetRandomValues;
     processSetMutation(mutation: SetDocumentMutation, transactionID?: string | null): Promise<T>;
     processChangeMutation(mutation: ChangeDocumentMutation, transactionID?: string | null): Promise<T>;
 };

package/lib/operations.js

@@ -1 +1 @@
-import{createChangeMutation as t,createRemoveMutation as e,createSetMutation as a}from"./create.js";export function createMutationOperations(n){let{issuer:r,hlc:o,processSetMutation:c,processChangeMutation:u}=n,i=n.getRandomValues??globalThis.crypto.getRandomValues.bind(globalThis.crypto);return{async createDocument({modelID:t,data:e,transactionID:n}){let u=i(new Uint8Array(12)),l=await a({issuer:r,hlc:o,modelID:t,data:e,unique:u});return await c(l,n)},async setDocument({modelID:t,unique:e,data:n,transactionID:u}){let i=await a({issuer:r,hlc:o,modelID:t,data:n,unique:e});return await c(i,u)},async updateDocument({docID:e,patch:a,transactionID:n}){let c=t({issuer:r,hlc:o,docID:e,patch:a});return await u(c,n)},async removeDocument({docID:t,transactionID:a}){let n=e({docID:t,issuer:r,hlc:o});return await u(n,a)}}}export function convertPatchInput(t){return t.map(t=>{let[e,a]=Object.entries(t)[0];return{...a,op:e}})}
+import{createChangeMutation as t,createRemoveMutation as e,createSetMutation as r}from"./create.js";export function createMutationOperations(n){let{issuer:a,hlc:c,getRandomValues:u,processSetMutation:o,processChangeMutation:i}=n;return{async createDocument({modelID:t,data:e,transactionID:n}){let i=u(new Uint8Array(12)),m=await r({issuer:a,hlc:c,modelID:t,data:e,unique:i});return await o(m,n)},async setDocument({modelID:t,unique:e,data:n,transactionID:u}){let i=await r({issuer:a,hlc:c,modelID:t,data:n,unique:e});return await o(i,u)},async updateDocument({docID:e,patch:r,transactionID:n}){let u=t({issuer:a,hlc:c,docID:e,patch:r});return await i(u,n)},async removeDocument({docID:t,transactionID:r}){let n=e({docID:t,issuer:a,hlc:c});return await i(n,r)}}}export function convertPatchInput(t){return t.map(t=>{let[e,r]=Object.entries(t)[0];return{...r,op:e}})}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/mutation",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "see LICENSE.md",
   "keywords": [],
   "type": "module",
@@ -16,13 +16,16 @@
   "sideEffects": false,
   "dependencies": {
     "@enkaku/codec": "^0.14.0",
+    "@enkaku/patch": "^0.14.0",
+    "@enkaku/runtime": "^0.14.0",
     "@enkaku/schema": "^0.14.0",
-    "@kubun/id": "^0.7.0"
+    "@kubun/hlc": "^0.8.0",
+    "@kubun/id": "^0.8.0"
   },
   "devDependencies": {
-    "@kubun/protocol": "^0.7.0",
-    "@kubun/db": "^0.7.0",
-    "@kubun/graphql": "^0.7.0"
+    "@kubun/graphql": "^0.8.0",
+    "@kubun/db": "^0.8.0",
+    "@kubun/protocol": "^0.8.0"
   },
   "scripts": {
     "build:clean": "del lib",
@@ -30,7 +33,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/hlc.d.ts

@@ -1,19 +0,0 @@
-export type HLCTimestamp = {
-    wallTime: number;
-    counter: number;
-    nodeID: string;
-};
-type HLCParams = {
-    nodeID: string;
-};
-export declare class HLC {
-    #private;
-    constructor(params: HLCParams);
-    get nodeID(): string;
-    now(): HLCTimestamp;
-    receive(remote: HLCTimestamp): HLCTimestamp;
-    static serialize(ts: HLCTimestamp): string;
-    static parse(s: string): HLCTimestamp;
-    static compare(a: HLCTimestamp, b: HLCTimestamp): number;
-}
-export {};

package/lib/hlc.js

@@ -1 +0,0 @@
-export class HLC{#t;#e=0;#l=0;constructor(t){this.#t=t.nodeID}get nodeID(){return this.#t}now(){let t=Date.now();return t>this.#e?(this.#e=t,this.#l=0):this.#l++,{wallTime:this.#e,counter:this.#l,nodeID:this.#t}}receive(t){let e=Date.now();return e>this.#e&&e>t.wallTime?(this.#e=e,this.#l=0):t.wallTime>this.#e?(this.#e=t.wallTime,this.#l=t.counter+1):this.#e>t.wallTime?this.#l++:this.#l=Math.max(this.#l,t.counter)+1,{wallTime:this.#e,counter:this.#l,nodeID:this.#t}}static serialize(t){let e=new Date(t.wallTime).toISOString(),l=t.counter.toString().padStart(4,"0");return`${e}:${l}:${t.nodeID}`}static parse(t){let e=t.indexOf("Z"),l=new Date(t.slice(0,e+1)).getTime(),i=t.slice(e+2),a=i.indexOf(":");return{wallTime:l,counter:Number.parseInt(i.slice(0,a),10),nodeID:i.slice(a+1)}}static compare(t,e){return t.wallTime!==e.wallTime?t.wallTime-e.wallTime:t.counter!==e.counter?t.counter-e.counter:t.nodeID<e.nodeID?-1:+(t.nodeID>e.nodeID)}}