@powersync/react-native 1.7.2 → 1.8.0

package/lib/db/PowerSyncDatabase.d.ts

@@ -1,6 +1,25 @@
-import { AbstractPowerSyncDatabase, AbstractStreamingSyncImplementation, PowerSyncBackendConnector, BucketStorageAdapter } from '@powersync/common';
+import { AbstractPowerSyncDatabase, AbstractStreamingSyncImplementation, PowerSyncBackendConnector, BucketStorageAdapter, DBAdapter, SQLOpenOptions } from '@powersync/common';
+/**
+ * A PowerSync database which provides SQLite functionality
+ * which is automatically synced.
+ *
+ * @example
+ * ```typescript
+ * export const db = new PowerSyncDatabase({
+ *  schema: AppSchema,
+ *  database: {
+ *    dbFilename: 'example.db'
+ *  }
+ * });
+ * ```
+ */
 export declare class PowerSyncDatabase extends AbstractPowerSyncDatabase {
     _initialize(): Promise<void>;
+    /**
+     * Opens a DBAdapter using React Native Quick SQLite as the
+     * default SQLite open factory.
+     */
+    protected openDBAdapter(options: SQLOpenOptions): DBAdapter;
     protected generateBucketStorageAdapter(): BucketStorageAdapter;
     protected generateSyncStreamImplementation(connector: PowerSyncBackendConnector): AbstractStreamingSyncImplementation;
 }

package/lib/db/PowerSyncDatabase.js

@@ -1,8 +1,31 @@
 import { AbstractPowerSyncDatabase, SqliteBucketStorage } from '@powersync/common';
 import { ReactNativeRemote } from '../sync/stream/ReactNativeRemote';
 import { ReactNativeStreamingSyncImplementation } from '../sync/stream/ReactNativeStreamingSyncImplementation';
+import { ReactNativeQuickSqliteOpenFactory } from './adapters/react-native-quick-sqlite/ReactNativeQuickSQLiteOpenFactory';
+/**
+ * A PowerSync database which provides SQLite functionality
+ * which is automatically synced.
+ *
+ * @example
+ * ```typescript
+ * export const db = new PowerSyncDatabase({
+ *  schema: AppSchema,
+ *  database: {
+ *    dbFilename: 'example.db'
+ *  }
+ * });
+ * ```
+ */
 export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
     async _initialize() { }
+    /**
+     * Opens a DBAdapter using React Native Quick SQLite as the
+     * default SQLite open factory.
+     */
+    openDBAdapter(options) {
+        const defaultFactory = new ReactNativeQuickSqliteOpenFactory(options);
+        return defaultFactory.openDB();
+    }
     generateBucketStorageAdapter() {
         return new SqliteBucketStorage(this.database, AbstractPowerSyncDatabase.transactionMutex);
     }
@@ -17,7 +40,7 @@ export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
             },
             retryDelayMs: this.options.retryDelay,
             crudUploadThrottleMs: this.options.crudUploadThrottleMs,
-            identifier: this.options.database.name
+            identifier: this.database.name
         });
     }
 }

package/lib/db/adapters/react-native-quick-sqlite/RNQSDBOpenFactory.d.ts

@@ -1,6 +1,18 @@
-import { AbstractPowerSyncDatabase, AbstractPowerSyncDatabaseOpenFactory, DBAdapter, PowerSyncDatabaseOptions, PowerSyncOpenFactoryOptions } from '@powersync/common';
+import { AbstractPowerSyncDatabase, AbstractPowerSyncDatabaseOpenFactory, DBAdapter, PowerSyncDatabaseOptions, PowerSyncOpenFactoryOptions, SQLOpenFactory } from '@powersync/common';
+/**
+ * @deprecated {@link PowerSyncDatabase} can now be constructed directly
+ * @example
+ * ```typescript
+ * const powersync = new PowerSyncDatabase({
+ *  database: {
+ *    dbFileName: 'powersync.db'
+ *  }
+ * });
+ * ```
+ */
 export declare class RNQSPowerSyncDatabaseOpenFactory extends AbstractPowerSyncDatabaseOpenFactory {
     protected instanceGenerated: boolean;
+    protected sqlOpenFactory: SQLOpenFactory;
     constructor(options: PowerSyncOpenFactoryOptions);
     protected openDB(): DBAdapter;
     generateInstance(options: PowerSyncDatabaseOptions): AbstractPowerSyncDatabase;

package/lib/db/adapters/react-native-quick-sqlite/RNQSDBOpenFactory.js

@@ -1,39 +1,27 @@
-import { open, QuickSQLite } from '@journeyapps/react-native-quick-sqlite';
 import { AbstractPowerSyncDatabaseOpenFactory } from '@powersync/common';
 import { PowerSyncDatabase } from '../../../db/PowerSyncDatabase';
-import { RNQSDBAdapter } from './RNQSDBAdapter';
+import { ReactNativeQuickSqliteOpenFactory } from './ReactNativeQuickSQLiteOpenFactory';
+/**
+ * @deprecated {@link PowerSyncDatabase} can now be constructed directly
+ * @example
+ * ```typescript
+ * const powersync = new PowerSyncDatabase({
+ *  database: {
+ *    dbFileName: 'powersync.db'
+ *  }
+ * });
+ * ```
+ */
 export class RNQSPowerSyncDatabaseOpenFactory extends AbstractPowerSyncDatabaseOpenFactory {
     instanceGenerated;
+    sqlOpenFactory;
     constructor(options) {
         super(options);
         this.instanceGenerated = false;
+        this.sqlOpenFactory = new ReactNativeQuickSqliteOpenFactory(options);
     }
     openDB() {
-        /**
-         * React Native Quick SQLite opens files relative to the `Documents`dir on iOS and the `Files`
-         * dir on Android. Locations need to be relative to those dirs using with dot ("../") notation
-         * to navigate up the directory tree.
-         * This simple adapter assumes any platform specific relative directory is already catered for
-         * in the options (if provided)
-         * https://github.com/margelo/react-native-quick-sqlite/blob/main/README.md#loading-existing-dbs
-         */
-        const { dbFilename } = this.options;
-        const openOptions = { location: this.options.dbLocation };
-        let DB;
-        try {
-            // Hot reloads can sometimes clear global JS state, but not close DB on native side
-            DB = open(dbFilename, openOptions);
-        }
-        catch (ex) {
-            if (ex.message.includes('already open')) {
-                QuickSQLite.close(dbFilename);
-                DB = open(dbFilename, openOptions);
-            }
-            else {
-                throw ex;
-            }
-        }
-        return new RNQSDBAdapter(DB, this.options.dbFilename);
+        return this.sqlOpenFactory.openDB();
     }
     generateInstance(options) {
         if (this.instanceGenerated) {

package/lib/db/adapters/react-native-quick-sqlite/ReactNativeQuickSQLiteOpenFactory.d.ts

@@ -0,0 +1,9 @@
+import { DBAdapter, SQLOpenOptions, SQLOpenFactory } from '@powersync/common';
+/**
+ * Opens a SQLite connection using React Native Quick SQLite
+ */
+export declare class ReactNativeQuickSqliteOpenFactory implements SQLOpenFactory {
+    protected options: SQLOpenOptions;
+    constructor(options: SQLOpenOptions);
+    openDB(): DBAdapter;
+}

package/lib/db/adapters/react-native-quick-sqlite/ReactNativeQuickSQLiteOpenFactory.js

@@ -0,0 +1,38 @@
+import { open, QuickSQLite } from '@journeyapps/react-native-quick-sqlite';
+import { RNQSDBAdapter } from './RNQSDBAdapter';
+/**
+ * Opens a SQLite connection using React Native Quick SQLite
+ */
+export class ReactNativeQuickSqliteOpenFactory {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    openDB() {
+        /**
+         * React Native Quick SQLite opens files relative to the `Documents`dir on iOS and the `Files`
+         * dir on Android. Locations need to be relative to those dirs using with dot ("../") notation
+         * to navigate up the directory tree.
+         * This simple adapter assumes any platform specific relative directory is already catered for
+         * in the options (if provided)
+         * https://github.com/margelo/react-native-quick-sqlite/blob/main/README.md#loading-existing-dbs
+         */
+        const { dbFilename } = this.options;
+        const openOptions = { location: this.options.dbLocation };
+        let DB;
+        try {
+            // Hot reloads can sometimes clear global JS state, but not close DB on native side
+            DB = open(dbFilename, openOptions);
+        }
+        catch (ex) {
+            if (ex.message.includes('already open')) {
+                QuickSQLite.close(dbFilename);
+                DB = open(dbFilename, openOptions);
+            }
+            else {
+                throw ex;
+            }
+        }
+        return new RNQSDBAdapter(DB, this.options.dbFilename);
+    }
+}

package/lib/index.d.ts

@@ -5,3 +5,4 @@ export * from './db/adapters/react-native-quick-sqlite/RNQSDBAdapter';
 export * from './db/adapters/react-native-quick-sqlite//RNQSDBOpenFactory';
 export * from './sync/stream/ReactNativeRemote';
 export * from './sync/stream/ReactNativeStreamingSyncImplementation';
+export * from './db/adapters/react-native-quick-sqlite/ReactNativeQuickSQLiteOpenFactory';

package/lib/index.js

@@ -6,3 +6,4 @@ export * from './db/adapters/react-native-quick-sqlite/RNQSDBAdapter';
 export * from './db/adapters/react-native-quick-sqlite//RNQSDBOpenFactory';
 export * from './sync/stream/ReactNativeRemote';
 export * from './sync/stream/ReactNativeStreamingSyncImplementation';
+export * from './db/adapters/react-native-quick-sqlite/ReactNativeQuickSQLiteOpenFactory';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/react-native",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -26,14 +26,14 @@
     "react": "*",
     "react-native": "*",
     "react-native-polyfill-globals": "^3.1.0",
-    "@powersync/common": "^1.12.01.12.0"
+    "@powersync/common": "^1.13.01.13.0"
   },
   "dependencies": {
     "async-lock": "^1.4.0",
     "bson": "^6.6.0",
     "react-native-fetch-api": "^3.0.0",
     "@powersync/react": "1.3.5",
-    "@powersync/common": "1.12.0"
+    "@powersync/common": "1.13.0"
   },
   "devDependencies": {
     "@journeyapps/react-native-quick-sqlite": "^1.1.6",