messageHelpers

README

messageHelpers

messageHelpers defines shared message types for inter-service communication — user, session, behaviour, authority, and translation messages.

Types

Type	Description
UserMessage	User identity payload with Key, Code, Source, Locale, Theme, Timezone, Role, and Payload fields
SessionMessage	Session payload with SessionID, Expiry, User, Token, Locale, and Payload fields
BehaviourMessage	Behaviour/action payload with Key, Source, and Payload fields
AuthorityMessage	Authority envelope with Key, User, Behaviour, Payload, and Source fields
GrantMessage	Grant request/response containing User and Behaviour
RevokeMessage	Revoke request/response containing User and Behaviour
DeclareMessage	Domain behaviour declaration with Domain and Behaviour fields
TranslationMessage	Translation request/response with Text, Locale, Origin, Translation, and Payload fields

Methods

Each message type provides Request(...) and Response(...) builder methods.

• UserMessage and BehaviourMessage also have Validate(*log.Logger) error
• TranslationMessage has ReponseWithPayload(...) for payload-carrying responses

Example

import "github.com/mt1976/frantic-core/messageHelpers"

func main() {
    user := messageHelpers.UserMessage{}.Request("key", "code", "source")
    session := messageHelpers.SessionMessage{}.Request("sessionID", time.Now(), user)
    _ = session
}

Documentation

Overview

Package messageHelpers defines shared message types used between services and application components.

Index

• type AuthorityMessage
• type BehaviourMessage
  • func (m *BehaviourMessage) Validate(log *log.Logger) error
• type DeclareMessage
  • func (m *DeclareMessage) Request(domain string, behaviour string) DeclareMessage
  • func (m *DeclareMessage) Response(payload any) DeclareMessage
• type GrantMessage
  • func (m *GrantMessage) Request(user UserMessage, behaviour BehaviourMessage) GrantMessage
  • func (m *GrantMessage) Response(payload any) GrantMessage
• type RevokeMessage
  • func (m *RevokeMessage) Request(user UserMessage, behaviour BehaviourMessage) RevokeMessage
  • func (m *RevokeMessage) Response(payload any) RevokeMessage
• type SessionMessage
  • func (m *SessionMessage) Request(sessionID string, expiry time.Time, user UserMessage) SessionMessage
  • func (m *SessionMessage) Response(payload any) SessionMessage
• type TranslationMessage
  • func (m *TranslationMessage) ReponseWithPayload(translation string, payload any) TranslationMessage
  • func (m *TranslationMessage) Request(text string, locale string, origin string) TranslationMessage
  • func (m *TranslationMessage) Response(translation string) TranslationMessage
• type UserMessage
  • func (m *UserMessage) Request(key, code, source, locale, theme, timezone, role string) UserMessage
  • func (m *UserMessage) Response(payload any) UserMessage
  • func (m *UserMessage) Validate(log *log.Logger) error

Types

type AuthorityMessage

type AuthorityMessage struct {
	Key       string           `json:"Key"`
	User      UserMessage      `json:"User"`
	Behaviour BehaviourMessage `json:"Behaviour"`
	Payload   any              `json:"Payload"`
	Source    string           `json:"Source"`
}

type BehaviourMessage

type BehaviourMessage struct {
	Key     string `json:"Key"`
	Source  string `json:"Source"`
	Payload any    `json:"Payload"`
}

func (*BehaviourMessage) Validate

func (m *BehaviourMessage) Validate(log *log.Logger) error

type DeclareMessage

type DeclareMessage struct {
	Domain    string           `json:"Domain"`
	Behaviour BehaviourMessage `json:"Behaviour"`
}

func (*DeclareMessage) Request

func (m *DeclareMessage) Request(domain string, behaviour string) DeclareMessage

func (*DeclareMessage) Response

func (m *DeclareMessage) Response(payload any) DeclareMessage

type GrantMessage

type GrantMessage struct {
	User      UserMessage      `json:"User"`
	Behaviour BehaviourMessage `json:"Behaviour"`
}

func (*GrantMessage) Request

func (m *GrantMessage) Request(user UserMessage, behaviour BehaviourMessage) GrantMessage

func (*GrantMessage) Response

func (m *GrantMessage) Response(payload any) GrantMessage

type RevokeMessage

type RevokeMessage struct {
	User      UserMessage      `json:"User"`
	Behaviour BehaviourMessage `json:"Behaviour"`
}

func (*RevokeMessage) Request

func (m *RevokeMessage) Request(user UserMessage, behaviour BehaviourMessage) RevokeMessage

func (*RevokeMessage) Response

func (m *RevokeMessage) Response(payload any) RevokeMessage

type SessionMessage

type SessionMessage struct {
	SessionID    string      `json:"SessionID"`
	Expiry       time.Time   `json:"Expiry"`
	UserKey      string      `json:"UserKey"`
	UserCode     string      `json:"UserCode"`
	SessionToken any         `json:"SessionToken"`
	User         UserMessage `json:"User"`
	Payload      any         `json:"Payload"`
	Locale       string      `json:"Locale"`
	Spare1       string      `json:"Spare1"`
	Spare2       string      `json:"Spare2"`
}

func (*SessionMessage) Request

func (m *SessionMessage) Request(sessionID string, expiry time.Time, user UserMessage) SessionMessage

func (*SessionMessage) Response

func (m *SessionMessage) Response(payload any) SessionMessage

type TranslationMessage

type TranslationMessage struct {
	Text        string `json:"Text"`
	Locale      string `json:"Locale"`
	Origin      string `json:"Origin"`
	Translation string `json:"Translation"`
	Payload     any    `json:"Payload"`
}

func (*TranslationMessage) ReponseWithPayload

func (m *TranslationMessage) ReponseWithPayload(translation string, payload any) TranslationMessage

func (*TranslationMessage) Request

func (m *TranslationMessage) Request(text string, locale string, origin string) TranslationMessage

func (*TranslationMessage) Response

func (m *TranslationMessage) Response(translation string) TranslationMessage

type UserMessage

type UserMessage struct {
	Key      string `json:"Key"`
	Code     string `json:"Code"`
	Payload  any    `json:"Payload"`
	Source   string `json:"Source"`
	Locale   string `json:"Locale"`
	Theme    string `json:"Theme"`
	Timezone string `json:"Timezone"`
	Role     string `json:"Role"`
	Spare0   string `json:"Spare0"`
	Spare1   string `json:"Spare1"`
	Spare2   string `json:"Spare2"`
}

func (*UserMessage) Request

func (m *UserMessage) Request(key, code, source, locale, theme, timezone, role string) UserMessage

func (*UserMessage) Response

func (m *UserMessage) Response(payload any) UserMessage

func (*UserMessage) Validate

func (m *UserMessage) Validate(log *log.Logger) error