openfin-notifications 1.10.2 → 1.10.3-alpha-755

package/dist/client/index.d.ts

@@ -14,6 +14,7 @@ import * as provider from './provider';
 import { NotificationSource } from './source';
 import { NotificationIndicator, IndicatorType, IndicatorColor } from './indicator';
 import { NotificationOptions } from './templates/templates';
+import { UpdatableNotificationOptions } from './templates/updatableNotificationTemplates';
 export * from './actions';
 export * from './controls';
 export * from './source';
@@ -44,6 +45,9 @@ export declare type CustomData = Record<string, any>;
 export declare type Notification<T extends NotificationOptions = NotificationOptions> = Readonly<Required<DistributiveOmit<T, 'buttons'>> & {
     readonly buttons: ReadonlyArray<Required<ButtonOptions>>;
 }>;
+export declare type UpdatableNotification<T extends UpdatableNotificationOptions = UpdatableNotificationOptions> = Readonly<DistributiveOmit<T, 'buttons'> & {
+    readonly buttons?: ReadonlyArray<Required<ButtonOptions>>;
+}>;
 /**
  * Event fired when an action is raised for a notification due to a specified trigger. It is important to note that
  * applications will only receive these events if they indicate to the service that they want to receive these events.
@@ -202,6 +206,28 @@ export declare function removeEventListener(eventType: 'notifications-count-chan
  * @param options Notification configuration options.
  */
 export declare function create<T extends NotificationOptions>(options: T): Promise<Notification<T>>;
+/**
+ * Updates an existing notification. Requires id of original Notification and one of:
+ *    - buttons
+ *    - customData
+ *    - Template
+ *
+ * The updated Notification will then show in Notification Centre and in the Toast stack if not expired.
+ *
+ * Example:
+ * ```ts
+ * import {update} from 'openfin-notifications';
+ *
+ *    update({
+        id: uniqueNotificationId,
+        body: 'i am an update! - ' + Date.now().toString(),
+        template: 'markdown',
+      });
+ * ```
+ * @param options
+ * @returns
+ */
+export declare function update<T extends UpdatableNotificationOptions>(options: T): Promise<Notification>;
 /**
  * Clears a specific notification from the Notification Center.
  *

package/dist/client/internal.d.ts

@@ -10,7 +10,8 @@
 import { NotificationActionResult, ActionTrigger } from './actions';
 import { ProviderStatus } from './provider';
 import { NotificationSource } from './source';
-import { NotificationOptions, Notification, NotificationActionEvent, NotificationClosedEvent, NotificationCreatedEvent, NotificationsCountChanged, NotificationFormSubmittedEvent } from './index';
+import { NotificationOptions, Notification, NotificationActionEvent, NotificationClosedEvent, NotificationCreatedEvent, NotificationsCountChanged, NotificationFormSubmittedEvent, UpdatableNotification } from './index';
+import { UpdatableNotificationOptions } from './templates/updatableNotificationTemplates';
 /**
  * The identity of the main application window of the service provider
  */
@@ -24,6 +25,7 @@ export declare const SERVICE_IDENTITY: {
 export declare const SERVICE_CHANNEL = "of-notifications-service-v1";
 export declare const enum APITopic {
     CREATE_NOTIFICATION = "create-notification",
+    UPDATE_NOTIFICATION = "update-notification",
     CLEAR_NOTIFICATION = "clear-notification",
     GET_APP_NOTIFICATIONS = "fetch-app-notifications",
     CLEAR_APP_NOTIFICATIONS = "clear-app-notifications",
@@ -35,6 +37,7 @@ export declare const enum APITopic {
 }
 export interface API {
     [APITopic.CREATE_NOTIFICATION]: [CreatePayload, NotificationInternal];
+    [APITopic.UPDATE_NOTIFICATION]: [UpdatePayload, NotificationInternal];
     [APITopic.CLEAR_NOTIFICATION]: [ClearPayload, boolean];
     [APITopic.CLEAR_APP_NOTIFICATIONS]: [undefined, number];
     [APITopic.GET_APP_NOTIFICATIONS]: [undefined, NotificationInternal[]];
@@ -51,10 +54,15 @@ export declare type CreatePayload<T extends NotificationOptions = NotificationOp
     date?: number;
     expires?: number | null;
 };
+export declare type UpdatePayload<T extends UpdatableNotificationOptions = UpdatableNotificationOptions> = T;
 export declare type NotificationInternal<T extends NotificationOptions = NotificationOptions> = DistributiveOmit<Notification<T>, 'date' | 'expires'> & {
     date: number;
     expires: number | null;
 };
+export declare type UpdatableNotificationInternal<T extends UpdatableNotificationOptions = UpdatableNotificationOptions> = UpdatableNotification<T> & {
+    bodyText?: string;
+    body?: string;
+};
 export interface ClearPayload {
     id: string;
 }

package/dist/client/main-bundle.js

@@ -119,6 +119,7 @@ exports.SERVICE_CHANNEL = 'of-notifications-service-v1';
 var APITopic;
 (function (APITopic) {
     APITopic["CREATE_NOTIFICATION"] = "create-notification";
+    APITopic["UPDATE_NOTIFICATION"] = "update-notification";
     APITopic["CLEAR_NOTIFICATION"] = "clear-notification";
     APITopic["GET_APP_NOTIFICATIONS"] = "fetch-app-notifications";
     APITopic["CLEAR_APP_NOTIFICATIONS"] = "clear-app-notifications";
@@ -391,7 +392,7 @@ async function getServicePromise() {
             }, 5000);
             channelPromise = fin.InterApplicationBus.Channel.connect(internal_1.SERVICE_CHANNEL, {
                 wait: true,
-                payload: { version: '1.10.2' },
+                payload: { version: '1.10.3-alpha-755' },
             }).then((channel) => {
                 window.clearTimeout(timeoutHandle);
                 const eventRouter = getEventRouter();
@@ -495,16 +496,26 @@ exports.DeferredPromise = DeferredPromise;
 "use strict";
 
 /**
- * These are the templates you can use.
+ * OpenFin Notification Templates API Version 1
  *
  * @module Templates
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateNames = void 0;
+exports.TemplateFragmentNames = exports.PresentationTemplateFragmentNames = exports.ContainerTemplateFragmentNames = exports.TemplateNames = void 0;
 exports.TemplateNames = {
     markdown: 'markdown',
     list: 'list',
+    custom: 'custom',
 };
+exports.ContainerTemplateFragmentNames = {
+    container: 'container',
+};
+exports.PresentationTemplateFragmentNames = {
+    text: 'text',
+    image: 'image',
+    list: 'list',
+};
+exports.TemplateFragmentNames = Object.assign(Object.assign({}, exports.ContainerTemplateFragmentNames), exports.PresentationTemplateFragmentNames);
 
 
 /***/ }),
@@ -548,7 +559,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNotificationsCount = exports.toggleNotificationCenter = exports.clearAll = exports.getAll = exports.clear = exports.create = exports.removeEventListener = exports.addEventListener = exports.VERSION = exports.NotificationIndicatorType = exports.IndicatorColor = exports.NotificationIndicator = exports.NotificationOptions = exports.provider = void 0;
+exports.getNotificationsCount = exports.toggleNotificationCenter = exports.clearAll = exports.getAll = exports.clear = exports.update = exports.create = exports.removeEventListener = exports.addEventListener = exports.VERSION = exports.NotificationIndicatorType = exports.IndicatorColor = exports.NotificationIndicator = exports.NotificationOptions = exports.provider = void 0;
 /**
  * @module NotificationCenter
  */
@@ -581,7 +592,7 @@ __exportStar(__webpack_require__(20), exports);
  *
  * This is the version which you are currently using.
  */
-exports.VERSION = '1.10.2';
+exports.VERSION = '1.10.3-alpha-755';
 const eventHandler = connection_1.getEventRouter();
 function parseEventWithNotification(event) {
     const { notification } = event;
@@ -681,6 +692,38 @@ async function create(options) {
     return Object.assign(Object.assign({}, response), { date: new Date(response.date), expires: response.expires !== null ? new Date(response.expires) : null });
 }
 exports.create = create;
+/**
+ * Updates an existing notification. Requires id of original Notification and one of:
+ *    - buttons
+ *    - customData
+ *    - Template
+ *
+ * The updated Notification will then show in Notification Centre and in the Toast stack if not expired.
+ *
+ * Example:
+ * ```ts
+ * import {update} from 'openfin-notifications';
+ *
+ *    update({
+        id: uniqueNotificationId,
+        body: 'i am an update! - ' + Date.now().toString(),
+        template: 'markdown',
+      });
+ * ```
+ * @param options
+ * @returns
+ */
+async function update(options) {
+    if (typeof options !== 'object' || options === null) {
+        throw new Error('Invalid argument passed to create: argument must be an object and must not be null');
+    }
+    if (!options.id) {
+        throw new Error('Invalid argument passed to create: "id" must be Id of previously created Notification');
+    }
+    const response = await connection_1.tryServiceDispatch(internal_1.APITopic.UPDATE_NOTIFICATION, Object.assign({}, options));
+    return Object.assign({}, response);
+}
+exports.update = update;
 /**
  * Clears a specific notification from the Notification Center.
  *
@@ -1507,6 +1550,9 @@ const internal_1 = __webpack_require__(0);
  * versions, this API will indicate that the provider is disconnected.
  *
  * @since 0.11.2
+ *
+ * Note: Template API version is only available when the connected provider is verison 1.10.2 or later.
+ *
  */
 function getStatus() {
     // We need to race a timeout here as we never reject if the provider is not connected.
@@ -1514,6 +1560,7 @@ function getStatus() {
         return {
             connected: false,
             version: null,
+            templateAPIVersion: null,
         };
     });
 }
@@ -1812,6 +1859,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(__webpack_require__(21), exports);
 __exportStar(__webpack_require__(5), exports);
+__exportStar(__webpack_require__(22), exports);
 
 
 /***/ }),
@@ -1828,6 +1876,15 @@ __exportStar(__webpack_require__(5), exports);
 Object.defineProperty(exports, "__esModule", { value: true });
 
 
+/***/ }),
+/* 22 */
+/***/ (function(module, exports, __webpack_require__) {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", { value: true });
+
+
 /***/ })
 /******/ ]);
 });