@limetech/lime-web-components 6.6.0 → 6.8.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [6.8.0](https://github.com/Lundalogik/lime-web-components/compare/v6.7.0...v6.8.0) (2026-01-28)
+
+
+### Features
+
+
+* **problem:** add problem provider interfaces ([a4d003f](https://github.com/Lundalogik/lime-web-components/commit/a4d003f3a8665185c7ec7a99458ebf671d541641))
+
+## [6.7.0](https://github.com/Lundalogik/lime-web-components/compare/v6.6.0...v6.7.0) (2026-01-14)
+
+
+### Features
+
+
+* **error:** register Stencil error handler ([cdd24d4](https://github.com/Lundalogik/lime-web-components/commit/cdd24d45ea411d9c1e135da24b174d0a9af79609))
+* **logger:** add package-aware logger factory ([ab45944](https://github.com/Lundalogik/lime-web-components/commit/ab459447747fc8751e4c56c262224c149b9c78c8))
+
 ## [6.6.0](https://github.com/Lundalogik/lime-web-components/compare/v6.5.0...v6.6.0) (2025-12-16)
 
 

package/dist/error/error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Global error handler for uncaught errors in Stencil components.
+ * Logs the error using the Lime platform's logging system.
+ *
+ * @remarks
+ * This function is registered as the global error handler for Stencil
+ * components to capture uncaught errors and log them appropriately.
+ *
+ * @param err - The uncaught error object
+ * @param element - The Stencil component element where the error occurred
+ *
+ * @internal
+ */
+export declare function errorHandler(err: unknown, element?: HTMLElement): void;
+//# sourceMappingURL=error.d.ts.map

package/dist/error/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/error/error.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,WAAW,QAkB/D"}

package/dist/error/error.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=error.spec.d.ts.map

package/dist/error/error.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.spec.d.ts","sourceRoot":"","sources":["../../src/error/error.spec.ts"],"names":[],"mappings":""}

package/dist/error/index.d.ts

@@ -0,0 +1,2 @@
+export * from './error';
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/eventdispatcher/eventdispatcher.d.ts

@@ -1,28 +1,94 @@
 /**
- * Service for handling application level events
+ * Service for application-wide event communication
+ *
+ * The {@link EventDispatcher} enables loosely-coupled communication between
+ * components through a publish-subscribe pattern.
+ *
+ * Components can dispatch custom events and subscribe to events from other
+ * components without direct coupling. This is particularly useful for:
+ * - Cross-component communication
+ * - Responding to platform-level events (navigation, data changes)
+ * - Notifying other components of state changes
+ *
+ * @example
+ * Basic usage
+ * ```typescript
+ * const eventDispatcher = platform.get(PlatformServiceName.EventDispatcher);
+ *
+ * // Dispatch an event
+ * eventDispatcher.dispatch('data-changed', { id: 123 });
+ *
+ * // Listen for events
+ * const handler = (event: CustomEvent<{ id: number }>) => {
+ *     console.log('Data changed:', event.detail.id);
+ * };
+ * eventDispatcher.addListener('data-changed', handler);
+ *
+ * // Clean up
+ * eventDispatcher.removeListener('data-changed', handler);
+ * ```
+ *
  * @public
  * @group Event dispatching
  */
 export interface EventDispatcher {
     /**
-     * Dispatch a new event
+     * Dispatch a custom event to all registered listeners
      *
-     * @param eventName - name of the event to dispatch
-     * @param data - data attached to the event
+     * Creates and dispatches a `CustomEvent` with the provided data. All components
+     * that have registered listeners for this event name will be notified.
+     *
+     * @param eventName - Unique name identifying the event type
+     * @param data - Data payload to include in the event's `detail` property
+     * @returns The `CustomEvent` that was dispatched
+     *
+     * @example
+     * ```typescript
+     * const eventDispatcher = platform.get(PlatformServiceName.EventDispatcher);
+     * eventDispatcher.dispatch('item-selected', { itemId: 42, name: 'Widget' });
+     * ```
      */
     dispatch<T>(eventName: string, data: T): CustomEvent<T>;
     /**
-     * Add a new listener for a specific event
+     * Register a listener for a specific event type
+     *
+     * The listener function will be called whenever an event with the matching
+     * name is dispatched. The same listener can be registered multiple times,
+     * but should typically be registered only once per component instance.
+     *
+     * **Important:** Always remove listeners in `disconnectedCallback()` to
+     * prevent memory leaks.
      *
-     * @param eventName - name of the event to listen to
-     * @param listener - listener to invoke when the event is dispatched
+     * @param eventName - Name of the event to listen for
+     * @param listener - Callback function to invoke when the event is dispatched
+     *
+     * @example
+     * ```typescript
+     * eventDispatcher.addListener('message-received', (event) => {
+     *     console.log('Message:', event.detail);
+     * });
+     * ```
      */
     addListener<T>(eventName: string, listener: (event: CustomEvent<T>) => void): void;
     /**
-     * Stop listening for a specific event
+     * Unregister a previously registered event listener
+     *
+     * Removes the specified listener function for the given event name. The
+     * listener reference must be the same function instance that was passed
+     * to {@link addListener}.
+     *
+     * Always call this in `disconnectedCallback()` to clean up listeners and
+     * prevent memory leaks.
+     *
+     * @param eventName - Name of the event to stop listening for
+     * @param listener - The exact listener function that was previously registered
      *
-     * @param eventName - name of the event to stop listening to
-     * @param listener - listener to remove from the dispatcher
+     * @example
+     * ```typescript
+     * const handler = (event: CustomEvent<string>) => console.log(event.detail);
+     * eventDispatcher.addListener('message-received', handler);
+     * eventDispatcher.removeListener('message-received', handler);
+     * ```
      */
     removeListener<T>(eventName: string, listener: (event: CustomEvent<T>) => void): void;
 }

package/dist/eventdispatcher/eventdispatcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventdispatcher.d.ts","sourceRoot":"","sources":["../../src/eventdispatcher/eventdispatcher.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAExD;;;;;OAKG;IACH,WAAW,CAAC,CAAC,EACT,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAC1C,IAAI,CAAC;IAER;;;;;OAKG;IACH,cAAc,CAAC,CAAC,EACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAC1C,IAAI,CAAC;CACX"}
+{"version":3,"file":"eventdispatcher.d.ts","sourceRoot":"","sources":["../../src/eventdispatcher/eventdispatcher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,CAAC,EACT,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAC1C,IAAI,CAAC;IAER;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,CAAC,EACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAC1C,IAAI,CAAC;CACX"}

package/dist/filter/decorator.d.ts

@@ -9,10 +9,28 @@ export interface SelectFiltersOptions extends StateOptions {
     limetype?: string;
 }
 /**
- * Gets a list of filters
+ * Decorator that subscribes to filters from the {@link FilterRepository}.
+ *
+ * This decorator automatically updates the decorated property whenever filters
+ * change in the platform. You can optionally filter by limetype or filter ID.
+ *
+ * @param options - Configuration including limetype/ID filtering and state transformation via {@link SelectFiltersOptions}
+ * @returns A PropertyDecorator that sets up automatic subscription to filters
+ *
+ * @example
+ * ```typescript
+ * @State()
+ * @SelectFilters()
+ * private filters: Filter[];
+ * ```
+ *
+ * @example
+ * ```typescript
+ * @State()
+ * @SelectFilters({ limetype: 'company' })
+ * private companyFilters: Filter[];
+ * ```
  *
- * @param options - state decorator options
- * @returns state decorator
  * @public
  * @group Filters
  */

package/dist/filter/decorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/filter/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACtD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CACzB,OAAO,GAAE,oBAAyB,GACnC,iBAAiB,CAMnB"}
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../src/filter/decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,YAAY,EAEf,MAAM,SAAS,CAAC;AAGjB;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACtD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,aAAa,CACzB,OAAO,GAAE,oBAAyB,GACnC,iBAAiB,CAMnB"}

package/dist/filter/repository.d.ts

@@ -1,22 +1,100 @@
 import { Filter } from '../query';
 import { StateRepository } from '../core';
 /**
+ * Repository for managing saved filter definitions.
+ *
+ * {@link FilterRepository} provides methods to create, update, and delete {@link Filter}
+ * definitions. Filters are named, reusable query expressions that can be applied to
+ * limetypes to define subsets of objects (e.g., "My Active Deals", "High Priority Tickets").
+ *
+ * Filters can be:
+ * - System-wide (available to all users)
+ * - User-specific (private to a single user when `iduser` is set)
+ * - Referenced in {@link InFilterExpression}s for advanced queries
+ *
+ * The repository extends {@link StateRepository}, enabling:
+ * - Reactive subscriptions to filter changes
+ * - Automatic UI updates when filters are created or deleted
+ * - Integration with state decorators
+ *
+ * @example
+ * Basic usage
+ * ```typescript
+ * const repo = platform.get(PlatformServiceName.FilterRepository);
+ *
+ * const filter: Filter = {
+ *     id: 'high_value_deals',
+ *     limetype: 'deal',
+ *     name: { 'en': 'High Value Deals' },
+ *     filter: {
+ *         op: Operator.AND,
+ *         exp: [
+ *             { key: 'status', op: Operator.EQUALS, exp: 'active' },
+ *             { key: 'value', op: Operator.GREATER_OR_EQUAL, exp: 100000 }
+ *         ]
+ *     }
+ * };
+ *
+ * await repo.save(filter);
+ * ```
+ *
  * @public
  * @group Filters
+ * @see {@link Filter} for filter definition structure
+ * @see {@link Expression} for building filter expressions
+ * @see {@link InFilterExpression} for referencing filters in queries
+ * @see {@link StateRepository} for subscription patterns
  */
 export interface FilterRepository extends StateRepository {
     /**
-     * Saves the new filter to the database
+     * Save a filter definition to the database.
      *
-     * @param filter - a filter to save
-     * @returns a promise that will be resolved when the filter is saved
+     * Creates a new filter or updates an existing one. The filter will be stored
+     * persistently and become available for use in queries and filter expressions.
+     *
+     * If a filter with the same `id` already exists, it will be updated with the
+     * new values. Otherwise, a new filter is created.
+     *
+     * @param filter - The {@link Filter} definition to save
+     * @returns Promise that resolves when the filter is saved
+     * @throws Error if save fails due to validation or permission issues
+     *
+     * @example
+     * ```typescript
+     * const repo = platform.get(PlatformServiceName.FilterRepository);
+     *
+     * const filter: Filter = {
+     *     id: 'my_deals',
+     *     limetype: 'deal',
+     *     name: { 'en': 'My Deals' },
+     *     filter: { key: 'owner', op: Operator.EQUALS, exp: currentUserId }
+     * };
+     *
+     * await repo.save(filter);
+     * ```
+     *
+     * @see {@link Filter} for the filter structure
+     * @see {@link Expression} for building filter expressions
+     * @see {@link delete} to remove a filter
      */
     save(filter: Filter): Promise<void>;
     /**
-     * Deletes the filter
+     * Delete a filter from the database.
+     *
+     * Permanently removes the specified filter. This operation cannot be undone.
+     *
+     * @param filter - The {@link Filter} to delete
+     * @returns Promise that resolves when the filter is deleted
+     * @throws Error if deletion fails due to permissions or other issues
+     *
+     * @example
+     * ```typescript
+     * const repo = platform.get(PlatformServiceName.FilterRepository);
+     * await repo.delete(filter);
+     * ```
      *
-     * @param filter - a filter to delete
-     * @returns a promise that will be resolved when the filter is deleted
+     * @see {@link Filter} for the filter structure
+     * @see {@link save} to create or update a filter
      */
     delete(filter: Filter): Promise<void>;
 }

package/dist/filter/repository.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/filter/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC"}
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/filter/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC"}