@globalpayments/vega 2.13.0 → 2.14.0

package/dist/types/components/vega-calendar/vega-calendar-event/slimmers/renderers/vega-calendar-event-renderer.d.ts

@@ -0,0 +1,54 @@
+import { VegaSlimmer } from '../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaCalendarEvent } from '../../vega-calendar-event';
+import { Nullable } from '../../../../../types/general';
+/** The `VegaCalendarEventRenderer` class is a TypeScript React component used for rendering calendar events with different display modes and custom styling. */
+export declare class VegaCalendarEventRenderer extends VegaSlimmer {
+  protected host: VegaCalendarEvent['host'];
+  protected timeFormat: VegaCalendarEvent['timeFormat'];
+  protected calendarEvent: VegaCalendarEvent['calendarEvent'];
+  protected colorController: VegaCalendarEvent['colorController'];
+  private eventTitleContainerRef;
+  /**
+   * This function returns the event title container as a nullable HTMLDivElement.
+   *
+   * @returns {Nullable<HTMLDivElement>} The method `getEventTitleContainer` is returning a nullable HTMLDivElement.
+   */
+  getEventTitleContainerRef(): Nullable<HTMLDivElement>;
+  /**
+   * The function conditionally renders either a group event or a normal event based on a boolean flag.
+   *
+   * @returns {HTMLElement} the event element
+   */
+  render(): HTMLElement;
+  /**
+   * render background mode event element
+   *
+   * @returns {HTMLDivElement} div element
+   */
+  private renderBackgroundModeEvent;
+  /**
+   * render event element
+   *
+   * @returns {HTMLAnchorElement} event element
+   */
+  private renderNormalEvent;
+  /**
+   * render event status element, a color badge or a color bar element
+   *
+   * @returns {HTMLDivElement} div element
+   */
+  private renderEventStatus;
+  /**
+   * render the custom color style tag element
+   *
+   * @returns {HTMLStyleElement} style element
+   */
+  private injectBackgroundColorStyle;
+  /**
+   * Takes a time string as input and formats it to ensure it always has two digits for hours and minutes.
+   *
+   * @param {string} timeString the event time string
+   * @returns {string} time string after format
+   */
+  private formatDisplayTime;
+}

package/dist/types/components/vega-calendar/vega-calendar-event/vega-calendar-event.d.ts

@@ -0,0 +1,25 @@
+import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
+import { VegaCalendarEventRenderer } from './slimmers/renderers/vega-calendar-event-renderer';
+import { VegaCalendarEventBgColorController } from './slimmers/controllers/vega-calendar-event-bg-color-controller';
+import { CalendarEvent } from '../../../helpers/calendar/calendar-event';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/componentUsageRuntimeMetrics';
+import { TimeFormat } from '../../../types/general';
+import { VegaCalendarEventSubStateController } from './slimmers/controllers/vega-calendar-sub-state-controller';
+import { VegaCalendarTitleMaxHeightController } from './slimmers/controllers/vega-calendar-event-title-max-height-controller';
+import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/pageResizeObserverSlimmer';
+export declare class VegaCalendarEvent {
+  protected readonly globalSlimmer: GlobalSlimmers;
+  protected readonly pageResizeObserverSlimmer: PageResizeObserverSlimmer;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCardElement>;
+  protected renderer: VegaCalendarEventRenderer;
+  protected colorController: VegaCalendarEventBgColorController;
+  protected subStateController: VegaCalendarEventSubStateController;
+  protected titleMaxHeightController: VegaCalendarTitleMaxHeightController;
+  host: HTMLVegaCalendarEventElement;
+  timeFormat: TimeFormat;
+  /**
+   * Specifies the calendar event.
+   */
+  calendarEvent: CalendarEvent;
+  render(): VegaCalendarEvent;
+}

package/dist/types/components/vega-calendar/vega-calendar.d.ts

@@ -0,0 +1,107 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
+import { VegaCalendarRenderer } from './slimmers/common/renderers/vega-calendar-renderer';
+import { VegaCalendarSwitchPanelRenderer } from './slimmers/common/renderers/vega-calendar-switch-panel';
+import { VegaCalendarViewRenderer } from './slimmers/common/renderers/vega-calendar-view-renderer';
+import { VegaCalendarMonthViewRenderer } from './slimmers/month-view/renderers/vega-calendar-month-view-renderer';
+import { VegaCalendarViewWithTimeRenderer } from './slimmers/day-view/renderers/vega-calendar-view-with-time-renderer';
+import { VegaCalendarTimeLineRenderer } from './slimmers/day-view/renderers/vega-calendar-time-line-renderer';
+import { VegaCalendarChangeEventType, VegaCalendarEventClickInfo, VegaCalendarRawEvent, VegaCalendarViewModeType } from './types';
+import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/eventEmitSlimmer';
+import { CalendarPeriod, CalendarView } from '../../helpers/calendar';
+import { VegaCalendarViewController } from './slimmers/common/controllers/vega-calendar-view-controller';
+import { VegaCalendarCurrentPeriodController } from './slimmers/common/controllers/vega-calendar-current-period-controller';
+import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/childNodesEventPreventSlimmer';
+import { VegaCalendarMonthEventRenderer } from './slimmers/month-view/renderers/vega-calendar-month-event-renderer';
+import { VegaCalendarEventController } from './slimmers/common/controllers/vega-calendar-event-controller';
+import { VegaCalendarEventResponsiveController } from './slimmers/common/controllers/vega-calendar-event-responsive-controller';
+import { VegaCalendarFullDayEventRenderer } from './slimmers/day-view/renderers/full-day-event/vega-calendar-full-day-event-renderer';
+import { CalendarEvent } from '../../helpers/calendar/calendar-event';
+import { VegaCalendarEventItemRenderer } from './slimmers/common/renderers/vega-calendar-event-item-renderer';
+import { VegaCalendarDayViewEventLayoutRenderer } from './slimmers/day-view/renderers/timed-event/vega-calendar-day-event-layout-renderer';
+import { VegaCalendarTimedEventRenderer } from './slimmers/day-view/renderers/timed-event/vega-calendar-timed-event-renderer';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/componentUsageRuntimeMetrics';
+import { VegaCalendarFullDayEventLayoutRenderer } from './slimmers/common/renderers/vega-calendar-full-day-event-layout-renderer';
+import { TimeFormat } from '../../types/general';
+import { SubStateNotifySlimmerBase } from '../../helpers/slimmers/sub-state/subStateNotifySlimmerBase';
+export declare class VegaCalendar {
+  protected readonly globalSlimmer: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCardElement>;
+  protected renderer: VegaCalendarRenderer;
+  protected switchPanelRenderer: VegaCalendarSwitchPanelRenderer;
+  protected viewRenderer: VegaCalendarViewRenderer;
+  protected monthViewRenderer: VegaCalendarMonthViewRenderer;
+  protected viewWithTimeRenderer: VegaCalendarViewWithTimeRenderer;
+  protected timeLineRenderer: VegaCalendarTimeLineRenderer;
+  protected monthEventRenderer: VegaCalendarMonthEventRenderer;
+  protected currentPeriodController: VegaCalendarCurrentPeriodController;
+  protected calendarViewController: VegaCalendarViewController;
+  protected dayViewFullDayEventRenderer: VegaCalendarFullDayEventRenderer;
+  protected dayViewTimedEventRenderer: VegaCalendarTimedEventRenderer;
+  protected eventItemRenderer: VegaCalendarEventItemRenderer;
+  protected dayViewEventLayoutRenderer: VegaCalendarDayViewEventLayoutRenderer;
+  protected fullDayEventLayoutRenderer: VegaCalendarFullDayEventLayoutRenderer;
+  protected calendarEventController: VegaCalendarEventController;
+  protected eventResponsiveController: VegaCalendarEventResponsiveController;
+  protected changeEventEmitter: EventEmitSlimmerBase;
+  protected eventClickEmitter: EventEmitSlimmerBase;
+  protected changeEventPrevent: ChildNodesEventPreventSlimmer;
+  protected readonly timeFormatNotifySlimmer: SubStateNotifySlimmerBase;
+  host: HTMLVegaCalendarElement;
+  calendarView: CalendarView;
+  currentPeriod: CalendarPeriod;
+  /**
+   * watch the state calendar current period change
+   */
+  watchCurrentPeriodChange(): void;
+  calendarEvents: CalendarEvent[];
+  /**
+   * Specifies the current view mode of the calendar.
+   */
+  viewMode: VegaCalendarViewModeType;
+  /**
+   * Watch the view mode change
+   *
+   * @param {VegaCalendarViewModeType} newValue the new value of view mode
+   */
+  watchViewModeChange(newValue: VegaCalendarViewModeType): void;
+  /**
+   * Specifies the events of the calendar.
+   */
+  events: VegaCalendarRawEvent[];
+  /**
+   * Watch the calendar events change
+   *
+   * @param {VegaCalendarRawEvent[]} newValue
+   */
+  watchEventsChange(newValue: VegaCalendarRawEvent[]): void;
+  /**
+   * Specifies the time format of the calendar.
+   */
+  timeFormat: TimeFormat;
+  /**
+   * Watches changes in the calendar's time format.
+   *
+   * @param {TimeFormat} newValue
+   */
+  watchTimeFormat(newValue: TimeFormat): void;
+  /**
+   * An event emitter notifying the component view content change after a switch panel click.
+   */
+  vegaChange: EventEmitter<VegaCalendarChangeEventType>;
+  /**
+   * An event emitter notifying the component view content change after a switch panel click.
+   *
+   * @eventSemantics namespace:native
+   */
+  change: EventEmitter<VegaCalendarChangeEventType>;
+  /**
+   * An event emitter notifying that a component event item is clicked.
+   */
+  vegaEventClick: EventEmitter<VegaCalendarEventClickInfo>;
+  /**
+   * An event emitter notifying that a component event item is clicked.
+   */
+  eventClick: EventEmitter<VegaCalendarEventClickInfo>;
+  render(): VegaCalendar;
+}

package/dist/types/components/vega-dropdown/slimmers/controllers/vega-dropdown-search-controller.d.ts

@@ -8,6 +8,8 @@ import { VegaDropdown } from '../../vega-dropdown';
 export declare class VegaDropdownSearchController extends VegaSlimmer {
   searchString: VegaDropdown['searchString'];
   caseSensitive: VegaDropdown['caseSensitive'];
+  useDefaultFilter: VegaDropdown['useDefaultFilter'];
+  searchable: VegaDropdown['searchable'];
   /**
    * The search function returns the source array if there is no search string, otherwise it searches the
    * nested list for matching items.
@@ -18,6 +20,14 @@ export declare class VegaDropdownSearchController extends VegaSlimmer {
    * @returns {VegaDropdownSourceItem[]} an array of `VegaDropdownSourceItem` objects.
    */
   search(source: VegaDropdown['source']): VegaDropdownSourceItem[];
+  /**
+   * The function `canSearch` returns true if the conditions for searching are met.
+   *
+   * @returns {boolean} The method `canSearch()` returns a boolean value based on the conditions specified in the
+   * return statement. It returns `true` if `useDefaultFilter` is true, `searchable` is true, and
+   * `searchString` is not an empty string; otherwise, it returns `false`.
+   */
+  private canSearch;
   /**
    * The function `searchSource` recursively searches through a nested list of `VegaDropdownSourceItem`
    * objects, filtering out items that do not match a search string and modifying the labels of matching

package/dist/types/components/vega-tooltip/slimmers/controllers/vega-tooltip-element-appender-controller.d.ts

@@ -19,4 +19,12 @@ export declare class VegaTooltipElementAppenderController extends ElementAppende
    * This constructor of the tooltip element appender controller.
    */
   constructor();
+  /**
+   * The `watchTrigger` function hides an element if the trigger is set to 'none'.
+   */
+  watchTrigger(): void;
+  /**
+   * The function `watchToShowTooltip` checks if the tooltip should be shown and then displays it if necessary.
+   */
+  watchToShowTooltip(): void;
 }

package/dist/types/components/vega-tooltip/vega-tooltip.d.ts

@@ -42,6 +42,7 @@ export declare class VegaTooltip {
    * - none: means tooltip is not displayed regardless of hover or click.
    */
   trigger: 'hover' | 'click' | 'none';
+  watchTrigger(): void;
   /**
    * Specifies the content that is displayed
    *    inside the tooltip.
@@ -63,7 +64,7 @@ export declare class VegaTooltip {
    *    within its container or relative to a reference point.
    */
   alignment: ElementAppenderAlignmentType;
-  watchPlacement(): void;
+  watchToShowTooltip(): void;
   /**
    * Specifies the target element that will contain the tooltip popup.
    *

package/dist/types/components.d.ts

@@ -17,6 +17,9 @@ import { VegaButtonIconAlign, VegaButtonSize, VegaButtonType, VegaButtonVariant
 import { VegaButtonCircleSize, VegaButtonCircleTooltip, VegaButtonCircleVariant } from "./components/vega-button-circle/types";
 import { DropdownPropsForButtonGroup, VegaButtonGroupIconAlign, VegaButtonGroupSize, VegaButtonGroupVariant } from "./components/vega-button-group/types";
 import { DropdownSourceGroup, DropdownSourceItem, VegaDropdownSourceItem } from "./components/vega-dropdown/types";
+import { VegaCalendarChangeEventType, VegaCalendarEventClickInfo, VegaCalendarRawEvent, VegaCalendarViewModeType } from "./components/vega-calendar/types";
+import { Nullable, TimeFormat } from "./types/general";
+import { CalendarEvent } from "./helpers/calendar/calendar-event";
 import { FormFieldValidationRule } from "./helpers/validator/rules/formFieldValidationRule";
 import { VegaChipIconAlign, VegaChipSize, VegaChipType, VegaChipVariant } from "./components/vega-chip/types";
 import { VegaComboBoxSize, VegaDropdownPropsForComboBox } from "./components/vega-combo-box/types";
@@ -27,7 +30,6 @@ import { VegaDropdownItemClickEvent } from "./components/vega-dropdown/vega-drop
 import { VegaFontAs } from "./components/vega-font/types";
 import { FormControlOption, FormValidateResult } from "./components/vega-form/types";
 import { VegaFile, VegaFileOptional, VegaImageUploaderStatus } from "./components/vega-image-uploader/types";
-import { Nullable, TimeFormat } from "./types/general";
 import { MaskConfigType } from "./components/vega-input/types";
 import { InputRangeStackType, InputRangeValueType } from "./components/vega-input-range/types";
 import { SelectedLabelType, SelectSourceItem, SelectType, SelectValueType, VegaDropdownPropsForSelect, VegaInputSelectSize, VegaInputSelectSourceLazyLoadCallback } from "./components/vega-input-select/types";
@@ -481,6 +483,26 @@ export namespace Components {
          */
         "size": 'default' | 'large' | 'small';
     }
+    interface VegaCalendar {
+        /**
+          * Specifies the events of the calendar.
+         */
+        "events": VegaCalendarRawEvent[];
+        /**
+          * Specifies the time format of the calendar.
+         */
+        "timeFormat": TimeFormat;
+        /**
+          * Specifies the current view mode of the calendar.
+         */
+        "viewMode": VegaCalendarViewModeType;
+    }
+    interface VegaCalendarEvent {
+        /**
+          * Specifies the calendar event.
+         */
+        "calendarEvent": CalendarEvent;
+    }
     interface VegaCard {
         /**
           * Defines the background color of the card element.    It accepts a string value representing a valid    background color token.
@@ -2599,6 +2621,10 @@ export interface VegaButtonLinkCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVegaButtonLinkElement;
 }
+export interface VegaCalendarCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLVegaCalendarElement;
+}
 export interface VegaCarouselCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLVegaCarouselElement;
@@ -2830,6 +2856,18 @@ declare global {
         prototype: HTMLVegaButtonLinkElement;
         new (): HTMLVegaButtonLinkElement;
     };
+    interface HTMLVegaCalendarElement extends Components.VegaCalendar, HTMLStencilElement {
+    }
+    var HTMLVegaCalendarElement: {
+        prototype: HTMLVegaCalendarElement;
+        new (): HTMLVegaCalendarElement;
+    };
+    interface HTMLVegaCalendarEventElement extends Components.VegaCalendarEvent, HTMLStencilElement {
+    }
+    var HTMLVegaCalendarEventElement: {
+        prototype: HTMLVegaCalendarEventElement;
+        new (): HTMLVegaCalendarEventElement;
+    };
     interface HTMLVegaCardElement extends Components.VegaCard, HTMLStencilElement {
     }
     var HTMLVegaCardElement: {
@@ -3270,6 +3308,8 @@ declare global {
         "vega-button-group": HTMLVegaButtonGroupElement;
         "vega-button-group-item": HTMLVegaButtonGroupItemElement;
         "vega-button-link": HTMLVegaButtonLinkElement;
+        "vega-calendar": HTMLVegaCalendarElement;
+        "vega-calendar-event": HTMLVegaCalendarEventElement;
         "vega-card": HTMLVegaCardElement;
         "vega-carousel": HTMLVegaCarouselElement;
         "vega-checkbox": HTMLVegaCheckboxElement;
@@ -3860,6 +3900,43 @@ declare namespace LocalJSX {
          */
         "size"?: 'default' | 'large' | 'small';
     }
+    interface VegaCalendar {
+        /**
+          * Specifies the events of the calendar.
+         */
+        "events"?: VegaCalendarRawEvent[];
+        /**
+          * An event emitter notifying the component view content change after a switch panel click.
+          * @eventSemantics namespace:native
+         */
+        "onChange"?: (event: VegaCalendarCustomEvent<VegaCalendarChangeEventType>) => void;
+        /**
+          * An event emitter notifying that a component event item is clicked.
+         */
+        "onEventClick"?: (event: VegaCalendarCustomEvent<VegaCalendarEventClickInfo>) => void;
+        /**
+          * An event emitter notifying the component view content change after a switch panel click.
+         */
+        "onVegaChange"?: (event: VegaCalendarCustomEvent<VegaCalendarChangeEventType>) => void;
+        /**
+          * An event emitter notifying that a component event item is clicked.
+         */
+        "onVegaEventClick"?: (event: VegaCalendarCustomEvent<VegaCalendarEventClickInfo>) => void;
+        /**
+          * Specifies the time format of the calendar.
+         */
+        "timeFormat"?: TimeFormat;
+        /**
+          * Specifies the current view mode of the calendar.
+         */
+        "viewMode"?: VegaCalendarViewModeType;
+    }
+    interface VegaCalendarEvent {
+        /**
+          * Specifies the calendar event.
+         */
+        "calendarEvent"?: CalendarEvent;
+    }
     interface VegaCard {
         /**
           * Defines the background color of the card element.    It accepts a string value representing a valid    background color token.
@@ -6279,6 +6356,8 @@ declare namespace LocalJSX {
         "vega-button-group": VegaButtonGroup;
         "vega-button-group-item": VegaButtonGroupItem;
         "vega-button-link": VegaButtonLink;
+        "vega-calendar": VegaCalendar;
+        "vega-calendar-event": VegaCalendarEvent;
         "vega-card": VegaCard;
         "vega-carousel": VegaCarousel;
         "vega-checkbox": VegaCheckbox;
@@ -6369,6 +6448,8 @@ declare module "@stencil/core" {
             "vega-button-group": LocalJSX.VegaButtonGroup & JSXBase.HTMLAttributes<HTMLVegaButtonGroupElement>;
             "vega-button-group-item": LocalJSX.VegaButtonGroupItem & JSXBase.HTMLAttributes<HTMLVegaButtonGroupItemElement>;
             "vega-button-link": LocalJSX.VegaButtonLink & JSXBase.HTMLAttributes<HTMLVegaButtonLinkElement>;
+            "vega-calendar": LocalJSX.VegaCalendar & JSXBase.HTMLAttributes<HTMLVegaCalendarElement>;
+            "vega-calendar-event": LocalJSX.VegaCalendarEvent & JSXBase.HTMLAttributes<HTMLVegaCalendarEventElement>;
             "vega-card": LocalJSX.VegaCard & JSXBase.HTMLAttributes<HTMLVegaCardElement>;
             "vega-carousel": LocalJSX.VegaCarousel & JSXBase.HTMLAttributes<HTMLVegaCarouselElement>;
             "vega-checkbox": LocalJSX.VegaCheckbox & JSXBase.HTMLAttributes<HTMLVegaCheckboxElement>;

package/dist/types/constants/runtime-metrics-payload-definition/vega-dropdown/runtime-metrics-payload-definition.d.ts

@@ -0,0 +1,2 @@
+import { ComponentUsageRuntimeMetricsDefinition } from '../../../helpers/slimmers/componentUsageRuntimeMetrics';
+export declare const VegaDropdownRuntimeMetricsPayloadDefinition: ComponentUsageRuntimeMetricsDefinition<HTMLVegaDropdownElement>[];

package/dist/types/constants/runtime-metrics-payload-definition/vega-left-nav/runtime-metrics-payload-definition.d.ts

@@ -0,0 +1,2 @@
+import { ComponentUsageRuntimeMetricsDefinition } from '../../../helpers/slimmers/componentUsageRuntimeMetrics';
+export declare const VegaLeftNavRuntimeMetricsPayloadDefinition: ComponentUsageRuntimeMetricsDefinition<HTMLVegaLeftNavElement>[];

package/dist/types/constants/runtime-metrics-payload-definition/vega-nav-card/runtime-metrics-payload-definition.d.ts

@@ -0,0 +1,2 @@
+import { ComponentUsageRuntimeMetricsDefinition } from '../../../helpers/slimmers/componentUsageRuntimeMetrics';
+export declare const VegaNavCardRuntimeMetricsPayloadDefinition: ComponentUsageRuntimeMetricsDefinition<HTMLVegaNavCardElement>[];

package/dist/types/constants/ui.d.ts

@@ -12,5 +12,5 @@ export declare const FlexWrap: readonly ["nowrap", "wrap", "wrap-reverse"];
 export declare const BoxDisplay: readonly ["block", "none"];
 export declare const BorderStyle: readonly ["solid", "dashed", "dotted", "double", "none"];
 export declare const TextAlign: readonly ["start", "end", "left", "right", "center", "justify"];
-export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick"];
+export declare const VegaNativeEventName: readonly ["change", "click", "focus", "blur", "close", "modalOpen", "validate", "formSubmit", "formReset", "rowClick", "selectChange", "selectAllChange", "pageSizeChange", "dropdownClick", "create", "search", "hide", "show", "popoverShow", "popoverHide", "cancel", "remove", "pageUpdate", "currentStepUpdate", "toggleStatus", "stateUpdate", "groupClick", "menuClick", "accordionExpand", "dropdownShow", "dropdownHide", "dropdownSearch", "actionClick", "eventClick", "dateClick"];
 export declare const CssStates: readonly ["default", "hover", "active", "focus-visible"];

package/dist/types/global/icons/chevron-left.d.ts

@@ -0,0 +1,3 @@
+import { IconPayload } from '../../helpers/icon/interface';
+declare const _default: IconPayload;
+export default _default;

package/dist/types/global/icons/chevron-right.d.ts

@@ -0,0 +1,3 @@
+import { IconPayload } from '../../helpers/icon/interface';
+declare const _default: IconPayload;
+export default _default;

package/dist/types/helpers/calendar/calendar-date.d.ts

@@ -0,0 +1,61 @@
+export declare type DateCompareResult = {
+  isPreviousMonth: boolean;
+  isNextMonth: boolean;
+  inMonth: boolean;
+};
+/**
+ * Calendar date class
+ */
+export declare class CalendarDate {
+  private _year;
+  private _month;
+  private _date;
+  constructor(year: number, month: number, date: number);
+  /**
+   * Create a calendar date from a Date object
+   *
+   * @param {Date} date - The Date object
+   * @returns {CalendarDate} - Return a CalendarDate object
+   */
+  static from(date: Date): CalendarDate;
+  /**
+   * The year of the calendar date
+   *
+   * @type {number}
+   */
+  get year(): number;
+  set year(value: number);
+  /**
+   * The month of the calendar date
+   *
+   * @type {number}
+   */
+  get month(): number;
+  set month(value: number);
+  /**
+   * The date of the calendar date
+   *
+   * @type {number}
+   */
+  get date(): number;
+  set date(value: number);
+  /**
+   * Verify whether the calendar date is today
+   *
+   * @returns {boolean} - Return true if the calendar date is today. Otherwise, return false.
+   */
+  isToday(): boolean;
+  /**
+   * Convert the calendar date to a Date object
+   *
+   * @returns {Date} - Return a Date object
+   */
+  toDate(): Date;
+  /**
+   * Compare with another calendar date
+   *
+   * @param {CalendarDate} date - The calendar date to compare with
+   * @returns {DateCompareResult} - Return a DateCompareResult object
+   */
+  compare(date: CalendarDate): DateCompareResult;
+}

package/dist/types/helpers/calendar/calendar-event.d.ts

@@ -0,0 +1,140 @@
+import { VegaCalendarEventVariantType, VegaCalendarRawEvent } from '../../components/vega-calendar/types';
+import { Nullable } from '../../types/general';
+import { CalendarDate } from './calendar-date';
+/** The `CalendarEvent` class in TypeScript represents a calendar event with methods to validate required fields, initialize dates and times, and determine if it is a group event. */
+export declare class CalendarEvent {
+  private _event;
+  private _eventKey;
+  private _startDate;
+  private _endDate;
+  private _startTime;
+  private _endTime;
+  /**
+   * The constructor initializes a VegaCalendarRawEvent object and performs validation checks on required fields.
+   *
+   * @param {VegaCalendarRawEvent} eventOptions - The `eventOptions` parameter in the constructor
+   * represents the raw event data for a Vega calendar event. It contains information such as the event
+   * title, start and end dates, location, description, and any other relevant details about the event.
+   */
+  constructor(eventOptions: VegaCalendarRawEvent);
+  /**
+   * The function returns the raw event data for a VegaCalendar event.
+   *
+   * @returns {VegaCalendarRawEvent} The `get event()` method is returning a `VegaCalendarRawEvent` object, which is stored in the `_event` property.
+   */
+  get event(): VegaCalendarRawEvent;
+  /**
+   * This function returns the key of an event in TypeScript.
+   *
+   * @returns {string} event key
+   */
+  get eventKey(): string;
+  /**
+   * This function returns the title of an event in TypeScript.
+   *
+   * @returns {string} The title of the event.
+   */
+  get title(): string;
+  /**
+   * This function returns the disabled of an event in TypeScript.
+   *
+   * @returns {boolean} The disabled of the event.
+   */
+  get disabled(): boolean;
+  /**
+   * This function returns the variant of an event in TypeScript.
+   *
+   * @returns {VegaCalendarEventVariantType|null} The variant of the event.
+   */
+  get variant(): Nullable<VegaCalendarEventVariantType>;
+  /**
+   * This function returns the color of an event in TypeScript.
+   *
+   * @returns {string|null} The color of the event.
+   */
+  get color(): Nullable<string>;
+  /**
+   * The function isAllDayEvent returns a boolean value indicating whether the event is an all-day event.
+   *
+   * @returns {boolean} The method `isAllDayEvent()` is returning a boolean value indicating whether the event is an all-day event or not. It returns `true` if the event is an all-day event, and `false` if it is not.
+   */
+  get isAllDayEvent(): boolean;
+  /**
+   * The function isRepeatEvent returns a boolean value based on whether the event's repeat property is not equal to 'none'.
+   *
+   * @returns {boolean} The method `isRepeatEvent` returns a boolean value indicating whether the `_event` has a repeat value other than 'none'.
+   */
+  get isRepeatEvent(): boolean;
+  /**
+   * The function returns the start date property of an object.
+   *
+   * @returns {Date} The `startDate` property of type `Date` is being returned.
+   */
+  get startDate(): Date;
+  /**
+   * The function returns the end date property of an object.
+   *
+   * @returns {Date} The `endDate` property of type `Date` is being returned.
+   */
+  get endDate(): Date;
+  /**
+   * This function returns the start time as a string.
+   *
+   * @returns {string} The `_startTime` property, which is a string, is being returned.
+   */
+  get startTime(): string;
+  /**
+   * This function returns the end time as a string.
+   *
+   * @returns {string} The `_endTime` property, which is a string, is being returned.
+   */
+  get endTime(): string;
+  /**
+   * Check the event is a group event or not
+   *
+   * @returns {boolean} true or false
+   */
+  isGroupEvent(): boolean;
+  /**
+   * This TypeScript function checks if a given date falls within the range of a calendar event based on its start and end dates, considering different repeat types like daily, weekly, monthly, and yearly.
+   *
+   * @param {CalendarDate} date - The `date` parameter represents the current date for which you want to
+   * check if it falls within the range of the `calendarEvent`. It is of type `CalendarDate`.
+   * @returns {boolean} a boolean value, either `true` or `false`, based on whether the `calendarEvent` falls on the `date` provided.
+   */
+  isCurrentDayEvent(date: CalendarDate): boolean;
+  /**
+   * Get the number of minutes the event lasted
+   *
+   * @returns {number} the minutes
+   */
+  getEventDuration(): number;
+  /**
+   * The function `convertTimeTo24Hour` converts a time string from 12-hour format to 24-hour format in TypeScript.
+   *
+   * @param {string} timeString - The `convertTimeTo24Hour` function you provided is used to convert a
+   * time string from 12-hour format to 24-hour format. The function checks if the input time string is
+   * in 12-hour format and contains either 'am' or 'pm'.
+   * @returns {string} The `convertTimeTo24Hour` function returns a string representing the input time string
+   * converted to 24-hour format. If the input time string is in 12-hour format and contains 'am' or
+   * 'pm', it converts it to 24-hour format. If the input time string is not in 12-hour format or does
+   * not contain 'am' or 'pm', it returns the original input
+   */
+  private convertTimeTo24Hour;
+  /**
+   * The function `checkEventRequireField` validates the required fields of a calendar event item in TypeScript.
+   *
+   * @param {VegaCalendarRawEvent} eventOptions - The `eventOptions` parameter is an object of type
+   * `VegaCalendarRawEvent` that contains information about a calendar event
+   */
+  private checkEventRequireField;
+  /**
+   * The `initDate` function in TypeScript initializes start and end dates and times for a calendar event based on the provided options.
+   *
+   * @param {VegaCalendarRawEvent} eventOptions - The `initDate` method you provided is used to
+   * initialize the start and end dates for a calendar event based on the options provided in the
+   * `eventOptions` object. The `eventOptions` object contains properties such as `startDate`,
+   * `startTime`, `endDate`, and `endTime` which are used
+   */
+  private initDate;
+}