@hebcal/leyning 8.2.2 → 8.2.3

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.
package/dist/leyning.d.ts CHANGED
@@ -18,14 +18,13 @@ export declare function getLeyningForParsha(parsha: string | string[]): Leyning;
18
18
  /**
19
19
  * Looks up leyning for a regular Shabbat parsha, including any special
20
20
  * maftir or Haftara.
21
- * @param {Event} ev the Hebcal event associated with this leyning
22
- * @param {boolean} [il] in Israel
23
- * @return {Leyning} map of aliyot
21
+ * @param ev the Hebcal event associated with this leyning
22
+ * @param [il] in Israel
23
+ * @returns map of aliyot
24
24
  */
25
25
  export declare function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
26
26
  /**
27
27
  * Returns the parsha metadata
28
- * @param {string|string[]} parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
29
- * @return {ParshaMeta}
28
+ * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
30
29
  */
31
30
  export declare function lookupParsha(parsha: string | string[]): ParshaMeta;
package/dist/types.d.ts CHANGED
@@ -98,18 +98,20 @@ export type LeyningWeekday = LeyningParshaHaShavua & {
98
98
  /** Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday */
99
99
  weekday?: AliyotMap;
100
100
  };
101
- /**
102
- * Shabbat and holiday leyning always has full kriyah and haftarah
103
- */
104
- export type LeyningShabbatHoliday = LeyningBase & {
105
- /** Map of aliyot `1` through `7` plus `M` for maftir */
106
- fullkriyah: AliyotMap;
101
+ export type HaftarahProps = {
107
102
  /** Haftarah object */
108
103
  haft: Aliyah | Aliyah[];
109
104
  /** Haftarah, such as `Isaiah 42:5 – 43:11` */
110
105
  haftara: string;
111
106
  /** Number of verses in the Haftarah */
112
107
  haftaraNumV?: number;
108
+ };
109
+ /**
110
+ * Shabbat and holiday leyning always has full kriyah and haftarah
111
+ */
112
+ export type LeyningShabbatHoliday = LeyningBase & HaftarahProps & {
113
+ /** Map of aliyot `1` through `7` plus `M` for maftir */
114
+ fullkriyah: AliyotMap;
113
115
  /** Haftarah object for Sephardim */
114
116
  seph?: Aliyah | Aliyah[];
115
117
  /** Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hebcal/leyning",
3
- "version": "8.2.2",
3
+ "version": "8.2.3",
4
4
  "author": "Michael J. Radwin (https://github.com/mjradwin)",
5
5
  "keywords": [
6
6
  "hebcal",
@@ -40,36 +40,38 @@
40
40
  "leyning-csv": "bin/leyning-csv"
41
41
  },
42
42
  "dependencies": {
43
- "@hebcal/core": "^5.4.6",
44
- "tslib": "^2.6.3"
43
+ "@hebcal/core": "^5.5.0",
44
+ "tslib": "^2.7.0"
45
45
  },
46
46
  "scripts": {
47
47
  "build:rollup": "rollup -c",
48
48
  "build:json2js": "for f in src/*.json; do echo 'export default' > $f.ts && cat $f >> $f.ts; done",
49
49
  "build": "npm run build:json2js && npm run build:rollup",
50
50
  "prepublish": "npm run build",
51
- "readme": "npx jsdoc2md dist/index.js",
51
+ "docs": "typedoc",
52
52
  "pretest": "npm run build",
53
- "test": "jest"
53
+ "lint": "gts lint",
54
+ "coverage": "jest --coverage",
55
+ "test": "jest",
56
+ "clean": "gts clean",
57
+ "fix": "gts fix"
54
58
  },
55
59
  "license": "BSD-2-Clause",
56
60
  "devDependencies": {
57
- "@babel/preset-env": "^7.24.7",
61
+ "@babel/preset-env": "^7.25.4",
58
62
  "@babel/preset-typescript": "^7.24.7",
59
- "@rollup/plugin-commonjs": "^26.0.1",
63
+ "@rollup/plugin-commonjs": "^28.0.0",
60
64
  "@rollup/plugin-json": "^6.1.0",
61
- "@rollup/plugin-node-resolve": "^15.2.3",
65
+ "@rollup/plugin-node-resolve": "^15.3.0",
62
66
  "@rollup/plugin-terser": "^0.4.4",
63
- "@rollup/plugin-typescript": "^11.1.6",
64
- "@types/jest": "^29.5.12",
65
- "eslint": "^8.57.0",
66
- "eslint-config-google": "^0.14.0",
67
+ "@rollup/plugin-typescript": "^12.1.0",
68
+ "@types/jest": "^29.5.13",
69
+ "@types/node": "^22.7.2",
67
70
  "gts": "^5.3.1",
68
71
  "jest": "^29.7.0",
69
- "jsdoc": "^4.0.3",
70
- "jsdoc-to-markdown": "^8.0.1",
71
- "rollup": "^4.18.0",
72
- "ts-jest": "^29.1.5",
73
- "typescript": "^5.5.2"
72
+ "rollup": "^4.22.4",
73
+ "ts-jest": "^29.2.5",
74
+ "typedoc": "^0.26.7",
75
+ "typescript": "^5.6.2"
74
76
  }
75
77
  }