@limetech/lime-web-components 5.33.1 → 5.34.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [5.34.1](https://github.com/Lundalogik/lime-web-components/compare/v5.34.0...v5.34.1) (2024-09-06)
+
+
+### Bug Fixes
+
+
+* **notifications:** add CreatedUser to Notification ([c1cdf71](https://github.com/Lundalogik/lime-web-components/commit/c1cdf71b8f75e46a240edb14a6ce187e47d31b90)), closes [Lundalogik/crm-feature#4343](https://github.com/Lundalogik/crm-feature/issues/4343)
+
+## [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)
 
 

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

@@ -26,9 +26,9 @@ export type Notification<T = unknown> = {
      */
     createdTime: Date;
     /**
-     * ID of the user that created the notification
+     * ID and limetype of the user object that created the notification
      */
-    createdUser: number;
+    createdUser?: CreatedUser;
     /**
      * Limetype that the notification is attached to
      */
@@ -46,4 +46,11 @@ export type Notification<T = unknown> = {
  * @alpha
  */
 export type NotificationType = 'mention';
+/**
+ * @alpha
+ */
+export type CreatedUser = {
+    id: number;
+    limetype: string;
+};
 //# 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,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"}
+{"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,CAAC,EAAE,WAAW,CAAC;IAE1B;;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;AAEzC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC"}

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

@@ -15,7 +15,7 @@ export interface NotificationRepository {
      */
     loadAll(options?: NotificationLoadOptions): Promise<NotificationResponse>;
     /**
-     * Gets a loaded notification by its id
+     * Get a loaded notification by its id
      *
      * @param notificationId - the id of the notification to get
      * @returns the fetched notification
@@ -28,12 +28,13 @@ export interface NotificationRepository {
      */
     delete(notification: Notification): Promise<void>;
     /**
-     * Marks a notification as read
+     * Mark a notification as read or unread
      *
-     * @param notification - the notification to mark as read
+     * @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
      */
-    markAsRead(notification: Notification): Promise<Notification>;
+    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,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"}
+{"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.1",
+  "version": "5.34.1",
   "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",