tiny-essentials 1.24.0 → 1.24.1

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

@@ -1,52 +0,0 @@
-export default firebaseObject;
-declare namespace firebaseObject {
-    /**
-     * 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.
-     */
-    export function get(value: string | number): Object | null;
-    export { AuthSystem as cookieSession };
-    export { domainRedirect };
-    export { database };
-    export { dbEscape as escape };
-    export { mySQL as mysql };
-    export { getDBAsync };
-    export { getDBValue };
-    export { getDBData };
-    export { transactionDBAsync };
-    export { databaseEscape };
-    export let logger: Record<string, any>;
-    export { 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 {Record<string, any>} item - Configuration for the Firebase app and services to initialize.
-     * @returns {boolean} `true` if the modules were successfully started, `false` otherwise.
-     */
-    export function startModule(value: string, item: Record<string, any>): boolean;
-    /**
-     * Starts the Firebase app and initializes required services.
-     *
-     * @param {Record<string, any>} admin - The Firebase Admin SDK.
-     * @param {Record<string, any>} item - Configuration containing app details and options.
-     * @param {Record<string, any>} 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.
-     */
-    export function start(admin: Record<string, any>, item: Record<string, any>, data: Record<string, any>): void;
-}
-import AuthSystem from './cookieSession.mjs';
-import domainRedirect from './domainRedirect.mjs';
-import database from './database/index.mjs';
-import * as dbEscape from './escape.mjs';
-import mySQL from './mySQL.mjs';
-import getDBAsync from './getDBAsync.mjs';
-import getDBValue from './getDBValue.mjs';
-import getDBData from './getDBData.mjs';
-import transactionDBAsync from './transactionDBAsync.mjs';
-import databaseEscape from './databaseEscape.mjs';
-import isEmulator from './isEmulator.mjs';
-//# sourceMappingURL=index.d.mts.map

package/dist/legacy/firebase/index.mjs

@@ -1,235 +0,0 @@
-// @ts-nocheck
-import { join } from 'path';
-import { existsSync, lstatSync, readFileSync } from 'fs';
-import AuthSystem from './cookieSession.mjs';
-import domainRedirect from './domainRedirect.mjs';
-import database from './database/index.mjs';
-import * as dbEscape from './escape.mjs';
-import mySQL from './mySQL.mjs';
-import getDBAsync from './getDBAsync.mjs';
-import getDBValue from './getDBValue.mjs';
-import getDBData from './getDBData.mjs';
-import transactionDBAsync from './transactionDBAsync.mjs';
-import databaseEscape from './databaseEscape.mjs';
-import isEmulator from './isEmulator.mjs';
-/**
- * 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 = AuthSystem;
-/**
- * Manages domain redirection.
- *
- * @type {domainRedirect}
- */
-firebaseObject.domainRedirect = domainRedirect;
-/**
- * Handles Firebase Database interactions.
- *
- * @type {database}
- */
-firebaseObject.database = database;
-/**
- * Handles database escaping for safe queries.
- *
- * @type {Record<string, any>}
- */
-firebaseObject.escape = dbEscape;
-/**
- * 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 {Record<string, any>}
- */
-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 {Record<string, any>} 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 {Record<string, any>} admin - The Firebase Admin SDK.
- * @param {Record<string, any>} item - Configuration containing app details and options.
- * @param {Record<string, any>} 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 = join(item.keysFolder, item.appID + '.json');
-                // Exist File
-                if (keyFile && existsSync(keyFile) && lstatSync(keyFile).isFile()) {
-                    try {
-                        const jsonData = 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);
-    }
-};
-// Send Module
-export default firebaseObject;

package/dist/legacy/firebase/isEmulator.cjs

@@ -1,16 +0,0 @@
-'use strict';
-
-// @ts-nocheck
-
-/**
- * Checks if the Firebase Functions are running in the emulator environment.
- * This function relies on the environment variable `FUNCTIONS_EMULATOR` to determine
- * whether the Firebase Functions are being executed locally in an emulator or in production.
- *
- * @returns {boolean} `true` if the Firebase Functions are running in the emulator, `false` otherwise.
- */
-function isEmulator() {
-  return process.env.FUNCTIONS_EMULATOR;
-}
-
-module.exports = isEmulator;

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

@@ -1,9 +0,0 @@
-/**
- * Checks if the Firebase Functions are running in the emulator environment.
- * This function relies on the environment variable `FUNCTIONS_EMULATOR` to determine
- * whether the Firebase Functions are being executed locally in an emulator or in production.
- *
- * @returns {boolean} `true` if the Firebase Functions are running in the emulator, `false` otherwise.
- */
-export default function isEmulator(): boolean;
-//# sourceMappingURL=isEmulator.d.mts.map

package/dist/legacy/firebase/isEmulator.mjs

@@ -1,11 +0,0 @@
-// @ts-nocheck
-/**
- * Checks if the Firebase Functions are running in the emulator environment.
- * This function relies on the environment variable `FUNCTIONS_EMULATOR` to determine
- * whether the Firebase Functions are being executed locally in an emulator or in production.
- *
- * @returns {boolean} `true` if the Firebase Functions are running in the emulator, `false` otherwise.
- */
-export default function isEmulator() {
-    return process.env.FUNCTIONS_EMULATOR;
-}

package/dist/legacy/firebase/logger.cjs

@@ -1,140 +0,0 @@
-'use strict';
-
-var clone = require('clone');
-var index = require('../../_virtual/index.cjs');
-var objFilter = require('../../v1/basics/objFilter.cjs');
-var isEmulator = require('./isEmulator.cjs');
-
-// @ts-nocheck
-
-
-/**
- * Recursively handles nested objects and arrays, converting any `BigInt` values
- * into an object with the type `_type_object: 'BIGINT'` and the `value` as a string.
- * This ensures that `BigInt` values are properly serialized and handled.
- *
- * @param {Object|Array} data - The data to process, which can be an object or an array.
- * @returns {Object|Array} The processed data with `BigInt` values converted into objects.
- */
-const loopInteraction = function (data) {
-  const checkData = function (item) {
-    // Checking
-    if (objFilter.objType(data[item], 'object') || Array.isArray(data[item])) {
-      loopInteraction(data[item]);
-    }
-
-    // BigInt
-    else if (objFilter.objType(data[item], 'bigint'))
-      data[item] = { _type_object: 'BIGINT', value: data[item].toString() };
-  };
-
-  // Data
-  if (objFilter.objType(data, 'object') || Array.isArray(data)) for (const item in data) checkData(item);
-  else {
-    // Get BigInt
-    if (objFilter.objType(data, 'bigint')) data = { _type_object: 'BIGINT', value: data.toString() };
-  }
-
-  // Complete
-  return data;
-};
-
-/**
- * A utility function that handles logging messages based on the environment.
- * If the environment is production and the `firebase-functions/logger` is available,
- * it will use Firebase's logger. Otherwise, it falls back to using the native JavaScript console.
- * The function also handles special cases like `BigInt` serialization and nested objects/arrays.
- *
- * @param {string} type - The type of log message (e.g., `log`, `info`, `warn`, `error`).
- * @param {Arguments} args - The arguments to be logged.
- * @returns {Promise<Record<string, any>>} A promise resolving with the result of the logging operation,
- * or the result of logging to the native console if Firebase logger is not available.
- */
-const logBase = async function (type, args) {
-  // Production
-  if (!isEmulator()) {
-    // Exist Log
-    if (index) {
-      let consoleData;
-      if (objFilter.objType(args, 'error'))
-        consoleData = JSON.parse(JSON.stringify(args, Object.getOwnPropertyNames(args)));
-      else consoleData = args;
-
-      for (const item in consoleData) {
-        let argData = clone(consoleData[item]);
-        loopInteraction(argData);
-
-        if (objFilter.objType(argData, 'object') || Array.isArray(argData))
-          argData = JSON.stringify(argData, null, 2);
-
-        consoleData[item] = argData;
-      }
-
-      const result = await index[type].apply(index, consoleData);
-
-      return {
-        result: result,
-        type: 'firebase-functions/logger',
-      };
-    }
-
-    // Nope
-    else
-      return {
-        result: console[type].apply(console, args),
-        type: 'console/javascript-vanilla',
-      };
-  }
-
-  // Nope
-  else
-    return {
-      result: console[type].apply(console, args),
-      type: 'console/javascript-vanilla',
-    };
-};
-
-// Module
-const fbLogger = {
-  /**
-   * Logs a message with the `log` level. If not in emulator mode, it uses Firebase's logger.
-   *
-   * @param {...*} args - The arguments to log.
-   * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-   */
-  log: function () {
-    return logBase('log', arguments);
-  },
-
-  /**
-   * Logs a message with the `info` level. If not in emulator mode, it uses Firebase's logger.
-   *
-   * @param {...*} args - The arguments to log.
-   * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-   */
-  info: function () {
-    return logBase('info', arguments);
-  },
-
-  /**
-   * Logs a message with the `warn` level. If not in emulator mode, it uses Firebase's logger.
-   *
-   * @param {...*} args - The arguments to log.
-   * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-   */
-  warn: function () {
-    return logBase('warn', arguments);
-  },
-
-  /**
-   * Logs a message with the `error` level. If not in emulator mode, it uses Firebase's logger.
-   *
-   * @param {...*} args - The arguments to log.
-   * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-   */
-  error: function () {
-    return logBase('error', arguments);
-  },
-};
-
-module.exports = fbLogger;

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

@@ -1,8 +0,0 @@
-export default fbLogger;
-declare namespace fbLogger {
-    function log(...args: any[]): Promise<Record<string, any>>;
-    function info(...args: any[]): Promise<Record<string, any>>;
-    function warn(...args: any[]): Promise<Record<string, any>>;
-    function error(...args: any[]): Promise<Record<string, any>>;
-}
-//# sourceMappingURL=logger.d.mts.map

package/dist/legacy/firebase/logger.mjs

@@ -1,126 +0,0 @@
-// @ts-nocheck
-import clone from 'clone';
-import logger from 'firebase-functions/logger';
-import objType from '../get/objType.mjs';
-import isEmulator from './isEmulator.mjs';
-/**
- * Recursively handles nested objects and arrays, converting any `BigInt` values
- * into an object with the type `_type_object: 'BIGINT'` and the `value` as a string.
- * This ensures that `BigInt` values are properly serialized and handled.
- *
- * @param {Object|Array} data - The data to process, which can be an object or an array.
- * @returns {Object|Array} The processed data with `BigInt` values converted into objects.
- */
-const loopInteraction = function (data) {
-    // Check Data
-    const interaction = {};
-    const checkData = function (item) {
-        // Checking
-        if (objType(data[item], 'object') || Array.isArray(data[item])) {
-            interaction[item] = {};
-            interaction[item] = loopInteraction(data[item]);
-        }
-        // BigInt
-        else if (objType(data[item], 'bigint'))
-            data[item] = { _type_object: 'BIGINT', value: data[item].toString() };
-    };
-    // Data
-    if (objType(data, 'object') || Array.isArray(data))
-        for (const item in data)
-            checkData(item);
-    else {
-        // Get BigInt
-        if (objType(data, 'bigint'))
-            data = { _type_object: 'BIGINT', value: data.toString() };
-    }
-    // Complete
-    return data;
-};
-/**
- * A utility function that handles logging messages based on the environment.
- * If the environment is production and the `firebase-functions/logger` is available,
- * it will use Firebase's logger. Otherwise, it falls back to using the native JavaScript console.
- * The function also handles special cases like `BigInt` serialization and nested objects/arrays.
- *
- * @param {string} type - The type of log message (e.g., `log`, `info`, `warn`, `error`).
- * @param {Arguments} args - The arguments to be logged.
- * @returns {Promise<Record<string, any>>} A promise resolving with the result of the logging operation,
- * or the result of logging to the native console if Firebase logger is not available.
- */
-const logBase = async function (type, args) {
-    // Production
-    if (!isEmulator()) {
-        // Exist Log
-        if (logger) {
-            let consoleData;
-            if (objType(args, 'error'))
-                consoleData = JSON.parse(JSON.stringify(args, Object.getOwnPropertyNames(args)));
-            else
-                consoleData = args;
-            for (const item in consoleData) {
-                let argData = clone(consoleData[item]);
-                loopInteraction(argData);
-                if (objType(argData, 'object') || Array.isArray(argData))
-                    argData = JSON.stringify(argData, null, 2);
-                consoleData[item] = argData;
-            }
-            const result = await logger[type].apply(logger, consoleData);
-            return {
-                result: result,
-                type: 'firebase-functions/logger',
-            };
-        }
-        // Nope
-        else
-            return {
-                result: console[type].apply(console, args),
-                type: 'console/javascript-vanilla',
-            };
-    }
-    // Nope
-    else
-        return {
-            result: console[type].apply(console, args),
-            type: 'console/javascript-vanilla',
-        };
-};
-// Module
-const fbLogger = {
-    /**
-     * Logs a message with the `log` level. If not in emulator mode, it uses Firebase's logger.
-     *
-     * @param {...*} args - The arguments to log.
-     * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-     */
-    log: function () {
-        return logBase('log', arguments);
-    },
-    /**
-     * Logs a message with the `info` level. If not in emulator mode, it uses Firebase's logger.
-     *
-     * @param {...*} args - The arguments to log.
-     * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-     */
-    info: function () {
-        return logBase('info', arguments);
-    },
-    /**
-     * Logs a message with the `warn` level. If not in emulator mode, it uses Firebase's logger.
-     *
-     * @param {...*} args - The arguments to log.
-     * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-     */
-    warn: function () {
-        return logBase('warn', arguments);
-    },
-    /**
-     * Logs a message with the `error` level. If not in emulator mode, it uses Firebase's logger.
-     *
-     * @param {...*} args - The arguments to log.
-     * @returns {Promise<Record<string, any>>} A promise resolving with the logging result.
-     */
-    error: function () {
-        return logBase('error', arguments);
-    },
-};
-export default fbLogger;

package/dist/legacy/firebase/mySQL.cjs

@@ -1,30 +0,0 @@
-'use strict';
-
-require('clone');
-require('../../v1/basics/objFilter.cjs');
-
-// @ts-nocheck
-
-
-/**
- * Connects to a MySQL database using the provided configuration and credentials.
- * The function utilizes `mySqlConnector.create` to establish the connection.
- *
- * @param {Record<string, any>} mysql - The MySQL module instance.
- * @param {Array|string} databases - The list of databases to connect to, or a single database name.
- * @param {Record<string, any>} cfg - The configuration object containing connection details (e.g., host, user, password).
- * @returns {Promise} Resolves with the connection object or rejects with an error.
- */
-function mySQL(mysql, databases, cfg) {
-  return new Promise(function (resolve, reject) {
-    // Get Module
-    try {
-      mySqlConnector.create(mysql, databases, cfg, 'firebase').then(resolve).catch(reject);
-    } catch (err) {
-      // Error
-      reject(err);
-    }
-  });
-}
-
-module.exports = mySQL;

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

@@ -1,11 +0,0 @@
-/**
- * Connects to a MySQL database using the provided configuration and credentials.
- * The function utilizes `mySqlConnector.create` to establish the connection.
- *
- * @param {Record<string, any>} mysql - The MySQL module instance.
- * @param {Array|string} databases - The list of databases to connect to, or a single database name.
- * @param {Record<string, any>} cfg - The configuration object containing connection details (e.g., host, user, password).
- * @returns {Promise} Resolves with the connection object or rejects with an error.
- */
-export default function mySQL(mysql: Record<string, any>, databases: any[] | string, cfg: Record<string, any>): Promise<any>;
-//# sourceMappingURL=mySQL.d.mts.map

package/dist/legacy/firebase/mySQL.mjs

@@ -1,23 +0,0 @@
-// @ts-nocheck
-import mysqlConnector from './mysqlConnector/index.mjs';
-/**
- * Connects to a MySQL database using the provided configuration and credentials.
- * The function utilizes `mySqlConnector.create` to establish the connection.
- *
- * @param {Record<string, any>} mysql - The MySQL module instance.
- * @param {Array|string} databases - The list of databases to connect to, or a single database name.
- * @param {Record<string, any>} cfg - The configuration object containing connection details (e.g., host, user, password).
- * @returns {Promise} Resolves with the connection object or rejects with an error.
- */
-export default function mySQL(mysql, databases, cfg) {
-    return new Promise(function (resolve, reject) {
-        // Get Module
-        try {
-            mySqlConnector.create(mysql, databases, cfg, 'firebase').then(resolve).catch(reject);
-        }
-        catch (err) {
-            // Error
-            reject(err);
-        }
-    });
-}