A NodeJS module to use MongoDB Stitch in an easy way.
npm install stitchingsh
$ npm install stitching
`
Overview
For now, the plan is to give an easy way to manage Authentication using MongoDB Stitch, but the real goal is to make everything else easier.
Setting up MongoDB Stitch app
Before using Stitching, you need to setup a MongoDB Stitch app. To get started, you can visit Getting Started page and follow the instructions. After you finish setting up a MongoDB Stitch app, you can use your APP ID to handle Authentication.
$3
Before registering an user, you need to enable email/password authentication in MongoDB Stitch (Authentication -> Providers -> Email/Password):
* Email Confirm URL: The URL included on the confirmation email. You will need to setup Stitching to receive a Token/Token ID pair in order to confirm an email.
* Password Reset URL: The URL included on the password reset email. You will need to setup Stitching to receive a Token/Token ID pair in order to reset a password.
* Reset Password Email Subject: Subject for the reset password email.
* Email Confirmation Subject: Subject for the confirmation email.
$3
Inside MongoDB Stitch, go to your Atlas Cluster and create a new collection:
* Database: The database where your metadata collection will belong (I.E. example).
* Collection: The metadata collection name used to store our user metadata (I.E. metadata).
After you created your collection, you need to set the next Field Rules:
#### Top-Level Document
READ (Only the owner of a document can read it)
`json
{
"owner_id": "%%user.id"
}
`
WRITE (Anyone can create a new document, but only the owner of a document can write to it)
`json
{
"%or": [
{
"%%prevRoot.owner_id": "%%user.id"
},
{
"%%prevRoot": {
"%exists": false
}
}
]
}
`
#### owner_id
VALID
`json
"%%user.id"
`
Note: Email/Password authentication doesn't handle metadata out of the box. This means that after login to your MongoDB Stitch app, you don't have other information regarding the email. We need a collection to save user name, date of birth, address, etc. This is optional and we can skip this step.
Usage
$3
Before using any Stitching functionality, lets connect to our MongoDB Stitch app.
`js
const stitching = require("stitching");
// Configuration
const APP_ID = "example-";
const CLUSTER = "mongodb-atlas";
const DB = "example";
const ENDPOINT = "https://stitch.mongodb.com";
const METADATA = "metadata"; // Optional collection name to handle user metadata (I.E. name, dob, profile_image, etc)
// Connect to MongoDB Stitch app
stitching.connect(APP_ID, ENDPOINT, CLUSTER, DB, METADATA);
`
After you connect your Stitching, you can access auth (Stitching Authentication), client (MongoDB Stitch Client), db (MongoDB Stitch DB) and providers (enum).
$3
You can use providers to authorize users to use your app. To enable a provider, go to Authentication -> Providers and follow the instructions for Facebook/Google/Custom. After you setup a provider, you can use it as follows:
`js
const stitching = require("stitching");
// Authenticate using Facebook
stitching.auth
.authenticate(stitching.providers.Facebook)
.catch(console.error);
`
Note: After invoking authentication, you'll be redirected to Facebook where the user needs to grant permissions.
After you are authenticated, you'll be redireted back to your app. Credentials will be available through stitching.auth.getCredentials:
`js
const stitching = require("stitching");
// Get current credentials
stitching.auth
.getCredentials()
.then(console.log) // Log credentials to console
.catch(console.error);
`
$3
To register a new user (email/password):
`js
const stitching = require("stitching");
// User email/password
const email = "email@email.com";
const password = "Password1!";
// Register a user with the given email/password
stitching.auth
.registerUser(email, password)
.then(() => {
console.log(An email was sent to ${email}. Please confirm the email by accessing the link provided.);
})
.catch(console.error);
`
#### Confirm an email
To confirm an email you need to setup Stitching on the Email Confirm URL to receive a Token/Token ID pair.
`js
const stitching = require("stitching");
// Implement your own logic to retrieve the Token/Token ID params from the Email Confirm URL
const token = "";
const tokenId = "";
// Confirm the email providing the Token/Token ID
stitching.auth
.emailConfirm(tokenId, token)
.then(console.log)
.catch(console.error);
`
#### Reset a password
In order to reset a password, first we need to sent a Reset Password Email:
`js
const stitching = require("stitching");
// User email
const email = "email@email.com";
// Send a password reset email
stitching.auth
.sendPasswordReset(email)
.then(console.log)
.catch(console.error);
`
After a Reset Password Email URL is accessed through the link provided on the Reset Password Email, we need to set the new password:
`js
const stitching = require("stitching");
// Implement your own logic to retrieve the Token/Token ID params from the Email Confirm URL
const token = "";
const tokenId = "";
// Set the new password
const newPassword = "AnotherPassword1!";
// Rest the password to the new one
stitching.auth
.passwordReset(tokenId, token, newPassword)
.then(console.log)
.catch(console.error);
`
#### Login
After a registered email is confirmed, we can login:
`js
const stitching = require("stitching");
// User email/password
const email = "email@email.com";
const password = "Password1!";
// Login using the given email/password
stitching.auth
.login(email, password)
.then((credentials) => {
// If we setup metadata collection, we log it to console
console.log(credentials.metadata);
})
.catch(console.error);
`
#### Logout
Whenever we want to logout:
`js
const stitching = require("stitching");
// Logout from the current session
stitching.auth
.logout()
.catch(console.error);
`
$3
Whenever we want to update the current user metadata:
`js
const stitching = require("stitching");
// Set the metadata for the current user
const metadata = {
name: "John Doe",
address: "123 Abc Street"
};
// Save metadata to database
stitching.auth
.updateMetadata(metadata)
.then(console.log)
.catch(console.error);
``