Use internal type for serialized schema

Author: simolus3

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -27,6 +27,7 @@ import { CrudTransaction } from './sync/bucket/CrudTransaction.js';
 import {
   DEFAULT_CRUD_UPLOAD_THROTTLE_MS,
   DEFAULT_RETRY_DELAY_MS,
+  InternalConnectionOptions,
   StreamingSyncImplementation,
   StreamingSyncImplementationListener,
   type AdditionalConnectionOptions,
@@ -462,7 +463,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
    * Connects to stream of events from the PowerSync instance.
    */
   async connect(connector: PowerSyncBackendConnector, options?: PowerSyncConnectionOptions) {
-    const resolvedOptions = options ?? {};
+    const resolvedOptions: InternalConnectionOptions = options ?? {};
     resolvedOptions.serializedSchema = this.schema.toJSON();
 
     return this.connectionManager.connect(connector, resolvedOptions);

packages/common/src/client/ConnectionManager.ts

@@ -2,7 +2,7 @@ import { ILogger } from 'js-logger';
 import { BaseListener, BaseObserver } from '../utils/BaseObserver.js';
 import { PowerSyncBackendConnector } from './connection/PowerSyncBackendConnector.js';
 import {
-  PowerSyncConnectionOptions,
+  InternalConnectionOptions,
   StreamingSyncImplementation
 } from './sync/stream/AbstractStreamingSyncImplementation.js';
 
@@ -24,14 +24,14 @@ export interface ConnectionManagerSyncImplementationResult {
 export interface ConnectionManagerOptions {
   createSyncImplementation(
     connector: PowerSyncBackendConnector,
-    options: PowerSyncConnectionOptions
+    options: InternalConnectionOptions
   ): Promise<ConnectionManagerSyncImplementationResult>;
   logger: ILogger;
 }
 
 type StoredConnectionOptions = {
   connector: PowerSyncBackendConnector;
-  options: PowerSyncConnectionOptions;
+  options: InternalConnectionOptions;
 };
 
 /**
@@ -95,7 +95,7 @@ export class ConnectionManager extends BaseObserver<ConnectionManagerListener> {
     await this.syncDisposer?.();
   }
 
-  async connect(connector: PowerSyncBackendConnector, options: PowerSyncConnectionOptions) {
+  async connect(connector: PowerSyncBackendConnector, options: InternalConnectionOptions) {
     // Keep track if there were pending operations before this call
     const hadPendingOptions = !!this.pendingConnectionOptions;
 
@@ -140,7 +140,7 @@ export class ConnectionManager extends BaseObserver<ConnectionManagerListener> {
   }
 
   protected async connectInternal() {
-    let appliedOptions: PowerSyncConnectionOptions | null = null;
+    let appliedOptions: InternalConnectionOptions | null = null;
 
     // This method ensures a disconnect before any connection attempt
     await this.disconnectInternal();

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

@@ -123,7 +123,9 @@ export interface StreamingSyncImplementationListener extends BaseListener {
  * Configurable options to be used when connecting to the PowerSync
  * backend instance.
  */
-export interface PowerSyncConnectionOptions extends BaseConnectionOptions, AdditionalConnectionOptions {}
+export type PowerSyncConnectionOptions = Omit<InternalConnectionOptions, 'serializedSchema'>;
+
+export interface InternalConnectionOptions extends BaseConnectionOptions, AdditionalConnectionOptions {}
 
 /** @internal */
 export interface BaseConnectionOptions {
@@ -181,7 +183,7 @@ export interface StreamingSyncImplementation extends BaseObserver<StreamingSyncI
   /**
    * Connects to the sync service
    */
-  connect(options?: PowerSyncConnectionOptions): Promise<void>;
+  connect(options?: InternalConnectionOptions): Promise<void>;
   /**
    * Disconnects from the sync services.
    * @throws if not connected or if abort is not controlled internally