@powersync/common 1.27.1 → 1.28.0

package/lib/client/AbstractPowerSyncDatabase.d.ts

@@ -183,6 +183,7 @@ export declare abstract class AbstractPowerSyncDatabase extends BaseObserver<Pow
      * Cannot be used while connected - this should only be called before {@link AbstractPowerSyncDatabase.connect}.
      */
     updateSchema(schema: Schema): Promise<void>;
+    get logger(): Logger.ILogger;
     /**
      * Wait for initialization to complete.
      * While initializing is automatic, this helps to catch and report initialization errors.

package/lib/client/AbstractPowerSyncDatabase.js

@@ -250,6 +250,9 @@ export class AbstractPowerSyncDatabase extends BaseObserver {
         await this.database.refreshSchema();
         this.iterateListeners(async (cb) => cb.schemaChanged?.(schema));
     }
+    get logger() {
+        return this.options.logger;
+    }
     /**
      * Wait for initialization to complete.
      * While initializing is automatic, this helps to catch and report initialization errors.
@@ -260,6 +263,7 @@ export class AbstractPowerSyncDatabase extends BaseObserver {
     // Use the options passed in during connect, or fallback to the options set during database creation or fallback to the default options
     resolvedConnectionOptions(options) {
         return {
+            ...options,
             retryDelayMs: options?.retryDelayMs ?? this.options.retryDelayMs ?? this.options.retryDelay ?? DEFAULT_RETRY_DELAY_MS,
             crudUploadThrottleMs: options?.crudUploadThrottleMs ?? this.options.crudUploadThrottleMs ?? DEFAULT_CRUD_UPLOAD_THROTTLE_MS
         };
@@ -274,11 +278,8 @@ export class AbstractPowerSyncDatabase extends BaseObserver {
         if (this.closed) {
             throw new Error('Cannot connect using a closed client');
         }
-        const { retryDelayMs, crudUploadThrottleMs } = this.resolvedConnectionOptions(options);
-        this.syncStreamImplementation = this.generateSyncStreamImplementation(connector, {
-            retryDelayMs,
-            crudUploadThrottleMs
-        });
+        const resolvedConnectOptions = this.resolvedConnectionOptions(options);
+        this.syncStreamImplementation = this.generateSyncStreamImplementation(connector, resolvedConnectOptions);
         this.syncStatusListenerDisposer = this.syncStreamImplementation.registerListener({
             statusChanged: (status) => {
                 this.currentStatus = new SyncStatus({

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

@@ -54,6 +54,13 @@ export type AbstractRemoteOptions = {
      * Binding should be done before passing here.
      */
     fetchImplementation: FetchImplementation | FetchImplementationProvider;
+    /**
+     * Optional options to pass directly to all `fetch` calls.
+     *
+     * This can include fields such as `dispatcher` (e.g. for proxy support),
+     * `cache`, or any other fetch-compatible options.
+     */
+    fetchOptions?: {};
 };
 export declare const DEFAULT_REMOTE_OPTIONS: AbstractRemoteOptions;
 export declare abstract class AbstractRemote {
@@ -84,6 +91,7 @@ export declare abstract class AbstractRemote {
      * Provides a BSON implementation. The import nature of this varies depending on the platform
      */
     abstract getBSON(): Promise<BSONImplementation>;
+    protected createSocket(url: string): WebSocket;
     /**
      * Connects to the sync/stream websocket endpoint
      */

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

@@ -44,7 +44,8 @@ export const DEFAULT_REMOTE_OPTIONS = {
     socketUrlTransformer: (url) => url.replace(/^https?:\/\//, function (match) {
         return match === 'https://' ? 'wss://' : 'ws://';
     }),
-    fetchImplementation: new FetchImplementationProvider()
+    fetchImplementation: new FetchImplementationProvider(),
+    fetchOptions: {}
 };
 export class AbstractRemote {
     connector;
@@ -153,6 +154,9 @@ export class AbstractRemote {
         }
         return res;
     }
+    createSocket(url) {
+        return new WebSocket(url);
+    }
     /**
      * Connects to the sync/stream websocket endpoint
      */
@@ -167,7 +171,8 @@ export class AbstractRemote {
         const userAgent = this.getUserAgent();
         const connector = new RSocketConnector({
             transport: new WebsocketClientTransport({
-                url: this.options.socketUrlTransformer(request.url)
+                url: this.options.socketUrlTransformer(request.url),
+                wsCreator: (url) => this.createSocket(url)
             }),
             setup: {
                 keepAlive: KEEP_ALIVE_MS,
@@ -318,6 +323,7 @@ export class AbstractRemote {
             body: JSON.stringify(data),
             signal: controller.signal,
             cache: 'no-store',
+            ...(this.options.fetchOptions ?? {}),
             ...options.fetchOptions
         }).catch((ex) => {
             if (ex.name == 'AbortError') {

package/lib/index.d.ts

@@ -32,5 +32,6 @@ export * from './db/DBAdapter.js';
 export * from './utils/AbortOperation.js';
 export * from './utils/BaseObserver.js';
 export * from './utils/DataStream.js';
+export * from './utils/Logger.js';
 export * from './utils/parseQuery.js';
 export * from './types/types.js';

package/lib/index.js

@@ -32,5 +32,6 @@ export * from './db/DBAdapter.js';
 export * from './utils/AbortOperation.js';
 export * from './utils/BaseObserver.js';
 export * from './utils/DataStream.js';
+export * from './utils/Logger.js';
 export * from './utils/parseQuery.js';
 export * from './types/types.js';

package/lib/utils/Logger.d.ts

@@ -0,0 +1,31 @@
+import Logger, { type ILogger, type ILogLevel } from 'js-logger';
+export { GlobalLogger, ILogger, ILoggerOpts, ILogHandler, ILogLevel } from 'js-logger';
+export declare const LogLevel: {
+    TRACE: Logger.ILogLevel;
+    DEBUG: Logger.ILogLevel;
+    INFO: Logger.ILogLevel;
+    TIME: Logger.ILogLevel;
+    WARN: Logger.ILogLevel;
+    ERROR: Logger.ILogLevel;
+    OFF: Logger.ILogLevel;
+};
+export interface CreateLoggerOptions {
+    logLevel?: ILogLevel;
+}
+/**
+ * Retrieves the base (default) logger instance.
+ *
+ * This base logger controls the default logging configuration and is shared
+ * across all loggers created with `createLogger`. Adjusting settings on this
+ * base logger affects all loggers derived from it unless explicitly overridden.
+ *
+ */
+export declare function createBaseLogger(): typeof Logger;
+/**
+ * Creates and configures a new named logger based on the base logger.
+ *
+ * Named loggers allow specific modules or areas of your application to have
+ * their own logging levels and behaviors. These loggers inherit configuration
+ * from the base logger by default but can override settings independently.
+ */
+export declare function createLogger(name: string, options?: CreateLoggerOptions): ILogger;

package/lib/utils/Logger.js

@@ -0,0 +1,36 @@
+import Logger from 'js-logger';
+const TypedLogger = Logger;
+export const LogLevel = {
+    TRACE: TypedLogger.TRACE,
+    DEBUG: TypedLogger.DEBUG,
+    INFO: TypedLogger.INFO,
+    TIME: TypedLogger.TIME,
+    WARN: TypedLogger.WARN,
+    ERROR: TypedLogger.ERROR,
+    OFF: TypedLogger.OFF
+};
+/**
+ * Retrieves the base (default) logger instance.
+ *
+ * This base logger controls the default logging configuration and is shared
+ * across all loggers created with `createLogger`. Adjusting settings on this
+ * base logger affects all loggers derived from it unless explicitly overridden.
+ *
+ */
+export function createBaseLogger() {
+    return Logger;
+}
+/**
+ * Creates and configures a new named logger based on the base logger.
+ *
+ * Named loggers allow specific modules or areas of your application to have
+ * their own logging levels and behaviors. These loggers inherit configuration
+ * from the base logger by default but can override settings independently.
+ */
+export function createLogger(name, options = {}) {
+    const logger = Logger.get(name);
+    if (options.logLevel) {
+        logger.setLevel(options.logLevel);
+    }
+    return logger;
+}

package/package.json

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