scene

package
v1.0.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 20, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Scene provides well structured template contexts and functionality for HTML template rendering. We chose the word "scene" to represent the context since "context" is an overloaded term and milieu was too hard to spell.

Index

Constants

View Source 
const (
	Version         = "Version"
	ShortVersion    = "ShortVersion"
	Page            = "Page"
	IsAuthenticated = "IsAuthenticated"
	User            = "User"
	APIData         = "APIData"
	SunriseEnabled  = "SunriseEnabled"
)

Keys for default Scene context items

View Source 
const (
	RoleAdmin      = "Admin"
	RoleCompliance = "Compliance"
	RoleObserver   = "Observer"
)

Role string constants

Variables

This section is empty.

Functions

func WithConf added in v0.28.0 

func WithConf(conf *config.Config)

Types

type AddressComponents added in v0.28.0 

type AddressComponents struct {
	AddressType    string
	AddressLine0   string
	AddressLine1   string
	AddressLine2   string
	AddressCountry string
}

type Error added in v1.0.0 

type Error struct {
	Scene
	Error        string
	SupportEmail string
	Support      string
}

func (*Error) WithEmail added in v1.0.0 

func (s *Error) WithEmail(email string) *Error

type IVMS101 added in v0.28.0 

type IVMS101 struct {
	Originator      Person
	OriginatorVASP  VASP
	Beneficiary     Person
	BeneficiaryVASP VASP
}

IVMS101 is a struct that represents the complex IVMS101 data as a flattened struct with only the data that is required by our web application.

type NationalIdentifier added in v0.28.0 

type NationalIdentifier struct {
	Identifier            string
	TypeRepr              string
	TypeCode              string
	CountryOfIssue        string
	RegistrationAuthority string
}

type Person added in v0.28.0 

type Person struct {
	AddressComponents
	Forename            string
	Surname             string
	PrimaryAddress      *ivms101.Address
	PrimaryAddressLines []string
	CustomerNumber      string
	NationalIdentifier  NationalIdentifier
	DateOfBirth         string
	PlaceOfBirth        string
	CountryOfResidence  string
}

func (Person) FullName added in v1.0.0 

func (p Person) FullName() string

type Prepared added in v1.0.0 

type Prepared struct {
	Routing *api.Routing
	// contains filtered or unexported fields
}

func (Prepared) Beneficiary added in v1.0.0 

func (s Prepared) Beneficiary() Person

func (Prepared) BeneficiaryVASP added in v1.0.0 

func (s Prepared) BeneficiaryVASP() VASP

func (Prepared) IdentityJSON added in v1.0.0 

func (s Prepared) IdentityJSON() string

func (Prepared) OriginatingVASP added in v1.0.0 

func (s Prepared) OriginatingVASP() VASP

func (Prepared) Originator added in v1.0.0 

func (s Prepared) Originator() Person

func (Prepared) RoutingJSON added in v1.0.0 

func (s Prepared) RoutingJSON() string

func (Prepared) TransactionJSON added in v1.0.0 

func (s Prepared) TransactionJSON() string

func (Prepared) Transfer added in v1.0.0 

func (s Prepared) Transfer() Transfer

type Scene 

type Scene map[string]interface{}

func New 

func New(c *gin.Context) Scene

func (Scene) APIKeyDetail added in v0.24.1 

func (s Scene) APIKeyDetail() *api.APIKey

func (Scene) APIKeysList added in v0.24.1 

func (s Scene) APIKeysList() *api.APIKeyList

func (Scene) AccountDetail added in v0.19.0 

func (s Scene) AccountDetail() *api.Account

func (Scene) AccountPerson added in v1.0.0 

func (s Scene) AccountPerson() Person

func (Scene) AccountsList 

func (s Scene) AccountsList() *api.AccountsList

func (Scene) CounterpartyDetail added in v0.25.0 

func (s Scene) CounterpartyDetail() *api.Counterparty

func (Scene) CounterpartyList 

func (s Scene) CounterpartyList() *api.CounterpartyList

func (Scene) CreateAPIKey added in v0.24.1 

func (s Scene) CreateAPIKey() *api.APIKey

func (Scene) Envelope added in v0.28.0 

func (s Scene) Envelope() *api.Envelope

func (Scene) EnvelopeList added in v1.0.0 

func (s Scene) EnvelopeList() *api.EnvelopesList

func (Scene) Error added in v1.0.0 

func (s Scene) Error(err error) *Error

Return the simplified/flattened IVMS101 identity representation if an Envelope has been set as the APIData in the Scene.

func (Scene) GetUser 

func (s Scene) GetUser() *auth.Claims

func (Scene) HasRole 

func (s Scene) HasRole(role string) bool

func (Scene) IVMS101 added in v0.28.0 

func (s Scene) IVMS101() *IVMS101

Return the simplified/flattened IVMS101 identity representation if an Envelope has been set as the APIData in the Scene.

func (Scene) IsAdmin 

func (s Scene) IsAdmin() bool

func (Scene) IsAuthenticated 

func (s Scene) IsAuthenticated() bool

func (Scene) IsViewOnly 

func (s Scene) IsViewOnly() bool

func (Scene) Prepared added in v1.0.0 

func (s Scene) Prepared() Prepared

func (Scene) TransactionCounts added in v1.0.0 

func (s Scene) TransactionCounts() *models.TransactionCounts

func (Scene) TransactionDetail added in v0.19.0 

func (s Scene) TransactionDetail() *Transaction

func (Scene) TransactionsList added in v0.19.0 

func (s Scene) TransactionsList() *TransactionList

func (Scene) Update 

func (s Scene) Update(o Scene) Scene

func (Scene) UserDetail added in v1.0.0 

func (s Scene) UserDetail() *api.User

func (Scene) UserList 

func (s Scene) UserList() *api.UserList

func (Scene) WithAPIData 

func (s Scene) WithAPIData(data interface{}) Scene

type Status added in v1.0.0 

type Status struct {
	Color   string
	Tooltip string
	// contains filtered or unexported fields
}

Status wraps a Transaction status to provide additional information such as class, tooltip, color, icons, etc for the UI.

func NewStatus added in v1.0.0 

func NewStatus(text string) Status

func (Status) ActionRequired added in v1.0.0 

func (s Status) ActionRequired() bool

func (Status) Opacity added in v1.0.0 

func (s Status) Opacity() string

func (Status) Repair added in v1.0.0 

func (s Status) Repair() bool

func (Status) Review added in v1.0.0 

func (s Status) Review() bool

func (Status) String added in v1.0.0 

func (s Status) String() string

func (Status) Wait added in v1.0.0 

func (s Status) Wait() bool

type Transaction added in v1.0.0 

type Transaction struct {
	api.Transaction
	Status Status
}

Wraps an *api.Transaction to provide additional UI-specific functionality.

type TransactionList added in v1.0.0 

type TransactionList struct {
	Page         *api.TransactionListQuery
	Transactions []*Transaction
}

Converted from an *api.TransactionList to provide additional UI-specific functionality.

type Transfer added in v1.0.0 

type Transfer struct {
	Originator   string
	Beneficiary  string
	Amount       float64
	VirtualAsset string
	AssetType    string
	TxID         string
	Tag          string
}

type VASP added in v0.28.0 

type VASP struct {
	AddressComponents
	LegalName             string
	PrimaryAddress        *ivms101.Address
	PrimaryAddressLines   []string
	CustomerNumber        string
	CountryOfRegistration string
	NationalIdentifier    NationalIdentifier
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.