@genesislcap/foundation-openfin 14.418.2 → 14.419.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/dts/notifications/openfin-notifications-listener.d.ts +5 -2
  2. package/dist/dts/notifications/openfin-notifications-listener.d.ts.map +1 -1
  3. package/dist/esm/notifications/openfin-notifications-listener.js +5 -2
  4. package/dist/foundation-openfin.api.json +2 -2
  5. package/dist/foundation-openfin.d.ts +5 -2
  6. package/package.json +14 -14
package/dist/dts/notifications/openfin-notifications-listener.d.ts CHANGED
@@ -15,7 +15,10 @@ export interface OpenfinToastButton extends ToastButton {
15
15
  /**
16
16
  * @public
17
17
  * @remarks
18
- * Openfin Notifications custom element
18
+ * OpenFin Notifications custom element. Extends `NotificationListener` from `@genesislcap/foundation-ui` and routes
19
+ * Genesis notification rows to OpenFin Workspace `create`. Toast button tasks are delivered via OpenFin
20
+ * `addEventListener('notification-action', ...)` — this host does not define additional Genesis-style `CustomEvent` names
21
+ * beyond the base notification listener integration.
19
22
  */
20
23
  export declare class OpenfinNotificationListener extends NotificationListener {
21
24
  /**
@@ -70,7 +73,7 @@ export declare class OpenfinNotificationListener extends NotificationListener {
70
73
  * condition: ({details}) => details.HEADER === 'Trade added',
71
74
  * action: ({details, buttonElement }) => {
72
75
  * Route.path.push('/some-route') // redirect to a route
73
- * buttonElement.$emit('some-store-event', details.TABLE_ENTITY_ID); //emit the entity id to the store
76
+ * // Forward the entity id to your store (e.g. custom event or app-specific API)
74
77
  * }
75
78
  * },
76
79
  * placeholder: 'View Trade',
package/dist/dts/notifications/openfin-notifications-listener.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"openfin-notifications-listener.d.ts","sourceRoot":"","sources":["../../../src/notifications/openfin-notifications-listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAEzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGlE,OAAO,EAOL,qBAAqB,EAEtB,MAAM,kCAAkC,CAAC;AAgB1C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAUD;;;;GAIG;AACH,qBAQa,2BAA4B,SAAQ,oBAAoB;IACnE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,EAAE,qBAAqB,CAAC;IAE7C;;;;OAIG;IACG,KAAK,EAAE,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAe;IAE3D;;;;OAIG;IACG,IAAI,EAAE,SAAS,GAAG,QAAQ,CAAY;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IACH,YAAY,EAAE,kBAAkB,EAAE,CAAM;IAElC,iBAAiB;YAMT,kBAAkB;cAiBhB,qBAAqB,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B9E,OAAO,CAAC,eAAe;CA+BxB"}
1
+ {"version":3,"file":"openfin-notifications-listener.d.ts","sourceRoot":"","sources":["../../../src/notifications/openfin-notifications-listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAEzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGlE,OAAO,EAOL,qBAAqB,EAEtB,MAAM,kCAAkC,CAAC;AAgB1C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAUD;;;;;;;GAOG;AACH,qBAQa,2BAA4B,SAAQ,oBAAoB;IACnE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,EAAE,qBAAqB,CAAC;IAE7C;;;;OAIG;IACG,KAAK,EAAE,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAe;IAE3D;;;;OAIG;IACG,IAAI,EAAE,SAAS,GAAG,QAAQ,CAAY;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IACH,YAAY,EAAE,kBAAkB,EAAE,CAAM;IAElC,iBAAiB;YAMT,kBAAkB;cAiBhB,qBAAqB,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B9E,OAAO,CAAC,eAAe;CA+BxB"}
package/dist/esm/notifications/openfin-notifications-listener.js CHANGED
@@ -25,7 +25,10 @@ function initializeNotifications(notificationsPlatformOptions) {
25
25
  /**
26
26
  * @public
27
27
  * @remarks
28
- * Openfin Notifications custom element
28
+ * OpenFin Notifications custom element. Extends `NotificationListener` from `@genesislcap/foundation-ui` and routes
29
+ * Genesis notification rows to OpenFin Workspace `create`. Toast button tasks are delivered via OpenFin
30
+ * `addEventListener('notification-action', ...)` — this host does not define additional Genesis-style `CustomEvent` names
31
+ * beyond the base notification listener integration.
29
32
  */
30
33
  let OpenfinNotificationListener = class OpenfinNotificationListener extends NotificationListener {
31
34
  constructor() {
@@ -59,7 +62,7 @@ let OpenfinNotificationListener = class OpenfinNotificationListener extends Noti
59
62
  * condition: ({details}) => details.HEADER === 'Trade added',
60
63
  * action: ({details, buttonElement }) => {
61
64
  * Route.path.push('/some-route') // redirect to a route
62
- * buttonElement.$emit('some-store-event', details.TABLE_ENTITY_ID); //emit the entity id to the store
65
+ * // Forward the entity id to your store (e.g. custom event or app-specific API)
63
66
  * }
64
67
  * },
65
68
  * placeholder: 'View Trade',
package/dist/foundation-openfin.api.json CHANGED
@@ -211,7 +211,7 @@
211
211
  {
212
212
  "kind": "Class",
213
213
  "canonicalReference": "@genesislcap/foundation-openfin!OpenfinNotificationListener:class",
214
- "docComment": "/**\n * @remarks\n *\n * Openfin Notifications custom element\n *\n * @public\n */\n",
214
+ "docComment": "/**\n * @remarks\n *\n * OpenFin Notifications custom element. Extends `NotificationListener` from `@genesislcap/foundation-ui` and routes Genesis notification rows to OpenFin Workspace `create`. Toast button tasks are delivered via OpenFin `addEventListener('notification-action', ...)` — this host does not define additional Genesis-style `CustomEvent` names beyond the base notification listener integration.\n *\n * @public\n */\n",
215
215
  "excerptTokens": [
216
216
  {
217
217
  "kind": "Content",
@@ -417,7 +417,7 @@
417
417
  {
418
418
  "kind": "Property",
419
419
  "canonicalReference": "@genesislcap/foundation-openfin!OpenfinNotificationListener#toastButtons:member",
420
- "docComment": "/**\n * Array of button configs for openfin notification toasts\n *\n * @example\n *\n * In these examples you could 1. View a trade, this is done by routing to the corresponding route. Dispatching the highlighted record id to the store and retrieving it in the view from the store. 2. Call an endpoint to approve a trade 3. Call an endpoint to reject a trade\n * ```html\n * <openfin-notifications-listener\n * ...\n * :toastButtons=\"${x => [\n * {\n * {\n * condition: ({details}) => details.HEADER === 'Trade added',\n * action: ({details, buttonElement }) => {\n * Route.path.push('/some-route') // redirect to a route\n * buttonElement.$emit('some-store-event', details.TABLE_ENTITY_ID); //emit the entity id to the store\n * }\n * },\n * placeholder: 'View Trade',\n * task: 'view-trade'\n * },\n * {\n * {\n * condition: ({details}) => details.HEADER === 'Trade added',\n * action: ({details, buttonElement }) => {\n * const connect = getConnect();\n * connect.commitEvent('approve-trade', {\n * DETAILS: {\n * TRADE_ID: details.TABLE_ENTITY_ID,\n * APPROVED: true\n * }\n * })\n * }\n * },\n * placeholder: 'Approve Trade',\n * task: 'approve-trade'\n * },\n * {\n * {\n * condition: ({details}) => details.HEADER === 'Trade added',\n * action: ({details, buttonElement }) => {\n * const connect = getConnect();\n * connect.commitEvent('approve-trade', {\n * DETAILS: {\n * TRADE_ID: details.TABLE_ENTITY_ID,\n * APPROVED: false\n * }\n * })\n * }\n * },\n * placeholder: 'Reject Trade',\n * task: 'reject-trade'\n * },\n *\n * ]\n * >\n * </openfin-notifications-listener>\n * ```\n *\n * @public\n */\n",
420
+ "docComment": "/**\n * Array of button configs for openfin notification toasts\n *\n * @example\n *\n * In these examples you could 1. View a trade, this is done by routing to the corresponding route. Dispatching the highlighted record id to the store and retrieving it in the view from the store. 2. Call an endpoint to approve a trade 3. Call an endpoint to reject a trade\n * ```html\n * <openfin-notifications-listener\n * ...\n * :toastButtons=\"${x => [\n * {\n * {\n * condition: ({details}) => details.HEADER === 'Trade added',\n * action: ({details, buttonElement }) => {\n * Route.path.push('/some-route') // redirect to a route\n * // Forward the entity id to your store (e.g. custom event or app-specific API)\n * }\n * },\n * placeholder: 'View Trade',\n * task: 'view-trade'\n * },\n * {\n * {\n * condition: ({details}) => details.HEADER === 'Trade added',\n * action: ({details, buttonElement }) => {\n * const connect = getConnect();\n * connect.commitEvent('approve-trade', {\n * DETAILS: {\n * TRADE_ID: details.TABLE_ENTITY_ID,\n * APPROVED: true\n * }\n * })\n * }\n * },\n * placeholder: 'Approve Trade',\n * task: 'approve-trade'\n * },\n * {\n * {\n * condition: ({details}) => details.HEADER === 'Trade added',\n * action: ({details, buttonElement }) => {\n * const connect = getConnect();\n * connect.commitEvent('approve-trade', {\n * DETAILS: {\n * TRADE_ID: details.TABLE_ENTITY_ID,\n * APPROVED: false\n * }\n * })\n * }\n * },\n * placeholder: 'Reject Trade',\n * task: 'reject-trade'\n * },\n *\n * ]\n * >\n * </openfin-notifications-listener>\n * ```\n *\n * @public\n */\n",
421
421
  "excerptTokens": [
422
422
  {
423
423
  "kind": "Content",
package/dist/foundation-openfin.d.ts CHANGED
@@ -13,7 +13,10 @@ export declare const isOpenFin: () => boolean;
13
13
  /**
14
14
  * @public
15
15
  * @remarks
16
- * Openfin Notifications custom element
16
+ * OpenFin Notifications custom element. Extends `NotificationListener` from `@genesislcap/foundation-ui` and routes
17
+ * Genesis notification rows to OpenFin Workspace `create`. Toast button tasks are delivered via OpenFin
18
+ * `addEventListener('notification-action', ...)` — this host does not define additional Genesis-style `CustomEvent` names
19
+ * beyond the base notification listener integration.
17
20
  */
18
21
  export declare class OpenfinNotificationListener extends NotificationListener {
19
22
  /**
@@ -68,7 +71,7 @@ export declare class OpenfinNotificationListener extends NotificationListener {
68
71
  * condition: ({details}) => details.HEADER === 'Trade added',
69
72
  * action: ({details, buttonElement }) => {
70
73
  * Route.path.push('/some-route') // redirect to a route
71
- * buttonElement.$emit('some-store-event', details.TABLE_ENTITY_ID); //emit the entity id to the store
74
+ * // Forward the entity id to your store (e.g. custom event or app-specific API)
72
75
  * }
73
76
  * },
74
77
  * placeholder: 'View Trade',
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-openfin",
3
3
  "description": "Genesis Foundation Openfin",
4
- "version": "14.418.2",
4
+ "version": "14.419.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -61,22 +61,22 @@
61
61
  }
62
62
  },
63
63
  "devDependencies": {
64
- "@genesislcap/foundation-testing": "14.418.2",
65
- "@genesislcap/genx": "14.418.2",
66
- "@genesislcap/rollup-builder": "14.418.2",
67
- "@genesislcap/ts-builder": "14.418.2",
68
- "@genesislcap/uvu-playwright-builder": "14.418.2",
69
- "@genesislcap/vite-builder": "14.418.2",
70
- "@genesislcap/webpack-builder": "14.418.2",
64
+ "@genesislcap/foundation-testing": "14.419.1",
65
+ "@genesislcap/genx": "14.419.1",
66
+ "@genesislcap/rollup-builder": "14.419.1",
67
+ "@genesislcap/ts-builder": "14.419.1",
68
+ "@genesislcap/uvu-playwright-builder": "14.419.1",
69
+ "@genesislcap/vite-builder": "14.419.1",
70
+ "@genesislcap/webpack-builder": "14.419.1",
71
71
  "sinon": "^17.0.1"
72
72
  },
73
73
  "dependencies": {
74
74
  "@finos/fdc3": "2.1.1",
75
- "@genesislcap/foundation-logger": "14.418.2",
76
- "@genesislcap/foundation-notifications": "14.418.2",
77
- "@genesislcap/foundation-ui": "14.418.2",
78
- "@genesislcap/foundation-utils": "14.418.2",
79
- "@genesislcap/web-core": "14.418.2",
75
+ "@genesislcap/foundation-logger": "14.419.1",
76
+ "@genesislcap/foundation-notifications": "14.419.1",
77
+ "@genesislcap/foundation-ui": "14.419.1",
78
+ "@genesislcap/foundation-utils": "14.419.1",
79
+ "@genesislcap/web-core": "14.419.1",
80
80
  "@interopio/desktop": "^6.3.1",
81
81
  "@openfin/workspace": "^20.4.0",
82
82
  "@openfin/workspace-platform": "^20.4.0",
@@ -90,5 +90,5 @@
90
90
  "publishConfig": {
91
91
  "access": "public"
92
92
  },
93
- "gitHead": "ae9a9252a0ca0d35759886db9b502921e3a3e831"
93
+ "gitHead": "e4880f9a62bd7ebb0a0e4798c8dfdd98de5c6e14"
94
94
  }