cwbiechotoolkit

type AuthorizeCustomClaims struct {
	AuthrorizedParty  string         `json:"azp,omitempty"`
	ResourceAccess    map[string]any `json:"resource_access,omitempty"`
	PreferredUsername string         `json:"preferred_username,omitempty"`
	Name              string         `json:"name,omitempty"`
	GivenName         string         `json:"given_name,omitempty"`
	FamilyName        string         `json:"family_name,omitempty"`
	Subject           string         `json:"sub,omitempty"`
	Audience          []string       `json:"aud,omitempty"`
	// jwt.StandardClaims  // this is for 'aud' that is a string
	jwt.MapClaims // start using this with custom claims
}

type DatabaseTransaction struct {
	// Skipper defines a function to skip middleware.
	// Returning true skips processing the middleware.
	Skipper func(c echo.Context) bool

	// sql query
	SQL *string

	// key used in the default query
	// required when SQL not provided
	Key *string

	// Application Configuration
	Config *any

	// Application Configuration attribute
	ConfigFieldName *string

	// database connection pool
	Connection *pgxpool.Pool
}

type DbConfigurtion struct {
	ID    uuid.UUID `db:"id" json:"id"`
	Key   string    `db:"key" json:"key"`
	Value string    `db:"value" json:"value"`
	Type  string    `db:"type" json:"type"`
}

type JwtAuthenticateConfig struct {
	// Skipper defines a function to skip middleware
	// Returning true skips processing the middleware.
	Skipper func(c echo.Context) bool

	// ApplicationKey is the key to validate the application
	ApplicationKey string

	// PublicKeyRaw is the public key to validate the token
	PublicKeyRaw string

	// PublicKey is the public key to validate the token as rsa.PublicKey
	// This is typically set by the middleware
	PublicKey *rsa.PublicKey

	// TokenRoles is the role(s) from the token
	TokenRoles []any

	// SigningMethod is the signing method for the token algorithm
	// Determined from the token
	SigningMethod string
}

type ResourceAccessConfig struct {
	// Skipper defines a function to skip middleware.
	// Returning true skips processing the middleware.
	Skipper func(c echo.Context) bool

	// Roles is the list of roles to authorize
	Roles []string

	// Role separator.
	// Optional.  Default value ""
	RoleSeparator string

	// Typically the office of the user defined in routes
	Scope string

	// Scope Variable
	// Optional.  Default value "symbol"
	ScopeVariable string

	// ScopeFromContext func to get the scope
	// Typically from the route and is most likely an office symbol
	ScopeFromContext func(c echo.Context, scopeVariable string) string

	// Context key.  Use this if jwtAuth sets something different than 'user'
	// Optional.  Default value "user"
	ContextKey string

	// Claims.
	Claims AuthorizeCustomClaims
}

type S3StaticConfig struct {
	// Skipper defines a function to skip middleware. Returning true skips processing
	// the middleware.
	Skipper func(c echo.Context) bool

	// Aws Configuration
	// Required.
	AwsConfig aws.Config

	// S3 bucket.
	// Required.
	Bucket string `yaml:"bucket"`

	// Allows you to enable the client to use path-style addressing, i.e.,
	// https://s3.amazonaws.com/BUCKET/KEY . By default, the S3 client will use virtual
	// hosted bucket addressing when possible( https://BUCKET.s3.amazonaws.com/KEY ).
	UsePathStyle bool

	// Prefix limits the response to keys that begin with the specified prefix.
	// Optional. Default value "/"
	Prefix string `yaml:"prefix"`

	// PrefixFunc is a function that returns the prefix to use for the request.
	PrefixFunc func(c echo.Context) string `yaml:"prefixfunc"`

	// IgnoreBase is a regexp to ignore
	// Optional.
	IgnoreBaseRegex string `yaml:"ignorebaseregex"`

	// Index file for serving content.
	// Optional. Default value "index.html".
	Index string `yaml:"index"`
}