tiny-essentials 1.0.0

package/dist/legacy/firebase/domainRedirect.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+// https://stackoverflow.com/questions/34212039/redirect-to-firebase-hosting-custom-domain
+
+/**
+ * Redirects requests from invalid domains to a specified base URL or calls a callback function.
+ * This middleware checks the 'x-forwarded-host' header of incoming requests and compares it to a list of valid domains.
+ * If the domain is invalid, it either redirects to the base URL or calls a provided callback.
+ *
+ * @param {string[]} [domains=['localhost:5000', 'example.com']] - A list of valid domains that the request must come from.
+ * @param {string} [baseurl='https://example.com/'] - The URL to redirect invalid requests to.
+ * @param {Function} [callback] - An optional callback function that is called when an invalid domain is detected.
+ *
+ * @returns {Function} A middleware function for use in an Express.js application.
+ */
+function domainRedirect(
+  domains = ['localhost:5000', 'example.com'],
+  baseurl = 'https://example.com/',
+  callback,
+) {
+  return (req, res, next) => {
+    // Invalid Domain Detected
+    if (!domains.includes(req.headers['x-forwarded-host'])) {
+      // No Callback
+      if (typeof callback !== 'function') return res.status(301).redirect(baseurl + req.url);
+      // Yes
+      else callback(req, res, next);
+    }
+
+    // Complete
+    return next();
+  };
+}
+
+module.exports = domainRedirect;

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

@@ -0,0 +1,12 @@
+/**
+ * Redirects requests from invalid domains to a specified base URL or calls a callback function.
+ * This middleware checks the 'x-forwarded-host' header of incoming requests and compares it to a list of valid domains.
+ * If the domain is invalid, it either redirects to the base URL or calls a provided callback.
+ *
+ * @param {string[]} [domains=['localhost:5000', 'example.com']] - A list of valid domains that the request must come from.
+ * @param {string} [baseurl='https://example.com/'] - The URL to redirect invalid requests to.
+ * @param {Function} [callback] - An optional callback function that is called when an invalid domain is detected.
+ *
+ * @returns {Function} A middleware function for use in an Express.js application.
+ */
+export default function domainRedirect(domains?: string[], baseurl?: string, callback?: Function): Function;

package/dist/legacy/firebase/domainRedirect.mjs

@@ -0,0 +1,27 @@
+// https://stackoverflow.com/questions/34212039/redirect-to-firebase-hosting-custom-domain
+/**
+ * Redirects requests from invalid domains to a specified base URL or calls a callback function.
+ * This middleware checks the 'x-forwarded-host' header of incoming requests and compares it to a list of valid domains.
+ * If the domain is invalid, it either redirects to the base URL or calls a provided callback.
+ *
+ * @param {string[]} [domains=['localhost:5000', 'example.com']] - A list of valid domains that the request must come from.
+ * @param {string} [baseurl='https://example.com/'] - The URL to redirect invalid requests to.
+ * @param {Function} [callback] - An optional callback function that is called when an invalid domain is detected.
+ *
+ * @returns {Function} A middleware function for use in an Express.js application.
+ */
+export default function domainRedirect(domains = ['localhost:5000', 'example.com'], baseurl = 'https://example.com/', callback) {
+    return (req, res, next) => {
+        // Invalid Domain Detected
+        if (!domains.includes(req.headers['x-forwarded-host'])) {
+            // No Callback
+            if (typeof callback !== 'function')
+                return res.status(301).redirect(baseurl + req.url);
+            // Yes
+            else
+                callback(req, res, next);
+        }
+        // Complete
+        return next();
+    };
+}

package/dist/legacy/firebase/escape.cjs

@@ -0,0 +1,75 @@
+'use strict';
+
+// Credits
+// https://github.com/joonhocho/firebase-encode/blob/master/src/index.js
+
+// http://stackoverflow.com/a/6969486/692528
+
+/**
+ * Escapes special characters in a string to make them safe for use in regular expressions.
+ *
+ * @param {string} str - The string to escape.
+ * @returns {string} The escaped string.
+ */
+const escapeRegExp = (str) => str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&');
+
+/**
+ * Creates encoding and decoding functions for custom characters.
+ *
+ * This function returns two pairs of functions: one for encoding and decoding
+ * the characters to/from their hexadecimal representations and another for encoding
+ * and decoding components (without the `/` character).
+ *
+ * @param {Array<string>} chars - The list of characters to encode/decode.
+ * @returns {Object} An object containing:
+ * - `encode`: Function that encodes characters to hexadecimal format.
+ * - `decode`: Function that decodes hexadecimal values back to characters.
+ */
+const create = (chars) => {
+  // Map characters to their hexadecimal representations
+  const charCodes = chars.map((c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
+
+  // Maps to convert between character and hexadecimal code
+  const charToCode = {};
+  const codeToChar = {};
+
+  chars.forEach((c, i) => {
+    charToCode[c] = charCodes[i];
+    codeToChar[charCodes[i]] = c;
+  });
+
+  // Regex for matching characters and their corresponding hex codes
+  const charsRegex = new RegExp(`[${escapeRegExp(chars.join(''))}]`, 'g');
+  const charCodesRegex = new RegExp(charCodes.join('|'), 'g');
+
+  /**
+   * Encodes a string by replacing its characters with their corresponding hexadecimal codes.
+   *
+   * @param {string} str - The string to encode.
+   * @returns {string} The encoded string.
+   */
+  const encode = (str) => str.replace(charsRegex, (match) => charToCode[match]);
+
+  /**
+   * Decodes a string by replacing its hexadecimal codes with their corresponding characters.
+   *
+   * @param {string} str - The string to decode.
+   * @returns {string} The decoded string.
+   */
+  const decode = (str) => str.replace(charCodesRegex, (match) => codeToChar[match]);
+
+  return { encode, decode };
+};
+
+// http://stackoverflow.com/a/19148116/692528
+// Create encode and decode functions for specific characters.
+const { encode, decode } = create('.$[]#/%'.split(''));
+
+// Create encode and decode functions for components (without `/`).
+const { encode: encodeComponents, decode: decodeComponents } = create('.$[]#%'.split(''));
+
+exports.create = create;
+exports.decode = decode;
+exports.decodeComponents = decodeComponents;
+exports.encode = encode;
+exports.encodeComponents = encodeComponents;

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

@@ -0,0 +1,17 @@
+/**
+ * Creates encoding and decoding functions for custom characters.
+ *
+ * This function returns two pairs of functions: one for encoding and decoding
+ * the characters to/from their hexadecimal representations and another for encoding
+ * and decoding components (without the `/` character).
+ *
+ * @param {Array<string>} chars - The list of characters to encode/decode.
+ * @returns {Object} An object containing:
+ * - `encode`: Function that encodes characters to hexadecimal format.
+ * - `decode`: Function that decodes hexadecimal values back to characters.
+ */
+export function create(chars: Array<string>): Object;
+export const encode: any;
+export const decode: any;
+export const encodeComponents: any;
+export const decodeComponents: any;

package/dist/legacy/firebase/escape.mjs

@@ -0,0 +1,58 @@
+// Credits
+// https://github.com/joonhocho/firebase-encode/blob/master/src/index.js
+// http://stackoverflow.com/a/6969486/692528
+/**
+ * Escapes special characters in a string to make them safe for use in regular expressions.
+ *
+ * @param {string} str - The string to escape.
+ * @returns {string} The escaped string.
+ */
+const escapeRegExp = (str) => str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&');
+/**
+ * Creates encoding and decoding functions for custom characters.
+ *
+ * This function returns two pairs of functions: one for encoding and decoding
+ * the characters to/from their hexadecimal representations and another for encoding
+ * and decoding components (without the `/` character).
+ *
+ * @param {Array<string>} chars - The list of characters to encode/decode.
+ * @returns {Object} An object containing:
+ * - `encode`: Function that encodes characters to hexadecimal format.
+ * - `decode`: Function that decodes hexadecimal values back to characters.
+ */
+const create = (chars) => {
+    // Map characters to their hexadecimal representations
+    const charCodes = chars.map((c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
+    // Maps to convert between character and hexadecimal code
+    const charToCode = {};
+    const codeToChar = {};
+    chars.forEach((c, i) => {
+        charToCode[c] = charCodes[i];
+        codeToChar[charCodes[i]] = c;
+    });
+    // Regex for matching characters and their corresponding hex codes
+    const charsRegex = new RegExp(`[${escapeRegExp(chars.join(''))}]`, 'g');
+    const charCodesRegex = new RegExp(charCodes.join('|'), 'g');
+    /**
+     * Encodes a string by replacing its characters with their corresponding hexadecimal codes.
+     *
+     * @param {string} str - The string to encode.
+     * @returns {string} The encoded string.
+     */
+    const encode = (str) => str.replace(charsRegex, (match) => charToCode[match]);
+    /**
+     * Decodes a string by replacing its hexadecimal codes with their corresponding characters.
+     *
+     * @param {string} str - The string to decode.
+     * @returns {string} The decoded string.
+     */
+    const decode = (str) => str.replace(charCodesRegex, (match) => codeToChar[match]);
+    return { encode, decode };
+};
+// http://stackoverflow.com/a/19148116/692528
+// Create encode and decode functions for specific characters.
+const { encode, decode } = create('.$[]#/%'.split(''));
+// Create encode and decode functions for components (without `/`).
+const { encode: encodeComponents, decode: decodeComponents } = create('.$[]#%'.split(''));
+// Export the functions for use.
+export { create, encode, decode, encodeComponents, decodeComponents };

package/dist/legacy/firebase/getDBAsync.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+/**
+ * Fetches data from a Firebase database asynchronously using the specified event type.
+ * This function wraps the Firebase database `once` method in a Promise, allowing asynchronous handling of database responses.
+ *
+ * @param {firebase.database.Reference} data - The Firebase database reference from which to retrieve data.
+ * @param {string} [type='value'] - The event type to listen for (e.g., 'value', 'child_added', 'child_changed', etc.).
+ * @returns {Promise<firebase.database.DataSnapshot>} A promise that resolves with the snapshot data when the request is successful.
+ * @throws {Error} If an error occurs during the database operation, the promise will be rejected with the error.
+ */
+function getDBAsync(data, type = 'value') {
+  return new Promise(function (resolve, reject) {
+    // Try
+    try {
+      // Run Data
+      data.once(
+        type,
+        function (snapshot) {
+          resolve(snapshot);
+        },
+        function (errorObject) {
+          reject(errorObject);
+        },
+      );
+    } catch (err) {
+      // Error
+      reject(err);
+    }
+  });
+}
+
+module.exports = getDBAsync;

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

@@ -0,0 +1,10 @@
+/**
+ * Fetches data from a Firebase database asynchronously using the specified event type.
+ * This function wraps the Firebase database `once` method in a Promise, allowing asynchronous handling of database responses.
+ *
+ * @param {firebase.database.Reference} data - The Firebase database reference from which to retrieve data.
+ * @param {string} [type='value'] - The event type to listen for (e.g., 'value', 'child_added', 'child_changed', etc.).
+ * @returns {Promise<firebase.database.DataSnapshot>} A promise that resolves with the snapshot data when the request is successful.
+ * @throws {Error} If an error occurs during the database operation, the promise will be rejected with the error.
+ */
+export default function getDBAsync(data: firebase.database.Reference, type?: string): Promise<firebase.database.DataSnapshot>;

package/dist/legacy/firebase/getDBAsync.mjs

@@ -0,0 +1,26 @@
+/**
+ * Fetches data from a Firebase database asynchronously using the specified event type.
+ * This function wraps the Firebase database `once` method in a Promise, allowing asynchronous handling of database responses.
+ *
+ * @param {firebase.database.Reference} data - The Firebase database reference from which to retrieve data.
+ * @param {string} [type='value'] - The event type to listen for (e.g., 'value', 'child_added', 'child_changed', etc.).
+ * @returns {Promise<firebase.database.DataSnapshot>} A promise that resolves with the snapshot data when the request is successful.
+ * @throws {Error} If an error occurs during the database operation, the promise will be rejected with the error.
+ */
+export default function getDBAsync(data, type = 'value') {
+    return new Promise(function (resolve, reject) {
+        // Try
+        try {
+            // Run Data
+            data.once(type, function (snapshot) {
+                resolve(snapshot);
+            }, function (errorObject) {
+                reject(errorObject);
+            });
+        }
+        catch (err) {
+            // Error
+            reject(err);
+        }
+    });
+}

package/dist/legacy/firebase/getDBData.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+var getDBAsync = require('./getDBAsync.cjs');
+var getDBValue = require('./getDBValue.cjs');
+
+function getDBData(data, type) {
+  return new Promise(function (resolve, reject) {
+    // Try
+    try {
+      // Get Data
+      getDBAsync(data, type)
+        .then((final_data) => resolve(getDBValue(final_data)))
+        .catch(reject);
+    } catch (err) {
+      // Error
+      reject(err);
+    }
+  });
+}
+
+module.exports = getDBData;

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

@@ -0,0 +1 @@
+export default function getDBData(data: any, type: any): Promise<any>;

package/dist/legacy/firebase/getDBData.mjs

@@ -0,0 +1,17 @@
+import getDBAsync from './getDBAsync.mjs';
+import getDBValue from './getDBValue.mjs';
+export default function getDBData(data, type) {
+    return new Promise(function (resolve, reject) {
+        // Try
+        try {
+            // Get Data
+            getDBAsync(data, type)
+                .then((final_data) => resolve(getDBValue(final_data)))
+                .catch(reject);
+        }
+        catch (err) {
+            // Error
+            reject(err);
+        }
+    });
+}

package/dist/legacy/firebase/getDBValue.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+/**
+ * Retrieves the value from a Firebase database snapshot.
+ * This function checks if the provided data object is a valid Firebase snapshot and
+ * calls its `.val()` method to get the actual data value.
+ *
+ * @param {firebase.database.DataSnapshot} data - The Firebase database snapshot from which to retrieve the value.
+ * @returns {any} The value stored in the snapshot, or `null` if the data is invalid or doesn't contain a valid value.
+ */
+function getDBValue(data) {
+  let new_data = null;
+  if (data && typeof data.val === 'function') new_data = data.val();
+  return new_data;
+}
+
+module.exports = getDBValue;

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

@@ -0,0 +1,9 @@
+/**
+ * Retrieves the value from a Firebase database snapshot.
+ * This function checks if the provided data object is a valid Firebase snapshot and
+ * calls its `.val()` method to get the actual data value.
+ *
+ * @param {firebase.database.DataSnapshot} data - The Firebase database snapshot from which to retrieve the value.
+ * @returns {any} The value stored in the snapshot, or `null` if the data is invalid or doesn't contain a valid value.
+ */
+export default function getDBValue(data: firebase.database.DataSnapshot): any;

package/dist/legacy/firebase/getDBValue.mjs

@@ -0,0 +1,14 @@
+/**
+ * Retrieves the value from a Firebase database snapshot.
+ * This function checks if the provided data object is a valid Firebase snapshot and
+ * calls its `.val()` method to get the actual data value.
+ *
+ * @param {firebase.database.DataSnapshot} data - The Firebase database snapshot from which to retrieve the value.
+ * @returns {any} The value stored in the snapshot, or `null` if the data is invalid or doesn't contain a valid value.
+ */
+export default function getDBValue(data) {
+    let new_data = null;
+    if (data && typeof data.val === 'function')
+        new_data = data.val();
+    return new_data;
+}

package/dist/legacy/firebase/index.cjs

@@ -0,0 +1,261 @@
+'use strict';
+
+var path = require('path');
+var fs = require('fs');
+var cookieSession = require('./cookieSession.cjs');
+var domainRedirect = require('./domainRedirect.cjs');
+var index = require('./database/index.cjs');
+var escape = require('./escape.cjs');
+var mySQL = require('./mySQL.cjs');
+var getDBAsync = require('./getDBAsync.cjs');
+var getDBValue = require('./getDBValue.cjs');
+var getDBData = require('./getDBData.cjs');
+var transactionDBAsync = require('./transactionDBAsync.cjs');
+var databaseEscape = require('./databaseEscape.cjs');
+var isEmulator = require('./isEmulator.cjs');
+
+/**
+ * Firebase Object to handle various Firebase services and utilities.
+ * Includes database, authentication, Firestore, storage, and more.
+ *
+ * @namespace firebaseObject
+ */
+const firebaseObject = { apps: {} };
+
+/**
+ * Retrieves a Firebase app by its identifier.
+ *
+ * @param {string|number} value - The app identifier to retrieve.
+ * @returns {Object|null} The Firebase app or `null` if not found.
+ */
+firebaseObject.get = function (value) {
+  // Check
+  if ((typeof value === 'string' || typeof value === 'number') && firebaseObject.apps[value]) {
+    // Send Item
+    return firebaseObject.apps[value];
+  }
+
+  // Nope
+  else return null;
+};
+
+/**
+ * Manages cookie session for authentication.
+ *
+ * @type {AuthSystem}
+ */
+firebaseObject.cookieSession = cookieSession;
+
+/**
+ * Manages domain redirection.
+ *
+ * @type {domainRedirect}
+ */
+firebaseObject.domainRedirect = domainRedirect;
+
+/**
+ * Handles Firebase Database interactions.
+ *
+ * @type {database}
+ */
+firebaseObject.database = index;
+
+/**
+ * Handles database escaping for safe queries.
+ *
+ * @type {Object}
+ */
+firebaseObject.escape = escape;
+
+/**
+ * Manages MySQL database interactions.
+ *
+ * @type {mySQL}
+ */
+firebaseObject.mysql = mySQL;
+
+/**
+ * Retrieves the database asynchronously.
+ *
+ * @type {getDBAsync}
+ */
+firebaseObject.getDBAsync = getDBAsync;
+
+/**
+ * Retrieves a specific database value.
+ *
+ * @type {getDBValue}
+ */
+firebaseObject.getDBValue = getDBValue;
+
+/**
+ * Retrieves database data asynchronously.
+ *
+ * @type {getDBData}
+ */
+firebaseObject.getDBData = getDBData;
+
+/**
+ * Handles asynchronous database transactions.
+ *
+ * @type {transactionDBAsync}
+ */
+firebaseObject.transactionDBAsync = transactionDBAsync;
+
+/**
+ * Provides database escape functionality for safe querying.
+ *
+ * @type {databaseEscape}
+ */
+firebaseObject.databaseEscape = databaseEscape;
+
+/**
+ * Logger to log information using Firebase or console.
+ *
+ * @type {Object}
+ */
+firebaseObject.logger = logger;
+
+/**
+ * Checks if the Firebase environment is running in emulator mode.
+ *
+ * @type {isEmulator}
+ */
+firebaseObject.isEmulator = isEmulator;
+
+/**
+ * Starts Firebase modules based on the provided configuration.
+ * Initializes services such as Database, Auth, Firestore, etc.
+ *
+ * @param {string} value - The Firebase app ID.
+ * @param {Object} item - Configuration for the Firebase app and services to initialize.
+ * @returns {boolean} `true` if the modules were successfully started, `false` otherwise.
+ */
+firebaseObject.startModule = function (value, item) {
+  // Check
+  if ((typeof value === 'string' || typeof value === 'number') && firebaseObject.apps[value]) {
+    // Confirm Action
+    let action_confirmed = false;
+
+    // Database
+    if (item.database) {
+      firebaseObject.apps[value].db = firebaseObject.apps[value].root.database();
+      action_confirmed = true;
+    }
+
+    // Auth
+    if (item.auth) {
+      firebaseObject.apps[value].auth = firebaseObject.apps[value].root.auth();
+      action_confirmed = true;
+    }
+
+    // Firestore
+    if (item.firestore) {
+      firebaseObject.apps[value].store = firebaseObject.apps[value].root.firestore();
+      action_confirmed = true;
+    }
+
+    // Storage
+    if (item.storage) {
+      firebaseObject.apps[value].storage = firebaseObject.apps[value].root.storage();
+      action_confirmed = true;
+    }
+
+    // Cloud Messaging
+    if (item.messaging) {
+      firebaseObject.apps[value].messaging = firebaseObject.apps[value].root.messaging();
+      action_confirmed = true;
+    }
+
+    // Send positive result
+    return action_confirmed;
+  }
+
+  // Nope
+  else return false;
+};
+
+/**
+ * Starts the Firebase app and initializes required services.
+ *
+ * @param {Object} admin - The Firebase Admin SDK.
+ * @param {Object} item - Configuration containing app details and options.
+ * @param {Object} data - Additional data to initialize the app.
+ * @throws {Error} Throws an error if the Firebase file is not found or if the app ID is missing.
+ */
+firebaseObject.start = function (admin, item, data) {
+  // Try
+  try {
+    // Start Firebase
+    const start_firebase = function (json_file = null) {
+      // Check Exist
+      if (!firebaseObject.apps[item.id]) {
+        // Firebase Settings
+        const firebase_settings = {};
+
+        // Exist File
+        if (json_file) firebase_settings.credential = admin.credential.cert(json_file);
+
+        // Read Data
+        if (data) {
+          for (const data_item in data) firebase_settings[data_item] = data[data_item];
+        }
+
+        // Fix Database URL
+        if (typeof firebase_settings.databaseURL === 'string') {
+          if (
+            !firebase_settings.databaseURL.startsWith('https://') &&
+            !firebase_settings.databaseURL.endsWith('.firebaseio.com')
+          )
+            firebase_settings.databaseURL = `https://${firebase_settings.databaseURL}.firebaseio.com`;
+        }
+
+        // Fix Storage URL
+        if (typeof firebase_settings.storageBucket === 'string')
+          if (!firebase_settings.storageBucket.endsWith('.appspot.com'))
+            firebase_settings.storageBucket = `${firebase_settings.storageBucket}.appspot.com`;
+
+        // Prepare Base
+        firebaseObject.apps[item.id] = {};
+
+        // Initialize App
+        firebaseObject.apps[item.id].root = admin.initializeApp(firebase_settings, item.id);
+
+        // Auto Start
+        if (item.autoStart) firebaseObject.startModule(item.id, item.autoStart);
+      }
+    };
+
+    // Exist ID
+    if (item && typeof item.id === 'string' && item.id !== 'start') {
+      // Check Variables
+      if (typeof item.appID === 'string') {
+        // Key File
+        let keyFile = null;
+        if (item.keysFolder) keyFile = path.join(item.keysFolder, item.appID + '.json');
+
+        // Exist File
+        if (keyFile && fs.existsSync(keyFile) && fs.lstatSync(keyFile).isFile()) {
+          try {
+            const jsonData = fs.readFileSync(keyFile, 'utf8');
+            const parsedKey = JSON.parse(jsonData);
+            start_firebase(parsedKey);
+          } catch (err) {
+            console.error(new Error('Failed to parse Firebase JSON file: ' + err.message));
+          }
+        } else console.error(new Error('Firebase File Not Found.'));
+      }
+
+      // Nope
+      else start_firebase();
+    }
+
+    // Nope
+    else console.error(new Error('You need to insert a ID value!'));
+  } catch (err) {
+    // Get Error
+    console.error(err);
+  }
+};
+
+module.exports = firebaseObject;