734 return app identifier and add function to retrieve app metadata

[kriswest]

resolves #734

Adds a new function to retrieve AppMetadata for an AppIdentifier and reduces several other return types to only specify AppIdentifier rather than AppMetadata (which is a superset of AppIdentifier's fields). This helps clarify what fields developers can expect in returns from functions (i.e. only the minimal set in AppIdentifier) and that they should manually retrieve any additional metadata (i.e. an AppMetadata) if they need it (for display purposes).

Key areas to review (preview links):

• API overview: https://deploy-preview-751--lambent-kulfi-cf51a7.netlify.app/docs/next/api/spec#reference-apps-or-app-instances-and-retrieve-their-metadata
• getAppMetadata() fn reference: https://deploy-preview-751--lambent-kulfi-cf51a7.netlify.app/docs/next/api/ref/desktopagent#getappmetadata
• Other types that had references changed to AppIdentifier from AppMetadata:
  • ContextMetadata
  • IntentResolution
  • findInstances
  • open

Finally, please note that the AppIntent returned by findIntent still uses AppMetadata (as the use case will pretty much always require it) as does the ImplementationMetadata returned by getInfo.

[netlify]

✅ Deploy Preview for lambent-kulfi-cf51a7 canceled.

Name	Link
🔨 Latest commit	3c2c52c
🔍 Latest deploy log	https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/62a71449942e27000884bab2

[robmoffat]

One question:

Is AppMetadata just a subset of the AppD record in this version? In #734 we were discussing making them equivalent, I think.

[kriswest]

It remains a subset. TBH, I think it will always be a subset (as it may not be appropriate to return the details and hostManifests elements), although I would like to widen it some (to include the email addresses, moreInfo link, publisher, lang and localizedVersions info). K

…

On Mon, 13 Jun 2022 at 10:04, Rob Moffat ***@***.***> wrote: One question: Is AppMetadata just a subset of the AppD record in this version? In #734 <#734> we were discussing making them equivalent, I think. — Reply to this email directly, view it on GitHub <#751 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAM7PBHPAPFW2UP326KACS3VO32RFANCNFSM5YOB5G4A> . You are receiving this because you authored the thread.Message ID: ***@***.***>

-- Kris West Principal Engineer [image: Cosaic] +1 (800) 821-8147 ***@***.*** Cosaic.io: <https://cosaic.io/> ChartIQ <http://cosaic.io/ChartIQ> + Finsemble <http://cosaic.io/Finsemble>

[mattjamieson]

Thanks @kriswest, LGTM. A few tiny tweaks.

[kriswest]

well spotted on a few of those, cheers @mattjamieson

[mistryvinay]

LGTM

[kriswest]

@openfin-johans @openfin-gavin @MichaelMCoates any chance you guys could take a look at this today? I'd like to get it off to the mailing list ASAP so we can then get on with sending out the pre-draft for the adoption vote next week.

The aim of the issue/PR is to reduce the need for the container to reproduce the full AppMetadata (which is growing in size gradually) in situations where it often isn't needed (for example on every context message or IntentResolution) and to provide a way to retrieve it. This should be more efficient for the container and clearer for the developer in terms of workflow (if you need the display metadata for an app, go retrieve it).

[openfin-johans]

It's a peach!