@vandenberghinc/volt 1.2.6 → 1.2.8

package/frontend/dist/frontend/src/modules/cookies.js

@@ -0,0 +1,143 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+// Imports.
+import { Google } from "./google.js";
+// Cookies object.
+export var Cookies;
+(function (Cookies) {
+    let _cookies = {};
+    let _last_cookies = '';
+    Cookies.enabled = false;
+    /**
+     * Checks if cookies need to be parsed again.
+     * @docs
+     */
+    function is_parse_required() {
+        return document.cookie !== _last_cookies;
+    }
+    Cookies.is_parse_required = is_parse_required;
+    /**
+     * Get cookies or a specific cookie by name.
+     * @experimental true
+     * @param name The name of the cookie.
+     * @docs
+     */
+    function get(name = null) {
+        if (document.cookie === _last_cookies) {
+            if (name != null) {
+                return _cookies[name];
+            }
+            return _cookies;
+        }
+        // Attributes.
+        _cookies = {};
+        _last_cookies = document.cookie;
+        // Vars.
+        let is_key = true, is_str = null;
+        let key = "", value = "";
+        // Wrapper.
+        const append = () => {
+            if (key.length > 0) {
+                _cookies[key] = decodeURIComponent(value);
+            }
+            value = "";
+            key = "";
+            is_key = true;
+            is_str = null;
+        };
+        // Parse.
+        for (let i = 0; i < document.cookie.length; i++) {
+            const c = document.cookie.charAt(i);
+            // Is key.
+            if (is_key) {
+                if (c === " " || c === "\t") {
+                    continue;
+                }
+                else if (c === "=") {
+                    is_key = false;
+                }
+                else {
+                    key += c;
+                }
+            }
+            // Is value.
+            else {
+                // End of string.
+                if (is_str != null && is_str === c) {
+                    value = value.substr(1, value.length - 1);
+                    append();
+                }
+                // End of cookie.
+                else if (c === ";") {
+                    append();
+                }
+                // Append to value.
+                else {
+                    // Start of string.
+                    if (value.length === 0 && (c === "\"" || c === "'")) {
+                        is_str = c;
+                    }
+                    value += c;
+                }
+            }
+        }
+        append();
+        if (name != null) {
+            return _cookies[name];
+        }
+        return _cookies;
+    }
+    Cookies.get = get;
+    /**
+     * Checks if the user has set a cookie preference (enabled or disabled).
+     * @docs
+     */
+    function has_preference() {
+        const pref = localStorage.getItem("volt_cookies_enabled");
+        return pref === "true" || pref === "false";
+    }
+    Cookies.has_preference = has_preference;
+    // Check if all the cookies are accepted.
+    /**
+     * Checks if cookies are accepted by the user.
+     * @docs
+     */
+    function is_accepted() {
+        return localStorage.getItem("volt_cookies_enabled") === "true";
+    }
+    Cookies.is_accepted = is_accepted;
+    /**
+     * Enables cookies (opt-in) and updates the user's preference.
+     * @param _set_storage Whether to update the localStorage preference (default: true).
+     * @docs
+     */
+    function enable(_set_storage = true) {
+        Cookies.enabled = true;
+        if (_set_storage) {
+            localStorage.setItem("volt_cookies_enabled", "true");
+        }
+        Google.disable_tracking();
+    }
+    Cookies.enable = enable;
+    /**
+     * Disables cookies (opt-out) and updates the user's preference.
+     * @param _set_storage Whether to update the localStorage preference (default: true).
+     * @docs
+     */
+    function disable(_set_storage = true) {
+        Cookies.enabled = false;
+        if (_set_storage) {
+            localStorage.setItem("volt_cookies_enabled", "false");
+        }
+        Google.enable_tracking();
+    }
+    Cookies.disable = disable;
+    // Initialize cookies.
+    if (is_accepted())
+        enable(false);
+    else
+        disable(false);
+})(Cookies || (Cookies = {}));
+export { Cookies as cookies }; // also export as lowercase for compatibility.

package/frontend/dist/frontend/src/modules/events.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+export declare namespace Events {
+    const events: Map<string, [any, (element: any, args: any) => void][]>;
+    /**
+     * Emit a registered event.
+     * @param id The id of the registered event to emit.
+     * @param args The arguments that will be passed to the registered callbacks.
+     * @docs
+     */
+    function emit(id: string, args?: Record<string, any>): void;
+    /**
+     * Set a callback for an event.
+     * @param id The id of the registered event to emit.
+     * @param element The element.
+     * @param callback The callback function, accepts parameters `(element, args)`.
+     * @docs
+     */
+    function on<T extends object>(id: string, element: T, callback: (element: T, args: Record<string, any>) => void): void;
+    /**
+     * Remove a callback for an event.
+     * @param id The id of the registered event to emit.
+     * @param element The element.
+     * @param callback The callback function to remove. When left undefined, all callbacks matching to that element will be removed.
+     * @docs
+     */
+    function remove<T extends object>(id: string, element: T, callback?: (element: T, args: Record<string, any>) => void): void;
+}
+export { Events as events };

package/frontend/dist/frontend/src/modules/events.js

@@ -0,0 +1,79 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+// Events module.
+export var Events;
+(function (Events) {
+    Events.events = new Map();
+    // Emit an event.
+    /**
+     * Emit a registered event.
+     * @param id The id of the registered event to emit.
+     * @param args The arguments that will be passed to the registered callbacks.
+     * @docs
+     */
+    function emit(id, args = {}) {
+        const callbacks = Events.events.get(id);
+        if (callbacks == null) {
+            return;
+        }
+        for (const i of callbacks) {
+            try {
+                i[1](i[0], args);
+            }
+            catch (e) {
+                console.error(`Error in event callback for event '${id}':`, e);
+            }
+        }
+    }
+    Events.emit = emit;
+    // On event.
+    /**
+     * Set a callback for an event.
+     * @param id The id of the registered event to emit.
+     * @param element The element.
+     * @param callback The callback function, accepts parameters `(element, args)`.
+     * @docs
+     */
+    function on(id, element, callback) {
+        let callbacks = Events.events.get(id);
+        if (callbacks == null) {
+            callbacks = [];
+            Events.events.set(id, callbacks);
+        }
+        callbacks.push([element, callback]);
+    }
+    Events.on = on;
+    // Remove a callback for an event.
+    /**
+     * Remove a callback for an event.
+     * @param id The id of the registered event to emit.
+     * @param element The element.
+     * @param callback The callback function to remove. When left undefined, all callbacks matching to that element will be removed.
+     * @docs
+     */
+    function remove(id, element, callback) {
+        const callbacks = Events.events.get(id);
+        if (callbacks == null) {
+            return;
+        }
+        const filtered = [];
+        callbacks.forEach((i) => {
+            if (i[0] === element && (callback == null || i[1] === callback)) {
+                return;
+            }
+            filtered.push(i);
+        });
+        Events.events.set(id, filtered);
+    }
+    Events.remove = remove;
+})(Events || (Events = {}));
+export { Events as events }; // also export as lowercase for compatibility.
+// Fire the onload event.
+/**
+ * Fires the `volt.on_load` event when the window finishes loading.
+ */
+window.onload = () => {
+    Events.emit("volt.on_load");
+};

package/frontend/dist/frontend/src/modules/google.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+export declare namespace Google {
+    const id: string;
+    /**
+     * Enable google analytics tracking
+     * @nav Fronted/Google
+     * @docs
+     */
+    function enable_tracking(): void;
+    /**
+     * Disable google analytics tracking
+     * @nav Fronted/Google
+     * @docs
+     */
+    function disable_tracking(): void;
+    const cloud: {
+        api_key: string;
+    };
+}
+export { Google as google };

package/frontend/dist/frontend/src/modules/google.js

@@ -0,0 +1,52 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+// Google wrapper module.
+export var Google;
+(function (Google) {
+    Google.id = "{{GOOGLE_TAG}}";
+    // Source: https://developers.google.com/analytics/devguides/collection/gajs/#disable
+    /**
+     * Enable google analytics tracking
+     * @nav Fronted/Google
+     * @docs
+     */
+    function enable_tracking() {
+        // document.cookie = "ga-opt-out=false; Path=/; SameSite=None;";
+        delete window[`ga-disable-${Google.id}`];
+    }
+    Google.enable_tracking = enable_tracking;
+    // Source: https://developers.google.com/analytics/devguides/collection/gajs/#disable
+    /**
+     * Disable google analytics tracking
+     * @nav Fronted/Google
+     * @docs
+     */
+    function disable_tracking() {
+        // document.cookie = "ga-opt-out=true; Path=/; SameSite=None;";
+        window[`ga-disable-${Google.id}`] = true;
+    }
+    Google.disable_tracking = disable_tracking;
+    // Auto initialize (internal use).
+    function _initialize() {
+        if (Google.id && typeof window !== "undefined") {
+            // @ts-ignore
+            window.dataLayer = window.dataLayer || [];
+            function gtag(...args) {
+                // @ts-ignore
+                window.dataLayer.push(args);
+            }
+            gtag('js', new Date());
+            gtag('config', Google.id);
+        }
+    }
+    // Google cloud.
+    Google.cloud = {
+        api_key: "{{GOOGLE_COULD_API_KEY}}",
+    };
+    // Initialize.
+    _initialize();
+})(Google || (Google = {}));
+;
+export { Google as google }; // also export as lowercase for compatibility.

package/frontend/dist/frontend/src/modules/meta.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+export declare namespace Meta {
+    function set({ author, title, description, image, favicon, }: {
+        author?: string;
+        title?: string;
+        description?: string;
+        image?: string;
+        favicon?: string;
+    }): void;
+}
+export { Meta as meta };

package/frontend/dist/frontend/src/modules/meta.js

@@ -0,0 +1,48 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+// Meta module.
+export var Meta;
+(function (Meta) {
+    // Set title.
+    function set({ author, title, description, image, favicon, }) {
+        const set_content_query = (query, content) => {
+            const e = document.querySelector(query);
+            if (e) {
+                e.content = content;
+                return true;
+            }
+            return false;
+        };
+        const set_content_og = (property, content) => {
+            // search for both "name=" and "property=".
+            let exists = set_content_query(`meta[property='${property}']`, content);
+            if (!exists) {
+                exists = set_content_query(`meta[name='${property}']`, content);
+                if (!exists) {
+                    // @todo when neither exists than create a property.
+                }
+            }
+        };
+        if (author != null) {
+            set_content_og("author", author);
+        }
+        if (title != null) {
+            document.title = title;
+            set_content_og("og:title", title);
+            set_content_og("twitter:title", title);
+        }
+        if (description != null) {
+            set_content_og("description", description);
+            set_content_og("og:description", description);
+            set_content_og("twitter:description", description);
+        }
+        if (image != null) {
+            set_content_og("og:image", image);
+            set_content_og("twitter:image", description);
+        }
+    }
+    Meta.set = set;
+})(Meta || (Meta = {}));
+export { Meta as meta }; // also export as lowercase for compatibility.