update: added client parameters to PowerSyncCredentials which are available in sync rules.

.changeset/bright-cooks-change.md

@@ -0,0 +1,6 @@
+---
+'@powersync/common': minor
+'@powersync/web': minor
+---
+
+Added support for user parameters. These parameters can be specified as part of the `connect` method's options object.

packages/common/src/client/sync/stream/AbstractStreamingSyncImplementation.ts

@@ -73,6 +73,11 @@ export interface PowerSyncConnectionOptions {
    * Defaults to a HTTP streaming connection.
    */
   connectionMethod?: SyncStreamConnectionMethod;
+
+  /**
+   * These parameters are passed to the sync rules, and will be available under the`user_parameters` object.
+   */
+  params?: Record<string, any>;
 }
 
 export interface StreamingSyncImplementation extends BaseObserver<StreamingSyncImplementationListener>, Disposable {
@@ -104,7 +109,8 @@ export const DEFAULT_STREAMING_SYNC_OPTIONS = {
 };
 
 export const DEFAULT_STREAM_CONNECTION_OPTIONS: Required<PowerSyncConnectionOptions> = {
-  connectionMethod: SyncStreamConnectionMethod.HTTP
+  connectionMethod: SyncStreamConnectionMethod.HTTP,
+  params: {}
 };
 
 export abstract class AbstractStreamingSyncImplementation
@@ -445,7 +451,8 @@ export abstract class AbstractStreamingSyncImplementation
           data: {
             buckets: req,
             include_checksum: true,
-            raw_data: true
+            raw_data: true,
+            parameters: resolvedOptions.params
           }
         };
 

packages/common/src/client/sync/stream/streaming-sync-types.ts

@@ -75,6 +75,11 @@ export interface StreamingSyncRequest {
    * Changes the response to stringified data in each OplogEntry
    */
   raw_data: boolean;
+
+  /**
+   * Client parameters to be passed to the sync rules.
+   */
+  parameters?: Record<string, any>;
 }
 
 export interface StreamingSyncCheckpoint {