wiki

type DeleteError struct {
	ID    string
	Error string
}

type ListPagesOptions struct {
	Page             int
	PerPage          int
	Sort             PageSortField
	Order            PageSortOrder
	PathPrefix       string
	Tags             []string
	ExcludePathRoots []string
}

type Page struct {
	ID          string   `json:"id"`
	Title       string   `json:"title"`
	Description string   `json:"description,omitempty"`
	Tags        []string `json:"tags,omitempty"`
	Content     string   `json:"content"`
	CreatedAt   string   `json:"createdAt"`
	UpdatedAt   string   `json:"updatedAt"`
}

type PageAttachment struct {
	Name    string    `json:"name"`
	Size    int64     `json:"size"`
	SavedAt time.Time `json:"savedAt"`
}

type PageMetadata struct {
	ID          string    `json:"id"`
	Title       string    `json:"title"`
	Description string    `json:"description,omitempty"`
	Tags        []string  `json:"tags,omitempty"`
	ModTime     time.Time `json:"modTime"`
}

type PageRevision struct {
	Rev     string    `json:"rev"`
	SavedAt time.Time `json:"savedAt"`
	Size    int64     `json:"size"`
	Content string    `json:"content,omitempty"`
}

type PageSearchResult struct {
	ID                string              `json:"id"`
	Title             string              `json:"title"`
	Description       string              `json:"description,omitempty"`
	Tags              []string            `json:"tags,omitempty"`
	ModTime           time.Time           `json:"modTime"`
	Matches           []*textsearch.Match `json:"matches"`
	MatchCount        int                 `json:"matchCount,omitempty"`
	HasMoreMatches    bool                `json:"hasMoreMatches"`
	NextMatchesCursor string              `json:"nextMatchesCursor,omitempty"`
}

type PageSortField string

type PageSortOrder string

type PageStore interface {
	List(ctx context.Context, opts ListPagesOptions) (*pagination.PaginatedResult[*PageTreeNode], error)
	ListFlat(ctx context.Context, opts ListPagesOptions) (*pagination.PaginatedResult[PageMetadata], error)
	Get(ctx context.Context, id string) (*Page, error)
	Create(ctx context.Context, id, content string) error
	Update(ctx context.Context, id, content string) error
	Delete(ctx context.Context, id string) error
	DeleteBatch(ctx context.Context, ids []string) (deleted []string, failed []DeleteError, err error)
	// Rename moves a page or every page under a directory path.
	Rename(ctx context.Context, oldID, newID string) error
	// Backlinks returns metadata for pages linking to target. Target is a
	// stored page ID or a scheme-prefixed wiki-link target such as
	// "dag:name". A relative link held by a page under pathPrefix also
	// matches when pathPrefix + "/" + link equals target.
	Backlinks(ctx context.Context, target, pathPrefix string) ([]PageMetadata, error)
	// ListRevisions returns stored prior versions of a page, newest
	// first, without content. Stores without revision support return an
	// empty list.
	ListRevisions(ctx context.Context, id string) ([]PageRevision, error)
	// GetRevision returns one stored revision including its content.
	GetRevision(ctx context.Context, id, rev string) (*PageRevision, error)
	// PutAttachment stores an attachment for an existing page,
	// replacing any attachment with the same name.
	PutAttachment(ctx context.Context, id, name string, content io.Reader) (*PageAttachment, error)
	// OpenAttachment opens an attachment for reading. The caller closes the
	// returned reader.
	OpenAttachment(ctx context.Context, id, name string) (io.ReadCloser, *PageAttachment, error)
	Search(ctx context.Context, query string) ([]*PageSearchResult, error)
	SearchCursor(ctx context.Context, opts SearchPagesOptions) (*pagination.CursorResult[PageSearchResult], error)
	SearchMatches(ctx context.Context, id string, opts SearchPageMatchesOptions) (*pagination.CursorResult[*textsearch.Match], error)
	// PathExists reports whether id identifies a page or a page directory.
	PathExists(ctx context.Context, id string) (pageExists, directoryExists bool, err error)
}

type PageTreeNode struct {
	ID       string          `json:"id"`
	Name     string          `json:"name"`
	Title    string          `json:"title,omitempty"`
	Tags     []string        `json:"tags,omitempty"`
	Type     string          `json:"type"` // "file" or "directory"
	Children []*PageTreeNode `json:"children,omitempty"`
	ModTime  time.Time       `json:"modTime"`
}

type SearchPageMatchesOptions struct {
	Cursor     string
	Limit      int
	Query      string
	PathPrefix string
}

type SearchPagesOptions struct {
	Cursor           string
	Limit            int
	Query            string
	MatchLimit       int
	PathPrefix       string
	FilterPrefix     string
	Tags             []string
	ExcludePathRoots []string
}

type WikiLink struct {
	Target string
	Anchor string
	Label  string
}