templates

package

v2.42.4 Latest Latest Go to latest Published: Feb 16, 2026 License: Apache-2.0 Imports: 10 Imported by: 1

Details

Package templates contains data-driven templates for path layouts.

Templates can use functions from the github.com/Masterminds/sprig library. All templates are cleaned with path.Clean().

This section is empty.

This section is empty.

func Base(tpl string) string

Base returns the base path for the given template string.

func WithResourceInfo(i *providerv1beta1.ResourceInfo, tpl string) string

WithResourceInfo renders template stings with ResourceInfo variables

func WithSpacePropertiesAndUser(u *userpb.User, spaceType string, spaceName string, spaceID string, tpl string) string

WithSpacePropertiesAndUser generates a layout based on user data and a space type.

func WithUser(u *userpb.User, tpl string) string

WithUser generates a layout based on user data.

type EmailData struct {
	Local  string
	Domain string
}

EmailData contains mail data split into local and domain part. It is extracted from splitting the username by @.

type ResourceData struct {
	ResourceInfo *providerv1beta1.ResourceInfo
	ResourceID   string
}

ResourceData contains the ResourceInfo ResourceData.ResourceID is a stringified form of ResourceInfo.Id

type SpaceData struct {
	*UserData
	SpaceType string
	SpaceName string
	SpaceId   string
}

SpaceData contains the templace placeholders for a space. For example {{.SpaceName}} {{.SpaceType}} or {{.User.Id.OpaqueId}}

type UserData struct {
	*userpb.User
	Email EmailData
}

UserData contains the template placeholders for a user. For example {{.Username}} or {{.Id.Idp}}