BridgeIt Services Client JavaScript API (DEV BRANCH)

An easy-to-use JavaScript API for BridgeIt Services.

Admin Service API

Auth Service API

Code Service API

Context Service API

Document Service API

Location Service API

Metrics Service API

Push Service API

Query Service API

Storage Service API

ES6 Promise Support

The BridgeIt Services Client API is written with ECMAScript 6 Promise/A+ support. All API functions that use asynchronous network io will return a Promise. If your application already supports ES6 Promises, you can continue using those. ES6 Promises are supported in all modern browsers except IE11 (http://caniuse.com/#search=promise). To support older browsers, you can use a shim, such as es6-promises, like so:

<script src="https://es6-promises.s3.amazonaws.com/es6-promise-2.0.1.js"></script>
<script>
    if( !("Promise" in window)){
        window.Promise = ES6Promise.Promise;
    }
</script>
<script src="bridgeit.js"></script>
<script src="bridgeit.io.js"></script>

Tests

The BridgetIt JS API Mocha integration tests can be run from the test directory either through the HTML files or with PhantomJS.

mocha-phantomjs all-tests.html

Mocha and PhantomJS are both required.

Global bridgeit.io Functions

• startTransaction
• endTransaction
• getLastTransactionId
• setCurrentRealm

startTransaction

function bridgeit.io.startTransaction()

Start a BridgeIt transaction.

This function will create a new transaction id, and automatially append the id to all bridgeit network calls. A BridgeIt transaction is not a ACID transaction, but simply a useful method to aid in auditing and diagnosing distributed network calls, especially among different services.

Example

bridgeit.io.startTransaction();
console.log('started transaction: ' + bridgeit.io.getLastTransactionId());
bridgeit.io.auth.login({
    account: accountId,
    username: adminId,
    password: adminPassword,
    host: host
}).then(function(authResponse){
    return bridgeit.io.documents.createDocument({
        document: newDoc,
        realm: realmId
    });
}).then(function(docURI){
    newDocURI = docURI;
    var uriParts = docURI.split('/');
    var docId = uriParts[uriParts.length-1];
    return bridgeit.io.documents.deleteDocument({
        account: accountId,
        realm: realmId,
        host: host,
        id: docId
    })
}).then(function(){
    console.log('completed transaction: ' + bridgeit.io.getLastTransactionId());
    bridgeit.io.endTransaction();
}).catch(function(error){
    console.log('something went wrong with transaction: ' + bridgeit.io.getLastTransactionId());
    bridgeit.io.endTransaction();
});
});

endTransaction

function bridgeit.io.endTransaction()

End a BridgeIt transaction.

This function will remove the current BridgeIt transaction id, if one exists.

Example

See startTransaction.

getLastTransactionId

function bridgeit.io.getLastTransactionId()

Return the last stored BridgeIt tranaction id.

Example

See startTransaction.

setCurrentRealm

function bridgeit.io.setCurrentRealm()

Set the current realm for all subsequent operations. This is useful when logging in as an admin, who is not in any realm, but needing to ensure that all other operations are done with a particular realm.

Example

bridgeit.io.auth.login({
    account: accountId,
    username: adminId,
    password: adminPassword,
    host: host
}).then(function(authResponse){
    bridgeit.io.setCurrentRealm('myRealm');
    //realm is no longer required for all subsequent operations
    return bridgeit.io.documents.createDocument({
        document: newDoc
    });
}).then(function(docURI){
    newDocURI = docURI;
    var uriParts = docURI.split('/');
    var docId = uriParts[uriParts.length-1];
    return bridgeit.io.documents.deleteDocument({
        account: accountId,
        host: host,
        id: docId
    })
});