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

package/src/services/httpClientService.ts

@@ -1,61 +0,0 @@
-/*
- * 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

@@ -1,73 +0,0 @@
-/*
- * 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

@@ -1,116 +0,0 @@
-/*
- * 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/stores/linidZoneStore.ts

@@ -1,62 +0,0 @@
-/*
- * 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 type { LinidZoneEntry } from '../types/linidZone';
-
-/**
- * State interface for the Linid Zone Store.
- */
-interface LinidZoneState {
-  /** Map of zone names to their registered entries. */
-  zones: Record<string, LinidZoneEntry[]>;
-}
-
-/**
- * Pinia store managing Linid zones and their registered entries.
- *
- * Each zone can contain multiple {@link LinidZoneEntry} objects,
- * and this store provides utilities to register them dynamically.
- */
-export const useLinidZoneStore = defineStore('linidZoneStore', {
-  state: (): LinidZoneState => ({
-    zones: {},
-  }),
-
-  actions: {
-    /**
-     * Register a new entry in a specified zone.
-     * @param zone - The name of the zone.
-     * @param entry - The entry to register.
-     */
-    register(zone: string, entry: LinidZoneEntry): void {
-      if (!this.zones[zone]) {
-        this.zones[zone] = [];
-      }
-      this.zones[zone].push(entry);
-    },
-  },
-});

package/src/types/linidConfiguration.ts

@@ -1,70 +0,0 @@
-/*
- * 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[];
-}

package/src/types/linidZone.ts

@@ -1,48 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * 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.
- */
-export interface LinidZoneEntry {
-  /**
-   * The unique plugin identifier that registered this entry.
-   *
-   * Typically corresponds to the plugin name or package name.
-   */
-  plugin: string;
-
-  /**
-   * 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>;
-}

package/src/types/module.ts

@@ -1,96 +0,0 @@
-/*
- * 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 { Component } from 'vue';
-import type { ModuleLifecycleHooks } from './moduleLifecycle';
-
-/**
- * Remote module interface.
- *
- * All remote modules exposed via Module Federation should implement this interface.
- * This is the contract between the host application and remote modules.
- */
-export interface RemoteModule extends ModuleLifecycleHooks {
-  /**
-   * Unique identifier for the module.
-   *
-   * Should be in kebab-case and match the ID in the module configuration.
-   */
-  id: string;
-
-  /**
-   * Human-readable name of the module.
-   */
-  name: string;
-
-  /**
-   * Version of the module.
-   *
-   * Should follow semantic versioning (semver).
-   */
-  version: string;
-
-  /**
-   * Optional description of the module.
-   *
-   * Provide a brief description of what the module does.
-   */
-  description?: string;
-}
-
-/**
- * Module configuration in the host (module-<name>.json).
- *
- * This is what the host provides to each module during the configuration phase.
- * The host reads this from `module-<name>.json` files.
- */
-export interface ModuleHostConfig {
-  /**
-   * Unique module identifier (kebab-case).
-   *
-   * Must match the module's exported `id` field.
-   */
-  id: string;
-
-  /**
-   * Module Federation remote name (must match a key in remotes.json).
-   *
-   * This is the name used to load the remote module via Module Federation.
-   */
-  remoteName: string;
-}
-
-/**
- * Module structure for a Vue component exposed via Module Federation.
- *
- * Remote modules must export a Vue component as their default export.
- */
-export interface RemoteComponentModule {
-  /**
-   * The default exported Vue component.
-   */
-  default: Component;
-}