authelia/internal/templates/types.go

package templates

import (
	th "html/template"
	"io"
	tt "text/template"
)

// Templates is the struct which holds all the *template.Template values.
type Templates struct {
	notification NotificationTemplates
	asset        AssetTemplates
	oidc         OpenIDConnectTemplates
}

type OpenIDConnectTemplates struct {
	formpost *th.Template
}

// AssetTemplates are templates for specific key assets.
type AssetTemplates struct {
	index *tt.Template
	api   OpenAPIAssetTemplates
}

// OpenAPIAssetTemplates are asset templates for the OpenAPI specification.
type OpenAPIAssetTemplates struct {
	index *tt.Template
	spec  *tt.Template
}

// NotificationTemplates are the templates for the notification system.
type NotificationTemplates struct {
	reset *EmailTemplate
	event *EmailTemplate
	otp   *EmailTemplate
}

// Template covers shared implementations between the text and html template.Template.
type Template interface {
	Execute(wr io.Writer, data any) error
	ExecuteTemplate(wr io.Writer, name string, data any) error
	Name() string
	DefinedTemplates() string
}

// Config for the Provider.
type Config struct {
	EmailTemplatesPath string
}

// EmailTemplate is the template type which contains both the html and txt versions of a template.
type EmailTemplate struct {
	HTML *th.Template
	Text *tt.Template
}

// EmailEventValues are the values used for event templates.
type EmailEventValues struct {
	Title       string
	DisplayName string
	Details     map[string]any
	RemoteIP    string
}

// EmailOneTimePasswordValues are the values used for the one time password template.
type EmailOneTimePasswordValues struct {
	Title           string
	DisplayName     string
	RemoteIP        string
	Identifier      string
	OneTimePassword string
}

// EmailPasswordResetValues are the values used for the password reset template.
type EmailPasswordResetValues struct {
	DisplayName string
	RemoteIP    string
	LinkURL     string
	LinkText    string
}