tiny-essentials 1.24.0 → 1.24.2

package/dist/legacy/firebase/cookieSession.cjs

@@ -1,123 +0,0 @@
-'use strict';
-
-// @ts-nocheck
-
-/**
- * Class representing an authentication system for generating session cookies.
- *
- * The AuthSystem handles checking the authentication time and generating session cookies based on
- * ID token verification. It supports custom time checking and cookie generation logic.
- *
- * @class AuthSystem
- */
-class AuthSystem {
-  /**
-   * Creates an instance of AuthSystem.
-   * Initializes default configurations for authentication time checking and session cookie expiration.
-   *
-   * @constructor
-   */
-  constructor() {
-    this.auth_time = 5;
-
-    // Default Values
-    const authSystem = this;
-    this.default = {
-      /**
-       * Checks whether the authentication time is within the last 5 minutes.
-       *
-       * @param {Object} decodedIdToken - The decoded ID token object.
-       * @param {number} decodedIdToken.auth_time - The authentication time from the ID token.
-       * @returns {boolean} Returns `true` if the authentication time is within the last 5 minutes.
-       */
-      checkAuthTime: (decodedIdToken) => {
-        // Only process if the user just signed in in the last {this.auth_time} minutes.
-        if (new Date().getTime() / 1000 - decodedIdToken.auth_time < authSystem.auth_time * 60)
-          return true;
-        // Nope
-        else return false;
-      },
-
-      /**
-       * Generates the session cookie expiration time ({this.auth_time} days by default).
-       *
-       * @returns {number} Returns the expiration time in milliseconds (5 days).
-       */
-      cookieTimeGenerator: () => {
-        // Set session expiration to 5 days.
-        const expiresIn = 60 * 60 * 24 * authSystem.auth_time * 1000;
-
-        // Create the session cookie. This will also verify the ID token in the process.
-        // The session cookie will have the same claims as the ID token.
-        // To only allow session cookie setting on recent sign-in, auth_time in ID token
-        // can be checked to ensure user was recently signed in before creating a session cookie.
-
-        // Complete
-        return expiresIn;
-      },
-    };
-
-    // Set Value
-    this.checkAuthTime = this.default.checkAuthTime;
-    this.cookieTimeGenerator = this.default.cookieTimeGenerator;
-  }
-
-  /**
-   * Sets a custom callback to check authentication time.
-   *
-   * @param {Function} callback - The callback function to validate authentication time.
-   * @returns {void}
-   */
-  setCookieTimeGenerator(callback) {
-    if (typeof callback === 'function') this.cookieTimeGenerator = callback;
-  }
-
-  /**
-   * Sets a custom callback to generate the cookie expiration time.
-   *
-   * @param {Function} callback - The callback function to generate cookie expiration time.
-   * @returns {void}
-   */
-  setCheckAuthTime(callback) {
-    if (typeof callback === 'function') this.checkAuthTime = callback;
-  }
-
-  /**
-   * Generates a session cookie for the user after verifying the ID token.
-   *
-   * @param {Record<string, any>} auth - The authentication object used to verify the ID token and create session cookies.
-   * @param {string} token - The ID token of the authenticated user.
-   * @returns {Promise<string>} A promise that resolves with the session cookie or rejects with an error.
-   */
-  genCookieSession(auth, token) {
-    const tinyThis = this;
-    return new Promise(function (resolve, reject) {
-      auth
-        .verifyIdToken(token)
-        .then(async (decodedIdToken) => {
-          try {
-            // Validate the authentication time
-            const checkedTime = await tinyThis.checkAuthTime(decodedIdToken);
-            if (checkedTime) {
-              // Generate session cookie
-              const expiresIn = await tinyThis.cookieTimeGenerator(decodedIdToken);
-              auth.createSessionCookie(token, { expiresIn }).then(resolve).catch(reject);
-            }
-
-            // Nope
-            else {
-              const err = new Error('Invalid Account ID Token Time.');
-              err.code = 401;
-              reject(err);
-            }
-          } catch (err) {
-            // Fail
-            reject(err);
-          }
-        })
-        .catch(reject);
-    });
-  }
-}
-
-module.exports = AuthSystem;

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

@@ -1,57 +0,0 @@
-export default AuthSystem;
-/**
- * Class representing an authentication system for generating session cookies.
- *
- * The AuthSystem handles checking the authentication time and generating session cookies based on
- * ID token verification. It supports custom time checking and cookie generation logic.
- *
- * @class AuthSystem
- */
-declare class AuthSystem {
-    auth_time: number;
-    default: {
-        /**
-         * Checks whether the authentication time is within the last 5 minutes.
-         *
-         * @param {Object} decodedIdToken - The decoded ID token object.
-         * @param {number} decodedIdToken.auth_time - The authentication time from the ID token.
-         * @returns {boolean} Returns `true` if the authentication time is within the last 5 minutes.
-         */
-        checkAuthTime: (decodedIdToken: {
-            auth_time: number;
-        }) => boolean;
-        /**
-         * Generates the session cookie expiration time ({this.auth_time} days by default).
-         *
-         * @returns {number} Returns the expiration time in milliseconds (5 days).
-         */
-        cookieTimeGenerator: () => number;
-    };
-    checkAuthTime: (decodedIdToken: {
-        auth_time: number;
-    }) => boolean;
-    cookieTimeGenerator: () => number;
-    /**
-     * Sets a custom callback to check authentication time.
-     *
-     * @param {Function} callback - The callback function to validate authentication time.
-     * @returns {void}
-     */
-    setCookieTimeGenerator(callback: Function): void;
-    /**
-     * Sets a custom callback to generate the cookie expiration time.
-     *
-     * @param {Function} callback - The callback function to generate cookie expiration time.
-     * @returns {void}
-     */
-    setCheckAuthTime(callback: Function): void;
-    /**
-     * Generates a session cookie for the user after verifying the ID token.
-     *
-     * @param {Record<string, any>} auth - The authentication object used to verify the ID token and create session cookies.
-     * @param {string} token - The ID token of the authenticated user.
-     * @returns {Promise<string>} A promise that resolves with the session cookie or rejects with an error.
-     */
-    genCookieSession(auth: Record<string, any>, token: string): Promise<string>;
-}
-//# sourceMappingURL=cookieSession.d.mts.map

package/dist/legacy/firebase/cookieSession.mjs

@@ -1,115 +0,0 @@
-// @ts-nocheck
-/**
- * Class representing an authentication system for generating session cookies.
- *
- * The AuthSystem handles checking the authentication time and generating session cookies based on
- * ID token verification. It supports custom time checking and cookie generation logic.
- *
- * @class AuthSystem
- */
-class AuthSystem {
-    /**
-     * Creates an instance of AuthSystem.
-     * Initializes default configurations for authentication time checking and session cookie expiration.
-     *
-     * @constructor
-     */
-    constructor() {
-        this.auth_time = 5;
-        // Default Values
-        const authSystem = this;
-        this.default = {
-            /**
-             * Checks whether the authentication time is within the last 5 minutes.
-             *
-             * @param {Object} decodedIdToken - The decoded ID token object.
-             * @param {number} decodedIdToken.auth_time - The authentication time from the ID token.
-             * @returns {boolean} Returns `true` if the authentication time is within the last 5 minutes.
-             */
-            checkAuthTime: (decodedIdToken) => {
-                // Only process if the user just signed in in the last {this.auth_time} minutes.
-                if (new Date().getTime() / 1000 - decodedIdToken.auth_time < authSystem.auth_time * 60)
-                    return true;
-                // Nope
-                else
-                    return false;
-            },
-            /**
-             * Generates the session cookie expiration time ({this.auth_time} days by default).
-             *
-             * @returns {number} Returns the expiration time in milliseconds (5 days).
-             */
-            cookieTimeGenerator: () => {
-                // Set session expiration to 5 days.
-                const expiresIn = 60 * 60 * 24 * authSystem.auth_time * 1000;
-                // Create the session cookie. This will also verify the ID token in the process.
-                // The session cookie will have the same claims as the ID token.
-                // To only allow session cookie setting on recent sign-in, auth_time in ID token
-                // can be checked to ensure user was recently signed in before creating a session cookie.
-                // Complete
-                return expiresIn;
-            },
-        };
-        // Set Value
-        this.checkAuthTime = this.default.checkAuthTime;
-        this.cookieTimeGenerator = this.default.cookieTimeGenerator;
-    }
-    /**
-     * Sets a custom callback to check authentication time.
-     *
-     * @param {Function} callback - The callback function to validate authentication time.
-     * @returns {void}
-     */
-    setCookieTimeGenerator(callback) {
-        if (typeof callback === 'function')
-            this.cookieTimeGenerator = callback;
-    }
-    /**
-     * Sets a custom callback to generate the cookie expiration time.
-     *
-     * @param {Function} callback - The callback function to generate cookie expiration time.
-     * @returns {void}
-     */
-    setCheckAuthTime(callback) {
-        if (typeof callback === 'function')
-            this.checkAuthTime = callback;
-    }
-    /**
-     * Generates a session cookie for the user after verifying the ID token.
-     *
-     * @param {Record<string, any>} auth - The authentication object used to verify the ID token and create session cookies.
-     * @param {string} token - The ID token of the authenticated user.
-     * @returns {Promise<string>} A promise that resolves with the session cookie or rejects with an error.
-     */
-    genCookieSession(auth, token) {
-        const tinyThis = this;
-        return new Promise(function (resolve, reject) {
-            auth
-                .verifyIdToken(token)
-                .then(async (decodedIdToken) => {
-                try {
-                    // Validate the authentication time
-                    const checkedTime = await tinyThis.checkAuthTime(decodedIdToken);
-                    if (checkedTime) {
-                        // Generate session cookie
-                        const expiresIn = await tinyThis.cookieTimeGenerator(decodedIdToken);
-                        auth.createSessionCookie(token, { expiresIn }).then(resolve).catch(reject);
-                    }
-                    // Nope
-                    else {
-                        const err = new Error('Invalid Account ID Token Time.');
-                        err.code = 401;
-                        reject(err);
-                    }
-                }
-                catch (err) {
-                    // Fail
-                    reject(err);
-                }
-            })
-                .catch(reject);
-        });
-    }
-}
-// Module
-export default AuthSystem;

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

@@ -1,14 +0,0 @@
-'use strict';
-
-var presence = require('./presence.cjs');
-var saveAsync = require('./saveAsync.cjs');
-
-// @ts-nocheck
-
-
-const database = {
-  presence: presence,
-  SaveAsync: saveAsync,
-};
-
-module.exports = database;

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

@@ -1,8 +0,0 @@
-export default database;
-declare namespace database {
-    export { presenceSystem as presence };
-    export { SaveAsync };
-}
-import presenceSystem from './presence.mjs';
-import SaveAsync from './saveAsync.mjs';
-//# sourceMappingURL=index.d.mts.map

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

@@ -1,8 +0,0 @@
-// @ts-nocheck
-import presenceSystem from './presence.mjs';
-import SaveAsync from './saveAsync.mjs';
-const database = {
-    presence: presenceSystem,
-    SaveAsync,
-};
-export default database;

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;