chore: renamed attachmentIds to onAttachmentIdsChange, to match changed signature

Author: Christiaan Landman

.changeset/heavy-dogs-work.md

@@ -2,4 +2,4 @@
 "powersync-example": minor
 ---
 
-Updated implementation of attachmentIds in PhotoAttachmentQueue to match updated abstract signature from AbstractAttachmentQueue.
+Updated/renamed implementation of `attachmentIds` to `onAttachmentIdsChange`, now implements a callback approach instead of AsyncGenerator.

.changeset/slow-years-pull.md

@@ -2,4 +2,4 @@
 "@journeyapps/powersync-attachments": major
 ---
 
-Changed abstract attachmentIds member of AbstractAttachmentQueue to use callback instead of an AsyncGenerator.
+Renamed abstract `attachmentIds` to `onAttachmentIdsChange` in `AbstractAttachmentQueue`, changed to use callback signature instead of an AsyncGenerator.

demos/react-native-supabase-todolist/library/powersync/PhotoAttachmentQueue.ts

@@ -16,9 +16,9 @@ export class PhotoAttachmentQueue extends AbstractAttachmentQueue {
     await super.init();
   }
 
-  attachmentIds(onResult: (ids: string[]) => void): void {
+  onAttachmentIdsChange(onUpdate: (ids: string[]) => void): void {
     this.powersync.watch(`SELECT photo_id as id FROM ${TODO_TABLE} WHERE photo_id IS NOT NULL`, [], {
-      onResult: result => onResult(result.rows?._array.map((r) => r.id) ?? [])
+      onResult: result => onUpdate(result.rows?._array.map((r) => r.id) ?? [])
     });
   }
 

packages/powersync-attachments/README.md

@@ -63,21 +63,18 @@ import { AbstractAttachmentQueue } from '@journeyapps/powersync-attachments';
 export class AttachmentQueue extends AbstractAttachmentQueue {}
 ```
 
-2. Implement `attachmentIds`, an `AsyncIterator` method to return an array of `string` values of IDs that relate to attachments in your app. We recommend using `PowerSync`'s `watch` query to return the all IDs of attachments in your app.
+2. Implement `onAttachmentIdsChange`, which takes in a callback to handle an array of `string` values of IDs that relate to attachments in your app. We recommend using `PowerSync`'s `watch` query to return the all IDs of attachments in your app.
 
    In this example, we query all photos that have been captured as part of an inspection and map these to an array of `string` values.
 
 ```javascript
 import { AbstractAttachmentQueue } from '@journeyapps/powersync-attachments';
 
 export class AttachmentQueue extends AbstractAttachmentQueue {
-  async *attachmentIds() {
-    for await (const result of this.powersync.watch(
-      `SELECT photo_id as id FROM checklists WHERE photo_id IS NOT NULL`,
-      []
-    )) {
-      yield result.rows?._array.map((r) => r.id) ?? [];
-    }
+  onAttachmentIdsChange(onUpdate) {
+    this.powersync.watch('SELECT photo_id as id FROM checklists WHERE photo_id IS NOT NULL', [], {
+      onResult: result => onUpdate(result.rows?._array.map((r) => r.id) ?? [])
+   });
   }
 }
 ```

packages/powersync-attachments/src/AbstractAttachmentQueue.ts

@@ -62,14 +62,14 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
    *
    * @example
    * ```typescript
-   * attachmentIds(onResult: (ids: string[]) => void): void {
+   * onAttachmentIdsChange(onUpdate) {
    *    this.powersync.watch('SELECT photo_id as id FROM todos WHERE photo_id IS NOT NULL', [], { 
-   *        onResult: result => onResult(result.rows?._array.map((r) => r.id) ?? []) 
+   *        onResult: result => onUpdate(result.rows?._array.map((r) => r.id) ?? []) 
    *    });
    * }
-   * 
+   * ```
    */
-  abstract attachmentIds(onResult: (ids: string[]) => void): void;
+  abstract onAttachmentIdsChange(onUpdate: (ids: string[]) => void): void;
 
 
   /**
@@ -111,7 +111,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
   }
 
   async watchAttachmentIds() {
-    this.attachmentIds(async (ids) => {
+    this.onAttachmentIdsChange(async (ids) => {
       const _ids = `${ids.map((id) => `'${id}'`).join(',')}`;
       console.debug(`Queuing for sync, attachment IDs: [${_ids}]`);