[MT-4431] Refactor - Type system #36
Conversation
As it's exactly matching the other place where we override it
Instead of defining it as a union of all possible implementations, we now declare it as the most generic Element interface (type + children) and expect all implementations to extend it. We can also now rely on the new `Element.isElementType()` helper to reduce duplication in our own type-guards code.
As there's not much need in it now, after we've inverted the types.
This is considered a temporary solution until we figure out a better way for it. In the longer run, I believe, it's worth to restructure the code so there is no dependencies or assumptions to the common Slate editor types structure. But that's not for now.
As it was duplicating `EmbedNode` interface from @prezly/slate-types
MT-4431 Refactor slate-editor repo types system
While working on MT-4421 we've came to realization that the approach we've took with defining Editor nodes types in the
Our current assumption is that the above can be fixed and improved by:
|
To make it more clear
- to check if value is `ElementNode` - to check if value is `ElementNode` of the given type - to check if value is `ElementNode` of one of the given types
Instead of relying on ambient-definition of `Element.isElement()`
Elementas the most generic shape allowing specific implementations to extend itInlineNodetype and type-guard in favour of runtime-definedEditor.isInline()checkBlockNodetype and type-guard in favour of runtime-definedEditor.isBlock()checkElementWithTypeand its type-guard, as it's the same as the genericElementAdditionalCustomTypeshack and only rely on Slate's stockCustomTypesdeclaration mergingCustomTypesambient declaration to@prezly/slate-commons(the plan is to keep it there as a temporary solution until we refactor the code to not depend on it)EmbedElementTypedefinition in favour ofEmbedNodedefined in@prezly/slate-typesLinkCandidateElementTypetoLinkCandidateNodeImageCandidateElementTypetoImageCandidateNodeLoaderElementTypetoLoaderNodeDIVIDER_TYPEconstant