@openfin/cloud-api 0.0.1-alpha.01a0640

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

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var t="@openfin/cloud-api";async function a(){try{return await window.fin.View.getCurrentSync().getInfo(),!0}catch (e2){return!1}}function u(e){if(e.name.startsWith("internal-generated"))throw new Error("Cannot extract app UUID from identity");return/\/[\d,a-z-]{36}$/.test(e.name)?e.name.split("/")[0]||"":e.name}var s="@openfin/cloud-api";function d(){return`${window.fin.me.uuid}-cloud-api-notifications`}var l=null;async function g(){return l||(l=w()),l}async function w(){if(!window.fin)throw new Error(`\`${s}\`: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${s}: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);u(window.fin.me);let e=await m();console.log(e),e.register("openfin-cloud-event",n=>{for(let i of _nullishCoalesce(o.get(n.type), () => ([])))typeof n.payload.timestamp=="string"&&(n.payload.timestamp=new Date(n.payload.timestamp)),i(n.payload)});let o=new Map;return{addEventListener:(n,i)=>{let r=o.get(n)||new Set;r.add(i),o.set(n,r)},removeEventListener:(n,i)=>{let r=o.get(n);if(!r){console.warn(`\`${s}\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,n);return}r.delete(i)===!1&&console.warn(`\`${s}\`: Listener was not found for event. Did you pass a function directly instead of a reference?`,n)},update:async n=>(await e.dispatch("openfin-cloud-update-notification",{version:1,payload:{notification:n}})).payload.response,clear:async n=>(await e.dispatch("openfin-cloud-clear-notification",{version:1,payload:{notificationId:n}})).payload.response,createNotification:async n=>(n.id&&console.warn(`\`${s}\`: 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.`),(await e.dispatch("openfin-cloud-create-notification",{version:1,payload:{notification:{...n,id:void 0}}})).payload.response)}}var p=null;async function m(){return p||(p=y()),p}async function y(){let e=await window.fin.InterApplicationBus.Channel.connect(d());return e.onDisconnection(o=>{console.warn(`\`${s}\`: Channel Disconnected from`,o,"Reconnecting..."),p=null}),e}var f;function N(){return`${window.fin.me.uuid}-client-api`}async function c(){return f||(f=window.fin.InterApplicationBus.Channel.connect(N())),f}async function E(){if(!window.fin)throw new Error(`\`${t}\`: \`getAppSettings\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`getAppSettings\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("get-settings")}async function P(){if(!window.fin)throw new Error(`\`${t}\`: \`getAppUserSettings\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`getAppUserSettings\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("get-user-settings")}async function v(e){if(!window.fin)throw new Error(`\`${t}\`: \`setAppUserSettings\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`setAppUserSettings\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("set-user-settings",e)}async function T(){if(!window.fin)throw new Error(`\`${t}\`: \`getAppUserPermissions\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`getAppUserPermissions\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("get-user-permissions")}exports.getAppSettings = E; exports.getAppUserPermissions = T; exports.getAppUserSettings = P; exports.getNotificationsClient = g; exports.setAppUserSettings = v;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/notifications.ts","../src/client-api.ts"],"names":["PACKAGE_NAME","isInViewContext","extractAppUuidFromIdentity","identity","getChannelName","notificationsClientPromise","getNotificationsClient","getNotificationsClientInternal","channelPromise","getChannelClient","message","listener","eventListeners","eventName","listeners","options","notificationId","channelClientPromise","getChannelClientInternal","channel","apiChannelClientPromise","getApiChannelName","getApiChannelClient","getAppSettings","getAppUserSettings","setAppUserSettings","settings","getAppUserPermissions"],"mappings":"AAEO,IAAMA,EAAe,qBAE5B,eAAsBC,GAAoC,CACtD,GAAI,CACA,aAAM,OAAO,IAAI,KAAK,eAAe,EAAE,QAAQ,EACxC,EACX,MAAQ,CACJ,MAAO,EACX,CACJ,CAEO,SAASC,EAA2BC,EAAoC,CAC3E,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,CCjBA,IAAMH,EAAe,qBAmBrB,SAASI,GAAiB,CACtB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,0BAChC,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,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,0EAA0E,EAG7GE,EAA2B,OAAO,IAAI,EAAE,EAExC,IAAMM,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,QAAQf,EAAe,CAAC,EAEtF,OAAAe,EAAQ,gBAAiBhB,GAAa,CAClC,QAAQ,KAAK,KAAKH,CAAY,gCAAiCG,EAAU,iBAAiB,EAC1Fc,EAAuB,IAC3B,CAAC,EAEME,CACX,CC3LA,IAAIC,EAkBJ,SAASC,GAAoB,CACzB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,aAChC,CAEA,eAAeC,GAAsD,CACjE,OAAKF,IACDA,EAA0B,OAAO,IAAI,oBAAoB,QAAQ,QAAQC,EAAkB,CAAC,GAGzFD,CACX,CAQA,eAAeG,GAAmC,CAC9C,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKvB,CAAY,oEAAoE,EAGzG,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,kEAAkE,EAKrG,OAFgB,MAAMsB,EAAoB,GAE3B,SAAS,cAAc,CAC1C,CAQA,eAAeE,GAAuC,CAClD,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKxB,CAAY,wEAAwE,EAG7G,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,sEAAsE,EAKzG,OAFgB,MAAMsB,EAAoB,GAE3B,SAAS,mBAAmB,CAC/C,CAUA,eAAeG,EAAmBC,EAAqC,CACnE,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAK1B,CAAY,wEAAwE,EAG7G,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,sEAAsE,EAKzG,OAFgB,MAAMsB,EAAoB,GAE3B,SAAS,oBAAqBI,CAAQ,CACzD,CAQA,eAAeC,GAAiD,CAC5D,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAK3B,CAAY,2EAA2E,EAGhH,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,yEAAyE,EAK5G,OAFgB,MAAMsB,EAAoB,GAE3B,SAAS,sBAAsB,CAClD","sourcesContent":["import type OpenFin from '@openfin/core';\n\nexport const PACKAGE_NAME = '@openfin/cloud-api';\n\nexport async function isInViewContext(): Promise<boolean> {\n    try {\n        await window.fin.View.getCurrentSync().getInfo();\n        return true;\n    } catch {\n        return false;\n    }\n}\n\nexport function 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","// eslint-disable-next-line check-file/no-index\nimport type * as NotificationsTypes from 'openfin-notifications';\n\nimport type { FlannelChannelClient, NotificationEventsMap, NotificationsClient } from './types';\nimport { extractAppUuidFromIdentity, isInViewContext } from './utils';\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\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","import type OpenFin from '@openfin/core';\n\nimport { isInViewContext, PACKAGE_NAME } from './utils';\n\nlet apiChannelClientPromise: Promise<OpenFin.ChannelClient>;\n\n/**\n * Represents a collection of returned app permissions\n */\nexport type AppPermissions = {\n    permissions: {\n        /**\n         * The name of the permission\n         */\n        name: string;\n        /**\n         * The ID of the permission\n         */\n        id: string;\n    }[];\n};\n\nfunction getApiChannelName() {\n    return `${window.fin.me.uuid}-client-api`;\n}\n\nasync function getApiChannelClient(): Promise<OpenFin.ChannelClient> {\n    if (!apiChannelClientPromise) {\n        apiChannelClientPromise = window.fin.InterApplicationBus.Channel.connect(getApiChannelName());\n    }\n\n    return apiChannelClientPromise;\n}\n\n/**\n * @returns The app settings that have been set against the current app\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 */\nasync function getAppSettings(): Promise<unknown> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getAppSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getAppSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('get-settings');\n}\n\n/**\n * @returns The app settings that have been set against the current app for the current user\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 */\nasync function getAppUserSettings(): Promise<unknown> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('get-user-settings');\n}\n\n/**\n * Assigns a set of user specific settings to the current app\n *\n * @returns The app settings that have been set against the current app for the current user\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 */\nasync function setAppUserSettings(settings: unknown): Promise<unknown> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`setAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`setAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('set-user-settings', settings);\n}\n\n/**\n * @returns The permissions that have been set against the current app for the current user\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 */\nasync function getAppUserPermissions(): Promise<AppPermissions> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getAppUserPermissions\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getAppUserPermissions\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('get-user-permissions');\n}\n\nexport { getAppSettings, getAppUserSettings, setAppUserSettings, getAppUserPermissions };\n"]}

package/dist/index.d.cts

@@ -0,0 +1,257 @@
+import * as OpenFin from '@openfin/core';
+import OpenFin__default from '@openfin/core';
+import * as NotificationsTypes from 'openfin-notifications';
+
+/**
+ * NotificationsClient is a client for accessing and interacting with the Notifications your application has created.
+ */
+type NotificationsClient = {
+    /**
+     * Adds an event listener to the Notifications service.
+     *
+     * @param event the event name to listen for
+     * @param callback the callback to be invoked when the event is emitted
+     */
+    addEventListener<T extends keyof NotificationEventsMap>(event: T, callback: NotificationEventsMap[T]): void;
+    /**
+     * Removes an event listener from the Notifications service.
+     *
+     * @see {NotificationsClient.addEventListener}
+     *
+     * @remarks If the listener is not found, a warning will be logged to the console.
+     */
+    removeEventListener<T extends keyof NotificationEventsMap>(event: T, callback: NotificationEventsMap[T]): void;
+    /**
+     * Creates a new Notification.
+     *
+     * @remarks `id` should __not__ be provided. Instead, use the id property of the returned notification object. If you supply and `id` property, it will be ignored, with a warning logged to the console.
+     *
+     * @param args
+     */
+    createNotification(...args: Parameters<typeof NotificationsTypes.create>): ReturnType<typeof NotificationsTypes.create>;
+    /**
+     * Updates an existing Notification.
+     */
+    update(...args: Parameters<typeof NotificationsTypes.update>): ReturnType<typeof NotificationsTypes.update>;
+    /**
+     * Clears a Notification with the specified id.
+     */
+    clear(...args: Parameters<typeof NotificationsTypes.clear>): ReturnType<typeof NotificationsTypes.clear>;
+};
+/**
+ * @internal
+ */
+type FlannelCreateNotificationRequest = {
+    version: 1;
+    payload: {
+        notification: NotificationsTypes.NotificationOptions;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelCreateNotificationResponse = {
+    version: 1;
+    payload: {
+        response: NotificationsTypes.Notification<NotificationsTypes.NotificationOptions>;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelUpdateNotificationRequest = {
+    version: 1;
+    payload: {
+        notification: NotificationsTypes.UpdatableNotificationOptions;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelUpdateNotificationResponse = {
+    version: 1;
+    payload: {
+        response: NotificationsTypes.Notification;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelClearNotificationRequest = {
+    version: 1;
+    payload: {
+        notificationId: string;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelClearNotificationResponse = {
+    version: 1;
+    payload: {
+        response: boolean;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelProvider = {
+    'openfin-cloud-create-notification': (arg0: FlannelCreateNotificationRequest) => Promise<FlannelCreateNotificationResponse>;
+    'openfin-cloud-update-notification': (arg0: FlannelUpdateNotificationRequest) => Promise<FlannelUpdateNotificationResponse>;
+    'openfin-cloud-clear-notification': (arg0: FlannelClearNotificationRequest) => Promise<FlannelClearNotificationResponse>;
+};
+type NotificationEventsMap = {
+    'notification-form-values-changed': (event: NotificationsTypes.NotificationFormValuesChangedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-form-submitted': (event: NotificationsTypes.NotificationFormSubmittedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-action': (event: NotificationsTypes.NotificationActionEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-created': (event: NotificationsTypes.NotificationCreatedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-toast-dismissed': (event: NotificationsTypes.NotificationToastDismissedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-closed': (event: NotificationsTypes.NotificationClosedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notifications-count-changed': (event: NotificationsTypes.NotificationsCountChanged & {
+        timestamp: Date;
+    }) => void;
+    'notification-reminder-created': (event: NotificationsTypes.NotificationReminderCreatedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-reminder-removed': (event: NotificationsTypes.NotificationReminderRemovedEvent & {
+        timestamp: Date;
+    }) => void;
+};
+/**
+ * @internal
+ */
+type FlannelClient = {
+    'openfin-cloud-event': <T extends keyof NotificationEventsMap>(arg0: {
+        type: T;
+        payload: Parameters<NotificationEventsMap[T]>[0];
+    }) => void;
+};
+/**
+ * @internal
+ */
+type FlannelChannelProvider = {
+    /**
+     * @internal
+     */
+    dispatch: <T extends keyof FlannelClient>(to: OpenFin__default.ClientIdentity | OpenFin__default.Identity, action: T, payload: Parameters<FlannelClient[T]>[0]) => Promise<Awaited<ReturnType<FlannelClient[T]>>>;
+    /**
+     * @internal
+     */
+    register: <T extends keyof FlannelProvider>(action: T, handler: (payload: Parameters<FlannelProvider[T]>[0], id: OpenFin__default.ProviderIdentity | OpenFin__default.ClientIdentity) => ReturnType<FlannelProvider[T]>) => boolean;
+} & Omit<OpenFin__default.ChannelProvider, 'dispatch' | 'register'>;
+
+declare global {
+    interface Window {
+        fin: typeof OpenFin.fin;
+    }
+}
+/**
+ * @returns A client for interacting with the OpenFin Notifications service
+ *
+ * @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>;
+
+/**
+ * Represents a collection of returned app permissions
+ */
+type AppPermissions = {
+    permissions: {
+        /**
+         * The name of the permission
+         */
+        name: string;
+        /**
+         * The ID of the permission
+         */
+        id: string;
+    }[];
+};
+/**
+ * @returns The app settings that have been set against the current app
+ *
+ * @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
+ */
+declare function getAppSettings(): Promise<unknown>;
+/**
+ * @returns The app settings that have been set against the current app for the current user
+ *
+ * @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
+ */
+declare function getAppUserSettings(): Promise<unknown>;
+/**
+ * Assigns a set of user specific settings to the current app
+ *
+ * @returns The app settings that have been set against the current app for the current user
+ *
+ * @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
+ */
+declare function setAppUserSettings(settings: unknown): Promise<unknown>;
+/**
+ * @returns The permissions that have been set against the current app for the current user
+ *
+ * @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
+ */
+declare function getAppUserPermissions(): Promise<AppPermissions>;
+
+export { type AppPermissions, type FlannelChannelProvider as __INTERNAL_FlannelChannelProvider, type FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest, type FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse, type FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest, type FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse, type FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest, type FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse, getAppSettings, getAppUserPermissions, getAppUserSettings, getNotificationsClient, setAppUserSettings };

package/dist/index.d.ts

@@ -0,0 +1,257 @@
+import * as OpenFin from '@openfin/core';
+import OpenFin__default from '@openfin/core';
+import * as NotificationsTypes from 'openfin-notifications';
+
+/**
+ * NotificationsClient is a client for accessing and interacting with the Notifications your application has created.
+ */
+type NotificationsClient = {
+    /**
+     * Adds an event listener to the Notifications service.
+     *
+     * @param event the event name to listen for
+     * @param callback the callback to be invoked when the event is emitted
+     */
+    addEventListener<T extends keyof NotificationEventsMap>(event: T, callback: NotificationEventsMap[T]): void;
+    /**
+     * Removes an event listener from the Notifications service.
+     *
+     * @see {NotificationsClient.addEventListener}
+     *
+     * @remarks If the listener is not found, a warning will be logged to the console.
+     */
+    removeEventListener<T extends keyof NotificationEventsMap>(event: T, callback: NotificationEventsMap[T]): void;
+    /**
+     * Creates a new Notification.
+     *
+     * @remarks `id` should __not__ be provided. Instead, use the id property of the returned notification object. If you supply and `id` property, it will be ignored, with a warning logged to the console.
+     *
+     * @param args
+     */
+    createNotification(...args: Parameters<typeof NotificationsTypes.create>): ReturnType<typeof NotificationsTypes.create>;
+    /**
+     * Updates an existing Notification.
+     */
+    update(...args: Parameters<typeof NotificationsTypes.update>): ReturnType<typeof NotificationsTypes.update>;
+    /**
+     * Clears a Notification with the specified id.
+     */
+    clear(...args: Parameters<typeof NotificationsTypes.clear>): ReturnType<typeof NotificationsTypes.clear>;
+};
+/**
+ * @internal
+ */
+type FlannelCreateNotificationRequest = {
+    version: 1;
+    payload: {
+        notification: NotificationsTypes.NotificationOptions;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelCreateNotificationResponse = {
+    version: 1;
+    payload: {
+        response: NotificationsTypes.Notification<NotificationsTypes.NotificationOptions>;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelUpdateNotificationRequest = {
+    version: 1;
+    payload: {
+        notification: NotificationsTypes.UpdatableNotificationOptions;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelUpdateNotificationResponse = {
+    version: 1;
+    payload: {
+        response: NotificationsTypes.Notification;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelClearNotificationRequest = {
+    version: 1;
+    payload: {
+        notificationId: string;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelClearNotificationResponse = {
+    version: 1;
+    payload: {
+        response: boolean;
+    };
+};
+/**
+ * @internal
+ */
+type FlannelProvider = {
+    'openfin-cloud-create-notification': (arg0: FlannelCreateNotificationRequest) => Promise<FlannelCreateNotificationResponse>;
+    'openfin-cloud-update-notification': (arg0: FlannelUpdateNotificationRequest) => Promise<FlannelUpdateNotificationResponse>;
+    'openfin-cloud-clear-notification': (arg0: FlannelClearNotificationRequest) => Promise<FlannelClearNotificationResponse>;
+};
+type NotificationEventsMap = {
+    'notification-form-values-changed': (event: NotificationsTypes.NotificationFormValuesChangedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-form-submitted': (event: NotificationsTypes.NotificationFormSubmittedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-action': (event: NotificationsTypes.NotificationActionEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-created': (event: NotificationsTypes.NotificationCreatedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-toast-dismissed': (event: NotificationsTypes.NotificationToastDismissedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-closed': (event: NotificationsTypes.NotificationClosedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notifications-count-changed': (event: NotificationsTypes.NotificationsCountChanged & {
+        timestamp: Date;
+    }) => void;
+    'notification-reminder-created': (event: NotificationsTypes.NotificationReminderCreatedEvent & {
+        timestamp: Date;
+    }) => void;
+    'notification-reminder-removed': (event: NotificationsTypes.NotificationReminderRemovedEvent & {
+        timestamp: Date;
+    }) => void;
+};
+/**
+ * @internal
+ */
+type FlannelClient = {
+    'openfin-cloud-event': <T extends keyof NotificationEventsMap>(arg0: {
+        type: T;
+        payload: Parameters<NotificationEventsMap[T]>[0];
+    }) => void;
+};
+/**
+ * @internal
+ */
+type FlannelChannelProvider = {
+    /**
+     * @internal
+     */
+    dispatch: <T extends keyof FlannelClient>(to: OpenFin__default.ClientIdentity | OpenFin__default.Identity, action: T, payload: Parameters<FlannelClient[T]>[0]) => Promise<Awaited<ReturnType<FlannelClient[T]>>>;
+    /**
+     * @internal
+     */
+    register: <T extends keyof FlannelProvider>(action: T, handler: (payload: Parameters<FlannelProvider[T]>[0], id: OpenFin__default.ProviderIdentity | OpenFin__default.ClientIdentity) => ReturnType<FlannelProvider[T]>) => boolean;
+} & Omit<OpenFin__default.ChannelProvider, 'dispatch' | 'register'>;
+
+declare global {
+    interface Window {
+        fin: typeof OpenFin.fin;
+    }
+}
+/**
+ * @returns A client for interacting with the OpenFin Notifications service
+ *
+ * @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>;
+
+/**
+ * Represents a collection of returned app permissions
+ */
+type AppPermissions = {
+    permissions: {
+        /**
+         * The name of the permission
+         */
+        name: string;
+        /**
+         * The ID of the permission
+         */
+        id: string;
+    }[];
+};
+/**
+ * @returns The app settings that have been set against the current app
+ *
+ * @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
+ */
+declare function getAppSettings(): Promise<unknown>;
+/**
+ * @returns The app settings that have been set against the current app for the current user
+ *
+ * @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
+ */
+declare function getAppUserSettings(): Promise<unknown>;
+/**
+ * Assigns a set of user specific settings to the current app
+ *
+ * @returns The app settings that have been set against the current app for the current user
+ *
+ * @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
+ */
+declare function setAppUserSettings(settings: unknown): Promise<unknown>;
+/**
+ * @returns The permissions that have been set against the current app for the current user
+ *
+ * @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
+ */
+declare function getAppUserPermissions(): Promise<AppPermissions>;
+
+export { type AppPermissions, type FlannelChannelProvider as __INTERNAL_FlannelChannelProvider, type FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest, type FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse, type FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest, type FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse, type FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest, type FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse, getAppSettings, getAppUserPermissions, getAppUserSettings, getNotificationsClient, setAppUserSettings };

package/dist/index.js

@@ -0,0 +1,2 @@
+var t="@openfin/cloud-api";async function a(){try{return await window.fin.View.getCurrentSync().getInfo(),!0}catch{return!1}}function u(e){if(e.name.startsWith("internal-generated"))throw new Error("Cannot extract app UUID from identity");return/\/[\d,a-z-]{36}$/.test(e.name)?e.name.split("/")[0]||"":e.name}var s="@openfin/cloud-api";function d(){return`${window.fin.me.uuid}-cloud-api-notifications`}var l=null;async function g(){return l||(l=w()),l}async function w(){if(!window.fin)throw new Error(`\`${s}\`: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${s}: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);u(window.fin.me);let e=await m();console.log(e),e.register("openfin-cloud-event",n=>{for(let i of o.get(n.type)??[])typeof n.payload.timestamp=="string"&&(n.payload.timestamp=new Date(n.payload.timestamp)),i(n.payload)});let o=new Map;return{addEventListener:(n,i)=>{let r=o.get(n)||new Set;r.add(i),o.set(n,r)},removeEventListener:(n,i)=>{let r=o.get(n);if(!r){console.warn(`\`${s}\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,n);return}r.delete(i)===!1&&console.warn(`\`${s}\`: Listener was not found for event. Did you pass a function directly instead of a reference?`,n)},update:async n=>(await e.dispatch("openfin-cloud-update-notification",{version:1,payload:{notification:n}})).payload.response,clear:async n=>(await e.dispatch("openfin-cloud-clear-notification",{version:1,payload:{notificationId:n}})).payload.response,createNotification:async n=>(n.id&&console.warn(`\`${s}\`: 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.`),(await e.dispatch("openfin-cloud-create-notification",{version:1,payload:{notification:{...n,id:void 0}}})).payload.response)}}var p=null;async function m(){return p||(p=y()),p}async function y(){let e=await window.fin.InterApplicationBus.Channel.connect(d());return e.onDisconnection(o=>{console.warn(`\`${s}\`: Channel Disconnected from`,o,"Reconnecting..."),p=null}),e}var f;function N(){return`${window.fin.me.uuid}-client-api`}async function c(){return f||(f=window.fin.InterApplicationBus.Channel.connect(N())),f}async function E(){if(!window.fin)throw new Error(`\`${t}\`: \`getAppSettings\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`getAppSettings\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("get-settings")}async function P(){if(!window.fin)throw new Error(`\`${t}\`: \`getAppUserSettings\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`getAppUserSettings\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("get-user-settings")}async function v(e){if(!window.fin)throw new Error(`\`${t}\`: \`setAppUserSettings\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`setAppUserSettings\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("set-user-settings",e)}async function T(){if(!window.fin)throw new Error(`\`${t}\`: \`getAppUserPermissions\` cannot be used in a non-OpenFin environment`);if(await a()===!1)throw new Error(`${t}: \`getAppUserPermissions\` cannot be used in a non-OpenFin environment`);return(await c()).dispatch("get-user-permissions")}export{E as getAppSettings,T as getAppUserPermissions,P as getAppUserSettings,g as getNotificationsClient,v as setAppUserSettings};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/notifications.ts","../src/client-api.ts"],"sourcesContent":["import type OpenFin from '@openfin/core';\n\nexport const PACKAGE_NAME = '@openfin/cloud-api';\n\nexport async function isInViewContext(): Promise<boolean> {\n    try {\n        await window.fin.View.getCurrentSync().getInfo();\n        return true;\n    } catch {\n        return false;\n    }\n}\n\nexport function 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","// eslint-disable-next-line check-file/no-index\nimport type * as NotificationsTypes from 'openfin-notifications';\n\nimport type { FlannelChannelClient, NotificationEventsMap, NotificationsClient } from './types';\nimport { extractAppUuidFromIdentity, isInViewContext } from './utils';\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\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","import type OpenFin from '@openfin/core';\n\nimport { isInViewContext, PACKAGE_NAME } from './utils';\n\nlet apiChannelClientPromise: Promise<OpenFin.ChannelClient>;\n\n/**\n * Represents a collection of returned app permissions\n */\nexport type AppPermissions = {\n    permissions: {\n        /**\n         * The name of the permission\n         */\n        name: string;\n        /**\n         * The ID of the permission\n         */\n        id: string;\n    }[];\n};\n\nfunction getApiChannelName() {\n    return `${window.fin.me.uuid}-client-api`;\n}\n\nasync function getApiChannelClient(): Promise<OpenFin.ChannelClient> {\n    if (!apiChannelClientPromise) {\n        apiChannelClientPromise = window.fin.InterApplicationBus.Channel.connect(getApiChannelName());\n    }\n\n    return apiChannelClientPromise;\n}\n\n/**\n * @returns The app settings that have been set against the current app\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 */\nasync function getAppSettings(): Promise<unknown> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getAppSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getAppSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('get-settings');\n}\n\n/**\n * @returns The app settings that have been set against the current app for the current user\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 */\nasync function getAppUserSettings(): Promise<unknown> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('get-user-settings');\n}\n\n/**\n * Assigns a set of user specific settings to the current app\n *\n * @returns The app settings that have been set against the current app for the current user\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 */\nasync function setAppUserSettings(settings: unknown): Promise<unknown> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`setAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`setAppUserSettings\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('set-user-settings', settings);\n}\n\n/**\n * @returns The permissions that have been set against the current app for the current user\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 */\nasync function getAppUserPermissions(): Promise<AppPermissions> {\n    if (!window.fin) {\n        throw new Error(`\\`${PACKAGE_NAME}\\`: \\`getAppUserPermissions\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    if ((await isInViewContext()) === false) {\n        throw new Error(`${PACKAGE_NAME}: \\`getAppUserPermissions\\` cannot be used in a non-OpenFin environment`);\n    }\n\n    const channel = await getApiChannelClient();\n\n    return channel.dispatch('get-user-permissions');\n}\n\nexport { getAppSettings, getAppUserSettings, setAppUserSettings, getAppUserPermissions };\n"],"mappings":"AAEO,IAAMA,EAAe,qBAE5B,eAAsBC,GAAoC,CACtD,GAAI,CACA,aAAM,OAAO,IAAI,KAAK,eAAe,EAAE,QAAQ,EACxC,EACX,MAAQ,CACJ,MAAO,EACX,CACJ,CAEO,SAASC,EAA2BC,EAAoC,CAC3E,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,CCjBA,IAAMC,EAAe,qBAmBrB,SAASC,GAAiB,CACtB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,0BAChC,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,KAAKJ,CAAY,4EAA4E,EAGjH,GAAK,MAAMK,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGL,CAAY,0EAA0E,EAG7GM,EAA2B,OAAO,IAAI,EAAE,EAExC,IAAMC,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,KAAKb,CAAY,+HACjBY,CACJ,EACA,MACJ,CAEIC,EAAU,OAAOH,CAAmC,IAAM,IAC1D,QAAQ,KAAK,KAAKV,CAAY,iGAAkGY,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,KAAKd,CAAY,+KACrB,GAEa,MAAMO,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,QAAQjB,EAAe,CAAC,EAEtF,OAAAiB,EAAQ,gBAAiBC,GAAa,CAClC,QAAQ,KAAK,KAAKnB,CAAY,gCAAiCmB,EAAU,iBAAiB,EAC1FH,EAAuB,IAC3B,CAAC,EAEME,CACX,CC3LA,IAAIE,EAkBJ,SAASC,GAAoB,CACzB,MAAO,GAAG,OAAO,IAAI,GAAG,IAAI,aAChC,CAEA,eAAeC,GAAsD,CACjE,OAAKF,IACDA,EAA0B,OAAO,IAAI,oBAAoB,QAAQ,QAAQC,EAAkB,CAAC,GAGzFD,CACX,CAQA,eAAeG,GAAmC,CAC9C,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKC,CAAY,oEAAoE,EAGzG,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,kEAAkE,EAKrG,OAFgB,MAAMF,EAAoB,GAE3B,SAAS,cAAc,CAC1C,CAQA,eAAeI,GAAuC,CAClD,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKF,CAAY,wEAAwE,EAG7G,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,sEAAsE,EAKzG,OAFgB,MAAMF,EAAoB,GAE3B,SAAS,mBAAmB,CAC/C,CAUA,eAAeK,EAAmBC,EAAqC,CACnE,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKJ,CAAY,wEAAwE,EAG7G,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,sEAAsE,EAKzG,OAFgB,MAAMF,EAAoB,GAE3B,SAAS,oBAAqBM,CAAQ,CACzD,CAQA,eAAeC,GAAiD,CAC5D,GAAI,CAAC,OAAO,IACR,MAAM,IAAI,MAAM,KAAKL,CAAY,2EAA2E,EAGhH,GAAK,MAAMC,EAAgB,IAAO,GAC9B,MAAM,IAAI,MAAM,GAAGD,CAAY,yEAAyE,EAK5G,OAFgB,MAAMF,EAAoB,GAE3B,SAAS,sBAAsB,CAClD","names":["PACKAGE_NAME","isInViewContext","extractAppUuidFromIdentity","identity","PACKAGE_NAME","getChannelName","notificationsClientPromise","getNotificationsClient","getNotificationsClientInternal","isInViewContext","extractAppUuidFromIdentity","channelPromise","getChannelClient","message","listener","eventListeners","eventName","listeners","options","notificationId","channelClientPromise","getChannelClientInternal","channel","identity","apiChannelClientPromise","getApiChannelName","getApiChannelClient","getAppSettings","PACKAGE_NAME","isInViewContext","getAppUserSettings","setAppUserSettings","settings","getAppUserPermissions"]}

package/package.json

@@ -0,0 +1,193 @@
+{
+    "name": "@openfin/cloud-api",
+    "version": "0.0.1-alpha.01a0640",
+    "sideEffects": false,
+    "description": "",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/index.cjs"
+        }
+    },
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.js",
+    "scripts": {
+        "build": "tsup --config ./tsup.config.ts",
+        "build:watch": "tsup --watch --config ./tsup.config.ts",
+        "lint": "eslint . --ext .ts,.tsx --max-warnings 0"
+    },
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "@openfin/core": "^34.78.80",
+        "openfin-notifications": "^2.3.2"
+    },
+    "devDependencies": {
+        "@typescript-eslint/eslint-plugin": "^7.5.0",
+        "@typescript-eslint/parser": "^7.5.0",
+        "eslint": "^8.57.0",
+        "eslint-config-next": "^14.1.4",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-check-file": "^2.6.2",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-simple-import-sort": "^12.0.0",
+        "eslint-plugin-unicorn": "^51.0.1",
+        "prettier": "^3.2.5",
+        "tsup": "^8.0.1",
+        "typescript": "^5.4.3"
+    },
+    "eslintConfig": {
+        "env": {
+            "browser": true,
+            "node": true
+        },
+        "parser": "@typescript-eslint/parser",
+        "parserOptions": {
+            "ecmaVersion": "latest",
+            "sourceType": "module",
+            "project": true
+        },
+        "extends": [
+            "eslint:recommended",
+            "plugin:prettier/recommended",
+            "plugin:@typescript-eslint/recommended",
+            "plugin:@typescript-eslint/strict",
+            "plugin:unicorn/recommended"
+        ],
+        "plugins": [
+            "simple-import-sort",
+            "prettier",
+            "check-file"
+        ],
+        "rules": {
+            "unicorn/prevent-abbreviations": [
+                "error",
+                {
+                    "replacements": {
+                        "props": false,
+                        "prop": false,
+                        "ref": false,
+                        "args": false,
+                        "arg": false,
+                        "src": false,
+                        "dev": false,
+                        "str": false
+                    }
+                }
+            ],
+            "@typescript-eslint/no-non-null-assertion": "error",
+            "unicorn/no-nested-ternary": "off",
+            "unicorn/no-array-for-each": "off",
+            "unicorn/no-useless-undefined": "off",
+            "unicorn/no-null": "off",
+            "eqeqeq": [
+                "error",
+                "always"
+            ],
+            "no-alert": "error",
+            "no-eval": "error",
+            "prettier/prettier": "warn",
+            "simple-import-sort/imports": [
+                "error",
+                {
+                    "groups": [
+                        [
+                            "^react$"
+                        ],
+                        [
+                            "^react"
+                        ],
+                        [
+                            "^next"
+                        ],
+                        [
+                            "^zod"
+                        ],
+                        [
+                            "^@radix-ui/"
+                        ],
+                        [
+                            "^[^.]"
+                        ],
+                        [
+                            "@/components/ui/.*"
+                        ],
+                        [
+                            "@/components/.*"
+                        ],
+                        [
+                            "@/config/.*"
+                        ],
+                        [
+                            "@/lib/.*"
+                        ],
+                        [
+                            "^\\.\\.(?!/?$)",
+                            "^\\.\\./?$"
+                        ],
+                        [
+                            "^\\./(?=.*/)(?!/?$)",
+                            "^\\.(?!/?$)",
+                            "^\\./?$"
+                        ],
+                        [
+                            "^.+\\.s?css$"
+                        ]
+                    ]
+                }
+            ],
+            "check-file/no-index": "error",
+            "check-file/filename-naming-convention": [
+                "error",
+                {
+                    "**/*.{jsx,tsx}": "KEBAB_CASE",
+                    "**/*.{js,ts}": "KEBAB_CASE"
+                },
+                {
+                    "ignoreMiddleExtensions": true
+                }
+            ],
+            "check-file/filename-blocklist": [
+                "error",
+                {
+                    "**/*.spec.js": "*.test.js",
+                    "**/*.spec.jsx": "*.test.jsx",
+                    "**/*.spec.ts": "*.test.ts",
+                    "**/*.spec.tsx": "*.test.tsx"
+                }
+            ],
+            "no-restricted-syntax": [
+                "error",
+                {
+                    "selector": "TSEnumDeclaration",
+                    "message": "Prefer string unions to enums."
+                }
+            ],
+            "curly": [
+                "error",
+                "multi-line"
+            ],
+            "@typescript-eslint/consistent-type-definitions": [
+                "error",
+                "type"
+            ],
+            "@typescript-eslint/no-unused-vars": [
+                "warn",
+                {
+                    "argsIgnorePattern": "^_",
+                    "varsIgnorePattern": "^_"
+                }
+            ],
+            "@typescript-eslint/no-explicit-any": 1
+        },
+        "ignorePatterns": [
+            "node_modules",
+            "out",
+            "build",
+            "dist/",
+            ".next"
+        ]
+    }
+}