sahab-utils 1.2.0 → 1.2.1

package/package.json

@@ -1,25 +1,27 @@
 {
-  "name": "sahab-utils",
-  "version": "1.2.0",
-  "description": "This package containts types and utils fuctions",
-  "main": "index.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/SahabApp/sahab-utils.git"
-  },
-  "keywords": [
-    "sahab"
-  ],
-  "author": "Sahab",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/SahabApp/sahab-utils/issues"
-  },
-  "homepage": "https://github.com/SahabApp/sahab-utils#readme",
-  "dependencies": {
-    "firebase": "^10.7.1"
-  }
+	"name": "sahab-utils",
+	"version": "1.2.1",
+	"description": "This package containts types and utils fuctions",
+	"main": "index.ts",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/SahabApp/sahab-utils.git"
+	},
+	"keywords": [
+		"sahab"
+	],
+	"author": "Sahab",
+	"license": "ISC",
+	"bugs": {
+		"url": "https://github.com/SahabApp/sahab-utils/issues"
+	},
+	"homepage": "https://github.com/SahabApp/sahab-utils#readme",
+	"dependencies": {
+		"firebase": "^10.7.1",
+		"lodash": "^4.17.21"
+	},
+	"packageManager": "yarn@4.9.1+sha512.f95ce356460e05be48d66401c1ae64ef84d163dd689964962c6888a9810865e39097a5e9de748876c2e0bf89b232d583c33982773e9903ae7a76257270986538"
 }

package/ts/calcs.ts

@@ -1,195 +1,287 @@
-import { CarService, Order, OrderPaymentType, ProvidedAddon, ProvidedService, ReduxOrder } from '../constants/types';
-import { preventNaN } from './utils';
-
-export function getServicesTotal(order: Order | ReduxOrder | undefined) {
-    let total = 0;
-    if (order) {
-        if (order.services) {
-            order.services.forEach((carService) => {
-                carService.services.forEach((service) => {
-                    if (service.price) {
-                        const price = service.price.price;
-                        total += price;
-                    }
-                });
-            });
-        }
-    }
-    return total;
+import sum from 'lodash/sum';
+import { Discount, Order, OrderPaymentType, ProvidedAddon, ProvidedService } from '../constants/types';
+import { isEmpty, preventNaN, toFixed } from './utils';
+
+export const SAHAB_PERCENTAGE = 0;
+export const ONLINE_SAHAB_PERCENTAGE = 0.03;
+export const CLIENT_SAHAB_PERCENTAGE = 0.03;
+
+export function getServicesTotal(order?: Order) {
+	let total = 0;
+	if (order) {
+		if (order.services) {
+			order.services.forEach((carService) => {
+				carService.services.forEach((service) => {
+					if (service.price) {
+						const price = service.price.price;
+						total += price;
+					}
+				});
+			});
+		}
+	}
+	return total;
 }
 
-export const getSahabDiscountsAmount = (order: Order | ReduxOrder | undefined) => {
-    const orderTotal = getServicesTotal(order);
-    let discounts = 0;
-
-    if (order?.promoCode?.amount && order?.promoCode?.amount > 0 && !order?.promoCode?.createdByProvider) {
-        if (order?.promoCode?.isPercentage) {
-            discounts += (preventNaN(order?.promoCode?.amount) / 100) * orderTotal;
-        } else {
-            discounts += preventNaN(order?.promoCode?.amount);
-        }
-    }
-
-    // Sahab Services Discounts
-    (order?.services ?? [])?.forEach((carService) => {
-        (carService?.services || []).forEach((service) => {
-            let sahabDiscounts = (service?.discounts ?? []).filter((discount) => !discount?.createdByProvider);
-
-            if (sahabDiscounts.length) {
-                sahabDiscounts.forEach((discount) => {
-                    if (discount.isPercentage) {
-                        discounts += (preventNaN(discount?.amount ?? 0) / 100) * (service?.price?.price ?? 0);
-                    } else {
-                        discounts += preventNaN(discount?.amount ?? 0);
-                    }
-                });
-            }
-        });
-    });
-
-    if (order?.usedBalance && order?.usedBalance > 0) {
-        discounts += order?.usedBalance;
-    }
-
-    return discounts;
-};
-
-export const getProviderDiscountsAmount = (order: Order | ReduxOrder | undefined) => {
-    const orderTotal = getServicesTotal(order);
-    let discounts = 0;
-
-    if (order?.promoCode?.amount && order?.promoCode?.amount > 0 && order?.promoCode?.createdByProvider) {
-        if (order?.promoCode?.isPercentage) {
-            discounts += (preventNaN(order?.promoCode?.amount) / 100) * orderTotal;
-        } else {
-            discounts += preventNaN(order?.promoCode?.amount);
-        }
-    }
-
-    (order?.services ?? [])?.forEach((carService) => {
-        (carService?.services || []).forEach((service) => {
-            let sahabDiscounts = (service?.discounts ?? []).filter((discount) => discount?.createdByProvider);
-
-            if (sahabDiscounts.length) {
-                sahabDiscounts.forEach((discount) => {
-                    if (discount.isPercentage) {
-                        discounts += (preventNaN(discount?.amount ?? 0) / 100) * (service?.price?.price ?? 0);
-                    } else {
-                        discounts += preventNaN(discount?.amount ?? 0);
-                    }
-                });
-            }
-        });
-    });
-
-    return discounts;
-};
-
-export const getCustomerTotalToPay = (order: Order | ReduxOrder | undefined) => {
-    const orderTotal = getServicesTotal(order);
-    const discounts = getSahabDiscountsAmount(order) + getProviderDiscountsAmount(order);
-
-    return orderTotal - discounts;
-};
-
-export const getProviderTransferAmount = (order: Order | ReduxOrder | undefined) => {
-    const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
-    const paymentAmount = preventNaN(order?.paymentAmount ?? 0);
-
-    const originalPrice = orderTotal / (1 + (order?.sahabClientPercentage ?? 0));
-    const minimumProviderAmount = originalPrice - originalPrice * (order?.sahabProviderPercentage ?? 0);
-
-    if (order?.paymentType === OrderPaymentType.CASH) {
-        return minimumProviderAmount - paymentAmount;
-    } else {
-        const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
-        const onlinePercentage = getOnlineProcessingFees(order);
-        const sahabFees = paymentAmount < minimumProviderAmount ? orderTotal - minimumProviderAmount : paymentAmount - minimumProviderAmount;
-
-        return orderTotal - sahabFees - onlinePercentage;
-    }
-};
-
-export const getProviderProfits = (order: Order | ReduxOrder | undefined) => {
-    return order?.paymentType === OrderPaymentType.CASH
-        ? getCustomerTotalToPay(order) + getProviderTransferAmount(order)
-        : getProviderTransferAmount(order);
-};
-
-export const getOnlineProcessingFees = (order: Order | ReduxOrder | undefined) => {
-    if (order?.paymentType !== OrderPaymentType.CASH) {
-        const orderTotal = preventNaN(order?.paymentAmount ?? 0);
-
-        return preventNaN(order?.sahabOnlinePercentage ?? 0) * orderTotal;
-    }
-
-    return 0;
-};
-
-export const getSahabFees = (order: Order | ReduxOrder | undefined) => {
-    const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
-    const paymentAmount = preventNaN(order?.paymentAmount ?? 0);
-
-    const originalPrice = orderTotal / (1 + (order?.sahabClientPercentage ?? 0));
-    const minimumProviderAmount = originalPrice - originalPrice * (order?.sahabProviderPercentage ?? 0);
-
-    if (paymentAmount < minimumProviderAmount) {
-        return 0;
-    } else {
-        return paymentAmount - minimumProviderAmount;
-    }
-};
+export function getSahabDiscountsAmount(order: Order) {
+	const orderTotal = getServicesTotal(order);
+	let discounts = 0;
+
+	if (
+		['CHOCO', 'ROSE', 'ركن', 'الإيمان', 'التقوى', 'نور العترة', 'Zhraa_fit', 'Greens_fit', 'لوكيت', 'المنتزه'].includes(
+			order?.promoCode?.promoCode || ''
+		)
+	) {
+		discounts += 0.05 * orderTotal;
+	} else if (order?.promoCode?.amount && order?.promoCode?.amount > 0 && !order?.promoCode?.createdByProvider) {
+		if (order?.promoCode?.isPercentage) {
+			discounts += (preventNaN(order?.promoCode?.amount) / 100) * orderTotal;
+		} else {
+			discounts += preventNaN(order?.promoCode?.amount);
+		}
+	}
+
+	// Sahab Services Discounts
+	(order?.services ?? [])?.forEach((carService) => {
+		(carService?.services || []).forEach((service) => {
+			let sahabDiscounts = [service?.discount].filter((discount) => !discount?.createdByProvider) as Discount[];
+
+			if (sahabDiscounts.length) {
+				sahabDiscounts.forEach((discount) => {
+					if (discount?.isPercentage) {
+						discounts += (preventNaN(discount?.amount ?? 0) / 100) * (service?.price?.price ?? 0);
+					} else {
+						discounts += preventNaN(discount?.amount ?? 0);
+					}
+				});
+			}
+		});
+	});
+
+	if (order?.usedBalance && order?.usedBalance > 0) {
+		discounts += order?.usedBalance;
+	}
+
+	return discounts;
+}
+
+export function getProviderDiscountsAmount(order: Order) {
+	const orderTotal = getServicesTotal(order);
+	let discounts = 0;
+
+	if (
+		['CHOCO', 'ROSE', 'ركن', 'الإيمان', 'التقوى', 'نور العترة', 'Zhraa_fit', 'Greens_fit', 'لوكيت', 'المنتزه'].includes(
+			order?.promoCode?.promoCode || ''
+		)
+	) {
+		discounts += 0.05 * orderTotal;
+	} else if (order?.promoCode?.amount && order?.promoCode?.amount > 0 && order?.promoCode?.createdByProvider) {
+		if (order?.promoCode?.isPercentage) {
+			discounts += (preventNaN(order?.promoCode?.amount) / 100) * orderTotal;
+		} else {
+			discounts += preventNaN(order?.promoCode?.amount);
+		}
+	}
+
+	(order?.services ?? [])?.forEach((carService) => {
+		(carService?.services || []).forEach((service) => {
+			let sahabDiscounts = [service?.discount].filter((discount) => discount?.createdByProvider) as Discount[];
+
+			if (sahabDiscounts.length) {
+				sahabDiscounts.forEach((discount) => {
+					if (discount?.isPercentage) {
+						discounts += (preventNaN(discount?.amount ?? 0) / 100) * (service?.price?.price ?? 0);
+					} else {
+						discounts += preventNaN(discount?.amount ?? 0);
+					}
+				});
+			}
+		});
+	});
+
+	return discounts;
+}
+
+export function getOrderTotalDiscountsAmount(order: Order) {
+	return getSahabDiscountsAmount(order) + getProviderDiscountsAmount(order);
+}
+
+export function getCustomerTotalToPay(order: Order) {
+	const sahabExtraPaymentAmount = order?.paymentType === OrderPaymentType.CASH ? order?.sahabExtraPaymentAmount || 0 : 0;
+	const orderTotal = getServicesTotal(order) + sahabExtraPaymentAmount;
+	const discounts = getSahabDiscountsAmount(order) + getProviderDiscountsAmount(order);
+
+	return orderTotal - discounts;
+}
+
+export function getProviderTransferAmount(order: Order) {
+	const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
+	const paymentAmount = preventNaN(order?.paymentAmount ?? 0);
+
+	const originalPrice = orderTotal / (1 + preventNaN(order?.sahabClientPercentage ?? 0));
+	const minimumProviderAmount = originalPrice - originalPrice * (order?.sahabProviderPercentage ?? 0);
+
+	if (order?.paymentType === OrderPaymentType.CASH) {
+		return minimumProviderAmount - paymentAmount;
+	} else {
+		const onlinePercentage = getOnlineProcessingFees(order);
+		const sahabFees = paymentAmount < minimumProviderAmount ? orderTotal - minimumProviderAmount : paymentAmount - minimumProviderAmount;
+
+		return orderTotal - sahabFees - onlinePercentage;
+	}
+}
+
+export function getProviderProfits(order: Order) {
+	const sahabExtraPaymentAmount = order?.paymentType === OrderPaymentType.CASH ? order?.sahabExtraPaymentAmount || 0 : 0;
+	return order?.paymentType === OrderPaymentType.CASH
+		? getCustomerTotalToPay(order) - sahabExtraPaymentAmount + getProviderTransferAmount(order)
+		: getProviderTransferAmount(order);
+}
+
+export function getOnlineProcessingFees(order: Order) {
+	if (order?.paymentType !== OrderPaymentType.CASH) {
+		const orderTotal = preventNaN(order?.paymentAmount ?? 0);
+
+		return preventNaN(order?.sahabOnlinePercentage ?? 0) * orderTotal;
+	}
+
+	return 0;
+}
+
+export function getSahabFees(order: Order) {
+	const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order);
+	const paymentAmount = preventNaN(order?.paymentAmount ?? 0);
+
+	const originalPrice = orderTotal / (1 + preventNaN(order?.sahabClientPercentage ?? 0));
+	const minimumProviderAmount = originalPrice - originalPrice * (order?.sahabProviderPercentage ?? 0);
+
+	const sahabExtraPaymentAmount = order?.paymentType === OrderPaymentType.CASH ? order?.sahabExtraPaymentAmount || 0 : 0;
+
+	if (paymentAmount < minimumProviderAmount) {
+		return 0 + sahabExtraPaymentAmount;
+	} else {
+		return paymentAmount - minimumProviderAmount + sahabExtraPaymentAmount;
+	}
+}
+
+export function calcOrdersData(orders: Order[]) {
+	//Filter Orders
+	const cashOrders = orders.filter((o) => o.paymentType === OrderPaymentType.CASH);
+	const onlineOrders = orders.filter((o) => o.paymentType !== OrderPaymentType.CASH);
+
+	const sahabOnlineRevenue = sum(onlineOrders.map((o) => getSahabFees(o)));
+	const totalOnlineTransfer = sum(onlineOrders.map((o) => getProviderTransferAmount(o)));
+	const providerOnlineRevenue = sum(onlineOrders.map((o) => getProviderProfits(o)));
+
+	const sahabCashRevenue = sum(cashOrders.map((o) => getSahabFees(o)));
+	const totalCashTransfer = sum(cashOrders.map((o) => getProviderTransferAmount(o)));
+	const providerCashRevenue = sum(cashOrders.map((o) => getProviderProfits(o)));
+
+	//Calculate Percentages
+	const totalTransfer = totalOnlineTransfer + totalCashTransfer;
+	const totalSahabRevenue = sahabOnlineRevenue + sahabCashRevenue;
+	const totalProviderRevenue = providerOnlineRevenue + providerCashRevenue;
+
+	return {
+		name: orders?.[0]?.providerName?.ar ?? '',
+		numCashOrders: cashOrders.length,
+		numOnlineOrders: onlineOrders.length,
+		providerCashRevenue: toFixed(providerCashRevenue),
+		providerOnlineRevenue: toFixed(providerOnlineRevenue),
+		totalProviderRevenue: toFixed(totalProviderRevenue),
+		totalCashTransfer: toFixed(totalCashTransfer),
+		totalOnlineTransfer: toFixed(totalOnlineTransfer),
+		sahabCashRevenue: toFixed(sahabCashRevenue),
+		sahabOnlineRevenue: toFixed(sahabOnlineRevenue),
+		totalTransfer: toFixed(totalTransfer),
+		totalSahabRevenue: toFixed(totalSahabRevenue),
+	};
+}
+
+export function calculatePromoCodeAmount(order: Order) {
+	if (isEmpty(order?.promoCode) || (order?.promoCode?.amount && order?.promoCode?.amount <= 0)) {
+		return 0;
+	}
+
+	const orderTotal = getServicesTotal(order) - getProviderDiscountsAmount(order) - getSahabDiscountsAmount(order);
+	if (order?.promoCode?.isPercentage) {
+		return (preventNaN(order?.promoCode?.amount) / 100) * orderTotal;
+	}
+	return preventNaN(order?.promoCode?.amount);
+}
 
 export function calculateDiscountAmount(order: Order) {
-    let discounts = 0;
-
-    if (!order?.promoCode?.amount && !order?.services?.some((service) => service?.services?.some((s) => s?.discounts?.length))) {
-        return 0;
-    }
-
-    const orderTotal = getServicesTotal(order);
-    if (order?.promoCode?.isPercentage) {
-        discounts += (preventNaN(order?.promoCode?.amount ?? 0) / 100) * orderTotal;
-    } else if (order?.promoCode?.amount) {
-        discounts += preventNaN(order?.promoCode?.amount ?? 0);
-    }
-
-    if (order?.services?.some((service) => service?.services?.some((s) => s?.discounts?.length))) {
-        (order?.services ?? [])?.forEach((carService) => {
-            (carService?.services || []).forEach((service) => {
-                let sahabDiscounts = service?.discounts ?? [];
-
-                if (sahabDiscounts.length) {
-                    sahabDiscounts.forEach((discount) => {
-                        if (discount.isPercentage) {
-                            discounts += (preventNaN(discount?.amount ?? 0) / 100) * (service?.price?.price ?? 0);
-                        } else {
-                            discounts += preventNaN(discount?.amount ?? 0);
-                        }
-                    });
-                }
-            });
-        });
-    }
-
-    return discounts;
+	let discounts = 0;
+
+	if (!order?.promoCode?.amount && !order?.services?.some((service) => service?.services?.some((s) => s?.discount))) {
+		return 0;
+	}
+
+	const orderTotal = getServicesTotal(order);
+	if (order?.promoCode?.isPercentage) {
+		discounts += (preventNaN(order?.promoCode?.amount ?? 0) / 100) * orderTotal;
+	} else if (order?.promoCode?.amount) {
+		discounts += preventNaN(order?.promoCode?.amount ?? 0);
+	}
+
+	if (order?.services?.some((service) => service?.services?.some((s) => s?.discount))) {
+		(order?.services ?? [])?.forEach((carService) => {
+			(carService?.services || []).forEach((service) => {
+				let sahabDiscounts = [service?.discount] as Discount[];
+
+				if (sahabDiscounts.length) {
+					sahabDiscounts.forEach((discount) => {
+						if (discount.isPercentage) {
+							discounts += (preventNaN(discount?.amount ?? 0) / 100) * (service?.price?.price ?? 0);
+						} else {
+							discounts += preventNaN(discount?.amount ?? 0);
+						}
+					});
+				}
+			});
+		});
+	}
+
+	return discounts;
 }
 
 export function getServiceTotal(providedService: ProvidedService | ProvidedAddon) {
-    let total = 0;
-
-    total += providedService?.price?.price ?? 0;
-    let sahabDiscounts = providedService?.discounts ?? [];
-
-    if (sahabDiscounts.length) {
-        sahabDiscounts.forEach((discount) => {
-            if (discount.isPercentage) {
-                total -= (preventNaN(discount?.amount ?? 0) / 100) * (providedService?.price?.price ?? 0);
-            } else {
-                total -= preventNaN(discount?.amount ?? 0);
-            }
-        });
-    }
-
-    return total;
+	let total = 0;
+
+	total += providedService?.price?.price ?? 0;
+	let sahabDiscounts = [providedService?.discount] as Discount[];
+
+	if (sahabDiscounts.length) {
+		sahabDiscounts.forEach((discount) => {
+			if (discount.isPercentage) {
+				total -= (preventNaN(discount?.amount ?? 0) / 100) * (providedService?.price?.price ?? 0);
+			} else {
+				total -= preventNaN(discount?.amount ?? 0);
+			}
+		});
+	}
+
+	if (total < 0) {
+		total = 0;
+	}
+
+	const clientPercentage = 0.03 * total;
+
+	return total + clientPercentage;
+}
+
+export function calculateOrderPercentage({
+	isPaid,
+	paymentId,
+	providerPercentage,
+}: {
+	isPaid: boolean;
+	paymentId: string;
+	providerPercentage: number;
+}) {
+	if (isPaid && paymentId && !isEmpty(providerPercentage)) {
+		return ONLINE_SAHAB_PERCENTAGE + SAHAB_PERCENTAGE + CLIENT_SAHAB_PERCENTAGE + providerPercentage;
+	} else {
+		return SAHAB_PERCENTAGE + CLIENT_SAHAB_PERCENTAGE + providerPercentage;
+	}
 }

package/ts/utils.ts

@@ -1,6 +1,21 @@
 export function preventNaN(x?: number | string) {
-    if (x === undefined || x === null || isNaN(x as any)) {
-        return 0;
-    }
-    return Number(x);
-}
+	if (x === undefined || x === null || isNaN(x as any)) {
+		return 0;
+	}
+	return Number(x);
+}
+
+export const toFixed = (num: any) => {
+	const decimal_places = 2;
+	num = Number(num || 0);
+	return (Math.round(num * 10 ** decimal_places) / 10 ** decimal_places).toFixed(decimal_places);
+};
+
+export const isEmpty = (text: any) => {
+	const txt = typeof text === 'string' ? text.trim() : text;
+
+	if ((txt !== 0 && !txt) || txt === '' || txt === null || txt === 'null' || txt === ' ' || txt === undefined || txt === 'undefined') {
+		return true;
+	}
+	return false;
+};