feat: @powersync/adapter-sql-js added to support SQL.js

.changeset/orange-spies-cry.md

@@ -0,0 +1,5 @@
+---
+'@powersync/dev': patch
+---
+
+Introduced dev package.

.changeset/rude-pears-fail.md

@@ -0,0 +1,5 @@
+---
+'@powersync/common': minor
+---
+
+Added ControlledExecutor utility to exports.

packages/common/src/index.ts

@@ -33,6 +33,7 @@ export * from './db/schema/TableV2.js';
 
 export * from './utils/AbortOperation.js';
 export * from './utils/BaseObserver.js';
+export * from './utils/ControlledExecutor.js';
 export * from './utils/DataStream.js';
 export * from './utils/Logger.js';
 export * from './utils/parseQuery.js';

packages/dev/README.md

@@ -0,0 +1,89 @@
+# PowerSync Dev
+
+A development package for PowerSync which uses [SQL.js](https://sql.js.org/#/) to provide a pure JavaScript SQLite implementation.
+This eliminates the need for native dependencies and enabling seamless development with Expo Go and other JavaScript-only environments.
+
+This package is specifically designed to streamline the development workflow and will be much slower than DB adapters that use native dependencies.
+For example when building React Native apps we recommend switching to our OP-sqlite or RNQS adapters when making production builds as they give substantially better performance.
+
+## Note: Alpha Release
+
+This package is currently in an alpha release.
+
+## Usage
+
+By default the SQLJS adapter will be in-memory. Read further for persister examples.
+
+```tsx
+import { SQLJSOpenFactory } from '@powersync/dev';
+
+const powersync = new PowerSyncDatabase({
+  schema: AppSchema,
+  database: new SQLJSOpenFactory({
+    dbFilename: 'powersync.db'
+  })
+});
+```
+
+## Persister examples
+
+### Expo
+
+We can use the [Expo File System](https://docs.expo.dev/versions/latest/sdk/filesystem/) to persist the database in an Expo app.
+
+```tsx
+import { PowerSyncDatabase, SQLJSOpenFactory, SQLJSPersister } from '@powersync/react-native';
+import * as FileSystem from 'expo-file-system';
+
+const powersync = new PowerSyncDatabase({
+  schema: AppSchema,
+  database: new SQLJSOpenFactory({
+    dbFilename: 'powersync.db',
+    persister: createSQLJSPersister('powersync.db')
+  })
+});
+
+const createSQLJSPersister = (dbFilename: string): SQLJSPersister => {
+  const dbPath = `${FileSystem.documentDirectory}${dbFilename}`;
+
+  return {
+    readFile: async (): Promise<ArrayLike<number> | Buffer | null> => {
+      try {
+        const fileInfo = await FileSystem.getInfoAsync(dbPath);
+        if (!fileInfo.exists) {
+          return null;
+        }
+
+        const result = await FileSystem.readAsStringAsync(dbPath, {
+          encoding: FileSystem.EncodingType.Base64
+        });
+
+        const binary = atob(result);
+        const bytes = new Uint8Array(binary.length);
+        for (let i = 0; i < binary.length; i++) {
+          bytes[i] = binary.charCodeAt(i);
+        }
+        return bytes;
+      } catch (error) {
+        console.error('Error reading database file:', error);
+        return null;
+      }
+    },
+
+    writeFile: async (data: ArrayLike<number> | Buffer): Promise<void> => {
+      try {
+        const uint8Array = new Uint8Array(data);
+        const binary = Array.from(uint8Array, (byte) => String.fromCharCode(byte)).join('');
+        const base64 = btoa(binary);
+
+        await FileSystem.writeAsStringAsync(dbPath, base64, {
+          encoding: FileSystem.EncodingType.Base64
+        });
+      } catch (error) {
+        console.error('Error writing database file:', error);
+        throw error;
+      }
+    }
+  };
+};
+```

packages/dev/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@powersync/dev",
+  "version": "0.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "description": "Development helpers for JourneyApps PowerSync",
+  "type": "module",
+  "main": "dist/bundle.mjs",
+  "module": "dist/bundle.mjs",
+  "types": "lib/index.d.ts",
+  "author": "JOURNEYAPPS",
+  "license": "Apache-2.0",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "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",
+  "scripts": {
+    "build": "tsc -b && rollup -c rollup.config.mjs",
+    "build:prod": "tsc -b --sourceMap false && rollup -c rollup.config.mjs --sourceMap false",
+    "clean": "rm -rf lib dist tsconfig.tsbuildinfo",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@powersync/common": "workspace:^",
+    "async-mutex": "^0.4.0"
+  },
+  "devDependencies": {
+    "@powersync/sql-js": "0.0.1",
+    "@powersync/web": "workspace:*",
+    "@rollup/plugin-alias": "^5.1.0",
+    "@types/sql.js": "^1.4.9",
+    "chance": "^1.1.9",
+    "rollup": "4.14.3",
+    "uuid": "^11.1.0"
+  }
+}

packages/dev/rollup.config.mjs

@@ -0,0 +1,41 @@
+import alias from '@rollup/plugin-alias';
+import commonjs from '@rollup/plugin-commonjs';
+import nodeResolve from '@rollup/plugin-node-resolve';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+/**
+ * @returns {import('rollup').RollupOptions}
+ */
+export default (commandLineArgs) => {
+  const sourceMap = (commandLineArgs.sourceMap || 'true') == 'true';
+
+  // Clears rollup CLI warning https://github.com/rollup/rollup/issues/2694
+  delete commandLineArgs.sourceMap;
+
+  return {
+    input: 'lib/index.js',
+    output: {
+      file: 'dist/bundle.mjs',
+      format: 'esm',
+      sourcemap: sourceMap
+    },
+    plugins: [
+      nodeResolve({ preferBuiltins: false, browser: true }),
+      commonjs({}),
+      alias({
+        entries: [
+          // The default Emscripten output contains code like `require("fs")`. This seems
+          // to be unreachable, but Metro complains when it detects it.
+          { find: 'fs', replacement: path.resolve(__dirname, 'vendored/empty.js') },
+          { find: 'path', replacement: path.resolve(__dirname, 'vendored/empty.js') },
+          { find: 'crypto', replacement: path.resolve(__dirname, 'vendored/empty.js') }
+        ]
+      })
+    ],
+    external: ['@powersync/common']
+  };
+};