@opentripplanner/vehicle-rental-overlay 1.4.2 → 2.0.0-alpha.1

package/src/VehicleRentalOverlay.story.js

@@ -1,284 +0,0 @@
-// Removed as core-utils is typescripted. TODO: Remove when typescripting!
-/* eslint-disable react/forbid-prop-types */
-import BaseMap from "@opentripplanner/base-map";
-import PropTypes from "prop-types";
-import React from "react";
-import { CircleMarker } from "react-leaflet";
-import { action } from "@storybook/addon-actions";
-import { boolean } from "@storybook/addon-knobs";
-
-import VehicleRentalOverlay from ".";
-import bikeRentalStations from "../__mocks__/bike-rental-stations.json";
-import carRentalStations from "../__mocks__/car-rental-stations.json";
-import eScooterStations from "../__mocks__/e-scooter-rental-stations.json";
-import { HubAndFloatingBike } from "./DefaultMarkers";
-
-import "../../../node_modules/leaflet/dist/leaflet.css";
-
-const center = [45.518092, -122.671202];
-
-/**
- * Creates an example Circle component to render entities
- * using a fixed size, fill color, and stroke color.
- */
-const MyCircle = ({ fillColor = "gray", pixels, strokeColor }) => {
-  const newStrokeColor = strokeColor || fillColor;
-
-  const GeneratedCircle = ({ children, entity: station }) => (
-    <CircleMarker
-      center={[station.y, station.x]}
-      color={newStrokeColor}
-      fillColor={fillColor}
-      fillOpacity={1}
-      radius={pixels}
-      weight={1}
-    >
-      {children}
-    </CircleMarker>
-  );
-  GeneratedCircle.propTypes = {
-    children: PropTypes.node,
-    // entity: coreUtils.types.stationType.isRequired
-    entity: PropTypes.object.isRequired
-  };
-  GeneratedCircle.defaultProps = {
-    children: null
-  };
-  return GeneratedCircle;
-};
-
-const bikeMapSymbols = [
-  {
-    dockStrokeColor: "#000000",
-    fillColor: "#FF2E28",
-    minZoom: 0,
-    pixels: 4,
-    type: "circle"
-  },
-  {
-    dockStrokeColor: "#000000",
-    fillColor: "#FF2E28",
-    minZoom: 14,
-    pixels: 6,
-    type: "circle"
-  },
-  {
-    minZoom: 18,
-    type: "hubAndFloatingBike"
-  }
-];
-// Bike symbols using new symbols prop.
-const bikeSymbols = [
-  {
-    getType: station => (station.isFloatingBike ? "floatingBike" : "dock"),
-    minZoom: 0,
-    symbol: MyCircle({ fillColor: "#FF2E28", pixels: 3 }),
-    symbolByType: {
-      dock: MyCircle({
-        fillColor: "#FF2E28",
-        pixels: 4,
-        strokeColor: "#000000"
-      })
-    }
-  },
-  {
-    getType: station => (station.isFloatingBike ? "floatingBike" : "dock"),
-    minZoom: 14,
-    symbol: MyCircle({ fillColor: "#FF2E28", pixels: 5 }),
-    symbolByType: {
-      dock: MyCircle({
-        fillColor: "#FF2E28",
-        pixels: 6,
-        strokeColor: "#000000"
-      })
-    }
-  },
-  {
-    minZoom: 18,
-    symbol: HubAndFloatingBike
-  }
-];
-const carMapSymbols = [
-  {
-    fillColor: "#009cde",
-    minZoom: 0,
-    pixels: 4,
-    type: "circle"
-  },
-  {
-    fillColor: "#009cde",
-    minZoom: 14,
-    pixels: 6,
-    type: "circle"
-  },
-  {
-    fillColor: "#009cde",
-    minZoom: 18,
-    type: "marker"
-  }
-];
-const configCompanies = [
-  {
-    id: "BIKETOWN",
-    label: "Biketown",
-    modes: "BICYCLE_RENT"
-  },
-  {
-    id: "CAR2GO",
-    label: "car2go",
-    modes: "CAR_RENT"
-  },
-  {
-    id: "RAZOR",
-    label: "Razor",
-    modes: "MICROMOBILITY_RENT"
-  },
-  {
-    id: "SHARED",
-    label: "Shared",
-    modes: "MICROMOBILITY_RENT"
-  }
-];
-const EScooterMapSymbols = [
-  {
-    fillColor: "#F80600",
-    minZoom: 0,
-    pixels: 4,
-    strokeColor: "#CCCCCC",
-    type: "circle"
-  },
-  // You can combine predefined symbols (type = "<type>")
-  // and external symbols (symbol = Component<({ entity, zoom })>.
-  // (the color and pixel properties are ignored if you use the symbol syntax.).
-  {
-    minZoom: 14,
-    symbol: MyCircle({
-      fillColor: "#F80600",
-      pixels: 6,
-      strokeColor: "#CCCCCC"
-    })
-  },
-  {
-    fillColor: "#F80600",
-    minZoom: 18,
-    type: "marker"
-  }
-];
-const setLocation = action("setLocation");
-
-const INITIAL_ZOOM = 13;
-
-const ZoomControlledMapWithVehicleRentalOverlay = ({
-  companies,
-  getStationName,
-  mapSymbols,
-  refreshVehicles,
-  stations,
-  visible
-}) => (
-  // Caution, <BaseMap> must be a direct parent of <VehicleRentalOverlay>.
-  // Therefore, do not place <BaseMap> in a decorator at this time.
-  <BaseMap center={center} zoom={INITIAL_ZOOM}>
-    <VehicleRentalOverlay
-      configCompanies={configCompanies}
-      companies={companies}
-      getStationName={getStationName}
-      setLocation={setLocation}
-      mapSymbols={mapSymbols}
-      name="Rentals"
-      refreshVehicles={refreshVehicles}
-      stations={stations}
-      visible={visible}
-    />
-  </BaseMap>
-);
-
-ZoomControlledMapWithVehicleRentalOverlay.propTypes = {
-  companies: PropTypes.arrayOf(PropTypes.string.isRequired),
-  getStationName: PropTypes.func,
-  // mapSymbols: coreUtils.types.vehicleRentalMapOverlaySymbolsType,
-  mapSymbols: PropTypes.object,
-  refreshVehicles: PropTypes.func.isRequired,
-  // stations: PropTypes.arrayOf(coreUtils.types.stationType.isRequired)
-  //   .isRequired,
-  stations: PropTypes.arrayOf(PropTypes.object.isRequired).isRequired,
-  visible: PropTypes.bool
-};
-
-ZoomControlledMapWithVehicleRentalOverlay.defaultProps = {
-  companies: null,
-  getStationName: undefined,
-  mapSymbols: null,
-  visible: true
-};
-
-function customStationName(_, station) {
-  return `🛴 (ID: ${station.id})`;
-}
-
-export default {
-  title: "VehicleRentalOverlay",
-  component: VehicleRentalOverlay
-};
-
-export const RentalBicycles = () => (
-  <ZoomControlledMapWithVehicleRentalOverlay
-    companies={["BIKETOWN"]}
-    mapSymbols={bikeMapSymbols}
-    refreshVehicles={action("refresh bicycles")}
-    stations={bikeRentalStations}
-  />
-);
-
-export const RentalBicyclesVisibilityControlledByKnob = () => {
-  const isOverlayVisible = boolean(
-    "Toggle visibility of vehicle rental overlay",
-    false
-  );
-  return (
-    <ZoomControlledMapWithVehicleRentalOverlay
-      companies={["BIKETOWN"]}
-      mapSymbols={bikeMapSymbols}
-      refreshVehicles={action("refresh bicycles")}
-      stations={bikeRentalStations}
-      visible={isOverlayVisible}
-    />
-  );
-};
-
-export const RentalBicyclesUsingNewSymbolsProp = () => (
-  <ZoomControlledMapWithVehicleRentalOverlay
-    companies={["BIKETOWN"]}
-    refreshVehicles={action("refresh bicycles")}
-    mapSymbols={bikeSymbols}
-    stations={bikeRentalStations}
-  />
-);
-
-export const RentalCars = () => (
-  <ZoomControlledMapWithVehicleRentalOverlay
-    companies={["CAR2GO"]}
-    mapSymbols={carMapSymbols}
-    refreshVehicles={action("refresh cars")}
-    stations={carRentalStations}
-  />
-);
-
-export const RentalEScooters = () => (
-  <ZoomControlledMapWithVehicleRentalOverlay
-    companies={["SHARED"]}
-    mapSymbols={EScooterMapSymbols}
-    refreshVehicles={action("refresh E-scooters")}
-    stations={eScooterStations}
-  />
-);
-
-export const RentalEScootersWithCustomNaming = () => (
-  <ZoomControlledMapWithVehicleRentalOverlay
-    companies={["SHARED"]}
-    getStationName={customStationName}
-    mapSymbols={EScooterMapSymbols}
-    refreshVehicles={action("refresh E-scooters")}
-    stations={eScooterStations}
-  />
-);

package/src/bike-icons.js

@@ -1,23 +0,0 @@
-import { divIcon } from "leaflet";
-import React from "react";
-import ReactDOMServer from "react-dom/server";
-
-import * as S from "./styled";
-
-export const floatingBikeIcon = divIcon({
-  iconSize: [24, 24],
-  iconAnchor: [12, 24],
-  popupAnchor: [0, -12],
-  html: ReactDOMServer.renderToStaticMarkup(<S.OutOfHubBikeIcon />),
-  className: ""
-});
-
-export const hubIcons = S.hubIcons.map(StyledIcon =>
-  divIcon({
-    iconSize: [24, 24],
-    iconAnchor: [12, 24],
-    popupAnchor: [0, -12],
-    html: ReactDOMServer.renderToStaticMarkup(<StyledIcon />),
-    className: ""
-  })
-);

package/src/index.js

@@ -1,371 +0,0 @@
-import flatten from "flat";
-import { Styled as BaseMapStyled } from "@opentripplanner/base-map";
-import coreUtils from "@opentripplanner/core-utils";
-import FromToLocationPicker from "@opentripplanner/from-to-location-picker";
-import ZoomBasedMarkers from "@opentripplanner/zoom-based-markers";
-import PropTypes from "prop-types";
-import React from "react";
-import { FormattedMessage, injectIntl } from "react-intl";
-import { FeatureGroup, MapLayer, Popup, withLeaflet } from "react-leaflet";
-
-import {
-  GenericMarker,
-  HubAndFloatingBike,
-  SharedBikeCircle
-} from "./DefaultMarkers";
-
-// Load the default messages.
-import defaultEnglishMessages from "../i18n/en-US.yml";
-
-// HACK: We should flatten the messages loaded above because
-// the YAML loaders behave differently between webpack and our version of jest:
-// - the yaml loader for webpack returns a nested object,
-// - the yaml loader for jest returns messages with flattened ids.
-const defaultMessages = flatten(defaultEnglishMessages);
-
-function makeDefaultGetStationName(intl) {
-  return function defaultGetStationName(configCompanies, station) {
-    const stationNetworks = coreUtils.itinerary.getCompaniesLabelFromNetworks(
-      station.networks,
-      configCompanies
-    );
-    let stationName = station.name || station.id;
-    if (station.isFloatingBike) {
-      stationName = intl.formatMessage(
-        {
-          defaultMessage:
-            defaultEnglishMessages["otpUi.VehicleRentalOverlay.floatingBike"],
-          description: "Popup title for a free-floating bike",
-          id: "otpUi.VehicleRentalOverlay.floatingBike"
-        },
-        { name: stationName }
-      );
-    } else if (station.isFloatingCar) {
-      stationName = intl.formatMessage(
-        {
-          defaultMessage:
-            defaultEnglishMessages["otpUi.VehicleRentalOverlay.floatingCar"],
-          description: "Popup title for a free-floating car",
-          id: "otpUi.VehicleRentalOverlay.floatingCar"
-        },
-        {
-          company: stationNetworks,
-          name: stationName
-        }
-      );
-    } else if (station.isFloatingVehicle) {
-      // assumes that all floating vehicles are E-scooters
-      stationName = intl.formatMessage(
-        {
-          defaultMessage:
-            defaultEnglishMessages[
-              "otpUi.VehicleRentalOverlay.floatingEScooter"
-            ],
-          description: "Popup title for a free-floating e-scooter",
-          id: "otpUi.VehicleRentalOverlay.floatingEScooter"
-        },
-        { company: stationNetworks }
-      );
-    }
-    return stationName;
-  };
-}
-
-/**
- * This vehicle rental overlay can be used to render vehicle rentals of various
- * types. This layer can be configured to show different styles of markers at
- * different zoom levels.
- */
-class VehicleRentalOverlay extends MapLayer {
-  constructor(props) {
-    super(props);
-    this.state = {
-      zoom: null
-    };
-  }
-
-  /**
-   * This helper method will be passed to the ZoomBasedMarkers symbolTransform prop.
-   * It creates a component that inserts a popup
-   * as a child of the specified symbol from the mapSymbols prop.
-   */
-  renderSymbolWithPopup = Symbol => {
-    const SymbolWrapper = ({ entity: station, zoom }) => (
-      <Symbol entity={station} zoom={zoom}>
-        {this.renderPopupForStation(
-          station,
-          station.bikesAvailable !== undefined && !station.isFloatingBike
-        )}
-      </Symbol>
-    );
-    SymbolWrapper.propTypes = {
-      // entity: coreUtils.types.stationType.isRequired,
-      zoom: PropTypes.number.isRequired
-    };
-
-    return SymbolWrapper;
-  };
-
-  /**
-   * Convert map symbols to zoomBasedSymbolType.
-   */
-  convertToZoomMarkerSymbols = mapSymbols =>
-    mapSymbols.map(mapSymbol => {
-      // If mapSymbol uses zoomBasedSymbolType, use it as is.
-      if (mapSymbol.symbol) {
-        return mapSymbol;
-      }
-
-      // Otherwise, convert into zoomBasedType (no support for symbols by type).
-      let symbol;
-      switch (mapSymbol.type) {
-        case "circle":
-          symbol = SharedBikeCircle(mapSymbol);
-          break;
-        case "hubAndFloatingBike":
-          symbol = HubAndFloatingBike;
-          break;
-        default:
-          symbol = GenericMarker(mapSymbol);
-      }
-
-      return {
-        minZoom: mapSymbol.minZoom,
-        symbol
-      };
-    });
-
-  createLeafletElement() {}
-
-  updateLeafletElement() {}
-
-  startRefreshing() {
-    const { refreshVehicles } = this.props;
-
-    // Create the timer only if refreshVehicles is a valid function.
-    if (typeof refreshVehicles === "function") {
-      // initial station retrieval
-      refreshVehicles();
-
-      // set up timer to refresh stations periodically
-      this.refreshTimer = setInterval(() => {
-        refreshVehicles();
-      }, 30000); // defaults to every 30 sec. TODO: make this configurable?
-    }
-  }
-
-  stopRefreshing() {
-    if (this.refreshTimer) clearInterval(this.refreshTimer);
-  }
-
-  /**
-   * When the layer is added (or toggled on, or its visibility becomes true),
-   * start refreshing vehicle positions.
-   */
-  onOverlayAdded = () => {
-    this.startRefreshing();
-  };
-
-  /**
-   * When the layer is removed (or toggled off, or its visibility becomes false),
-   * stop refreshing vehicle positions.
-   */
-  onOverlayRemoved = () => {
-    this.stopRefreshing();
-  };
-
-  /**
-   * Listen to changes on the BaseMap's center or zoom.
-   * @param viewport The viewport data. See https://github.com/PaulLeCam/react-leaflet/blob/master/example/components/viewport.js for details.
-   */
-  onViewportChanged = viewport => {
-    const { zoom: newZoom } = viewport;
-    if (this.state.zoom !== newZoom) {
-      this.setState({ zoom: newZoom });
-    }
-  };
-
-  /**
-   * Upon mounting, see whether the vehicles should be fetched,
-   * and also call the register overlay prop that the
-   * @opentripplanner/base-map package has injected to listen to zoom/position changes.
-   */
-  componentDidMount() {
-    const { leaflet, registerOverlay, visible } = this.props;
-    this.setState({
-      zoom: leaflet.map.getZoom()
-    });
-    if (visible) this.startRefreshing();
-    if (typeof registerOverlay === "function") {
-      registerOverlay(this);
-    }
-  }
-
-  componentWillUnmount() {
-    this.stopRefreshing();
-  }
-
-  /**
-   * Render some popup html for a station. This contains custom logic for
-   * displaying rental vehicles in the TriMet MOD website that might not be
-   * applicable to other regions.
-   */
-  renderPopupForStation = (station, stationIsHub = false) => {
-    const { configCompanies, getStationName, intl, setLocation } = this.props;
-    const getStationNameFunc =
-      getStationName || makeDefaultGetStationName(intl);
-    const stationName = getStationNameFunc(configCompanies, station);
-    const location = {
-      lat: station.y,
-      lon: station.x,
-      name: stationName
-    };
-    return (
-      <Popup>
-        <BaseMapStyled.MapOverlayPopup>
-          <BaseMapStyled.PopupTitle>{stationName}</BaseMapStyled.PopupTitle>
-
-          {/* render dock info if it is available */}
-          {stationIsHub && (
-            <BaseMapStyled.PopupRow>
-              <div>
-                <FormattedMessage
-                  defaultMessage={
-                    defaultMessages["otpUi.VehicleRentalOverlay.availableBikes"]
-                  }
-                  description="Label text for the number of bikes available"
-                  id="otpUi.VehicleRentalOverlay.availableBikes"
-                  values={{ value: station.bikesAvailable }}
-                />
-              </div>
-              <div>
-                <FormattedMessage
-                  defaultMessage={
-                    defaultMessages["otpUi.VehicleRentalOverlay.availableDocks"]
-                  }
-                  description="Label text for the number of docks available"
-                  id="otpUi.VehicleRentalOverlay.availableDocks"
-                  values={{ value: station.spacesAvailable }}
-                />
-              </div>
-            </BaseMapStyled.PopupRow>
-          )}
-
-          {/* Set as from/to toolbar */}
-          <BaseMapStyled.PopupRow>
-            <FromToLocationPicker
-              label
-              location={location}
-              setLocation={setLocation}
-            />
-          </BaseMapStyled.PopupRow>
-        </BaseMapStyled.MapOverlayPopup>
-      </Popup>
-    );
-  };
-
-  render() {
-    const { companies, leaflet, mapSymbols, stations } = this.props;
-    const { zoom = leaflet.map.getZoom() } = this.state;
-    // Render an empty FeatureGroup if the rental vehicles should not be visible
-    // on the map. Otherwise previous stations may still be shown due to some
-    // react-leaflet internals, maybe? Also, do not return null because that will
-    // prevent the overlay from appearing in the layer controls.
-
-    let filteredStations = stations;
-    if (companies) {
-      filteredStations = stations.filter(
-        station =>
-          station.networks.filter(value => companies.includes(value)).length > 0
-      );
-    }
-
-    if (!filteredStations || filteredStations.length === 0) {
-      return <FeatureGroup />;
-    }
-
-    // Convert map symbols for this overlay to zoomBasedSymbolType.
-    const symbols = this.convertToZoomMarkerSymbols(mapSymbols);
-
-    return (
-      <FeatureGroup>
-        <ZoomBasedMarkers
-          entities={filteredStations}
-          symbols={symbols}
-          symbolTransform={this.renderSymbolWithPopup}
-          zoom={zoom}
-        />
-      </FeatureGroup>
-    );
-  }
-}
-
-VehicleRentalOverlay.props = {
-  /**
-   * The entire companies config array.
-   */
-  // configCompanies: PropTypes.arrayOf(coreUtils.types.companyType.isRequired)
-  //   .isRequired,
-  /**
-   * A list of companies that are applicable to just this instance of the
-   * overlay.
-   */
-  companies: PropTypes.arrayOf(PropTypes.string.isRequired),
-  /**
-   * An optional custom function to create a string name of a particular vehicle
-   * rental station. This function takes two arguments of the configCompanies
-   * prop and a vehicle rental station. The function must return a string.
-   */
-  getStationName: PropTypes.func,
-  /**
-   * A configuration of what map markers or symbols to show at various
-   * zoom levels.
-   */
-  // mapSymbols: coreUtils.types.vehicleRentalMapOverlaySymbolsType,
-  /**
-   * If specified, a function that will be triggered every 30 seconds whenever this layer is
-   * visible.
-   */
-  refreshVehicles: PropTypes.func,
-  /**
-   * A callback for when a user clicks on setting this stop as either the from
-   * or to location of a new search.
-   *
-   * This will be dispatched with the following argument:
-   *
-   * ```js
-   *  {
-   *    location: {
-   *      lat: number,
-   *      lon: number,
-   *      name: string
-   *    },
-   *    locationType: "from" or "to"
-   *  }
-   * ```
-   */
-  setLocation: PropTypes.func.isRequired,
-  /**
-   * A list of the vehicle rental stations specific to this overlay instance.
-   */
-  // stations: PropTypes.arrayOf(coreUtils.types.stationType),
-  /**
-   * Whether the overlay is currently visible.
-   */
-  visible: PropTypes.bool
-};
-
-VehicleRentalOverlay.defaultProps = {
-  getStationName: null,
-  mapSymbols: [
-    {
-      zoom: 0,
-      symbol: GenericMarker
-    }
-  ],
-  refreshVehicles: null,
-  stations: [],
-  visible: false
-};
-
-export default withLeaflet(injectIntl(VehicleRentalOverlay));