# onedrive-auth

> Simple ES2015 library for OneDrive auth

Latest version **1.1.1** (published 2016-03-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install onedrive-auth
pnpm add onedrive-auth
yarn add onedrive-auth
bun add onedrive-auth
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-03-23 |
| First published | 2016-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | hlomzik |
| Maintainers | hlomzik |
| Keywords | onedrive, auth, promise |

## Links

- npm: https://www.npmjs.com/package/onedrive-auth
- Repository: https://github.com/hlomzik/onedrive-auth
- Homepage: https://github.com/hlomzik/onedrive-auth#readme
- Issues: https://github.com/hlomzik/onedrive-auth/issues
- npm.io page: https://npm.io/package/onedrive-auth

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2016-03-23
- 1.1.0 — 2016-03-22
- 1.0.1 — 2016-03-21
- 0.2.1 — 2016-01-09
- 0.2.0 — 2016-01-09
- 0.1.1 — 2016-01-08

## README

# onedrive-auth

Simple javascript OneDrive auth library. Makes an authorization and returns
back the OAuth2 token.

Uses [Promises](https://www.promisejs.org/) for better flow handling.

## Usage

```
bower install onedrive-auth
```

Use the main file (`dist/odauth.js`) in any way you prefer: `require()` it or
directly add via `<script>` tag and use global `OneDriveAuth` object:

```js
// <script src="js/odauth.js"> or use require.js or any bundling tool:
var OneDriveAuth = require('onedrive-auth');

// create OneDrive client
var onedrive = new OneDriveAuth({
  clientId: 'YOUR-CLIENT-ID',
  scopes: 'onedrive.readonly wl.signin',
  redirectUri: 'YOUR-CALLBACK-URI',
});

// check for active token
onedrive.auth().then(token => {
  // call OneDrive API endpoints with given token
}).catch(err => {
  // create auth button
});

// start auth process after user's click
some_auth_button.onclick = event => {
  onedrive.auth(true).then(token => {
    // call OneDrive API endpoints with given token
    // hide auth button
  });
};
```

## Example

Here is the simple example of authorizing using this library and interacting
with OneDrive api to create a file explorer web app:
[See it in action!](https://hlomzik.github.io/onedrive-auth)

## Files

* `odauth.js` - ES2015 library, main file with simple `export default`
* `dist/odauth.js` - transpiled ES3 file to direct use in web apps; contains
  UMD block, globally accessible as `OneDriveAuth`
* `.babelrc` - options for babel@6 to get the current transpiled result

Sample OneDrive explorer page. Only available in `gh-pages` branch:

* `index.html` - a sample web app to view the contents of the signed in user's
  OneDrive and show the JSON structures returned by the API.
* `callback.html` - page assigned with `redirectUri` to work with response
  from OneDrive OAuth2 API. Returns control back to main page with token.
* `style.css`, `spinner_grey_40_transparent.gif` - just utility files for
  example page. Should be inserted in `index.html` directly later.

## License

[MIT](https://github.com/hlomzik/onedrive-auth/blob/master/LICENSE)

---
_Source: https://npm.io/package/onedrive-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._