faroe

type ActionErrorLoggerInterface interface {
	LogActionError(timestamp time.Time, message string, actionInvocationId string, action string)
}

type ActionInvocationEndpointClientInterface interface {
	// Sends a request to an action invocation endpoint with the request body.
	// Returns the string body of a 200 response.
	// An error is returned if a 200 response could be received (after one or several attempts).
	SendActionInvocationEndpointRequest(body string) (string, error)
}

type ClockInterface interface {
	// Returns the current time.
	Now() time.Time
}

type EmailAddressCheckerInterface interface {
	// Returns true, nil if the email address is allowed and false, nil if not.
	CheckEmailAddress(emailAddress string) (bool, error)
}

type EmailSenderInterface interface {
	// Send an email to emailAddress.
	SendSignupEmailAddressVerificationCode(emailAddress string, emailAddressVerificationCode string) error

	// Send an email to emailAddress.
	// displayName may be an empty string.
	SendUserEmailAddressUpdateEmailVerificationCode(emailAddress string, displayName string, emailAddressVerificationCode string) error

	// Send an email to emailAddress.
	// displayName may be an empty string.
	SendUserPasswordResetTemporaryPassword(emailAddress string, displayName string, temporaryPassword string) error

	// Send an email to emailAddress.
	// displayName may be an empty string.
	SendUserSignedInNotification(emailAddress string, displayName string, timestamp time.Time) error

	// Send an email to emailAddress.
	// displayName may be an empty string.
	SendUserEmailAddressUpdatedNotification(emailAddress string, displayName string, newEmailAddress string, timestamp time.Time) error

	// Send an email to emailAddress.
	// displayName may be an empty string.
	SendUserPasswordUpdatedNotification(emailAddress string, displayName string, timestamp time.Time) error
}

type PasswordHashAlgorithmInterface interface {
	// A unique identifier of this algorithm.
	Id() string

	SaltSize() int

	Hash(password string, salt []byte) ([]byte, error)
}

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

type SessionConfigStruct struct {
	// A non-zero, positive value. Defines how long an inactive session remains valid.
	InactivityTimeout time.Duration

	// A non-zero, positive value. Defines how often session activity is recorded.
	ActivityCheckInterval time.Duration

	// Positive value. 0 if disabled
	Expiration time.Duration

	// Positive value. 0 if disabled
	UserCacheExpiration time.Duration
}

type StorageInterface interface {
	// Retrieves the value and counter associated with the given key
	// Returns [ErrStorageEntryNotFound] if the key doesn't exist.
	// An error is returned for any other failure.
	Get(key string) ([]byte, int32, error)

	// Stores the value under the given key.
	// The counter is set to 0.
	// expiresAt is just a soft expiration hint.
	// There is no requirement for the entry to be immediately deleted or considered invalid after expiration.
	// Returns [ErrStorageEntryAlreadyExists] if the key already exists.
	// An error is returned for any other failure.
	Add(key string, value []byte, expiresAt time.Time) error

	// Updates the value and TTL for the given key if the counter matches.
	// expiresAt is just a soft expiration hint.
	// There is no requirement for the entry to be immediately deleted or considered invalid after expiration.
	// Returns [ErrStorageEntryNotFound] if the key doesn't exist or the counter doesn't match.
	// An error is returned for any other failure.
	Update(key string, value []byte, expiresAt time.Time, counter int32) error

	// Removes the value associated with the given key.
	// Returns [ErrStorageEntryNotFound] if the key doesn't exist.
	// An error is returned for any other failure.
	Delete(key string) error
}

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

type UserStoreInterface interface {
	// Creates a new user. The email address should be stored as-is, with the casing preserved.
	// The email address counter, password hash counter, disabled counter, and sessions counter should be set to 0.
	// Returns the created user if successful.
	// Returns [ErrUserStoreUserEmailAddressAlreadyUsed] if the email address is already tied to another user.
	// An error is returned for any other failure.
	CreateUser(emailAddress string, passwordHash []byte, passwordHashAlgorithmId string, passwordSalt []byte) (UserStruct, error)

	// Gets a user.
	// Returns [ErrUserStoreUserNotFound] if a user doesn't exist.
	// An error is returned for any other failure.
	GetUser(userId string) (UserStruct, error)

	// Gets a user by email address.
	// The email address must match exactly, including letter casing.
	// Returns [ErrUserStoreUserNotFound] if a user doesn't exist.
	// An error is returned for any other failure.
	GetUserByEmailAddress(emailAddress string) (UserStruct, error)

	// Updates a user's email address and increment a user's email address counter if the email address counter matches.
	// The new email address should be stored as-is, with the casing preserved.
	// Returns [ErrUserStoreUserNotFound] if a user doesn't exist or the user's email address counter doesn't match.
	// Returns [ErrUserStoreUserEmailAddressAlreadyUsed] if the email address is already tied to another user.
	// An error is returned for any other failure.
	UpdateUserEmailAddress(userId string, emailAddress string, userEmailAddressCounter int32) error

	// Updates a user's password hash, password hash algorithm ID, and password salt,
	// as well as increment a user's email address counter, if the user password hash counter matches.
	// Returns [ErrUserStoreUserNotFound] if a user doesn't exist or the user's password hash counter doesn't match.
	// An error is returned for any other failure.
	UpdateUserPasswordHash(userId string, passwordHash []byte, passwordHashAlgorithmId string, passwordSalt []byte, userPasswordHashCounter int32) error

	// Increments a user's sessions counter if the user's sessions counter matches.
	// Returns [ErrUserStoreUserNotFound] if a user doesn't exist or the user's sessions counter doesn't match.
	// An error is returned for any other failure.
	IncrementUserSessionsCounter(userId string, userSessionsCounter int32) error

	// Deletes a user.
	// Returns [ErrUserStoreUserNotFound] if a user doesn't exist.
	// An error is returned for any other failure.
	DeleteUser(userId string) error
}

type UserStruct struct {
	// A unique ID.
	Id string

	// A unique email address.
	EmailAddress string

	PasswordHash []byte

	PasswordSalt []byte

	PasswordHashAlgorithmId string

	Disabled bool

	// An empty string if not defined.
	DisplayName string

	EmailAddressCounter int32

	PasswordHashCounter int32

	DisabledCounter int32

	SessionsCounter int32
}