@dative-gpi/foundation-core-domain 0.0.2

package/models/groups/groupInfos.ts

@@ -0,0 +1,72 @@
+import { PathCrumb, PathCrumbDTO } from "../shared/pathCrumb";
+
+export class GroupInfos {
+    id: string;
+    organisationId: string;
+    parentId?: string;
+    imageId?: string;
+    imageBlurHash: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    icon: string;
+    code: string;
+    label: string;
+    tags: string[];
+    path: PathCrumb[];
+    groupsIds: string[];
+    deviceOrganisationsIds: string[];
+    modelsIds: string[];
+    recursiveGroupsIds: string[];
+    recursiveDeviceOrganisationsIds: string[];
+    recursiveModelsIds: string[];
+
+    constructor(params: GroupInfosDTO) {
+        this.id = params.id;
+        this.organisationId = params.organisationId;
+        this.parentId = params.parentId;
+        this.imageId = params.imageId;
+        this.imageBlurHash = params.imageBlurHash;
+        this.imageHeight = params.imageHeight;
+        this.imageWidth = params.imageWidth;
+        this.icon = params.icon;
+        this.code = params.code;
+        this.label = params.label;
+        this.tags = params.tags;
+        this.path = params.path.map(dto => new PathCrumb({ ...dto })).sort((a, b) => b.index - a.index);
+        this.groupsIds = params.groupsIds.slice();
+        this.deviceOrganisationsIds = params.deviceOrganisationsIds.slice();
+        this.modelsIds = params.modelsIds.slice();
+        this.recursiveGroupsIds = params.recursiveGroupsIds.slice();
+        this.recursiveDeviceOrganisationsIds = params.recursiveDeviceOrganisationsIds.slice();
+        this.recursiveModelsIds = params.recursiveModelsIds.slice();
+    }
+}
+
+export interface GroupInfosDTO {
+    id: string;
+    organisationId: string;
+    parentId?: string;
+    imageId?: string;
+    imageBlurHash: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    icon: string;
+    code: string;
+    label: string;
+    tags: string[];
+    path: PathCrumbDTO[];
+    groupsIds: string[];
+    deviceOrganisationsIds: string[];
+    modelsIds: string[];
+    recursiveGroupsIds: string[];
+    recursiveDeviceOrganisationsIds: string[];
+    recursiveModelsIds: string[];
+}
+
+export interface GroupFilters {
+    parentId?: string;
+    root?: boolean;
+    modelsIds?: string[];
+    groupsIds?: string[];
+    search?: string;
+}

package/models/groups/index.ts

@@ -0,0 +1,2 @@
+export * from "./groupDetails";
+export * from "./groupInfos";

package/models/index.ts

@@ -0,0 +1,32 @@
+export * from "./alerts";
+export * from "./applications";
+export * from "./articles";
+export * from "./authTokens";
+export * from "./connectivityAlerts";
+export * from "./customProperties";
+export * from "./customPropertyValues";
+export * from "./dataCategories";
+export * from "./dataDefinitions";
+export * from "./dataDefinitionMappings"; // No service
+export * from "./deviceConnectivities";
+export * from "./deviceOrganisations";
+export * from "./deviceStatuses";
+export * from "./enums";                  // No service
+export * from "./families";
+export * from "./groups";
+export * from "./languages";
+export * from "./locations";
+export * from "./manufacturers";
+export * from "./models";
+export * from "./modelStatuses";          // No service
+export * from "./organisations";
+export * from "./organisationTypes";
+export * from "./permissionCategories";
+export * from "./permissions";
+export * from "./roleOrganisations";
+export * from "./roleOrganisationTypes";
+export * from "./shared";                 // No service
+export * from "./timeZones";
+export * from "./translations";
+export * from "./userOrganisations";
+export * from "./users";

package/models/languages/index.ts

@@ -0,0 +1,2 @@
+export * from "./languageDetails";
+export * from "./languageInfos";

package/models/languages/languageDetails.ts

@@ -0,0 +1,10 @@
+import { LanguageInfos, LanguageInfosDTO } from "./languageInfos";
+
+export class LanguageDetails extends LanguageInfos {
+    constructor(params: LanguageDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface LanguageDetailsDTO extends LanguageInfosDTO {
+}

package/models/languages/languageInfos.ts

@@ -0,0 +1,24 @@
+export class LanguageInfos {
+    id: string;
+    icon: string;
+    code: string;
+    label: string;
+  
+    constructor(params: LanguageInfosDTO) {
+      this.id = params.id;
+      this.icon = params.icon;
+      this.code = params.code;
+      this.label = params.label;
+    }
+  }
+  
+  export interface LanguageInfosDTO {
+    id: string;
+    icon: string;
+    code: string;
+    label: string;
+  }
+
+  export interface LanguageFilters {
+    search?: string;
+  }

package/models/locations/address.ts

@@ -0,0 +1,29 @@
+export class Address {
+    placeId: string;
+    placeLabel: string;
+    formattedAddress: string;
+    locality: string;
+    country: string;
+    latitude: number;
+    longitude: number;
+
+    constructor(params: AddressDTO) {
+        this.placeId = params.placeId;
+        this.placeLabel = params.placeLabel;
+        this.formattedAddress = params.formattedAddress;
+        this.locality = params.locality;
+        this.country = params.country;
+        this.latitude = params.latitude;
+        this.longitude = params.longitude;
+    }
+}
+
+export interface AddressDTO {
+    placeId: string;
+    placeLabel: string;
+    formattedAddress: string;
+    locality: string;
+    country: string;
+    latitude: number;
+    longitude: number;
+}

package/models/locations/index.ts

@@ -0,0 +1,3 @@
+export * from "./address";
+export * from "./locationDetails";
+export * from "./locationInfos";

package/models/locations/locationDetails.ts

@@ -0,0 +1,35 @@
+import { LocationInfos, LocationInfosDTO } from "./locationInfos";
+import { AddressDTO } from "./address";
+
+export class LocationDetails extends LocationInfos {
+    description: string;
+
+    constructor(params: LocationDetailsDTO) {
+        super(params);
+
+        this.description = params.description;
+    }
+}
+
+export interface LocationDetailsDTO extends LocationInfosDTO {
+    description: string;
+}
+
+
+export interface CreateLocationDTO {
+    icon: string;
+    code: string;
+    label: string;
+    description: string;
+    tags: string[];
+    address?: AddressDTO;
+}
+
+export interface UpdateLocationDTO {
+    icon: string;
+    code: string;
+    label: string;
+    description: string;
+    tags: string[];
+    address?: AddressDTO;
+}

package/models/locations/locationInfos.ts

@@ -0,0 +1,46 @@
+import { Address, AddressDTO } from "./address";
+
+export class LocationInfos {
+    id: string;
+    organisationId: string;
+    icon: string;
+    code: string;
+    label: string;
+    tags: string[];
+    address: Address;
+    modelsIds: string[];
+    deviceOrganisationsIds: string[];
+    deviceOrganisationsCount: number;
+
+    constructor(params: LocationInfosDTO) {
+        this.id = params.id;
+        this.organisationId = params.organisationId;
+        this.icon = params.icon;
+        this.code = params.code;
+        this.label = params.label;
+        this.tags = params.tags.slice();
+        this.address = new Address(params.address);
+        this.modelsIds = params.modelsIds.slice();
+        this.deviceOrganisationsIds = params.deviceOrganisationsIds.slice();
+        this.deviceOrganisationsCount = params.deviceOrganisationsCount;
+    }
+}
+
+export class LocationInfosDTO {
+    id: string;
+    organisationId: string;
+    icon: string;
+    code: string;
+    label: string;
+    tags: string[];
+    address: AddressDTO;
+    modelsIds: string[];
+    deviceOrganisationsIds: string[];
+    deviceOrganisationsCount: number;
+}
+
+export interface LocationFilters {
+    locationsIds?: string[];
+    modelsIds?: string[];
+    search?: string;
+}

package/models/manufacturers/index.ts

@@ -0,0 +1,2 @@
+export * from "./manufacturerDetails";
+export * from "./manufacturerInfos";

package/models/manufacturers/manufacturerDetails.ts

@@ -0,0 +1,15 @@
+import { ManufacturerInfos, ManufacturerInfosDTO } from "./manufacturerInfos";
+
+export class ManufacturerDetails extends ManufacturerInfos {
+    description: string;
+
+    constructor(params: ManufacturerDetailsDTO) {
+        super(params);
+
+        this.description = params.description;
+    }
+}
+
+export interface ManufacturerDetailsDTO extends ManufacturerInfosDTO {
+    description: string;
+}

package/models/manufacturers/manufacturerInfos.ts

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

package/models/modelStatuses/index.ts

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

package/models/modelStatuses/modelStatus.ts

@@ -0,0 +1,53 @@
+export class ModelStatus {
+    id: string;
+    modelId: string;
+    dataCategoryId: string;
+    dataCategoryLabel: string;
+    dataDefinitionId: string;
+    dataDefinitionLabel: string;
+    groupById: string;
+    groupByLabel: string;
+    label: string;
+    index: number;
+    lifetime: number;
+    timeToLive: number;
+    showDefault: boolean;
+    iconDefault: string;
+    colorDefault: string;
+  
+    constructor(params: ModelStatusDTO) {
+        this.id = params.id;
+        this.modelId = params.modelId;
+        this.dataCategoryId = params.dataCategoryId;
+        this.dataCategoryLabel = params.dataCategoryLabel;
+        this.dataDefinitionId = params.dataDefinitionId;
+        this.dataDefinitionLabel = params.dataDefinitionLabel;
+        this.groupById = params.groupById;
+        this.groupByLabel = params.groupByLabel;
+        this.label = params.label;
+        this.index = params.index;
+        this.lifetime = params.lifetime;
+        this.timeToLive = params.timeToLive;
+        this.showDefault = params.showDefault;
+        this.iconDefault = params.iconDefault;
+        this.colorDefault = params.colorDefault;
+    }
+}
+  
+export interface ModelStatusDTO {
+    id: string;
+    modelId: string;
+    dataCategoryId: string;
+    dataCategoryLabel: string;
+    dataDefinitionId: string;
+    dataDefinitionLabel: string;
+    groupById: string;
+    groupByLabel: string;
+    label: string;
+    index: number;
+    lifetime: number;
+    timeToLive: number;
+    showDefault: boolean;
+    iconDefault: string;
+    colorDefault: string;
+}

package/models/models/index.ts

@@ -0,0 +1,2 @@
+export * from "./modelDetails";
+export * from "./modelInfos";

package/models/models/modelDetails.ts

@@ -0,0 +1,10 @@
+import { ModelInfos, ModelInfosDTO } from "./modelInfos";
+
+export class ModelDetails extends ModelInfos {
+    constructor(params: ModelDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface ModelDetailsDTO extends ModelInfosDTO {
+}

package/models/models/modelInfos.ts

@@ -0,0 +1,43 @@
+export class ModelInfos {
+    id: string;
+    manufacturerId: string;
+    manufacturerLabel: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    code: string;
+    label: string;
+    connectable: boolean;
+
+    constructor(params: ModelInfosDTO) {
+        this.id = params.id;
+        this.manufacturerId = params.manufacturerId;
+        this.manufacturerLabel = params.manufacturerLabel;
+        this.imageId = params.imageId;
+        this.imageBlurHash = params.imageBlurHash;
+        this.imageHeight = params.imageHeight;
+        this.imageWidth = params.imageWidth;
+        this.code = params.code;
+        this.label = params.label;
+        this.connectable = params.connectable;
+    }
+}
+
+export interface ModelInfosDTO {
+    id: string;
+    manufacturerId: string;
+    manufacturerLabel: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    code: string;
+    label: string;
+    connectable: boolean;
+}
+
+export interface ModelFilters {
+    modelsIds?: string[];
+    search?: string;
+}

package/models/organisationTypes/index.ts

@@ -0,0 +1,2 @@
+export * from "./organisationTypeDetails";
+export * from "./organisationTypeInfos";

package/models/organisationTypes/organisationTypeDetails.ts

@@ -0,0 +1,21 @@
+import { OrganisationTypeInfos, OrganisationTypeInfosDTO } from "./organisationTypeInfos";
+import { DashboardType } from "../enums/dashboardEnums";
+
+export class OrganisationTypeDetails extends OrganisationTypeInfos {
+    description: string;
+
+    constructor(params: OrganisationTypeDetailsDTO) {
+        super(params);
+
+        this.description = params.description;
+    }
+}
+
+export interface OrganisationTypeDetailsDTO extends OrganisationTypeInfosDTO  {
+    description: string;
+}
+
+export interface ChangeOrganisationTypeDashboardDTO {
+    mainDashboardId?: string;
+    mainDashboardType: DashboardType;
+}

package/models/organisationTypes/organisationTypeInfos.ts

@@ -0,0 +1,29 @@
+import { DashboardType } from "../enums/dashboardEnums";
+
+export class OrganisationTypeInfos {
+  id: string;
+  mainDashboardId?: string;
+  mainDashboardType: DashboardType;
+  code: string;
+  label: string;
+
+  constructor(params: OrganisationTypeInfosDTO) {
+    this.id = params.id;
+    this.mainDashboardId = params.mainDashboardId;
+    this.mainDashboardType = params.mainDashboardType;
+    this.code = params.code;
+    this.label = params.label;
+  }
+}
+
+export interface OrganisationTypeInfosDTO {
+  id: string;
+  mainDashboardId?: string;
+  mainDashboardType: DashboardType;
+  code: string;
+  label: string;
+}
+
+export interface OrganisationTypeFilters {
+  search?: string;
+}

package/models/organisations/index.ts

@@ -0,0 +1,2 @@
+export * from "./organisationDetails";
+export * from "./organisationInfos";

package/models/organisations/organisationDetails.ts

@@ -0,0 +1,53 @@
+import { PermissionInfos, PermissionInfosDTO } from "../permissions/permissionInfos";
+import { OrganisationInfos, OrganisationInfosDTO } from "./organisationInfos";
+import { DashboardType } from "../enums/dashboardEnums";
+
+export class OrganisationDetails extends OrganisationInfos {
+    organisationTypeId: string;
+    mainDashboardId?: string;
+    mainDashboardType: DashboardType;
+    adminId: string;
+    adminName: string;
+    description: string;
+    locationsCount: number;
+    deviceOrganisationsCount: number;
+    permissions: PermissionInfos[];
+
+    constructor(params: OrganisationDetailsDTO) {
+        super(params);
+
+        this.organisationTypeId = params.organisationTypeId;
+        this.mainDashboardType = params.mainDashboardType;
+        this.mainDashboardId = params.mainDashboardId;
+        this.adminId = params.adminId;
+        this.adminName = params.adminName;
+        this.description = params.description;
+        this.locationsCount = params.locationsCount;
+        this.deviceOrganisationsCount = params.deviceOrganisationsCount;
+        this.permissions = params.permissions.map(dto => new PermissionInfos(dto));
+    }
+}
+
+export interface OrganisationDetailsDTO extends OrganisationInfosDTO {
+    organisationTypeId: string;
+    mainDashboardId?: string;
+    mainDashboardType: DashboardType;
+    adminId: string;
+    adminName: string;
+    description: string;
+    locationsCount: number;
+    deviceOrganisationsCount: number;
+    permissions: PermissionInfosDTO[];
+}
+
+export interface UpdateOrganisationDTO {
+    imageId?: string;
+    image?: string;
+    label: string;
+    description: string;
+}
+
+export interface ChangeOrganisationDashboardDTO {
+    mainDashboardId?: string;
+    mainDashboardType: DashboardType;
+}

package/models/organisations/organisationInfos.ts

@@ -0,0 +1,33 @@
+export class OrganisationInfos {
+    id: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    label: string;
+    userOrganisationsCount: number;
+
+    constructor(params: OrganisationInfosDTO) {
+        this.id = params.id;
+        this.imageId = params.imageId;
+        this.imageBlurHash = params.imageBlurHash;
+        this.imageHeight = params.imageHeight;
+        this.imageWidth = params.imageWidth;
+        this.label = params.label;
+        this.userOrganisationsCount = params.userOrganisationsCount;
+    }
+}
+
+export interface OrganisationInfosDTO {
+    id: string;
+    imageId?: string;
+    imageBlurHash?: string;
+    imageHeight?: number;
+    imageWidth?: number;
+    label: string;
+    userOrganisationsCount: number;
+}
+
+export interface OrganisationFilters {
+    search?: string;
+}

package/models/permissionCategories/index.ts

@@ -0,0 +1,2 @@
+export * from "./permissionCategoryDetails";
+export * from "./permissionCategoryInfos";

package/models/permissionCategories/permissionCategoryDetails.ts

@@ -0,0 +1,10 @@
+import { PermissionCategoryInfos, PermissionCategoryInfosDTO } from "./permissionCategoryInfos";
+
+export class PermissionCategoryDetails extends PermissionCategoryInfos {
+    constructor(params: PermissionCategoryDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface PermissionCategoryDetailsDTO extends PermissionCategoryInfosDTO {
+}

package/models/permissionCategories/permissionCategoryInfos.ts

@@ -0,0 +1,24 @@
+export class PermissionCategoryInfos {
+    id: string;
+    code: string;
+    label: string;
+    prefix: string;
+
+    constructor(params: PermissionCategoryInfosDTO) {
+        this.id = params.id;
+        this.code = params.code;
+        this.label = params.label;
+        this.prefix = params.prefix;
+    }
+}
+
+export interface PermissionCategoryInfosDTO {
+    id: string;
+    code: string;
+    label: string;
+    prefix: string;
+}
+
+export interface PermissionCategoryFilters {
+    search?: string;
+}

package/models/permissions/index.ts

@@ -0,0 +1,2 @@
+export * from "./permissionDetails";
+export * from "./permissionInfos";

package/models/permissions/permissionDetails.ts

@@ -0,0 +1,10 @@
+import { PermissionInfos, PermissionInfosDTO } from "./permissionInfos";
+
+export class PermissionDetails extends PermissionInfos {
+    constructor(params: PermissionDetailsDTO) {
+        super(params);
+    }
+}
+
+export interface PermissionDetailsDTO extends PermissionInfosDTO {
+}

package/models/permissions/permissionInfos.ts

@@ -0,0 +1,17 @@
+export class PermissionInfos {
+    id: string;
+    code: string;
+    label: string;
+
+    constructor(params: PermissionInfosDTO) {
+        this.id = params.id;
+        this.code = params.code;
+        this.label = params.label;
+    }
+}
+
+export interface PermissionInfosDTO {
+    id: string;
+    code: string;
+    label: string;
+}

package/models/roleOrganisationTypes/index.ts

@@ -0,0 +1,2 @@
+export * from "./roleOrganisationTypeDetails";
+export * from "./roleOrganisationTypeInfos";

package/models/roleOrganisationTypes/roleOrganisationTypeDetails.ts

@@ -0,0 +1,15 @@
+import { RoleOrganisationTypeInfos, RoleOrganisationTypeInfosDTO } from "./roleOrganisationTypeInfos";
+
+export class RoleOrganisationTypeDetails extends RoleOrganisationTypeInfos {
+    description: string;
+
+    constructor(params: RoleOrganisationTypeDetailsDTO) {
+        super(params);
+
+        this.description = params.description;
+    }
+}
+
+export interface RoleOrganisationTypeDetailsDTO extends RoleOrganisationTypeInfosDTO {
+    description: string;
+}