ackeecz / authist

Authist

• Check our API documentation

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

• The signInWithFacebook method takes token parameter that is Facebook access token you will get it on the frontend side
• Your Facebook access token must have the email permission assigned to successfully get the user's email

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.

authist's Issues

Add google authentication provider

Add a new signInWithGoogle functionality and authentication flow.

What to do?

• Create new googleProvider file under providers folder
• Design GoogleProviderOptions interface - which data you need to successfully authenticate / register the user? Which data is optional / required? (hint: you will probably use google people API)
• Implement signInWithGoogle authentication flow (you can inspire in emailPasswordProvider); Please keep in mind the authentication flow should be possible to implement without using the signInWithGoogle function. It means all helper functions should be calleble from the outside.
• Appropriately export all necessary helper functions, interfaces and signInWithGoogle function

Add apple authentication provider

Add a new signInWithApple functionality and authentication flow.

• You can use verify-apple-id-token package

Fix Deploy step

• Set GH pages token and fix deploy
• Publish package to NPM (https://github.com/marketplace/actions/publish-to-npm)
• Change

on:
  push:
    branches: [ master ]

to

on:
  push:
    tags: [ '*' ]

Add facebook authentication provider

Add a new signInWithFacebook functionality and authentication flow.

What to do?

• Create new facebookProvider file under providers folder
• Design FacebookProviderOptions interface - which data you need to successfully authenticate / register the user? Which data is optional / required? (hint: you will probably use FB graph /me endpoint)
• Implement signInWithFacebook authentication flow (you can inspire in emailPasswordProvider); Please keep in mind the authentication flow should be possible to implement without using the signInWithFacebook function. It means all helper functions should be callable from the outside.
• Appropriately export all necessary helper functions, interfaces and signInWithFacebook function

Add token verification tests

There is a function called verifyToken which validates JWT token and returns user object. We need to add tests for this function.