@kubun/mutation 0.3.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/README.md

@@ -0,0 +1,11 @@
+# Kubun mutation
+
+## Installation
+
+```sh
+npm install @kubun/mutation
+```
+
+## License
+
+[Prosperity Public License 3.0.0](LICENSE.md)

package/lib/apply.d.ts

@@ -0,0 +1,14 @@
+import { type Validator } from '@enkaku/schema';
+import type { KubunDB } from '@kubun/db';
+import type { ChangeDocumentMutation, DocumentData, DocumentMutation, DocumentNode, SetDocumentMutation } from '@kubun/protocol';
+export type DocumentValidator = Validator<DocumentData>;
+export type ValidatorsRecord = Record<string, Promise<DocumentValidator>>;
+export type MutationContext = {
+    db: KubunDB;
+    validators: ValidatorsRecord;
+};
+export declare function getDocumentValidator(ctx: MutationContext, id: string): Promise<DocumentValidator>;
+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>;
+//# sourceMappingURL=apply.d.ts.map

package/lib/apply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply.d.ts","sourceRoot":"","sources":["../src/apply.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAA2B,MAAM,gBAAgB,CAAA;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAExC,OAAO,KAAK,EACV,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACpB,MAAM,iBAAiB,CAAA;AAIxB,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,YAAY,CAAC,CAAA;AACvD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAA;AAEzE,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,OAAO,CAAA;IACX,UAAU,EAAE,gBAAgB,CAAA;CAC7B,CAAA;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAOjG;AAED,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,eAAe,EACpB,QAAQ,EAAE,sBAAsB,GAC/B,OAAO,CAAC,YAAY,CAAC,CAoCvB;AAED,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,eAAe,EACpB,QAAQ,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAqCvB;AAED,wBAAsB,aAAa,CACjC,GAAG,EAAE,eAAe,EACpB,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,YAAY,CAAC,CASvB"}

package/lib/apply.js

@@ -0,0 +1,100 @@
+import * as A from '@automerge/automerge/slim';
+import { fromB64 } from '@enkaku/codec';
+import { asType, createValidator } from '@enkaku/schema';
+import { DocumentID } from '@kubun/id';
+import { automergeReady, automergeToData } from './automerge.js';
+export function getDocumentValidator(ctx, id) {
+    if (ctx.validators[id] == null) {
+        ctx.validators[id] = ctx.db.getDocumentModel(id).then((model)=>createValidator({
+                ...model.schema,
+                $id: id
+            }));
+    }
+    return ctx.validators[id];
+}
+export async function applyChangeMutation(ctx, mutation) {
+    const id = DocumentID.fromString(mutation.sub);
+    const docID = id.toString();
+    const doc = await ctx.db.getDocument(id);
+    if (doc == null) {
+        throw new Error(`Document not found: ${docID}`);
+    }
+    if (mutation.iss !== doc.owner) {
+        // TODO: verify capabilities if issuer is not owner
+        throw new Error('Invalid mutation issuer');
+    }
+    if (mutation.data === null) {
+        return await ctx.db.saveDocument({
+            id,
+            existing: doc,
+            data: null,
+            state: null
+        });
+    }
+    if (doc.data === null) {
+        throw new Error(`Cannot apply changes to empty document: ${docID}`);
+    }
+    const [docStates, validator] = await Promise.all([
+        ctx.db.getDocumentStates([
+            docID
+        ]),
+        getDocumentValidator(ctx, id.model.toString()),
+        automergeReady
+    ]);
+    // Create doc from data object if state is not present
+    const currentDoc = docStates[docID] ? A.load(docStates[docID]) : A.from(doc.data);
+    const changes = fromB64(mutation.data);
+    // Apply incremental changes or full merge
+    const newDoc = mutation.inc ? A.loadIncremental(currentDoc, changes) : A.merge(currentDoc, A.load(changes));
+    // Validate merged data
+    const data = asType(validator, automergeToData(newDoc));
+    return await ctx.db.saveDocument({
+        id,
+        existing: doc,
+        data,
+        state: A.save(newDoc)
+    });
+}
+export async function applySetMutation(ctx, mutation) {
+    const owner = mutation.aud ?? mutation.iss;
+    if (mutation.iss !== owner) {
+        // TODO: verify capabilities if issuer is not owner
+        throw new Error('Invalid mutation issuer');
+    }
+    const id = DocumentID.fromString(mutation.sub);
+    const [doc, validator] = await Promise.all([
+        ctx.db.getDocument(id),
+        getDocumentValidator(ctx, id.model.toString()),
+        automergeReady
+    ]);
+    const mergeDoc = mutation.data === null ? null : A.load(fromB64(mutation.data));
+    const data = mergeDoc ? asType(validator, automergeToData(mergeDoc)) : null;
+    if (doc === null) {
+        return await ctx.db.createDocument({
+            id,
+            owner,
+            data,
+            state: mergeDoc ? A.save(mergeDoc) : null,
+            unique: fromB64(mutation.unq)
+        });
+    }
+    if (doc.owner !== owner) {
+        throw new Error(`Cannot change owner from ${doc.owner} to ${owner} in document: ${id.toString()}`);
+    }
+    return await ctx.db.saveDocument({
+        id,
+        existing: doc,
+        data,
+        state: mergeDoc ? A.save(mergeDoc) : null
+    });
+}
+export async function applyMutation(ctx, mutation) {
+    switch(mutation.typ){
+        case 'change':
+            return await applyChangeMutation(ctx, mutation);
+        case 'set':
+            return await applySetMutation(ctx, mutation);
+        default:
+            throw new Error('Unsupported mutation type');
+    }
+}

package/lib/automerge.d.ts

@@ -0,0 +1,5 @@
+import * as A from '@automerge/automerge/slim';
+import type { DocumentData } from '@kubun/protocol';
+export declare const automergeReady: PromiseLike<void>;
+export declare function automergeToData(doc: A.Doc<DocumentData>): DocumentData;
+//# sourceMappingURL=automerge.d.ts.map

package/lib/automerge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"automerge.d.ts","sourceRoot":"","sources":["../src/automerge.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAE9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAEnD,eAAO,MAAM,cAAc,mBAA0D,CAAA;AAErF,wBAAgB,eAAe,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,YAAY,CAEtE"}

package/lib/automerge.js

@@ -0,0 +1,8 @@
+// @ts-ignore missing type definition
+import { automergeWasmBase64 } from '@automerge/automerge/automerge.wasm.base64.js';
+import * as A from '@automerge/automerge/slim';
+import { lazy } from '@enkaku/async';
+export const automergeReady = lazy(()=>A.initializeBase64Wasm(automergeWasmBase64));
+export function automergeToData(doc) {
+    return JSON.parse(JSON.stringify(doc));
+}

package/lib/create.d.ts

@@ -0,0 +1,25 @@
+import type { PatchOperation } from '@kubun/graphql';
+import { DocumentID, type DocumentModelID } from '@kubun/id';
+import type { ChangeDocumentMutation, DocumentData, SetDocumentMutation } from '@kubun/protocol';
+export type CreateSetMutationParams<Data extends DocumentData = DocumentData> = {
+    data: Data | null;
+    issuer: string;
+    modelID: DocumentModelID | string;
+    owner?: string;
+    unique: Uint8Array;
+};
+export declare function createSetMutation<Data extends DocumentData = DocumentData>(params: CreateSetMutationParams<Data>): Promise<SetDocumentMutation>;
+export type CreateChangeMutationParams<Data extends DocumentData = DocumentData> = {
+    docID: DocumentID | string;
+    from?: Partial<Data>;
+    issuer: string;
+    loadState: (id: string) => Promise<Uint8Array | null>;
+    patch: Array<PatchOperation>;
+};
+export declare function createChangeMutation<Data extends DocumentData = DocumentData>(params: CreateChangeMutationParams<Data>): Promise<ChangeDocumentMutation>;
+export type CreateRemoveMutationParams = {
+    docID: string;
+    issuer: string;
+};
+export declare function createRemoveMutation(params: CreateRemoveMutationParams): ChangeDocumentMutation;
+//# sourceMappingURL=create.d.ts.map

package/lib/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AAC5D,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAKhG,MAAM,MAAM,uBAAuB,CAAC,IAAI,SAAS,YAAY,GAAG,YAAY,IAAI;IAC9E,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,eAAe,GAAG,MAAM,CAAA;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAED,wBAAsB,iBAAiB,CAAC,IAAI,SAAS,YAAY,GAAG,YAAY,EAC9E,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,GACpC,OAAO,CAAC,mBAAmB,CAAC,CAe9B;AAED,MAAM,MAAM,0BAA0B,CAAC,IAAI,SAAS,YAAY,GAAG,YAAY,IAAI;IACjF,KAAK,EAAE,UAAU,GAAG,MAAM,CAAA;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAA;IACrD,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;CAC7B,CAAA;AAED,wBAAsB,oBAAoB,CAAC,IAAI,SAAS,YAAY,GAAG,YAAY,EACjF,MAAM,EAAE,0BAA0B,CAAC,IAAI,CAAC,GACvC,OAAO,CAAC,sBAAsB,CAAC,CAkBjC;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,sBAAsB,CAQ/F"}

package/lib/create.js

@@ -0,0 +1,52 @@
+import * as A from '@automerge/automerge/slim';
+import { toB64 } from '@enkaku/codec';
+import { DocumentID } from '@kubun/id';
+import { automergeReady } from './automerge.js';
+import { applyPatches } from './json-patch.js';
+export async function createSetMutation(params) {
+    const issuer = params.issuer;
+    const owner = params.owner ?? issuer;
+    const [docID] = await Promise.all([
+        DocumentID.create(params.modelID, owner, params.unique),
+        automergeReady
+    ]);
+    return {
+        typ: 'set',
+        iss: issuer,
+        aud: owner,
+        sub: docID.toString(),
+        data: params.data == null ? null : toB64(A.save(A.from(params.data))),
+        unq: toB64(params.unique)
+    };
+}
+export async function createChangeMutation(params) {
+    const docID = DocumentID.from(params.docID).toString();
+    // Load current state of document from DB
+    const [state] = await Promise.all([
+        params.loadState(docID),
+        automergeReady
+    ]);
+    const loadedDoc = state ? A.load(state) : null;
+    // Apply patches to loaded doc or locally created one
+    const newDoc = A.change(loadedDoc ?? A.from(params.from ?? {}), (proxy)=>{
+        applyPatches(proxy, params.patch);
+    });
+    // Save incremental or full data state
+    const data = loadedDoc ? A.saveSince(newDoc, A.getHeads(loadedDoc)) : A.save(newDoc);
+    return {
+        typ: 'change',
+        iss: params.issuer,
+        sub: docID,
+        data: toB64(data),
+        inc: loadedDoc != null
+    };
+}
+export function createRemoveMutation(params) {
+    return {
+        typ: 'change',
+        iss: params.issuer,
+        sub: params.docID,
+        data: null,
+        inc: false
+    };
+}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export type { DocumentValidator, MutationContext, ValidatorsRecord } from './apply.js';
+export { applyChangeMutation, applyMutation, applySetMutation } from './apply.js';
+export type { CreateChangeMutationParams, CreateRemoveMutationParams, CreateSetMutationParams, } from './create.js';
+export { createChangeMutation, createRemoveMutation, createSetMutation } from './create.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACtF,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACjF,YAAY,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,GACxB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA"}

package/lib/index.js

@@ -0,0 +1,2 @@
+export { applyChangeMutation, applyMutation, applySetMutation } from './apply.js';
+export { createChangeMutation, createRemoveMutation, createSetMutation } from './create.js';

package/lib/json-patch.d.ts

@@ -0,0 +1,8 @@
+import type { PatchOperation } from '@kubun/graphql';
+import type { DocumentData } from '@kubun/protocol';
+export declare function parsePath(path: string): Array<string | number>;
+export declare function getPath(obj: unknown, path: string): unknown;
+export declare function setPath(obj: Record<string, unknown> | Array<unknown>, path: string, value: unknown): void;
+export declare function deletePath(obj: Record<string, unknown> | Array<unknown>, path: string): void;
+export declare function applyPatches(data: DocumentData, patches: Array<PatchOperation>): void;
+//# sourceMappingURL=json-patch.d.ts.map

package/lib/json-patch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-patch.d.ts","sourceRoot":"","sources":["../src/json-patch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAEnD,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAS9D;AAED,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAI3D;AAED,wBAAgB,OAAO,CACrB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,EAC7C,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,GACb,IAAI,CAYN;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAY5F;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,IAAI,CA0BrF"}

package/lib/json-patch.js

@@ -0,0 +1,70 @@
+export function parsePath(path) {
+    return path.slice(1).split('/').map((key)=>{
+        // Convert array indices to numbers
+        const index = Number(key);
+        return Number.isNaN(index) ? key : index;
+    });
+}
+export function getPath(obj, path) {
+    const keys = parsePath(path);
+    // @ts-ignore index signature
+    return keys.reduce((acc, key)=>acc?.[key], obj);
+}
+export function setPath(obj, path, value) {
+    const keys = parsePath(path);
+    const lastKey = keys.pop();
+    if (lastKey !== undefined) {
+        // @ts-ignore unknown object
+        const target = keys.reduce((acc, key)=>acc[key], obj);
+        if (Array.isArray(target) && typeof lastKey === 'number' && lastKey === target.length) {
+            target.push(value) // Append to array if index is equal to array length
+            ;
+        } else {
+            ;
+            target[lastKey] = value;
+        }
+    }
+}
+export function deletePath(obj, path) {
+    const keys = parsePath(path);
+    const lastKey = keys.pop();
+    if (lastKey !== undefined) {
+        // @ts-ignore unknown object
+        const target = keys.reduce((acc, key)=>acc[key], obj);
+        if (Array.isArray(target) && typeof lastKey === 'number') {
+            target.splice(lastKey, 1) // Remove from array if lastKey is an index
+            ;
+        } else {
+            delete target[lastKey];
+        }
+    }
+}
+export function applyPatches(data, patches) {
+    for (const patch of patches){
+        switch(patch.op){
+            case 'add':
+            case 'replace':
+                setPath(data, patch.path, patch.value);
+                break;
+            case 'remove':
+                deletePath(data, patch.path);
+                break;
+            case 'copy':
+                {
+                    const value = getPath(data, patch.from);
+                    setPath(data, patch.path, value);
+                    break;
+                }
+            case 'move':
+                {
+                    const value = getPath(data, patch.from);
+                    deletePath(data, patch.from);
+                    setPath(data, patch.path, value);
+                    break;
+                }
+            default:
+                // @ts-ignore never type
+                throw new Error(`Unknown operation: ${patch.op}`);
+        }
+    }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@kubun/mutation",
+  "version": "0.3.0",
+  "license": "see LICENSE.md",
+  "keywords": [],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@automerge/automerge": "^2.2.8",
+    "@enkaku/async": "^0.12.0",
+    "@enkaku/codec": "^0.12.0",
+    "@enkaku/schema": "^0.12.0",
+    "@kubun/id": "^0.3.0"
+  },
+  "devDependencies": {
+    "@kubun/db": "^0.3.3",
+    "@kubun/graphql": "^0.3.6",
+    "@kubun/protocol": "^0.3.4"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "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:unit": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}