@hestia-earth/schema
Version:
HESTIA Schema
555 lines (554 loc) • 20.4 kB
TypeScript
import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Property } from './Property';
export declare enum TermTermType {
animalBreed = "animalBreed",
animalManagement = "animalManagement",
animalProduct = "animalProduct",
aquacultureManagement = "aquacultureManagement",
biochar = "biochar",
biologicalControlAgent = "biologicalControlAgent",
building = "building",
characterisedIndicator = "characterisedIndicator",
crop = "crop",
cropEstablishment = "cropEstablishment",
cropResidue = "cropResidue",
cropResidueManagement = "cropResidueManagement",
cropSupport = "cropSupport",
electricity = "electricity",
emission = "emission",
endpointIndicator = "endpointIndicator",
excreta = "excreta",
excretaManagement = "excretaManagement",
experimentDesign = "experimentDesign",
feedFoodAdditive = "feedFoodAdditive",
fertiliserBrandName = "fertiliserBrandName",
forage = "forage",
fuel = "fuel",
inorganicFertiliser = "inorganicFertiliser",
irrigation = "irrigation",
landCover = "landCover",
landUseManagement = "landUseManagement",
liveAnimal = "liveAnimal",
liveAquaticSpecies = "liveAquaticSpecies",
machinery = "machinery",
material = "material",
measurement = "measurement",
methodEmissionResourceUse = "methodEmissionResourceUse",
methodMeasurement = "methodMeasurement",
model = "model",
operation = "operation",
organicFertiliser = "organicFertiliser",
otherInorganicChemical = "otherInorganicChemical",
otherOrganicChemical = "otherOrganicChemical",
pastureManagement = "pastureManagement",
pesticideAI = "pesticideAI",
pesticideBrandName = "pesticideBrandName",
processedFood = "processedFood",
processingAid = "processingAid",
property = "property",
region = "region",
resourceUse = "resourceUse",
sampleDesign = "sampleDesign",
seed = "seed",
soilAmendment = "soilAmendment",
soilTexture = "soilTexture",
soilType = "soilType",
standardsLabels = "standardsLabels",
substrate = "substrate",
system = "system",
tillage = "tillage",
transport = "transport",
usdaSoilType = "usdaSoilType",
veterinaryDrug = "veterinaryDrug",
waste = "waste",
wasteManagement = "wasteManagement",
water = "water",
waterRegime = "waterRegime"
}
/**
* Contains all the fields that make the blank nodes unique.
*/
export declare const termUniquenessFields: {
subClassOf: string[];
defaultProperties: string[];
};
/**
* An item from the [Glossary of Terms](/glossary/) (controlled vocabulary). The Glossary of Terms ensures the most important data fields describing the agri-food system are named consistently. Terms can only be referred to by their <code>[@id](/schema/Term#@id)</code> or their <code>[name](/schema/Term#name)</code>. Changes to Terms and their fields can be requested via [GitLab](https://gitlab.com/hestia-earth/hestia-glossary/-/blob/develop/CONTRIBUTING.md).
*/
export declare class Term extends JSON<SchemaType.Term> {
/**
* The name of the Term.
*/
name?: string;
/**
* A list of synonyms for the name of the Term.
*/
synonyms?: (string)[];
/**
* A definition of the Term.
*/
definition?: string;
/**
* A more detailed description of the Term, which can include information about the source of these data.
*/
description?: string;
/**
* The units that the value (quantity) must always be expressed in (e.g., kg).
*/
units?: string;
/**
* A description of the [units](/schema/Term#units) of the term in plain and simple language.
*/
unitsDescription?: string;
/**
* A list of references to the Terms that are one level above in a hierarchy (see the [RDF Vocabulary](https://www.w3.org/TR/owl-ref/#subClassOf-def) for more details).
*/
subClassOf?: Term[];
/**
* A list of default [Properties](/schema/Property) of the Term (e.g., the dry matter of a crop).
*/
defaultProperties?: Property[];
/**
* The unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature.
*/
casNumber?: string;
/**
* The id of the reference product of the activity in the [ecoinvent](https://glossary.ecoinvent.org/) database.
*/
ecoinventReferenceProductId?: any;
/**
* The name of the species in the FAO [FISHSTAT](http://www.fao.org/fishery/statistics/global-aquaculture-production/en) database.
*/
fishstatName?: string;
/**
* The World Customs Organization [Harmonized System 2017](http://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools/hs-nomenclature-2017-edition/hs-nomenclature-2017-edition.aspx) code.
*/
hsCode?: string;
/**
* The [Indicative Crop Classification](https://unstats.un.org/unsd/classifications/Family/Detail/1002) code.
*/
iccCode?: number;
/**
* The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for sub divisions within countries.
*/
iso31662Code?: string;
/**
* The full name of the administrative region including all higher level region names in the [GADM](https://gadm.org/) database.
*/
gadmFullName?: string;
/**
* The unique identifier assigned by [GADM](https://gadm.org/) database.
*/
gadmId?: string;
/**
* The level of the administrative region in the [GADM](https://gadm.org/) database.
*/
gadmLevel?: number;
/**
* The name of the administrative region in the [GADM](https://gadm.org/) database.
*/
gadmName?: string;
/**
* The name of the country in the [GADM](https://gadm.org/) database.
*/
gadmCountry?: string;
/**
* The Global Trade Item Number (GTIN) is an identifier for trade items, developed by GS1.
*/
gtin?: string;
/**
* The simplified molecular-input line-entry system ([SMILES](https://en.wikipedia.org/wiki/Simplified_molecular-input_line-entry_system)) is a specification in is a string of symbols which represents a chemical's three-dimensional structure. A large number of SMILES exist for any particular structure, and canonical SMILES generates a single generic SMILES amongst all possibilities.
*/
canonicalSmiles?: string;
/**
* The latitude (-90 to 90, WGS84 datum). If a polygon, the centroid.
*/
latitude?: number;
/**
* The longitude (-180 to 180, WGS84 datum). If a polygon, the centroid.
*/
longitude?: number;
/**
* The area of the region in km2.
*/
area?: number;
/**
* The identifier for the activity in the [openLCA](https://www.openlca.org/) database.
*/
openLCAId?: string;
/**
* The taxonomic name of an organism that consists of the genus and species.
*/
scientificName?: string;
/**
* A website URL.
*/
website?: any;
/**
* A hyperlink to the [FAO AGROVOC](http://aims.fao.org/standards/agrovoc/functionalities/search) multilingual thesaurus entry.
*/
agrovoc?: any;
/**
* A hyperlink to the [AQUASTAT](http://www.fao.org/fishery/species/search/en) species fact sheet.
*/
aquastatSpeciesFactSheet?: any;
/**
* A hyperlink to the [Cornell University biological control glossary](https://biocontrol.entomology.cornell.edu/) page.
*/
cornellBiologicalControl?: any;
/**
* A hyperlink to the [Ecolabel Index](https://www.ecolabelindex.com/) page.
*/
ecolabelIndex?: any;
/**
* A hyperlink to the [Feedipedia](https://www.feedipedia.org/) page.
*/
feedipedia?: any;
/**
* A hyperlink to the [Fishbase](https://www.fishbase.se) page.
*/
fishbase?: any;
/**
* A hyperlink to the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) page.
*/
pubchem?: any;
/**
* A hyperlink to the [Wikipedia](https://www.wikipedia.org/) page.
*/
wikipedia?: any;
/**
* The type of term.
*/
termType?: TermTermType;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* 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;
}
/**
* An item from the [Glossary of Terms](/glossary/) (controlled vocabulary). The Glossary of Terms ensures the most important data fields describing the agri-food system are named consistently. Terms can only be referred to by their <code>[@id](/schema/Term#@id)</code> or their <code>[name](/schema/Term#name)</code>. Changes to Terms and their fields can be requested via [GitLab](https://gitlab.com/hestia-earth/hestia-glossary/-/blob/develop/CONTRIBUTING.md).
*/
export interface ITermJSONLD extends JSONLD<NodeType.Term> {
/**
* A list of synonyms for the name of the Term.
*/
synonyms?: (string)[];
/**
* A definition of the Term.
*/
definition?: string;
/**
* A more detailed description of the Term, which can include information about the source of these data.
*/
description?: string;
/**
* The units that the value (quantity) must always be expressed in (e.g., kg).
*/
units?: string;
/**
* A description of the [units](/schema/Term#units) of the term in plain and simple language.
*/
unitsDescription?: string;
/**
* A list of references to the Terms that are one level above in a hierarchy (see the [RDF Vocabulary](https://www.w3.org/TR/owl-ref/#subClassOf-def) for more details).
*/
subClassOf?: ITermJSONLD[];
/**
* A list of default [Properties](/schema/Property) of the Term (e.g., the dry matter of a crop).
*/
defaultProperties?: Property[];
/**
* The unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature.
*/
casNumber?: string;
/**
* The id of the reference product of the activity in the [ecoinvent](https://glossary.ecoinvent.org/) database.
*/
ecoinventReferenceProductId?: any;
/**
* The name of the species in the FAO [FISHSTAT](http://www.fao.org/fishery/statistics/global-aquaculture-production/en) database.
*/
fishstatName?: string;
/**
* The World Customs Organization [Harmonized System 2017](http://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools/hs-nomenclature-2017-edition/hs-nomenclature-2017-edition.aspx) code.
*/
hsCode?: string;
/**
* The [Indicative Crop Classification](https://unstats.un.org/unsd/classifications/Family/Detail/1002) code.
*/
iccCode?: number;
/**
* The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for sub divisions within countries.
*/
iso31662Code?: string;
/**
* The full name of the administrative region including all higher level region names in the [GADM](https://gadm.org/) database.
*/
gadmFullName?: string;
/**
* The unique identifier assigned by [GADM](https://gadm.org/) database.
*/
gadmId?: string;
/**
* The level of the administrative region in the [GADM](https://gadm.org/) database.
*/
gadmLevel?: number;
/**
* The name of the administrative region in the [GADM](https://gadm.org/) database.
*/
gadmName?: string;
/**
* The name of the country in the [GADM](https://gadm.org/) database.
*/
gadmCountry?: string;
/**
* The Global Trade Item Number (GTIN) is an identifier for trade items, developed by GS1.
*/
gtin?: string;
/**
* The simplified molecular-input line-entry system ([SMILES](https://en.wikipedia.org/wiki/Simplified_molecular-input_line-entry_system)) is a specification in is a string of symbols which represents a chemical's three-dimensional structure. A large number of SMILES exist for any particular structure, and canonical SMILES generates a single generic SMILES amongst all possibilities.
*/
canonicalSmiles?: string;
/**
* The latitude (-90 to 90, WGS84 datum). If a polygon, the centroid.
*/
latitude?: number;
/**
* The longitude (-180 to 180, WGS84 datum). If a polygon, the centroid.
*/
longitude?: number;
/**
* The area of the region in km2.
*/
area?: number;
/**
* The identifier for the activity in the [openLCA](https://www.openlca.org/) database.
*/
openLCAId?: string;
/**
* The taxonomic name of an organism that consists of the genus and species.
*/
scientificName?: string;
/**
* A website URL.
*/
website?: any;
/**
* A hyperlink to the [FAO AGROVOC](http://aims.fao.org/standards/agrovoc/functionalities/search) multilingual thesaurus entry.
*/
agrovoc?: any;
/**
* A hyperlink to the [AQUASTAT](http://www.fao.org/fishery/species/search/en) species fact sheet.
*/
aquastatSpeciesFactSheet?: any;
/**
* A hyperlink to the [Cornell University biological control glossary](https://biocontrol.entomology.cornell.edu/) page.
*/
cornellBiologicalControl?: any;
/**
* A hyperlink to the [Ecolabel Index](https://www.ecolabelindex.com/) page.
*/
ecolabelIndex?: any;
/**
* A hyperlink to the [Feedipedia](https://www.feedipedia.org/) page.
*/
feedipedia?: any;
/**
* A hyperlink to the [Fishbase](https://www.fishbase.se) page.
*/
fishbase?: any;
/**
* A hyperlink to the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) page.
*/
pubchem?: any;
/**
* A hyperlink to the [Wikipedia](https://www.wikipedia.org/) page.
*/
wikipedia?: any;
/**
* The type of term.
*/
termType?: TermTermType;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* 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;
}
/**
* An item from the [Glossary of Terms](/glossary/) (controlled vocabulary). The Glossary of Terms ensures the most important data fields describing the agri-food system are named consistently. Terms can only be referred to by their <code>[@id](/schema/Term#@id)</code> or their <code>[name](/schema/Term#name)</code>. Changes to Terms and their fields can be requested via [GitLab](https://gitlab.com/hestia-earth/hestia-glossary/-/blob/develop/CONTRIBUTING.md).
*/
export interface ITermPivoted extends JSONLD<NodeType.Term> {
/**
* A list of synonyms for the name of the Term.
*/
synonyms?: (string)[];
/**
* A definition of the Term.
*/
definition?: string;
/**
* A more detailed description of the Term, which can include information about the source of these data.
*/
description?: string;
/**
* The units that the value (quantity) must always be expressed in (e.g., kg).
*/
units?: string;
/**
* A description of the [units](/schema/Term#units) of the term in plain and simple language.
*/
unitsDescription?: string;
/**
* A list of references to the Terms that are one level above in a hierarchy (see the [RDF Vocabulary](https://www.w3.org/TR/owl-ref/#subClassOf-def) for more details).
*/
subClassOf?: Pick<ITermPivoted, '@type' | '@id' | 'name'>[];
/**
* A list of default [Properties](/schema/Property) of the Term (e.g., the dry matter of a crop).
*/
defaultProperties?: {
[key: string]: {
value: number;
};
};
/**
* The unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature.
*/
casNumber?: string;
/**
* The id of the reference product of the activity in the [ecoinvent](https://glossary.ecoinvent.org/) database.
*/
ecoinventReferenceProductId?: any;
/**
* The name of the species in the FAO [FISHSTAT](http://www.fao.org/fishery/statistics/global-aquaculture-production/en) database.
*/
fishstatName?: string;
/**
* The World Customs Organization [Harmonized System 2017](http://www.wcoomd.org/en/topics/nomenclature/instrument-and-tools/hs-nomenclature-2017-edition/hs-nomenclature-2017-edition.aspx) code.
*/
hsCode?: string;
/**
* The [Indicative Crop Classification](https://unstats.un.org/unsd/classifications/Family/Detail/1002) code.
*/
iccCode?: number;
/**
* The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for sub divisions within countries.
*/
iso31662Code?: string;
/**
* The full name of the administrative region including all higher level region names in the [GADM](https://gadm.org/) database.
*/
gadmFullName?: string;
/**
* The unique identifier assigned by [GADM](https://gadm.org/) database.
*/
gadmId?: string;
/**
* The level of the administrative region in the [GADM](https://gadm.org/) database.
*/
gadmLevel?: number;
/**
* The name of the administrative region in the [GADM](https://gadm.org/) database.
*/
gadmName?: string;
/**
* The name of the country in the [GADM](https://gadm.org/) database.
*/
gadmCountry?: string;
/**
* The Global Trade Item Number (GTIN) is an identifier for trade items, developed by GS1.
*/
gtin?: string;
/**
* The simplified molecular-input line-entry system ([SMILES](https://en.wikipedia.org/wiki/Simplified_molecular-input_line-entry_system)) is a specification in is a string of symbols which represents a chemical's three-dimensional structure. A large number of SMILES exist for any particular structure, and canonical SMILES generates a single generic SMILES amongst all possibilities.
*/
canonicalSmiles?: string;
/**
* The latitude (-90 to 90, WGS84 datum). If a polygon, the centroid.
*/
latitude?: number;
/**
* The longitude (-180 to 180, WGS84 datum). If a polygon, the centroid.
*/
longitude?: number;
/**
* The area of the region in km2.
*/
area?: number;
/**
* The identifier for the activity in the [openLCA](https://www.openlca.org/) database.
*/
openLCAId?: string;
/**
* The taxonomic name of an organism that consists of the genus and species.
*/
scientificName?: string;
/**
* A website URL.
*/
website?: any;
/**
* A hyperlink to the [FAO AGROVOC](http://aims.fao.org/standards/agrovoc/functionalities/search) multilingual thesaurus entry.
*/
agrovoc?: any;
/**
* A hyperlink to the [AQUASTAT](http://www.fao.org/fishery/species/search/en) species fact sheet.
*/
aquastatSpeciesFactSheet?: any;
/**
* A hyperlink to the [Cornell University biological control glossary](https://biocontrol.entomology.cornell.edu/) page.
*/
cornellBiologicalControl?: any;
/**
* A hyperlink to the [Ecolabel Index](https://www.ecolabelindex.com/) page.
*/
ecolabelIndex?: any;
/**
* A hyperlink to the [Feedipedia](https://www.feedipedia.org/) page.
*/
feedipedia?: any;
/**
* A hyperlink to the [Fishbase](https://www.fishbase.se) page.
*/
fishbase?: any;
/**
* A hyperlink to the [PubChem](https://pubchem.ncbi.nlm.nih.gov/) page.
*/
pubchem?: any;
/**
* A hyperlink to the [Wikipedia](https://www.wikipedia.org/) page.
*/
wikipedia?: any;
/**
* The type of term.
*/
termType?: TermTermType;
/**
* The version of the schema when these data were created.
*/
schemaVersion?: string;
/**
* 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 termFields: string[];