mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-17 16:50:22 +00:00
AI disclaimer : AI used ## Changes - **jsdom 26 → 29** across all packages' devDependencies — **except`@uppy/aws-s3`** (left at 26; that plugin is being rewritten and its deps are handled on the rewrite branch). - **`@uppy/xhr-upload` unit tests migrated from nock to MSW**, and `nock` dropped from its devDependencies. ## Why the test migration was needed jsdom **28** overhauled resource loading so `XMLHttpRequest` now goes through jsdom's internal (undici-based) fetch instead of Node's `http` module ([jsdom 28 release notes](https://github.com/jsdom/jsdom/releases/tag/28.0.0)). nock intercepts at the Node `http` / `http.ClientRequest` layer ([nock README](https://github.com/nock/nock)), so it can no longer see uppy's upload requests — the mocked responses never arrive and the tests time out. (This is the long-standing nock + jsdom XHR incompatibility: [nock#518](https://github.com/nock/nock/issues/518).) --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .npmignore | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| turbo.json | ||
@uppy/companion-client
Client library for communication with Companion. Intended for use in Uppy plugins.
Uppy is being developed by the folks at Transloadit, a versatile file encoding service.
Example
import Uppy from '@uppy/core'
import { Provider, RequestClient, Socket } from '@uppy/companion-client'
const uppy = new Uppy()
const client = new RequestClient(uppy, {
companionUrl: 'https://uppy.mywebsite.com/',
})
client.get('/drive/list').then(() => {})
const provider = new Provider(uppy, {
companionUrl: 'https://uppy.mywebsite.com/',
provider: providerPluginInstance,
})
provider.checkAuth().then(() => {})
const socket = new Socket({ target: 'wss://uppy.mywebsite.com/' })
socket.on('progress', () => {})
Installation
Unless you are writing a custom provider plugin, you do not need to install this.
$ npm install @uppy/companion-client
Documentation
Documentation for this plugin can be found on the Uppy website.