@dative-gpi/foundation-core-domain 0.0.2

package/index.ts

@@ -0,0 +1 @@
+export * from "./models";

package/models/alerts/alertDataDefinition.ts

@@ -0,0 +1,17 @@
+export class AlertDataDefinition {
+    dataDefinitionId: string;
+    value: string;
+    label: string;
+  
+    constructor(params: AlertDataDefinitionDTO) {
+      this.dataDefinitionId = params.dataDefinitionId;
+      this.value = params.value;
+      this.label = params.label;
+    }
+  }
+  
+  export interface AlertDataDefinitionDTO {
+    dataDefinitionId: string;
+    value: string;
+    label: string;
+  }

package/models/alerts/alertDetails.ts

@@ -0,0 +1,15 @@
+import { AlertInfos, AlertInfosDTO } from "./alertInfos";
+
+export class AlertDetails extends AlertInfos {
+    description: string;
+
+    constructor(params: AlertDetailsDTO) {
+        super(params);
+
+        this.description = params.description;
+    }
+}
+
+export interface AlertDetailsDTO extends AlertInfosDTO {
+    description: string;
+}

package/models/alerts/alertInfos.ts

@@ -0,0 +1,116 @@
+import { AlertDataDefinition, AlertDataDefinitionDTO } from "./alertDataDefinition";
+import { AlertStatus, Criticity } from "../enums/alertEnums";
+import { AlertState, AlertStateDTO } from "./alertState";
+import { SelectedEntities } from "../enums/sharedEnums";
+import { DateVariable } from "../shared/dateVariable";
+
+export class AlertInfos {
+    id: string;
+    scenarioId: string;
+    scenarioLabel: string;
+    organisationId: string;
+    deviceOrganisationId: string;
+    deviceOrganisationLabel: string;
+    icon: string;
+    code: string;
+    label: string;
+    criticity: Criticity;
+    acknowledged: boolean;
+    acknowledgingUserId?: string;
+    acknowledgingUserName?: string;
+    acknowledgingUserImageId?: string;
+    acknowledgingUserImageBlurHash?: string;
+    acknowledgingUserImageWidth?: number;
+    acknowledgingUserImageHeight?: number;
+    acknowledgingTimestamp?: number;
+    initialState: AlertState;
+    triggerSourceTimestamp?: number;
+    triggerEnqueuedTimestamp?: number;
+    triggerProcessedTimestamp?: number;
+    lastState: AlertState;
+    currentSourceTimestamp?: number;
+    currentEnqueuedTimestamp?: number;
+    currentProcessedTimestamp?: number;
+    status: AlertStatus;
+    tags: string[];
+    history: AlertState[];
+    groupByValues: AlertDataDefinition[];
+
+    constructor(params: AlertInfosDTO) {
+        this.id = params.id;
+        this.scenarioId = params.scenarioId;
+        this.scenarioLabel = params.scenarioLabel;
+        this.organisationId = params.organisationId;
+        this.deviceOrganisationId = params.deviceOrganisationId;
+        this.deviceOrganisationLabel = params.deviceOrganisationLabel;
+        this.icon = params.icon;
+        this.code = params.code;
+        this.label = params.label;
+        this.criticity = params.criticity;
+        this.acknowledged = params.acknowledged;
+        this.acknowledgingUserId = params.acknowledgingUserId;
+        this.acknowledgingUserName = params.acknowledgingUserName;
+        this.acknowledgingUserImageId = params.acknowledgingUserImageId;
+        this.acknowledgingUserImageBlurHash = params.acknowledgingUserImageBlurHash;
+        this.acknowledgingUserImageWidth = params.acknowledgingUserImageWidth;
+        this.acknowledgingUserImageHeight = params.acknowledgingUserImageHeight;
+        this.acknowledgingTimestamp = params.acknowledgingTimestamp;
+        this.initialState = new AlertState(params.initialState);
+        this.triggerSourceTimestamp = params.triggerSourceTimestamp;
+        this.triggerEnqueuedTimestamp = params.triggerEnqueuedTimestamp;
+        this.triggerProcessedTimestamp = params.triggerProcessedTimestamp;
+        this.lastState = new AlertState(params.lastState);
+        this.currentSourceTimestamp = params.currentSourceTimestamp;
+        this.currentEnqueuedTimestamp = params.currentEnqueuedTimestamp;
+        this.currentProcessedTimestamp = params.currentProcessedTimestamp;
+        this.status = params.status;
+        this.tags = params.tags;
+        this.history = params.history.map(dto => new AlertState(dto));
+        this.groupByValues = params.groupByValues.map(dto => new AlertDataDefinition(dto));
+    }
+}
+
+export interface AlertInfosDTO {
+    id: string;
+    scenarioId: string;
+    scenarioLabel: string;
+    organisationId: string;
+    deviceOrganisationId: string;
+    deviceOrganisationLabel: string;
+    icon: string;
+    code: string;
+    label: string;
+    criticity: Criticity;
+    acknowledged: boolean;
+    acknowledgingUserId?: string;
+    acknowledgingUserName?: string;
+    acknowledgingUserImageId?: string;
+    acknowledgingUserImageBlurHash?: string;
+    acknowledgingUserImageWidth?: number;
+    acknowledgingUserImageHeight?: number;
+    acknowledgingTimestamp?: number;
+    initialState: AlertStateDTO;
+    triggerSourceTimestamp?: number;
+    triggerEnqueuedTimestamp?: number;
+    triggerProcessedTimestamp?: number;
+    lastState: AlertStateDTO;
+    currentSourceTimestamp?: number;
+    currentEnqueuedTimestamp?: number;
+    currentProcessedTimestamp?: number;
+    status: AlertStatus;
+    tags: string[];
+    history: AlertStateDTO[];
+    groupByValues: AlertDataDefinitionDTO[];
+}
+
+export interface AlertFilters {
+    scenarioId?: string;
+    deviceOrganisationId?: string;
+    statuses?: AlertStatus[];
+    acknowledged?: boolean;
+    startDate?: string;
+    endDate?: string;
+    selectedEntities?: SelectedEntities; 
+    entitiesIds?: string[];
+    dateVariables?: DateVariable[];
+}

package/models/alerts/alertState.ts

@@ -0,0 +1,29 @@
+import { AlertDataDefinition, AlertDataDefinitionDTO } from "./alertDataDefinition";
+import { AlertStatus } from "../enums/alertEnums";
+
+export class AlertState {
+    id: string;
+    status: AlertStatus;
+    sourceTimestamp: number;
+    enqueuedTimestamp: number;
+    processedTimestamp: number;
+    metadataValues?: AlertDataDefinition[];
+
+    constructor(params: AlertStateDTO) {
+        this.id = params.id;
+        this.status = params.status;
+        this.sourceTimestamp = params.sourceTimestamp;
+        this.enqueuedTimestamp = params.enqueuedTimestamp;
+        this.processedTimestamp = params.processedTimestamp;
+        this.metadataValues = params.metadataValues?.map(dto => new AlertDataDefinition(dto));
+    }
+}
+
+export interface AlertStateDTO {
+    id: string;
+    status: AlertStatus;
+    sourceTimestamp: number;
+    enqueuedTimestamp: number;
+    processedTimestamp: number;
+    metadataValues?: AlertDataDefinitionDTO[];
+}

package/models/alerts/index.ts

@@ -0,0 +1,4 @@
+export * from "./alertDataDefinition";
+export * from "./alertDetails";
+export * from "./alertInfos";
+export * from "./alertState";

package/models/applications/applicationDetails.ts

@@ -0,0 +1,16 @@
+import { LanguageInfos, LanguageInfosDTO } from "../languages/languageInfos";
+import { ApplicationInfos, ApplicationInfosDTO } from "./applicationInfos";
+
+export class ApplicationDetails extends ApplicationInfos {
+    languages: LanguageInfos[];
+
+    constructor(params: ApplicationDetailsDTO) {
+        super(params);
+
+        this.languages = params.languages.map((dto) => new LanguageInfos(dto));
+    }
+}
+
+export interface ApplicationDetailsDTO extends ApplicationInfosDTO {
+    languages: LanguageInfosDTO[];
+}

package/models/applications/applicationInfos.ts

@@ -0,0 +1,29 @@
+export class ApplicationInfos {
+    id: string;
+    fallbackLanguageCode: string;
+    logoId?: string;
+    logoBlurHash?: string;
+    logoHeight?: string;
+    logoWidth?: string;
+    label: string;
+
+    constructor(params: ApplicationInfosDTO) {
+        this.id = params.id;
+        this.fallbackLanguageCode = params.fallbackLanguageCode;
+        this.logoId = params.logoId;
+        this.logoBlurHash = params.logoBlurHash;
+        this.logoHeight = params.logoHeight;
+        this.logoWidth = params.logoWidth;
+        this.label = params.label;
+    }
+}
+
+export interface ApplicationInfosDTO {
+    id: string;
+    fallbackLanguageCode: string;
+    logoId?: string;
+    logoBlurHash?: string;
+    logoHeight?: string;
+    logoWidth?: string;
+    label: string;
+}

package/models/applications/index.ts

@@ -0,0 +1,2 @@
+export * from "./applicationDetails";
+export * from "./applicationInfos";

package/models/articles/articleDetails.ts

@@ -0,0 +1,27 @@
+import { ArticleInfos, ArticleInfosDTO } from "./articleInfos";
+
+export class ArticleDetails extends ArticleInfos {
+    manufacturerId: string;
+    familyId: string;
+    familyLabel: string;
+    code: string;
+    description: string;
+    
+    constructor(params: ArticleDetailsDTO) {
+        super(params);
+
+        this.manufacturerId = params.manufacturerId;
+        this.familyId = params.familyId;
+        this.familyLabel = params.familyLabel;
+        this.code = params.code;
+        this.description = params.description;
+    }
+}
+
+export interface ArticleDetailsDTO extends ArticleInfosDTO {
+    manufacturerId: string;
+    familyId: string;
+    familyLabel: string;
+    code: string;
+    description: string;
+}

package/models/articles/articleInfos.ts

@@ -0,0 +1,30 @@
+export class ArticleInfos {
+    id: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    label: string;
+    
+    constructor(params: ArticleInfosDTO) {
+        this.id = params.id;
+        this.label = params.label;
+        this.imageId = params.imageId;
+        this.imageBlurHash = params.imageBlurHash;
+        this.imageHeight = params.imageHeight;
+        this.imageWidth = params.imageWidth;
+    }
+}
+
+export interface ArticleInfosDTO {
+    id: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    label: string;
+}
+
+export interface ArticleFilters {
+    search?: string;
+}

package/models/articles/index.ts

@@ -0,0 +1,2 @@
+export * from "./articleDetails";
+export * from "./articleInfos";

package/models/authTokens/authTokenDetails.ts

@@ -0,0 +1,20 @@
+import { AuthTokenInfos, AuthTokenInfosDTO } from "./authTokenInfos";
+
+export class AuthTokenDetails extends AuthTokenInfos {
+    token: string;
+
+    constructor(params: AuthTokenDetailsDTO) {
+        super(params);
+        this.token = params.token;
+    }
+}
+
+export interface AuthTokenDetailsDTO extends AuthTokenInfosDTO {
+    token: string;
+}
+
+export interface CreateAuthTokenDTO {
+    userId: string;
+    label: string;
+    lifetime: number;
+}

package/models/authTokens/authTokenInfos.ts

@@ -0,0 +1,27 @@
+export class AuthTokenInfos {
+    id: string;
+    userId?: string;
+    label: string;
+    creationDate: number;
+    dateMax: number;
+
+    constructor(params: AuthTokenInfosDTO) {
+        this.id = params.id;
+        this.userId = params.userId;
+        this.label = params.label;
+        this.creationDate = params.creationDate;
+        this.dateMax = params.dateMax;
+    }
+}
+
+export interface AuthTokenInfosDTO {
+    id: string;
+    userId?: string;
+    label: string;
+    creationDate: number;
+    dateMax: number;
+}
+
+export interface AuthTokenFilters {
+    userId?: string;
+}

package/models/authTokens/index.ts

@@ -0,0 +1,2 @@
+export * from "./authTokenDetails";
+export * from "./authTokenInfos";

package/models/connectivityAlerts/connectivityAlertDetails.ts

@@ -0,0 +1,10 @@
+import { ConnectivityAlertInfos, ConnectivityAlertInfosDTO } from "./connectivityAlertInfos";
+
+export class ConnectivityAlertDetails extends ConnectivityAlertInfos {
+    constructor(params: ConnectivityAlertDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface ConnectivityAlertDetailsDTO extends ConnectivityAlertInfosDTO {
+}

package/models/connectivityAlerts/connectivityAlertInfos.ts

@@ -0,0 +1,58 @@
+import { DeviceConnectivityInfos, DeviceConnectivityInfosDTO } from "../deviceConnectivities/deviceConnectivityInfos";
+import { AlertStatus } from "../enums/alertEnums";
+
+export class ConnectivityAlertInfos {
+  id: string;
+  deviceId: string;
+  organisationId: string;
+  deviceOrganisationId: string;
+  deviceOrganisationLabel: string;
+  deviceOrganisationImageId?: string;
+  deviceOrganisationImageBlurHash?: string;
+  deviceOrganisationImageHeight?: number;
+  deviceOrganisationImageWidth?: number;
+  deviceOrganisationConnectivity?: DeviceConnectivityInfos;
+  triggerProcessedTimestamp: number;
+  resolveProcessedTimestamp?: number;
+  status: AlertStatus;
+
+  constructor(params: ConnectivityAlertInfosDTO) {
+    this.id = params.id;
+    this.deviceId = params.deviceId;
+    this.organisationId = params.organisationId;
+    this.deviceOrganisationId = params.deviceOrganisationId;
+    this.deviceOrganisationLabel = params.deviceOrganisationLabel;
+    this.deviceOrganisationImageId = params.deviceOrganisationImageId;
+    this.deviceOrganisationImageBlurHash = params.deviceOrganisationImageBlurHash;
+    this.deviceOrganisationImageHeight = params.deviceOrganisationImageHeight;
+    this.deviceOrganisationImageWidth = params.deviceOrganisationImageWidth;
+    this.deviceOrganisationConnectivity = params.deviceOrganisationConnectivity != null ?
+      new DeviceConnectivityInfos({ ...params.deviceOrganisationConnectivity, id: params.deviceOrganisationId }) :
+      undefined;
+    this.triggerProcessedTimestamp = params.triggerProcessedTimestamp;
+    this.resolveProcessedTimestamp = params.resolveProcessedTimestamp;
+    this.status = params.status;
+  }
+}
+
+export interface ConnectivityAlertInfosDTO {
+  id: string;
+  deviceId: string;
+  organisationId: string;
+  deviceOrganisationId: string;
+  deviceOrganisationLabel: string;
+  deviceOrganisationImageId?: string;
+  deviceOrganisationImageBlurHash?: string;
+  deviceOrganisationImageHeight?: number;
+  deviceOrganisationImageWidth?: number;
+  deviceOrganisationConnectivity?: DeviceConnectivityInfosDTO;
+  triggerProcessedTimestamp: number;
+  resolveProcessedTimestamp?: number;
+  status: AlertStatus;
+}
+
+export interface ConnectivityAlertFilters {
+  deviceOrganisationId?: string;
+  startDate?: string;
+  endDate?: string;
+}

package/models/connectivityAlerts/index.ts

@@ -0,0 +1,2 @@
+export * from "./connectivityAlertDetails";
+export * from "./connectivityAlertInfos";

package/models/customProperties/customPropertyColor.ts

@@ -0,0 +1,22 @@
+import { FilterType } from "../enums/sharedEnums";
+
+export class CustomPropertyColor {
+    priority: number;
+    filterType: FilterType;
+    filterValues: string[];
+    color: string;
+
+    constructor(params: CustomPropertyColorDTO) {
+        this.priority = params.priority;
+        this.filterType = params.filterType;
+        this.filterValues = params.filterValues.slice();
+        this.color = params.color;
+    }
+}
+
+export interface CustomPropertyColorDTO {
+    priority: number;
+    filterType: FilterType;
+    filterValues: string[];
+    color: string;
+}

package/models/customProperties/customPropertyDetails.ts

@@ -0,0 +1,11 @@
+import { CustomPropertyInfos, CustomPropertyInfosDTO } from "./customPropertyInfos";
+
+export class CustomPropertyDetails extends CustomPropertyInfos {
+    constructor(params: CustomPropertyDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface CustomPropertyDetailsDTO extends CustomPropertyInfosDTO {
+    description: string;
+}

package/models/customProperties/customPropertyInfos.ts

@@ -0,0 +1,68 @@
+import { CustomPropertyColor, CustomPropertyColorDTO } from "./customPropertyColor";
+import { PropertyDataType, PropertyEntity } from "../enums/customPropertyEnums";
+
+export class CustomPropertyInfos {
+    id: string;
+    code: string;
+    label: string;
+    categoryLabel: string;
+    index: number;
+    entity: PropertyEntity;
+    dataType: PropertyDataType;
+    addInInfos: boolean;
+    readOnlyCore: boolean;
+    readOnlyAdmin: boolean;
+    defaultValue: string;
+    history: boolean;
+    historySize: number;
+    colorful: boolean;
+    colorMap: CustomPropertyColor[];
+    useOnlyAllowedValues: boolean;
+    allowedValues: { [key: string]: string };
+  
+    constructor(params: CustomPropertyInfosDTO) {
+      this.id = params.id;
+      this.code = params.code;
+      this.label = params.label;
+      this.categoryLabel = params.categoryLabel;
+      this.index = params.index;
+      this.entity = params.entity;
+      this.dataType = params.dataType;
+      this.addInInfos = params.addInInfos;
+      this.readOnlyCore = params.readOnlyCore;
+      this.readOnlyAdmin = params.readOnlyAdmin;
+      this.defaultValue = params.defaultValue;
+      this.history = params.history;
+      this.historySize = params.historySize;
+      this.colorful = params.colorful;
+      this.colorMap = params.colorMap.map(dto => new CustomPropertyColor(dto));
+      this.useOnlyAllowedValues = params.useOnlyAllowedValues;
+      this.allowedValues = { ...params.allowedValues };
+    }
+  }
+  
+  export interface CustomPropertyInfosDTO {
+    id: string;
+    code: string;
+    label: string;
+    categoryLabel: string;
+    index: number;
+    entity: number;
+    dataType: number;
+    addInInfos: boolean;
+    readOnlyCore: boolean;
+    readOnlyAdmin: boolean;
+    defaultValue: string;
+    history: boolean;
+    historySize: number;
+    colorful: boolean;
+    colorMap: CustomPropertyColorDTO[];
+    useOnlyAllowedValues: boolean;
+    allowedValues: { [key: string]: string };
+  }
+  
+  export interface CustomPropertyFilters {
+    entities?: PropertyEntity[];
+    editableCore?: boolean;
+    search?: string;
+  }

package/models/customProperties/index.ts

@@ -0,0 +1,3 @@
+export * from "./customPropertyColor";
+export * from "./customPropertyDetails";
+export * from "./customPropertyInfos";

package/models/customPropertyValues/customPropertyValueDetails.ts

@@ -0,0 +1,10 @@
+import { CustomPropertyValueInfos, CustomPropertyValueInfosDTO } from "./customPropertyValueInfos";
+
+export class CustomPropertyValueDetails extends CustomPropertyValueInfos {
+    constructor(params: CustomPropertyValueDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface CustomPropertyValueDetailsDTO extends CustomPropertyValueInfosDTO {
+}

package/models/customPropertyValues/customPropertyValueInfos.ts

@@ -0,0 +1,14 @@
+export class CustomPropertyValueInfos {
+    value: string;
+    timestamp?: number;
+
+    constructor(params: CustomPropertyValueInfosDTO) {
+        this.value = params.value;
+        this.timestamp = params.timestamp;
+    }
+}
+
+export interface CustomPropertyValueInfosDTO {
+    value: string;
+    timestamp?: number;
+}

package/models/customPropertyValues/index.ts

@@ -0,0 +1,2 @@
+export * from "./customPropertyValueDetails";
+export * from "./customPropertyValueInfos";

package/models/dataCategories/dataCategoryDetails.ts

@@ -0,0 +1,10 @@
+import { DataCategoryInfos, DataCategoryInfosDTO } from "./dataCategoryInfos";
+
+export class DataCategoryDetails extends DataCategoryInfos {
+  constructor(params: DataCategoryDetailsDTO) {
+    super(params);
+  }
+}
+
+export interface DataCategoryDetailsDTO extends DataCategoryInfosDTO {
+}

package/models/dataCategories/dataCategoryInfos.ts

@@ -0,0 +1,29 @@
+export class DataCategoryInfos {
+    id: string;
+    modelId: string;
+    code: string;
+    label: string;
+    correlated: boolean;
+  
+    constructor(params: DataCategoryInfosDTO) {
+      this.id = params.id;
+      this.modelId = params.modelId;
+      this.code = params.code;
+      this.label = params.label;
+      this.correlated = params.correlated;
+    }
+  }
+  
+  export interface DataCategoryInfosDTO {
+    id: string;
+    modelId: string;
+    code: string;
+    label: string;
+    correlated: boolean;
+  }
+  
+  export interface DataCategoryFilters {
+    modelId?: string;
+    correlated?: boolean;
+    search?: string;
+  }

package/models/dataCategories/index.ts

@@ -0,0 +1,2 @@
+export * from "./dataCategoryDetails";
+export * from "./dataCategoryInfos";

package/models/dataDefinitionMappings/dataDefinitionMappingDetails.ts

@@ -0,0 +1,10 @@
+import { DataDefinitionMappingInfos, DataDefinitionMappingInfosDTO } from "./dataDefinitionMappingInfos";
+
+export class DataDefinitionMappingDetails extends DataDefinitionMappingInfos {
+    constructor(params: DataDefinitionMappingDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface DataDefinitionMappingDetailsDTO extends DataDefinitionMappingInfosDTO {
+}

package/models/dataDefinitionMappings/dataDefinitionMappingInfos.ts

@@ -0,0 +1,17 @@
+export class DataDefinitionMappingInfos {
+    id: string;
+    inputValue: string;
+    outputValue: string;
+  
+    constructor(params: DataDefinitionMappingInfosDTO) {
+      this.id = params.id;
+      this.inputValue = params.inputValue;
+      this.outputValue = params.outputValue;
+    }
+  }
+  
+  export interface DataDefinitionMappingInfosDTO {
+    id: string;
+    inputValue: string;
+    outputValue: string;
+  }

package/models/dataDefinitionMappings/index.ts

@@ -0,0 +1,2 @@
+export * from "./dataDefinitionMappingDetails";
+export * from "./dataDefinitionMappingInfos";

package/models/dataDefinitions/dataDefinitionDetails.ts

@@ -0,0 +1,10 @@
+import { DataDefinitionInfos, DataDefinitionInfosDTO } from "./dataDefinitionInfos";
+
+export class DataDefinitionDetails extends DataDefinitionInfos {
+    constructor(params: DataDefinitionDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface DataDefinitionDetailsDTO extends DataDefinitionInfosDTO {
+}