@koine/react 1.0.10 → 1.0.11

package/Calendar/useCalendar.d.ts

@@ -0,0 +1,49 @@
+import type { Calendars, CalendarEvent, CalendarEventsMap, CalendarView } from "./types";
+import type { KoineCalendarLegendProps } from "./CalendarLegend";
+import type { KoineCalendarDaygridNavProps } from "./CalendarDaygridNav";
+import type { KoineCalendarDaygridTableProps } from "./CalendarDaygridTable";
+export declare type UseCalendarProps = {
+    /** The locale to format with `date-fns` */
+    locale: string;
+    /** Calendars infos to use */
+    calendars: Calendars;
+    /** Fall back to `process.env.GOOGLE_CALENDAR_API_KEY */
+    apiKey?: string;
+    /** The key is the event `uid` */
+    events?: CalendarEventsMap;
+    /** It defaults to the first of the current month */
+    start?: Date;
+    /** It defaults to the last day of the current month */
+    end?: Date;
+    /**
+     * The calendar view
+     * @default "month"
+     */
+    view?: CalendarView;
+    /**
+     * The default is the time zone of the calendar
+     * @see https://developers.google.com/calendar/api/v3/reference/events/list
+     */
+    timeZone?: string;
+    onError?: (e: any) => void;
+};
+export declare type UseCalendarReturn = ReturnType<typeof useCalendar>;
+export declare type CalendarsUpdateActionEvents = {
+    type: "events";
+    payload: Record<string, number>;
+};
+export declare type CalendarsUpdateActionVisibility = {
+    type: "visibility";
+    payload: string | string[];
+};
+export declare type CalendarsUpdateAction = CalendarsUpdateActionEvents | CalendarsUpdateActionVisibility;
+export declare function useCalendar({ locale, apiKey, calendars, events: initialEvents, start: initialStart, end: initialEnd, view: initialView, timeZone, onError, }: UseCalendarProps): {
+    view: "month" | "week";
+    eventClicked: CalendarEvent | null;
+    setEventClicked: import("react").Dispatch<import("react").SetStateAction<CalendarEvent | null>>;
+    eventHovered: CalendarEvent | null;
+    setEventHovered: import("react").Dispatch<import("react").SetStateAction<CalendarEvent | null>>;
+    getDaygridNavProps: () => KoineCalendarDaygridNavProps;
+    getDaygridTableProps: () => KoineCalendarDaygridTableProps;
+    getLegendProps: () => KoineCalendarLegendProps;
+};

package/Calendar/useCalendar.js

@@ -0,0 +1,182 @@
+import { useCallback, useEffect, useReducer, useState } from "react";
+import { getCalendarsEventsFromGoogle } from "./calendar-api-google";
+import { getStartDate, getEndDate, getPrevDate, getNextDate, isTodayInView, } from "./utils";
+export function useCalendar({ locale, apiKey, calendars, events: initialEvents, start: initialStart, end: initialEnd, view: initialView = "month", timeZone = "", onError, }) {
+    const [view, setView] = useState(initialView);
+    const start = initialStart || getStartDate(new Date(), view);
+    const end = initialEnd || getEndDate(start, view);
+    const [range, setRange] = useState([start, end]);
+    const [todayInView, setTodayInView] = useState(isTodayInView(start, end));
+    const [events, setEvents] = useState(initialEvents || {});
+    const [eventHovered, setEventHovered] = useState(null);
+    const [eventClicked, setEventClicked] = useState(null);
+    const [calendarsMap, updateCalendars] = useReducer((state, action) => {
+        const { type } = action;
+        switch (type) {
+            case "events": {
+                const events = action.payload;
+                return Object.entries(state).reduce((map, [id, calendar]) => {
+                    map[id] = {
+                        ...calendar,
+                        events: events[id] || 0,
+                    };
+                    return map;
+                }, {});
+            }
+            case "visibility": {
+                const visible = action.payload;
+                if (typeof visible === "string") {
+                    return {
+                        ...state,
+                        [visible]: {
+                            ...state[visible],
+                            on: !state[visible].on,
+                        },
+                    };
+                }
+                else {
+                    return Object.entries(state).reduce((map, [id, calendar]) => {
+                        map[id] = {
+                            ...calendar,
+                            on: visible.indexOf(id) > -1,
+                        };
+                        return map;
+                    }, {});
+                }
+            }
+            default:
+                return state;
+        }
+    }, 
+    // initial state
+    calendars.reduce((map, calendar) => {
+        map[calendar.id] = {
+            ...calendar,
+            name: calendar.name || "",
+            on: true,
+            events: 0,
+        };
+        return map;
+    }, {}));
+    const toggleCalendarVisibility = useCallback((idOrIds) => {
+        updateCalendars({ type: "visibility", payload: idOrIds });
+    }, [updateCalendars]);
+    const updateCalendarsBasedOnEvents = useCallback((events) => {
+        const payload = {};
+        for (const uid in events) {
+            const { id } = events[uid].calendar;
+            payload[id] = payload[id] || 0;
+            payload[id]++;
+        }
+        updateCalendars({ type: "events", payload });
+    }, []);
+    const loadCalendars = useCallback(async (calendars, start, end) => {
+        try {
+            const newEvents = await getCalendarsEventsFromGoogle({
+                apiKey,
+                calendars,
+                timeZone,
+                start,
+                end,
+            });
+            // setEvents(mergeCalendarEvents(events, newEvents));
+            setEvents(newEvents);
+        }
+        catch (e) {
+            if (onError)
+                onError(e);
+        }
+    }, [setEvents, apiKey, timeZone, onError]);
+    const handleToday = useCallback(() => {
+        const [start, end] = range;
+        const newStart = getStartDate(new Date(), view);
+        const newEnd = getEndDate(newStart, view);
+        setRange([newStart, newEnd]);
+        // reset event only if we are not on the current view already
+        if (start.getTime() !== newStart.getTime() ||
+            end.getTime() !== newEnd.getTime()) {
+            setEventClicked(null);
+            setEventHovered(null);
+        }
+    }, [view, range]);
+    const handlePrev = useCallback(() => {
+        setRange(([start]) => {
+            const newStart = getPrevDate(start, view);
+            const newEnd = getEndDate(newStart, view);
+            return [newStart, newEnd];
+        });
+        setEventClicked(null);
+        setEventHovered(null);
+    }, [view]);
+    const handleNext = useCallback(() => {
+        setRange(([start]) => {
+            const newStart = getNextDate(start, view);
+            const newEnd = getEndDate(newStart, view);
+            return [newStart, newEnd];
+        });
+        setEventClicked(null);
+        setEventHovered(null);
+    }, [view]);
+    const handleView = useCallback((newView) => {
+        const newStart = getStartDate(start, newView);
+        const newEnd = getEndDate(newStart, newView);
+        setRange([newStart, newEnd]);
+        setView(newView);
+        setEventClicked(null);
+        setEventHovered(null);
+    }, [start]);
+    useEffect(() => {
+        const [start, end] = range;
+        loadCalendars(calendars, start, end);
+        setTodayInView(isTodayInView(start, end));
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [range]);
+    useEffect(() => {
+        if (events) {
+            updateCalendarsBasedOnEvents(events);
+        }
+    }, [events, updateCalendarsBasedOnEvents]);
+    // when toggling a calendar we also remove the clicked event if that belongs
+    // to a now hidden calendar
+    useEffect(() => {
+        if (eventClicked) {
+            if (!calendarsMap[eventClicked.calendar.id].on) {
+                setEventClicked(null);
+            }
+        }
+    }, [calendarsMap, eventClicked, setEventClicked]);
+    return {
+        view,
+        eventClicked,
+        setEventClicked,
+        eventHovered,
+        setEventHovered,
+        getDaygridNavProps: () => ({
+            locale,
+            handlePrev,
+            handleNext,
+            handleToday,
+            handleView,
+            todayInView,
+            range,
+            view,
+        }),
+        getDaygridTableProps: () => ({
+            locale,
+            events,
+            eventClicked,
+            setEventClicked,
+            eventHovered,
+            setEventHovered,
+            handlePrev,
+            handleNext,
+            calendarsMap,
+            range,
+            view,
+        }),
+        getLegendProps: () => ({
+            calendarsMap,
+            toggleCalendarVisibility,
+        }),
+    };
+}

package/Calendar/utils.d.ts

@@ -0,0 +1,11 @@
+import type { CalendarEventsMap, CalendarView, CalendarViewWeeks } from "./types";
+export declare function getEventTimestamp(dateLike: number | Date | string): number;
+export declare function getDisplayTime(date: Date): string;
+export declare function getStartDate(date: Date, view: CalendarView): Date;
+export declare function getEndDate(start: Date, view: CalendarView): Date;
+export declare function getPrevDate(date: Date, view: CalendarView): Date;
+export declare function getNextDate(date: Date, view: CalendarView): Date;
+export declare function isTodayInView(start: Date, end: Date): boolean;
+export declare function mergeCalendarEvents(first: CalendarEventsMap, second: CalendarEventsMap): CalendarEventsMap;
+export declare function addCalendarEvents(toAdd: CalendarEventsMap, toExtend: CalendarEventsMap): CalendarEventsMap;
+export declare function processEventsInView(eventsMap: CalendarEventsMap, calendarView: CalendarView, month: number, weeks: Date[]): CalendarViewWeeks;

package/Calendar/utils.js

@@ -0,0 +1,203 @@
+import isWithinInterval from "date-fns/isWithinInterval";
+import endOfMonth from "date-fns/endOfMonth";
+import startOfWeek from "date-fns/startOfWeek";
+import endOfWeek from "date-fns/endOfWeek";
+import subMonths from "date-fns/subMonths";
+import addMonths from "date-fns/addMonths";
+import subWeeks from "date-fns/subWeeks";
+import addWeeks from "date-fns/addWeeks";
+import addDays from "date-fns/addDays";
+export function getEventTimestamp(dateLike) {
+    const date = new Date(dateLike);
+    date.setHours(0, 0, 0, 0);
+    return date.valueOf() / 1000;
+}
+export function getDisplayTime(date) {
+    return (date.getHours() +
+        ":" +
+        "0".repeat(2 - date.getMinutes().toString().length) +
+        date.getMinutes());
+}
+export function getStartDate(date, view) {
+    date.setHours(0, 0, 0);
+    if (view === "month") {
+        date.setDate(1);
+    }
+    else if (view === "week") {
+        date = startOfWeek(date, { weekStartsOn: 1 });
+    }
+    return date;
+}
+export function getEndDate(start, view) {
+    let end = start;
+    if (view === "month") {
+        end = endOfMonth(start);
+    }
+    else if (view === "week") {
+        end = endOfWeek(start, { weekStartsOn: 1 });
+    }
+    end.setHours(23, 59, 59);
+    return end;
+}
+export function getPrevDate(date, view) {
+    if (view === "month") {
+        return subMonths(date, 1);
+    }
+    return subWeeks(date, 1);
+}
+export function getNextDate(date, view) {
+    if (view === "month") {
+        return addMonths(date, 1);
+    }
+    return addWeeks(date, 1);
+}
+export function isTodayInView(start, end) {
+    return isWithinInterval(new Date(), { start, end });
+}
+export function mergeCalendarEvents(first, second) {
+    const all = {};
+    addCalendarEvents(first, all);
+    addCalendarEvents(second, all);
+    return all;
+}
+export function addCalendarEvents(toAdd, toExtend) {
+    for (const id in toAdd) {
+        const event = toAdd[id];
+        toExtend[id] = event;
+    }
+    return toExtend;
+}
+function getEventsByTimestamp(events) {
+    const output = {};
+    for (const uid in events) {
+        const event = events[uid];
+        event.days.forEach((timestamp) => {
+            output[timestamp] = (output[timestamp] || {});
+            output[timestamp][uid] = event;
+        });
+    }
+    return output;
+}
+function getSortedEvents(events) {
+    const output = [];
+    for (const uid in events) {
+        output.push(events[uid]);
+    }
+    // sort events first multi, then all day then by start then by created date
+    output.sort((a, b) => {
+        const multi = Number(b.multi) - Number(a.multi);
+        const allDay = Number(b.allDay) - Number(a.allDay);
+        const start = a.start.getTime() - b.start.getTime();
+        const created = a.created.getTime() - b.created.getTime();
+        return multi || allDay || start || created;
+    });
+    return output;
+}
+const FREE_SLOT = 0;
+const BUSY_SLOT = 1;
+export function processEventsInView(eventsMap, calendarView, month, weeks) {
+    const eventsByTimestamp = getEventsByTimestamp(eventsMap);
+    const eventsList = getSortedEvents(eventsMap);
+    const todayDate = new Date();
+    const todayTimestamp = getEventTimestamp(todayDate);
+    const startedAtTopMap = {};
+    const viewWeeks = [];
+    for (let weekIdx = 0; weekIdx < weeks.length; weekIdx++) {
+        const viewWeek = {
+            props: { key: `week.${weekIdx}` },
+            days: [],
+        };
+        const weekStartDate = weeks[weekIdx];
+        const weekStartDay = weekStartDate.getDate();
+        const weekStartTimestamp = getEventTimestamp(new Date(weekStartDate));
+        const weekEndTimestamp = getEventTimestamp(addDays(new Date(weekStartDate), 6));
+        for (let dayNumber = 0; dayNumber < 7; dayNumber++) {
+            const dayDate = new Date(new Date(weekStartDate).setDate(weekStartDay + dayNumber));
+            const dayTimestamp = getEventTimestamp(dayDate);
+            const $isToday = todayTimestamp === dayTimestamp;
+            const $isOutOfRange = calendarView === "month" && dayDate.getMonth() !== month;
+            const contextualProps = {
+                $isToday,
+                $isOutOfRange,
+            };
+            const viewDay = {
+                props: { key: `day.${dayTimestamp}`, ...contextualProps },
+                timestamp: dayTimestamp + "",
+                label: dayDate.getDate() + "",
+                events: [],
+            };
+            // check that we have events in this day
+            if (eventsByTimestamp?.[dayTimestamp]) {
+                const verticalSlots = Object.keys(eventsByTimestamp[dayTimestamp]).map(() => FREE_SLOT);
+                for (let eventIdx = 0; eventIdx < eventsList.length; eventIdx++) {
+                    const event = eventsList[eventIdx];
+                    let width = 1;
+                    let top = 0;
+                    let firstOfMulti;
+                    if (!event.daysMap[dayTimestamp]) {
+                        continue;
+                    }
+                    // only for multi days events:
+                    if (event.multi) {
+                        // filter out the days outside of the current week view to avoid
+                        // making a multi-days event chip wider than the week row or shorter
+                        // than it should be (when event spans across weeks)
+                        width = event.days.filter((t) => t >= weekStartTimestamp && t <= weekEndTimestamp).length;
+                        // flag the first day of multi-days events, consider that an event
+                        // might start in a day earlier (hence outside) of the current
+                        // week/month view, so we always check for Mondays (dayNumber === 0)
+                        if (event.days.indexOf(dayTimestamp) === 0 || dayNumber === 0) {
+                            firstOfMulti = true;
+                        }
+                    }
+                    // if we already have the information on when the event has been
+                    // vertically positioned use that index
+                    if (startedAtTopMap[event.uid]) {
+                        top = startedAtTopMap[event.uid];
+                    }
+                    else {
+                        // now look for a free slot and use its index as `top`
+                        for (let verticalIdx = 0; verticalIdx < verticalSlots.length; verticalIdx++) {
+                            const freeOrBusy = verticalSlots[verticalIdx];
+                            if (freeOrBusy !== BUSY_SLOT) {
+                                top = verticalIdx;
+                                break;
+                            }
+                        }
+                    }
+                    // now mark the slot as busy
+                    verticalSlots[top] = BUSY_SLOT;
+                    // store the slot vertical position consistently for multi-days events
+                    if (firstOfMulti) {
+                        startedAtTopMap[event.uid] = top;
+                    }
+                    // push the event, they will be sorted later
+                    viewDay.events.push({
+                        key: `event.${dayTimestamp}-${top}`,
+                        ...contextualProps,
+                        ...event,
+                        isPast: todayDate > event.end,
+                        firstOfMulti,
+                        top,
+                        width,
+                    });
+                }
+                // fill the empty slots with events' placeholders
+                for (let i = 0; i < verticalSlots.length; i++) {
+                    if (verticalSlots[i] !== BUSY_SLOT) {
+                        viewDay.events.push({
+                            key: `event.${dayTimestamp}-${i}}`,
+                            placeholder: true,
+                            top: i,
+                        });
+                    }
+                }
+                // sort events and events placeholders by top position
+                viewDay.events.sort((a, b) => a.top - b.top);
+            }
+            viewWeek.days.push(viewDay);
+        }
+        viewWeeks.push(viewWeek);
+    }
+    return viewWeeks;
+}

package/Carousel/Carousel.d.ts

@@ -0,0 +1 @@
+export declare const KoineCarousel: null;