@genesislcap/foundation-openfin 14.214.1-FUI-2233.1

package/dist/foundation-openfin.api.json

@@ -0,0 +1,574 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.34.9",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@tagname",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@fires",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true,
+        "@tagname": true,
+        "@fires": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@genesislcap/foundation-openfin!",
+  "docComment": "",
+  "name": "@genesislcap/foundation-openfin",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@genesislcap/foundation-openfin!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-openfin!isOpenFin:var",
+          "docComment": "/**\n * @remarks\n *\n * Util method to check whether an application is running in an openfin workspace container\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "isOpenFin: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => boolean"
+            }
+          ],
+          "fileUrlPath": "src/utils.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "isOpenFin",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/foundation-openfin!OpenfinNotifications:class",
+          "docComment": "/**\n * @remarks\n *\n * Openfin Notifications custom element\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-openfin!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": "Property",
+              "canonicalReference": "@genesislcap/foundation-openfin!OpenfinNotifications#mode:member",
+              "docComment": "/**\n * @remarks\n *\n * The notification sound mode\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "mode: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "'default' | 'silent'"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "mode",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-openfin!OpenfinNotifications#notificationsPlatform:member",
+              "docComment": "/**\n * @remarks\n *\n * Config for registering a workspace with the Openfin notifications component\n *\n * @example\n *\n * Create your notifications platform constant\n * ```ts\n * const notificationsPlatform: NotificationsPlatform = {\n *   id: 'platform-id', // the id of your openfin workspace\n *   icon: 'https://localhost:8080/path/to/icon.svg', // the url to the icon for your workspace\n *   title: 'Platform title' // the platform title which will appear in notifications\n * }\n * ```\n *\n * Setting the property in an html view template\n * ```html\n * <openfin-notifications-listener\n *   ...\n *   :notificationsPlatform=\"${() => notificationsPlatform}\"\n * >\n * </openfin-notifications-listener>\n * ```\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "notificationsPlatform: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "NotificationsPlatform",
+                  "canonicalReference": "@openfin/workspace!NotificationsPlatform:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "notificationsPlatform",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-openfin!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-openfin!OpenfinNotifications#toast:member",
+              "docComment": "/**\n * @remarks\n *\n * The notification type of toast messages\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "toast: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "'transient' | 'sticky' | 'none'"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "toast",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-openfin!OpenfinNotifications#toastButtons:member",
+              "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",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "toastButtons: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OpenfinToastButton",
+                  "canonicalReference": "@genesislcap/foundation-openfin!OpenfinToastButton:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "toastButtons",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-openfin!OpenfinToastButton:interface",
+          "docComment": "/**\n * @remarks\n *\n * OpenfinToastButton interface which extends ToastButton. Adds the task property which is used in mapping button actions to their corresponding callbacks\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface OpenfinToastButton extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "ToastButton",
+              "canonicalReference": "@genesislcap/foundation-notifications!ToastButton:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/notifications/openfin-notifications-listener.ts",
+          "releaseTag": "Public",
+          "name": "OpenfinToastButton",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-openfin!OpenfinToastButton#cta:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "cta?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "cta",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-openfin!OpenfinToastButton#message:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "message?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "message",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-openfin!OpenfinToastButton#task:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "task: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "task",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}