@iternio/react-native-auto-play 0.0.1

package/src/types/Image.ts

@@ -0,0 +1,32 @@
+import type { ImageSourcePropType } from 'react-native';
+import type { ThemedColor } from '../utils/NitroColor';
+import type { GlyphName } from './Glyphmap';
+
+export type AutoImage =
+  | {
+      name: GlyphName;
+
+      /**
+       * Sets the icon dark and light mode color or a single color for both.
+       * Defaults to white for dark mode and black for light mode if not specified.
+       * Might not get applied everywhere like MapTemplate buttons on Android.
+       */
+      color?: ThemedColor | string;
+
+      /**
+       * Sets the background color for dark and light mode or a single color for both
+       * Defaults to transparent if not specified.
+       */
+      backgroundColor?: ThemedColor | string;
+      fontScale?: number;
+      type: 'glyph';
+    }
+  | {
+      image: ImageSourcePropType;
+      /**
+       * if specified the image gets tinted, if not it will just use the original image
+       * Might not get applied everywhere like MapTemplate buttons on Android.
+       */
+      color?: ThemedColor | string;
+      type: 'asset';
+    };

package/src/types/Maneuver.ts

@@ -0,0 +1,240 @@
+import type { ImageSourcePropType } from 'react-native';
+import type { ThemedColor } from '../utils/NitroColor';
+import type { GlyphName } from './Glyphmap';
+import type { TravelEstimates } from './Trip';
+
+export enum ManeuverType {
+  Depart = 0,
+  Arrive = 10,
+  ArriveLeft = 11,
+  ArriveRight = 12,
+  Straight = 20,
+  Turn = 30,
+  Roundabout = 40,
+  OffRamp = 50,
+  OnRamp = 60,
+  Fork = 70,
+  EnterFerry = 80,
+  Keep = 90,
+}
+
+export enum TrafficSide {
+  Right = 0, // counterclockwise for roundabouts
+  Left = 1, // clockwise for roundabouts
+}
+
+export enum TurnType {
+  NoTurn = 0, // Android TYPE_UNKNOWN, iOS noTurn
+  SlightLeft = 1, // Android TYPE_TURN_SLIGHT_LEFT, iOS slightLeftTurn
+  SlightRight = 2, // Android TYPE_TURN_SLIGHT_RIGHT, iOS slightRightTurn
+  NormalLeft = 3, // Android TYPE_TURN_NORMAL_LEFT, iOS leftTurn
+  NormalRight = 4, // Android TYPE_TURN_NORMAL_RIGHT, iOS rightTurn
+  SharpLeft = 5, // Android TYPE_TURN_SHARP_LEFT, iOS sharpLeftTurn
+  SharpRight = 6, // Android TYPE_TURN_SHARP_RIGHT, iOS sharpRightTurn
+  UTurnLeft = 7, // Android TYPE_U_TURN_LEFT, iOS uTurn
+  UTurnRight = 8, // Android TYPE_U_TURN_RIGHT, iOS uTurn
+}
+
+export enum OffRampType {
+  SlightLeft = 0, // Android TYPE_OFF_RAMP_SLIGHT_LEFT
+  SlightRight = 1, // Android TYPE_OFF_RAMP_SLIGHT_RIGHT
+  NormalLeft = 2, // Android TYPE_OFF_RAMP_NORMAL_LEFT
+  NormalRight = 3, // Android TYPE_OFF_RAMP_NORMAL_RIGHT
+}
+
+export enum OnRampType {
+  SlightLeft = 0, // Android TYPE_ON_RAMP_SLIGHT_LEFT
+  SlightRight = 1, // Android TYPE_ON_RAMP_SLIGHT_RIGHT
+  NormalLeft = 2, // Android TYPE_ON_RAMP_NORMAL_LEFT
+  NormalRight = 3, // Android TYPE_ON_RAMP_NORMAL_RIGHT
+  SharpLeft = 4, // Android TYPE_ON_RAMP_SHARP_LEFT
+  SharpRight = 5, // Android TYPE_ON_RAMP_SHARP_RIGHT
+  UTurnLeft = 6, // Android TYPE_ON_RAMP_U_TURN_LEFT
+  UTurnRight = 7, // Android TYPE_ON_RAMP_U_TURN_RIGHT
+}
+
+export enum ForkType {
+  Left = 0, // Android TYPE_FORK_LEFT
+  Right = 1, // Android TYPE_FORK_RIGHT
+}
+
+export enum KeepType {
+  Left = 0, // Android TYPE_KEEP_LEFT, iOS keepLeft
+  Right = 1, // Android TYPE_KEEP_RIGHT, iOS keepRight
+  FollowRoad = 2,
+}
+
+export interface BaseManeuver {
+  /**
+   * @namespace iOS specify a unique identifier, sending over a Maneuver with a known id will only update the travelEstimates on the previously sent Maneuver
+   * @namespace Android applies all updates and does not check for id
+   */
+  id: string;
+  travelEstimates: TravelEstimates;
+  trafficSide: TrafficSide;
+  maneuverType: ManeuverType;
+  /**
+   * @namespace iOS picks the best matching one based on length
+   * @namespace Android picks the first one only
+   */
+  roadName?: Array<string>;
+  highwayExitLabel?: string;
+}
+
+export interface WaypointManeuver extends BaseManeuver {
+  maneuverType:
+    | ManeuverType.Arrive
+    | ManeuverType.ArriveLeft
+    | ManeuverType.ArriveRight
+    | ManeuverType.Depart;
+}
+
+export interface StraightManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.Straight;
+}
+
+export interface TurnManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.Turn;
+  turnType: TurnType;
+  /**
+   * Optional turn angle in degrees to represent exact turn geometry.
+   */
+  angle?: number;
+  /**
+   * must not include turnAngle
+   * @namespace iOS
+   */
+  elementAngles?: Array<number>;
+}
+
+export interface RoundaboutManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.Roundabout;
+  /**
+   * Optional exit number at the roundabout (1 = first exit).
+   */
+  exitNumber?: number;
+  /**
+   * Optional exit angle in degrees (1 to 360).
+   */
+  angle?: number;
+  /**
+   * must not include exitAngle
+   * @namespace iOS
+   */
+  elementAngles?: Array<number>;
+}
+
+export interface OffRampManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.OffRamp;
+  offRampType: OffRampType;
+}
+
+export interface OnRampManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.OnRamp;
+  onRampType: OnRampType;
+}
+
+export interface FerryManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.EnterFerry;
+}
+
+export interface ForkManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.Fork;
+  forkType: ForkType;
+}
+
+export interface KeepManeuver extends BaseManeuver {
+  maneuverType: ManeuverType.Keep;
+  keepType: KeepType;
+}
+
+export interface Lane {
+  angles: Array<number>;
+}
+
+export interface PreferredLane extends Lane {
+  /**
+   * highlightedAngle must not be included in angles, if you have no more angles you can specify an empty angles array
+   */
+  highlightedAngle: number;
+  isPreferred: boolean;
+}
+
+export type ManeuverImage =
+  | {
+      name: GlyphName;
+      /**
+       * make sure to specify a color with a proper contrast ratio to cardBackgroundColor otherwise it might not get applied
+       * defaults to white/black for dark/light mode
+       */
+      color?: ThemedColor | string;
+      type: 'glyph';
+    }
+  | {
+      image: ImageSourcePropType;
+      /**
+       * if specified the image gets tinted, if not it will just use the original image
+       */
+      color?: ThemedColor | string;
+      type: 'asset';
+    };
+
+interface LaneImage {
+  /**
+   * all images from all lanes will be merged and
+   * @namespace Android setLanesImage called on the specified step/maneuver
+   * @namespace iOS be set as symbolImage on the secondary maneuver (a new one will be generated, in case you specify a secondary maneuver it will not be shown then)
+   */
+  image: ManeuverImage;
+}
+
+export type Maneuver =
+  | WaypointManeuver
+  | StraightManeuver
+  | TurnManeuver
+  | RoundaboutManeuver
+  | OffRampManeuver
+  | OnRampManeuver
+  | FerryManeuver
+  | ForkManeuver
+  | KeepManeuver;
+
+export type AttributedInstructionVariantImage = { image: ManeuverImage; position: number };
+
+export type AttributedInstructionVariant = {
+  text: string;
+  images?: Array<AttributedInstructionVariantImage>;
+};
+
+export type PreferredImageLane = PreferredLane & LaneImage;
+export type ImageLane = Lane & LaneImage;
+
+export type LinkedLaneGuidance = {
+  /**
+   * @namespace iOS
+   */
+  instructionVariants: Array<string>;
+  lanes: Array<PreferredImageLane | ImageLane>;
+};
+
+export type RoutingManeuver = Maneuver & {
+  attributedInstructionVariants: Array<AttributedInstructionVariant>;
+  symbolImage: ManeuverImage;
+  junctionImage?: ManeuverImage;
+  linkedLaneGuidance?: LinkedLaneGuidance;
+  cardBackgroundColor: ThemedColor | string;
+  type: 'routing';
+};
+
+export type MessageManeuver = {
+  title: string;
+  /**
+   * @namespace Android
+   */
+  text?: string;
+  image?: ManeuverImage;
+  cardBackgroundColor: ThemedColor | string;
+  type: 'message';
+};
+
+export type AutoManeuver = [RoutingManeuver, RoutingManeuver | undefined] | MessageManeuver;

package/src/types/RootComponent.ts

@@ -0,0 +1,38 @@
+export type WindowInformation = {
+  width: number;
+  height: number;
+  scale: number;
+};
+
+export type ColorScheme = 'dark' | 'light';
+
+export type RootComponentInitialProps = {
+  /**
+   * AutoPlayRoot for the main app on the head unit
+   * AutoPlayDashboard for the CarPlay dashboard (iOS only)
+   * or a random uuid for cluster displays
+   */
+  id: string;
+  /**
+   * react-native rootTag
+   */
+  rootTag: number;
+  /**
+   * this is the initial color scheme, add onAppearanceDidChange on MapTemplate to get updates
+   */
+  colorScheme: ColorScheme;
+  window: WindowInformation;
+};
+
+export type AutoPlayClusterInitialProps = RootComponentInitialProps & {
+  /**
+   * lets you know if the compass is enabled/disabled
+   * @namespace iOS
+   */
+  compass?: boolean;
+  /**
+   * lets you know if the speed limit is enabled/disabled
+   * @namespace iOS
+   */
+  speedLimit?: boolean;
+};

package/src/types/Telemetry.ts

@@ -0,0 +1,71 @@
+import type { Permission } from 'react-native/types';
+
+export type AndroidAutoPermissions =
+  | Permission
+  | AndroidAutoTelemetryPermissions
+  | AndroidAutomotiveTelemetryPermissions;
+
+export enum AndroidAutoTelemetryPermissions {
+  Speed = 'com.google.android.gms.permission.CAR_SPEED',
+  Energy = 'com.google.android.gms.permission.CAR_FUEL',
+  Odometer = 'com.google.android.gms.permission.CAR_MILEAGE',
+}
+
+export enum AndroidAutomotiveTelemetryPermissions {
+  Info = 'android.car.permission.CAR_INFO',
+  Speed = 'android.car.permission.CAR_SPEED',
+  Energy = 'android.car.permission.CAR_ENERGY',
+  ExteriorEnvironment = 'android.car.permission.CAR_EXTERIOR_ENVIRONMENT',
+  EnergyPorts = 'android.car.permission.CAR_ENERGY_PORTS',
+}
+
+export type PermissionRequestResult = { granted: Array<string>; denied: Array<string> } | null;
+
+type NumericTelemetryItem = {
+  /**
+   * timestamp in seconds when the value was received on native side
+   */
+  timestamp: number;
+  value: number;
+};
+
+type StringTelemetryItem = {
+  /**
+   * timestamp in seconds when the value was received on native side
+   */
+  timestamp: number;
+  value: string;
+};
+
+type VehicleTelemetryItem = {
+  name?: StringTelemetryItem;
+  year?: NumericTelemetryItem;
+  manufacturer?: StringTelemetryItem;
+};
+
+export type Telemetry = {
+  /**
+   * Speed in km/h
+   */
+  speed?: NumericTelemetryItem;
+  /**
+   * Fuel level in %
+   */
+  fuelLevel?: NumericTelemetryItem;
+  /**
+   * Battery level in %
+   */
+  batteryLevel?: NumericTelemetryItem;
+  /**
+   * Range in km
+   */
+  range?: NumericTelemetryItem;
+  /**
+   * Odometer in km
+   */
+  odometer?: NumericTelemetryItem;
+  /**
+   * Vehicle information
+   */
+  vehicle?: VehicleTelemetryItem;
+};

package/src/types/Text.ts

@@ -0,0 +1,26 @@
+export type DistanceUnits = 'meters' | 'miles' | 'kilometers' | 'yards' | 'feet';
+
+export type Distance = {
+  value: number;
+  unit: DistanceUnits;
+};
+
+export enum TextPlaceholders {
+  Distance = '{distance}',
+  Duration = '{duration}',
+}
+
+export type AutoText = {
+  /**
+   * use the `TextPlaceholders.Distance` and `TextPlaceholders.Duration` inside the string to position the distance and duration props
+   */
+  text: string;
+  /**
+   * make sure to use `TextPlaceholders.Distance` on the text property
+   */
+  distance?: Distance;
+  /**
+   * duration in seconds, make sure to use `TextPlaceholders.Duration` on the text property
+   */
+  duration?: number;
+};

package/src/types/Trip.ts

@@ -0,0 +1,79 @@
+import type { AutoText, Distance } from './Text';
+
+type RouteChoice = {
+  id: string;
+  /**
+   * Title on the alternatives, only visible when providing more then one routeChoices
+   */
+  summaryVariants: Array<string>;
+  /**
+   * Content shown on the overview, only property visible when providing a single routeChoice
+   */
+  additionalInformationVariants: Array<string>;
+  /**
+   * Subtitle on the alternatives, only visible when providing more then one routeChoices
+   * travelEstimates are automatically appended to this one
+   */
+  selectionSummaryVariants: Array<string>;
+  /**
+   * ⚠️ name of the last step is used as title on Android Auto,
+   * ideally all these should have the same name to make sure to not exceed the step count
+   * https://developer.android.com/design/ui/cars/guides/ux-requirements/plan-task-flows#steps-refreshes
+   */
+  steps: Array<TripPoint>;
+};
+
+export type TripPoint = {
+  latitude: number;
+  longitude: number;
+  name: string;
+  /**
+   * includes the duration until arriving at this step, distance to this step and arrival time with timezone
+   */
+  travelEstimates: TravelEstimates;
+};
+
+/**
+ * used for showTripSelector
+ */
+export type TripsConfig = {
+  id: string;
+  routeChoices: Array<RouteChoice>;
+};
+
+export type TripPreviewTextConfiguration = {
+  startButtonTitle: string;
+  additionalRoutesButtonTitle: string;
+  overviewButtonTitle: string;
+  /**
+   * specifies the title for the travel estimates row on the trip preview
+   * @namespace Android
+   */
+  travelEstimatesTitle: string;
+};
+
+export type DurationWithTimeZone = {
+  timezone: string;
+  seconds: number;
+};
+
+export type TravelEstimates = {
+  distanceRemaining: Distance;
+  timeRemaining: DurationWithTimeZone;
+  /**
+   * @namespace Android
+   */
+  tripText?: AutoText;
+  // /**
+  //  * @namespace Android
+  //  */
+  // tripIcon?: number;
+};
+
+/**
+ * used for startNavigation
+ */
+export type TripConfig = {
+  id: string;
+  routeChoice: RouteChoice;
+};