Skip to content

Remove mentions of wa-sqlite peer dependency #550

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.

Sign up for GitHub

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

Merged
simolus3 merged 1 commit into from
Aug 3, 2026
Merged

Remove mentions of wa-sqlite peer dependency #550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions client-sdks/frameworks/next-js.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,21 +61,19 @@
<CodeGroup>

```shell npm
npm install @powersync/web @journeyapps/wa-sqlite @powersync/react
npm install @powersync/web @powersync/react
```

```shell yarn
yarn add @powersync/web @journeyapps/wa-sqlite @powersync/react
yarn add @powersync/web @powersync/react
```

```shell pnpm
pnpm install @powersync/web @journeyapps/wa-sqlite @powersync/react
pnpm install @powersync/web @powersync/react
```

</CodeGroup>

<Note>This SDK currently requires [@journeyapps/wa-sqlite](https://www.npmjs.com/package/@journeyapps/wa-sqlite) as a peer dependency.</Note>

### Copy Worker Assets

When using Turbopack, you need to copy the PowerSync worker files to your public directory. Add a `postinstall` script to your `package.json`:
Expand Down Expand Up @@ -320,7 +318,7 @@

#### Update `layout.tsx`

Update `RootLayout` to wrap `children` with the `PowerSyncProvider`. Importantly, **the root layout should remain a Server Component** — do not add `'use client'` here. This is the standard Next.js App Router convention and is required if you want to export `metadata` (or use `generateMetadata`) from the layout. The client boundary is drawn at `PowerSyncProvider`, which is all that's needed to get PowerSync running in the browser.

Check warning on line 321 in client-sdks/frameworks/next-js.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/frameworks/next-js.mdx#L321 

Did you really mean 'generateMetadata'?

```typescript app/layout.tsx
import type { Metadata } from 'next';
Expand Down
6 changes: 3 additions & 3 deletions client-sdks/frameworks/tanstack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,17 @@ Install the TanStackDB-PowerSync collection package with a PowerSync SDK. Then d
<Tabs>
<Tab title="npm">
```bash
npm install @tanstack/powersync-db-collection @powersync/web @journeyapps/wa-sqlite
npm install @tanstack/powersync-db-collection @powersync/web
```
</Tab>
<Tab title="yarn">
```bash
yarn add @tanstack/powersync-db-collection @powersync/web @journeyapps/wa-sqlite
yarn add @tanstack/powersync-db-collection @powersync/web
```
</Tab>
<Tab title="pnpm">
```bash
pnpm install @tanstack/powersync-db-collection @powersync/web @journeyapps/wa-sqlite
pnpm install @tanstack/powersync-db-collection @powersync/web
```
</Tab>
</Tabs>
Expand Down
6 changes: 3 additions & 3 deletions client-sdks/reference/javascript-web.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,17 +343,17 @@ Run the below command in your project folder:
<Tabs>
<Tab title="npm">
```bash
npm upgrade @powersync/web @journeyapps/wa-sqlite
npm upgrade @powersync/web
```
</Tab>
<Tab title="yarn">
```bash
yarn upgrade @powersync/web @journeyapps/wa-sqlite
yarn upgrade @powersync/web
```
</Tab>
<Tab title="pnpm">
```bash
pnpm upgrade @powersync/web @journeyapps/wa-sqlite
pnpm upgrade @powersync/web
```
</Tab>
</Tabs>
Expand Down
6 changes: 3 additions & 3 deletions snippets/capacitor/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@ You must also install the following peer dependencies:
<Tabs>
<Tab title="npm">
```bash
npm install @capacitor-community/sqlite @powersync/web @journeyapps/wa-sqlite
npm install @capacitor-community/sqlite @powersync/web
```
</Tab>

<Tab title="yarn">
```bash
yarn add @capacitor-community/sqlite @powersync/web @journeyapps/wa-sqlite
yarn add @capacitor-community/sqlite @powersync/web
```
</Tab>

<Tab title="pnpm">
```bash
pnpm install @capacitor-community/sqlite @powersync/web @journeyapps/wa-sqlite
pnpm install @capacitor-community/sqlite @powersync/web
```
</Tab>
</Tabs>
Expand Down
24 changes: 0 additions & 24 deletions snippets/javascript-web/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,3 @@ Add the [PowerSync Web NPM package](https://www.npmjs.com/package/@powersync/web
```
</Tab>
</Tabs>

**Install Peer Dependencies**

This SDK currently requires [`@journeyapps/wa-sqlite`](https://www.npmjs.com/package/@journeyapps/wa-sqlite) as a peer dependency. Install it in your app with:

<Tabs>
<Tab title="npm">
```bash
npm install @journeyapps/wa-sqlite
```
</Tab>

<Tab title="yarn">
```bash
yarn add @journeyapps/wa-sqlite
```
</Tab>

<Tab title="pnpm">
```bash
pnpm install @journeyapps/wa-sqlite
```
</Tab>
</Tabs>
Loading