@hebcal/rest-api 7.0.0 → 7.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,17 +3,32 @@ import { TachanunResult } from '@hebcal/core/dist/esm/tachanun';
3
3
  import { StringMap } from '@hebcal/leyning/dist/esm/types';
4
4
  import { RestApiOptions } from './common.js';
5
5
  import type { LocationPlainObj } from './location.js';
6
+ /**
7
+ * A single event as rendered for the classic Hebcal.com JSON API, as
8
+ * produced by `eventToClassicApiObject()`
9
+ */
6
10
  export type ClassicApiItem = {
11
+ /** rendered event title, e.g. `'Rosh Hashana'` or `'Candle lighting: 7:14pm'` */
7
12
  title: string;
13
+ /** ISO 8601 date (or date+time, for timed events) */
8
14
  date: string;
15
+ /** Hebrew date rendered as a string, omitted for timed events */
9
16
  hdate?: string;
17
+ /** category, e.g. `'holiday'`, `'roshchodesh'`, `'candles'` (see `getEventCategories()`) */
10
18
  category: string;
19
+ /** subcategory, e.g. `'major'`, `'minor'` */
11
20
  subcat?: string;
21
+ /** `true` if this is a Yom Tov holiday */
12
22
  yomtov?: boolean;
23
+ /** original (non-brief) event description, present when it differs from `title` */
13
24
  title_orig?: string;
25
+ /** Hebrew rendering of the title (`he-x-NoNikud` locale, no vowel points) */
14
26
  hebrew?: string;
27
+ /** Torah/Haftarah readings, when applicable */
15
28
  leyning?: StringMap;
29
+ /** URL with tracking parameters appended, for events that have one (see `appendIsraelAndTracking()`) */
16
30
  link?: string;
31
+ /** Sefirat HaOmer count details, present only for Omer-count events */
17
32
  omer?: {
18
33
  count: {
19
34
  he: string;
@@ -28,6 +43,7 @@ export type ClassicApiItem = {
28
43
  lamnatzeachWord: string;
29
44
  lamnatzeachLetter: string;
30
45
  };
46
+ /** Molad (new moon) details, present only for Molad announcement events */
31
47
  molad?: {
32
48
  hy: number;
33
49
  hm: string;
@@ -37,32 +53,67 @@ export type ClassicApiItem = {
37
53
  chalakim: number;
38
54
  instant: string;
39
55
  };
56
+ /**
57
+ * Hebrew date broken into gematriya-rendered parts, present when
58
+ * `RestApiEventOptions.heDateParts` is set (or the event itself is a
59
+ * Hebrew-date event)
60
+ */
40
61
  heDateParts?: {
41
62
  y: string;
42
63
  m: string;
43
64
  d: string;
44
65
  };
66
+ /** holiday description or linked-event text, when available */
45
67
  memo?: string;
68
+ /** the underlying `Event` object, present only when `RestApiEventOptions.includeEvent` is set */
46
69
  ev?: Event;
47
70
  };
71
+ /**
72
+ * The classic Hebcal.com JSON API response envelope, as produced by
73
+ * `eventsToClassicApiHeader()` and `eventsToClassicApi()`
74
+ */
48
75
  export type ClassicApiResult = {
76
+ /** calendar title, see `getCalendarTitle()` */
49
77
  title: string;
78
+ /** ISO 8601 timestamp of when this response was generated */
50
79
  date: string;
80
+ /** `@hebcal/core` package version */
51
81
  version: string;
52
82
  location: LocationPlainObj;
83
+ /** whether Tachanun is recited, present when `RestApiEventOptions.tachanun` is set and the range is a single day */
53
84
  tachanun?: TachanunResult;
85
+ /** ISO 8601 start/end dates spanned by `items` */
54
86
  range?: {
55
87
  start: string;
56
88
  end: string;
57
89
  };
90
+ /** the events, present when generated via `eventsToClassicApi()` */
58
91
  items?: ClassicApiItem[];
59
92
  };
60
93
  /**
61
- * Formats a list events for the classic Hebcal.com JSON API response
94
+ * Formats a list of events for the classic Hebcal.com JSON API response,
95
+ * including both the header fields and the `items` array.
96
+ * @param events - the events to render
97
+ * @param options - controls title, location, tracking, and per-item rendering
98
+ * @param leyning - `false` to omit Torah/Haftarah readings from each item
99
+ * @returns the full classic API response object
62
100
  */
63
101
  export declare function eventsToClassicApi(events: Event[], options: RestApiOptions, leyning?: boolean): ClassicApiResult;
102
+ /**
103
+ * Builds just the header fields (title, date, version, location, range,
104
+ * tachanun) of the classic Hebcal.com JSON API response, without the
105
+ * `items` array.
106
+ * @param events - the events used to determine title and date range
107
+ * @param options - controls title, location, and tachanun rendering
108
+ * @returns the classic API response object, without `items`
109
+ */
64
110
  export declare function eventsToClassicApiHeader(events: Event[], options: RestApiOptions): ClassicApiResult;
65
111
  /**
66
- * Converts a Hebcal event to a classic Hebcal.com JSON API object
112
+ * Converts a single Hebcal event to a classic Hebcal.com JSON API object
113
+ * @param ev - the event to convert
114
+ * @param options - controls locale, tracking parameters, and which optional
115
+ * fields (`heDateParts`, `ev`) are included
116
+ * @param leyning - `false` to omit Torah/Haftarah readings
117
+ * @returns the rendered API item
67
118
  */
68
119
  export declare function eventToClassicApiObject(ev: Event, options: RestApiOptions, leyning?: boolean): ClassicApiItem;
@@ -18,13 +18,26 @@ function eventIsoDate(ev) {
18
18
  return isoDateString(ev.greg());
19
19
  }
20
20
  /**
21
- * Formats a list events for the classic Hebcal.com JSON API response
21
+ * Formats a list of events for the classic Hebcal.com JSON API response,
22
+ * including both the header fields and the `items` array.
23
+ * @param events - the events to render
24
+ * @param options - controls title, location, tracking, and per-item rendering
25
+ * @param leyning - `false` to omit Torah/Haftarah readings from each item
26
+ * @returns the full classic API response object
22
27
  */
23
28
  export function eventsToClassicApi(events, options, leyning = true) {
24
29
  const result = eventsToClassicApiHeader(events, options);
25
30
  result.items = events.map(ev => eventToClassicApiObject(ev, options, leyning));
26
31
  return result;
27
32
  }
33
+ /**
34
+ * Builds just the header fields (title, date, version, location, range,
35
+ * tachanun) of the classic Hebcal.com JSON API response, without the
36
+ * `items` array.
37
+ * @param events - the events used to determine title and date range
38
+ * @param options - controls title, location, and tachanun rendering
39
+ * @returns the classic API response object, without `items`
40
+ */
28
41
  export function eventsToClassicApiHeader(events, options) {
29
42
  const result = {
30
43
  title: getCalendarTitle(events, options),
@@ -44,7 +57,12 @@ export function eventsToClassicApiHeader(events, options) {
44
57
  return result;
45
58
  }
46
59
  /**
47
- * Converts a Hebcal event to a classic Hebcal.com JSON API object
60
+ * Converts a single Hebcal event to a classic Hebcal.com JSON API object
61
+ * @param ev - the event to convert
62
+ * @param options - controls locale, tracking parameters, and which optional
63
+ * fields (`heDateParts`, `ev`) are included
64
+ * @param leyning - `false` to omit Torah/Haftarah readings
65
+ * @returns the rendered API item
48
66
  */
49
67
  export function eventToClassicApiObject(ev, options, leyning = true) {
50
68
  const timedEv = ev;
@@ -1 +1 @@
1
- {"version":3,"file":"classic-rest-api.js","sourceRoot":"","sources":["../../src/classic-rest-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,SAAS,EAAE,aAAa,EAAC,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAC,MAAM,EAAC,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAC,OAAO,EAAC,MAAM,kCAAkC,CAAC;AACzD,OAAO,EAAC,MAAM,EAAC,MAAM,8BAA8B,CAAC;AAKpD,OAAO,EAAC,eAAe,EAAC,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAC,QAAQ,EAAC,MAAM,gCAAgC,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAC,2BAA2B,EAAC,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EAAC,oBAAoB,EAAC,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAC,oBAAoB,EAAC,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAEL,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,uBAAuB,EAAC,MAAM,UAAU,CAAC;AACjD,OAAO,EAAC,kBAAkB,EAAC,MAAM,eAAe,CAAC;AAEjD,OAAO,EAAC,qBAAqB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAC,WAAW,IAAI,KAAK,EAAC,MAAM,sCAAsC,CAAC;AA0D1E,SAAS,YAAY,CAAC,EAAS;IAC7B,OAAO,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAe,EACf,OAAuB,EACvB,OAAO,GAAG,IAAI;IAEd,MAAM,MAAM,GAAG,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAC7B,uBAAuB,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAC9C,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,MAAe,EACf,OAAuB;IAEvB,MAAM,MAAM,GAAqB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC;QACxC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAC9B,OAAO;QACP,QAAQ,EAAE,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC;KAC/C,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,GAAG;YACb,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9B,GAAG,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SAC7C,CAAC;QACF,IAAI,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YAChE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,EAAS,EACT,OAAuB,EACvB,OAAO,GAAG,IAAI;IAEd,MAAM,OAAO,GAAG,EAAgB,CAAC;IACjC,MAAM,SAAS,GAAS,OAAO,CAAC,SAAS,CAAC;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IACxB,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;IACrB,MAAM,IAAI,GACR,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5E,MAAM,IAAI,GAAG,KAAK;QAChB,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,SAAS,CAAC;QAC/C,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACtB,MAAM,UAAU,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC3B,IAAI,KAAK,GAAG,iBAAiB,CAAC,EAAE,CAAC;QAC/B,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IAC1B,MAAM,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,KAAK,KAAK,CAAC,eAAe,CAAC;IAC1E,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAClE,KAAK,IAAI,IAAI,GAAG,IAAI,CAAC;IACvB,CAAC;IACD,MAAM,MAAM,GAA4B;QACtC,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;KACX,CAAC;IACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;IACD,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAChC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QACrD,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAC3B,CAAC;IACD,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,KAAK,KAAK,CAAC,eAAe,CAAC;YAChD,MAAM,OAAO,GAAG,QAAQ;gBACtB,CAAC,CAAC,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC;gBACrC,CAAC,CAAC,oBAAoB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACjC,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QACD,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;QACrB,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YAClC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBAChC,SAAS,GAAG,IAAI,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;YAC7C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACxC,MAAM,CAAC,IAAI,GAAG,uBAAuB,CACnC,GAAG,EACH,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EACnB,SAAS,EACT,SAAS,EACT,WAAW,CACZ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,IAAI,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,EAAe,CAAC;QAC/B,MAAM,CAAC,IAAI,GAAG;YACZ,KAAK,EAAE;gBACL,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC3B,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;aAC5B;YACD,MAAM,EAAE;gBACN,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBACnC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;aACxB;YACD,cAAc,EAAE,MAAM,CAAC,iBAAiB,EAAE;YAC1C,eAAe,EAAE,MAAM,CAAC,kBAAkB,EAAE;YAC5C,iBAAiB,EAAE,MAAM,CAAC,oBAAoB,EAAE;SACjD,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,EAAgB,CAAC;QACjC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;QACxB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;QACvB,MAAM,CAAC,KAAK,GAAG;YACb,EAAE;YACF,EAAE,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACxC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;YACf,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;YACjB,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE;YACvB,QAAQ,EAAE,CAAC,CAAC,WAAW,EAAE;YACzB,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE;SAC7C,CAAC;QACF,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAChE,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC;QAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,CAAC,WAAW,GAAG;YACnB,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;YAChB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC;YACrC,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;SACjB,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,IAAI,qBAAqB,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACzE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClD,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IACjC,CAAC;SAAM,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,CAAC;IACD,OAAO,MAAwB,CAAC;AAClC,CAAC;AAED,SAAS,YAAY,CAAC,MAAiB,EAAE,MAAiB;IACxD,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAAiB,EAAE,MAAiB;IACzD,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;QAClC,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,CAAC,QAAQ,IAAI,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC;IAC5C,CAAC;IACD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,CAAC,kBAAkB,IAAI,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC;IACxD,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,eAAe,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IAClD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAgB;IAC3C,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IACpC,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAChD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,eAAe,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
1
+ {"version":3,"file":"classic-rest-api.js","sourceRoot":"","sources":["../../src/classic-rest-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,SAAS,EAAE,aAAa,EAAC,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAC,MAAM,EAAC,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAC,OAAO,EAAC,MAAM,kCAAkC,CAAC;AACzD,OAAO,EAAC,MAAM,EAAC,MAAM,8BAA8B,CAAC;AAKpD,OAAO,EAAC,eAAe,EAAC,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAC,QAAQ,EAAC,MAAM,gCAAgC,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAC,2BAA2B,EAAC,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EAAC,oBAAoB,EAAC,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAC,oBAAoB,EAAC,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAEL,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,uBAAuB,EAAC,MAAM,UAAU,CAAC;AACjD,OAAO,EAAC,kBAAkB,EAAC,MAAM,eAAe,CAAC;AAEjD,OAAO,EAAC,qBAAqB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAC,WAAW,IAAI,KAAK,EAAC,MAAM,sCAAsC,CAAC;AA2F1E,SAAS,YAAY,CAAC,EAAS;IAC7B,OAAO,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAe,EACf,OAAuB,EACvB,OAAO,GAAG,IAAI;IAEd,MAAM,MAAM,GAAG,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAC7B,uBAAuB,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAC9C,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAAe,EACf,OAAuB;IAEvB,MAAM,MAAM,GAAqB;QAC/B,KAAK,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC;QACxC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAC9B,OAAO;QACP,QAAQ,EAAE,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC;KAC/C,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,GAAG;YACb,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9B,GAAG,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SAC7C,CAAC;QACF,IAAI,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YAChE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CACrC,EAAS,EACT,OAAuB,EACvB,OAAO,GAAG,IAAI;IAEd,MAAM,OAAO,GAAG,EAAgB,CAAC;IACjC,MAAM,SAAS,GAAS,OAAO,CAAC,SAAS,CAAC;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IACxB,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;IACrB,MAAM,IAAI,GACR,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5E,MAAM,IAAI,GAAG,KAAK;QAChB,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,SAAS,CAAC;QAC/C,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACtB,MAAM,UAAU,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC3B,IAAI,KAAK,GAAG,iBAAiB,CAAC,EAAE,CAAC;QAC/B,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IAC1B,MAAM,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,KAAK,KAAK,CAAC,eAAe,CAAC;IAC1E,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAClE,KAAK,IAAI,IAAI,GAAG,IAAI,CAAC;IACvB,CAAC;IACD,MAAM,MAAM,GAA4B;QACtC,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;KACX,CAAC;IACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC/B,CAAC;IACD,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAChC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QACrD,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAC3B,CAAC;IACD,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,KAAK,KAAK,CAAC,eAAe,CAAC;YAChD,MAAM,OAAO,GAAG,QAAQ;gBACtB,CAAC,CAAC,2BAA2B,CAAC,EAAE,EAAE,EAAE,CAAC;gBACrC,CAAC,CAAC,oBAAoB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YACjC,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QACD,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;QACrB,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YAClC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBAChC,SAAS,GAAG,IAAI,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;YAC7C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACxC,MAAM,CAAC,IAAI,GAAG,uBAAuB,CACnC,GAAG,EACH,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EACnB,SAAS,EACT,SAAS,EACT,WAAW,CACZ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,IAAI,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,EAAe,CAAC;QAC/B,MAAM,CAAC,IAAI,GAAG;YACZ,KAAK,EAAE;gBACL,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC3B,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;aAC5B;YACD,MAAM,EAAE;gBACN,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBACnC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;aACxB;YACD,cAAc,EAAE,MAAM,CAAC,iBAAiB,EAAE;YAC1C,eAAe,EAAE,MAAM,CAAC,kBAAkB,EAAE;YAC5C,iBAAiB,EAAE,MAAM,CAAC,oBAAoB,EAAE;SACjD,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,EAAgB,CAAC;QACjC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;QACxB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;QACvB,MAAM,CAAC,KAAK,GAAG;YACb,EAAE;YACF,EAAE,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACxC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;YACf,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;YACjB,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE;YACvB,QAAQ,EAAE,CAAC,CAAC,WAAW,EAAE;YACzB,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE;SAC7C,CAAC;QACF,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAChE,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC;QAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,CAAC,WAAW,GAAG;YACnB,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;YAChB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC;YACrC,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;SACjB,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,IAAI,qBAAqB,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACzE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClD,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IACjC,CAAC;SAAM,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,CAAC;IACD,OAAO,MAAwB,CAAC;AAClC,CAAC;AAED,SAAS,YAAY,CAAC,MAAiB,EAAE,MAAiB;IACxD,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,MAAiB,EAAE,MAAiB;IACzD,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;QAClC,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,CAAC,QAAQ,IAAI,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC;IAC5C,CAAC;IACD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,CAAC,kBAAkB,IAAI,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC;IACxD,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,eAAe,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IAClD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAgB;IAC3C,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IACpC,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAChD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,eAAe,GAAG,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -1,43 +1,111 @@
1
1
  import { Event } from '@hebcal/core/dist/esm/event';
2
2
  import { CalOptions } from '@hebcal/core/dist/esm/CalOptions';
3
+ /**
4
+ * A simple string-to-string dictionary
5
+ */
3
6
  export type StringMap = Record<string, string>;
7
+ /**
8
+ * Options specific to rendering events for the REST API, as opposed to
9
+ * options in `CalOptions` that control which events are generated
10
+ */
4
11
  export type RestApiEventOptions = {
12
+ /**
13
+ * value for the `utm_source` (or hebcal.com-internal `us`) tracking
14
+ * parameter appended to event links
15
+ */
5
16
  utmSource?: string;
17
+ /**
18
+ * value for the `utm_medium` (or hebcal.com-internal `um`) tracking
19
+ * parameter appended to event links (default `'api'`)
20
+ */
6
21
  utmMedium?: string;
22
+ /**
23
+ * value for the `utm_campaign` (or hebcal.com-internal `uc`) tracking
24
+ * parameter appended to event links
25
+ */
7
26
  utmCampaign?: string;
27
+ /**
28
+ * include a `tachanun` field in the classic API response describing
29
+ * whether Tachanun is recited (only applies when the result covers a
30
+ * single day)
31
+ */
8
32
  tachanun?: boolean;
33
+ /**
34
+ * append the Hebrew rendering of the event title to the CSV subject line
35
+ */
9
36
  appendHebrewToSubject?: boolean;
37
+ /**
38
+ * `true` if this calendar is a Yahrzeit/Anniversary calendar; changes the
39
+ * generated calendar title
40
+ */
10
41
  yahrzeit?: boolean;
42
+ /**
43
+ * `true`, `'1'`, or `1` marks this calendar as a recurring subscription
44
+ * (e.g. a webcal feed); suppresses the year from the generated calendar
45
+ * title since the feed is perpetually up to date
46
+ */
11
47
  subscribe?: string | number | boolean;
48
+ /**
49
+ * include a `heDateParts` field (Hebrew year/month/day rendered with
50
+ * `gematriya`) on each classic API event
51
+ */
12
52
  heDateParts?: boolean;
53
+ /**
54
+ * include the underlying `Event` object as the `ev` field on each
55
+ * classic API event
56
+ */
13
57
  includeEvent?: boolean;
58
+ /**
59
+ * render CSV dates as `DD/MM/YYYY` (European order) instead of the
60
+ * default `MM/DD/YYYY`
61
+ */
14
62
  euro?: boolean;
15
- title?: string;
16
- description?: string;
63
+ /**
64
+ * prefer a location's ASCII name over its short display name when
65
+ * generating a calendar title or download filename
66
+ */
17
67
  preferAsciiName?: boolean;
18
68
  };
19
- export type RestApiOptions = CalOptions & RestApiEventOptions;
20
- export declare function getDownloadFilename(options: RestApiOptions): string;
21
69
  /**
22
- * Returns just the date portion as YYYY-MM-DD
23
- * @deprecated use `isoDateString` instead
70
+ * Combines `@hebcal/core`'s `CalOptions` (which control which events are
71
+ * generated) with `RestApiEventOptions` (which control how events are
72
+ * rendered by this package)
24
73
  */
25
- export declare function toISOString(d: Date): string;
74
+ export type RestApiOptions = CalOptions & RestApiEventOptions;
26
75
  /**
27
- * Returns a category and subcategory name
76
+ * Generates a base filename (without extension) for a calendar download,
77
+ * incorporating the year, date range, and/or location as available.
78
+ * @param options - the year/date-range/location used to construct the
79
+ * filename; typically the same options passed to the calendar generator
80
+ * @returns a filename like `hebcal_2020` or `hebcal_1993_providence`
28
81
  */
29
- export declare function getEventCategories(ev: Event): string[];
82
+ export declare function getDownloadFilename(options: RestApiOptions): string;
30
83
  /**
31
- * Renders the event title in default locale, but strips off time
32
- * @deprecated
84
+ * Returns a category and subcategory name for an event, e.g.
85
+ * `['holiday', 'major']` or `['roshchodesh']`.
86
+ * @param ev - the event to categorize
87
+ * @returns an array of 1 or 2 category strings
33
88
  */
34
- export declare function renderTitleWithoutTime(ev: Event, locale?: string): string;
89
+ export declare function getEventCategories(ev: Event): string[];
35
90
  /**
36
91
  * Generates a title like "Hebcal 2020 Israel" or "Hebcal May 1993 Providence"
92
+ * @param events - the events in the calendar, used to determine the date
93
+ * range shown in the title
94
+ * @param options - controls location name, `il`/Diaspora, and whether this
95
+ * is a Yahrzeit calendar or a subscription (see `RestApiEventOptions`)
96
+ * @returns the generated calendar title
37
97
  */
38
98
  export declare function getCalendarTitle(events: Event[], options: RestApiOptions): string;
39
99
  /**
40
100
  * Bitmask for learning events (Daf Yomi, Nach Yomi, Mishna Yomi, Daily Learning, Yerushalmi Yomi)
41
101
  */
42
102
  export declare const LEARNING_MASK: number;
103
+ /**
104
+ * Determines whether an event's title should be rendered with `Event.renderBrief()`
105
+ * instead of `Event.render()` — for example timed events, non-1st-of-month
106
+ * Hebrew date events, learning-schedule events, Shabbat Mevarchim, and Yom
107
+ * Kippur Katan.
108
+ * @param ev - the event to check
109
+ * @returns `true` if the brief rendering should be used
110
+ */
43
111
  export declare function shouldRenderBrief(ev: Event): boolean;
@@ -1,6 +1,13 @@
1
1
  import { flags } from '@hebcal/core/dist/esm/event';
2
- import { HDate, isoDateString } from '@hebcal/hdate';
2
+ import { HDate } from '@hebcal/hdate';
3
3
  import { makeAnchor } from './makeAnchor.js';
4
+ /**
5
+ * Generates a base filename (without extension) for a calendar download,
6
+ * incorporating the year, date range, and/or location as available.
7
+ * @param options - the year/date-range/location used to construct the
8
+ * filename; typically the same options passed to the calendar generator
9
+ * @returns a filename like `hebcal_2020` or `hebcal_1993_providence`
10
+ */
4
11
  export function getDownloadFilename(options) {
5
12
  let fileName = 'hebcal';
6
13
  if (options.year) {
@@ -35,14 +42,10 @@ export function getDownloadFilename(options) {
35
42
  return fileName;
36
43
  }
37
44
  /**
38
- * Returns just the date portion as YYYY-MM-DD
39
- * @deprecated use `isoDateString` instead
40
- */
41
- export function toISOString(d) {
42
- return isoDateString(d);
43
- }
44
- /**
45
- * Returns a category and subcategory name
45
+ * Returns a category and subcategory name for an event, e.g.
46
+ * `['holiday', 'major']` or `['roshchodesh']`.
47
+ * @param ev - the event to categorize
48
+ * @returns an array of 1 or 2 category strings
46
49
  */
47
50
  export function getEventCategories(ev) {
48
51
  const s = ev.getDesc();
@@ -51,15 +54,6 @@ export function getEventCategories(ev) {
51
54
  }
52
55
  return ev.getCategories();
53
56
  }
54
- /**
55
- * Renders the event title in default locale, but strips off time
56
- * @deprecated
57
- */
58
- export function renderTitleWithoutTime(ev, locale) {
59
- return ev.eventTime === undefined
60
- ? ev.render(locale)
61
- : ev.renderBrief(locale);
62
- }
63
57
  function shortLocationName(options) {
64
58
  const loc = options.location;
65
59
  if (!loc) {
@@ -75,6 +69,11 @@ function shortLocationName(options) {
75
69
  }
76
70
  /**
77
71
  * Generates a title like "Hebcal 2020 Israel" or "Hebcal May 1993 Providence"
72
+ * @param events - the events in the calendar, used to determine the date
73
+ * range shown in the title
74
+ * @param options - controls location name, `il`/Diaspora, and whether this
75
+ * is a Yahrzeit calendar or a subscription (see `RestApiEventOptions`)
76
+ * @returns the generated calendar title
78
77
  */
79
78
  export function getCalendarTitle(events, options) {
80
79
  let title = 'Hebcal';
@@ -123,6 +122,14 @@ export const LEARNING_MASK = flags.DAF_YOMI |
123
122
  flags.MISHNA_YOMI |
124
123
  flags.DAILY_LEARNING |
125
124
  flags.YERUSHALMI_YOMI;
125
+ /**
126
+ * Determines whether an event's title should be rendered with `Event.renderBrief()`
127
+ * instead of `Event.render()` — for example timed events, non-1st-of-month
128
+ * Hebrew date events, learning-schedule events, Shabbat Mevarchim, and Yom
129
+ * Kippur Katan.
130
+ * @param ev - the event to check
131
+ * @returns `true` if the brief rendering should be used
132
+ */
126
133
  export function shouldRenderBrief(ev) {
127
134
  if (ev.eventTime !== undefined) {
128
135
  return true;
@@ -1 +1 @@
1
- {"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AAGzD,OAAO,EAAC,KAAK,EAAE,aAAa,EAAC,MAAM,eAAe,CAAC;AACnD,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAuB3C,MAAM,UAAU,mBAAmB,CAAC,OAAuB;IACzD,IAAI,QAAQ,GAAG,QAAQ,CAAC;IACxB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,QAAQ,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;QAC/B,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzB,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,QAAQ,IAAI,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;QAClC,CAAC;IACH,CAAC;SAAM,IACL,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;QACjC,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAC/B,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACtC,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACd,QAAQ,IAAI,GAAG,GAAG,EAAE,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,QAAQ,IAAI,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,OAAO,CAAC,QAAoB,CAAC;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC;QAClE,IAAI,IAAI,EAAE,CAAC;YACT,QAAQ,IAAI,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,CAAO;IACjC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAAS;IAC1C,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IACvB,IAAI,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACtE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,EAAE,CAAC,aAAa,EAAE,CAAC;AAC5B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,EAAS,EAAE,MAAe;IAC/D,OAAQ,EAAiB,CAAC,SAAS,KAAK,SAAS;QAC/C,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;QACnB,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAuB;IAChD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAoB,CAAC;IACzC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAChC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAe,EACf,OAAuB;IAEvB,IAAI,KAAK,GAAG,QAAQ,CAAC;IACrB,MAAM,YAAY,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,IAAI,8BAA8B,CAAC;IAC1C,CAAC;SAAM,IAAI,YAAY,EAAE,CAAC;QACxB,KAAK,IAAI,GAAG,GAAG,YAAY,CAAC;IAC9B,CAAC;SAAM,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACtB,KAAK,IAAI,SAAS,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,KAAK,IAAI,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IAC9B,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;QAClE,KAAK,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAC9B,CAAC;SAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7C,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;YAC9C,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAC/D,CAAC;aAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC/C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,MAAM,EAAC,CAAC,CAAC;YACtE,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7C,KAAK,IAAI,GAAG,GAAG,UAAU,GAAG,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACrC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GACxB,KAAK,CAAC,QAAQ;IACd,KAAK,CAAC,SAAS;IACf,KAAK,CAAC,WAAW;IACjB,KAAK,CAAC,cAAc;IACpB,KAAK,CAAC,eAAe,CAAC;AAExB,MAAM,UAAU,iBAAiB,CAAC,EAAS;IACzC,IAAK,EAAiB,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;SAAM,IAAI,IAAI,GAAG,CAAC,aAAa,GAAG,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IACL,IAAI,GAAG,KAAK,CAAC,UAAU;QACvB,EAAE,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAC3C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AAGzD,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAC;AACpC,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AA8E3C;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAuB;IACzD,IAAI,QAAQ,GAAG,QAAQ,CAAC;IACxB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,QAAQ,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;QAC/B,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzB,QAAQ,IAAI,GAAG,CAAC;QAClB,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,QAAQ,IAAI,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;QAClC,CAAC;IACH,CAAC;SAAM,IACL,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;QACjC,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAC/B,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACtC,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACd,QAAQ,IAAI,GAAG,GAAG,EAAE,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,QAAQ,IAAI,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACzC,MAAM,GAAG,GAAG,OAAO,CAAC,QAAoB,CAAC;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC;QAClE,IAAI,IAAI,EAAE,CAAC;YACT,QAAQ,IAAI,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAAS;IAC1C,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;IACvB,IAAI,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACtE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,EAAE,CAAC,aAAa,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAuB;IAChD,MAAM,GAAG,GAAG,OAAO,CAAC,QAAoB,CAAC;IACzC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;QAChC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAe,EACf,OAAuB;IAEvB,IAAI,KAAK,GAAG,QAAQ,CAAC;IACrB,MAAM,YAAY,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,IAAI,8BAA8B,CAAC;IAC1C,CAAC;SAAM,IAAI,YAAY,EAAE,CAAC;QACxB,KAAK,IAAI,GAAG,GAAG,YAAY,CAAC;IAC9B,CAAC;SAAM,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACtB,KAAK,IAAI,SAAS,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,KAAK,IAAI,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IAC9B,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;QAClE,KAAK,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAC9B,CAAC;SAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7C,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;YAC9C,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAC/D,CAAC;aAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC/C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,MAAM,EAAC,CAAC,CAAC;YACtE,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7C,KAAK,IAAI,GAAG,GAAG,UAAU,GAAG,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACrC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GACxB,KAAK,CAAC,QAAQ;IACd,KAAK,CAAC,SAAS;IACf,KAAK,CAAC,WAAW;IACjB,KAAK,CAAC,cAAc;IACpB,KAAK,CAAC,eAAe,CAAC;AAExB;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAS;IACzC,IAAK,EAAiB,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;SAAM,IAAI,IAAI,GAAG,CAAC,aAAa,GAAG,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IACL,IAAI,GAAG,KAAK,CAAC,UAAU;QACvB,EAAE,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAC3C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}
package/dist/esm/csv.d.ts CHANGED
@@ -1,7 +1,20 @@
1
1
  import { Event } from '@hebcal/core/dist/esm/event';
2
2
  import { RestApiOptions } from './common.js';
3
3
  /**
4
- * Renders an Event as a string
4
+ * Renders a single event as one line of Outlook-compatible CSV
5
+ * (no trailing newline).
6
+ * @param ev - the event to render
7
+ * @param options - controls locale, date format (`euro`), and whether to
8
+ * append the Hebrew title (`appendHebrewToSubject`)
9
+ * @returns a CSV row: subject, start/end date/time, all-day flag,
10
+ * description, "show time as", and location
5
11
  */
6
12
  export declare function eventToCsv(ev: Event, options: RestApiOptions): string;
13
+ /**
14
+ * Renders a list of events as an Outlook-compatible CSV document, including
15
+ * the header row and a trailing CRLF.
16
+ * @param events - the events to render
17
+ * @param options - see `eventToCsv()`
18
+ * @returns the full CSV document, using CRLF line endings
19
+ */
7
20
  export declare function eventsToCsv(events: Event[], options: RestApiOptions): string;
package/dist/esm/csv.js CHANGED
@@ -19,7 +19,13 @@ const CATEGORY = {
19
19
  zmanim: '',
20
20
  };
21
21
  /**
22
- * Renders an Event as a string
22
+ * Renders a single event as one line of Outlook-compatible CSV
23
+ * (no trailing newline).
24
+ * @param ev - the event to render
25
+ * @param options - controls locale, date format (`euro`), and whether to
26
+ * append the Hebrew title (`appendHebrewToSubject`)
27
+ * @returns a CSV row: subject, start/end date/time, all-day flag,
28
+ * description, "show time as", and location
23
29
  */
24
30
  export function eventToCsv(ev, options) {
25
31
  const d = ev.greg();
@@ -81,6 +87,13 @@ export function eventToCsv(ev, options) {
81
87
  const showTimeAs = timed || isChag ? 4 : 3;
82
88
  return `"${subj}",${date},${startTime},${endDate},${endTime},${allDay},"${memo}","${showTimeAs}","${loc}"`;
83
89
  }
90
+ /**
91
+ * Renders a list of events as an Outlook-compatible CSV document, including
92
+ * the header row and a trailing CRLF.
93
+ * @param events - the events to render
94
+ * @param options - see `eventToCsv()`
95
+ * @returns the full CSV document, using CRLF line endings
96
+ */
84
97
  export function eventsToCsv(events, options) {
85
98
  return ([csvHeader].concat(events.map(ev => eventToCsv(ev, options))).join('\r\n') +
86
99
  '\r\n');
@@ -1 +1 @@
1
- {"version":3,"file":"csv.js","sourceRoot":"","sources":["../../src/csv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAC,eAAe,EAAC,MAAM,uCAAuC,CAAC;AAEtE,OAAO,EAGL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,qBAAqB,EAAC,MAAM,cAAc,CAAC;AAEnD,MAAM,SAAS,GACb,mHAAmH,CAAC;AAEtH,MAAM,QAAQ,GAAc;IAC1B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,UAAU,EAAE,iBAAiB;IAC7B,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,iBAAiB;IAC1B,SAAS,EAAE,EAAE;IACb,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,EAAE;IACR,QAAQ,EAAE,eAAe;IACzB,WAAW,EAAE,iBAAiB;IAC9B,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,EAAE;CACX,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,EAAS,EAAE,OAAuB;IAC3D,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;IACpB,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACzB,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI;QACvB,CAAC,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG;QAC5B,CAAC,CAAC,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,GAAG,CAAC;IAE/B,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,MAAM,GAAG,QAAQ,CAAC;IAEtB,MAAM,OAAO,GAAG,EAAgB,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,IAAI,IAAI,GAAG,iBAAiB,CAAC,EAAE,CAAC;QAC9B,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACtE,OAAO,GAAG,SAAS,GAAG,IAAI,OAAO,GAAG,CAAC;QACrC,OAAO,GAAG,IAAI,CAAC;QACf,MAAM,GAAG,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,GAAG,GAAG,iBAAiB,CAAC;IAC5B,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC3B,IAAI,KAAK,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAG,CAAC;QACtD,IAAI,YAAY,EAAE,CAAC;YACjB,GAAG,GAAG,YAAY,CAAC;QACrB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,GAAG,GAAG,QAAQ,CAAC;gBACf,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAEtD,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,IAAI,MAAM,MAAM,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAED,IAAI,KAAK,GAAG,EAAE,CAAC,IAAI,IAAI,qBAAqB,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACvE,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAChD,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,IAAI,GAAG,KAAK;SACf,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;SACpB,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC;SACrB,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAE3B,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,IAAI,IAAI,KAAK,IAAI,IAAI,SAAS,IAAI,OAAO,IAAI,OAAO,IAAI,MAAM,KAAK,IAAI,MAAM,UAAU,MAAM,GAAG,GAAG,CAAC;AAC7G,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAe,EAAE,OAAuB;IAClE,OAAO,CACL,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1E,MAAM,CACP,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"csv.js","sourceRoot":"","sources":["../../src/csv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAC,eAAe,EAAC,MAAM,uCAAuC,CAAC;AAEtE,OAAO,EAGL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,qBAAqB,EAAC,MAAM,cAAc,CAAC;AAEnD,MAAM,SAAS,GACb,mHAAmH,CAAC;AAEtH,MAAM,QAAQ,GAAc;IAC1B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,UAAU,EAAE,iBAAiB;IAC7B,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,iBAAiB;IAC1B,SAAS,EAAE,EAAE;IACb,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,EAAE;IACR,QAAQ,EAAE,eAAe;IACzB,WAAW,EAAE,iBAAiB;IAC9B,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,EAAE;CACX,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAAC,EAAS,EAAE,OAAuB;IAC3D,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;IACpB,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IACzB,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI;QACvB,CAAC,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG;QAC5B,CAAC,CAAC,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,GAAG,CAAC;IAE/B,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,MAAM,GAAG,QAAQ,CAAC;IAEtB,MAAM,OAAO,GAAG,EAAgB,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,IAAI,IAAI,GAAG,iBAAiB,CAAC,EAAE,CAAC;QAC9B,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACtE,OAAO,GAAG,SAAS,GAAG,IAAI,OAAO,GAAG,CAAC;QACrC,OAAO,GAAG,IAAI,CAAC;QACf,MAAM,GAAG,SAAS,CAAC;IACrB,CAAC;IAED,IAAI,GAAG,GAAG,iBAAiB,CAAC;IAC5B,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC3B,IAAI,KAAK,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAG,CAAC;QACtD,IAAI,YAAY,EAAE,CAAC;YACjB,GAAG,GAAG,YAAY,CAAC;QACrB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,GAAG,GAAG,QAAQ,CAAC;gBACf,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAEtD,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,IAAI,MAAM,MAAM,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAED,IAAI,KAAK,GAAG,EAAE,CAAC,IAAI,IAAI,qBAAqB,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACvE,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAChD,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,IAAI,GAAG,KAAK;SACf,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;SACpB,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC;SACrB,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAE3B,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,IAAI,IAAI,KAAK,IAAI,IAAI,SAAS,IAAI,OAAO,IAAI,OAAO,IAAI,MAAM,KAAK,IAAI,MAAM,UAAU,MAAM,GAAG,GAAG,CAAC;AAC7G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,MAAe,EAAE,OAAuB;IAClE,OAAO,CACL,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1E,MAAM,CACP,CAAC;AACJ,CAAC"}
@@ -2,5 +2,12 @@ import { Event } from '@hebcal/core/dist/esm/event';
2
2
  /**
3
3
  * Returns a description of the holiday. Uses the English description by
4
4
  * default, or the Hebrew description when `locale` is a Hebrew locale.
5
+ * Returns an empty string if no description is available.
6
+ * @param ev - the holiday event to describe
7
+ * @param firstSentence - `true` to truncate the description at the first
8
+ * sentence (up to and excluding the first `.`)
9
+ * @param locale - the locale to render the description in; Hebrew locales
10
+ * (e.g. `'he'`) get the Hebrew description, everything else gets English
11
+ * @returns the holiday description, or `''` if none is found
5
12
  */
6
13
  export declare function getHolidayDescription(ev: Event, firstSentence?: boolean, locale?: string): string;
@@ -11,6 +11,13 @@ Locale.addTranslations('he', poHe);
11
11
  /**
12
12
  * Returns a description of the holiday. Uses the English description by
13
13
  * default, or the Hebrew description when `locale` is a Hebrew locale.
14
+ * Returns an empty string if no description is available.
15
+ * @param ev - the holiday event to describe
16
+ * @param firstSentence - `true` to truncate the description at the first
17
+ * sentence (up to and excluding the first `.`)
18
+ * @param locale - the locale to render the description in; Hebrew locales
19
+ * (e.g. `'he'`) get the Hebrew description, everything else gets English
20
+ * @returns the holiday description, or `''` if none is found
14
21
  */
15
22
  export function getHolidayDescription(ev, firstSentence = false, locale) {
16
23
  const localeName = Locale.isHebrewLocale(locale) ? 'he' : 'en';
@@ -1 +1 @@
1
- {"version":3,"file":"holiday.js","sourceRoot":"","sources":["../../src/holiday.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAC,MAAM,EAAC,MAAM,eAAe,CAAC;AACrC,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,IAAI,MAAM,YAAY,CAAC;AAE9B,qEAAqE;AACrE,uEAAuE;AACvE,sDAAsD;AACtD,MAAM,WAAW,GAAG,OAAO,CAAC;AAE5B,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACnC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAEnC;;;GAGG;AAEH,MAAM,UAAU,qBAAqB,CACnC,EAAS,EACT,aAAa,GAAG,KAAK,EACrB,MAAe;IAEf,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/D,MAAM,GAAG,GACP,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,iBAAiB;QACrC,CAAC,CAAC,2BAA2B;QAC7B,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;IACnB,MAAM,IAAI,GACR,MAAM,CAAC,iBAAiB,CAAC,WAAW,GAAG,GAAG,EAAE,UAAU,CAAC;QACvD,MAAM,CAAC,iBAAiB,CAAC,WAAW,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC;QACjE,EAAE,CAAC;IACL,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAC7B,IAAI,aAAa,IAAI,GAAG,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
1
+ {"version":3,"file":"holiday.js","sourceRoot":"","sources":["../../src/holiday.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAC,MAAM,EAAC,MAAM,eAAe,CAAC;AACrC,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,IAAI,MAAM,YAAY,CAAC;AAE9B,qEAAqE;AACrE,uEAAuE;AACvE,sDAAsD;AACtD,MAAM,WAAW,GAAG,OAAO,CAAC;AAE5B,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACnC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAEnC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,qBAAqB,CACnC,EAAS,EACT,aAAa,GAAG,KAAK,EACrB,MAAe;IAEf,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/D,MAAM,GAAG,GACP,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,iBAAiB;QACrC,CAAC,CAAC,2BAA2B;QAC7B,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;IACnB,MAAM,IAAI,GACR,MAAM,CAAC,iBAAiB,CAAC,WAAW,GAAG,GAAG,EAAE,UAAU,CAAC;QACvD,MAAM,CAAC,iBAAiB,CAAC,WAAW,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC;QACjE,EAAE,CAAC;IACL,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAC7B,IAAI,aAAa,IAAI,GAAG,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
@@ -1,26 +1,51 @@
1
1
  import { Location } from '@hebcal/core/dist/esm/location';
2
2
  import type { StringMap } from './common.js';
3
+ /**
4
+ * Maps a 2-letter ISO 3166 country code (e.g. `'FR'`) to its English name
5
+ * (e.g. `'France'`)
6
+ */
3
7
  export declare const countryNames: StringMap;
4
8
  /**
5
- * Location information
9
+ * JSON-serializable representation of a `@hebcal/core` `Location`, as
10
+ * returned by `locationToPlainObj()`. When `locationToPlainObj()` is
11
+ * called without a location, only `geo: 'none'` is set.
6
12
  */
7
13
  export type LocationPlainObj = {
14
+ /** display name, e.g. `'Providence, RI'` */
8
15
  title?: string | null;
16
+ /** short city name, e.g. `'Providence'` */
9
17
  city?: string | null;
18
+ /** Olson timezone ID, e.g. `'America/New_York'` */
10
19
  tzid?: string;
11
20
  latitude?: number;
12
21
  longitude?: number;
22
+ /** 2-letter ISO 3166 country code, e.g. `'US'` */
13
23
  cc?: string;
24
+ /** English country name, e.g. `'United States'` */
14
25
  country?: string;
26
+ /** elevation in meters, when known */
27
+ elevation?: number;
28
+ /** GeoNames admin1 code (roughly, US state or subnational region) */
15
29
  admin1?: string;
30
+ /** ASCII-only spelling of the location name */
16
31
  asciiname?: string;
32
+ /** geocoding method or source, e.g. `'zip'`, `'city'`, or `'none'` */
17
33
  geo?: string;
34
+ /** US ZIP code, when the location was looked up by ZIP */
18
35
  zip?: string;
36
+ /** 2-letter US state abbreviation */
19
37
  state?: string;
38
+ /** full US state name */
20
39
  stateName?: string;
40
+ /** GeoNames.org geonameid */
21
41
  geonameid?: number;
22
42
  };
23
43
  /**
24
- * Converts a @hebcal/core `Location` to a plain JS object.
44
+ * Converts a `@hebcal/core` `Location` to a plain, JSON-serializable object.
45
+ * Some fields (e.g. `elevation`, `state`, `geonameid`) are only present when
46
+ * the `Location` was constructed with that extra metadata attached (as done
47
+ * by GeoNames-backed location lookups).
48
+ * @param location - the location to convert, or `undefined`
49
+ * @returns a plain object, or `{geo: 'none'}` if `location` is `undefined`
25
50
  */
26
51
  export declare function locationToPlainObj(location: Location | undefined): LocationPlainObj;
@@ -1,4 +1,8 @@
1
1
  import countryNames0 from './countryNames.json.js';
2
+ /**
3
+ * Maps a 2-letter ISO 3166 country code (e.g. `'FR'`) to its English name
4
+ * (e.g. `'France'`)
5
+ */
2
6
  export const countryNames = countryNames0;
3
7
  const LOC_FIELDS = [
4
8
  'elevation',
@@ -11,7 +15,12 @@ const LOC_FIELDS = [
11
15
  'geonameid',
12
16
  ];
13
17
  /**
14
- * Converts a @hebcal/core `Location` to a plain JS object.
18
+ * Converts a `@hebcal/core` `Location` to a plain, JSON-serializable object.
19
+ * Some fields (e.g. `elevation`, `state`, `geonameid`) are only present when
20
+ * the `Location` was constructed with that extra metadata attached (as done
21
+ * by GeoNames-backed location lookups).
22
+ * @param location - the location to convert, or `undefined`
23
+ * @returns a plain object, or `{geo: 'none'}` if `location` is `undefined`
15
24
  */
16
25
  export function locationToPlainObj(location) {
17
26
  if (typeof location === 'object' &&
@@ -1 +1 @@
1
- {"version":3,"file":"location.js","sourceRoot":"","sources":["../../src/location.ts"],"names":[],"mappings":"AAEA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AAEnD,MAAM,CAAC,MAAM,YAAY,GAAc,aAA0B,CAAC;AAsBlE,MAAM,UAAU,GAAG;IACjB,WAAW;IACX,QAAQ;IACR,WAAW;IACX,KAAK;IACL,KAAK;IACL,OAAO;IACP,WAAW;IACX,WAAW;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,QAA8B;IAE9B,IACE,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,CAAC,WAAW,KAAK,UAAU,EAC1C,CAAC;QACD,MAAM,EAAE,GAAW,QAAQ,CAAC,cAAc,EAAG,CAAC;QAC9C,MAAM,CAAC,GAAqB;YAC1B,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE;YACzB,IAAI,EAAE,QAAQ,CAAC,YAAY,EAAE;YAC7B,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE;YACxB,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAAE;YAChC,SAAS,EAAE,QAAQ,CAAC,YAAY,EAAE;YAClC,EAAE,EAAE,EAAE;YACN,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;SAC1B,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAI,QAAgB,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,GAAG,EAAE,CAAC;gBACP,CAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;YACtB,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACN,OAAO,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC;IACvB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"location.js","sourceRoot":"","sources":["../../src/location.ts"],"names":[],"mappings":"AAEA,OAAO,aAAa,MAAM,wBAAwB,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAc,aAA0B,CAAC;AAsClE,MAAM,UAAU,GAAG;IACjB,WAAW;IACX,QAAQ;IACR,WAAW;IACX,KAAK;IACL,KAAK;IACL,OAAO;IACP,WAAW;IACX,WAAW;CACZ,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,QAA8B;IAE9B,IACE,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,CAAC,WAAW,KAAK,UAAU,EAC1C,CAAC;QACD,MAAM,EAAE,GAAW,QAAQ,CAAC,cAAc,EAAG,CAAC;QAC9C,MAAM,CAAC,GAAqB;YAC1B,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE;YACzB,IAAI,EAAE,QAAQ,CAAC,YAAY,EAAE;YAC7B,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE;YACxB,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAAE;YAChC,SAAS,EAAE,QAAQ,CAAC,YAAY,EAAE;YAClC,EAAE,EAAE,EAAE;YACN,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;SAC1B,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAI,QAAgB,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,GAAG,EAAE,CAAC;gBACP,CAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;YACtB,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACN,OAAO,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC;IACvB,CAAC;AACH,CAAC"}
package/dist/esm/url.d.ts CHANGED
@@ -1,5 +1,28 @@
1
+ /**
2
+ * Rewrites a long-form `hebcal.com/sedrot/<parsha>-<YYYYMMDD>` URL in place
3
+ * to the short `hebcal.com/s/<year>[i]/<parsha-id>[d]` form, e.g.
4
+ * `/sedrot/bereshit-20201017` becomes `/s/5781/1`. Falls back to trimming
5
+ * the `/sedrot/` prefix to `/s/` if the path doesn't match the expected
6
+ * `<parsha>-<8-digit-date>` shape.
7
+ * @param u - the URL to rewrite; mutated in place via `u.pathname`
8
+ */
1
9
  export declare function shortenSedrotUrl(u: URL): void;
2
10
  /**
3
- * Appends utm_source and utm_medium parameters to a URL
11
+ * Adjusts a Hebcal.com event link for Israel/Diaspora and appends UTM
12
+ * tracking parameters. For `www.hebcal.com` holiday/sedrot/omer links, this
13
+ * also sets `i=on` when `il` is true, rewrites the host to the shorter
14
+ * `hebcal.com` and shortens the path (see `shortenSedrotUrl()` for sedrot),
15
+ * and uses the abbreviated `us`/`um`/`uc` parameter names instead of the
16
+ * full `utm_source`/`utm_medium`/`utm_campaign` (the `us`/`um` params are
17
+ * omitted when `utmCampaign` starts with `'ical-'` or `'pdf-'`, since those
18
+ * campaigns are tracked by `uc` alone). For all other URLs, the standard
19
+ * `utm_source`/`utm_medium`/`utm_campaign` parameters are appended, and
20
+ * `utm_source` defaults to `'hebcal.com'` when not otherwise specified.
21
+ * @param url - the event URL to rewrite
22
+ * @param il - `true` to mark the link as using the Israel holiday schedule
23
+ * @param utmSource - tracking source, e.g. `'js'`
24
+ * @param utmMedium - tracking medium, e.g. `'api'`
25
+ * @param utmCampaign - tracking campaign, e.g. `'ical-foo'`
26
+ * @returns the rewritten URL as a string
4
27
  */
5
28
  export declare function appendIsraelAndTracking(url: string, il: boolean, utmSource?: string, utmMedium?: string, utmCampaign?: string): string;
package/dist/esm/url.js CHANGED
@@ -36,6 +36,14 @@ function parse8digitDateStr(date) {
36
36
  }
37
37
  return dt;
38
38
  }
39
+ /**
40
+ * Rewrites a long-form `hebcal.com/sedrot/<parsha>-<YYYYMMDD>` URL in place
41
+ * to the short `hebcal.com/s/<year>[i]/<parsha-id>[d]` form, e.g.
42
+ * `/sedrot/bereshit-20201017` becomes `/s/5781/1`. Falls back to trimming
43
+ * the `/sedrot/` prefix to `/s/` if the path doesn't match the expected
44
+ * `<parsha>-<8-digit-date>` shape.
45
+ * @param u - the URL to rewrite; mutated in place via `u.pathname`
46
+ */
39
47
  export function shortenSedrotUrl(u) {
40
48
  const path = u.pathname;
41
49
  const dash = path.lastIndexOf('-');
@@ -62,7 +70,22 @@ export function shortenSedrotUrl(u) {
62
70
  }
63
71
  }
64
72
  /**
65
- * Appends utm_source and utm_medium parameters to a URL
73
+ * Adjusts a Hebcal.com event link for Israel/Diaspora and appends UTM
74
+ * tracking parameters. For `www.hebcal.com` holiday/sedrot/omer links, this
75
+ * also sets `i=on` when `il` is true, rewrites the host to the shorter
76
+ * `hebcal.com` and shortens the path (see `shortenSedrotUrl()` for sedrot),
77
+ * and uses the abbreviated `us`/`um`/`uc` parameter names instead of the
78
+ * full `utm_source`/`utm_medium`/`utm_campaign` (the `us`/`um` params are
79
+ * omitted when `utmCampaign` starts with `'ical-'` or `'pdf-'`, since those
80
+ * campaigns are tracked by `uc` alone). For all other URLs, the standard
81
+ * `utm_source`/`utm_medium`/`utm_campaign` parameters are appended, and
82
+ * `utm_source` defaults to `'hebcal.com'` when not otherwise specified.
83
+ * @param url - the event URL to rewrite
84
+ * @param il - `true` to mark the link as using the Israel holiday schedule
85
+ * @param utmSource - tracking source, e.g. `'js'`
86
+ * @param utmMedium - tracking medium, e.g. `'api'`
87
+ * @param utmCampaign - tracking campaign, e.g. `'ical-foo'`
88
+ * @returns the rewritten URL as a string
66
89
  */
67
90
  export function appendIsraelAndTracking(url, il, utmSource, utmMedium, utmCampaign) {
68
91
  const u = new URL(url);
@@ -1 +1 @@
1
- {"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAC;AACpC,OAAO,EAAC,QAAQ,EAAC,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAE3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;AAC5C,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1B,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,gBAAgB,GAAa;IACjC,kBAAkB;IAClB,gBAAgB;IAChB,qBAAqB;IACrB,kBAAkB;IAClB,cAAc;IACd,aAAa;IACb,oBAAoB;CACZ,CAAC;AAEX,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;AAClC,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7B,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,EAAG,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,EAAE,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IACpC,IAAI,EAAE,GAAG,GAAG,EAAE,CAAC;QACb,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,CAAM;IACrC,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC;IACxB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACrC,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YACrC,CAAC,IAAI,GAAG,CAAC;YACT,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,CAAC,IAAI,GAAG,CAAC;QACX,CAAC;QACD,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,CAAC,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,GAAW,EACX,EAAW,EACX,SAAkB,EAClB,SAAkB,EAClB,WAAoB;IAEpB,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC;IAC7C,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,EAAE,EAAE,CAAC;YACP,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,UAAU,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YACrC,CAAC,CAAC,IAAI,GAAG,YAAY,CAAC;YACtB,IAAI,UAAU,EAAE,CAAC;gBACf,CAAC,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAC1C,CAAC;iBAAM,IAAI,QAAQ,EAAE,CAAC;gBACpB,gBAAgB,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,SAAS;gBACT,CAAC,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC;YACD,IACE,CAAC,WAAW;gBACZ,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EACpE,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBACtC,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,IAAI,WAAW,EAAE,CAAC;gBAChB,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACxC,CAAC;YACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IACD,IAAI,CAAC,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,SAAS,GAAG,YAAY,CAAC,CAAC,6CAA6C;IACzE,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AACtB,CAAC"}
1
+ {"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAC;AACpC,OAAO,EAAC,QAAQ,EAAC,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAE3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;AAC5C,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1B,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,gBAAgB,GAAa;IACjC,kBAAkB;IAClB,gBAAgB;IAChB,qBAAqB;IACrB,kBAAkB;IAClB,cAAc;IACd,aAAa;IACb,oBAAoB;CACZ,CAAC;AAEX,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;AAClC,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7B,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,EAAG,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,EAAE,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IACpC,IAAI,EAAE,GAAG,GAAG,EAAE,CAAC;QACb,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,CAAM;IACrC,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC;IACxB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACrC,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YACrC,CAAC,IAAI,GAAG,CAAC;YACT,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,CAAC,IAAI,GAAG,CAAC;QACX,CAAC;QACD,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,CAAC,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,uBAAuB,CACrC,GAAW,EACX,EAAW,EACX,SAAkB,EAClB,SAAkB,EAClB,WAAoB;IAEpB,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC;IAC7C,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,EAAE,EAAE,CAAC;YACP,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,UAAU,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YACrC,CAAC,CAAC,IAAI,GAAG,YAAY,CAAC;YACtB,IAAI,UAAU,EAAE,CAAC;gBACf,CAAC,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAC1C,CAAC;iBAAM,IAAI,QAAQ,EAAE,CAAC;gBACpB,gBAAgB,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,SAAS;gBACT,CAAC,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC;YACD,IACE,CAAC,WAAW;gBACZ,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EACpE,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBACtC,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,IAAI,WAAW,EAAE,CAAC;gBAChB,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACxC,CAAC;YACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IACD,IAAI,CAAC,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,SAAS,GAAG,YAAY,CAAC,CAAC,6CAA6C;IACzE,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,SAAS,EAAE,CAAC;QACd,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AACtB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hebcal/rest-api",
3
- "version": "7.0.0",
3
+ "version": "7.0.1",
4
4
  "author": "Michael J. Radwin (https://github.com/mjradwin)",
5
5
  "keywords": [
6
6
  "hebcal"
@@ -49,7 +49,7 @@
49
49
  "devDependencies": {
50
50
  "@hebcal/learning": "^6.9.5",
51
51
  "@hebcal/locales": "^6.5.1",
52
- "@types/node": "^26.1.1",
52
+ "@types/node": "^26.1.2",
53
53
  "gettext-parser": "^9.1.1",
54
54
  "oxlint": "^1.76.0",
55
55
  "prettier": "^3.9.6",