@globalpayments/vega 2.13.1 → 2.14.0

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;
+}

package/dist/types/helpers/calendar/calendar-period/calendar-period.abstract.d.ts

@@ -0,0 +1,73 @@
+import { CalendarDate } from '../calendar-date';
+/**
+ * CalendarPeriod is an abstract class that represents a period of date for calendar.
+ */
+export declare abstract class CalendarPeriod {
+  private readonly _current;
+  private _startDate;
+  private _endDate;
+  private readonly _count;
+  protected constructor(count: number, current: CalendarDate);
+  /**
+   * The current date of the period.
+   *
+   * @type {CalendarDate}
+   */
+  get current(): CalendarDate;
+  /**
+   * The start date of the period
+   *
+   * @type {CalendarDate}
+   */
+  get startDate(): CalendarDate;
+  /**
+   * The end date of the period
+   *
+   * @type {CalendarDate}
+   */
+  get endDate(): CalendarDate;
+  /**
+   * The count of the period
+   *
+   * @type {number}
+   */
+  get count(): number;
+  /**
+   * Go to a specific date.
+   *
+   * @param {CalendarDate} date - The date to go to.
+   * @returns {this} - The current period.
+   */
+  goTo(date: CalendarDate): this;
+  /**
+   * Go to now.
+   *
+   * @returns {this} - The current period.
+   */
+  now(): this;
+  /**
+   * Calculate the period start date and end date.
+   *
+   * @param {CalendarDate} date - The date to calculate the period from.
+   */
+  protected calculatePeriod(date: CalendarDate): void;
+  /**
+   * Set the current period to the next.
+   *
+   * @returns {this} - The updated period
+   */
+  abstract next(): this;
+  /**
+   * Set the current period to the previous.
+   *
+   * @returns {this} - The updated period
+   */
+  abstract previous(): this;
+  /**
+   * Create a new period by the given date.
+   *
+   * @param {CalendarDate} current - The date to create the period from.
+   * @returns {this} - The new period.
+   */
+  protected abstract createBy(current: CalendarDate): this;
+}

package/dist/types/helpers/calendar/calendar-period/day-period.d.ts

@@ -0,0 +1,21 @@
+import { CalendarPeriod } from './calendar-period.abstract';
+import { CalendarDate } from '../calendar-date';
+/**
+ * Period of day.
+ */
+export declare class DayPeriod extends CalendarPeriod {
+  private static readonly DISPLAY_DATE_COUNT;
+  constructor(current?: CalendarDate);
+  /**
+   * @inheritDoc
+   */
+  next(): this;
+  /**
+   * @inheritDoc
+   */
+  previous(): this;
+  /**
+   * @inheritDoc
+   */
+  protected createBy(current: CalendarDate): this;
+}

package/dist/types/helpers/calendar/calendar-period/month-period.d.ts

@@ -0,0 +1,21 @@
+import { CalendarPeriod } from './calendar-period.abstract';
+import { CalendarDate } from '../calendar-date';
+/**
+ * Period of month
+ */
+export declare class MonthPeriod extends CalendarPeriod {
+  private static readonly DISPLAY_DATE_COUNT;
+  constructor(current?: CalendarDate);
+  /**
+   * @inheritDoc
+   */
+  next(): this;
+  /**
+   * @inheritDoc
+   */
+  previous(): this;
+  /**
+   * @inheritDoc
+   */
+  protected createBy(current: CalendarDate): this;
+}

package/dist/types/helpers/calendar/calendar-period/week-period.d.ts

@@ -0,0 +1,21 @@
+import { CalendarPeriod } from './calendar-period.abstract';
+import { CalendarDate } from '../calendar-date';
+/**
+ * Period of the week
+ */
+export declare class WeekPeriod extends CalendarPeriod {
+  private static readonly DISPLAY_DATE_COUNT;
+  constructor(current?: CalendarDate);
+  /**
+   * @inheritDoc
+   */
+  next(): this;
+  /**
+   * @inheritDoc
+   */
+  previous(): this;
+  /**
+   * @inheritDoc
+   */
+  protected createBy(current: CalendarDate): this;
+}

package/dist/types/helpers/calendar/calendar-view-generator/calendar-view-generator.abstract.d.ts

@@ -0,0 +1,35 @@
+import { CalendarPeriod } from '../calendar-period/calendar-period.abstract';
+import { CalendarView } from '../calendar-view';
+/**
+ * Calendar view generator abstract class.
+ */
+export declare abstract class CalendarViewGenerator {
+  protected weekdays: number[];
+  private readonly WEEKDAYS_SHORT;
+  constructor();
+  /**
+   * Get weekday names.
+   *
+   * @returns {string[]} - The weekday strings
+   */
+  protected getWeekdayNames(): string[];
+  /**
+   * Generate calendar dates
+   *
+   * @param {CalendarPeriod} period - The calendar period
+   * @returns {Date[]} - The date result
+   */
+  protected generateDates(period: CalendarPeriod): Date[];
+  /**
+   * Generate calendar head
+   *
+   * @returns {string[]} - The data of week head
+   */
+  protected generateWeekHead(): string[];
+  /**
+   * Generate calendar view data.
+   *
+   * @param {CalendarPeriod} calendarPeriod - The calendar period
+   */
+  abstract generate(calendarPeriod: CalendarPeriod): CalendarView;
+}

package/dist/types/helpers/calendar/calendar-view-generator/day-view-generator.d.ts

@@ -0,0 +1,12 @@
+import { CalendarViewGenerator } from './calendar-view-generator.abstract';
+import { CalendarView } from '../calendar-view';
+import { DayPeriod } from '../calendar-period/day-period';
+/**
+ * Day view calendar generator
+ */
+export declare class DayViewGenerator extends CalendarViewGenerator {
+  /**
+   * @inheritDoc
+   */
+  generate(period: DayPeriod): CalendarView;
+}

package/dist/types/helpers/calendar/calendar-view-generator/month-view-generator.d.ts

@@ -0,0 +1,12 @@
+import { CalendarViewGenerator } from './calendar-view-generator.abstract';
+import { CalendarView } from '../calendar-view';
+import { MonthPeriod } from '../calendar-period/month-period';
+/**
+ * Calendar month view generator
+ */
+export declare class MonthViewGenerator extends CalendarViewGenerator {
+  /**
+   * @inheritDoc
+   */
+  generate(period: MonthPeriod): CalendarView;
+}

package/dist/types/helpers/calendar/calendar-view-generator/week-view-generator.d.ts

@@ -0,0 +1,12 @@
+import { CalendarViewGenerator } from './calendar-view-generator.abstract';
+import { CalendarView } from '../calendar-view';
+import { WeekPeriod } from '../calendar-period/week-period';
+/**
+ * Calendar week view generator
+ */
+export declare class WeekViewGenerator extends CalendarViewGenerator {
+  /**
+   * @inheritDoc
+   */
+  generate(period: WeekPeriod): CalendarView;
+}

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

@@ -0,0 +1,21 @@
+import { CalendarDate } from './calendar-date';
+/**
+ * Calendar view
+ */
+export declare class CalendarView {
+  private readonly _weekdays;
+  private readonly _dateItems;
+  constructor(weekdays: string[], dateItems: CalendarDate[][]);
+  /**
+   * The week head of the calendar view
+   *
+   * @type {string[]}
+   */
+  get weekdays(): string[];
+  /**
+   * The date items of the calendar view
+   *
+   * @type {CalendarDate[][]}
+   */
+  get dateItems(): CalendarDate[][];
+}

package/dist/types/helpers/calendar/index.d.ts

@@ -0,0 +1,10 @@
+export { CalendarViewGenerator } from './calendar-view-generator/calendar-view-generator.abstract';
+export { DayViewGenerator } from './calendar-view-generator/day-view-generator';
+export { WeekViewGenerator } from './calendar-view-generator/week-view-generator';
+export { MonthViewGenerator } from './calendar-view-generator/month-view-generator';
+export { CalendarPeriod } from './calendar-period/calendar-period.abstract';
+export { DayPeriod } from './calendar-period/day-period';
+export { WeekPeriod } from './calendar-period/week-period';
+export { MonthPeriod } from './calendar-period/month-period';
+export { CalendarDate } from './calendar-date';
+export { CalendarView } from './calendar-view';

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-period/day-period.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-period/month-period.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-period/week-period.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-view-generator/day-view-generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-view-generator/month-view-generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-view-generator/week-view-generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/calendar-view.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/test/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers/calendar/utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get a week days array
+ *
+ * @param {number} firstWeekDay - The first week day (0: Sunday, 1: Monday, ...)
+ * @returns {number[]} - The week days array
+ */
+export declare const getWeekdays: (firstWeekDay?: number) => number[];

package/dist/types/helpers/event-manager/eventID/vegaEventId.d.ts

@@ -77,4 +77,6 @@ export declare const VegaDropdownShow: VegaEventID;
 export declare const VegaDropdownHide: VegaEventID;
 export declare const VegaDropdownSearch: VegaEventID;
 export declare const VegaActionClick: VegaEventID;
+export declare const VegaEventClick: VegaEventID;
+export declare const VegaDateClick: VegaEventID;
 export declare const HTMLNativeEventIds: VegaEventID[];

package/dist/types/helpers/event-manager/eventID/vegaInternalEventId.d.ts

@@ -22,3 +22,4 @@ export declare const VegaInternalButtonGroupClick: VegaInternalEventID;
 export declare const VegaInternalLeftNavLinkClick: VegaInternalEventID;
 export declare const VegaInternalSubStatePull: VegaInternalEventID;
 export declare const VegaInternalSubStatePush: VegaInternalEventID;
+export declare const VegaInternalCalendarMonthEventsChange: VegaInternalEventID;

package/dist/types/types/components.type.d.ts

@@ -91,6 +91,14 @@ export {
 	DropdownSourceItem,
 	VegaDropdownSourceItem,
 } from '../components/vega-dropdown/types';
+export {
+	VegaCalendarChangeEventType,
+	VegaCalendarEventClickInfo,
+	VegaCalendarRawEvent,
+	VegaCalendarViewModeType,
+} from '../components/vega-calendar/types';
+export { Nullable, TimeFormat } from '../types/general';
+export { CalendarEvent } from '../helpers/calendar/calendar-event';
 export { FormFieldValidationRule } from '../helpers/validator/rules/formFieldValidationRule';
 export {
 	VegaChipIconAlign,
@@ -110,7 +118,6 @@ export { VegaDropdownItemClickEvent } from '../components/vega-dropdown/vega-dro
 export { VegaFontAs } from '../components/vega-font/types';
 export { FormControlOption, FormValidateResult } from '../components/vega-form/types';
 export { VegaFile, VegaFileOptional, VegaImageUploaderStatus } from '../components/vega-image-uploader/types';
-export { Nullable, TimeFormat } from '../types/general';
 export { MaskConfigType } from '../components/vega-input/types';
 export { InputRangeStackType, InputRangeValueType } from '../components/vega-input-range/types';
 export {

package/dist/vega/index.esm.js

@@ -1 +1 @@
-export{B as Breakpoints,g as getCurrentBreakpoint}from"./p-3542f8fe.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-018d77cc.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-91160d38.js";export{c as camelToDashCase}from"./p-0bb29d98.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-d361ef78.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{a as Typography,b as TypographyKeys,T as TypographyUrls}from"./p-c59042c0.js";export{B as BreakpointKeys}from"./p-3c8b2105.js";export{F as FrameworkEnum,v as VegaEnvManager,c as VegaEventManager,V as VegaLoader,a as VegaNotify,b as VegaThemeManager,w as waitForVega}from"./p-7653f0c2.js";export{F as FeatureFlag}from"./p-629acb2e.js";export{V as VegaDialog}from"./p-34964cc9.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-1fe9e4b3.js";export{V as VegaIconManager}from"./p-9d426517.js";export{V as ValidCreditCardNumberRule}from"./p-8054bb18.js";import"./p-eb6c9578.js";import"./p-344ee7cb.js";import"./p-3a0a4d15.js";import"./p-469bc36e.js";import"./p-320642bd.js";import"./p-abf5b8f7.js";import"./p-d3f1d3dd.js";import"./p-cb13b4e6.js";import"./p-112455b1.js";import"./p-ac23cfa6.js";import"./p-9e70473b.js";const o=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{o as Rings}
+export{B as Breakpoints,g as getCurrentBreakpoint}from"./p-3542f8fe.js";export{L as LogUtility,s as setVegaLogLevel}from"./p-018d77cc.js";export{d as formatAndValidBackgroundColor,e as formatAndValidBorderColor,g as formatAndValidBorderRadius,c as formatAndValidBreakpointSize,a as formatAndValidGap,h as formatAndValidPadding,f as formatAndValidResponsiveToken,b as formatAndValidShadow,i as formatAndValidTextColor}from"./p-e4d466f0.js";export{c as camelToDashCase}from"./p-0bb29d98.js";export{d as BackgroundColorMap,a as BackgroundColors,e as BorderColorMap,b as BorderColors,B as BorderRadius,C as Colors,F as FillBackgroundColors,g as ShadowMap,f as Shadows,h as Spacing,S as StrokeBackgroundColors,c as TextColorMap,T as TextColors}from"./p-1265732f.js";export{I as Icons,g as getIconFromToken}from"./p-16493e5b.js";export{a as Typography,b as TypographyKeys,T as TypographyUrls}from"./p-c59042c0.js";export{B as BreakpointKeys}from"./p-3c8b2105.js";export{F as FrameworkEnum,v as VegaEnvManager,c as VegaEventManager,V as VegaLoader,a as VegaNotify,b as VegaThemeManager,w as waitForVega}from"./p-99c8fe92.js";export{F as FeatureFlag}from"./p-f2118771.js";export{V as VegaDialog}from"./p-34964cc9.js";export{B as VegaJQueryDelegatedEventStrategy}from"./p-aae8855d.js";export{V as VegaIconManager}from"./p-9d426517.js";export{V as ValidCreditCardNumberRule}from"./p-8054bb18.js";import"./p-fc21bd44.js";import"./p-344ee7cb.js";import"./p-6bdc4407.js";import"./p-3a0a4d15.js";import"./p-469bc36e.js";import"./p-320642bd.js";import"./p-abf5b8f7.js";import"./p-d3f1d3dd.js";import"./p-cb13b4e6.js";import"./p-112455b1.js";import"./p-61f18887.js";import"./p-f1d8fd1c.js";const o=["ring-input-focus","dark-ring-input-focus","ring-input-danger-focus","dark-ring-input-danger-focus","ring-action-focus","dark-ring-action-focus","ring-action-danger-focus","dark-ring-action-danger-focus"];export{o as Rings}