jcal-zmanim 1.0.4

package/build/Settings.d.ts

@@ -0,0 +1,25 @@
+import Location from './JCal/Location';
+import { ZmanToShow } from './jcal-zmanim';
+export default class Settings {
+    zmanimToShow: ZmanToShow[];
+    location: Location;
+    showNotifications: boolean;
+    numberOfItemsToShow: number;
+    minToShowPassedZman: number;
+    showGaonShir: boolean;
+    showDafYomi: boolean;
+    english: boolean;
+    /**
+     *
+     * @param {[ZmanToShow]} [zmanimToShow] List of which zmanim to show
+     * @param {Location} [location]
+     * @param {boolean} [showNotifications] Show shul notifications?
+     * @param {number} [numberOfItemsToShow] Number of zmanim to show on the main screen
+     * @param {number} [minToShowPassedZman] Number of minutes to continue showing zmanim that have passed
+     * @param {boolean} [showGaonShir] Show the Shir Shel Yom of the Gr"a?
+     * @param {boolean} [showDafYomi] Show the Daf Yomi?
+     * @param {boolean} [english] Show in English?
+     */
+    constructor(zmanimToShow?: ZmanToShow[], location?: Location, showNotifications?: boolean, numberOfItemsToShow?: number, minToShowPassedZman?: number, showGaonShir?: boolean, showDafYomi?: boolean, english?: boolean);
+    clone(): Settings;
+}

package/build/Settings.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Locations_1 = require("./Locations");
+const GeneralUtils_1 = require("./GeneralUtils");
+const ZmanTypes_1 = require("./ZmanTypes");
+class Settings {
+    /**
+     *
+     * @param {[ZmanToShow]} [zmanimToShow] List of which zmanim to show
+     * @param {Location} [location]
+     * @param {boolean} [showNotifications] Show shul notifications?
+     * @param {number} [numberOfItemsToShow] Number of zmanim to show on the main screen
+     * @param {number} [minToShowPassedZman] Number of minutes to continue showing zmanim that have passed
+     * @param {boolean} [showGaonShir] Show the Shir Shel Yom of the Gr"a?
+     * @param {boolean} [showDafYomi] Show the Daf Yomi?
+     * @param {boolean} [english] Show in English?
+     */
+    constructor(zmanimToShow, location, showNotifications, numberOfItemsToShow, minToShowPassedZman, showGaonShir, showDafYomi, english) {
+        /**
+         * @property {[ZmanToShow]} zmanimToShow List of which zmanim to show
+         */
+        this.zmanimToShow = (zmanimToShow || [
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.ChatzosLayla),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.Alos72),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.TalisTefillin),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.NetzMishor),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.szksMga),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.szksGra),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.sztMga),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.sztGra),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.chatzosDay),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.minGed),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.minKet),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.plag),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.shkiaElevation),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.tzais50),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.tzais72),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.candleLighting),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.SofZmanEatingChometz),
+            (0, ZmanTypes_1.getZmanType)(ZmanTypes_1.ZmanTypeIds.SofZmanBurnChometz), //Sof Zman burn Chometz
+        ]);
+        /**
+         * @property {Location} location
+         */
+        this.location = (location || (0, Locations_1.findLocation)('Lakewood NJ'));
+        /**
+         * @property {boolean} showNotifications Show shul notifications?
+         */
+        this.showNotifications = (0, GeneralUtils_1.setDefault)(showNotifications, true);
+        /**
+         * @property {number} numberOfItemsToShow Number of zmanim to show on the main screen
+         */
+        this.numberOfItemsToShow = (0, GeneralUtils_1.setDefault)(numberOfItemsToShow, 5);
+        /**
+         * @property {number} minToShowPassedZman Number of minutes to continue showing zmanim that have passed
+         */
+        this.minToShowPassedZman = (0, GeneralUtils_1.setDefault)(minToShowPassedZman, 15);
+        /**
+         * @property {boolean} [showGaonShir] Show the Shir Shel Yom of the Gr"a?
+         */
+        this.showGaonShir = (0, GeneralUtils_1.setDefault)(showGaonShir, false);
+        /**
+         * @property {boolean} [showDafYomi] Show Daf Yomi?
+         */
+        this.showDafYomi = (0, GeneralUtils_1.setDefault)(showDafYomi, true);
+        /**
+         * @property {boolean} [english] Should the language be English?
+         */
+        this.english = (0, GeneralUtils_1.setDefault)(english, true);
+    }
+    clone() {
+        return new Settings([...this.zmanimToShow], this.location, this.showNotifications, this.numberOfItemsToShow, this.minToShowPassedZman, this.showGaonShir, this.showDafYomi, this.english);
+    }
+}
+exports.default = Settings;

package/build/ZmanTypes.d.ts

@@ -0,0 +1,34 @@
+import { ZmanToShow } from './jcal-zmanim';
+export declare const ZmanTypeIds: Readonly<{
+    ChatzosLayla: 0;
+    Alos90: 1;
+    Alos72: 2;
+    TalisTefillin: 3;
+    NetzAtElevation: 4;
+    NetzMishor: 5;
+    szksMga: 6;
+    szksGra: 7;
+    sztMga: 8;
+    sztGra: 9;
+    chatzosDay: 10;
+    minGed: 11;
+    minKet: 12;
+    plag: 13;
+    shkiaAtSeaLevel: 14;
+    shkiaElevation: 15;
+    tzais45: 16;
+    tzais50: 17;
+    tzais72: 18;
+    rabbeinuTamZmanios: 19;
+    rabbeinuTamZmaniosMga: 20;
+    candleLighting: 21;
+    SofZmanEatingChometz: 22;
+    SofZmanBurnChometz: 23;
+}>;
+export declare const ZmanTypes: ZmanToShow[];
+/**
+ * Get the ZmanType with the given id or name.
+ * @param {Number} id
+ * @returns {{id:number, desc: String, eng: String, heb: String }}
+ */
+export declare function getZmanType(id: number): ZmanToShow | undefined;

package/build/ZmanTypes.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getZmanType = exports.ZmanTypes = exports.ZmanTypeIds = void 0;
+exports.ZmanTypeIds = Object.freeze({
+    ChatzosLayla: 0,
+    Alos90: 1,
+    Alos72: 2,
+    TalisTefillin: 3,
+    NetzAtElevation: 4,
+    NetzMishor: 5,
+    szksMga: 6,
+    szksGra: 7,
+    sztMga: 8,
+    sztGra: 9,
+    chatzosDay: 10,
+    minGed: 11,
+    minKet: 12,
+    plag: 13,
+    shkiaAtSeaLevel: 14,
+    shkiaElevation: 15,
+    tzais45: 16,
+    tzais50: 17,
+    tzais72: 18,
+    rabbeinuTamZmanios: 19,
+    rabbeinuTamZmaniosMga: 20,
+    candleLighting: 21,
+    SofZmanEatingChometz: 22,
+    SofZmanBurnChometz: 23,
+});
+exports.ZmanTypes = [
+    {
+        id: exports.ZmanTypeIds.ChatzosLayla,
+        desc: 'חצות הלילה',
+        eng: 'Chatzos - Midnight',
+        heb: 'חצות הלילה',
+    },
+    {
+        id: exports.ZmanTypeIds.Alos90,
+        desc: 'עלות השחר - 90 דקות',
+        eng: 'Alos Hashachar - 90',
+        heb: 'עלות השחר (90)',
+    },
+    {
+        id: exports.ZmanTypeIds.Alos72,
+        desc: 'עלות השחר - 72 דקות',
+        eng: 'Alos Hashachar - 72',
+        heb: 'עלות השחר (72)',
+    },
+    {
+        id: exports.ZmanTypeIds.TalisTefillin,
+        desc: 'זמן עטיפת טלית ותפילין - 36 דקות',
+        eng: 'Taliss and Tefillin',
+        heb: 'טלית ותפילין',
+    },
+    {
+        id: exports.ZmanTypeIds.NetzAtElevation,
+        desc: 'הנץ החמה בגובה המיקום',
+        eng: 'Sunrise at current elevation',
+        heb: 'הנץ החמה - מגובה',
+    },
+    {
+        id: exports.ZmanTypeIds.NetzMishor,
+        desc: 'הנץ החמה בגובה פני הים',
+        eng: 'Sunrise',
+        heb: 'הנץ החמה',
+    },
+    {
+        id: exports.ZmanTypeIds.szksMga,
+        desc: 'סזק"ש מג"א',
+        eng: 'Zman Krias Shma - MG"A',
+        heb: 'סזק"ש מג"א',
+    },
+    {
+        id: exports.ZmanTypeIds.szksGra,
+        desc: 'סזק"ש הגר"א',
+        eng: 'Zman Krias Shma - GR"A',
+        heb: 'סזק"ש הגר"א',
+    },
+    {
+        id: exports.ZmanTypeIds.sztMga,
+        desc: 'סז"ת מג"א',
+        eng: 'Zman Tefilla - MG"A',
+        heb: 'סז"ת מג"א',
+    },
+    {
+        id: exports.ZmanTypeIds.sztGra,
+        desc: 'סז"ת הגר"א',
+        eng: 'Zman Tefilla - GR"A',
+        heb: 'סז"ת הגר"א',
+    },
+    {
+        id: exports.ZmanTypeIds.chatzosDay,
+        desc: 'חצות היום',
+        eng: 'Chatzos - Midday',
+        heb: 'חצות היום',
+    },
+    {
+        id: exports.ZmanTypeIds.minGed,
+        desc: 'מנחה גדולה',
+        eng: 'Mincha Gedola',
+        heb: 'מנחה גדולה',
+    },
+    {
+        id: exports.ZmanTypeIds.minKet,
+        desc: 'מנחה קטנה',
+        eng: 'Mincha Ketana',
+        heb: 'מנחה קטנה',
+    },
+    {
+        id: exports.ZmanTypeIds.plag,
+        desc: 'פלג המנחה',
+        eng: 'Plag HaMincha',
+        heb: 'פלג המנחה',
+    },
+    {
+        id: exports.ZmanTypeIds.shkiaAtSeaLevel,
+        desc: 'שקיעת החמה מגובה פני הים',
+        eng: 'Sunset at sea level',
+        heb: 'שקיעת החמה - ממישור',
+    },
+    {
+        id: exports.ZmanTypeIds.shkiaElevation,
+        desc: 'שקיעת החמה מגובה המיקום',
+        eng: 'Sunset',
+        heb: 'שקיעת החמה',
+    },
+    {
+        id: exports.ZmanTypeIds.tzais45,
+        desc: '45 דקות אחרי שקיעה',
+        eng: 'Nightfall - 45',
+        heb: 'צאת הכוכבים (45)',
+    },
+    {
+        id: exports.ZmanTypeIds.tzais50,
+        desc: '50 דקות אחרי שקיעה',
+        eng: 'Nightfall - 50',
+        heb: 'צאת הכוכבים (50)',
+    },
+    {
+        id: exports.ZmanTypeIds.tzais72,
+        desc: '72 דקות אחרי שקיעה',
+        eng: 'Rabbeinu Tam',
+        heb: 'צה"כ ר"ת - 72 דקות',
+    },
+    {
+        id: exports.ZmanTypeIds.rabbeinuTamZmanios,
+        desc: '72 דקות זמניות אחרי שקיעה',
+        eng: 'Rabbeinu Tam - Zmanios',
+        heb: 'צה"כ ר"ת - זמניות',
+    },
+    {
+        id: exports.ZmanTypeIds.rabbeinuTamZmaniosMga,
+        desc: '72 דקות זמניות אחרי שקיעה - מג"א',
+        eng: 'Rabbeinu Tam - Zmanios MG"A',
+        heb: 'צה"כ ר"ת - זמניות מג"א',
+    },
+    {
+        id: exports.ZmanTypeIds.candleLighting,
+        desc: 'זמן הדלקת נרות',
+        eng: 'Candle lighting time',
+        heb: 'זמן הדלקת נרות',
+    },
+    {
+        id: exports.ZmanTypeIds.SofZmanEatingChometz,
+        desc: 'סוף זמן אכילת חמץ',
+        eng: 'Stop eating Chometz',
+        heb: 'סוף זמן אכילת חמץ',
+    },
+    {
+        id: exports.ZmanTypeIds.SofZmanBurnChometz,
+        desc: 'סוף זמן ביעור חמץ',
+        eng: 'Destroy Chometz',
+        heb: 'סוף זמן ביעור חמץ',
+    },
+];
+/**
+ * Get the ZmanType with the given id or name.
+ * @param {Number} id
+ * @returns {{id:number, desc: String, eng: String, heb: String }}
+ */
+function getZmanType(id) {
+    return exports.ZmanTypes.find(zt => zt.id === id);
+}
+exports.getZmanType = getZmanType;

package/build/index.d.ts

@@ -0,0 +1 @@
+export {};

package/build/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utils_js_1 = __importDefault(require("./JCal/Utils.js"));
+const Zmanim_js_1 = __importDefault(require("./JCal/Zmanim.js"));
+const Settings_js_1 = __importDefault(require("./Settings.js"));
+const jDate_js_1 = __importDefault(require("./JCal/jDate.js"));
+const Location_js_1 = __importDefault(require("./JCal/Location.js"));
+const Locations_js_1 = require("./Locations.js");
+const ZmanTypes_js_1 = require("./ZmanTypes.js");
+const Molad_js_1 = __importDefault(require("./JCal/Molad.js"));
+const PirkeiAvos_js_1 = __importDefault(require("./JCal/PirkeiAvos.js"));
+const Dafyomi_js_1 = __importDefault(require("./JCal/Dafyomi.js"));
+const Sedra_js_1 = __importDefault(require("./JCal/Sedra.js"));
+const AppUtils_js_1 = __importStar(require("./AppUtils.js"));
+const Notifications_js_1 = __importDefault(require("./Notifications.js"));
+module.exports = {
+    Utils: Utils_js_1.default,
+    AppUtils: AppUtils_js_1.default,
+    DaysOfWeek: AppUtils_js_1.DaysOfWeek,
+    getNotifications: Notifications_js_1.default,
+    Locations: Locations_js_1.Locations,
+    findLocation: Locations_js_1.findLocation,
+    ZmanTypes: ZmanTypes_js_1.ZmanTypes,
+    ZmanTypeIds: ZmanTypes_js_1.ZmanTypeIds,
+    Zmanim: Zmanim_js_1.default,
+    Location: Location_js_1.default,
+    Settings: Settings_js_1.default,
+    jDate: jDate_js_1.default,
+    Molad: Molad_js_1.default,
+    PirkeiAvos: PirkeiAvos_js_1.default,
+    Dafyomi: Dafyomi_js_1.default,
+    Sedra: Sedra_js_1.default
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "jcal-zmanim",
+  "description": "A very complete JavaScript library for the Jewish Calendar, Zmanim, Holidays, and daily Shul notes.",
+  "version": "1.0.4",
+  "main": "build/index.js",
+  "devDependencies": {
+    "@types/node": "20.8.10",
+    "rimraf": "5.0.5",
+    "typescript": "5.2.2"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rimraf ./build && NODE_ENV=production && tsc",
+    "build-dev": "NODE_ENV=development && tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cbsom/jCal.git"
+  },
+  "keywords": [
+    "Calendar",
+    "Jewish",
+    "Halacha",
+    "Zmanim",
+    "Shul"
+  ],
+  "author": "Chaim B. Sommers <cb@compute.co.il>",
+  "license": "GPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/cbsom/jCal/issues"
+  },
+  "homepage": "https://github.com/cbsom/jCal#readme"
+}