Documentation edits made through Mintlify web editor

Author: benitav

client-sdk-references/javascript-web.mdx

@@ -3,22 +3,27 @@ title: "JavaScript Web"
 description: "Full SDK reference for using PowerSync in JavaScript Web clients"
 sidebarTitle: Overview
 ---
+
 <CardGroup>
   <Card title="PowerSync SDK on NPM" icon="npm" href="https://www.npmjs.com/package/@powersync/web">
-  This SDK is distributed via NPM [[External link].](https://www.npmjs.com/package/@powersync/web)
+    This SDK is distributed via NPM [\[External link\].](https://www.npmjs.com/package/@powersync/web)
   </Card>
+
   <Card title="Source Code" icon="github" href="https://github.com/powersync-ja/powersync-js/tree/main/packages/web">
-  Refer to packages/web in the powersync-js repo on GitHub.
+    Refer to packages/web in the powersync-js repo on GitHub.
   </Card>
+
   <Card title="API Reference" icon="book" href="https://powersync-ja.github.io/powersync-js/web-sdk">
-  Full API reference for the PowerSync SDK [[External link].](https://powersync-ja.github.io/powersync-js/web-sdk)
+    Full API reference for the PowerSync SDK [\[External link\].](https://powersync-ja.github.io/powersync-js/web-sdk)
   </Card>
+
   <Card title="Example Projects" icon="code" href="/resources/demo-apps-example-projects">
-  Gallery of example projects/demo apps built with JavaScript Web stacks and PowerSync.
+    Gallery of example projects/demo apps built with JavaScript Web stacks and PowerSync.
   </Card>
 </CardGroup>
 
 ### SDK Features
+
 * Provides real-time streaming of database changes.
 * Offers direct access to the SQLite database, enabling the use of SQL on both client and server sides.
 * Operations are asynchronous by default, ensuring the user interface remains unblocked.
@@ -31,17 +36,17 @@ sidebarTitle: Overview
 See the [SDK's README](https://www.npmjs.com/package/@powersync/web) for installation instructions.
 
 <Info>
-**Some peer dependencies are required.**
-
-**Note**: As of @powersync/web@1.4.0, polyfills are bundled in the SDK and are no longer required.
+  **Some peer dependencies are required.**
 
-See the [Readme](https://www.npmjs.com/package/@powersync/web#installation) for the necessary peer dependencies that need to be installed.
+  **Note**: As of @powersync/web@1.4.0, polyfills are bundled in the SDK and are no longer required.
 
-By default this SDK connects to a PowerSync instance via WebSocket (from @powersync/web@1.6.0) or HTTP stream (before @powersync/web@1.6.0).
+  See the [Readme](https://www.npmjs.com/package/@powersync/web#installation) for the necessary peer dependencies that need to be installed.
 
-* See the [Developer Notes](/client-sdk-references/javascript-web#developer-notes) section below for details about connecting with either method.
+  By default this SDK connects to a PowerSync instance via WebSocket (from @powersync/web@1.6.0) or HTTP stream (before @powersync/web@1.6.0).
 
+  * See the [Developer Notes](/client-sdk-references/javascript-web#developer-notes) section below for details about connecting with either method.
 </Info>
+
 ## Getting Started
 
 Before implementing the PowerSync SDK in your project, make sure you have completed these steps:
@@ -50,29 +55,29 @@ Before implementing the PowerSync SDK in your project, make sure you have comple
 * [Configured your backend database](/installation/database-setup) and connected it to your PowerSync instance.
 * [Installed](/client-sdk-references/javascript-web#installation) the PowerSync Web SDK.
 
-### 1\. Define the Schema
+### 1. Define the Schema
 
 The first step is defining the schema for the local SQLite database.
 
 This schema represents a "view" of the downloaded data. No migrations are required — the schema is applied directly when the local PowerSync database is constructed (as we'll show in the next step).
 
 <Info>
-**Generate schema automatically**
+  **Generate schema automatically**
 
-In the [dashboard](/usage/tools/powersync-dashboard), the schema can be generated based off your sync rules by right-clicking on an instance and selecting **Generate client-side schema**.
+  In the [dashboard](/usage/tools/powersync-dashboard), the schema can be generated based off your sync rules by right-clicking on an instance and selecting **Generate client-side schema**.
 
-Similar functionality exists in the [CLI](/usage/tools/cli).
+  Similar functionality exists in the [CLI](/usage/tools/cli).
 </Info>
 
-The types available are `text`, `integer` and `real`. These should map directly to the values produced by the [Sync Rules](/usage/sync-rules). If a value doesn't match, it is cast automatically. For details on how Postgres types are mapped to the types below, see the section on [Types](/usage/sync-rules/types) in the _Sync Rules_ documentation.
+The types available are `text`, `integer` and `real`. These should map directly to the values produced by the [Sync Rules](/usage/sync-rules). If a value doesn't match, it is cast automatically. For details on how Postgres types are mapped to the types below, see the section on [Types](/usage/sync-rules/types) in the *Sync Rules* documentation.
 
 **Example**:
 
 ```js
 // AppSchema.ts
 import { column, Schema, Table } from '@powersync/web';
 
-const lists = new TableV2({
+const lists = new Table({
   created_at: column.text,
   name: column.text,
   owner_id: column.text
@@ -108,7 +113,7 @@ export type ListRecord = Database['lists'];
   **Note**: No need to declare a primary key `id` column, as PowerSync will automatically create this.
 </Info>
 
-### 2\. Instantiate the PowerSync Database
+### 2. Instantiate the PowerSync Database
 
 Next, you need to instantiate the PowerSync database — this is the core managed database.
 
@@ -134,9 +139,9 @@ export const db = new PowerSyncDatabase({
 ```
 
 <Note>
-**SDK versions lower than 1.2.0**
+  **SDK versions lower than 1.2.0**
 
-In SDK versions lower than 1.2.0, you will need to use the deprecated [WASQLitePowerSyncDatabaseOpenFactory](https://powersync-ja.github.io/powersync-js/web-sdk/classes/WASQLitePowerSyncDatabaseOpenFactory) syntax to instantiate the database.
+  In SDK versions lower than 1.2.0, you will need to use the deprecated [WASQLitePowerSyncDatabaseOpenFactory](https://powersync-ja.github.io/powersync-js/web-sdk/classes/WASQLitePowerSyncDatabaseOpenFactory) syntax to instantiate the database.
 </Note>
 
 Once you've instantiated your PowerSync database, you will need to call the [connect()](https://powersync-ja.github.io/powersync-js/web-sdk/classes/AbstractPowerSyncDatabase#connect) method to activate it.
@@ -149,7 +154,7 @@ export const setupPowerSync = async () => {
 };
 ```
 
-### 3\. Integrate with your Backend
+### 3. Integrate with your Backend
 
 The PowerSync backend connector provides the connection between your application backend and the PowerSync client-slide managed SQLite database.
 
@@ -160,9 +165,9 @@ It is used to:
 
 Accordingly, the connector must implement two methods:
 
-1. [PowerSyncBackendConnector.fetchCredentials](https://powersync-ja.github.io/powersync-js/web-sdk/interfaces/PowerSyncBackendConnector#fetchcredentials) \- This is called every couple of minutes and is used to obtain credentials for your app backend API. -> See [Authentication Setup](/installation/authentication-setup) for instructions on how the credentials should be generated.
-2. [PowerSyncBackendConnector.uploadData](https://powersync-ja.github.io/powersync-js/web-sdk/interfaces/PowerSyncBackendConnector#uploaddata) \- Use this to upload client-side changes to your app backend.
-\-> See [Writing Client Changes](/installation/app-backend-setup/writing-client-changes) for considerations on the app backend implementation.
+1. [PowerSyncBackendConnector.fetchCredentials](https://powersync-ja.github.io/powersync-js/web-sdk/interfaces/PowerSyncBackendConnector#fetchcredentials) - This is called every couple of minutes and is used to obtain credentials for your app backend API. -> See [Authentication Setup](/installation/authentication-setup) for instructions on how the credentials should be generated.
+2. [PowerSyncBackendConnector.uploadData](https://powersync-ja.github.io/powersync-js/web-sdk/interfaces/PowerSyncBackendConnector#uploaddata) - Use this to upload client-side changes to your app backend.
+   -> See [Writing Client Changes](/installation/app-backend-setup/writing-client-changes) for considerations on the app backend implementation.
 
 **Example**:
 
@@ -203,10 +208,10 @@ Once the PowerSync instance is configured you can start using the SQLite DB func
 
 The most commonly used CRUD functions to interact with your SQLite data are:
 
-* [PowerSyncDatabase.get](/client-sdk-references/javascript-web#fetching-a-single-item) \- get (SELECT) a single row from a table.
-* [PowerSyncDatabase.getAll](/client-sdk-references/javascript-web#querying-items-powersync.getall) \- get (SELECT) a set of rows from a table.
-* [PowerSyncDatabase.watch](/client-sdk-references/javascript-web#watching-queries-powersync.watch) \- execute a read query every time source tables are modified.
-* [PowerSyncDatabase.execute](/client-sdk-references/javascript-web#mutations-powersync.execute) \- execute a write (INSERT/UPDATE/DELETE) query.
+* [PowerSyncDatabase.get](/client-sdk-references/javascript-web#fetching-a-single-item) - get (SELECT) a single row from a table.
+* [PowerSyncDatabase.getAll](/client-sdk-references/javascript-web#querying-items-powersync.getall) - get (SELECT) a set of rows from a table.
+* [PowerSyncDatabase.watch](/client-sdk-references/javascript-web#watching-queries-powersync.watch) - execute a read query every time source tables are modified.
+* [PowerSyncDatabase.execute](/client-sdk-references/javascript-web#mutations-powersync.execute) - execute a write (INSERT/UPDATE/DELETE) query.
 
 ### Fetching a Single Item
 
@@ -308,4 +313,4 @@ See [JavaScript ORM Support](/client-sdk-references/javascript-web/javascript-or
 
 ## Troubleshooting
 
-See [Troubleshooting](/resources/troubleshooting) for pointers to debug common issues.
+See [Troubleshooting](/resources/troubleshooting) for pointers to debug common issues.