@hestia-earth/schema
Version:
HESTIA Schema
408 lines (407 loc) • 18.8 kB
TypeScript
import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Bibliography } from './Bibliography';
import { Actor } from './Actor';
import { Term } from './Term';
import { IActorJSONLD } from './Actor';
import { ITermJSONLD } from './Term';
import { IActorPivoted } from './Actor';
import { ITermPivoted } from './Term';
import { TermTermType } from './Term';
export declare enum SourceOriginalLicense {
'CC-BY' = "CC-BY",
'CC-BY-NC' = "CC-BY-NC",
'CC-BY-NC-ND' = "CC-BY-NC-ND",
'CC-BY-NC-SA' = "CC-BY-NC-SA",
'CC-BY-ND' = "CC-BY-ND",
'CC-BY-SA' = "CC-BY-SA",
CC0 = "CC0",
'GNU-FDL' = "GNU-FDL",
'no public license' = "no public license",
'other public license' = "other public license"
}
/**
* Contains all the TermTermType with override on the Source.
* Note: it does not contain the default TermTermType on related Blank Nodes.
*/
export declare const sourceTermTermType: {
sampleDesign: TermTermType[];
experimentDesign: TermTermType[];
all: TermTermType[];
};
/**
* The Source of these data.
*/
export declare class Source extends JSON<SchemaType.Source> {
/**
* The name from <code>[bibliography](/schema/Source#bibliography)</code>.
*/
name?: string;
/**
* The bibliographic information describing the document or dataset.
*/
bibliography?: Bibliography;
/**
* If multiple Sources were consolidated by meta-analysis, a list of sources describing the meta-analysis document or dataset.
*/
metaAnalyses?: Source[];
/**
* The user who uploaded these data.
*/
uploadBy?: Actor;
/**
* A free text field to describe the data upload, including any issues in the original data, assumptions made, or other important points.
*/
uploadNotes?: string;
/**
* The date the data was checked by an independent data validator [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
validationDate?: Date;
/**
* The people/organizations who/which validated these data.
*/
validationBy?: Actor[];
/**
* The intended application (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
intendedApplication?: string;
/**
* The reasons for carrying out the study (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
studyReasons?: string;
/**
* The intended audience i.e., to whom the results of the study are intended to be communicated (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
intendedAudience?: string;
/**
* Whether the results are intended to be used in comparative assertions (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
comparativeAssertions?: boolean;
/**
* The sample design, taken from the [Glossary](/glossary?termType=sampleDesign).
*/
sampleDesign?: Term;
/**
* For sample designs involving weights, a description of the weights.
*/
weightingMethod?: string;
/**
* The design of the experiment, taken from the [Glossary](/glossary?termType=experimentDesign).
*/
experimentDesign?: Term;
/**
* The [public copyright license](https://en.wikipedia.org/wiki/Public_copyright_license) that the original version of these data were licensed under. Required for public uploads only. <ul class="is-pl-3 is-list-style-disc"> <li>
<code>CC0</code> is a [Creative Commons license](https://creativecommons.org/share-your-work/public-domain/cc0/)
that relinquishes copyright and releases the material into the public domain.
</li>
<li>
<code>CC-BY</code> is a [Creative Commons license](https://creativecommons.org/licenses/by/4.0/)
allowing reuse as long as credit is given to the author of the material.
</li>
<li>
<code>CC-BY-SA</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-sa/4.0/)
allowing reuse as long as credit is given to the author of the material and adaptations
of the material are shared under the same license terms.
</li>
<li>
<code>CC-BY-NC</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material.
</li>
<li>
<code>CC-BY-NC-SA</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-sa/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material
and adaptations of the material are shared under the same license terms.
</li>
<li>
<code>CC-BY-NC-ND</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-nd/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material
but preventing derivatives or adaptations of the material being made.
</li>
<li>
<code>CC-BY-ND</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-nd/4.0/)
allowing reuse as long as credit is given to the author of the material
but preventing derivatives or adaptations of the material being made.
</li>
<li>
<code>GNU-FDL</code> is a [GNU Project license](https://www.gnu.org/licenses/fdl-1.3.html)
allowing reuse as long as adaptations of the material are shared under the same license terms.
</li>
<li>
<code>other public license</code> means the material is licensed under a license not listed above.
</li>
<li>
<code>no public license</code> means the material is under copyright by the original author or
publisher with no rights granted for public use beyond the exceptions to copyright in national law.
</li>
</ul>
*/
originalLicense?: SourceOriginalLicense;
/**
* 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. If we find the Source on the [Mendeley](https://www.mendeley.com/) catalogue, the data in the Source node are public and we set this field to <code>false</code>.
*/
dataPrivate?: 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;
/**
* 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 Source of these data.
*/
export interface ISourceJSONLD extends JSONLD<NodeType.Source> {
/**
* The bibliographic information describing the document or dataset.
*/
bibliography?: Bibliography;
/**
* If multiple Sources were consolidated by meta-analysis, a list of sources describing the meta-analysis document or dataset.
*/
metaAnalyses?: ISourceJSONLD[];
/**
* The user who uploaded these data.
*/
uploadBy?: IActorJSONLD;
/**
* A free text field to describe the data upload, including any issues in the original data, assumptions made, or other important points.
*/
uploadNotes?: string;
/**
* The date the data was checked by an independent data validator [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
validationDate?: Date;
/**
* The people/organizations who/which validated these data.
*/
validationBy?: IActorJSONLD[];
/**
* The intended application (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
intendedApplication?: string;
/**
* The reasons for carrying out the study (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
studyReasons?: string;
/**
* The intended audience i.e., to whom the results of the study are intended to be communicated (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
intendedAudience?: string;
/**
* Whether the results are intended to be used in comparative assertions (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
comparativeAssertions?: boolean;
/**
* The sample design, taken from the [Glossary](/glossary?termType=sampleDesign).
*/
sampleDesign?: ITermJSONLD;
/**
* For sample designs involving weights, a description of the weights.
*/
weightingMethod?: string;
/**
* The design of the experiment, taken from the [Glossary](/glossary?termType=experimentDesign).
*/
experimentDesign?: ITermJSONLD;
/**
* The [public copyright license](https://en.wikipedia.org/wiki/Public_copyright_license) that the original version of these data were licensed under. Required for public uploads only. <ul class="is-pl-3 is-list-style-disc"> <li>
<code>CC0</code> is a [Creative Commons license](https://creativecommons.org/share-your-work/public-domain/cc0/)
that relinquishes copyright and releases the material into the public domain.
</li>
<li>
<code>CC-BY</code> is a [Creative Commons license](https://creativecommons.org/licenses/by/4.0/)
allowing reuse as long as credit is given to the author of the material.
</li>
<li>
<code>CC-BY-SA</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-sa/4.0/)
allowing reuse as long as credit is given to the author of the material and adaptations
of the material are shared under the same license terms.
</li>
<li>
<code>CC-BY-NC</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material.
</li>
<li>
<code>CC-BY-NC-SA</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-sa/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material
and adaptations of the material are shared under the same license terms.
</li>
<li>
<code>CC-BY-NC-ND</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-nd/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material
but preventing derivatives or adaptations of the material being made.
</li>
<li>
<code>CC-BY-ND</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-nd/4.0/)
allowing reuse as long as credit is given to the author of the material
but preventing derivatives or adaptations of the material being made.
</li>
<li>
<code>GNU-FDL</code> is a [GNU Project license](https://www.gnu.org/licenses/fdl-1.3.html)
allowing reuse as long as adaptations of the material are shared under the same license terms.
</li>
<li>
<code>other public license</code> means the material is licensed under a license not listed above.
</li>
<li>
<code>no public license</code> means the material is under copyright by the original author or
publisher with no rights granted for public use beyond the exceptions to copyright in national law.
</li>
</ul>
*/
originalLicense?: SourceOriginalLicense;
/**
* 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. If we find the Source on the [Mendeley](https://www.mendeley.com/) catalogue, the data in the Source node are public and we set this field to <code>false</code>.
*/
dataPrivate?: 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;
/**
* 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 Source of these data.
*/
export interface ISourcePivoted extends JSONLD<NodeType.Source> {
/**
* The bibliographic information describing the document or dataset.
*/
bibliography?: Bibliography;
/**
* If multiple Sources were consolidated by meta-analysis, a list of sources describing the meta-analysis document or dataset.
*/
metaAnalyses?: Pick<ISourcePivoted, '@type' | '@id' | 'name'>[];
/**
* The user who uploaded these data.
*/
uploadBy?: Pick<IActorPivoted, '@type' | '@id' | 'name'>;
/**
* A free text field to describe the data upload, including any issues in the original data, assumptions made, or other important points.
*/
uploadNotes?: string;
/**
* The date the data was checked by an independent data validator [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
validationDate?: Date;
/**
* The people/organizations who/which validated these data.
*/
validationBy?: Pick<IActorPivoted, '@type' | '@id' | 'name'>[];
/**
* The intended application (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
intendedApplication?: string;
/**
* The reasons for carrying out the study (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
studyReasons?: string;
/**
* The intended audience i.e., to whom the results of the study are intended to be communicated (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
intendedAudience?: string;
/**
* Whether the results are intended to be used in comparative assertions (see [ISO 14044:2006](https://www.iso.org/standard/38498.html)).
*/
comparativeAssertions?: boolean;
/**
* The sample design, taken from the [Glossary](/glossary?termType=sampleDesign).
*/
sampleDesign?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* For sample designs involving weights, a description of the weights.
*/
weightingMethod?: string;
/**
* The design of the experiment, taken from the [Glossary](/glossary?termType=experimentDesign).
*/
experimentDesign?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The [public copyright license](https://en.wikipedia.org/wiki/Public_copyright_license) that the original version of these data were licensed under. Required for public uploads only. <ul class="is-pl-3 is-list-style-disc"> <li>
<code>CC0</code> is a [Creative Commons license](https://creativecommons.org/share-your-work/public-domain/cc0/)
that relinquishes copyright and releases the material into the public domain.
</li>
<li>
<code>CC-BY</code> is a [Creative Commons license](https://creativecommons.org/licenses/by/4.0/)
allowing reuse as long as credit is given to the author of the material.
</li>
<li>
<code>CC-BY-SA</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-sa/4.0/)
allowing reuse as long as credit is given to the author of the material and adaptations
of the material are shared under the same license terms.
</li>
<li>
<code>CC-BY-NC</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material.
</li>
<li>
<code>CC-BY-NC-SA</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-sa/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material
and adaptations of the material are shared under the same license terms.
</li>
<li>
<code>CC-BY-NC-ND</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-nd/4.0/)
allowing reuse for non-commercial purposes as long as credit is given to the author of the material
but preventing derivatives or adaptations of the material being made.
</li>
<li>
<code>CC-BY-ND</code> is a [Creative Commons license](https://creativecommons.org/licenses/by-nc-nd/4.0/)
allowing reuse as long as credit is given to the author of the material
but preventing derivatives or adaptations of the material being made.
</li>
<li>
<code>GNU-FDL</code> is a [GNU Project license](https://www.gnu.org/licenses/fdl-1.3.html)
allowing reuse as long as adaptations of the material are shared under the same license terms.
</li>
<li>
<code>other public license</code> means the material is licensed under a license not listed above.
</li>
<li>
<code>no public license</code> means the material is under copyright by the original author or
publisher with no rights granted for public use beyond the exceptions to copyright in national law.
</li>
</ul>
*/
originalLicense?: SourceOriginalLicense;
/**
* 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. If we find the Source on the [Mendeley](https://www.mendeley.com/) catalogue, the data in the Source node are public and we set this field to <code>false</code>.
*/
dataPrivate?: 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;
/**
* 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 sourceFields: string[];