@kiminix/tp-client 1.0.0 → 1.2.0

package/dist/sitemap/apis.js

@@ -0,0 +1,58 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import axios from "axios";
+import { base } from "../constants";
+// others module APIs
+var SitemapAPIs = /** @class */ (function () {
+    function SitemapAPIs() {
+    }
+    SitemapAPIs.get = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, axios.get(base + "/sitemap")
+                            .then(function (response) {
+                            return response.data;
+                        })];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return SitemapAPIs;
+}());
+export { SitemapAPIs };

package/dist/types.d.ts

@@ -0,0 +1,4 @@
+export interface ApiError {
+    message: string;
+    code?: string;
+}

package/dist/types.js

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

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

@@ -0,0 +1,29 @@
+export declare function getTruncatedTimestamp(): number;
+export declare function dateToString(date: string | Date, options: Intl.DateTimeFormatOptions): string;
+export declare function toStringDefault(date: string, options: Intl.DateTimeFormatOptions): string;
+export declare function isBetween(date: Date, start: Date, end: Date): boolean;
+export declare function isDayAfter(date: Date, dateToCompare: Date, include?: Boolean): boolean;
+export declare function isDayBefore(date: Date, dateToCompare: Date, include?: Boolean): boolean;
+/**
+ * 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 declare function toString(date: string, options?: Intl.DateTimeFormatOptions): string;
+export declare function toLocaleTime(date: string): string;
+/**
+ *
+ * @param date
+ * return a date in this format 'yyyy-MM-dd' ex: 2022-06-25
+ */
+export declare function toLocaleDate(date: Date): string;
+export declare class Time {
+    hours: number;
+    minutes: number;
+    seconds: number;
+    constructor(hours: number, minutes: number, seconds: number);
+    static from(date: Date): Time;
+    toMinutes(): number;
+    toString(): string;
+}

package/dist/utils/date-utils.js

@@ -0,0 +1,101 @@
+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 toStringDefault(date, options) {
+    return parseISO(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.2.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"
+  }
 }