@linagora/linid-im-front-corelib 0.0.71 → 0.0.73

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

@@ -0,0 +1,13 @@
+import type { RouteLocationNormalizedLoaded, Router } from 'vue-router';
+import { LinidFilter } from '../filters/linidFilter';
+/**
+ * Composable that synchronizes a list of LinID filters with the query
+ * params of the current URL.
+ * @param router - Vue router instance, used to update the URL.
+ * @param route - Current normalized route, used to read query params.
+ * @returns An object exposing `setFiltersInUrl` and `getFiltersFromUrl`.
+ */
+export declare function useLinidFilterUrl(router: Router, route: RouteLocationNormalizedLoaded): {
+    setFiltersInUrl: (filters: LinidFilter[], keeps: string[]) => void;
+    getFiltersFromUrl: (filters: LinidFilter[]) => LinidFilter[];
+};

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 value, ready to use with
+     * APIs powered by `spring-query-filter`.
+     * @returns The query parameter string representation of the filter, e.g. `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

@@ -11,6 +11,7 @@ export { useQuasarRules } from './composables/useQuasarRules';
 export { useScopedI18n } from './composables/useScopedI18n';
 export { useTree } from './composables/useTree';
 export { useUiDesign } from './composables/useUiDesign';
+export { useLinidFilterUrl } from './composables/useLinidFilterUrl';
 export { useLinidConfigurationStore } from './stores/linidConfigurationStore';
 export { useLinidUiStore } from './stores/linidUiStore';
 export { useLinidUserStore } from './stores/linidUserStore';
@@ -27,6 +28,9 @@ 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';
@@ -44,3 +48,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linagora/linid-im-front-corelib",
-  "version": "0.0.71",
+  "version": "0.0.73",
   "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": [
@@ -55,6 +55,7 @@
     "rxjs": "7.8.2",
     "vue": "3.5.30",
     "vue-i18n": "11.3.0",
+    "vue-router": "5.0.3",
     "interactjs": "1.10.27"
   },
   "devDependencies": {