refactor: interfaces to be more clear

Author: DominicGBauer

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -24,7 +24,7 @@ import { CrudEntry, CrudEntryJSON } from './sync/bucket/CrudEntry.js';
 import { CrudTransaction } from './sync/bucket/CrudTransaction.js';
 import {
   DEFAULT_CRUD_UPLOAD_THROTTLE_MS,
-  type PowerSyncConnectionOptionalOptions,
+  type AdditionalConnectionOptions,
   type PowerSyncConnectionOptions,
   StreamingSyncImplementation,
   StreamingSyncImplementationListener
@@ -36,7 +36,7 @@ export interface DisconnectAndClearOptions {
   clearLocal?: boolean;
 }
 
-export interface BasePowerSyncDatabaseOptions extends PowerSyncConnectionOptionalOptions {
+export interface BasePowerSyncDatabaseOptions extends AdditionalConnectionOptions {
   /** Schema used for the local database. */
   schema: Schema;
   logger?: ILogger;
@@ -233,7 +233,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
 
   protected abstract generateSyncStreamImplementation(
     connector: PowerSyncBackendConnector,
-    options?: PowerSyncConnectionOptionalOptions
+    options?: AdditionalConnectionOptions
   ): StreamingSyncImplementation;
 
   protected abstract generateBucketStorageAdapter(): BucketStorageAdapter;

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

@@ -37,18 +37,16 @@ export interface LockOptions<T> {
   signal?: AbortSignal;
 }
 
-export interface AbstractStreamingSyncImplementationOptions {
+export interface AbstractStreamingSyncImplementationOptions extends AdditionalConnectionOptions {
   adapter: BucketStorageAdapter;
   uploadCrud: () => Promise<void>;
-  crudUploadThrottleMs?: number;
   /**
    * An identifier for which PowerSync DB this sync implementation is
    * linked to. Most commonly DB name, but not restricted to DB name.
    */
   identifier?: string;
   logger?: ILogger;
   remote: AbstractRemote;
-  retryDelayMs?: number;
 }
 
 export interface StreamingSyncImplementationListener extends BaseListener {
@@ -67,23 +65,21 @@ export interface StreamingSyncImplementationListener extends BaseListener {
  * Configurable options to be used when connecting to the PowerSync
  * backend instance.
  */
-export interface PowerSyncConnectionOptions extends PowerSyncConnectionOptionalOptions, PowerSyncConnectionRequiredOptions {}
-
-export interface PowerSyncConnectionRequiredOptions {
-  /**
+export interface PowerSyncConnectionOptions extends AdditionalConnectionOptions {
+    /**
    * The connection method to use when streaming updates from
    * the PowerSync backend instance.
    * Defaults to a HTTP streaming connection.
    */
-  connectionMethod: SyncStreamConnectionMethod;
+    connectionMethod: SyncStreamConnectionMethod;
 
-  /**
-   * These parameters are passed to the sync rules, and will be available under the`user_parameters` object.
-   */
-  params: Record<string, StreamingSyncRequestParameterType>;
+    /**
+     * These parameters are passed to the sync rules, and will be available under the`user_parameters` object.
+     */
+    params: Record<string, StreamingSyncRequestParameterType>;
 }
 
-export interface PowerSyncConnectionOptionalOptions {
+export interface AdditionalConnectionOptions {
     /**
    * Delay for retrying sync streaming operations
    * from the PowerSync backend after an error occurs.
@@ -126,7 +122,7 @@ export const DEFAULT_STREAMING_SYNC_OPTIONS = {
   crudUploadThrottleMs: DEFAULT_CRUD_UPLOAD_THROTTLE_MS
 };
 
-export const DEFAULT_STREAM_CONNECTION_OPTIONS: PowerSyncConnectionRequiredOptions = {
+export const DEFAULT_STREAM_CONNECTION_OPTIONS: PowerSyncConnectionOptions = {
   connectionMethod: SyncStreamConnectionMethod.WEB_SOCKET,
   params: {}
 };
@@ -444,7 +440,7 @@ The next upload iteration will be delayed.`);
       type: LockType.SYNC,
       signal,
       callback: async () => {
-        const resolvedOptions: PowerSyncConnectionRequiredOptions = {
+        const resolvedOptions: PowerSyncConnectionOptions = {
           ...DEFAULT_STREAM_CONNECTION_OPTIONS,
           ...(options ?? {})
         };

packages/web/src/db/PowerSyncDatabase.ts

@@ -3,7 +3,7 @@ import {
   type PowerSyncBackendConnector,
   type PowerSyncCloseOptions,
   type PowerSyncConnectionOptions,
-  type PowerSyncConnectionOptionalOptions,
+  type AdditionalConnectionOptions,
   AbstractPowerSyncDatabase,
   DBAdapter,
   DEFAULT_POWERSYNC_CLOSE_OPTIONS,
@@ -168,7 +168,7 @@ export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
   protected generateSyncStreamImplementation(
     connector: PowerSyncBackendConnector,
     // This is used to pass in options on connection instead of only during db creation
-    options?: PowerSyncConnectionOptionalOptions
+    options?: AdditionalConnectionOptions
   ): StreamingSyncImplementation {
     const remote = new WebRemote(connector);
     // Use the options passed in during connect, or fallback to the options set during database creation