@fluyappgocore/commons-backend 1.0.202

package/build/lib/functions.d.ts

@@ -0,0 +1,89 @@
+import { Response } from "express";
+import { LimitedType } from "./helpers";
+export declare const getMailSubjectFromHTML: (html: string, defaultSubject: string) => Promise<string>;
+/**
+ * Extracts rate limiting metadata from HTTP response headers
+ *
+ * @param res - Express/HTTP Response object containing rate limit headers
+ * @returns {RateLimitMetadata} Object containing rate limit information
+ *    - limit: Maximum number of requests allowed (X-RateLimit-Limit)
+ *    - remaining: Number of requests remaining (X-RateLimit-Remaining)
+ *    - reset: Timestamp when the rate limit resets (X-RateLimit-Reset)
+ */
+export declare const getRateLimitMetadata: (res: Response) => {
+    limit: string | undefined;
+    remaining: string | undefined;
+    reset: string | undefined;
+};
+export declare const getClientIP: (req: any) => any;
+/**
+ * Creates a rate limiter that restricts requests to a specified maximum within a one-minute window
+ * @param maxRequests - Maximum number of requests allowed per minute (defaults to 10)
+ * @returns Express middleware rate limiter
+ * @example
+ * // Allow 20 requests per minute
+ * app.use(createOneMinuteLimiter(20));
+ */
+export declare const createOneMinuteLimiter: (maxRequests?: number) => import("express-rate-limit").RateLimitRequestHandler;
+/**
+ * Creates a rate limiter that restricts requests to a specified maximum within a ten-minute window
+ * @param maxRequests - Maximum number of requests allowed per 10 minutes (defaults to 50)
+ * @returns Express middleware rate limiter
+ * @example
+ * // Allow 100 requests per 10 minutes
+ * app.use(createTenMinuteLimiter(100));
+ */
+export declare const createTenMinuteLimiter: (maxRequests?: number) => import("express-rate-limit").RateLimitRequestHandler;
+export declare const oneMinuteLimiter: import("express-rate-limit").RateLimitRequestHandler;
+export declare const tenMinuteLimiter: import("express-rate-limit").RateLimitRequestHandler;
+/**
+ * Formats a date according to Spanish (es-ES) locale specifications
+ * @param date - Date object to format
+ * @returns Formatted date string in the format "DD/MM/YYYY HH:mm:ss"
+ * @example
+ * // Returns "25/03/2024 14:30:45"
+ * formatDateEs(new Date());
+ */
+export declare const formatDateEs: (date: Date) => string;
+/**
+ * Sanitizes a text field by removing newlines and trimming whitespace
+ * @param field - String to sanitize
+ * @returns Sanitized string with newlines replaced by spaces and trimmed
+ * @example
+ * // Returns "Hello World"
+ * sanitizeField("Hello\nWorld");
+ */
+export declare const sanitizeField: (field: string) => string;
+/**
+ * Compares two objects and returns an object containing the fields that have changed,
+ * along with their old and new values. All values are converted to strings for comparison.
+ * Objects are JSON stringified for comparison.
+ *
+ * @param oldObj - The original object to compare from
+ * @param newObj - The new object to compare against
+ * @returns An object mapping changed field names to their old and new string values
+ * @example
+ * const oldUser = { name: "John", age: 30, data: { score: 100 } };
+ * const newUser = { name: "John", age: 31, data: { score: 200 } };
+ * const changes = getChangedFields(oldUser, newUser);
+ * // Returns:
+ * // {
+ * //   age: { oldValue: "30", newValue: "31" },
+ * //   data: { oldValue: '{"score":100}', newValue: '{"score":200}' }
+ * // }
+ */
+export declare const getChangedFields: (oldObj: any, newObj: any) => {
+    [key: string]: {
+        oldValue: string;
+        newValue: string;
+    };
+};
+/**
+ * Gets the limit for a specific resource type based on the entity's tier
+ * @param entity - Entity object with tierId property
+ * @param limit - The type of limit to retrieve (branch, department, service, user, agent, device, ticketsMonthly)
+ * @returns The limit value for the specified type, or -1 if tier is unknown or entity has no tierId
+ */
+export declare const getLimitsByTier: (entity: {
+    tierId?: number;
+} | null, limit: LimitedType) => number;

package/build/lib/functions.js

@@ -0,0 +1,214 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLimitsByTier = exports.getChangedFields = exports.sanitizeField = exports.formatDateEs = exports.tenMinuteLimiter = exports.oneMinuteLimiter = exports.createTenMinuteLimiter = exports.createOneMinuteLimiter = exports.getClientIP = exports.getRateLimitMetadata = exports.getMailSubjectFromHTML = void 0;
+var express_rate_limit_1 = __importDefault(require("express-rate-limit"));
+var helpers_1 = require("./helpers");
+var getMailSubjectFromHTML = function (html, defaultSubject) { return __awaiter(void 0, void 0, void 0, function () {
+    var titleRegex, match, pageTitle;
+    return __generator(this, function (_a) {
+        titleRegex = /<title>(.*?)<\/title>/;
+        match = html.match(titleRegex);
+        if (match && match[1]) {
+            pageTitle = match[1];
+            return [2 /*return*/, pageTitle];
+        }
+        else {
+            return [2 /*return*/, defaultSubject];
+        }
+        return [2 /*return*/];
+    });
+}); };
+exports.getMailSubjectFromHTML = getMailSubjectFromHTML;
+/**
+ * Extracts rate limiting metadata from HTTP response headers
+ *
+ * @param res - Express/HTTP Response object containing rate limit headers
+ * @returns {RateLimitMetadata} Object containing rate limit information
+ *    - limit: Maximum number of requests allowed (X-RateLimit-Limit)
+ *    - remaining: Number of requests remaining (X-RateLimit-Remaining)
+ *    - reset: Timestamp when the rate limit resets (X-RateLimit-Reset)
+ */
+var getRateLimitMetadata = function (res) {
+    var _a, _b, _c;
+    return {
+        limit: ((_a = res.getHeader("X-RateLimit-Limit")) === null || _a === void 0 ? void 0 : _a.toString()) || undefined,
+        remaining: ((_b = res.getHeader("X-RateLimit-Remaining")) === null || _b === void 0 ? void 0 : _b.toString()) || undefined,
+        reset: ((_c = res.getHeader("X-RateLimit-Reset")) === null || _c === void 0 ? void 0 : _c.toString()) || undefined,
+    };
+};
+exports.getRateLimitMetadata = getRateLimitMetadata;
+var getClientIP = function (req) { return req.ip || req.headers["x-forwarded-for"] || req.connection.remoteAddress; };
+exports.getClientIP = getClientIP;
+/**
+ * Creates a rate limiter that restricts requests to a specified maximum within a one-minute window
+ * @param maxRequests - Maximum number of requests allowed per minute (defaults to 10)
+ * @returns Express middleware rate limiter
+ * @example
+ * // Allow 20 requests per minute
+ * app.use(createOneMinuteLimiter(20));
+ */
+var createOneMinuteLimiter = function (maxRequests) {
+    if (maxRequests === void 0) { maxRequests = 10; }
+    return express_rate_limit_1.default({
+        windowMs: 1 * 60 * 1000,
+        max: maxRequests,
+        message: "Too many requests in 1 minute (max " + maxRequests + "), please slow down.",
+        headers: true,
+        keyGenerator: exports.getClientIP,
+    });
+};
+exports.createOneMinuteLimiter = createOneMinuteLimiter;
+/**
+ * Creates a rate limiter that restricts requests to a specified maximum within a ten-minute window
+ * @param maxRequests - Maximum number of requests allowed per 10 minutes (defaults to 50)
+ * @returns Express middleware rate limiter
+ * @example
+ * // Allow 100 requests per 10 minutes
+ * app.use(createTenMinuteLimiter(100));
+ */
+var createTenMinuteLimiter = function (maxRequests) {
+    if (maxRequests === void 0) { maxRequests = 50; }
+    return express_rate_limit_1.default({
+        windowMs: 10 * 60 * 1000,
+        max: maxRequests,
+        message: "Too many requests in 10 minutes (max " + maxRequests + "), please slow down.",
+        headers: true,
+        keyGenerator: exports.getClientIP,
+    });
+};
+exports.createTenMinuteLimiter = createTenMinuteLimiter;
+// For backward compatibility
+exports.oneMinuteLimiter = exports.createOneMinuteLimiter();
+exports.tenMinuteLimiter = exports.createTenMinuteLimiter();
+/**
+ * Formats a date according to Spanish (es-ES) locale specifications
+ * @param date - Date object to format
+ * @returns Formatted date string in the format "DD/MM/YYYY HH:mm:ss"
+ * @example
+ * // Returns "25/03/2024 14:30:45"
+ * formatDateEs(new Date());
+ */
+var formatDateEs = function (date) {
+    return date
+        .toLocaleString("es-ES", {
+        year: "numeric",
+        month: "2-digit",
+        day: "2-digit",
+        hour: "2-digit",
+        minute: "2-digit",
+        second: "2-digit",
+    })
+        .replace(",", "");
+};
+exports.formatDateEs = formatDateEs;
+/**
+ * Sanitizes a text field by removing newlines and trimming whitespace
+ * @param field - String to sanitize
+ * @returns Sanitized string with newlines replaced by spaces and trimmed
+ * @example
+ * // Returns "Hello World"
+ * sanitizeField("Hello\nWorld");
+ */
+var sanitizeField = function (field) { return (field ? field.replace(/\r?\n|\r/g, " ").trim() : ""); };
+exports.sanitizeField = sanitizeField;
+/**
+ * Compares two objects and returns an object containing the fields that have changed,
+ * along with their old and new values. All values are converted to strings for comparison.
+ * Objects are JSON stringified for comparison.
+ *
+ * @param oldObj - The original object to compare from
+ * @param newObj - The new object to compare against
+ * @returns An object mapping changed field names to their old and new string values
+ * @example
+ * const oldUser = { name: "John", age: 30, data: { score: 100 } };
+ * const newUser = { name: "John", age: 31, data: { score: 200 } };
+ * const changes = getChangedFields(oldUser, newUser);
+ * // Returns:
+ * // {
+ * //   age: { oldValue: "30", newValue: "31" },
+ * //   data: { oldValue: '{"score":100}', newValue: '{"score":200}' }
+ * // }
+ */
+var getChangedFields = function (oldObj, newObj) {
+    var changes = {};
+    Object.keys(newObj).forEach(function (key) {
+        var oldValue = oldObj[key];
+        var newValue = newObj[key];
+        // Skip if values are the same
+        if (oldValue === newValue)
+            return;
+        // Convert values to strings for comparison and storage
+        var oldStringified = typeof oldValue === "object" && oldValue !== null ? JSON.stringify(oldValue) : String(oldValue !== null && oldValue !== void 0 ? oldValue : "");
+        var newStringified = typeof newValue === "object" && newValue !== null ? JSON.stringify(newValue) : String(newValue);
+        // Only add if values are actually different when compared as strings
+        if (oldStringified !== newStringified) {
+            changes[key] = {
+                oldValue: oldStringified,
+                newValue: newStringified,
+            };
+        }
+    });
+    return changes;
+};
+exports.getChangedFields = getChangedFields;
+/**
+ * Gets the limit for a specific resource type based on the entity's tier
+ * @param entity - Entity object with tierId property
+ * @param limit - The type of limit to retrieve (branch, department, service, user, agent, device, ticketsMonthly)
+ * @returns The limit value for the specified type, or -1 if tier is unknown or entity has no tierId
+ */
+var getLimitsByTier = function (entity, limit) {
+    if (entity === null || entity === void 0 ? void 0 : entity.tierId) {
+        var tier = entity.tierId;
+        if (tier === 1) {
+            return helpers_1.TierLimits.free[limit];
+        }
+        else if (tier === 2) {
+            return helpers_1.TierLimits.starter[limit];
+        }
+        return -1; // Default for unknown tiers
+    }
+    else {
+        return -1;
+    }
+};
+exports.getLimitsByTier = getLimitsByTier;

package/build/lib/helpers.d.ts

@@ -0,0 +1,29 @@
+export declare enum LimitedType {
+    branch = "branch",
+    department = "department",
+    service = "service",
+    user = "user",
+    agent = "agent",
+    device = "device",
+    ticketsMonthly = "ticketsMonthly"
+}
+export declare const TierLimits: {
+    free: {
+        branch: number;
+        department: number;
+        service: number;
+        user: number;
+        agent: number;
+        device: number;
+        ticketsMonthly: number;
+    };
+    starter: {
+        branch: number;
+        department: number;
+        service: number;
+        user: number;
+        agent: number;
+        device: number;
+        ticketsMonthly: number;
+    };
+};

package/build/lib/helpers.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TierLimits = exports.LimitedType = void 0;
+var LimitedType;
+(function (LimitedType) {
+    LimitedType["branch"] = "branch";
+    LimitedType["department"] = "department";
+    LimitedType["service"] = "service";
+    LimitedType["user"] = "user";
+    LimitedType["agent"] = "agent";
+    LimitedType["device"] = "device";
+    LimitedType["ticketsMonthly"] = "ticketsMonthly";
+})(LimitedType = exports.LimitedType || (exports.LimitedType = {}));
+exports.TierLimits = {
+    free: {
+        branch: 1,
+        department: 1,
+        service: 5,
+        user: 4,
+        agent: 3,
+        device: 0,
+        ticketsMonthly: 200,
+    },
+    starter: {
+        branch: 3,
+        department: 3,
+        service: 20,
+        user: 6,
+        agent: 5,
+        device: 3,
+        ticketsMonthly: 5000,
+    },
+};

package/build/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./functions";
+export * from "./helpers";
+export * from "./logger";
+export * from "./ensureDatabase";

package/build/lib/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./functions"), exports);
+__exportStar(require("./helpers"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./ensureDatabase"), exports);

package/build/lib/logger.d.ts

@@ -0,0 +1,2 @@
+import pino from "pino";
+export declare const logger: pino.Logger<never, boolean>;

package/build/lib/logger.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+var pino_1 = __importDefault(require("pino"));
+exports.logger = pino_1.default({
+    level: process.env.LOG_LEVEL || 'info',
+    transport: {
+        target: 'pino-pretty',
+        options: {
+            colorize: true,
+            levelFirst: true,
+            translateTime: 'SYS:standard',
+            ignore: 'pid,hostname',
+            messageFormat: '{msg} {context}',
+            customLevels: {
+                error: 50,
+                warn: 40,
+                info: 30,
+                debug: 20,
+                trace: 10
+            },
+            customColors: 'error:red,warn:yellow,info:blue,debug:green,trace:gray'
+        },
+    },
+    base: {
+        env: process.env.NODE_ENV,
+    },
+    timestamp: function () { return ",\"time\":\"" + new Date(Date.now()).toISOString() + "\""; },
+    formatters: {
+        level: function (label) {
+            return { level: label.toUpperCase() };
+        },
+    },
+    redact: {
+        paths: ['password', 'secret', 'token', '*.password', '*.secret', '*.token'],
+        censor: '**REDACTED**'
+    },
+});

package/build/middlewares/auth.middleware.d.ts

@@ -0,0 +1,6 @@
+import { NextFunction, Response, Request } from "express";
+import { RequestWithUser, RequestWithUserFB } from "../interfaces";
+export declare function authFBMiddleware(request: RequestWithUserFB, response: Response, next: NextFunction): Promise<void>;
+export declare function authMiddleware(request: RequestWithUser, response: Response, next: NextFunction): Promise<void>;
+export declare function midAuthMiddleware(request: RequestWithUser, response: Response, next: NextFunction): Promise<void>;
+export declare function authTokenMiddleware(request: Request, response: Response, next: NextFunction): Promise<void>;