@hestia-earth/schema/Source.d.ts

Hestia Schema

import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Bibliography } from './Bibliography';
import { Actor } from './Actor';
/**
 * The Source of these data.
 */
export declare class Source extends JSON<SchemaType.Source> {
    /**
    * The name from [bibliography](#bibliography).
    */
    name?: string;
    /**
    * The bibliographic informaton 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[];
    /**
    * A DOI assigned to the data Source in Hestia, if requested by the user.
    */
    doiHESTIA?: string;
    /**
    * Date uploaded to Hestia in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
    */
    uploadDate?: Date;
    /**
    * The user who uploaded these data to Hestia.
    */
    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 Hestia 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 in Hestia.
    */
    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)). If data is uploaded to Hestia but is not to be shared with the public, this should be specified using the dataPrivate field in [Cycle], [Site], and [ImpactAssessment].
    */
    comparativeAssertions?: 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;
    /**
    * If these data are private. If we find the Source on the [Mendeley](https://www.mendeley.com/) catalogue, the data Source is therefore public, and this field will be set to false (you can still set the [Sites](./Site), [Cycles](./Cycle), and [Impact Assessments](./ImpactAssessment) to private in this case).
    */
    dataPrivate?: boolean;
}
/**
 * The Source of these data.
 */
export interface ISourceJSONLD extends JSONLD<NodeType.Source> {
    /**
    * The bibliographic informaton 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[];
    /**
    * A DOI assigned to the data Source in Hestia, if requested by the user.
    */
    doiHESTIA?: string;
    /**
    * Date uploaded to Hestia in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
    */
    uploadDate?: Date;
    /**
    * The user who uploaded these data to Hestia.
    */
    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 Hestia 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 in Hestia.
    */
    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)). If data is uploaded to Hestia but is not to be shared with the public, this should be specified using the dataPrivate field in [Cycle], [Site], and [ImpactAssessment].
    */
    comparativeAssertions?: 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;
    /**
    * If these data are private. If we find the Source on the [Mendeley](https://www.mendeley.com/) catalogue, the data Source is therefore public, and this field will be set to false (you can still set the [Sites](./Site), [Cycles](./Cycle), and [Impact Assessments](./ImpactAssessment) to private in this case).
    */
    dataPrivate?: boolean;
}