@kiminix/tp-client 1.0.0 → 1.1.0

package/dist/utils/date-utils.js

@@ -0,0 +1,98 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { differenceInCalendarDays, getUnixTime, isAfter, isBefore, isSameDay, parseISO, setMinutes, setSeconds } from "date-fns";
+// timestamp will be updated every one hour
+export function getTruncatedTimestamp() {
+    return getUnixTime(setMinutes(setSeconds(new Date(), 0), 0));
+}
+export function dateToString(date, options) {
+    if (typeof date == 'string') {
+        return parseISO(date).toLocaleDateString("fr-FR", options);
+    }
+    else {
+        return date.toLocaleDateString("fr-FR", options);
+    }
+}
+export function isBetween(date, start, end) {
+    return (isSameDay(date, start) || isSameDay(date, end) || (isAfter(date, start) && isBefore(date, end)));
+}
+export function isDayAfter(date, dateToCompare, include) {
+    if (include === void 0) { include = false; }
+    return (differenceInCalendarDays(date, dateToCompare) > 0 || (include && differenceInCalendarDays(date, dateToCompare) === 0));
+}
+export function isDayBefore(date, dateToCompare, include) {
+    if (include === void 0) { include = false; }
+    return (differenceInCalendarDays(date, dateToCompare) < 0 || (include && differenceInCalendarDays(date, dateToCompare) === 0));
+}
+/**
+ * timezone {timeZone: 'Africa/Tunis'} should not be set for date without timezone otherwise info will be wrong
+ * ex: if date is in this format: 20/08/2023 , timezone should not be used
+ * @param date
+ * @param options
+ */
+export function toString(date, options) {
+    if (options === void 0) { options = {}; }
+    var mergedOptions = __assign(__assign({
+        weekday: "short",
+        year: "numeric",
+        month: "long",
+        day: "numeric"
+    }, options), { timeZone: undefined } // should be keep in last position to force reset to undefined
+    );
+    return parseISO(date).toLocaleDateString("fr-FR", mergedOptions);
+}
+export function toLocaleTime(date) {
+    // request a weekday along with a long date. ex: 25 juin 2022 10:30
+    var options = {
+        year: "numeric",
+        month: "long",
+        day: "numeric",
+        hour: '2-digit',
+        minute: '2-digit',
+        timeZone: 'Africa/Tunis' // Set the timezone to Tunisia
+    };
+    return parseISO(date).toLocaleTimeString("fr-FR", options);
+}
+/**
+ *
+ * @param date
+ * return a date in this format 'yyyy-MM-dd' ex: 2022-06-25
+ */
+export function toLocaleDate(date) {
+    var options = {
+        year: 'numeric',
+        month: '2-digit',
+        day: '2-digit'
+    };
+    // fr-CA is required to get the correct output format date in 'yyyy-MM-dd' ex: 2022-06-25
+    return date.toLocaleDateString("fr-CA", options);
+}
+var Time = /** @class */ (function () {
+    function Time(hours, minutes, seconds) {
+        this.hours = hours;
+        this.minutes = minutes;
+        this.seconds = seconds;
+    }
+    Time.from = function (date) {
+        return new Time(date.getHours(), date.getMinutes(), date.getSeconds());
+    };
+    Time.prototype.toMinutes = function () {
+        return this.hours * 60 + this.minutes;
+    };
+    Time.prototype.toString = function () {
+        var minutes = this.minutes < 10 ? "0".concat(this.minutes) : "".concat(this.minutes);
+        var hours = this.hours < 10 ? "0".concat(this.hours) : "".concat(this.hours);
+        return "".concat(hours, ":").concat(minutes);
+    };
+    return Time;
+}());
+export { Time };

package/dist/utils/menu-utils.d.ts

@@ -0,0 +1,10 @@
+import { DailyDiscount, LocalDate, PresetMenu } from "../menus/types/get-menus";
+export declare class MenuUtils {
+    static isMenuAvailable(menu: PresetMenu): boolean;
+    static isMenuAvailableByDay(menu: PresetMenu, date: Date): boolean;
+    static getDiscounts(menu: PresetMenu): Map<LocalDate, DailyDiscount>;
+    static getAvailableDiscounts(menu: PresetMenu): Map<LocalDate, DailyDiscount>;
+    static getMinAvailablePrice(menu: PresetMenu): number;
+    static getAvailableDiscountByDay(menu: PresetMenu, date: Date): DailyDiscount | undefined;
+    static getDiscountByDay(menu: PresetMenu, date: Date): DailyDiscount | undefined;
+}

package/dist/utils/menu-utils.js

@@ -0,0 +1,76 @@
+import { parseISO } from "date-fns";
+import { isDayAfter, isDayBefore, toLocaleDate } from "./date-utils";
+var MenuUtils = /** @class */ (function () {
+    function MenuUtils() {
+    }
+    // check if the menu is still available ( from today )
+    MenuUtils.isMenuAvailable = function (menu) {
+        var today = new Date();
+        var endAt = menu.availableUntil ? parseISO(menu.availableUntil) : undefined;
+        return endAt ? isDayBefore(today, endAt, true) : true;
+    };
+    MenuUtils.isMenuAvailableByDay = function (menu, date) {
+        var _a, _b;
+        var localDate = toLocaleDate(date);
+        // check if the menu is available for this day
+        var endAt = menu.availableUntil ? parseISO(menu.availableUntil) : undefined;
+        var isMenuAvailable = endAt ? isDayBefore(date, endAt, true) : true;
+        var isExcluded = (_b = (_a = menu.excludedDays) === null || _a === void 0 ? void 0 : _a.includes(localDate)) !== null && _b !== void 0 ? _b : false;
+        return isMenuAvailable && !isExcluded;
+    };
+    MenuUtils.getDiscounts = function (menu) {
+        var _a;
+        var today = new Date();
+        // correct way to get daily discounts Map instance
+        var discounts_ = (_a = menu.discount) !== null && _a !== void 0 ? _a : {};
+        var discounts = new Map(Object.entries(discounts_));
+        var result = Array.from(discounts.entries())
+            .filter(function (entry) {
+            var dateAsString = entry[0], dailyDiscount = entry[1];
+            var discountDate = parseISO(dateAsString);
+            // check if discount date is available and not in the past
+            return isDayAfter(discountDate, today, true);
+        });
+        return new Map(result);
+    };
+    MenuUtils.getAvailableDiscounts = function (menu) {
+        var _a;
+        var today = new Date();
+        // correct way to get daily discount Map instance
+        var discounts_ = (_a = menu.discount) !== null && _a !== void 0 ? _a : {};
+        var discounts = new Map(Object.entries(discounts_));
+        var result = Array.from(discounts.entries())
+            .filter(function (entry) {
+            var dateAsString = entry[0], dailyDiscount = entry[1];
+            var discountDate = parseISO(dateAsString);
+            // check if discount date is available and not in the past
+            return dailyDiscount.isAvailable && isDayAfter(discountDate, today, true);
+        });
+        return new Map(result);
+    };
+    // return min available price for the menu ( from today )
+    MenuUtils.getMinAvailablePrice = function (menu) {
+        var availableDiscounts = MenuUtils.getAvailableDiscounts(menu);
+        var discounts = Array.from(availableDiscounts.values());
+        // search if there is a lower price in the daily settings
+        return discounts
+            .reduce(function (min, dailyDiscount) {
+            var _a;
+            return Math.min(min, (_a = dailyDiscount === null || dailyDiscount === void 0 ? void 0 : dailyDiscount.price) === null || _a === void 0 ? void 0 : _a.adult);
+        }, menu.price.adult);
+    };
+    MenuUtils.getAvailableDiscountByDay = function (menu, date) {
+        // correct way to get daily discount Map instance
+        var discounts = MenuUtils.getAvailableDiscounts(menu);
+        var localDate = toLocaleDate(date);
+        return discounts.get(localDate);
+    };
+    MenuUtils.getDiscountByDay = function (menu, date) {
+        // correct way to get daily discount Map instance
+        var discounts = MenuUtils.getDiscounts(menu);
+        var localDate = toLocaleDate(date);
+        return discounts.get(localDate);
+    };
+    return MenuUtils;
+}());
+export { MenuUtils };

package/package.json

@@ -1,11 +1,28 @@
 {
   "name": "@kiminix/tp-client",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "1.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
   "scripts": {
+    "build": "tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",
   "license": "ISC",
-  "description": ""
+  "description": "",
+  "devDependencies": {
+    "@types/node": "20.11.16",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "eslint": "^8.56.0",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "axios": "^1.6.7",
+    "date-fns": "^3.3.1",
+    "purify-ts": "^2.0.3"
+  }
 }