@edifice.io/client

import { App, USER_PREFS } from '../globals'; import { IWebApp } from '../session/interfaces'; export declare abstract class ConfigurationFrameworkFactory { static instance(): IConfigurationFramework; } export interface IConfigurationFramework { /** Framework initialization */ initialize(version: string | null, cdnDomain: string | null): Promise<void>; readonly Platform: { readonly deploymentTag: string; readonly cdnDomain: string; readonly apps: { /** * Initialize an app (preload its public conf and i18n) * @param app Which application to initialize * @param alternativeApp Truthy when an application needs initializing another, while remaining principal. */ initialize(app: App, alternativeApp?: boolean): Promise<void>; /** Load and return the public conf of an app. */ getPublicConf(app: App): Promise<any>; /** Load and return the server conf of an app. */ getWebAppConf(app: App): Promise<IWebApp | undefined>; /** Load the i18n of an app. */ loadI18n(app: App): Promise<void>; }; /** Configured theme. */ readonly theme: ITheme; /** Configured tracking. */ readonly analytics: { /** Get a tracker parameters. */ parameters<T extends ITrackingParams>(type: TrackingType): Promise<T | undefined>; /** * Get the XiTi configuration. * This method awaits for the session to be be fully loaded. * //FIXME refactor xiti configuration */ xiti(): Promise<IXitiTrackingParams | undefined>; /** Check the status, if something goes wrong. */ readonly status: AnalyticStatus; }; /** I18n (port from legacy infra-front)*/ readonly idiom: IIdiom; listLanguages(): Promise<string[]>; }; readonly User: { /** User's preferences.*/ readonly preferences: IUserPreferences; /** Legacy option (//FIXME which use ?).*/ readonly keepOpenOnLogout: boolean; /** User's prefered apps. */ readonly bookmarkedApps: Array<IWebApp>; /** Load the user's preferences for the given app. */ loadAppPrefs(app: App): Promise<any>; /** Save the user's preferences for the given app. */ saveAppPrefs(app: App): Promise<void>; loadLanguage(): Promise<string>; saveLanguage(lang: string): Promise<void>; }; } export type AnalyticStatus = 'void' | 'pending' | 'ready' | 'failed'; export type TrackingType = 'matomo' | 'internal'; export interface ITrackingParams { /** Whitelist of events to track, in the form "app" or "app.eventName" or "*.eventName". */ trackOnly: string[]; /** Blacklist of events not to track, in the form "app" or "app.eventName" or "*.eventName". */ doNotTrack: string[]; /** Set to true if state changes of the Single Page App need to be tracked. */ detailApps: boolean; } export interface IMatomoTrackingParams extends ITrackingParams { url: string; siteId: number; UserId: string; Profile: string; School: string; Project: string; } /** 2021 implementation of XiTi. */ export interface IXitiTrackingParams { /** Which property of LIBELLE_SERVICE to use depends on the frontend. */ LIBELLE_SERVICE: { default: string; } & { [prop: string]: string; }; TYPE: string; OUTIL: any; STRUCT_ID: any; STRUCT_UAI: string; PROJET: any; EXPLOITANT: any; PLATFORME: any; ID_PERSO: any; PROFILE: any; } export interface ITheme { /** (legacy) Name of the currently active skin (user's choice in /timeline) : "default" by default, or another available name. */ readonly skinName: string; /** (legacy) Name of the currently active theme, derived from a parent which is classified as 1D (panda) or 2D(theme-open-ent). This is a domain-level configurated value. */ readonly themeName: string; /** (legacy) FIXME Seems to be equal to themeName. */ readonly skin: string; /** (legacy) URL to the currently active theme/skin folder. */ readonly themeUrl: string; /** (legacy) URL to the currently active portal.html template. Used in infra-front. */ readonly portalTemplate: string; /** (legacy) URL to the folder containing assets. */ readonly basePath: string; /** (legacy) URL where the user is redirected after logout. */ readonly logoutCallback: string; /** Available skins configuration (also called "overrides"). */ readonly skins: Array<IThemeConfOverriding>; /** Check if the "school degree" of the current theme is 1D ("panda", or an override of it). */ readonly is1D: boolean; /** Check if the "school degree" of the current theme is 2D ("theme-open-ent" or an override of it). */ readonly is2D: boolean; /** Get the theme/skin configuration. */ getConf(version?: string): Promise<IThemeConf>; /** Await for theme to be fully loaded (skin, overrides, degrees...). */ onFullyReady(): Promise<ITheme>; /** Await for skin conf to be loaded. */ onSkinReady(): Promise<ITheme>; /** Await for overrides conf to be loaded. */ onOverrideReady(): Promise<IThemeOverrides>; /** List available themes. */ listThemes(): Promise<IThemeDesc[]>; /** Configure UI with this theme by default. */ setDefaultTheme(theme: IThemeDesc): void; /** List available skins. */ listSkins(): Promise<IThemeConfOverriding[]>; /** Get the help path, which can be dedicated to 1D or 2D. */ getHelpPath(): Promise<string>; } export interface IThemeDesc { _id: string; displayName: string; path: string; } export interface IThemeConf { dependencies: { themes: { [name: string]: string; }; widgets: { [name: string]: string; }; }; emitWrapper: boolean; overriding: Array<IThemeConfOverriding>; } export interface IThemeConfOverriding { parent: 'panda' | 'theme-open-ent'; child: string; bootstrapVersion: string; skins: Array<string>; help: string; group?: string; edumedia: { uri: string; pattern: string; ignoreSubjects?: Array<string>; }; } export type IThemeOverrides = { [app in App]?: string; }; export type AddBundleCallback = () => void | Promise<void>; export interface IIdiom { /** Get the translation of a given key. * @param params (optional) map of key/value variables. * @return the key itself when no translation exists. */ translate(key: string, params?: { [param: string]: any; }): string; /** Load a language bundle then return a Promise. */ addBundlePromise(path: string): Promise<void>; /** Load a language bundle then call an optional callback. */ addBundle(path: string, callback?: AddBundleCallback): void; /** Load the JSON language file from a given folder, using the current user's language, then call an optional callback. */ addTranslations(folder: string, callback?: AddBundleCallback): void; /** Load the JSON language files from many given folders, using the current user's language, then return a Promise. */ addAllTranslations(folders: string[]): Promise<void>; /** Add new key/values translations to the in-memory dictionary, using a key/value map. Existing in-memory keys ARE NOT REPLACED. Only new ones are added. */ addKeys(keys: any): void; /** @return a new string without accentuation. */ removeAccents(str: string): string; } export type UserPreferenceKey = (typeof USER_PREFS)[keyof typeof USER_PREFS] | App; export interface IUserPreferences { data: { [key in UserPreferenceKey]?: any; }; get(key: UserPreferenceKey): any; load(key: UserPreferenceKey, defaultTo?: any): Promise<any>; update(key: UserPreferenceKey, data: any): IUserPreferences; save(key: UserPreferenceKey): Promise<void>; } export interface IOdeTheme { basePath: string; bootstrapVersion: string; is1d: boolean; logoutCallback: string; skin: string; skinName: string; skins: Array<IThemeConfOverriding>; themeName: string; themeUrl: string; npmTheme: string | undefined; } export interface IGetConf { app: App; applications: IWebApp[]; conf: IThemeConf; currentApp: IWebApp | undefined; theme: IOdeTheme; }