@accounts/mongo : Monorepo integration

.circleci/config.yml

@@ -4,6 +4,7 @@ jobs:
   build:
     docker:
       - image: circleci/node:8
+      - image: circleci/mongo:3
     steps:
       - checkout
       - run: yarn install --frozen-lockfile

packages/database-mongo/README.md

@@ -0,0 +1,54 @@
+# @accounts/mongo
+
+_MongoDB adaptor for accounts_
+
+[![npm](https://img.shields.io/npm/v/@accounts/mongo.svg?maxAge=2592000)](https://www.npmjs.com/package/@accounts/mongo)
+[![Circle CI](https://circleci.com/gh/accounts-js/mongo.svg?style=shield)](https://circleci.com/gh/accounts-js/mongo)
+[![codecov](https://codecov.io/gh/accounts-js/mongo/branch/master/graph/badge.svg)](https://codecov.io/gh/accounts-js/mongo)
+![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+## Note
+
+This package is under active development.
+
+## Install
+
+```
+yarn add @accounts/mongo
+```
+
+## Usage
+
+```javascript
+import { AccountsServer } from '@accounts/server';
+import { Mongo } from '@accounts/mongo';
+
+// If you are using mongoose
+mongoose.connect(process.env.MONGO_URL);
+const db = mongoose.connection;
+
+// If you are using mongodb 2.x
+const db = await mongodb.MongoClient.connect(process.env.MONGO_URL);
+
+// If you are using mongodb 3.x
+const client = await mongodb.MongoClient.connect(process.env.MONGO_URL);
+const db = client.db('my-db-name');
+
+const accountsMongo = new Mongo(db, options);
+const accountsServer = new AccountsServer({ db: accountsMongo });
+```
+
+The users will be saved under the `users` collection.
+
+## Options
+
+| Property                        |          Type          |                         Default                         | Description                                                   |
+| ------------------------------- | :--------------------: | :-----------------------------------------------------: | ------------------------------------------------------------- |
+| collectionName                  |         String         |                          users                          | The users collection name.                                    |
+| sessionCollectionName           |         String         |                        sessions                         | The sessions collection name.                                 |
+| timestamps                      |         Object         |  `{ createdAt: 'createdAt', updatedAt: 'updatedAt' }`   | The timestamps for the users and sessions collection.         |
+| convertUserIdToMongoObjectId    |        Boolean         |                          true                           | Should the user collection use \_id as string or ObjectId.    |
+| convertSessionIdToMongoObjectId |        Boolean         |                          true                           | Should the session collection use \_id as string or ObjectId. |
+| caseSensitiveUserName           |        Boolean         |                          true                           | Perform case intensitive query for user name.                 |
+| idProvider                      |        Function        |                                                         | Function that generate the id for new objects.                |
+| dateProvider                    | `(date?: Date) => any` | `(date?: Date) => (date ? date.getTime() : Date.now())` | Function that generate the date for the timestamps.           |