#1373: add notes field in order and product types

[Angela-lltt]

Describe your change

Related Issue

resolves #1373

Contributor License Agreement

• I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

• Issue: If a change was made to the FDC3 Standard, was an issue linked above?
• CHANGELOG: Is a CHANGELOG.md entry included?
• API changes: Does this PR include changes to any of the FDC3 APIs (DesktopAgent, Channel, PrivateChannel, Listener, Bridging)?
  • Docs & Sources: If yes, were both documentation (/docs) and sources updated?
    
    JSDoc comments on interfaces and types should be matched to the main documentation in /docs
  • Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?
    
    Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
  • Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?
    
    The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
    • If yes, was code generation (npm run build) run and the results checked in?
      
      Generated code will be found at /src/api/BrowserTypes.ts and/or /src/bridging/BridgingTypes.ts
• Context types: Were new Context type schemas created or modified in this PR?
  • Were the field type conventions adhered to?
  • Was the BaseContext schema applied via allOf (as it is in existing types)?
  • Was a title and description provided for all properties defined in the schema?
  • Was at least one example provided?
  • Was code generation (npm run build) run and the results checked in?
    
    Generated code will be found at /src/context/ContextTypes.ts
• Intents: Were new Intents created in this PR?
  • Were the intent name prefixes and other naming conventions & characteristics adhered to?
  • Was the new intent added to the list in the Intents Overview?

[netlify]

✅ Deploy Preview for fdc3 ready!

Name	Link
🔨 Latest commit	f2871cc
🔍 Latest deploy log	https://app.netlify.com/projects/fdc3/deploys/6842cecad42dfd0008ef122e
😎 Deploy Preview	https://deploy-preview-1597.preview-fdc3.finos.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[robmoffat]

@Angela-lltt please add a CHANGELOG.md entry.

@finos/fdc3-maintainers and @finos/fdc3-editors please review.

[kriswest]

LGTM - I'll hold on approving until the Changelog is added.

@robmoffat you still need to update the Changelog in this PR which is overlapping: https://github.com/finos/FDC3/pull/1574/files (see comment https://github.com/finos/FDC3/pull/1574/files#r2037646220).

Alternatively, @Angela-lltt could put two changelog entries into her PR and we close yours.

Finally, @Angela-lltt is anything in #1503 that would be of use to your team. We probably don't want to include everything in there, but I'm happy for any of it to be recycled!

[Angela-lltt]

@robmoffat @kriswest I just updated the CHANGELOG.md, please help to check.
And currently we're using costomized context type in our team, so we're not using items in #1503.

[bingenito]

Shouldn't this have generated changes to fdc3-context/generated/context/ContextTypes.ts reflecting the new properties from the schema?

[kriswest]

@bingenito is correct. @Angela-lltt could you resolve conflicts with main and then run the following in packages/fdc3-context:
npm run typegen
then add any resulting changes to your PR and it should be good to go.

Also suggested minor tweaks to the changelog entries.

And currently we're using costomized context type in our team, so we're not using items in #1503.

I didn't expect that that you were, as they've not been added to the standard (RFQ type, additional fields on Product, Order and Trade). Another way to look at the question is "Are you using custom types that have fields that we should consider adding to Order, Trade, Product (and a future RFQ type)? Is there overlap between those proposed definitions and custom types that you have to use due to the lack of them in the standard,

[kriswest]

Suggested change

	* Add a notes field to trade type ([#1563](https://github.com/finos/FDC3/pull/1563))
	* Add a notes filed to order and product types ([#1597](https://github.com/finos/FDC3/pull/1597))
	* Add a notes field to the Trade Context type ([#1563](https://github.com/finos/FDC3/pull/1563))
	* Add a notes filed to the Order and Product Context types ([#1597](https://github.com/finos/FDC3/pull/1597))

[kriswest]

@Lecss and @Angela-lltt could someone run npm run typegen on this branch and push the result? We can complete the review afterwards

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: Angela-lltt / name: Angela (ae45ddc, f65dd37, f2871cc, a73bcba)

[Angela-lltt]

@kriswest Updated

[kriswest]

@Angela-lltt thanks! However it looks like your last commit went with the wrong email address (see https://github.com/finos/FDC3/commit/7c978d57b74c799e85207a89232cd3e23c6c87fe.patch and didn't get authorised in Easy CLA.

You can probably fix that with:

git commit --amend --author="Author Name <email@address.com>" --no-edit
git push --force

[kriswest]

...and there are some conflicts in need of resolving.

[kriswest]

Suggested change

	* Add a notes filed to Order and Product types ([#1597](https://github.com/finos/FDC3/pull/1597))
	* Add a notes field to Order and Product types ([#1597](https://github.com/finos/FDC3/pull/1597))

[kriswest]

LGTM

@bingenito I think all sorted now.

@finos/fdc3-editors pls review.

[Angela-lltt]

@kriswest All updated

[novavi]

LGTM

[Angela-lltt]

@robmoffat @kriswest it failed on Nodejs CI test check, could you help on it?

[kriswest]

@Angela-lltt you can ignore the failing check - it passed all the tests, but failed to post a comment as the PR came from a fork. The maintainers are going to try and resolve that soon.