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

.changeset/bright-cooks-change.md

@@ -0,0 +1,6 @@
+---
+'@powersync/common': patch
+'@powersync/web': patch
+---
+
+Added support for user parameters.

packages/common/src/client/connection/PowerSyncCredentials.ts

@@ -2,4 +2,5 @@ export interface PowerSyncCredentials {
   endpoint: string;
   token: string;
   expiresAt?: Date;
+  params?: Record<string, string>;
 }

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

@@ -431,6 +431,7 @@ export abstract class AbstractStreamingSyncImplementation
         let appliedCheckpoint: Checkpoint | null = null;
 
         let bucketSet = new Set<string>(initialBuckets.keys());
+        const { params = undefined } = (await this.options.remote.getCredentials()) ?? {};
 
         this.logger.debug('Requesting stream from server');
 
@@ -440,7 +441,8 @@ export abstract class AbstractStreamingSyncImplementation
           data: {
             buckets: req,
             include_checksum: true,
-            raw_data: true
+            raw_data: true,
+            parameters: 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, string>;
 }
 
 export interface StreamingSyncCheckpoint {

packages/web/src/db/sync/SharedWebStreamingSyncImplementation.ts

@@ -29,6 +29,7 @@ class SharedSyncClientProvider extends AbstractSharedSyncClientProvider {
     if (credentials == null) {
       return null;
     }
+
     /**
      * The credentials need to be serializable.
      * Users might extend [PowerSyncCredentials] to contain
@@ -38,7 +39,8 @@ class SharedSyncClientProvider extends AbstractSharedSyncClientProvider {
     return {
       endpoint: credentials.endpoint,
       token: credentials.token,
-      expiresAt: credentials.expiresAt
+      expiresAt: credentials.expiresAt,
+      params: credentials.params
     };
   }