portal

package
v1.118.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2026 License: Apache-2.0 Imports: 45 Imported by: 0

Documentation

Overview

Package portal provides the asset portal data layer for persisting AI-generated assets (JSX dashboards, HTML reports, SVG charts).

The portal's domain vocabulary — the persisted entities, the authenticated user, the store contracts and the validation over them — is defined in internal/portal/portaldomain and aliased here. The split exists because this package must import every handler seam it registers routes from, so a seam cannot import this package back; the shared types therefore sit below both. Every name below keeps the spelling callers already use.

Index

Constants

View Source 
const (
	// MaxContentUploadBytes is the maximum size for content uploads (10 MB).
	MaxContentUploadBytes = portaldomain.MaxContentUploadBytes
	// MaxThumbnailUploadBytes is the maximum size for thumbnail uploads (512 KB).
	MaxThumbnailUploadBytes = portaldomain.MaxThumbnailUploadBytes
	// MaxChangeSummaryLength is the maximum length for a version change summary.
	MaxChangeSummaryLength = portaldomain.MaxChangeSummaryLength
)

Upload ceilings for content and thumbnails.

View Source 
const (
	// PermissionViewer allows read-only access.
	PermissionViewer = portaldomain.PermissionViewer
	// PermissionEditor allows read and write access.
	PermissionEditor = portaldomain.PermissionEditor
)

Share permission levels.

View Source 
const (
	// OriginExplicit is a share created deliberately by an owner/editor.
	OriginExplicit = portaldomain.OriginExplicit
	// OriginPublicLinkLogin is a viewer share auto-created when a user signs
	// in through a public link and had no prior share for the target.
	OriginPublicLinkLogin = portaldomain.OriginPublicLinkLogin
)

Share origins.

View Source 
const (
	// AccessModeRestricted admits only the named recipient
	// (SharedWithUserID or SharedWithEmail) and the share's creator.
	AccessModeRestricted = portaldomain.AccessModeRestricted
	// AccessModeAuthenticated admits any signed-in platform user.
	AccessModeAuthenticated = portaldomain.AccessModeAuthenticated
	// AccessModePublic admits anyone holding the token, without sign-in.
	AccessModePublic = portaldomain.AccessModePublic
)

Share access modes.

View Source 
const (
	ThreadKindComment    = threads.ThreadKindComment
	ThreadKindQuestion   = threads.ThreadKindQuestion
	ThreadKindCorrection = threads.ThreadKindCorrection
	ThreadKindRating     = threads.ThreadKindRating
)

Thread kinds.

View Source 
const (
	EventTypeComment       = threads.EventTypeComment
	EventTypeInsightLinked = threads.EventTypeInsightLinked
)

Thread event types.

View Source 
const (
	ValidationStatePending   = threads.ValidationStatePending
	ValidationStateValidated = threads.ValidationStateValidated
	ValidationStateDisputed  = threads.ValidationStateDisputed
)

Validation states.

View Source 
const DefaultNoticeText = portaldomain.DefaultNoticeText

DefaultNoticeText is the notice shown on public shares when no custom text is provided. Exported so out-of-package share creators (e.g. the export adapters) apply the same default rather than re-declaring the literal.

View Source 
const DefaultSearchLimit = portaldomain.DefaultSearchLimit

DefaultSearchLimit is the top-K returned when a ranked query does not specify a limit.

View Source 
const ThreadStatusResolved = threads.ThreadStatusResolved

ThreadStatusResolved is re-exported from pkg/portal/threads.

Variables

View Source 
var (
	NewPostgresThreadStore = threads.NewPostgresThreadStore
	NewThreadEventID       = threads.NewThreadEventID
)

Thread data-layer constructors.

Functions

func AssetIndexText added in v1.81.0 

func AssetIndexText(name, description string, tags []string) string

AssetIndexText composes the text an asset is embedded and lexically indexed on for relevance search: its name, description, and tags.

func CollectionIndexText added in v1.81.0 

func CollectionIndexText(name, description, sectionsText string) string

CollectionIndexText composes the text a collection is embedded and lexically indexed on: its name, description, and the denormalized section text.

func ContextWithUser added in v1.95.0 

func ContextWithUser(ctx context.Context, user *User) context.Context

ContextWithUser returns a copy of ctx carrying the authenticated user, the value GetUser reads. Exported so handlers split into sibling packages (e.g. internal/httpserver/datahubapi) can be exercised with an authenticated principal.

func DeriveThumbnailKey added in v1.40.1 

func DeriveThumbnailKey(s3Key string) string

DeriveThumbnailKey replaces the filename in an S3 key with "thumbnail.png" (the light/default variant).

func DeriveThumbnailKeyVariant added in v1.86.3 

func DeriveThumbnailKeyVariant(s3Key, variant string) string

DeriveThumbnailKeyVariant replaces the filename in an S3 key with the thumbnail filename for the given variant ("dark" -> thumbnail_dark.png, anything else -> thumbnail.png).

func ExtensionForContentType added in v1.43.0 

func ExtensionForContentType(ct string) string

ExtensionForContentType returns the file extension used in an asset's object key for a content type.

func GenerateShareToken added in v1.100.2 

func GenerateShareToken() (string, error)

GenerateShareToken generates a cryptographically random hex token for share links. Exported so out-of-package share creators (e.g. the export adapters) mint tokens with the same length and encoding as portal-issued shares.

func KeepAnyShare added in v1.86.0 

func KeepAnyShare(p SharePermission) bool

KeepAnyShare keeps shares at any permission.

func KeepEditorShares added in v1.86.0 

func KeepEditorShares(p SharePermission) bool

KeepEditorShares keeps only editor-permission shares.

func RequirePortalAuth 

func RequirePortalAuth(auth *Authenticator) func(http.Handler) http.Handler

RequirePortalAuth creates middleware that enforces portal authentication.

func ResolveContentType added in v1.110.0 

func ResolveContentType(declared string, content []byte) string

ResolveContentType returns the content type to store for content whose author declared declared.

func SectionsText added in v1.81.0 

func SectionsText(sections []CollectionSection) string

SectionsText flattens a collection's sections into the denormalized sections_text column.

func ValidSharePermission added in v1.42.0 

func ValidSharePermission(p string) bool

ValidSharePermission checks whether a permission string is valid.

func ValidateAssetName 

func ValidateAssetName(name string) error

ValidateAssetName checks that a name is non-empty and within length limits.

func ValidateChangeSummary added in v1.43.1 

func ValidateChangeSummary(s string) error

ValidateChangeSummary checks that a change summary is within length limits.

func ValidateCollectionDescription added in v1.47.0 

func ValidateCollectionDescription(desc string) error

ValidateCollectionDescription checks collection description length.

func ValidateCollectionName added in v1.47.0 

func ValidateCollectionName(name string) error

ValidateCollectionName checks that a collection name is valid.

func ValidateContentType 

func ValidateContentType(ct string) error

ValidateContentType checks that a content type is present and is one the platform stores for content that arrives as a string.

func ValidateContentTypeChange added in v1.117.0 

func ValidateContentTypeChange(existing, resolved string) error

ValidateContentTypeChange checks the type a content update resolved to against the type the asset already carries.

func ValidateDescription 

func ValidateDescription(desc string) error

ValidateDescription checks that a description is within length limits.

func ValidateEmail added in v0.35.9 

func ValidateEmail(email string) error

ValidateEmail checks that an email address has a basic valid format.

func ValidateNoticeText added in v1.39.0 

func ValidateNoticeText(text string) error

ValidateNoticeText checks that notice text is within length limits.

func ValidateSectionDescription added in v1.47.0 

func ValidateSectionDescription(desc string) error

ValidateSectionDescription checks section description length.

func ValidateSectionTitle added in v1.47.0 

func ValidateSectionTitle(title string) error

ValidateSectionTitle checks section title length.

func ValidateSections added in v1.47.0 

func ValidateSections(sections []CollectionSection) error

ValidateSections checks sections count and content validity.

func ValidateShareMessage added in v1.118.0 

func ValidateShareMessage(message string) error

ValidateShareMessage checks the sharer's optional plain-text note.

func ValidateTags 

func ValidateTags(tags []string) error

ValidateTags checks tag count and individual tag length.

Types

type Asset 

type Asset = portaldomain.Asset

Asset represents a persisted AI-generated asset.

type AssetCollectionRef added in v1.47.0 

type AssetCollectionRef = portaldomain.AssetCollectionRef

AssetCollectionRef is a lightweight reference to a collection that contains an asset.

type AssetFilter 

type AssetFilter = portaldomain.AssetFilter

AssetFilter defines filtering criteria for listing assets.

type AssetSearchQuery added in v1.81.0 

type AssetSearchQuery = portaldomain.AssetSearchQuery

AssetSearchQuery describes a relevance ranking request over saved assets.

type AssetSearcher added in v1.81.0 

type AssetSearcher = portaldomain.AssetSearcher

AssetSearcher ranks the caller's assets by relevance to a query.

type AssetStore 

type AssetStore = portaldomain.AssetStore

AssetStore persists and queries portal assets.

func NewNoopAssetStore 

func NewNoopAssetStore() AssetStore

NewNoopAssetStore creates a no-op AssetStore for use when no database is available.

func NewPostgresAssetStore 

func NewPostgresAssetStore(db *sql.DB) AssetStore

NewPostgresAssetStore creates a new PostgreSQL asset store.

type AssetUpdate 

type AssetUpdate = portaldomain.AssetUpdate

AssetUpdate holds mutable fields for updating an asset.

type AssetVersion added in v1.43.0 

type AssetVersion = portaldomain.AssetVersion

AssetVersion records a single version of an asset's content.

type AuditMetrics added in v0.36.0 

type AuditMetrics interface {
	Timeseries(ctx context.Context, filter audit.TimeseriesFilter) ([]audit.TimeseriesBucket, error)
	Breakdown(ctx context.Context, filter audit.BreakdownFilter) ([]audit.BreakdownEntry, error)
	Overview(ctx context.Context, filter audit.MetricsFilter) (*audit.Overview, error)
}

AuditMetrics provides aggregate audit metrics scoped to individual users.

type Authenticator 

type Authenticator struct {
	// contains filtered or unexported fields
}

Authenticator wraps the platform's middleware.Authenticator chain for HTTP portal requests. Unlike the admin authenticator, it does not require a specific persona — any authenticated user can access the portal.

func NewAuthenticator 

func NewAuthenticator(auth middleware.Authenticator, opts ...AuthenticatorOption) *Authenticator

NewAuthenticator creates a Authenticator.

func (*Authenticator) Authenticate 

func (pa *Authenticator) Authenticate(r *http.Request) (*User, error)

Authenticate resolves the caller via session cookie (CSRF-enforced on state-changing methods) first, then falls back to token auth. A CSRF failure on a valid cookie is deferred, not fatal: a CSRF-exempt token (which a cross-site attacker cannot supply) may still authenticate the request, and only when none does is the rejection surfaced (→ 403).

func (*Authenticator) IssueCSRF added in v1.96.0 

func (pa *Authenticator) IssueCSRF(subject string) string

IssueCSRF returns a CSRF token bound to subject, or "" when cookie auth is not configured.

type AuthenticatorOption 

type AuthenticatorOption func(*Authenticator)

AuthenticatorOption configures the portal authenticator.

func WithBrowserAuth 

func WithBrowserAuth(ba *browsersession.Authenticator) AuthenticatorOption

WithBrowserAuth adds cookie-based authentication.

type ChangesetReader added in v1.84.0 

type ChangesetReader = feedbackapi.ChangesetReader

ChangesetReader provides read access to knowledge changesets, used to surface the thread -> insight -> changeset chain on a feedback thread.

type Collection added in v1.47.0 

type Collection = portaldomain.Collection

Collection represents a curated, ordered group of assets organized into sections.

type CollectionConfig added in v1.47.0 

type CollectionConfig = portaldomain.CollectionConfig

CollectionConfig holds extensible per-collection settings.

type CollectionFilter added in v1.47.0 

type CollectionFilter = portaldomain.CollectionFilter

CollectionFilter defines filtering criteria for listing collections.

type CollectionItem added in v1.47.0 

type CollectionItem = portaldomain.CollectionItem

CollectionItem is an ordered reference to an asset within a section.

type CollectionSearchQuery added in v1.81.0 

type CollectionSearchQuery = portaldomain.CollectionSearchQuery

CollectionSearchQuery describes a relevance ranking request over collections.

type CollectionSearcher added in v1.81.0 

type CollectionSearcher = portaldomain.CollectionSearcher

CollectionSearcher ranks the caller's collections by relevance to a query.

type CollectionSection added in v1.47.0 

type CollectionSection = portaldomain.CollectionSection

CollectionSection is an ordered section within a collection.

type CollectionStore added in v1.47.0 

type CollectionStore = portaldomain.CollectionStore

CollectionStore persists and queries portal collections.

func NewNoopCollectionStore added in v1.47.0 

func NewNoopCollectionStore() CollectionStore

NewNoopCollectionStore creates a no-op CollectionStore for use when no database is available.

func NewPostgresCollectionStore added in v1.47.0 

func NewPostgresCollectionStore(db *sql.DB) CollectionStore

NewPostgresCollectionStore creates a new PostgreSQL collection store.

type Deps 

type Deps struct {
	AssetStore         AssetStore
	ShareStore         ShareStore
	VersionStore       VersionStore
	CollectionStore    CollectionStore
	ThreadStore        ThreadStore
	KnowledgePageStore knowledgepage.Store
	// KnowledgePageDedupThreshold is the create-time duplicate-gate threshold (#705)
	// the REST create path shares with the MCP apply path. 0 disables the gate. The
	// platform resolves it (default/disabled) before wiring; the handler treats it as
	// final.
	KnowledgePageDedupThreshold float64
	S3Client                    S3Client
	S3Bucket                    string
	PublicBaseURL               string
	RateLimit                   RateLimitConfig
	// RateLimitResolver attributes the client IP for the public viewer's
	// rate limiter with trusted-proxy awareness (#904). nil yields the safe
	// trust-none default (direct peer address; X-Forwarded-For ignored), so an
	// attacker cannot mint unlimited per-IP buckets with a spoofed header.
	RateLimitResolver  *ratelimit.Resolver
	OIDCEnabled        bool
	AdminRoles         []string // roles that grant admin access in the portal
	PromptStore        PromptStore
	PromptRegistrar    PromptRegistrar
	PromptInfoProvider PromptInfoProvider
	AuditMetrics       AuditMetrics
	InsightStore       InsightReader
	ChangesetReader    ChangesetReader
	MemoryStore        MemoryReader
	MemoryWriter       MemoryWriter
	EmbeddingProvider  embedding.Provider
	PersonaResolver    PersonaResolver
	// SearchRouter backs GET /api/v1/portal/search, the REST surface over the
	// unified knowledge federation. nil disables the endpoint (no searchable
	// source configured).
	SearchRouter SearchRouter
	// DataHubRegistrar, when set, registers the portal DataHub Catalog and Context
	// Docs REST routes (#718) onto the portal mux. It is provided by cmd wiring
	// (internal/httpserver/datahubapi.Handler.Register) so the DataHub feature lives in its
	// own package; nil leaves the /api/v1/portal/datahub/* routes unregistered.
	DataHubRegistrar func(*http.ServeMux)
	// MentionResolver filters the @-mentions written in a thread comment to
	// the people who can open the thread's target (#627). nil disables
	// mentions (no database): tokens stay ordinary text and notify nobody.
	MentionResolver MentionResolver
	// Authenticator resolves a logged-in user from a public (unauthenticated)
	// request so the public viewer can auto-promote a signed-in viewer to a
	// derived share. Optional; nil disables auto-promote.
	Authenticator *Authenticator
	// Platform brand (far right of public viewer header)
	BrandName    string // display name (default: "MCP Data Platform")
	BrandLogoSVG string // inline SVG for header logo (empty = default icon)
	BrandURL     string // link URL (e.g., "https://plexara.io"); empty = no link

	// Implementor brand (far left of public viewer header, optional)
	ImplementorName    string // display name (e.g., "ACME Corp"); empty = hidden
	ImplementorLogoSVG string // inline SVG; empty = hidden
	ImplementorURL     string // link URL; empty = no link

	// Notifier receives share and thread trigger events (issue #631). nil
	// disables email notifications; implementations log their own failures
	// and never fail the originating request.
	Notifier Notifier
	// ShareGuest is the guest access path for email shares (#1001): branded
	// denial pages, one-time view links, and guest sessions. nil keeps the
	// pre-#1001 plain-text denials and registers no guest routes.
	ShareGuest *shareguest.Service
	// NotificationRegistrar, when set, registers the self-scoped
	// notification-preference REST routes onto the portal's authenticated
	// mux (the DataHubRegistrar pattern): the feature lives with the
	// notification substrate, not in this package. nil leaves the
	// /api/v1/portal/notification-prefs routes unregistered.
	NotificationRegistrar func(*http.ServeMux)
}

Deps holds dependencies for the portal handler.

type Handler 

type Handler struct {
	// contains filtered or unexported fields
}

Handler provides portal REST API endpoints.

func NewHandler 

func NewHandler(deps Deps, authMiddle func(http.Handler) http.Handler) *Handler

NewHandler creates a new portal API handler.

func (*Handler) ServeHTTP 

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler.

type InsightReader added in v0.36.0 

type InsightReader interface {
	List(ctx context.Context, filter knowledge.InsightFilter) ([]knowledge.Insight, int, error)
	Stats(ctx context.Context, filter knowledge.InsightFilter) (*knowledge.InsightStats, error)
	// Get returns a single insight by id, used to surface a knowledge page's
	// source-insight lineage (#678). A drained or deleted insight returns an error.
	Get(ctx context.Context, id string) (*knowledge.Insight, error)
}

InsightReader provides read-only access to user insights.

type InsightSearcher added in v1.80.0 

type InsightSearcher = knowledge.InsightSearcher

InsightSearcher is the optional relevance-search capability of the insight store, declared canonically in the knowledge package next to its query and result types. The knowledge-search route (and the recall_insight tool) are registered only when the wired InsightStore satisfies it; the memory-backed adapter does, the legacy separate-table store does not.

type MemoryReader added in v1.52.0 

type MemoryReader interface {
	List(ctx context.Context, filter memory.Filter) ([]memory.Record, int, error)
	HybridSearch(ctx context.Context, q memory.HybridQuery) ([]memory.ScoredRecord, error)
	LexicalSearch(ctx context.Context, q memory.LexicalQuery) ([]memory.ScoredRecord, error)
}

MemoryReader provides read-only access to user memory records. The search methods back the portal's per-user "my knowledge" search: both queries are scoped to the caller via CreatedBy server-side, so a user can never search another user's records.

type MemoryWriter added in v1.88.0 

type MemoryWriter = feedbackapi.MemoryWriter

MemoryWriter inserts memory records. It backs the "capture feedback as an insight" path: a reviewer turns a feedback thread into a pending, knowledge-dimension memory record that enters the apply_knowledge review queue. The full memory.Store satisfies it; the portal only needs Insert.

type MentionResolver added in v1.114.0 

type MentionResolver = feedbackapi.MentionResolver

MentionResolver returns the addresses a comment body delivers an @-mention to on a thread target: the names written in the body, minus the author's own address, filtered to the people who can open that target. Implemented by pkg/portal/mention, which the composition root injects; a nil resolver disables mentions (no database), leaving every token ordinary text.

type Notifier added in v1.103.0 

type Notifier interface {
	// NotifyShare fires after a successful direct-share insert.
	NotifyShare(ctx context.Context, share *Share, ev ShareEvent)
	// NotifyThreadEvent fires after a successful thread create or event
	// append. thread carries the target reference; body is the comment text;
	// mentioned carries the @-mentions the body delivers, already filtered to
	// people who can open the target (#627). Mentioned people are notified as
	// mentions -- their own category, which a recipient can keep on while
	// muting general thread activity -- and are left out of the general
	// notification, so one comment never sends the same person two emails.
	NotifyThreadEvent(ctx context.Context, thread *Thread, actorEmail, body string, mentioned []string)
}

Notifier receives the portal's notification trigger events (issue #631): direct shares and feedback-thread activity. Implementations queue email notifications and must never fail the originating request -- both methods are fire-and-forget, logging their own errors. The share kind is one of "asset", "collection", or "prompt". A nil Notifier disables notifications.

The implementation lives with the notification delivery substrate (internal/platform/notifydelivery); portal only fires the events.

type PersonaInfo added in v0.36.0 

type PersonaInfo struct {
	Name  string
	Tools []string // resolved tool names from Allow/Deny patterns
}

PersonaInfo holds resolved persona details for the current user.

type PersonaResolver added in v0.36.0 

type PersonaResolver func(roles []string) *PersonaInfo

PersonaResolver resolves a user's roles to their persona info.

type PromptInfoProvider added in v1.51.0 

type PromptInfoProvider interface {
	AllPromptInfos() []registry.PromptInfo
}

PromptInfoProvider returns metadata about system-registered prompts.

type PromptRegistrar added in v1.51.0 

type PromptRegistrar interface {
	RegisterRuntimePrompt(p *prompt.Prompt)
	UnregisterRuntimePrompt(name string)
}

PromptRegistrar registers/unregisters prompts with the live MCP server.

type PromptStore added in v1.51.0 

type PromptStore = prompt.Store

PromptStore provides prompt persistence for the portal: exactly the prompt store contract, aliased so portal deps read naturally.

type Provenance 

type Provenance = portaldomain.Provenance

Provenance records the tool call history that produced an asset.

type ProvenanceToolCall 

type ProvenanceToolCall = portaldomain.ProvenanceToolCall

ProvenanceToolCall records a single tool invocation in the provenance chain.

type RateLimitConfig 

type RateLimitConfig = viewerlimit.Config

RateLimitConfig aliases the public viewer rate limiter's config, which lives in internal/portal/viewerlimit with the implementation. The alias keeps the portal's public API spelling stable for existing callers.

type S3Client 

type S3Client = portaldomain.S3Client

S3Client abstracts the S3 operations needed by the portal toolkit.

type ScoredAsset added in v1.81.0 

type ScoredAsset = portaldomain.ScoredAsset

ScoredAsset pairs an asset with its relevance score in [0,1].

type ScoredCollection added in v1.81.0 

type ScoredCollection = portaldomain.ScoredCollection

ScoredCollection pairs a collection with its relevance score in [0,1].

type SearchCaller added in v1.88.0 

type SearchCaller struct {
	UserID  string
	Email   string
	Persona string
}

SearchCaller is the resolved requester identity per-user providers scope on.

type SearchCoverage added in v1.88.0 

type SearchCoverage struct {
	Source   string `json:"source"`
	Matched  int    `json:"matched"`
	Shown    int    `json:"shown"`
	Withheld int    `json:"withheld,omitempty"`
}

SearchCoverage reports, per source, how many records matched versus how many are shown, the anti-tunnel signal that breadth exists beyond the display set, plus how many the caller's persona hid (#1108) so "nothing matched" and "matches you may not see" render differently.

type SearchGroup added in v1.88.0 

type SearchGroup struct {
	Source string      `json:"source"`
	Hits   []SearchHit `json:"hits"`
}

SearchGroup is one source's slice of the balanced display set.

type SearchHit added in v1.88.0 

type SearchHit struct {
	Text       string   `json:"text"`
	Source     string   `json:"source"`
	Ref        string   `json:"ref"`
	Score      float64  `json:"score"`
	Status     string   `json:"status,omitempty"`
	EntityURNs []string `json:"entity_urns,omitempty"`
	Dimension  string   `json:"dimension,omitempty"`
}

SearchHit is one matched record. The JSON shape matches the MCP search tool's hit so the portal and agent surfaces render identical results.

type SearchQuery added in v1.88.0 

type SearchQuery struct {
	Intent     string
	EntityURNs []string
	Status     string
	Sources    []string
	Caller     SearchCaller
	Limit      int
}

SearchQuery is one unified search. Intent is natural-language text; EntityURNs is an exact entity-keyed lookup; at least one is set. Caller is the per-user scope boundary. These fields mirror knowledge.Query; the adapter in main maps between them.

type SearchResult added in v1.88.0 

type SearchResult struct {
	Groups         []SearchGroup
	Coverage       []SearchCoverage
	Ranking        string
	UnknownSources []string
	// WithheldNotice explains, in one line, results the caller's persona hid
	// because they belong to connections it is not granted (#1108). Empty when
	// nothing was withheld. The adapter builds it from the router's coverage so
	// the portal and the MCP search tool render identical copy.
	WithheldNotice string
}

SearchResult is the grouped-by-source response. It mirrors knowledge.Result.

type SearchRouter added in v1.88.0 

type SearchRouter interface {
	Search(ctx context.Context, q SearchQuery) (SearchResult, error)
}

SearchRouter is the unified knowledge-search federation behind the portal's GET /api/v1/portal/search endpoint. It is a portal-local interface (rather than a direct dependency on pkg/knowledge) because that package already imports pkg/portal for the asset and knowledge-page stores; importing it back would form a cycle. main wires a thin adapter over *knowledge.Router that maps to these types, so the REST surface returns the same grouped, scope-enforced result set as the MCP search tool.

type Share 

type Share = portaldomain.Share

Share represents a share link for an asset, collection, or prompt.

type ShareAccessMode added in v1.104.0 

type ShareAccessMode = portaldomain.ShareAccessMode

ShareAccessMode determines who may open a share token.

type ShareEvent added in v1.118.0 

type ShareEvent struct {
	// Kind is one of "asset", "collection", or "prompt".
	Kind string
	// ItemID and ItemTitle identify the shared item.
	ItemID    string
	ItemTitle string
	// Message is the sharer's plain-text note, already validated by
	// ValidateShareMessage. Empty means no note.
	Message string
}

ShareEvent carries what a share notification is about: the item shared and the sharer's optional personal note.

The note lives here rather than on Share because it is not part of the share: it is never persisted, never shown in the viewer, and reaches only the one email the share produces. A share created with notify off carries no note anywhere.

type ShareKeep added in v1.86.0 

type ShareKeep = feedbackapi.ShareKeep

ShareKeep decides whether a share grant counts toward a gathered target set. KeepEditorShares is the "I can act on it" scope (worklist, MCP agent); KeepAnyShare is the "I can view it" scope (activity feed).

type ShareOrigin added in v1.84.0 

type ShareOrigin = portaldomain.ShareOrigin

ShareOrigin records how a share came to exist.

type SharePermission added in v1.42.0 

type SharePermission = portaldomain.SharePermission

SharePermission defines the access level for a share recipient.

type ShareStore 

type ShareStore = portaldomain.ShareStore

ShareStore persists and queries share links for assets, collections, and prompts.

func NewNoopShareStore 

func NewNoopShareStore() ShareStore

NewNoopShareStore creates a no-op ShareStore for use when no database is available.

func NewPostgresShareStore 

func NewPostgresShareStore(db *sql.DB) ShareStore

NewPostgresShareStore creates a new PostgreSQL share store.

type ShareSummary added in v0.37.0 

type ShareSummary = portaldomain.ShareSummary

ShareSummary indicates what kinds of active shares exist for an asset.

type SharedAsset 

type SharedAsset = portaldomain.SharedAsset

SharedAsset combines an Asset with share metadata for "shared with me" results.

type SharedCollection added in v1.47.0 

type SharedCollection = portaldomain.SharedCollection

SharedCollection combines a Collection with share metadata.

type SharedPrompt added in v1.81.0 

type SharedPrompt struct {
	Prompt     prompt.Prompt                `json:"prompt"`
	ShareID    string                       `json:"share_id"`
	SharedBy   string                       `json:"shared_by"`
	SharedAt   time.Time                    `json:"shared_at"`
	Permission portaldomain.SharePermission `json:"permission"`
}

SharedPrompt is a prompt shared with the current user, with share metadata, for the "Shared With Me" listing.

type SharedPromptRef added in v1.81.0 

type SharedPromptRef = portaldomain.SharedPromptRef

SharedPromptRef references a prompt shared with a user along with share metadata.

type TargetGatherer added in v1.86.0 

type TargetGatherer = feedbackapi.TargetGatherer

TargetGatherer gathers the asset/collection ids a single user can reach, bundling the stores and identity so callers (REST worklist/activity feed, the manage_feedback MCP tool) build it once and ask for asset or collection ids with the desired share scope.

type Thread added in v1.84.0 

type Thread = threads.Thread

Thread is re-exported from pkg/portal/threads.

type ThreadEvent added in v1.84.0 

type ThreadEvent = threads.ThreadEvent

ThreadEvent is re-exported from pkg/portal/threads.

type ThreadFilter added in v1.84.0 

type ThreadFilter = threads.ThreadFilter

ThreadFilter is re-exported from pkg/portal/threads.

type ThreadStore added in v1.84.0 

type ThreadStore = threads.ThreadStore

ThreadStore is re-exported from pkg/portal/threads.

type ThreadUpdate added in v1.84.0 

type ThreadUpdate = threads.ThreadUpdate

ThreadUpdate is re-exported from pkg/portal/threads.

type ThreadWithMeta added in v1.84.0 

type ThreadWithMeta = threads.ThreadWithMeta

ThreadWithMeta is re-exported from pkg/portal/threads.

type User 

type User = access.User

User holds information about the authenticated portal user. It is defined with the authorization core because it is the subject of every permission check the portal makes.

func GetUser 

func GetUser(ctx context.Context) *User

GetUser returns the User from context, or nil if not set.

type ValidationResponse added in v1.84.0 

type ValidationResponse = threads.ValidationResponse

ValidationResponse is re-exported from pkg/portal/threads.

type VersionStore added in v1.43.0 

type VersionStore = portaldomain.VersionStore

VersionStore persists and queries asset version history.

func NewNoopVersionStore added in v1.43.0 

func NewNoopVersionStore() VersionStore

NewNoopVersionStore creates a no-op VersionStore for use when no database is available.

func NewPostgresVersionStore added in v1.43.0 

func NewPostgresVersionStore(db *sql.DB) VersionStore

NewPostgresVersionStore creates a new PostgreSQL asset version store.

Source Files

View all Source files

Directories

Path Synopsis
Package knowledgepage is the store and ranked-search backend for canonical business/domain knowledge pages (#633): org-shared markdown documents stored inline in Postgres so their content is vector- and full-text searchable.
 Package knowledgepage is the store and ranked-search backend for canonical business/domain knowledge pages (#633): org-shared markdown documents stored inline in Postgres so their content is vector- and full-text searchable.
Package mention implements @-mention tagging on portal feedback threads (#627).
 Package mention implements @-mention tagging on portal feedback threads (#627).
Package s3adapter adapts an mcp-s3 client to the portal.S3Client interface used by the portal handler for blob storage.
 Package s3adapter adapts an mcp-s3 client to the portal.S3Client interface used by the portal handler for blob storage.
Package shareaccess decides who may open a portal share token.
 Package shareaccess decides who may open a portal share token.
Package shareguest gives the named recipient of an email share a way in without a platform account (#1001).
 Package shareguest gives the named recipient of an email share a way in without a platform account (#1001).
Package threads holds the portal feedback-thread data layer: the Thread types and constants, the ThreadStore interface, its PostgreSQL implementation, and the filter/query helpers.
 Package threads holds the portal feedback-thread data layer: the Thread types and constants, the ThreadStore interface, its PostgreSQL implementation, and the filter/query helpers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.