@openfin/cloud-api 0.0.1-alpha.4f8b7372 → 0.0.1-alpha.8d5ffd0

package/README.md

@@ -0,0 +1,59 @@
+# @openfin/cloud-api
+
+Client library for interacting with notifications when used as part of the OpenFin Cloud Platform.
+
+<!-- High-level description of what this package is useful for. Include specific use case/s whenever possible. -->
+
+<!-- Depending on package, explain why this package vs a different one, and link to other options. -->
+
+Related packages:
+
+-   [@openfin/workspace](https://www.npmjs.com/package/@openfin/workspace)
+-   [@openfin/workspace-platform](https://www.npmjs.com/package/@openfin/workspace-platform)
+
+<!-- For more information about how to work with this package, see [{the relevant docs}]({relevant_docs_link}). -->
+
+## Prerequisites
+
+None.
+
+## Installation
+
+With npm:
+
+> npm -i @openfin/cloud-api
+
+With pnpm:
+
+> pnpm add @openfin/cloud-api
+
+With bun:
+
+> bun add @openfin/cloud-api
+
+With yarn:
+
+> yarn global add @openfin/cloud-api
+
+## Usage
+
+<!-- If this is a command-line tool, this is some basic usage info. -->
+
+<!-- If it is a library, link to the specific section of the developer guide or api refdoc. (This might mean repeating links already -->
+<!-- provided in the first section of the readme. This is FINE.) -->
+
+<!-- ## For more information -->
+
+<!-- -   [{Developer guide}]({relevant_docs_link}). -->
+<!-- -   [{API reference}]({relevant_docs_link}). -->
+<!-- - See the [workspace-starter]() project for example code.-->
+
+## License
+
+Copyright 2024-2024 OpenFin
+
+The code in this package is distributed under the {relevant license}.
+
+However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the link listed below or email us at support@openfin.co with questions.
+
+-   [Developer license](https://openfin.co/developer-agreement/)

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":["PACKAGE_NAME","getChannelName","isInViewContext","extractAppUuidFromIdentity","identity","notificationsClientPromise","getNotificationsClient","getNotificationsClientInternal","channelPromise","getChannelClient","message","listener","eventListeners","eventName","listeners","options","notificationId","channelClientPromise","getChannelClientInternal","channel"],"mappings":"AAMA,IAAMA,EAAe,qBAmBrB,SAASC,GAAiB,CACtB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,0BAChC,CAEA,eAAeC,GAAoC,CAC/C,GAAI,CACA,aAAM,OAAO,IAAI,KAAK,eAAe,EAAE,QAAQ,EACxC,EACX,MAAQ,CACJ,MAAO,EACX,CACJ,CAEA,SAASC,EAA2BC,EAAoC,CACpE,GAAIA,EAAS,KAAK,WAAW,oBAAoB,EAC7C,MAAM,IAAI,MAAM,uCAAuC,EAG3D,MAAI,mBAAmB,KAAKA,EAAS,IAAI,EAC9BA,EAAS,KAAK,MAAM,GAAG,EAAE,CAAC,GAAK,GAGnCA,EAAS,IACpB,CAEA,IAAIC,EAAkE,KAStE,eAAeC,GAAuD,CAClE,OAAKD,IACDA,EAA6BE,EAA+B,GAGzDF,CACX,CAEA,eAAeE,GAA+D,CAC1E,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKP,CAAY,4EAA4E,EAGjH,GAAK,MAAME,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGF,CAAY,0EAA0E,EAG7GG,EAA2B,OAAO,IAAI,EAAE,EAExC,IAAMK,EAAiB,MAAMC,EAAiB,EAC9C,QAAQ,IAAID,CAAc,EAE1BA,EAAe,SAAS,sBAAwBE,GAAY,CACxD,QAAWC,KAAYC,EAAe,IAAIF,EAAQ,IAAI,GAAK,CAAC,EAEpD,OAAOA,EAAQ,QAAQ,WAAc,WACrCA,EAAQ,QAAQ,UAAY,IAAI,KAAKA,EAAQ,QAAQ,SAAS,GAGlEC,EAASD,EAAQ,OAAgB,CAEzC,CAAC,EAED,IAAME,EAAiB,IAAI,IAE3B,MAAO,CACH,iBAAkB,CAAwCC,EAAcF,IAAuC,CAC3G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,GAAK,IAAI,IACvDC,EAAU,IAAIH,CAAQ,EACtBC,EAAe,IAAIC,EAAWC,CAAS,CAC3C,EACA,oBAAqB,CAAwCD,EAAcF,IAAuC,CAC9G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,EAC9C,GAAI,CAACC,EAAW,CACZ,QAAQ,KACJ,KAAKd,CAAY,+HACjBa,CACJ,EACA,MACJ,CAEIC,EAAU,OAAOH,CAAmC,IAAM,IAC1D,QAAQ,KAAK,KAAKX,CAAY,iGAAkGa,CAAS,CAEjJ,EACA,OAAQ,MAAOE,IACM,MAAMP,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAcO,CAClB,CACJ,CAAC,GACe,QAAQ,SAE5B,MAAO,MAAOC,IACO,MAAMR,EAAe,SAAS,mCAAoC,CAC/E,QAAS,EACT,QAAS,CACL,eAAAQ,CACJ,CACJ,CAAC,GACe,QAAQ,SAE5B,mBAAoB,MAChBD,IAEIA,EAAQ,IACR,QAAQ,KACJ,KAAKf,CAAY,+KACrB,GAEa,MAAMQ,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAc,CAAE,GAAGO,EAAS,GAAI,MAAU,CAC9C,CACJ,CAAC,GACe,QAAQ,SAEhC,CACJ,CAEA,IAAIE,EAA6D,KAEjE,eAAeR,GAAkD,CAC7D,OAAKQ,IACDA,EAAuBC,EAAyB,GAG7CD,CACX,CAEA,eAAeC,GAA0D,CACrE,IAAMC,EAAW,MAAM,OAAO,IAAI,oBAAoB,QAAQ,QAAQlB,EAAe,CAAC,EAEtF,OAAAkB,EAAQ,gBAAiBf,GAAa,CAClC,QAAQ,KAAK,KAAKJ,CAAY,gCAAiCI,EAAU,iBAAiB,EAC1Fa,EAAuB,IAC3B,CAAC,EAEME,CACX","sourcesContent":["// eslint-disable-next-line check-file/no-index\nimport type OpenFin from '@openfin/core';\nimport type * as NotificationsTypes from 'openfin-notifications';\n\nimport type { FlannelChannelClient, NotificationEventsMap, NotificationsClient } from './types';\n\nconst PACKAGE_NAME = '@openfin/cloud-api';\n\nexport type {\n    FlannelChannelProvider as __INTERNAL_FlannelChannelProvider,\n    FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest,\n    FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse,\n    FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest,\n    FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse,\n    FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest,\n    FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse,\n} from './types';\n\ndeclare global {\n    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions\n    interface Window {\n        fin: typeof import('@openfin/core').fin;\n    }\n}\n\nfunction getChannelName() {\n    return `${window.fin.me.uuid}-cloud-api-notifications`;\n}\n\nasync function isInViewContext(): Promise<boolean> {\n    try {\n        await window.fin.View.getCurrentSync().getInfo();\n        return true;\n    } catch {\n        return false;\n    }\n}\n\nfunction extractAppUuidFromIdentity(identity: OpenFin.Identity): string {\n    if (identity.name.startsWith('internal-generated')) {\n        throw new Error('Cannot extract app UUID from identity');\n    }\n    // <uuid>/<name>\n    if (/\\/[\\d,a-z-]{36}$/.test(identity.name)) {\n        return identity.name.split('/')[0] || '';\n    }\n\n    return identity.name;\n}\n\nlet notificationsClientPromise: Promise<NotificationsClient> | null = null;\n\n/**\n * @returns A client for interacting with the OpenFin Notifications service\n *\n * @throws {Error} If the function is called outside of an OpenFin environment\n * @throws {Error} If the function is called outside of an OpenFin View context\n * @throws {Error} If the app UUID cannot be extracted from the current context\n */\nasync function getNotificationsClient(): Promise<NotificationsClient> {\n    if (!notificationsClientPromise) {\n        notificationsClientPromise = getNotificationsClientInternal();\n    }\n\n    return notificationsClientPromise;\n}\n\nasync function getNotificationsClientInternal(): Promise<NotificationsClient> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    extractAppUuidFromIdentity(window.fin.me);\n\n    const channelPromise = await getChannelClient();\n    console.log(channelPromise);\n\n    channelPromise.register('openfin-cloud-event', (message) => {\n        for (const listener of eventListeners.get(message.type) ?? []) {\n            // `Date` is serialized as a string, so we need to convert it back\n            if (typeof message.payload.timestamp === 'string') {\n                message.payload.timestamp = new Date(message.payload.timestamp);\n            }\n\n            listener(message.payload as never);\n        }\n    });\n\n    const eventListeners = new Map<keyof NotificationEventsMap, Set<NotificationEventsMap[keyof NotificationEventsMap]>>();\n\n    return {\n        addEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName) || new Set();\n            listeners.add(listener);\n            eventListeners.set(eventName, listeners);\n        },\n        removeEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName);\n            if (!listeners) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,\n                    eventName,\n                );\n                return;\n            }\n\n            if (listeners.delete(listener as (args: unknown) => void) === false) {\n                console.warn(`\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference?`, eventName);\n            }\n        },\n        update: async (options: Parameters<typeof NotificationsTypes.update>[0]): ReturnType<typeof NotificationsTypes.update> => {\n            const response = await channelPromise.dispatch('openfin-cloud-update-notification', {\n                version: 1,\n                payload: {\n                    notification: options,\n                },\n            });\n            return response.payload.response;\n        },\n        clear: async (notificationId: Parameters<typeof NotificationsTypes.clear>[0]): ReturnType<typeof NotificationsTypes.clear> => {\n            const response = await channelPromise.dispatch('openfin-cloud-clear-notification', {\n                version: 1,\n                payload: {\n                    notificationId,\n                },\n            });\n            return response.payload.response;\n        },\n        createNotification: async (\n            options: NotificationsTypes.NotificationOptions,\n        ): Promise<NotificationsTypes.Notification<NotificationsTypes.NotificationOptions>> => {\n            if (options.id) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: The \\`id\\` property is not supported and will be ignored. If you need to use the \\`id\\` property, you should use the \\`id\\` property of the returned notification object.`,\n                );\n            }\n            const response = await channelPromise.dispatch('openfin-cloud-create-notification', {\n                version: 1,\n                payload: {\n                    notification: { ...options, id: undefined },\n                },\n            });\n            return response.payload.response;\n        },\n    };\n}\n\nlet channelClientPromise: Promise<FlannelChannelClient> | null = null;\n\nasync function getChannelClient(): Promise<FlannelChannelClient> {\n    if (!channelClientPromise) {\n        channelClientPromise = getChannelClientInternal();\n    }\n\n    return channelClientPromise;\n}\n\nasync function getChannelClientInternal(): Promise<FlannelChannelClient> {\n    const channel = (await window.fin.InterApplicationBus.Channel.connect(getChannelName())) as FlannelChannelClient;\n\n    channel.onDisconnection((identity) => {\n        console.warn(`\\`${PACKAGE_NAME}\\`: Channel Disconnected from`, identity, 'Reconnecting...');\n        channelClientPromise = null;\n    });\n\n    return channel;\n}\n\nexport { getNotificationsClient };\n"]}
+{"version":3,"sources":["../src/index.ts"],"names":["PACKAGE_NAME","getChannelName","isInViewContext","extractAppUuidFromIdentity","identity","notificationsClientPromise","getNotificationsClient","getNotificationsClientInternal","channelPromise","getChannelClient","message","listener","eventListeners","eventName","listeners","options","notificationId","channelClientPromise","getChannelClientInternal","channel"],"mappings":"AAMA,IAAMA,EAAe,qBAmBrB,SAASC,GAAiB,CACtB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,0BAChC,CAEA,eAAeC,GAAoC,CAC/C,GAAI,CACA,aAAM,OAAO,IAAI,KAAK,eAAe,EAAE,QAAQ,EACxC,EACX,MAAQ,CACJ,MAAO,EACX,CACJ,CAEA,SAASC,EAA2BC,EAAoC,CACpE,GAAIA,EAAS,KAAK,WAAW,oBAAoB,EAC7C,MAAM,IAAI,MAAM,uCAAuC,EAG3D,MAAI,mBAAmB,KAAKA,EAAS,IAAI,EAC9BA,EAAS,KAAK,MAAM,GAAG,EAAE,CAAC,GAAK,GAGnCA,EAAS,IACpB,CAEA,IAAIC,EAAkE,KAmDtE,eAAeC,GAAuD,CAClE,OAAKD,IACDA,EAA6BE,EAA+B,GAGzDF,CACX,CAEA,eAAeE,GAA+D,CAC1E,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKP,CAAY,4EAA4E,EAGjH,GAAK,MAAME,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGF,CAAY,0EAA0E,EAG7GG,EAA2B,OAAO,IAAI,EAAE,EAExC,IAAMK,EAAiB,MAAMC,EAAiB,EAC9C,QAAQ,IAAID,CAAc,EAE1BA,EAAe,SAAS,sBAAwBE,GAAY,CACxD,QAAWC,KAAYC,EAAe,IAAIF,EAAQ,IAAI,GAAK,CAAC,EAEpD,OAAOA,EAAQ,QAAQ,WAAc,WACrCA,EAAQ,QAAQ,UAAY,IAAI,KAAKA,EAAQ,QAAQ,SAAS,GAGlEC,EAASD,EAAQ,OAAgB,CAEzC,CAAC,EAED,IAAME,EAAiB,IAAI,IAE3B,MAAO,CACH,iBAAkB,CAAwCC,EAAcF,IAAuC,CAC3G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,GAAK,IAAI,IACvDC,EAAU,IAAIH,CAAQ,EACtBC,EAAe,IAAIC,EAAWC,CAAS,CAC3C,EACA,oBAAqB,CAAwCD,EAAcF,IAAuC,CAC9G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,EAC9C,GAAI,CAACC,EAAW,CACZ,QAAQ,KACJ,KAAKd,CAAY,+HACjBa,CACJ,EACA,MACJ,CAEIC,EAAU,OAAOH,CAAmC,IAAM,IAC1D,QAAQ,KAAK,KAAKX,CAAY,iGAAkGa,CAAS,CAEjJ,EACA,OAAQ,MAAOE,IACM,MAAMP,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAcO,CAClB,CACJ,CAAC,GACe,QAAQ,SAE5B,MAAO,MAAOC,IACO,MAAMR,EAAe,SAAS,mCAAoC,CAC/E,QAAS,EACT,QAAS,CACL,eAAAQ,CACJ,CACJ,CAAC,GACe,QAAQ,SAE5B,mBAAoB,MAChBD,IAEIA,EAAQ,IACR,QAAQ,KACJ,KAAKf,CAAY,+KACrB,GAEa,MAAMQ,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAc,CAAE,GAAGO,EAAS,GAAI,MAAU,CAC9C,CACJ,CAAC,GACe,QAAQ,SAEhC,CACJ,CAEA,IAAIE,EAA6D,KAEjE,eAAeR,GAAkD,CAC7D,OAAKQ,IACDA,EAAuBC,EAAyB,GAG7CD,CACX,CAEA,eAAeC,GAA0D,CACrE,IAAMC,EAAW,MAAM,OAAO,IAAI,oBAAoB,QAAQ,QAAQlB,EAAe,CAAC,EAEtF,OAAAkB,EAAQ,gBAAiBf,GAAa,CAClC,QAAQ,KAAK,KAAKJ,CAAY,gCAAiCI,EAAU,iBAAiB,EAC1Fa,EAAuB,IAC3B,CAAC,EAEME,CACX","sourcesContent":["// eslint-disable-next-line check-file/no-index\nimport type OpenFin from '@openfin/core';\nimport type * as NotificationsTypes from 'openfin-notifications';\n\nimport type { FlannelChannelClient, NotificationEventsMap, NotificationsClient } from './types';\n\nconst PACKAGE_NAME = '@openfin/cloud-api';\n\nexport type {\n    FlannelChannelProvider as __INTERNAL_FlannelChannelProvider,\n    FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest,\n    FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse,\n    FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest,\n    FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse,\n    FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest,\n    FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse,\n} from './types';\n\ndeclare global {\n    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions\n    interface Window {\n        fin: typeof import('@openfin/core').fin;\n    }\n}\n\nfunction getChannelName() {\n    return `${window.fin.me.uuid}-cloud-api-notifications`;\n}\n\nasync function isInViewContext(): Promise<boolean> {\n    try {\n        await window.fin.View.getCurrentSync().getInfo();\n        return true;\n    } catch {\n        return false;\n    }\n}\n\nfunction extractAppUuidFromIdentity(identity: OpenFin.Identity): string {\n    if (identity.name.startsWith('internal-generated')) {\n        throw new Error('Cannot extract app UUID from identity');\n    }\n    // <uuid>/<name>\n    if (/\\/[\\d,a-z-]{36}$/.test(identity.name)) {\n        return identity.name.split('/')[0] || '';\n    }\n\n    return identity.name;\n}\n\nlet notificationsClientPromise: Promise<NotificationsClient> | null = null;\n\n/**\n * @returns A client for interacting with the OpenFin Notifications service\n *\n * @throws {Error} If the function is called outside of an OpenFin environment\n * @throws {Error} If the function is called outside of an OpenFin View context\n * @throws {Error} If the app UUID cannot be extracted from the current context\n *\n * @example **Basic Usage** Creating a notification, updating it and then clearing it\n * ```ts\n * const notificationsClient = await getNotificationsClient();\n *\n * const notification = await notificationsClient.createNotification({\n *     title: 'Hello, World!',\n *     body: 'This is a notification from the OpenFin Cloud API',\n * });\n *\n * // Use the `id` from the returned notification to interact with it\n * console.log(notification.id);\n *\n * // Update the notification\n * await notificationsClient.update({\n *     id: notification.id,\n *     body: 'This is a notification from the OpenFin Cloud API, that has been updated!',\n * })\n *\n * // Clear the notification\n * await notificationsClient.clear(notification.id);\n * ```\n *\n * @example **Advanced Usage** Listening for events\n * ```ts\n * const notificationsClient = await getNotificationsClient();\n *\n * // create the notification\n * const notification = await notificationsClient.createNotification({\n *     title: `${window.fin.me.identity.name} Hello, World!`,\n *     body: `This is a notification from the cloud API example created at ${new Date().toLocaleTimeString()}`,\n *     buttons: [\n *         {\n *             title: 'Acknowledge',\n *         },\n *     ],\n * });\n *\n * notificationsClient.addEventListener('notification-action', (event) => {\n *     console.log('Notification action:', event);\n * });\n * ```\n */\nasync function getNotificationsClient(): Promise<NotificationsClient> {\n    if (!notificationsClientPromise) {\n        notificationsClientPromise = getNotificationsClientInternal();\n    }\n\n    return notificationsClientPromise;\n}\n\nasync function getNotificationsClientInternal(): Promise<NotificationsClient> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    extractAppUuidFromIdentity(window.fin.me);\n\n    const channelPromise = await getChannelClient();\n    console.log(channelPromise);\n\n    channelPromise.register('openfin-cloud-event', (message) => {\n        for (const listener of eventListeners.get(message.type) ?? []) {\n            // `Date` is serialized as a string, so we need to convert it back\n            if (typeof message.payload.timestamp === 'string') {\n                message.payload.timestamp = new Date(message.payload.timestamp);\n            }\n\n            listener(message.payload as never);\n        }\n    });\n\n    const eventListeners = new Map<keyof NotificationEventsMap, Set<NotificationEventsMap[keyof NotificationEventsMap]>>();\n\n    return {\n        addEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName) || new Set();\n            listeners.add(listener);\n            eventListeners.set(eventName, listeners);\n        },\n        removeEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName);\n            if (!listeners) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,\n                    eventName,\n                );\n                return;\n            }\n\n            if (listeners.delete(listener as (args: unknown) => void) === false) {\n                console.warn(`\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference?`, eventName);\n            }\n        },\n        update: async (options: Parameters<typeof NotificationsTypes.update>[0]): ReturnType<typeof NotificationsTypes.update> => {\n            const response = await channelPromise.dispatch('openfin-cloud-update-notification', {\n                version: 1,\n                payload: {\n                    notification: options,\n                },\n            });\n            return response.payload.response;\n        },\n        clear: async (notificationId: Parameters<typeof NotificationsTypes.clear>[0]): ReturnType<typeof NotificationsTypes.clear> => {\n            const response = await channelPromise.dispatch('openfin-cloud-clear-notification', {\n                version: 1,\n                payload: {\n                    notificationId,\n                },\n            });\n            return response.payload.response;\n        },\n        createNotification: async (\n            options: NotificationsTypes.NotificationOptions,\n        ): Promise<NotificationsTypes.Notification<NotificationsTypes.NotificationOptions>> => {\n            if (options.id) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: The \\`id\\` property is not supported and will be ignored. If you need to use the \\`id\\` property, you should use the \\`id\\` property of the returned notification object.`,\n                );\n            }\n            const response = await channelPromise.dispatch('openfin-cloud-create-notification', {\n                version: 1,\n                payload: {\n                    notification: { ...options, id: undefined },\n                },\n            });\n            return response.payload.response;\n        },\n    };\n}\n\nlet channelClientPromise: Promise<FlannelChannelClient> | null = null;\n\nasync function getChannelClient(): Promise<FlannelChannelClient> {\n    if (!channelClientPromise) {\n        channelClientPromise = getChannelClientInternal();\n    }\n\n    return channelClientPromise;\n}\n\nasync function getChannelClientInternal(): Promise<FlannelChannelClient> {\n    const channel = (await window.fin.InterApplicationBus.Channel.connect(getChannelName())) as FlannelChannelClient;\n\n    channel.onDisconnection((identity) => {\n        console.warn(`\\`${PACKAGE_NAME}\\`: Channel Disconnected from`, identity, 'Reconnecting...');\n        channelClientPromise = null;\n    });\n\n    return channel;\n}\n\nexport { getNotificationsClient };\n"]}

package/dist/index.d.cts

@@ -31,14 +31,10 @@ type NotificationsClient = {
     createNotification(...args: Parameters<typeof NotificationsTypes.create>): ReturnType<typeof NotificationsTypes.create>;
     /**
      * Updates an existing Notification.
-     *
-     * @remarks Not implemented.
      */
     update(...args: Parameters<typeof NotificationsTypes.update>): ReturnType<typeof NotificationsTypes.update>;
     /**
      * Clears a Notification with the specified id.
-     *
-     * @remarks Not implemented.
      */
     clear(...args: Parameters<typeof NotificationsTypes.clear>): ReturnType<typeof NotificationsTypes.clear>;
 };
@@ -167,6 +163,48 @@ declare global {
  * @throws {Error} If the function is called outside of an OpenFin environment
  * @throws {Error} If the function is called outside of an OpenFin View context
  * @throws {Error} If the app UUID cannot be extracted from the current context
+ *
+ * @example **Basic Usage** Creating a notification, updating it and then clearing it
+ * ```ts
+ * const notificationsClient = await getNotificationsClient();
+ *
+ * const notification = await notificationsClient.createNotification({
+ *     title: 'Hello, World!',
+ *     body: 'This is a notification from the OpenFin Cloud API',
+ * });
+ *
+ * // Use the `id` from the returned notification to interact with it
+ * console.log(notification.id);
+ *
+ * // Update the notification
+ * await notificationsClient.update({
+ *     id: notification.id,
+ *     body: 'This is a notification from the OpenFin Cloud API, that has been updated!',
+ * })
+ *
+ * // Clear the notification
+ * await notificationsClient.clear(notification.id);
+ * ```
+ *
+ * @example **Advanced Usage** Listening for events
+ * ```ts
+ * const notificationsClient = await getNotificationsClient();
+ *
+ * // create the notification
+ * const notification = await notificationsClient.createNotification({
+ *     title: `${window.fin.me.identity.name} Hello, World!`,
+ *     body: `This is a notification from the cloud API example created at ${new Date().toLocaleTimeString()}`,
+ *     buttons: [
+ *         {
+ *             title: 'Acknowledge',
+ *         },
+ *     ],
+ * });
+ *
+ * notificationsClient.addEventListener('notification-action', (event) => {
+ *     console.log('Notification action:', event);
+ * });
+ * ```
  */
 declare function getNotificationsClient(): Promise<NotificationsClient>;
 

package/dist/index.d.ts

@@ -31,14 +31,10 @@ type NotificationsClient = {
     createNotification(...args: Parameters<typeof NotificationsTypes.create>): ReturnType<typeof NotificationsTypes.create>;
     /**
      * Updates an existing Notification.
-     *
-     * @remarks Not implemented.
      */
     update(...args: Parameters<typeof NotificationsTypes.update>): ReturnType<typeof NotificationsTypes.update>;
     /**
      * Clears a Notification with the specified id.
-     *
-     * @remarks Not implemented.
      */
     clear(...args: Parameters<typeof NotificationsTypes.clear>): ReturnType<typeof NotificationsTypes.clear>;
 };
@@ -167,6 +163,48 @@ declare global {
  * @throws {Error} If the function is called outside of an OpenFin environment
  * @throws {Error} If the function is called outside of an OpenFin View context
  * @throws {Error} If the app UUID cannot be extracted from the current context
+ *
+ * @example **Basic Usage** Creating a notification, updating it and then clearing it
+ * ```ts
+ * const notificationsClient = await getNotificationsClient();
+ *
+ * const notification = await notificationsClient.createNotification({
+ *     title: 'Hello, World!',
+ *     body: 'This is a notification from the OpenFin Cloud API',
+ * });
+ *
+ * // Use the `id` from the returned notification to interact with it
+ * console.log(notification.id);
+ *
+ * // Update the notification
+ * await notificationsClient.update({
+ *     id: notification.id,
+ *     body: 'This is a notification from the OpenFin Cloud API, that has been updated!',
+ * })
+ *
+ * // Clear the notification
+ * await notificationsClient.clear(notification.id);
+ * ```
+ *
+ * @example **Advanced Usage** Listening for events
+ * ```ts
+ * const notificationsClient = await getNotificationsClient();
+ *
+ * // create the notification
+ * const notification = await notificationsClient.createNotification({
+ *     title: `${window.fin.me.identity.name} Hello, World!`,
+ *     body: `This is a notification from the cloud API example created at ${new Date().toLocaleTimeString()}`,
+ *     buttons: [
+ *         {
+ *             title: 'Acknowledge',
+ *         },
+ *     ],
+ * });
+ *
+ * notificationsClient.addEventListener('notification-action', (event) => {
+ *     console.log('Notification action:', event);
+ * });
+ * ```
  */
 declare function getNotificationsClient(): Promise<NotificationsClient>;
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// eslint-disable-next-line check-file/no-index\nimport type OpenFin from '@openfin/core';\nimport type * as NotificationsTypes from 'openfin-notifications';\n\nimport type { FlannelChannelClient, NotificationEventsMap, NotificationsClient } from './types';\n\nconst PACKAGE_NAME = '@openfin/cloud-api';\n\nexport type {\n    FlannelChannelProvider as __INTERNAL_FlannelChannelProvider,\n    FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest,\n    FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse,\n    FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest,\n    FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse,\n    FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest,\n    FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse,\n} from './types';\n\ndeclare global {\n    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions\n    interface Window {\n        fin: typeof import('@openfin/core').fin;\n    }\n}\n\nfunction getChannelName() {\n    return `${window.fin.me.uuid}-cloud-api-notifications`;\n}\n\nasync function isInViewContext(): Promise<boolean> {\n    try {\n        await window.fin.View.getCurrentSync().getInfo();\n        return true;\n    } catch {\n        return false;\n    }\n}\n\nfunction extractAppUuidFromIdentity(identity: OpenFin.Identity): string {\n    if (identity.name.startsWith('internal-generated')) {\n        throw new Error('Cannot extract app UUID from identity');\n    }\n    // <uuid>/<name>\n    if (/\\/[\\d,a-z-]{36}$/.test(identity.name)) {\n        return identity.name.split('/')[0] || '';\n    }\n\n    return identity.name;\n}\n\nlet notificationsClientPromise: Promise<NotificationsClient> | null = null;\n\n/**\n * @returns A client for interacting with the OpenFin Notifications service\n *\n * @throws {Error} If the function is called outside of an OpenFin environment\n * @throws {Error} If the function is called outside of an OpenFin View context\n * @throws {Error} If the app UUID cannot be extracted from the current context\n */\nasync function getNotificationsClient(): Promise<NotificationsClient> {\n    if (!notificationsClientPromise) {\n        notificationsClientPromise = getNotificationsClientInternal();\n    }\n\n    return notificationsClientPromise;\n}\n\nasync function getNotificationsClientInternal(): Promise<NotificationsClient> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    extractAppUuidFromIdentity(window.fin.me);\n\n    const channelPromise = await getChannelClient();\n    console.log(channelPromise);\n\n    channelPromise.register('openfin-cloud-event', (message) => {\n        for (const listener of eventListeners.get(message.type) ?? []) {\n            // `Date` is serialized as a string, so we need to convert it back\n            if (typeof message.payload.timestamp === 'string') {\n                message.payload.timestamp = new Date(message.payload.timestamp);\n            }\n\n            listener(message.payload as never);\n        }\n    });\n\n    const eventListeners = new Map<keyof NotificationEventsMap, Set<NotificationEventsMap[keyof NotificationEventsMap]>>();\n\n    return {\n        addEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName) || new Set();\n            listeners.add(listener);\n            eventListeners.set(eventName, listeners);\n        },\n        removeEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName);\n            if (!listeners) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,\n                    eventName,\n                );\n                return;\n            }\n\n            if (listeners.delete(listener as (args: unknown) => void) === false) {\n                console.warn(`\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference?`, eventName);\n            }\n        },\n        update: async (options: Parameters<typeof NotificationsTypes.update>[0]): ReturnType<typeof NotificationsTypes.update> => {\n            const response = await channelPromise.dispatch('openfin-cloud-update-notification', {\n                version: 1,\n                payload: {\n                    notification: options,\n                },\n            });\n            return response.payload.response;\n        },\n        clear: async (notificationId: Parameters<typeof NotificationsTypes.clear>[0]): ReturnType<typeof NotificationsTypes.clear> => {\n            const response = await channelPromise.dispatch('openfin-cloud-clear-notification', {\n                version: 1,\n                payload: {\n                    notificationId,\n                },\n            });\n            return response.payload.response;\n        },\n        createNotification: async (\n            options: NotificationsTypes.NotificationOptions,\n        ): Promise<NotificationsTypes.Notification<NotificationsTypes.NotificationOptions>> => {\n            if (options.id) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: The \\`id\\` property is not supported and will be ignored. If you need to use the \\`id\\` property, you should use the \\`id\\` property of the returned notification object.`,\n                );\n            }\n            const response = await channelPromise.dispatch('openfin-cloud-create-notification', {\n                version: 1,\n                payload: {\n                    notification: { ...options, id: undefined },\n                },\n            });\n            return response.payload.response;\n        },\n    };\n}\n\nlet channelClientPromise: Promise<FlannelChannelClient> | null = null;\n\nasync function getChannelClient(): Promise<FlannelChannelClient> {\n    if (!channelClientPromise) {\n        channelClientPromise = getChannelClientInternal();\n    }\n\n    return channelClientPromise;\n}\n\nasync function getChannelClientInternal(): Promise<FlannelChannelClient> {\n    const channel = (await window.fin.InterApplicationBus.Channel.connect(getChannelName())) as FlannelChannelClient;\n\n    channel.onDisconnection((identity) => {\n        console.warn(`\\`${PACKAGE_NAME}\\`: Channel Disconnected from`, identity, 'Reconnecting...');\n        channelClientPromise = null;\n    });\n\n    return channel;\n}\n\nexport { getNotificationsClient };\n"],"mappings":"AAMA,IAAMA,EAAe,qBAmBrB,SAASC,GAAiB,CACtB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,0BAChC,CAEA,eAAeC,GAAoC,CAC/C,GAAI,CACA,aAAM,OAAO,IAAI,KAAK,eAAe,EAAE,QAAQ,EACxC,EACX,MAAQ,CACJ,MAAO,EACX,CACJ,CAEA,SAASC,EAA2BC,EAAoC,CACpE,GAAIA,EAAS,KAAK,WAAW,oBAAoB,EAC7C,MAAM,IAAI,MAAM,uCAAuC,EAG3D,MAAI,mBAAmB,KAAKA,EAAS,IAAI,EAC9BA,EAAS,KAAK,MAAM,GAAG,EAAE,CAAC,GAAK,GAGnCA,EAAS,IACpB,CAEA,IAAIC,EAAkE,KAStE,eAAeC,GAAuD,CAClE,OAAKD,IACDA,EAA6BE,EAA+B,GAGzDF,CACX,CAEA,eAAeE,GAA+D,CAC1E,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKP,CAAY,4EAA4E,EAGjH,GAAK,MAAME,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGF,CAAY,0EAA0E,EAG7GG,EAA2B,OAAO,IAAI,EAAE,EAExC,IAAMK,EAAiB,MAAMC,EAAiB,EAC9C,QAAQ,IAAID,CAAc,EAE1BA,EAAe,SAAS,sBAAwBE,GAAY,CACxD,QAAWC,KAAYC,EAAe,IAAIF,EAAQ,IAAI,GAAK,CAAC,EAEpD,OAAOA,EAAQ,QAAQ,WAAc,WACrCA,EAAQ,QAAQ,UAAY,IAAI,KAAKA,EAAQ,QAAQ,SAAS,GAGlEC,EAASD,EAAQ,OAAgB,CAEzC,CAAC,EAED,IAAME,EAAiB,IAAI,IAE3B,MAAO,CACH,iBAAkB,CAAwCC,EAAcF,IAAuC,CAC3G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,GAAK,IAAI,IACvDC,EAAU,IAAIH,CAAQ,EACtBC,EAAe,IAAIC,EAAWC,CAAS,CAC3C,EACA,oBAAqB,CAAwCD,EAAcF,IAAuC,CAC9G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,EAC9C,GAAI,CAACC,EAAW,CACZ,QAAQ,KACJ,KAAKd,CAAY,+HACjBa,CACJ,EACA,MACJ,CAEIC,EAAU,OAAOH,CAAmC,IAAM,IAC1D,QAAQ,KAAK,KAAKX,CAAY,iGAAkGa,CAAS,CAEjJ,EACA,OAAQ,MAAOE,IACM,MAAMP,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAcO,CAClB,CACJ,CAAC,GACe,QAAQ,SAE5B,MAAO,MAAOC,IACO,MAAMR,EAAe,SAAS,mCAAoC,CAC/E,QAAS,EACT,QAAS,CACL,eAAAQ,CACJ,CACJ,CAAC,GACe,QAAQ,SAE5B,mBAAoB,MAChBD,IAEIA,EAAQ,IACR,QAAQ,KACJ,KAAKf,CAAY,+KACrB,GAEa,MAAMQ,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAc,CAAE,GAAGO,EAAS,GAAI,MAAU,CAC9C,CACJ,CAAC,GACe,QAAQ,SAEhC,CACJ,CAEA,IAAIE,EAA6D,KAEjE,eAAeR,GAAkD,CAC7D,OAAKQ,IACDA,EAAuBC,EAAyB,GAG7CD,CACX,CAEA,eAAeC,GAA0D,CACrE,IAAMC,EAAW,MAAM,OAAO,IAAI,oBAAoB,QAAQ,QAAQlB,EAAe,CAAC,EAEtF,OAAAkB,EAAQ,gBAAiBf,GAAa,CAClC,QAAQ,KAAK,KAAKJ,CAAY,gCAAiCI,EAAU,iBAAiB,EAC1Fa,EAAuB,IAC3B,CAAC,EAEME,CACX","names":["PACKAGE_NAME","getChannelName","isInViewContext","extractAppUuidFromIdentity","identity","notificationsClientPromise","getNotificationsClient","getNotificationsClientInternal","channelPromise","getChannelClient","message","listener","eventListeners","eventName","listeners","options","notificationId","channelClientPromise","getChannelClientInternal","channel"]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// eslint-disable-next-line check-file/no-index\nimport type OpenFin from '@openfin/core';\nimport type * as NotificationsTypes from 'openfin-notifications';\n\nimport type { FlannelChannelClient, NotificationEventsMap, NotificationsClient } from './types';\n\nconst PACKAGE_NAME = '@openfin/cloud-api';\n\nexport type {\n    FlannelChannelProvider as __INTERNAL_FlannelChannelProvider,\n    FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest,\n    FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse,\n    FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest,\n    FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse,\n    FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest,\n    FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse,\n} from './types';\n\ndeclare global {\n    // eslint-disable-next-line @typescript-eslint/consistent-type-definitions\n    interface Window {\n        fin: typeof import('@openfin/core').fin;\n    }\n}\n\nfunction getChannelName() {\n    return `${window.fin.me.uuid}-cloud-api-notifications`;\n}\n\nasync function isInViewContext(): Promise<boolean> {\n    try {\n        await window.fin.View.getCurrentSync().getInfo();\n        return true;\n    } catch {\n        return false;\n    }\n}\n\nfunction extractAppUuidFromIdentity(identity: OpenFin.Identity): string {\n    if (identity.name.startsWith('internal-generated')) {\n        throw new Error('Cannot extract app UUID from identity');\n    }\n    // <uuid>/<name>\n    if (/\\/[\\d,a-z-]{36}$/.test(identity.name)) {\n        return identity.name.split('/')[0] || '';\n    }\n\n    return identity.name;\n}\n\nlet notificationsClientPromise: Promise<NotificationsClient> | null = null;\n\n/**\n * @returns A client for interacting with the OpenFin Notifications service\n *\n * @throws {Error} If the function is called outside of an OpenFin environment\n * @throws {Error} If the function is called outside of an OpenFin View context\n * @throws {Error} If the app UUID cannot be extracted from the current context\n *\n * @example **Basic Usage** Creating a notification, updating it and then clearing it\n * ```ts\n * const notificationsClient = await getNotificationsClient();\n *\n * const notification = await notificationsClient.createNotification({\n *     title: 'Hello, World!',\n *     body: 'This is a notification from the OpenFin Cloud API',\n * });\n *\n * // Use the `id` from the returned notification to interact with it\n * console.log(notification.id);\n *\n * // Update the notification\n * await notificationsClient.update({\n *     id: notification.id,\n *     body: 'This is a notification from the OpenFin Cloud API, that has been updated!',\n * })\n *\n * // Clear the notification\n * await notificationsClient.clear(notification.id);\n * ```\n *\n * @example **Advanced Usage** Listening for events\n * ```ts\n * const notificationsClient = await getNotificationsClient();\n *\n * // create the notification\n * const notification = await notificationsClient.createNotification({\n *     title: `${window.fin.me.identity.name} Hello, World!`,\n *     body: `This is a notification from the cloud API example created at ${new Date().toLocaleTimeString()}`,\n *     buttons: [\n *         {\n *             title: 'Acknowledge',\n *         },\n *     ],\n * });\n *\n * notificationsClient.addEventListener('notification-action', (event) => {\n *     console.log('Notification action:', event);\n * });\n * ```\n */\nasync function getNotificationsClient(): Promise<NotificationsClient> {\n    if (!notificationsClientPromise) {\n        notificationsClientPromise = getNotificationsClientInternal();\n    }\n\n    return notificationsClientPromise;\n}\n\nasync function getNotificationsClientInternal(): Promise<NotificationsClient> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getNotificationsClient\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    extractAppUuidFromIdentity(window.fin.me);\n\n    const channelPromise = await getChannelClient();\n    console.log(channelPromise);\n\n    channelPromise.register('openfin-cloud-event', (message) => {\n        for (const listener of eventListeners.get(message.type) ?? []) {\n            // `Date` is serialized as a string, so we need to convert it back\n            if (typeof message.payload.timestamp === 'string') {\n                message.payload.timestamp = new Date(message.payload.timestamp);\n            }\n\n            listener(message.payload as never);\n        }\n    });\n\n    const eventListeners = new Map<keyof NotificationEventsMap, Set<NotificationEventsMap[keyof NotificationEventsMap]>>();\n\n    return {\n        addEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName) || new Set();\n            listeners.add(listener);\n            eventListeners.set(eventName, listeners);\n        },\n        removeEventListener: <T extends keyof NotificationEventsMap>(eventName: T, listener: NotificationEventsMap[T]) => {\n            const listeners = eventListeners.get(eventName);\n            if (!listeners) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,\n                    eventName,\n                );\n                return;\n            }\n\n            if (listeners.delete(listener as (args: unknown) => void) === false) {\n                console.warn(`\\`${PACKAGE_NAME}\\`: Listener was not found for event. Did you pass a function directly instead of a reference?`, eventName);\n            }\n        },\n        update: async (options: Parameters<typeof NotificationsTypes.update>[0]): ReturnType<typeof NotificationsTypes.update> => {\n            const response = await channelPromise.dispatch('openfin-cloud-update-notification', {\n                version: 1,\n                payload: {\n                    notification: options,\n                },\n            });\n            return response.payload.response;\n        },\n        clear: async (notificationId: Parameters<typeof NotificationsTypes.clear>[0]): ReturnType<typeof NotificationsTypes.clear> => {\n            const response = await channelPromise.dispatch('openfin-cloud-clear-notification', {\n                version: 1,\n                payload: {\n                    notificationId,\n                },\n            });\n            return response.payload.response;\n        },\n        createNotification: async (\n            options: NotificationsTypes.NotificationOptions,\n        ): Promise<NotificationsTypes.Notification<NotificationsTypes.NotificationOptions>> => {\n            if (options.id) {\n                console.warn(\n                    `\\`${PACKAGE_NAME}\\`: The \\`id\\` property is not supported and will be ignored. If you need to use the \\`id\\` property, you should use the \\`id\\` property of the returned notification object.`,\n                );\n            }\n            const response = await channelPromise.dispatch('openfin-cloud-create-notification', {\n                version: 1,\n                payload: {\n                    notification: { ...options, id: undefined },\n                },\n            });\n            return response.payload.response;\n        },\n    };\n}\n\nlet channelClientPromise: Promise<FlannelChannelClient> | null = null;\n\nasync function getChannelClient(): Promise<FlannelChannelClient> {\n    if (!channelClientPromise) {\n        channelClientPromise = getChannelClientInternal();\n    }\n\n    return channelClientPromise;\n}\n\nasync function getChannelClientInternal(): Promise<FlannelChannelClient> {\n    const channel = (await window.fin.InterApplicationBus.Channel.connect(getChannelName())) as FlannelChannelClient;\n\n    channel.onDisconnection((identity) => {\n        console.warn(`\\`${PACKAGE_NAME}\\`: Channel Disconnected from`, identity, 'Reconnecting...');\n        channelClientPromise = null;\n    });\n\n    return channel;\n}\n\nexport { getNotificationsClient };\n"],"mappings":"AAMA,IAAMA,EAAe,qBAmBrB,SAASC,GAAiB,CACtB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,0BAChC,CAEA,eAAeC,GAAoC,CAC/C,GAAI,CACA,aAAM,OAAO,IAAI,KAAK,eAAe,EAAE,QAAQ,EACxC,EACX,MAAQ,CACJ,MAAO,EACX,CACJ,CAEA,SAASC,EAA2BC,EAAoC,CACpE,GAAIA,EAAS,KAAK,WAAW,oBAAoB,EAC7C,MAAM,IAAI,MAAM,uCAAuC,EAG3D,MAAI,mBAAmB,KAAKA,EAAS,IAAI,EAC9BA,EAAS,KAAK,MAAM,GAAG,EAAE,CAAC,GAAK,GAGnCA,EAAS,IACpB,CAEA,IAAIC,EAAkE,KAmDtE,eAAeC,GAAuD,CAClE,OAAKD,IACDA,EAA6BE,EAA+B,GAGzDF,CACX,CAEA,eAAeE,GAA+D,CAC1E,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKP,CAAY,4EAA4E,EAGjH,GAAK,MAAME,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGF,CAAY,0EAA0E,EAG7GG,EAA2B,OAAO,IAAI,EAAE,EAExC,IAAMK,EAAiB,MAAMC,EAAiB,EAC9C,QAAQ,IAAID,CAAc,EAE1BA,EAAe,SAAS,sBAAwBE,GAAY,CACxD,QAAWC,KAAYC,EAAe,IAAIF,EAAQ,IAAI,GAAK,CAAC,EAEpD,OAAOA,EAAQ,QAAQ,WAAc,WACrCA,EAAQ,QAAQ,UAAY,IAAI,KAAKA,EAAQ,QAAQ,SAAS,GAGlEC,EAASD,EAAQ,OAAgB,CAEzC,CAAC,EAED,IAAME,EAAiB,IAAI,IAE3B,MAAO,CACH,iBAAkB,CAAwCC,EAAcF,IAAuC,CAC3G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,GAAK,IAAI,IACvDC,EAAU,IAAIH,CAAQ,EACtBC,EAAe,IAAIC,EAAWC,CAAS,CAC3C,EACA,oBAAqB,CAAwCD,EAAcF,IAAuC,CAC9G,IAAMG,EAAYF,EAAe,IAAIC,CAAS,EAC9C,GAAI,CAACC,EAAW,CACZ,QAAQ,KACJ,KAAKd,CAAY,+HACjBa,CACJ,EACA,MACJ,CAEIC,EAAU,OAAOH,CAAmC,IAAM,IAC1D,QAAQ,KAAK,KAAKX,CAAY,iGAAkGa,CAAS,CAEjJ,EACA,OAAQ,MAAOE,IACM,MAAMP,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAcO,CAClB,CACJ,CAAC,GACe,QAAQ,SAE5B,MAAO,MAAOC,IACO,MAAMR,EAAe,SAAS,mCAAoC,CAC/E,QAAS,EACT,QAAS,CACL,eAAAQ,CACJ,CACJ,CAAC,GACe,QAAQ,SAE5B,mBAAoB,MAChBD,IAEIA,EAAQ,IACR,QAAQ,KACJ,KAAKf,CAAY,+KACrB,GAEa,MAAMQ,EAAe,SAAS,oCAAqC,CAChF,QAAS,EACT,QAAS,CACL,aAAc,CAAE,GAAGO,EAAS,GAAI,MAAU,CAC9C,CACJ,CAAC,GACe,QAAQ,SAEhC,CACJ,CAEA,IAAIE,EAA6D,KAEjE,eAAeR,GAAkD,CAC7D,OAAKQ,IACDA,EAAuBC,EAAyB,GAG7CD,CACX,CAEA,eAAeC,GAA0D,CACrE,IAAMC,EAAW,MAAM,OAAO,IAAI,oBAAoB,QAAQ,QAAQlB,EAAe,CAAC,EAEtF,OAAAkB,EAAQ,gBAAiBf,GAAa,CAClC,QAAQ,KAAK,KAAKJ,CAAY,gCAAiCI,EAAU,iBAAiB,EAC1Fa,EAAuB,IAC3B,CAAC,EAEME,CACX","names":["PACKAGE_NAME","getChannelName","isInViewContext","extractAppUuidFromIdentity","identity","notificationsClientPromise","getNotificationsClient","getNotificationsClientInternal","channelPromise","getChannelClient","message","listener","eventListeners","eventName","listeners","options","notificationId","channelClientPromise","getChannelClientInternal","channel"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-api",
-    "version": "0.0.1-alpha.4f8b7372",
+    "version": "0.0.1-alpha.8d5ffd0",
     "sideEffects": false,
     "description": "",
     "exports": {