@liturgical-calendar/components-js
Version:
Liturgical calendar components for javascript: an html select populated with liturgical calendars supported by the Liturgical Calendar API; form controls for parameters that are supported by the Liturgical Calendar API; a webcalendar; and liturgy of the d
268 lines • 7.64 kB
TypeScript
declare const _default: {};
export default _default;
export type CalendarEvent = {
/**
* - The "key" or "tag" or "id" of the liturgical event
*/
event_key: string;
/**
* - The progressive index, one for each liturgical event
*/
event_idx: int;
/**
* - The name of the liturgical event according to the requested locale
*/
name: string;
/**
* - The date of the liturgical event
*/
date: Date | int;
/**
* - The month of the liturgical event
*/
month: int;
/**
* - The month of the liturgical event in the requested locale
*/
month_long: string;
/**
* - The month of the liturgical event in the requested locale
*/
month_short: string;
/**
* - The day of the liturgical event
*/
day: int;
/**
* - The day of the liturgical event according to the ISO 8601 standard
*/
day_of_the_week_iso8601: string;
/**
* - The day of the liturgical event in the requested locale
*/
day_of_the_week_long: string;
/**
* - The day of the liturgical event in the requested locale
*/
day_of_the_week_short: string;
/**
* - The liturgical grade of the liturgical event
*/
grade: int;
/**
* - An array of the liturgical commons of the liturgical event
*/
common: string[];
/**
* - The liturgical commons of the liturgical event in the requested locale
*/
common_lcl: string;
/**
* - An array of the liturgical colors of the liturgical event
*/
color: string[];
/**
* - The liturgical colors of the liturgical event in the requested locale
*/
color_lcl: string[];
/**
* - The liturgical grade of the liturgical event in the requested locale
*/
grade_lcl: string;
/**
* - The liturgical grade of the liturgical event as it should be displayed
*/
grade_display: string | null;
/**
* - The abbreviated form of the liturgical grade
*/
grade_abbr: string;
/**
* - The liturgical cycle (festive A, B, or C; or weekday I or II) of the liturgical event
*/
liturgical_year?: string | undefined;
/**
* - The liturgical season of the liturgical event
*/
liturgical_season: string;
/**
* - The liturgical season of the liturgical event in the requested locale
*/
liturgical_season_lcl: string;
/**
* - The liturgical event for which the current event is a Vigil Mass
*/
is_vigil_for?: string | undefined;
/**
* - Will have a boolean value of 'true' if the event is a Vigil Mass for a Solemnity or Sunday
*/
is_vigil_mass?: boolean | undefined;
/**
* - Will have a boolean value of 'true' if the expected First Vespers are confirmed
*/
has_vesper_i?: boolean | undefined;
/**
* - Will have a boolean value of 'true' if the expected Second Vespers are confirmed
*/
has_vesper_ii?: boolean | undefined;
/**
* - Will have a boolean value of 'true' if the expected Vigil Mass is confirmed
*/
has_vigil_mass?: boolean | undefined;
/**
* - The psalter week in which the liturgical event falls
*/
psalter_week?: string | undefined;
/**
* - The type of the liturgical event
*/
type: ["mobile", "fixed"];
};
export type CalendarSettings = {
/**
* - The year for which the calendar is calculated
*/
year: number;
/**
* - When Epiphany is celebrated
*/
epiphany: ["JAN6", "SUNDAY_JAN2_JAN8"];
"": ["THURSDAY", "SUNDAY\"]} ascension - When the Ascension is celebrated"];
/**
* - When Corpus Christi is celebrated
*/
corpus_christi: ["THURSDAY", "SUNDAY"];
/**
* - The locale for the calendar
*/
locale: string;
/**
* - The type of the response data
*/
return_type: ["JSON", "XML", "YML", "ICS"];
/**
* - The type of the year whether it is liturgical or civil
*/
year_type: ["LITURGICAL", "CIVIL"];
/**
* - Whether the feast of the Eternal High Priest is celebrated
*/
eternal_high_priest: boolean;
/**
* - The national calendar used for the calculation
*/
national_calendar?: string | undefined;
/**
* - The diocesan calendar used for the calculation
*/
diocesan_calendar?: string | undefined;
};
export type CalendarMetadata = {
/**
* - The version of the API
*/
version: string;
/**
* - The timestamp for when the API response was generated / cached
*/
timestamp: int;
/**
* - The ISO-8601 formatted date and time for when the API response was generated / cached
*/
date_time: string;
/**
* - The headers received in the request
*/
request_headers: {
Accept: string;
"Accept-Language": string;
};
/**
* - An array of solemnities keys and dates in the current calendar calculation
*/
solemnities: {
event_key: string;
date: string;
timezone_type: number;
timezone: string;
}[];
/**
* - An array of solemnities keys in the current calendar calculation
*/
solemnities_keys: string[];
/**
* - An array of feasts keys and dates in the current calendar calculation
*/
feasts: {
event_key: string;
date: string;
timezone_type: number;
timezone: string;
}[];
/**
* - An array of feasts keys in the current calendar calculation
*/
feasts_keys: string[];
/**
* - An array of memorials keys and dates in the current calendar calculation
*/
memorials: {
event_key: string;
date: string;
timezone_type: number;
timezone: string;
}[];
/**
* - An array of memorials keys in the current calendar calculation
*/
memorials_keys: string[];
/**
* - An array of liturgical events with their keys and dates that were suppressed in the current calendar calculation
*/
suppressed_events: {
event_key: string;
date: string;
timezone_type: number;
timezone: string;
}[];
/**
* - An array of liturgical events keys that were suppressed in the current calendar calculation
*/
suppressed_events_keys: string[];
/**
* - An array of liturgical events with their keys and dates that are having been suppressed were reinstated for whatever reason in the current calendar calculation (usually because of a transferral defined in a national calendar)
*/
reinstated_events: {
event_key: string;
date: string;
timezone_type: number;
timezone: string;
}[];
/**
* - An array of liturgical events keys that are having been suppressed were reinstated for whatever reason in the current calendar calculation (usually because of a transferral defined in a national calendar)
*/
reinstated_events_keys: string[];
/**
* - The name of the diocese for which the calendar was calculated
*/
diocese_name?: string | undefined;
};
export type Counter = {
/**
* - The count of the liturgical events within the same month
*/
cm: number;
/**
* - The count of the liturgical events within the same season
*/
cs: number;
/**
* - The count of the liturgical events within the same week
*/
cw: number;
/**
* - The count of the liturgical events within the same day
*/
cd: number;
};
//# sourceMappingURL=typedefs.d.ts.map