@uppy/companion-client is a client-side library for Uppy, a modular file uploader for web browsers. It allows you to interact with Uppy Companion, a server-side component that handles file uploads from various sources such as local disk, remote URLs, and cloud services like Google Drive, Dropbox, and Instagram.

What are @uppy/companion-client's main functionalities?

Upload Files

This feature allows you to upload files to a specified endpoint using the Companion server. The code sample demonstrates how to upload a file named 'example.txt' to a Companion server.

const { uploadFile } = require('@uppy/companion-client');

const file = new File(['content'], 'example.txt', { type: 'text/plain' });

uploadFile(file, {
  endpoint: 'https://your-companion-server.com/upload',
  fieldName: 'file'
}).then(response => {
  console.log('File uploaded successfully:', response);
}).catch(error => {
  console.error('Error uploading file:', error);
});

Generate Pre-signed URLs

This feature allows you to generate pre-signed URLs for uploading files directly to cloud storage services like Amazon S3. The code sample demonstrates how to generate a pre-signed URL for a file named 'example.txt'.

const { getPreSignedUrl } = require('@uppy/companion-client');

getPreSignedUrl('https://your-companion-server.com/s3', {
  filename: 'example.txt',
  contentType: 'text/plain'
}).then(response => {
  console.log('Pre-signed URL:', response.url);
}).catch(error => {
  console.error('Error generating pre-signed URL:', error);
});

List Files

This feature allows you to list files from a specified source, such as Google Drive or Dropbox, using the Companion server. The code sample demonstrates how to list files from Google Drive.

const { list } = require('@uppy/companion-client');

list('https://your-companion-server.com/drive').then(response => {
  console.log('Files:', response.items);
}).catch(error => {
  console.error('Error listing files:', error);
});

Other packages similar to @uppy/companion-client

@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

License

The MIT License.

3.5.0

Released: 2023-02-13

| Package | Version | Package | Version | | -------------------- | ------- | -------------------- | ------- | | @uppy/audio | 1.0.4 | @uppy/screen-capture | 3.0.2 | | @uppy/companion | 4.3.0 | @uppy/transloadit | 3.1.1 | | @uppy/core | 3.0.6 | @uppy/xhr-upload | 3.1.0 | | @uppy/dashboard | 3.2.2 | uppy | 3.5.0 | | @uppy/locales | 3.0.6 | | |

@uppy/transloadit: fix assemblyOptions option (Antoine du Hamel / #4316)
meta: Remove Robodog advice, since it is deprecated (Artur Paikin)
@uppy/dashboard: fix dashboard acquirers list (Mikael Finstad / #4306)
@uppy/dashboard: Dashboard: disallow clicking on buttons and links in Dashboard disabled mode (Artur Paikin / #4292)
@uppy/audio,@uppy/core,@uppy/dashboard,@uppy/screen-capture: Warn more instead of erroring (Artur Paikin / #4302)
@uppy/locales: Update de_DE.js (Jörn Velten / #4297)
meta: use load balancer for companion in e2e tests (Mikael Finstad / #4228)
@uppy/companion: @uppy/companion upgrade grant dependency (Scott Bessler / #4286)
@uppy/xhr-upload: add 'upload-stalled' event (Antoine du Hamel / #4247)
@uppy/locales: minor enhancements and typo fixes for the hungarian translation (KergeKacsa / #4282)

Keywords

FAQs

What is @uppy/companion-client?

Is @uppy/companion-client popular?

Is @uppy/companion-client well maintained?

Package last updated on 20 Oct 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install