Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions client-sdk-references/node.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Node.js client (alpha)"
title: "Node.js client (Beta)"
description: "SDK reference for using PowerSync in Node.js clients."
sidebarTitle: Overview
---
Expand All @@ -8,7 +8,7 @@
import NodeInstallation from '/snippets/node/installation.mdx';

<Note>
This page describes the PowerSync _client_ SDK for Node.js.

Check warning on line 11 in client-sdk-references/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdk-references/node.mdx#L11

Did you really mean '_client_'?
If you're interested in using PowerSync for your Node.js backend, no special package is required.
Instead, follow our guides on [app backend setup](/installation/app-backend-setup).
</Note>
Expand All @@ -26,13 +26,13 @@
Full API reference for the PowerSync SDK [\[External link\].](https://powersync-ja.github.io/powersync-js/node-sdk)
</Card>

<Card title="Example Projects" icon="code" href="/resources/demo-apps-example-projects#node-js-alpha">
<Card title="Example Projects" icon="code" href="/resources/demo-apps-example-projects#node-js-beta">
Gallery of example projects/demo apps built with Node.js and PowerSync.
</Card>
</CardGroup>

<Warning>
This SDK is currently in an [**alpha** release](/resources/feature-status). It is not suitable for production use as breaking changes may still occur.
This SDK is currently in a [**beta** release](/resources/feature-status) and can be considered production-ready for tested use cases.
</Warning>

### SDK Features
Expand Down
2 changes: 1 addition & 1 deletion installation/client-side-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

3. [Instantiate the PowerSync Database](/installation/client-side-setup/instantiate-powersync-database)

* This instantiates the aforemention managed SQLite database.

Check warning on line 27 in installation/client-side-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

installation/client-side-setup.mdx#L27

Did you really mean 'aforemention'?

4. [Integrate with your Backend](/installation/client-side-setup/integrating-with-your-backend) \[Optional]

Expand Down Expand Up @@ -78,7 +78,7 @@
<Card title="Swift" icon="swift" href="/client-sdk-references/swift" horizontal />
</Accordion>

<Accordion title="Node.js (Alpha)" icon="node-js">
<Accordion title="Node.js (Beta)" icon="node-js">
<NodeInstallation />

See the full SDK reference for further details and getting started instructions:
Expand Down
2 changes: 1 addition & 1 deletion installation/client-side-setup/define-your-schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ For an example implementation of the client-side schema, see the _Getting Starte

* [1\. Define the Schema](/client-sdk-references/swift#1-define-the-schema)

### <Icon icon="node-js" iconType="solid" size={32}/> Node.js (alpha)
### <Icon icon="node-js" iconType="solid" size={32}/> Node.js (beta)

* [1\. Define the Schema](/client-sdk-references/node#1-define-the-schema)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For an example implementation of instantiating the client-side database, see the

* [2\. Instantiate the PowerSync Database](/client-sdk-references/swift#2-instantiate-the-powersync-database)

### <Icon icon="node-js" iconType="solid" size={32}/> Node.js (alpha)
### <Icon icon="node-js" iconType="solid" size={32}/> Node.js (beta)

* [2\. Instantiate the PowerSync Database](/client-sdk-references/node#2-instantiate-the-powersync-database)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For an example implementation of a PowerSync 'backend connector', see the _Getti

* [3\. Integrate with your Backend](/client-sdk-references/javascript-web#3-integrate-with-your-backend)

### <Icon icon="node-js" iconType="solid" size={32}/> Node.js (alpha)
### <Icon icon="node-js" iconType="solid" size={32}/> Node.js (beta)

* [3\. Integrate with your Backend](/client-sdk-references/node#3-integrate-with-your-backend)

Expand Down
2 changes: 1 addition & 1 deletion installation/quickstart-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ PowerSync is designed to be stack agnostic, and currently supports [Postgres](/i
- [**JavaScript Web**](/client-sdk-references/javascript-web) (including integrations for React & Vue)
- [**Kotlin Multiplatform**](/client-sdk-references/kotlin-multiplatform)
- [**Swift**](/client-sdk-references/swift)
- [**Node.js**](/client-sdk-references/node) (alpha)
- [**Node.js**](/client-sdk-references/node) (beta)
- [**.NET**](/client-sdk-references/dotnet) (alpha)

<Note>
Expand Down
4 changes: 2 additions & 2 deletions migration-guides/mongodb-atlas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@

If you have a PowerSync Service instance set up and connected, open the `sync-rules.yaml` file associated with your PowerSync project and edit the SQL-like queries based on your database schema. Below is a simple Sync Rules example using a simple database schema. Sync Rules involve organizing data into ["buckets"](/usage/sync-rules/organize-data-into-buckets) (a bucket is a grouping of data). The example below uses a ["global bucket"](/usage/sync-rules/example-global-data) as a simple starting point — data in a "global bucket" will be synced to all users.

<Info>Note that MongoDB uses "_id" as the name of the ID field in collections whereas PowerSync uses "id" in its client-side database. This is why `SELECT _id as id` should always be used in the data queries when pairing PowerSync with MongoDB.</Info>

Check warning on line 86 in migration-guides/mongodb-atlas.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

migration-guides/mongodb-atlas.mdx#L86

Did you really mean '_id'?

```yaml
bucket_definitions:
Expand Down Expand Up @@ -158,7 +158,7 @@
```

```typescript TypeScript - Node.js
// Our Node.js SDK is currently in an alpha release
// Our Node.js SDK is currently in a beta release
import { column, Schema, Table } from '@powersync/node';

const todos = new Table(
Expand Down Expand Up @@ -311,7 +311,7 @@
```

```typescript TypeScript - Node.js
// Our Node.js SDK is currently in an alpha release
// Our Node.js SDK is currently in a beta release
import { PowerSyncDatabase } from '@powersync/node';
import { Connector } from './Connector';
import { AppSchema } from './Schema';
Expand Down
2 changes: 1 addition & 1 deletion resources/demo-apps-example-projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ This page showcases example projects organized by platform and backend technolog
* [Vite with Encryption](https://github.com/powersync-ja/powersync-js/blob/main/demos/example-vite-encryption/README.md) - Web database encryption demo
</Accordion>

<Accordion title="Node.js (alpha)" icon="node-js">
<Accordion title="Node.js (beta)" icon="node-js">
#### Examples

* [CLI Example](https://github.com/powersync-ja/powersync-js/tree/main/demos/example-node) - Node.js CLI client connecting to PowerSync and running live queries
Expand Down
2 changes: 1 addition & 1 deletion resources/feature-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Below is a summary of the current main PowerSync features and their release stat
| | |
| **Client SDKs** | |
| .NET SDK | Alpha |
| Node.js SDK | Alpha |
| Node.js SDK | Beta |
| Swift SDK | V1 |
| Kotlin Multiplatform SDK | V1 |
| JavaScript/Web SDK | V1 |
Expand Down
2 changes: 1 addition & 1 deletion snippets/client-sdks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<Card title="Swift" icon="swift" href="/client-sdk-references/swift" />

<Card title="Node.js (Alpha)" icon="node-js" href="/client-sdk-references/node" />
<Card title="Node.js (Beta)" icon="node-js" href="/client-sdk-references/node" />

<Card title=".NET (Alpha)" icon="microsoft" href="/client-sdk-references/dotnet" />
</CardGroup>
2 changes: 1 addition & 1 deletion usage/lifecycle-maintenance/upgrading-the-client-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ pnpm upgrade @powersync/web @journeyapps/wa-sqlite
</Tab>
</Tabs>

## <Icon icon="js" iconType="solid" size={32}/> Node.js (alpha)
## <Icon icon="js" iconType="solid" size={32}/> Node.js (beta)

Run the below command in your project folder:

Expand Down