Code components "link" props can only be coarse, resulting in irrelevant shape matches when building `ContentTemplate`s

Overview

• @lauriiii at #3555413-19: Allow linking to referenced entities: add `url` property to `EntityReferenceItem::propertyDefinitions()` → :
  

  
  Images seem to introduce some interesting. It looks like we could map the image to "image" but there's also URI and root-relative URL. What's the difference between these different mappings?

• @Wim Leers at #3555413-20: Allow linking to referenced entities: add `url` property to `EntityReferenceItem::propertyDefinitions()` → :
  

  That is best explained by quoting the test coverage, which makes this very explicit:

              'Silly image 🤡 → URI → Root-relative file URL' => 'ℹ︎␜entity:node:foo␝field_silly_image␞␟entity␜␜entity:file␝uri␞␟url',
              'Silly image 🤡 → URI' => 'ℹ︎␜entity:node:foo␝field_silly_image␞␟entity␜␜entity:file␝uri␞␟value',
              "Silly image 🤡" => 'ℹ︎␜entity:node:foo␝field_silly_image␞␟src_with_alternate_widths',
  

  1. The first ("URI → root-relative file URL"): the image field's reference to the File entity is followed, then the "url" property on the "uri" field on the File entity is retrieved.
  2. The second ("URI"): the image field's reference to the File entity is followed, then the "value" property on the "uri" field on the File entity is retrieved — aka the main property on that field, which is why there's one less level in the hierarchy for this one.
  3. The third ("just the image field itself"): the image field's src_with_alternate_widths computed property that Canvas added.

  You can only see all 3 , because the second one returns a public:// URI. but, arguably, it does not make sense to expose "root-relative file URL" for an image field, either, because src_with_alternate_widths is likely preferable. Except … if you want to link to the original image, because then the query string is just noise.

  […]

  👆 Note the bold+underlined bit!

• @lauriii at #3555413-25: Allow linking to referenced entities: add `url` property to `EntityReferenceItem::propertyDefinitions()` → :
  

  I think with the improved labels it would have made sense to me what was being offered there. FWIW, I was testing this with code components so maybe the prop type in code components should be setting stronger restrictions for the stream wrapper URL to not be offered?

• @Wim Leers at #3555413-26: Allow linking to referenced entities: add `url` property to `EntityReferenceItem::propertyDefinitions()` → :
  

  The code component editor is correct, it's just coarse. I think we need to expand the code component editor UI (and the JSON schema for props that code components are allowed to have) to allow for optional granularity. This is especially true for links. Because the hyperlink is literally the foundation of the web, and it's also literally what a CMS is about: managing content and relations between them. So it's important that the author of a code component can actually specify what kind of link they expect. Because only then can Canvas offer links!

  This is what that UI currently looks like, annotated to convey what the coarse prop shapes are that you're allowed to pick:

Proposed resolution

Allow more granularity. See the change record that in August through September introduced the ability for highly structured approaches to restricting links. (Before then, it was a hacky pattern: …-based mess, aka regex hell 🧟).

1️⃣ Add a Link target prop setting in the code component editor UI

Which maps to contentMediaType. Offer 4 choices initially:

1. (DEFAULT! — plus, this is what all existing code components use. This corresponds to no contentMediaType being set in JSON Schema)
2. (contentMediaType: image/*) → will result in only suggestions for image fields and image media
3. (contentMediaType: video/*) → will result in only suggestions for video media
4. (contentMediaType: text/html) → will result in only suggestions for the host entity's URL (since ✨ In a content template, how can I link to an entity? Active ), entity reference fields (once 🐛 HostEntityUrlPropSource shouldn't be specific to the host entity Postponed: needs info lands) and link fields

Perhaps with a UI description along the lines of

2️⃣.A Add an optional prop setting in the code component editor UI

Which maps to contentMediaType. Offer 2 choices initially:

1. (DEFAULT!)
2. (sets x-allowed-schemes: [http, https])

Perhaps with a UI description along the lines of

2️⃣.B , always restrict to HTTP(S) links

Alternatively, we could omit that second setting and just always restrict all "URL prop shapes" for code components to x-allowed-schemes: [http, https], and provide an update path to make it so.

User interface changes

TBD