event.go

package persist

import (
	"database/sql"
	"fmt"
)

type ResourceType int
type Action string
type ActionList []Action

const (
	ResourceTypeUser ResourceType = iota
	ResourceTypeToken
	ResourceTypeCollection
	ResourceTypeGallery
	ResourceTypeAdmire
	ResourceTypeComment
	ResourceTypeCommunity
	ResourceTypePost
	ResourceTypeAllUsers
	ActionUserCreated                     Action = "UserCreated"
	ActionUserFollowedUsers               Action = "UserFollowedUsers"
	ActionUserPosted                      Action = "UserPosted"
	ActionUserPostedYourWork              Action = "UserPostedYourWork"
	ActionUserPostedFirstPost             Action = "UserPostedFirstPost"
	ActionCollectorsNoteAddedToToken      Action = "CollectorsNoteAddedToToken"
	ActionCollectionCreated               Action = "CollectionCreated"
	ActionCollectorsNoteAddedToCollection Action = "CollectorsNoteAddedToCollection"
	ActionTokensAddedToCollection         Action = "TokensAddedToCollection"
	ActionAdmiredFeedEvent                Action = "AdmiredFeedEvent"
	ActionAdmiredPost                     Action = "AdmiredPost"
	ActionAdmiredToken                    Action = "AdmiredToken"
	ActionAdmiredComment                  Action = "AdmiredComment"
	ActionCommentedOnFeedEvent            Action = "CommentedOnFeedEvent"
	ActionCommentedOnPost                 Action = "CommentedOnPost"
	ActionReplyToComment                  Action = "RepliedToComment"
	ActionMentionUser                     Action = "MentionUser"
	ActionMentionCommunity                Action = "MentionCommunity"
	ActionViewedGallery                   Action = "ViewedGallery"
	ActionViewedToken                     Action = "ViewedToken"
	ActionCollectionUpdated               Action = "CollectionUpdated"
	ActionGalleryUpdated                  Action = "GalleryUpdated"
	ActionGalleryInfoUpdated              Action = "GalleryInfoUpdated"
	ActionNewTokensReceived               Action = "NewTokensReceived"
	ActionTopActivityBadgeReceived        Action = "ActivityBadgeReceived"
	ActionAnnouncement                    Action = "Announcement"
	ActionUserFromFarcasterJoined         Action = "UserFromFarcasterJoined"
)

type EventData struct {
	UserBio                             string               `json:"user_bio"`
	UserFollowedBack                    bool                 `json:"user_followed_back"`
	UserRefollowed                      bool                 `json:"user_refollowed"`
	NewTokenID                          DBID                 `json:"new_token_id"`
	NewTokenQuantity                    HexString            `json:"new_token_quantity"`
	TokenCollectorsNote                 string               `json:"token_collectors_note"`
	TokenCollectionID                   DBID                 `json:"token_collection_id"`
	TokenContractID                     DBID                 `json:"token_contract_id"`
	TokenDefinitionID                   DBID                 `json:"token_definition_id"`
	CollectionTokenIDs                  DBIDList             `json:"collection_token_ids"`
	CollectionCollectorsNote            string               `json:"collection_collectors_note"`
	GalleryName                         *string              `json:"gallery_name"`
	GalleryDescription                  *string              `json:"gallery_description"`
	GalleryNewCollectionCollectorsNotes map[DBID]string      `json:"gallery_new_collection_collectors_notes"`
	GalleryNewTokenIDs                  map[DBID]DBIDList    `json:"gallery_new_token_ids"`
	GalleryNewCollections               DBIDList             `json:"gallery_new_collections"`
	GalleryNewTokenCollectorsNotes      map[DBID]string      `json:"gallery_new_token_collectors_notes"`
	ActivityBadgeThreshold              int                  `json:"activity_badge_threshold"`
	NewTopActiveUser                    bool                 `json:"new_top_active_user"`
	AnnouncementDetails                 *AnnouncementDetails `json:"announcement_details"`
}

type FeedEventData struct {
	UserBio                             string            `json:"user_bio"`
	UserFollowedIDs                     DBIDList          `json:"user_followed_ids"`
	UserFollowedBack                    []bool            `json:"user_followed_back"`
	TokenID                             DBID              `json:"token_id"`
	TokenCollectionID                   DBID              `json:"token_collection_id"`
	TokenGalleryID                      DBID              `json:"token_gallery_id"`
	TokenNewCollectorsNote              string            `json:"token_new_collectors_note"`
	CollectionID                        DBID              `json:"collection_id"`
	CollectionGalleryID                 DBID              `json:"collection_gallery_id"`
	CollectionTokenIDs                  DBIDList          `json:"collection_token_ids"`
	CollectionNewCollectorsNote         string            `json:"collection_new_collectors_note"`
	CollectionIsPreFeed                 bool              `json:"collection_is_pre_feed"`
	CollectionIsNew                     bool              `json:"collection_is_new"`
	GalleryID                           DBID              `json:"gallery_id"`
	GalleryName                         string            `json:"gallery_name"`
	GalleryDescription                  string            `json:"gallery_description"`
	GalleryNewCollectionCollectorsNotes map[DBID]string   `json:"gallery_new_collection_collectors_notes"`
	GalleryNewCollectionTokenIDs        map[DBID]DBIDList `json:"gallery_new_token_ids"`
	GalleryNewCollections               DBIDList          `json:"gallery_new_collections"`
	// this field should never be used again and should be replaced with its collection equivalent
	GalleryNewTokenCollectorsNotes           map[DBID]string          `json:"gallery_new_token_collectors_notes"`
	GalleryNewCollectionTokenCollectorsNotes map[DBID]map[DBID]string `json:"gallery_new_collection_token_collectors_notes"`
}

var errFeedEventNotFound ErrFeedEventNotFound

type ErrFeedEventNotFound struct{}

func (e ErrFeedEventNotFound) Unwrap() error { return notFoundError }
func (e ErrFeedEventNotFound) Error() string { return "feed event not found" }

type ErrFeedEventNotFoundByID struct{ ID DBID }

func (e ErrFeedEventNotFoundByID) Unwrap() error { return errFeedEventNotFound }
func (e ErrFeedEventNotFoundByID) Error() string {
	return fmt.Sprintf("event not found by id=%s", e.ID)
}

var errPostNotFound ErrPostNotFound

type ErrPostNotFound struct{}

func (e ErrPostNotFound) Unwrap() error { return notFoundError }
func (e ErrPostNotFound) Error() string { return "post not found" }

type ErrPostNotFoundByID struct{ ID DBID }

func (e ErrPostNotFoundByID) Unwrap() error { return errPostNotFound }
func (e ErrPostNotFoundByID) Error() string {
	return fmt.Sprintf("post not found by id=%s", e.ID)
}

type ErrUnknownAction struct {
	Action Action
}

func (e ErrUnknownAction) Error() string {
	return fmt.Sprintf("unknown action: %s", e.Action)
}

type ErrUnknownResourceType struct {
	ResourceType ResourceType
}

func (e ErrUnknownResourceType) Error() string {
	return fmt.Sprintf("unknown resource type: %v", e.ResourceType)
}

func StrPtrToNullStr(s *string) sql.NullString {
	if s == nil {
		return sql.NullString{}
	}
	return sql.NullString{Valid: true, String: *s}
}

func NullStrToStr(s sql.NullString) string {
	if !s.Valid {
		return ""
	}
	return s.String
}

func DBIDToNullStr(id DBID) sql.NullString {
	s := id.String()
	return StrPtrToNullStr(&s)
}

func NullStrToDBID(s sql.NullString) DBID {
	return DBID(NullStrToStr(s))
}