document

type CountFilter struct {
	// CollectionID filters by collection. Empty means all collections.
	CollectionID id.CollectionID
	// State filters by document state. Empty means all states.
	State State
	// Search filters by title, matched exactly as ListFilter.Search.
	Search string
	// Tenant is the old explicit tenant filter.
	//
	// Deprecated: the tenant comes from the context (weave.WithTenant). A non-nil value must equal it.
	Tenant *string
	// UpdatedBefore counts only documents last updated before this instant.
	// Zero means no filter.
	UpdatedBefore time.Time
}

type Document struct {
	weave.Entity

	ID            id.DocumentID     `json:"id" bun:"id,pk"`
	CollectionID  id.CollectionID   `json:"collection_id" bun:"collection_id,notnull"`
	TenantID      string            `json:"tenant_id" bun:"tenant_id,notnull"`
	Title         string            `json:"title,omitempty" bun:"title"`
	Source        string            `json:"source,omitempty" bun:"source"`
	SourceType    string            `json:"source_type,omitempty" bun:"source_type"`
	ContentHash   string            `json:"content_hash" bun:"content_hash,notnull"`
	ContentLength int               `json:"content_length" bun:"content_length,notnull,default:0"`
	ChunkCount    int               `json:"chunk_count" bun:"chunk_count,notnull,default:0"`
	Metadata      map[string]string `json:"metadata" bun:"metadata,notnull,default:'{}'"`
	State         State             `json:"state" bun:"state,notnull,default:'pending'"`
	Error         string            `json:"error,omitempty" bun:"error"`
	// SourceKey identifies the source this document is the current version
	// of within its collection. Empty means the document is not source-managed.
	SourceKey string `json:"source_key,omitempty" bun:"source_key,notnull,default:''"`
}

type ListFilter struct {
	// CollectionID filters by collection. Empty means all collections.
	CollectionID id.CollectionID
	// State filters by document state. Empty means all states.
	State State
	// Search filters documents by title (case-insensitive substring match).
	Search string
	// SourceKey filters by exact source key. Empty means any.
	SourceKey string
	// ContentHash filters by exact content hash. Empty means any.
	ContentHash string
	// Limit is the maximum number of documents to return. Zero means no limit.
	Limit int
	// Offset is the number of documents to skip.
	Offset int
	// SortDesc lists newest first. The default is oldest first, which API
	// clients paging by offset already depend on.
	SortDesc bool
	// Tenant is the old explicit tenant filter.
	//
	// Deprecated: the tenant comes from the context (weave.WithTenant). A non-nil value must equal it.
	Tenant *string
}

type State string

type Store interface {
	// CreateDocument persists a new document. Its TenantID must be the
	// context tenant, and its collection must belong to that tenant, else
	// weave.ErrCollectionNotFound.
	CreateDocument(ctx context.Context, doc *Document) error

	// GetDocument retrieves a document by ID.
	GetDocument(ctx context.Context, docID id.DocumentID) (*Document, error)

	// UpdateDocument persists changes to an existing document. A document
	// never changes collection: a different CollectionID is not-found.
	UpdateDocument(ctx context.Context, doc *Document) error

	// DeleteDocument removes a document by ID.
	DeleteDocument(ctx context.Context, docID id.DocumentID) error

	// ListDocuments returns documents matching the given filter.
	ListDocuments(ctx context.Context, filter *ListFilter) ([]*Document, error)

	// CountDocuments returns the number of documents matching the given filter.
	CountDocuments(ctx context.Context, filter *CountFilter) (int64, error)

	// DeleteDocumentsByCollection removes all documents belonging to a collection.
	DeleteDocumentsByCollection(ctx context.Context, colID id.CollectionID) error
}