Add includeInvisibleContent option to extractTextContents

[thomasdax98]

Description

Add includeInvisibleContent option to extractTextContents

This option controls if invisible blocks are included in the returned contents. The default is false.

Use cases:

includeInvisibleContent = false: content generation -> ignore invisible content

includeInvisibleContent = true: automatic translation of a whole document

Acceptance criteria

• I have verified if my change requires an example
• I have verified if my change requires a changeset
• I have verified if my change requires screenshots/screencasts

Example

Example blocks

[{"name":"RichText","visible":true,"output":{"draftContent":{"blocks":[{"key":"393ng","text":"Visible RichText","type":"paragraph-standard","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}},"additionalFields":{"userGroup":"All"}},{"name":"RichText","visible":false,"output":{"draftContent":{"blocks":[{"key":"d7n9g","text":"Invisible RichText","type":"paragraph-standard","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}},"additionalFields":{"userGroup":"All"}},{"name":"Columns","visible":true,"output":{"layout":"2-20-2","columns":[{"key":"b46ba4b9-4fd5-4821-834b-720bb413798b","visible":true,"props":{"blocks":[{"key":"9ea53870-1768-4770-b618-fe86ba4a6709","visible":true,"type":"richtext","props":{"draftContent":{"blocks":[{"key":"bldkm","text":"Visible Column","type":"paragraph-standard","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}}},{"key":"afccac23-52b4-4f1f-91bf-efba92e9d3ca","visible":false,"type":"richtext","props":{"draftContent":{"blocks":[{"key":"77ice","text":"Invisible Column","type":"paragraph-standard","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}}}]}}]},"additionalFields":{"userGroup":"All"}},{"name":"StandaloneCallToActionList","visible":true,"output":{"callToActionList":{"blocks":[{"key":"ac90a0c5-2d56-4c42-a67f-0d77d900b16f","visible":true,"props":{"textLink":{"link":{"attachedBlocks":[{"type":"internal","props":{}}],"activeType":"internal"},"text":"Visible List Item"},"variant":"Contained"}},{"key":"8daac125-3523-421f-b9c0-174a31419a2b","visible":false,"props":{"textLink":{"link":{"attachedBlocks":[{"type":"internal","props":{}}],"activeType":"internal"},"text":"Invisible List Item"},"variant":"Contained"}}]},"alignment":"left"},"additionalFields":{"userGroup":"All"}},{"name":"StandaloneCallToActionList","visible":true,"output":{"callToActionList":{"blocks":[{"key":"5a2b882c-bf91-4410-915c-fc865193da5a","visible":true,"props":{"textLink":{"link":{"attachedBlocks":[{"type":"internal","props":{}},{"type":"email","props":{"email":"invisible@email-one-of.com"}},{"type":"external","props":{"targetUrl":"https://visible.external-one-of.com","openInNewWindow":false}}],"activeType":"external"},"text":""},"variant":"Contained"}}]},"alignment":"left"},"additionalFields":{"userGroup":"All"}},{"name":"FullWidthImage","visible":true,"output":{"image":{"attachedBlocks":[{"type":"pixelImage","props":{}}],"activeType":"pixelImage"},"content":{"block":{"draftContent":{"blocks":[{"key":"9ln7p","text":"Disabled optional block","type":"paragraph-standard","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}},"visible":false}},"additionalFields":{"userGroup":"All"}}]

Output (`includeInvisibleContent` = false)

[
    "<p class=\"paragraph-standard\">Visible RichText</p>",
    "<p class=\"paragraph-standard\">Visible Column</p>",
    "Visible List Item",
    "https://visible.external-one-of.com"
]

Output (`includeInvisibleContent` = true)

[
    "<p class=\"paragraph-standard\">Visible RichText</p>",
    "<p class=\"paragraph-standard\">Invisible RichText</p>",
    "<p class=\"paragraph-standard\">Visible Column</p>",
    "<p class=\"paragraph-standard\">Invisible Column</p>",
    "Visible List Item",
    "Invisible List Item",
    "invisible@email-one-of.com",
    "https://visible.external-one-of.com",
    "<p class=\"paragraph-standard\">Disabled optional block</p>"
]

Further information

• Task: https://vivid-planet.atlassian.net/browse/COM-1620