@projektemacher/storymapjs 0.10.6 → 0.10.7

package/src/core/mixins.ts

@@ -0,0 +1,171 @@
+// Mixin helpers following the TypeScript handbook mixin pattern:
+// https://www.typescriptlang.org/docs/handbook/mixins.html
+
+/* eslint-disable @typescript-eslint/no-explicit-any -- the handbook mixin
+   pattern requires mixin constructors to take a single any[] rest parameter
+   (see TS2545). */
+
+/** Constructor shape accepted by the mixin functions. */
+export type Constructor<T = object> = new (...args: any[]) => T;
+
+/** Eventing members provided by the Evented mixin. */
+export interface EventedInstance {
+    on: (type: string, fn: unknown, context?: unknown) => unknown;
+    off: (type: string, fn: unknown, context?: unknown) => unknown;
+    fire: (type: string, data?: unknown, target?: unknown) => unknown;
+    hasEventListeners: (type: string) => boolean;
+}
+
+/** Instance contract for DomMixed consumers. */
+export interface DomMixedInstance extends EventedInstance {
+    _el: Record<string, HTMLElement>;
+    data?: unknown;
+}
+
+/*	Evented
+	adds custom events functionality to a class (semantics of the former
+	core/Events class)
+================================================== */
+
+/** Adds eventing (on/off/fire/hasEventListeners) to a class. */
+export function Evented<T extends Constructor>(Base: T) {
+    return class extends Base {
+        declare "_vco_events"?: Record<string, { action: unknown; context: unknown }[]>;
+
+        on(
+            /*String*/ type: string,
+            /*Function*/ fn: unknown,
+            /*(optional) Object*/ context?: unknown,
+        ): this {
+            const events = (this._vco_events = this._vco_events || {});
+            events[type] = events[type] || [];
+            events[type].push({
+                action: fn,
+                context: context || this,
+            });
+            return this;
+        }
+
+        hasEventListeners(/*String*/ type: string) /*-> Boolean*/ {
+            return !!this._vco_events?.[type]?.length;
+        }
+
+        off(
+            /*String*/ type: string,
+            /*Function*/ fn: unknown,
+            /*(optional) Object*/ context?: unknown,
+        ): this {
+            if (!this.hasEventListeners(type)) {
+                return this;
+            }
+            const events = this._vco_events as Record<
+                string,
+                { action: unknown; context: unknown }[]
+            >;
+            for (let i = 0, len = events[type].length; i < len; i++) {
+                if (
+                    events[type][i].action === fn &&
+                    (!context || events[type][i].context === context)
+                ) {
+                    events[type].splice(i, 1);
+                    return this;
+                }
+            }
+            return this;
+        }
+
+        fire(
+            /*String*/ type: string,
+            /*(optional) Object*/ data?: unknown,
+            target?: unknown,
+        ): this {
+            if (!this.hasEventListeners(type)) {
+                return this;
+            }
+
+            const event = {
+                type: type,
+                target: target || this,
+                ...(data as Record<string, unknown> | undefined),
+            };
+
+            const listeners = (
+                this._vco_events as Record<string, { action: unknown; context: unknown }[]>
+            )[type].slice();
+
+            for (const listener of listeners) {
+                (listener.action as (e: unknown) => void).call(listener.context || this, event);
+            }
+
+            return this;
+        }
+
+        constructor(...args: any[]) {
+            super(...args);
+        }
+    };
+}
+
+/*	DomMixed
+	DOM container conveniences, replacing the former DomMixins runtime
+	mixin (addTo/removeFrom call the onAdd/onRemove lifecycle hooks)
+================================================== */
+
+/** Adds DOM container conveniences (addTo/removeFrom/setPosition/show/hide
+ *  and the onAdd/onRemove/onLoaded lifecycle events) to a class. */
+export function DomMixed<T extends Constructor<DomMixedInstance>>(Base: T) {
+    return class extends Base {
+        /*	Adding, Hiding, Showing etc
+        ================================================== */
+        show(animate?: unknown): void {
+            if (!animate) {
+                this._el.container.style.display = "block";
+            }
+            // animated show is not implemented
+        }
+
+        hide(): void {
+            this._el.container.style.display = "none";
+        }
+
+        addTo(container: HTMLElement): this {
+            container.appendChild(this._el.container);
+            this.onAdd();
+            return this;
+        }
+
+        removeFrom(container: HTMLElement): this {
+            container.removeChild(this._el.container);
+            this.onRemove();
+            return this;
+        }
+
+        /*	Set the Position
+        ================================================== */
+        setPosition(pos: Record<string, number>, el?: HTMLElement): this {
+            const target = el || this._el.container;
+            for (const name of Object.keys(pos)) {
+                (target.style as unknown as Record<string, string>)[name] = pos[name] + "px";
+            }
+            return this;
+        }
+
+        /*	Lifecycle events
+        ================================================== */
+        onLoaded(): void {
+            this.fire("loaded", this.data);
+        }
+
+        onAdd(): void {
+            this.fire("added", this.data);
+        }
+
+        onRemove(): void {
+            this.fire("removed", this.data);
+        }
+
+        constructor(...args: any[]) {
+            super(...args);
+        }
+    };
+}

package/src/dom/Dom.ts

@@ -0,0 +1,31 @@
+/*	Dom
+	Utilities for working with the DOM
+================================================= */
+
+export default class Dom {
+    static get(id: string | HTMLElement): HTMLElement | null {
+        return typeof id === "string" ? document.getElementById(id) : id;
+    }
+
+    static create(tagName: string, className: string, container?: HTMLElement): HTMLElement {
+        const el = document.createElement(tagName);
+        el.className = className;
+        if (container) {
+            container.appendChild(el);
+        }
+        return el;
+    }
+
+    static getPosition(el: HTMLElement | null): { x: number; y: number } {
+        const pos = {
+            x: 0,
+            y: 0,
+        };
+        while (el && !isNaN(el.offsetLeft) && !isNaN(el.offsetTop)) {
+            pos.x += el.offsetLeft;
+            pos.y += el.offsetTop;
+            el = el.offsetParent as HTMLElement | null;
+        }
+        return pos;
+    }
+}

package/src/dom/DomEvent.ts

@@ -0,0 +1,61 @@
+import { stamp } from "../core/Util";
+
+/*	DomEvent
+	Inspired by Leaflet
+	DomEvent contains functions for working with DOM events.
+================================================== */
+
+/** Elements/objects DomEvent listeners can be attached to. */
+type DomEventTarget = HTMLElement | Window | Document;
+
+/** Legacy drag handlers historically mixed mouse and touch event surfaces. */
+export type LegacyEvent = Event & {
+    originalEvent?: TouchEvent;
+    targetTouches?: TouchList;
+    pageX?: number;
+    pageY?: number;
+};
+
+const DomEvent = {
+    addListener: function (
+        obj: DomEventTarget,
+        type: string,
+        fn: (e: Event) => void,
+        context?: unknown,
+    ): void {
+        const handler = function (e: Event) {
+            return (fn as (this: unknown, e: Event) => void).call(context || obj, e);
+        };
+
+        obj.addEventListener(type, handler, false);
+        (obj as unknown as Record<string, unknown>)["_vco_" + type + stamp(fn)] = handler;
+    },
+
+    removeListener: function (
+        obj: DomEventTarget,
+        type: string,
+        fn: (e: Event) => void,
+        context?: unknown,
+    ): void {
+        const key = "_vco_" + type + stamp(fn);
+        const handler = (obj as unknown as Record<string, unknown>)[key];
+
+        if (!handler) {
+            return;
+        }
+
+        obj.removeEventListener(type, handler as EventListener, false);
+        (obj as unknown as Record<string, unknown>)[key] = null;
+    },
+
+    preventDefault: function (e: Event): void {
+        if (e.preventDefault) {
+            e.preventDefault();
+        } else {
+            e.returnValue = false;
+        }
+    },
+};
+
+export { DomEvent };
+export type { DomEventTarget };

package/src/globals.d.ts

@@ -0,0 +1,16 @@
+// Externally loaded script globals (YouTube/SoundCloud player APIs).
+// Everything the library or the test harness touches on window is typed
+// at its usage site instead.
+
+declare global {
+    // Externally loaded script globals
+    const YT: {
+        Player: new (el: HTMLElement | string, opts: unknown) => unknown;
+        PlayerState: Record<string, number>;
+    };
+    const SC: {
+        Widget: (el: HTMLElement) => { pause(): void };
+    };
+}
+
+export {};

package/src/language/Language.ts

@@ -0,0 +1,107 @@
+import be from "./locale/be.json";
+import bg from "./locale/bg.json";
+import cs from "./locale/cs.json";
+import de from "./locale/de.json";
+import el from "./locale/el.json";
+import en from "./locale/en.json";
+import es from "./locale/es.json";
+import et from "./locale/et.json";
+import fr from "./locale/fr.json";
+import he from "./locale/he.json";
+import hu from "./locale/hu.json";
+import isLocale from "./locale/is.json";
+import it from "./locale/it.json";
+import jp from "./locale/jp.json";
+import ko from "./locale/ko.json";
+import nl from "./locale/nl.json";
+import nn from "./locale/nn.json";
+import no from "./locale/no.json";
+import pl from "./locale/pl.json";
+import pt from "./locale/pt.json";
+import ru from "./locale/ru.json";
+import sk from "./locale/sk.json";
+import sr from "./locale/sr.json";
+import sv from "./locale/sv.json";
+import tr from "./locale/tr.json";
+import uk from "./locale/uk.json";
+import ur from "./locale/ur.json";
+import zhCn from "./locale/zh-cn.json";
+import zhTw from "./locale/zh-tw.json";
+
+interface LanguageEntry {
+    buttons?: Record<string, string>;
+    messages?: Record<string, string>;
+    [key: string]: unknown;
+}
+
+// Static locale map: the bundler-agnostic form of what `import.meta.glob`
+// with `{ eager: true }` desugars to (works in vite dev and rollup builds).
+const localeModules: Record<string, { default?: unknown }> = {
+    "./locale/be.json": { default: be },
+    "./locale/bg.json": { default: bg },
+    "./locale/cs.json": { default: cs },
+    "./locale/de.json": { default: de },
+    "./locale/el.json": { default: el },
+    "./locale/en.json": { default: en },
+    "./locale/es.json": { default: es },
+    "./locale/et.json": { default: et },
+    "./locale/fr.json": { default: fr },
+    "./locale/he.json": { default: he },
+    "./locale/hu.json": { default: hu },
+    "./locale/is.json": { default: isLocale },
+    "./locale/it.json": { default: it },
+    "./locale/jp.json": { default: jp },
+    "./locale/ko.json": { default: ko },
+    "./locale/nl.json": { default: nl },
+    "./locale/nn.json": { default: nn },
+    "./locale/no.json": { default: no },
+    "./locale/pl.json": { default: pl },
+    "./locale/pt.json": { default: pt },
+    "./locale/ru.json": { default: ru },
+    "./locale/sk.json": { default: sk },
+    "./locale/sr.json": { default: sr },
+    "./locale/sv.json": { default: sv },
+    "./locale/tr.json": { default: tr },
+    "./locale/uk.json": { default: uk },
+    "./locale/ur.json": { default: ur },
+    "./locale/zh-cn.json": { default: zhCn },
+    "./locale/zh-tw.json": { default: zhTw },
+};
+
+const EN: Record<string, unknown> =
+    (localeModules["./locale/en.json"]?.default as Record<string, unknown> | undefined) || {};
+
+let Language: LanguageEntry = {};
+
+function getLanguage(code: string): Record<string, unknown> {
+    const lang = structuredClone(
+        (localeModules[`./locale/${code}.json`]?.default as Record<string, unknown> | undefined) ||
+            {},
+    );
+    for (const k in EN) {
+        if (lang[k]) {
+            if (typeof EN[k] == "object" && EN[k] !== null && typeof lang[k] == "object") {
+                // fresh object: never mutate the shared English default,
+                // otherwise one setLanguage() call would poison every later
+                // lookup (and every other language falling back to English)
+                lang[k] = Object.assign({}, EN[k] as object, lang[k]);
+            }
+        } else {
+            lang[k] = structuredClone(EN[k]);
+        }
+    }
+    return lang;
+}
+
+/**
+ * Switch the active UI language.
+ *
+ * @param code - A locale code for which a locale file exists (e.g. `"en"`).
+ * @returns The language entry that is now active.
+ */
+function setLanguage(code: string): LanguageEntry {
+    Language = getLanguage(code);
+    return Language;
+}
+
+export { setLanguage, Language };

package/src/language/locale/be.json

@@ -0,0 +1,18 @@
+{
+    "name": "Беларуская",
+    "lang": "be",
+    "messages": {
+        "loading": "Загрузка",
+        "wikipedia": "Вікіпедыя",
+        "start": "Start Exploring"
+    },
+    "buttons": {
+        "map_overview": "Прагляд мапы",
+        "overview": "Прагляд",
+        "backtostart": "Вярнуцца ў пачатак",
+        "collapse_toggle": "Схаваць мапу",
+        "uncollapse_toggle": "Паказаць мапу",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/bg.json

@@ -0,0 +1,18 @@
+{
+    "name": "Български",
+    "lang": "bg",
+    "messages": {
+        "loading": "Зареждане",
+        "wikipedia": "От Уикипедия, свободната енциклопедия",
+        "start": "Започнете да разглеждате"
+    },
+    "buttons": {
+        "map_overview": "Преглед на картата",
+        "overview": "Преглед",
+        "backtostart": "Към началото",
+        "collapse_toggle": "Скриване на картата",
+        "uncollapse_toggle": "Показване на картата",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/cs.json

@@ -0,0 +1,18 @@
+{
+    "name": "Čeština",
+    "lang": "cs",
+    "messages": {
+        "loading": "Nahrávání",
+        "wikipedia": "Z Wikipedie, svobodné encyklopedie",
+        "start": "Prozkoumat"
+    },
+    "buttons": {
+        "map_overview": "Přehledová mapa",
+        "overview": "Přehled",
+        "backtostart": "Zpět na začátek",
+        "collapse_toggle": "Skrýt mapu",
+        "uncollapse_toggle": "Zobrazit mapu",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/de.json

@@ -0,0 +1,20 @@
+{
+    "name": "Deutsch",
+    "lang": "de",
+    "messages": {
+        "loading": "Daten werden geladen",
+        "wikipedia": "von Wikipedia, der freien Enzyklopädie",
+        "start": "Explore"
+    },
+    "buttons": {
+        "map_overview": "Kartenübersicht",
+        "overview": "Kartenübersicht",
+        "backtostart": "Zurück zum Anfang",
+        "collapse_toggle": "Karte ausblenden",
+        "uncollapse_toggle": "Karte anzeigen",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>",
+        "fullscreen": "Vollbild",
+        "exit_fullscreen": "Vollbild beenden"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/el.json

@@ -0,0 +1,18 @@
+{
+    "name": "Ελληνικά",
+    "lang": "el",
+    "messages": {
+        "loading": "Φόρτωση",
+        "wikipedia": "Από την Wikipedia, την ελεύθερη εγκυκλοπαίδεια",
+        "start": "Έναρξη περιήγησης"
+    },
+    "buttons": {
+        "map_overview": "Επισκόπηση χάρτη",
+        "overview": "Επισκόπηση",
+        "backtostart": "Επιστροφή στην αρχή",
+        "collapse_toggle": "Απόκρυψη χάρτη",
+        "uncollapse_toggle": "Εμφάνιση χάρτη",
+        "swipe_to_navigate": "Κτυπήστε ελαφρά για περιήγηση<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/en.json

@@ -0,0 +1,28 @@
+{
+    "name": "English",
+    "lang": "en",
+    "messages": {
+        "error": "Error loading",
+        "loading": "Loading",
+        "wikipedia": "From Wikipedia, the free encyclopedia",
+        "start": "Start Exploring",
+        "consent_title": "External content",
+        "consent_message": "Load content from {service}?",
+        "consent_allow": "Allow",
+        "consent_deny": "Deny",
+        "consent_blocked": "Content from {service} is blocked.",
+        "consent_service_tiles": "map tiles",
+        "consent_service_fonts": "web fonts"
+    },
+    "buttons": {
+        "map_overview": "Map Overview",
+        "overview": "Overview",
+        "backtostart": "Back To Beginning",
+        "collapse_toggle": "Hide Map",
+        "uncollapse_toggle": "Show Map",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>",
+        "fullscreen": "Full Screen",
+        "exit_fullscreen": "Exit Full Screen"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/es.json

@@ -0,0 +1,18 @@
+{
+    "name": "Español",
+    "lang": "es",
+    "messages": {
+        "loading": "cargando",
+        "wikipedia": "de Wikipedia, la enciclopedia libre",
+        "start": "Explore"
+    },
+    "buttons": {
+        "map_overview": "vista general del mapa",
+        "overview": "vista general",
+        "backtostart": "volver al comienzo",
+        "collapse_toggle": "ocultar mapa",
+        "uncollapse_toggle": "mostrar mapa",
+        "swipe_to_navigate": "Deslizar para navegar<br><span class='vco-button'>Entendido</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/et.json

@@ -0,0 +1,18 @@
+{
+    "name": "eesti",
+    "lang": "et",
+    "messages": {
+        "loading": "Laadib",
+        "wikipedia": "Vikipeedia, vaba entsüklopeedia",
+        "start": "Uuri"
+    },
+    "buttons": {
+        "map_overview": "Kaardi ülevaade",
+        "overview": "Ülevaade",
+        "backtostart": "Tagasi algusesse",
+        "collapse_toggle": "Peida kaart",
+        "uncollapse_toggle": "Näita kaarti",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/fr.json

@@ -0,0 +1,18 @@
+{
+    "name": "Français",
+    "lang": "fr",
+    "messages": {
+        "loading": "Chargement",
+        "wikipedia": "Extrait de Wikipédia, l'encyclopédie libre",
+        "start": "Explore"
+    },
+    "buttons": {
+        "map_overview": "Vue d'ensemble de la carte",
+        "overview": "Vue d'ensemble",
+        "backtostart": "Retourner au point de départ",
+        "collapse_toggle": "Masquer la carte",
+        "uncollapse_toggle": "Afficher la carte",
+        "swipe_to_navigate": "Faites glisser pour naviguer<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/he.json

@@ -0,0 +1,18 @@
+{
+    "name": "עברית",
+    "lang": "he",
+    "direction": "rtl",
+    "messages": {
+        "loading": "טוען",
+        "wikipedia": "מתוך ויקיפדיה, האנציקלופדיה החופשית",
+        "start": "התחל במסע"
+    },
+    "buttons": {
+        "map_overview": "המפה במלואה",
+        "overview": "תצוגה מקדימה",
+        "backtostart": "חזור להתחלה",
+        "collapse_toggle": "הסתר מפה",
+        "uncollapse_toggle": "הצג מפה",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    }
+}

package/src/language/locale/hu.json

@@ -0,0 +1,18 @@
+{
+    "name": "Magyar",
+    "lang": "hu",
+    "messages": {
+        "loading": "töltés",
+        "wikipedia": "Wikipedia",
+        "start": "Indítsd"
+    },
+    "buttons": {
+        "map_overview": "teljes térkép",
+        "overview": "teljes sztori",
+        "backtostart": "vissza az elejére",
+        "collapse_toggle": "összecsuk",
+        "uncollapse_toggle": "kinyit",
+        "swipe_to_navigate": "Húzd el a navigációhoz<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/is.json

@@ -0,0 +1,18 @@
+{
+    "name": "Icelandic",
+    "lang": "is",
+    "messages": {
+        "loading": "Hleðsla",
+        "wikipedia": "Frá Wikipedia",
+        "start": "Hefja"
+    },
+    "buttons": {
+        "map_overview": "Kortayfirlit",
+        "overview": "Yfirlit",
+        "backtostart": "Hefja aftur",
+        "collapse_toggle": "Fela kortið",
+        "uncollapse_toggle": "Sýna kortið",
+        "swipe_to_navigate": "Strjúktu fyrir valmynd<br><span class='vco-button'>Allt í lagi</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/it.json

@@ -0,0 +1,18 @@
+{
+    "name": "Italiano",
+    "lang": "it",
+    "messages": {
+        "loading": "caricare",
+        "wikipedia": "da Wikipedia, la enciclopedia libera",
+        "start": "Explore"
+    },
+    "buttons": {
+        "map_overview": "vista generale della mappa",
+        "overview": "vista generale",
+        "backtostart": "tornare all' inizio",
+        "collapse_toggle": "nascondere mappa",
+        "uncollapse_toggle": "mostrare mappa",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}

package/src/language/locale/jp.json

@@ -0,0 +1,18 @@
+{
+    "name": "日本語",
+    "lang": "jp",
+    "messages": {
+        "loading": "ローディング",
+        "wikipedia": "フリー百科事典ウィキペディア（Wikipedia）から",
+        "start": "Explore"
+    },
+    "buttons": {
+        "map_overview": "概観地図",
+        "overview": "概観",
+        "backtostart": "初めに戻る",
+        "collapse_toggle": "地図を隠す",
+        "uncollapse_toggle": "地図を表示",
+        "swipe_to_navigate": "Swipe to Navigate<br><span class='vco-button'>OK</span>"
+    },
+    "direction": "ltr"
+}