mts-booking-library 2.4.14 → 3.0.1

package/lib/types/journeys/Trip.d.ts

@@ -1,12 +1,76 @@
+import { DateWithTimeZone } from "../common/dates";
 import { TariffsMatrix, TariffType, TermsType } from "../common/Tariffs";
 export type Trip = {
+    /** The unique identifier for the trip */
     id: number;
-    date: Date;
-    departureStopName: string;
-    destinationStopName: string;
-    tariffsMatrix: TariffsMatrix;
-    tariffTypes: TariffType[];
-    termsTypes: TermsType[];
+    /** The name of the trip */
+    name?: string;
+    /** Extension of the trip name */
+    nameExtension?: string;
+    /** LinkAvel Bus name */
+    linkAvelBusName?: string;
+    /** Extended name of the trip */
+    extendedName?: string;
+    /** Whether the trip is tentative */
+    tentative?: boolean;
+    /** Whether the trip is canceled */
+    canceled?: boolean;
+    /** Bus ID */
+    busId?: number;
+    /** Seller ID */
+    sellerId?: number;
+    /** Route ID */
+    routeId?: number;
+    /** Route name */
+    routeName?: string;
+    /** Line ID */
+    lineId?: number;
+    /** Line name */
+    lineName?: string;
+    /** Whether it's a service */
+    isService?: boolean;
+    /** Line type */
+    lineType?: string;
+    /** Date of the trip */
+    date?: string;
+    /** Date as string */
+    dateString?: string;
+    /** Whether the trip is sellable */
+    isSellable?: boolean;
+    /** Apex related trip ID */
+    apexRelatedTripId?: number;
+    /** Related trips IDs */
+    relatedTripsIds?: number[];
+    /** Departure time */
+    departureTime?: string;
+    /** Destination time */
+    destinationTime?: string;
+    /** Departure time as ISO string */
+    departureDateTime?: DateWithTimeZone;
+    /** Destination time as ISO string */
+    destinationDateTime?: DateWithTimeZone;
+    /** All bus tickets IDs */
+    allBusTicketsIds?: number[];
+    /** Ongoing route stop ID to bus tickets IDs mapping */
+    ongoingRouteStopIdToBusTicketsIds?: Record<string, number[]>;
+    /** Destination route stop ID to bus tickets IDs mapping */
+    destinationRouteStopIdToBusTicketsIds?: Record<string, number[]>;
+    /** Departure route stop ID to bus tickets IDs mapping */
+    departureRouteStopIdToBusTicketsIds?: Record<string, number[]>;
+    /** The name of the departure stop */
+    departureStopName?: string;
+    /** Departure physical agency stop ID */
+    departurePhysicalAgencyStopId?: number;
+    /** The name of the destination stop */
+    destinationStopName?: string;
+    /** Destination physical agency stop ID */
+    destinationPhysicalAgencyStopId?: number;
+    /** List of the tariffTypes to be found in the tariffsMatrix */
+    tariffTypes?: TariffType[];
+    /** List of the termsTypes to be found in the tariffsMatrix */
+    termsTypes?: TermsType[];
+    /** Tariff matrix for this trip */
+    tariffsMatrix?: TariffsMatrix;
 };
 /**
  * This type is used to represent a trip for the reduction page. This only makes sense for a JourneyBooking,

package/lib/types/services/Service.d.ts

@@ -26,18 +26,27 @@ export type Service = {
     isDateRequired: boolean;
     isTripMandatory: boolean;
 };
+export type TripIdAndHour = {
+    /** The id of the trip. */
+    tripId: number;
+    /** The hour of the trip. */
+    hour: string;
+};
 export type ServiceTrip = {
-    tripId?: number;
-    date: Date;
+    /** The name of the service */
     name: string;
+    /** The date and time of the service in ISO string format, if set. */
+    serviceDate?: string;
+    /** The id of the trip, if set. */
+    tripId?: number;
 };
 /**
  * @description Represents a response from the service trips endpoint
  * @param {boolean} areThereTrips - Indicates whether there are trips available for the service.
- * @param {ServiceTrip[]} trips - An array of {@link ServiceTrip} objects representing the available trips. This can be empty
+ * @param {TripIdAndHour[]} trips - An array of {@link TripIdAndHour} objects representing the available trips. This can be empty
  * even if `areThereTrips` is true, as the user might be not allowed to select a specific trip.
  */
 export type ServiceTripsResponse = {
     areThereTrips: boolean;
-    trips: ServiceTrip[];
+    trips: TripIdAndHour[];
 };

package/lib/types/services/ServiceCart.d.ts

@@ -2,49 +2,22 @@ import { Booking } from "../../booking/booking";
 import { Cart } from "../common/Cart";
 import { TariffSummary } from "../common/Tariffs";
 import { ServiceTrip } from "./Service";
-/**
- * This is the object to be passed to `ServiceBooking.createServiceCart`, containing
- * information about the selected service.
- */
-export type CreateServiceCartRequest = {
-    /** The currency in which the service is priced. */
-    currency: Booking.Currencies;
-    /** Information about the selected service. */
-    service: {
-        /** The unique identifier for the service. */
-        serviceId: number;
-        /** A record containing tariff ids as keys and their respective quantities as values. */
-        tariffIdToQuantity: Record<number, number>;
-        /** The date for the service in ISO string format (optional). */
-        date?: string;
-        /** The unique identifier for the trip (optional). */
-        tripId?: number;
-        /** The id of the OTA Reseller that sold the ticket */
-        otaResellerId?: number;
-        /** A string in base64 representing the picture of the ticket that was sold */
-        otaTicketPicture?: string;
-    };
-};
 /**
  * @description Represents a `ServiceCart`, which extends the {@link Cart} type by including additional
  * information about the bookings
- *
- * @property {ServiceBooking[]} bookings - An array of {@link ServiceBookingType} objects representing the bookings associated
- * with this journey cart.
  */
 export type ServiceCart = Cart & {
+    /** An array of {@link ServiceBookingType} objects representing the bookings associated with this journey cart. */
     bookings: ServiceBookingType[];
 };
 /**
  * @description Represents a `ServiceBooking`, which contains information about a service booking.
- *
- * @property {Booking.BookingTypes} type - The type of booking. For services, this is always `Booking.BookingTypes.SERVICE`.
- * @property {TariffSummary[]} summary - An array of {@link TariffSummary} objects representing the tariff summary
- * associated with this journey booking.
- * @property {ServiceTrip} info - An array of {@link ServiceTrip} objects representing the stops associated with this journey booking.
  */
 export type ServiceBookingType = {
+    /** The type of booking. For services, this is always `Booking.BookingTypes.SERVICE`. */
     type: Booking.BookingTypes;
+    /** An array of {@link TariffSummary} objects representing the tariff summary associated with this journey booking. */
     summary: TariffSummary[];
+    /** Information about the service. */
     info: ServiceTrip;
 };

package/lib/types/subscriptions/SubscriptionAvailabilities.d.ts

@@ -30,40 +30,38 @@ export type GetSubscriptionAvailabilityRequest = {
  * @description This is the object to be returned by to `SubscriptionBooking.getSubscrptionAvailabilities`,
  * containing general information about the selected subscription as well as the list of periods in which it is possible to
  * book the subscription.
- *
- * @property {string} departureStopName - The name of the departure stop.
- * @property {string} destinationStopName - The name of the destination stop.
- * @property {Date} outboundDepartureTime - The departure time of the outbound trip.
- * @property {Date} outboundDestinationTime - The destination time of the outbound trip.
- * @property {Date} returnDepartureTime - The departure time of the return trip.
- * @property {Date} returnDestinationTime - The destination time of the return trip.
- * @property {SubscriptionCalendarDayPeriodInfo[]} periods - The list of periods for which the availability of the subscription was checked.
  */
 export type GetSubscriptionAvailabilityResponse = {
+    /** The name of the departure stop. */
     departureStopName: string;
+    /** The name of the destination stop. */
     destinationStopName: string;
-    outboundDepartureTime: Date;
-    outboundDestinationTime: Date;
-    returnDepartureTime: Date;
-    returnDestinationTime: Date;
+    /** The departure time of the outbound trip in hh:mm format */
+    outboundDepartureTimeString: string;
+    /** The destination time of the outbound trip in hh:mm format */
+    outboundDestinationTimeString: string;
+    /** The departure time of the return trip in hh:mm format */
+    returnDepartureTimeString: string | null;
+    /** The destination time of the return trip in hh:mm format */
+    returnDestinationTimeString: string | null;
+    /** The list of periods for which the availability of the subscription was checked. */
     periods: SubscriptionCalendarDayPeriodInfo[];
 };
 /**
  * @description This is the object descibing the availability of a subscription for a given period.
- * Note that it is possible to book a subscription only is both {@link journeyAvailable} and {@link isAvailable} are true.
- *
- * @property {string} periodName - The name of the period (e.g. "July 2023")
- * @property {Date} dateFrom - The start date of the period.
- * @property {Date} dateTo - The end date of the period.
- * @property {number} price - The price of the subscription for the given period.
- * @property {boolean} journeyAvailable - Whether this subscription is available in this period.
- * @property {boolean} isAvailable - If this subscription is available (i.e. if {@link journeyAvailable} is true), this tells whether it can be booked
+ * Note that it is possible to book a subscription only is both journeyAvailable and isAvailable are true.
  */
 export type SubscriptionCalendarDayPeriodInfo = {
+    /** The name of the period (e.g. "July 2023") */
     periodName: string;
-    dateFrom: Date;
-    dateTo: Date;
+    /** The start date of the period in ISO string format */
+    dateFrom: string;
+    /** The end date of the period in ISO string format */
+    dateTo: string;
+    /** The price of the subscription for the given period */
     price: number;
+    /** Whether this subscription is available in this period */
     journeyAvailable: boolean;
+    /** If this subscription is available (i.e. if journeyAvailable is true), this tells whether it can be booked */
     isAvailable: boolean;
 };

package/lib/types/subscriptions/SubscriptionCart.d.ts

@@ -31,13 +31,12 @@ export type CreateSubscriptionCartRequest = {
     periods: SubscriptionPeriod[];
 };
 /**
- * @description This is the object that describes which perios should be booked.
- *
- * @property {string} dateFrom - The start date of the period as returned by {@link SubscriptionBooking.getSubscrptionAvailabilities}.
- * @property {string} dateTo - The end date of the period as returned by {@link SubscriptionBooking.getSubscrptionAvailabilities}.
+ * @description This is the object that describes which periods should be booked.
  */
 export type SubscriptionPeriod = {
+    /** The start date of the period in ISO string format as returned by {@link SubscriptionBooking.getSubscrptionAvailabilities} */
     dateFrom: string;
+    /** The end date of the period in ISO string format as returned by {@link SubscriptionBooking.getSubscrptionAvailabilities} */
     dateTo: string;
 };
 /**

package/lib/types/subscriptions/Subscriptions.d.ts

@@ -1,26 +1,25 @@
 /**
  * @description This is the object to be returned by to `SubscriptionBooking.getSubscrptions`, containing information about the selected subscription.
- *
- * @property {number} departurePhysicalAgencyStopId - The id of the departure stop.
- * @property {string} departureStopName - The name of the departure stop.
- * @property {number} destinationPhysicalAgencyStopId - The id of the destination stop.
- * @property {string} destinationStopName - The name of the destination stop.
- * @property {string} departureTime - The time of departure from the departureStop.
- * @property {string} destinationTime - The time of arrival to the destinationStop.
- * @property {string} lineName - The name of the line on which the subscription is sold.
- * @property {number} routeId - The id of the route on which the subscription is sold.
- * @property {string} routeName - The name of the route on which the subscription is sold.
- * @property {number} sellerId - The id of the seller selling the subscription.
  */
 export type Subscription = {
+    /** The id of the departure stop. */
     departurePhysicalAgencyStopId: number;
+    /** The name of the departure stop. */
     departureStopName: string;
+    /** The id of the destination stop. */
     destinationPhysicalAgencyStopId: number;
+    /** The name of the destination stop. */
     destinationStopName: string;
+    /** The time of departure from the departureStop in MM/DD/YYYY HH:MM:SS format. */
     departureTime: string;
+    /** The time of arrival to the destinationStop in MM/DD/YYYY HH:MM:SS format. */
     destinationTime: string;
+    /** The name of the line on which the subscription is sold. */
     lineName: string;
+    /** The id of the route on which the subscription is sold. */
     routeId: number;
+    /** The name of the route on which the subscription is sold. */
     routeName: string;
+    /** The id of the seller selling the subscription. */
     sellerId: number;
 };

package/lib/types/tpl/TplCart.d.ts

@@ -1,25 +1,6 @@
 import { Booking } from "../../booking/booking";
 import { Cart } from "../common/Cart";
 import { TariffSummary } from "../common/Tariffs";
-/**
- * @description This is the object to be passed to {@link TplBooking.createTplCart}, containing information about the selected tpl service.
- */
-export type CreateTplCartRequest = {
-    /** The currency in which the ticket is priced. */
-    currency: Booking.Currencies;
-    /** A map that associates a tariff id (the one chosen by the user) to the number of tickets to buy for that tariff. */
-    tariffIdToQuantity: Map<number, number>;
-    /** The start date of the ticket. This is optional and should be used only for subscriptions */
-    startDate?: string;
-    /** Whether the subscription is for the current period. This is optional and should be used only for subscriptions. */
-    isCurrentPeriod?: boolean;
-    /** The PNR of the subscription ticket to renew. This is optional and should be used only for subscriptions. */
-    renewSubscriptionTicketPNR?: string;
-    /** The id of the OTA Reseller that sold the ticket */
-    otaResellerId?: number;
-    /** A string in base64 representing the picture of the ticket that was sold */
-    otaTicketPicture?: string;
-};
 /**
  * @description Represents a `TplCart`, which extends the {@link Cart} type by including additional
  * information about the bookings
@@ -55,8 +36,8 @@ export type TplBookingInfo = {
     superAreaId: number;
     /** The validity of the ticket (or of the subscription). */
     validity: string;
-    /** The start date of the ticket (or of the subscription). */
+    /** The start date of the ticket (or of the subscription). Format: "DD/MM/YYYY HH:MM" */
     startDate: string;
-    /** The end date of the ticket (or of the subscription). */
+    /** The end date of the ticket (or of the subscription). Format: "DD/MM/YYYY HH:MM" */
     endDate: string;
 };

package/lib/utils/utils.d.ts

@@ -1,11 +1,3 @@
-/**
- * This method return the ISO string of the date without GMT. An ISO string looks like this: YYYY-MM-DDThh:mm:ss.mmmZ
- * @param {Date | string} date the date to convert
- * @param {boolean} [removeTimezone=true] if true, the timezone will be removed from the ISO string, meaning
- * that the string will look like this: YYYY-MM-DDThh:mm:ss.mmm
- * @returns {string} the ISO string
- */
-export declare const getISOStringWithoutGMT: (date: Date | string | null | undefined, removeTimezone?: boolean) => string | null;
 /**
  * This method check where a variable is null or undefined
  * @param value The value to check

package/lib/utils/utils.js

@@ -1,22 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNullOrWhiteSpace = exports.isNullOrUndefined = exports.getISOStringWithoutGMT = void 0;
-/**
- * This method return the ISO string of the date without GMT. An ISO string looks like this: YYYY-MM-DDThh:mm:ss.mmmZ
- * @param {Date | string} date the date to convert
- * @param {boolean} [removeTimezone=true] if true, the timezone will be removed from the ISO string, meaning
- * that the string will look like this: YYYY-MM-DDThh:mm:ss.mmm
- * @returns {string} the ISO string
- */
-var getISOStringWithoutGMT = function (date, removeTimezone) {
-    if (removeTimezone === void 0) { removeTimezone = true; }
-    if (!date)
-        return null;
-    var newDate = new Date(date);
-    var isoString = new Date(newDate.valueOf() - newDate.getTimezoneOffset() * 60000).toISOString();
-    return removeTimezone ? isoString.slice(0, -1) : isoString;
-};
-exports.getISOStringWithoutGMT = getISOStringWithoutGMT;
+exports.isNullOrWhiteSpace = exports.isNullOrUndefined = void 0;
 /**
  * This method check where a variable is null or undefined
  * @param value The value to check

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "2.4.14",
+  "version": "3.0.1",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -8,7 +8,7 @@
     "build": "tsc",
     "pretest": "tsc --noEmit",
     "test": "jest --config jestconfig.json",
-    "prepare": "npm run build",
+    "prepare": "npm audit --audit-level=moderate && npm run build",
     "prepublishOnly": "npm run test --runInBand",
     "version": "git add -A src",
     "postversion": "git push && git push --tags",
@@ -19,19 +19,19 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@eslint/js": "^9.27.0",
-    "@types/jest": "^29.5.14",
+    "@eslint/js": "^9.33.0",
+    "@types/jest": "^30.0.0",
     "@types/node-localstorage": "^1.3.3",
-    "dotenv": "^16.5.0",
-    "eslint": "^9.27.0",
-    "eslint-config-prettier": "^10.1.5",
-    "globals": "^16.2.0",
-    "jest": "^29.7.0",
+    "dotenv": "^17.2.1",
+    "eslint": "^9.33.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.3.0",
+    "jest": "^30.0.5",
     "node-localstorage": "^3.0.5",
-    "prettier": "^3.5.3",
-    "ts-jest": "^29.3.4",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.32.1"
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.1",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.40.0"
   },
   "files": [
     "lib/**/*"
@@ -42,8 +42,8 @@
   ],
   "author": "Infoservice s.r.l.",
   "dependencies": {
-    "@react-native-async-storage/async-storage": "^2.2.0",
-    "axios": "^1.11.0",
-    "zustand": "^5.0.6"
+    "@react-native-async-storage/async-storage": "~2.2.0",
+    "axios": "~1.13.0",
+    "zustand": "~5.0.8"
   }
 }