@linagora/linid-im-front-corelib 0.0.4 → 0.0.6

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

@@ -0,0 +1,42 @@
+/**
+ * Describes a single attribute of an entity.
+ * Corresponds to `AttributeDescription` from the backend API.
+ */
+export interface LinIdAttributeConfiguration {
+    /** The name of the attribute (e.g., "email"). */
+    name: string;
+    /** The backend type of the attribute (e.g., "string", "integer"). */
+    type: string;
+    /** Whether the attribute is required. */
+    required: boolean;
+    /** Whether the attribute has validation rules. */
+    hasValidations: boolean;
+    /** The UI input type to be used on the front-end (e.g., "text", "select"). */
+    input: string;
+    /** Settings for the input (e.g., options, placeholder). */
+    inputSettings: Record<string, unknown>;
+}
+/**
+ * Represents the configuration of an entity declared in the application.
+ * Returned by the `/metadata/entities` endpoint.
+ */
+export interface LinIdEntityConfiguration {
+    /** The name of the entity (e.g., "user", "group"). */
+    name: string;
+    /** The list of attributes defined for this entity. */
+    attributes: LinIdAttributeConfiguration[];
+}
+/**
+ * Represents a REST route configuration exposed by the application.
+ * Returned by the `/metadata/routes` endpoint.
+ */
+export interface LinIdRouteConfiguration {
+    /** The HTTP method (e.g., "GET", "POST", "PUT", "DELETE"). */
+    method: string;
+    /** The full route path (e.g., "/entities/{entity}"). */
+    path: string;
+    /** The name of the entity this route is related to; may be null for generic routes. */
+    entity: string | null;
+    /** The list of path variable names used in the route (e.g., ["entity", "id"]). */
+    variables: string[];
+}

package/docs/services.md

@@ -0,0 +1,39 @@
+# Services 🔧
+
+This document describes the **services** provided by `linid-im-front-corelib`.
+
+---
+
+## 🔌 HTTP Client Service
+
+Singleton Axios wrapper shared across all modules.
+
+### Functions
+
+| Function                | Description                                       |
+| ----------------------- | ------------------------------------------------- |
+| `setHttpClient(client)` | Initializes the shared Axios instance (call once) |
+| `getHttpClient()`       | Returns the shared Axios instance                 |
+
+### Usage
+
+```ts
+import { setHttpClient, getHttpClient } from '@linagora/linid-im-front-corelib';
+
+// Host initializes once during boot
+setHttpClient(axiosInstance);
+
+// Modules retrieve the shared instance
+const http = getHttpClient();
+```
+
+### Rules
+
+- ✅ Host calls `setHttpClient()` once during boot
+- ✅ Modules use `getHttpClient()` to access the same instance
+- ⚠️ Warning logged if re-initialization is attempted
+- ❌ Error thrown if `getHttpClient()` is called before initialization
+
+---
+
+> Additional services will be added as new features are implemented in the library.

package/docs/types-and-interfaces.md

@@ -34,8 +34,8 @@ interface LinidZoneState {
 }
 ```
 
-* `zones` is a reactive object.
-* Each key corresponds to a zone, each value is an array of plugins for that zone.
+- `zones` is a reactive object.
+- Each key corresponds to a zone, each value is an array of plugins for that zone.
 
 ---
 
@@ -69,21 +69,68 @@ Used internally by [`loadAsyncComponent`](./helpers.md#loadasynccomponent) to en
 
 ```typescript
 // ❌ Wrong - named export only
-export const MyComponent = defineComponent({ /* ... */ });
+export const MyComponent = defineComponent({
+  /* ... */
+});
 
 // ✅ Correct - default export
-export default defineComponent({ /* ... */ });
+export default defineComponent({
+  /* ... */
+});
+```
+
+---
+
+## 🏢 Entity Configuration Types
+
+Types for entity and route metadata returned by the backend API.
+
+### LinIdAttributeConfiguration
+
+Describes a single attribute of an entity (name, type, input settings, validations).
+
+### LinIdEntityConfiguration
+
+Represents an entity with its name and list of attributes.
+Returned by `/metadata/entities` and `/metadata/entities/:entity`.
+
+### LinIdRouteConfiguration
+
+Represents a REST route (method, path, entity, variables).
+Returned by `/metadata/routes`.
+
+---
+
+## 🗃️ LinIdConfigurationState
+
+Represents the state of the Pinia store that manages entity and route configurations.
+
+```ts
+interface LinIdConfigurationState {
+  /** List of entity configurations fetched from the backend. */
+  entities: LinIdEntityConfiguration[];
+  /** List of route configurations fetched from the backend. */
+  routes: LinIdRouteConfiguration[];
+  /** Indicates if the configuration is currently being loaded. */
+  loading: boolean;
+  /** Error message if the configuration fetch failed. */
+  error: string | null;
+}
 ```
 
 ---
 
 ## 🧰 Summary
 
-| Type / Interface        | Purpose                                               |
-| ----------------------- | ----------------------------------------------------- |
-| `LinidZoneEntry`        | Defines the contract for a plugin component           |
-| `LinidZoneState`        | Defines the structure of the zone store               |
-| `RemoteComponentModule` | Defines the structure of a federated component module |
+| Type / Interface              | Purpose                                               |
+| ----------------------------- | ----------------------------------------------------- |
+| `LinidZoneEntry`              | Defines the contract for a plugin component           |
+| `LinidZoneState`              | Defines the structure of the zone store               |
+| `RemoteComponentModule`       | Defines the structure of a federated component module |
+| `LinIdAttributeConfiguration` | Describes an entity attribute                         |
+| `LinIdEntityConfiguration`    | Describes an entity and its attributes                |
+| `LinIdRouteConfiguration`     | Describes a REST route                                |
+| `LinIdConfigurationState`     | Defines the structure of the configuration store      |
 
 These types enforce **consistency and type safety** across all front-end modules and plugins.
 

package/eslint.config.js

@@ -123,9 +123,10 @@ export default defineConfigWithVueTs(
     files: [
       '**/*.test.ts',
       '**/*.spec.ts',
+      '**/*.test.js',
+      '**/*.spec.js',
       '**/__tests__/**',
       '**/*.config.*',
-      '**/*.config.*',
     ],
     rules: {
       'jsdoc/require-jsdoc': 'off',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linagora/linid-im-front-corelib",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "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",
   "main": "dist/core-lib.umd.js",
@@ -40,28 +40,36 @@
   "homepage": "https://github.com/linagora/linid-im-front-corelib#readme",
   "peerDependencies": {
     "@module-federation/enhanced": "0.21.4",
+    "axios": "1.13.2",
     "pinia": "3.0.4",
     "vue": "3.5.24"
   },
   "devDependencies": {
     "@eslint/js": "9.39.1",
-    "@types/node": "20.19.9",
-    "@vitejs/plugin-vue": "6.0.1",
+    "@types/node": "24.10.2",
+    "@vitejs/plugin-vue": "6.0.2",
+    "@vitest/coverage-v8": "4.0.15",
     "@vue/eslint-config-prettier": "10.2.0",
     "@vue/eslint-config-typescript": "14.6.0",
+    "@vue/test-utils": "2.4.6",
     "eslint": "9.39.1",
     "eslint-plugin-headers": "1.3.3",
-    "eslint-plugin-jsdoc": "61.2.1",
-    "eslint-plugin-vue": "10.5.1",
-    "prettier": "3.6.2",
+    "eslint-plugin-jsdoc": "61.5.0",
+    "eslint-plugin-vue": "10.6.2",
+    "happy-dom": "20.0.11",
+    "prettier": "3.7.4",
     "typescript": "5.9.3",
-    "vite": "7.2.2",
-    "vitest": "4.0.8",
-    "vue-tsc": "3.1.3"
+    "vite": "7.2.7",
+    "vite-tsconfig-paths": "5.1.4",
+    "vitest": "4.0.15",
+    "vue-tsc": "3.1.8"
   },
   "scripts": {
-    "build": "vite build && vue-tsc --declaration --emitDeclarationOnly",
-    "test": "vitest",
+    "build": "vite build && vue-tsc --declaration --emitDeclarationOnly -p tsconfig.lib.json",
+    "test": "vitest run",
+    "test:coverage": "vitest --run --coverage",
+    "test:watch": "vitest",
+    "test:ci": "vitest run --coverage --reporter=dot",
     "dev": "vite",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",

package/src/index.ts

@@ -29,10 +29,21 @@ export { default as LinidZoneRenderer } from './components/LinidZoneRenderer.vue
 
 // Stores
 export { useLinidZoneStore } from './stores/linidZoneStore';
+export { useLinIdConfigurationStore } from './stores/linIdConfigurationStore';
+
+// Services
+export { getHttpClient, setHttpClient } from './services/httpClientService';
 
 // Types - Zones
 export type { LinidZoneEntry } from './types/linidZone';
 
+// Types - Configuration
+export type {
+  LinIdAttributeConfiguration,
+  LinIdEntityConfiguration,
+  LinIdRouteConfiguration,
+} from './types/linidConfiguration';
+
 export type {
   ModuleHostConfig,
   RemoteComponentModule,

package/src/services/httpClientService.ts

@@ -0,0 +1,61 @@
+/*
+ * Copyright (C) 2025 Linagora
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+ * Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+ * any later version, provided you comply with the Additional Terms applicable for LinID Identity Manager software by
+ * LINAGORA pursuant to Section 7 of the GNU Affero General Public License, subsections (b), (c), and (e), pursuant to
+ * which these Appropriate Legal Notices must notably (i) retain the display of the "LinID™" trademark/logo at the top
+ * of the interface window, the display of the “You are using the Open Source and free version of LinID™, powered by
+ * Linagora © 2009–2013. Contribute to LinID R&D by subscribing to an Enterprise offer!” infobox and in the e-mails
+ * sent with the Program, notice appended to any type of outbound messages (e.g. e-mail and meeting requests) as well
+ * as in the LinID Identity Manager user interface, (ii) retain all hypertext links between LinID Identity Manager
+ * and https://linid.org/, as well as between LINAGORA and LINAGORA.com, and (iii) refrain from infringing LINAGORA
+ * intellectual property rights over its trademarks and commercial brands. Other Additional Terms apply, see
+ * <http://www.linagora.com/licenses/> for more details.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License and its applicable Additional Terms for
+ * LinID Identity Manager along with this program. If not, see <http://www.gnu.org/licenses/> for the GNU Affero
+ * General Public License version 3 and <http://www.linagora.com/licenses/> for the Additional Terms applicable to the
+ * LinID Identity Manager software.
+ */
+
+import type { AxiosInstance } from 'axios';
+
+/**
+ * Singleton HTTP client instance shared across all modules.
+ */
+let httpClient: AxiosInstance | null = null;
+
+/**
+ * Initializes the shared HTTP client instance.
+ * Should be called once by the host application during boot.
+ * @param client - The Axios instance to use as the shared HTTP client.
+ */
+export function setHttpClient(client: AxiosInstance): void {
+  if (httpClient !== null) {
+    console.warn(
+      '[LinID CoreLib] HTTP client has already been initialized. Re-initialization is ignored.'
+    );
+    return;
+  }
+  httpClient = client;
+}
+
+/**
+ * Returns the shared HTTP client instance.
+ * Must be called after initialization via `setHttpClient()`.
+ * @returns The shared Axios instance.
+ */
+export function getHttpClient(): AxiosInstance {
+  if (httpClient === null) {
+    throw new Error(
+      '[LinID CoreLib] HTTP client is not initialized. Call setHttpClient() first.'
+    );
+  }
+  return httpClient;
+}

package/src/services/linIdConfigurationService.ts

@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2025 Linagora
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+ * Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+ * any later version, provided you comply with the Additional Terms applicable for LinID Identity Manager software by
+ * LINAGORA pursuant to Section 7 of the GNU Affero General Public License, subsections (b), (c), and (e), pursuant to
+ * which these Appropriate Legal Notices must notably (i) retain the display of the "LinID™" trademark/logo at the top
+ * of the interface window, the display of the “You are using the Open Source and free version of LinID™, powered by
+ * Linagora © 2009–2013. Contribute to LinID R&D by subscribing to an Enterprise offer!” infobox and in the e-mails
+ * sent with the Program, notice appended to any type of outbound messages (e.g. e-mail and meeting requests) as well
+ * as in the LinID Identity Manager user interface, (ii) retain all hypertext links between LinID Identity Manager
+ * and https://linid.org/, as well as between LINAGORA and LINAGORA.com, and (iii) refrain from infringing LINAGORA
+ * intellectual property rights over its trademarks and commercial brands. Other Additional Terms apply, see
+ * <http://www.linagora.com/licenses/> for more details.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License and its applicable Additional Terms for
+ * LinID Identity Manager along with this program. If not, see <http://www.gnu.org/licenses/> for the GNU Affero
+ * General Public License version 3 and <http://www.linagora.com/licenses/> for the Additional Terms applicable to the
+ * LinID Identity Manager software.
+ */
+
+import type {
+  LinIdEntityConfiguration,
+  LinIdRouteConfiguration,
+} from '../types/linidConfiguration';
+import { getHttpClient } from './httpClientService';
+
+/**
+ * Service for managing and exposing LinID entity and route configurations.
+ * Fetches metadata from the backend API.
+ */
+/**
+ * Fetches all entity configurations from the backend.
+ * @returns A promise resolving to an array of entity configurations.
+ */
+export async function getEntitiesConfiguration(): Promise<
+  LinIdEntityConfiguration[]
+> {
+  const response =
+    await getHttpClient().get<LinIdEntityConfiguration[]>('/metadata/entities');
+  return response.data;
+}
+
+/**
+ * Fetches a specific entity configuration by name.
+ * @param entityId - The name/identifier of the entity.
+ * @returns A promise resolving to the entity configuration.
+ */
+export async function getEntityConfiguration(
+  entityId: string
+): Promise<LinIdEntityConfiguration> {
+  const response = await getHttpClient().get<LinIdEntityConfiguration>(
+    `/metadata/entities/${entityId}`
+  );
+  return response.data;
+}
+
+/**
+ * Fetches all route configurations from the backend.
+ * @returns A promise resolving to an array of route configurations.
+ */
+export async function getRoutesConfiguration(): Promise<
+  LinIdRouteConfiguration[]
+> {
+  const response =
+    await getHttpClient().get<LinIdRouteConfiguration[]>('/metadata/routes');
+  return response.data;
+}

package/src/stores/linIdConfigurationStore.ts

@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2025 Linagora
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+ * Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+ * any later version, provided you comply with the Additional Terms applicable for LinID Identity Manager software by
+ * LINAGORA pursuant to Section 7 of the GNU Affero General Public License, subsections (b), (c), and (e), pursuant to
+ * which these Appropriate Legal Notices must notably (i) retain the display of the "LinID™" trademark/logo at the top
+ * of the interface window, the display of the “You are using the Open Source and free version of LinID™, powered by
+ * Linagora © 2009–2013. Contribute to LinID R&D by subscribing to an Enterprise offer!” infobox and in the e-mails
+ * sent with the Program, notice appended to any type of outbound messages (e.g. e-mail and meeting requests) as well
+ * as in the LinID Identity Manager user interface, (ii) retain all hypertext links between LinID Identity Manager
+ * and https://linid.org/, as well as between LINAGORA and LINAGORA.com, and (iii) refrain from infringing LINAGORA
+ * intellectual property rights over its trademarks and commercial brands. Other Additional Terms apply, see
+ * <http://www.linagora.com/licenses/> for more details.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License and its applicable Additional Terms for
+ * LinID Identity Manager along with this program. If not, see <http://www.gnu.org/licenses/> for the GNU Affero
+ * General Public License version 3 and <http://www.linagora.com/licenses/> for the Additional Terms applicable to the
+ * LinID Identity Manager software.
+ */
+
+import { defineStore } from 'pinia';
+import {
+  getEntitiesConfiguration,
+  getRoutesConfiguration,
+} from '../services/linIdConfigurationService';
+import type {
+  LinIdEntityConfiguration,
+  LinIdRouteConfiguration,
+} from '../types/linidConfiguration';
+
+/**
+ * State interface for the LinId Configuration Store.
+ */
+interface LinIdConfigurationState {
+  /** List of entity configurations fetched from the backend. */
+  entities: LinIdEntityConfiguration[];
+  /** List of route configurations fetched from the backend. */
+  routes: LinIdRouteConfiguration[];
+  /** Indicates if the configuration is currently being loaded. */
+  loading: boolean;
+  /** Error message if the configuration fetch failed. */
+  error: string | null;
+}
+
+/**
+ * Pinia store managing LinID entity and route configurations.
+ *
+ * Fetches and stores metadata from the backend API.
+ */
+export const useLinIdConfigurationStore = defineStore(
+  'linidConfigurationStore',
+  {
+    state: (): LinIdConfigurationState => ({
+      entities: [],
+      routes: [],
+      loading: false,
+      error: null,
+    }),
+
+    getters: {
+      /**
+       * Returns an entity configuration by name.
+       * @param state - The store state.
+       * @returns A function that takes an entity name and returns the configuration.
+       */
+      getEntityByName:
+        (state) =>
+        (name: string): LinIdEntityConfiguration | undefined =>
+          state.entities.find((entity) => entity.name === name),
+
+      /**
+       * Returns all routes for a specific entity.
+       * @param state - The store state.
+       * @returns A function that takes an entity name and returns its routes.
+       */
+      getRoutesByEntity:
+        (state) =>
+        (entityName: string): LinIdRouteConfiguration[] =>
+          state.routes.filter((route) => route.entity === entityName),
+    },
+
+    actions: {
+      /**
+       * Fetches all entity and route configurations from the backend.
+       */
+      async fetchConfiguration(): Promise<void> {
+        this.loading = true;
+        this.error = null;
+
+        try {
+          const [entities, routes] = await Promise.all([
+            getEntitiesConfiguration(),
+            getRoutesConfiguration(),
+          ]);
+
+          this.entities = entities;
+          this.routes = routes;
+        } catch (err) {
+          this.error =
+            err instanceof Error
+              ? err.message
+              : 'Failed to fetch configuration';
+          console.error('[LinID CoreLib] Failed to fetch configuration:', err);
+        } finally {
+          this.loading = false;
+        }
+      },
+    },
+  }
+);

package/src/types/linidConfiguration.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) 2025 Linagora
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+ * Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
+ * any later version, provided you comply with the Additional Terms applicable for LinID Identity Manager software by
+ * LINAGORA pursuant to Section 7 of the GNU Affero General Public License, subsections (b), (c), and (e), pursuant to
+ * which these Appropriate Legal Notices must notably (i) retain the display of the "LinID™" trademark/logo at the top
+ * of the interface window, the display of the “You are using the Open Source and free version of LinID™, powered by
+ * Linagora © 2009–2013. Contribute to LinID R&D by subscribing to an Enterprise offer!” infobox and in the e-mails
+ * sent with the Program, notice appended to any type of outbound messages (e.g. e-mail and meeting requests) as well
+ * as in the LinID Identity Manager user interface, (ii) retain all hypertext links between LinID Identity Manager
+ * and https://linid.org/, as well as between LINAGORA and LINAGORA.com, and (iii) refrain from infringing LINAGORA
+ * intellectual property rights over its trademarks and commercial brands. Other Additional Terms apply, see
+ * <http://www.linagora.com/licenses/> for more details.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License and its applicable Additional Terms for
+ * LinID Identity Manager along with this program. If not, see <http://www.gnu.org/licenses/> for the GNU Affero
+ * General Public License version 3 and <http://www.linagora.com/licenses/> for the Additional Terms applicable to the
+ * LinID Identity Manager software.
+ */
+
+/**
+ * Describes a single attribute of an entity.
+ * Corresponds to `AttributeDescription` from the backend API.
+ */
+export interface LinIdAttributeConfiguration {
+  /** The name of the attribute (e.g., "email"). */
+  name: string;
+  /** The backend type of the attribute (e.g., "string", "integer"). */
+  type: string;
+  /** Whether the attribute is required. */
+  required: boolean;
+  /** Whether the attribute has validation rules. */
+  hasValidations: boolean;
+  /** The UI input type to be used on the front-end (e.g., "text", "select"). */
+  input: string;
+  /** Settings for the input (e.g., options, placeholder). */
+  inputSettings: Record<string, unknown>;
+}
+
+/**
+ * Represents the configuration of an entity declared in the application.
+ * Returned by the `/metadata/entities` endpoint.
+ */
+export interface LinIdEntityConfiguration {
+  /** The name of the entity (e.g., "user", "group"). */
+  name: string;
+  /** The list of attributes defined for this entity. */
+  attributes: LinIdAttributeConfiguration[];
+}
+
+/**
+ * Represents a REST route configuration exposed by the application.
+ * Returned by the `/metadata/routes` endpoint.
+ */
+export interface LinIdRouteConfiguration {
+  /** The HTTP method (e.g., "GET", "POST", "PUT", "DELETE"). */
+  method: string;
+  /** The full route path (e.g., "/entities/{entity}"). */
+  path: string;
+  /** The name of the entity this route is related to; may be null for generic routes. */
+  entity: string | null;
+  /** The list of path variable names used in the route (e.g., ["entity", "id"]). */
+  variables: string[];
+}