@linagora/linid-im-front-corelib 0.0.77 → 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';
@@ -38,7 +40,7 @@ export type { Page, Pagination, QTableRequestEvent, QuasarPagination, QueryFilte
 export type { AttributeInputType, LinidApiEndpointConfiguration, LinidAttributeConfiguration, LinidEntityConfiguration, } from './types/linidConfiguration';
 export type { FederatedModule, ModuleHostConfig, ModuleZoneDefinition, RemoteModule, } from './types/module';
 export type { ModuleLifecycleHooks, ModuleLifecycleResult, } from './types/moduleLifecycle';
-export type { LinidQAvatarProps, LinidQBadgeProps, LinidQBannerProps, LinidQBtnDropdownProps, LinidQBtnProps, LinidQCardActionsProps, LinidQCardProps, LinidQCheckboxProps, LinidQDateProps, LinidQDialogProps, LinidQFieldProps, LinidQFileProps, LinidQFormProps, LinidQHeaderProps, LinidQIconProps, LinidQChipProps, LinidQImgProps, LinidQInputProps, LinidQItemLabelProps, LinidQItemProps, LinidQItemSectionProps, LinidQLayoutProps, LinidQListProps, LinidQMenuProps, LinidQRouteTabProps, LinidQSelectProps, LinidQSeparatorProps, LinidQSpinnerProps, LinidQSplitterProps, LinidQTableProps, LinidQTabsProps, LinidQToggleProps, LinidQToolbarProps, LinidQToolbarTitleProps, LinidQTreeProps, UiDesign, UiDesignNamespace, UiDesignValue, } from './types/uiDesign';
+export type { LinidQAvatarProps, LinidQBadgeProps, LinidQBannerProps, LinidQBtnDropdownProps, LinidQBtnProps, LinidQCardActionsProps, LinidQCardProps, LinidQCheckboxProps, LinidQDateProps, LinidQDialogProps, LinidQFieldProps, LinidQFileProps, LinidQFormProps, LinidQHeaderProps, LinidQIconProps, LinidQChipProps, LinidQImgProps, LinidQInputProps, LinidQItemLabelProps, LinidQItemProps, LinidQItemSectionProps, LinidQLayoutProps, LinidQListProps, LinidQMenuProps, LinidQOptionGroupProps, LinidQRouteTabProps, LinidQSelectProps, LinidQSeparatorProps, LinidQSpinnerProps, LinidQSplitterProps, LinidQTableProps, LinidQTabsProps, LinidQToggleProps, LinidQToolbarProps, LinidQToolbarTitleProps, LinidQTreeProps, UiDesign, UiDesignNamespace, UiDesignValue, } from './types/uiDesign';
 export type { NavigationMenuItem } from './types/linidUi';
 export { ModuleLifecyclePhase } from './types/moduleLifecycle';
 export { BasicRemoteModule } from './lifecycle/skeleton';

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/dist/types/src/types/uiDesign.d.ts

@@ -1,4 +1,4 @@
-import type { NamedColor, QAvatarProps, QBadgeProps, QBannerProps, QBtnDropdownProps, QBtnProps, QCardActionsProps, QCardProps, QCheckboxProps, QChipProps, QDateProps, QDialogProps, QFieldProps, QFileProps, QFormProps, QHeaderProps, QIconProps, QImgProps, QInputProps, QItemLabelProps, QItemProps, QItemSectionProps, QLayoutProps, QListProps, QMenuProps, QRouteTabProps, QSelectProps, QSeparatorProps, QSpinnerProps, QSplitterProps, QTableProps, QTabsProps, QToggleProps, QToolbarProps, QToolbarTitleProps, QTreeProps, VueClassProp, VueStyleObjectProp, VueStyleProp } from 'quasar';
+import type { NamedColor, QAvatarProps, QBadgeProps, QBannerProps, QBtnDropdownProps, QBtnProps, QCardActionsProps, QCardProps, QCheckboxProps, QChipProps, QDateProps, QDialogProps, QFieldProps, QFileProps, QFormProps, QHeaderProps, QIconProps, QImgProps, QInputProps, QItemLabelProps, QItemProps, QItemSectionProps, QLayoutProps, QListProps, QMenuProps, QOptionGroup, QRouteTabProps, QSelectProps, QSeparatorProps, QSpinnerProps, QSplitterProps, QTableProps, QTabsProps, QToggleProps, QToolbarProps, QToolbarTitleProps, QTreeProps, VueClassProp, VueStyleObjectProp, VueStyleProp } from 'quasar';
 /**
  * Represents a single primitive value in the UI configuration.
  */
@@ -161,6 +161,7 @@ declare const Q_TREE_PROPS: readonly ["tickStrategy", "noSelectionUnset", "defau
  */
 declare const Q_SPLITTER_PROPS: readonly ["horizontal", "limits", "modelValue", "reverse", "unit", "disable", "beforeClass", "afterClass", "separatorClass", "separatorStyle", "dark"];
 declare const Q_SEPARATOR_PROPS: readonly ["spaced", "inset", "vertical", "dark", "size", "color"];
+declare const Q_OPTION_GROUP_PROPS: readonly ["keepColor", "type", "leftLabel", "inline", "size", "color", "dark", "dense"];
 /**
  * Maps Quasar component names to their respective props keys for UI design retrieval.
  */
@@ -305,12 +306,16 @@ export type LinidQSplitterProps = Pick<QSplitterProps, (typeof Q_SPLITTER_PROPS)
  * Subset of QSeparator props supported in UI design configuration.
  */
 export type LinidQSeparatorProps = Pick<QSeparatorProps, (typeof Q_SEPARATOR_PROPS)[number]>;
+/**
+ * Subset of QOptionGroup props supported in UI design configuration.
+ */
+export type LinidQOptionGroupProps = Pick<QOptionGroup, (typeof Q_OPTION_GROUP_PROPS)[number]>;
 /**
  * Union type of all supported Quasar component props subsets.
  */
-export type LinidQComponentProps = LinidQAvatarProps | LinidQBadgeProps | LinidQBannerProps | LinidQBtnDropdownProps | LinidQBtnProps | LinidQCardActionsProps | LinidQCardProps | LinidQCheckboxProps | LinidQDateProps | LinidQDialogProps | LinidQFieldProps | LinidQFileProps | LinidQFormProps | LinidQHeaderProps | LinidQIconProps | LinidQChipProps | LinidQImgProps | LinidQInputProps | LinidQItemLabelProps | LinidQItemProps | LinidQItemSectionProps | LinidQListProps | LinidQMenuProps | LinidQRouteTabProps | LinidQSelectProps | LinidQSeparatorProps | LinidQSpinnerProps | LinidQSplitterProps | LinidQTableProps | LinidQTabsProps | LinidQToggleProps | LinidQToolbarProps | LinidQToolbarTitleProps | LinidQTreeProps;
+export type LinidQComponentProps = LinidQAvatarProps | LinidQBadgeProps | LinidQBannerProps | LinidQBtnDropdownProps | LinidQBtnProps | LinidQCardActionsProps | LinidQCardProps | LinidQCheckboxProps | LinidQDateProps | LinidQDialogProps | LinidQFieldProps | LinidQFileProps | LinidQFormProps | LinidQHeaderProps | LinidQIconProps | LinidQChipProps | LinidQImgProps | LinidQInputProps | LinidQItemLabelProps | LinidQItemProps | LinidQItemSectionProps | LinidQListProps | LinidQMenuProps | LinidQOptionGroupProps | LinidQRouteTabProps | LinidQSelectProps | LinidQSeparatorProps | LinidQSpinnerProps | LinidQSplitterProps | LinidQTableProps | LinidQTabsProps | LinidQToggleProps | LinidQToolbarProps | LinidQToolbarTitleProps | LinidQTreeProps;
 /**
  * Valid Quasar component names for type-safe UI design retrieval.
  */
-export type QComponentName = 'q-avatar' | 'q-badge' | 'q-banner' | 'q-btn' | 'q-btn-dropdown' | 'q-card' | 'q-card-actions' | 'q-checkbox' | 'q-date' | 'q-dialog' | 'q-field' | 'q-file' | 'q-form' | 'q-header' | 'q-icon' | 'q-chip' | 'q-img' | 'q-input' | 'q-item' | 'q-item-label' | 'q-item-section' | 'q-layout' | 'q-list' | 'q-menu' | 'q-route-tab' | 'q-select' | 'q-separator' | 'q-spinner' | 'q-splitter' | 'q-table' | 'q-tabs' | 'q-toggle' | 'q-toolbar' | 'q-toolbar-title' | 'q-tree';
+export type QComponentName = 'q-avatar' | 'q-badge' | 'q-banner' | 'q-btn' | 'q-btn-dropdown' | 'q-card' | 'q-card-actions' | 'q-checkbox' | 'q-date' | 'q-dialog' | 'q-field' | 'q-file' | 'q-form' | 'q-header' | 'q-icon' | 'q-chip' | 'q-img' | 'q-input' | 'q-item' | 'q-item-label' | 'q-item-section' | 'q-layout' | 'q-list' | 'q-menu' | 'q-option-group' | 'q-route-tab' | 'q-select' | 'q-separator' | 'q-spinner' | 'q-splitter' | 'q-table' | 'q-tabs' | 'q-toggle' | 'q-toolbar' | 'q-toolbar-title' | 'q-tree';
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linagora/linid-im-front-corelib",
-  "version": "0.0.77",
+  "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": [