@dative-gpi/foundation-core-domain 0.0.2

package/models/dataDefinitions/dataDefinitionInfos.ts

@@ -0,0 +1,57 @@
+import { DataDefinitionMappingInfos, DataDefinitionMappingInfosDTO } from "../dataDefinitionMappings/dataDefinitionMappingInfos";
+import { DataTable } from "../enums/dataDefinitionEnums";
+
+export class DataDefinitionInfos {
+    id: string;
+    modelId: string;
+    dataCategoryId: string;
+    dataCategoryCode: string;
+    dataCategoryLabel: string;
+    code: string;
+    label: string;
+    description: string;
+    dataTable: DataTable;
+    useOnlyMappings: boolean;
+    unit: string;
+    codes: string[];
+    mappings: DataDefinitionMappingInfos[];
+  
+    constructor(params: DataDefinitionInfosDTO) {
+        this.id = params.id;
+        this.modelId = params.modelId;
+        this.dataCategoryId = params.dataCategoryId;
+        this.dataCategoryCode = params.dataCategoryCode;
+        this.dataCategoryLabel = params.dataCategoryLabel;
+        this.code = params.code;
+        this.label = params.label;
+        this.description = params.description;
+        this.dataTable = params.dataTable;
+        this.useOnlyMappings = params.useOnlyMappings;
+        this.unit = params.unit;
+        this.codes = params.codes.slice();
+        this.mappings = params.mappings?.map(dto => new DataDefinitionMappingInfos(dto)) ?? [];
+    }
+}
+  
+  export interface DataDefinitionInfosDTO {
+    id: string;
+    modelId: string;
+    dataCategoryId: string;
+    dataCategoryCode: string;
+    dataCategoryLabel: string;
+    code: string;
+    label: string;
+    description: string;
+    dataTable: DataTable;
+    useOnlyMappings: boolean;
+    unit: string;
+    codes: string[];
+    mappings: DataDefinitionMappingInfosDTO[];
+  }
+  
+  export interface DataDefinitionFilters {
+    modelsIds?: string[];
+    dataCategoryId?: string;
+    dataTable?: DataTable;
+    search?: string;
+  }

package/models/dataDefinitions/index.ts

@@ -0,0 +1,2 @@
+export * from "./dataDefinitionDetails";
+export * from "./dataDefinitionInfos";

package/models/deviceConnectivities/deviceConnectivityDetails.ts

@@ -0,0 +1,10 @@
+import { DeviceConnectivityInfos, DeviceConnectivityInfosDTO } from "./deviceConnectivityInfos";
+
+export class DeviceConnectivityDetails extends DeviceConnectivityInfos {
+    constructor(params: DeviceConnectivityDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface DeviceConnectivityDetailsDTO extends DeviceConnectivityInfosDTO {
+}

package/models/deviceConnectivities/deviceConnectivityInfos.ts

@@ -0,0 +1,31 @@
+import { ConnectivityStatus } from "../enums/deviceEnums";
+
+export class DeviceConnectivityInfos {
+    id: string;
+    sourceTimestamp?: number;
+    enqueuedTimestamp?: number;
+    processedTimestamp?: number;
+    status: ConnectivityStatus;
+    icon: string;
+    color: string;
+
+    constructor(params: DeviceConnectivityInfosDTO) {
+        this.id = params.id;
+        this.sourceTimestamp = params.sourceTimestamp;
+        this.enqueuedTimestamp = params.enqueuedTimestamp;
+        this.processedTimestamp = params.processedTimestamp;
+        this.status = params.status;
+        this.icon = params.icon;
+        this.color = params.color;
+    }
+}
+
+export interface DeviceConnectivityInfosDTO {
+    id: string;
+    sourceTimestamp?: number;
+    enqueuedTimestamp?: number;
+    processedTimestamp?: number;
+    status: ConnectivityStatus;
+    icon: string;
+    color: string;
+}

package/models/deviceConnectivities/index.ts

@@ -0,0 +1,2 @@
+export * from "./deviceConnectivityDetails";
+export * from "./deviceConnectivityInfos";

package/models/deviceOrganisations/deviceOrganisationAlert.ts

@@ -0,0 +1,28 @@
+import { AlertStatus, Criticity } from "../enums/alertEnums";
+
+export class DeviceOrganisationAlert {
+    id: string;
+    label: string;
+    status: AlertStatus;
+    criticity: Criticity;
+    sourceTimestamp?: number;
+    enqueuedTimestamp?: number;
+
+  constructor(params: DeviceOrganisationAlertDTO) {
+    this.id = params.id;
+    this.label = params.label;
+    this.status = params.status;
+    this.criticity = params.criticity;
+    this.sourceTimestamp = params.sourceTimestamp;
+    this.enqueuedTimestamp = params.enqueuedTimestamp;
+  }
+}
+
+export interface DeviceOrganisationAlertDTO {
+  id: string;
+  label: string;
+  status: AlertStatus;
+  criticity: Criticity;
+  sourceTimestamp?: number;
+  enqueuedTimestamp?: number;
+}

package/models/deviceOrganisations/deviceOrganisationDetails.ts

@@ -0,0 +1,64 @@
+import { DeviceOrganisationOption, DeviceOrganisationOptionDTO } from "./deviceOrganisationOption";
+import { DeviceOrganisationInfos, DeviceOrganisationInfosDTO } from "./deviceOrganisationInfos";
+import { PathCrumb, PathCrumbDTO } from "../shared/pathCrumb";
+
+export class DeviceOrganisationDetails extends DeviceOrganisationInfos {
+    articleCode: string;
+    familyId: string;
+    familyLabel: string;
+    description: string;
+    options: DeviceOrganisationOption[];
+    path: PathCrumb[];
+
+    constructor(params: DeviceOrganisationDetailsDTO) {
+        super(params);
+
+        this.articleCode = params.articleCode;
+        this.familyId = params.familyId;
+        this.familyLabel = params.familyLabel;
+        this.description = params.description;
+        this.options = params.options.map(dto => new DeviceOrganisationOption({ ...dto }));
+        this.path = params.path.map(dto => new PathCrumb({ ...dto })).sort((a, b) => b.index - a.index);
+    }
+}
+
+export interface DeviceOrganisationDetailsDTO extends DeviceOrganisationInfosDTO {
+    articleCode: string;
+    familyId: string;
+    familyLabel: string;
+    description: string;
+    options: DeviceOrganisationOptionDTO[];
+    path: PathCrumbDTO[];
+}
+
+export interface CreateDeviceOrganisationDTO {
+    manufacturerId: string;
+    managerId?: string;
+    locationId?: string;
+    groupId?: string;
+    code: string;
+    label: string;
+    description: string;
+    tags: string[];
+    meta: { [key: string]: string };
+}
+
+export interface UpdateDeviceOrganisationDTO {
+    managerId?: string;
+    locationId?: string;
+    groupId?: string;
+    imageId?: string;
+    image?: string;
+    label: string;
+    description: string;
+    tags: string[];
+    meta: { [key: string]: string };
+}
+
+export interface ChangeDeviceOrganisationGroupDTO {
+    groupId?: string;
+}
+
+export interface ChangeDeviceOrganisationLocationDTO {
+    locationId?: string;
+}

package/models/deviceOrganisations/deviceOrganisationInfos.ts

@@ -0,0 +1,132 @@
+import { DeviceConnectivityDetails, DeviceConnectivityDetailsDTO } from "../deviceConnectivities/deviceConnectivityDetails";
+import { DeviceStatusDetails, DeviceStatusDetailsDTO } from "../deviceStatuses/deviceStatusDetails";
+import { DeviceOrganisationAlert, DeviceOrganisationAlertDTO } from "./deviceOrganisationAlert";
+import { ModelStatus, ModelStatusDTO } from "../modelStatuses/modelStatus";
+
+export class DeviceOrganisationInfos {
+    id: string;
+    deviceId: string;
+    manufacturerId: string;
+    manufacturerLabel: string;
+    articleId: string;
+    articleLabel: string;
+    modelId: string;
+    modelLabel: string;
+    ownerId?: string;
+    ownerLabel?: string;
+    organisationId: string;
+    managerId?: string;
+    managerName?: string;
+    locationId?: string;
+    locationLabel?: string;
+    locationAddress?: string;
+    groupId?: string;
+    groupLabel?: string;
+    groupIcon?: string;
+    label: string;
+    code: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    tags: string[];
+    unrestricted: boolean;
+    online: number;
+    meta: { [key: string]: string };
+    modelStatuses: ModelStatus[];
+    status?: DeviceStatusDetails;
+    connectivity?: DeviceConnectivityDetails;
+    alerts: DeviceOrganisationAlert[];
+    worstAlert?: DeviceOrganisationAlert;
+
+    get connectable(): DeviceConnectivityDetails | undefined {
+        return this.connectivity;
+    }
+
+    constructor(params: DeviceOrganisationInfosDTO) {
+        this.id = params.id;
+        this.deviceId = params.deviceId;
+        this.manufacturerId = params.manufacturerId;
+        this.manufacturerLabel = params.manufacturerLabel;
+        this.articleId = params.articleId;
+        this.articleLabel = params.articleLabel;
+        this.modelId = params.modelId;
+        this.modelLabel = params.modelLabel;
+        this.ownerId = params.ownerId;
+        this.ownerLabel = params.ownerLabel;
+        this.organisationId = params.organisationId;
+        this.managerId = params.managerId;
+        this.managerName = params.managerName;
+        this.locationId = params.locationId;
+        this.locationLabel = params.locationLabel;
+        this.locationAddress = params.locationAddress;
+        this.groupId = params.groupId;
+        this.groupLabel = params.groupLabel;
+        this.groupIcon = params.groupIcon;
+        this.label = params.label;
+        this.code = params.code;
+        this.imageId = params.imageId;
+        this.imageBlurHash = params.imageBlurHash;
+        this.imageHeight = params.imageHeight;
+        this.imageWidth = params.imageWidth;
+        this.tags = params.tags.slice();
+        this.unrestricted = params.unrestricted;
+        this.online = params.online;
+        this.meta = { ...params.meta };
+        this.modelStatuses = params.modelStatuses.map(dto => new ModelStatus(dto));
+        this.status = params.status != null ? new DeviceStatusDetails(params.status) : undefined;
+        this.connectivity = params.connectivity != null ? new DeviceConnectivityDetails({ ...params.connectivity, id: params.id }) : undefined;
+        this.alerts = params.alerts.map(dto => new DeviceOrganisationAlert(dto));
+        this.worstAlert = params.worstAlert != null ? new DeviceOrganisationAlert(params.worstAlert) : undefined;
+    }
+}
+
+export interface DeviceOrganisationInfosDTO {
+    id: string;
+    deviceId: string;
+    manufacturerId: string;
+    manufacturerLabel: string;
+    articleId: string;
+    articleLabel: string;
+    modelId: string;
+    modelLabel: string;
+    ownerId?: string;
+    ownerLabel?: string;
+    organisationId: string;
+    managerId?: string;
+    managerName?: string;
+    locationId?: string;
+    locationLabel?: string;
+    locationAddress?: string;
+    groupId?: string;
+    groupLabel?: string;
+    groupIcon?: string;
+    label: string;
+    code: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    tags: string[];
+    unrestricted: boolean;
+    online: number;
+    meta: { [key: string]: string };
+    modelStatuses: ModelStatusDTO[];
+    status?: DeviceStatusDetailsDTO;
+    connectivity?: DeviceConnectivityDetailsDTO;
+    alerts: DeviceOrganisationAlertDTO[];
+    worstAlert?: DeviceOrganisationAlertDTO;
+}
+
+export interface DeviceOrganisationFilters {
+    locationId?: string;
+    otherLocationId?: string;
+    groupId?: string;
+    otherGroupId?: string;
+    root?: boolean;
+    unrestricted?: boolean;
+    modelsIds?: string[];
+    deviceOrganisationsIds?: string[];
+    otherDeviceOrganisationsIds?: string[];
+    search?: string;
+}

package/models/deviceOrganisations/deviceOrganisationOption.ts

@@ -0,0 +1,23 @@
+export class DeviceOrganisationOption {
+    id: number;
+    key: string;
+    value: string;
+    keyLabel: string;
+    valueLabel: string;
+  
+    constructor(params: DeviceOrganisationOptionDTO) {
+        this.id = params.id;
+        this.key = params.key;
+        this.value = params.value;
+        this.keyLabel = params.keyLabel;
+        this.valueLabel = params.valueLabel;
+    }
+}
+  
+export interface DeviceOrganisationOptionDTO {
+    id: number;
+    key: string;
+    value: string;
+    keyLabel: string;
+    valueLabel: string;
+}

package/models/deviceOrganisations/index.ts

@@ -0,0 +1,4 @@
+export * from "./deviceOrganisationAlert";
+export * from "./deviceOrganisationDetails";
+export * from "./deviceOrganisationInfos";
+export * from "./deviceOrganisationOption";

package/models/deviceStatuses/deviceStatusDetails.ts

@@ -0,0 +1,10 @@
+import { DeviceStatusInfos, DeviceStatusInfosDTO } from "./deviceStatusInfos";
+
+export class DeviceStatusDetails extends DeviceStatusInfos {
+    constructor(params: DeviceStatusDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface DeviceStatusDetailsDTO extends DeviceStatusInfosDTO {
+}

package/models/deviceStatuses/deviceStatusInfos.ts

@@ -0,0 +1,65 @@
+export class DeviceStatusInfos {
+  id: string;
+  statuses: DeviceStatus[];
+
+  constructor(params: DeviceStatusInfosDTO) {
+    this.id = params.id;
+    this.statuses = params.statuses.map(dto => new DeviceStatus(dto));
+  }
+}
+
+export class DeviceStatus {
+  modelStatusId: string;
+  statusGroups: DeviceStatusGroup[];
+
+  constructor(params: DeviceStatusDTO) {
+    this.modelStatusId = params.modelStatusId;
+    this.statusGroups = params.statusGroups.map(dto => new DeviceStatusGroup(dto));
+  }
+}
+
+export class DeviceStatusGroup {
+  sourceTimestamp?: number;
+  enqueuedTimestamp?: number;
+  processedTimestamp?: number;
+  groupByValue: string;
+  value: string;
+  unit: string;
+  label: string;
+  icon: string;
+  color: string;
+
+  constructor(params: DeviceStatusGroupDTO) {
+    this.sourceTimestamp = params.sourceTimestamp;
+    this.enqueuedTimestamp = params.enqueuedTimestamp;
+    this.processedTimestamp = params.processedTimestamp;
+    this.groupByValue = params.groupByValue;
+    this.value = params.value;
+    this.unit = params.unit;
+    this.label = params.label;
+    this.icon = params.icon;
+    this.color = params.color;
+  }
+}
+
+export interface DeviceStatusInfosDTO {
+  id: string;
+  statuses: DeviceStatusDTO[];
+}
+
+export interface DeviceStatusDTO {
+  modelStatusId: string;
+  statusGroups: DeviceStatusGroupDTO[];
+}
+
+export interface DeviceStatusGroupDTO {
+  sourceTimestamp?: number;
+  enqueuedTimestamp?: number;
+  processedTimestamp?: number;
+  groupByValue: string;
+  value: string;
+  unit: string;
+  label: string;
+  icon: string;
+  color: string;
+}

package/models/deviceStatuses/index.ts

@@ -0,0 +1,2 @@
+export * from "./deviceStatusDetails";
+export * from "./deviceStatusInfos";

package/models/enums/alertEnums.ts

@@ -0,0 +1,30 @@
+export enum AlertStatus
+{
+  None = 0,
+  Pending = 1,
+  Untriggered = 2,
+  Unresolved = 3,
+  Resolved = 4,
+  Expired = 5,
+  Triggered = 6,
+  Abandoned = 7
+}
+
+export enum Criticity {
+  None = 0,
+  Information = 1,
+  Warning = 2,
+  Error = 3
+}
+
+export enum TriggerOn {
+    None = 0,
+    RisingEdge = 1,
+    Everytime = 2
+}
+
+export enum ResolveOn {
+  None = 0,
+  OutOfTrigger = 1,
+  NewOperation = 2
+}

package/models/enums/applicationEnums.ts

@@ -0,0 +1,8 @@
+export enum ApplicationScope {
+    None = 0,
+    OrganisationType = 1,
+    Organisation = 2,
+    Group = 11,
+    Scenario = 12,
+    Report = 13
+  }

package/models/enums/customPropertyEnums.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

@@ -0,0 +1,30 @@
+export enum StructureLevel {
+    None                      = 0,
+    OrganisationDashboard     = 1,
+    OrganisationTypeDashboard = 2,
+    OrganisationWidget        = 3,
+    OrganisationTypeWidget    = 4,
+    GroupDashboard            = 5,
+    GroupWidget               = 6,
+    AlertDashboard            = 7,
+    AlertWidget               = 8,
+    OrganisationList          = 9
+  }
+  
+  export enum DashboardType {
+    None             = 0,
+    Organisation     = 1,
+    OrganisationType = 2,
+    Shallow          = 3
+  }
+  
+  export enum AutoRefresh {
+    None           = 0,
+    FifteenSeconds = 1,
+    ThirtySeconds  = 2,
+    OneMinute      = 3,
+    FiveMinutes    = 4,
+    FifteenMinutes = 5,
+    ThirtyMinutes  = 6,
+    OneHour        = 7
+  }

package/models/enums/dataDefinitionEnums.ts

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

package/models/enums/deviceEnums.ts

@@ -0,0 +1,7 @@
+export enum ConnectivityStatus {
+    None = 0,
+    Connected = 1,
+    PartiallyConnected = 2,
+    AlmostOffline = 3,
+    Offline = 4
+}

package/models/enums/index.ts

@@ -0,0 +1,9 @@
+export * from "./alertEnums";
+export * from "./applicationEnums";
+export * from "./customPropertyEnums";
+export * from "./dashboardEnums";
+export * from "./dataDefinitionEnums";
+export * from "./deviceEnums";
+export * from "./roleEnums";
+export * from "./sharedEnums";
+export * from "./userEnums";

package/models/enums/roleEnums.ts

@@ -0,0 +1,5 @@
+export enum RoleType {
+    None = 0,
+    Organisation = 1,
+    OrganisationType = 2
+  }

package/models/enums/sharedEnums.ts

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

package/models/enums/userEnums.ts

@@ -0,0 +1,13 @@
+export enum UserType {
+    User = 0,
+    ServiceAccount = 1,
+    Extension = 2
+  }
+  
+  export enum UserValidityState
+  {
+      InvitationNotSent = 0x000,
+      InvitationSent = 0x001,
+      AccountCreated = 0x011,
+      AccountValidated = 0x111
+  }

package/models/families/familyDetails.ts

@@ -0,0 +1,18 @@
+import { FamilyInfos, FamilyInfosDTO } from "./familyInfos";
+
+export class FamilyDetails extends FamilyInfos {
+    parentId: string;
+    parentLabel: string;
+    
+    constructor(params: FamilyDetailsDTO) {
+        super(params);
+
+        this.parentId = params.parentId;
+        this.parentLabel = params.parentLabel;
+    }
+}
+
+export interface FamilyDetailsDTO extends FamilyInfosDTO {
+    parentId: string;
+    parentLabel: string;
+}

package/models/families/familyInfos.ts

@@ -0,0 +1,18 @@
+export class FamilyInfos {
+    id: string;
+    label: string;
+    
+    constructor(params: FamilyInfosDTO) {
+        this.id = params.id;
+        this.label = params.label;
+    }
+}
+
+export interface FamilyInfosDTO {
+    id: string;
+    label: string;
+}
+
+export interface FamilyFilters {
+    search?: string;
+}

package/models/families/index.ts

@@ -0,0 +1,2 @@
+export * from "./familyDetails";
+export * from "./familyInfos";

package/models/groups/groupDetails.ts

@@ -0,0 +1,41 @@
+import { GroupInfos, GroupInfosDTO } from "./groupInfos";
+
+export class GroupDetails extends GroupInfos {
+    parentIcon?: string;
+    parentLabel?: string;
+
+    constructor(params: GroupDetailsDTO) {
+        super(params);
+
+        this.parentIcon = params.parentIcon;
+        this.parentLabel = params.parentLabel;
+    }
+}
+
+export interface GroupDetailsDTO extends GroupInfosDTO {
+    parentIcon?: string;
+    parentLabel?: string;
+}
+
+export interface CreateGroupDTO {
+    parentId?: string;
+    image?: string;
+    icon: string;
+    code: string;
+    label: string;
+    tags: string[];
+}
+
+export interface UpdateGroupDTO {
+    parentId?: string;
+    imageId?: string;
+    image?: string;
+    icon: string;
+    code: string;
+    label: string;
+    tags: string[];
+}
+
+export interface ChangeGroupParentDTO {
+    parentId?: string;
+}