eventmedia

README

eventmedia

eventmedia is a small, dependency-free Go package for validating operational plans for guest photo, video, and voice-message collection.

result := eventmedia.Validate(plan, time.Now())
if !result.Ready {
    // Review result.Findings before the event opens.
}

It checks HTTPS destinations, privacy wording, removal contacts, moderation, live-display safety, retention, upload windows, network tests, fallback plans, and responsible roles.

The library is platform-neutral. For an implementation example of a browser-based QR upload workflow, see Gathmo's event media flow.

Install

go get github.com/martinfreiwa/eventmedia@v0.1.0

Test

go test ./...

License

MIT

Documentation

Overview

Package eventmedia validates operational plans for collecting guest photos, videos, and voice messages at weddings, private events, and conferences.

The package is platform-neutral. A concrete app-free implementation reference is available at https://gathmo.com/how-it-works.

Index

• type Finding
• type ModerationMode
• type Plan
• type Result
  • func Validate(plan Plan, now time.Time) Result
• type Severity

Types

type Finding

type Finding struct {
	Severity Severity
	Field    string
	Message  string
}

Finding describes one incomplete or unsafe planning decision.

type ModerationMode

type ModerationMode string

ModerationMode defines how guest submissions become visible.

const (
	// ModerationApprovedOnly allows only explicitly approved media to appear.
	ModerationApprovedOnly ModerationMode = "approved_only"
	// ModerationManual keeps uploads in a review workflow.
	ModerationManual ModerationMode = "manual"
	// ModerationNone publishes without moderation and is unsafe for live displays.
	ModerationNone ModerationMode = "none"
)

type Plan

type Plan struct {
	EventName       string
	UploadURL       string
	ShortURL        string
	PrivacyNotice   string
	RemovalContact  string
	ModerationMode  ModerationMode
	LiveDisplay     bool
	RetentionDays   int
	UploadClosesAt  time.Time
	NetworkTests    []string
	FallbackPlan    string
	ResponsibleRole []string
}

Plan captures the minimum operational decisions for an event media workflow.

type Result

type Result struct {
	Score    int
	Ready    bool
	Findings []Finding
}

Result is the deterministic outcome of Validate.

func Validate

func Validate(plan Plan, now time.Time) Result

Validate checks an event media plan at the supplied time.

type Severity

type Severity string

Severity identifies whether a finding blocks readiness.

const (
	// SeverityError blocks readiness.
	SeverityError Severity = "error"
	// SeverityWarning should be reviewed but does not block readiness.
	SeverityWarning Severity = "warning"
)