colouring-montreal/app/src/frontend/config/data-fields-config.ts

import { Category } from './categories-config';

/**
 * This interface is used only in code which uses dataFields, not in the dataFields definition itself
 * Cannot make dataFields an indexed type ({[key: string]: DataFieldDefinition}),
 * because then we wouldn't have type-checking for whether a given key exists on dataFields,
 * e.g. dataFields.foo_bar would not be highlighted as an error.
 */
export interface DataFieldDefinition {
    category: Category;
    title: string;
    tooltip?: string;
    properties?: { [key: string]: DataFieldDefinition};
    example: any; // the example field is used to automatically determine the type of the properties in the Building interface
}

export const dataFields = { /* eslint-disable @typescript-eslint/camelcase */
    location_name: {
        category: Category.Location,
        title: "Building Name",
        tooltip: "May not be needed for many buildings.",
        example: "The Cruciform",
    },
    location_number: {
        category: Category.Location,
        title: "Building number",
        example: 12,
    },
    location_street: {
        category: Category.Location,
        title: "Street",
        example: "Gower Street",
        //tooltip: ,
    },
    location_line_two: {
        category: Category.Location,
        title: "Address line 2",
        example: "Flat 21",
        //tooltip: ,
    },
    location_town: {
        category: Category.Location,
        title: "Town",
        example: "London",
        //tooltip: ,
    },
    location_postcode: {
        category: Category.Location,
        title: "Postcode",
        example: "W1W 6TR",
        //tooltip: ,
    },
    ref_toid: {
        category: Category.Location,
        title: "TOID",
        tooltip: "Ordnance Survey Topography Layer ID (to be filled automatically)",
        example: "",
    },
    
    /**
     * UPRNs is not part of the buildings table, but the string fields 
     * are included here for completeness
     */
    uprns: {
        category: Category.Location,
        title: "UPRNs",
        tooltip: "Unique Property Reference Numbers (to be filled automatically)",
        example: [{uprn: "", parent_uprn: "" }, {uprn: "", parent_uprn: "" }],
    },

    ref_osm_id: {
        category: Category.Location,
        title: "OSM ID",
        tooltip: "OpenStreetMap feature ID",
        example: "",
    },
    location_latitude: {
        category: Category.Location,
        title: "Latitude",
        example: 12.4564,
    },
    location_longitude: {
        category: Category.Location,
        title: "Longitude",
        example: 0.12124,
    },

    current_landuse_group: {
        category: Category.LandUse,
        title: "Current Land Use (Group)",
        tooltip: "Land use Groups as classified by [NLUD](https://www.gov.uk/government/statistics/national-land-use-database-land-use-and-land-cover-classification)",
        example: ["", ""],
    },
    current_landuse_order: {
        category: Category.LandUse,
        title: "Current Land Use (Order)",
        tooltip: "Land use Order as classified by [NLUD](https://www.gov.uk/government/statistics/national-land-use-database-land-use-and-land-cover-classification)",
        example: "",
    },

    building_attachment_form: {
        category: Category.Type,
        title: "Adjacency/configuration",
        tooltip: "We have prepopulated these based on their current attachment. A building can either be detached, semi-detached or part of a terrace (middle or end)",
        example: "",
    },
    date_change_building_use: {
        category: Category.Type,
        title:"When did use change?",
        tooltip: "This is the date the building stopped being used for for the function it was built for. I.e. if it was Victorian warehouse which is now an office this would be when it became an office or if it was something before that, maybe a garage then the date that happened",
        example: 1920,
    },
    /**
     * original_building_use does not exist in database yet.
     * Slug needs to be adjusted if the db column will be named differently 
     */
    original_building_use: {
        category: Category.Type,
        title: "Original building use",
        tooltip: "What was the building originally used for when it was built? I.e. If it was Victorian warehouse which is now an office this would be warehouse",
        example: "",
    },

    size_roof_shape: {
        category: Category.Type,
        title: "Roof type",
        example: "",
        //tooltip: ,
    },

    date_year: {
        category: Category.Age,
        title: "Year built (best estimate)",
        example: 1924,
    },
    date_lower : {
        category: Category.Age,
        title: "Earliest possible start date",
        tooltip: "This should be the earliest year in which building could have started.",
        example: 1900,
    },
    date_upper: {
        category: Category.Age,
        title: "Latest possible start year",
        tooltip: "This should be the latest year in which building could have started.",
        example: 2000,
    },
    facade_year: {
        category: Category.Age,
        title: "Facade year",
        tooltip: "Best estimate",
        example: 1900,
    },
    date_source: {
        category: Category.Age,
        title: "Source of information",
        tooltip: "Source for the main start date",
        example: "",
    },
    date_source_detail: {
        category: Category.Age,
        title: "Source details",
        tooltip: "References for date source (max 500 characters)",
        example: "",
    },
    date_link: {
        category: Category.Age,
        title: "Text and Image Links",
        tooltip: "URL for age and date reference",
        example: ["", "", ""],
    },

    size_storeys_core: {
        category: Category.Size,
        title: "Core storeys",
        tooltip: "How many storeys between the pavement and start of roof?",
        example: 10,
    },
    size_storeys_attic: {
        category: Category.Size,
        title: "Attic storeys",
        tooltip: "How many storeys above start of roof?",
        example: 1,
    },
    size_storeys_basement: {
        category: Category.Size,
        title: "Basement storeys",
        tooltip: "How many storeys below pavement level?",
        example: 1,
    },
    size_height_apex: {
        category: Category.Size,
        title: "Height to apex (m)",
        example: 100.5,
        //tooltip: ,
    },
    size_height_eaves: {
        category: Category.Size,
        title: "Height to eaves (m)",
        example: 20.33,
        //tooltip: ,
    },
    size_floor_area_ground: {
        category: Category.Size,
        title: "Ground floor area (m²)",
        example: 1245.6,
        //tooltip: ,
    },
    size_floor_area_total: {
        category: Category.Size,
        title: "Total floor area (m²)",
        example: 2001.7,
        //tooltip: ,
    },
    size_width_frontage: {
        category: Category.Size,
        title: "Frontage Width (m)",
        example: 12.2,
        //tooltip: ,
    },

    size_configuration: {
        category: Category.Size,
        title: "Configuration (semi/detached, end/terrace)",
        example: "",
        //tooltip: ,
    },

    size_plot_area_total: {
        category: Category.Streetscape,
        title: "Total area of plot (m²)",
        example: 123.02,
        //tooltip: ,
    },
    size_far_ratio: {
        category: Category.Streetscape,
        title: "FAR ratio (percentage of plot covered by building)",
        example: 0.1,
        //tooltip: ,
    },

    construction_core_material: {
        category: Category.Construction,
        title: "Core Material",
        tooltip:"The main structural material",
        example: "",
    },

    construction_secondary_materials: {
        category: Category.Construction,
        title: "Secondary Construction Material/s",
        tooltip:"Other construction materials",
        example: "",
    },

    construction_roof_covering: {
        category: Category.Construction,
        title: "Main Roof Covering",
        tooltip:'Main roof covering material',
        example: "",
    },

    sust_breeam_rating: {
        category: Category.Sustainability,
        title: "BREEAM Rating",
        tooltip: "(Building Research Establishment Environmental Assessment Method) May not be present for many buildings",
        example: "",
    },
    sust_dec: {
        category: Category.Sustainability,
        title: "DEC Rating",
        tooltip: "(Display Energy Certificate) Any public building should have (and display) a DEC. Showing how the energy use for that building compares to other buildings with same use",
        example: "G",
    },
    sust_aggregate_estimate_epc: {
        category: Category.Sustainability,
        title: "EPC Rating",
        tooltip: "(Energy Performance Certifcate) Any premises sold or rented is required to have an EPC to show how energy efficient it is. Only buildings rate grade E or higher maybe rented",
        example: "",
    },
    sust_retrofit_date: {
        category: Category.Sustainability,
        title: "Last significant retrofit",
        tooltip: "Date of last major building refurbishment",
        example: 1920,
    },
    sust_life_expectancy: {
        category: Category.Sustainability,
        title: "Expected lifespan for typology",
        example: 123,
        //tooltip: ,
    },

    planning_portal_link: {
        category: Category.Planning,
        title: "Planning portal link",
        example: "",
        //tooltip: ,
    },
    planning_in_conservation_area: {
        category: Category.Planning,
        title: "In a conservation area?",
        example: true,
        //tooltip: ,
    },
    planning_conservation_area_name: {
        category: Category.Planning,
        title: "Conservation area name",
        example: "",
        //tooltip: ,
    },
    planning_in_list: {
        category: Category.Planning,
        title: "Is listed on the National Heritage List for England?",
        example: true,
        //tooltip: ,
    },
    planning_list_id: {
        category: Category.Planning,
        title: "National Heritage List for England list id",
        example: "121436",
        //tooltip: ,
    },
    planning_list_cat: {
        category: Category.Planning,
        title: "National Heritage List for England list type",
        example: "",
        //tooltip: ,
    },
    planning_list_grade: {
        category: Category.Planning,
        title: "Listing grade",
        example: "II",
        //tooltip: ,
    },
    planning_heritage_at_risk_id: {
        category: Category.Planning,
        title: "Heritage at risk list id",
        example: "",
        //tooltip: ,
    },
    planning_world_list_id: {
        category: Category.Planning,
        title: "World heritage list id",
        example: "",
        //tooltip: ,
    },
    planning_in_glher: {
        category: Category.Planning,
        title: "In the Greater London Historic Environment Record?",
        example: true,
        //tooltip: ,
    },
    planning_glher_url: {
        category: Category.Planning,
        title: "Greater London Historic Environment Record link",
        example: "",
        //tooltip: ,
    },
    planning_in_apa: {
        category: Category.Planning,
        title: "In an Architectural Priority Area?",
        example: true,
        //tooltip: ,
    },
    planning_apa_name: {
        category: Category.Planning,
        title: "Architectural Priority Area name",
        example: "",
        //tooltip: ,
    },
    planning_apa_tier: {
        category: Category.Planning,
        title: "Architectural Priority Area tier",
        example: "2",
        //tooltip: ,
    },
    planning_in_local_list: {
        category: Category.Planning,
        title: "Is locally listed?",
        example: true,
        //tooltip: ,
    },
    planning_local_list_url: {
        category: Category.Planning,
        title: "Local list link",
        example: "",
        //tooltip: ,
    },
    planning_in_historic_area_assessment: {
        category: Category.Planning,
        title: "Within a historic area assessment?",
        example: true,
        //tooltip: ,
    },
    planning_historic_area_assessment_url: {
        category: Category.Planning,
        title: "Historic area assessment link",
        example: "",
        //tooltip: ,
    },
    planning_demolition_proposed: {
        category: Category.Planning,
        title: "Is the building proposed for demolition?",
        example: true,
        //tooltip: ,
    },

    likes_total: {
        category: Category.Community,
        title: "Total number of likes",
        example: 100,
    },

    demolished_buildings: {
        category: Category.Dynamics,
        title: 'Past (demolished) buildings on this site',
        items: {
            year_constructed: {
                title: 'Construction year',
                example: { min: 1989, max: 1991 },
            },
            year_demolished: {
                title: 'Demolition year',
                example: { min: 1993, max: 1994 },
            },
            lifespan: {
                title: 'Lifespan',
                example: "2-5",
            },
            overlap_present: {
                title: 'Roughly what percentage of this building was inside the current site boundary?',
                tooltip: '',
                example: "25%"
            },
            links: {
                title: 'Links / sources',
                example: ["", ""]
            }
        },
        example: [
            {
                year_constructed: { min: 1989, max: 1991 },
                year_demolished: { min: 1993, max: 1994 },
                lifespan: "2-5", overlap_present: "50%", links: ["", ""]}
        ]
    }
};