Skip to content

feat: @powersync/dev added to support SQL.js #647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/angry-mayflies-ring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/react-native': minor
---

Re-exporting dev package members.
5 changes: 5 additions & 0 deletions .changeset/orange-spies-cry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/dev': patch
---

Introduced dev package.
5 changes: 5 additions & 0 deletions .changeset/rude-pears-fail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/common': minor
---

Added ControlledExecutor utility to exports.
1 change: 1 addition & 0 deletions packages/common/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
85 changes: 85 additions & 0 deletions packages/dev/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# PowerSync Dev

A development package for PowerSync which uses [SQL.js](https://sql.js.org/#/)

## 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;
}
}
};
};
```
46 changes: 46 additions & 0 deletions packages/dev/package.json
Original file line number Diff line number Diff line change
@@ -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"
}
}
40 changes: 40 additions & 0 deletions packages/dev/rollup.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
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: [
{ 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') }
// add others as needed
]
})
],
external: ['@powersync/common']
};
};
Loading
Loading