Skip to content

self-assert API

Draft assistants

Related to the creation of drafts.

NameDescription
DraftAssistantProvides an assistant to guide the completion of a model.
FieldDraftAssistantAn assistant designed to manage a single field or a simple piece of data within a larger form or model.
SectionDraftAssistantAssists in the creation of complex models by coordinating multiple inner DraftAssistant.
IntegerDraftAssistantProvides an assistant for the completion of an integer field, represented by a string.
PublisherEventsEvents emitted by a DraftPublisher.
DraftPublisherObserves changes to a DraftAssistant by emitting structured events.
DraftViewerChanges to a draft can be observed by viewers.

Rule labeling

NameDescription
RuleLabelAsJsonJSON representation of a RuleLabel
RuleLabelDescribes a rule by its id and description.
LabeledRuleDescribes a rule by its id and description.

Rules

Related to the definition of business rules and their evaluation.

NameDescription
AssertionRepresents a validation rule in the problem domain.
InquiryRepresents a rule that needs to be evaluated asynchronously.
RuleRepresents a validation rule in the problem domain.
RulesBrokenProvides a way to handle multiple failed rules, by their labels.
RulesetRuns all rules and throws an error if any has failed. The failed rules are included in the error.
RuleEvaluationRepresents the evaluation of a rule on a given value.
CollectableRuleDescribes a rule that knows how to collect failures into a list.
RequirementsA collection of common rule requirements.

Supporting types

NameDescription
RulesBrokenAsJsonJSON representation of RulesBroken
MaybeAsync-
RuleRequirement-
SelfContainedRule-
SelfContainedRules-
SelfContainedAssertion-
ValueParam-
SelfContainedAssertions-
Predicate-
CreationClosure-
AssistantsInMaps an array of models to the assistants that handle them.
ModelFromContainerDescribes how to get a model from another that serves as a container.