@centreon/ui-context 1.0.0-MON-191119-npm-develop.0

package/README.md

@@ -0,0 +1,13 @@
+# centreon-ui-context
+
+A repository containing the shared context for the Centreon front-end (using the [React Context](https://reactjs.org/docs/context.html))
+
+## Linting
+
+To lint the code with ESlint, run:
+
+`npm run eslint`
+
+You can also fix fixable linter errors by running:
+
+`npm run eslint:fix`

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@centreon/ui-context",
+  "version": "1.0.0-MON-191119-npm-develop.0",
+  "description": "Centreon UI shared context",
+  "main": "src/index.ts",
+  "keywords": [],
+  "author": "centreon@centreon.com",
+  "license": "MIT",
+  "scripts": {
+    "lint": "biome check ./src/ --error-on-warnings",
+    "lint:fix": "pnpm lint --fix",
+    "lint:ci": "biome ci ./src/ --error-on-warnings"
+  }
+}

package/src/acknowledgementAtom.ts

@@ -0,0 +1,9 @@
+import { atom } from 'jotai';
+
+import { defaultAcknowledgement } from './defaults';
+
+import { Acknowledgement } from '.';
+
+const acknowledgementAtom = atom<Acknowledgement>(defaultAcknowledgement);
+
+export default acknowledgementAtom;

package/src/aclAtom.ts

@@ -0,0 +1,9 @@
+import { atom } from 'jotai';
+
+import { defaultAcl } from './defaults';
+
+import { Acl } from '.';
+
+const aclAtom = atom<Acl>(defaultAcl);
+
+export default aclAtom;

package/src/additionalResources.ts

@@ -0,0 +1,5 @@
+import { atom } from 'jotai';
+
+import { AdditionalResource } from './types';
+
+export const additionalResourcesAtom = atom<Array<AdditionalResource>>([]);

package/src/browserLocaleAtom.ts

@@ -0,0 +1,3 @@
+import { atom } from 'jotai';
+
+export const browserLocaleAtom = atom(navigator.language.slice(0, 2));

package/src/cloudServicesAtom.ts

@@ -0,0 +1,5 @@
+import { atom } from 'jotai';
+
+const cloudServicesAtom = atom(false);
+
+export default cloudServicesAtom;

package/src/defaults.ts

@@ -0,0 +1,64 @@
+import { ListingVariant, ThemeMode, User } from './types';
+
+const defaultUser: User = {
+  alias: '',
+  canManageApiTokens: false,
+  default_page: '/monitoring/resources',
+  id: undefined,
+  isAdmin: undefined,
+  isExportButtonEnabled: false,
+  locale: null,
+  name: '',
+  themeMode: ThemeMode.light,
+  timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
+  use_deprecated_pages: false,
+  user_interface_density: ListingVariant.compact
+};
+
+const defaultResourceStorageOptimizationMode = false;
+
+const defaultAcl = {
+  actions: {
+    host: {
+      acknowledgement: false,
+      check: false,
+      comment: false,
+      disacknowledgement: false,
+      downtime: false,
+      submit_status: false
+    },
+    service: {
+      acknowledgement: false,
+      check: false,
+      comment: false,
+      disacknowledgement: false,
+      downtime: false,
+      submit_status: false
+    }
+  }
+};
+
+const defaultDowntime = {
+  duration: 3600,
+  fixed: true,
+  with_services: false
+};
+
+const defaultRefreshInterval = 15;
+
+const defaultAcknowledgement = {
+  force_active_checks: false,
+  notify: true,
+  persistent: false,
+  sticky: false,
+  with_services: true
+};
+
+export {
+  defaultUser,
+  defaultAcl,
+  defaultDowntime,
+  defaultRefreshInterval,
+  defaultAcknowledgement,
+  defaultResourceStorageOptimizationMode
+};

package/src/downtimeAtom.ts

@@ -0,0 +1,9 @@
+import { atom } from 'jotai';
+
+import { defaultDowntime } from './defaults';
+
+import { Downtime } from '.';
+
+const downtimeAtom = atom<Downtime>(defaultDowntime);
+
+export default downtimeAtom;

package/src/federatedModulesAndWidgetsAtoms.ts

@@ -0,0 +1,7 @@
+import { atom } from 'jotai';
+
+import { FederatedModule } from './types';
+
+export const federatedModulesAtom = atom<Array<FederatedModule> | null>(null);
+
+export const federatedWidgetsAtom = atom<Array<FederatedModule> | null>(null);

package/src/index.ts

@@ -0,0 +1,43 @@
+export { default as userAtom } from './userAtom';
+export { default as aclAtom } from './aclAtom';
+export { default as downtimeAtom } from './downtimeAtom';
+export { default as refreshIntervalAtom } from './refreshIntervalAtom';
+export { default as statisticsRefreshIntervalAtom } from './statisticsRefreshIntervalAtom';
+export { default as cloudServicesAtom } from './cloudServicesAtom';
+export { default as acknowledgementAtom } from './acknowledgementAtom';
+export { default as resourceStorageOptimizationModeAtom } from './resourceStorageOptimizationMode';
+export { default as platformNameAtom } from './platformNameAtom';
+export { default as userPermissionsAtom } from './userPermissionsAtom';
+
+export { ThemeMode, ListingVariant, DashboardGlobalRole } from './types';
+export {
+  platformFeaturesAtom,
+  featureFlagsDerivedAtom
+} from './platformFeauresAtom';
+
+export { platformVersionsAtom } from './platformVersionsAtom';
+
+export { isOnPublicPageAtom } from './isOnPublicPageAtom';
+export { additionalResourcesAtom } from './additionalResources';
+export {
+  federatedModulesAtom,
+  federatedWidgetsAtom
+} from './federatedModulesAndWidgetsAtoms';
+export { browserLocaleAtom } from './browserLocaleAtom';
+export { isResourceStatusFullSearchEnabledAtom } from './isResourceStatusFullSearchEnabledAtom';
+
+export type {
+  User,
+  UserContext,
+  ActionAcl,
+  Actions,
+  Downtime,
+  CloudServices,
+  Acknowledgement,
+  Acl,
+  DashboardRolesAndPermissions,
+  FeatureFlags,
+  PlatformFeatures,
+  AdditionalResource,
+  UserPermissions
+} from './types';

package/src/isOnPublicPageAtom.ts

@@ -0,0 +1,3 @@
+import { atom } from 'jotai';
+
+export const isOnPublicPageAtom = atom(false);

package/src/isResourceStatusFullSearchEnabledAtom.ts

@@ -0,0 +1,3 @@
+import { atom } from 'jotai';
+
+export const isResourceStatusFullSearchEnabledAtom = atom(false);

package/src/platformFeauresAtom.ts

@@ -0,0 +1,12 @@
+import { atom } from 'jotai';
+
+import { FeatureFlags, PlatformFeatures } from './types';
+
+export const platformFeaturesAtom = atom<PlatformFeatures | null>(null);
+export const featureFlagsDerivedAtom = atom<FeatureFlags | null>(
+  (get): FeatureFlags => {
+    const platformFeatures = get(platformFeaturesAtom);
+
+    return platformFeatures?.featureFlags as FeatureFlags;
+  }
+);

package/src/platformNameAtom.ts

@@ -0,0 +1,5 @@
+import { atom } from 'jotai';
+
+const platformNameAtom = atom<string | null>(null);
+
+export default platformNameAtom;

package/src/platformVersionsAtom.ts

@@ -0,0 +1,5 @@
+import { atom } from 'jotai';
+
+import { PlatformVersions } from './types';
+
+export const platformVersionsAtom = atom<PlatformVersions | null>(null);

package/src/refreshIntervalAtom.ts

@@ -0,0 +1,7 @@
+import { atom } from 'jotai';
+
+import { defaultRefreshInterval } from './defaults';
+
+const refreshIntervalAtom = atom(defaultRefreshInterval);
+
+export default refreshIntervalAtom;

package/src/resourceStorageOptimizationMode.ts

@@ -0,0 +1,9 @@
+import { atom } from 'jotai';
+
+import { defaultResourceStorageOptimizationMode } from './defaults';
+
+const resourceStorageOptimizationModeAtom = atom(
+  defaultResourceStorageOptimizationMode
+);
+
+export default resourceStorageOptimizationModeAtom;

package/src/statisticsRefreshIntervalAtom.ts

@@ -0,0 +1,6 @@
+import { atom } from 'jotai';
+import { defaultRefreshInterval } from './defaults';
+
+const statisticsRefreshIntervalAtom = atom(defaultRefreshInterval);
+
+export default statisticsRefreshIntervalAtom;

package/src/types.ts

@@ -0,0 +1,147 @@
+import type { Dispatch, SetStateAction } from 'react';
+
+export enum ListingVariant {
+  compact = 'compact',
+  extended = 'extended'
+}
+
+export enum DashboardGlobalRole {
+  administrator = 'administrator',
+  creator = 'creator',
+  viewer = 'viewer'
+}
+
+export interface DashboardRolesAndPermissions {
+  createDashboards: boolean;
+  globalUserRole: DashboardGlobalRole;
+  manageAllDashboards: boolean;
+  viewDashboards: boolean;
+}
+
+export interface User {
+  alias: string;
+  canManageApiTokens: boolean;
+  dashboard?: DashboardRolesAndPermissions | null;
+  default_page?: string | null;
+  id?: number;
+  isAdmin?: boolean;
+  isExportButtonEnabled: boolean;
+  locale: string | null;
+  name: string;
+  themeMode?: ThemeMode;
+  timezone: string;
+  use_deprecated_pages: boolean;
+  user_interface_density: ListingVariant;
+}
+
+export enum ThemeMode {
+  dark = 'dark',
+  light = 'light'
+}
+
+export interface CloudServices {
+  areCloudServicesEnabled: boolean;
+  setAreCloudServicesEnabled: Dispatch<SetStateAction<boolean>>;
+}
+
+export interface Acknowledgement {
+  force_active_checks: boolean;
+  notify: boolean;
+  persistent: boolean;
+  sticky: boolean;
+  with_services: boolean;
+}
+
+export type UserContext = {
+  acknowledgement: Acknowledgement;
+  acl: Acl;
+  cloudServices: CloudServices | undefined;
+  downtime: Downtime;
+  refreshInterval: number;
+  resourceStorageOptimizationMode: boolean;
+} & User;
+
+export interface ActionAcl {
+  acknowledgement: boolean;
+  check: boolean;
+  comment: boolean;
+  downtime: boolean;
+  submit_status: boolean;
+}
+
+export interface Actions {
+  host: ActionAcl;
+  service: ActionAcl;
+}
+
+export interface Acl {
+  actions: Actions;
+}
+
+export interface Downtime {
+  duration: number;
+  fixed: boolean;
+  with_services: boolean;
+}
+
+export interface FeatureFlags {
+  adExclusionPeriods?: boolean;
+  notification?: boolean;
+  vault?: boolean;
+  mapVisxViewer?: boolean;
+}
+
+export interface PlatformFeatures {
+  featureFlags: FeatureFlags;
+  isCloudPlatform: boolean;
+}
+
+export interface AdditionalResource {
+  baseEndpoint: string;
+  defaultMonitoringParameter?: Record<string, boolean | number | string>;
+  label: string;
+  resourceType: string;
+}
+
+interface FederatedComponentsConfiguration {
+  federatedComponents: Array<string>;
+  panelMinHeight?: number;
+  panelMinWidth?: number;
+  path: string;
+  title?: string;
+}
+
+interface PageComponent {
+  children?: string;
+  component: string;
+  featureFlag?: string;
+  route: string;
+}
+
+export interface FederatedModule {
+  federatedComponentsConfiguration: Array<FederatedComponentsConfiguration>;
+  federatedPages: Array<PageComponent>;
+  moduleFederationName: string;
+  moduleName: string;
+  preloadScript?: string;
+  remoteEntry: string;
+  remoteUrl?: string;
+}
+
+interface Version {
+  fix: string;
+  major: string;
+  minor: string;
+  version: string;
+}
+
+export interface PlatformVersions {
+  modules: Record<string, Version>;
+  web: Version;
+  widgets: Record<string, Version | null>;
+}
+
+export interface UserPermissions {
+  top_counter: boolean;
+  poller_statistics: boolean;
+}

package/src/userAtom.ts

@@ -0,0 +1,9 @@
+import { atom } from 'jotai';
+
+import { defaultUser } from './defaults';
+
+import { User } from '.';
+
+const userAtom = atom<User>(defaultUser);
+
+export default userAtom;

package/src/userPermissionsAtom.ts

@@ -0,0 +1,6 @@
+import { atom } from 'jotai';
+import { UserPermissions } from '.';
+
+const userPermissionsAtom = atom<UserPermissions | null>(null);
+
+export default userPermissionsAtom;