tiny-essentials 1.24.0 → 1.24.1

package/dist/legacy/http/fetch/json.d.mts

@@ -1,24 +0,0 @@
-/**
- * Performs a `fetch` request using any provided arguments and returns a Promise
- * that resolves with the parsed JSON response.
- *
- * This function acts as a wrapper around `fetch`, automatically parsing the
- * response body as JSON and handling errors both at the network level and
- * during JSON parsing.
- *
- * @function getJsonFetch
- * @param {...any} arguments - All arguments are forwarded directly to the `fetch` function.
- *                            Common usage is `getJsonFetch(url, options)`.
- *
- * @returns {Promise<any>} A Promise that resolves with the parsed JSON data
- *                         if the request succeeds and the response is valid JSON,
- *                         or rejects with an error if the request or parsing fails.
- * @deprecated
- *
- * @example
- * getJsonFetch('https://api.example.com/data')
- *   .then(data => console.log(data))
- *   .catch(err => console.error('Fetch error:', err));
- */
-export default function getJsonFetch(...args: any[]): Promise<any>;
-//# sourceMappingURL=json.d.mts.map

package/dist/legacy/http/fetch/json.mjs

@@ -1,43 +0,0 @@
-import fetch from 'node-fetch';
-/**
- * Performs a `fetch` request using any provided arguments and returns a Promise
- * that resolves with the parsed JSON response.
- *
- * This function acts as a wrapper around `fetch`, automatically parsing the
- * response body as JSON and handling errors both at the network level and
- * during JSON parsing.
- *
- * @function getJsonFetch
- * @param {...any} arguments - All arguments are forwarded directly to the `fetch` function.
- *                            Common usage is `getJsonFetch(url, options)`.
- *
- * @returns {Promise<any>} A Promise that resolves with the parsed JSON data
- *                         if the request succeeds and the response is valid JSON,
- *                         or rejects with an error if the request or parsing fails.
- * @deprecated
- *
- * @example
- * getJsonFetch('https://api.example.com/data')
- *   .then(data => console.log(data))
- *   .catch(err => console.error('Fetch error:', err));
- */
-export default function getJsonFetch() {
-    const tinyArgs = arguments;
-    return new Promise((resolve, reject) => fetch
-        // @ts-ignore
-        .apply(fetch, tinyArgs)
-        .then((response) => {
-        // Get Response
-        response
-            .json()
-            .then((data) => {
-            resolve(data);
-        })
-            .catch((err) => {
-            reject(err);
-        });
-    })
-        .catch((err) => {
-        reject(err);
-    }));
-}

package/dist/legacy/http/fetch/text.cjs

@@ -1,49 +0,0 @@
-'use strict';
-
-var fetch = require('node-fetch');
-
-/**
- * Performs a `fetch` request using any provided arguments and returns a Promise
- * that resolves with the raw text response.
- *
- * This function is a wrapper around `fetch`, automatically extracting the response body
- * as plain text. It handles both network errors and issues during text parsing.
- *
- * @function getTextFetch
- * @param {...any} arguments - All arguments are forwarded directly to the `fetch` function.
- *                             Typically used as `getTextFetch(url, options)`.
- *
- * @returns {Promise<string>} A Promise that resolves with the response text
- *                            if the request is successful and parsing succeeds,
- *                            or rejects with an error if the request or text conversion fails.
- * @deprecated
- *
- * @example
- * getTextFetch('https://example.com/page')
- *   .then(text => console.log(text))
- *   .catch(err => console.error('Fetch error:', err));
- */
-function getTextFetch() {
-  const tinyArgs = arguments;
-  return new Promise((resolve, reject) =>
-    fetch
-      // @ts-ignore
-      .apply(fetch, tinyArgs)
-      .then((response) => {
-        // Get Response
-        response
-          .text()
-          .then((data) => {
-            resolve(data);
-          })
-          .catch((err) => {
-            reject(err);
-          });
-      })
-      .catch((err) => {
-        reject(err);
-      }),
-  );
-}
-
-module.exports = getTextFetch;

package/dist/legacy/http/fetch/text.d.mts

@@ -1,23 +0,0 @@
-/**
- * Performs a `fetch` request using any provided arguments and returns a Promise
- * that resolves with the raw text response.
- *
- * This function is a wrapper around `fetch`, automatically extracting the response body
- * as plain text. It handles both network errors and issues during text parsing.
- *
- * @function getTextFetch
- * @param {...any} arguments - All arguments are forwarded directly to the `fetch` function.
- *                             Typically used as `getTextFetch(url, options)`.
- *
- * @returns {Promise<string>} A Promise that resolves with the response text
- *                            if the request is successful and parsing succeeds,
- *                            or rejects with an error if the request or text conversion fails.
- * @deprecated
- *
- * @example
- * getTextFetch('https://example.com/page')
- *   .then(text => console.log(text))
- *   .catch(err => console.error('Fetch error:', err));
- */
-export default function getTextFetch(...args: any[]): Promise<string>;
-//# sourceMappingURL=text.d.mts.map

package/dist/legacy/http/fetch/text.mjs

@@ -1,42 +0,0 @@
-import fetch from 'node-fetch';
-/**
- * Performs a `fetch` request using any provided arguments and returns a Promise
- * that resolves with the raw text response.
- *
- * This function is a wrapper around `fetch`, automatically extracting the response body
- * as plain text. It handles both network errors and issues during text parsing.
- *
- * @function getTextFetch
- * @param {...any} arguments - All arguments are forwarded directly to the `fetch` function.
- *                             Typically used as `getTextFetch(url, options)`.
- *
- * @returns {Promise<string>} A Promise that resolves with the response text
- *                            if the request is successful and parsing succeeds,
- *                            or rejects with an error if the request or text conversion fails.
- * @deprecated
- *
- * @example
- * getTextFetch('https://example.com/page')
- *   .then(text => console.log(text))
- *   .catch(err => console.error('Fetch error:', err));
- */
-export default function getTextFetch() {
-    const tinyArgs = arguments;
-    return new Promise((resolve, reject) => fetch
-        // @ts-ignore
-        .apply(fetch, tinyArgs)
-        .then((response) => {
-        // Get Response
-        response
-            .text()
-            .then((data) => {
-            resolve(data);
-        })
-            .catch((err) => {
-            reject(err);
-        });
-    })
-        .catch((err) => {
-        reject(err);
-    }));
-}

package/dist/legacy/http/fileCache.cjs

@@ -1,80 +0,0 @@
-'use strict';
-
-var _ = require('lodash');
-var moment = require('moment-timezone');
-var md5 = require('md5');
-var byteLength = require('byte-length');
-
-/**
- * @function fileCache
- *
- * Sends a stringified file as a response with caching, security headers, and optional metadata.
- * If `data.file` is not a string, the request is passed to the next middleware.
- *
- * @param {import('express').Response} res - Express response object.
- * @param {import('express').NextFunction} next - Express next middleware function.
- * @param {object} data - Configuration object for the file response.
- * @param {string} [data.file] - The content of the file to send (must be a string).
- * @param {number} [data.fileMaxAge] - Max age in seconds for cache expiration.
- * @param {string} [data.date] - A date string used for the `Last-Modified` header.
- * @param {string} [data.timezone="Universal"] - Timezone for `moment.tz()`.
- * @param {string} [data.contentType="application/javascript"] - MIME type for the response.
- * @deprecated
- *
- * @example
- * import fileCache from './fileCache.mjs';
- *
- * app.get('/my-script.js', (req, res, next) => {
- *   const content = fs.readFileSync('./public/my-script.js', 'utf8');
- *   fileCache(res, next, {
- *     file: content,
- *     fileMaxAge: 3600,
- *     date: fs.statSync('./public/my-script.js').mtime,
- *     contentType: 'application/javascript'
- *   });
- * });
- */
-function fileCache(res, next, data) {
-  // Prepare Config
-  const tinyCfg = _.defaultsDeep({}, data, {
-    timezone: 'Universal',
-    contentType: 'application/javascript',
-  });
-
-  // Is String
-  if (typeof tinyCfg.file === 'string') {
-    // File Type
-    res.setHeader('Content-Type', tinyCfg.contentType);
-    res.setHeader('Accept-Ranges', 'bytes');
-    res.setHeader('Access-Control-Allow-Origin', 'same-origin');
-    res.setHeader('Cross-Origin-Resource-Policy', 'same-origin');
-    res.setHeader('X-Content-Type-Options', 'nosniff');
-    res.setHeader('X-Frame-Options', 'SAMEORIGIN');
-    res.setHeader('Timing-Allow-Origin', 'same-origin');
-    res.removeHeader('Connection');
-    res.removeHeader('X-Powered-By');
-
-    // MD5
-    if (md5) res.setHeader('Content-MD5', Buffer.from(md5(tinyCfg.file)).toString('base64'));
-
-    // Time
-    if (tinyCfg.date && moment)
-      res.setHeader('Last-Modified', moment.tz(tinyCfg.date, tinyCfg.timezone).toString());
-
-    // Cache Control
-    if (typeof tinyCfg.fileMaxAge === 'number')
-      res.setHeader('Expires', moment.tz('UTC').add(tinyCfg.fileMaxAge, 'seconds').toString());
-    res.set('Cache-Control', `public, max-age=${tinyCfg.fileMaxAge}`);
-
-    // File Size
-    if (byteLength) res.setHeader('Content-Length', byteLength.byteLength(tinyCfg.file));
-
-    // Send FIle
-    res.send(tinyCfg.file);
-  }
-
-  // Nope
-  else next();
-}
-
-module.exports = fileCache;

package/dist/legacy/http/fileCache.d.mts

@@ -1,37 +0,0 @@
-/**
- * @function fileCache
- *
- * Sends a stringified file as a response with caching, security headers, and optional metadata.
- * If `data.file` is not a string, the request is passed to the next middleware.
- *
- * @param {import('express').Response} res - Express response object.
- * @param {import('express').NextFunction} next - Express next middleware function.
- * @param {object} data - Configuration object for the file response.
- * @param {string} [data.file] - The content of the file to send (must be a string).
- * @param {number} [data.fileMaxAge] - Max age in seconds for cache expiration.
- * @param {string} [data.date] - A date string used for the `Last-Modified` header.
- * @param {string} [data.timezone="Universal"] - Timezone for `moment.tz()`.
- * @param {string} [data.contentType="application/javascript"] - MIME type for the response.
- * @deprecated
- *
- * @example
- * import fileCache from './fileCache.mjs';
- *
- * app.get('/my-script.js', (req, res, next) => {
- *   const content = fs.readFileSync('./public/my-script.js', 'utf8');
- *   fileCache(res, next, {
- *     file: content,
- *     fileMaxAge: 3600,
- *     date: fs.statSync('./public/my-script.js').mtime,
- *     contentType: 'application/javascript'
- *   });
- * });
- */
-export default function fileCache(res: import("express").Response, next: import("express").NextFunction, data: {
-    file?: string | undefined;
-    fileMaxAge?: number | undefined;
-    date?: string | undefined;
-    timezone?: string | undefined;
-    contentType?: string | undefined;
-}): void;
-//# sourceMappingURL=fileCache.d.mts.map

package/dist/legacy/http/fileCache.mjs

@@ -1,71 +0,0 @@
-import _ from 'lodash';
-import moment from 'moment-timezone';
-import md5 from 'md5';
-import byteLength from 'byte-length';
-/**
- * @function fileCache
- *
- * Sends a stringified file as a response with caching, security headers, and optional metadata.
- * If `data.file` is not a string, the request is passed to the next middleware.
- *
- * @param {import('express').Response} res - Express response object.
- * @param {import('express').NextFunction} next - Express next middleware function.
- * @param {object} data - Configuration object for the file response.
- * @param {string} [data.file] - The content of the file to send (must be a string).
- * @param {number} [data.fileMaxAge] - Max age in seconds for cache expiration.
- * @param {string} [data.date] - A date string used for the `Last-Modified` header.
- * @param {string} [data.timezone="Universal"] - Timezone for `moment.tz()`.
- * @param {string} [data.contentType="application/javascript"] - MIME type for the response.
- * @deprecated
- *
- * @example
- * import fileCache from './fileCache.mjs';
- *
- * app.get('/my-script.js', (req, res, next) => {
- *   const content = fs.readFileSync('./public/my-script.js', 'utf8');
- *   fileCache(res, next, {
- *     file: content,
- *     fileMaxAge: 3600,
- *     date: fs.statSync('./public/my-script.js').mtime,
- *     contentType: 'application/javascript'
- *   });
- * });
- */
-export default function fileCache(res, next, data) {
-    // Prepare Config
-    const tinyCfg = _.defaultsDeep({}, data, {
-        timezone: 'Universal',
-        contentType: 'application/javascript',
-    });
-    // Is String
-    if (typeof tinyCfg.file === 'string') {
-        // File Type
-        res.setHeader('Content-Type', tinyCfg.contentType);
-        res.setHeader('Accept-Ranges', 'bytes');
-        res.setHeader('Access-Control-Allow-Origin', 'same-origin');
-        res.setHeader('Cross-Origin-Resource-Policy', 'same-origin');
-        res.setHeader('X-Content-Type-Options', 'nosniff');
-        res.setHeader('X-Frame-Options', 'SAMEORIGIN');
-        res.setHeader('Timing-Allow-Origin', 'same-origin');
-        res.removeHeader('Connection');
-        res.removeHeader('X-Powered-By');
-        // MD5
-        if (md5)
-            res.setHeader('Content-MD5', Buffer.from(md5(tinyCfg.file)).toString('base64'));
-        // Time
-        if (tinyCfg.date && moment)
-            res.setHeader('Last-Modified', moment.tz(tinyCfg.date, tinyCfg.timezone).toString());
-        // Cache Control
-        if (typeof tinyCfg.fileMaxAge === 'number')
-            res.setHeader('Expires', moment.tz('UTC').add(tinyCfg.fileMaxAge, 'seconds').toString());
-        res.set('Cache-Control', `public, max-age=${tinyCfg.fileMaxAge}`);
-        // File Size
-        if (byteLength)
-            res.setHeader('Content-Length', byteLength.byteLength(tinyCfg.file));
-        // Send FIle
-        res.send(tinyCfg.file);
-    }
-    // Nope
-    else
-        next();
-}

package/dist/legacy/http/getDomainURL.cjs

@@ -1,60 +0,0 @@
-'use strict';
-
-var check_domain = require('./check_domain.cjs');
-
-/**
- * @function getDomainURL
- *
- * Constructs a full URL string from a domain and optional port, determining the proper protocol.
- * It also supports extracting the domain from an Express `req` object via `checkDomain.get(req)`.
- *
- * @param {string|import('express').Request} domain - A domain string (e.g. "example.com") or Express `req` object.
- * @param {number} [port] - Optional port to include in the URL (not added for ports 80 or 443).
- * @param {string} [httpResult='https'] - The protocol to use (usually "http" or "https").
- *
- * @returns {string} A fully constructed URL string. Returns an empty string if the domain is invalid.
- * @deprecated
- *
- * @example
- * getDomainURL('example.com', 443); // "https://example.com"
- * getDomainURL('localhost', 3000);  // "http://localhost:3000"
- * getDomainURL(req, 8080);          // Uses domain from request object
- */
-function getDomainURL(domain, port, httpResult = 'https') {
-  // Domain Selected
-  let domainSelected = null;
-
-  // String
-  if (typeof domain === 'string') domainSelected = domain;
-  // Nope
-  else domainSelected = check_domain.get(domain);
-
-  // Domain
-  if (typeof domainSelected === 'string') {
-    // Port
-    let finalPort = '';
-    let finalURL = '';
-    if (typeof port === 'number' && port !== 80 && port !== 443) {
-      finalPort = ':' + finalPort;
-    } else {
-      finalPort = '';
-    }
-
-    // Normal Domain
-    if (!domainSelected.startsWith('localhost:') && domainSelected !== 'localhost')
-      finalURL = `${httpResult}://${domainSelected}`;
-    // Localhost
-    else finalURL = `http://${domainSelected}`;
-
-    // Exist Port
-    if (finalPort && typeof finalURL.split(':')[2] !== 'string') finalURL += finalPort;
-
-    // Complete
-    return finalURL;
-  }
-
-  // Nope
-  else return '';
-}
-
-module.exports = getDomainURL;

package/dist/legacy/http/getDomainURL.d.mts

@@ -1,20 +0,0 @@
-/**
- * @function getDomainURL
- *
- * Constructs a full URL string from a domain and optional port, determining the proper protocol.
- * It also supports extracting the domain from an Express `req` object via `checkDomain.get(req)`.
- *
- * @param {string|import('express').Request} domain - A domain string (e.g. "example.com") or Express `req` object.
- * @param {number} [port] - Optional port to include in the URL (not added for ports 80 or 443).
- * @param {string} [httpResult='https'] - The protocol to use (usually "http" or "https").
- *
- * @returns {string} A fully constructed URL string. Returns an empty string if the domain is invalid.
- * @deprecated
- *
- * @example
- * getDomainURL('example.com', 443); // "https://example.com"
- * getDomainURL('localhost', 3000);  // "http://localhost:3000"
- * getDomainURL(req, 8080);          // Uses domain from request object
- */
-export default function getDomainURL(domain: string | import("express").Request, port?: number, httpResult?: string): string;
-//# sourceMappingURL=getDomainURL.d.mts.map

package/dist/legacy/http/getDomainURL.mjs

@@ -1,55 +0,0 @@
-import checkDomain from './check_domain.mjs';
-/**
- * @function getDomainURL
- *
- * Constructs a full URL string from a domain and optional port, determining the proper protocol.
- * It also supports extracting the domain from an Express `req` object via `checkDomain.get(req)`.
- *
- * @param {string|import('express').Request} domain - A domain string (e.g. "example.com") or Express `req` object.
- * @param {number} [port] - Optional port to include in the URL (not added for ports 80 or 443).
- * @param {string} [httpResult='https'] - The protocol to use (usually "http" or "https").
- *
- * @returns {string} A fully constructed URL string. Returns an empty string if the domain is invalid.
- * @deprecated
- *
- * @example
- * getDomainURL('example.com', 443); // "https://example.com"
- * getDomainURL('localhost', 3000);  // "http://localhost:3000"
- * getDomainURL(req, 8080);          // Uses domain from request object
- */
-export default function getDomainURL(domain, port, httpResult = 'https') {
-    // Domain Selected
-    let domainSelected = null;
-    // String
-    if (typeof domain === 'string')
-        domainSelected = domain;
-    // Nope
-    else
-        domainSelected = checkDomain.get(domain);
-    // Domain
-    if (typeof domainSelected === 'string') {
-        // Port
-        let finalPort = '';
-        let finalURL = '';
-        if (typeof port === 'number' && port !== 80 && port !== 443) {
-            finalPort = ':' + finalPort;
-        }
-        else {
-            finalPort = '';
-        }
-        // Normal Domain
-        if (!domainSelected.startsWith('localhost:') && domainSelected !== 'localhost')
-            finalURL = `${httpResult}://${domainSelected}`;
-        // Localhost
-        else
-            finalURL = `http://${domainSelected}`;
-        // Exist Port
-        if (finalPort && typeof finalURL.split(':')[2] !== 'string')
-            finalURL += finalPort;
-        // Complete
-        return finalURL;
-    }
-    // Nope
-    else
-        return '';
-}

package/dist/legacy/http/userIP.cjs

@@ -1,65 +0,0 @@
-'use strict';
-
-var _ = require('lodash');
-
-/**
- * @typedef {{ value: string[] | string, type: string | null }} IpResult
- */
-
-/**
- * Retrieves the client's IP address from the Express request object,
- * supporting detection for Firebase/Cloud Functions, proxies, and direct connections.
- *
- * @param {import('express').Request} req - The Express request object.
- * @param {Object} [options] - Optional configuration.
- * @param {boolean} [options.isFirebase=false] - Enable detection for Firebase environments (e.g., Fastly).
- *
- * @returns {IpResult} An object containing the list of IP addresses and the detection source type.
- * @deprecated
- *
- * @example
- * const ipInfo = userIp(req);
- * console.log(ipInfo.value); // ['192.168.0.1']
- * console.log(ipInfo.type);  // 'x-forwarded-for'
- */
-function userIp(req, options) {
-  /** @type {IpResult} */
-  const ip = {};
-
-  const tinyCfg = _.defaultsDeep({}, options, {
-    isFirebase: false,
-  });
-
-  if (req.headers) {
-    // Firebase / Fastly
-    if (tinyCfg.isFirebase && req.headers['fastly-client-ip']) {
-      ip.value = req.headers['fastly-client-ip'];
-      ip.type = 'fastly-client-ip';
-    }
-
-    // Proxies
-    if (typeof ip.value !== 'string' && req.headers['x-forwarded-for']) {
-      ip.value = req.headers['x-forwarded-for'];
-      ip.type = 'x-forwarded-for';
-    }
-  }
-
-  // Connection IP
-  if (typeof ip.value !== 'string' && req.connection && req.connection.remoteAddress) {
-    ip.value = req.connection.remoteAddress;
-    ip.type = 'connection.remoteAddress';
-  }
-
-  // Fallback: req.ip (Express built-in)
-  if (typeof ip.value !== 'string' && req.ip) {
-    ip.value = req.ip;
-    ip.type = 'req.ip';
-  }
-
-  // Normalize as array
-  if (typeof ip.value === 'string') ip.value = ip.value.split(',').map((i) => i.trim());
-
-  return ip;
-}
-
-module.exports = userIp;

package/dist/legacy/http/userIP.d.mts

@@ -1,27 +0,0 @@
-/**
- * @typedef {{ value: string[] | string, type: string | null }} IpResult
- */
-/**
- * Retrieves the client's IP address from the Express request object,
- * supporting detection for Firebase/Cloud Functions, proxies, and direct connections.
- *
- * @param {import('express').Request} req - The Express request object.
- * @param {Object} [options] - Optional configuration.
- * @param {boolean} [options.isFirebase=false] - Enable detection for Firebase environments (e.g., Fastly).
- *
- * @returns {IpResult} An object containing the list of IP addresses and the detection source type.
- * @deprecated
- *
- * @example
- * const ipInfo = userIp(req);
- * console.log(ipInfo.value); // ['192.168.0.1']
- * console.log(ipInfo.type);  // 'x-forwarded-for'
- */
-export default function userIp(req: import("express").Request, options?: {
-    isFirebase?: boolean | undefined;
-}): IpResult;
-export type IpResult = {
-    value: string[] | string;
-    type: string | null;
-};
-//# sourceMappingURL=userIP.d.mts.map

package/dist/legacy/http/userIP.mjs

@@ -1,53 +0,0 @@
-import _ from 'lodash';
-/**
- * @typedef {{ value: string[] | string, type: string | null }} IpResult
- */
-/**
- * Retrieves the client's IP address from the Express request object,
- * supporting detection for Firebase/Cloud Functions, proxies, and direct connections.
- *
- * @param {import('express').Request} req - The Express request object.
- * @param {Object} [options] - Optional configuration.
- * @param {boolean} [options.isFirebase=false] - Enable detection for Firebase environments (e.g., Fastly).
- *
- * @returns {IpResult} An object containing the list of IP addresses and the detection source type.
- * @deprecated
- *
- * @example
- * const ipInfo = userIp(req);
- * console.log(ipInfo.value); // ['192.168.0.1']
- * console.log(ipInfo.type);  // 'x-forwarded-for'
- */
-export default function userIp(req, options) {
-    /** @type {IpResult} */
-    const ip = {};
-    const tinyCfg = _.defaultsDeep({}, options, {
-        isFirebase: false,
-    });
-    if (req.headers) {
-        // Firebase / Fastly
-        if (tinyCfg.isFirebase && req.headers['fastly-client-ip']) {
-            ip.value = req.headers['fastly-client-ip'];
-            ip.type = 'fastly-client-ip';
-        }
-        // Proxies
-        if (typeof ip.value !== 'string' && req.headers['x-forwarded-for']) {
-            ip.value = req.headers['x-forwarded-for'];
-            ip.type = 'x-forwarded-for';
-        }
-    }
-    // Connection IP
-    if (typeof ip.value !== 'string' && req.connection && req.connection.remoteAddress) {
-        ip.value = req.connection.remoteAddress;
-        ip.type = 'connection.remoteAddress';
-    }
-    // Fallback: req.ip (Express built-in)
-    if (typeof ip.value !== 'string' && req.ip) {
-        ip.value = req.ip;
-        ip.type = 'req.ip';
-    }
-    // Normalize as array
-    if (typeof ip.value === 'string')
-        ip.value = ip.value.split(',').map((i) => i.trim());
-    return ip;
-}