This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

authist

0.5.0 • Public • Published

Authist

NPM version Pipeline Status Deploy Status Coverage Vulnerabilities

Error codes

Code Message How to debug / fix
PasswordMismatch You entered a wrong password! Did you store password we hashed for you?
UsernameRequired Username is required field, please enter the username! 🤔
PasswordRequired Password is required field, please enter the password! 🤔
UserNotFound It seems this user doesn't exist, are you sure you entered correct credentials? Do you want to enable auto registration? Declare saveNonExistingUser function

🚧🏗️🚧

Under heavy development

Features

  • supported features by Firebase Authentication, a fellow auth ideal service
    • email and password authentication ref
    • google authentication ref
    • facebook authentication ref
    • twitter authentication ref
    • github authentication ref
    • custom auth system authentication ref
    • anonymous auth ref kept forever
    • storing provider data ref what data
    • reset password email ref
    • recovery email ref
    • verify email ref

Email and password authentication

Usage

import { createAuthenticator } from 'authist';

const authenticator = createAuthenticator({
    getUserById: () => Promise.resolve(), // todo: add implementation
    emailPassword: {
        getUserByEmail: (email: string) => Promise.resolve(), // todo: add implementation
    },
});
const { user, credentials } = await authenticator.signInWithEmailAndPassword(email, password);

Express middleware

import express from 'express';

const app = express();
app.get('/users/me', authenticator.expressBearer, (req, res) => {
    res.json(req.user);
});

Facebook authentication

Usage

import { createAuthenticator } from 'authist';

const authenticator = createAuthenticator({
    getUserById: () => Promise.resolve(), // todo: add implementation
    facebook: {
        getUserByEmail: (email: string) => Promise.resolve(), // todo: add implementation
        graphApiVersion: 'v9.0',
    },
});
const { user, credentials } = await authenticator.signInWithFacebook(accessToken);

Google authentication

  • The signInWithGoogle method takes token parameter that is Google access token
  • Your Google access token must have the email scope assigned to successfully get the user's email

Usage

import { createAuthenticator } from 'authist';

const authenticator = createAuthenticator({
    getUserById: () => Promise.resolve(), // todo: add implementation
    google: {
        getUserByEmail: (email: string) => Promise.resolve(), // todo: add implementation
    },
});
const { user, credentials } = await authenticator.signInWithGoogle(accessToken);

License

This project is licensed under MIT.

Dependencies (6)

Dev Dependencies (17)

Package Sidebar

Install

npm i authist

Weekly Downloads

17

Version

0.5.0

License

MIT

Unpacked Size

194 kB

Total Files

55

Last publish

Collaborators

  • ackeecz