Add type definition to support e-mail verification #53
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ions are defined for a component type Instead of having to re-define the openForms key itself and re-compose it with the translatable keys, we can instead use a type variable to specify the extensions to add via the OFExtensions helper type. This removes the amount of possible errors and repetition w/r to the translation keys that need to be passed, and the re-use of the generic types is greater.
…cation email extension The extension is added under the openForms namespace to prevent possible future collissions, and to make it explicit this is an additional feature added by Open Forms. The property is optional so that existing email components do not require a data migration - not specifying it is falsy, which is the default behaviour. The property is not added under the 'validate' namespace, because it's something that can only be properly validated server-side - it does not make sense to configure client-side validation error messages for this validation step because of that reason. We can still emit validation errors server-side in a way that they will probably be displayed with the component as if it was client-side validation.
sergei-maertens
force-pushed
the
feature/4542-support-email-verification
branch
from
564f811 to
58edc62
Compare
stevenbal
approved these changes
Aug 20, 2024
Comment on lines
+44
to
+47
| export type RadioComponentSchema = Require< | ||
| RadioManualValuesSchema | RadioVariableValuesSchema, | ||
| 'openForms' | ||
| >; |
There was a problem hiding this comment.
Does the Require here mean that the openForms key is required for RadioComponentSchema?
There was a problem hiding this comment.
indeed! I found it a bit weird that there's no built-in utility type for it (Required makes everything required). Without this, the formio builder doesn't build properly, and for select, selectboxes and radio the dataSrc must be specified.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partially closes open-formulieren/open-forms#4542
requireVerification, which we'll expose in the formio builder after this is merged.I checked that formio-builder still builds with
npm packand installing the tarball locally.