@hestia-earth/schema
Version:
HESTIA Schema
510 lines (509 loc) • 21.6 kB
TypeScript
import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Cycle } from './Cycle';
import { Product } from './Product';
import { Site } from './Site';
import { Term } from './Term';
import { Organisation } from './Organisation';
import { Source } from './Source';
import { Indicator } from './Indicator';
import { ICycleJSONLD } from './Cycle';
import { ISiteJSONLD } from './Site';
import { ITermJSONLD } from './Term';
import { IOrganisationJSONLD } from './Organisation';
import { ISourceJSONLD } from './Source';
import { ICyclePivoted } from './Cycle';
import { ISitePivoted } from './Site';
import { ITermPivoted } from './Term';
import { IOrganisationPivoted } from './Organisation';
import { ISourcePivoted } from './Source';
import { TermTermType } from './Term';
export declare enum ImpactAssessmentAllocationMethod {
biophysical = "biophysical",
economic = "economic",
energy = "energy",
mass = "mass",
none = "none",
'none required' = "none required",
'system expansion' = "system expansion"
}
/**
* Contains all the TermTermType with override on the ImpactAssessment.
* Note: it does not contain the default TermTermType on related Blank Nodes.
*/
export declare const impactAssessmentTermTermType: {
country: TermTermType[];
region: TermTermType[];
emissionsResourceUse: {
term: TermTermType[];
};
impacts: {
term: TermTermType[];
};
endpoints: {
term: TermTermType[];
};
all: TermTermType[];
};
/**
* Contains all the fields that make the blank nodes unique.
*/
export declare const impactAssessmentUniquenessFields: {
emissionsResourceUse: string[];
impacts: string[];
endpoints: string[];
};
/**
* The emissions, resource uses, and environmental impacts created during the production of one unit of a [Product](/schema/ImpactAssessment#product) from a [Cycle](/schema/Cycle). The functional unit is defined by the units of the Product. If there are more than one Product in the Cycle, allocation is used to apportion these impacts across the Products.
*/
export declare class ImpactAssessment extends JSON<SchemaType.ImpactAssessment> {
/**
* The name of the Impact Assessment.
*/
name?: string;
/**
* The version of the Impact Assessment.
*/
version?: string;
/**
* A text description of the version of the Impact Assessment.
*/
versionDetails?: string;
/**
* A reference to the node describing the production [Cycle](/schema/Cycle).
*/
cycle?: Cycle;
/**
* The [Product](/schema/Product) produced during the production [Cycle](/schema/Cycle), which is the target of this Impact Assessment.
*/
product?: Product;
/**
* The quantity of the <code>[product](/schema/ImpactAssessment#product)</code> that this Impact Assessment is expressed per. The units are determined by the [Term](/schema/Term) of the <code>[product](/schema/ImpactAssessment#product)</code> (e.g., 1kg for [Wheat, grain](/term/wheatGrain), or 1 head for a [Pig](/term/pig)).
*/
functionalUnitQuantity?: number;
/**
* The method used to allocate environmental impacts between [Products](/schema/Product).
*/
allocationMethod?: ImpactAssessmentAllocationMethod;
/**
* The end date or year of production in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The start date of production in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* A reference to the node describing the [Site](/schema/Site) where production occurred.
*/
site?: Site;
/**
* The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
*/
country?: Term;
/**
* The lowest level [GADM](https://gadm.org/) region available following the naming convention used in the [Glossary](/glossary?termType=region).
*/
region?: Term;
/**
* A reference to the node describing the [Organisation](/schema/Organisation) that produced the [Product](/schema/Product).
*/
organisation?: Organisation;
/**
* The [Source](/schema/Source) for the data in the Impact Assessment. Not required (but recommended) for public uploads (i.e., where <code>[dataPrivate](/schema/ImpactAssessment#dataPrivate)</code> is <code>false</code>).
*/
source?: Source;
/**
* A list of emissions and resource uses.
*/
emissionsResourceUse?: Indicator[];
/**
* The mid-point environmental impact [Indicators](/schema/Indicator). These are calculated from <code>[emissions](/schema/ImpactAssessment#emissions)</code> and <code>[resourceUse](/schema/ImpactAssessment#resourceUse)</code> by applying characterisation factors to generate a [characterised impact indicator](/glossary?termType=characterisedIndicator).
*/
impacts?: Indicator[];
/**
* The end-point environmental impact [Indicators](/schema/Indicator). These are calculated from the mid-point <code>[impacts](/schema/ImpactAssessment#impacts)</code> by applying characterisation factors to generate an [end-point impact indicator](/glossary?termType=endpointIndicator).
*/
endpoints?: Indicator[];
/**
* If these data are private. Private means that HESTIA administrators can access these data and you can grant access to other platform users, but these data will not be made available to any other users of the platform or distributed to third parties.
*/
dataPrivate?: boolean;
/**
* If the [Cycle](/schema/ImpactAssessment#cycle) has an organic label. Used by the aggregation engine only.
*/
organic?: boolean;
/**
* If the [Cycle](/schema/ImpactAssessment#cycle) was irrigated. Used by the aggregation engine only.
*/
irrigated?: boolean;
/**
* If this node was autogenerated during upload.
*/
autoGenerated?: boolean;
/**
* The identifier for these data in the source database (e.g., if the data were converted from openLCA or ecoinvent, the id field from that database).
*/
originalId?: string;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* A list of fields that have been added to the original dataset.
*/
added?: (string)[];
/**
* A list of versions of the model used to add these fields.
*/
addedVersion?: (string)[];
/**
* A list of fields that have been updated on the original dataset.
*/
updated?: (string)[];
/**
* A list of versions of the model used to update these fields.
*/
updatedVersion?: (string)[];
/**
* If this Impact Assessment has been 'aggregated' using data from multiple Impact Assessments.
*/
aggregated?: boolean;
/**
* If this aggregated Impact Assessment has been validated by the HESTIA team.
*/
aggregatedDataValidated?: boolean;
/**
* A version of the aggregation engine corresponding to this Impact Assessment.
*/
aggregatedVersion?: string;
/**
* A data quality score for aggregated data, set equal to [the quality score of the linked Cycle](/schema/Cycle#aggregatedQualityScore).
*/
aggregatedQualityScore?: number;
/**
* The maximum value for [the aggregated quality score](/schema/ImpactAssessment#aggregatedQualityScore), set equal to
[the max quality score of the linked Cycle](/schema/Cycle#aggregatedQualityScoreMax).
*/
aggregatedQualityScoreMax?: number;
/**
* Impact Assessments used to aggregated this Impact Assessment.
*/
aggregatedImpactAssessments?: ImpactAssessment[];
/**
* Sources used to aggregated this Impact Assessment.
*/
aggregatedSources?: Source[];
/**
* Date created on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
createdAt?: Date;
/**
* Last update date on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
updatedAt?: Date;
}
/**
* The emissions, resource uses, and environmental impacts created during the production of one unit of a [Product](/schema/ImpactAssessment#product) from a [Cycle](/schema/Cycle). The functional unit is defined by the units of the Product. If there are more than one Product in the Cycle, allocation is used to apportion these impacts across the Products.
*/
export interface IImpactAssessmentJSONLD extends JSONLD<NodeType.ImpactAssessment> {
/**
* The version of the Impact Assessment.
*/
version?: string;
/**
* A text description of the version of the Impact Assessment.
*/
versionDetails?: string;
/**
* A reference to the node describing the production [Cycle](/schema/Cycle).
*/
cycle?: ICycleJSONLD;
/**
* The [Product](/schema/Product) produced during the production [Cycle](/schema/Cycle), which is the target of this Impact Assessment.
*/
product?: Product;
/**
* The quantity of the <code>[product](/schema/ImpactAssessment#product)</code> that this Impact Assessment is expressed per. The units are determined by the [Term](/schema/Term) of the <code>[product](/schema/ImpactAssessment#product)</code> (e.g., 1kg for [Wheat, grain](/term/wheatGrain), or 1 head for a [Pig](/term/pig)).
*/
functionalUnitQuantity?: number;
/**
* The method used to allocate environmental impacts between [Products](/schema/Product).
*/
allocationMethod?: ImpactAssessmentAllocationMethod;
/**
* The end date or year of production in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The start date of production in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* A reference to the node describing the [Site](/schema/Site) where production occurred.
*/
site?: ISiteJSONLD;
/**
* The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
*/
country?: ITermJSONLD;
/**
* The lowest level [GADM](https://gadm.org/) region available following the naming convention used in the [Glossary](/glossary?termType=region).
*/
region?: ITermJSONLD;
/**
* A reference to the node describing the [Organisation](/schema/Organisation) that produced the [Product](/schema/Product).
*/
organisation?: IOrganisationJSONLD;
/**
* The [Source](/schema/Source) for the data in the Impact Assessment. Not required (but recommended) for public uploads (i.e., where <code>[dataPrivate](/schema/ImpactAssessment#dataPrivate)</code> is <code>false</code>).
*/
source?: ISourceJSONLD;
/**
* A list of emissions and resource uses.
*/
emissionsResourceUse?: Indicator[];
/**
* The mid-point environmental impact [Indicators](/schema/Indicator). These are calculated from <code>[emissions](/schema/ImpactAssessment#emissions)</code> and <code>[resourceUse](/schema/ImpactAssessment#resourceUse)</code> by applying characterisation factors to generate a [characterised impact indicator](/glossary?termType=characterisedIndicator).
*/
impacts?: Indicator[];
/**
* The end-point environmental impact [Indicators](/schema/Indicator). These are calculated from the mid-point <code>[impacts](/schema/ImpactAssessment#impacts)</code> by applying characterisation factors to generate an [end-point impact indicator](/glossary?termType=endpointIndicator).
*/
endpoints?: Indicator[];
/**
* If these data are private. Private means that HESTIA administrators can access these data and you can grant access to other platform users, but these data will not be made available to any other users of the platform or distributed to third parties.
*/
dataPrivate?: boolean;
/**
* If the [Cycle](/schema/ImpactAssessment#cycle) has an organic label. Used by the aggregation engine only.
*/
organic?: boolean;
/**
* If the [Cycle](/schema/ImpactAssessment#cycle) was irrigated. Used by the aggregation engine only.
*/
irrigated?: boolean;
/**
* If this node was autogenerated during upload.
*/
autoGenerated?: boolean;
/**
* The identifier for these data in the source database (e.g., if the data were converted from openLCA or ecoinvent, the id field from that database).
*/
originalId?: string;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* A list of fields that have been added to the original dataset.
*/
added?: (string)[];
/**
* A list of versions of the model used to add these fields.
*/
addedVersion?: (string)[];
/**
* A list of fields that have been updated on the original dataset.
*/
updated?: (string)[];
/**
* A list of versions of the model used to update these fields.
*/
updatedVersion?: (string)[];
/**
* If this Impact Assessment has been 'aggregated' using data from multiple Impact Assessments.
*/
aggregated?: boolean;
/**
* If this aggregated Impact Assessment has been validated by the HESTIA team.
*/
aggregatedDataValidated?: boolean;
/**
* A version of the aggregation engine corresponding to this Impact Assessment.
*/
aggregatedVersion?: string;
/**
* A data quality score for aggregated data, set equal to [the quality score of the linked Cycle](/schema/Cycle#aggregatedQualityScore).
*/
aggregatedQualityScore?: number;
/**
* The maximum value for [the aggregated quality score](/schema/ImpactAssessment#aggregatedQualityScore), set equal to
[the max quality score of the linked Cycle](/schema/Cycle#aggregatedQualityScoreMax).
*/
aggregatedQualityScoreMax?: number;
/**
* Impact Assessments used to aggregated this Impact Assessment.
*/
aggregatedImpactAssessments?: IImpactAssessmentJSONLD[];
/**
* Sources used to aggregated this Impact Assessment.
*/
aggregatedSources?: ISourceJSONLD[];
/**
* Date created on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
createdAt?: Date;
/**
* Last update date on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
updatedAt?: Date;
}
/**
* The emissions, resource uses, and environmental impacts created during the production of one unit of a [Product](/schema/ImpactAssessment#product) from a [Cycle](/schema/Cycle). The functional unit is defined by the units of the Product. If there are more than one Product in the Cycle, allocation is used to apportion these impacts across the Products.
*/
export interface IImpactAssessmentPivoted extends JSONLD<NodeType.ImpactAssessment> {
/**
* The version of the Impact Assessment.
*/
version?: string;
/**
* A text description of the version of the Impact Assessment.
*/
versionDetails?: string;
/**
* A reference to the node describing the production [Cycle](/schema/Cycle).
*/
cycle?: Pick<ICyclePivoted, '@type' | '@id' | 'name'>;
/**
* The [Product](/schema/Product) produced during the production [Cycle](/schema/Cycle), which is the target of this Impact Assessment.
*/
product?: Product;
/**
* The quantity of the <code>[product](/schema/ImpactAssessment#product)</code> that this Impact Assessment is expressed per. The units are determined by the [Term](/schema/Term) of the <code>[product](/schema/ImpactAssessment#product)</code> (e.g., 1kg for [Wheat, grain](/term/wheatGrain), or 1 head for a [Pig](/term/pig)).
*/
functionalUnitQuantity?: number;
/**
* The method used to allocate environmental impacts between [Products](/schema/Product).
*/
allocationMethod?: ImpactAssessmentAllocationMethod;
/**
* The end date or year of production in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The start date of production in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* A reference to the node describing the [Site](/schema/Site) where production occurred.
*/
site?: Pick<ISitePivoted, '@type' | '@id' | 'name'>;
/**
* The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
*/
country?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The lowest level [GADM](https://gadm.org/) region available following the naming convention used in the [Glossary](/glossary?termType=region).
*/
region?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* A reference to the node describing the [Organisation](/schema/Organisation) that produced the [Product](/schema/Product).
*/
organisation?: Pick<IOrganisationPivoted, '@type' | '@id' | 'name'>;
/**
* The [Source](/schema/Source) for the data in the Impact Assessment. Not required (but recommended) for public uploads (i.e., where <code>[dataPrivate](/schema/ImpactAssessment#dataPrivate)</code> is <code>false</code>).
*/
source?: Pick<ISourcePivoted, '@type' | '@id' | 'name'>;
/**
* A list of emissions and resource uses.
*/
emissionsResourceUse?: {
[key: string]: {
value: number;
};
};
/**
* The mid-point environmental impact [Indicators](/schema/Indicator). These are calculated from <code>[emissions](/schema/ImpactAssessment#emissions)</code> and <code>[resourceUse](/schema/ImpactAssessment#resourceUse)</code> by applying characterisation factors to generate a [characterised impact indicator](/glossary?termType=characterisedIndicator).
*/
impacts?: {
[key: string]: {
value: number;
};
};
/**
* The end-point environmental impact [Indicators](/schema/Indicator). These are calculated from the mid-point <code>[impacts](/schema/ImpactAssessment#impacts)</code> by applying characterisation factors to generate an [end-point impact indicator](/glossary?termType=endpointIndicator).
*/
endpoints?: {
[key: string]: {
value: number;
};
};
/**
* If these data are private. Private means that HESTIA administrators can access these data and you can grant access to other platform users, but these data will not be made available to any other users of the platform or distributed to third parties.
*/
dataPrivate?: boolean;
/**
* If the [Cycle](/schema/ImpactAssessment#cycle) has an organic label. Used by the aggregation engine only.
*/
organic?: boolean;
/**
* If the [Cycle](/schema/ImpactAssessment#cycle) was irrigated. Used by the aggregation engine only.
*/
irrigated?: boolean;
/**
* If this node was autogenerated during upload.
*/
autoGenerated?: boolean;
/**
* The identifier for these data in the source database (e.g., if the data were converted from openLCA or ecoinvent, the id field from that database).
*/
originalId?: string;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* A list of fields that have been added to the original dataset.
*/
added?: (string)[];
/**
* A list of versions of the model used to add these fields.
*/
addedVersion?: (string)[];
/**
* A list of fields that have been updated on the original dataset.
*/
updated?: (string)[];
/**
* A list of versions of the model used to update these fields.
*/
updatedVersion?: (string)[];
/**
* If this Impact Assessment has been 'aggregated' using data from multiple Impact Assessments.
*/
aggregated?: boolean;
/**
* If this aggregated Impact Assessment has been validated by the HESTIA team.
*/
aggregatedDataValidated?: boolean;
/**
* A version of the aggregation engine corresponding to this Impact Assessment.
*/
aggregatedVersion?: string;
/**
* A data quality score for aggregated data, set equal to [the quality score of the linked Cycle](/schema/Cycle#aggregatedQualityScore).
*/
aggregatedQualityScore?: number;
/**
* The maximum value for [the aggregated quality score](/schema/ImpactAssessment#aggregatedQualityScore), set equal to
[the max quality score of the linked Cycle](/schema/Cycle#aggregatedQualityScoreMax).
*/
aggregatedQualityScoreMax?: number;
/**
* Impact Assessments used to aggregated this Impact Assessment.
*/
aggregatedImpactAssessments?: Pick<IImpactAssessmentPivoted, '@type' | '@id' | 'name'>[];
/**
* Sources used to aggregated this Impact Assessment.
*/
aggregatedSources?: Pick<ISourcePivoted, '@type' | '@id' | 'name'>[];
/**
* Date created on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
createdAt?: Date;
/**
* Last update date on HESTIA in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
updatedAt?: Date;
}
export declare const impactAssessmentFields: string[];