tiny-essentials 1.24.0 → 1.24.1

package/dist/legacy/firebase/database/presence.cjs

@@ -1,137 +0,0 @@
-'use strict';
-
-var moment = require('moment-timezone');
-var _ = require('lodash');
-
-// @ts-nocheck
-
-/** @typedef {import("firebase/database")} FbDatabase */
-/** @typedef {import("firebase/database").DataSnapshot} DataSnapshot */
-/** @typedef {import("firebase/database").DatabaseReference} DatabaseReference */
-
-/**
- * Firebase Presence System
- *
- * This module allows real-time tracking of user presence using Firebase Realtime Database.
- * It handles multiple connections (tabs/devices), updates online status, and records the last time online.
- *
- * @module presenceSystem
- */
-const presenceSystem = {
-  /**
-   * Returns the source code of the `start` function as a string, with placeholders replaced.
-   *
-   * This function is useful to retrieve a browser-compatible version of the `start` function
-   * for client-side injection (e.g., for Firebase emulators or test UIs).
-   *
-   * @param {string} [lodash='_'] - The lodash import replacement string (usually `_`).
-   * @returns {string} JavaScript source code as a string with `lodash` and `moment` replaced or removed.
-   */
-  browserVersion: function (lodash = '_') {
-    // Get Browser Version
-    return presenceSystem.start
-      .toString()
-      .replace(`import _ from 'lodash'`, lodash)
-      .replace('let moment;', '')
-      .replace('moment = null;', 'console.error(err);')
-      .replace(
-        `import moment from 'moment-timezone'`,
-        "const tinypudding = 'Tiny Jasmini's Pudding.'",
-      );
-  },
-
-  /**
-   * Starts presence tracking for a given user in Firebase Realtime Database.
-   *
-   * It sets up handlers for `.info/connected`, manages disconnect events,
-   * and updates the last online time in UTC format.
-   *
-   * @param {object} database - Firebase database reference (usually `admin.database()` or `firebase.database()`).
-   * @param {string|object} myConnectionsRef - Path or database ref to the user's `connections` node.
-   * @param {string|object} lastOnlineRef - Path or database ref to the user's `lastOnline` node.
-   * @param {object} [data] - Optional configuration overrides.
-   * @param {boolean|object} [data.connected=true] - Data to store when device is connected.
-   * @param {Function} [data.removeError] - Callback for `onDisconnect().remove()` errors.
-   * @param {Function} [data.getDate] - Function to return a UTC-based timestamp object (uses `moment` if available).
-   */
-  start: (database, myConnectionsRef, lastOnlineRef, data) => {
-    // Since I can connect from multiple devices or browser tabs, we store each connection instance separately
-    // any time that connectionsRef's value is null (i.e. has no children) I am offline
-    if (typeof myConnectionsRef === 'string') {
-      myConnectionsRef = database.ref(myConnectionsRef);
-    }
-
-    // stores the timestamp of my last disconnect (the last time I was seen online)
-    if (typeof lastOnlineRef === 'string') {
-      lastOnlineRef = database.ref(lastOnlineRef);
-    }
-
-    // Get Base
-    data = _.defaultsDeep({}, data, {
-      // Remove Error
-      removeError: (err) => {
-        if (err) {
-          console.group('could not establish onDisconnect event');
-          console.error(err);
-          console.groupEnd();
-        }
-      },
-
-      // Is Connected
-      connected: true,
-
-      // Get Data
-      getDate: function () {
-        // Prepare Values
-        let momentTime;
-
-        // Timezone Module
-        if (moment) {
-          momentTime = moment.utc().toObject();
-        }
-
-        // Vanilla
-        else {
-          const date = new Date();
-          momentTime = {
-            date: date.getUTCDate(),
-            hours: date.getUTCHours(),
-            milliseconds: date.getUTCMilliseconds(),
-            minutes: date.getUTCMinutes(),
-            months: date.getUTCMonth(),
-            seconds: date.getUTCSeconds(),
-            years: date.getUTCFullYear(),
-          };
-        }
-
-        // Insert Timezone Name
-        momentTime.timezone = 'Universal';
-
-        // Return the value
-        return momentTime;
-      },
-    });
-
-    // Prepare Connection
-    const connectedRef = database.ref('.info/connected');
-    connectedRef.on('value', (/** @type {DataSnapshot} */ snap) => {
-      if (snap.val() === true) {
-        // We're connected (or reconnected)! Do anything here that should happen only if online (or on reconnect)
-        const con = myConnectionsRef.push();
-
-        // When I disconnect, remove this device
-        con.onDisconnect().remove(data.removeError);
-
-        // Add this device to my connections list
-        // this value could contain info about the device or a timestamp too
-        con.set(data.connected);
-
-        // When I disconnect, update the last time I was seen online
-        const momentTime = data.getDate();
-        lastOnlineRef.onDisconnect().set(momentTime);
-      }
-    });
-  },
-};
-
-module.exports = presenceSystem;

package/dist/legacy/firebase/database/presence.d.mts

@@ -1,13 +0,0 @@
-export default presenceSystem;
-export type FbDatabase = typeof import("firebase/database");
-export type DataSnapshot = import("firebase/database").DataSnapshot;
-export type DatabaseReference = import("firebase/database").DatabaseReference;
-declare namespace presenceSystem {
-    function browserVersion(lodash?: string): string;
-    function start(database: object, myConnectionsRef: string | object, lastOnlineRef: string | object, data?: {
-        connected?: boolean | object | undefined;
-        removeError?: Function | undefined;
-        getDate?: Function | undefined;
-    }): void;
-}
-//# sourceMappingURL=presence.d.mts.map

package/dist/legacy/firebase/database/presence.mjs

@@ -1,115 +0,0 @@
-// @ts-nocheck
-import moment from 'moment-timezone';
-import _ from 'lodash';
-/** @typedef {import("firebase/database")} FbDatabase */
-/** @typedef {import("firebase/database").DataSnapshot} DataSnapshot */
-/** @typedef {import("firebase/database").DatabaseReference} DatabaseReference */
-/**
- * Firebase Presence System
- *
- * This module allows real-time tracking of user presence using Firebase Realtime Database.
- * It handles multiple connections (tabs/devices), updates online status, and records the last time online.
- *
- * @module presenceSystem
- */
-const presenceSystem = {
-    /**
-     * Returns the source code of the `start` function as a string, with placeholders replaced.
-     *
-     * This function is useful to retrieve a browser-compatible version of the `start` function
-     * for client-side injection (e.g., for Firebase emulators or test UIs).
-     *
-     * @param {string} [lodash='_'] - The lodash import replacement string (usually `_`).
-     * @returns {string} JavaScript source code as a string with `lodash` and `moment` replaced or removed.
-     */
-    browserVersion: function (lodash = '_') {
-        // Get Browser Version
-        return presenceSystem.start
-            .toString()
-            .replace(`import _ from 'lodash'`, lodash)
-            .replace('let moment;', '')
-            .replace('moment = null;', 'console.error(err);')
-            .replace(`import moment from 'moment-timezone'`, "const tinypudding = 'Tiny Jasmini's Pudding.'");
-    },
-    /**
-     * Starts presence tracking for a given user in Firebase Realtime Database.
-     *
-     * It sets up handlers for `.info/connected`, manages disconnect events,
-     * and updates the last online time in UTC format.
-     *
-     * @param {object} database - Firebase database reference (usually `admin.database()` or `firebase.database()`).
-     * @param {string|object} myConnectionsRef - Path or database ref to the user's `connections` node.
-     * @param {string|object} lastOnlineRef - Path or database ref to the user's `lastOnline` node.
-     * @param {object} [data] - Optional configuration overrides.
-     * @param {boolean|object} [data.connected=true] - Data to store when device is connected.
-     * @param {Function} [data.removeError] - Callback for `onDisconnect().remove()` errors.
-     * @param {Function} [data.getDate] - Function to return a UTC-based timestamp object (uses `moment` if available).
-     */
-    start: (database, myConnectionsRef, lastOnlineRef, data) => {
-        // Since I can connect from multiple devices or browser tabs, we store each connection instance separately
-        // any time that connectionsRef's value is null (i.e. has no children) I am offline
-        if (typeof myConnectionsRef === 'string') {
-            myConnectionsRef = database.ref(myConnectionsRef);
-        }
-        // stores the timestamp of my last disconnect (the last time I was seen online)
-        if (typeof lastOnlineRef === 'string') {
-            lastOnlineRef = database.ref(lastOnlineRef);
-        }
-        // Get Base
-        data = _.defaultsDeep({}, data, {
-            // Remove Error
-            removeError: (err) => {
-                if (err) {
-                    console.group('could not establish onDisconnect event');
-                    console.error(err);
-                    console.groupEnd();
-                }
-            },
-            // Is Connected
-            connected: true,
-            // Get Data
-            getDate: function () {
-                // Prepare Values
-                let momentTime;
-                // Timezone Module
-                if (moment) {
-                    momentTime = moment.utc().toObject();
-                }
-                // Vanilla
-                else {
-                    const date = new Date();
-                    momentTime = {
-                        date: date.getUTCDate(),
-                        hours: date.getUTCHours(),
-                        milliseconds: date.getUTCMilliseconds(),
-                        minutes: date.getUTCMinutes(),
-                        months: date.getUTCMonth(),
-                        seconds: date.getUTCSeconds(),
-                        years: date.getUTCFullYear(),
-                    };
-                }
-                // Insert Timezone Name
-                momentTime.timezone = 'Universal';
-                // Return the value
-                return momentTime;
-            },
-        });
-        // Prepare Connection
-        const connectedRef = database.ref('.info/connected');
-        connectedRef.on('value', (/** @type {DataSnapshot} */ snap) => {
-            if (snap.val() === true) {
-                // We're connected (or reconnected)! Do anything here that should happen only if online (or on reconnect)
-                const con = myConnectionsRef.push();
-                // When I disconnect, remove this device
-                con.onDisconnect().remove(data.removeError);
-                // Add this device to my connections list
-                // this value could contain info about the device or a timestamp too
-                con.set(data.connected);
-                // When I disconnect, update the last time I was seen online
-                const momentTime = data.getDate();
-                lastOnlineRef.onDisconnect().set(momentTime);
-            }
-        });
-    },
-};
-export default presenceSystem;

package/dist/legacy/firebase/database/saveAsync.cjs

@@ -1,149 +0,0 @@
-'use strict';
-
-// @ts-nocheck
-
-/**
- * Class representing an asynchronous save system with callback support.
- *
- * This class is designed to handle database operations asynchronously and supports
- * adding multiple operations to a queue, as well as running callbacks after each action.
- *
- * @class SaveAsync
- */
-class SaveAsync {
-  /**
-   * Creates an instance of SaveAsync.
-   *
-   * @param {object} db - The database reference to interact with (e.g., Firebase or other DB).
-   */
-  constructor(db) {
-    this.db = db;
-    this.list = [];
-    this.callbacks = {};
-    this.using = false;
-  }
-
-  /**
-   * Registers a callback to be run when a specific action type is executed.
-   *
-   * @param {string} where - The action type (e.g., "set", "push", etc.).
-   * @param {Function} callback - The callback function to run when the action is performed.
-   * @returns {boolean} Returns `true` if the callback is successfully registered.
-   */
-  on(where, callback) {
-    if (!Array.isArray(this.callbacks[where])) this.callbacks[where] = [];
-    this.callbacks[where].push(callback);
-    return true;
-  }
-
-  /**
-   * Runs all callbacks associated with a specific action type.
-   *
-   * @param {string} type - The action type (e.g., "set", "push", etc.).
-   * @param {any} data - The data passed to the callback(s).
-   * @param {string} [where] - The location (optional) where the action was performed.
-   */
-  _runCallbacks(type, data, where) {
-    if (Array.isArray(this.callbacks[type]))
-      for (const item in this.callbacks[type])
-        if (typeof this.callbacks[type][item] === 'function')
-          this.callbacks[type][item](data, where);
-  }
-
-  /**
-   * Processes the queued actions and executes them one by one.
-   *
-   * Each action in the queue is processed asynchronously. Once one action completes,
-   * the next action in the queue is triggered.
-   */
-  action() {
-    // Insert
-    if (this.list.length > 0) {
-      // Get Item
-      const post = this.list.shift();
-      const tinyThis = this;
-
-      // Try
-      try {
-        if (typeof post.where !== 'string') {
-          if (post.data) {
-            this.db[post.type](post.data)
-              .then(() => {
-                this._runCallbacks(post.type, post.data);
-                tinyThis.action();
-              })
-              .catch((err) => {
-                console.error(err);
-              });
-          } else {
-            this.db[post.type]()
-              .then(() => {
-                this._runCallbacks(post.type);
-                tinyThis.action();
-              })
-              .catch((err) => {
-                console.error(err);
-              });
-          }
-        } else {
-          if (post.data) {
-            this.db
-              .child(post.where)
-              [post.type](post.data)
-              .then(() => {
-                this._runCallbacks(post.type, post.data, post.where);
-                tinyThis.action();
-              })
-              .catch((err) => {
-                console.error(err);
-              });
-          } else {
-            this.db
-              .child(post.where)
-              [post.type]()
-              .then(() => {
-                this._runCallbacks(post.type, null, post.where);
-                tinyThis.action();
-              })
-              .catch((err) => {
-                console.error(err);
-              });
-          }
-        }
-      } catch (err) {
-        // Error
-        console.error(err);
-      }
-    }
-
-    // Nope
-    else this.using = false;
-  }
-
-  /**
-   * Inserts a new action into the queue.
-   *
-   * The action will be executed when the system is ready (i.e., when the queue is not in use).
-   *
-   * @param {object} [data={}] - The data to be saved (optional).
-   * @param {string} [type='set'] - The type of the database action (e.g., 'set', 'push', etc.).
-   * @param {string|null} [where=null] - The location where the data should be stored (optional).
-   */
-  insert(data = {}, type = 'set', where = null) {
-    // Insert
-    if (data !== null) {
-      if (where !== null) this.list.push({ where: String(where), data: data, type: type });
-      else this.list.push({ data: data, type: type });
-    } else {
-      if (where !== null) this.list.push({ where: String(where), type: type });
-      else this.list.push({ type: type });
-    }
-
-    if (!this.using) {
-      this.using = true;
-      this.action();
-    }
-  }
-}
-
-module.exports = SaveAsync;

package/dist/legacy/firebase/database/saveAsync.d.mts

@@ -1,55 +0,0 @@
-export default SaveAsync;
-/**
- * Class representing an asynchronous save system with callback support.
- *
- * This class is designed to handle database operations asynchronously and supports
- * adding multiple operations to a queue, as well as running callbacks after each action.
- *
- * @class SaveAsync
- */
-declare class SaveAsync {
-    /**
-     * Creates an instance of SaveAsync.
-     *
-     * @param {object} db - The database reference to interact with (e.g., Firebase or other DB).
-     */
-    constructor(db: object);
-    db: object;
-    list: any[];
-    callbacks: {};
-    using: boolean;
-    /**
-     * Registers a callback to be run when a specific action type is executed.
-     *
-     * @param {string} where - The action type (e.g., "set", "push", etc.).
-     * @param {Function} callback - The callback function to run when the action is performed.
-     * @returns {boolean} Returns `true` if the callback is successfully registered.
-     */
-    on(where: string, callback: Function): boolean;
-    /**
-     * Runs all callbacks associated with a specific action type.
-     *
-     * @param {string} type - The action type (e.g., "set", "push", etc.).
-     * @param {any} data - The data passed to the callback(s).
-     * @param {string} [where] - The location (optional) where the action was performed.
-     */
-    _runCallbacks(type: string, data: any, where?: string): void;
-    /**
-     * Processes the queued actions and executes them one by one.
-     *
-     * Each action in the queue is processed asynchronously. Once one action completes,
-     * the next action in the queue is triggered.
-     */
-    action(): void;
-    /**
-     * Inserts a new action into the queue.
-     *
-     * The action will be executed when the system is ready (i.e., when the queue is not in use).
-     *
-     * @param {object} [data={}] - The data to be saved (optional).
-     * @param {string} [type='set'] - The type of the database action (e.g., 'set', 'push', etc.).
-     * @param {string|null} [where=null] - The location where the data should be stored (optional).
-     */
-    insert(data?: object, type?: string, where?: string | null): void;
-}
-//# sourceMappingURL=saveAsync.d.mts.map

package/dist/legacy/firebase/database/saveAsync.mjs

@@ -1,148 +0,0 @@
-// @ts-nocheck
-/**
- * Class representing an asynchronous save system with callback support.
- *
- * This class is designed to handle database operations asynchronously and supports
- * adding multiple operations to a queue, as well as running callbacks after each action.
- *
- * @class SaveAsync
- */
-class SaveAsync {
-    /**
-     * Creates an instance of SaveAsync.
-     *
-     * @param {object} db - The database reference to interact with (e.g., Firebase or other DB).
-     */
-    constructor(db) {
-        this.db = db;
-        this.list = [];
-        this.callbacks = {};
-        this.using = false;
-    }
-    /**
-     * Registers a callback to be run when a specific action type is executed.
-     *
-     * @param {string} where - The action type (e.g., "set", "push", etc.).
-     * @param {Function} callback - The callback function to run when the action is performed.
-     * @returns {boolean} Returns `true` if the callback is successfully registered.
-     */
-    on(where, callback) {
-        if (!Array.isArray(this.callbacks[where]))
-            this.callbacks[where] = [];
-        this.callbacks[where].push(callback);
-        return true;
-    }
-    /**
-     * Runs all callbacks associated with a specific action type.
-     *
-     * @param {string} type - The action type (e.g., "set", "push", etc.).
-     * @param {any} data - The data passed to the callback(s).
-     * @param {string} [where] - The location (optional) where the action was performed.
-     */
-    _runCallbacks(type, data, where) {
-        if (Array.isArray(this.callbacks[type]))
-            for (const item in this.callbacks[type])
-                if (typeof this.callbacks[type][item] === 'function')
-                    this.callbacks[type][item](data, where);
-    }
-    /**
-     * Processes the queued actions and executes them one by one.
-     *
-     * Each action in the queue is processed asynchronously. Once one action completes,
-     * the next action in the queue is triggered.
-     */
-    action() {
-        // Insert
-        if (this.list.length > 0) {
-            // Get Item
-            const post = this.list.shift();
-            const tinyThis = this;
-            // Try
-            try {
-                if (typeof post.where !== 'string') {
-                    if (post.data) {
-                        this.db[post.type](post.data)
-                            .then(() => {
-                            this._runCallbacks(post.type, post.data);
-                            tinyThis.action();
-                        })
-                            .catch((err) => {
-                            console.error(err);
-                        });
-                    }
-                    else {
-                        this.db[post.type]()
-                            .then(() => {
-                            this._runCallbacks(post.type);
-                            tinyThis.action();
-                        })
-                            .catch((err) => {
-                            console.error(err);
-                        });
-                    }
-                }
-                else {
-                    if (post.data) {
-                        this.db
-                            .child(post.where)[post.type](post.data)
-                            .then(() => {
-                            this._runCallbacks(post.type, post.data, post.where);
-                            tinyThis.action();
-                        })
-                            .catch((err) => {
-                            console.error(err);
-                        });
-                    }
-                    else {
-                        this.db
-                            .child(post.where)[post.type]()
-                            .then(() => {
-                            this._runCallbacks(post.type, null, post.where);
-                            tinyThis.action();
-                        })
-                            .catch((err) => {
-                            console.error(err);
-                        });
-                    }
-                }
-            }
-            catch (err) {
-                // Error
-                console.error(err);
-            }
-        }
-        // Nope
-        else
-            this.using = false;
-    }
-    /**
-     * Inserts a new action into the queue.
-     *
-     * The action will be executed when the system is ready (i.e., when the queue is not in use).
-     *
-     * @param {object} [data={}] - The data to be saved (optional).
-     * @param {string} [type='set'] - The type of the database action (e.g., 'set', 'push', etc.).
-     * @param {string|null} [where=null] - The location where the data should be stored (optional).
-     */
-    insert(data = {}, type = 'set', where = null) {
-        // Insert
-        if (data !== null) {
-            if (where !== null)
-                this.list.push({ where: String(where), data: data, type: type });
-            else
-                this.list.push({ data: data, type: type });
-        }
-        else {
-            if (where !== null)
-                this.list.push({ where: String(where), type: type });
-            else
-                this.list.push({ type: type });
-        }
-        if (!this.using) {
-            this.using = true;
-            this.action();
-        }
-    }
-}
-// Module export
-export default SaveAsync;

package/dist/legacy/firebase/databaseEscape.cjs

@@ -1,45 +0,0 @@
-'use strict';
-
-var escape = require('./escape.cjs');
-
-// @ts-nocheck
-
-
-/**
- * Escapes a given string or number for use in Firebase database paths, with an option to preserve the path structure.
- *
- * This function encodes the input string or number using a custom encoding defined in the `firebaseEscape.encode()` method.
- * If the `keepPath` flag is set to `true`, the function will encode each segment of the path individually.
- *
- * @param {string|number} text - The text or number to be escaped.
- * @param {boolean} [keepPath=false] - Whether to preserve the path structure (encode each path segment separately).
- * @returns {string|null} The escaped string or null if the input is neither a string nor a number.
- */
-function databaseEscape(text, keepPath = false) {
-  // Check if the input is a string or number
-  if (typeof text === 'string' || typeof text === 'number') {
-    // Convert the value to a string if it's a number
-    let new_value = text;
-    if (typeof new_value === 'number') new_value = String(new_value);
-
-    // Normal escape (do not preserve path)
-    if (!keepPath) new_value = escape.encode(new_value);
-    // Escape path segments individually (preserve path structure)
-    else {
-      // Split path into segments
-      new_value = new_value.split('/');
-      for (const item in new_value) new_value[item] = escape.encode(new_value[item]);
-
-      // Join the segments back into a single string
-      new_value = new_value.join('/');
-    }
-
-    // Return the escaped value
-    return new_value;
-  }
-
-  // Return null if the input is neither a string nor a number
-  else return null;
-}
-
-module.exports = databaseEscape;

package/dist/legacy/firebase/databaseEscape.d.mts

@@ -1,12 +0,0 @@
-/**
- * Escapes a given string or number for use in Firebase database paths, with an option to preserve the path structure.
- *
- * This function encodes the input string or number using a custom encoding defined in the `firebaseEscape.encode()` method.
- * If the `keepPath` flag is set to `true`, the function will encode each segment of the path individually.
- *
- * @param {string|number} text - The text or number to be escaped.
- * @param {boolean} [keepPath=false] - Whether to preserve the path structure (encode each path segment separately).
- * @returns {string|null} The escaped string or null if the input is neither a string nor a number.
- */
-export default function databaseEscape(text: string | number, keepPath?: boolean): string | null;
-//# sourceMappingURL=databaseEscape.d.mts.map