@powersync/op-sqlite 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/op-sqlite",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "PowerSync - sync Postgres or MongoDB with SQLite in your React Native app for offline-first and real-time data",
   "source": "./src/index.ts",
   "main": "./lib/commonjs/index.js",
@@ -58,17 +58,17 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@op-engineering/op-sqlite": "^10.1.0",
-    "@powersync/common": "^1.22.1",
+    "@op-engineering/op-sqlite": "^11.2.13",
+    "@powersync/common": "^1.22.2",
     "react": "*",
     "react-native": "*"
   },
   "dependencies": {
     "async-lock": "^1.4.0",
-    "@powersync/common": "1.22.1"
+    "@powersync/common": "1.22.2"
   },
   "devDependencies": {
-    "@op-engineering/op-sqlite": "^10.1.0",
+    "@op-engineering/op-sqlite": "^11.2.13",
     "@react-native/eslint-config": "^0.73.1",
     "@types/async-lock": "^1.4.0",
     "@types/react": "^18.2.44",
@@ -131,6 +131,6 @@
     "build:prod": "bob build",
     "typecheck": "tsc",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib"
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib node_modules"
   }
 }

package/powersync-op-sqlite.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.dependency "React-callinvoker"
   s.dependency "React"
-  s.dependency "powersync-sqlite-core", "~> 0.3.6"
+  s.dependency "powersync-sqlite-core", "~> 0.3.8"
   if defined?(install_modules_dependencies())
     install_modules_dependencies(s)
   else

package/src/db/OPSqliteAdapter.ts

@@ -1,8 +1,21 @@
-import { BaseObserver, DBAdapter, DBAdapterListener, DBLockOptions, QueryResult, Transaction } from '@powersync/common';
-import { ANDROID_DATABASE_PATH, IOS_LIBRARY_PATH, open, type DB } from '@op-engineering/op-sqlite';
+import {
+  BaseObserver,
+  DBAdapter,
+  DBAdapterListener,
+  DBLockOptions,
+  QueryResult,
+  Transaction
+} from '@powersync/common';
+import {
+  ANDROID_DATABASE_PATH,
+  getDylibPath,
+  IOS_LIBRARY_PATH,
+  open,
+  type DB
+} from '@op-engineering/op-sqlite';
 import Lock from 'async-lock';
 import { OPSQLiteConnection } from './OPSQLiteConnection';
-import { NativeModules, Platform } from 'react-native';
+import { Platform } from 'react-native';
 import { SqliteOptions } from './SqliteOptions';
 
 /**
@@ -44,7 +57,7 @@ export class OPSQLiteDBAdapter extends BaseObserver<DBAdapterListener> implement
   }
 
   protected async init() {
-    const { lockTimeoutMs, journalMode, journalSizeLimit, synchronous, encryptionKey } = this.options.sqliteOptions;
+    const { lockTimeoutMs, journalMode, journalSizeLimit, synchronous } = this.options.sqliteOptions!;
     const dbFilename = this.options.name;
 
     this.writeConnection = await this.openConnection(dbFilename);
@@ -78,9 +91,7 @@ export class OPSQLiteDBAdapter extends BaseObserver<DBAdapterListener> implement
 
     this.readConnections = [];
     for (let i = 0; i < READ_CONNECTIONS; i++) {
-      // Workaround to create read-only connections
-      let dbName = './'.repeat(i + 1) + dbFilename;
-      const conn = await this.openConnection(dbName);
+      const conn = await this.openConnection(dbFilename);
       await conn.execute('PRAGMA query_only = true');
       this.readConnections.push({ busy: false, connection: conn });
     }
@@ -88,10 +99,11 @@ export class OPSQLiteDBAdapter extends BaseObserver<DBAdapterListener> implement
 
   protected async openConnection(filenameOverride?: string): Promise<OPSQLiteConnection> {
     const dbFilename = filenameOverride ?? this.options.name;
-    const DB: DB = this.openDatabase(dbFilename, this.options.sqliteOptions.encryptionKey);
+    const DB: DB = this.openDatabase(dbFilename, this.options.sqliteOptions?.encryptionKey ?? undefined);
 
-    //Load extension for all connections
-    this.loadExtension(DB);
+    //Load extensions for all connections
+    this.loadAdditionalExtensions(DB);
+    this.loadPowerSyncExtension(DB);
 
     await DB.execute('SELECT powersync_init()');
 
@@ -126,10 +138,17 @@ export class OPSQLiteDBAdapter extends BaseObserver<DBAdapterListener> implement
     }
   }
 
-  private loadExtension(DB: DB) {
+  private loadAdditionalExtensions(DB: DB) {
+    if (this.options.sqliteOptions?.extensions && this.options.sqliteOptions.extensions.length > 0) {
+      for (const extension of this.options.sqliteOptions.extensions) {
+        DB.loadExtension(extension.path, extension.entryPoint);
+      }
+    }
+  }
+
+  private async loadPowerSyncExtension(DB: DB) {
     if (Platform.OS === 'ios') {
-      const bundlePath: string = NativeModules.PowerSyncOpSqlite.getBundlePath();
-      const libPath = `${bundlePath}/Frameworks/powersync-sqlite-core.framework/powersync-sqlite-core`;
+      const libPath = getDylibPath('co.powersync.sqlitecore', 'powersync-sqlite-core');
       DB.loadExtension(libPath, 'sqlite3_powersync_init');
     } else {
       DB.loadExtension('libpowersync', 'sqlite3_powersync_init');
@@ -273,8 +292,10 @@ export class OPSQLiteDBAdapter extends BaseObserver<DBAdapterListener> implement
     await this.initialized;
     await this.writeConnection!.refreshSchema();
 
-    for (let readConnection of this.readConnections) {
-      await readConnection.connection.refreshSchema();
+    if(this.readConnections) {
+      for (let readConnection of this.readConnections) {
+        await readConnection.connection.refreshSchema();
+      }
     }
   }
 }

package/src/db/SqliteOptions.ts

@@ -28,7 +28,16 @@ export interface SqliteOptions {
    * Encryption key for the database.
    * If set, the database will be encrypted using SQLCipher.
    */
-  encryptionKey?: string;
+  encryptionKey?: string | null;
+
+  /**
+   * Load extensions using the path and entryPoint.
+   * More info can be found here https://op-engineering.github.io/op-sqlite/docs/api#loading-extensions.
+   */
+  extensions?: Array<{
+    path: string;
+    entryPoint?: string;
+  }>;
 }
 
 // SQLite journal mode. Set on the primary connection.
@@ -57,5 +66,6 @@ export const DEFAULT_SQLITE_OPTIONS: Required<SqliteOptions> = {
   synchronous: SqliteSynchronous.normal,
   journalSizeLimit: 6 * 1024 * 1024,
   lockTimeoutMs: 30000,
-  encryptionKey: null
+  encryptionKey: null,
+  extensions: []
 };

package/src/index.ts

@@ -1,30 +1,4 @@
-import { NativeModules, Platform } from 'react-native';
-
-const LINKING_ERROR =
-  `The package '@powersync/op-sqlite' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
-
-const isTurboModuleEnabled = global.__turboModuleProxy != null;
-
-const PowerSyncOpSqliteModule = isTurboModuleEnabled
-  ? require('./NativePowerSyncOpSqlite').default
-  : NativeModules.PowerSyncOpSqlite;
-
-const PowerSyncOpSqlite = PowerSyncOpSqliteModule
-  ? PowerSyncOpSqliteModule
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        }
-      }
-    );
-
-export function getBundlePath(): string {
-  return PowerSyncOpSqlite.getBundlePath();
-}
-
-export { OPSqliteOpenFactory, OPSQLiteOpenFactoryOptions } from './db/OPSqliteDBOpenFactory';
+export {
+  OPSqliteOpenFactory,
+  OPSQLiteOpenFactoryOptions
+} from './db/OPSqliteDBOpenFactory';

package/android/src/main/java/com/powersync/opsqlite/PowerSyncOpSqliteModule.kt

@@ -1,25 +0,0 @@
-package com.powersync.opsqlite
-
-import com.facebook.react.bridge.ReactApplicationContext
-import com.facebook.react.bridge.ReactMethod
-import com.facebook.react.bridge.Promise
-
-class PowerSyncOpSqliteModule internal constructor(context: ReactApplicationContext) :
-  PowerSyncOpSqliteSpec(context) {
-
-  @ReactMethod
-  override fun getBundlePath(): String {
-    //This method should only be used for iOS platforms
-    //Ensure you wrap its usage with a (Platform.OS === 'ios') check
-    //Returns an empty string for android
-    return ""
-  }
-
-  override fun getName(): String {
-    return NAME
-  }
-
-  companion object {
-    const val NAME = "PowerSyncOpSqlite"
-  }
-}

package/android/src/newarch/PowerSyncOpSqliteSpec.kt

@@ -1,7 +0,0 @@
-package com.powersync.opsqlite
-
-import com.facebook.react.bridge.ReactApplicationContext
-
-abstract class PowerSyncOpSqliteSpec internal constructor(context: ReactApplicationContext) :
-  NativePowerSyncOpSqliteSpec(context) {
-}

package/android/src/oldarch/PowerSyncOpSqliteSpec.kt

@@ -1,11 +0,0 @@
-package com.powersync.opsqlite
-
-import com.facebook.react.bridge.ReactApplicationContext
-import com.facebook.react.bridge.ReactContextBaseJavaModule
-import com.facebook.react.bridge.Promise
-
-abstract class PowerSyncOpSqliteSpec internal constructor(context: ReactApplicationContext) :
-  ReactContextBaseJavaModule(context) {
-
-    abstract fun getBundlePath(): String
-  }

package/lib/commonjs/NativePowerSyncOpSqlite.js

@@ -1,9 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _reactNative = require("react-native");
-var _default = exports.default = _reactNative.TurboModuleRegistry.getEnforcing('PowerSyncOpSqlite');
-//# sourceMappingURL=NativePowerSyncOpSqlite.js.map

package/lib/commonjs/NativePowerSyncOpSqlite.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_reactNative","require","_default","exports","default","TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativePowerSyncOpSqlite.ts"],"mappings":";;;;;;AACA,IAAAA,YAAA,GAAAC,OAAA;AAAmD,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAMpCC,gCAAmB,CAACC,YAAY,CAAO,mBAAmB,CAAC","ignoreList":[]}

package/lib/module/NativePowerSyncOpSqlite.js

@@ -1,5 +0,0 @@
-"use strict";
-
-import { TurboModuleRegistry } from 'react-native';
-export default TurboModuleRegistry.getEnforcing('PowerSyncOpSqlite');
-//# sourceMappingURL=NativePowerSyncOpSqlite.js.map

package/lib/module/NativePowerSyncOpSqlite.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativePowerSyncOpSqlite.ts"],"mappings":";;AACA,SAASA,mBAAmB,QAAQ,cAAc;AAMlD,eAAeA,mBAAmB,CAACC,YAAY,CAAO,mBAAmB,CAAC","ignoreList":[]}

package/lib/typescript/commonjs/src/NativePowerSyncOpSqlite.d.ts

@@ -1,7 +0,0 @@
-import type { TurboModule } from 'react-native';
-export interface Spec extends TurboModule {
-    getBundlePath(): string;
-}
-declare const _default: Spec;
-export default _default;
-//# sourceMappingURL=NativePowerSyncOpSqlite.d.ts.map

package/lib/typescript/commonjs/src/NativePowerSyncOpSqlite.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativePowerSyncOpSqlite.d.ts","sourceRoot":"","sources":["../../../../src/NativePowerSyncOpSqlite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,aAAa,IAAI,MAAM,CAAC;CACzB;;AAED,wBAA2E"}

package/lib/typescript/module/src/NativePowerSyncOpSqlite.d.ts

@@ -1,7 +0,0 @@
-import type { TurboModule } from 'react-native';
-export interface Spec extends TurboModule {
-    getBundlePath(): string;
-}
-declare const _default: Spec;
-export default _default;
-//# sourceMappingURL=NativePowerSyncOpSqlite.d.ts.map

package/lib/typescript/module/src/NativePowerSyncOpSqlite.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativePowerSyncOpSqlite.d.ts","sourceRoot":"","sources":["../../../../src/NativePowerSyncOpSqlite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,aAAa,IAAI,MAAM,CAAC;CACzB;;AAED,wBAA2E"}

package/src/NativePowerSyncOpSqlite.ts

@@ -1,8 +0,0 @@
-import type { TurboModule } from 'react-native';
-import { TurboModuleRegistry } from 'react-native';
-
-export interface Spec extends TurboModule {
-  getBundlePath(): string;
-}
-
-export default TurboModuleRegistry.getEnforcing<Spec>('PowerSyncOpSqlite');