A community based topic aggregation platform built on atproto
bretton.dev
1package communities
2
3import (
4 "time"
5)
6
7// Community represents a Coves community indexed from the firehose
8// Communities are federated, instance-scoped forums built on atProto
9type Community struct {
10 CreatedAt time.Time `json:"createdAt" db:"created_at"`
11 UpdatedAt time.Time `json:"updatedAt" db:"updated_at"`
12 RecordURI string `json:"recordUri,omitempty" db:"record_uri"`
13 FederatedFrom string `json:"federatedFrom,omitempty" db:"federated_from"`
14 DisplayName string `json:"displayName" db:"display_name"`
15 Description string `json:"description" db:"description"`
16 PDSURL string `json:"-" db:"pds_url"`
17 AvatarCID string `json:"avatarCid,omitempty" db:"avatar_cid"`
18 BannerCID string `json:"bannerCid,omitempty" db:"banner_cid"`
19 OwnerDID string `json:"ownerDid" db:"owner_did"`
20 CreatedByDID string `json:"createdByDid" db:"created_by_did"`
21 HostedByDID string `json:"hostedByDid" db:"hosted_by_did"`
22 PDSEmail string `json:"-" db:"pds_email"`
23 PDSPassword string `json:"-" db:"pds_password_encrypted"`
24 Name string `json:"name" db:"name"`
25 RecordCID string `json:"recordCid,omitempty" db:"record_cid"`
26 FederatedID string `json:"federatedId,omitempty" db:"federated_id"`
27 PDSAccessToken string `json:"-" db:"pds_access_token"`
28 SigningKeyPEM string `json:"-" db:"signing_key_encrypted"`
29 ModerationType string `json:"moderationType,omitempty" db:"moderation_type"`
30 Handle string `json:"handle" db:"handle"`
31 PDSRefreshToken string `json:"-" db:"pds_refresh_token"`
32 Visibility string `json:"visibility" db:"visibility"`
33 RotationKeyPEM string `json:"-" db:"rotation_key_encrypted"`
34 DID string `json:"did" db:"did"`
35 ContentWarnings []string `json:"contentWarnings,omitempty" db:"content_warnings"`
36 DescriptionFacets []byte `json:"descriptionFacets,omitempty" db:"description_facets"`
37 PostCount int `json:"postCount" db:"post_count"`
38 SubscriberCount int `json:"subscriberCount" db:"subscriber_count"`
39 MemberCount int `json:"memberCount" db:"member_count"`
40 ID int `json:"id" db:"id"`
41 AllowExternalDiscovery bool `json:"allowExternalDiscovery" db:"allow_external_discovery"`
42}
43
44// Subscription represents a lightweight feed follow (user subscribes to see posts)
45type Subscription struct {
46 SubscribedAt time.Time `json:"subscribedAt" db:"subscribed_at"`
47 UserDID string `json:"userDid" db:"user_did"`
48 CommunityDID string `json:"communityDid" db:"community_did"`
49 RecordURI string `json:"recordUri,omitempty" db:"record_uri"`
50 RecordCID string `json:"recordCid,omitempty" db:"record_cid"`
51 ID int `json:"id" db:"id"`
52}
53
54// Membership represents active participation with reputation tracking
55type Membership struct {
56 JoinedAt time.Time `json:"joinedAt" db:"joined_at"`
57 LastActiveAt time.Time `json:"lastActiveAt" db:"last_active_at"`
58 UserDID string `json:"userDid" db:"user_did"`
59 CommunityDID string `json:"communityDid" db:"community_did"`
60 ID int `json:"id" db:"id"`
61 ReputationScore int `json:"reputationScore" db:"reputation_score"`
62 ContributionCount int `json:"contributionCount" db:"contribution_count"`
63 IsBanned bool `json:"isBanned" db:"is_banned"`
64 IsModerator bool `json:"isModerator" db:"is_moderator"`
65}
66
67// ModerationAction represents a moderation action taken against a community
68type ModerationAction struct {
69 CreatedAt time.Time `json:"createdAt" db:"created_at"`
70 ExpiresAt *time.Time `json:"expiresAt,omitempty" db:"expires_at"`
71 CommunityDID string `json:"communityDid" db:"community_did"`
72 Action string `json:"action" db:"action"`
73 Reason string `json:"reason,omitempty" db:"reason"`
74 InstanceDID string `json:"instanceDid" db:"instance_did"`
75 ID int `json:"id" db:"id"`
76 Broadcast bool `json:"broadcast" db:"broadcast"`
77}
78
79// CreateCommunityRequest represents input for creating a new community
80type CreateCommunityRequest struct {
81 Name string `json:"name"`
82 DisplayName string `json:"displayName,omitempty"`
83 Description string `json:"description"`
84 Language string `json:"language,omitempty"`
85 Visibility string `json:"visibility"`
86 CreatedByDID string `json:"createdByDid"`
87 HostedByDID string `json:"hostedByDid"`
88 AvatarBlob []byte `json:"avatarBlob,omitempty"`
89 BannerBlob []byte `json:"bannerBlob,omitempty"`
90 Rules []string `json:"rules,omitempty"`
91 Categories []string `json:"categories,omitempty"`
92 AllowExternalDiscovery bool `json:"allowExternalDiscovery"`
93}
94
95// UpdateCommunityRequest represents input for updating community metadata
96type UpdateCommunityRequest struct {
97 CommunityDID string `json:"communityDid"`
98 UpdatedByDID string `json:"updatedByDid"` // User making the update (for authorization)
99 DisplayName *string `json:"displayName,omitempty"`
100 Description *string `json:"description,omitempty"`
101 AvatarBlob []byte `json:"avatarBlob,omitempty"`
102 BannerBlob []byte `json:"bannerBlob,omitempty"`
103 Visibility *string `json:"visibility,omitempty"`
104 AllowExternalDiscovery *bool `json:"allowExternalDiscovery,omitempty"`
105 ModerationType *string `json:"moderationType,omitempty"`
106 ContentWarnings []string `json:"contentWarnings,omitempty"`
107}
108
109// ListCommunitiesRequest represents query parameters for listing communities
110type ListCommunitiesRequest struct {
111 Visibility string `json:"visibility,omitempty"`
112 HostedBy string `json:"hostedBy,omitempty"`
113 SortBy string `json:"sortBy,omitempty"`
114 SortOrder string `json:"sortOrder,omitempty"`
115 Limit int `json:"limit"`
116 Offset int `json:"offset"`
117}
118
119// SearchCommunitiesRequest represents query parameters for searching communities
120type SearchCommunitiesRequest struct {
121 Query string `json:"query"`
122 Visibility string `json:"visibility,omitempty"`
123 Limit int `json:"limit"`
124 Offset int `json:"offset"`
125}