turf-common 1.3.1-beta.9 → 1.3.1

package/build/src/models/booking-code-model.d.ts

@@ -0,0 +1,139 @@
+import { TimeSlot } from "./time-slot-model";
+import { IGetBookingCodesPerThirtyMinutes } from "../interface/get-booking-codes-per-thirty-min.interface";
+import { IFormateDateAndTime } from "../interface/formate-date-and-time.interface";
+import { IDateFormatter } from "../interface/date-formatter.interface";
+import { ITimeFormatter } from "../interface/time-formatter.interface";
+export declare class BookingCode {
+    code: string;
+    turfId: string;
+    pitchCode: string;
+    slot: string;
+    fromTimeCode: string;
+    toTimeCode: string;
+    dateCode: string;
+    cost: string;
+    pitchNumber: number;
+    constructor(code: string, cost?: string);
+    parse(): BookingCode;
+    getBookingTimeInMinutes(): number;
+    getPitchNo(): number;
+    getHalfHourTimeCodes(): string[];
+    /**
+     *
+     * @returns {Array<string>} - List of half hour time slot codes between start time & end time inclusive
+     * @example fromTime: 0000; toTime: 0130
+     * // returns ['00000030','00300100','01000130']
+     */
+    getHalfHourTimeRangeCodes(): string[];
+    getValidDate(): Date;
+    getDateCode(): string;
+    getWeekday(): number;
+    getMonthCode(): string;
+    getDateWithFromTimeCode(): string;
+    getCodeWithoutTurfCode(): string;
+    static sortByCode(bookingCodes: BookingCode[]): void;
+    static getOneSlotBookingCode(turfId: string, bookingDate: string, fhfm: string, thtm: string, pitchCode: string): string;
+    static getDiscountedCost(couponCode: string, totalCost: number, validationApply?: boolean, totalBookingHours?: number): number;
+    static getDiscountAmount(couponCode: string, totalCost: number): number;
+    static isValidDate(date: string): boolean;
+    static parseDateCode(dateCode: string): Date;
+    static getWeekday(dateCode: number): number;
+    static convertToDate(str: string): Date;
+    static previousDateChecker(fromDate: number, index: number, errorKey?: string): void;
+    static previousTimeChecker(fromTime: string, fromDate: number, index: number): void;
+    static getDateCodesByWeek(fromDate: number, toDate: number, selectedWeekday: number): string[];
+    static getDatesByWeek(fromDate: number, toDate: number, selectedWeekday: number): Date[];
+    static isValidTimeRange(timeSlot: string): boolean;
+    static dateFormat(dates: Array<Date>): Array<string>;
+    static getDateCode(date: Date): string;
+    /**
+     * Returns list of month codes (YYMM) in the Date range inclusive
+     * @param {Date} from - Start Date
+     * @param {Date} to - End Date
+     * @return {Array<Number>} - The array of month codes (YYMM)
+     */
+    static getMonthCodesRange(from: Date, to: Date): number[];
+    static getNMonthCodes(n: number): number[];
+    static getCodes(fromDate: number, toDate: number, weekday: number, turfId: number, from: string, to: string): string[];
+    static getNextDayDateCode(dateCode: number): number;
+    getUtcDateWithTime(dateCodeWithTime: string): Date;
+    static getUtcDateWithTime(dateCodeWithTime: string): Date;
+    getNoOfHoursDifference(): number;
+    static getBookingCodesPerThirtyMinutes(from: string, to: string, bookingDate: string): IGetBookingCodesPerThirtyMinutes[];
+    static getCostPerThirtyMinutes(bookingCodePerThirtyMinutesPerSlot: {
+        slotCodePerThirtyMinute: string;
+        bookingDate: string;
+    }[], pricePerThirtyMinutesData: {
+        [date: string]: {
+            [time: string]: number;
+        };
+    }): string;
+    static padBookingCode(bookingCodeWithoutTurfCode: string): string;
+    static getInstance(turfId: number, bookingCodeWithoutTurfCode: string): BookingCode;
+    /**
+     * Extracts the numeric part of a bookingCode, excluding a predefined deleted slot separator.
+     *
+     * @param {string} bookingCode - The input bookingCode to extract from.
+     * @returns {string} The numeric part of the bookingCode.
+     */
+    static extractBookingCodeByDeletedSlotSeparator: (bookingCode: string) => string;
+    getCost(): number;
+    getTimeslot(): TimeSlot;
+    static getIndianTimeZoneDate(bookingBufferOffsetHour?: number): Date;
+    getInstanceByPitchNo(newPitchNo: number): BookingCode;
+    getDateFromTimeCode(): number;
+    getPreviousBookingSlotCode(): string;
+    getPreviousBookingCode(): BookingCode;
+    getPreviousTimeSlotCode(isHour?: boolean): string;
+    getNextBookingSlotCode(): string;
+    getNextTimeSlotCode(isHour?: boolean): string;
+    getNextBookingCode(): BookingCode;
+    getOffsetTimeSlotCode(timeCode: string, isHour?: boolean, isNext?: boolean): string;
+    isInPast(): boolean;
+    formatDateAndTime(formateDateAndTime: IFormateDateAndTime): string;
+    static timeFormatter(timeFormatter: ITimeFormatter): string;
+    static dateFormatter(dateFormatter: IDateFormatter): string;
+    /**
+     * Calculates the total time difference between two date codes.
+     * @param unit - Optional. Specifies the unit of time for the result. Valid values are "minute" or "hr". Defaults to "minute" if not provided.
+     * @returns The total time difference in the specified unit (minutes or hours) between the "from" and "to" date codes.
+     */
+    getTotalTime(unit?: "minute" | "hr"): number;
+    /**
+     * Gets the date codes across a time range.
+     *
+     * @returns An object containing the date codes for the from and to time.
+     * @description
+     * The `fromDateCode` is generated by combining the current instance's `dateCode` and `fromTimeCode`.
+     * The `toDateCode` is generated based on the `fromTimeCode` and `toTimeCode`. If `fromTimeCode` is greater
+     * than `toTimeCode`, it adds one day to the current instance's `dateCode`.
+     */
+    getAcrossDateCodes(): {
+        fromDateCode: string;
+        toDateCode: string;
+    };
+    static getTotalTimeByBookingCodes(bookingCodes: BookingCode[]): number;
+    /**
+     * Retrieves booking codes for a booking scenario that may span across different days.
+     * If the booking spans multiple days, two codes are generated for each day; otherwise, a single code is used.
+     *
+     * @returns {string[]} An array containing the booking codes.
+     */
+    getBookingCodesByAcrossDateBookingCode(): string[];
+    /**
+     * Converts booking codes obtained using `getBookingCodesByAcrossDateBookingCode` into an array of BookingCode models.
+     *
+     * @returns {BookingCode[]} An array containing BookingCode models.
+     */
+    getBookingCodeModelsByAcrossDateBookingCode(): BookingCode[];
+    /**
+     * @param {BookingCode} nextBookingCode - The booking code to check for adjacency.
+     * @returns {boolean} True if the codes are adjacent, false otherwise.
+     *
+     * @description
+     * Two booking codes are considered adjacent if the current booking code ends at the end of the day (`2400`)
+     * and the next booking code starts at the beginning of the day (`0000`) on the following day.
+     * Additionally, the pitch number and turf ID must match between the two codes.
+     */
+    isAdjacentBookingCode(nextBookingCode: BookingCode): boolean;
+}