@zeushq/nextjs-zidentity/src/handlers/auth.ts

Next.js SDK for signin in with Zeus Identity

import { HandleLogin } from './login';
import { HandleLogout } from './logout';
import { HandleCallback } from './callback';
import { HandleProfile } from './profile';
import { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';

/**
 * If you want to add some custom behavior to the default auth handlers, you can pass in custom handlers for
 * `login`, `logout`, `callback` and `profile` eg
 *
 * ```js
 * // pages/api/auth/[...zidentity].js
 * import { handleAuth, handleLogin } from '@zeushq/nextjs-zidentity';
 * import { errorReporter, logger } from '../../../utils';
 *
 * export default handleAuth({
 *   async login(req, res) {
 *     try {
 *        // Pass in custom params to your handler
 *       await handleLogin(req, res, { authorizationParams: { customParam: 'foo' } });
 *       // Add your own custom logging.
 *       logger('Redirecting to login');
 *     } catch (error) {
 *       // Add you own custom error logging.
 *       errorReporter(error);
 *       res.status(error.status || 500).end(error.message);
 *     }
 *   }
 * });
 * ```
 *
 * @category Server
 */
export interface Handlers {
  login: HandleLogin;
  logout: HandleLogout;
  callback: HandleCallback;
  profile: HandleProfile;
}

/**
 * The main way to use the server SDK.
 *
 * Simply set the environment variables per {@link Config} then create the file `pages/api/auth/[...zidentity].js`, eg
 *
 * ```js
 * // pages/api/auth/[...zidentity].js
 * import { handleAuth } from '@zeushq/nextjs-zidentity';
 *
 * export default handleAuth();
 * ```
 *
 * This will create 4 handlers for the following urls:
 *
 * - `/api/auth/login`: log the user in to your app by redirecting them to your Identity Provider.
 * - `/api/auth/callback`: The page that your Identity Provider will redirect the user back to on login.
 * - `/api/auth/logout`: log the user out of your app.
 * - `/api/auth/me`: View the user profile JSON (used by the {@link UseUser} hook)
 *
 * @category Server
 */
export type HandleAuth = (userHandlers?: Partial<Handlers>) => NextApiHandler;

/**
 * @ignore
 */
const wrapErrorHandling =
  (fn: NextApiHandler): NextApiHandler =>
    async (req: NextApiRequest, res: NextApiResponse): Promise<void> => {
      try {
        await fn(req, res);
      } catch (error: any) {
        console.error(error);
        res.status(error.status || 500).end(error.message);
      }
    };

/**
 * @ignore
 */
export default function handlerFactory({
  handleLogin,
  handleLogout,
  handleCallback,
  handleProfile
}: {
  handleLogin: HandleLogin;
  handleLogout: HandleLogout;
  handleCallback: HandleCallback;
  handleProfile: HandleProfile;
}): HandleAuth {
  return (userHandlers: Partial<Handlers> = {}): NextApiHandler => {
    const { login, logout, callback, profile } = {
      login: wrapErrorHandling(handleLogin),
      logout: wrapErrorHandling(handleLogout),
      callback: wrapErrorHandling(handleCallback),
      profile: wrapErrorHandling(handleProfile),
      ...userHandlers
    };
    return async (req, res): Promise<void> => {
      let {
        query: { zidentity: route }
      } = req;

      route = Array.isArray(route) ? route[0] : route;

      switch (route) {
        case 'login':
          return login(req, res) as any;
        case 'signup':
          return login(req, res, { authorizationParams: { signup: true } }) as any;
        case 'logout':
          return logout(req, res) as any;
        case 'callback':
          return callback(req, res) as any;
        case 'me':
          return profile(req, res) as any;
        default:
          res.status(404).end();
      }
    };
  };
}