sahab-utils 1.0.0

package/constants/types.ts

@@ -0,0 +1,579 @@
+import { DocumentReference, GeoPoint, Timestamp } from 'firebase/firestore'
+
+export type GeoPointType = GeoPoint;
+export type TimestampType = Timestamp
+
+export type DistenceDueration = {
+	distance: string;
+	duration: string;
+};
+
+export enum CarSize {
+	X_SMALL,
+	SMALL,
+	MEDIUM,
+	LARGE,
+	X_LARGE,
+}
+
+export type Car = {
+	carId: string;
+	manufacturer: string;
+	model: string;
+	size: CarSize;
+	year: string;
+	color: string;
+	plateLetters: string;
+	plateNumber: string;
+	imageUrl?: string;
+};
+
+export type Client = {
+	uid: string;
+	phoneNumber: string;
+	firstName: string;
+	lastName: string;
+	email?: string;
+	balance: number;
+	rating?: number;
+	imageUrl?: string;
+};
+
+export type Price = {
+	size: CarSize;
+	price: number;
+};
+
+export enum OrderStatus {
+	PENDING, // 0
+	CONFIRMED, // 1
+	REJECTED, // 2
+	EXPIRED, // 3
+	IN_PROGRESS, // 4
+	COMPLETED, // 5
+	CANCELLED, // 6
+	RATED, // 7
+	STARTED, // 8
+}
+
+export enum OrderPaymentType {
+	APPLE_PAY,
+	CREDIT,
+	CASH,
+}
+
+export type Location = {
+	geohash?: string;
+	northeast: GeoPointType;
+	southwest: GeoPointType;
+};
+
+// IF ADDING A NEW PROPERTY TO THIS TYPE
+// PLEASE ADD IT TO THE REDUX ORDER TYPE AS WELL
+// AND ALSO IN `extractReduxOrder` FUNCTION IN `utils.ts`
+// IN ORDER TO AVOID ANY PROBLEMS
+export type Order = {
+	orderId?: string;
+	clientRef?: DocumentReference;
+	clientId?: string;
+	client?: Client;
+	providerRef?: DocumentReference;
+	providerId?: string;
+	servedBy?: DocumentReference;
+	servedByName?: string;
+	createdDate?: TimestampType;
+	orderDate?: TimestampType;
+	services?: CarService[];
+	location?: GeoPointType;
+	locationUrl?: string;
+	willClientBeThere?: boolean;
+	paymentType?: OrderPaymentType;
+	clientRating?: number;
+	providerRating?: number;
+	orderStatus?: OrderStatus;
+	staticMap?: any; // For static map
+	isPaid?: boolean;
+	rejectedBy?: string[];
+	finishDate?: TimestampType;
+	arrivalDate?: TimestampType;
+	canceledDate?: TimestampType;
+	paymentAmount?: number;
+	sahabPercentage?: number; // 0.06
+	sahabClientPercentage?: number; // 0.03
+	sahabOnlinePercentage?: number; // 0.03
+	sahabProviderPercentage?: number; // 0.03
+	paymentId?: string;
+	paymentCancelationId?: string;
+	paymentRefundId?: string;
+	paymentCaptureId?: string;
+	canceledBy?: 'provider' | 'client';
+	movementsCreated?: boolean;
+	orderNote?: string;
+	cancelReason?: string;
+	isDismissed?: boolean;
+	isLate?: boolean;
+	promoCode?: Discount;
+	isTest?: boolean;
+	clientNumber?: string;
+	usedBalance?: number;
+	isDummyOrder?: boolean;
+	ratingNote?: string;
+};
+
+// ! DO NOT PLACE ANY FIRESTORE REF IN THIS OBJECT TYPE
+export type ReduxOrder = {
+	orderId?: string;
+	clientId?: string;
+	client?: Client;
+	servedByPath?: string; // as "service_providers/providerId/drivers/driverId"
+	providerId?: string;
+	servedByName?: string;
+	createdDate?: TimestampType;
+	orderDate?: TimestampType;
+	canceledDate?: TimestampType;
+	services?: CarService[];
+	location?: GeoPointType;
+	locationUrl?: string;
+	willClientBeThere?: boolean;
+	paymentType?: OrderPaymentType;
+	clientRating?: number;
+	providerRating?: number;
+	orderStatus?: OrderStatus;
+	staticMap?: any; // For static map
+	isPaid?: boolean;
+	rejectedBy?: string[];
+	finishDate?: TimestampType;
+	arrivalDate?: TimestampType;
+	paymentAmount?: number;
+	sahabPercentage?: number; // 0.06
+	sahabClientPercentage?: number; // 0.03
+	sahabOnlinePercentage?: number; // 0.03
+	sahabProviderPercentage?: number; // 0.03
+	paymentId?: string;
+	paymentCancelationId?: string;
+	paymentRefundId?: string;
+	paymentCaptureId?: string;
+	canceledBy?: 'provider' | 'client';
+	movementsCreated?: boolean;
+	orderNote?: string;
+	cancelReason?: string;
+	isDismissed?: boolean;
+	isLate?: boolean;
+	promoCode?: Discount;
+	clientNumber?: string;
+	isTest?: boolean;
+	usedBalance?: number;
+	isDummyOrder?: boolean;
+	ratingNote?: string;
+	discounts?: Discount[];
+};
+
+export type MoneyMovement = {
+	movementId: string;
+	amount: number;
+	orderId?: string;
+	date: TimestampType;
+	movementType: MovementType;
+	createdBy?: string;
+};
+
+export enum MovementType {
+	CLIENT_ORDER_PAYMENT,
+	CLIENT_BALANCE_TOP_UP,
+	PROVIDER_NEGATIVE_BALANCE_PAYMENT,
+	PROVIDER_POSITIVE_BALANCE_PAYMENT,
+	ORDER_REFUND,
+	SAHAB_PAYMENT_TO_PROVIDER,
+	SAHAB_RECEIVE_FROM_PROVIDER,
+	USING_BALANCE,
+}
+
+export enum ComplaintType {
+	BUG,
+	COMPLAINT,
+}
+
+export enum ComplaintStatus {
+	PENDING,
+	IN_REVIEW,
+	RESOLVED,
+}
+
+export type Complaint = {
+	complaintId: string;
+	complaintNumber: string;
+	desc: string;
+	createdDate: TimestampType;
+	status: ComplaintStatus;
+	type: ComplaintType;
+	resolvedBy?: string;
+	resolveDate?: string;
+};
+
+export type City = {
+	cityId?: string;
+	cityName: string;
+	countryName: string;
+	cityName_ar: string;
+	countryName_ar: string;
+	locationBounds?: Location;
+	coordinates?: GeoPointType;
+	g?: { geohash: string; geopoint: GeoPointType };
+	providerUid?: string;
+};
+
+export type Driver = {
+	type?: 'driver';
+	driverId?: string;
+	providerUid?: string;
+	firstName?: string;
+	lastName?: string;
+	phoneNumber?: string;
+	imageUrl?: string;
+	language?: 'en' | 'ar';
+	mainPushToken?: string;
+	hmsPushToken?: string;
+	cities?: City[];
+	isAllowedToCross?: boolean;
+	deactivated?: boolean;
+};
+
+export type ProviderCar = {
+	carId?: string;
+	providerRef?: DocumentReference;
+	manufacturer?: string;
+	model?: string;
+	year?: string;
+	color?: string;
+	plateLetters?: string;
+	plateNumber?: string;
+	istimarahUrl?: string;
+	fileType?: string;
+};
+
+export type Day = 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday';
+
+export type HH =
+	| '00'
+	| '01'
+	| '02'
+	| '03'
+	| '04'
+	| '05'
+	| '06'
+	| '07'
+	| '08'
+	| '09'
+	| '10'
+	| '11'
+	| '12'
+	| '13'
+	| '14'
+	| '15'
+	| '16'
+	| '17'
+	| '18'
+	| '19'
+	| '20'
+	| '21'
+	| '22'
+	| '23';
+export type MM =
+	| '00'
+	| '01'
+	| '02'
+	| '03'
+	| '04'
+	| '05'
+	| '06'
+	| '07'
+	| '08'
+	| '09'
+	| '10'
+	| '11'
+	| '12'
+	| '13'
+	| '14'
+	| '15'
+	| '16'
+	| '17'
+	| '18'
+	| '19'
+	| '20'
+	| '21'
+	| '22'
+	| '23'
+	| '24'
+	| '25'
+	| '26'
+	| '27'
+	| '28'
+	| '29'
+	| '30'
+	| '31'
+	| '32'
+	| '33'
+	| '34'
+	| '35'
+	| '36'
+	| '37'
+	| '38'
+	| '39'
+	| '40'
+	| '41'
+	| '42'
+	| '43'
+	| '44'
+	| '45'
+	| '46'
+	| '47'
+	| '48'
+	| '49'
+	| '50'
+	| '51'
+	| '52'
+	| '53'
+	| '54'
+	| '55'
+	| '56'
+	| '57'
+	| '58'
+	| '59';
+export type Hour = `${HH}:${MM}`;
+export type WorkingHour = {
+	start: Hour;
+	end: Hour;
+};
+export type WorkingHours = {
+	sunday: WorkingHour[];
+	monday: WorkingHour[];
+	tuesday: WorkingHour[];
+	wednesday: WorkingHour[];
+	thursday: WorkingHour[];
+	friday: WorkingHour[];
+	saturday: WorkingHour[];
+};
+
+export enum ReviewStatus {
+	PENDING,
+	IN_REVIEW,
+	ACCEPTED,
+	DECLINED,
+}
+
+export enum RegistrationSection {
+	OWNER_NAME,
+	CITY,
+	RULES,
+	BUSINESS_INFO,
+	DRIVERS_INFO,
+	VEHICLE_PERMIT,
+	VEHICLE_REGISTRATION,
+	SERVICES,
+	ADDONS,
+	WORKING_HOURS,
+	OVERVIEW,
+	STATUS,
+	DONE,
+}
+
+export type DeclineReason = {
+	reasonDesc: {
+		ar: string;
+		en: string;
+	};
+	section: RegistrationSection;
+};
+
+export type ProviderService = {
+	serviceId?: string;
+	name?: {
+		ar: string;
+		en: string;
+	};
+	imageUrl?: string;
+	providerId?: string;
+	prices?: Price[];
+	description?: {
+		ar: string;
+		en: string;
+	};
+	includedServices?: {
+		ar: string;
+		en: string;
+	}[];
+	hide?: boolean;
+	time?: number;
+	numberOfVisits?: number;
+};
+
+export type ProvidedService = {
+	serviceId?: string;
+	name?: {
+		ar: string;
+		en: string;
+	};
+	imageUrl?: string;
+	providerId?: string;
+	description?: {
+		ar: string;
+		en: string;
+	};
+	price: Price;
+	isDone?: boolean;
+	finishDate?: TimestampType;
+	quantity?: number;
+	type: 'service';
+	time?: number;
+	includedServices?: {
+		ar: string;
+		en: string;
+	}[];
+	numberOfVisits?: number;
+	discounts?: Discount[];
+};
+
+export type ProviderAddon = {
+	addonId?: string;
+	providerId?: string;
+	name?: {
+		ar: string;
+		en: string;
+	};
+	prices?: Price[];
+	description?: {
+		ar: string;
+		en: string;
+	};
+	hide?: boolean;
+	time?: number;
+};
+
+export type ProvidedAddon = {
+	addonId?: string;
+	providerId?: string;
+	name?: {
+		ar: string;
+		en: string;
+	};
+	price?: Price;
+	description?: {
+		ar: string;
+		en: string;
+	};
+	quantity?: number;
+	type: 'addon';
+	time?: number;
+	isDone?: boolean;
+	finishDate?: TimestampType;
+	discounts?: Discount[];
+};
+
+export type Provider = {
+	type?: 'provider';
+	providerUid?: string;
+	providerName?: {
+		ar: string;
+		en: string;
+	};
+	providerPhoneNumber?: string; // not used anymore
+	providerCarNumber?: string;
+	numberOfDrivers?: number;
+	numberOfCars?: number;
+	totalRating?: number;
+	numberOfRaters?: number;
+	logoUrl?: string;
+	phoneNumber?: string;
+	ownerFirstName?: string;
+	ownerLastName?: string;
+	services?: ProviderService[];
+	addons?: ProviderAddon[];
+	working247?: boolean;
+	workingHoursV2?: WorkingHours;
+	submitDate?: TimestampType;
+	reviewStatus?: ReviewStatus;
+	reviewedBy?: string;
+	declineReasons?: DeclineReason[];
+	acceptOrdersAutomatically?: boolean;
+	freeWashes?: number;
+	registrationSection?: RegistrationSection;
+	currency?: string;
+	mainPushToken?: string;
+	hmsPushToken?: string;
+	isTest?: boolean;
+	language?: 'en' | 'ar';
+	balance?: number;
+	permitUrl?: string;
+	permitType?: string;
+	checkoutCustomerId?: string;
+	ownerEmail?: string;
+	isEmailVerified?: boolean;
+	receiveOrders?: boolean; // true if undefined or null
+	isAcceptingOrders?: boolean;
+};
+
+export type Card = {
+	id?: string;
+	issuer?: string;
+	expiry_month?: string;
+	expiry_year?: string;
+	name?: string;
+	scheme?: string;
+	bin?: string;
+	last4?: string;
+	customer?: {
+		id?: string;
+	};
+
+	default?: boolean;
+	customer_id?: string;
+};
+
+export type CheckoutCustomer = {
+	default?: string;
+	email?: string;
+	id?: string;
+	name?: string;
+	instruments?: Card[];
+	metadata?: {
+		iban?: string;
+		providerUid?: string;
+	};
+};
+
+export type CarService = {
+	car?: Car;
+	services: Array<ProvidedService | ProvidedAddon>;
+	isDone?: boolean;
+};
+
+export type Discount = {
+	promoCodeId?: string;
+	promoCode?: string;
+	validFrom?: TimestampType;
+	validTo?: TimestampType;
+	createdAt?: TimestampType;
+	allowedOnce?: boolean;
+	createdByProvider?: boolean;
+	providerUid?: string;
+	usedBy?: string[];
+	amount?: number;
+	isPercentage?: boolean;
+	maxAmount?: number;
+	isAutoApplied?: boolean;
+	servicesIds?: string[];
+	addonsIds?: string[];
+};
+
+export type OrderReview = {
+	ratingId: string;
+	ratingNote: string;
+	orderId: string;
+	orderDate: TimestampType;
+	createdDate: TimestampType;
+	providerId: string;
+	arrivalDate: string;
+	finishDate: string;
+	rating: number;
+	clientId: string;
+};

package/index.ts

@@ -0,0 +1,2 @@
+export * from './constants/types'
+export * from './ts/calcs'

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "sahab-utils",
+  "version": "1.0.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"
+  }
+}

package/ts/calcs.ts

@@ -0,0 +1,195 @@
+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;
+}
+
+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 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;
+}
+
+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;
+}

package/ts/utils.ts

@@ -0,0 +1,6 @@
+export function preventNaN(x?: number | string) {
+    if (x === undefined || x === null || isNaN(x as any)) {
+        return 0;
+    }
+    return Number(x);
+}