@powersync/web 0.0.0-dev-20240506092851

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,55 @@
+<p align="center">
+  <a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/19345049/602bafa0-41ce-4cee-a432-56848c278722"/></a>
+</p>
+
+# PowerSync SDK for Web
+
+[PowerSync](https://powersync.com) is a service and set of SDKs that keeps Postgres databases in sync with on-device SQLite databases.
+
+This package (`packages/web`) is the PowerSync SDK for JavaScript Web clients. It is an extension of `packages/common`.
+
+See a summary of features [here](https://docs.powersync.com/client-sdk-references/js-web).
+
+## Beta Release
+
+The web SDK package is currently in a Beta release.
+
+# Installation
+
+## Install Package
+
+```bash
+npm install @powersync/web
+```
+
+## Install Peer Dependency: WA-SQLite
+
+This SDK currently requires `@journeyapps/wa-sqlite` as a peer dependency.
+
+Install it in your app with:
+
+```bash
+npm install @journeyapps/wa-sqlite
+```
+
+# Getting Started
+
+Our [full SDK reference](https://docs.powersync.com/client-sdk-references/js-web) contains everything you need to know to get started implementing PowerSync in your project.
+
+# Changelog
+
+A changelog for this SDK is available [here](https://releases.powersync.com/announcements/powersync-js-web-client-sdk).
+
+# API Reference
+
+The full API reference for this SDK can be found [here](https://powersync-ja.github.io/powersync-js/web-sdk).
+
+# Examples
+
+For example projects built with PowerSync on Web, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#js-web) gallery. Most of these projects can also be found in the [`demos/`](../demos/) directory.
+
+# Found a bug or need help?
+
+- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
+- Please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues) when you come across a bug.
+- Have feedback or an idea? [Submit an idea](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) via our public roadmap or [schedule a chat](https://calendly.com/powersync-product/powersync-chat) with someone from our product team.

package/lib/src/db/PowerSyncDatabase.d.ts

@@ -0,0 +1,43 @@
+import { AbstractPowerSyncDatabase, AbstractStreamingSyncImplementation, PowerSyncBackendConnector, BucketStorageAdapter, PowerSyncDatabaseOptions, PowerSyncCloseOptions } from '@powersync/common';
+import { Mutex } from 'async-mutex';
+export interface WebPowerSyncFlags {
+    /**
+     * Enables multi tab support
+     */
+    enableMultiTabs?: boolean;
+    /**
+     * Open in SSR placeholder mode. DB operations and Sync operations will be a No-op
+     */
+    ssrMode?: boolean;
+    /**
+     * Externally unload open PowerSync database instances when the window closes.
+     * Setting this to `true` requires calling `close` on all open PowerSyncDatabase
+     * instances before the window unloads
+     */
+    externallyUnload?: boolean;
+    /**
+     * Broadcast logs from shared workers, such as the shared sync worker,
+     * to individual tabs. This defaults to true.
+     */
+    broadcastLogs?: boolean;
+}
+export interface WebPowerSyncDatabaseOptions extends PowerSyncDatabaseOptions {
+    flags?: WebPowerSyncFlags;
+}
+export declare class PowerSyncDatabase extends AbstractPowerSyncDatabase {
+    protected options: WebPowerSyncDatabaseOptions;
+    static SHARED_MUTEX: Mutex;
+    protected unloadListener?: () => Promise<void>;
+    constructor(options: WebPowerSyncDatabaseOptions);
+    _initialize(): Promise<void>;
+    /**
+     * Closes the database connection.
+     * By default the sync stream client is only disconnected if
+     * multiple tabs are not enabled.
+     */
+    close(options?: PowerSyncCloseOptions): Promise<void>;
+    connect(connector: PowerSyncBackendConnector): Promise<void>;
+    protected generateBucketStorageAdapter(): BucketStorageAdapter;
+    protected runExclusive<T>(cb: () => Promise<T>): Promise<any>;
+    protected generateSyncStreamImplementation(connector: PowerSyncBackendConnector): AbstractStreamingSyncImplementation;
+}

package/lib/src/db/PowerSyncDatabase.js

@@ -0,0 +1,91 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { AbstractPowerSyncDatabase, SqliteBucketStorage, DEFAULT_POWERSYNC_CLOSE_OPTIONS } from '@powersync/common';
+import { WebRemote } from './sync/WebRemote';
+import { SharedWebStreamingSyncImplementation } from './sync/SharedWebStreamingSyncImplementation';
+import { SSRStreamingSyncImplementation } from './sync/SSRWebStreamingSyncImplementation';
+import { WebStreamingSyncImplementation } from './sync/WebStreamingSyncImplementation';
+import { Mutex } from 'async-mutex';
+export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
+    constructor(options) {
+        super(options);
+        this.options = options;
+        const { flags } = this.options;
+        if ((flags === null || flags === void 0 ? void 0 : flags.enableMultiTabs) && !flags.externallyUnload) {
+            this.unloadListener = () => this.close({ disconnect: false });
+            window.addEventListener('unload', this.unloadListener);
+        }
+    }
+    _initialize() {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    /**
+     * Closes the database connection.
+     * By default the sync stream client is only disconnected if
+     * multiple tabs are not enabled.
+     */
+    close(options = DEFAULT_POWERSYNC_CLOSE_OPTIONS) {
+        var _a, _b;
+        if (this.unloadListener) {
+            window.removeEventListener('unload', this.unloadListener);
+        }
+        return super.close({
+            // Don't disconnect by default if multiple tabs are enabled
+            disconnect: (_a = options.disconnect) !== null && _a !== void 0 ? _a : !((_b = this.options.flags) === null || _b === void 0 ? void 0 : _b.enableMultiTabs)
+        });
+    }
+    connect(connector) {
+        /**
+         * Using React strict mode might cause calls to connect to fire multiple times
+         * Connect is wrapped inside a lock in order to prevent race conditions internally between multiple
+         * connection attempts.
+         */
+        return this.runExclusive(() => {
+            var _a;
+            (_a = this.options.logger) === null || _a === void 0 ? void 0 : _a.debug('Attempting to connect to PowerSync instance');
+            return super.connect(connector);
+        });
+    }
+    generateBucketStorageAdapter() {
+        return new SqliteBucketStorage(this.database, AbstractPowerSyncDatabase.transactionMutex);
+    }
+    runExclusive(cb) {
+        var _a;
+        if ((_a = this.options.flags) === null || _a === void 0 ? void 0 : _a.ssrMode) {
+            return PowerSyncDatabase.SHARED_MUTEX.runExclusive(cb);
+        }
+        return navigator.locks.request(`lock-${this.options.database.name}`, cb);
+    }
+    generateSyncStreamImplementation(connector) {
+        const remote = new WebRemote(connector);
+        const syncOptions = Object.assign(Object.assign({}, this.options), { adapter: this.bucketStorageAdapter, remote, uploadCrud: () => __awaiter(this, void 0, void 0, function* () {
+                yield this.waitForReady();
+                yield connector.uploadData(this);
+            }), identifier: this.options.database.name });
+        const { flags } = this.options;
+        switch (true) {
+            case flags === null || flags === void 0 ? void 0 : flags.ssrMode:
+                return new SSRStreamingSyncImplementation(syncOptions);
+            case flags === null || flags === void 0 ? void 0 : flags.enableMultiTabs:
+                if (!(flags === null || flags === void 0 ? void 0 : flags.broadcastLogs)) {
+                    const warning = `
+Multiple tabs are enabled, but broadcasting of logs is disabled.
+Logs for shared sync worker will only be available in the shared worker context
+          `;
+                    const logger = this.options.logger;
+                    logger ? logger.warn(warning) : console.warn(warning);
+                }
+                return new SharedWebStreamingSyncImplementation(syncOptions);
+            default:
+                return new WebStreamingSyncImplementation(syncOptions);
+        }
+    }
+}
+PowerSyncDatabase.SHARED_MUTEX = new Mutex();

package/lib/src/db/adapters/AbstractWebPowerSyncDatabaseOpenFactory.d.ts

@@ -0,0 +1,23 @@
+import { AbstractPowerSyncDatabase, AbstractPowerSyncDatabaseOpenFactory, PowerSyncDatabaseOptions, PowerSyncOpenFactoryOptions } from '@powersync/common';
+import { WebPowerSyncDatabaseOptions, WebPowerSyncFlags } from '../../db/PowerSyncDatabase';
+export interface WebPowerSyncOpenFlags extends WebPowerSyncFlags {
+    disableSSRWarning?: boolean;
+}
+export interface WebPowerSyncOpenFactoryOptions extends PowerSyncOpenFactoryOptions {
+    flags?: WebPowerSyncOpenFlags;
+}
+export declare const DEFAULT_POWERSYNC_FLAGS: WebPowerSyncOpenFlags;
+/**
+ * Intermediate PowerSync Database Open factory for Web which uses a mock
+ * SSR DB Adapter if running on server side.
+ * Most SQLite DB implementations only run on client side, this will safely return
+ * empty query results in SSR which will allow for generating server partial views.
+ */
+export declare abstract class AbstractWebPowerSyncDatabaseOpenFactory extends AbstractPowerSyncDatabaseOpenFactory {
+    protected options: WebPowerSyncOpenFactoryOptions;
+    protected isServerSide(): boolean;
+    constructor(options: WebPowerSyncOpenFactoryOptions);
+    generateOptions(): WebPowerSyncDatabaseOptions;
+    protected resolveDBFlags(): WebPowerSyncFlags;
+    generateInstance(options: PowerSyncDatabaseOptions): AbstractPowerSyncDatabase;
+}

package/lib/src/db/adapters/AbstractWebPowerSyncDatabaseOpenFactory.js

@@ -0,0 +1,56 @@
+import { AbstractPowerSyncDatabaseOpenFactory } from '@powersync/common';
+import { PowerSyncDatabase } from '../../db/PowerSyncDatabase';
+import { SSRDBAdapter } from './SSRDBAdapter';
+export const DEFAULT_POWERSYNC_FLAGS = {
+    /**
+     * Multiple tabs are by default not supported on Android, iOS and Safari.
+     * Other platforms will have multiple tabs enabled by default.
+     */
+    enableMultiTabs: typeof globalThis.navigator !== 'undefined' && // For SSR purposes
+        typeof SharedWorker !== 'undefined' &&
+        !navigator.userAgent.match(/(Android|iPhone|iPod|iPad)/i) &&
+        !window.safari,
+    broadcastLogs: true
+};
+/**
+ * Intermediate PowerSync Database Open factory for Web which uses a mock
+ * SSR DB Adapter if running on server side.
+ * Most SQLite DB implementations only run on client side, this will safely return
+ * empty query results in SSR which will allow for generating server partial views.
+ */
+export class AbstractWebPowerSyncDatabaseOpenFactory extends AbstractPowerSyncDatabaseOpenFactory {
+    isServerSide() {
+        return typeof window == 'undefined';
+    }
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    generateOptions() {
+        var _a;
+        const isServerSide = this.isServerSide();
+        if (isServerSide && !((_a = this.options.flags) === null || _a === void 0 ? void 0 : _a.disableSSRWarning)) {
+            console.warn(`
+  Running PowerSync in SSR mode.
+  Only empty query results will be returned.
+  Disable this warning by setting 'disableSSRWarning: true' in options.`);
+        }
+        // Resolve flags for PowerSync DB client
+        const resolvedFlags = this.resolveDBFlags();
+        if (!resolvedFlags.enableMultiTabs) {
+            console.warn('Multiple tab support is not enabled. Using this site across multiple tabs may not function correctly.');
+        }
+        return Object.assign(Object.assign({}, this.options), { database: isServerSide ? new SSRDBAdapter() : this.openDB(), schema: this.schema, flags: resolvedFlags });
+    }
+    resolveDBFlags() {
+        var _a, _b;
+        const flags = Object.assign(Object.assign(Object.assign({}, DEFAULT_POWERSYNC_FLAGS), { ssrMode: this.isServerSide() }), ((_a = this.options.flags) !== null && _a !== void 0 ? _a : {}));
+        if (typeof ((_b = this.options.flags) === null || _b === void 0 ? void 0 : _b.enableMultiTabs) != 'undefined') {
+            flags.enableMultiTabs = this.options.flags.enableMultiTabs;
+        }
+        return flags;
+    }
+    generateInstance(options) {
+        return new PowerSyncDatabase(options);
+    }
+}

package/lib/src/db/adapters/SSRDBAdapter.d.ts

@@ -0,0 +1,29 @@
+import { BaseObserver, DBAdapterListener, DBAdapter, DBLockOptions, LockContext, QueryResult, Transaction } from '@powersync/common';
+import { Mutex } from 'async-mutex';
+/**
+ * Implements a Mock DB adapter for use in Server Side Rendering (SSR).
+ * This adapter will return empty results for queries, which will allow
+ * server rendered views to initially generate scaffolding components
+ */
+export declare class SSRDBAdapter extends BaseObserver<DBAdapterListener> implements DBAdapter {
+    name: string;
+    readMutex: Mutex;
+    writeMutex: Mutex;
+    constructor();
+    close(): void;
+    readLock<T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    readTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    writeLock<T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    writeTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    execute(query: string, params?: any[]): Promise<QueryResult>;
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[] | undefined): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[] | undefined): Promise<T>;
+    /**
+     * Generates a mock context for use in read/write transactions.
+     * `this` already mocks most of the API, commit and rollback mocks
+     *  are added here
+     */
+    private generateMockTransactionContext;
+}

package/lib/src/db/adapters/SSRDBAdapter.js

@@ -0,0 +1,85 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { BaseObserver } from '@powersync/common';
+import { Mutex } from 'async-mutex';
+const MOCK_QUERY_RESPONSE = {
+    rowsAffected: 0
+};
+/**
+ * Implements a Mock DB adapter for use in Server Side Rendering (SSR).
+ * This adapter will return empty results for queries, which will allow
+ * server rendered views to initially generate scaffolding components
+ */
+export class SSRDBAdapter extends BaseObserver {
+    constructor() {
+        super();
+        this.name = 'SSR DB';
+        this.readMutex = new Mutex();
+        this.writeMutex = new Mutex();
+    }
+    close() { }
+    readLock(fn, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.readMutex.runExclusive(() => fn(this));
+        });
+    }
+    readTransaction(fn, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.readLock(() => fn(this.generateMockTransactionContext()));
+        });
+    }
+    writeLock(fn, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.writeMutex.runExclusive(() => fn(this));
+        });
+    }
+    writeTransaction(fn, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.writeLock(() => fn(this.generateMockTransactionContext()));
+        });
+    }
+    execute(query, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.writeMutex.runExclusive(() => __awaiter(this, void 0, void 0, function* () { return MOCK_QUERY_RESPONSE; }));
+        });
+    }
+    executeBatch(query, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.writeMutex.runExclusive(() => __awaiter(this, void 0, void 0, function* () { return MOCK_QUERY_RESPONSE; }));
+        });
+    }
+    getAll(sql, parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return [];
+        });
+    }
+    getOptional(sql, parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return null;
+        });
+    }
+    get(sql, parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw new Error(`No values are returned in SSR mode`);
+        });
+    }
+    /**
+     * Generates a mock context for use in read/write transactions.
+     * `this` already mocks most of the API, commit and rollback mocks
+     *  are added here
+     */
+    generateMockTransactionContext() {
+        return Object.assign(Object.assign({}, this), { commit: () => __awaiter(this, void 0, void 0, function* () {
+                return MOCK_QUERY_RESPONSE;
+            }), rollback: () => __awaiter(this, void 0, void 0, function* () {
+                return MOCK_QUERY_RESPONSE;
+            }) });
+    }
+}

package/lib/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.d.ts

@@ -0,0 +1,56 @@
+import { BaseObserver, DBAdapter, DBAdapterListener, DBLockOptions, LockContext, PowerSyncOpenFactoryOptions, QueryResult, Transaction } from '@powersync/common';
+export type WASQLiteFlags = {
+    enableMultiTabs?: boolean;
+};
+export interface WASQLiteDBAdapterOptions extends Omit<PowerSyncOpenFactoryOptions, 'schema'> {
+    flags?: WASQLiteFlags;
+    /**
+     * Use an existing port to an initialized worker.
+     * A worker will be initialized if none is provided
+     */
+    workerPort?: MessagePort;
+}
+/**
+ * Adapter for WA-SQLite
+ */
+export declare class WASQLiteDBAdapter extends BaseObserver<DBAdapterListener> implements DBAdapter {
+    protected options: WASQLiteDBAdapterOptions;
+    private initialized;
+    private logger;
+    private dbGetHelpers;
+    private workerMethods;
+    constructor(options: WASQLiteDBAdapterOptions);
+    get name(): string;
+    protected get flags(): WASQLiteFlags;
+    getWorker(): void;
+    protected init(): Promise<void>;
+    execute(query: string, params?: any[] | undefined): Promise<QueryResult>;
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
+    /**
+     * Wraps the worker execute function, awaiting for it to be available
+     */
+    private _execute;
+    /**
+     * Wraps the worker executeBatch function, awaiting for it to be available
+     */
+    private _executeBatch;
+    /**
+     * Attempts to close the connection.
+     * Shared workers might not actually close the connection if other
+     * tabs are still using it.
+     */
+    close(): void;
+    getAll<T>(sql: string, parameters?: any[] | undefined): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[] | undefined): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[] | undefined): Promise<T>;
+    readLock<T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions | undefined): Promise<T>;
+    writeLock<T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions | undefined): Promise<T>;
+    protected acquireLock(callback: () => Promise<any>): Promise<any>;
+    readTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions | undefined): Promise<T>;
+    writeTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions | undefined): Promise<T>;
+    /**
+     * Wraps a lock context into a transaction context
+     */
+    private wrapTransaction;
+    private generateDBHelpers;
+}