211 lines
No EOL
9.2 KiB
TypeScript
211 lines
No EOL
9.2 KiB
TypeScript
import {Translation} from "../../UI/i18n/Translation";
|
|
import {LayoutConfigJson} from "./Json/LayoutConfigJson";
|
|
import LayerConfig from "./LayerConfig";
|
|
import {LayerConfigJson} from "./Json/LayerConfigJson";
|
|
import Constants from "../Constants";
|
|
import TilesourceConfig from "./TilesourceConfig";
|
|
import {ExtractImages} from "./Conversion/FixImages";
|
|
import ExtraLinkConfig from "./ExtraLinkConfig";
|
|
|
|
export default class LayoutConfig {
|
|
public static readonly defaultSocialImage = "assets/SocialImage.png"
|
|
public readonly id: string;
|
|
public readonly credits?: string;
|
|
public readonly language: string[];
|
|
public readonly title: Translation;
|
|
public readonly shortDescription: Translation;
|
|
public readonly description: Translation;
|
|
public readonly descriptionTail?: Translation;
|
|
public readonly icon: string;
|
|
public readonly socialImage?: string;
|
|
public readonly startZoom: number;
|
|
public readonly startLat: number;
|
|
public readonly startLon: number;
|
|
public readonly widenFactor: number;
|
|
public readonly defaultBackgroundId?: string;
|
|
public layers: LayerConfig[];
|
|
public tileLayerSources: TilesourceConfig[]
|
|
public readonly clustering?: {
|
|
maxZoom: number,
|
|
minNeededElements: number,
|
|
};
|
|
public readonly hideFromOverview: boolean;
|
|
public lockLocation: boolean | [[number, number], [number, number]];
|
|
public readonly enableUserBadge: boolean;
|
|
public readonly enableShareScreen: boolean;
|
|
public readonly enableMoreQuests: boolean;
|
|
public readonly enableAddNewPoints: boolean;
|
|
public readonly enableLayers: boolean;
|
|
public readonly enableSearch: boolean;
|
|
public readonly enableGeolocation: boolean;
|
|
public readonly enableBackgroundLayerSelection: boolean;
|
|
public readonly enableShowAllQuestions: boolean;
|
|
public readonly enableExportButton: boolean;
|
|
public readonly enablePdfDownload: boolean;
|
|
|
|
public readonly customCss?: string;
|
|
|
|
public readonly overpassUrl: string[];
|
|
public readonly overpassTimeout: number;
|
|
public readonly overpassMaxZoom: number
|
|
public readonly osmApiTileSize: number
|
|
public readonly official: boolean;
|
|
|
|
public readonly usedImages: string[]
|
|
public readonly extraLink?: ExtraLinkConfig
|
|
|
|
public readonly definedAtUrl?: string;
|
|
public readonly definitionRaw?: string;
|
|
|
|
constructor(json: LayoutConfigJson, official = true, options?: {
|
|
definedAtUrl?: string,
|
|
definitionRaw?: string
|
|
}) {
|
|
this.official = official;
|
|
this.id = json.id;
|
|
this.definedAtUrl = options?.definedAtUrl
|
|
this.definitionRaw = options?.definitionRaw
|
|
if (official) {
|
|
if (json.id.toLowerCase() !== json.id) {
|
|
throw "The id of a theme should be lowercase: " + json.id
|
|
}
|
|
if (json.id.match(/[a-z0-9-_]/) == null) {
|
|
throw "The id of a theme should match [a-z0-9-_]*: " + json.id
|
|
}
|
|
}
|
|
const context = this.id
|
|
this.credits = json.credits;
|
|
this.language = json.mustHaveLanguage ?? Array.from(Object.keys(json.title));
|
|
this.usedImages = Array.from(new ExtractImages(official, undefined).convertStrict(json, "while extracting the images of " + json.id + " " + context ?? "")).sort()
|
|
{
|
|
if (typeof json.title === "string") {
|
|
throw `The title of a theme should always be a translation, as it sets the corresponding languages (${context}.title). The themenID is ${this.id}; the offending object is ${JSON.stringify(json.title)} which is a ${typeof json.title})`
|
|
}
|
|
if (this.language.length == 0) {
|
|
throw `No languages defined. Define at least one language. (${context}.languages)`
|
|
}
|
|
if (json.title === undefined) {
|
|
throw "Title not defined in " + this.id;
|
|
}
|
|
if (json.description === undefined) {
|
|
throw "Description not defined in " + this.id;
|
|
}
|
|
if (json.widenFactor <= 0) {
|
|
throw "Widenfactor too small, shoud be > 0"
|
|
}
|
|
if (json.widenFactor > 20) {
|
|
throw "Widenfactor is very big, use a value between 1 and 5 (current value is " + json.widenFactor + ") at " + context
|
|
}
|
|
if (json["hideInOverview"]) {
|
|
throw "The json for " + this.id + " contains a 'hideInOverview'. Did you mean hideFromOverview instead?"
|
|
}
|
|
if (json.layers === undefined) {
|
|
throw "Got undefined layers for " + json.id + " at " + context
|
|
}
|
|
}
|
|
this.title = new Translation(json.title, "themes:" + context + ".title");
|
|
this.description = new Translation(json.description, "themes:" + context + ".description");
|
|
this.shortDescription = json.shortDescription === undefined ? this.description.FirstSentence() : new Translation(json.shortDescription, "themes:" + context + ".shortdescription");
|
|
this.descriptionTail = json.descriptionTail === undefined ? undefined : new Translation(json.descriptionTail, "themes:" + context + ".descriptionTail");
|
|
this.icon = json.icon;
|
|
this.socialImage = json.socialImage ?? LayoutConfig.defaultSocialImage;
|
|
if (this.socialImage === "") {
|
|
if (official) {
|
|
throw "Theme " + json.id + " has empty string as social image"
|
|
}
|
|
}
|
|
this.startZoom = json.startZoom;
|
|
this.startLat = json.startLat;
|
|
this.startLon = json.startLon;
|
|
this.widenFactor = json.widenFactor ?? 1.5;
|
|
|
|
this.defaultBackgroundId = json.defaultBackgroundId;
|
|
this.tileLayerSources = (json.tileLayerSources ?? []).map((config, i) => new TilesourceConfig(config, `${this.id}.tileLayerSources[${i}]`))
|
|
// At this point, layers should be expanded and validated either by the generateScript or the LegacyJsonConvert
|
|
this.layers = json.layers.map(lyrJson => new LayerConfig(<LayerConfigJson>lyrJson, json.id + ".layers." + lyrJson["id"], official));
|
|
|
|
this.extraLink = new ExtraLinkConfig(json.extraLink ?? {
|
|
icon: "./assets/svg/pop-out.svg",
|
|
href: "https://{basepath}/{theme}.html?lat={lat}&lon={lon}&z={zoom}&language={language}",
|
|
newTab: true,
|
|
requirements: ["iframe", "no-welcome-message"]
|
|
}, context + ".extraLink")
|
|
|
|
|
|
this.clustering = {
|
|
maxZoom: 16,
|
|
minNeededElements: 250,
|
|
};
|
|
if (json.clustering === false) {
|
|
this.clustering = {
|
|
maxZoom: 0,
|
|
minNeededElements: 100000,
|
|
};
|
|
} else if (json.clustering) {
|
|
this.clustering = {
|
|
maxZoom: json.clustering.maxZoom ?? 18,
|
|
minNeededElements: json.clustering.minNeededElements ?? 250,
|
|
}
|
|
}
|
|
|
|
this.hideFromOverview = json.hideFromOverview ?? false;
|
|
this.lockLocation = <[[number, number], [number, number]]>json.lockLocation ?? undefined;
|
|
this.enableUserBadge = json.enableUserBadge ?? true;
|
|
this.enableShareScreen = json.enableShareScreen ?? true;
|
|
this.enableMoreQuests = json.enableMoreQuests ?? true;
|
|
this.enableLayers = json.enableLayers ?? true;
|
|
this.enableSearch = json.enableSearch ?? true;
|
|
this.enableGeolocation = json.enableGeolocation ?? true;
|
|
this.enableAddNewPoints = json.enableAddNewPoints ?? true;
|
|
this.enableBackgroundLayerSelection = json.enableBackgroundLayerSelection ?? true;
|
|
this.enableShowAllQuestions = json.enableShowAllQuestions ?? false;
|
|
this.enableExportButton = json.enableDownload ?? false;
|
|
this.enablePdfDownload = json.enablePdfDownload ?? false;
|
|
this.customCss = json.customCss;
|
|
this.overpassUrl = Constants.defaultOverpassUrls
|
|
if (json.overpassUrl !== undefined) {
|
|
if (typeof json.overpassUrl === "string") {
|
|
this.overpassUrl = [json.overpassUrl]
|
|
} else {
|
|
this.overpassUrl = json.overpassUrl
|
|
}
|
|
}
|
|
this.overpassTimeout = json.overpassTimeout ?? 30
|
|
this.overpassMaxZoom = json.overpassMaxZoom ?? 16
|
|
this.osmApiTileSize = json.osmApiTileSize ?? this.overpassMaxZoom + 1
|
|
|
|
}
|
|
|
|
public CustomCodeSnippets(): string[] {
|
|
if (this.official) {
|
|
return [];
|
|
}
|
|
const msg = "<br/><b>This layout uses <span class='alert'>custom javascript</span>, loaded for the wide internet. The code is printed below, please report suspicious code on the issue tracker of MapComplete:</b><br/>"
|
|
const custom = [];
|
|
for (const layer of this.layers) {
|
|
custom.push(...layer.CustomCodeSnippets().map(code => code + "<br />"))
|
|
}
|
|
if (custom.length === 0) {
|
|
return custom;
|
|
}
|
|
custom.splice(0, 0, msg);
|
|
return custom;
|
|
}
|
|
|
|
public isLeftRightSensitive() {
|
|
return this.layers.some(l => l.isLeftRightSensitive())
|
|
}
|
|
|
|
public getMatchingLayer(tags: any): LayerConfig | undefined {
|
|
if (tags === undefined) {
|
|
return undefined
|
|
}
|
|
for (const layer of this.layers) {
|
|
if (layer.source.osmTags.matchesProperties(tags)) {
|
|
return layer
|
|
}
|
|
}
|
|
return undefined
|
|
}
|
|
|
|
} |