@limetech/lime-web-components 5.32.0 → 5.33.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [5.33.1](https://github.com/Lundalogik/lime-web-components/compare/v5.33.0...v5.33.1) (2024-09-03)
+
+
+### Bug Fixes
+
+
+* **notifications:** update interfaces to better align with other services ([900b937](https://github.com/Lundalogik/lime-web-components/commit/900b93711ff3e7ade43010536948afcd58fae753)), closes [Lundalogik/crm-feature#4341](https://github.com/Lundalogik/crm-feature/issues/4341)
+
+## [5.33.0](https://github.com/Lundalogik/lime-web-components/compare/v5.32.0...v5.33.0) (2024-08-30)
+
+
+### Features
+
+
+* **notifications:** update load response and provide load options ([dd6aa7c](https://github.com/Lundalogik/lime-web-components/commit/dd6aa7c8f83dd80416552b5acc232c518eff9d59))
+
 ## [5.32.0](https://github.com/Lundalogik/lime-web-components/compare/v5.31.0...v5.32.0) (2024-08-23)
 
 

package/dist/notification-service/notification.d.ts

@@ -4,9 +4,46 @@
  * @alpha
  * @group NotificationRepository
  */
-export type Notification = {
+export type Notification<T = unknown> = {
+    /**
+     * The notification id
+     */
     id: number;
-    iduser: number;
-    read: Boolean;
+    /**
+     * Type of notification
+     */
+    type?: NotificationType;
+    /**
+     * ID of the user the notification belongs to
+     */
+    userId: number;
+    /**
+     * Date when the notification was marked as read
+     */
+    read?: Date;
+    /**
+     * Date when the notification was created
+     */
+    createdTime: Date;
+    /**
+     * ID of the user that created the notification
+     */
+    createdUser: number;
+    /**
+     * Limetype that the notification is attached to
+     */
+    limetype?: string;
+    /**
+     * ID of the object the notification is attached to
+     */
+    objectId?: number;
+    /**
+     * Data attached to the notification
+     */
+    data?: T;
 };
+/**
+ * @alpha
+ */
+export type NotificationType = 'mention';
 //# sourceMappingURL=notification.d.ts.map

package/dist/notification-service/notification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../src/notification-service/notification.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC"}
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../src/notification-service/notification.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,OAAO,IAAI;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC"}

package/dist/notification-service/repository.d.ts

@@ -7,36 +7,64 @@ import { Notification } from './notification';
  */
 export interface NotificationRepository {
     /**
-     * Gets all notifications
+     * Load all notifications belonging to the logged in user from the server
      *
-     * @returns the saved notifications
-     */
-    loadNotifications(): Promise<Notification[] | undefined>;
-    /**
-     * Creates a notification
+     * @param options - options to provide when loading notifications
      *
-     * @returns the created notification
+     * @returns the saved notifications
      */
-    createNotification(): Promise<Notification | undefined>;
+    loadAll(options?: NotificationLoadOptions): Promise<NotificationResponse>;
     /**
-     * Gets a notification by its id
+     * Gets a loaded notification by its id
      *
      * @param notificationId - the id of the notification to get
      * @returns the fetched notification
      */
-    getNotification(notificationId: number): Promise<Notification | undefined>;
+    get(notificationId: number): Notification | undefined;
     /**
-     * Deletes a notification by its id
+     * Delete a notification
      *
-     * @param notificationId - the id of the notification to delete
+     * @param notification - the notification to delete
      */
-    deleteNotification(notificationId: number): Promise<void>;
+    delete(notification: Notification): Promise<void>;
     /**
      * Marks a notification as read
      *
-     * @param notificationId - the id of the notification to mark as read
-     * @returns the read notification
+     * @param notification - the notification to mark as read
+     * @returns the updated notification
+     */
+    markAsRead(notification: Notification): Promise<Notification>;
+}
+/**
+ * The count response of loaded notifications
+ *
+ * @alpha
+ * @group NotificationRepository
+ */
+export type NotificationCount = {
+    total: number;
+    unread: number;
+};
+/**
+ * The response of loaded notifications
+ *
+ * @alpha
+ * @group NotificationRepository
+ */
+export type NotificationResponse = {
+    items: Notification[];
+    count: NotificationCount;
+};
+/**
+ * The options to load notifications with
+ *
+ * @alpha
+ * @group NotificationRepository
+ */
+export interface NotificationLoadOptions {
+    /**
+     * Maximum number of notifications to load
      */
-    markNotificationAsRead(notificationId: number): Promise<Notification | undefined>;
+    limit?: number;
 }
 //# sourceMappingURL=repository.d.ts.map

package/dist/notification-service/repository.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/notification-service/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,iBAAiB,IAAI,OAAO,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,CAAC;IAEzD;;;;OAIG;IACH,kBAAkB,IAAI,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAExD;;;;;OAKG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAE3E;;;;OAIG;IACH,kBAAkB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,sBAAsB,CAClB,cAAc,EAAE,MAAM,GACvB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;CACxC"}
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/notification-service/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE1E;;;;;OAKG;IACH,GAAG,CAAC,cAAc,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IAEtD;;;;OAIG;IACH,MAAM,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;OAKG;IACH,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACjE;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,KAAK,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.32.0",
+  "version": "5.33.1",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -35,7 +35,7 @@
     "tslib": "^2.6.3"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^19.2.2",
+    "@commitlint/config-conventional": "^19.4.1",
     "@microsoft/api-extractor": "^7.47.7",
     "@types/jest": "^27.5.0",
     "@typescript-eslint/eslint-plugin": "^7.5.0",