contrapunctus/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

refactoring: slight cleanup of tests

Browse source
This commit is contained in:
Pieter Vander Vennet 2023-04-07 03:54:11 +02:00
parent 2e9b1016de
commit f8d34648a0
28 changed files with 252 additions and 353 deletions
Download patch file Download diff file Expand all files Collapse all files

97
Models/ThemeConfig/Json/LayerConfigJson.ts
View file

@ -25,13 +25,13 @@ export interface LayerConfigJson {
*
* If not given, will be hidden (and thus not toggable) in the layer control
*/
name?: string | any
name?: string | Record<string, string>
/**
* A description for this layer.
* Shown in the layer selections and in the personel theme
*/
description?: string | any
description?: string | Record<string, string>
/**
* This determines where the data for the layer is fetched: from OSM or from an external geojson dataset.
@ -45,49 +45,52 @@ export interface LayerConfigJson {
source:
| "special"
| "special:library"
| ({
/**
* Every source must set which tags have to be present in order to load the given layer.
*/
osmTags: TagConfigJson
/**
* The maximum amount of seconds that a tile is allowed to linger in the cache
*/
maxCacheAge?: number
} & {
/**
* The actual source of the data to load, if loaded via geojson.
*
* # A single geojson-file
* source: {geoJson: "https://my.source.net/some-geo-data.geojson"}
* fetches a geojson from a third party source
*
* # A tiled geojson source
* source: {geoJson: "https://my.source.net/some-tile-geojson-{layer}-{z}-{x}-{y}.geojson", geoJsonZoomLevel: 14}
* to use a tiled geojson source. The web server must offer multiple geojsons. {z}, {x} and {y} are substituted by the location; {layer} is substituted with the id of the loaded layer
*
* Some API's use a BBOX instead of a tile, this can be used by specifying {y_min}, {y_max}, {x_min} and {x_max}
*/
geoJson: string
/**
* To load a tiled geojson layer, set the zoomlevel of the tiles
*/
geoJsonZoomLevel?: number
/**
* Indicates that the upstream geojson data is OSM-derived.
* Useful for e.g. merging or for scripts generating this cache
*/
isOsmCache?: boolean
/**
* Some API's use a mercator-projection (EPSG:900913) instead of WGS84. Set the flag `mercatorCrs: true` in the source for this
*/
mercatorCrs?: boolean
/**
* Some API's have an id-field, but give it a different name.
* Setting this key will rename this field into 'id'
*/
idKey?: string
})
| (
| {
/**
* Every source must set which tags have to be present in order to load the given layer.
*/
osmTags: TagConfigJson
/**
* The maximum amount of seconds that a tile is allowed to linger in the cache
*/
maxCacheAge?: number
}
| {
/**
* The actual source of the data to load, if loaded via geojson.
*
* # A single geojson-file
* source: {geoJson: "https://my.source.net/some-geo-data.geojson"}
* fetches a geojson from a third party source
*
* # A tiled geojson source
* source: {geoJson: "https://my.source.net/some-tile-geojson-{layer}-{z}-{x}-{y}.geojson", geoJsonZoomLevel: 14}
* to use a tiled geojson source. The web server must offer multiple geojsons. {z}, {x} and {y} are substituted by the location; {layer} is substituted with the id of the loaded layer
*
* Some API's use a BBOX instead of a tile, this can be used by specifying {y_min}, {y_max}, {x_min} and {x_max}
*/
geoJson: string
/**
* To load a tiled geojson layer, set the zoomlevel of the tiles
*/
geoJsonZoomLevel?: number
/**
* Indicates that the upstream geojson data is OSM-derived.
* Useful for e.g. merging or for scripts generating this cache
*/
isOsmCache?: boolean
/**
* Some API's use a mercator-projection (EPSG:900913) instead of WGS84. Set the flag `mercatorCrs: true` in the source for this
*/
mercatorCrs?: boolean
/**
* Some API's have an id-field, but give it a different name.
* Setting this key will rename this field into 'id'
*/
idKey?: string
}
)
/**
*
@ -212,7 +215,7 @@ export interface LayerConfigJson {
*
* Do _not_ indicate 'new': 'add a new shop here' is incorrect, as the shop might have existed forever, it could just be unmapped!
*/
title: string | any
title: string | Record<string, string>
/**
* The tags to add. It determines the icon too
*/
@ -223,7 +226,7 @@ export interface LayerConfigJson {
*
* (The first sentence is until the first '.'-character in the description)
*/
description?: string | any
description?: string | Record<string, string>
/**
* Example images, which show real-life pictures of what such a feature might look like

10
Models/ThemeConfig/Json/LayoutConfigJson.ts
View file

@ -41,23 +41,23 @@ export interface LayoutConfigJson {
/**
* The title, as shown in the welcome message and the more-screen.
*/
title: string | any
title: string | Record<string, string>
/**
* A short description, showed as social description and in the 'more theme'-buttons.
* Note that if this one is not defined, the first sentence of 'description' is used
*/
shortDescription?: string | any
shortDescription?: string | Record<string, string>
/**
* The description, as shown in the welcome message and the more-screen
*/
description: string | any
description: string | Record<string, string>
/**
* A part of the description, shown under the login-button.
*/
descriptionTail?: string | any
descriptionTail?: string | Record<string, string>
/**
* The icon representing this theme.
@ -196,7 +196,7 @@ export interface LayoutConfigJson {
| string
| {
builtin: string | string[]
override: any
override: Partial<LayerConfigJson>
/**
* TagRenderings with any of these labels will be removed from the layer.
* Note that the 'id' and 'group' are considered labels too

3
Models/ThemeConfig/Json/QuestionableTagRenderingConfigJson.ts
View file

@ -186,9 +186,10 @@ export interface QuestionableTagRenderingConfigJson extends TagRenderingConfigJs
/**
* When set, influences the way a question is asked.
* Instead of showing a full-widht text field, the text field will be shown within the rendering of the question.
* Instead of showing a full-width text field, the text field will be shown within the rendering of the question.
*
* This combines badly with special input elements, as it'll distort the layout.
* Note that this will be set automatically if no special elements are present.
*/
inline?: boolean

9
Models/ThemeConfig/Json/TagRenderingConfigJson.ts
View file

@ -21,7 +21,7 @@ export interface TagRenderingConfigJson {
/**
* A human-readable text explaining what this tagRendering does
*/
description?: string | any
description?: string | Record<string, string>
/**
* Renders this value. Note that "{key}"-parts are substituted by the corresponding values of the element.
@ -30,7 +30,10 @@ export interface TagRenderingConfigJson {
* Note that this is a HTML-interpreted value, so you can add links as e.g. '<a href='{website}'>{website}</a>' or include images such as `This is of type A <br><img src='typeA-icon.svg' />`
* type: rendered
*/
render?: string | any
render?:
| string
| Record<string, string>
| { special: Record<string, string | Record<string, string>> & { type: string } }
/**
* Only show this tagrendering (or ask the question) if the selected object also matches the tags specified as `condition`.
@ -102,7 +105,7 @@ export interface TagRenderingConfigJson {
* If not known yet, the user will be presented with `then` as an option
* Type: rendered
*/
then: string | any
then: string | Record<string, string>
/**
* An icon supporting this mapping; typically shown pretty small
* Type: icon