@dative-gpi/foundation-shared-domain 0.0.230 → 0.1.68

package/enums/actions.ts

@@ -0,0 +1,6 @@
+export enum ActionType {
+  None = 0,
+  OpenDrawer = 1,
+  OpenTabs = 2,
+  NavigateTo = 3
+}

package/enums/agendas.ts

@@ -0,0 +1,6 @@
+export enum AgendaMode {
+  None = 0,
+  Day = 1,
+  Week = 2,
+  Month = 3,
+}

package/enums/applications.ts

@@ -0,0 +1,25 @@
+export enum Scope {
+  None = 0,
+  Public = 0b1111,
+  Application = 0b1000,
+  Organisation = 0b0100,
+  User = 0b0010,
+  UserOrganisation = 0b0001
+}
+
+export enum ApplicationScope {
+  None             = 0,
+  OrganisationType = 1,
+  Organisation     = 2
+}
+
+export enum EntityType {
+  None = 0,
+  Model = 1,
+  Group = 2,
+  Location = 3,
+  Device = 5,
+  User = 6,
+  Dashboard = 7,
+  Folder = 8
+}

package/enums/charts.ts

@@ -0,0 +1,115 @@
+export enum ChartOrigin {
+  None             = 0,
+  Organisation     = 1,
+  OrganisationType = 2
+}
+
+export enum ChartType {
+  None      = 0,
+  XY        = 1,
+  Pie       = 2,
+  Heatmap   = 3,
+  Slider    = 4,
+  Gauge     = 5,
+  ScoreCard = 6,
+  Table     = 7
+}
+
+export enum ColorSets {
+  Default              = 0,
+  Grafana              = 1,
+  Kelly                = 2,
+  Armytage             = 3,
+  ZeileisHornikMurrell = 4,
+  Hash                 = 5
+}
+
+export enum AxisType {
+  None     = 0,
+  Date     = 1,
+  Value    = 2,
+  Category = 3
+}
+
+export enum SerieType {
+  None        = 0,
+  Lines       = 1,
+  Area        = 2,
+  Range       = 3,
+  Histogram   = 4,
+  Operation   = 5,
+  Planning    = 6,
+  ScatterPlot = 7,
+  Top         = 8,
+  Bars        = 9,
+  StackedBars = 10,
+  Pie         = 11,
+  Heatmap     = 12,
+  Slider      = 13,
+  Gauge       = 14,
+  ScoreCard   = 15,
+  Table       = 16
+}
+
+export enum PlotPer {
+  None       = 0,
+  SinglePlot = 1,
+  Model      = 2,
+  Group      = 3,
+  Location   = 4,
+  Device     = 5
+}
+
+export enum AggregationType {
+  None       = 0,
+  Sum        = 1,
+  Cardinal   = 2,
+  Mean       = 3,
+  Median     = 4,
+  First      = 5,
+  Last       = 6,
+  Difference = 7,
+  Minimum    = 8,
+  Maximum    = 9,
+  Range      = 10
+}
+
+export enum PlanningType {
+  None        = 0,
+  UntilNext   = 1,
+  ElapsedTime = 2,
+  SinglePoint = 3
+}
+
+export enum DisplayAs {
+  None   = 0,
+  Bars   = 1,
+  Lines  = 2,
+  Points = 3
+}
+
+export enum OperationOn {
+  None               = 0,
+  SameGroup          = 1,
+  SameEntity         = 2,
+  SameGroupAndEntity = 3
+}
+
+export enum HeatmapRule {
+  None     = 0,
+  Gradient = 1,
+  Ranges   = 2,
+  Fixed    = 3
+}
+
+export enum PieBreakdown {
+  Entity = 0,
+  Serie  = 1,
+  Group  = 2
+}
+
+export enum Position {
+  None     = 0,
+  Abscissa = 1,
+  Ordinate = 2
+}

package/enums/customProperties.ts

@@ -0,0 +1,12 @@
+export enum PropertyEntity {
+    Device             = 0,
+    DeviceOrganisation = 1
+  }
+  
+  export enum PropertyDataType {
+    Number   = 0,
+    Boolean  = 1,
+    String   = 2,
+    DateTime = 3,
+    Icon     = 4
+  }

package/{models/enums/dashboardEnums.ts → enums/dashboards.ts}

@@ -6,9 +6,10 @@ export enum DashboardType {
 }
 
 export enum DashboardVariableType {
-  Number   = 0,
-  String   = 1,
-  TimeStep = 2
+  None     = 0,
+  Number   = 1,
+  String   = 2,
+  TimeStep = 3
 }
 
 export enum AutoRefresh {

package/enums/datas.ts

@@ -0,0 +1,7 @@
+
+export enum DataTable {
+    None = 0,
+    Number = 1,
+    String = 2,
+    DateTime = 3
+}

package/{models/enums/dateEnums.ts → enums/dates.ts}

@@ -40,4 +40,21 @@ export enum Days {
   Saturday  = 5,
   Sunday    = 6,
   AllDays   = 7
+}
+
+export enum Months {
+  None      = 0,
+  January   = 1,
+  February  = 2,
+  March     = 3,
+  April     = 4,
+  May       = 5,
+  June      = 6,
+  July      = 7,
+  August    = 8,
+  September = 9,
+  October   = 10,
+  November  = 11,
+  December  = 12,
+  AllMonths = 13
 }

package/enums/filters.ts

@@ -0,0 +1,12 @@
+export enum FilterType {
+  None        = 0,
+  Equal       = 1,
+  More        = 2,
+  Less        = 3,
+  MoreOrEqual = 4,
+  LessOrEqual = 5,
+  Different   = 6,
+  Contains    = 7,
+  StartsWith  = 8,
+  EndsWith    = 9
+}

package/enums/index.ts

@@ -0,0 +1,17 @@
+export * from "./actions";
+export * from "./agendas";
+export * from "./alerts";
+export * from "./applications";
+export * from "./charts";
+export * from "./connectivities";
+export * from "./customProperties";
+export * from "./dashboards";
+export * from "./datas";
+export * from "./dates";
+export * from "./filters";
+export * from "./index";
+export * from "./lists";
+export * from "./messages";
+export * from "./roles";
+export * from "./times";
+export * from "./users";

package/enums/lists.ts

@@ -0,0 +1,4 @@
+export enum ListModes {
+    Table = "table",
+    Iterator = "iterator"
+}

package/enums/messages.ts

@@ -0,0 +1,16 @@
+export enum MessageType {
+  None = 0,
+  UserApplicationCreation = 1,
+  UserOrganisationCreation = 2,
+  OrganisationCreation = 3,
+  UserApplicationAffectation = 4,
+  UserOrganisationAffectation = 5,
+  OrganisationAdminElevation = 6,
+  AccountInvitation = 7,
+  AccountValidation = 8,
+  PasswordReinitialisation = 9,
+  AlertCreation = 10,
+  AlertResolution = 11,
+  ConnectivityAlertCreation = 12,
+  ConnectivityAlertResolution = 13
+}

package/enums/roles.ts

@@ -0,0 +1,7 @@
+// TODO : remove pour utiliser ApplicationScope et faire migration
+
+export enum RoleType {
+  None = 0,
+  Organisation = 1,
+  OrganisationType = 2
+}

package/enums/times.ts

@@ -0,0 +1,11 @@
+export enum TimeUnit {
+  None        = 0,
+  Millisecond = 1,
+  Second      = 2,
+  Minute      = 3,
+  Hour        = 4,
+  Day         = 5,
+  Week        = 6,
+  Month       = 7,
+  Year        = 8
+}

package/enums/users.ts

@@ -0,0 +1,14 @@
+export enum UserType {
+  None = 0,
+  User = 1,
+  ServiceAccount = 2,
+  Extension = 3
+}
+
+export enum UserValidityState {
+  None = 0,
+  InvitationNotSent = 1,
+  InvitationSent = 2,
+  AccountCreated = 3,
+  AccountValidated = 4
+}

package/models/authTokens/authTokenInfos.ts

@@ -1,4 +1,4 @@
-import { utcToEpoch } from "../../tools";
+import { isoToEpoch } from "../../tools";
 
 export class AuthTokenInfos {
   id: string;
@@ -9,8 +9,8 @@ export class AuthTokenInfos {
   constructor(params: AuthTokenInfosDTO) {
     this.id = params.id;
     this.label = params.label;
-    this.creationDate = utcToEpoch(params.creationDate);
-    this.dateMax = utcToEpoch(params.dateMax);
+    this.creationDate = isoToEpoch(params.creationDate);
+    this.dateMax = isoToEpoch(params.dateMax);
   }
 }
 

package/models/images/imageDetails.ts

@@ -0,0 +1,11 @@
+import { ImageInfos, type ImageInfosDTO } from "./imageInfos";
+
+export class ImageDetails extends ImageInfos {
+
+    constructor(params: ImageDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface ImageDetailsDTO extends ImageInfosDTO {
+}

package/models/images/{blurHash.ts → imageInfos.ts}

@@ -1,16 +1,16 @@
-export class BlurHash {
+export class ImageInfos {
     blurHash: string;
     width: number;
     height: number;
 
-    constructor(params: BlurHashDTO) {
+    constructor(params: ImageInfosDTO) {
         this.blurHash = params.blurHash;
         this.width = params.width;
         this.height = params.height;
     }
 }
 
-export interface BlurHashDTO {
+export interface ImageInfosDTO {
     blurHash: string;
     width: number;
     height: number;

package/models/images/index.ts

@@ -1 +1,2 @@
-export * from "./blurHash";
+export * from "./imageDetails";
+export * from "./imageInfos";

package/models/index.ts

@@ -1,11 +1,11 @@
 export * from "./applications";
 export * from "./authTokens";
-export * from "./enums";                    // No service
 export * from "./images";
-export * from "./languages";                // No service
+export * from "./languages";          // No service
 export * from "./locations";
+export * from "./notifications";
 export * from "./organisations";
-export * from "./organisationTypes";        // No service
+export * from "./organisationTypes";  // No service
 export * from "./permissions";
 export * from "./terminals";
 export * from "./timeZones";

package/models/notifications/index.ts

@@ -0,0 +1,2 @@
+export * from "./notificationDetails";
+export * from "./notificationInfos";

package/models/notifications/notificationDetails.ts

@@ -0,0 +1,10 @@
+import { NotificationInfos, type NotificationInfosDTO } from "./notificationInfos";
+
+export class NotificationDetails extends NotificationInfos {
+  constructor(params: NotificationDetailsDTO) {
+    super(params);
+  }
+}
+
+export interface NotificationDetailsDTO extends NotificationInfosDTO {
+}

package/models/notifications/notificationInfos.ts

@@ -0,0 +1,56 @@
+import { type Criticity, type MessageType, type Scope } from "@dative-gpi/foundation-shared-domain/enums";
+import { isoToEpoch } from "@dative-gpi/foundation-shared-domain/tools";
+
+export class NotificationInfos {
+  id: string;
+  title: string;
+  body: string;
+  pageUrl: string;
+  audienceId: string;
+  audienceScope: Scope;
+  organisationId?: string;
+  entityId?: string;
+  type: MessageType;
+  criticity: Criticity;
+  timestamp: number;
+  acknowledged: boolean | null;
+  acknowledgingTimestamp: number | null;
+
+  constructor(params: NotificationInfosDTO) {
+    this.id = params.id;
+    this.title = params.title;
+    this.body = params.body;
+    this.pageUrl = params.pageUrl;
+    this.audienceId = params.audienceId;
+    this.audienceScope = params.audienceScope as Scope;
+    this.organisationId = params.organisationId;
+    this.entityId = params.entityId;
+    this.type = params.type as MessageType;
+    this.criticity = params.criticity as Criticity;
+    this.timestamp = isoToEpoch(params.timestamp);
+    this.acknowledged = params.acknowledged;
+    this.acknowledgingTimestamp = params.acknowledgingTimestamp ?
+      isoToEpoch(params.acknowledgingTimestamp) : null;
+  }
+}
+
+export interface NotificationInfosDTO {
+  id: string;
+  title: string;
+  body: string;
+  pageUrl: string;
+  audienceId: string;
+  audienceScope: number;
+  organisationId?: string;
+  entityId?: string;
+  type: number;
+  criticity: number;
+  timestamp: string;
+  acknowledged: boolean | null;
+  acknowledgingTimestamp: string | null;
+}
+
+export interface NotificationFilters {
+  type?: MessageType | null;
+  criticity?: Criticity | null;
+}

package/models/organisationTypes/organisationTypeDetails.ts

@@ -1,6 +1,6 @@
 import type { OrganisationTypeInfosDTO } from "./organisationTypeInfos";
 import { OrganisationTypeInfos } from "./organisationTypeInfos";
-import type { DashboardType } from "../enums/dashboardEnums";
+import type { DashboardType } from "../../enums/dashboards";
 
 export class OrganisationTypeDetails extends OrganisationTypeInfos {
     description: string;

package/models/organisationTypes/organisationTypeInfos.ts

@@ -1,4 +1,4 @@
-import type { DashboardType } from "../enums/dashboardEnums";
+import type { DashboardType } from "../../enums/dashboards";
 
 export class OrganisationTypeInfos {
   id: string;

package/models/organisations/organisationDetails.ts

@@ -2,7 +2,7 @@ import type { PermissionInfosDTO } from "../permissions/permissionInfos";
 import { PermissionInfos } from "../permissions/permissionInfos";
 import type { OrganisationInfosDTO } from "./organisationInfos";
 import { OrganisationInfos } from "./organisationInfos";
-import type { DashboardType } from "../enums/dashboardEnums";
+import type { DashboardType } from "../../enums/dashboards";
 
 export class OrganisationDetails extends OrganisationInfos {
     code: string;

package/models/terminals/terminalInfos.ts

@@ -1,4 +1,4 @@
-import { utcToEpoch } from "../../tools";
+import { isoToEpoch } from "../../tools";
 
 export class TerminalInfos {
   id: string;
@@ -17,7 +17,7 @@ export class TerminalInfos {
     this.icon = params.icon;
     this.key = params.key;
     this.location = params.location;
-    this.lastConnection = utcToEpoch(params.lastConnection);
+    this.lastConnection = isoToEpoch(params.lastConnection);
     this.token = params.token;
   }
 

package/models/users/userDetails.ts

@@ -6,7 +6,6 @@ export class UserDetails extends UserInfos {
     hasSignedPolicies: boolean;
     languageCode: string;
     timeZoneId: string;
-    timeZoneOffset: string;
     allowNotifications: boolean;
     allowSms: boolean;
     allowEmails: boolean;
@@ -18,7 +17,6 @@ export class UserDetails extends UserInfos {
         this.hasSignedPolicies = params.hasSignedPolicies;
         this.languageCode = params.languageCode;
         this.timeZoneId = params.timeZoneId;
-        this.timeZoneOffset = params.timeZoneOffset;
         this.allowNotifications = params.allowNotifications;
         this.allowSms = params.allowSms;
         this.allowEmails = params.allowEmails;
@@ -30,7 +28,6 @@ export interface UserDetailsDTO extends UserInfosDTO {
     hasSignedPolicies: boolean;
     languageCode: string;
     timeZoneId: string;
-    timeZoneOffset: string;
     allowNotifications: boolean;
     allowSms: boolean;
     allowEmails: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dative-gpi/foundation-shared-domain",
   "sideEffects": false,
-  "version": "0.0.230",
+  "version": "0.1.68",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,5 +12,5 @@
   "peerDependencies": {
     "date-fns": "^3.6.0"
   },
-  "gitHead": "93365f65d39d6c9cc3821ffb48cba187200deaf9"
+  "gitHead": "fa2ed7031088f422751fc1d939f2fbe168ae0596"
 }

package/tools/autoRefresh.ts

@@ -0,0 +1,22 @@
+import { AutoRefresh } from '../enums';
+
+export const autoRefreshToSeconds = (autoRefresh: AutoRefresh): number => {
+  switch (autoRefresh) {
+    case AutoRefresh.FifteenSeconds:
+      return 15;
+    case AutoRefresh.ThirtySeconds:
+      return 30;
+    case AutoRefresh.OneMinute:
+      return 60;
+    case AutoRefresh.FiveMinutes:
+      return 300;
+    case AutoRefresh.FifteenMinutes:
+      return 900;
+    case AutoRefresh.ThirtyMinutes:
+      return 1800;
+    case AutoRefresh.OneHour:
+      return 3600;
+    default:
+      return 0;
+  }
+}

package/tools/datesTools.ts

@@ -1,13 +1,63 @@
 import { parse } from "date-fns";
 
+export const ISO_FORMAT: string = "yyyy-MM-dd'T'HH:mm:ss";
+
+export const OPTIONS: { [key: string]: Intl.DateTimeFormatOptions } = {
+  dayMonthLongOnly: {
+    day: "2-digit",
+    month: "long"
+  },
+  shortDate: {
+    day: "2-digit",
+    month: "2-digit",
+    year: "numeric"
+  },
+  longDate: {
+    weekday: "long",
+    day: "2-digit",
+    month: "long",
+    year: "numeric"
+  },
+  shortTime: {
+    day: "2-digit",
+    month: "2-digit",
+    year: "numeric",
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit"
+  },
+  longTime: {
+    weekday: "long",
+    day: "2-digit",
+    month: "long",
+    year: "numeric",
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit"
+  },
+  monthYearOnly: {
+    month: "long",
+    year: "numeric"
+  },
+  time: {
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit"
+  },
+  shortTimeOnly: {
+    hour: "2-digit",
+    minute: "2-digit"
+  }
+};
+
+export const isoToEpoch = (value: string): number => {
+  return parse(value.substring(0, 19) + "Z", ISO_FORMAT + "X", new Date()).getTime();
+};
+
 const BASE = ["now"];
 const WIDGET = ["from", "to"];
 const ALERT = ["alert", "alertstart", "alertend"];
 
-const removeArtifacts = (date: string): string => {
-  return date.substring(0, 19) + "Z";
-};
-
 const fromExpression = (expression: string, variant: 'default' | 'before-after'): boolean => {
   if (
     /^\d{2}\/\d{2}\/\d{4} \d{2}:\d{2}(:\d{2})?$/g.test(expression) ||
@@ -66,14 +116,6 @@ const fromExpression = (expression: string, variant: 'default' | 'before-after')
   return true;
 };
 
-export const isoTimeFormat = (timeZone: boolean = false): string => {
-    return `yyyy-MM-dd'T'HH:mm:ss${timeZone ? "X" : ""}`;
-};
-
-export const utcToEpoch = (value: string): number => {
-  return parse(removeArtifacts(value), isoTimeFormat(true), new Date()).getTime();
-};
-
 export const validateExpression = (expression: string, variant: "default" | "before-after"): boolean => {
   return (fromExpression(expression!, variant));
 };

package/tools/index.ts

@@ -1,2 +1,4 @@
 export * from "./datesTools";
-export * from "./single";
+export * from "./single";
+export * from "./notificationsTools";
+export * from "./autoRefresh";

package/tools/notificationsTools.ts

@@ -0,0 +1,39 @@
+import { type NotificationInfos } from "../models";
+import { Criticity, Scope } from "../enums";
+
+export const getFromAudience = (
+  notifications: NotificationInfos[],
+  application: boolean,
+  criticity: Criticity,
+  organisationId?: string | null,
+  userId?: string | null,
+): NotificationInfos[] => notifications.filter((n: NotificationInfos) => {
+  if (n.acknowledged) {
+    return false;
+  }
+  if (![Criticity.None, n.criticity].includes(criticity)) {
+    return false;
+  }
+  switch (n.audienceScope) {
+    case Scope.Organisation    :
+    case Scope.UserOrganisation: return organisationId && n.organisationId && n.organisationId === organisationId;
+    case Scope.User            : return userId && n.audienceId === userId;
+    case Scope.Application     :
+    case Scope.Public          : return application;
+
+  }
+  return false;
+});
+
+export const getForDrawer = (
+  notifications: NotificationInfos[],
+  organisationId: string,
+  userId: string,
+  criticity: Criticity = Criticity.None
+): NotificationInfos[] => getFromAudience(notifications, true, criticity, organisationId, userId);
+
+export const getForCard = (
+  notifications: NotificationInfos[],
+  organisationId: string,
+  criticity: Criticity = Criticity.None
+): NotificationInfos[] => getFromAudience(notifications, false, criticity, organisationId, null);

package/models/enums/applicationEnums.ts

@@ -1,5 +0,0 @@
-export enum Position {
-  None     = 0,
-  Abscissa = 1,
-  Ordinate = 2
-}

package/models/enums/index.ts

@@ -1,5 +0,0 @@
-export * from "./alertEnums";
-export * from "./applicationEnums";
-export * from "./dashboardEnums";
-export * from "./dateEnums";
-export * from "./deviceEnums";