@backstage/plugin-notifications-common 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @backstage/plugin-notifications-common
 
+## 0.0.3
+
+### Patch Changes
+
+- 0d99528: Notification processor functions are now renamed to `preProcess` and `postProcess`.
+  Additionally, processor name is now required to be returned by `getName`.
+  A new processor functionality `processOptions` was added to process options before sending the notification.
+- e003e0e: The ordered list of notifications' severities is exported by notifications-common for reusability.
+
 ## 0.0.2
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1,3 +1,11 @@
 'use strict';
 
+const notificationSeverities = [
+  "critical",
+  "high",
+  "normal",
+  "low"
+];
+
+exports.notificationSeverities = notificationSeverities;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/constants.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NotificationSeverity } from './types';\n\n/** Ordered list of severities used by the Notifications.\n *\n * @public */\nexport const notificationSeverities: NotificationSeverity[] = [\n  'critical',\n  'high',\n  'normal',\n  'low',\n];\n"],"names":[],"mappings":";;AAoBO,MAAM,sBAAiD,GAAA;AAAA,EAC5D,UAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF;;;;"}

package/dist/index.d.ts

@@ -2,28 +2,82 @@
 type NotificationSeverity = 'critical' | 'high' | 'normal' | 'low';
 /** @public */
 type NotificationPayload = {
+    /**
+     * Notification title
+     */
     title: string;
+    /**
+     * Optional longer description for the notification
+     */
     description?: string;
+    /**
+     * Optional link where the notification is pointing to
+     */
     link?: string;
+    /**
+     * Notification severity, defaults to 'normal'
+     */
     severity?: NotificationSeverity;
+    /**
+     * Optional notification topic
+     */
     topic?: string;
+    /**
+     * Notification scope, can be used to re-send same notifications in case
+     * the scope and origin matches.
+     */
     scope?: string;
+    /**
+     * Optional notification icon
+     */
     icon?: string;
 };
 /** @public */
 type Notification = {
+    /**
+     * Unique identifier for the notification
+     */
     id: string;
-    user: string;
+    /**
+     * The user entity reference that the notification is targeted to or null
+     * for broadcast notifications
+     */
+    user: string | null;
+    /**
+     * Notification creation date
+     */
     created: Date;
+    /**
+     * If user has saved the notification, the date when it was saved
+     */
     saved?: Date;
+    /**
+     * If user has read the notification, the date when it was read
+     */
     read?: Date;
+    /**
+     * If the notification has been updated due to it being in the same scope
+     * and from same origin as previous notification, the date when it was updated
+     */
     updated?: Date;
+    /**
+     * Origin of the notification as in the reference to sender
+     */
     origin: string;
+    /**
+     * Actual notification payload
+     */
     payload: NotificationPayload;
 };
 /** @public */
 type NotificationStatus = {
+    /**
+     * Total number of unread notifications for the user
+     */
     unread: number;
+    /**
+     * Total number of read notifications for the user
+     */
     read: number;
 };
 /** @public */
@@ -39,4 +93,9 @@ type NotificationReadSignal = {
 /** @public */
 type NotificationSignal = NewNotificationSignal | NotificationReadSignal;
 
-export { NewNotificationSignal, Notification, NotificationPayload, NotificationReadSignal, NotificationSeverity, NotificationSignal, NotificationStatus };
+/** Ordered list of severities used by the Notifications.
+ *
+ * @public */
+declare const notificationSeverities: NotificationSeverity[];
+
+export { type NewNotificationSignal, type Notification, type NotificationPayload, type NotificationReadSignal, type NotificationSeverity, type NotificationSignal, type NotificationStatus, notificationSeverities };

package/dist/index.esm.js

@@ -1,2 +1,9 @@
+const notificationSeverities = [
+  "critical",
+  "high",
+  "normal",
+  "low"
+];
 
+export { notificationSeverities };
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"index.esm.js","sources":["../src/constants.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { NotificationSeverity } from './types';\n\n/** Ordered list of severities used by the Notifications.\n *\n * @public */\nexport const notificationSeverities: NotificationSeverity[] = [\n  'critical',\n  'high',\n  'normal',\n  'low',\n];\n"],"names":[],"mappings":"AAoBO,MAAM,sBAAiD,GAAA;AAAA,EAC5D,UAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-notifications-common",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Common functionalities for the notifications plugin",
   "backstage": {
     "role": "common-library"
@@ -35,7 +35,7 @@
     "@material-ui/icons": "^4.9.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.0"
+    "@backstage/cli": "^0.26.3"
   },
   "module": "dist/index.esm.js"
 }