self-assert API
Draft assistants
Related to the creation of drafts.
| Name | Description |
|---|---|
| DraftAssistant | Provides an assistant to guide the completion of a model. |
| FieldDraftAssistant | An assistant designed to manage a single field or a simple piece of data within a larger form or model. |
| SectionDraftAssistant | Assists in the creation of complex models by coordinating multiple inner DraftAssistant. |
| IntegerDraftAssistant | Provides an assistant for the completion of an integer field, represented by a string. |
| PublisherEvents | Events emitted by a DraftPublisher. |
| DraftPublisher | Observes changes to a DraftAssistant by emitting structured events. |
| DraftViewer | Changes to a draft can be observed by viewers. |
Rule labeling
| Name | Description |
|---|---|
| RuleLabelAsJson | JSON representation of a RuleLabel |
| RuleLabel | Describes a rule by its id and description. |
| LabeledRule | Describes a rule by its id and description. |
Rules
Related to the definition of business rules and their evaluation.
| Name | Description |
|---|---|
| Assertion | Represents a validation rule in the problem domain. |
| Inquiry | Represents a rule that needs to be evaluated asynchronously. |
| Rule | Represents a validation rule in the problem domain. |
| RulesBroken | Provides a way to handle multiple failed rules, by their labels. |
| Ruleset | Runs all rules and throws an error if any has failed. The failed rules are included in the error. |
| RuleEvaluation | Represents the evaluation of a rule on a given value. |
| CollectableRule | Describes a rule that knows how to collect failures into a list. |
| Requirements | A collection of common rule requirements. |
Supporting types
| Name | Description |
|---|---|
| RulesBrokenAsJson | JSON representation of RulesBroken |
| MaybeAsync | - |
| RuleRequirement | - |
| SelfContainedRule | - |
| SelfContainedRules | - |
| SelfContainedAssertion | - |
| ValueParam | - |
| SelfContainedAssertions | - |
| Predicate | - |
| CreationClosure | - |
| AssistantsIn | Maps an array of models to the assistants that handle them. |
| ModelFromContainer | Describes how to get a model from another that serves as a container. |
