@linagora/linid-im-front-corelib 0.0.82 → 0.0.84

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

@@ -35,3 +35,30 @@ export declare function useScopedI18n(scope: string): {
      */
     translateOrDefault: (defaultValue: string, ...args: unknown[]) => ReturnType<ComposerTranslation>;
 };
+/**
+ * Resolves the effective locale to apply, without any side effect.
+ *
+ * The locale is resolved by priority: the stored user preference first, then the locally persisted language.
+ * If neither the stored preference nor the localStorage value is a supported language, the UI store locale is used as the fallback.
+ * @returns The locale code the caller should apply to its i18n target.
+ */
+export declare function resolveLocale(): string;
+/**
+ * Synchronises the persisted state with the given locale.
+ *
+ * The locale is always written to localStorage. The server-side user preference is updated only when it differs from
+ * the currently stored one.
+ * @param locale - The locale to persist.
+ * @returns A promise that resolves once the persisted state has been synchronised.
+ */
+export declare function syncLocale(locale: string): Promise<void>;
+/**
+ * Applies the given locale to the application and persists the choice.
+ *
+ * Updates the active i18n locale, reflects it in the UI store, and synchronises the persisted state. This assumes the
+ * shared i18n instance runs in Composition mode (legacy: false), as guaranteed by the corelib LinidI18n convention;
+ * on a legacy instance the locale assignment would be a silent no-op at runtime.
+ * @param locale - The locale code to apply (e.g. "fr-FR").
+ * @returns A promise that resolves once the locale has been applied and persisted.
+ */
+export declare function changeLocale(locale: string): Promise<void>;

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

@@ -8,7 +8,7 @@ export { usePagination } from './composables/usePagination';
 export { QDATE_DEFAULT_MASK, useQuasarDate } from './composables/useQuasarDate';
 export { useQuasarFieldValidation } from './composables/useQuasarFieldValidation';
 export { useQuasarRules } from './composables/useQuasarRules';
-export { useScopedI18n } from './composables/useScopedI18n';
+export { changeLocale, resolveLocale, syncLocale, useScopedI18n, } from './composables/useScopedI18n';
 export { useTree } from './composables/useTree';
 export { useUiDesign } from './composables/useUiDesign';
 export { useLinidFilterUrl } from './composables/useLinidFilterUrl';
@@ -35,7 +35,7 @@ export { LinidFilterSet } from './filters/linidFilterSet';
 export { LinidFilterValue } from './filters/linidFilterValue';
 export { LINID_FILTER_NEGATION_PREFIX, LINID_FILTER_OR_SEPARATOR, } from './types/linidFilter';
 export type { LinidFilterSetUserPreference } from './types/linidFilter';
-export type { LinidZoneEntry } from './types/linidZone';
+export type { BaseLinidZoneEntry, ComponentLinidZoneEntry, FederatedLinidZoneEntry, LinidZoneEntry, LinidZoneResolvedEntry, } 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';

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

@@ -5,6 +5,13 @@ import type { NavigationMenuItem } from '../types/linidUi';
 interface LinidUiState {
     /** List of main navigation menu items. */
     mainNavigationItems: NavigationMenuItem[];
+    /** Internationalization state: active locale and available languages. */
+    i18n: {
+        /** Currently active locale code (e.g. "fr-FR"). */
+        locale: string;
+        /** List of available locale codes declared in the configuration. */
+        languages: string[];
+    };
 }
 /**
  * Returns the Linid UI Store instance.
@@ -16,5 +23,15 @@ export declare const useLinidUiStore: () => import("pinia").Store<"LinidUiStore"
      * @param items - The navigation menu items to add.
      */
     addMainNavigationMenuItems(...items: NavigationMenuItem[]): void;
+    /**
+     * Sets the list of available locale codes.
+     * @param languages - The available locale codes (e.g. ["fr-FR", "en-US"]).
+     */
+    setAvailableLanguages(languages: string[]): void;
+    /**
+     * Sets the active locale code.
+     * @param locale - The locale code to activate (e.g. "fr-FR").
+     */
+    setLocale(locale: string): void;
 }>;
 export {};

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

@@ -1,3 +1,4 @@
+import type { Component } from 'vue';
 import type { LinidZoneEntry } from '../types/linidZone';
 /**
  * State interface for the Linid Zone Store.
@@ -12,17 +13,37 @@ interface LinidZoneState {
  */
 export declare const useLinidZoneStore: () => import("pinia").Store<"linidZoneStore", LinidZoneState, {}, {
     /**
-     * Register a new entry in a specified zone.
+     * Append an entry to a specified zone, creating the zone if needed.
+     *
+     * Internal helper backing the public `register*` actions.
      * @param zone - The name of the zone.
-     * @param entry - The entry to register.
+     * @param entry - The entry to append.
      */
-    register(zone: string, entry: LinidZoneEntry): void;
+    appendEntry(zone: string, entry: LinidZoneEntry): void;
     /**
-     * Register a new entry only if the plugin
+     * Register a federated plugin component in a specified zone.
+     * @param zone - The name of the zone.
+     * @param plugin - The plugin identifier of the remote component to load.
+     * @param props - Optional props passed to the rendered component.
+     */
+    registerPlugin(zone: string, plugin: string, props?: Record<string, unknown>): void;
+    /**
+     * Register a federated plugin component only if the plugin
      * is not already registered in the zone.
      * @param zone - The name of the zone.
-     * @param entry - The entry to register.
+     * @param plugin - The plugin identifier of the remote component to load.
+     * @param props - Optional props passed to the rendered component.
+     */
+    registerPluginOnce(zone: string, plugin: string, props?: Record<string, unknown>): void;
+    /**
+     * Register a Vue component directly in a specified zone.
+     *
+     * The component is stored with `markRaw` to keep it out of the
+     * reactivity system, as Vue components must not be reactive.
+     * @param zone - The name of the zone.
+     * @param component - The Vue component to render as-is.
+     * @param props - Optional props passed to the rendered component.
      */
-    registerOnce(zone: string, entry: LinidZoneEntry): void;
+    registerComponent(zone: string, component: Component, props?: Record<string, unknown>): void;
 }>;
 export {};

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

@@ -1,21 +1,68 @@
+import type { Component } from 'vue';
 /**
- * Represents a single entry registered within a Linid Zone.
- *
- * Each entry corresponds to a component provided by a plugin,
- * and can optionally define props to configure that component.
+ * Base model shared by all zone entry variants.
+ */
+export interface BaseLinidZoneEntry {
+    /**
+     * Optional props to be passed to the rendered component.
+     *
+     * The keys are prop names, and the values are Vue components or objects
+     * compatible with Vue’s component system.
+     */
+    props?: Record<string, unknown>;
+}
+/**
+ * Zone entry referencing a component loaded through module federation.
  */
-export interface LinidZoneEntry {
+export interface FederatedLinidZoneEntry extends BaseLinidZoneEntry {
+    /** Discriminant of the federated variant. */
+    type: 'federated';
     /**
      * The unique plugin identifier that registered this entry.
      *
      * Typically corresponds to the plugin name or package name.
      */
     plugin: string;
+}
+/**
+ * Zone entry providing a Vue component directly.
+ *
+ * Unlike federated entries, no module federation loading is involved:
+ * the component is rendered as-is.
+ */
+export interface ComponentLinidZoneEntry extends BaseLinidZoneEntry {
+    /** Discriminant of the component variant. */
+    type: 'component';
     /**
-     * Optional props to be passed to the rendered component.
+     * The Vue component to render directly.
+     */
+    component: Component;
+}
+/**
+ * Represents a single entry registered within a Linid Zone.
+ *
+ * An entry provides its component either through a federated plugin
+ * identifier ({@link FederatedLinidZoneEntry}) or as a Vue component
+ * given directly ({@link ComponentLinidZoneEntry}), and can optionally
+ * define props to configure that component.
+ */
+export type LinidZoneEntry = FederatedLinidZoneEntry | ComponentLinidZoneEntry;
+/**
+ * A zone entry resolved for rendering by `LinidZoneRenderer`.
+ *
+ * Whatever the entry variant, the resolved form always carries the
+ * component to render.
+ */
+export interface LinidZoneResolvedEntry {
+    /**
+     * The component to render.
      *
-     * The keys are prop names, and the values are Vue components or objects
-     * compatible with Vue’s component system.
+     * Either the async component loaded from the federated plugin,
+     * or the Vue component provided directly by the entry.
+     */
+    component: Component;
+    /**
+     * Optional props to be passed to the rendered component.
      */
     props?: Record<string, unknown>;
 }

package/package.json

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