Restructure metadata in preparation for truth source change.

Author: KockaAdmiralac

extensions/includes/format.mjs

@@ -1,3 +1,5 @@
+import { getLanguageCodes } from './language.mjs';
+import { InterwikiDataImpl, MetadataImpl } from './metadata.mjs';
 import {
     addPoints,
     getBoolProperty,
@@ -156,14 +158,35 @@ function convertLayer(layer, datamap, convertedLayers, language) {
     convertedLayers.add(layer.id);
 }
 
+/**
+ * Retrieves map metadata to store in DataMaps for two-way conversion.
+ * @param {TileMap} map Tiled map being converted to DataMaps
+ * @param {string} mapName Filename of the Tiled map
+ * @returns {MetadataImpl} Map metadata to store in DataMaps
+ */
+function getDataMapsMetadata(map, mapName) {
+    const metadata = new MetadataImpl();
+    for (const language of getLanguageCodes()) {
+        const localizedMapName = getStringProperty(map, 'name', language);
+        if (!localizedMapName && language !== 'en') {
+            continue;
+        }
+        metadata.interwiki[language] = new InterwikiDataImpl({
+            mapName: localizedMapName || mapName
+        });
+    }
+    metadata.fileName = mapName;
+    return metadata;
+}
+
 /**
  * Converts a Tiled map to DataMaps format.
  * @param {TileMap} map Tiled map to convert to DataMaps
  * @param {string} mapName Filename of the Tiled map
  * @param {string} language Language to use for localized properties
  * @returns {DataMap} Converted DataMap object
  */
-export function convertMap(map, mapName, language = 'en') {
+export function convertTiledToDataMaps(map, mapName, language = 'en') {
     const /** @type {DataMap} */ datamap = {
         $schema: '/extensions/DataMaps/schemas/v17.3.json',
         backgrounds: [{
@@ -179,9 +202,7 @@ export function convertMap(map, mapName, language = 'en') {
                 map.height * map.tileHeight
             ]
         },
-        custom: {
-            mapName: getStringProperty(map, 'name', language) || mapName
-        },
+        custom: getDataMapsMetadata(map, mapName),
         disclaimer: getStringProperty(map, 'disclaimer', language),
         include: getListProperty(map, 'include', language),
         markers: {},
@@ -208,14 +229,14 @@ export function convertMap(map, mapName, language = 'en') {
  */
 function write(map, filePath) {
     const mapName = FileInfo.completeBaseName(FileInfo.fileName(filePath));
-    const convertedMap = convertMap(map, mapName);
+    const convertedMap = convertTiledToDataMaps(map, mapName);
     const file = new TextFile(filePath, TextFile.WriteOnly);
     file.write(`${JSON.stringify(convertedMap, null, 4)}\n`);
     file.commit();
 }
 
 export default /** @type {ScriptedMapFormat} */ {
-    extension: 'json',
+    extension: 'mw-datamaps',
     name: 'DataMaps',
     write
 };

extensions/includes/language.mjs

@@ -5,7 +5,7 @@ import { getStringProperty } from './util.mjs';
  * Gets all wiki language codes for the current Tiled project.
  * @returns {string[]} Available wiki language codes
  */
-function getLanguageCodes() {
+export function getLanguageCodes() {
     const languagesStr = getStringProperty(tiled.project, 'languages') || 'en';
     return languagesStr.split(',').map(lang => lang.trim());
 }

extensions/includes/metadata.mjs

@@ -0,0 +1,60 @@
+const CURRENT_VERSION = 0;
+
+/**
+ * @implements {Metadata}
+ */
+export class MetadataImpl {
+    /**
+     * Class constructor.
+     * @param {Metadata|undefined} metadata Metadata
+     */
+    constructor(metadata = undefined) {
+        /** @type {Record<string, InterwikiDataImpl>} */
+        this.interwiki = {};
+        /** @type {number} */
+        this.version = metadata?.version || CURRENT_VERSION;
+        /** @type {string|undefined} */
+        this.fileName = metadata?.fileName;
+        if (metadata?.interwiki) {
+            for (const [key, value] of Object.entries(metadata.interwiki)) {
+                this.interwiki[key] = new InterwikiDataImpl(value);
+            }
+        }
+    }
+    /**
+     * Serializes the metadata to JSON.
+     * @returns {object} Metadata with unneeded properties removed.
+     */
+    toJSON() {
+        return {
+            fileName: this.fileName,
+            interwiki: this.interwiki,
+            version: this.version,
+        };
+    }
+}
+
+/**
+ * @implements {InterwikiData}
+ */
+export class InterwikiDataImpl {
+    /**
+     * Class constructor.
+     * @param {InterwikiData} data Interwiki data
+     */
+    constructor(data) {
+        /** @type {string} */
+        this.mapName = data.mapName;
+        /** @type {number} */
+        this.revision = 0;
+    }
+    /**
+     * Serializes the interwiki data to JSON.
+     * @returns {object} Interwiki data with unneeded properties removed.
+     */
+    toJSON() {
+        return {
+            mapName: this.mapName,
+        };
+    }
+}

extensions/includes/publish.mjs

@@ -4,7 +4,7 @@ import {
     generateOAuthUrl,
     getAccessToken
 } from './auth.mjs';
-import { convertMap } from './format.mjs';
+import { convertTiledToDataMaps } from './format.mjs';
 import { getDefaultLanguageIndex, getLanguageNames, selectLanguage } from './language.mjs';
 import { getStoredToken, storeToken } from './session.mjs';
 
@@ -128,9 +128,9 @@ function getToken(language) {
  */
 function publishMap(accessToken, summary, map, language) {
     const mapName = FileInfo.completeBaseName(FileInfo.fileName(map.fileName));
-    const datamap = convertMap(map, mapName, language);
+    const datamap = convertTiledToDataMaps(map, mapName, language);
     return edit(
-        `Map:${datamap.custom?.mapName}`,
+        `Map:${datamap.custom?.interwiki?.[language].mapName}`,
         JSON.stringify(datamap),
         summary,
         accessToken,

extensions/tsconfig.json

@@ -11,6 +11,7 @@
 		"target": "ES2016",
 		"lib": [
             "ES2016",
+			"ES2017.Object",
 			"DOM"
         ],
 		"baseUrl": "extensions",

extensions/types/map.d.ts

@@ -11,5 +11,5 @@ interface DataMap {
     categories?: Record<string, MarkerCategory>
     disclaimer?: string
     markers: Record<string, Marker[]>
-    custom?: Record<string, any>
+    custom?: Metadata
 }

extensions/types/metadata.d.ts

@@ -0,0 +1,11 @@
+interface InterwikiData {
+    mapName: string;
+    [key: string]: any;
+}
+
+interface Metadata {
+    interwiki?: Record<string, InterwikiData>;
+    fileName?: string;
+    version: number;
+    [key: string]: any;
+}