Nature's Particle Manager

mongodb-stitch-browser-sdk

4.0.13 • Public • Published

Join the chat at https://gitter.im/mongodb/stitch

MongoDB Stitch Browser SDK

The official MongoDB Stitch Browser SDK for JavaScript/TypeScript.

Index

Documentation

Discussion

Installation

NPM

Run the following in the root directory of your NPM project.

npm install mongodb-stitch-browser-sdk

This will start you off with the core SDK functionality as well as the remote MongoDB service.

For customized dependencies use the following:

npm install mongodb-stitch-browser-core
npm install mongodb-stitch-browser-services-aws
npm install mongodb-stitch-browser-services-http
npm install mongodb-stitch-browser-services-mongodb-remote
npm install mongodb-stitch-browser-services-twilio

HTML Script Tags

You can also include the SDK directly in your HTML code using script tags. For core SDK functionality and the remote MongoDB service, use the following:

<script src="https://s3.amazonaws.com/stitch-sdks/js/bundles/4.0.13/stitch.js"></script>

For customized dependencies use the following:

<script src="https://s3.amazonaws.com/stitch-sdks/js/bundles/4.0.13/stitch-core.js"></script>
<script src="https://s3.amazonaws.com/stitch-sdks/js/bundles/4.0.13/stitch-services-aws.js"></script>
<script src="https://s3.amazonaws.com/stitch-sdks/js/bundles/4.0.13/stitch-services-http.js"></script>
<script src="https://s3.amazonaws.com/stitch-sdks/js/bundles/4.0.13/stitch-services-mongodb-remote.js"></script>
<script src="https://s3.amazonaws.com/stitch-sdks/js/bundles/4.0.13/stitch-services-twilio.js"></script>

Example Usage

Creating a new app with the SDK (NPM)

Set up an application on Stitch

  1. Go to https://stitch.mongodb.com/ and log in to MongoDB Atlas.
  2. Create a new app in your project with your desired name.
  3. Go to your app in Stitch via Atlas by clicking Stitch Apps in the left side pane and clicking your app.
  4. Copy your app's client app id by going to Clients on the left side pane and clicking copy on the App ID section.
  5. Go to Providers from Users in the left side pane and edit and enable "Allow users to log in anonymously".

Set up an NPM project

  1. Ensure that you have npm installed. See npmjs.com.
  2. Initialize a new NPM project with npm init.
  3. Add the MongoDB Stitch Browser SDK by running npm install mongodb-stitch-browser-sdk.
  4. Install webpack.js by running npm install --save-dev webpack webpack-cli.
  5. Add the following field to the "scripts" field of your package.json:
"scripts"{
    "pack": "webpack"
}
  1. Create directories for your source files, and your distributed files:
mkdir src dist
  1. Create the file src/index.js and add the following code, replacing <your-client-app-id> with the id you retrieved when setting up the application in MongoDB Stitch:
import { Stitch, AnonymousCredential } from 'mongodb-stitch-browser-sdk'
 
function initializeAndLogin() {
  const client = Stitch.initializeDefaultAppClient('<your-client-app-id>');
  client.auth.loginWithCredential(new AnonymousCredential()).then(user => {
    document.getElementById('auth-status').innerHTML = 
      `Logged in as anonymous user with id ${user.id}`;
  });
}
 
window.onload = initializeAndLogin;
  1. Create the file dist/index.html and add the following code:
<!doctype html>
  <html>
   <head>
     <title>MongoDB Stitch Sample</title>
   </head>
   <body>
     <script src="main.js"></script> 
     <div id="auth-status">Logged Out</div>
   </body>
  </html>
  1. Run the webpack bundler by running npm run pack.
  2. Open dist/index.html in your web browser. If everything was configured correctly, you should see a message in the browser window that you are logged in as an anonymous user.

See the Getting Started guide on webpack's website for more information on how to use webpack to bundle your JavaScript or TypeScript code that uses the Stitch SDK.

Additionally, the JavaScript code above utilizes ES6 features. If you'd like your code to run in older browsers, you'll need to use a transpiler like Babel as part of your bundling process. See babel-loader.

Using the SDK

Initialize the SDK

  1. When your app or webpage is initialized, run the following code to initialize the Stitch SDK, replacing <your-client-app-id> with your Stitch application's client app ID:
import { Stitch, AnonymousCredential } from 'mongodb-stitch-browser-sdk'
 
Stitch.initializeDefaultAppClient('<your-client-app-id>');
  1. To get a client to use for logging in and communicating with Stitch, use Stitch.defaultAppClient
const stitchClient = Stitch.defaultAppClient;

Logging In

  1. We enabled anonymous log in, so let's log in with it; add the following anywhere in your code:
const client = Stitch.defaultAppClient;
 
console.log("logging in anonymously");
client.auth.loginWithCredential(new AnonymousCredential()).then(user => {
  console.log(`logged in anonymously as user ${user.id}`)
});
  1. When running this code, you should see the following in your browser's debug console:
logging in anonymously                                                    	
logged in anonymously as user 58c5d6ebb9ede022a3d75050

Using BSON and Extended JSON

This library depends on mongodb-stitch-bson and mongodb-stitch-extjson. Usage of both can be see on the respective READMEs.

Executing a function

  1. Once logged in, executing a function happens via the StitchAppClient's callFunction() method
client.callFunction("echoArg", ["Hello world!"]).then(echoedResult => {
  console.log(`Echoed result: ${echoedResult}`);
})
  1. If you've configured your Stitch application to have a function named "echoArg" that returns its argument, you should see a message like:
Echoed result: Hello world!

Getting a StitchAppClient without Stitch.getDefaultAppClient

In the case that you don't want a single default initialized StitchAppClient, you can use the following with as many client app IDs as you'd like to initialize clients for multiple app IDs:

const client = Stitch.initializeAppClient("<your-client-app-id>");

You can use the client returned there or anywhere else in your app by using the following:

const client = Stitch.getAppClient("<your-client-app-id>");

install

npm i mongodb-stitch-browser-sdk

Downloadsweekly downloads

177

version

4.0.13

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability