salat 3.1.0 → 3.2.0

package/README.md

@@ -1,9 +1,10 @@
 # Salat [![npm version](https://badge.fury.io/js/salat.svg)](https://badge.fury.io/js/salat)
 
-## Description
+PLEASE SUPPORT THIS REPO WITH A STAR ⭐🌟💫
 
-> Daily prayer time in all the cities in [Morocco](https://www.google.com/search?q=morocco) :morocco:, directly in your terminal, at the tip of your fingers
+## Description
 
+> Daily prayer time in all the cities in [Morocco](https://www.google.com/search?q=morocco) , directly in your terminal, at the tip of your fingers
 
 **A stupid simple Command line utility to get the daily prayers time for all the citiy in Morocco**
 
@@ -11,6 +12,215 @@ The source of the data is [the Moroccan Ministery Website](http://www.habous.gov
 
 ## Getting started
 
+```bash
+npx salat [cityName]
+```
+
+Please note that if the cityName contains space of `'` you need to use quotes, example
+
+```bash
+npx salat "el jadida"
+npx salat "L'msid"
+```
+
+## City List
+
+This is an exhaustive list of the supported cities :
+
+- Agadir
+- Ahfir
+- Ain Aouda
+- Aïn Chaïr
+- Ait El Kak
+- Ait Ourir
+- Akayouar
+- Akdal Amelchil
+- Akdez
+- Akhefnir
+- Akka
+- Aknoul
+- Akoudal Amelchil Midelt
+- Amkala
+- Amsmrir
+- Araich
+- Arbaoua
+- Arfoud
+- Asa
+- Askin
+- Asoul
+- Assila
+- Azemmour
+- Azilal
+- Azrou
+- Bab Bared
+- Ben Ahmed
+- Ben Slimane
+- Bengrir
+- Beni Adrar
+- Beni Ansar
+- Beni Mellal
+- Beni Tejit
+- Berkane
+- Berrchid
+- Bir Anzaran
+- Bir Kandour
+- Bouanan
+- Bouarfa
+- Bouikra
+- Bouizkaren
+- Boujdour
+- Boukrae
+- Boulmane
+- Boumalen Dadas
+- Bourd
+- Bouskoura
+- Bouznika
+- Casablanca
+- Chefchaouan
+- Chichaoua
+- Dakhla
+- Debdou
+- Demnat
+- Deryouche
+- El Brouj
+- El Gara
+- El Hajeb
+- El Jabha
+- El Jadida
+- El Kasba
+- El Mahbes
+- El Menzel
+- Enif
+- Erich
+- Errachidia
+- Essaouira
+- Ezak
+- Fem Lehsan
+- Fem Zkid
+- Ferkhana
+- Fes
+- Fezouane
+- Figuig
+- Fnideq
+- Fquih Ben Salah
+- Geltat Zamour
+- Guelmim
+- Guercif
+- Hoceima
+- Igherem
+- Ikes
+- Imelchil
+- Imin Telat
+- Imntanout
+- Imouzzer Kandar
+- Jerada
+- Kalaat Megouna
+- Kalaat Sraghna
+- Kares
+- Kariat Ba Mohammed
+- Kasbah Tadla
+- Katara
+- Kelmima
+- Kénitra
+- Ketama
+- Khemis Sidi Abd Jelil
+- Khemis Zemamra
+- Khémissat
+- Khenifra
+- Khouribga
+- Ksar El Kebir
+- Ksar El Sghir
+- Ksar Ich
+- L'msid
+- Laayoune
+- Laayoune Sidi Mellouk
+- Lagouira
+- Marrakech
+- Martil
+- Mediek
+- Meknes
+- Melilla
+- Meskoura
+- Metmata
+- Midelt
+- Misour
+- Mohammedia
+- Moulay Bouaza
+- Moulay Bousselham
+- Moulay Yacoub
+- Nador
+- Oualidia
+- Ouazane
+- Oued Amlil
+- Oued Law
+- Oued Zam
+- Oujda
+- Oulad Ayad
+- Oulad Tayma
+- Oulmes
+- Ourzazate
+- Ousered
+- Rabat
+- Ras Alma
+- Remani
+- Rhamna
+- Ribate El Kheir
+- Risani
+- Safi
+- Saïdia
+- Sebta
+- Sefrou
+- Selouane
+- Settat
+- Sidi Benour
+- Sidi Ghanem
+- Sidi Ifni
+- Sidi Kacém
+- Sidi Slimane
+- Sidi Yahya Gharb
+- Smara
+- Souq Arbiâ Gharb
+- Tafntan
+- Tafougalt
+- Tafraouet
+- Tahla
+- Tahla
+- Talouine
+- Talsint
+- Tamslouhet
+- Tanger
+- Tantan
+- Taounat
+- Taourirt
+- Tarfaya
+- Taroudant
+- Tasltanet
+- Tata
+- Taza
+- Tazarin
+- Tefariti
+- Temnar
+- Tendrara
+- Tenghir
+- Tenjedad
+- Tetouan
+- Tiflet
+- Tindit
+- Tisa
+- Tisenet
+- Tizi Ousli
+- Tiznit
+- Toulkoult
+- Yefrin
+- Yousofia
+- Zagoura
+- Zaouiat Ahansal
+- Zaouiat Moulay Ibrahim
+- Zayou
+- Zerhoune
+
+Alternatively You can also install it globally
+
 ```bash
 # Install
 
@@ -25,33 +235,16 @@ $ salat
 $ salat [cityName]
 ```
 
-Alternatively, if you don't want to install it globally, you can just use:
-
-```bash
-npx salat
-```
-
-`City name should be provided the same way it's written in the cities.json`
-
 ## Output
 
 ```bash
 # The programs prints to the console the prayers' time for the current day in the default city as shown bellow:
 ```
+
 ![screen 1](images/screenShot1.png)
 ![screen 2](images/screenShot2.png)
 ![screen 3](images/screenShot3.png)
 
-
-## Dependecies
-
-The code behind depends on :
-
-- [axios](https://github.com/axios/axios) to make an http request ( fetch the data).
-- [jsdom](https://github.com/jsdom/jsdom) to parse the html result.
-- [chalk](https://github.com/chalk/chalk) to avoid boring styles and colors.
-- [node-localstorage](https://github.com/lmaccherone/node-localstorage) to read and write from localstorage.
-
 ## Change the default city
 
 - The default city is :heart: [Marrakech](https://www.google.com/search?q=marrakech) :heart:, set as a value for the `DEFAULT_CITY` variable in `./constants.js`
@@ -68,10 +261,9 @@ The code behind depends on :
 
 - [x] Use a default city
 - [x] Use localstorage-like api for caching purposes
-- [x] Display execution time
 - [ ] Improve performance
 - [ ] Add unit tests
-- [ ] Add a documentation site
+- [x] Add a documentation site
 - [ ] Command to set the default city
 - [ ] Command to display the list of available cities
 - [ ] Command to display the time table for the whole month
@@ -80,4 +272,4 @@ The code behind depends on :
 
 This project is under the MIT license.
 
-### Built With :heart: in Ramadan
+### Built With 💖 in Ramadan

package/dist/app.js

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Project's dependencies
+const chalk_1 = __importDefault(require("chalk"));
+const utils_1 = require("./utils");
+// Project's data
+const constants_1 = require("./constants");
+const cities_json_1 = __importDefault(require("./data/cities.json"));
+// Setting up localStorage
+const node_localstorage_1 = require("node-localstorage");
+const args = process.argv;
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+// Logging function
+const green = (msg) => console.log(chalk_1.default.green(msg));
+// Cast citiesData to City[] properly
+const cities = cities_json_1.default;
+const localStorage = new node_localstorage_1.LocalStorage(constants_1.LOCAL_STORAGE_PATH);
+const cityNameArg = args[2];
+const cityName = (0, utils_1.getCityName)(cityNameArg, cities);
+// Convert string ID to number since getCityId returns number and getData expects number
+const cityId = (0, utils_1.getCityId)(cityName, cities);
+const main = async () => {
+    // Printing a banner ('cause I'm cool and I can do it XD)
+    green(constants_1.BANNER);
+    const storageKey = `${cityName.toLowerCase()}_${new Date().toLocaleDateString()}`;
+    let item = localStorage.getItem(storageKey);
+    // Disable localStorage for local development
+    if (process.env.NODE_ENV === "development") {
+        console.log("development mode: localStorage is disabled");
+        item = null;
+    }
+    let prayers = null;
+    if (item) {
+        prayers = JSON.parse(item);
+    }
+    else {
+        try {
+            const data = await (0, utils_1.getData)(cityId);
+            prayers = (0, utils_1.parsePrayerTimesFromResponse)(data);
+            localStorage.setItem(storageKey, JSON.stringify(prayers));
+        }
+        catch (ex) {
+            //TODO: Use a more descriptive error message
+            console.error("Something went wrong!");
+            console.log(ex);
+            return;
+        }
+    }
+    console.clear();
+    (0, utils_1.displayResult)(prayers, cityName);
+};
+(async () => {
+    await main();
+})();

package/dist/constants.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOCAL_STORAGE_PATH = exports.DEFAULT_CITY = exports.NOT_FOUND_ERROR = exports.BANNER = exports.API_URL = void 0;
+exports.API_URL = "https://www.habous.gov.ma/prieres/horaire-api.php";
+exports.BANNER = ``;
+exports.NOT_FOUND_ERROR = `
+  Your city was not found in the list
+  Using the default city
+  ----------------------
+  You may need to check the spelling
+  `;
+exports.DEFAULT_CITY = "Marrakech";
+exports.LOCAL_STORAGE_PATH = "./storage";

package/dist/data/prayers.json

@@ -0,0 +1,20 @@
+[
+    {
+        "prayer": "Fajr"
+    },
+    {
+        "prayer": "Chorouq"
+    },
+    {
+        "prayer": "Dhuhr"
+    },
+    {
+        "prayer": "Asr"
+    },
+    {
+        "prayer": "Maghrib"
+    },
+    {
+        "prayer": "Ishae"
+    }
+]

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayResult = exports.parsePrayerTimesFromResponse = exports.getData = exports.getCityId = exports.getCityName = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const domino_1 = __importDefault(require("domino"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const constants_1 = require("./constants");
+const prayers_json_1 = __importDefault(require("./data/prayers.json"));
+const error = (msg) => console.log(chalk_1.default.red(msg));
+const getCityName = (arg, cities) => {
+    if (arg == null)
+        return constants_1.DEFAULT_CITY;
+    const index = getCityIndex(arg, cities);
+    if (index === -1) {
+        error(constants_1.NOT_FOUND_ERROR);
+        return constants_1.DEFAULT_CITY;
+    }
+    return arg;
+};
+exports.getCityName = getCityName;
+const getCityId = (arg, cities) => {
+    const parsed = parseInt(arg);
+    if (parsed && cities.length >= parsed) {
+        return parsed;
+    }
+    return getCityIndex(arg, cities) + 1;
+};
+exports.getCityId = getCityId;
+const getCityIndex = (city, cities) => cities.map((e) => e.name.toLowerCase()).indexOf(city.toLowerCase());
+const getData = async (cityId) => {
+    const response = await (0, node_fetch_1.default)(`${constants_1.API_URL}?ville=${cityId}`, {});
+    return await response.text();
+};
+exports.getData = getData;
+const parsePrayerTimesFromResponse = (response) => {
+    const window = domino_1.default.createWindow(response);
+    const document = window.document;
+    const tds = document.getElementsByTagName("td");
+    const prayers = JSON.parse(JSON.stringify(prayers_json_1.default));
+    let j = 0;
+    for (let i = 1; i < tds.length && j < prayers.length; i += 2) {
+        prayers[j].time = tds[i].textContent.trim();
+        j++;
+    }
+    // Transform array to object and return it
+    return prayers.reduce((acc, { prayer, time }) => {
+        if (time) {
+            acc[prayer] = time;
+        }
+        return acc;
+    }, {});
+};
+exports.parsePrayerTimesFromResponse = parsePrayerTimesFromResponse;
+function tConv24(time24) {
+    const [hours, minutes] = time24.split(":");
+    const hour = Number(hours);
+    const formattedHour = hour % 12 || 12;
+    const formattedHourWithZero = (formattedHour + "").padStart(2, "0");
+    const formattedMinutes = minutes.padStart(2, "0");
+    const formattedTime = `${formattedHourWithZero}:${formattedMinutes}`;
+    const ampm = hour < 12 ? "AM" : "PM";
+    return `${formattedTime} ${ampm}`;
+}
+const displayResult = (prayers, city) => {
+    if (!prayers)
+        return;
+    console.log(` 🧭 ${city}, Morocco\n\n 📆 ${new Date().toDateString()}\n`);
+    Object.keys(prayers).forEach((key) => {
+        console.log(` ${chalk_1.default.cyan(key.padEnd(7, " "))} --> ${chalk_1.default.green(tConv24(prayers[key]))}`);
+    });
+    console.log("\n");
+};
+exports.displayResult = displayResult;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "salat",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Daily Moroccan prayers time, right in your console, at the tip of your fingers",
-  "homepage": "https://github.com/kafiln/salat-cli",
-  "main": "app.js",
+  "homepage": "https://kafiln.github.io/salat-cli/",
+  "main": "dist/app.js",
   "bin": {
-    "salat": "app.js"
+    "salat": "dist/app.js"
   },
   "dependencies": {
     "chalk": "^2.4.2",
@@ -14,8 +14,11 @@
     "node-localstorage": "^1.3.1"
   },
   "scripts": {
-    "dev": "env NODE_ENV=development  nodemon app.js",
-    "start": "node app"
+    "dev": "ts-node src/app.ts",
+    "build": "tsc",
+    "start": "node dist/app.js",
+    "prestart": "npm run build",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "prayers",
@@ -29,6 +32,11 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "nodemon": "^3.1.0"
+    "@types/node": "^25.2.1",
+    "@types/node-fetch": "^2.6.13",
+    "@types/node-localstorage": "^1.3.3",
+    "nodemon": "^3.1.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
   }
 }

package/{app.js → src/app.ts}

@@ -1,33 +1,41 @@
 #!/usr/bin/env node
 
 // Project's dependencies
-const chalk = require("chalk");
-const args = process.argv;
-const {
+import chalk from "chalk";
+import {
+  displayResult,
   getCityId,
   getCityName,
-  displayResult,
   getData,
   parsePrayerTimesFromResponse,
-} = require("./utils.js");
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
-
-// Logging functioin
-const green = (msg) => console.log(chalk.green(msg));
+} from "./utils";
 
 // Project's data
-const { BANNER, LOCAL_STORAGE_PATH } = require("./constants");
-const cities = require("./data/cities.json");
+import { BANNER, LOCAL_STORAGE_PATH } from "./constants";
+import citiesData from "./data/cities.json";
+import { City, PrayerTimes } from "./types";
 
 // Setting up localStorage
-const { LocalStorage } = require("node-localstorage");
-localStorage = new LocalStorage(LOCAL_STORAGE_PATH);
+import { LocalStorage } from "node-localstorage";
+
+const args = process.argv;
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+
+// Logging function
+const green = (msg: string) => console.log(chalk.green(msg));
+
+// Cast citiesData to City[] properly
+const cities: City[] = citiesData as City[];
+
+const localStorage = new LocalStorage(LOCAL_STORAGE_PATH);
 
-const cityName = getCityName(args[2], cities);
+const cityNameArg = args[2];
+const cityName = getCityName(cityNameArg, cities);
+// Convert string ID to number since getCityId returns number and getData expects number
 const cityId = getCityId(cityName, cities);
 
 const main = async () => {
-  // Prinitng a banner ('cause I'm cool and I can do it XD)
+  // Printing a banner ('cause I'm cool and I can do it XD)
   green(BANNER);
 
   const storageKey = `${cityName.toLowerCase()}_${new Date().toLocaleDateString()}`;
@@ -38,19 +46,19 @@ const main = async () => {
     console.log("development mode: localStorage is disabled");
     item = null;
   }
-  let prayers;
+  let prayers: PrayerTimes | null = null;
 
   if (item) {
     prayers = JSON.parse(item);
   } else {
     try {
-      prayers = parsePrayerTimesFromResponse(await getData(cityId));
+      const data = await getData(cityId);
+      prayers = parsePrayerTimesFromResponse(data);
       localStorage.setItem(storageKey, JSON.stringify(prayers));
     } catch (ex) {
-      //TODO: Use a more descriptif error message
+      //TODO: Use a more descriptive error message
       console.error("Something went wrong!");
       console.log(ex);
-      // console.log(ex);
       return;
     }
   }

package/src/constants.ts

@@ -0,0 +1,13 @@
+export const API_URL = "https://www.habous.gov.ma/prieres/horaire-api.php";
+
+export const BANNER = ``;
+
+export const NOT_FOUND_ERROR = `
+  Your city was not found in the list
+  Using the default city
+  ----------------------
+  You may need to check the spelling
+  `;
+
+export const DEFAULT_CITY = "Marrakech";
+export const LOCAL_STORAGE_PATH = "./storage";