harrisoff / onedrive-js-sdk

Wraps some of OneDrive's APIs, only for uploading and sharing files.

OneDrive JS SDK

This project wraps a small part of OneDrive's APIs, only for uploading files and creating sharing links.

You can build a webGUI to use it. There is an example OneDrive Image Hosting.

中文文档

Configure Account

In App registrations page click new registration button, then you'll need to fill the following fields:

• Name

• Supported account types

  Personal Microsoft accounts only is enough for personal usage

• Redirect URI

  For example, https://localhost:3000/

After registration, click Authentication on the left, check Access tokens (used for implicit flows) and save.

Application (client) ID is generated once the application is registered. But you'll need to verify the application before using it. Just click Branding on the left and follow the instructions.

Usage

Authentication

Here we use token flow in authentication. Use helper function generateAuthUrl to generate an auth url and open it.

import { generateAuthUrl } from '@harrisoff/onedrive-js-sdk'

const authUrl = generateAuthUrl('your-client-id', 'your-redirect-uri')

Actually there's another field scope is required in the auth url. This value is set to openid https://graph.microsoft.com/Files.ReadWrite.All and is unnecessary to be changed.

After redirecting back to your site, access_token or error messages will be presented in the hash depending on whether authentication is successful.

API calls

There are two ways to call APIs.

The original APIs are exposed so you can use them directly:

import { uploadSmall, createUploadSession, uploadLargeChunk, share, getShareUrl } from '@harrisoff/onedrive-js-sdk'

Or you can use constructor to create a client instance, which wraps the original APIs:

import OneDriveAPI, { getShareUrl } from '@harrisoff/onedrive-js-sdk'

const client = new OneDriveApi({ accessToken })
const { id: fileId } = await client.upload(file, filePath)
const { shareId } = await client.share(fileId)
const sharingLink = getShareUrl(shareId)

TODO List

• progress callback

Development

For more details, see:

• Official OneDrive API Document
• some notes for my personal reference