DefinitelyTyped/types/simple-oauth2/simple-oauth2-tests.ts

// off https://github.com/lelylan/simple-oauth2/blob/master/README.md
// slightly changed to remove external dependencies

// Initialize the OAuth2 Library
import * as oauth2lib from "simple-oauth2";

// Set the configuration settings
const credentials: oauth2lib.ModuleOptions = {
    client: {
        id: '<client-id>',
        secret: '<client-secret>'
    },
    auth: {
        tokenHost: 'https://api.oauth.com'
    }
};

const oauth2 = oauth2lib.create(credentials);

// Test custom `idParamName`
{
    const oauth2 = oauth2lib.create({ client: { id: 'x', secret: 'x', idParamName: 'foobar' }, auth: { tokenHost: 'x' } });
    oauth2.authorizationCode.authorizeURL({ foobar: 'x' });
}

// #Authorization Code flow
(async () => {
    // Authorization oauth2 URI
    const authorizationUri = oauth2.authorizationCode.authorizeURL({
        redirect_uri: 'http://localhost:3000/callback',
        scope: '<scope>',
        state: '<state>'
    });

    oauth2.authorizationCode.authorizeURL({
        redirect_uri: 'http://localhost:3000/callback',
        scope: ['<scope1>', '<scope2>'],
        state: '<state>'
    });

    // Redirect example using Express (see http://expressjs.com/api.html#res.redirect)
    // res.redirect(authorizationUri);

    // Get the access token object (the authorization code is given from the previous step).
    const tokenConfig = {
        code: '<code>',
        redirect_uri: 'http://localhost:3000/callback',
        scope: ['<scope1>', '<scope2>']
    };

    // Save the access token
    try {
        const result = await oauth2.authorizationCode.getToken(tokenConfig);
        const accessToken = oauth2.accessToken.create(result);
    } catch (error) {
        console.log('Access Token Error', error.message);
    }
})();

// #Password Credentials Flow
(async () => {
    const tokenConfig = {
        username: 'username',
        password: 'password',
        scope: [ '<scope1>', '<scope2>' ],
    };

    // Save the access token
    try {
        const result = await oauth2.ownerPassword.getToken(tokenConfig);
        const accessToken = oauth2.accessToken.create(result);
    } catch (error) {
        console.log('Access Token Error', error.message);
    }
})();

// #Client Credentials Flow
(async () => {
    const tokenConfig = {};

    // Get the access token object for the client
    try {
        const result = await oauth2.clientCredentials.getToken(tokenConfig);
        const accessToken = oauth2.accessToken.create(result);
    } catch (error) {
        console.log('Access Token error', error.message);
    }
})();

// #Access Token object
(async () => {
    // Sample of a JSON access token (you got it through previous steps)
    const tokenObject = {
        access_token: '<access-token>',
        refresh_token: '<refresh-token>',
        expires_in: '7200'
    };

    // Create the access token wrapper
    let accessToken = oauth2.accessToken.create(tokenObject);

    // Check if the token is expired. If expired it is refreshed.
    if (accessToken.expired()) {
        try {
            accessToken = await accessToken.refresh();
        } catch (error) {
            console.log('Error refreshing access token: ', error.message);
        }
    }

    // Revoke both access and refresh tokens
    try {
        // Revoke only the access token
        await accessToken.revoke('access_token');

        // Session ended. But the refresh_token is still valid.
        // Revoke the refresh token
        await accessToken.revoke('refresh_token');

        console.log('Token revoked');
    } catch (error) {
        console.log('Error revoking token: ', error.message);
    }

    // or...

    try {
        // Revokes both tokens, refresh token is only revoked if the access_token is properly revoked
        await accessToken.revokeAll();
    } catch (error) {
        console.log('Error revoking token: ', error.message);
    }
})();

// #Errors
// not applicable, as those errors about missing authentication codes are already found by the typescript compiler

// (function () {
//     oauth2.authorizationCode.getToken({})
//         .catch((error) => {
//             console.log(error.message);
//         });

//     // => { "status": "401", "message": "Unauthorized" }
// })();