mathias
c26e29ac4d
The hexagonal interfaces the engine depends on. Keeps the engine provider- and sink-agnostic: YouTube/Vimeo implement VideoSource, the AI router implements Summarizer, store/brain implement Sink, ESO implements SecretStore. This is what makes standalone-vs-homelab a wiring choice (ADR-003).
43 lines
1.7 KiB
Go
43 lines
1.7 KiB
Go
// Package ports defines the interfaces (hexagonal "ports") that the use-case
|
|
// engine depends on. Concrete adapters live in internal/adapters. The engine
|
|
// imports this package; it never imports a concrete provider, store, or model.
|
|
// See docs/architecture/architecture.md.
|
|
package ports
|
|
|
|
import (
|
|
"context"
|
|
|
|
"gitea.d-ma.be/mathias/tapir/internal/domain"
|
|
)
|
|
|
|
// VideoSource is a video platform Tapir watches (YouTube, Vimeo).
|
|
type VideoSource interface {
|
|
// ListSubscriptions returns the channels the user subscribes to.
|
|
ListSubscriptions(ctx context.Context, userID string) ([]domain.Subscription, error)
|
|
// NewVideos returns videos newly seen for the given subscription.
|
|
NewVideos(ctx context.Context, sub domain.Subscription) ([]domain.Video, error)
|
|
// FetchTranscript resolves a transcript, captions-first. Returns a
|
|
// Transcript with Source == SourceNone when none is available (not an error).
|
|
FetchTranscript(ctx context.Context, v domain.Video) (domain.Transcript, error)
|
|
}
|
|
|
|
// Summarizer turns a transcript into a summary. Backed by the AI router
|
|
// (local Primary -> BYO Fallback). See docs/use-cases/ai_routing.feature.
|
|
type Summarizer interface {
|
|
Summarize(ctx context.Context, v domain.Video, t domain.Transcript) (domain.Summary, error)
|
|
}
|
|
|
|
// Sink delivers a summary to a destination (user store, brain, ...).
|
|
// Implementations fail independently of one another.
|
|
type Sink interface {
|
|
// Name identifies the sink for delivery records ("store", "brain").
|
|
Name() string
|
|
Deliver(ctx context.Context, s domain.Summary) error
|
|
}
|
|
|
|
// SecretStore resolves opaque references to secret material (OAuth tokens,
|
|
// BYO keys). Backed by ESO/1Password. Tables store only the reference.
|
|
type SecretStore interface {
|
|
Get(ctx context.Context, ref string) (string, error)
|
|
}
|