Detalhes do pacote

@brightwave/uppy-companion-client

transloadit1.7kMIT4.4.1-8

Client library for communication with Companion. Intended for use in Uppy plugins.

file uploader, uppy, uppy-plugin, companion

readme (leia-me)

@uppy/companion-client

Uppy logo: a smiling puppy above a pink upwards arrow

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

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.

License

The MIT License.

changelog (log de mudanças)

@uppy/companion-client

4.4.0

Released: 2025-01-06 Included in: Uppy v4.11.0

  • @uppy/angular,@uppy/audio,@uppy/aws-s3,@uppy/box,@uppy/companion-client,@uppy/compressor,@uppy/core,@uppy/dashboard,@uppy/drag-drop,@uppy/drop-target,@uppy/dropbox,@uppy/facebook,@uppy/file-input,@uppy/form,@uppy/golden-retriever,@uppy/google-drive-picker,@uppy/google-drive,@uppy/google-photos-picker,@uppy/google-photos,@uppy/image-editor,@uppy/informer,@uppy/instagram,@uppy/locales,@uppy/onedrive,@uppy/progress-bar,@uppy/provider-views,@uppy/react,@uppy/remote-sources,@uppy/screen-capture,@uppy/status-bar,@uppy/thumbnail-generator,@uppy/transloadit,@uppy/tus,@uppy/unsplash,@uppy/url,@uppy/vue,@uppy/webcam,@uppy/webdav,@uppy/xhr-upload,@uppy/zoom: Remove "paths" from all tsconfig's (Merlijn Vos / #5572)

4.2.0

Released: 2024-12-05 Included in: Uppy v4.8.0

  • @uppy/companion-client: Fix allowed origins (Mikael Finstad / #5536)
  • @uppy/audio,@uppy/aws-s3,@uppy/box,@uppy/companion-client,@uppy/compressor,@uppy/core,@uppy/dashboard,@uppy/drag-drop,@uppy/drop-target,@uppy/dropbox,@uppy/facebook,@uppy/file-input,@uppy/form,@uppy/golden-retriever,@uppy/google-drive,@uppy/google-photos,@uppy/image-editor,@uppy/informer,@uppy/instagram,@uppy/locales,@uppy/onedrive,@uppy/progress-bar,@uppy/provider-views,@uppy/react,@uppy/remote-sources,@uppy/screen-capture,@uppy/status-bar,@uppy/store-default,@uppy/thumbnail-generator,@uppy/transloadit,@uppy/tus,@uppy/unsplash,@uppy/url,@uppy/utils,@uppy/vue,@uppy/webcam,@uppy/xhr-upload,@uppy/zoom: cleanup tsconfig (Mikael Finstad / #5520)

4.1.1

Released: 2024-10-31 Included in: Uppy v4.6.0

  • @uppy/aws-s3,@uppy/box,@uppy/companion-client,@uppy/core,@uppy/dashboard,@uppy/drag-drop,@uppy/dropbox,@uppy/facebook,@uppy/file-input,@uppy/form,@uppy/golden-retriever,@uppy/google-drive,@uppy/google-photos,@uppy/image-editor,@uppy/informer,@uppy/instagram,@uppy/locales,@uppy/onedrive,@uppy/progress-bar,@uppy/provider-views,@uppy/react-native,@uppy/react,@uppy/redux-dev-tools,@uppy/screen-capture,@uppy/status-bar,@uppy/store-default,@uppy/store-redux,@uppy/svelte,@uppy/thumbnail-generator,@uppy/transloadit,@uppy/tus,@uppy/unsplash,@uppy/url,@uppy/utils,@uppy/vue,@uppy/webcam,@uppy/xhr-upload,@uppy/zoom: Fix links (Anthony Veaudry / #5492)

4.0.0

Released: 2024-07-10 Included in: Uppy v4.0.0

  • docs,@uppy/companion-client: don't close socket when pausing (Mikael Finstad / #4821)

4.0.0-beta.7

Released: 2024-06-04 Included in: Uppy v4.0.0-beta.10

  • @uppy/companion-client: do not allow boolean RequestOptions (Mikael Finstad / #5198)
  • @uppy/companion-client: remove deprecated options (Mikael Finstad / #5198)
  • @uppy/companion-client: make supportsRefreshToken default (Mikael Finstad / #5198)
  • @uppy/companion-client: remove optional chaining (Mikael Finstad / #5198)
  • @uppy/companion-client: remove Socket (Mikael Finstad / #5198)

4.0.0-beta.6

Released: 2024-05-14 Included in: Uppy v4.0.0-beta.7

  • @uppy/companion-client,@uppy/dropbox,@uppy/screen-capture,@uppy/unsplash,@uppy/url,@uppy/webcam: Use title consistently from locales (Merlijn Vos / #5134)

4.0.0-beta.1

Released: 2024-03-28 Included in: Uppy v4.0.0-beta.1

  • @uppy/companion-client,@uppy/provider-views,@uppy/status-bar: fix type imports (Antoine du Hamel / #5038)
  • @uppy/companion-client: Replace Provider.initPlugin with composition (Merlijn Vos / #4977)

3.8.0

Released: 2024-03-27 Included in: Uppy v3.24.0

  • @uppy/box,@uppy/companion-client,@uppy/provider-views,@uppy/status-bar: fix type imports (Antoine du Hamel / #5038)
  • @uppy/companion-client: Replace Provider.initPlugin with composition (Merlijn Vos / #4977)

3.7.4

Released: 2024-02-28 Included in: Uppy v3.23.0

  • @uppy/companion-client,@uppy/utils,@uppy/xhr-upload: improvements for #4922 (Mikael Finstad / #4960)

3.7.3

Released: 2024-02-22 Included in: Uppy v3.22.2

  • @uppy/companion-client: fix body/url on upload-success (Merlijn Vos / #4922)
  • @uppy/companion-client: remove unnecessary 'use strict' directives (Antoine du Hamel / #4943)
  • @uppy/companion-client: type changes for provider-views (Antoine du Hamel / #4938)
  • @uppy/companion-client: update types (Antoine du Hamel / #4927)

3.7.1

Released: 2024-02-19 Included in: Uppy v3.22.0

  • @uppy/aws-s3-multipart,@uppy/aws-s3,@uppy/companion-client,@uppy/tus,@uppy/xhr-upload: update uppyfile objects before emitting events (antoine du hamel / #4928)
  • @uppy/companion-client: fix tests and linter (antoine du hamel / #4890)
  • @uppy/companion-client: migrate to ts (merlijn vos / #4864)
  • @uppy/companion-client: fix typeerror (antoine du hamel)

3.7.0

Released: 2023-12-12 Included in: Uppy v3.21.0

  • @uppy/companion-client: avoid unnecessary preflight requests (Antoine du Hamel / #4462)

3.6.1

Released: 2023-11-24 Included in: Uppy v3.20.0

  • @uppy/companion-client: fix log type error (Mikael Finstad / #4766)
  • @uppy/companion-client: revert breaking change (Antoine du Hamel / #4801)

3.5.0

Released: 2023-10-20 Included in: Uppy v3.18.0

  • @uppy/companion-client: fixup! Added Companion OAuth Key type (Murderlon / #4668)
  • @uppy/companion-client: Added Companion OAuth Key type (Chris Pratt / #4668)

3.4.1

Released: 2023-09-29 Included in: Uppy v3.17.0

  • @uppy/companion-client: fix a refresh token race condition (Mikael Finstad / #4695)

3.4.0

Released: 2023-09-05 Included in: Uppy v3.15.0

  • @uppy/aws-s3-multipart,@uppy/aws-s3,@uppy/companion-client,@uppy/core,@uppy/tus,@uppy/utils,@uppy/xhr-upload: Move remote file upload logic into companion-client (Merlijn Vos / #4573)

3.3.0

Released: 2023-08-15 Included in: Uppy v3.14.0

  • @uppy/companion-client,@uppy/provider-views: make authentication optional (Dominik Schmidt / #4556)

3.1.2

Released: 2023-04-04 Included in: Uppy v3.7.0

  • @uppy/companion-client: do not open socket more than once (Artur Paikin)

3.1.1

Released: 2022-11-16 Included in: Uppy v3.3.1

  • @uppy/companion-client: treat * the same as missing header (Antoine du Hamel / #4221)

3.1.0

Released: 2022-11-10 Included in: Uppy v3.3.0

  • @uppy/companion-client: add support for AbortSignal (Antoine du Hamel / #4201)
  • @uppy/companion-client: prevent preflight race condition (Mikael Finstad / #4182)

3.0.2

Released: 2022-09-25 Included in: Uppy v3.1.0

  • @uppy/audio,@uppy/aws-s3-multipart,@uppy/aws-s3,@uppy/box,@uppy/companion-client,@uppy/companion,@uppy/compressor,@uppy/core,@uppy/dashboard,@uppy/drag-drop,@uppy/drop-target,@uppy/dropbox,@uppy/facebook,@uppy/file-input,@uppy/form,@uppy/golden-retriever,@uppy/google-drive,@uppy/image-editor,@uppy/informer,@uppy/instagram,@uppy/locales,@uppy/onedrive,@uppy/progress-bar,@uppy/provider-views,@uppy/react,@uppy/redux-dev-tools,@uppy/remote-sources,@uppy/screen-capture,@uppy/status-bar,@uppy/store-default,@uppy/store-redux,@uppy/svelte,@uppy/thumbnail-generator,@uppy/transloadit,@uppy/tus,@uppy/unsplash,@uppy/url,@uppy/utils,@uppy/vue,@uppy/webcam,@uppy/xhr-upload,@uppy/zoom: add missing entries to changelog for individual packages (Antoine du Hamel / #4092)

3.0.0

Released: 2022-08-22 Included in: Uppy v3.0.0

  • Switch to ESM

2.2.0

Released: 2022-05-30 Included in: Uppy v2.11.0

  • @uppy/companion-client: Revert "Revert "@uppy/companion-client: refactor to ESM"" (Antoine du Hamel / #3730)

2.1.0

Released: 2022-05-14 Included in: Uppy v2.10.0

  • @uppy/companion-client: refactor to ESM (Antoine du Hamel / #3693)

2.0.6

Released: 2022-04-07 Included in: Uppy v2.9.2

  • @uppy/aws-s3,@uppy/companion-client,@uppy/transloadit,@uppy/utils: Propagate isNetworkError through error wrappers (Renée Kooi / #3620)

2.0.5

Released: 2022-02-14 Included in: Uppy v2.5.0

  • @uppy/companion-client,@uppy/companion,@uppy/provider-views,@uppy/robodog: Finishing touches on Companion dynamic Oauth (Renée Kooi / #2802)