@geops/rvf-mobility-web-component 0.1.127-beta.1 → 0.1.127-beta.2

package/src/utils/getStopStatus.test.ts

@@ -1,105 +0,0 @@
-import getStopStatus from "./getStopStatus";
-
-describe("getStopStatus", () => {
-  describe("when the station is empty", () => {
-    it("returns a correct status", () => {
-      const stopSequence = {
-        stations: [{}],
-      };
-      const {
-        // progress,
-        // isInBetween,
-        // isCancelled,
-        // isFirst,
-        // isLast,
-        // isPassed,
-        // isLeft,
-        // isNotRealtime,
-        isNotStop,
-        // isBoarding,
-        // isNextStop,
-        // isCloseToNextStop,
-        // @ts-expect-error bad type definition
-      } = getStopStatus(stopSequence, 0);
-      expect(isNotStop).toBe(true);
-    });
-
-    it("returns a correct isNotRealtime status", () => {
-      const stopSequence = {
-        stations: [
-          { arrivalDelay: null, departureDelay: null, state: "PENDING" },
-          { arrivalDelay: null, departureDelay: null, state: "TIME_BASED" },
-          { arrivalDelay: 0, departureDelay: 0, state: "PENDING" },
-          { arrivalDelay: 0, departureDelay: 0, state: "TIME_BASED" },
-        ],
-      };
-      let {
-        isNotRealtime,
-        // @ts-expect-error bad type definition
-      } = getStopStatus(stopSequence, 0);
-      expect(isNotRealtime).toBe(true);
-      // @ts-expect-error bad type definition
-      isNotRealtime = getStopStatus(stopSequence, 1).isNotRealtime;
-      expect(isNotRealtime).toBe(true);
-      // @ts-expect-error bad type definition
-      isNotRealtime = getStopStatus(stopSequence, 2).isNotRealtime;
-      expect(isNotRealtime).toBe(false);
-      // @ts-expect-error bad type definition
-      isNotRealtime = getStopStatus(stopSequence, 3).isNotRealtime;
-      expect(isNotRealtime).toBe(true);
-    });
-  });
-
-  describe("when it's the first station", () => {
-    it("returns a correct status", () => {
-      const stopSequence = {
-        stations: [{}],
-      };
-      const {
-        // isInBetween,
-        // isCancelled,
-        isFirst,
-        // isLast,
-        // isPassed,
-        // isLeft,
-        // isNotRealtime,
-        // isNotStop,
-        // isBoarding,
-        isNextStop,
-        progress,
-        // isCloseToNextStop,
-        // @ts-expect-error bad type definition
-      } = getStopStatus(stopSequence, 0);
-      expect(progress).toBe(50);
-      expect(isFirst).toBe(true);
-      expect(isNextStop).toBe(true);
-    });
-  });
-
-  describe("when it's the first station and not a stop", () => {
-    it("returns a correct status", () => {
-      const stopSequence = {
-        stations: [{}],
-      };
-      const {
-        // isInBetween,
-        // isCancelled,
-        isFirst,
-        // isBoarding,
-        isNextStop,
-        // isLast,
-        // isPassed,
-        // isLeft,
-        // isNotRealtime,
-        isNotStop,
-        progress,
-        // isCloseToNextStop,
-        // @ts-expect-error bad type definition
-      } = getStopStatus(stopSequence, 0);
-      expect(progress).toBe(50);
-      expect(isFirst).toBe(true);
-      expect(isNextStop).toBe(true);
-      expect(isNotStop).toBe(true);
-    });
-  });
-});

package/src/utils/getStopStatus.ts

@@ -1,171 +0,0 @@
-import type { RealtimeStopSequence } from "mobility-toolbox-js/types";
-
-export interface StopStatus {
-  isBoarding?: boolean;
-  isCancelled?: boolean;
-  isCloseToNextStop?: boolean;
-  isFirst?: boolean;
-  isInBetween?: boolean;
-  isLast?: boolean;
-  isLeft?: boolean;
-  isNextStop?: boolean;
-  isNotRealtime?: boolean;
-  isNotStop?: boolean;
-  isPassed?: boolean;
-  progress?: number;
-}
-
-const getBasicStatus = (stop, currTime, previousStop, nextStop) => {
-  let topBoundary = stop.arrivalTime;
-  let bottomBoundary = stop.arrivalTime;
-
-  if (previousStop) {
-    topBoundary =
-      stop.arrivalTime - (stop.arrivalTime - previousStop.arrivalTime) / 2;
-  }
-  if (nextStop) {
-    bottomBoundary =
-      stop.arrivalTime + (nextStop.arrivalTime - stop.arrivalTime) / 2;
-  }
-
-  const isNotStop = !stop.arrivalTime && !stop.departureTime;
-  const hasNoDelays =
-    stop.arrivalDelay === null && stop.departureDelay === null;
-  const isNotRealtime = stop.state === "TIME_BASED" || hasNoDelays;
-  const isCancelled =
-    stop.state === "JOURNEY_CANCELLED" || stop.state === "STOP_CANCELLED";
-  const isBoarding = stop.state === "BOARDING";
-
-  const isPassedBottom = currTime > bottomBoundary;
-
-  const isLeft =
-    stop.state === "LEAVING" ||
-    (isNotRealtime && isPassedBottom) ||
-    (isCancelled && isPassedBottom);
-
-  return {
-    bottomBoundary,
-    isBoarding,
-    isCancelled,
-    isLeft,
-    isNotRealtime,
-    isNotStop,
-    isPassedBottom,
-    topBoundary,
-  };
-};
-
-/**
- * This function provide an object with some informations about the status of the vehicle for this station.
- * If the vehicul has already passed the sattion how far is it from the station, ...
- */
-const getStopStatus = (
-  stopSequence: RealtimeStopSequence,
-  index: number,
-): StopStatus => {
-  const { stations: stops } = stopSequence;
-  let progress = 0;
-  const previousStop = stops[index - 1];
-  const stop = stops[index];
-  const nextStop = stops[index + 1];
-
-  if (!stop) {
-    return {};
-  }
-
-  const currTime = Date.now();
-  const previousStopStatus =
-    previousStop &&
-    getBasicStatus(previousStop, currTime, stops[index - 2], stop);
-  const basicStatus = getBasicStatus(stop, currTime, previousStop, nextStop);
-  let { isLeft } = basicStatus;
-  const {
-    bottomBoundary,
-    isBoarding,
-    isCancelled,
-    isNotRealtime,
-    isNotStop,
-    isPassedBottom,
-    topBoundary,
-  } = basicStatus;
-
-  const isNextStop = !isLeft && (!previousStop || previousStopStatus.isLeft);
-
-  // The future stop is the stop after a stop with state === "BOARDING"
-  const isFutureStop = !isLeft && (!previousStop || !previousStopStatus.isLeft);
-
-  let isCloseToNextStop = false;
-  if (isNextStop) {
-    const timeGap = (bottomBoundary - topBoundary) * 0.2; // 20% of the duration between 2 stops
-    isCloseToNextStop = currTime > stop.arrivalTime - timeGap;
-  }
-
-  // Check if the stop has been passed
-  // For SBAHNMW-298
-  // Considerate the state ("LEAVING")
-  // which is important if the data has not been updated for a long time
-  let isPassed = isPassedBottom && !isNextStop && !isFutureStop;
-
-  if (topBoundary < currTime && currTime < bottomBoundary && !isFutureStop) {
-    progress = Math.round(
-      ((currTime - topBoundary) * 100) / (bottomBoundary - topBoundary),
-    );
-  }
-
-  // For SBAHNMW-298
-  // Set the progress manually
-  // if the data has not been updated for a long time.
-  // These stops would have be passed if the data were up-to-date
-  if (isPassedBottom && (isNextStop || isFutureStop)) {
-    progress = 0;
-  }
-
-  // The first station is a special case because the top boundary starts at 50% of the div element.
-  const isFirstStation = index === 0;
-
-  if (isFirstStation) {
-    progress = 50;
-  }
-
-  if (isBoarding) {
-    // When the train has not left the first station the progress is 0.
-    progress = 50;
-  } else if (
-    !isFirstStation &&
-    ((isLeft && progress < 50) || (!isLeft && progress > 50))
-  ) {
-    // Here we ensure that isLeft and progress values are properly synced
-    // It doesn't apply to the the first station.
-    progress = 50;
-  }
-
-  // For SBAHNMW-210
-  // If some data (arrivalTime or state) from backend are wrong, 2 stops have the progress bar.
-  // So to avoid double progress display, we force the isPassed value to true.
-  if (progress > 50 && getStopStatus(stopSequence, index + 1).progress > 0) {
-    progress = 100;
-    isLeft = true;
-    isPassed = true;
-  }
-
-  if (isPassed) {
-    progress = 100;
-  }
-
-  return {
-    isBoarding,
-    isCancelled,
-    isCloseToNextStop,
-    isFirst: !previousStop,
-    isInBetween: !isPassed && progress > 0,
-    isLast: !nextStop,
-    isLeft,
-    isNextStop,
-    isNotRealtime,
-    isNotStop,
-    isPassed,
-    progress,
-  };
-};
-
-export default getStopStatus;

package/src/utils/getTextColor.ts

@@ -1,10 +0,0 @@
-import { realtimeConfig } from "mobility-toolbox-js/ol";
-
-const getTextColor = (type) => {
-  if (type === "bus" || type === "tram") {
-    return "#fff";
-  }
-  return realtimeConfig.getTextColorForType(type);
-};
-
-export default getTextColor;

package/src/utils/getTextColorForVehicle.ts

@@ -1,31 +0,0 @@
-import { realtimeConfig } from "mobility-toolbox-js/ol";
-
-import getTextColor from "./getTextColor";
-
-import type {
-  RealtimeDeparture,
-  RealtimeLine,
-  RealtimeStopSequence,
-  RealtimeTrajectory,
-} from "mobility-toolbox-js/types";
-
-import type { LnpLineInfo } from "./hooks/useLnp";
-
-const getTextColorForVehicle = (object: unknown) => {
-  const textColor =
-    (object as LnpLineInfo | RealtimeLine).text_color ||
-    (object as RealtimeDeparture | RealtimeStopSequence).line?.text_color ||
-    (object as RealtimeTrajectory).properties?.line?.text_color;
-
-  if (textColor) {
-    return textColor;
-  }
-
-  const type =
-    (object as RealtimeStopSequence).type ||
-    (object as RealtimeTrajectory).properties?.type;
-
-  return getTextColor(type) || realtimeConfig.getTextColorForType(type);
-};
-
-export default getTextColorForVehicle;

package/src/utils/getTextFontForVehicle.test.ts

@@ -1,7 +0,0 @@
-import getTextFontForVehicle from "./getTextFontForVehicle";
-
-describe("getTextFontForVehicle", () => {
-  it("returns font that inherit", () => {
-    expect(getTextFontForVehicle(null, null, 12)).toBe("bold 12px arial");
-  });
-});

package/src/utils/getTextFontForVehicle.tsx

@@ -1,17 +0,0 @@
-import type { ViewState } from "mobility-toolbox-js/types";
-
-/**
- * Return the font depending on an object representing a vehicle or a line.
- * This function is used to have the same font on the map and on other components.
- */
-const getTextFontForVehicle = (
-  object?: unknown,
-  viewState?: ViewState,
-  fontSize?: number,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  text?: string,
-) => {
-  return `bold ${fontSize}px arial`;
-};
-
-export default getTextFontForVehicle;

package/src/utils/getTextForVehicle.test.ts

@@ -1,17 +0,0 @@
-import getTextForVehicle from "./getTextForVehicle";
-
-describe("getTextForVehicle", () => {
-  it("returns empty", () => {
-    expect(getTextForVehicle()).toBe("");
-    expect(getTextForVehicle(null)).toBe("");
-  });
-
-  it("returns name", () => {
-    expect(getTextForVehicle("name")).toBe("name");
-    expect(getTextForVehicle({ name: "name" })).toBe("name");
-    expect(getTextForVehicle({ line: { name: "name" } })).toBe("name");
-    expect(getTextForVehicle({ properties: { line: { name: "name" } } })).toBe(
-      "name",
-    );
-  });
-});

package/src/utils/getTextForVehicle.ts

@@ -1,25 +0,0 @@
-import type {
-  RealtimeLine,
-  RealtimeStopSequence,
-  RealtimeTrajectory,
-} from "mobility-toolbox-js/types";
-
-import type { LnpLineInfo } from "./hooks/useLnp";
-
-/**
- * Return the text depending on an object representing a vehicle or a line.
- * This function is used to have the same text on the map and on other components.
- */
-const getTextForVehicle = (object: unknown = ""): string => {
-  const name =
-    (object as RealtimeTrajectory)?.properties?.line?.name ||
-    (object as RealtimeStopSequence)?.line?.name ||
-    (object as RealtimeLine)?.name ||
-    (object as LnpLineInfo)?.short_name ||
-    (object as string) ||
-    "";
-
-  return name;
-};
-
-export default getTextForVehicle;

package/src/utils/getUrlFromTemplate.test.ts

@@ -1,23 +0,0 @@
-import getUrlFromTemplate from "./getUrlFromTemplate";
-
-describe("getUrlFromTemplate", () => {
-  it("should replace parameters in the template", () => {
-    const template = "?z={{z}}&x={{x}}&y={{y}}";
-    const params = new URLSearchParams({ x: "512", y: "200", z: "10" });
-    const url = getUrlFromTemplate(template, params);
-    expect(url).toBe("http://localhost/?z=10&x=512&y=200");
-  });
-
-  it("should handle hash templates", () => {
-    const template = "#/map/{{z}}/{{x}}/{{y}}";
-    const params = new URLSearchParams({ x: "512", y: "200", z: "10" });
-    const url = getUrlFromTemplate(template, params);
-    expect(url).toBe("http://localhost/#/map/10/512/200");
-  });
-
-  it("should handle null templates returning the window location", () => {
-    const params = new URLSearchParams({ x: "512", y: "200", z: "10" });
-    const url = getUrlFromTemplate(null, params);
-    expect(url).toBe("http://localhost/");
-  });
-});

package/src/utils/getUrlFromTemplate.ts

@@ -1,47 +0,0 @@
-/**
- * Return an url as a string from a template and a list of parameters.
- * Example:
- * template: "https://example.com/{{z}}/{{x}}/{{y}}.png"
- * params: {z: "10", x: "512", y: "512"}
- * return: "https://example.com/10/512/512.png"
- *
- * If a parameter is missing, the template is not replaced.
- *
- * @param template - The url template containing parameters in the form {{param}}
- * @param params - An object containing the parameters to replace in the template
- * @returns The url with the parameters replaced
- */
-function getUrlFromTemplate(template: string, params: URLSearchParams): string {
-  let tpl = template || "";
-  params?.forEach((value, key) => {
-    tpl = tpl.replace(`{{${key}}}`, value);
-  });
-  if (tpl.startsWith("#")) {
-    tpl = `${window.location.href.split("#")[0]}${tpl}`;
-  } else if (tpl.startsWith("?") || !tpl) {
-    const existingParams = new URLSearchParams(window.location.search);
-
-    // Set current values of the template parameters
-    const tplParams = new URLSearchParams(tpl);
-    tplParams.forEach((value, key) => {
-      existingParams.set(key, value);
-    });
-
-    // Remove duplicated parameters if the template already includes them
-    if (template?.includes("{{x}}") && template?.includes("{{y}}")) {
-      existingParams.delete("center");
-    }
-    if (template?.includes("{{z}}")) {
-      existingParams.delete("zoom");
-    }
-
-    let str = existingParams.toString();
-    if (!str.startsWith("?") && tpl.length) {
-      str = `?${str}`;
-    }
-    tpl = `${window.location.href.split("?")[0]}${str}${window.location.hash}`;
-  }
-  return tpl;
-}
-
-export default getUrlFromTemplate;

package/src/utils/highlightLinesNetworkPlan.ts

@@ -1,25 +0,0 @@
-import { LNP_LAYER_ID_HIGHLIGHT, LNP_LINE_ID_PROP } from "./constants";
-
-import type { MaplibreLayer } from "mobility-toolbox-js/ol";
-
-function highlightLinesNetworkPlan(
-  ids: number[] | string[] = [0],
-  baseLayer: MaplibreLayer,
-) {
-  try {
-    const styleLayer = baseLayer?.mapLibreMap?.getLayer(LNP_LAYER_ID_HIGHLIGHT);
-    if (styleLayer) {
-      baseLayer?.mapLibreMap?.setFilter(styleLayer.id, [
-        "match",
-        ["get", LNP_LINE_ID_PROP],
-        ids,
-        true,
-        false,
-      ]);
-    }
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error("Error setting filter for highlight layer", e);
-  }
-}
-export default highlightLinesNetworkPlan;

package/src/utils/hooks/useDebug.tsx

@@ -1,11 +0,0 @@
-import { useMemo } from "preact/hooks";
-
-const useDebug = () => {
-  const debug = useMemo(() => {
-    const value = new URLSearchParams(window.location.search).get("debug");
-    return !value || value === "false" ? false : value;
-  }, []);
-  return debug;
-};
-
-export default useDebug;

package/src/utils/hooks/useDeparture.tsx

@@ -1,24 +0,0 @@
-import { createContext } from "preact";
-import { useContext } from "preact/hooks";
-
-import type { RealtimeDeparture } from "mobility-toolbox-js/types";
-
-export interface DepartureContextType {
-  departure?: RealtimeDeparture;
-  index?: number;
-}
-
-export const DepartureContext = createContext({
-  departure: null,
-  index: null,
-} as DepartureContextType);
-
-const useDeparture = (): DepartureContextType => {
-  const context = useContext<DepartureContextType>(DepartureContext);
-  if (!context) {
-    throw new Error("useDeparture must be used within a ContextProvider");
-  }
-  return context;
-};
-
-export default useDeparture;

package/src/utils/hooks/useFit.tsx

@@ -1,57 +0,0 @@
-import { Feature } from "ol";
-import { Point } from "ol/geom";
-import { fromExtent } from "ol/geom/Polygon";
-import { useEffect, useRef } from "preact/hooks";
-
-import useFitOnFeatures from "./useFitOnFeatures";
-
-import type { RealtimeRouteIdentifierMatch } from "mobility-toolbox-js/types";
-import type { GeoJSONFeature } from "ol/format/GeoJSON";
-
-import type { LnpLineInfo, LnpStopInfo } from "./useLnp";
-import type { StopsFeature } from "./useSearchStops";
-
-export type FitOnObject = (obj: FitObject, willOverlayOpen?: boolean) => void;
-
-export type FitObject =
-  | LnpLineInfo
-  | LnpStopInfo
-  | RealtimeRouteIdentifierMatch
-  | StopsFeature;
-
-function useFit() {
-  const fitOnFeatures = useFitOnFeatures();
-  const fit = useRef<FitOnObject>();
-
-  useEffect(() => {
-    fit.current = (obj: FitObject, willOverlayOpen = false) => {
-      if (
-        (obj as StopsFeature)?.type === "Feature" &&
-        (obj as StopsFeature).geometry
-      ) {
-        fitOnFeatures.current([obj as GeoJSONFeature], willOverlayOpen);
-        return;
-      }
-      const extent =
-        (obj as LnpLineInfo)?.extent ||
-        (obj as RealtimeRouteIdentifierMatch)?.bounds;
-
-      if (extent) {
-        const feature = new Feature(fromExtent(extent));
-        fitOnFeatures.current([feature], willOverlayOpen);
-        return;
-      }
-
-      const coordinate = (obj as LnpStopInfo)?.coordinates;
-      if (coordinate) {
-        const feature = new Feature(new Point(coordinate));
-        fitOnFeatures.current([feature], willOverlayOpen);
-        return;
-      }
-    };
-  }, [fitOnFeatures]);
-
-  return fit;
-}
-
-export default useFit;

package/src/utils/hooks/useFitOnFeatures.tsx

@@ -1,77 +0,0 @@
-import { GeoJSON } from "ol/format";
-import { Vector } from "ol/source";
-import { useEffect, useRef } from "preact/hooks";
-
-import { FIT_ON_FEATURES_MAX_ZOOM_POINT } from "../constants";
-
-import useMapContext from "./useMapContext";
-
-import type { Feature, Map } from "ol";
-import type { GeoJSONFeature } from "ol/format/GeoJSON";
-const geojson = new GeoJSON();
-
-export type FitOnFeatures = (
-  features: (Feature | GeoJSONFeature)[],
-  willOverlayOpen?: boolean,
-  map?: Map,
-) => void;
-
-const useFitOnFeatures = () => {
-  const { isOverlayOpen, map: contextMap } = useMapContext();
-
-  const isOverlayOpenRef = useRef(isOverlayOpen);
-  const fitOnFeatures = useRef<FitOnFeatures>();
-
-  useEffect(() => {
-    isOverlayOpenRef.current = isOverlayOpen;
-  }, [isOverlayOpen]);
-
-  useEffect(() => {
-    fitOnFeatures.current = (
-      features: (Feature | GeoJSONFeature)[],
-      willOverlayOpen = false,
-      map?: Map,
-    ) => {
-      if ((!map && !contextMap) || !features?.length) {
-        return;
-      }
-      let feats = features as Feature[];
-
-      // Convert to ol features if GeoJSON
-      const geoJSONFeature = features?.[0] as GeoJSONFeature;
-      if (geoJSONFeature?.geometry && geoJSONFeature?.type === "Feature") {
-        // Single feature case
-        feats = geojson.readFeatures(
-          {
-            features,
-            type: "FeatureCollection",
-          },
-          { featureProjection: "EPSG:3857" },
-        );
-      }
-
-      const mapToUse = map || contextMap;
-      const extent = new Vector({ features: feats }).getExtent();
-      mapToUse.getView().fit(extent, {
-        duration: 500,
-        maxZoom:
-          extent[0] === extent[2] || extent[1] === extent[3]
-            ? FIT_ON_FEATURES_MAX_ZOOM_POINT
-            : undefined,
-        padding: [
-          50,
-          50,
-          50,
-          willOverlayOpen || isOverlayOpenRef.current ? 350 : 50,
-        ],
-      });
-      return () => {
-        mapToUse?.getView().cancelAnimations();
-      };
-    };
-  }, [contextMap]);
-
-  return fitOnFeatures;
-};
-
-export default useFitOnFeatures;

package/src/utils/hooks/useI18n.tsx

@@ -1,23 +0,0 @@
-import { createContext } from "preact";
-import { useContext } from "preact/hooks";
-
-export interface I18NContextType {
-  locale(lang?: string): string;
-  t: (id: string, templateValues?: Record<string, string>) => string;
-}
-
-export const I18nContext = createContext<I18NContextType>({
-  t: (id: string, templateValues?: Record<string, string>) => {
-    return `${id} ${JSON.stringify(templateValues)}`;
-  },
-} as I18NContextType);
-
-const useI18n = (): I18NContextType => {
-  const context = useContext<I18NContextType>(I18nContext);
-  if (!context) {
-    throw new Error("useI18n must be used within a ContextProvider");
-  }
-  return context;
-};
-
-export default useI18n;