snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/public/model/recap.go

@@ -0,0 +1,94 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+type Recap struct {
+	Id                string          `json:"id"`
+	UserId            string          `json:"user_id"`
+	Title             string          `json:"title"`
+	CreateAt          int64           `json:"create_at"`
+	UpdateAt          int64           `json:"update_at"`
+	DeleteAt          int64           `json:"delete_at"`
+	ReadAt            int64           `json:"read_at"`
+	ViewedAt          int64           `json:"viewed_at"`
+	TotalMessageCount int             `json:"total_message_count"`
+	Status            string          `json:"status"`
+	BotID             string          `json:"bot_id"`
+	ScheduledRecapId  string          `json:"scheduled_recap_id,omitempty"` // Set if created from scheduled recap
+	SkipReason        string          `json:"skip_reason,omitempty"`        // Why the recap was skipped; see SkipReason* constants
+	Channels          []*RecapChannel `json:"channels,omitempty"`
+}
+
+type RecapChannel struct {
+	Id            string   `json:"id"`
+	RecapId       string   `json:"recap_id"`
+	ChannelId     string   `json:"channel_id"`
+	ChannelName   string   `json:"channel_name"`
+	Highlights    []string `json:"highlights"`
+	ActionItems   []string `json:"action_items"`
+	SourcePostIds []string `json:"source_post_ids"`
+	CreateAt      int64    `json:"create_at"`
+}
+
+type CreateRecapRequest struct {
+	Title      string   `json:"title"`
+	ChannelIds []string `json:"channel_ids"`
+	AgentID    string   `json:"agent_id"`
+}
+
+type AIRecapSummaryResponse struct {
+	Highlights  []string `json:"highlights"`
+	ActionItems []string `json:"action_items"`
+}
+
+type RecapProcessingOptions struct {
+	TimePeriod         string
+	CustomInstructions string
+}
+
+// RecapChannelResult represents the result of processing a single channel for a recap
+type RecapChannelResult struct {
+	ChannelID    string
+	MessageCount int
+	Success      bool
+}
+
+const (
+	RecapStatusPending    = "pending"
+	RecapStatusProcessing = "processing"
+	RecapStatusCompleted  = "completed"
+	RecapStatusFailed     = "failed"
+	RecapStatusSkipped    = "skipped" // Recap skipped due to a limit violation or a non-recoverable creation failure
+)
+
+// Skip reason constants for when a recap is skipped
+const (
+	SkipReasonDailyLimit        = "daily_limit_reached"
+	SkipReasonCooldown          = "cooldown_active"
+	SkipReasonJobCreationFailed = "job_creation_failed" // Recap row committed but its processing job could not be enqueued
+)
+
+// Auditable returns safe-to-log fields for audit logging
+func (r *Recap) Auditable() map[string]any {
+	channelIDs := make([]string, 0, len(r.Channels))
+	for _, channel := range r.Channels {
+		channelIDs = append(channelIDs, channel.ChannelId)
+	}
+
+	return map[string]any{
+		"id":                  r.Id,
+		"user_id":             r.UserId,
+		"title":               r.Title,
+		"status":              r.Status,
+		"channel_ids":         channelIDs,
+		"total_message_count": r.TotalMessageCount,
+		"bot_id":              r.BotID,
+		"scheduled_recap_id":  r.ScheduledRecapId,
+		"skip_reason":         r.SkipReason,
+		"create_at":           r.CreateAt,
+		"update_at":           r.UpdateAt,
+		"read_at":             r.ReadAt,
+		"viewed_at":           r.ViewedAt,
+	}
+}