@dangl/ava-model 2.29.3 → 2.30.0-beta0002

package/dist/ava-model/index.d.ts

@@ -441,6 +441,8 @@ declare class ServiceSpecificationDto implements IServiceSpecificationDto {
     projectCatalogues?: CatalogueDto[] | undefined;
     /** Referenced catalogues for this ElementContainerBase. */
     catalogueReferences?: CatalogueReferenceDto[] | undefined;
+    /** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
+    sustainabilityCatalogues?: SustainabilityCatalogueDto[] | undefined;
     /** The date when the execution of the services is scheduled to start */
     plannedExecutionStart?: Date | undefined;
     /** The date then the execution of the services is scheduled to be finished */
@@ -457,7 +459,7 @@ declare class ServiceSpecificationDto implements IServiceSpecificationDto {
     approvalDate?: Date | undefined;
     /** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
     typeOfApproval?: string | undefined;
-    /** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
+    /** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
     addendumNumber?: string | undefined;
     /** This indicates, if this element is part of an addendum an, if yes, with what status. */
     addendumStatus?: AddendumStatusDto | undefined;
@@ -550,6 +552,8 @@ interface IServiceSpecificationDto {
     projectCatalogues?: ICatalogueDto[] | undefined;
     /** Referenced catalogues for this ElementContainerBase. */
     catalogueReferences?: ICatalogueReferenceDto[] | undefined;
+    /** This is a list of sustainability catalogues that are relevant for this ServiceSpecification. Sustainability catalogues are sources for environmental or sustainability data. */
+    sustainabilityCatalogues?: ISustainabilityCatalogueDto[] | undefined;
     /** The date when the execution of the services is scheduled to start */
     plannedExecutionStart?: Date | undefined;
     /** The date then the execution of the services is scheduled to be finished */
@@ -566,7 +570,7 @@ interface IServiceSpecificationDto {
     approvalDate?: Date | undefined;
     /** This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB */
     typeOfApproval?: string | undefined;
-    /** This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
+    /** This optional string property is shared by all IElement s, and indicates if the element is part of an addendum, a 'Nachtrag' in German. */
     addendumNumber?: string | undefined;
     /** This indicates, if this element is part of an addendum an, if yes, with what status. */
     addendumStatus?: AddendumStatusDto | undefined;
@@ -711,6 +715,8 @@ declare class PositionDto extends IElementDto implements IPositionDto {
     comissionStatus: ComissionStatusDto;
     /** A list of positions that complement this Position. The positions are referenced by their GUIDs. It might be used together with ComplementedByQuantities in case that only a given quantity is complemented by positions. */
     complementedBy?: string[] | undefined;
+    /** This list contains information about sustainability indicators or environmental impact for this position. */
+    sustainabilityIndicators?: PositionSustainabilityIndicatorDto[] | undefined;
     /** Will indicate if this Position is complemented in this ServiceSpecification by other Positions. It can not be set to false when there are entries in the ComplementedBy property. */
     complemented: boolean;
     /** Indicates that the amount for this Position is to be set by the bidder. */
@@ -844,6 +850,8 @@ interface IPositionDto extends IIElementDto {
     comissionStatus: ComissionStatusDto;
     /** A list of positions that complement this Position. The positions are referenced by their GUIDs. It might be used together with ComplementedByQuantities in case that only a given quantity is complemented by positions. */
     complementedBy?: string[] | undefined;
+    /** This list contains information about sustainability indicators or environmental impact for this position. */
+    sustainabilityIndicators?: IPositionSustainabilityIndicatorDto[] | undefined;
     /** Will indicate if this Position is complemented in this ServiceSpecification by other Positions. It can not be set to false when there are entries in the ComplementedBy property. */
     complemented: boolean;
     /** Indicates that the amount for this Position is to be set by the bidder. */
@@ -1236,6 +1244,70 @@ declare enum ComissionStatusDto {
     Postponed = "Postponed",
     Removed = "Removed"
 }
+/** This model contains the sustainability or environment impact data. */
+declare class PositionSustainabilityIndicatorDto implements IPositionSustainabilityIndicatorDto {
+    /** Elements GUID identifier. */
+    id: string;
+    /** This is usually in the form of an URL that specifies the indicator. */
+    source?: string | undefined;
+    /** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
+    comment?: string | undefined;
+    /** If present, this indicator may be divided up into different life cycle stages. */
+    lifeCycleStages?: SustainabilityLifeCycleStageDto[] | undefined;
+    /** This is a key that specifies the type of indicator. It is not used for any calculations but can be used to identify the indicator type, e.g. "carbonFootprint", "waterConsumption" or similar. The actual value of this property is not defined in the library and can be set freely, but it is recommended to use a consistent naming scheme, e.g. by using URLs or IRIs to avoid conflicts. In GAEB XML, it has a max length of 50 characters. */
+    indicatorKey?: string | undefined;
+    /** This is the actual value of the indicator. */
+    value?: number | undefined;
+    /** The unit of measurement for the value. */
+    unitTag?: string | undefined;
+    /** If present, this is a conversion factor used here in this indicator for the value. */
+    conversionFactor?: number | undefined;
+    constructor(data?: IPositionSustainabilityIndicatorDto);
+    init?(_data?: any): void;
+    static fromJS(data: any): PositionSustainabilityIndicatorDto;
+    toJSON?(data?: any): any;
+}
+/** This model contains the sustainability or environment impact data. */
+interface IPositionSustainabilityIndicatorDto {
+    /** Elements GUID identifier. */
+    id: string;
+    /** This is usually in the form of an URL that specifies the indicator. */
+    source?: string | undefined;
+    /** This is a text giving more information about the indicator, e.g. details about the calculation method, or other comments. */
+    comment?: string | undefined;
+    /** If present, this indicator may be divided up into different life cycle stages. */
+    lifeCycleStages?: ISustainabilityLifeCycleStageDto[] | undefined;
+    /** This is a key that specifies the type of indicator. It is not used for any calculations but can be used to identify the indicator type, e.g. "carbonFootprint", "waterConsumption" or similar. The actual value of this property is not defined in the library and can be set freely, but it is recommended to use a consistent naming scheme, e.g. by using URLs or IRIs to avoid conflicts. In GAEB XML, it has a max length of 50 characters. */
+    indicatorKey?: string | undefined;
+    /** This is the actual value of the indicator. */
+    value?: number | undefined;
+    /** The unit of measurement for the value. */
+    unitTag?: string | undefined;
+    /** If present, this is a conversion factor used here in this indicator for the value. */
+    conversionFactor?: number | undefined;
+}
+/** This model represents the life cycle stages for sustainability indicators. For example, for a carbon footprint indicator, you could specify the carbon footprint for the production stage, the transportation stage and the disposal stage of a service or product. */
+declare class SustainabilityLifeCycleStageDto implements ISustainabilityLifeCycleStageDto {
+    /** Elements GUID identifier. */
+    id: string;
+    /** The key is the name or identifier of the stage. */
+    key?: string | undefined;
+    /** The value for this given stage. */
+    value?: number | undefined;
+    constructor(data?: ISustainabilityLifeCycleStageDto);
+    init?(_data?: any): void;
+    static fromJS(data: any): SustainabilityLifeCycleStageDto;
+    toJSON?(data?: any): any;
+}
+/** This model represents the life cycle stages for sustainability indicators. For example, for a carbon footprint indicator, you could specify the carbon footprint for the production stage, the transportation stage and the disposal stage of a service or product. */
+interface ISustainabilityLifeCycleStageDto {
+    /** Elements GUID identifier. */
+    id: string;
+    /** The key is the name or identifier of the stage. */
+    key?: string | undefined;
+    /** The value for this given stage. */
+    value?: number | undefined;
+}
 /** This class represents as identifier of a certain service specification's element and is uniquely within the service specification. */
 declare class ItemNumberDto implements IItemNumberDto {
     /** Elements GUID identifier. */
@@ -2004,6 +2076,28 @@ interface ITradeDiscountDto {
     /** The rate of the trade discount. */
     rate: number;
 }
+/** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
+declare class SustainabilityCatalogueDto implements ISustainabilityCatalogueDto {
+    /** Elements GUID identifier. */
+    id: string;
+    /** The key must be a unique identifier for the sustainability catalogue. It is used to link sustainability data in positions to a catalogue. The Dangl.AVA module does not enforce uniqueness, but it is recommended to use a unique key for each catalogue. */
+    key?: string | undefined;
+    /** The description property can be used to provide further information about the sustainability catalogue. */
+    description?: string | undefined;
+    constructor(data?: ISustainabilityCatalogueDto);
+    init?(_data?: any): void;
+    static fromJS(data: any): SustainabilityCatalogueDto;
+    toJSON?(data?: any): any;
+}
+/** This elements represents a catalogue or source of sustainability information that is used within a ServiceSpecification. */
+interface ISustainabilityCatalogueDto {
+    /** Elements GUID identifier. */
+    id: string;
+    /** The key must be a unique identifier for the sustainability catalogue. It is used to link sustainability data in positions to a catalogue. The Dangl.AVA module does not enforce uniqueness, but it is recommended to use a unique key for each catalogue. */
+    key?: string | undefined;
+    /** The description property can be used to provide further information about the sustainability catalogue. */
+    description?: string | undefined;
+}
 /** This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g. 5 Months */
 declare class WarrantyDurationDto implements IWarrantyDurationDto {
     /** The scalar value of the duration. This value must be equal to or bigger than zero (>= 0). Negative values can not be set and will be ignored. */
@@ -2144,5 +2238,5 @@ declare const avaModelsVersion: {
     buildDateUtc: Date;
 };
 
-export { AddendumStatusDto, AdditionTypeDto, ArticleDataDto, AwardTypeDto, BankingInformationDto, CalculationDto, CatalogueDto, CatalogueReferenceDto, CatalogueTypeDto, ComissionStatusDto, CommerceInquiryTypeDto, CommercePropertiesDto, ComplementedByQuantityDto, DurationUnitDto, ExchangePhaseDto, ExecutionDescriptionDto, GrossPriceComponentDto, HoldOutDurationUnitDto, HoldOutTypeDto, IElementDto, ItemNumberDto, ItemNumberSchemaDto, ItemNumberSchemaTierAlignmentDto, ItemNumberSchemaTierDto, ItemNumberSchemaTierTypeDto, ItemNumberTypeDto, LabourPriceComponentDto, NoteTextDto, OenormNoteTextPropertiesDto, OenormOriginCodeDto, OenormPositionPropertiesDto, OenormPropertiesDto, OriginDto, PartyInformationDto, PositionComplementingTypeDto, PositionDto, PositionHoldOutPropertiesDto, PositionTypeDto, PriceCatalogueDataDto, PriceComponentDto, PriceComponentTypeDto, PriceInformationDto, PriceRoundingModeDto, PriceTypeDto, ProductDataDto, ProjectDto, ProjectInformationDto, QuantityAssignmentDto, STLBKeyDto, STLBReferenceDto, ServiceSpecificationCommercePropertiesDto, ServiceSpecificationDto, ServiceSpecificationGroupDto, ServiceTypeDto, SpecialAwardKindDto, StandardReferenceTypeDto, StandardizedDescriptionDto, SubDescriptionDto, TradeDiscountDto, WarrantyDurationDto, avaModelsVersion };
-export type { IArticleDataDto, IBankingInformationDto, ICalculationDto, ICatalogueDto, ICatalogueReferenceDto, ICommercePropertiesDto, IComplementedByQuantityDto, IExecutionDescriptionDto, IGrossPriceComponentDto, IIElementDto, IItemNumberDto, IItemNumberSchemaDto, IItemNumberSchemaTierDto, ILabourPriceComponentDto, INoteTextDto, IOenormNoteTextPropertiesDto, IOenormPositionPropertiesDto, IOenormPropertiesDto, IPartyInformationDto, IPositionDto, IPositionHoldOutPropertiesDto, IPriceCatalogueDataDto, IPriceComponentDto, IPriceInformationDto, IProductDataDto, IProjectDto, IProjectInformationDto, IQuantityAssignmentDto, ISTLBKeyDto, ISTLBReferenceDto, IServiceSpecificationCommercePropertiesDto, IServiceSpecificationDto, IServiceSpecificationGroupDto, IStandardizedDescriptionDto, ISubDescriptionDto, ITradeDiscountDto, IWarrantyDurationDto };
+export { AddendumStatusDto, AdditionTypeDto, ArticleDataDto, AwardTypeDto, BankingInformationDto, CalculationDto, CatalogueDto, CatalogueReferenceDto, CatalogueTypeDto, ComissionStatusDto, CommerceInquiryTypeDto, CommercePropertiesDto, ComplementedByQuantityDto, DurationUnitDto, ExchangePhaseDto, ExecutionDescriptionDto, GrossPriceComponentDto, HoldOutDurationUnitDto, HoldOutTypeDto, IElementDto, ItemNumberDto, ItemNumberSchemaDto, ItemNumberSchemaTierAlignmentDto, ItemNumberSchemaTierDto, ItemNumberSchemaTierTypeDto, ItemNumberTypeDto, LabourPriceComponentDto, NoteTextDto, OenormNoteTextPropertiesDto, OenormOriginCodeDto, OenormPositionPropertiesDto, OenormPropertiesDto, OriginDto, PartyInformationDto, PositionComplementingTypeDto, PositionDto, PositionHoldOutPropertiesDto, PositionSustainabilityIndicatorDto, PositionTypeDto, PriceCatalogueDataDto, PriceComponentDto, PriceComponentTypeDto, PriceInformationDto, PriceRoundingModeDto, PriceTypeDto, ProductDataDto, ProjectDto, ProjectInformationDto, QuantityAssignmentDto, STLBKeyDto, STLBReferenceDto, ServiceSpecificationCommercePropertiesDto, ServiceSpecificationDto, ServiceSpecificationGroupDto, ServiceTypeDto, SpecialAwardKindDto, StandardReferenceTypeDto, StandardizedDescriptionDto, SubDescriptionDto, SustainabilityCatalogueDto, SustainabilityLifeCycleStageDto, TradeDiscountDto, WarrantyDurationDto, avaModelsVersion };
+export type { IArticleDataDto, IBankingInformationDto, ICalculationDto, ICatalogueDto, ICatalogueReferenceDto, ICommercePropertiesDto, IComplementedByQuantityDto, IExecutionDescriptionDto, IGrossPriceComponentDto, IIElementDto, IItemNumberDto, IItemNumberSchemaDto, IItemNumberSchemaTierDto, ILabourPriceComponentDto, INoteTextDto, IOenormNoteTextPropertiesDto, IOenormPositionPropertiesDto, IOenormPropertiesDto, IPartyInformationDto, IPositionDto, IPositionHoldOutPropertiesDto, IPositionSustainabilityIndicatorDto, IPriceCatalogueDataDto, IPriceComponentDto, IPriceInformationDto, IProductDataDto, IProjectDto, IProjectInformationDto, IQuantityAssignmentDto, ISTLBKeyDto, ISTLBReferenceDto, IServiceSpecificationCommercePropertiesDto, IServiceSpecificationDto, IServiceSpecificationGroupDto, IStandardizedDescriptionDto, ISubDescriptionDto, ISustainabilityCatalogueDto, ISustainabilityLifeCycleStageDto, ITradeDiscountDto, IWarrantyDurationDto };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dangl/ava-model",
-  "version": "2.29.3",
+  "version": "2.30.0-beta0002",
   "description": "",
   "main": "dist/ava-model/fesm2022/dangl-ava-model.min.mjs",
   "types": "dist/ava-model/index.d.ts",