UNPKG

@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

litcal.johnromanodorazio.com

Liturgical-Calendar/liturgy-components-js

151 lines (150 loc) • 10.3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/** * @typedef {Object} ReadingsFerial * @prop {string} first_reading - The first reading Bible reference * @prop {string} responsorial_psalm - The responsorial psalm reference * @prop {string} gospel_acclamation - The gospel acclamation/alleluia verse reference * @prop {string} gospel - The gospel reading reference */ /** * @typedef {Object} ReadingsFestive * @prop {string} first_reading - The first reading Bible reference * @prop {string} responsorial_psalm - The responsorial psalm reference * @prop {string} second_reading - The second reading Bible reference * @prop {string} gospel_acclamation - The gospel acclamation/alleluia verse reference * @prop {string} gospel - The gospel reading reference */ /** * @typedef {Object} ReadingsPalmSunday * @prop {string} palm_gospel - The gospel for the blessing of palms * @prop {string} first_reading - The first reading Bible reference * @prop {string} responsorial_psalm - The responsorial psalm reference * @prop {string} second_reading - The second reading Bible reference * @prop {string} gospel_acclamation - The gospel acclamation/alleluia verse reference * @prop {string} gospel - The gospel (Passion) reading reference */ /** * @typedef {Object} ReadingsEasterVigil * @prop {string} first_reading - First reading * @prop {string} responsorial_psalm - First responsorial psalm * @prop {string} second_reading - Second reading * @prop {string} responsorial_psalm_2 - Second responsorial psalm * @prop {string} third_reading - Third reading * @prop {string} responsorial_psalm_3 - Third responsorial psalm * @prop {string} fourth_reading - Fourth reading * @prop {string} responsorial_psalm_4 - Fourth responsorial psalm * @prop {string} fifth_reading - Fifth reading * @prop {string} responsorial_psalm_5 - Fifth responsorial psalm * @prop {string} sixth_reading - Sixth reading * @prop {string} responsorial_psalm_6 - Sixth responsorial psalm * @prop {string} seventh_reading - Seventh reading * @prop {string} responsorial_psalm_7 - Seventh responsorial psalm * @prop {string} epistle - The epistle reading * @prop {string} responsorial_psalm_epistle - Responsorial psalm after epistle * @prop {string} gospel_acclamation - The gospel acclamation * @prop {string} gospel - The gospel reading reference */ /** * @typedef {Object} ReadingsFestiveWithVigil * @prop {ReadingsFestive} vigil - Vigil Mass readings * @prop {ReadingsFestive} day - Day Mass readings */ /** * @typedef {Object} ReadingsChristmas * @prop {ReadingsFestive} vigil - Vigil Mass readings * @prop {ReadingsFestive} night - Mass during the Night readings * @prop {ReadingsFestive} dawn - Mass at Dawn readings * @prop {ReadingsFestive} day - Mass during the Day readings */ /** * @typedef {Object} ReadingsMultipleSchemas * @prop {ReadingsFestive} schema_one - First schema of readings * @prop {ReadingsFestive} schema_two - Second schema of readings * @prop {ReadingsFestive} schema_three - Third schema of readings */ /** * @typedef {Object} ReadingsWithEvening * @prop {ReadingsFestive} day - Day Mass readings * @prop {ReadingsFestive} evening - Evening Mass readings */ /** * @typedef {Object} ReadingsSeasonal * @prop {ReadingsFerial} easter_season - Readings for Easter season * @prop {ReadingsFerial} outside_easter_season - Readings outside Easter season */ /** * @typedef {ReadingsFerial|ReadingsFestive|ReadingsPalmSunday|ReadingsEasterVigil|ReadingsFestiveWithVigil|ReadingsChristmas|ReadingsMultipleSchemas|ReadingsWithEvening|ReadingsSeasonal} Readings */ /** * @typedef {Object} CalendarEvent * @prop {string} event_key - The "key" or "tag" or "id" of the liturgical event * @prop {int} event_idx - The progressive index, one for each liturgical event * @prop {string} name - The name of the liturgical event according to the requested locale * @prop {Date|string} date - The date of the liturgical event, either as a Date object or an RFC 3339 (ISO-8601) formatted string `YYYY-MM-DD` * @prop {int} month - The month of the liturgical event * @prop {string} month_long - The month of the liturgical event in the requested locale * @prop {string} month_short - The month of the liturgical event in the requested locale * @prop {int} day - The day of the liturgical event * @prop {string} day_of_the_week_iso8601 - The day of the liturgical event according to the ISO 8601 standard * @prop {string} day_of_the_week_long - The day of the liturgical event in the requested locale * @prop {string} day_of_the_week_short - The day of the liturgical event in the requested locale * @prop {int} grade - The liturgical grade of the liturgical event * @prop {string[]} common - An array of the liturgical commons of the liturgical event * @prop {string} common_lcl - The liturgical commons of the liturgical event in the requested locale * @prop {string[]} color - An array of the liturgical colors of the liturgical event * @prop {string[]} color_lcl - The liturgical colors of the liturgical event in the requested locale * @prop {string} grade_lcl - The liturgical grade of the liturgical event in the requested locale * @prop {string | null} grade_display - The liturgical grade of the liturgical event as it should be displayed * @prop {string} grade_abbr - The abbreviated form of the liturgical grade * @prop {string} liturgical_season - The liturgical season of the liturgical event * @prop {string} liturgical_season_lcl - The liturgical season of the liturgical event in the requested locale * @prop {string} [liturgical_year] - The liturgical cycle (festive A, B, or C; or weekday I or II) of the liturgical event * @prop {string} [is_vigil_for] - The liturgical event for which the current event is a Vigil Mass * @prop {boolean} [is_vigil_mass] - Will have a boolean value of 'true' if the event is a Vigil Mass for a Solemnity or Sunday * @prop {boolean} [has_vesper_i] - Will have a boolean value of 'true' if the expected First Vespers are confirmed * @prop {boolean} [has_vesper_ii] - Will have a boolean value of 'true' if the expected Second Vespers are confirmed * @prop {boolean} [has_vigil_mass] - Will have a boolean value of 'true' if the expected Vigil Mass is confirmed * @prop {string} [psalter_week] - The psalter week in which the liturgical event falls * @prop {boolean} [holy_day_of_obligation] - Will have a boolean value of 'true' if the liturgical event is observed as a holy day of obligation * @prop {['mobile', 'fixed']} type - The type of the liturgical event * @prop {Readings} readings - The lectionary readings for this liturgical event */ /** * @typedef {Object} CalendarSettings * @prop {number} year - The year for which the calendar is calculated * @prop {['JAN6', 'SUNDAY_JAN2_JAN8']} epiphany - When Epiphany is celebrated * @prop {['THURSDAY', 'SUNDAY']} ascension - When the Ascension is celebrated * @prop {['THURSDAY', 'SUNDAY']} corpus_christi - When Corpus Christi is celebrated * @prop {string} locale - The locale for the calendar * @prop {['JSON', 'XML', 'YML', 'ICS']} return_type - The type of the response data * @prop {['LITURGICAL', 'CIVIL']} year_type - The type of the year whether it is liturgical or civil * @prop {boolean} eternal_high_priest - Whether the feast of the Eternal High Priest is celebrated * @prop {{ [event_key: string]: boolean }} [holydays_of_obligation] - Map of event_key → boolean indicating which liturgical events are observed as holy days of obligation * @prop {string} [national_calendar] - The national calendar used for the calculation * @prop {string} [diocesan_calendar] - The diocesan calendar used for the calculation */ /** * @typedef {Object} CalendarMetadata * @prop {string} version - The version of the API * @prop {int} timestamp - The timestamp for when the API response was generated / cached * @prop {string} date_time - The ISO-8601 formatted date and time for when the API response was generated / cached * @prop {{Accept: string, 'Accept-Language': string}} request_headers - The headers received in the request * @prop {{event_key: string, date: string, timezone_type: number, timezone: string}[]} solemnities - An array of solemnities keys and dates in the current calendar calculation * @prop {string[]} solemnities_keys - An array of solemnities keys in the current calendar calculation * @prop {{event_key: string, date: string, timezone_type: number, timezone: string}[]} feasts - An array of feasts keys and dates in the current calendar calculation * @prop {string[]} feasts_keys - An array of feasts keys in the current calendar calculation * @prop {{event_key: string, date: string, timezone_type: number, timezone: string}[]} memorials - An array of memorials keys and dates in the current calendar calculation * @prop {string[]} memorials_keys - An array of memorials keys in the current calendar calculation * @prop {{event_key: string, date: string, timezone_type: number, timezone: string}[]} suppressed_events - An array of liturgical events with their keys and dates that were suppressed in the current calendar calculation * @prop {string[]} suppressed_events_keys - An array of liturgical events keys that were suppressed in the current calendar calculation * @prop {{event_key: string, date: string, timezone_type: number, timezone: string}[]} reinstated_events - 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) * @prop {string[]} reinstated_events_keys - 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) * @prop {string} [diocese_name] - The name of the diocese for which the calendar was calculated */ /** * @typedef {Object} Counter * @prop {number} cm - The count of the liturgical events within the same month * @prop {number} cs - The count of the liturgical events within the same season * @prop {number} cw - The count of the liturgical events within the same week * @prop {number} cd - The count of the liturgical events within the same day */ export default {};