openfin-notifications 1.10.1 → 1.10.2-alpha-730

package/dist/client/index.d.ts

@@ -12,7 +12,7 @@ import { ButtonOptions, ControlOptions } from './controls';
 import { DistributiveOmit } from './internal';
 import * as provider from './provider';
 import { NotificationSource } from './source';
-import { NotificationIndicator, IndicatorType } from './indicator';
+import { NotificationIndicator, IndicatorType, IndicatorColor } from './indicator';
 import { NotificationOptions } from './templates/templates';
 export * from './actions';
 export * from './controls';
@@ -21,7 +21,7 @@ export * from './forms';
 export * from './stream';
 export * from './templates';
 export { provider, NotificationOptions };
-export { NotificationIndicator, IndicatorType as NotificationIndicatorType };
+export { NotificationIndicator, IndicatorColor, IndicatorType as NotificationIndicatorType };
 /**
  * The Notification Client library's version in semver format.
  *

package/dist/client/indicator.d.ts

@@ -2,6 +2,7 @@
  * @module Notifications
  */
 /**
+ * @deprecated
  * Lists possible semantic use-cases for notifications, which can alter how the notification is presented to the user.
  *
  * Additional indicator types may be added in future releases.
@@ -11,6 +12,9 @@ export declare enum IndicatorType {
     WARNING = "warning",
     SUCCESS = "success"
 }
+/**
+ * Lists possible colors available for use as NotificationIndicator background color.
+ */
 export declare enum IndicatorColor {
     RED = "red",
     GREEN = "green",

package/dist/client/main-bundle.js

@@ -391,7 +391,7 @@ async function getServicePromise() {
             }, 5000);
             channelPromise = fin.InterApplicationBus.Channel.connect(internal_1.SERVICE_CHANNEL, {
                 wait: true,
-                payload: { version: '1.10.1' },
+                payload: { version: '1.10.2-alpha-730' },
             }).then((channel) => {
                 window.clearTimeout(timeoutHandle);
                 const eventRouter = getEventRouter();
@@ -495,16 +495,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);
 
 
 /***/ }),
@@ -513,10 +523,7 @@ exports.TemplateNames = {
 
 "use strict";
 
-/* eslint-disable no-redeclare */
-/**
- * @module NotificationCenter
- */
+/* eslint-disable @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-explicit-any */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
@@ -551,7 +558,10 @@ 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.NotificationIndicator = exports.NotificationOptions = exports.provider = void 0;
+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;
+/**
+ * @module NotificationCenter
+ */
 /**
  * Need a comment block here so that the comment block above is interpreted as a file comment, and not a comment on the
  * import below.
@@ -567,6 +577,7 @@ const validation_1 = __webpack_require__(12);
 const indicator_1 = __webpack_require__(13);
 Object.defineProperty(exports, "NotificationIndicator", { enumerable: true, get: function () { return indicator_1.NotificationIndicator; } });
 Object.defineProperty(exports, "NotificationIndicatorType", { enumerable: true, get: function () { return indicator_1.IndicatorType; } });
+Object.defineProperty(exports, "IndicatorColor", { enumerable: true, get: function () { return indicator_1.IndicatorColor; } });
 const templates_1 = __webpack_require__(5);
 Object.defineProperty(exports, "NotificationOptions", { enumerable: true, get: function () { return templates_1.NotificationOptions; } });
 __exportStar(__webpack_require__(1), exports);
@@ -580,7 +591,7 @@ __exportStar(__webpack_require__(20), exports);
  *
  * This is the version which you are currently using.
  */
-exports.VERSION = '1.10.1';
+exports.VERSION = '1.10.2-alpha-730';
 const eventHandler = connection_1.getEventRouter();
 function parseEventWithNotification(event) {
     const { notification } = event;
@@ -1506,6 +1517,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.
@@ -1513,6 +1527,7 @@ function getStatus() {
         return {
             connected: false,
             version: null,
+            templateAPIVersion: null,
         };
     });
 }
@@ -1577,6 +1592,7 @@ module.exports = function cmp (a, b) {
 
 "use strict";
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.safeStringify = exports.validateEnvironment = exports.sanitizeEventType = exports.sanitizeFunction = void 0;
 /**
@@ -1638,6 +1654,7 @@ exports.safeStringify = safeStringify;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IndicatorColor = exports.IndicatorType = void 0;
 /**
+ * @deprecated
  * Lists possible semantic use-cases for notifications, which can alter how the notification is presented to the user.
  *
  * Additional indicator types may be added in future releases.
@@ -1648,6 +1665,9 @@ var IndicatorType;
     IndicatorType["WARNING"] = "warning";
     IndicatorType["SUCCESS"] = "success";
 })(IndicatorType = exports.IndicatorType || (exports.IndicatorType = {}));
+/**
+ * Lists possible colors available for use as NotificationIndicator background color.
+ */
 var IndicatorColor;
 (function (IndicatorColor) {
     IndicatorColor["RED"] = "red";
@@ -1715,13 +1735,7 @@ __exportStar(__webpack_require__(18), exports);
 
 "use strict";
 
-/**
- * When you make a form, you provide a list of [[FormFields]]. Each FormField contains the ingredients to make a single widget in the form.
- * The actual definitions of the widgets are derived from [[BaseWidgetSpec]].
- *
- * A FormField contains the type of data, the key to store the user input into [[CustomDataWithForms]], and some additional configuration.
- * @module FormFields
- */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FieldType = void 0;
 /**