@genesislcap/foundation-fdc3 14.214.0 → 14.214.1-openfin-notifications.1

package/dist/dts/index.d.ts

@@ -9,4 +9,5 @@ export * from './fdc3-channel-event';
 export * from './util';
 export * from './utils';
 export * from './notifications/interop-notifications-listener';
+export * from './notifications/openfin-notifications-listener';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,EAAE,EAAE,gBAAgB,CAAC,GAAG,CAAC;KAC1B;CACF;AAGD,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,gDAAgD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,EAAE,EAAE,gBAAgB,CAAC,GAAG,CAAC;KAC1B;CACF;AAGD,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC"}

package/dist/dts/notifications/openfin-notifications-listener.d.ts

@@ -0,0 +1,15 @@
+import { NotificationDataRow } from '@genesislcap/foundation-notifications';
+import { NotificationListener } from '@genesislcap/foundation-ui';
+/**
+ * @tagname openfin-notification-listener
+ * @public
+ * @remarks
+ * This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the openfin notifications bus.
+ */
+export declare class OpenfinNotifications extends NotificationListener {
+    toast: string;
+    connectedCallback(): Promise<void>;
+    protected showNotificationToast(row: NotificationDataRow): Promise<void>;
+    private mapToastButtons;
+}
+//# sourceMappingURL=openfin-notifications-listener.d.ts.map

package/dist/dts/notifications/openfin-notifications-listener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openfin-notifications-listener.d.ts","sourceRoot":"","sources":["../../../src/notifications/openfin-notifications-listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAe,MAAM,uCAAuC,CAAC;AAGzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAsDlE;;;;;GAKG;AACH,qBAQa,oBAAqB,SAAQ,oBAAoB;IACtD,KAAK,EAAE,MAAM,CAAe;IAE5B,iBAAiB;cAoBP,qBAAqB,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B9E,OAAO,CAAC,eAAe;CAoBxB"}

package/dist/esm/index.js

@@ -4,3 +4,4 @@ export * from './fdc3-channel-event';
 export * from './util';
 export * from './utils';
 export * from './notifications/interop-notifications-listener';
+export * from './notifications/openfin-notifications-listener';

package/dist/esm/notifications/openfin-notifications-listener.js

@@ -0,0 +1,149 @@
+import { __awaiter, __decorate } from "tslib";
+import { NotificationListener } from '@genesislcap/foundation-ui';
+import { attr } from '@genesislcap/web-core';
+import { customElement, html, ref } from '@microsoft/fast-element';
+import * as Notifications from '@openfin/workspace/notifications';
+import { IndicatorColor } from '@openfin/workspace/notifications';
+import { init } from '@openfin/workspace-platform';
+const PLATFORM_ID = 'use-notifications';
+const PLATFORM_ICON = 'http://localhost:8080/images/icon-dot.png';
+const PLATFORM_TITLE = 'Use Notifications';
+const OpenfinGensisPriorityMap = {
+    Information: 1,
+    Warning: 2,
+    Serious: 3,
+    Critical: 4,
+};
+const OpenfinGensisColorMap = {
+    Information: 'blue',
+    Warning: 'yellow',
+    Serious: 'red',
+    Critical: 'red',
+};
+function initializeWorkspacePlatform() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield init({
+            browser: {
+                defaultWindowOptions: {
+                    icon: PLATFORM_ICON,
+                    workspacePlatform: {
+                        pages: [],
+                        favicon: PLATFORM_ICON,
+                    },
+                },
+            },
+        });
+    });
+}
+function initializeNotifications() {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log('initialise notifications');
+        yield Notifications.register({
+            notificationsPlatformOptions: {
+                id: PLATFORM_ID,
+                icon: PLATFORM_ICON,
+                title: PLATFORM_TITLE,
+            },
+        });
+        yield Notifications.addEventListener('notification-action', (event) => {
+            console.log(event, 'notification-action button clicked');
+        });
+    });
+}
+/**
+ * @tagname openfin-notification-listener
+ * @public
+ * @remarks
+ * This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the openfin notifications bus.
+ */
+let OpenfinNotifications = class OpenfinNotifications extends NotificationListener {
+    constructor() {
+        super(...arguments);
+        this.toast = 'transient';
+    }
+    connectedCallback() {
+        const _super = Object.create(null, {
+            connectedCallback: { get: () => super.connectedCallback }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            yield _super.connectedCallback.call(this);
+            yield initializeWorkspacePlatform();
+            yield initializeNotifications();
+            const notification = {
+                title: 'Simple Notification',
+                body: 'This is a simple notification',
+                toast: 'transient',
+                category: 'default',
+                template: 'markdown',
+                id: `${Math.random()}`,
+                soundOptions: {
+                    mode: 'silent',
+                },
+                platform: PLATFORM_ID,
+            };
+            yield Notifications.create(notification);
+        });
+    }
+    showNotificationToast(row) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { HEADER: title, MESSAGE: body, NOTIFY_SEVERITY: type } = row;
+            const notification = {
+                title,
+                body,
+                priority: OpenfinGensisPriorityMap[type],
+                toast: this.toast || 'transient',
+                category: type,
+                template: 'markdown',
+                id: `${Math.random()}`,
+                soundOptions: {
+                    mode: 'silent',
+                },
+                indicator: {
+                    text: title,
+                    color: OpenfinGensisColorMap[type],
+                    fallback: IndicatorColor.BLUE,
+                },
+                buttons: this.mapToastButtons(this.toastButtons),
+                platform: PLATFORM_ID,
+            };
+            try {
+                yield Notifications.create(notification);
+            }
+            catch (e) {
+                console.error('Openfin notifications error', e);
+            }
+        });
+    }
+    mapToastButtons(toastButtons) {
+        if (!toastButtons) {
+            return null;
+        }
+        return toastButtons.map((t) => {
+            return {
+                title: t.placeholder,
+                type: 'button',
+                onClick: {
+                    cta: true,
+                    task: 'acknowledge-task',
+                    customData: {
+                        message: 'Notification button clicked',
+                    },
+                },
+            };
+        });
+    }
+};
+__decorate([
+    attr
+], OpenfinNotifications.prototype, "toast", void 0);
+OpenfinNotifications = __decorate([
+    customElement({
+        name: 'openfin-notification-listener',
+        template: html `
+    <template ${ref('notificationListener')}>
+      <slot></slot>
+    </template>
+  `,
+    })
+], OpenfinNotifications);
+export { OpenfinNotifications };

package/dist/foundation-fdc3.api.json

@@ -1715,6 +1715,158 @@
             "startIndex": 1,
             "endIndex": 3
           }
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/foundation-fdc3!OpenfinNotifications:class",
+          "docComment": "/**\n * @remarks\n *\n * This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the openfin notifications bus.\n *\n * @tagname\n *\n * openfin-notification-listener\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class OpenfinNotifications extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "NotificationListener",
+              "canonicalReference": "@genesislcap/foundation-ui!NotificationListener:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/notifications/openfin-notifications-listener.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "OpenfinNotifications",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-fdc3!OpenfinNotifications#connectedCallback:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "connectedCallback(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "connectedCallback"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-fdc3!OpenfinNotifications#showNotificationToast:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected showNotificationToast(row: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "NotificationDataRow",
+                  "canonicalReference": "@genesislcap/foundation-notifications!NotificationDataRow:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "row",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "showNotificationToast"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-fdc3!OpenfinNotifications#toast:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "toast: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "toast",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
         }
       ]
     }

package/dist/foundation-fdc3.d.ts

@@ -1677,6 +1677,19 @@ export { Listener }
  */
 export declare const logger: Logger;
 
+/**
+ * @tagname openfin-notification-listener
+ * @public
+ * @remarks
+ * This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the openfin notifications bus.
+ */
+export declare class OpenfinNotifications extends NotificationListener {
+    toast: string;
+    connectedCallback(): Promise<void>;
+    protected showNotificationToast(row: NotificationDataRow): Promise<void>;
+    private mapToastButtons;
+}
+
 export { PrivateChannel }
 
 export { StandardIntent }

package/docs/api/foundation-fdc3.md

@@ -9,6 +9,7 @@
 |  Class | Description |
 |  --- | --- |
 |  [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) |  |
+|  [OpenfinNotifications](./foundation-fdc3.openfinnotifications.md) |  |
 
 ## Interfaces
 

package/docs/api/foundation-fdc3.openfinnotifications.connectedcallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [OpenfinNotifications](./foundation-fdc3.openfinnotifications.md) &gt; [connectedCallback](./foundation-fdc3.openfinnotifications.connectedcallback.md)
+
+## OpenfinNotifications.connectedCallback() method
+
+**Signature:**
+
+```typescript
+connectedCallback(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-fdc3.openfinnotifications.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [OpenfinNotifications](./foundation-fdc3.openfinnotifications.md)
+
+## OpenfinNotifications class
+
+**Signature:**
+
+```typescript
+export declare class OpenfinNotifications extends NotificationListener 
+```
+**Extends:** NotificationListener
+
+## Remarks
+
+This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the openfin notifications bus.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [toast](./foundation-fdc3.openfinnotifications.toast.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [connectedCallback()](./foundation-fdc3.openfinnotifications.connectedcallback.md) |  |  |
+|  [showNotificationToast(row)](./foundation-fdc3.openfinnotifications.shownotificationtoast.md) | <code>protected</code> |  |
+

package/docs/api/foundation-fdc3.openfinnotifications.shownotificationtoast.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [OpenfinNotifications](./foundation-fdc3.openfinnotifications.md) &gt; [showNotificationToast](./foundation-fdc3.openfinnotifications.shownotificationtoast.md)
+
+## OpenfinNotifications.showNotificationToast() method
+
+**Signature:**
+
+```typescript
+protected showNotificationToast(row: NotificationDataRow): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  row | NotificationDataRow |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-fdc3.openfinnotifications.toast.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [OpenfinNotifications](./foundation-fdc3.openfinnotifications.md) &gt; [toast](./foundation-fdc3.openfinnotifications.toast.md)
+
+## OpenfinNotifications.toast property
+
+**Signature:**
+
+```typescript
+toast: string;
+```

package/docs/api-report.md

@@ -264,6 +264,16 @@ export { Listener }
 // @public
 export const logger: Logger;
 
+// @public (undocumented)
+export class OpenfinNotifications extends NotificationListener {
+    // (undocumented)
+    connectedCallback(): Promise<void>;
+    // (undocumented)
+    protected showNotificationToast(row: NotificationDataRow): Promise<void>;
+    // (undocumented)
+    toast: string;
+}
+
 export { PrivateChannel }
 
 export { StandardIntent }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-fdc3",
   "description": "Genesis Foundation FDC3",
-  "version": "14.214.0",
+  "version": "14.214.1-openfin-notifications.1",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -59,26 +59,28 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.214.0",
-    "@genesislcap/genx": "14.214.0",
-    "@genesislcap/rollup-builder": "14.214.0",
-    "@genesislcap/ts-builder": "14.214.0",
-    "@genesislcap/uvu-playwright-builder": "14.214.0",
-    "@genesislcap/vite-builder": "14.214.0",
-    "@genesislcap/webpack-builder": "14.214.0",
+    "@genesislcap/foundation-testing": "14.211.5",
+    "@genesislcap/genx": "14.211.5",
+    "@genesislcap/rollup-builder": "14.211.5",
+    "@genesislcap/ts-builder": "14.211.5",
+    "@genesislcap/uvu-playwright-builder": "14.211.5",
+    "@genesislcap/vite-builder": "14.211.5",
+    "@genesislcap/webpack-builder": "14.211.5",
     "rimraf": "^5.0.0",
     "sinon": "^17.0.1"
   },
   "dependencies": {
     "@finos/fdc3": "2.1.1",
-    "@genesislcap/foundation-logger": "14.214.0",
-    "@genesislcap/foundation-notifications": "14.214.0",
-    "@genesislcap/foundation-ui": "14.214.0",
-    "@genesislcap/foundation-utils": "14.214.0",
-    "@genesislcap/web-core": "14.214.0",
+    "@genesislcap/foundation-logger": "14.211.5",
+    "@genesislcap/foundation-notifications": "14.211.5",
+    "@genesislcap/foundation-ui": "14.211.5",
+    "@genesislcap/foundation-utils": "14.211.5",
+    "@genesislcap/web-core": "14.211.5",
     "@interopio/desktop": "^6.3.1",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
+    "@openfin/workspace": "^19.1.23",
+    "@openfin/workspace-platform": "^19.1.23",
     "rxjs": "^7.5.4",
     "tslib": "^2.3.1"
   },
@@ -90,5 +92,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "12de0640c63d111cb448bd3204a9d2133afb9c49"
+  "gitHead": "d9d249f0436f4cc3d1491fe19b52caa78152982f"
 }