@limetech/lime-web-components 5.33.0 → 5.34.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [5.34.0](https://github.com/Lundalogik/lime-web-components/compare/v5.33.1...v5.34.0) (2024-09-05)
+
+
+### Features
+
+
+* **notifications:** mark notification as unread ([32acc44](https://github.com/Lundalogik/lime-web-components/commit/32acc44e5e3170c8c2a6d7ddb67ff002fed111d5))
+
+## [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)
 
 

package/README.md

@@ -17,15 +17,12 @@ not updated, the GitHub build will fail when the API is verified.
 
 ## Deploy documentation
 
-Documentation is deployed to GitHub Pages when a new release is built by GitHub Actions. It can also be deployed manually from a Linux or macOS computer. *NB! Running the publish script locally will update your git config for the repository with the values of the GIT_AUTHOR_EMAIL and GIT_AUTHOR_NAME environment variables. If you set these to anything other than your own user, you may wish to update your config again after publishing. The script will also make changes to a few files, and will checkout these again at the end. Any uncommitted changes you've made to these files **will be lost**. The script also removes the local copy of the branch gh-pages.*
+Documentation is deployed to GitHub Pages when a new release is built by GitHub Actions. It can also be deployed manually from a Linux or macOS computer.
 
 Follow these steps:
 
 1. The following environment variables must be set:
-  - GIT_AUTHOR_EMAIL - the email address for the user making the commit
-  - GIT_AUTHOR_NAME - the name of the user making the commit
-  - GH_TOKEN - a GitHub access-token with write-access to the repository
-  - GH_USERNAME - the GitHub user to which the above access-token belongs
+  - GITHUB_TOKEN - a GitHub access-token with write-access to the repository
 2. Run `git fetch`.
 3. Run `git branch` and make sure you do *not* have a local copy of the branch `gh-pages`. If you do, push anything that should be pushed, and remove the local branch.
 4. From the repo-root, run `npm run docs:publish -- --v=<version>`, where `<version>` is the version of lime-elements you are building the documentation for. **Any existing documentation for this version number will be overwritten.** If no version is supplied, the version will be set to `0.0.0-dev`. If `--dryRun=true` is supplied, the entire script will run, except the push to GitHub.

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,39 +7,34 @@ import { Notification } from './notification';
  */
 export interface NotificationRepository {
     /**
-     * Gets all notifications
+     * Load all notifications belonging to the logged in user from the server
      *
      * @param options - options to provide when loading notifications
      *
      * @returns the saved notifications
      */
-    loadNotifications(options?: NotificationLoadOptions): Promise<NotificationResponse | undefined>;
+    loadAll(options?: NotificationLoadOptions): Promise<NotificationResponse>;
     /**
-     * Creates a notification
-     *
-     * @returns the created notification
-     */
-    createNotification(): Promise<Notification | undefined>;
-    /**
-     * Gets a notification by its id
+     * Get 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
+     * Mark a notification as read or unread
      *
-     * @param notificationId - the id of the notification to mark as read
-     * @returns the read notification
+     * @param notification - the notification to update
+     * @param read - optional - whether the notification should be marked as read or unread. Defaults to `true`
+     * @returns the updated notification
      */
-    markNotificationAsRead(notificationId: number): Promise<Notification | undefined>;
+    markAsRead(notification: Notification, read: boolean): Promise<Notification>;
 }
 /**
  * The count response of loaded notifications

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;;;;;;OAMG;IACH,iBAAiB,CACb,OAAO,CAAC,EAAE,uBAAuB,GAClC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAC;IAE7C;;;;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;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"}
+{"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;;;;;;OAMG;IACH,UAAU,CACN,YAAY,EAAE,YAAY,EAC1B,IAAI,EAAE,OAAO,GACd,OAAO,CAAC,YAAY,CAAC,CAAC;CAC5B;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.33.0",
+  "version": "5.34.0",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -16,7 +16,7 @@
     "build": "tsc && tsc -p tsconfig.es5.json",
     "start": "tsc --watch",
     "test": "stencil test --spec",
-    "docs": "typedoc",
+    "docs:build": "typedoc",
     "docs:publish": "node publish-docs.js",
     "api:update": "npm run build && api-extractor run --local --verbose",
     "api:verify": "api-extractor run",
@@ -25,14 +25,12 @@
     "lint:json": "prettier -l '{!(package*).json,packages/*/!(package*).json,.prettierrc}'",
     "lint:json:fix": "prettier --write '{!(package*).json,packages/*/!(package*).json,.prettierrc}'",
     "lint:src": "eslint '**/*.{ts,js}' --max-warnings=0",
-    "lint:src:fix": "eslint '**/*.{ts,js}' --fix --max-warnings=0",
-    "postpublish": "npm run docs:publish -- --v=current",
-    "postpublish:dry-run": "npm run docs:publish -- --v=current --dryRun"
+    "lint:src:fix": "eslint '**/*.{ts,js}' --fix --max-warnings=0"
   },
   "dependencies": {
     "@stencil/core": "^2.22.3",
     "rxjs": "^7.8.1",
-    "tslib": "^2.6.3"
+    "tslib": "^2.7.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19.4.1",