@dropgate/core 2.1.0 → 2.2.0-beta.2

package/dist/index.d.cts

@@ -154,6 +154,18 @@ interface UploadResult {
     /** Base64-encoded encryption key (only present if encrypted). */
     keyB64?: string;
 }
+/**
+ * Upload session with cancellation support.
+ * Returned by uploadFile() to allow cancelling uploads in progress.
+ */
+interface UploadSession {
+    /** Promise that resolves with upload result when complete. */
+    result: Promise<UploadResult>;
+    /** Cancel the upload. */
+    cancel: (reason?: string) => void;
+    /** Get current upload status. */
+    getStatus: () => 'initializing' | 'uploading' | 'completing' | 'completed' | 'cancelled' | 'error';
+}
 /**
  * Result of a client/server compatibility check.
  */
@@ -266,12 +278,14 @@ interface UploadOptions extends ServerTarget {
     file: FileSource;
     /** File lifetime in milliseconds (0 = server default). */
     lifetimeMs: number;
-    /** Whether to encrypt the file with E2EE. */
-    encrypt: boolean;
+    /** Whether to encrypt the file with E2EE. Defaults to true if server supports E2EE. */
+    encrypt?: boolean;
     /** Override the filename sent to the server. */
     filenameOverride?: string;
     /** Callback for progress updates. */
     onProgress?: (evt: UploadProgressEvent) => void;
+    /** Callback when upload is cancelled by user. */
+    onCancel?: () => void;
     /** AbortSignal to cancel the upload. */
     signal?: AbortSignal;
     /** Timeout settings for various upload phases. */
@@ -314,8 +328,8 @@ interface ValidateUploadOptions {
     file: FileSource;
     /** Requested file lifetime in milliseconds. */
     lifetimeMs: number;
-    /** Whether encryption will be used. */
-    encrypt: boolean;
+    /** Whether encryption will be used. Defaults to true if server supports E2EE. */
+    encrypt?: boolean;
     /** Server info containing capabilities to validate against. */
     serverInfo: ServerInfo;
 }
@@ -567,7 +581,7 @@ declare class DropgateClient {
      * @throws {DropgateProtocolError} If the server returns an error.
      * @throws {DropgateAbortError} If the upload is cancelled.
      */
-    uploadFile(opts: UploadOptions): Promise<UploadResult>;
+    uploadFile(opts: UploadOptions): Promise<UploadSession>;
     /**
      * Download a file from the server with optional decryption.
      *
@@ -608,11 +622,11 @@ declare function getDefaultFetch(): FetchFn | undefined;
  * Finite state machine states for P2P send sessions.
  * Prevents race conditions and ensures callbacks fire in correct order.
  */
-type P2PSendState = 'initializing' | 'listening' | 'negotiating' | 'transferring' | 'finishing' | 'completed' | 'closed';
+type P2PSendState = 'initializing' | 'listening' | 'negotiating' | 'transferring' | 'finishing' | 'completed' | 'cancelled' | 'closed';
 /**
  * Finite state machine states for P2P receive sessions.
  */
-type P2PReceiveState = 'initializing' | 'connecting' | 'negotiating' | 'transferring' | 'completed' | 'closed';
+type P2PReceiveState = 'initializing' | 'connecting' | 'negotiating' | 'transferring' | 'completed' | 'cancelled' | 'closed';
 /**
  * PeerJS Peer constructor interface.
  * Consumer must provide this constructor to P2P functions.
@@ -722,6 +736,13 @@ interface P2PReceiveCompleteEvent {
     received: number;
     total: number;
 }
+/** Cancellation event for P2P operations. */
+interface P2PCancellationEvent {
+    /** Who cancelled the transfer ('sender' or 'receiver'). */
+    cancelledBy: 'sender' | 'receiver';
+    /** Optional cancellation message. */
+    message?: string;
+}
 /**
  * Options for starting a P2P send session.
  */
@@ -760,6 +781,8 @@ interface P2PSendOptions extends P2PServerConfig {
     onError?: (err: Error) => void;
     /** Callback when receiver disconnects. */
     onDisconnect?: () => void;
+    /** Callback when transfer is cancelled by either party. */
+    onCancel?: (evt: P2PCancellationEvent) => void;
 }
 /**
  * Return value from startP2PSend containing session control.
@@ -820,6 +843,8 @@ interface P2PReceiveOptions extends P2PServerConfig {
     onError?: (err: Error) => void;
     /** Callback when sender disconnects. */
     onDisconnect?: () => void;
+    /** Callback when transfer is cancelled by either party. */
+    onCancel?: (evt: P2PCancellationEvent) => void;
 }
 /**
  * Return value from startP2PReceive containing session control.

package/dist/index.d.ts

@@ -154,6 +154,18 @@ interface UploadResult {
     /** Base64-encoded encryption key (only present if encrypted). */
     keyB64?: string;
 }
+/**
+ * Upload session with cancellation support.
+ * Returned by uploadFile() to allow cancelling uploads in progress.
+ */
+interface UploadSession {
+    /** Promise that resolves with upload result when complete. */
+    result: Promise<UploadResult>;
+    /** Cancel the upload. */
+    cancel: (reason?: string) => void;
+    /** Get current upload status. */
+    getStatus: () => 'initializing' | 'uploading' | 'completing' | 'completed' | 'cancelled' | 'error';
+}
 /**
  * Result of a client/server compatibility check.
  */
@@ -266,12 +278,14 @@ interface UploadOptions extends ServerTarget {
     file: FileSource;
     /** File lifetime in milliseconds (0 = server default). */
     lifetimeMs: number;
-    /** Whether to encrypt the file with E2EE. */
-    encrypt: boolean;
+    /** Whether to encrypt the file with E2EE. Defaults to true if server supports E2EE. */
+    encrypt?: boolean;
     /** Override the filename sent to the server. */
     filenameOverride?: string;
     /** Callback for progress updates. */
     onProgress?: (evt: UploadProgressEvent) => void;
+    /** Callback when upload is cancelled by user. */
+    onCancel?: () => void;
     /** AbortSignal to cancel the upload. */
     signal?: AbortSignal;
     /** Timeout settings for various upload phases. */
@@ -314,8 +328,8 @@ interface ValidateUploadOptions {
     file: FileSource;
     /** Requested file lifetime in milliseconds. */
     lifetimeMs: number;
-    /** Whether encryption will be used. */
-    encrypt: boolean;
+    /** Whether encryption will be used. Defaults to true if server supports E2EE. */
+    encrypt?: boolean;
     /** Server info containing capabilities to validate against. */
     serverInfo: ServerInfo;
 }
@@ -567,7 +581,7 @@ declare class DropgateClient {
      * @throws {DropgateProtocolError} If the server returns an error.
      * @throws {DropgateAbortError} If the upload is cancelled.
      */
-    uploadFile(opts: UploadOptions): Promise<UploadResult>;
+    uploadFile(opts: UploadOptions): Promise<UploadSession>;
     /**
      * Download a file from the server with optional decryption.
      *
@@ -608,11 +622,11 @@ declare function getDefaultFetch(): FetchFn | undefined;
  * Finite state machine states for P2P send sessions.
  * Prevents race conditions and ensures callbacks fire in correct order.
  */
-type P2PSendState = 'initializing' | 'listening' | 'negotiating' | 'transferring' | 'finishing' | 'completed' | 'closed';
+type P2PSendState = 'initializing' | 'listening' | 'negotiating' | 'transferring' | 'finishing' | 'completed' | 'cancelled' | 'closed';
 /**
  * Finite state machine states for P2P receive sessions.
  */
-type P2PReceiveState = 'initializing' | 'connecting' | 'negotiating' | 'transferring' | 'completed' | 'closed';
+type P2PReceiveState = 'initializing' | 'connecting' | 'negotiating' | 'transferring' | 'completed' | 'cancelled' | 'closed';
 /**
  * PeerJS Peer constructor interface.
  * Consumer must provide this constructor to P2P functions.
@@ -722,6 +736,13 @@ interface P2PReceiveCompleteEvent {
     received: number;
     total: number;
 }
+/** Cancellation event for P2P operations. */
+interface P2PCancellationEvent {
+    /** Who cancelled the transfer ('sender' or 'receiver'). */
+    cancelledBy: 'sender' | 'receiver';
+    /** Optional cancellation message. */
+    message?: string;
+}
 /**
  * Options for starting a P2P send session.
  */
@@ -760,6 +781,8 @@ interface P2PSendOptions extends P2PServerConfig {
     onError?: (err: Error) => void;
     /** Callback when receiver disconnects. */
     onDisconnect?: () => void;
+    /** Callback when transfer is cancelled by either party. */
+    onCancel?: (evt: P2PCancellationEvent) => void;
 }
 /**
  * Return value from startP2PSend containing session control.
@@ -820,6 +843,8 @@ interface P2PReceiveOptions extends P2PServerConfig {
     onError?: (err: Error) => void;
     /** Callback when sender disconnects. */
     onDisconnect?: () => void;
+    /** Callback when transfer is cancelled by either party. */
+    onCancel?: (evt: P2PCancellationEvent) => void;
 }
 /**
  * Return value from startP2PReceive containing session control.