@perdieminc/time-slots 0.0.1 → 0.0.3

package/src/types/get-schedules.d.ts

@@ -1,122 +0,0 @@
-import type { PrepTimeCadence } from "../constants";
-
-export interface GetCateringPrepTimeParams {
-	items: CartItem[];
-	prepTimeCadence?: PrepTimeCadence;
-	prepTimeFrequency?: number;
-	timezone?: string;
-}
-
-import type {
-	BusinessHoursOverrideInput,
-	BusinessHoursOverrideOutput,
-} from "./business-hours";
-import type { BusyTimeItem } from "./common";
-import type { FulfillmentPreference, LocationLike } from "./location";
-import type { FulfillmentSchedule, Platform } from "./schedule";
-
-// ── High-level input objects ────────────────────────────────────────────────
-
-export interface PreSaleConfig {
-	active: boolean;
-	due_start_date?: string | Date;
-	due_end_date?: string | Date;
-	use_store_hours_due?: boolean;
-	due_start_time?: string | null;
-	due_end_time?: string | null;
-}
-
-export interface WeeklyPreSaleConfig {
-	active: boolean;
-	pickup_days: number[];
-	ordering_days: number[];
-}
-
-export interface StoreConfig {
-	isAsapOrders: boolean;
-	isSameDayOrders: boolean;
-	max_future_order_days?: number;
-	businessHoursOverrides: BusinessHoursOverrideInput[];
-	preSaleConfig?: PreSaleConfig;
-	weeklyPreSaleConfig?: WeeklyPreSaleConfig;
-}
-export type CateringServiceType = {
-	min_quantity: number;
-	max_quantity: number;
-	serve_count: number;
-	prep_time: {
-		cadence: PrepTimeCadence;
-		frequency: number;
-	};
-};
-export interface CartItem {
-	preSale?: boolean;
-	weeklyPreSale?: boolean;
-	internalCategoryId?: string;
-	cateringService?: CateringServiceType;
-}
-export interface CateringPrepTimeResult {
-	prepTimeCadence: PrepTimeCadence;
-	prepTimeFrequency: number;
-	/** Only set when prepTimeCadence is not DAY (e.g. HOUR). */
-	weekDayPrepTimes?: Record<number, number>;
-}
-
-export interface PrepTimeSettings {
-	prepTimeInMinutes: number;
-	weekDayPrepTimes: Record<number, number>;
-	gapInMinutes: number;
-	busyTimes: Record<string, BusyTimeItem[]>;
-	prepTimeFrequency: number;
-	prepTimeCadence: PrepTimeCadence;
-	/** When fulfillment is DELIVERY, added to each weekday prep time so slots reflect when order is received. */
-	estimatedDeliveryMinutes?: number;
-}
-
-// ── getSchedules params / result ────────────────────────────────────────────
-
-export interface GetSchedulesParams {
-	store: StoreConfig;
-	locations: LocationLike[];
-	cartItems: CartItem[];
-	fulfillmentPreference: FulfillmentPreference;
-	prepTimeSettings: PrepTimeSettings;
-	currentLocation: LocationLike;
-	isCateringFlow?: boolean;
-	/** Platform for timezone handling in next-available-date logic. Default "web". */
-	platform?: Platform;
-}
-
-export interface GetSchedulesResult {
-	schedule: FulfillmentSchedule;
-	isWeeklyPreSaleAvailable: boolean;
-}
-
-// ── Legacy flat params (kept for backward-compat if needed) ─────────────────
-
-export interface InitScheduleParams {
-	isAsapOrders: boolean;
-	isSameDayOrders: boolean;
-	preSalePickupDays: number[];
-	isWeeklyPreSaleActive: boolean;
-	preSaleOrderingDays: number[];
-	locations: LocationLike[];
-	daysCount?: number;
-	fulfillmentPreference: FulfillmentPreference;
-	prepTimeInMinutes: number;
-	weekDayPrepTimes: Record<number, number>;
-	hasCartWeeklyPreSaleItem: boolean;
-	busyTimes: BusyTimeItem[];
-	cartCategoryIds: string[];
-	gapInMinutes: number;
-	businessHoursOverrides: Record<string, BusinessHoursOverrideOutput[]>;
-	currentLocation: LocationLike;
-}
-
-export interface InitScheduleResult {
-	businessHoursOverrides: Record<string, BusinessHoursOverrideOutput[]>;
-	locationId: string;
-	fulfillmentPreference: FulfillmentPreference;
-	schedule: FulfillmentSchedule;
-	isWeeklyPreSaleAvailable: boolean;
-}

package/src/types/index.ts

@@ -1,34 +0,0 @@
-export type {
-	BusinessHour,
-	BusinessHourInput,
-	BusinessHoursOverrideInput,
-	BusinessHoursOverrideOutput,
-} from "./business-hours";
-export type { BusyTimeItem } from "./common";
-export type {
-	CartItem,
-	CateringPrepTimeResult,
-	GetCateringPrepTimeParams,
-	GetSchedulesParams,
-	GetSchedulesResult,
-	InitScheduleParams,
-	InitScheduleResult,
-	PrepTimeSettings,
-	PreSaleConfig,
-	StoreConfig,
-	WeeklyPreSaleConfig,
-} from "./get-schedules";
-export type { FulfillmentPreference, LocationLike } from "./location";
-export type {
-	DaySchedule,
-	FulfillmentSchedule,
-	GenerateLocationFulfillmentScheduleParams,
-	GenerateScheduleParams,
-	GetNextAvailableDatesParams,
-	GetOpeningClosingTimeOnDateParams,
-	Platform,
-} from "./schedule";
-export type {
-	FilterBusyTimesFromScheduleParams,
-	MenuType,
-} from "./schedule-filter";

package/src/types/location.d.ts

@@ -1,25 +0,0 @@
-import type { BusinessHourInput } from "./business-hours";
-
-export type FulfillmentPreference = "PICKUP" | "DELIVERY" | "CURBSIDE";
-export type BusinessHourType = {
-	day: number;
-	start_time: string;
-	end_time: string;
-};
-export interface LocationLike {
-	location_id: string;
-	id?: string;
-	timezone: string;
-	pickup_hours?: BusinessHourInput[];
-	delivery_hours?: BusinessHourInput[];
-	curbside_hours?: {
-		use_pickup_hours?: boolean;
-		times?: BusinessHourInput[];
-	};
-	catering?: {
-		enabled: boolean | string;
-		pickup: Omit<BusinessHourType, "day">;
-		delivery: Omit<BusinessHourType, "day">;
-	};
-	[key: string]: unknown;
-}

package/src/types/schedule-filter.d.ts

@@ -1,27 +0,0 @@
-import type { BusyTimeItem } from "./common";
-import type { FulfillmentSchedule } from "./schedule";
-export type MenuTimeSlot = {
-	all_day: boolean;
-	end_time: string | null;
-	start_time: string | null;
-};
-
-export type MenuType = {
-	menu_id: string;
-	store_id: string;
-	location_id: string | null;
-	all_locations: boolean;
-	display_name: string;
-	description: string | null;
-	times: Record<string, MenuTimeSlot>;
-	category_ids: string[];
-	last_modified_by: string;
-	created_at: string;
-	updated_at: string;
-};
-
-export interface FilterBusyTimesFromScheduleParams {
-	schedule: FulfillmentSchedule;
-	busyTimes?: BusyTimeItem[];
-	cartCategoryIds?: string[];
-}

package/src/types/schedule.d.ts

@@ -1,83 +0,0 @@
-import type { PLATFORM } from "../constants";
-import type {
-	BusinessHour,
-	BusinessHoursOverrideOutput,
-} from "./business-hours";
-import type { FulfillmentPreference, LocationLike } from "./location";
-
-export interface DaySchedule {
-	date: Date;
-	originalStoreOpeningTime: Date | null;
-	originalStoreClosingTime: Date | null;
-	remainingShifts: number;
-	openingTime: Date;
-	closingTime: Date;
-	firstAvailableSlot: Date;
-	slots: Date[];
-	[key: string]: unknown;
-}
-
-export type FulfillmentSchedule = DaySchedule[];
-
-export interface GenerateScheduleParams {
-	currentDate?: Date;
-	prepTimeBehaviour?: number;
-	prepTimeInMinutes?: number;
-	weekDayPrepTimes?: Record<number, number>;
-	timeZone: string;
-	dates?: Date[];
-	businessHours?: BusinessHour[];
-	businessHoursOverrides?: BusinessHoursOverrideOutput[];
-	preSaleHoursOverride?: Array<{
-		startTime: string;
-		endTime: string;
-		month?: number;
-		day?: number;
-	}> | null;
-	gapInMinutes?: number;
-	prepTimeCadence?: PrepTimeCadence;
-}
-export type Platform = (typeof PLATFORM)[keyof typeof PLATFORM];
-export interface GetNextAvailableDatesParams {
-	startDate: Date;
-	timeZone: string;
-	businessHours: BusinessHour[];
-	businessHoursOverrides?: BusinessHoursOverrideOutput[];
-	datesCount?: number;
-	preSaleDates?: number[];
-	presalePickupWeekDays?: number[];
-	endDate?: Date | null;
-	isDaysCadence?: boolean;
-	/** Platform for timezone handling. Web uses @date-fns/tz; ios/android use timezone-support. Default "web". */
-	platform?: Platform;
-}
-
-export interface GenerateLocationFulfillmentScheduleParams {
-	startDate: Date;
-	prepTimeFrequency?: number;
-	prepTimeCadence?: PrepTimeCadence;
-	weekDayPrepTimes?: Record<number, number>;
-	location: LocationLike;
-	fulfillmentPreference: FulfillmentPreference;
-	/** Overrides for this location only (not keyed by location_id). */
-	businessHoursOverrides?: BusinessHoursOverrideOutput[];
-	preSaleHoursOverride?: Array<{
-		startTime: string;
-		endTime: string;
-		month?: number;
-		day?: number;
-	}> | null;
-	gapInMinutes?: number;
-	daysCount?: number;
-	preSaleDates?: number[];
-	presalePickupWeekDays?: number[];
-	endDate?: Date | null;
-	platform?: Platform;
-}
-
-export interface GetOpeningClosingTimeOnDateParams {
-	date?: Date;
-	businessHours?: BusinessHour[];
-	businessHoursOverrides?: BusinessHoursOverrideOutput[];
-	timeZone: string;
-}

package/src/types/timezone-support.d.ts

@@ -1,31 +0,0 @@
-declare module "timezone-support" {
-	export function findTimeZone(timezone: string): string;
-	export function getUnixTime(time: {
-		zone: string;
-		year: number;
-		month: number;
-		day: number;
-		hours: number | string;
-		minutes: number | string;
-		seconds: number | string;
-		milliseconds: number | string;
-	}): number;
-	export function getZonedTime(
-		date: Date | number,
-		timezone: string,
-	): {
-		zone: string;
-		year: number;
-		month: number;
-		day: number;
-		hours: number | string;
-		minutes: number | string;
-		seconds: number | string;
-		milliseconds: number | string;
-		dayOfWeek: number;
-	};
-	export function toZonedTime(
-		date: Date | number | string,
-		timezone: string,
-	): Date;
-}

package/src/utils/business-hours.ts

@@ -1,120 +0,0 @@
-import { FULFILLMENT_TYPES } from "../constants";
-import type {
-	BusinessHour,
-	BusinessHoursOverrideInput,
-	BusinessHoursOverrideOutput,
-	FulfillmentPreference,
-	LocationLike,
-} from "../types";
-
-export function toBusinessHoursOverride(
-	businessHoursOverride: BusinessHoursOverrideInput,
-): BusinessHoursOverrideOutput {
-	const {
-		month,
-		day,
-		start_time: startTime,
-		end_time: endTime,
-		is_open: isOpen,
-	} = businessHoursOverride;
-
-	return {
-		month,
-		day,
-		startTime: isOpen ? startTime : null,
-		endTime: isOpen ? endTime : null,
-	};
-}
-
-export function getLocationsBusinessHoursOverrides(
-	businessHoursOverrides: BusinessHoursOverrideInput[],
-	locations: LocationLike[],
-): Record<string, BusinessHoursOverrideOutput[]> {
-	const result: Record<string, BusinessHoursOverrideOutput[]> = {};
-
-	for (const override of businessHoursOverrides) {
-		const { all_locations: allLocations, location_ids: locationIds } =
-			override || {};
-
-		if (allLocations === true) {
-			for (const location of locations || []) {
-				const id = location.location_id;
-				result[id] ??= [];
-				result[id].push(toBusinessHoursOverride(override));
-			}
-		} else {
-			for (const id of locationIds || []) {
-				const location = locations.find((loc) => loc.location_id === id);
-				if (location) {
-					result[id] ??= [];
-					result[id].push(toBusinessHoursOverride(override));
-				}
-			}
-		}
-	}
-
-	return result;
-}
-
-export const isLocationCateringEnabled = (
-	location: LocationLike | undefined,
-): boolean => {
-	if (!location) return false;
-	return (
-		!!location?.catering?.enabled && location?.catering?.enabled !== "false"
-	);
-};
-
-export function getLocationBusinessHoursForFulfillment(
-	location: LocationLike,
-	fulfillmentPreference: FulfillmentPreference,
-	isCatering = false,
-): BusinessHour[] {
-	const fulfillmentBusinessHours: Record<
-		string,
-		Array<{ day: number; start_time: string; end_time: string }> | undefined
-	> = {
-		[FULFILLMENT_TYPES.PICKUP]: location?.pickup_hours,
-		[FULFILLMENT_TYPES.DELIVERY]: location?.delivery_hours,
-		[FULFILLMENT_TYPES.CURBSIDE]: location?.curbside_hours?.use_pickup_hours
-			? location?.pickup_hours
-			: location?.curbside_hours?.times,
-	};
-
-	const cateringBusinessTimings: Partial<
-		Record<FulfillmentPreference, { start_time: string; end_time: string }>
-	> = {
-		[FULFILLMENT_TYPES.PICKUP]: location?.catering?.pickup,
-		[FULFILLMENT_TYPES.DELIVERY]: location?.catering?.delivery,
-	};
-
-	const businessHours = fulfillmentBusinessHours[fulfillmentPreference];
-
-	const cateringBusinessTiming =
-		isCatering && isLocationCateringEnabled(location)
-			? cateringBusinessTimings[fulfillmentPreference]
-			: null;
-
-	if (isCatering && !cateringBusinessTiming) {
-		//if catering is enabled but no business hours are set, return empty arrayif
-		return [];
-	}
-
-	return (
-		businessHours?.map((businessHour) => {
-			if (isCatering && cateringBusinessTiming) {
-				//if catering is enabled and catering business hours are set, return catering business hours
-				return {
-					day: businessHour.day,
-					startTime: cateringBusinessTiming.start_time,
-					endTime: cateringBusinessTiming.end_time,
-				};
-			}
-			return {
-				day: businessHour.day,
-				startTime: businessHour.start_time,
-				endTime: businessHour.end_time,
-			};
-		}) ?? []
-	);
-}

package/src/utils/catering.ts

@@ -1,85 +0,0 @@
-import { findTimeZone, getZonedTime } from "timezone-support";
-import { DEFAULT_TIMEZONE, PREP_TIME_CADENCE } from "../constants";
-import type {
-	CateringPrepTimeResult,
-	GetCateringPrepTimeParams,
-} from "../types";
-
-function buildCateringPrepTimeResult(
-	prepTimeCadence: CateringPrepTimeResult["prepTimeCadence"],
-	prepTimeFrequency: number,
-	timezone: string = DEFAULT_TIMEZONE,
-): CateringPrepTimeResult {
-	const result: CateringPrepTimeResult = {
-		prepTimeCadence,
-		prepTimeFrequency,
-	};
-	if (prepTimeCadence === PREP_TIME_CADENCE.DAY) {
-		result.weekDayPrepTimes = {};
-	} else {
-		result.weekDayPrepTimes = {
-			[getZonedTime(new Date(), findTimeZone(timezone)).dayOfWeek]:
-				prepTimeCadence === PREP_TIME_CADENCE.HOUR
-					? prepTimeFrequency * 60
-					: prepTimeFrequency,
-		};
-	}
-	return result;
-}
-
-/**
- * Derives prep time config (cadence, frequency, weekDayPrepTimes) from cart items for catering flow.
- * DAY cadence has priority; if any item uses days, returns max day frequency.
- * Otherwise returns HOUR cadence with max hour frequency across items.
- * When items are empty or have no catering prep time, falls back to params (e.g. from prepTimeSettings).
- */
-export function getCateringPrepTimeConfig(
-	params: GetCateringPrepTimeParams,
-): CateringPrepTimeResult {
-	const { items, timezone = DEFAULT_TIMEZONE } = params;
-
-	if (items.length === 0) {
-		return buildCateringPrepTimeResult(
-			params.prepTimeCadence ?? PREP_TIME_CADENCE.HOUR,
-			params.prepTimeFrequency ?? 1,
-			timezone,
-		);
-	}
-
-	const dayFrequencies: number[] = [];
-	const hourFrequencies: number[] = [];
-
-	for (const item of items) {
-		const cadence = item.cateringService?.prep_time?.cadence;
-		const frequency = item.cateringService?.prep_time?.frequency;
-		if (cadence == null || frequency == null) continue;
-
-		if (cadence === PREP_TIME_CADENCE.DAY) {
-			dayFrequencies.push(frequency);
-		} else if (cadence === PREP_TIME_CADENCE.HOUR) {
-			hourFrequencies.push(frequency);
-		}
-	}
-
-	if (dayFrequencies.length > 0) {
-		return buildCateringPrepTimeResult(
-			PREP_TIME_CADENCE.DAY,
-			Math.max(...dayFrequencies),
-			timezone,
-		);
-	}
-
-	if (hourFrequencies.length > 0) {
-		return buildCateringPrepTimeResult(
-			PREP_TIME_CADENCE.HOUR,
-			Math.max(...hourFrequencies),
-			timezone,
-		);
-	}
-
-	return buildCateringPrepTimeResult(
-		params.prepTimeCadence ?? PREP_TIME_CADENCE.HOUR,
-		params.prepTimeFrequency ?? 1,
-		timezone,
-	);
-}

package/src/utils/date.ts

@@ -1,163 +0,0 @@
-import { addDays, compareAsc } from "date-fns";
-import { findTimeZone, getUnixTime, getZonedTime } from "timezone-support";
-
-import type { BusinessHour } from "../types";
-
-export function setHmOnDate(date: Date, hm: string, timeZone: string): Date {
-	const [hours, minutes] = String(hm).split(":");
-
-	const zonedTime = getZonedTime(new Date(date), findTimeZone(timeZone));
-
-	return new Date(
-		getUnixTime({
-			zone: zonedTime.zone,
-			year: zonedTime.year,
-			month: zonedTime.month,
-			day: zonedTime.day,
-			hours: hours === "24" ? 23 : Number(hours),
-			minutes: hours === "24" ? 59 : Number(minutes),
-			seconds: 0,
-			milliseconds: 0,
-		}),
-	);
-}
-
-export function getNextDateForDayOfWeek(
-	targetDayIndex: number,
-	referenceDate: Date = new Date(),
-): Date {
-	const currentDayIndex = referenceDate.getDay();
-	const daysUntilTarget = (targetDayIndex - currentDayIndex + 7) % 7;
-	return addDays(referenceDate, daysUntilTarget);
-}
-
-export function getPreSalePickupDates(
-	preSalePickupDays: number[] = [],
-	preSaleOrderingDays: number[] = [],
-): Date[] {
-	const today = new Date();
-	const currentDayIndex = today.getDay();
-
-	if (preSalePickupDays.includes(currentDayIndex)) {
-		return [];
-	}
-
-	if (!preSaleOrderingDays.includes(currentDayIndex)) {
-		return [];
-	}
-
-	return preSalePickupDays
-		.map((day) => getNextDateForDayOfWeek(day))
-		.sort(compareAsc);
-}
-
-export function overrideTimeZoneOnUTC(
-	date: Date | string,
-	timeZoneB: string,
-): Date {
-	const timeZoneATime = getZonedTime(new Date(date), findTimeZone("UTC"));
-	const timeZoneBTime = getZonedTime(new Date(date), findTimeZone(timeZoneB));
-
-	return new Date(
-		getUnixTime({
-			...timeZoneATime,
-			zone: timeZoneBTime.zone,
-		}),
-	);
-}
-
-export function isTodayInTimeZone(date: Date, timeZone: string): boolean {
-	if (!date) {
-		return false;
-	}
-	const zonedNow = getZonedTime(Date.now(), findTimeZone(timeZone));
-	const zonedTime = getZonedTime(date, findTimeZone(timeZone));
-
-	return zonedNow.day === zonedTime.day && zonedNow.month === zonedTime.month;
-}
-
-export function isTomorrowInTimeZone(date: Date, timeZone: string): boolean {
-	const zonedNow = getZonedTime(addDays(Date.now(), 1), findTimeZone(timeZone));
-	const zonedTime = getZonedTime(date, findTimeZone(timeZone));
-
-	return zonedNow.day === zonedTime.day && zonedNow.month === zonedTime.month;
-}
-
-export function isSameDateInTimeZone(
-	dateLeft: Date,
-	dateRight: Date,
-	timeZone: string,
-): boolean {
-	const zonedDateLeft = getZonedTime(dateLeft, findTimeZone(timeZone));
-	const zonedDateRight = getZonedTime(dateRight, findTimeZone(timeZone));
-
-	return (
-		zonedDateLeft.year === zonedDateRight.year &&
-		zonedDateLeft.month === zonedDateRight.month &&
-		zonedDateLeft.day === zonedDateRight.day
-	);
-}
-
-export function isMidnightTransition(
-	endDate: Date,
-	startDateNextDay: Date,
-	timeZone: string,
-): boolean {
-	if (!endDate || !startDateNextDay) {
-		return false;
-	}
-	const zonedEndDate = getZonedTime(endDate, findTimeZone(timeZone));
-	const zonedStartDate = getZonedTime(startDateNextDay, findTimeZone(timeZone));
-
-	return (
-		zonedEndDate.hours === 23 &&
-		zonedEndDate.minutes === 59 &&
-		zonedStartDate.hours === 0 &&
-		zonedStartDate.minutes === 0
-	);
-}
-
-export function addDaysInTimeZone(
-	date: Date,
-	days: number,
-	timeZone: string,
-): Date {
-	const zonedTime = getZonedTime(addDays(date, days), findTimeZone(timeZone));
-	return new Date(
-		getUnixTime({
-			...zonedTime,
-			hours: 0,
-			minutes: 0,
-			seconds: 0,
-			milliseconds: 0,
-		}),
-	);
-}
-
-export function isZeroPrepTimeForMidnightShift({
-	prevDayBusinessHours,
-	businessHour,
-}: {
-	prevDayBusinessHours: BusinessHour[];
-	businessHour: BusinessHour;
-}): boolean {
-	if (
-		!Array.isArray(prevDayBusinessHours) ||
-		prevDayBusinessHours.length === 0
-	) {
-		return false;
-	}
-
-	if (!businessHour || businessHour.startTime !== "00:00") {
-		return false;
-	}
-
-	const currentDay = businessHour.day;
-	const prevDay = (currentDay + 6) % 7;
-
-	const prevDayHas24End = prevDayBusinessHours.some(
-		(bh) =>
-			bh.day === prevDay && (bh.endTime === "24:00" || bh.endTime === "23:59"),
-	);
-	return prevDayHas24End;
-}