@powersync/common 0.0.0-dev-20240506092851

package/lib/index.d.ts

@@ -0,0 +1,32 @@
+export * from './client/AbstractPowerSyncDatabase';
+export * from './client/AbstractPowerSyncOpenFactory';
+export * from './client/connection/PowerSyncBackendConnector';
+export * from './client/connection/PowerSyncCredentials';
+export * from './client/sync/bucket/BucketStorageAdapter';
+export * from './client/sync/bucket/CrudEntry';
+export * from './client/sync/bucket/SqliteBucketStorage';
+export * from './client/sync/bucket/CrudBatch';
+export * from './client/sync/bucket/CrudTransaction';
+export * from './client/sync/bucket/SyncDataBatch';
+export * from './client/sync/bucket/SyncDataBucket';
+export * from './client/sync/bucket/OpType';
+export * from './client/sync/bucket/OplogEntry';
+export * from './client/sync/stream/AbstractRemote';
+export * from './client/sync/stream/AbstractStreamingSyncImplementation';
+export * from './client/sync/stream/streaming-sync-types';
+export * from './db/crud/SyncStatus';
+export * from './db/crud/UploadQueueStatus';
+export * from './db/schema/Schema';
+export * from './db/schema/Table';
+export * from './db/schema/Index';
+export * from './db/schema/IndexedColumn';
+export * from './db/crud/SyncStatus';
+export * from './db/crud/UploadQueueStatus';
+export * from './db/DBAdapter';
+export * from './db/Column';
+export * from './db/schema/TableV2';
+export * from './utils/AbortOperation';
+export * from './utils/BaseObserver';
+export * from './utils/strings';
+export * from './utils/parseQuery';
+export * from './types/types';

package/lib/index.js

@@ -0,0 +1,32 @@
+export * from './client/AbstractPowerSyncDatabase';
+export * from './client/AbstractPowerSyncOpenFactory';
+export * from './client/connection/PowerSyncBackendConnector';
+export * from './client/connection/PowerSyncCredentials';
+export * from './client/sync/bucket/BucketStorageAdapter';
+export * from './client/sync/bucket/CrudEntry';
+export * from './client/sync/bucket/SqliteBucketStorage';
+export * from './client/sync/bucket/CrudBatch';
+export * from './client/sync/bucket/CrudTransaction';
+export * from './client/sync/bucket/SyncDataBatch';
+export * from './client/sync/bucket/SyncDataBucket';
+export * from './client/sync/bucket/OpType';
+export * from './client/sync/bucket/OplogEntry';
+export * from './client/sync/stream/AbstractRemote';
+export * from './client/sync/stream/AbstractStreamingSyncImplementation';
+export * from './client/sync/stream/streaming-sync-types';
+export * from './db/crud/SyncStatus';
+export * from './db/crud/UploadQueueStatus';
+export * from './db/schema/Schema';
+export * from './db/schema/Table';
+export * from './db/schema/Index';
+export * from './db/schema/IndexedColumn';
+export * from './db/crud/SyncStatus';
+export * from './db/crud/UploadQueueStatus';
+export * from './db/DBAdapter';
+export * from './db/Column';
+export * from './db/schema/TableV2';
+export * from './utils/AbortOperation';
+export * from './utils/BaseObserver';
+export * from './utils/strings';
+export * from './utils/parseQuery';
+export * from './types/types';

package/lib/types/types.d.ts

@@ -0,0 +1,8 @@
+export interface CompilableQuery<T> {
+    execute(): Promise<T[]>;
+    compile(): CompiledQuery;
+}
+export interface CompiledQuery {
+    readonly sql: string;
+    readonly parameters: ReadonlyArray<unknown>;
+}

package/lib/types/types.js

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

package/lib/utils/AbortOperation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Calls to Abortcontroller.abort(reason: any) will result in the
+ * `reason` being thrown. This is not necessarily an error,
+ *  but extends error for better logging purposes.
+ */
+export declare class AbortOperation extends Error {
+    protected reason: string;
+    constructor(reason: string);
+}

package/lib/utils/AbortOperation.js

@@ -0,0 +1,18 @@
+/**
+ * Calls to Abortcontroller.abort(reason: any) will result in the
+ * `reason` being thrown. This is not necessarily an error,
+ *  but extends error for better logging purposes.
+ */
+export class AbortOperation extends Error {
+    reason;
+    constructor(reason) {
+        super(reason);
+        this.reason = reason;
+        // Set the prototype explicitly
+        Object.setPrototypeOf(this, AbortOperation.prototype);
+        // Capture stack trace
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, AbortOperation);
+        }
+    }
+}

package/lib/utils/BaseObserver.d.ts

@@ -0,0 +1,20 @@
+export interface Disposable {
+    dispose: () => Promise<void>;
+}
+export interface BaseObserverInterface<T extends BaseListener> {
+    registerListener(listener: Partial<T>): () => void;
+}
+export type BaseListener = {
+    [key: string]: ((...event: any) => any) | undefined;
+};
+export declare class BaseObserver<T extends BaseListener = BaseListener> implements BaseObserverInterface<T> {
+    protected listeners: {
+        [id: string]: Partial<T>;
+    };
+    constructor();
+    /**
+     * Register a listener for updates to the PowerSync client.
+     */
+    registerListener(listener: Partial<T>): () => void;
+    iterateListeners(cb: (listener: Partial<T>) => any): void;
+}

package/lib/utils/BaseObserver.js

@@ -0,0 +1,22 @@
+import { v4 } from 'uuid';
+export class BaseObserver {
+    listeners;
+    constructor() {
+        this.listeners = {};
+    }
+    /**
+     * Register a listener for updates to the PowerSync client.
+     */
+    registerListener(listener) {
+        const id = v4();
+        this.listeners[id] = listener;
+        return () => {
+            delete this.listeners[id];
+        };
+    }
+    iterateListeners(cb) {
+        for (const i in this.listeners) {
+            cb(this.listeners[i]);
+        }
+    }
+}

package/lib/utils/mutex.d.ts

@@ -0,0 +1,7 @@
+import { Mutex } from 'async-mutex';
+/**
+ * Wrapper for async-mutex runExclusive, which allows for a timeout on each exclusive lock.
+ */
+export declare function mutexRunExclusive<T>(mutex: Mutex, callback: () => Promise<T>, options?: {
+    timeoutMs: number;
+}): Promise<T>;

package/lib/utils/mutex.js

@@ -0,0 +1,28 @@
+/**
+ * Wrapper for async-mutex runExclusive, which allows for a timeout on each exclusive lock.
+ */
+export async function mutexRunExclusive(mutex, callback, options) {
+    return new Promise((resolve, reject) => {
+        const timeout = options?.timeoutMs;
+        let timedOut = false;
+        const timeoutId = timeout
+            ? setTimeout(() => {
+                timedOut = true;
+                reject(new Error('Timeout waiting for lock'));
+            }, timeout)
+            : undefined;
+        mutex.runExclusive(async () => {
+            if (timeoutId) {
+                clearTimeout(timeoutId);
+            }
+            if (timedOut)
+                return;
+            try {
+                resolve(await callback());
+            }
+            catch (ex) {
+                reject(ex);
+            }
+        });
+    });
+}

package/lib/utils/parseQuery.d.ts

@@ -0,0 +1,6 @@
+import type { CompilableQuery } from '../types/types';
+export interface ParsedQuery {
+    sqlStatement: string;
+    parameters: any[];
+}
+export declare const parseQuery: <T>(query: string | CompilableQuery<T>, parameters: any[]) => ParsedQuery;

package/lib/utils/parseQuery.js

@@ -0,0 +1,16 @@
+export const parseQuery = (query, parameters) => {
+    let sqlStatement;
+    if (typeof query == 'string') {
+        sqlStatement = query;
+    }
+    else {
+        const hasAdditionalParameters = parameters.length > 0;
+        if (hasAdditionalParameters) {
+            throw new Error('You cannot pass parameters to a compiled query.');
+        }
+        const compiled = query.compile();
+        sqlStatement = compiled.sql;
+        parameters = compiled.parameters;
+    }
+    return { sqlStatement, parameters: parameters };
+};

package/lib/utils/strings.d.ts

@@ -0,0 +1,3 @@
+export declare function quoteString(s: string): string;
+export declare function quoteJsonPath(path: string): string;
+export declare function quoteIdentifier(s: string): string;

package/lib/utils/strings.js

@@ -0,0 +1,9 @@
+export function quoteString(s) {
+    return `'${s.replaceAll("'", "''")}'`;
+}
+export function quoteJsonPath(path) {
+    return quoteString(`$.${path}`);
+}
+export function quoteIdentifier(s) {
+    return `"${s.replaceAll('"', '""')}"`;
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@powersync/common",
+  "version": "0.0.0-dev-20240506092851",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "description": "API definitions for JourneyApps PowerSync",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "author": "JOURNEYAPPS",
+  "license": "Apache-2.0",
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/powersync-ja/powersync-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/powersync-ja/powersync-js/issues"
+  },
+  "homepage": "https://docs.powersync.com/resources/api-reference",
+  "dependencies": {
+    "async-mutex": "^0.4.0",
+    "can-ndjson-stream": "^1.0.2",
+    "event-iterator": "^2.0.0",
+    "js-logger": "^1.6.1",
+    "lodash": "^4.17.21",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.197",
+    "@types/node": "^20.5.9",
+    "@types/uuid": "^9.0.1",
+    "typescript": "^5.1.3",
+    "vitest": "^1.5.2"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "rm -rf lib tsconfig.tsbuildinfo",
+    "test": "vitest"
+  }
+}