@limetech/lime-web-components 5.31.0 → 5.33.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [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)
+
+
+### Features
+
+
+* **notifications:** add notification interfaces ([fde53f6](https://github.com/Lundalogik/lime-web-components/commit/fde53f68701853246d3327f94ee2f6c175d567a1))
+
 ## [5.31.0](https://github.com/Lundalogik/lime-web-components/compare/v5.30.0...v5.31.0) (2024-03-25)
 
 

package/dist/es5/index.js

@@ -26,3 +26,4 @@ tslib_1.__exportStar(require("./datetimeformatter"), exports);
 tslib_1.__exportStar(require("./conditionregistry"), exports);
 tslib_1.__exportStar(require("./view"), exports);
 tslib_1.__exportStar(require("./webcomponent"), exports);
+tslib_1.__exportStar(require("./notification-service"), exports);

package/dist/es5/notification-service/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./repository"), exports);
+tslib_1.__exportStar(require("./notification"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/dist/es5/notification-service/notification.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es5/notification-service/repository.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es5/notification-service/types.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var platform_1 = require("../core/platform");
+var SERVICE_NAME = 'state.notifications';
+platform_1.PlatformServiceName.NotificationRepository = SERVICE_NAME;

package/dist/index.d.ts

@@ -45,4 +45,5 @@ export * from './datetimeformatter';
 export * from './conditionregistry';
 export * from './view';
 export * from './webcomponent';
+export * from './notification-service';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -45,3 +45,4 @@ export * from './datetimeformatter';
 export * from './conditionregistry';
 export * from './view';
 export * from './webcomponent';
+export * from './notification-service';

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

@@ -0,0 +1,4 @@
+export * from './repository';
+export * from './notification';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notification-service/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC"}

package/dist/notification-service/index.js

@@ -0,0 +1,3 @@
+export * from './repository';
+export * from './notification';
+export * from './types';

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

@@ -0,0 +1,12 @@
+/**
+ * A Notification object
+ *
+ * @alpha
+ * @group NotificationRepository
+ */
+export type Notification = {
+    id: number;
+    iduser: number;
+    read: Boolean;
+};
+//# sourceMappingURL=notification.d.ts.map

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

@@ -0,0 +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"}

package/dist/notification-service/notification.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,76 @@
+import { Notification } from './notification';
+/**
+ * Service for handling notifications
+ *
+ * @alpha
+ * @group NotificationRepository
+ */
+export interface NotificationRepository {
+    /**
+     * Gets all notifications
+     *
+     * @param options - options to provide when loading notifications
+     *
+     * @returns the saved notifications
+     */
+    loadNotifications(options?: NotificationLoadOptions): Promise<NotificationResponse | undefined>;
+    /**
+     * Creates a notification
+     *
+     * @returns the created notification
+     */
+    createNotification(): Promise<Notification | undefined>;
+    /**
+     * Gets a notification by its id
+     *
+     * @param notificationId - the id of the notification to get
+     * @returns the fetched notification
+     */
+    getNotification(notificationId: number): Promise<Notification | undefined>;
+    /**
+     * Deletes a notification by its id
+     *
+     * @param notificationId - the id of the notification to delete
+     */
+    deleteNotification(notificationId: number): Promise<void>;
+    /**
+     * Marks a notification as read
+     *
+     * @param notificationId - the id of the notification to mark as read
+     * @returns the read notification
+     */
+    markNotificationAsRead(notificationId: number): Promise<Notification | undefined>;
+}
+/**
+ * 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
+     */
+    limit?: number;
+}
+//# sourceMappingURL=repository.d.ts.map

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

@@ -0,0 +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"}

package/dist/notification-service/repository.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,15 @@
+import { NotificationRepository } from './repository';
+declare const SERVICE_NAME = "state.notifications";
+declare module '../core/platform' {
+    interface PlatformServiceNameType {
+        /**
+         * @see {@link NotificationRepository}
+         */
+        NotificationRepository: typeof SERVICE_NAME;
+    }
+    interface LimeWebComponentPlatform {
+        get(name: PlatformServiceNameType['NotificationRepository']): NotificationRepository;
+    }
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/notification-service/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAGtD,QAAA,MAAM,YAAY,wBAAwB,CAAC;AAI3C,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,sBAAsB,EAAE,OAAO,YAAY,CAAC;KAC/C;IAED,UAAU,wBAAwB;QAC9B,GAAG,CACC,IAAI,EAAE,uBAAuB,CAAC,wBAAwB,CAAC,GACxD,sBAAsB,CAAC;KAC7B;CACJ"}

package/dist/notification-service/types.js

@@ -0,0 +1,3 @@
+import { PlatformServiceName } from '../core/platform';
+const SERVICE_NAME = 'state.notifications';
+PlatformServiceName.NotificationRepository = SERVICE_NAME;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.31.0",
+  "version": "5.33.0",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -32,14 +32,14 @@
   "dependencies": {
     "@stencil/core": "^2.22.3",
     "rxjs": "^7.8.1",
-    "tslib": "^2.6.2"
+    "tslib": "^2.6.3"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^19.1.0",
-    "@microsoft/api-extractor": "^7.43.0",
+    "@commitlint/config-conventional": "^19.4.1",
+    "@microsoft/api-extractor": "^7.47.7",
     "@types/jest": "^27.5.0",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
+    "@typescript-eslint/eslint-plugin": "^7.5.0",
+    "@typescript-eslint/parser": "^7.5.0",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.57.0",
@@ -48,12 +48,12 @@
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-sonarjs": "^0.24.0",
+    "eslint-plugin-sonarjs": "^0.25.1",
     "eslint-plugin-tsdoc": "^0.2.17",
     "jest": "^27.5.1",
     "jest-cli": "^27.5.1",
     "prettier": "^3.2.5",
-    "replace-in-file": "^7.1.0",
+    "replace-in-file": "^8.1.0",
     "shelljs": "0.8.5",
     "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "~3.15.0",