@tursodatabase/sync-common 0.2.0-pre.1

package/README.md

@@ -0,0 +1,8 @@
+## About
+
+This package is the Turso Sync common JS library which is shared between final builds for Node and Browser.
+
+Do not use this package directly - instead you must use `@tursodatabase/sync` or `@tursodatabase/sync-browser`.
+
+> **⚠️ Warning:** This software is ALPHA, only use for development, testing, and experimentation. We are working to make it production ready, but do not use it for critical data right now.
+

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { run, memoryIO } from "./run.js";
+import { SyncOpts, ProtocolIo, RunOpts, DatabaseRowMutation, DatabaseRowStatement, DatabaseRowTransformResult } from "./types.js";
+export { run, memoryIO, };
+export type { SyncOpts, ProtocolIo, RunOpts, DatabaseRowMutation, DatabaseRowStatement, DatabaseRowTransformResult };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAEjI,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAA;AACzB,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+import { run, memoryIO } from "./run.js";
+export { run, memoryIO, };

package/dist/run.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolIo, RunOpts } from "./types.js";
+export declare function memoryIO(): ProtocolIo;
+export declare function run(opts: RunOpts, io: ProtocolIo, engine: any, generator: any): Promise<any>;
+//# sourceMappingURL=run.d.ts.map

package/dist/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../run.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,UAAU,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AA2FpE,wBAAgB,QAAQ,IAAI,UAAU,CAUrC;AAGD,wBAAsB,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAoBlG"}

package/dist/run.js

@@ -0,0 +1,121 @@
+"use strict";
+const GENERATOR_RESUME_IO = 0;
+const GENERATOR_RESUME_DONE = 1;
+function trackPromise(p) {
+    let status = { promise: null, finished: false };
+    status.promise = p.finally(() => status.finished = true);
+    return status;
+}
+function timeoutMs(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+async function process(opts, io, request) {
+    const requestType = request.request();
+    const completion = request.completion();
+    if (requestType.type == 'Http') {
+        try {
+            let headers = opts.headers;
+            if (requestType.headers != null && requestType.headers.length > 0) {
+                headers = { ...opts.headers };
+                for (let header of requestType.headers) {
+                    headers[header[0]] = header[1];
+                }
+            }
+            const response = await fetch(`${opts.url}${requestType.path}`, {
+                method: requestType.method,
+                headers: headers,
+                body: requestType.body != null ? new Uint8Array(requestType.body) : null,
+            });
+            completion.status(response.status);
+            const reader = response.body.getReader();
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done) {
+                    completion.done();
+                    break;
+                }
+                completion.pushBuffer(value);
+            }
+        }
+        catch (error) {
+            completion.poison(`fetch error: ${error}`);
+        }
+    }
+    else if (requestType.type == 'FullRead') {
+        try {
+            const metadata = await io.read(requestType.path);
+            if (metadata != null) {
+                completion.pushBuffer(metadata);
+            }
+            completion.done();
+        }
+        catch (error) {
+            completion.poison(`metadata read error: ${error}`);
+        }
+    }
+    else if (requestType.type == 'FullWrite') {
+        try {
+            await io.write(requestType.path, requestType.content);
+            completion.done();
+        }
+        catch (error) {
+            completion.poison(`metadata write error: ${error}`);
+        }
+    }
+    else if (requestType.type == 'Transform') {
+        if (opts.transform == null) {
+            completion.poison("transform is not set");
+            return;
+        }
+        const results = [];
+        for (const mutation of requestType.mutations) {
+            const result = opts.transform(mutation);
+            if (result == null) {
+                results.push({ type: 'Keep' });
+            }
+            else if (result.operation == 'skip') {
+                results.push({ type: 'Skip' });
+            }
+            else if (result.operation == 'rewrite') {
+                results.push({ type: 'Rewrite', stmt: result.stmt });
+            }
+            else {
+                completion.poison("unexpected transform operation");
+                return;
+            }
+        }
+        completion.pushTransform(results);
+        completion.done();
+    }
+}
+export function memoryIO() {
+    let values = new Map();
+    return {
+        async read(path) {
+            return values.get(path);
+        },
+        async write(path, data) {
+            values.set(path, data);
+        }
+    };
+}
+;
+export async function run(opts, io, engine, generator) {
+    let tasks = [];
+    while (true) {
+        const { type, ...rest } = await generator.resumeAsync(null);
+        if (type == 'Done') {
+            return null;
+        }
+        if (type == 'SyncEngineStats') {
+            return rest;
+        }
+        for (let request = engine.protocolIo(); request != null; request = engine.protocolIo()) {
+            tasks.push(trackPromise(process(opts, io, request)));
+        }
+        const tasksRace = tasks.length == 0 ? Promise.resolve() : Promise.race([timeoutMs(opts.preemptionMs), ...tasks.map(t => t.promise)]);
+        await Promise.all([engine.ioLoopAsync(), tasksRace]);
+        tasks = tasks.filter(t => !t.finished);
+    }
+    return generator.take();
+}

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+export declare const enum DatabaseChangeType {
+    Insert = 0,
+    Update = 1,
+    Delete = 2
+}
+export interface DatabaseRowMutation {
+    changeTime: number;
+    tableName: string;
+    id: number;
+    changeType: DatabaseChangeType;
+    before?: Record<string, any>;
+    after?: Record<string, any>;
+    updates?: Record<string, any>;
+}
+export type DatabaseRowTransformResult = {
+    operation: 'skip';
+} | {
+    operation: 'rewrite';
+    stmt: DatabaseRowStatement;
+} | null;
+export type Transform = (arg: DatabaseRowMutation) => DatabaseRowTransformResult;
+export interface RunOpts {
+    preemptionMs: number;
+    url: string;
+    headers: {
+        [K: string]: string;
+    };
+    transform?: Transform;
+}
+export interface ProtocolIo {
+    read(path: string): Promise<Buffer | Uint8Array | null>;
+    write(path: string, content: Buffer | Uint8Array): Promise<void>;
+}
+export interface SyncOpts {
+    path: string;
+    clientName?: string;
+    url: string;
+    authToken?: string;
+    encryptionKey?: string;
+    tablesIgnore?: string[];
+    transform?: Transform;
+    tracing?: string;
+}
+export interface DatabaseRowStatement {
+    sql: string;
+    values: Array<any>;
+}
+export type GeneratorResponse = {
+    type: 'IO';
+} | {
+    type: 'Done';
+} | {
+    type: 'SyncEngineStats';
+    operations: number;
+    mainWal: number;
+    revertWal: number;
+    lastPullUnixTime: number;
+    lastPushUnixTime: number | null;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,CAAC,KAAK,MAAM,kBAAkB;IACxC,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACb;AAED,MAAM,WAAW,mBAAmB;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,kBAAkB,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAChC;AAED,MAAM,MAAM,0BAA0B,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAAG,IAAI,CAAC;AAC7H,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,mBAAmB,KAAK,0BAA0B,CAAC;AACjF,MAAM,WAAW,OAAO;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC;IACxD,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;CACrB;AAED,MAAM,MAAM,iBAAiB,GACvB;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GACd;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAA"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@tursodatabase/sync-common",
+  "version": "0.2.0-pre.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tursodatabase/turso"
+  },
+  "type": "module",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "packageManager": "yarn@4.9.2",
+  "files": [
+    "dist/**",
+    "README.md"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "tsc-build": "npm exec tsc",
+    "build": "npm run tsc-build",
+    "test": "echo 'no tests'"
+  }
+}