types.ts

import { EmailAdapter } from 'adminforth';
import  {type PluginsCommonOptions } from "adminforth";


export interface PluginOptions extends PluginsCommonOptions {

  /**
   * Field name in auth resource which contains email
   */
  emailField: string;

  /**
   * To work properly, this plugin requires a virtual password field in auth resource,
   * which will define any constraints which determine the password strength (regex, minLength).
   * When user will enter passowrd, it will be validated against this field constraints
   * If you don't need it in backoffice itself, you can add it and set showIn = []
   */
  passwordField: string;

  /**
   * Non-virtual field name in auth resource which contains password hash
   */
  passwordHashField: string;

  /**
   * Default which will be assigned to user by default
   * e.g. can be used to set default role
   */
  defaultFieldValues?: {
    [key: string]: any;
  }




  /**
   * If not set user will not be asked for email confirmation (might be dangerous)
   */
  confirmEmails?: { 

    /**
     * A boolean field in auth resource which will be set to true when email is confirmed.
     * Must have boolean type.
     */
    emailConfirmedField: string;

    /**
     * From which email to send password reset emails
     * e.g. no-reply@example.com
     * Example.com must be allowed in provider to send emails
     */
    sendFrom: string;

    /**
     * Adapter to send emails
     */
    adapter: EmailAdapter;
  }


  /**
   * Hooks to be executed before and after user is created
   */
  hooks?: {
    beforeUserSave?: any;
    afterUserSave?: any;
  }
  
  /**
   * Signup component order inder login button
   */
  loginPageComponentOrder?: number;

   /**
   * The origin(s) (scheme + host + optional port) of the admin panel that are
   * allowed to appear in password reset links, e.g. "https://admin.example.com".
   */
  expectedOrigin: string | string[];

}