@crdt-sync/core 0.1.1 → 0.2.0

package/pkg/bundler/crdt_sync.d.ts

@@ -0,0 +1,95 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A WebAssembly-compatible wrapper around [`StateStore`].
+ *
+ * Methods accept and return JSON-encoded strings at the Wasm boundary so that
+ * [`Envelope`] payloads and CRDT values can be exchanged between Rust and
+ * JavaScript without sharing memory structures directly.
+ */
+export class WasmStateStore {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Apply a remote [`Envelope`] (serialised as a JSON string) to this store.
+     *
+     * Throws a JavaScript error if the JSON cannot be deserialised.
+     */
+    apply_envelope(envelope_json: string): void;
+    /**
+     * Return the current Lamport clock value.
+     *
+     * Returned as `f64` because JavaScript's `Number` type cannot safely
+     * represent all `u64` values.  Values up to `2^53 − 1`
+     * (`Number.MAX_SAFE_INTEGER`) are represented exactly.  For distributed
+     * systems that could conceivably tick the clock beyond that threshold,
+     * treat the returned value as approximate or use `BigInt` on the JS side.
+     */
+    clock(): number;
+    /**
+     * Read the current value of a named LWW register as a JSON string.
+     *
+     * Returns `undefined` in JavaScript if the key has never been written.
+     */
+    get_register(key: string): string | undefined;
+    /**
+     * Create a new `WasmStateStore` for the given node identifier.
+     */
+    constructor(node_id: string);
+    /**
+     * Delete the element at visible `index` in the named RGA sequence.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string, or `undefined` if
+     * `index` is out of bounds.
+     */
+    seq_delete(key: string, index: number): string | undefined;
+    /**
+     * Insert a JSON-encoded element at `index` in the named RGA sequence.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string.
+     */
+    seq_insert(key: string, index: number, value_json: string): string;
+    /**
+     * Return all visible elements of the named sequence as a JSON array string.
+     *
+     * Throws a JavaScript error if serialisation fails.
+     */
+    seq_items(key: string): string;
+    /**
+     * Return the number of visible elements in the named sequence.
+     */
+    seq_len(key: string): number;
+    /**
+     * Add a JSON-encoded element to the named OR-Set.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string.
+     */
+    set_add(key: string, value_json: string): string;
+    /**
+     * Returns `true` if the named OR-Set contains the JSON-encoded `value`.
+     */
+    set_contains(key: string, value_json: string): boolean;
+    /**
+     * Return all elements of the named OR-Set as a JSON array string.
+     *
+     * Throws a JavaScript error if serialisation fails.
+     */
+    set_items(key: string): string;
+    /**
+     * Write a JSON-encoded value to the named LWW register.
+     *
+     * Returns the resulting [`Envelope`] serialised as a JSON string, ready
+     * to broadcast to peer nodes.
+     */
+    set_register(key: string, value_json: string): string;
+    /**
+     * Remove a JSON-encoded element from the named OR-Set.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string, or `undefined` if
+     * the element was not present in the set.
+     *
+     * Throws a JavaScript error if `value_json` is not valid JSON.
+     */
+    set_remove(key: string, value_json: string): string | undefined;
+}

package/pkg/bundler/crdt_sync.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./crdt_sync.d.ts" */
+
+import * as wasm from "./crdt_sync_bg.wasm";
+import { __wbg_set_wasm } from "./crdt_sync_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    WasmStateStore
+} from "./crdt_sync_bg.js";

package/pkg/bundler/crdt_sync_bg.js

@@ -0,0 +1,430 @@
+/**
+ * A WebAssembly-compatible wrapper around [`StateStore`].
+ *
+ * Methods accept and return JSON-encoded strings at the Wasm boundary so that
+ * [`Envelope`] payloads and CRDT values can be exchanged between Rust and
+ * JavaScript without sharing memory structures directly.
+ */
+export class WasmStateStore {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        WasmStateStoreFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_wasmstatestore_free(ptr, 0);
+    }
+    /**
+     * Apply a remote [`Envelope`] (serialised as a JSON string) to this store.
+     *
+     * Throws a JavaScript error if the JSON cannot be deserialised.
+     * @param {string} envelope_json
+     */
+    apply_envelope(envelope_json) {
+        const ptr0 = passStringToWasm0(envelope_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_apply_envelope(this.__wbg_ptr, ptr0, len0);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
+    /**
+     * Return the current Lamport clock value.
+     *
+     * Returned as `f64` because JavaScript's `Number` type cannot safely
+     * represent all `u64` values.  Values up to `2^53 − 1`
+     * (`Number.MAX_SAFE_INTEGER`) are represented exactly.  For distributed
+     * systems that could conceivably tick the clock beyond that threshold,
+     * treat the returned value as approximate or use `BigInt` on the JS side.
+     * @returns {number}
+     */
+    clock() {
+        const ret = wasm.wasmstatestore_clock(this.__wbg_ptr);
+        return ret;
+    }
+    /**
+     * Read the current value of a named LWW register as a JSON string.
+     *
+     * Returns `undefined` in JavaScript if the key has never been written.
+     * @param {string} key
+     * @returns {string | undefined}
+     */
+    get_register(key) {
+        const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_get_register(this.__wbg_ptr, ptr0, len0);
+        let v2;
+        if (ret[0] !== 0) {
+            v2 = getStringFromWasm0(ret[0], ret[1]).slice();
+            wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        }
+        return v2;
+    }
+    /**
+     * Create a new `WasmStateStore` for the given node identifier.
+     * @param {string} node_id
+     */
+    constructor(node_id) {
+        const ptr0 = passStringToWasm0(node_id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_new(ptr0, len0);
+        this.__wbg_ptr = ret >>> 0;
+        WasmStateStoreFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * Delete the element at visible `index` in the named RGA sequence.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string, or `undefined` if
+     * `index` is out of bounds.
+     * @param {string} key
+     * @param {number} index
+     * @returns {string | undefined}
+     */
+    seq_delete(key, index) {
+        const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_seq_delete(this.__wbg_ptr, ptr0, len0, index);
+        let v2;
+        if (ret[0] !== 0) {
+            v2 = getStringFromWasm0(ret[0], ret[1]).slice();
+            wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        }
+        return v2;
+    }
+    /**
+     * Insert a JSON-encoded element at `index` in the named RGA sequence.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string.
+     * @param {string} key
+     * @param {number} index
+     * @param {string} value_json
+     * @returns {string}
+     */
+    seq_insert(key, index, value_json) {
+        let deferred4_0;
+        let deferred4_1;
+        try {
+            const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(value_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ret = wasm.wasmstatestore_seq_insert(this.__wbg_ptr, ptr0, len0, index, ptr1, len1);
+            var ptr3 = ret[0];
+            var len3 = ret[1];
+            if (ret[3]) {
+                ptr3 = 0; len3 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred4_0 = ptr3;
+            deferred4_1 = len3;
+            return getStringFromWasm0(ptr3, len3);
+        } finally {
+            wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+        }
+    }
+    /**
+     * Return all visible elements of the named sequence as a JSON array string.
+     *
+     * Throws a JavaScript error if serialisation fails.
+     * @param {string} key
+     * @returns {string}
+     */
+    seq_items(key) {
+        let deferred3_0;
+        let deferred3_1;
+        try {
+            const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ret = wasm.wasmstatestore_seq_items(this.__wbg_ptr, ptr0, len0);
+            var ptr2 = ret[0];
+            var len2 = ret[1];
+            if (ret[3]) {
+                ptr2 = 0; len2 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred3_0 = ptr2;
+            deferred3_1 = len2;
+            return getStringFromWasm0(ptr2, len2);
+        } finally {
+            wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
+        }
+    }
+    /**
+     * Return the number of visible elements in the named sequence.
+     * @param {string} key
+     * @returns {number}
+     */
+    seq_len(key) {
+        const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_seq_len(this.__wbg_ptr, ptr0, len0);
+        return ret >>> 0;
+    }
+    /**
+     * Add a JSON-encoded element to the named OR-Set.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string.
+     * @param {string} key
+     * @param {string} value_json
+     * @returns {string}
+     */
+    set_add(key, value_json) {
+        let deferred4_0;
+        let deferred4_1;
+        try {
+            const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(value_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ret = wasm.wasmstatestore_set_add(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+            var ptr3 = ret[0];
+            var len3 = ret[1];
+            if (ret[3]) {
+                ptr3 = 0; len3 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred4_0 = ptr3;
+            deferred4_1 = len3;
+            return getStringFromWasm0(ptr3, len3);
+        } finally {
+            wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+        }
+    }
+    /**
+     * Returns `true` if the named OR-Set contains the JSON-encoded `value`.
+     * @param {string} key
+     * @param {string} value_json
+     * @returns {boolean}
+     */
+    set_contains(key, value_json) {
+        const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(value_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_set_contains(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        return ret !== 0;
+    }
+    /**
+     * Return all elements of the named OR-Set as a JSON array string.
+     *
+     * Throws a JavaScript error if serialisation fails.
+     * @param {string} key
+     * @returns {string}
+     */
+    set_items(key) {
+        let deferred3_0;
+        let deferred3_1;
+        try {
+            const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ret = wasm.wasmstatestore_set_items(this.__wbg_ptr, ptr0, len0);
+            var ptr2 = ret[0];
+            var len2 = ret[1];
+            if (ret[3]) {
+                ptr2 = 0; len2 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred3_0 = ptr2;
+            deferred3_1 = len2;
+            return getStringFromWasm0(ptr2, len2);
+        } finally {
+            wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
+        }
+    }
+    /**
+     * Write a JSON-encoded value to the named LWW register.
+     *
+     * Returns the resulting [`Envelope`] serialised as a JSON string, ready
+     * to broadcast to peer nodes.
+     * @param {string} key
+     * @param {string} value_json
+     * @returns {string}
+     */
+    set_register(key, value_json) {
+        let deferred4_0;
+        let deferred4_1;
+        try {
+            const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ptr1 = passStringToWasm0(value_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            const ret = wasm.wasmstatestore_set_register(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+            var ptr3 = ret[0];
+            var len3 = ret[1];
+            if (ret[3]) {
+                ptr3 = 0; len3 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred4_0 = ptr3;
+            deferred4_1 = len3;
+            return getStringFromWasm0(ptr3, len3);
+        } finally {
+            wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+        }
+    }
+    /**
+     * Remove a JSON-encoded element from the named OR-Set.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string, or `undefined` if
+     * the element was not present in the set.
+     *
+     * Throws a JavaScript error if `value_json` is not valid JSON.
+     * @param {string} key
+     * @param {string} value_json
+     * @returns {string | undefined}
+     */
+    set_remove(key, value_json) {
+        const ptr0 = passStringToWasm0(key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(value_json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.wasmstatestore_set_remove(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        if (ret[3]) {
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        let v3;
+        if (ret[0] !== 0) {
+            v3 = getStringFromWasm0(ret[0], ret[1]).slice();
+            wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        }
+        return v3;
+    }
+}
+if (Symbol.dispose) WasmStateStore.prototype[Symbol.dispose] = WasmStateStore.prototype.free;
+export function __wbg___wbindgen_throw_df03e93053e0f4bc(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+}
+export function __wbg_getRandomValues_3dda8830c2565714() { return handleError(function (arg0, arg1) {
+    globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
+}, arguments); }
+export function __wbindgen_cast_0000000000000001(arg0, arg1) {
+    // Cast intrinsic for `Ref(String) -> Externref`.
+    const ret = getStringFromWasm0(arg0, arg1);
+    return ret;
+}
+export function __wbindgen_init_externref_table() {
+    const table = wasm.__wbindgen_externrefs;
+    const offset = table.grow(4);
+    table.set(0, undefined);
+    table.set(offset + 0, undefined);
+    table.set(offset + 1, null);
+    table.set(offset + 2, true);
+    table.set(offset + 3, false);
+}
+const WasmStateStoreFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_wasmstatestore_free(ptr >>> 0, 1));
+
+function addToExternrefTable0(obj) {
+    const idx = wasm.__externref_table_alloc();
+    wasm.__wbindgen_externrefs.set(idx, obj);
+    return idx;
+}
+
+function getArrayU8FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        const idx = addToExternrefTable0(e);
+        wasm.__wbindgen_exn_store(idx);
+    }
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}

package/pkg/bundler/crdt_sync_bg.wasm.d.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_wasmstatestore_free: (a: number, b: number) => void;
+export const wasmstatestore_apply_envelope: (a: number, b: number, c: number) => [number, number];
+export const wasmstatestore_clock: (a: number) => number;
+export const wasmstatestore_get_register: (a: number, b: number, c: number) => [number, number];
+export const wasmstatestore_new: (a: number, b: number) => number;
+export const wasmstatestore_seq_delete: (a: number, b: number, c: number, d: number) => [number, number];
+export const wasmstatestore_seq_insert: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+export const wasmstatestore_seq_items: (a: number, b: number, c: number) => [number, number, number, number];
+export const wasmstatestore_seq_len: (a: number, b: number, c: number) => number;
+export const wasmstatestore_set_add: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const wasmstatestore_set_contains: (a: number, b: number, c: number, d: number, e: number) => number;
+export const wasmstatestore_set_items: (a: number, b: number, c: number) => [number, number, number, number];
+export const wasmstatestore_set_register: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const wasmstatestore_set_remove: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __wbindgen_start: () => void;

package/pkg/bundler/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "crdt-sync",
+  "type": "module",
+  "description": "A generic state synchronization engine based on CRDTs (Conflict-free Replicated Data Types) for keeping distributed state in harmony without conflicts.",
+  "version": "0.1.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/franruedaesq/CRDT-sync"
+  },
+  "files": [
+    "crdt_sync_bg.wasm",
+    "crdt_sync.js",
+    "crdt_sync_bg.js",
+    "crdt_sync.d.ts"
+  ],
+  "main": "crdt_sync.js",
+  "types": "crdt_sync.d.ts",
+  "sideEffects": [
+    "./crdt_sync.js",
+    "./snippets/*"
+  ],
+  "keywords": [
+    "crdt",
+    "sync",
+    "distributed",
+    "state",
+    "conflict-free"
+  ]
+}