@linagora/linid-im-front-corelib 0.0.70 → 0.0.72

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

@@ -0,0 +1,60 @@
+import { type LinidFilterType } from '../types/linidFilter';
+import { LinidFilterValue } from './linidFilterValue';
+/**
+ * Represents a filter that can be applied to a list of entities.
+ * The generic parameter `T` allows consumers to define their own options structure
+ * for maximum flexibility.
+ * @template T - The type of options, defaults to Record<string, unknown>.
+ */
+export declare class LinidFilter<T = Record<string, unknown>> {
+    /**
+     *  Auto generated unique identifier of the filter.
+     */
+    id: string;
+    /**
+     * Identifier of the filter.
+     */
+    name: string;
+    /**
+     * Defines the filter category and expected behavior.
+     */
+    type: LinidFilterType;
+    /**
+     * Configuration object of the filter, defined by the consumer.
+     */
+    options: T;
+    /**
+     * List of applied filter values.
+     */
+    values: LinidFilterValue[];
+    /**
+     * Create a new filter.
+     * @param name - Identifier of the filter.
+     * @param type - Defines the filter category and expected behavior.
+     * @param options - Configuration object of the filter, defined by the consumer.
+     * @param values - List of applied filter values.
+     */
+    constructor(name: string, type: LinidFilterType, options: T, values: LinidFilterValue[]);
+    /**
+     * Parses a value expression (e.g. `paris|not_lk_lyon`, as produced by
+     * {@link LinidFilterValue.toString}) into a new {@link LinidFilter} instance. `input` is the
+     * bare value expression only — it never carries the `name=` query parameter prefix produced
+     * by {@link LinidFilter.toString}.
+     *
+     * `type` and `options` are not derivable from `input`, so the returned filter gets a
+     * placeholder `'text'` `type` and empty `options`; `id` is auto generated by the constructor,
+     * as for any `LinidFilter` instance. Callers that already track a `LinidFilter` definition
+     * should only use the parsed `values`.
+     * @param name - Identifier of the filter.
+     * @param input - The value expression, with values separated by `|`.
+     * @returns The parsed filter instance.
+     * @template T - The type of options, defaults to Record<string, unknown>.
+     */
+    static fromString<T = Record<string, unknown>>(name: string, input: string): LinidFilter<T>;
+    /**
+     * Reconstructs the filter as an HTTP query parameter pair (`name=value`), ready to use with
+     * APIs powered by `spring-query-filter`.
+     * @returns The query parameter string representation of the filter, e.g. `city=paris|not_lk_lyon`.
+     */
+    toString(): string;
+}

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

@@ -0,0 +1,38 @@
+import { type LinidFilterOperator } from '../types/linidFilter';
+/**
+ * Represents a single applied value of a `LinidFilter`, converted to a string expression
+ * combining an optional negation, a comparison operator and a raw value
+ * (e.g. `not_lk_paris`, `gt_18`, `paris`).
+ */
+export declare class LinidFilterValue {
+    /**
+     * Whether the comparison must be negated.
+     */
+    isNegation: boolean;
+    /**
+     * The comparison operator applied to the value.
+     */
+    operator: LinidFilterOperator;
+    /**
+     * The raw filter value, with the negation marker and operator prefix stripped.
+     */
+    value: string;
+    /**
+     * Creates a new filter value.
+     * @param isNegation - Whether the comparison must be negated.
+     * @param operator - The comparison operator applied to the value.
+     * @param value - The raw filter value.
+     */
+    constructor(isNegation: boolean, operator: LinidFilterOperator, value: string);
+    /**
+     * Parses a filter value expression (e.g. `not_lk_paris`) into a {@link LinidFilterValue}.
+     * @param input - The filter value expression to parse.
+     * @returns The parsed filter value.
+     */
+    static fromString(input: string): LinidFilterValue;
+    /**
+     * Reconstructs the filter value expression from its negation, operator and value.
+     * @returns The filter value expression (e.g. `not_lk_paris`).
+     */
+    toString(): string;
+}

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

@@ -27,13 +27,16 @@ export { deepEqual, deepEqualUnordered, fromDot, isObject, merge, renameKeys, }
 export { getPiniaStore, setPiniaStore } from './services/piniaStoreService';
 export { getUiDesign, setUiDesign } from './services/uiDesignService';
 export { uiEventSubject } from './services/uiEventService';
+export { LinidFilter } from './filters/linidFilter';
+export { LinidFilterValue } from './filters/linidFilterValue';
+export { LINID_FILTER_NEGATION_PREFIX, LINID_FILTER_OR_SEPARATOR, } from './types/linidFilter';
 export type { LinidZoneEntry } from './types/linidZone';
 export type { LinidRoute, LinidRoutes } from './types/linidRoute';
 export type { Page, Pagination, QTableRequestEvent, QuasarPagination, QueryFilter, } from './types/page';
 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, LinidQDateProps, LinidQDialogProps, LinidQFileProps, LinidQFormProps, LinidQHeaderProps, LinidQIconProps, LinidQImgProps, LinidQInputProps, LinidQItemLabelProps, LinidQItemProps, LinidQItemSectionProps, LinidQLayoutProps, LinidQListProps, LinidQMenuProps, LinidQRouteTabProps, LinidQSelectProps, 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, LinidQFileProps, LinidQFormProps, LinidQHeaderProps, LinidQIconProps, LinidQImgProps, LinidQInputProps, LinidQItemLabelProps, LinidQItemProps, LinidQItemSectionProps, LinidQLayoutProps, LinidQListProps, LinidQMenuProps, LinidQRouteTabProps, LinidQSelectProps, 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';
@@ -44,3 +47,4 @@ export type { DialogEvent } from './types/dialogType';
 export type { LinidUser } from './types/linidUser';
 export type { TreeNode, TreeNodeType } from './types/linidTree';
 export type { DropdownClickPayload, MenuItem } from './types/dropdownButton';
+export type { LinidFilterOperator, LinidFilterType } from './types/linidFilter';

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

@@ -0,0 +1,20 @@
+/**
+ * Separator used between OR'd value expressions in a filter's string representation.
+ */
+export declare const LINID_FILTER_OR_SEPARATOR = "|";
+/**
+ * Prefix used to mark a filter value as negated.
+ */
+export declare const LINID_FILTER_NEGATION_PREFIX = "not_";
+/**
+ * Supported filter categories. Defines the filter behavior and the UI input used to edit it.
+ */
+export type LinidFilterType = 'date' | 'text' | 'number' | 'list' | 'tree';
+/**
+ * Supported comparison operators for a filter value.
+ * - `lk_` matches a "like / contains" comparison.
+ * - `` (empty string) matches a strict equality comparison.
+ * - `gt_` matches a "greater than" comparison.
+ * - `lt_` matches a "lower than" comparison.
+ */
+export type LinidFilterOperator = 'lk_' | '' | 'gt_' | 'lt_';

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

@@ -1,4 +1,4 @@
-import type { NamedColor, QAvatarProps, QBadgeProps, QBannerProps, QBtnDropdownProps, QBtnProps, QCardActionsProps, QCardProps, QDateProps, QDialogProps, QFileProps, QFormProps, QHeaderProps, QIconProps, QImgProps, QInputProps, QItemLabelProps, QItemProps, QItemSectionProps, QLayoutProps, QListProps, QMenuProps, QRouteTabProps, QSelectProps, QSpinnerProps, QSplitterProps, QTableProps, QTabsProps, QToggleProps, QToolbarProps, QToolbarTitleProps, QTreeProps, VueClassProp, VueStyleObjectProp, VueStyleProp } from 'quasar';
+import type { NamedColor, QAvatarProps, QBadgeProps, QBannerProps, QBtnDropdownProps, QBtnProps, QCardActionsProps, QCardProps, QCheckboxProps, QDateProps, QDialogProps, QFileProps, QFormProps, QHeaderProps, QIconProps, QImgProps, QInputProps, QItemLabelProps, QItemProps, QItemSectionProps, QLayoutProps, QListProps, QMenuProps, QRouteTabProps, QSelectProps, QSpinnerProps, QSplitterProps, QTableProps, QTabsProps, QToggleProps, QToolbarProps, QToolbarTitleProps, QTreeProps, VueClassProp, VueStyleObjectProp, VueStyleProp } from 'quasar';
 /**
  * Represents a single primitive value in the UI configuration.
  */
@@ -76,6 +76,10 @@ declare const Q_ICON_PROPS: readonly ["left", "right", "name", "size", "color"];
  * List of QToggleProps keys for type-safe UI design retrieval.
  */
 declare const Q_TOGGLE_PROPS: readonly ["toggleOrder", "toggleIndeterminate", "keepColor", "icon", "checkedIcon", "uncheckedIcon", "indeterminateIcon", "leftLabel", "size", "color", "dark", "dense", "iconColor"];
+/**
+ * List of QToggleProps keys for type-safe UI design retrieval.
+ */
+declare const Q_CHECKBOX_PROPS: readonly ["toggleOrder", "toggleIndeterminate", "keepColor", "checkedIcon", "uncheckedIcon", "indeterminateIcon", "size", "color", "dark", "dense"];
 /**
  * List of QInputProps keys for type-safe UI design retrieval.
  */
@@ -196,6 +200,10 @@ export type LinidQCardProps = Pick<QCardProps, (typeof Q_CARD_PROPS)[number]>;
  * Subset of QCardActions props supported in UI design configuration.
  */
 export type LinidQCardActionsProps = Pick<QCardActionsProps, (typeof Q_CARD_ACTIONS_PROPS)[number]>;
+/**
+ * Subset of QCheckboxProps props supported in UI design configuration.
+ */
+export type LinidQCheckboxProps = Pick<QCheckboxProps, (typeof Q_CHECKBOX_PROPS)[number]>;
 /**
  * Subset of QIcon props supported in UI design configuration.
  */
@@ -279,9 +287,9 @@ export type LinidQSplitterProps = Pick<QSplitterProps, (typeof Q_SPLITTER_PROPS)
 /**
  * Union type of all supported Quasar component props subsets.
  */
-export type LinidQComponentProps = LinidQAvatarProps | LinidQBadgeProps | LinidQBannerProps | LinidQBtnDropdownProps | LinidQBtnProps | LinidQCardActionsProps | LinidQCardProps | LinidQDateProps | LinidQDialogProps | LinidQFileProps | LinidQFormProps | LinidQHeaderProps | LinidQIconProps | LinidQImgProps | LinidQInputProps | LinidQItemLabelProps | LinidQItemProps | LinidQItemSectionProps | LinidQListProps | LinidQMenuProps | LinidQRouteTabProps | LinidQSelectProps | LinidQSpinnerProps | LinidQTableProps | LinidQTabsProps | LinidQToggleProps | LinidQToolbarProps | LinidQToolbarTitleProps | LinidQTreeProps;
+export type LinidQComponentProps = LinidQAvatarProps | LinidQBadgeProps | LinidQBannerProps | LinidQBtnDropdownProps | LinidQBtnProps | LinidQCardActionsProps | LinidQCardProps | LinidQCheckboxProps | LinidQDateProps | LinidQDialogProps | LinidQFileProps | LinidQFormProps | LinidQHeaderProps | LinidQIconProps | LinidQImgProps | LinidQInputProps | LinidQItemLabelProps | LinidQItemProps | LinidQItemSectionProps | LinidQListProps | LinidQMenuProps | LinidQRouteTabProps | LinidQSelectProps | 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-date' | 'q-dialog' | 'q-file' | 'q-form' | 'q-header' | 'q-icon' | 'q-img' | 'q-input' | 'q-item' | 'q-item-label' | 'q-item-section' | 'q-layout' | 'q-list' | 'q-menu' | 'q-route-tab' | 'q-select' | 'q-spinner' | 'q-table' | 'q-tabs' | 'q-toggle' | 'q-toolbar' | 'q-toolbar-title' | 'q-tree' | 'q-splitter';
+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-file' | 'q-form' | 'q-header' | 'q-icon' | 'q-img' | 'q-input' | 'q-item' | 'q-item-label' | 'q-item-section' | 'q-layout' | 'q-list' | 'q-menu' | 'q-route-tab' | 'q-select' | 'q-spinner' | 'q-table' | 'q-tabs' | 'q-toggle' | 'q-toolbar' | 'q-toolbar-title' | 'q-tree' | 'q-splitter';
 export {};

package/package.json

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