@powersync/common 1.11.1 → 1.12.0

package/lib/client/sync/stream/AbstractStreamingSyncImplementation.d.ts

@@ -1,4 +1,5 @@
 import { ILogger } from 'js-logger';
+import { StreamingSyncRequestParameterType } from './streaming-sync-types';
 import { AbstractRemote } from './AbstractRemote';
 import { BucketStorageAdapter } from '../bucket/BucketStorageAdapter';
 import { SyncStatus, SyncStatusOptions } from '../../../db/crud/SyncStatus';
@@ -54,6 +55,10 @@ 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, StreamingSyncRequestParameterType>;
 }
 export interface StreamingSyncImplementation extends BaseObserver<StreamingSyncImplementationListener>, Disposable {
     /**

package/lib/client/sync/stream/AbstractStreamingSyncImplementation.js

@@ -22,7 +22,8 @@ export const DEFAULT_STREAMING_SYNC_OPTIONS = {
     crudUploadThrottleMs: DEFAULT_CRUD_UPLOAD_THROTTLE_MS
 };
 export const DEFAULT_STREAM_CONNECTION_OPTIONS = {
-    connectionMethod: SyncStreamConnectionMethod.HTTP
+    connectionMethod: SyncStreamConnectionMethod.HTTP,
+    params: {}
 };
 export class AbstractStreamingSyncImplementation extends BaseObserver {
     _lastSyncedAt;
@@ -315,7 +316,8 @@ export class AbstractStreamingSyncImplementation extends BaseObserver {
                     data: {
                         buckets: req,
                         include_checksum: true,
-                        raw_data: true
+                        raw_data: true,
+                        parameters: resolvedOptions.params
                     }
                 };
                 const stream = resolvedOptions?.connectionMethod == SyncStreamConnectionMethod.HTTP

package/lib/client/sync/stream/streaming-sync-types.d.ts

@@ -42,6 +42,12 @@ export interface SyncResponse {
     checkpoint_token?: string;
     checkpoint?: Checkpoint;
 }
+type JSONValue = string | number | boolean | null | undefined | JSONObject | JSONArray;
+interface JSONObject {
+    [key: string]: JSONValue;
+}
+type JSONArray = JSONValue[];
+export type StreamingSyncRequestParameterType = JSONValue;
 export interface StreamingSyncRequest {
     /**
      * Existing bucket states.
@@ -59,6 +65,10 @@ 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, StreamingSyncRequestParameterType>;
 }
 export interface StreamingSyncCheckpoint {
     checkpoint: Checkpoint;
@@ -114,3 +124,4 @@ export interface CrudResponse {
      */
     checkpoint?: OpId;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/common",
-  "version": "1.11.1",
+  "version": "1.12.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"