Public API Reference

The supported API is exposed from package public entry points. Do not import implementation files under src/lib.

Core contracts

• ValidationPolicy — supplies a list of validators.
• ValidationModel — model shape with optional validation and required results.
• Validator — fluent rule definition for one property path.
• ValidatorHelper — creates validators with validateFor().
• ValidationResult and ValidationError — structured failure state.
• FormGroupStatus and PolicyGroupConfig — aggregate workflow state.

ValidationProviderService

• register(name, policy) registers a policy once.
• replacePolicy(name, policy) replaces or creates a dynamic policy.
• unregisterPolicy(name) removes a policy.
• registerFormGroupPolicy(group, policy) maps a section to a policy.
• unregisterFormGroupPolicy(group) removes that mapping.
• registerPolicyGroup(key, config) creates a multi-policy aggregate.
• unregisterPolicyGroup(key) removes the aggregate.
• validateAll(model, policy, options) evaluates one policy.
• evaluatePolicies(model, names, group?) evaluates policies in sequence.
• evaluateFormGroup(model, group, policy?) refreshes one group.
• clearValidationState(model, policyNames) removes validation metadata and group state.
• onValidationRefresh(model) observes refresh notifications for one model.

Angular UI surface

The adapter exports ValidationModule, ValidatorDirective, display configuration tokens and providers, display strategies, and the status/summary components.

React UI surface

The React adapter exports ValidationRulesProvider, useValidationRules, useValidationForm, useValidationField, ValidationMessage, ValidationSummary, testing helpers, controlled-field props, and React-specific validation result types. React applications should import these APIs from @validation-rules-engine/react.

Core without an adapter

Plain TypeScript and the Vanilla Showcase consume Core contracts (ValidationPolicy, ValidatorHelper, result metadata) directly. There is no separate Vanilla package API. See Vanilla Showcase and Core Public API.

Compatibility

Core contracts, Angular directive selectors, Angular component selectors, policy-validation-* DOM hooks, the Angular stylesheet export, React hook names, React component names, and policy-domain type names remain compatibility contracts. Renaming them requires a planned breaking release.