@openfin/cloud-api 0.0.1-alpha.12a0cef

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 o="@openfin/cloud-api";function l(){return`${window.fin.me.uuid}-cloud-api-notifications`}async function c(){try{return await window.fin.View.getCurrentSync().getInfo(),!0}catch (e2){return!1}}function f(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 r=null;async function y(){return r||(r=p()),r}async function p(){if(!window.fin)throw new Error(`\`${o}\`: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);if(await c()===!1)throw new Error(`${o}: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);f(window.fin.me);let e=await d();console.log(e),e.register("openfin-cloud-event",n=>{for(let t of _nullishCoalesce(i.get(n.type), () => ([])))typeof n.payload.timestamp=="string"&&(n.payload.timestamp=new Date(n.payload.timestamp)),t(n.payload)});let i=new Map;return{addEventListener:(n,t)=>{let a=i.get(n)||new Set;a.add(t),i.set(n,a)},removeEventListener:(n,t)=>{let a=i.get(n);if(!a){console.warn(`\`${o}\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,n);return}a.delete(t)===!1&&console.warn(`\`${o}\`: 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(`\`${o}\`: 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 s=null;async function d(){return s||(s=u()),s}async function u(){let e=await window.fin.InterApplicationBus.Channel.connect(l());return e.onDisconnection(i=>{console.warn(`\`${o}\`: Channel Disconnected from`,i,"Reconnecting..."),s=null}),e}exports.getNotificationsClient = y;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +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,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

@@ -0,0 +1,211 @@
+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>;
+
+export { 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, getNotificationsClient };

package/dist/index.d.ts

@@ -0,0 +1,211 @@
+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>;
+
+export { 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, getNotificationsClient };

package/dist/index.js

@@ -0,0 +1,2 @@
+var o="@openfin/cloud-api";function l(){return`${window.fin.me.uuid}-cloud-api-notifications`}async function c(){try{return await window.fin.View.getCurrentSync().getInfo(),!0}catch{return!1}}function f(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 r=null;async function y(){return r||(r=p()),r}async function p(){if(!window.fin)throw new Error(`\`${o}\`: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);if(await c()===!1)throw new Error(`${o}: \`getNotificationsClient\` cannot be used in a non-OpenFin environment`);f(window.fin.me);let e=await d();console.log(e),e.register("openfin-cloud-event",n=>{for(let t of i.get(n.type)??[])typeof n.payload.timestamp=="string"&&(n.payload.timestamp=new Date(n.payload.timestamp)),t(n.payload)});let i=new Map;return{addEventListener:(n,t)=>{let a=i.get(n)||new Set;a.add(t),i.set(n,a)},removeEventListener:(n,t)=>{let a=i.get(n);if(!a){console.warn(`\`${o}\`: Listener was not found for event. Did you pass a function directly instead of a reference or forget to add the listener?`,n);return}a.delete(t)===!1&&console.warn(`\`${o}\`: 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(`\`${o}\`: 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 s=null;async function d(){return s||(s=u()),s}async function u(){let e=await window.fin.InterApplicationBus.Channel.connect(l());return e.onDisconnection(i=>{console.warn(`\`${o}\`: Channel Disconnected from`,i,"Reconnecting..."),s=null}),e}export{y as getNotificationsClient};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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 *\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

@@ -0,0 +1,194 @@
+{
+    "name": "@openfin/cloud-api",
+    "version": "0.0.1-alpha.12a0cef",
+    "sideEffects": false,
+    "description": "",
+    "exports": {
+        ".": {
+            "import": "./dist/index.cjs",
+            "require": "./dist/index.js"
+        }
+    },
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.js",
+    "scripts": {
+        "build": "tsup --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": "^6.21.0",
+        "@typescript-eslint/parser": "^6.21.0",
+        "eslint": "^8.56.0",
+        "eslint-config-next": "^14.1.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-check-file": "^2.6.2",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-simple-import-sort": "^10.0.0",
+        "eslint-plugin-unicorn": "^51.0.1",
+        "prettier": "^3.2.5",
+        "tsup": "^8.0.1",
+        "typescript": "^5.3.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": [
+                "warn"
+            ]
+        },
+        "ignorePatterns": [
+            "node_modules",
+            "out",
+            "build",
+            "dist/",
+            ".next"
+        ]
+    }
+}