@linagora/linid-im-front-corelib 0.0.78 → 0.0.79

package/dist/types/src/composables/useLinidUserPreference.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Composable to manage user preferences lifecycle and synchronization
+ * between backend API and local Pinia store.
+ * @returns Composable exposing methods to interact with user preferences and the underlying store.
+ */
+export declare function useLinidUserPreference(): {
+    init: () => Promise<void>;
+    saveUserPreference: (key: string, value: string) => Promise<void>;
+    deleteUserPreference: (key: string) => Promise<void>;
+    userPreferenceStore: import("pinia").Store<"LinidUserPreferenceStore", import("../stores/linidUserPreferenceStore").LinidUserPreferenceState, {}, {
+        setUserPreferences(values: Record<string, string>): void;
+        setUserPreference(key: string, value: string): void;
+        removeUserPreference(key: string): void;
+    }>;
+};

package/dist/types/src/filters/linidFilterSet.d.ts

@@ -8,6 +8,10 @@ import { LinidFilter } from './linidFilter';
  * [`spring-query-filter`](https://github.com/Zorin95670/spring-query-filter).
  */
 export declare class LinidFilterSet {
+    /**
+     * Unique identifier of the filter set.
+     */
+    id: string;
     /**
      * User-friendly name of the favorite search (e.g. "My Active Projects").
      */
@@ -18,10 +22,11 @@ export declare class LinidFilterSet {
     filters: LinidFilter[];
     /**
      * Creates a new filter set.
+     * @param id - Unique identifier of the filter set.
      * @param label - User-friendly name of the favorite search.
      * @param filters - Collection of filters composing the favorite search.
      */
-    constructor(label: string, filters: LinidFilter[]);
+    constructor(id: string, label: string, filters: LinidFilter[]);
     /**
      * Parses a string representation of a filter set, as produced by {@link LinidFilterSet.toString},
      * into a new {@link LinidFilterSet} instance.
@@ -35,11 +40,12 @@ export declare class LinidFilterSet {
      * `value` tolerates `null`/`undefined`/any non-string at runtime (e.g. `localStorage.getItem(...)`,
      * or across a Module Federation boundary): like an empty string, it produces an empty `filters`
      * array instead of throwing.
+     * @param id - Unique identifier of the filter set.
      * @param label - User-friendly name of the favorite search.
      * @param value - The `&`-separated string of `name=value` pairs, as produced by `toString()`.
      * @returns The parsed filter set.
      */
-    static fromString(label: string, value: string | null | undefined): LinidFilterSet;
+    static fromString(id: string, label: string, value: string | null | undefined): LinidFilterSet;
     /**
      * Reconstructs the filter set as a `&`-separated string of `name=value` pairs, one per filter,
      * ready to use with APIs powered by `spring-query-filter` or to store in user preferences.

package/dist/types/src/index.d.ts

@@ -12,10 +12,12 @@ export { useScopedI18n } from './composables/useScopedI18n';
 export { useTree } from './composables/useTree';
 export { useUiDesign } from './composables/useUiDesign';
 export { useLinidFilterUrl } from './composables/useLinidFilterUrl';
+export { useLinidUserPreference } from './composables/useLinidUserPreference';
 export { useLinidConfigurationStore } from './stores/linidConfigurationStore';
 export { useLinidUiStore } from './stores/linidUiStore';
 export { useLinidUserStore } from './stores/linidUserStore';
 export { useLinidZoneStore } from './stores/linidZoneStore';
+export { useLinidUserPreferenceStore } from './stores/linidUserPreferenceStore';
 export { getDayjsInstance, setDayjsInstance } from './services/dayjsService';
 export { getModuleFederation, loadAsyncComponent, setModuleFederation, } from './services/federationService';
 export { getHttpClient, setHttpClient } from './services/httpClientService';

package/dist/types/src/stores/linidUserPreferenceStore.d.ts

@@ -0,0 +1,29 @@
+/**
+ * State interface for the Linid User Preference Store.
+ */
+export interface LinidUserPreferenceState {
+    /** Collection of user preferences indexed by key. */
+    userPreferences: Record<string, string>;
+}
+/**
+ * Returns the Linid User Preference Store instance.
+ * @returns The Linid User Preference Store instance.
+ */
+export declare const useLinidUserPreferenceStore: () => import("pinia").Store<"LinidUserPreferenceStore", LinidUserPreferenceState, {}, {
+    /**
+     * Replaces all user preferences with the provided collection.
+     * @param values The complete set of user preferences.
+     */
+    setUserPreferences(values: Record<string, string>): void;
+    /**
+     * Creates or updates a user preference.
+     * @param key The user preference key.
+     * @param value The user preference value.
+     */
+    setUserPreference(key: string, value: string): void;
+    /**
+     * Removes a user preference by its key.
+     * @param key The user preference key to remove.
+     */
+    removeUserPreference(key: string): void;
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linagora/linid-im-front-corelib",
-  "version": "0.0.78",
+  "version": "0.0.79",
   "description": "Core library of the LinID Identity Manager project. Provides shared types, services, components, and utilities for front-end and plugin, enabling consistent integration across the LinID ecosystem.",
   "type": "module",
   "files": [