npm - @genesislcap/foundation-openfin - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-openfin 14.408.0 → 14.409.0

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 (17) hide show

package/README.md CHANGED Viewed

@@ -1,78 +1,25 @@
-# Genesis Foundation Openfin
+# @genesislcap/foundation-openfin
-This provides a robust implementation of the Openfin workspace container
+Documentation for this package is published on the Genesis docs site:
-## API Documentation
-For more detailed information on API and configurations, please refer to the [API documentation](docs/api/index.md) in the `docs/api` directory.
+**Docs: [Foundation Openfin](https://docs.genesis.global/docs/develop/client-capabilities/desktop-interoperability/openfin/foundation-openfin/)**
 ## Installation
-To include `@genesislcap/foundation-openfin` in your project, add it as a dependency in your `package.json` file and follow your project's routine for dependency installation.
-This package depends on a newer version of typescript which you will also need to add to your package json
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 ```json
 {
   "dependencies": {
-    ...
-    "@genesislcap/foundation-openfin": "latest",
-    "typescript": "^5.6.3",
-    ...
+    "@genesislcap/foundation-openfin": "latest"
   }
 }
 ```
-## Key Features
-- **Openfin Notifications:** Implements a component to create openfin notifications
-## Usage Examples
-### Adding Intent Listeners
-```html
-<openfin-notifications
-  resource-name="ALL_NOTIFY_ALERT_RECORDS"
-  data-pbc-asset-id="interop-notification-listener"
-  :notificationsPlatform="${() => ({
-  id: PLATFORM_ID,
-    icon: PLATFORM_ICON,
-    title: PLATFORM_TITLE
-  })}"
-  :toastButtons="${x => [
-      {
-        condition: ({details}) => details.HEADER === 'Trade added',
-          action: ({details, buttonElement }) => {
-        Route.path.push('/some-route')
-        if (buttonElement) {
-          buttonElement.$emit('some-event', details.TABLE_ENTITY_ID);
-        }
-      },
-      {
-      condition: ({details}) => details.HEADER === 'Trade added',
-      action: async ({details, buttonElement }) => {
-        const connect = getConnect();
-        const response = await connect.commitEvent('EVENT_APPROVE_TRADE', {
-          DETAILS: {
-            TRADE_ID: details.TABLE_ENTITY_ID
-          }
-        })
-        if (response.ERROR?.length) {
-          debugger;
-        }
-      },
-      placeholder: 'Approve Trade',
-      task: 'approve-trade'
-    },
-  ]}"
-></openfin-notifications>
-```
 ## License
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 ### Licensed components
 Genesis low-code platform

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-openfin",
   "description": "Genesis Foundation Openfin",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -61,22 +61,22 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0",
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0",
     "sinon": "^17.0.1"
   },
   "dependencies": {
     "@finos/fdc3": "2.1.1",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-notifications": "14.408.0",
-    "@genesislcap/foundation-ui": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
-    "@genesislcap/web-core": "14.408.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-notifications": "14.409.0",
+    "@genesislcap/foundation-ui": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
+    "@genesislcap/web-core": "14.409.0",
     "@interopio/desktop": "^6.3.1",
     "@openfin/workspace": "^20.4.0",
     "@openfin/workspace-platform": "^20.4.0",
@@ -90,5 +90,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-openfin.isopenfin.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [isOpenFin](./foundation-openfin.isopenfin.md)
-## isOpenFin() function
-**Signature:**
-```typescript
-isOpenFin: () => boolean
-```
-**Returns:**
-boolean
-## Remarks
-Util method to check whether an application is running in an openfin workspace container

package/docs/api/foundation-openfin.md DELETED Viewed

@@ -1,78 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md)
-## foundation-openfin package
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[isOpenFin()](./foundation-openfin.isopenfin.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[OpenfinToastButton](./foundation-openfin.openfintoastbutton.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-openfin.openfinnotificationlistener.connectedcallback.md DELETED Viewed

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

package/docs/api/foundation-openfin.openfinnotificationlistener.md DELETED Viewed

@@ -1,164 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md)
-## OpenfinNotificationListener class
-**Signature:**
-```typescript
-export declare class OpenfinNotificationListener extends NotificationListener
-```
-**Extends:** NotificationListener
-## Remarks
-Openfin Notifications custom element
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[mode](./foundation-openfin.openfinnotificationlistener.mode.md)
-</td><td>
-</td><td>
-'default' \| 'silent'
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[notificationsPlatform](./foundation-openfin.openfinnotificationlistener.notificationsplatform.md)
-</td><td>
-</td><td>
-NotificationsPlatform
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[toast](./foundation-openfin.openfinnotificationlistener.toast.md)
-</td><td>
-</td><td>
-'transient' \| 'sticky' \| 'none'
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[toastButtons](./foundation-openfin.openfinnotificationlistener.toastbuttons.md)
-</td><td>
-</td><td>
-[OpenfinToastButton](./foundation-openfin.openfintoastbutton.md)<!-- -->\[\]
-</td><td>
-Array of button configs for openfin notification toasts
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[connectedCallback()](./foundation-openfin.openfinnotificationlistener.connectedcallback.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[showNotificationToast(row)](./foundation-openfin.openfinnotificationlistener.shownotificationtoast.md)
-</td><td>
-`protected`
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-openfin.openfinnotificationlistener.mode.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md) &gt; [mode](./foundation-openfin.openfinnotificationlistener.mode.md)
-## OpenfinNotificationListener.mode property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-mode: 'default' | 'silent';
-```
-## Remarks
-The notification sound mode

package/docs/api/foundation-openfin.openfinnotificationlistener.notificationsplatform.md DELETED Viewed

@@ -1,40 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md) &gt; [notificationsPlatform](./foundation-openfin.openfinnotificationlistener.notificationsplatform.md)
-## OpenfinNotificationListener.notificationsPlatform property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-notificationsPlatform: NotificationsPlatform;
-```
-## Remarks
-Config for registering a workspace with the Openfin notifications component
-## Example
-Create your notifications platform constant
-```ts
-const notificationsPlatform: NotificationsPlatform = {
-  id: 'platform-id', // the id of your openfin workspace
-  icon: 'https://localhost:8080/path/to/icon.svg', // the url to the icon for your workspace
-  title: 'Platform title' // the platform title which will appear in notifications
-}
-```
-Setting the property in an html view template
-```html
-<openfin-notifications-listener
-  ...
-  :notificationsPlatform="${() => notificationsPlatform}"
->
-</openfin-notifications-listener>
-```

package/docs/api/foundation-openfin.openfinnotificationlistener.shownotificationtoast.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md) &gt; [showNotificationToast](./foundation-openfin.openfinnotificationlistener.shownotificationtoast.md)
-## OpenfinNotificationListener.showNotificationToast() method
-**Signature:**
-```typescript
-protected showNotificationToast(row: NotificationDataRow): Promise<void>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-row
-</td><td>
-NotificationDataRow
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;void&gt;

package/docs/api/foundation-openfin.openfinnotificationlistener.toast.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md) &gt; [toast](./foundation-openfin.openfinnotificationlistener.toast.md)
-## OpenfinNotificationListener.toast property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-toast: 'transient' | 'sticky' | 'none';
-```
-## Remarks
-The notification type of toast messages

package/docs/api/foundation-openfin.openfinnotificationlistener.toastbuttons.md DELETED Viewed

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinNotificationListener](./foundation-openfin.openfinnotificationlistener.md) &gt; [toastButtons](./foundation-openfin.openfinnotificationlistener.toastbuttons.md)
-## OpenfinNotificationListener.toastButtons property
-Array of button configs for openfin notification toasts
-**Signature:**
-```typescript
-toastButtons: OpenfinToastButton[];
-```
-## Example
-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
-```html
-<openfin-notifications-listener
-  ...
-  :toastButtons="${x => [
-    {
-      {
-        condition: ({details}) => details.HEADER === 'Trade added',
-        action: ({details, buttonElement }) => {
-          Route.path.push('/some-route') // redirect to a route
-          buttonElement.$emit('some-store-event', details.TABLE_ENTITY_ID); //emit the entity id to the store
-        }
-      },
-      placeholder: 'View Trade',
-      task: 'view-trade'
-   },
-   {
-      {
-        condition: ({details}) => details.HEADER === 'Trade added',
-        action: ({details, buttonElement }) => {
-          const connect = getConnect();
-          connect.commitEvent('approve-trade', {
-            DETAILS: {
-              TRADE_ID: details.TABLE_ENTITY_ID,
-              APPROVED: true
-            }
-          })
-        }
-      },
-      placeholder: 'Approve Trade',
-      task: 'approve-trade'
-   },
-   {
-      {
-        condition: ({details}) => details.HEADER === 'Trade added',
-        action: ({details, buttonElement }) => {
-          const connect = getConnect();
-          connect.commitEvent('approve-trade', {
-            DETAILS: {
-              TRADE_ID: details.TABLE_ENTITY_ID,
-              APPROVED: false
-            }
-          })
-        }
-      },
-      placeholder: 'Reject Trade',
-      task: 'reject-trade'
-   },
- ]
->
-</openfin-notifications-listener>
-```

package/docs/api/foundation-openfin.openfintoastbutton.cta.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinToastButton](./foundation-openfin.openfintoastbutton.md) &gt; [cta](./foundation-openfin.openfintoastbutton.cta.md)
-## OpenfinToastButton.cta property
-**Signature:**
-```typescript
-cta?: boolean;
-```

package/docs/api/foundation-openfin.openfintoastbutton.md DELETED Viewed

@@ -1,97 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-openfin](./foundation-openfin.md) &gt; [OpenfinToastButton](./foundation-openfin.openfintoastbutton.md)
-## OpenfinToastButton interface
-**Signature:**
-```typescript
-export interface OpenfinToastButton extends ToastButton
-```
-**Extends:** ToastButton
-## Remarks
-OpenfinToastButton interface which extends ToastButton. Adds the task property which is used in mapping button actions to their corresponding callbacks
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[cta?](./foundation-openfin.openfintoastbutton.cta.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[message?](./foundation-openfin.openfintoastbutton.message.md)
-</td><td>
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[task](./foundation-openfin.openfintoastbutton.task.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-openfin.openfintoastbutton.message.md DELETED Viewed

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

package/docs/api/foundation-openfin.openfintoastbutton.task.md DELETED Viewed

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

package/docs/api/index.md DELETED Viewed

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md)
-## API Reference
-## Packages
-<table><thead><tr><th>
-Package
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[@genesislcap/foundation-openfin](./foundation-openfin.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api-report.md.api.md DELETED Viewed

@@ -1,42 +0,0 @@
-## API Report File for "@genesislcap/foundation-openfin"
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-```ts
-import { NotificationDataRow } from '@genesislcap/foundation-notifications';
-import { NotificationListener } from '@genesislcap/foundation-ui';
-import { NotificationsPlatform } from '@openfin/workspace/notifications';
-import { ToastButton } from '@genesislcap/foundation-notifications';
-// @public (undocumented)
-export const isOpenFin: () => boolean;
-// @public (undocumented)
-export class OpenfinNotificationListener extends NotificationListener {
-    // (undocumented)
-    connectedCallback(): Promise<void>;
-    // @beta (undocumented)
-    mode: 'default' | 'silent';
-    // @beta (undocumented)
-    notificationsPlatform: NotificationsPlatform;
-    // (undocumented)
-    protected showNotificationToast(row: NotificationDataRow): Promise<void>;
-    // @beta (undocumented)
-    toast: 'transient' | 'sticky' | 'none';
-    toastButtons: OpenfinToastButton[];
-}
-// @public (undocumented)
-export interface OpenfinToastButton extends ToastButton {
-    // (undocumented)
-    cta?: boolean;
-    // (undocumented)
-    message?: string;
-    // (undocumented)
-    task: string;
-}
-// (No @packageDocumentation comment for this package)
-```