formlookup

type Config struct {
	// Task authorizes the caller against a task — the question task completion asks,
	// ADR-0317 — and returns its form. ErrNoTask and ErrForbidden are its refusals.
	Task func(r *http.Request, key uint64) (Task, error)
	// Worker resolves a Worker by name from the Worker store.
	Worker func(name string) (Worker, bool, error)
	// Workers lists the Workers a model author may pick, for the editor.
	Workers func(r *http.Request) ([]Worker, error)
	// Ask puts a query to a Worker Instance and waits for its answer.
	Ask func(ctx context.Context, jobType, connector string, q lookup.Query, timeout time.Duration) (lookup.Page, error)
	// Allow is the per-person rate limit.
	Allow func(key string) bool
	// Principal names the caller, for the rate limit and for the cursor a page is
	// continued with. Empty when the server runs without authentication.
	Principal func(r *http.Request) string
	// Timeout bounds one query.
	Timeout time.Duration
	// MaxBody bounds a request's body: the server's Request budget.
	MaxBody int64
}

type Field struct {
	Key      string
	Label    string
	Required bool
	// Conditional is set when form-js may hide the field. The server cannot evaluate
	// form-js's condition, so it does not insist on a value a hidden field never sends.
	Conditional bool
	// Disabled fields are not submitted by form-js, and not checked.
	Disabled bool
	Source   Source
	Provider Provider
}

type Filter struct {
	Property string `json:"property"`
	Field    string `json:"field,omitempty"`
	Value    string `json:"value,omitempty"`
	// Required makes a bound filter a precondition: no search runs until its field has
	// a value. Without it, an empty field leaves the search unnarrowed.
	Required bool `json:"required,omitempty"`
}

type Form struct {
	Fields []Field
	// contains filtered or unexported fields
}

type Item struct {
	// Value is what the form submits: the record's identifier.
	Value string `json:"value"`
	// Label is what a person reads; Description the line under it.
	Label       string            `json:"label"`
	Description string            `json:"description,omitempty"`
	Details     map[string]string `json:"details,omitempty"`
}

type Option struct {
	Label       string   `json:"label,omitempty"`
	Description string   `json:"description,omitempty"`
	Details     []string `json:"details,omitempty"`
}

type Provider struct {
	// WorkerType is the Worker Type a form's Worker must be of — the kind of its
	// Console record ("entra").
	WorkerType string `json:"workerType"`
	// Resource is what is searched, in the Worker Type's vocabulary ("users").
	Resource string `json:"resource"`
	// JobType routes the query: it reaches Worker Instances serving this job type.
	JobType string `json:"-"`
	// Label names the source to a model author.
	Label string `json:"label"`
	// ValueProperty identifies a record; it is what a form submits.
	ValueProperty string   `json:"valueProperty"`
	Searchable    []string `json:"searchable"`
	Filterable    []string `json:"filterable"`
	Readable      []string `json:"readable"`
	// DefaultLabel and DefaultDescription are what an option shows when the form
	// names nothing; Fallback stands in for either when a record leaves it empty — a
	// user without a mailbox still has a user principal name.
	DefaultLabel       string `json:"defaultLabel"`
	DefaultDescription string `json:"defaultDescription"`
	Fallback           string `json:"fallback,omitempty"`
	// ValueFormat says in words what a value looks like, for an error message.
	ValueFormat string `json:"valueFormat"`
	// contains filtered or unexported fields
}

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

type Source struct {
	Version      int      `json:"version"`
	WorkerType   string   `json:"workerType"`
	Worker       string   `json:"worker"`
	Resource     string   `json:"resource"`
	SearchFields []string `json:"searchFields,omitempty"`
	Filters      []Filter `json:"filters,omitempty"`
	Option       Option   `json:"option,omitempty"`
	PageSize     int      `json:"pageSize,omitempty"`
	// MinSearchLength is how many characters a term needs before it is searched; 0
	// lists what the filters admit without one. Absent means 2.
	MinSearchLength *int `json:"minSearchLength,omitempty"`
	// ActiveOnly leaves disabled accounts out. Absent means true: a person picked for
	// a process is normally somebody who can still sign in, and a leaver process that
	// wants the disabled ones says so.
	ActiveOnly *bool  `json:"activeOnly,omitempty"`
	Verify     string `json:"verify,omitempty"`
}

type SubmissionError struct {
	Status     int
	Code       string
	Message    string
	RetryAfter int
}

type Task struct {
	Schema []byte
}

type Worker struct {
	Name       string `json:"name"`
	WorkerType string `json:"workerType"`
	Enabled    bool   `json:"enabled"`
	// FormLookups is the Worker's own switch: its editors decide whether a form may
	// search through its credential (ADR-0205). Seeing a form, or editing one, is not
	// that permission.
	FormLookups bool `json:"formLookups"`
}