bladepop/vinyl-auth

A simple, short and vanilla javascript compatible token authentication library

vinyl-auth

A simple, short and vanilla javascript compatible token authentication library

Configuration example

var authConfig = {
    authProviderPath: 'provider.html',          // the path for the auth provider page
    storageTTL: 60,                             // in seconds
    storage: new Vinyl.VinylStorage(localStorage),
    refreshTokenPath: 'refreshtoken.json',      // if path is not set, refresh token mechanism is deactivated
    refreshTokenInterval: 15,                    // in seconds
    handleAuthSuccess: function (userData) {
        console.log('auth success', userData);  // {auth_token: "xxxx", uid: "yyyy", name: "Slemp Diggler"}
    },
    handleAuthFailure: function (error) {
        console.log('auth failure', error);     // {reason: "unauthorized", errors: Array(1)}
    },
    handleAuthStart: function (event) {
        console.log('auth start', event);       // {message: "Auth has started"}
    },
    handleAuthLogout: function (event) {
        console.log('logout', event);           // {message: "Logout"}
    },
    handleAuthTokenExpiry: function (event) {
        console.log('token expired', event);    // {message: "Token has expired"}
    }
};

Basic usage example

Include the library

    <script type="application/javascript" src="../dist/vinyl-auth.min.js" ></script>

To instansiate a new VinylAuth module use the Vinyl.VinylAuth(config) command from anywhere in your code.

var auth = new Vinyl.VinylAuth(authConfig);
auth.initialize();

function doAuth(force) {
    auth.authenticate(force);       // Can be forced to ignore current storage
}

function showRecord() {
    console.log(auth.getRecord());
}

function logout() {
    auth.logout();
}

doAuth(false);

TODO

• Local storage token module
• Token validation on refresh
• Refresh token mechanism
• Login Overlay example