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

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

@@ -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/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.83",
+  "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": [