@backblaze-labs/b2-sdk 0.1.0 → 0.2.0

package/dist/sync/actions/index.d.cts

@@ -12,8 +12,9 @@ export interface SyncAction {
     /**
      * Executes the action (or no-ops if dryRun is true) and returns a corresponding event.
      * @param dryRun - When true, skip the actual I/O but still return the event.
+     * @param signal - Optional abort signal for canceling in-flight I/O.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Uploads a local file to B2. */
 export declare class UploadAction implements SyncAction {
@@ -29,14 +30,15 @@ export declare class UploadAction implements SyncAction {
      * @param size - File size in bytes.
      * @param doUpload - Callback that performs the actual upload.
      */
-    constructor(relativePath: string, absolutePath: string, size: number, doUpload: (absolutePath: string, relativePath: string) => Promise<void>);
+    constructor(relativePath: string, absolutePath: string, size: number, doUpload: (absolutePath: string, relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Uploads the file (unless dryRun) and returns an 'upload-done' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the upload.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Downloads a B2 file to the local filesystem. */
 export declare class DownloadAction implements SyncAction {
@@ -50,14 +52,15 @@ export declare class DownloadAction implements SyncAction {
      * @param size - File size in bytes.
      * @param doDownload - Callback that performs the actual download.
      */
-    constructor(relativePath: string, size: number, doDownload: (relativePath: string) => Promise<void>);
+    constructor(relativePath: string, size: number, doDownload: (relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Downloads the file (unless dryRun) and returns a 'download-done' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the download.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Server-side copies a B2 file to a new key within the same or different bucket. */
 export declare class CopyAction implements SyncAction {
@@ -71,14 +74,15 @@ export declare class CopyAction implements SyncAction {
      * @param size - File size in bytes.
      * @param doCopy - Callback that performs the server-side copy.
      */
-    constructor(relativePath: string, size: number, doCopy: (relativePath: string) => Promise<void>);
+    constructor(relativePath: string, size: number, doCopy: (relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Copies the file (unless dryRun) and returns a 'copy-done' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the copy.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Hides a file in B2 by creating a hide marker (soft delete). */
 export declare class HideAction implements SyncAction {
@@ -91,14 +95,15 @@ export declare class HideAction implements SyncAction {
      * @param relativePath - Path relative to the sync root.
      * @param doHide - Callback that creates the hide marker.
      */
-    constructor(relativePath: string, doHide: (relativePath: string) => Promise<void>);
+    constructor(relativePath: string, doHide: (relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Hides the file (unless dryRun) and returns a 'hide' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the hide request.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Permanently deletes a specific file version from B2. */
 export declare class DeleteRemoteAction implements SyncAction {
@@ -113,14 +118,15 @@ export declare class DeleteRemoteAction implements SyncAction {
      * @param fileId - The B2 file version ID to delete.
      * @param doDelete - Callback that performs the deletion.
      */
-    constructor(relativePath: string, fileId: string, doDelete: (fileId: string, fileName: string) => Promise<void>);
+    constructor(relativePath: string, fileId: string, doDelete: (fileId: string, fileName: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Deletes the remote file version (unless dryRun) and returns a 'delete-remote' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the delete request.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Deletes a file from the local filesystem. */
 export declare class DeleteLocalAction implements SyncAction {
@@ -135,14 +141,15 @@ export declare class DeleteLocalAction implements SyncAction {
      * @param absolutePath - Absolute local filesystem path.
      * @param doDelete - Callback that performs the deletion.
      */
-    constructor(relativePath: string, absolutePath: string, doDelete: (absolutePath: string) => Promise<void>);
+    constructor(relativePath: string, absolutePath: string, doDelete: (absolutePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Deletes the local file (unless dryRun) and returns a 'delete-local' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal checked before deleting.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Represents a no-op action for files that do not need syncing. */
 export declare class SkipAction implements SyncAction {
@@ -159,9 +166,10 @@ export declare class SkipAction implements SyncAction {
     /**
      * Returns a 'skip' event with the reason message. No I/O is performed.
      * @param _dryRun - Whether to simulate the action (unused for no-op).
+     * @param _signal - Unused abort signal accepted for the shared action interface.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(_dryRun: boolean): Promise<SyncEvent>;
+    execute(_dryRun: boolean, _signal?: AbortSignal): Promise<SyncEvent>;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/sync/actions/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sync/actions/index.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,UAAU,GACV,MAAM,GACN,MAAM,GACN,eAAe,GACf,cAAc,GACd,MAAM,CAAA;AAEV,qEAAqE;AACrE,MAAM,WAAW,UAAU;IACzB,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC7C;AAED,kCAAkC;AAClC,qBAAa,YAAa,YAAW,UAAU;IAW3C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAb3B,QAAQ,CAAC,IAAI,EAAG,QAAQ,CAAS;IAEjC;;;;;;OAMG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAG1F;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,mDAAmD;AACnD,qBAAa,cAAe,YAAW,UAAU;IAU7C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,QAAQ,CAAC,IAAI,EAAG,UAAU,CAAS;IAEnC;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,UAAU,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGtE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,qFAAqF;AACrF,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAXzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAE/B;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGlE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,kEAAkE;AAClE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGlE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,2DAA2D;AAC3D,qBAAa,kBAAmB,YAAW,UAAU;IAWjD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,eAAe,CAAS;IACxC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACN,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGhF;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,gDAAgD;AAChD,qBAAa,iBAAkB,YAAW,UAAU;IAWhD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,cAAc,CAAS;IACvC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGpE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,oEAAoE;AACpE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM;IAGzB;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAGpD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sync/actions/index.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,UAAU,GACV,MAAM,GACN,MAAM,GACN,eAAe,GACf,cAAc,GACd,MAAM,CAAA;AAEV,qEAAqE;AACrE,MAAM,WAAW,UAAU;IACzB,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CACnE;AAED,kCAAkC;AAClC,qBAAa,YAAa,YAAW,UAAU;IAW3C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAb3B,QAAQ,CAAC,IAAI,EAAG,QAAQ,CAAS;IAEjC;;;;;;OAMG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,QAAQ,EAAE,CACzB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,WAAW,KACjB,OAAO,CAAC,IAAI,CAAC;IAGpB;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,mDAAmD;AACnD,qBAAa,cAAe,YAAW,UAAU;IAU7C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,QAAQ,CAAC,IAAI,EAAG,UAAU,CAAS;IAEnC;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,UAAU,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAG5F;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,qFAAqF;AACrF,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAXzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAE/B;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAGxF;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,kEAAkE;AAClE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAGxF;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,2DAA2D;AAC3D,qBAAa,kBAAmB,YAAW,UAAU;IAWjD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,eAAe,CAAS;IACxC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACN,QAAQ,EAAE,CACzB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,WAAW,KACjB,OAAO,CAAC,IAAI,CAAC;IAGpB;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,gDAAgD;AAChD,qBAAa,iBAAkB,YAAW,UAAU;IAWhD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,cAAc,CAAS;IACvC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAG1F;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,oEAAoE;AACpE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM;IAGzB;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAG3E"}

package/dist/sync/actions/index.d.ts

@@ -12,8 +12,9 @@ export interface SyncAction {
     /**
      * Executes the action (or no-ops if dryRun is true) and returns a corresponding event.
      * @param dryRun - When true, skip the actual I/O but still return the event.
+     * @param signal - Optional abort signal for canceling in-flight I/O.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Uploads a local file to B2. */
 export declare class UploadAction implements SyncAction {
@@ -29,14 +30,15 @@ export declare class UploadAction implements SyncAction {
      * @param size - File size in bytes.
      * @param doUpload - Callback that performs the actual upload.
      */
-    constructor(relativePath: string, absolutePath: string, size: number, doUpload: (absolutePath: string, relativePath: string) => Promise<void>);
+    constructor(relativePath: string, absolutePath: string, size: number, doUpload: (absolutePath: string, relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Uploads the file (unless dryRun) and returns an 'upload-done' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the upload.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Downloads a B2 file to the local filesystem. */
 export declare class DownloadAction implements SyncAction {
@@ -50,14 +52,15 @@ export declare class DownloadAction implements SyncAction {
      * @param size - File size in bytes.
      * @param doDownload - Callback that performs the actual download.
      */
-    constructor(relativePath: string, size: number, doDownload: (relativePath: string) => Promise<void>);
+    constructor(relativePath: string, size: number, doDownload: (relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Downloads the file (unless dryRun) and returns a 'download-done' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the download.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Server-side copies a B2 file to a new key within the same or different bucket. */
 export declare class CopyAction implements SyncAction {
@@ -71,14 +74,15 @@ export declare class CopyAction implements SyncAction {
      * @param size - File size in bytes.
      * @param doCopy - Callback that performs the server-side copy.
      */
-    constructor(relativePath: string, size: number, doCopy: (relativePath: string) => Promise<void>);
+    constructor(relativePath: string, size: number, doCopy: (relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Copies the file (unless dryRun) and returns a 'copy-done' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the copy.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Hides a file in B2 by creating a hide marker (soft delete). */
 export declare class HideAction implements SyncAction {
@@ -91,14 +95,15 @@ export declare class HideAction implements SyncAction {
      * @param relativePath - Path relative to the sync root.
      * @param doHide - Callback that creates the hide marker.
      */
-    constructor(relativePath: string, doHide: (relativePath: string) => Promise<void>);
+    constructor(relativePath: string, doHide: (relativePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Hides the file (unless dryRun) and returns a 'hide' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the hide request.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Permanently deletes a specific file version from B2. */
 export declare class DeleteRemoteAction implements SyncAction {
@@ -113,14 +118,15 @@ export declare class DeleteRemoteAction implements SyncAction {
      * @param fileId - The B2 file version ID to delete.
      * @param doDelete - Callback that performs the deletion.
      */
-    constructor(relativePath: string, fileId: string, doDelete: (fileId: string, fileName: string) => Promise<void>);
+    constructor(relativePath: string, fileId: string, doDelete: (fileId: string, fileName: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Deletes the remote file version (unless dryRun) and returns a 'delete-remote' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal for canceling the delete request.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Deletes a file from the local filesystem. */
 export declare class DeleteLocalAction implements SyncAction {
@@ -135,14 +141,15 @@ export declare class DeleteLocalAction implements SyncAction {
      * @param absolutePath - Absolute local filesystem path.
      * @param doDelete - Callback that performs the deletion.
      */
-    constructor(relativePath: string, absolutePath: string, doDelete: (absolutePath: string) => Promise<void>);
+    constructor(relativePath: string, absolutePath: string, doDelete: (absolutePath: string, signal?: AbortSignal) => Promise<void>);
     /**
      * Deletes the local file (unless dryRun) and returns a 'delete-local' event.
      * @param dryRun - Whether to simulate the action without making changes.
+     * @param signal - Optional abort signal checked before deleting.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(dryRun: boolean): Promise<SyncEvent>;
+    execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>;
 }
 /** Represents a no-op action for files that do not need syncing. */
 export declare class SkipAction implements SyncAction {
@@ -159,9 +166,10 @@ export declare class SkipAction implements SyncAction {
     /**
      * Returns a 'skip' event with the reason message. No I/O is performed.
      * @param _dryRun - Whether to simulate the action (unused for no-op).
+     * @param _signal - Unused abort signal accepted for the shared action interface.
      *
-     * @returns An async generator yielding sync progress events.
+     * @returns A promise resolving to the sync event produced by the action.
      */
-    execute(_dryRun: boolean): Promise<SyncEvent>;
+    execute(_dryRun: boolean, _signal?: AbortSignal): Promise<SyncEvent>;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/sync/actions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sync/actions/index.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,UAAU,GACV,MAAM,GACN,MAAM,GACN,eAAe,GACf,cAAc,GACd,MAAM,CAAA;AAEV,qEAAqE;AACrE,MAAM,WAAW,UAAU;IACzB,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CAC7C;AAED,kCAAkC;AAClC,qBAAa,YAAa,YAAW,UAAU;IAW3C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAb3B,QAAQ,CAAC,IAAI,EAAG,QAAQ,CAAS;IAEjC;;;;;;OAMG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAG1F;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,mDAAmD;AACnD,qBAAa,cAAe,YAAW,UAAU;IAU7C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,QAAQ,CAAC,IAAI,EAAG,UAAU,CAAS;IAEnC;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,UAAU,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGtE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,qFAAqF;AACrF,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAXzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAE/B;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGlE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,kEAAkE;AAClE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGlE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,2DAA2D;AAC3D,qBAAa,kBAAmB,YAAW,UAAU;IAWjD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,eAAe,CAAS;IACxC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACN,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGhF;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,gDAAgD;AAChD,qBAAa,iBAAkB,YAAW,UAAU;IAWhD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,cAAc,CAAS;IACvC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IAGpE;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAMnD;AAED,oEAAoE;AACpE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM;IAGzB;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAGpD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sync/actions/index.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,UAAU,GACV,MAAM,GACN,MAAM,GACN,eAAe,GACf,cAAc,GACd,MAAM,CAAA;AAEV,qEAAqE;AACrE,MAAM,WAAW,UAAU;IACzB,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;CACnE;AAED,kCAAkC;AAClC,qBAAa,YAAa,YAAW,UAAU;IAW3C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAb3B,QAAQ,CAAC,IAAI,EAAG,QAAQ,CAAS;IAEjC;;;;;;OAMG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,QAAQ,EAAE,CACzB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,WAAW,KACjB,OAAO,CAAC,IAAI,CAAC;IAGpB;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,mDAAmD;AACnD,qBAAa,cAAe,YAAW,UAAU;IAU7C,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,QAAQ,CAAC,IAAI,EAAG,UAAU,CAAS;IAEnC;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,UAAU,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAG5F;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,qFAAqF;AACrF,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAXzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAE/B;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACJ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAGxF;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,kEAAkE;AAClE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAGxF;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,2DAA2D;AAC3D,qBAAa,kBAAmB,YAAW,UAAU;IAWjD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,eAAe,CAAS;IACxC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACN,QAAQ,EAAE,CACzB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,WAAW,KACjB,OAAO,CAAC,IAAI,CAAC;IAGpB;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,gDAAgD;AAChD,qBAAa,iBAAkB,YAAW,UAAU;IAWhD,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAZ3B,QAAQ,CAAC,IAAI,EAAG,cAAc,CAAS;IACvC,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;;OAKG;gBAEQ,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC;IAG1F;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAMzE;AAED,oEAAoE;AACpE,qBAAa,UAAW,YAAW,UAAU;IAUzC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAVzB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAS;IAC/B,QAAQ,CAAC,IAAI,KAAI;IAEjB;;;;OAIG;gBAEQ,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM;IAGzB;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC;CAG3E"}