Powersync docs (#756)

Add PowerSync docs

Author: stevensJourney

docs/config.json

@@ -105,6 +105,10 @@
         {
           "label": "RxDB Collection",
           "to": "collections/rxdb-collection"
+        },
+        {
+          "label": "PowerSync Collection",
+          "to": "collections/powersync-collection"
         }
       ]
     },
@@ -171,6 +175,14 @@
         {
           "label": "rxdbCollectionOptions",
           "to": "reference/rxdb-db-collection/functions/rxdbcollectionoptions"
+        },
+        {
+          "label": "PowerSync Collection",
+          "to": "reference/powersync-db-collection/index"
+        },
+        {
+          "label": "powersyncCollectionOptions",
+          "to": "reference/powersync-db-collection/functions/powerSyncCollectionOptions"
         }
       ],
       "frameworks": [

docs/overview.md

@@ -143,6 +143,8 @@ TanStack DB provides several built-in collection types for different data source
 
 - **[RxDBCollection](./collections/rxdb-collection.md)** — Integrate with RxDB for offline-first local persistence with powerful replication and sync capabilities.
 
+- **[PowerSyncCollection](./collections/powersync-collection.md)** — Sync with PowerSync's SQLite-based database for offline-first persistence with real-time synchronization with PostgreSQL, MongoDB, and MySQL backends.
+
 **Local Collections**
 
 - **[LocalStorageCollection](./collections/local-storage-collection.md)** — Store small amounts of local-only state that persists across sessions and syncs across browser tabs.

docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md

@@ -0,0 +1,240 @@
+---
+id: PowerSyncTransactor
+title: PowerSyncTransactor
+---
+
+# Class: PowerSyncTransactor
+
+Defined in: [PowerSyncTransactor.ts:51](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L51)
+
+Applies mutations to the PowerSync database. This method is called automatically by the collection's
+insert, update, and delete operations. You typically don't need to call this directly unless you
+have special transaction requirements.
+
+## Example
+
+```typescript
+// Create a collection
+const collection = createCollection(
+  powerSyncCollectionOptions<Document>({
+    database: db,
+    table: APP_SCHEMA.props.documents,
+  })
+)
+
+const addTx = createTransaction({
+  autoCommit: false,
+  mutationFn: async ({ transaction }) => {
+    await new PowerSyncTransactor({ database: db }).applyTransaction(transaction)
+  },
+})
+
+addTx.mutate(() => {
+  for (let i = 0; i < 5; i++) {
+    collection.insert({ id: randomUUID(), name: `tx-${i}` })
+  }
+})
+
+await addTx.commit()
+await addTx.isPersisted.promise
+```
+
+## Param
+
+The transaction containing mutations to apply
+
+## Constructors
+
+### Constructor
+
+```ts
+new PowerSyncTransactor(options): PowerSyncTransactor;
+```
+
+Defined in: [PowerSyncTransactor.ts:55](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L55)
+
+#### Parameters
+
+##### options
+
+[`TransactorOptions`](../type-aliases/TransactorOptions.md)
+
+#### Returns
+
+`PowerSyncTransactor`
+
+## Properties
+
+### database
+
+```ts
+database: AbstractPowerSyncDatabase;
+```
+
+Defined in: [PowerSyncTransactor.ts:52](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L52)
+
+***
+
+### pendingOperationStore
+
+```ts
+pendingOperationStore: PendingOperationStore;
+```
+
+Defined in: [PowerSyncTransactor.ts:53](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L53)
+
+## Methods
+
+### applyTransaction()
+
+```ts
+applyTransaction(transaction): Promise<void>;
+```
+
+Defined in: [PowerSyncTransactor.ts:63](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L63)
+
+Persists a Transaction to the PowerSync SQLite database.
+
+#### Parameters
+
+##### transaction
+
+`Transaction`\<`any`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### handleDelete()
+
+```ts
+protected handleDelete(
+   mutation, 
+   context, 
+waitForCompletion): Promise<PendingOperation | null>;
+```
+
+Defined in: [PowerSyncTransactor.ts:204](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L204)
+
+#### Parameters
+
+##### mutation
+
+`PendingMutation`\<`any`\>
+
+##### context
+
+`LockContext`
+
+##### waitForCompletion
+
+`boolean` = `false`
+
+#### Returns
+
+`Promise`\<`PendingOperation` \| `null`\>
+
+***
+
+### handleInsert()
+
+```ts
+protected handleInsert(
+   mutation, 
+   context, 
+waitForCompletion): Promise<PendingOperation | null>;
+```
+
+Defined in: [PowerSyncTransactor.ts:149](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L149)
+
+#### Parameters
+
+##### mutation
+
+`PendingMutation`\<`any`\>
+
+##### context
+
+`LockContext`
+
+##### waitForCompletion
+
+`boolean` = `false`
+
+#### Returns
+
+`Promise`\<`PendingOperation` \| `null`\>
+
+***
+
+### handleOperationWithCompletion()
+
+```ts
+protected handleOperationWithCompletion(
+   mutation, 
+   context, 
+   waitForCompletion, 
+handler): Promise<PendingOperation | null>;
+```
+
+Defined in: [PowerSyncTransactor.ts:232](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L232)
+
+Helper function which wraps a persistence operation by:
+- Fetching the mutation's collection's SQLite table details
+- Executing the mutation
+- Returning the last pending diff operation if required
+
+#### Parameters
+
+##### mutation
+
+`PendingMutation`\<`any`\>
+
+##### context
+
+`LockContext`
+
+##### waitForCompletion
+
+`boolean`
+
+##### handler
+
+(`tableName`, `mutation`, `serializeValue`) => `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`PendingOperation` \| `null`\>
+
+***
+
+### handleUpdate()
+
+```ts
+protected handleUpdate(
+   mutation, 
+   context, 
+waitForCompletion): Promise<PendingOperation | null>;
+```
+
+Defined in: [PowerSyncTransactor.ts:177](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L177)
+
+#### Parameters
+
+##### mutation
+
+`PendingMutation`\<`any`\>
+
+##### context
+
+`LockContext`
+
+##### waitForCompletion
+
+`boolean` = `false`
+
+#### Returns
+
+`Promise`\<`PendingOperation` \| `null`\>