@powersync/capacitor 0.0.0-dev-20250922105508

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,95 @@
+<p align="center">
+	<a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
+</p>
+
+# PowerSync SDK for Capacitor
+
+_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB or MySQL on the server-side._
+
+This package (`@powersync/capacitor`) is the PowerSync SDK for Capacitor apps. It wraps the [PowerSync Web SDK](https://www.npmjs.com/package/@powersync/web) and uses [Capacitor Community SQLite](https://github.com/capacitor-community/sqlite) as the database driver for Android and iOS.
+
+## Note: Alpha Release
+
+This package is currently in an alpha release.
+
+## Installation
+
+### Install Package
+
+```bash
+npm install @powersync/capacitor
+```
+
+This package uses `@powersync/web` as a peer dependency. For additional `@powersync/web` configuration and instructions see the Web SDK [README](https://www.npmjs.com/package/@powersync/web).
+
+### Install Peer Dependencies
+
+You must also install the following peer dependencies:
+
+```bash
+npm install @capacitor-community/sqlite @powersync/web @journeyapps/wa-sqlite
+```
+
+See the [Capacitor Community SQLite](https://github.com/capacitor-community/sqlite?tab=readme-ov-file#installation) repository for additional instructions.
+
+### Sync Capacitor Plugins
+
+After installing, sync your Capacitor project:
+
+```bash
+npx cap sync
+```
+
+## Usage
+
+```javascript
+import { PowerSyncDatabase } from '@powersync/capacitor';
+// Import general components from the Web SDK package
+import { Schema } from '@powersync/web';
+/**
+ * The Capacitor PowerSyncDatabase will automatically detect the platform
+ * and use the appropriate database drivers.
+ */
+const db = new PowerSyncDatabase({
+  schema: new Schema({...}),
+  database: {
+    dbFilename: "mydatabase.sqlite"
+  }
+});
+```
+
+- On Android and iOS, this SDK uses [Capacitor Community SQLite](https://github.com/capacitor-community/sqlite) for native database access.
+- On web, it falls back to the [PowerSync Web SDK](https://www.npmjs.com/package/@powersync/web).
+
+When using custom database factories, be sure to specify the `CapacitorSQLiteOpenFactory` for Capacitor platforms.
+
+```javascript
+const db = new PowerSyncDatabase({
+  schema: new Schema({...}),
+  database: isWeb ? new WASQLiteOpenFactory({dbFilename: "mydb.sqlite"}) :
+    new CapacitorSQLiteOpenFactory({dbFilename: "mydb.sqlite"})
+});
+```
+
+## Platform Support
+
+- **Android**: Uses native SQLite via Capacitor Community SQLite.
+- **iOS**: Uses native SQLite via Capacitor Community SQLite.
+- **Web**: Uses WASQLite via the PowerSync Web SDK.
+- **Electron**: Uses WASQLite via the PowerSync Web SDK.
+
+## Limitations
+
+- Encryption for native mobile platforms is not yet supported.
+- Multiple tab support is not available for native Android and iOS targets.
+- The Capacitor Community SQLite APIs differ for execution and query operations. The `.execute()` method cannot be used for `SELECT` queries or `RETURNING` queries.
+
+## Examples
+
+See the [`demos/example-capacitor/`](https://github.com/journeyapps/powersync-react-native-sdk/blob/capacitor-sdk/demos/example-capacitor/README.md#L1) directory for a working example.
+
+## Found a bug or need help?
+
+- Join our [Discord server](https://discord.gg/powersync) to ask questions or share feedback.
+- Open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues) for bugs.
+- Submit ideas via our [public roadmap](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) or [schedule a chat](https://calendly.com/powersync-product/powersync-chat).

package/android/build.gradle

@@ -0,0 +1,71 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+    powerSyncCoreVersion = project.hasProperty('powerSyncCoreVersion') ? rootProject.ext.powerSyncCoreVersion : '0.4.5'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.powersync.capacitor"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    externalNativeBuild {
+        cmake {
+            path "CMakeLists.txt"
+        }
+    }
+
+    buildFeatures {
+        prefab true
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "com.powersync:powersync-sqlite-core:$powerSyncCoreVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/cpp/powersync_capacitor_jni.c

@@ -0,0 +1,58 @@
+#include <jni.h>
+#include <dlfcn.h>
+#include <android/log.h>
+
+#define LOG_TAG "PowerSyncNative"
+
+// Forward declarations (no need for full struct definitions)
+typedef struct sqlite3 sqlite3;
+typedef struct sqlite3_api_routines sqlite3_api_routines;
+
+typedef int (*sqlite3_auto_extension_fn)(void (*xEntryPoint)(void));
+
+extern int sqlite3_powersync_init(
+    sqlite3 *db,                              // Database handle
+    const char **pzErrMsg,                    // Error message out parameter
+    const struct sqlite3_api_routines *pThunk // SQLite API routines
+);
+
+int register_powersync(void) {
+    void *handle = dlopen("libsqlcipher.so", RTLD_LAZY);
+    if (!handle) {
+        __android_log_print(ANDROID_LOG_WARN, LOG_TAG, "Failed to dlopen libsqlcipher.so, trying process handle");
+        // Try loading from the process itself
+        handle = dlopen(NULL, RTLD_LAZY);
+        if (!handle) {
+            __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, "Failed to dlopen process handle. SQLCipher symbols not found.");
+            return -1;
+        }
+    } else {
+        __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Successfully loaded libsqlcipher.so");
+    }
+
+    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Resolving sqlite3_auto_extension symbol");
+    sqlite3_auto_extension_fn auto_ext = (sqlite3_auto_extension_fn)dlsym(handle, "sqlite3_auto_extension");
+    if (!auto_ext) {
+        __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, "Failed to resolve sqlite3_auto_extension symbol");
+    }
+
+
+    if (!auto_ext) {
+        __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, "Required symbols not found. Aborting registration.");
+        dlclose(handle);
+        return -2;
+    }
+
+    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Registering powersync extension");
+    int result = auto_ext((void(*)(void))sqlite3_powersync_init);
+    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "register_powersync result: %d", result);
+    dlclose(handle);
+    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Completed register_powersync");
+    return result;
+}
+
+// JNI wrapper
+JNIEXPORT jint JNICALL
+Java_com_powersync_capacitor_PowerSync_registerPowersync(JNIEnv *env, jobject thiz) {
+    return register_powersync();
+}

package/android/src/main/java/com/powersync/capacitor/PowerSync.java

@@ -0,0 +1,13 @@
+package com.powersync.capacitor;
+
+import com.getcapacitor.Logger;
+
+public class PowerSync {
+    static {
+        System.loadLibrary("powersync_capacitor"); 
+        // Ensures we load this early before registering. 
+        System.loadLibrary("sqlcipher");
+    }
+
+    public static native int registerPowersync();
+}

package/android/src/main/java/com/powersync/capacitor/PowerSyncPlugin.java

@@ -0,0 +1,20 @@
+package com.powersync.capacitor;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "PowerSync")
+public class PowerSyncPlugin extends Plugin {
+
+    private PowerSync implementation = new PowerSync();
+
+    @PluginMethod
+    public void registerCore(PluginCall call) {
+        JSObject ret = new JSObject();
+        ret.put("responseCode", implementation.registerPowersync());
+        call.resolve(ret);
+    }
+}

package/dist/docs.json

@@ -0,0 +1,39 @@
+{
+  "api": {
+    "name": "PowerSyncPlugin",
+    "slug": "powersyncplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "registerCore",
+        "signature": "() => Promise<RegistrationResponse>",
+        "parameters": [],
+        "returns": "Promise<RegistrationResponse>",
+        "tags": [],
+        "docs": "Registers the PowerSync core extension with the SQLite library.",
+        "complexTypes": [
+          "RegistrationResponse"
+        ],
+        "slug": "registercore"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "RegistrationResponse",
+      "slug": "registrationresponse",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  /**\n   * Zero for successful registration, non-zero for failure.\n   * - [Android] -1: SQLCipher library not found.\n   * - [Android] -2: Required symbols not found.\n   * - The result of sqlite3_auto_extension\n   */\n  responseCode: number;\n}",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/PowerSyncDatabase.d.ts

@@ -0,0 +1,15 @@
+import { DBAdapter, PowerSyncBackendConnector, RequiredAdditionalConnectionOptions, StreamingSyncImplementation, PowerSyncDatabase as WebPowerSyncDatabase, WebPowerSyncDatabaseOptionsWithSettings } from '@powersync/web';
+/**
+ * PowerSyncDatabase class for managing database connections and sync implementations.
+ * This extends the WebPowerSyncDatabase to provide platform-specific implementations
+ * for Capacitor environments (iOS and Android).
+ *
+ * @experimental
+ * @alpha
+ */
+export declare class PowerSyncDatabase extends WebPowerSyncDatabase {
+    protected get isNativeCapacitorPlatform(): boolean;
+    protected openDBAdapter(options: WebPowerSyncDatabaseOptionsWithSettings): DBAdapter;
+    protected runExclusive<T>(cb: () => Promise<T>): Promise<T>;
+    protected generateSyncStreamImplementation(connector: PowerSyncBackendConnector, options: RequiredAdditionalConnectionOptions): StreamingSyncImplementation;
+}

package/dist/esm/PowerSyncDatabase.js

@@ -0,0 +1,70 @@
+import { Capacitor } from '@capacitor/core';
+import { PowerSyncDatabase as WebPowerSyncDatabase, WebRemote } from '@powersync/web';
+import { CapacitorSQLiteAdapter } from './adapter/CapacitorSQLiteAdapter';
+import { CapacitorStreamingSyncImplementation } from './sync/CapacitorSyncImplementation';
+/**
+ * PowerSyncDatabase class for managing database connections and sync implementations.
+ * This extends the WebPowerSyncDatabase to provide platform-specific implementations
+ * for Capacitor environments (iOS and Android).
+ *
+ * @experimental
+ * @alpha
+ */
+export class PowerSyncDatabase extends WebPowerSyncDatabase {
+    get isNativeCapacitorPlatform() {
+        const platform = Capacitor.getPlatform();
+        return platform == 'ios' || platform == 'android';
+    }
+    openDBAdapter(options) {
+        var _a, _b, _c;
+        const platform = Capacitor.getPlatform();
+        if (platform == 'ios' || platform == 'android') {
+            if (options.database.dbLocation) {
+                (_a = options.logger) === null || _a === void 0 ? void 0 : _a.warn(`
+          dbLocation is ignored on iOS and Android platforms. 
+          The database directory can be configured in the Capacitor project.
+          See https://github.com/capacitor-community/sqlite?tab=readme-ov-file#installation`);
+            }
+            (_b = options.logger) === null || _b === void 0 ? void 0 : _b.debug(`Using CapacitorSQLiteAdapter for platform: ${platform}`);
+            return new CapacitorSQLiteAdapter({
+                dbFilename: options.database.dbFilename
+            });
+        }
+        else {
+            (_c = options.logger) === null || _c === void 0 ? void 0 : _c.debug(`Using default web adapter for web platform`);
+            return super.openDBAdapter(options);
+        }
+    }
+    runExclusive(cb) {
+        if (this.isNativeCapacitorPlatform) {
+            // Use mutex for mobile platforms.
+            // This is mainly for testing purposes since navigator.locks require secure contexts.
+            return this.runExclusiveMutex.runExclusive(cb);
+        }
+        else {
+            // Use navigator.locks for web platform
+            return super.runExclusive(cb);
+        }
+    }
+    generateSyncStreamImplementation(connector, options) {
+        var _a;
+        if (this.isNativeCapacitorPlatform) {
+            // We don't want to support multi-tab on mobile platforms.
+            // We technically can, but it's not a common use case and requires additional work/testing.
+            this.logger.debug(`Using Capacitor sync implementation`);
+            if ((_a = this.options.flags) === null || _a === void 0 ? void 0 : _a.enableMultiTabs) {
+                this.logger.warn(`enableMultiTabs is not supported on Capacitor mobile platforms. Ignoring the flag.`);
+            }
+            const remote = new WebRemote(connector, this.logger);
+            return new CapacitorStreamingSyncImplementation(Object.assign(Object.assign({}, this.options), { retryDelayMs: options.retryDelayMs, crudUploadThrottleMs: options.crudUploadThrottleMs, adapter: this.bucketStorageAdapter, remote, uploadCrud: async () => {
+                    await this.waitForReady();
+                    await connector.uploadData(this);
+                }, identifier: this.database.name, logger: this.logger, subscriptions: options.subscriptions }));
+        }
+        else {
+            this.logger.debug(`Using default web sync implementation for web platform`);
+            return super.generateSyncStreamImplementation(connector, options);
+        }
+    }
+}
+//# sourceMappingURL=PowerSyncDatabase.js.map

package/dist/esm/PowerSyncDatabase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PowerSyncDatabase.js","sourceRoot":"","sources":["../../src/PowerSyncDatabase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAKL,iBAAiB,IAAI,oBAAoB,EAEzC,SAAS,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,oCAAoC,EAAE,MAAM,oCAAoC,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAkB,SAAQ,oBAAoB;IACzD,IAAc,yBAAyB;QACrC,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACzC,OAAO,QAAQ,IAAI,KAAK,IAAI,QAAQ,IAAI,SAAS,CAAC;IACpD,CAAC;IAES,aAAa,CAAC,OAAgD;;QACtE,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACzC,IAAI,QAAQ,IAAI,KAAK,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/C,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAChC,MAAA,OAAO,CAAC,MAAM,0CAAE,IAAI,CAAC;;;4FAG+D,CAAC,CAAC;YACxF,CAAC;YACD,MAAA,OAAO,CAAC,MAAM,0CAAE,KAAK,CAAC,8CAA8C,QAAQ,EAAE,CAAC,CAAC;YAChF,OAAO,IAAI,sBAAsB,CAAC;gBAChC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU;aACxC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAA,OAAO,CAAC,MAAM,0CAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;YACpE,OAAO,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAES,YAAY,CAAI,EAAoB;QAC5C,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACnC,kCAAkC;YAClC,qFAAqF;YACrF,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,uCAAuC;YACvC,OAAO,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAES,gCAAgC,CACxC,SAAoC,EACpC,OAA4C;;QAE5C,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACnC,0DAA0D;YAC1D,2FAA2F;YAC3F,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,IAAI,MAAA,IAAI,CAAC,OAAO,CAAC,KAAK,0CAAE,eAAe,EAAE,CAAC;gBACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oFAAoF,CAAC,CAAC;YACzG,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAErD,OAAO,IAAI,oCAAoC,iCACzC,IAAI,CAAC,OAAc,KACvB,YAAY,EAAE,OAAO,CAAC,YAAY,EAClC,oBAAoB,EAAE,OAAO,CAAC,oBAAoB,EAClD,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAClC,MAAM,EACN,UAAU,EAAE,KAAK,IAAI,EAAE;oBACrB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;oBAC1B,MAAM,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBACnC,CAAC,EACD,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,EACnB,aAAa,EAAE,OAAO,CAAC,aAAa,IACpC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;YAC5E,OAAO,KAAK,CAAC,gCAAgC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;CACF","sourcesContent":["import { Capacitor } from '@capacitor/core';\nimport {\n  DBAdapter,\n  PowerSyncBackendConnector,\n  RequiredAdditionalConnectionOptions,\n  StreamingSyncImplementation,\n  PowerSyncDatabase as WebPowerSyncDatabase,\n  WebPowerSyncDatabaseOptionsWithSettings,\n  WebRemote\n} from '@powersync/web';\nimport { CapacitorSQLiteAdapter } from './adapter/CapacitorSQLiteAdapter';\nimport { CapacitorStreamingSyncImplementation } from './sync/CapacitorSyncImplementation';\n\n/**\n * PowerSyncDatabase class for managing database connections and sync implementations.\n * This extends the WebPowerSyncDatabase to provide platform-specific implementations\n * for Capacitor environments (iOS and Android).\n *\n * @experimental\n * @alpha\n */\nexport class PowerSyncDatabase extends WebPowerSyncDatabase {\n  protected get isNativeCapacitorPlatform(): boolean {\n    const platform = Capacitor.getPlatform();\n    return platform == 'ios' || platform == 'android';\n  }\n\n  protected openDBAdapter(options: WebPowerSyncDatabaseOptionsWithSettings): DBAdapter {\n    const platform = Capacitor.getPlatform();\n    if (platform == 'ios' || platform == 'android') {\n      if (options.database.dbLocation) {\n        options.logger?.warn(`\n          dbLocation is ignored on iOS and Android platforms. \n          The database directory can be configured in the Capacitor project.\n          See https://github.com/capacitor-community/sqlite?tab=readme-ov-file#installation`);\n      }\n      options.logger?.debug(`Using CapacitorSQLiteAdapter for platform: ${platform}`);\n      return new CapacitorSQLiteAdapter({\n        dbFilename: options.database.dbFilename\n      });\n    } else {\n      options.logger?.debug(`Using default web adapter for web platform`);\n      return super.openDBAdapter(options);\n    }\n  }\n\n  protected runExclusive<T>(cb: () => Promise<T>): Promise<T> {\n    if (this.isNativeCapacitorPlatform) {\n      // Use mutex for mobile platforms.\n      // This is mainly for testing purposes since navigator.locks require secure contexts.\n      return this.runExclusiveMutex.runExclusive(cb);\n    } else {\n      // Use navigator.locks for web platform\n      return super.runExclusive(cb);\n    }\n  }\n\n  protected generateSyncStreamImplementation(\n    connector: PowerSyncBackendConnector,\n    options: RequiredAdditionalConnectionOptions\n  ): StreamingSyncImplementation {\n    if (this.isNativeCapacitorPlatform) {\n      // We don't want to support multi-tab on mobile platforms.\n      // We technically can, but it's not a common use case and requires additional work/testing.\n      this.logger.debug(`Using Capacitor sync implementation`);\n      if (this.options.flags?.enableMultiTabs) {\n        this.logger.warn(`enableMultiTabs is not supported on Capacitor mobile platforms. Ignoring the flag.`);\n      }\n      const remote = new WebRemote(connector, this.logger);\n\n      return new CapacitorStreamingSyncImplementation({\n        ...(this.options as {}),\n        retryDelayMs: options.retryDelayMs,\n        crudUploadThrottleMs: options.crudUploadThrottleMs,\n        adapter: this.bucketStorageAdapter,\n        remote,\n        uploadCrud: async () => {\n          await this.waitForReady();\n          await connector.uploadData(this);\n        },\n        identifier: this.database.name,\n        logger: this.logger,\n        subscriptions: options.subscriptions\n      });\n    } else {\n      this.logger.debug(`Using default web sync implementation for web platform`);\n      return super.generateSyncStreamImplementation(connector, options);\n    }\n  }\n}\n"]}

package/dist/esm/adapter/CapacitorSQLiteAdapter.d.ts

@@ -0,0 +1,35 @@
+import { SQLiteDBConnection } from '@capacitor-community/sqlite';
+import { BaseObserver, DBAdapter, DBAdapterListener, DBLockOptions, LockContext, QueryResult, SQLOpenOptions, Transaction } from '@powersync/web';
+import Lock from 'async-lock';
+/**
+ * An implementation of {@link DBAdapter} using the Capacitor Community SQLite [plugin](https://github.com/capacitor-community/sqlite).
+ *
+ * @experimental
+ * @alpha This is currently experimental and may change without a major version bump.
+ */
+export declare class CapacitorSQLiteAdapter extends BaseObserver<DBAdapterListener> implements DBAdapter {
+    protected options: SQLOpenOptions;
+    protected _writeConnection: SQLiteDBConnection | null;
+    protected _readConnection: SQLiteDBConnection | null;
+    protected initializedPromise: Promise<void>;
+    protected lock: Lock;
+    constructor(options: SQLOpenOptions);
+    protected get writeConnection(): SQLiteDBConnection;
+    protected get readConnection(): SQLiteDBConnection;
+    private init;
+    close(): Promise<void>;
+    get name(): string;
+    protected generateLockContext(db: SQLiteDBConnection): LockContext;
+    execute(query: string, params?: any[]): Promise<QueryResult>;
+    executeRaw(query: string, params?: any[]): Promise<any[][]>;
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
+    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>;
+    refreshSchema(): Promise<void>;
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+    protected internalTransaction<T>(ctx: LockContext, fn: (tx: Transaction) => Promise<T>): Promise<T>;
+}