@limetech/lime-web-components 5.38.1 → 5.39.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [5.39.0](https://github.com/Lundalogik/lime-web-components/compare/v5.38.1...v5.39.0) (2024-11-21)
+
+
+### Features
+
+
+* **core:** add event that dispatches current idle status of the user ([c625b0f](https://github.com/Lundalogik/lime-web-components/commit/c625b0f7d5349f97577cfbec77f4fe27f92814f3)), closes [Lundalogik/crm-feature#4482](https://github.com/Lundalogik/crm-feature/issues/4482)
+* **poller:** add poller and poller factory ([7a59130](https://github.com/Lundalogik/lime-web-components/commit/7a59130906a3de4c2a7dda58ffd0f6b16fabffc8)), closes [Lundalogik/crm-feature#4482](https://github.com/Lundalogik/crm-feature/issues/4482)
+
 ## [5.38.1](https://github.com/Lundalogik/lime-web-components/compare/v5.38.0...v5.38.1) (2024-10-28)
 
 

package/dist/core/idle.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The user's idle state. When set to `active` the user is actively using the
+ * application. When set to `idle`, the user has either minimized the
+ * application or not used it actively for a while.
+ * @beta
+ * @group Core
+ */
+export type IdleState = 'active' | 'idle';
+/**
+ * The event emitted by {@link EventDispatcher} when the user's idle state
+ * changes
+ * @beta
+ * @group Core
+ */
+export type IdleStateChangeEvent = CustomEvent<{
+    state: IdleState;
+}>;
+/**
+ * Name of the event emitted by {@link EventDispatcher} when the user's idle
+ * state changes
+ * @beta
+ * @group Core
+ */
+export declare const IdleStateEventName: "idle-state";
+//# sourceMappingURL=idle.d.ts.map

package/dist/core/idle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idle.d.ts","sourceRoot":"","sources":["../../src/core/idle.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,CAAC;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAErE;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,cAAwB,CAAC"}

package/dist/core/idle.js

@@ -0,0 +1,7 @@
+/**
+ * Name of the event emitted by {@link EventDispatcher} when the user's idle
+ * state changes
+ * @beta
+ * @group Core
+ */
+export const IdleStateEventName = 'idle-state';

package/dist/core/index.d.ts

@@ -5,4 +5,5 @@ export * from './plugin-loader';
 export * from './state';
 export * from './decorators';
 export * from './metadata';
+export * from './idle';
 //# sourceMappingURL=index.d.ts.map

package/dist/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC"}

package/dist/core/index.js

@@ -5,3 +5,4 @@ export * from './plugin-loader';
 export * from './state';
 export * from './decorators';
 export * from './metadata';
+export * from './idle';

package/dist/es5/core/idle.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdleStateEventName = void 0;
+exports.IdleStateEventName = 'idle-state';

package/dist/es5/core/index.js

@@ -8,3 +8,4 @@ tslib_1.__exportStar(require("./plugin-loader"), exports);
 tslib_1.__exportStar(require("./state"), exports);
 tslib_1.__exportStar(require("./decorators"), exports);
 tslib_1.__exportStar(require("./metadata"), exports);
+tslib_1.__exportStar(require("./idle"), exports);

package/dist/es5/index.js

@@ -27,3 +27,4 @@ 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);
+tslib_1.__exportStar(require("./poller"), exports);

package/dist/es5/poller/factory.js

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

package/dist/es5/poller/index.js

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

package/dist/es5/poller/poller.js

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

package/dist/es5/poller/types.js

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

package/dist/index.d.ts

@@ -46,4 +46,5 @@ export * from './conditionregistry';
 export * from './view';
 export * from './webcomponent';
 export * from './notification-service';
+export * from './poller';
 //# 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;AAC/B,cAAc,wBAAwB,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;AACvC,cAAc,UAAU,CAAC"}

package/dist/index.js

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

package/dist/poller/factory.d.ts

@@ -0,0 +1,49 @@
+import { IdleState } from '../core';
+import { Poller } from './poller';
+/**
+ * Factory for creating pollers.
+ *
+ * @example
+ * ```typescript
+ * const poller = factory.create(
+ *     async () => fetchDataFromAPI(),
+ *     60000 // Polling every 1 minute
+ * );
+ *
+ * const unsubscribe = poller.subscribe((data) => {
+ *     console.log('Received data:', data);
+ * });
+ *
+ * unsubscribe();
+ * ```
+ * @beta
+ * @group Poller
+ */
+export interface PollerFactory {
+    /**
+     * Creates a generic poller
+     *
+     * @param callback - An asynchronous function that will be executed
+     * periodically by the poller.
+     * @param intervalMs - The interval, in milliseconds, at which the callback
+     * should be executed.
+     * @returns the poller
+     */
+    create<T>(callback: () => Promise<T>, intervalMs: number): Poller<T>;
+    /**
+     * Creates a poller that executes its callback based on the users idle
+     * status
+     *
+     * @param callback - An asynchronous function that will be executed
+     * periodically by the poller based on the users idle status.
+     * @param intervalMs - The interval, in milliseconds, at which the callback
+     * should be executed.
+     * @param idleState - The idle state when the poller is active. When set to
+     * `active`, the poller will only execute while the user is actively using
+     * the application. When set to `idle`, the poller will only execute while
+     * the user is idle. Default value is `active`.
+     * @returns the poller
+     */
+    createIdlePoller<T>(callback: () => Promise<T>, intervalMs: number, idleState?: IdleState): Poller<T>;
+}
+//# sourceMappingURL=factory.d.ts.map

package/dist/poller/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/poller/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAErE;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,CAAC,EACd,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC1B,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,SAAS,GACtB,MAAM,CAAC,CAAC,CAAC,CAAC;CAChB"}

package/dist/poller/factory.js

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

package/dist/poller/index.d.ts

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

package/dist/poller/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/poller/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/poller/index.js

@@ -0,0 +1,3 @@
+export * from './factory';
+export * from './poller';
+export * from './types';

package/dist/poller/poller.d.ts

@@ -0,0 +1,49 @@
+/**
+ * A generic interface for a poller that periodically executes a callback and
+ * notifies subscribers of the result. The poller manages its lifecycle
+ * automatically, ensuring that polling starts when the first subscriber
+ * registers and stops when the last subscriber unsubscribes.
+ *
+ * The poller caches the most recent value from the callback and immediately
+ * delivers it to any new subscriber without waiting for the next polling
+ * cycle. This ensures that subscribers always receive the latest available
+ * data as soon as they register.
+ *
+ * Consumers are only concerned with subscribing to updates. The poller
+ * implementation handles polling intervals, error management, and subscriber
+ * lifecycle internally, making it simple and reliable for end users.
+ *
+ * @example
+ * ```typescript
+ * // Add a subscriber
+ * const unsubscribe = poller.subscribe((result) => {
+ *     console.log('Received data:', result);
+ * });
+ *
+ * // Remove the subscriber
+ * unsubscribe();
+ * ```
+ * @beta
+ * @group Poller
+ */
+export interface Poller<T> {
+    /**
+     * Subscribes a callback to receive updates from the poller.
+     *
+     * When the first subscriber registers, the poller automatically starts
+     * polling. Any new subscriber immediately receives the latest cached value,
+     * and all subscribers are notified of subsequent polling results.
+     *
+     * @param callback - A function that will be called with the latest value
+     * from the poller callback. If no value is available, the callback will
+     * receive `undefined`.
+     * @returns A function to unsubscribe from the poller.
+     */
+    subscribe(callback: (value?: T) => void): () => void;
+    /**
+     * Immediately forces the poller to trigger its callback and reset the
+     * internal timer
+     */
+    trigger(): void;
+}
+//# sourceMappingURL=poller.d.ts.map

package/dist/poller/poller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poller.d.ts","sourceRoot":"","sources":["../../src/poller/poller.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAErD;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;CACnB"}

package/dist/poller/poller.js

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

package/dist/poller/types.d.ts

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

package/dist/poller/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/poller/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,IAAI,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAGlE,QAAA,MAAM,YAAY,kBAAkB,CAAC;AAIrC,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,uBAAuB;QAC7B;;WAEG;QACH,aAAa,EAAE,OAAO,YAAY,CAAC;KACtC;IAED,UAAU,wBAAwB;QAC9B,GAAG,CACC,IAAI,EAAE,uBAAuB,CAAC,eAAe,CAAC,GAC/C,oBAAoB,CAAC;KAC3B;CACJ"}

package/dist/poller/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-web-components",
-  "version": "5.38.1",
+  "version": "5.39.0",
   "description": "Lime Web Components",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -30,10 +30,10 @@
   "dependencies": {
     "@stencil/core": "^2.22.3",
     "rxjs": "^7.8.1",
-    "tslib": "^2.8.0"
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^19.5.0",
+    "@commitlint/config-conventional": "^19.6.0",
     "@microsoft/api-extractor": "^7.47.11",
     "@types/jest": "^27.5.0",
     "@typescript-eslint/eslint-plugin": "^7.5.0",