Skip to main content

OneDrive

The @uppy/onedrive plugin lets users import files from their OneDrive account.

tip

Try out the live example or take it for a spin in StackBlitz.

When should I use this?​

When you want to let users import files from their OneDrive account.

A Companion instance is required for the OneDrive plugin to work. Companion handles authentication with OneDrive, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.

You can self-host Companion or get a hosted version with any Transloadit plan.

npm install @uppy/onedrive

Use​

Using OneDrive requires setup in both Uppy and Companion.

Use in Uppy​

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import OneDrive from '@uppy/onedrive';

import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';

new Uppy()
	.use(Dashboard, { inline: true, target: '#dashboard' })
	.use(OneDrive, { companionUrl: 'https://your-companion.com' });

Use with Transloadit​

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import OneDrive from '@uppy/onedrive';

uppy.use(OneDrive, {
	companionUrl: COMPANION_URL,
	companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
});

You may also hit rate limits, because the OAuth application is shared between everyone using Transloadit.

To solve that, you can use your own OAuth keys with Transloadit’s hosted Companion servers by using Transloadit Template Credentials. Create a Template Credential on the Transloadit site. Select “Companion OAuth” for the service, and enter the key and secret for the provider you want to use. Then you can pass the name of the new credentials to that provider:

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import OneDrive from '@uppy/onedrive';

uppy.use(OneDrive, {
	companionUrl: COMPANION_URL,
	companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
	companionKeysParams: {
		key: 'YOUR_TRANSLOADIT_API_KEY',
		credentialsName: 'my_companion_dropbox_creds',
	},
});

Use in Companion​

To sign up for API keys, go to the Azure Platform from Microsoft.

Create a project for your app if you don’t have one yet.

The app page has a "Redirect URIs" field. Here, add:

https://$YOUR_COMPANION_HOST_NAME/onedrive/redirect

If you are using Transloadit hosted Companion:

https://api2.transloadit.com/companion/onedrive/redirect

Go to the “Manifest” tab, and find the "signInAudience" key. Change it to "signInAudience": "AzureADandPersonalMicrosoftAccount", and click “Save”.

Go to the “Overview” tab. Copy the Application (client) ID field - this will be your Oauth client ID.

Go to the “Certificates & secrets” tab, and click “+ New client secret”. Copy the Value field - this will be your OAuth client secret.

Configure the OneDrive key and secret in Companion. With the standalone Companion server, specify environment variables:

export COMPANION_ONEDRIVE_KEY="OneDrive Application ID"
export COMPANION_ONEDRIVE_SECRET="OneDrive OAuth client secret value"

When using the Companion Node.js API, configure these options:

companion.app({
	providerOptions: {
		onedrive: {
			key: 'OneDrive Application ID',
			secret: 'OneDrive OAuth client secret value',
		},
	},
});

API​

Options​

id​

A unique identifier for this plugin (string, default is a unique ID for each plugin).

title​

Title / name shown in the UI, such as Dashboard tabs (string, default is the name of the plugin).

target​

DOM element, CSS selector, or plugin to place the drag and drop area into (string, Element, Function, or UIPlugin, default: Dashboard).

companionUrl​

URL to a Companion instance (string, default: null).

companionHeaders​

Custom headers that should be sent along to Companion on every request (Object, default: {}).

companionAllowedHosts​

The valid and authorised URL(s) from which OAuth responses should be accepted (string or RegExp or Array). This option is useful when you have your Companion running on several hosts. Otherwise, the default value should do fine, which uses the origin of companionUrl.

This value can be a string, a RegExp pattern, or an Array of these. Strings are evaluated as regular expressions too and will be wrapped in a RegExp like so:

new RegExp(`^${value}$`);

Important: You must escape regex characters like ., or you might open your app up to security vulnerabilities.

  • Example correct strings
    • '^(?:.*\\.)?example\.com$' matches example.com and all of its subdomains.
    • 'https://example\.com' matches https://example.com only.
  • Example vulnerability: 'https://www.example.com' would allow an attacker with the domain wwwxexample.com to forge and inject a fraudulent token into Uppy.

companionCookiesRule​

This option correlates to the RequestCredentials value (string, default: 'same-origin').

This tells the plugin whether to send cookies to Companion.

locale​

An object with strings property containing additional i18n strings. The key is the i18n key and the value is the English string.

Example:

{
	strings: {
		someKey: 'Some English string',
	},
}

storage​

A custom storage to be used for the plugin’s persistent data. Type AsyncStore, default is LocalStorage.