import {
  newXFTPAgent, closeXFTPAgent,
  parseXFTPServer,
  encryptFileForUpload, uploadFile, downloadFile, deleteFile,
  decodeDescriptionURI, encodeDescriptionURI,
  XFTPRetriableError, XFTPPermanentError, isRetriable,
} from "xftp-web"

// Create agent (manages connections)
const agent = newXFTPAgent()

// Upload
const server = parseXFTPServer("xftp://...")
const encrypted = encryptFileForUpload(fileBytes, "photo.jpg")
const {rcvDescription, sndDescription, uri} = await uploadFile(agent, server, encrypted, {
  onProgress: (uploaded, total) => console.log(`${uploaded}/${total}`),
})

// Download (from URI or FileDescription)
const fd = decodeDescriptionURI(uri)
const {header, content} = await downloadFile(agent, fd)

// Delete (using sender description)
await deleteFile(agent, sndDescription)

// Cleanup
closeXFTPAgent(agent)

Error handling

try {
  await uploadFile(agent, server, encrypted)
} catch (e) {
  if (e instanceof XFTPRetriableError) {
    // Network/timeout/session errors — safe to retry
  } else if (e instanceof XFTPPermanentError) {
    // AUTH, NO_FILE, BLOCKED, etc. — do not retry
  }
  // or use: isRetriable(e)
}

Development

Prerequisites

Haskell toolchain with cabal (to build xftp-server)
Node.js 20+

Setup

# Build the XFTP server binary (from repo root)
cabal build xftp-server

# Install JS dependencies
cd xftp-web
npm install

Running tests

npm run test

The pretest script automatically installs Chromium and sets up the libsodium symlink. The browser test starts an xftp-server instance on port 7000 via globalSetup.

If Chromium fails to launch due to missing system libraries:

# Requires root
npx playwright install-deps chromium

Build

npm run build

Output goes to dist/.

License

AGPL-3.0-only