Auto-updater for the Tiled extension.

Author: KockaAdmiralac

.gitignore

@@ -2,4 +2,5 @@
 *.png
 *.tiled-session
 *.tmx
+bundle.json
 node_modules

extensions/include/session.mjs

@@ -1,5 +1,6 @@
 const ACCESS_TOKEN_PROPERTY = 'wikiAccessToken';
 const LAST_LANGUAGE_PROPERTY = 'wikiLastLanguage';
+const DISABLE_UPDATE_CHECKS = 'wikiDisableUpdateChecks';
 
 /**
  * Retrieves the path to the Tiled session file.
@@ -75,3 +76,18 @@ export function storeLastLanguage(language) {
     setSessionProperty(LAST_LANGUAGE_PROPERTY, language);
 }
 
+/**
+ * Checks if automatic update checks are disabled.
+ * @returns {boolean} True if automatic update checks are disabled
+ */
+export function areAutoUpdateChecksDisabled() {
+    return getSessionProperty(DISABLE_UPDATE_CHECKS) === true;
+}
+
+/**
+ * Sets whether automatic update checks are disabled.
+ * @param {boolean} disabled True to disable automatic update checks
+ */
+export function storeAutoUpdateChecksDisabled(disabled) {
+    setSessionProperty(DISABLE_UPDATE_CHECKS, disabled);
+}

extensions/update.mjs

@@ -0,0 +1,129 @@
+import { httpGet } from './include/api.mjs';
+import {
+    areAutoUpdateChecksDisabled,
+    storeAutoUpdateChecksDisabled,
+} from './include/session.mjs';
+
+// Conflict with the DOM File type.
+const TiledFile = /** @type {any} */ (File);
+
+/**
+ * Checks if the repository has been set up using Git.
+ * @returns {boolean} If the repository is using Git
+ */
+function isGit() {
+    const p = new Process();
+    p.workingDirectory = tiled.project.extensionsPath;
+    const status = p.exec('git', ['status'], false);
+    return status === 0;
+}
+
+/**
+ * Runs `git pull`.
+ */
+function pullGit() {
+    const p = new Process();
+    p.workingDirectory = tiled.project.extensionsPath;
+    const status = p.exec('git', ['pull'], false);
+    if (status !== 0) {
+        tiled.alert(`Failed to pull updates from Git: ${p.readStdErr()}`);
+    } else {
+        tiled.log(p.readStdOut());
+    }
+}
+
+/**
+ * Recursively retrieves all files in a directory and its subdirectories that
+ * are relevant to the update process.
+ * @param {string} dir Directory to inspect for files
+ * @param {string[]} prefix Base directory for relative paths
+ * @returns {Record<string, string>}
+ */
+function getAllUpdaterFiles(dir, prefix = []) {
+    const /** @type {Record<string, string>} */ files = {};
+    for (const fileName of TiledFile.directoryEntries(dir, 2, 0)) {
+        if (!fileName.endsWith('.mjs') && !fileName.endsWith('.svg')) {
+            continue;
+        }
+        const file = new TextFile(`${dir}/${fileName}`, TextFile.ReadOnly);
+        files[[...prefix, fileName].join('/')] = file.readAll();
+        file.close();
+    }
+    for (const directory of TiledFile.directoryEntries(dir, 24577, 0)) {
+        Object.assign(files, getAllUpdaterFiles(
+            FileInfo.joinPaths(dir, directory),
+            [...prefix, directory]
+        ));
+    }
+    return files;
+}
+
+/**
+ * Prompts the user to update the extension if any changes have been detected
+ * and auto-update is enabled.
+ */
+function update() {
+    if (areAutoUpdateChecksDisabled()) {
+        return;
+    }
+    const localFiles = getAllUpdaterFiles(tiled.project.extensionsPath);
+    tiled.log(JSON.stringify(Object.keys(localFiles)));
+
+    httpGet('https://maps.undertale.wiki/bundle.json').then(bundle => {
+        const onlyLocalFiles = Object.keys(localFiles).filter(path => !(path in bundle));
+        const diffFiles = Object.entries(bundle).filter(([path, content]) => {
+            const filePath = FileInfo.joinPaths(tiled.project.extensionsPath, path);
+            if (!TiledFile.exists(filePath)) {
+                return true;
+            }
+            const file = new TextFile(filePath, TextFile.ReadOnly);
+            const localContent = file.readAll();
+            file.close();
+            return localContent !== content;
+        });
+        if (onlyLocalFiles.length === 0 && diffFiles.length === 0) {
+            tiled.log('Extension is up to date.');
+            return;
+        }
+        if (isGit()) {
+            if (tiled.confirm('Updates are available for the wiki extension, but you are using Git. Do you want to run git pull? (You can disable these prompts using Edit > Disable tiled-datamaps update checks.)')) {
+                pullGit();
+            }
+            return;
+        }
+        if (!tiled.confirm(`Updates are available for the wiki extension! Do you want to update now? (You can disable these prompts using Edit > Disable tiled-datamaps update checks.)`)) {
+            return;
+        }
+        for (const path of onlyLocalFiles) {
+            TiledFile.remove(FileInfo.joinPaths(tiled.project.extensionsPath, path));
+        }
+        for (const [path, content] of diffFiles) {
+            const filePath = FileInfo.joinPaths(tiled.project.extensionsPath, path);
+            TiledFile.makePath(FileInfo.path(filePath));
+            const file = new TextFile(filePath, TextFile.WriteOnly);
+            file.write(content);
+            file.commit();
+        }
+        tiled.alert('Extension updated successfully! Please restart Tiled to apply the updates.');
+    }).catch(error => {
+        tiled.alert(`Failed to check for updates: ${error.message}. Check the console for more details.`);
+        tiled.log(`Error details: ${error.stack}`);
+    });
+}
+
+const enablePopup = tiled.registerAction('WikiDisableUpdateChecks', () => {
+    storeAutoUpdateChecksDisabled(enablePopup.checked);
+});
+enablePopup.checkable = true;
+enablePopup.checked = areAutoUpdateChecksDisabled();
+enablePopup.icon = 'images/wiki.svg';
+enablePopup.iconVisibleInMenu = false;
+enablePopup.text = 'Disable tiled-datamaps update checks';
+
+tiled.extendMenu('Edit', [
+    {
+        action: 'WikiDisableUpdateChecks'
+    }
+]);
+
+update();

package.json

@@ -27,5 +27,6 @@
         "typescript": "5.9.3"
     },
     "packageManager": "npm@11.6.2",
-    "private": true
+    "private": true,
+    "type": "module"
 }

pages/bundle.js

@@ -0,0 +1,19 @@
+import {readdir, readFile, writeFile} from 'fs/promises';
+import {join} from 'path';
+import {fileURLToPath} from 'url';
+
+const bundle = {};
+const scriptDir = join(fileURLToPath(import.meta.url), '..');
+const extensionsDir = join(scriptDir, '..', 'extensions');
+for (const dir of await readdir(extensionsDir, {
+    recursive: true,
+    withFileTypes: true,
+})) {
+    if (dir.isFile() && (dir.name.endsWith('.mjs') || dir.name.endsWith('.svg'))) {
+        const filePath = join(dir.parentPath, dir.name);
+        const content = await readFile(filePath, 'utf-8');
+        const relativePath = filePath.slice(extensionsDir.length + 1);
+        bundle[relativePath] = content;
+    }
+}
+await writeFile(join(scriptDir, 'bundle.json'), JSON.stringify(bundle));