🔀🎉 nameSchema module as replacement for v3 renameFz

.eslintignore

@@ -18,4 +18,3 @@ static/missions/*
 static/releasenotes/*
 
 src/modules/support/*
-src/modules/renameFz/*

docs/.vuepress/utils/v3Comparison.json

@@ -39,6 +39,7 @@
         "overview": { "module": "overview" },
         "Redesign01": { "module": "redesign" },
         "releaseNotes": { "module": "" },
+        "RenameFz": { "module": "nameSchema" },
         "ShareAlliancePost": { "module": "shareAlliancePost" },
         "showChatButtonAbove": {
             "module": "chatExtras",
@@ -65,7 +66,6 @@
         "Layout02",
         "Layout03",
         "Layout04",
-        "RenameFZ",
         "WachenplanungOnMap",
         "fms7Target",
         "geoBorders",

package.json

@@ -29,6 +29,7 @@
         "highcharts": "11.3.0",
         "highcharts-vue": "1.4.3",
         "leaflet.heat": "0.2.0",
+        "liquidjs": "10.10.0",
         "localforage": "1.10.0",
         "lodash": "4.17.21",
         "mini-svg-data-uri": "1.4.4",

src/generated/libraries.json

@@ -274,6 +274,10 @@
         "url": "https://github.com/Leaflet/Leaflet.heat",
         "version": "0.2.0"
     },
+    "liquidjs": {
+        "url": "https://github.com/harttle/liquidjs#readme",
+        "version": "10.10.0"
+    },
     "local-web-server": {
         "version": "5.3.1"
     },

src/modules/nameSchema/README.md

@@ -0,0 +1,3 @@
+# Name Schema
+
+Provides bulk-renaming of vehicles and buildings.

src/modules/nameSchema/assets/helper/exclusion.ts

@@ -0,0 +1,39 @@
+import type { ModuleMainFunction } from 'typings/Module';
+
+export default class ExclusionHelper {
+    private excludedBuildings: string[] = [];
+    private excludedVehicles: string[] = [];
+
+    constructor(
+        private readonly moduleParams: Parameters<ModuleMainFunction>[0]
+    ) {}
+
+    public async init() {
+        const {
+            MODULE_ID: moduleId,
+            LSSM: {
+                $stores: { settings },
+            },
+        } = this.moduleParams;
+
+        this.excludedBuildings = await settings.getSetting<string[]>({
+            moduleId,
+            settingId: 'excludeBuildings',
+            defaultValue: [],
+        });
+
+        this.excludedVehicles = await settings.getSetting<string[]>({
+            moduleId,
+            settingId: 'excludeVehicles',
+            defaultValue: [],
+        });
+    }
+
+    public isBuildingTypeExcluded(typeId: number) {
+        return this.excludedBuildings.some(id => Number(id) === typeId);
+    }
+
+    public isVehicleTypeExcluded(typeId: number) {
+        return this.excludedVehicles.some(id => Number(id) === typeId);
+    }
+}

src/modules/nameSchema/assets/helper/numeral.ts

@@ -0,0 +1,216 @@
+/**
+ * Convert a number to a roman numeral.
+ * @param num - Number to convert.
+ * @returns Roman numeral.
+ * @see https://stackoverflow.com/a/41358305
+ */
+export const convertNumberToRoman = (num: number): string => {
+    const roman: Record<string, number> = {
+        M: 1000,
+        CM: 900,
+        D: 500,
+        CD: 400,
+        C: 100,
+        XC: 90,
+        L: 50,
+        XL: 40,
+        X: 10,
+        IX: 9,
+        V: 5,
+        IV: 4,
+        I: 1,
+    };
+    let str = '';
+    let rest = num;
+
+    for (const i of Object.keys(roman)) {
+        const q = Math.floor(rest / roman[i]);
+        rest -= q * roman[i];
+        str += i.repeat(q);
+    }
+
+    return str;
+};
+
+/**
+ * Convert a number to a string of letters.
+ * @param num - Number to convert.
+ * @returns String of letters.
+ */
+export const convertNumberToAlpha = (num: number): string => {
+    let str = '';
+    let rest = num;
+
+    do {
+        const q = rest % 26;
+        rest = Math.floor(rest / 26);
+        str = String.fromCharCode(64 + q) + str;
+    } while (rest > 0);
+
+    return str;
+};
+
+/**
+ * Convert a number to ICAO alphabet word.
+ * @param num - Number to convert.
+ * @returns ICAO alphabet word.
+ * @see https://de.wikipedia.org/wiki/ICAO-Alphabet
+ */
+export const convertNumberToICAOAlpha = (num: number): string => {
+    const alphabet = [
+        'Alfa',
+        'Bravo',
+        'Charlie',
+        'Delta',
+        'Echo',
+        'Foxtrot',
+        'Golf',
+        'Hotel',
+        'India',
+        'Juliett',
+        'Kilo',
+        'Lima',
+        'Mike',
+        'November',
+        'Oscar',
+        'Papa',
+        'Quebec',
+        'Romeo',
+        'Sierra',
+        'Tango',
+        'Uniform',
+        'Victor',
+        'Whiskey',
+        'X-Ray',
+        'Yankee',
+        'Zulu',
+    ];
+    return alphabet[(num - 1) % alphabet.length];
+};
+
+/**
+ * Convert a number to a greek letter.
+ * @param num - Number to convert.
+ * @returns Greek letter.
+ */
+export const convertNumberToGreek = (num: number): string => {
+    const alphabet = [
+        'Alpha',
+        'Beta',
+        'Gamma',
+        'Delta',
+        'Epsilon',
+        'Zeta',
+        'Eta',
+        'Theta',
+        'Iota',
+        'Kappa',
+        'Lambda',
+        'My',
+        'Ny',
+        'Xi',
+        'Omikron',
+        'Pi',
+        'Rho',
+        'Sigma',
+        'Tau',
+        'Ypsilon',
+        'Phi',
+        'Chi',
+        'Psi',
+        'Omega',
+    ];
+    return alphabet[(num - 1) % alphabet.length];
+};
+
+/**
+ * Convert a string number to a string of emoji digits.
+ * @param string - String number to convert.
+ * @returns String of emoji digits.
+ */
+export const convertStringNumberToEmoji = (string: string): string => {
+    const emojiNum = (digit: number) =>
+        `${String.fromCodePoint(48 + (digit % 10))}\ufe0f\u20e3`;
+
+    let str = '';
+    for (const element of string) str += emojiNum(Number(element));
+
+    return str;
+};
+
+/**
+ * Convert a number to a german phonetic alphabet word.
+ * @param num - Number to convert.
+ * @returns German phonetic alphabet word.
+ * @see https://de.wikipedia.org/wiki/Buchstabiertafel
+ */
+export const convertNumberToGermanPhonetic = (num: number): string => {
+    const alphabet = [
+        'Anton',
+        'Berta',
+        'Cäsar',
+        'Dora',
+        'Emil',
+        'Friedrich',
+        'Gustav',
+        'Heinrich',
+        'Ida',
+        'Julius',
+        'Kaufmann',
+        'Ludwig',
+        'Martha',
+        'Nordpol',
+        'Otto',
+        'Paula',
+        'Quelle',
+        'Richard',
+        'Samuel',
+        'Theodor',
+        'Ulrich',
+        'Viktor',
+        'Wilhelm',
+        'Xanthippe',
+        'Ypsilon',
+        'Zacharias',
+    ];
+
+    return alphabet[(num - 1) % alphabet.length];
+};
+
+/**
+ * Convert a number to an austrian phonetic alphabet word.
+ * @param num - Number to convert.
+ * @returns Austrian phonetic alphabet word.
+ * @see https://de.wikipedia.org/wiki/Buchstabiertafel
+ */
+export const convertNumberToAustrianPhonetic = (num: number): string => {
+    const alphabet = [
+        'Anton',
+        'Berta',
+        'Cäsar',
+        'Dora',
+        'Emil',
+        'Friedrich',
+        'Gustav',
+        'Heinrich',
+        'Ida',
+        'Julius',
+        'Konrad',
+        'Ludwig',
+        'Martha',
+        'Nordpol',
+        'Otto',
+        'Paula',
+        'Richard',
+        'Siegfried',
+        'Theodor',
+        'Ulrich',
+        'Viktor',
+        'Wilhelm',
+        'Xaver',
+        'Ypsilon',
+        'Zürich',
+    ];
+
+    return alphabet[(num - 1) % alphabet.length];
+};

src/modules/nameSchema/assets/helper/rename.ts

@@ -0,0 +1,63 @@
+import type { ModuleMainFunction } from 'typings/Module';
+
+export default class RenameHelper {
+    constructor(
+        private readonly moduleParams: Parameters<ModuleMainFunction>[0]
+    ) {}
+
+    private async request(url: URL, feature: string) {
+        const { LSSM, MODULE_ID } = this.moduleParams;
+
+        url.searchParams.append('_method', 'put');
+        url.searchParams.append('utf8', '✓');
+        url.searchParams.append(
+            'authenticity_token',
+            document
+                .querySelector('meta[name="csrf-token"]')
+                ?.getAttribute('content') || ''
+        );
+
+        try {
+            await LSSM.$stores.api.request({
+                url: url.pathname,
+                feature: `${MODULE_ID}-${feature}`,
+                dialogOnError: false,
+                init: {
+                    redirect: 'manual',
+                    credentials: 'include',
+                    headers: {
+                        'Content-Type': 'application/x-www-form-urlencoded',
+                        'Upgrade-Insecure-Requests': '1',
+                    },
+                    referrer: window.location.href,
+                    body: url.searchParams.toString(),
+                    method: 'POST',
+                    mode: 'cors',
+                },
+            });
+        } catch (e: unknown) {
+            if (e instanceof Response && e.type === 'opaqueredirect') {
+                // expected redirect
+                return;
+            }
+
+            // rethrow error
+            throw e;
+        }
+    }
+
+    public async renameVehicle(vehicleId: number, newCaption: string) {
+        const url = new URL(`/vehicles/${vehicleId}`, window.location.origin);
+
+        url.searchParams.append('vehicle[caption]', newCaption);
+
+        return this.request(url, 'rename-vehicle');
+    }
+    public async renameBuilding(buildingId: number, newCaption: string) {
+        const url = new URL(`/buildings/${buildingId}`, window.location.origin);
+
+        url.searchParams.append('building[name]', newCaption);
+
+        return this.request(url, 'rename-building');
+    }
+}