accessreq

type DecideRequest struct {
	// Permission is viewer or editor.
	Permission string `json:"permission" example:"viewer"`
}

type Decision struct {
	Status     string
	Permission string
	DecidedBy  string
	ShareID    string
}

type Deps struct {
	Store Requests
	// Resolve reads an item; an error is an item that does not exist.
	Resolve func(ctx context.Context, targetType, id string) (Target, error)
	// CanOpen reports whether the user already opens the item.
	CanOpen func(ctx context.Context, user *access.User, targetType, id string) bool
	// IsAdmin is the platform's administrator rule.
	IsAdmin func(user *access.User) bool
	// CanShare reports whether the user's persona lets them share what they
	// own (persona.SharingAllowed): an approval writes a share, so an owner
	// whose persona withholds sharing cannot approve (#2257). An
	// administrator always can. Nil admits every owner.
	CanShare func(user *access.User) bool
	// Share creates the person share an approval grants and returns its id.
	Share func(ctx context.Context, targetType, id, createdBy, recipientEmail, permission string) (string, error)
	// NotifyOwner tells the owner a request is waiting; NotifyRequester tells
	// the requester how it was answered. Either may be nil.
	NotifyOwner     func(ctx context.Context, req *Request, itemName string)
	NotifyRequester func(ctx context.Context, req *Request, itemName string)
	// Settings reads the stored configuration; nil uses Defaults.
	Settings func(ctx context.Context) Settings
}

type OpenRequest struct {
	Message string `json:"message,omitempty" example:"I need this for the quarterly review"`
}

type Page struct {
	// HasAccess is true when the person already opens the item.
	HasAccess bool `json:"has_access"`
	// Name is the item's name, only when the deployment reveals names.
	Name string `json:"name,omitempty"`
	// OwnerEmail is who a request goes to.
	OwnerEmail string `json:"owner_email"`
	// Pending is the person's live request for the item, if any.
	Pending *Request `json:"pending,omitempty"`
}

type Request struct {
	ID             string     `json:"id"`
	TargetType     string     `json:"target_type" example:"asset"`
	TargetID       string     `json:"target_id"`
	RequesterID    string     `json:"requester_id"`
	RequesterEmail string     `json:"requester_email"`
	OwnerEmail     string     `json:"owner_email"`
	Message        string     `json:"message,omitempty"`
	Status         string     `json:"status" example:"pending"`
	Permission     string     `json:"permission,omitempty" example:"viewer"`
	DecidedBy      string     `json:"decided_by,omitempty"`
	DecidedAt      *time.Time `json:"decided_at,omitempty"`
	ShareID        string     `json:"share_id,omitempty"`
	CreatedAt      time.Time  `json:"created_at"`
	ExpiresAt      time.Time  `json:"expires_at"`
	// TargetName is the item's name, filled for its owner.
	TargetName string `json:"target_name,omitempty"`
}

type RequestList struct {
	Requests []Request `json:"requests"`
}

type Requests interface {
	Open(ctx context.Context, r Request) (*Request, bool, error)
	Pending(ctx context.Context, targetType, targetID, requesterID string) (*Request, error)
	Get(ctx context.Context, id string) (*Request, error)
	ListForOwner(ctx context.Context, ownerEmail, targetType, targetID string, all bool) ([]Request, error)
	Decide(ctx context.Context, id string, d Decision) error
}

type Settings struct {
	// RevealNames shows the item's name on the page a person who cannot
	// open it sees; otherwise the page has a generic title.
	RevealNames bool `json:"reveal_names" example:"false"`
	// ExpireDays is how long a request waits for an answer.
	ExpireDays int `json:"expire_days" example:"14"`
}

type SettingsStore interface {
	Read(ctx context.Context) Settings
	Write(ctx context.Context, s Settings, author string) error
}

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

type Target struct {
	Name       string
	OwnerID    string
	OwnerEmail string
}