@aytacworld/express-module-mongo

This module contains the database models for @aytacworld/express-module-login and @aytacworld/express-module-oauth-server.

The module uses MongoDB as backend.

!!! You need to pass the connectionSting with configs object, or it will try to connect to a mongoDb instance on localhost

Installation

using npm

npm i @aytacworld/express-module-mongo

using yarn

yarn add @aytacworld/express-module-mongo

Usage

Add the module using app.module() method, before any other module or route. So it will become available to others.

app.js

const Express = require('@aytacworld/express');
const ExpressDatabase = require('@aytacworld/express-module-mongo');
const config = require('./config');
const app = new Express(config);

app.module(ExpressDatabase);

app.route('/', require('./route'));

app.listen();

In your route, you can access the db as authDb module.

route.js

const path = require('path');
const router = require('express').Router();

const Router = (config, { authDb }) => {
  router.get('/', async (req, res) => {
    const user = await authDb.users.findById(123);
    res.render('homepage', { user });
  });

  return router;
};

module.exports = Router;

Config

{
  "EXPRESS_MODULE_AUTH_DB_NAME": "myAuthDb", // String, default: authDb
  "EXPRESS_MODULE_AUTH_CONNECTION_STRING": "mongo://localhost:27017/authDb", // String, default: "mongo://localhost:27017/authDb"
  "EXPRESS_MODULE_AUTH_APPLICATION_NAME": "my-awesome-app", // String, default: "myApplication"
  "EXPRESS_MODULE_AUTH_SALT_ROUND": 34, // Number, default: 10
}

Schemas and Methods

Users

Schema

{
  username: String,
  password: String,
  hashed: Boolean,
  applications: [String],
}

Methods

{
  static findById(id): Promise<user>;
  static findByUsername(username): Promise<user>;
  static comparePassword(username, password): Promise<user|false>;
  static updateUser(username, password): Promise<void>;
  static addUser(username, password): Promise<void>;
  static deleteUser(username): Promise<void>;
}

Clients

Schema

{
  name: String,
  clientId: String,
  clientSecret: String,
  redirectUrl: String,
}

Methods

{
  static findById(id): Promise<client>;
  static findByClientId(clientId): Promise<client>;
  static compareSecret(username, secret): Promise<client|false>;
  static updateClient(clientId, name, secret, redirectUrl): Promise<void>;
  static addClient(clientId, name, secret, redirectUrl): Promise<void>;
  static deleteClient(clientId): Promise<void>;
}

Tokens

Schema

{
  token: String,
  userId: String,
  clientId: String,
  redirectUri: String,

  refreshToken: String,
  expiresIn: Number,

  authCode: String,
  state: String,
  transactionId: String,
  codeChallenge: String,
}

Methods

{
  static find(key): Promise<token>;
  static findByUserIdAndClientId(userId, clientId): Promise<token>;
  static findByTransactionId(transactionId): Promise<token>;
  static saveCode(authCode, userId, clientId, redirectUri, state, transactionId): Promise<void>;
  static exchangeAuthCodeForAccessToken(authCode, accessToken, refreshToken, expiresIn): Promise<void>;
  static refreshAccessToken(refreshToken, accessToken, expiresIn): Promise<void>;
}

MIT License

Copyright (c) 2019 Adem Aytaç

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.