Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harrisoff/onedrive-js-sdk
Wraps some of OneDrive's APIs, only for uploading and sharing files.
https://github.com/harrisoff/onedrive-js-sdk
image-hosting imagehost onedrive onedrive-api onedrive-sdk
Last synced: 3 months ago
JSON representation
Wraps some of OneDrive's APIs, only for uploading and sharing files.
- Host: GitHub
- URL: https://github.com/harrisoff/onedrive-js-sdk
- Owner: harrisoff
- License: mit
- Created: 2021-10-30T06:30:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T15:32:07.000Z (almost 2 years ago)
- Last Synced: 2024-03-19T17:23:21.980Z (3 months ago)
- Topics: image-hosting, imagehost, onedrive, onedrive-api, onedrive-sdk
- Language: TypeScript
- Homepage:
- Size: 206 KB
- Stars: 13
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome - harrisoff/onedrive-js-sdk - Wraps some of OneDrive's APIs, only for uploading and sharing files. (TypeScript)
README
# OneDrive JS SDK
[](https://github.com/microsoft/TypeScript)
[](https://www.npmjs.com/package/@harrisoff/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](https://github.com/harrisoff/onedrive-image-hosting).
[中文文档](./README.zh-cn.md)
## Configure Account
In [App registrations](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) 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](https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth?view=odsp-graph-online#token-flow) in authentication. Use helper function `generateAuthUrl` to generate an auth url and open it.
```ts
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:
```ts
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:
```ts
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](https://docs.microsoft.com/en-us/onedrive/developer/)
- [some notes for my personal reference](./NOTES.md)