@hestia-earth/schema
Version:
HESTIA Schema
202 lines (201 loc) • 6.18 kB
TypeScript
import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Term } from './Term';
import { ITermJSONLD } from './Term';
import { ITermPivoted } from './Term';
import { TermTermType } from './Term';
/**
* Contains all the TermTermType with override on the Actor.
* Note: it does not contain the default TermTermType on related Blank Nodes.
*/
export declare const actorTermTermType: {
country: TermTermType[];
all: TermTermType[];
};
/**
* A person or institution.
*/
export declare class Actor extends JSON<SchemaType.Actor> {
/**
* An automatically generated field made up of: <code>firstName</code> initial, <code>lastName</code>, <code>primaryInstitution</code>. If the Actor is an institution, the <code>lastName</code> only.
*/
name?: string;
/**
* The Actor's first name.
*/
firstName?: string;
/**
* The Actor's last name or the name of the institution.
*/
lastName?: string;
/**
* The Actor's [ORCiD](https://orcid.org/) identifier.
*/
orcid?: string;
/**
* The Actor's [Scopus](https://www.scopus.com/) identifier.
*/
scopusID?: string;
/**
* The Actor's primary institution.
*/
primaryInstitution?: string;
/**
* A city or town.
*/
city?: string;
/**
* The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
*/
country?: Term;
/**
* The email address of the Actor.
*/
email?: string;
/**
* A link to a website describing the Actor.
*/
website?: any;
/**
* 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;
/**
* 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;
}
/**
* A person or institution.
*/
export interface IActorJSONLD extends JSONLD<NodeType.Actor> {
/**
* The Actor's first name.
*/
firstName?: string;
/**
* The Actor's last name or the name of the institution.
*/
lastName?: string;
/**
* The Actor's [ORCiD](https://orcid.org/) identifier.
*/
orcid?: string;
/**
* The Actor's [Scopus](https://www.scopus.com/) identifier.
*/
scopusID?: string;
/**
* The Actor's primary institution.
*/
primaryInstitution?: string;
/**
* A city or town.
*/
city?: string;
/**
* The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
*/
country?: ITermJSONLD;
/**
* The email address of the Actor.
*/
email?: string;
/**
* A link to a website describing the Actor.
*/
website?: any;
/**
* 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;
/**
* 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;
}
/**
* A person or institution.
*/
export interface IActorPivoted extends JSONLD<NodeType.Actor> {
/**
* The Actor's first name.
*/
firstName?: string;
/**
* The Actor's last name or the name of the institution.
*/
lastName?: string;
/**
* The Actor's [ORCiD](https://orcid.org/) identifier.
*/
orcid?: string;
/**
* The Actor's [Scopus](https://www.scopus.com/) identifier.
*/
scopusID?: string;
/**
* The Actor's primary institution.
*/
primaryInstitution?: string;
/**
* A city or town.
*/
city?: string;
/**
* The country from the [Glossary](/glossary?termType=region), following [GADM](https://gadm.org/) naming conventions.
*/
country?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The email address of the Actor.
*/
email?: string;
/**
* A link to a website describing the Actor.
*/
website?: any;
/**
* 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;
/**
* 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 actorFields: string[];