declare const _default: {}; export default _default; export type ReadingsFerial = { /** * - The first reading Bible reference */ first_reading: string; /** * - The responsorial psalm reference */ responsorial_psalm: string; /** * - The gospel acclamation/alleluia verse reference */ gospel_acclamation: string; /** * - The gospel reading reference */ gospel: string; }; export type ReadingsFestive = { /** * - The first reading Bible reference */ first_reading: string; /** * - The responsorial psalm reference */ responsorial_psalm: string; /** * - The second reading Bible reference */ second_reading: string; /** * - The gospel acclamation/alleluia verse reference */ gospel_acclamation: string; /** * - The gospel reading reference */ gospel: string; }; export type ReadingsPalmSunday = { /** * - The gospel for the blessing of palms */ palm_gospel: string; /** * - The first reading Bible reference */ first_reading: string; /** * - The responsorial psalm reference */ responsorial_psalm: string; /** * - The second reading Bible reference */ second_reading: string; /** * - The gospel acclamation/alleluia verse reference */ gospel_acclamation: string; /** * - The gospel (Passion) reading reference */ gospel: string; }; export type ReadingsEasterVigil = { /** * - First reading */ first_reading: string; /** * - First responsorial psalm */ responsorial_psalm: string; /** * - Second reading */ second_reading: string; /** * - Second responsorial psalm */ responsorial_psalm_2: string; /** * - Third reading */ third_reading: string; /** * - Third responsorial psalm */ responsorial_psalm_3: string; /** * - Fourth reading */ fourth_reading: string; /** * - Fourth responsorial psalm */ responsorial_psalm_4: string; /** * - Fifth reading */ fifth_reading: string; /** * - Fifth responsorial psalm */ responsorial_psalm_5: string; /** * - Sixth reading */ sixth_reading: string; /** * - Sixth responsorial psalm */ responsorial_psalm_6: string; /** * - Seventh reading */ seventh_reading: string; /** * - Seventh responsorial psalm */ responsorial_psalm_7: string; /** * - The epistle reading */ epistle: string; /** * - Responsorial psalm after epistle */ responsorial_psalm_epistle: string; /** * - The gospel acclamation */ gospel_acclamation: string; /** * - The gospel reading reference */ gospel: string; }; export type ReadingsFestiveWithVigil = { /** * - Vigil Mass readings */ vigil: ReadingsFestive; /** * - Day Mass readings */ day: ReadingsFestive; }; export type ReadingsChristmas = { /** * - Vigil Mass readings */ vigil: ReadingsFestive; /** * - Mass during the Night readings */ night: ReadingsFestive; /** * - Mass at Dawn readings */ dawn: ReadingsFestive; /** * - Mass during the Day readings */ day: ReadingsFestive; }; export type ReadingsMultipleSchemas = { /** * - First schema of readings */ schema_one: ReadingsFestive; /** * - Second schema of readings */ schema_two: ReadingsFestive; /** * - Third schema of readings */ schema_three: ReadingsFestive; }; export type ReadingsWithEvening = { /** * - Day Mass readings */ day: ReadingsFestive; /** * - Evening Mass readings */ evening: ReadingsFestive; }; export type ReadingsSeasonal = { /** * - Readings for Easter season */ easter_season: ReadingsFerial; /** * - Readings outside Easter season */ outside_easter_season: ReadingsFerial; }; export type Readings = ReadingsFerial | ReadingsFestive | ReadingsPalmSunday | ReadingsEasterVigil | ReadingsFestiveWithVigil | ReadingsChristmas | ReadingsMultipleSchemas | ReadingsWithEvening | ReadingsSeasonal; 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, either as a Date object or an RFC 3339 (ISO-8601) formatted string `YYYY-MM-DD` */ date: Date | string; /** * - 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 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 cycle (festive A, B, or C; or weekday I or II) of the liturgical event */ liturgical_year?: string | undefined; /** * - 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; /** * - Will have a boolean value of 'true' if the liturgical event is observed as a holy day of obligation */ holy_day_of_obligation?: boolean | undefined; /** * - The type of the liturgical event */ type: ["mobile", "fixed"]; /** * - The lectionary readings for this liturgical event */ readings: Readings; }; export type CalendarSettings = { /** * - The year for which the calendar is calculated */ year: number; /** * - When Epiphany is celebrated */ epiphany: ["JAN6", "SUNDAY_JAN2_JAN8"]; /** * - When the Ascension is celebrated */ ascension: ["THURSDAY", "SUNDAY"]; /** * - 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; /** * - Map of event_key → boolean indicating which liturgical events are observed as holy days of obligation */ holydays_of_obligation?: { [event_key: string]: boolean; } | undefined; /** * - 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