piral-auth/src/create.ts

Plugin for handling authentication in Piral.

import * as actions from './actions';
import { PiralPlugin } from 'piral-core';
import { PiletAuthApi, UserInfo } from './types';

/**
 * Available configuration options for the auth plugin.
 */
export interface AuthConfig {
  /**
   * Gets the current user, if any.
   */
  user?: UserInfo;
}

/**
 * Creates new Pilet API extensions for enabling authentication support.
 */
export function createAuthApi(config: AuthConfig = {}): PiralPlugin<PiletAuthApi> {
  const { user } = config;

  return (context) => {
    context.defineActions(actions);

    context.dispatch((state) => ({
      ...state,
      user,
    }));

    return {
      getUser() {
        return context.readState((state) => state.user);
      },
    };
  };
}