remove union type for chat message

[Yannick-Malins]

force the message part of a chat message to be a types structure, remove the union type that was kept for initial compatibility

update documentation

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: Yannick-Malins / name: Yannick (3f43819, 8ef2f0a, 4647b4c, c555f13, 6c45392, 0505a4d)
• ✅ login: kriswest / name: Kris West (a710850)

[netlify]

✅ Deploy Preview for fdc3 canceled.

Name	Link
🔨 Latest commit	0505a4d
🔍 Latest deploy log	https://app.netlify.com/sites/fdc3/deploys/6579b227d8d44e0008d7a657

[kriswest]

@bingenito Heres a PR from @Yannick-Malins that will remove that union type, which was left in for backwards compatibility, but is likely not needed as this type was added in 2.1. If this looks good to you we'll confirm consent for it at the next SWG meeting and then merge it (and regenerate the typescript context types in the NPM module - currently a manual process due to a quicktype issue).

I'll also see what we can do about adding a recommendation to not use union types in future.

[bingenito]

(and regenerate the typescript context types in the NPM module - currently a manual process due to a quicktype issue).

Is it possible to see what the type will look like as part of the PR?

[kriswest]

(and regenerate the typescript context types in the NPM module - currently a manual process due to a quicktype issue).

Is it possible to see what the type will look like as part of the PR?

Not until I can migrate it to FINOS repo branch and run the generation (would be automated, but for the aforementioned quicktype issue). I can do that migration after @Yannick-Malins is authorized by easyCLA (which is hopefully just a case of clicking on the link in the above message from the easyCLA bot #1102 (comment))

[kriswest]

This is the quicktype PR we're waiting on seeing merged so we can go back to automated generation: glideapps/quicktype#2426
I've given them a nudge on it

[kriswest]

@bingenito I got access to the fork from @Yannick-Malins to regenerate the types, you can now see the change to ContextTypes.ts in the diff

[bingenito]

Thanks @kriswest and @Yannick-Malins, looks good. I could have inferred that is the result but nice to see what gets generated up front.

[kriswest]

Thanks @kriswest and @Yannick-Malins, looks good. I could have inferred that is the result but nice to see what gets generated up front.

Very true - feel free to bug the quicktype maintainers for me :-p

[kriswest]

Generation of types is back to automated on commit, although it doesn't make it into the PR unless you run it yourself first, which is now also possible.

@Yannick-Malins the SWG meeting approved doing this last week, so now we just need to:

• pass reviews (@hughtroeger @bingenito)
• fix CLA check @Yannick-Malins please try clicking on the authorize link in the EasyCLA comment above
• fix conflicts in package-lock.json @Yannick-Malins

[kriswest]

/easycla

[kriswest]

@Yannick-Malins @mistryvinay can one of you hit that authorize link in the EasyCLA comment and check if you've got one of the new CLAs in place?

[kriswest]

LGTM

[kriswest]

Needs a changelog entry

[kriswest]

LGTM