@dropgate/core

Overview

@dropgate/core is the universal client library for Dropgate. It provides all the core functionality for:

- Uploading files to Dropgate servers (with optional E2EE)
- Downloading files from Dropgate servers
- Direct peer-to-peer file transfers (P2P)
- Server capability detection and version checking
- Utility functions for lifetime conversions, base64 encoding, and more

This package is headless and environment-agnostic — it contains no DOM manipulation, no browser-specific APIs, and no Node.js-specific code. All environment-specific concerns (loading PeerJS, handling file streams, etc.) are handled by the consumer.

Installation

``bash
npm install @dropgate/core
`

Builds

The package ships with multiple build targets:

| Format | File | Use Case |
| --- | --- | --- |
| ESM | dist/index.js | Modern bundlers, Node.js 18+ |
| CJS | dist/index.cjs | Legacy Node.js, CommonJS |
| Browser IIFE | dist/index.browser.js |

`

Or as an ES module:

`html

`

P2P Consumer Responsibilities

The P2P methods are headless. The consumer is responsible for:

1. Loading PeerJS: Provide the Peer constructor to p2pSend/p2pReceive
2. File Writing: Handle received chunks via onData callback (e.g., using streamSaver)
3. UI Updates: React to callbacks (onProgress, onStatus, etc.)

This design allows the library to work in any environment (browser, Electron, Node.js with WebRTC).

$3

The P2P implementation is designed for unlimited file sizes with constant memory usage:

- Stream-through architecture: Chunks flow immediately to onData, no buffering
- Flow control: Sender pauses when receiver's write queue backs up
- WebRTC reliability: SCTP provides reliable, ordered, checksum-verified delivery

> Note: For large files, always use the onData` callback approach rather than buffering in memory.

License

Licensed under the Apache-2.0 License.
See the LICENSE file for details.

Acknowledgements

* Logo designed by TheFuturisticIdiot
* Built with TypeScript
* Inspired by the growing need for privacy-respecting, open file transfer tools

Contact Us

* Need help or want to chat? Join our Discord Server
* Found a bug? Open an issue
* Have a suggestion? Submit a feature request