filepizza-client 2.0.1 → 2.1.0

package/README.md

@@ -28,8 +28,10 @@ import { FilePizzaUploader } from 'filepizza-client';
 
 const uploader = new FilePizzaUploader({
   filePizzaServerUrl: 'https://your-filepizza-server.com',
-  // You can optionally specify an additional shared slug where multiple uploaders can connect and share files
-  sharedSlug: 'filepizza-demo'
+
+  // You can optionally specify an additional shared slug
+  // where multiple uploaders can connect and share files
+  sharedSlug: 'filepizza-demo',
 });
 
 await uploader.initialize();
@@ -39,8 +41,13 @@ uploader.on('progress', (progressInfo) => {
 });
 
 uploader.setFiles(fileList); // From an input element
+
 const links = uploader.getShareableLinks();
-console.log(`Shareable links: ${links.join(', ')}`);
+
+if (links) {
+  console.log(`Long link: ${links.long}`);
+  console.log(`Short link: ${links.short}`);
+}
 ```
 
 Set up a FilePizza client instance and use it to download files:
@@ -49,7 +56,7 @@ Set up a FilePizza client instance and use it to download files:
 import { FilePizzaDownloader } from 'filepizza-client';
 
 const downloader = new FilePizzaDownloader({
-  filePizzaServerUrl: 'https://your-filepizza-server.com'
+  filePizzaServerUrl: 'https://your-filepizza-server.com',
 });
 
 await downloader.initialize();
@@ -62,6 +69,45 @@ await downloader.connect(filePizzaUrl);
 await downloader.startDownload();
 ```
 
+By default, the client:
+
+- Fetches ICE server configuration from the FilePizza server
+- Attempts to discover a PeerJS signaling server from:
+  ```
+  /api/peerjs-servers
+  ```
+- Falls back to PeerJS defaults if no signaling server is configured
+
+You can also explicitly override the PeerJS signaling server configuration.
+
+The uploader and downloader must use the same PeerJS signaling server in order to connect:
+
+```javascript
+import {
+  FilePizzaUploader,
+  FilePizzaDownloader,
+} from 'filepizza-client';
+
+const peerJSSignalingServer = {
+  host: 'peerjs.example.com',
+  port: 443,
+  path: '/',
+  secure: true,
+};
+
+const uploader = new FilePizzaUploader({
+  filePizzaServerUrl: 'https://your-filepizza-server.com',
+  peerJSSignalingServer,
+});
+
+const downloader = new FilePizzaDownloader({
+  filePizzaServerUrl: 'https://your-filepizza-server.com',
+  peerJSSignalingServer,
+});
+```
+
+If no `peerJSSignalingServer` is provided, the client will use the FilePizza server configuration (if available) or default PeerJS behavior.
+
 ## Examples
 
 ### Regular Example

package/dist/filepizza-downloader.d.ts

@@ -1,7 +1,12 @@
 import { EventEmitter } from './event-emitter';
-import { FileInfo, ProgressInfo, ConnectionStatus, CompletedFile } from './types';
+import { FileInfo, ProgressInfo, ConnectionStatus, CompletedFile, PeerJSSignalingServer } from './types';
+type DownloaderOptions = {
+    filePizzaServerUrl?: string;
+    peerJSSignalingServer?: PeerJSSignalingServer;
+    discoverPeerJSSignalingServer?: boolean;
+};
 /**
- * FilePizza Downloader - connects to FilePizza uploads
+ * FilePizza Downloader - connects to FilePizza uploads.
  */
 export declare class FilePizzaDownloader extends EventEmitter {
     private peer?;
@@ -17,143 +22,55 @@ export declare class FilePizzaDownloader extends EventEmitter {
     private isPasswordRequired;
     private isPasswordInvalid;
     private errorMessage?;
-    private iceServers?;
     private completedFiles;
-    /**
-     * Create a new FilePizza downloader
-     * @param options Configuration options
-     */
-    constructor(options?: {
-        filePizzaServerUrl?: string;
-    });
-    /**
-     * Initialize the downloader
-     */
+    private peerJSSignalingServer?;
+    private discoverPeerJSSignalingServer;
+    constructor(options?: DownloaderOptions);
     initialize(): Promise<void>;
-    /**
-     * Connect to an uploader using a FilePizza URL or slug
-     */
     connect(urlOrSlug: string): Promise<boolean>;
-    /**
-     * Reset the connection state to begin new download
-     */
     private resetConnectionState;
-    /**
-     * Submit password for protected download
-     */
     submitPassword(password: string): void;
-    /**
-     * Start downloading the files
-     */
     startDownload(): Promise<void>;
-    /**
-     * Pause the download
-     */
     pauseDownload(): void;
     /**
-     * Resume the download
+     * Kept for public API compatibility.
+     *
+     * The server frontend protocol currently supports pause/stop, not resume.
+     * A paused transfer should be restarted by creating a new connection.
      */
     resumeDownload(): void;
-    /**
-     * Cancel the download
-     */
     cancelDownload(): void;
-    /**
-     * Cleanup resources when done
-     */
     private cleanupFileStreams;
-    /**
-     * Get file information
-     */
     getFileInfo(): FileInfo[];
-    /**
-     * Get download status
-     */
     getStatus(): {
         status: ConnectionStatus;
         isPasswordRequired: boolean;
         isPasswordInvalid: boolean;
         errorMessage?: string;
     };
-    /**
-     * Get progress information
-     */
     getProgress(): ProgressInfo;
-    /**
-     * Extract slug from URL or use directly
-     */
     private extractSlug;
+    private fetchChannel;
     /**
-     * Extract uploader peer IDs from the FilePizza server when multiple uploaders are present
+     * Fallback for older FilePizza servers that do not expose /api/channel/:slug.
      */
+    private extractUploaderPeerIDsFromHtml;
     private extractUploaderPeerIDs;
-    /**
-     * Look up the uploader's peer ID from the FilePizza server
-     */
     private lookupUploaderPeerID;
-    /**
-     * Connect to a specific uploader by ID
-     */
     getAvailableUploaders(urlOrSlug: string): Promise<string[]>;
-    /**
-     * Connect to a specific uploader by ID
-     */
     connectToUploader(uploaderId: string): Promise<boolean>;
-    /**
-     * Get ICE servers from the FilePizza server
-     */
-    private getIceServers;
-    /**
-     * Connect directly to a peer
-     */
     private connectToPeer;
-    /**
-     * Handle incoming data from uploader
-     */
     private handleData;
-    /**
-     * Handle password required message
-     */
     private handlePasswordRequired;
-    /**
-     * Handle file info message
-     */
     private handleInfo;
-    /**
-     * Handle error message
-     */
     private handleError;
-    /**
-     * Handle report message (channel reported for violation)
-     */
     private handleReport;
-    /**
-     * Handle chunk message
-     */
     private handleChunk;
-    /**
-     * Initialize streams for all files
-     */
     private initializeFileStreams;
-    /**
-     * Store a completed file
-     */
     private storeCompletedFile;
-    /**
-     * Download a completed file
-     */
     downloadFile(fileName: string): Promise<void>;
-    /**
-     * Get completed files
-     */
     getCompletedFiles(): CompletedFile[];
-    /**
-     * Download all completed files
-     */
     downloadAllFiles(): Promise<void>;
-    /**
-     * Request the next file
-     */
     private requestNextFile;
     private getBrowserName;
     private getBrowserVersion;
@@ -162,3 +79,4 @@ export declare class FilePizzaDownloader extends EventEmitter {
     private getMobileVendor;
     private getMobileModel;
 }
+export {};