@flightlesslabs/dodo-ui 0.10.2 → 0.11.0

package/src/lib/stories/developer tools/helpers/Time/getMoment/getMoment.ts

@@ -1,5 +1,5 @@
 import type { ConfigType, OptionType } from 'dayjs';
-import dayjs from 'dayjs';
+import dayjs, { Dayjs } from 'dayjs';
 import utc from 'dayjs/plugin/utc.js';
 import timezone from 'dayjs/plugin/timezone.js';
 import customParseFormat from 'dayjs/plugin/customParseFormat.js';
@@ -15,14 +15,13 @@ export type GetMomentDate = ConfigType;
 
 /**
  * Optional formatting string used to parse the date.
- * Refer to dayjs customParseFormat plugin for supported formats.
  */
 export type GetMomentFormat = OptionType;
 
 /**
  * Settings to control how the moment is returned (UTC, timezone, or local).
  */
-export type GetMomentSettings = {
+export interface GetMomentSettings {
   /**
    * Timezone string (e.g., "America/New_York").
    */
@@ -32,28 +31,28 @@ export type GetMomentSettings = {
    * Whether to return the time in UTC. If true, overrides timezone.
    */
   utc?: boolean;
-};
+}
 
 /**
  * A wrapper around dayjs to return a moment-like object with optional formatting,
  * timezone, or UTC handling.
  *
- * @param {GetMomentDate} [date] - The input date, time, or string to be parsed.
- * @param {format} [format] - A custom format string for parsing the input date.
- * @param {GetMomentSettings} [settings] - Optional settings for format, timezone, and UTC.
- * @returns {dayjs.Dayjs} - A dayjs object in local, UTC, or specified timezone.
+ * @param date - The input date, time, or string to be parsed.
+ * @param format - A custom format string for parsing the input date.
+ * @param settings - Optional settings for timezone or UTC output.
+ * @returns A dayjs object in local, UTC, or specified timezone.
  *
  * @example
- * getMoment('2025-01-01T12:00:00Z', { utc: true }).format()
- * getMoment('01-01-2025', { format: 'DD-MM-YYYY', timezone: 'Asia/Kolkata' }).format()
+ * getMoment('2025-01-01T12:00:00Z', undefined, { utc: true }).format()
+ * getMoment('01-01-2025', 'DD-MM-YYYY', { timezone: 'Asia/Kolkata' }).format()
  */
 export default function getMoment(
   date?: GetMomentDate,
   format?: GetMomentFormat,
   settings?: GetMomentSettings,
-): dayjs.Dayjs {
+): Dayjs {
   const timezone = settings?.timezone;
-  const utc = settings?.utc ? true : false;
+  const utc = settings?.utc ?? false;
 
   if (utc) {
     return dayjs.utc(dayjs(date, format));

package/dist/stories/components/Info/Calendar/utils/createDateOfMonth.d.ts

@@ -1,28 +0,0 @@
-import type { DateOfMonth } from './types.js';
-import type { CalendarWeekNames } from '../SubComponents/CalendarDatesChart/CalendarWeek/CalendarWeek.svelte';
-export interface CreateDatesOfMonthSettings {
-    /** Day considered as start of the week */
-    startOfWeek?: CalendarWeekNames;
-    /** Include leading days from the previous month */
-    showLastMonth?: boolean;
-    /** Include trailing days from the next month */
-    showNextMonth?: boolean;
-    /** Set today manually  */
-    today?: Date;
-    /** Minimum allowed date, rest of the dates will be disabled  */
-    minDate?: Date;
-    /** Maxium allowed date, rest of the dates will be disabled  */
-    maxDate?: Date;
-    /** Exclude Dates, these dates will be disabled */
-    excludeDates?: Date[];
-    /** Include Dates, rest of the dates will be disabled  */
-    includeDates?: Date[];
-    /** Optional IANA timezone */
-    timezone?: string;
-    /** Use UTC time */
-    utc?: boolean;
-    /** Range value */
-    rangeValue?: [Date, Date];
-}
-export type CreateDateOfMonthType = 'currentMonth' | 'nextMonth' | 'lastMonth';
-export default function createDateOfMonth(date?: Date, settings?: CreateDatesOfMonthSettings, monthType?: CreateDateOfMonthType): DateOfMonth;

package/dist/stories/components/Info/Calendar/utils/createDateOfMonth.js

@@ -1,87 +0,0 @@
-import getMoment from '../../../../developer tools/helpers/Time/getMoment/getMoment.js';
-function dateMoment(date, settings) {
-    return getMoment(date, undefined, {
-        timezone: settings?.timezone,
-        utc: settings?.utc,
-    });
-}
-function getIsToday(dayMoment, todayDate, todayManual) {
-    const dayDateFormat = dayMoment.format('DD-MM-YYYY');
-    let today = false;
-    if (todayManual && todayManual === dayDateFormat) {
-        today = true;
-    }
-    else if (todayDate === dayDateFormat) {
-        today = true;
-    }
-    return today;
-}
-function getIsDateDisabled(dayMoment, minDate, maxDate, excludeDates, includeDates) {
-    const dayDateFormat = dayMoment.format('DD-MM-YYYY');
-    let disabled = false;
-    if (minDate?.isValid() && dayMoment.isBefore(minDate)) {
-        disabled = true;
-    }
-    if (maxDate?.isValid() && dayMoment.isAfter(maxDate)) {
-        disabled = true;
-    }
-    if (excludeDates?.length && excludeDates.includes(dayDateFormat)) {
-        disabled = true;
-    }
-    if (includeDates?.length && !includeDates.includes(dayDateFormat)) {
-        disabled = true;
-    }
-    return disabled;
-}
-export default function createDateOfMonth(date, settings, monthType = 'currentMonth') {
-    const minDate = settings?.minDate ? dateMoment(settings.minDate, settings) : undefined;
-    const maxDate = settings?.maxDate ? dateMoment(settings.maxDate, settings) : undefined;
-    const excludeDates = settings?.excludeDates?.length
-        ? settings?.excludeDates.map((item) => dateMoment(item, settings).format('DD-MM-YYYY'))
-        : undefined;
-    const includeDates = settings?.includeDates?.length
-        ? settings?.includeDates.map((item) => dateMoment(item, settings).format('DD-MM-YYYY'))
-        : undefined;
-    const [range1, range2] = settings?.rangeValue || [];
-    const rangeStart = range1 ? dateMoment(range1, settings) : undefined;
-    const rangeEnd = range2 ? dateMoment(range2, settings) : undefined;
-    const todayDate = dateMoment(undefined, settings).format('DD-MM-YYYY');
-    const todayManual = settings?.today
-        ? dateMoment(settings?.today, settings).format('DD-MM-YYYY')
-        : undefined;
-    const dayMoment = dateMoment(date, settings);
-    const dayMomentDayFormatted = dayMoment.format('DD-MM-YYYY');
-    let isRangeStart = false;
-    let isRangeEnd = false;
-    let inRange = false;
-    if (rangeStart && rangeEnd) {
-        if (dayMomentDayFormatted === rangeStart.format('DD-MM-YYYY')) {
-            isRangeStart = true;
-        }
-        if (dayMomentDayFormatted === rangeEnd.format('DD-MM-YYYY')) {
-            isRangeEnd = true;
-        }
-        if (dayMoment.isAfter(rangeStart) && dayMoment.isBefore(rangeEnd)) {
-            inRange = true;
-        }
-    }
-    const dataToExport = {
-        id: `${dayMoment.valueOf()}`,
-        date: dayMoment.toDate(),
-        isCurrentMonth: true,
-        disabled: getIsDateDisabled(dayMoment, minDate, maxDate, excludeDates, includeDates),
-        today: getIsToday(dayMoment, todayDate, todayManual),
-        isRangeStart,
-        isRangeEnd,
-        inRange,
-    };
-    if (monthType === 'lastMonth') {
-        dataToExport.isLastMonth = true;
-        dataToExport.isCurrentMonth = false;
-    }
-    else if (monthType === 'nextMonth') {
-        dataToExport.isNextMonth = true;
-        dataToExport.isCurrentMonth = false;
-    }
-    return dataToExport;
-}

package/dist/stories/components/Info/Calendar/utils/getDatesOfMonth.d.ts

@@ -1,10 +0,0 @@
-import type { DateOfMonth } from './types.js';
-import { type CreateDatesOfMonthSettings } from './createDateOfMonth.js';
-/**
- * Generates a calendar grid of dates for a given month.
- *
- * @param {Date} date - The base date for the month to generate.
- * @param {GetDatesOfMonthSettings} [settings] - Optional settings for formatting and display.
- * @returns {(DateOfMonth[][] | null)} - A 2D array of DateOfMonth objects representing the calendar, or null if invalid.
- */
-export default function getDatesOfMonth(date?: Date, settings?: CreateDatesOfMonthSettings): DateOfMonth[][] | null;

package/dist/stories/components/Info/Calendar/utils/index.mdx

@@ -1,64 +0,0 @@
-import { Source } from '@storybook/blocks';
-
-# Utils
-
-## `getDatesOfMonth`
-
-`getDatesOfMonth(date, settings)` generates a calendar view of a given month with options to include dates from the previous and next month.
-
-### Usage
-
-<Source
-  dark
-  language="ts"
-  code={`
-import { getDatesOfMonth, getMoment} from '@flightlesslabs/dodo-ui';
-
-const dates = getDatesOfMonth(new Date(), {
-showLastMonth: false,
-showNextMonth: false,
-});
-
-// Or
-
-const dates2 = getDatesOfMonth(getMoment('01-02-2025', 'DD-MM-YYYY').toDate());
-
-`}
-/>
-
-## Types
-
-### `DateOfMonth`
-
-<Source
-  dark
-  language="ts"
-  code={`
- type DateOfMonth = {
-  id: string;
-  dayNumber: number;
-  date: Date;
-  isCurrentMonth?: boolean;
-  isLastMonth?: boolean;
-  isNextMonth?: boolean;
-};
-`}
-/>
-
-### Enum: `DAYS_OF_WEEK`
-
-<Source
-  dark
-  language="ts"
-  code={`
- const enum DAYS_OF_WEEK {
-  SUN,
-  MON,
-  TUE,
-  WED,
-  THU,
-  FRI,
-  SAT,
-}
-`}
-/>

package/src/lib/stories/components/Info/Calendar/utils/createDateOfMonth.ts

@@ -1,160 +0,0 @@
-import getMoment from '$lib/stories/developer tools/helpers/Time/getMoment/getMoment.js';
-import type dayjs from 'dayjs';
-import type { DateOfMonth } from './types.js';
-import type { CalendarWeekNames } from '../SubComponents/CalendarDatesChart/CalendarWeek/CalendarWeek.svelte';
-
-export interface CreateDatesOfMonthSettings {
-  /** Day considered as start of the week */
-  startOfWeek?: CalendarWeekNames;
-
-  /** Include leading days from the previous month */
-  showLastMonth?: boolean;
-
-  /** Include trailing days from the next month */
-  showNextMonth?: boolean;
-
-  /** Set today manually  */
-  today?: Date;
-
-  /** Minimum allowed date, rest of the dates will be disabled  */
-  minDate?: Date;
-
-  /** Maxium allowed date, rest of the dates will be disabled  */
-  maxDate?: Date;
-
-  /** Exclude Dates, these dates will be disabled */
-  excludeDates?: Date[];
-
-  /** Include Dates, rest of the dates will be disabled  */
-  includeDates?: Date[];
-
-  /** Optional IANA timezone */
-  timezone?: string;
-
-  /** Use UTC time */
-  utc?: boolean;
-
-  /** Range value */
-  rangeValue?: [Date, Date];
-}
-
-export type CreateDateOfMonthType = 'currentMonth' | 'nextMonth' | 'lastMonth';
-
-function dateMoment(date?: Date, settings?: CreateDatesOfMonthSettings) {
-  return getMoment(date, undefined, {
-    timezone: settings?.timezone,
-    utc: settings?.utc,
-  });
-}
-
-function getIsToday(dayMoment: dayjs.Dayjs, todayDate: string, todayManual: string | undefined) {
-  const dayDateFormat = dayMoment.format('DD-MM-YYYY');
-  let today = false;
-
-  if (todayManual && todayManual === dayDateFormat) {
-    today = true;
-  } else if (todayDate === dayDateFormat) {
-    today = true;
-  }
-
-  return today;
-}
-
-function getIsDateDisabled(
-  dayMoment: dayjs.Dayjs,
-  minDate: dayjs.Dayjs | undefined,
-  maxDate: dayjs.Dayjs | undefined,
-  excludeDates: string[] | undefined,
-  includeDates: string[] | undefined,
-) {
-  const dayDateFormat = dayMoment.format('DD-MM-YYYY');
-  let disabled = false;
-
-  if (minDate?.isValid() && dayMoment.isBefore(minDate)) {
-    disabled = true;
-  }
-
-  if (maxDate?.isValid() && dayMoment.isAfter(maxDate)) {
-    disabled = true;
-  }
-
-  if (excludeDates?.length && excludeDates.includes(dayDateFormat)) {
-    disabled = true;
-  }
-
-  if (includeDates?.length && !includeDates.includes(dayDateFormat)) {
-    disabled = true;
-  }
-
-  return disabled;
-}
-
-export default function createDateOfMonth(
-  date?: Date,
-  settings?: CreateDatesOfMonthSettings,
-  monthType: CreateDateOfMonthType = 'currentMonth',
-): DateOfMonth {
-  const minDate = settings?.minDate ? dateMoment(settings.minDate, settings) : undefined;
-  const maxDate = settings?.maxDate ? dateMoment(settings.maxDate, settings) : undefined;
-  const excludeDates = settings?.excludeDates?.length
-    ? settings?.excludeDates.map((item) => dateMoment(item, settings).format('DD-MM-YYYY'))
-    : undefined;
-  const includeDates = settings?.includeDates?.length
-    ? settings?.includeDates.map((item) => dateMoment(item, settings).format('DD-MM-YYYY'))
-    : undefined;
-
-  const [range1, range2] = settings?.rangeValue || [];
-
-  const rangeStart = range1 ? dateMoment(range1, settings) : undefined;
-  const rangeEnd = range2 ? dateMoment(range2, settings) : undefined;
-
-  const todayDate = dateMoment(undefined, settings).format('DD-MM-YYYY');
-
-  const todayManual = settings?.today
-    ? dateMoment(settings?.today, settings).format('DD-MM-YYYY')
-    : undefined;
-
-  const dayMoment = dateMoment(date, settings);
-  const dayMomentDayFormatted = dayMoment.format('DD-MM-YYYY');
-
-  let isRangeStart = false;
-
-  let isRangeEnd = false;
-
-  let inRange = false;
-
-  if (rangeStart && rangeEnd) {
-    if (dayMomentDayFormatted === rangeStart.format('DD-MM-YYYY')) {
-      isRangeStart = true;
-    }
-
-    if (dayMomentDayFormatted === rangeEnd.format('DD-MM-YYYY')) {
-      isRangeEnd = true;
-    }
-
-    if (dayMoment.isAfter(rangeStart) && dayMoment.isBefore(rangeEnd)) {
-      inRange = true;
-    }
-  }
-
-  const dataToExport: DateOfMonth = {
-    id: `${dayMoment.valueOf()}`,
-    date: dayMoment.toDate(),
-    isCurrentMonth: true,
-    disabled: getIsDateDisabled(dayMoment, minDate, maxDate, excludeDates, includeDates),
-    today: getIsToday(dayMoment, todayDate, todayManual),
-    isRangeStart,
-    isRangeEnd,
-    inRange,
-  };
-
-  if (monthType === 'lastMonth') {
-    dataToExport.isLastMonth = true;
-    dataToExport.isCurrentMonth = false;
-  } else if (monthType === 'nextMonth') {
-    dataToExport.isNextMonth = true;
-    dataToExport.isCurrentMonth = false;
-  }
-
-  return dataToExport;
-}