More code commenting

Author: benitav

packages/powersync-sdk-common/src/client/AbstractPowerSyncDatabase.ts

@@ -91,9 +91,15 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
    */
   protected static transactionMutex: Mutex = new Mutex();
 
+  /**
+   * Returns true if the connection is closed.
+   */
   closed: boolean;
   ready: boolean;
 
+  /**
+   * Current connection status.
+   */
   currentStatus?: SyncStatus;
   syncStreamImplementation?: AbstractStreamingSyncImplementation;
   sdkVersion: string;
@@ -202,7 +208,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
   }
 
   /**
-   * Queues a CRUD upload when internal CRUD tables have been updated
+   * Queues a CRUD upload when internal CRUD tables have been updated.
    */
   protected async watchCrudUploads() {
     for await (const event of this.onChange({
@@ -223,7 +229,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
   }
 
   /**
-   * Connects to stream of events from PowerSync instance
+   * Connects to stream of events from the PowerSync instance.
    */
   async connect(connector: PowerSyncBackendConnector) {
     // close connection if one is open
@@ -293,7 +299,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     });
   }
 
-  /*
+  /** 
    * Close the database, releasing resources.
    *
    * Also disconnects any active connection.
@@ -441,7 +447,8 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
   }
 
   /**
-   * Execute a statement and optionally return results.
+   * Execute a write (INSERT/UPDATE/DELETE) query
+   * and optionally return results.
    */
   async execute(sql: string, parameters?: any[]) {
     await this.waitForReady();
@@ -624,6 +631,9 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     });
   }
 
+  /**
+   * @ignore 
+   */
   private async executeReadOnly(sql: string, params: any[]) {
     await this.waitForReady();
     return this.database.readLock((tx) => tx.execute(sql, params));

packages/powersync-sdk-common/src/client/connection/PowerSyncBackendConnector.ts

@@ -2,7 +2,8 @@ import { PowerSyncCredentials } from './PowerSyncCredentials';
 import type { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase';
 
 export interface PowerSyncBackendConnector {
-  /** Get credentials for PowerSync.
+  /** Allows the PowerSync client to retrieve an authentication token from your backend 
+   * which is used to authenticate against the PowerSync service.
    *
    * This should always fetch a fresh set of credentials - don't use cached
    * values.

packages/powersync-sdk-common/src/client/sync/bucket/CrudEntry.ts

@@ -7,9 +7,15 @@ import hash from 'object-hash';
  */
 export type OpId = string;
 
+/**
+ * Type of local change.
+ */
 export enum UpdateType {
+  /** Insert or replace existing row. All non-null columns are included in the data. Generated by INSERT statements. */
   PUT = 'PUT',
+  /** Update existing row. Contains the id, and value of each changed column. Generated by UPDATE statements. */
   PATCH = 'PATCH',
+  /** Delete existing row. Contains the id. Generated by DELETE statements. */
   DELETE = 'DELETE'
 }
 

packages/powersync-sdk-common/src/client/sync/bucket/OpType.ts

@@ -7,6 +7,9 @@ export enum OpTypeEnum {
 
 export type OpTypeJSON = string;
 
+/**
+ * Used internally for sync buckets.
+ */
 export class OpType {
   static fromJSON(jsonValue: OpTypeJSON) {
     return new OpType(OpTypeEnum[jsonValue]);

packages/powersync-sdk-common/src/utils/BaseObserver.ts

@@ -15,6 +15,9 @@ export class BaseObserver<T extends BaseListener = BaseListener> implements Base
     this.listeners = {};
   }
 
+  /**
+   * Register a listener for updates on the PowerSync client.
+   */
   registerListener(listener: Partial<T>): () => void {
     const id = v4();
     this.listeners[id] = listener;