feedlib

type Action struct {
	// A unique identifier for each action
	ID string `json:"id" firestore:"id"`

	// A higher sequence number means that it came later
	SequenceNumber int `json:"sequenceNumber" firestore:"sequenceNumber"`

	// A friendly name for the action; rich text with Unicode, can have emoji
	Name string `json:"name" firestore:"name"`

	// A link to a PNG image that would serve as an avatar
	Icon Link `json:"icon" firestore:"icon"`

	// Action types are: primary, secondary, overflow and floating
	// Primary actions get dominant visual treatment;
	// secondary actions less so;
	// overflow actions are hidden;
	// floating actions are material FABs
	ActionType ActionType `json:"actionType" firestore:"actionType"`

	// How the action should be handled e.g inline or full page.
	// This is a hint for frontend logic.
	Handling Handling `json:"handling" firestore:"handling"`

	// indicated whether this action should or can be triggered by na anoymous user
	AllowAnonymous bool `json:"allowAnonymous" firestore:"allowAnonymous"`
}

type ActionType string

type BooleanFilter string

type Channel string

type Context struct {
	// the system or human user that created this event
	UserID string `json:"userID" firestore:"userID"`

	// the flavour of the feed/app that originated this event
	Flavour Flavour `json:"flavour" firestore:"flavour"`

	// the client (organization) that this user belongs to
	OrganizationID string `json:"organizationID" firestore:"organizationID"`

	// the location (e.g branch) from which the event was sent
	LocationID string `json:"locationID" firestore:"locationID"`

	// when this event was sent
	Timestamp time.Time `json:"timestamp" firestore:"timestamp"`
}

type Element interface {
	ValidateAndUnmarshal(b []byte) error
	ValidateAndMarshal() ([]byte, error)
}

type Event struct {
	// A unique identifier for each action
	ID string `json:"id" firestore:"id"`

	// An event name - two upper case words separated by an underscore
	Name string `json:"name" firestore:"name"`

	// Technical metadata - when/where/why/who/what/how etc
	Context Context `json:"context,omitempty" firestore:"context,omitempty"`

	// The actual 'business data' carried by the event
	Payload Payload `json:"payload,omitempty" firestore:"payload,omitempty"`
}

type Flavour string

type Handling string

type Item struct {
	// A unique identifier for each feed item
	ID string `json:"id" firestore:"id"`

	// A higher sequence number means that it came later
	SequenceNumber int `json:"sequenceNumber" firestore:"sequenceNumber"`

	// When this feed item should be expired/removed, automatically. RFC3339.
	Expiry time.Time `json:"expiry" firestore:"expiry"`

	// If a feed item is persistent, it also goes to the inbox
	// AND triggers a push notification.
	// Pinning a feed item makes it persistent.
	Persistent bool `json:"persistent" firestore:"persistent"`

	// Whether the task under a feed item is completed, pending etc
	Status Status `json:"status" firestore:"status"`

	// Whether the feed item is to be shown or hidden
	Visibility Visibility `json:"visibility" firestore:"visibility"`

	// A link to a PNG image that would serve as an avatar
	Icon Link `json:"icon" firestore:"icon"`

	// The person - real or robot - that generated this feed item. Rich text.
	Author string `json:"author" firestore:"author"`

	// An OPTIONAL second title line. Rich text.
	Tagline string `json:"tagline" firestore:"tagline"`

	// A label e.g for the queue that this item belongs to
	Label string `json:"label" firestore:"label"`

	// When this feed item was created. RFC3339.
	// This is used to calculate the feed item's age for display.
	Timestamp time.Time `json:"timestamp" firestore:"timestamp"`

	// An OPTIONAL summary line. Rich text.
	Summary string `json:"summary" firestore:"summary"`

	// Rich text that can include any unicode e.g emoji
	Text string `json:"text" firestore:"text"`

	// TextType determines how the frontend will render the text
	TextType TextType `json:"textType" firestore:"textType"`

	// an illustrative image for the item
	Links []Link `json:"links" firestore:"links"`

	// Actions are the primary, secondary and overflow actions associated
	// with a feed item
	Actions []Action `json:"actions,omitempty" firestore:"actions,omitempty"`

	// Conversations are messages and replies around a feed item
	Conversations []Message `json:"conversations,omitempty" firestore:"conversations,omitempty"`

	// Identifiers of all the users that got this message
	Users []string `json:"users,omitempty" firestore:"users,omitempty"`

	// Identifiers of all the groups that got this message
	Groups []string `json:"groups,omitempty" firestore:"groups,omitempty"`

	// How the user should be notified of this new item, if at all
	NotificationChannels []Channel `json:"notificationChannels,omitempty" firestore:"notificationChannels,omitempty"`

	// FeatureImage represents the image associated to a post
	FeatureImage string `json:"feature_image"`
}

type Keys string

type Link struct {
	// A unique identifier for each feed item
	ID string `json:"id" firestore:"id"`

	// A URL at which the video can be accessed.
	// For a private video, the URL should include authentication information.
	URL string `json:"url" firestore:"url"`

	// LinkType of link
	LinkType LinkType `json:"linkType" firestore:"linkType"`

	// name or title of the linked item
	Title string `json:"title" firestore:"title"`

	// details about the linked item
	Description string `json:"description" firestore:"description"`

	// A URL to a PNG image that represents a thumbnail for the item
	Thumbnail string `json:"thumbnail" firestore:"thumbnail"`
}

type LinkType string

type Message struct {
	// A unique identifier for each message on the thread
	ID string `json:"id" firestore:"id"`

	// A higher sequence number means that it came later
	SequenceNumber int `json:"sequenceNumber" firestore:"sequenceNumber"`

	// Rich text that can include any unicode e.g emoji
	Text string `json:"text" firestore:"text"`

	// The unique ID of any message that this one is replying to - a thread
	ReplyTo string `json:"replyTo" firestore:"replyTo"`

	// The UID of the user that posted the message
	PostedByUID string `json:"postedByUID" firestore:"postedByUID"`

	// The UID of the user that posted the message
	PostedByName string `json:"postedByName" firestore:"postedByName"`

	// when this message was sent
	Timestamp time.Time `json:"timestamp" firestore:"timestamp"`
}

type NotificationBody struct {
	// Human readable rich text sent when an item/nudge is published to a user's Feed
	PublishMessage string `json:"publishMessage" firestore:"publishMessage"`

	// Human readable rich text sent when item/nudge is deleted to a user's Feed
	DeleteMessage string `json:"deleteMessage" firestore:"deleteMessage"`

	// Human readable rich text sent when a user does a RESOLVE action
	ResolveMessage string `json:"resolveMessage" firestore:"resolveMessage"`

	// Human readable rich text sent when a user does an UNRESOLVE action
	UnresolveMessage string `json:"unresolveMessage" firestore:"unresolveMessage"`

	// Human readable rich text sent when a user does a SHOW action
	ShowMessage string `json:"showMessage" firestore:"showMessage"`

	// Human readable rich text sent when a user does a HIDE action
	HideMessage string `json:"hideMessage" firestore:"hideMessage"`
}

type Nudge struct {
	// A unique identifier for each nudge
	ID string `json:"id" firestore:"id"`

	// A higher sequence number means that it came later
	SequenceNumber int `json:"sequenceNumber" firestore:"sequenceNumber"`

	// Visibility determines if a nudge should be visible or not
	Visibility Visibility `json:"visibility" firestore:"visibility"`

	// whether the nudge is done (acted on) or pending
	Status Status `json:"status" firestore:"status"`

	// When this nudge should be expired/removed, automatically. RFC3339.
	Expiry time.Time `json:"expiry" firestore:"expiry"`

	// the title (lead line) of the nudge
	Title string `json:"title" firestore:"title"`

	// the text/copy of the nudge
	Text string `json:"text" firestore:"text"`

	// an illustrative image for the nudge
	Links []Link `json:"links" firestore:"links"`

	// actions to include on the nudge
	Actions []Action `json:"actions" firestore:"actions"`

	// Identifiers of all the users that got this message
	Users []string `json:"users,omitempty" firestore:"users,omitempty"`

	// Identifiers of all the groups that got this message
	Groups []string `json:"groups,omitempty" firestore:"groups,omitempty"`

	// How the user should be notified of this new item, if at all
	NotificationChannels []Channel `json:"notificationChannels,omitempty" firestore:"notificationChannels,omitempty"`

	// Text/Message the user will see in their notifications body when an action is performed on a nudge
	NotificationBody NotificationBody `json:"notificationBody,omitempty" firestore:"notificationBody,omitempty"`
}

type Payload struct {
	Data map[string]interface{} `json:"data" firestore:"data"`
}

type Status string

type TextType string

type Visibility string