Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] 544 desktop agent bridging proposal #634

Closed
wants to merge 87 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
4b4b8c7
adding docs folder for bridging
WatsonCIQ Mar 10, 2022
18d4f04
Notes from initial meeting as MD
WatsonCIQ Mar 10, 2022
48e5dd7
small formatting changes
WatsonCIQ Mar 10, 2022
264e123
separating out generic message formats an improving on the findIntent…
kriswest Mar 10, 2022
0e5c3a5
further tweaks
kriswest Mar 10, 2022
8ca8b08
Moving type specific message fields under a body element + correct JS…
kriswest Mar 10, 2022
7fa6bcf
minor typo fixes + comments
kriswest Mar 10, 2022
529373b
comment on request format
kriswest Mar 10, 2022
e59fa11
comments
kriswest Mar 10, 2022
130d6b2
missing comma
kriswest Mar 10, 2022
4586964
raiseIntent braindump
Mar 11, 2022
c61cb84
update raiseIntent scenario
Mar 14, 2022
3e63310
Change header levels and add Apps section content.
WatsonCIQ Mar 14, 2022
1e373ca
Meeting 20220315 (#14)
kriswest Mar 22, 2022
2bde817
adjusting a number of notes in proposal write-up
kriswest Mar 23, 2022
75e4926
Merge pull request #633 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Mar 23, 2022
90d3168
Added paths
Mar 29, 2022
1514499
spec update
Apr 1, 2022
2f5051b
spec update - standalone bridge
Apr 25, 2022
09afeb0
Typos
May 3, 2022
810f623
Headings and desktop agent name consistentcy
May 3, 2022
13aec12
update
May 3, 2022
409ac52
updating connection overview
kriswest May 4, 2022
e9e0bc6
updating connection overview
kriswest May 4, 2022
46b0f75
Merge branch '544-Desktop-Agent-Bridging-Proposal' into cosaic-tpina_…
kriswest May 4, 2022
e861199
Merge pull request #693 from ChartIQ/cosaic-tpina_544-DAB-proposal
kriswest May 4, 2022
f7b6479
intro content and open questions
kriswest May 4, 2022
33b9bbb
Typos
May 6, 2022
fdc09e7
Save
May 25, 2022
905b969
Merge branch 'master' into 544-Desktop-Agent-Bridging-Proposal
kriswest Jun 7, 2022
1c39fe7
Proposal update
Jun 7, 2022
29439ce
Merge branch 'master' into tpina_544_DAB_update
Jun 7, 2022
ea8aaa4
Merge branch 'finos:master' into tpina_544_DAB_update
kriswest Jun 7, 2022
cbea562
Merge branch 'master' into 544-Desktop-Agent-Bridging-Proposal
kriswest Jun 7, 2022
899fd70
Merge branch '544-Desktop-Agent-Bridging-Proposal' into tpina_544_DAB…
kriswest Jun 7, 2022
8672a32
Merge pull request #744 from ChartIQ/tpina_544_DAB_update
kriswest Jun 7, 2022
802ded0
add bridging spec to website standard nav sidebar - note that diagram…
kriswest Jun 10, 2022
06ab23c
Proposal update - connection protocol
Jul 6, 2022
4e2a809
Update docs/api-bridging/spec.md
kriswest Jul 6, 2022
1c20213
Merge pull request #773 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Jul 6, 2022
471f90b
Typos spotted during discussion group session
Jul 6, 2022
5d30205
Merge remote-tracking branch 'upstream/master' into 544-Desktop-Agent…
Jul 25, 2022
57d8ba9
typos and clarifications to spec
Jul 25, 2022
d1c4e88
Merge branch 'finos:544-Desktop-Agent-Bridging-Proposal' into 544-Des…
tpina Jul 25, 2022
c4b1358
Proposal update
Jul 26, 2022
c14f264
Updating proposal structure and adding messaging protocol
kriswest Jul 26, 2022
b308341
adding TODO message
kriswest Jul 27, 2022
a202302
clean up
Jul 27, 2022
6d97396
Revert "Merge remote-tracking branch 'upstream/master' into 544-Deskt…
Jul 27, 2022
5de6dcc
Merge pull request #783 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Jul 27, 2022
5d300aa
typos
Aug 22, 2022
d176d66
proposal update
Aug 22, 2022
8ae9d96
update
Aug 23, 2022
b69c947
update
Aug 23, 2022
ba4bc23
DAB proposal update: identifying messages, identifying agents, payloa…
kriswest Aug 23, 2022
9102043
Merge branch 'master' into 544-Desktop-Agent-Bridging-Proposal
kriswest Aug 23, 2022
61bb38e
update
Aug 24, 2022
faeba21
Bridge Workflows broken by disconnection
kriswest Aug 24, 2022
f26c2fb
Merge pull request #800 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Aug 24, 2022
4dd3f63
typos spotted during meeting
Aug 25, 2022
e587b80
Merge pull request #801 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Aug 25, 2022
5e0089e
Update to DAB spec
kriswest Sep 21, 2022
4eed1b4
Merge branch '544-Desktop-Agent-Bridging-Proposal' of https://github.…
Sep 21, 2022
a9d25a5
Merge remote-tracking branch 'upstream/master' into 544-Desktop-Agent…
kriswest Sep 21, 2022
501b971
Merge remote-tracking branch 'upstream/544-Desktop-Agent-Bridging-Pro…
kriswest Sep 21, 2022
5f71c70
Merge branch '544-Desktop-Agent-Bridging-Proposal' of https://github.…
Sep 21, 2022
4ecc3b3
Merge branch '544-Desktop-Agent-Bridging-Proposal' of https://github.…
Sep 22, 2022
17115aa
typos
Sep 22, 2022
c7324ab
adding message exchange content
kriswest Sep 27, 2022
480a5d2
Merge branch '544-Desktop-Agent-Bridging-Proposal' of https://github.…
kriswest Sep 27, 2022
35a475d
Merge pull request #821 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Sep 27, 2022
5471c3c
cleanup
Sep 28, 2022
41a8e20
Further clean-up and adding messages for PrivateChannel events and br…
kriswest Sep 28, 2022
9e5d7d8
Merge pull request #823 from ChartIQ/544-Desktop-Agent-Bridging-Proposal
kriswest Sep 28, 2022
4fa0b80
Improving a poorly worded sentence
kriswest Oct 10, 2022
5eb70e4
Merge pull request #830 from finos:544-DAB-proposal-tweak
kriswest Oct 10, 2022
ac45778
Add advice on visual feedback to users on connect events
kriswest Oct 25, 2022
d7cecea
Handle TODO in Forwarding of Messages and Collating Responses
kriswest Oct 25, 2022
8816731
Added section on returning error responses
kriswest Oct 25, 2022
63d5978
Correction to raiseIntent message exchange
kriswest Oct 25, 2022
a5c0bdb
Consolidating error handling sections
kriswest Oct 25, 2022
28564cb
Adding exchanges for open and findInstances
kriswest Oct 25, 2022
6e8aa09
Update spec.md
kriswest Oct 25, 2022
fe2b095
typos and linting
Oct 25, 2022
407a13d
Apply suggestions from code review
kriswest Oct 25, 2022
0abae34
Merge pull request #837 from Finsemble/544-Desktop-Agent-Bridging-Pro…
kriswest Oct 25, 2022
3202af5
Update todo and open questions
kriswest Oct 26, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* Added a Trademarks page to website to acknowledge trademarks used within the Standard not owned by FINOS or the Linux Foundation ([#534](https://github.com/finos/FDC3/pull/534))
* Added details of FDC3's existing versioning and deprecation policies to the FDC3 compliance page ([#539](https://github.com/finos/FDC3/pull/539))
* Added a new experimental features policy, which exempts features designated as experimental from the versioning and deprecation policies, to the FDC3 compliance page ([#549](https://github.com/finos/FDC3/pull/549))
* Added a recommended set of user channel definitions to the API docs and typescript sources ([#727](https://github.com/finos/FDC3/pull/727))
* Added a recommended set of user channel definitions to the API docs and typescript sources ([#727](https://github.com/finos/FDC3/pull/726))
* Added the optional exposure of originating app metadata to messages received via `addContextListener` and `addIntentListener` via the new `ContextMetadata` type. ([#725](https://github.com/finos/FDC3/pull/725))
* Added the current app's `AppMetadata` to the `ImplementationMetadata` returned by `fdc3.getInfo()` allowing an app to retrieve its own metadata, according to the Desktop Agent ([#726](https://github.com/finos/FDC3/pull/726))
* Added a context type representing a range of time (`fdc3.timerange`). ([#706](https://github.com/finos/FDC3/pull/706))
Expand All @@ -55,7 +55,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* Added `categories` field and recommended categories list to AppD application records to enable category based browsing of AppDs ([#673](https://github.com/finos/FDC3/pull/673))
* Added an `interop` field to AppD application records, replacing the `intents` field, to more fully describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
* Added `AppIdentifier` type, which is a new parent of `AppMetadata` and clarifies required fields for API call parameters which now prefer `appId` and `instanceId` over `name` ([#722](https://github.com/finos/FDC3/pull/722))
* Added a `getAppMetdata()` function to the desktop agent that can be used to retrieve the full `AppMetadata` for an `AppIdentifier` and reduced types such as `IntentResolution.source` and `ContextMetadata.source` from `AppMetadata` to `AppIdentifier` to clarify what fields a developer can rely on and that they should manually retrieve the full `AppMetadata` when they need it for display purposes. ([#751](https://github.com/finos/FDC3/pull/751))

### Changed

Expand All @@ -69,7 +68,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* The `fdc3.joinChannel()`, `fdc3.getCurrentChannel()` and `fdc3.leaveCurrentChannel()` functions have been made optional for FDC3 API compliance, but are recommended through the application of the SHOULD keyword. ([#512](https://github.com/finos/FDC3/pull/512))
* All DesktopAgent and Channel API functions are now async for consistency, changing the return type of the `broadcast`, `addIntentListener`, `addContextListener` and `getInfo` functions ([#516](https://github.com/finos/FDC3/pull/516))
* `IntentResolution` now requires the name of the intent raised to included, allowing it to be used to determine the intent raised via `fdc3.raiseIntentForContext()`. ([#507](https://github.com/finos/FDC3/pull/507))
* The App Directory record schema (Application) has had the `manifestType` and `manifest` properties removed and replaced with the new `type` (required), `details` and `hostManifests` properties ([#437](https://github.com/finos/FDC3/pull/437))
* App Directory `images` field was replaced with `screenshots` to better align the application record with web application manifest and match its format to that used by `icons` ([#675](https://github.com/finos/FDC3/pull/675))
* API `AppMetadata` type was updated to replace the `images` field with a `screenshots` field (an array of `Image` objects) matching the spec of the App Directory's `screenshots` field entries ([#736](https://github.com/finos/FDC3/pull/736))
* App Directory endpoint for creating applications was removed as these will often be implementation dependent and should not be required for compliance ([#695](https://github.com/finos/FDC3/pull/695))
Expand Down Expand Up @@ -111,6 +109,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

* `addContextListener(contextType, handler)` now supports passing `null` as the context type ([#329](https://github.com/finos/FDC3/pull/329))
* All other API type changes and additions from the [FDC3 Standard 1.2](https://github.com/finos/FDC3/releases/tag/v1.2) release
* The Application schema by removing the `manifestType` and `manifest` properties, introducing new `type` (required), `details` and `hostManifests` properties ([#437](https://github.com/finos/FDC3/pull/437)

### Deprecated

Expand Down
Loading