@aytacworld/express-database-mongo

Contains the default authentication and oauth database for @aytacworld/express apps

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@aytacworld/express-database-mongo
Minified + gzip package size for @aytacworld/express-database-mongo in KB

Readme

@aytacworld/express-database-mongo

!!! This package is obsolete, use @aytacworld/express-module-mongo instead !!!

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

When requiring just past in the connectionstring to your mongoDB Server.

You can also use mongo as your session storage.

Installation

using npm

npm i @aytacworld/express-database-mongo

using yarn

yarn add @aytacworld/express-database-mongo

Usage

app.js

...
const ExpressDatabase = require('@aytacworld/express-database-mongo')('appname', 'mongodb://localhost:27017/auth', 'sessionDbName', 'sessionCollectionName');

const app = new Express({
  ...
  authDatabase: ExpressDatabase,
  // If you want to use mongo Session storage, add the following
  sessionStore: ExpressDatabase.sesstionStore
  ...
});

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) 2018 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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.