// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package websocket

const (
	// Client actions
	ActionAuth        = "auth"
	ActionSubscribe   = "subscribe"
	ActionUnsubscribe = "unsubscribe"

	// Server actions
	ActionAuthSuccess  = "auth.success"
	ActionUnsubscribed = "unsubscribed"
)

// IncomingMessage represents a message from the client.
type IncomingMessage struct {
	Action string `json:"action"`
	// Token is set for auth action.
	Token string `json:"token,omitempty"`
	// Event is set for subscribe/unsubscribe actions.
	Event string `json:"event,omitempty"`
}

// OutgoingMessage represents a message from the server to the client.
// Exactly one of Event, Error, or Action will be set.
type OutgoingMessage struct {
	// Event identifies the event type. On push messages (e.g. "notification.created"),
	// it carries the event name. On error responses for subscribe/unsubscribe,
	// it identifies which event caused the error.
	Event string `json:"event,omitempty"`
	// Error is set for error responses (e.g. "forbidden").
	Error string `json:"error,omitempty"`
	// Action is set for server-initiated actions (e.g. "auth.success", "unsubscribed").
	Action string `json:"action,omitempty"`
	// Success is set for auth.success action.
	Success bool `json:"success,omitempty"`
	// Reason provides context for server-initiated actions.
	Reason string `json:"reason,omitempty"`
	// Data carries the event payload.
	Data any `json:"data,omitempty"`
}