sahab-utils 1.2.7 → 1.2.9

package/constants/types.ts

@@ -1,776 +0,0 @@
-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 ClientLocation = {
-	locationId: string;
-	name: string;
-	latitude: number;
-	longitude: number;
-	isPrimary?: boolean;
-};
-
-export type Client = {
-	uid: string;
-	phoneNumber: string;
-	firstName?: string;
-	lastName?: string;
-	email?: string;
-	balance?: number;
-	rating?: number;
-	imageUrl?: string;
-	isTest?: boolean;
-	isEmailVerified?: boolean;
-	language?: string;
-	checkoutCustomerId?: string;
-	latitude?: number;
-	longitude?: number;
-	joinDate?: Date;
-	locations?: ClientLocation[];
-	version?: 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,
-	GOOGLE_PAY,
-	SAMSUNG_PAY,
-	STC_PAY,
-	TABBY,
-	TAMARA,
-}
-
-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
-	sahabExtraPaymentAmount?: number; // for cash payments
-	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;
-	isAddonStructure?: boolean;
-	isMonthlyPackage?: boolean;
-	isPaymentSettled?: boolean;
-	notificationTaskId?: string;
-	providerName?: {
-		ar: string;
-		en: string;
-	};
-	providerPhoneNumber?: string;
-	providerLogoUrl?: string;
-	paymentGateway?: 'PAYLINK' | 'CHECKOUT';
-};
-
-// ! 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
-	sahabExtraPaymentAmount?: number; // for cash payments
-	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;
-	isAddonStructure?: boolean;
-	isMonthlyPackage?: boolean;
-	isPaymentSettled?: boolean;
-	notificationTaskId?: string;
-	providerName?: {
-		ar: string;
-		en: string;
-	};
-	providerPhoneNumber?: string;
-	providerLogoUrl?: string;
-};
-
-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;
-	discount?: 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;
-	discount?: 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;
-	ordersPercentage?: number; // percentage
-	integrations?: { email?: string; isActive?: boolean; key: string }[];
-};
-
-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;
-};
-
-// Country Codes Type
-export type CountryCode = {
-	code: string;
-	dial_code: string;
-	flag: string;
-	name_en: string;
-	name_ar: string;
-};
-
-export type LocationInfo = {
-	city?: string;
-	country?: string;
-	postalCode?: string;
-	line1: string;
-	line2?: string;
-	long_name?: string;
-	latitude?: number;
-	longitude?: number;
-};
-
-export type SavedLocation = {
-	locationId: string;
-	name: string;
-	latitude: number;
-	longitude: number;
-	isPrimary?: boolean;
-};
-
-export type CheckoutCard = {
-	id?: string;
-	type?: string;
-	fingerprint?: string;
-	expiry_month?: string;
-	expiry_year?: string;
-	scheme?: string;
-	scheme_local?: string;
-	last4?: string;
-	bin?: string;
-	card_type?: string;
-	card_category?: string;
-	issuer?: string;
-	issuer_country?: string;
-	product_type?: string;
-};
-
-export type CheckoutToken = {
-	type?: string;
-	token?: string;
-	expires_on?: string;
-	expiry_month?: number;
-	expiry_year?: number;
-	scheme?: string;
-	scheme_local?: string;
-	last4?: string;
-	bin?: string;
-	card_type?: string;
-	card_category?: string;
-	issuer?: string;
-	issuer_country?: string;
-	product_id: string;
-	product_type: string;
-	billing_address?: {
-		address_line1?: string;
-		address_line2: string;
-		city?: string;
-		state?: string;
-		zip?: string;
-		country?: string;
-	};
-	phone?: {
-		country_code?: string;
-		number?: string;
-	};
-	name?: string;
-};
-
-export type SPECIFIED_TIME = 'anytime' | number;
-
-export type PlaceOrder = {
-	clientID: string;
-	providerId: string;
-	orderMilllSec: number;
-	orderNanoSec: number;
-	services: CarService[];
-	lat: number;
-	long: number;
-	willClientBeThere: boolean;
-	paymentType: OrderPaymentType;
-	isPaid: boolean;
-	paymentId: string;
-	isProviderTest: boolean;
-	providerReceiveOrders: boolean;
-	orderNote: string;
-	promoCode: Discount;
-	driverIds: string[];
-	providerName: {
-		ar: string;
-		en: string;
-	};
-	paymentAmount: number;
-	usedBalance: number;
-	providerPhoneNumber: string;
-	isAddonStructure: boolean;
-	isMonthlyPackage: boolean;
-	sahabExtraPaymentAmount: number;
-	orderId?: string;
-};
-
-export type WeatherData = {
-	date: string;
-	precipitationProbability: number; // in %
-	rainAccumulation: number; // in mm
-	cloudCover: number; // in %
-	humidity: number; // in %
-	windSpeed: number; // in km/h
-	uvIndex: number; // scale from 0-11+
-};
-
-export type PaymentConfigs = {
-	isCashAllowed: boolean;
-	isGooglePayAllowed?: boolean;
-	paymentGateways: {
-		key: string;
-		isActive: boolean;
-		priority: number;
-	}[];
-};
-
-export type Slot = {
-	id: string;
-	time: number;
-	selected: boolean;
-	reserved: boolean;
-};
-
-export type Statement = {
-	numberOfOrders: number;
-	completedOrders: number;
-	ratedOrders: number;
-	cancelledOrders: number;
-	cashOrders: number;
-	creditOrders: number;
-	applePayPayments: number;
-	expiredOrders: number;
-	confirmedOrders: number;
-	lateOrders: number;
-	ordersTotal: number;
-	orders: Order[];
-	statmentDate?: Date | string;
-};