sahab-utils 1.2.6 → 1.2.9

package/dist/constants/types.d.ts

@@ -0,0 +1,659 @@
+import { DocumentReference, GeoPoint, Timestamp } from 'firebase/firestore';
+export type GeoPointType = GeoPoint;
+export type TimestampType = Timestamp;
+export type DistenceDueration = {
+    distance: string;
+    duration: string;
+};
+export declare enum CarSize {
+    X_SMALL = 0,
+    SMALL = 1,
+    MEDIUM = 2,
+    LARGE = 3,
+    X_LARGE = 4
+}
+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 declare enum OrderStatus {
+    PENDING = 0,// 0
+    CONFIRMED = 1,// 1
+    REJECTED = 2,// 2
+    EXPIRED = 3,// 3
+    IN_PROGRESS = 4,// 4
+    COMPLETED = 5,// 5
+    CANCELLED = 6,// 6
+    RATED = 7,// 7
+    STARTED = 8
+}
+export declare enum OrderPaymentType {
+    APPLE_PAY = 0,
+    CREDIT = 1,
+    CASH = 2,
+    GOOGLE_PAY = 3,
+    SAMSUNG_PAY = 4,
+    STC_PAY = 5,
+    TABBY = 6,
+    TAMARA = 7
+}
+export type Location = {
+    geohash?: string;
+    northeast: GeoPointType;
+    southwest: GeoPointType;
+};
+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;
+    isPaid?: boolean;
+    rejectedBy?: string[];
+    finishDate?: TimestampType;
+    arrivalDate?: TimestampType;
+    canceledDate?: TimestampType;
+    paymentAmount?: number;
+    sahabPercentage?: number;
+    sahabClientPercentage?: number;
+    sahabOnlinePercentage?: number;
+    sahabProviderPercentage?: number;
+    sahabExtraPaymentAmount?: number;
+    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' | 'TAP';
+};
+export type ReduxOrder = {
+    orderId?: string;
+    clientId?: string;
+    client?: Client;
+    servedByPath?: string;
+    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;
+    isPaid?: boolean;
+    rejectedBy?: string[];
+    finishDate?: TimestampType;
+    arrivalDate?: TimestampType;
+    paymentAmount?: number;
+    sahabPercentage?: number;
+    sahabClientPercentage?: number;
+    sahabOnlinePercentage?: number;
+    sahabProviderPercentage?: number;
+    sahabExtraPaymentAmount?: number;
+    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 declare enum MovementType {
+    CLIENT_ORDER_PAYMENT = 0,
+    CLIENT_BALANCE_TOP_UP = 1,
+    PROVIDER_NEGATIVE_BALANCE_PAYMENT = 2,
+    PROVIDER_POSITIVE_BALANCE_PAYMENT = 3,
+    ORDER_REFUND = 4,
+    SAHAB_PAYMENT_TO_PROVIDER = 5,
+    SAHAB_RECEIVE_FROM_PROVIDER = 6,
+    USING_BALANCE = 7
+}
+export declare enum ComplaintType {
+    BUG = 0,
+    COMPLAINT = 1
+}
+export declare enum ComplaintStatus {
+    PENDING = 0,
+    IN_REVIEW = 1,
+    RESOLVED = 2
+}
+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 declare enum ReviewStatus {
+    PENDING = 0,
+    IN_REVIEW = 1,
+    ACCEPTED = 2,
+    DECLINED = 3
+}
+export declare enum RegistrationSection {
+    OWNER_NAME = 0,
+    CITY = 1,
+    RULES = 2,
+    BUSINESS_INFO = 3,
+    DRIVERS_INFO = 4,
+    VEHICLE_PERMIT = 5,
+    VEHICLE_REGISTRATION = 6,
+    SERVICES = 7,
+    ADDONS = 8,
+    WORKING_HOURS = 9,
+    OVERVIEW = 10,
+    STATUS = 11,
+    DONE = 12
+}
+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;
+    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;
+    isAcceptingOrders?: boolean;
+    ordersPercentage?: number;
+    integrations?: {
+        email?: string;
+        isActive?: boolean;
+        key: string;
+        /** Tap (and other gateways): server-side API secret */
+        secretKey?: string;
+        /** Tap Connect marketplace payout destination id (sub-merchant) */
+        tapDestinationId?: 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[];
+    clientIds?: string[];
+    createrEmail?: string;
+    sahabPercentage?: number;
+    providerPercentage?: number;
+};
+export type OrderReview = {
+    ratingId: string;
+    ratingNote: string;
+    orderId: string;
+    orderDate: TimestampType;
+    createdDate: TimestampType;
+    providerId: string;
+    arrivalDate: string;
+    finishDate: string;
+    rating: number;
+    clientId: string;
+};
+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;
+    paymentGateway?: 'PAYLINK' | 'CHECKOUT' | 'TAP';
+    /** Mirrors Order economics for server-side Tap split; optional override of client fee % */
+    sahabClientPercentage?: number;
+};
+export type WeatherData = {
+    date: string;
+    precipitationProbability: number;
+    rainAccumulation: number;
+    cloudCover: number;
+    humidity: number;
+    windSpeed: number;
+    uvIndex: number;
+};
+export type PaymentConfigs = {
+    isCashAllowed: boolean;
+    isGooglePayAllowed?: boolean;
+    /** Tap GoSell merchant id for card / Apple Pay SDK config (optional; falls back in app). */
+    tapMerchantId?: string;
+    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;
+};