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.

Sign up for GitHub

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

Correcting privateChannelAddEventListenerRequest to include null as a valid listenerType #1446

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Correcting privateChannelAddEventListenerRequest to include null as a valid listenerType #1446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* Added support for event listening outside of intent or context listnener. Added new function `addEventListener`, type `EventHandler`, enum `FDC3EventType` and interfaces `FDC3Event` and `FDC3ChannelChangedEvent`. ([#1207](https://github.com/finos/FDC3/pull/1207))
* Added new `CreateOrUpdateProfile` intent. ([#1359](https://github.com/finos/FDC3/pull/1359))


### Changed

* `window.fdc3` is now an optional property and may or may not be defined. Applications should now use `getAgent()` as the recommended way of retrieving a reference to the FDC3 API. ([#1386](https://github.com/finos/FDC3/pull/1386))
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion schemas/api/privateChannelAddEventListenerRequest.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@
"listenerType": {
"title": "Event listener type",
"description": "The type of PrivateChannel event that the listener should be applied to.",
"$ref": "common.schema.json#/$defs/PrivateChannelEventListenerTypes"
"oneOf": [
{ "$ref": "common.schema.json#/$defs/PrivateChannelEventListenerTypes" },
{ "type": "null" }
]
}
},
"additionalProperties": false,
Expand Down
10 changes: 4 additions & 6 deletions src/api/BrowserTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1442,7 +1442,7 @@ export interface AppMetadata {
}

/**
* Describes an Icon images that may be used to represent the application.
* Describes an Icon image that may be used to represent the application.
*/
export interface Icon {
/**
Expand Down Expand Up @@ -2107,7 +2107,7 @@ export interface GetCurrentContextResponsePayload {
*/

/**
* Request to retrieve information about the FDC3 Desktop Agent implementation and the
* Request to retrieve information about the FDC3 Desktop Agent implementation and the
* metadata of the calling application according to the Desktop Agent.
*
* A request message from an FDC3-enabled app to a Desktop Agent.
Expand Down Expand Up @@ -2907,16 +2907,14 @@ export interface TPayload {
/**
* The type of PrivateChannel event that the listener should be applied to.
*/
listenerType: PrivateChannelEventListenerTypes;
listenerType: PrivateChannelEventListenerTypes | null;
/**
* The Id of the PrivateChannel that the listener should be added to.
*/
privateChannelId: string;
}

/**
* The type of PrivateChannel event that the listener should be applied to.
*
* Event listener type names for Private Channel events.
*/
export type PrivateChannelEventListenerTypes = "onAddContextListener" | "onUnsubscribe" | "onDisconnect";
Expand Down Expand Up @@ -5257,7 +5255,7 @@ const typeMap: any = {
{ json: "type", js: "type", typ: r("PrivateChannelAddEventListenerRequestType") },
], false),
"TPayload": o([
{ json: "listenerType", js: "listenerType", typ: r("PrivateChannelEventListenerTypes") },
{ json: "listenerType", js: "listenerType", typ: u(r("PrivateChannelEventListenerTypes"), null) },
{ json: "privateChannelId", js: "privateChannelId", typ: "" },
], false),
"PrivateChannelAddEventListenerResponse": o([
Expand Down
2 changes: 1 addition & 1 deletion src/context/ContextTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export type ActionType = "broadcast" | "raiseIntent";
export interface AppIdentifier {
/**
* The unique application identifier located within a specific application directory
* instance. An example of an appId might be '[email protected]'
* instance. An example of an appId might be '[email protected]'.
*/
appId: string;
/**
Expand Down