@hestia-earth/schema
Version:
HESTIA Schema
325 lines (324 loc) • 9.98 kB
TypeScript
import { JSON, JSONLD, NodeType, SchemaType } from './types';
import { Term } from './Term';
import { Infrastructure } from './Infrastructure';
import { Actor } from './Actor';
import { ITermJSONLD } from './Term';
import { IActorJSONLD } from './Actor';
import { ITermPivoted } from './Term';
import { IActorPivoted } from './Actor';
import { TermTermType } from './Term';
/**
* Contains all the TermTermType with override on the Organisation.
* Note: it does not contain the default TermTermType on related Blank Nodes.
*/
export declare const organisationTermTermType: {
country: TermTermType[];
region: TermTermType[];
all: TermTermType[];
};
/**
* Contains all the fields that make the blank nodes unique.
*/
export declare const organisationUniquenessFields: {
infrastructure: string[];
};
/**
* The organisation which manages the [Site(s)](/schema/Site).
*/
export declare class Organisation extends JSON<SchemaType.Organisation> {
/**
* The name of the Organisation.
*/
name?: string;
/**
* A description of the Organisation.
*/
description?: string;
/**
* A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Organisation boundary of type 'FeatureCollection', 'Feature' or 'GeometryCollection' in the WGS84 datum.
*/
boundary?: object;
/**
* The area in km2 of the [boundary](/schema/Organisation#boundary). This field is automatically calculated when [boundary](/schema/Organisation#boundary) is provided.
*/
boundaryArea?: number;
/**
* The area of the Organisation in hectares.
*/
area?: number;
/**
* The latitude of the Organisation (-90 to 90).
*/
latitude?: number;
/**
* The longitude of the Organisation (-180 to 180).
*/
longitude?: number;
/**
* The street address.
*/
streetAddress?: string;
/**
* The city or town.
*/
city?: string;
/**
* The most specific geographical region from the [Glossary](/glossary?termType=region).
*/
region?: Term;
/**
* The country from the [Glossary](/glossary?termType=region).
*/
country?: Term;
/**
* The post office box number.
*/
postOfficeBoxNumber?: string;
/**
* The postal code.
*/
postalCode?: string;
/**
* A link to a website describing the Organisation.
*/
website?: any;
/**
* The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
*/
glnNumber?: string;
/**
* The start date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* The end date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The Infrastructure on the Site.
*/
infrastructure?: Infrastructure[];
/**
* 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.
*/
originalId?: string;
/**
* The user who uploaded these data.
*/
uploadBy?: Actor;
/**
* 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 organisation which manages the [Site(s)](/schema/Site).
*/
export interface IOrganisationJSONLD extends JSONLD<NodeType.Organisation> {
/**
* A description of the Organisation.
*/
description?: string;
/**
* A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Organisation boundary of type 'FeatureCollection', 'Feature' or 'GeometryCollection' in the WGS84 datum.
*/
boundary?: object;
/**
* The area in km2 of the [boundary](/schema/Organisation#boundary). This field is automatically calculated when [boundary](/schema/Organisation#boundary) is provided.
*/
boundaryArea?: number;
/**
* The area of the Organisation in hectares.
*/
area?: number;
/**
* The latitude of the Organisation (-90 to 90).
*/
latitude?: number;
/**
* The longitude of the Organisation (-180 to 180).
*/
longitude?: number;
/**
* The street address.
*/
streetAddress?: string;
/**
* The city or town.
*/
city?: string;
/**
* The most specific geographical region from the [Glossary](/glossary?termType=region).
*/
region?: ITermJSONLD;
/**
* The country from the [Glossary](/glossary?termType=region).
*/
country?: ITermJSONLD;
/**
* The post office box number.
*/
postOfficeBoxNumber?: string;
/**
* The postal code.
*/
postalCode?: string;
/**
* A link to a website describing the Organisation.
*/
website?: any;
/**
* The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
*/
glnNumber?: string;
/**
* The start date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* The end date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The Infrastructure on the Site.
*/
infrastructure?: Infrastructure[];
/**
* 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.
*/
originalId?: string;
/**
* The user who uploaded these data.
*/
uploadBy?: IActorJSONLD;
/**
* 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 organisation which manages the [Site(s)](/schema/Site).
*/
export interface IOrganisationPivoted extends JSONLD<NodeType.Organisation> {
/**
* A description of the Organisation.
*/
description?: string;
/**
* A nested [GeoJSON](https://tools.ietf.org/html/rfc7946) object for the Organisation boundary of type 'FeatureCollection', 'Feature' or 'GeometryCollection' in the WGS84 datum.
*/
boundary?: object;
/**
* The area in km2 of the [boundary](/schema/Organisation#boundary). This field is automatically calculated when [boundary](/schema/Organisation#boundary) is provided.
*/
boundaryArea?: number;
/**
* The area of the Organisation in hectares.
*/
area?: number;
/**
* The latitude of the Organisation (-90 to 90).
*/
latitude?: number;
/**
* The longitude of the Organisation (-180 to 180).
*/
longitude?: number;
/**
* The street address.
*/
streetAddress?: string;
/**
* The city or town.
*/
city?: string;
/**
* The most specific geographical region from the [Glossary](/glossary?termType=region).
*/
region?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The country from the [Glossary](/glossary?termType=region).
*/
country?: Pick<ITermPivoted, '@type' | '@id' | 'name'>;
/**
* The post office box number.
*/
postOfficeBoxNumber?: string;
/**
* The postal code.
*/
postalCode?: string;
/**
* A link to a website describing the Organisation.
*/
website?: any;
/**
* The [Global Location Number](https://en.wikipedia.org/wiki/Global_Location_Number).
*/
glnNumber?: string;
/**
* The start date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
startDate?: string;
/**
* The end date of the Organisation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
*/
endDate?: string;
/**
* The Infrastructure on the Site.
*/
infrastructure?: {
[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;
/**
* The identifier for these data in the source database.
*/
originalId?: string;
/**
* The user who uploaded these data.
*/
uploadBy?: Pick<IActorPivoted, '@type' | '@id' | 'name'>;
/**
* 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 organisationFields: string[];