lastloginmethod

type BeforeStoreCookieFunc func(ctx context.Context, r *http.Request, method string) (bool, error)

type Config struct {
	// CookieName specifies the key for storing the last used login method cookie.
	// Default: "modular-auth.last_used_login_method"
	CookieName string

	// MaxAge specifies the cookie duration.
	// Default: 30 days
	MaxAge time.Duration

	// Domain specifies the cookie domain.
	Domain string

	// Path specifies the cookie path. Default: "/"
	Path string

	// SameSite specifies the cookie SameSite attribute. Default: http.SameSiteLaxMode
	SameSite http.SameSite

	// Secure specifies whether the cookie requires HTTPS. Default: false
	Secure bool

	// StoreInDatabase specifies whether the resolved login method should also be persisted in the DB via Repository.
	// Default: false
	StoreInDatabase bool

	// CustomRoutes specifies custom path-to-method mappings (e.g. "/auth/sso/callback" -> "saml").
	CustomRoutes map[string]string

	// DisableDefaultRoutes specifies whether built-in route heuristics should be disabled.
	DisableDefaultRoutes bool

	// CustomResolver is an optional custom resolver function for inferring login methods from requests.
	CustomResolver ResolveMethodFunc

	// BeforeStoreCookie is an optional GDPR consent check callback before issuing the cookie.
	BeforeStoreCookie BeforeStoreCookieFunc
}

type LastLoginMethodEventPayload struct {
	UserID       string         `json:"userId,omitempty"`
	Method       string         `json:"method"`
	CookieStored bool           `json:"cookieStored"`
	DBStored     bool           `json:"dbStored"`
	Extra        map[string]any `json:"extra,omitempty"`
}

type MemoryRepository struct {
	// contains filtered or unexported fields
}

type Option func(*Config)

type Plugin struct {
	// contains filtered or unexported fields
}

type Repository interface {
	// UpdateLastLoginMethod persists the authentication method used by the specified user.
	//
	// Function:
	//   Called after successful user authentication to store the last used login method (e.g. "email_password", "passkey", "google").
	//
	// Storage:
	//   Database (GORM / SQL) - Updates last_login_method column on users table.
	//
	// Arguments:
	//   - ctx: Request cancellation context.
	//   - userID: Target user primary key ID.
	//   - method: Identifier string of the login method used.
	//
	// Returns:
	//   - error: Nil on success, ErrUserNotFound if missing, or database error.
	//
	// Example SQL:
	//   UPDATE users SET last_login_method = $1, updated_at = NOW() WHERE id = $2;
	UpdateLastLoginMethod(ctx context.Context, userID string, method string) error

	// GetLastLoginMethod retrieves the last used authentication method for the specified user.
	//
	// Function:
	//   Used to pre-select or highlight the user's preferred login method on sign-in screens.
	//
	// Storage:
	//   Database (GORM / SQL) - Query last_login_method column by user ID.
	//
	// Arguments:
	//   - ctx: Request cancellation context.
	//   - userID: Target user primary key ID.
	//
	// Returns:
	//   - string: Method identifier string if set (e.g. "email_password", "passkey", "google").
	//   - error: Nil on success, ErrUserNotFound if missing, or database error.
	//
	// Example SQL:
	//   SELECT last_login_method FROM users WHERE id = $1 LIMIT 1;
	GetLastLoginMethod(ctx context.Context, userID string) (string, error)
}

type ResolveMethodFunc func(ctx context.Context, r *http.Request) (string, bool)

type SetLastLoginMethodParams struct {
	UserID string `json:"userId"`
	Method string `json:"method"`
}