@iternio/react-native-auto-play 0.1.7 → 0.1.8

package/README.md

@@ -9,7 +9,7 @@
 
 [![npm version](https://img.shields.io/npm/v/@iternio/react-native-auto-play.svg)](https://www.npmjs.com/package/@iternio/react-native-auto-play)
 [![npm downloads](https://img.shields.io/npm/dm/@iternio/react-native-auto-play.svg)](https://www.npmjs.com/package/@iternio/react-native-auto-play)
-[![License](https://img.shields.io/npm/l/@iternio/react-native-auto-play.svg)](https://github.com/Iternio-Planning-AB/react-native-auto-play/blob/main/LICENSE)
+[![License](https://img.shields.io/npm/l/@iternio/react-native-auto-play.svg)](https://github.com/Iternio-Planning-AB/react-native-auto-play/blob/master/LICENSE.md)
 
 ## Features
 
@@ -196,6 +196,30 @@ In case you wanna open up your CarPlay app from one of the CarPlay dashboard but
 ### Android Auto
 No platform specific setup required - we got you covered with all the required stuff.
 
+### Android Auto Customization
+You can customize certain behaviors of the library on Android Auto by setting properties in your app's `android/gradle.properties` file.
+
+-   **Telemetry Update Interval**: Control how often telemetry data is updated.
+    ```properties
+    ReactNativeAutoPlay_androidTelemetryUpdateInterval=4000
+    ```
+    The value is in milliseconds. The default is `4000`.
+
+-   **UI Scale Factor**: Apply a scaling factor to the React Native UI rendered on the car screen. This does not affect the templates.
+    ```properties
+    ReactNativeAutoPlay_androidAutoScaleFactor=1.5f
+    ```
+    The default value is `1.5`.
+
+-   **Cluster Splash Screen**: Customize the splash screen shown on the instrument cluster.
+    ```properties
+    # Delay in milliseconds after the root component is rendered before the splash screen hides.
+    ReactNativeAutoPlay_clusterSplashDelayMs=1000
+    # Duration of the splash screen fade out animation in milliseconds.
+    ReactNativeAutoPlay_clusterSplashDurationMs=500
+    ```
+    The default values are `1000` for the delay and `500` for the duration.
+
 ## Icons
 The library is using [Material Symbols](https://fonts.google.com/icons) for iconography. The font is bundled with the library, so no extra setup is required. You can use these icons on both Android Auto and CarPlay.
 
@@ -384,8 +408,8 @@ useEffect(() => {
 
 -   `useMapTemplate()`: Get a reference to the parent `MapTemplate` instance.
 -   `useVoiceInput()`: Access voice input functionality - Android Auto only.
--   `useSafeAreaInsets()`: Get safe area insets for the car screen.
--   `useFocusedEffect()`: A useEffect alternative that executes when the specified component is visible to the user - use any of the `AutoPlayModules` enum or a cluster uuid.
+-   `useSafeAreaInsets()`: Get safe area insets for any root component.
+-   `useFocusedEffect()`: A useEffect alternative that executes when the specified component is visible to the user - use any of the `AutoPlayModules` enum or a cluster uuid to sepcify the component the effect should listen for.
 -   `useAndroidAutoTelemetry()`: Access to car telemetry data on Android Auto.
     ```tsx
     import {
@@ -442,6 +466,17 @@ useEffect(() => {
 -   **Broken exceptions with `react-native-skia`**: When using `react-native-skia` up to version `2.4.7`, exceptions on iOS are not reported correctly. This is fixed in newer versions of `react-native-skia`. For more details, see this [pull request](https://github.com/Shopify/react-native-skia/pull/3595).
 -   **AppState on iOS**: The `AppState` module from React Native does not work correctly on iOS because this library uses scenes, which are not supported by the stock `AppState` module. This library provides a custom state listener that works for both Android and iOS. Use `HybridAutoPlay.addListenerRenderState` instead of `AppState`.
 -   **Timers stop on screen lock**: iOS stops all timers when the device's main screen is turned off. To ensure timers continue to run (which is often necessary for background tasks related to autoplay), a patch for `react-native` is required. A patch is included in the root `patches/` directory and can be applied using `patch-package`.
+-   **expo-splash-screen stuck on iOS**: The `expo-splash-screen` module is broken on iOS because it does not support scenes, which are used by this library. This can cause the splash screen to be stuck on either the mobile device or on CarPlay. To fix this, a patch for `expo-splash-screen` is included in the root `patches/` directory and can be applied using `patch-package`. After applying the patch, you can hide the splash screen for a specific scene by passing the module name to the `hide` or `hideAsync` function. The module name can be one of the values from the `AutoPlayModules` enum or the UUID of a cluster screen.
+    ```tsx
+    import { hideAsync } from 'expo-splash-screen';
+    import { AutoPlayModules } from '@iternio/react-native-auto-play';
+
+    // Hide the splash screen for the main app
+    hideAsync(AutoPlayModules.App);
+
+    // Hide the splash screen for the CarPlay screen
+    hideAsync(AutoPlayModules.AutoPlayRoot);
+    ```
 
 ## Contributing
 
@@ -450,3 +485,4 @@ Contributions are welcome! Please submit a pull request.
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

package/ios/scenes/AutoPlayInterfaceController.swift

@@ -70,6 +70,9 @@ class AutoPlayInterfaceController: NSObject, CPInterfaceControllerDelegate {
     ) async throws -> String? {
         guard let templateId = topTemplateId else { return nil }
 
+        // Ensure at least one template remains
+        guard templates.count > 1 else { return nil }
+
         try await interfaceController.popTemplate(
             animated: animated
         )

package/lib/specs/VoiceInput.nitro.d.ts

@@ -0,0 +1,8 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+import type { CleanupCallback } from '../types/Event';
+export interface VoiceInput extends HybridObject<{
+    android: 'kotlin';
+    ios: 'swift';
+}> {
+    registerVoiceInputListener(callback: (voiceInputResult?: string, error?: string) => void): CleanupCallback;
+}

package/lib/specs/VoiceInput.nitro.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iternio/react-native-auto-play",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Android Auto and Apple CarPlay for react-native",
   "main": "lib/index",
   "module": "lib/index",

package/lib/hooks/useIsAutoPlayFocused.d.ts

@@ -1,7 +0,0 @@
-/**
- * A hook to determine if the CarPlay/Android Auto screen is currently focused (visible).
- *
- * @param moduleName The name of the module to listen to.
- * @returns `true` if the screen is focused, `false` otherwise.
- */
-export declare function useIsAutoPlayFocused(moduleName: string): boolean;

package/lib/hooks/useIsAutoPlayFocused.js

@@ -1,20 +0,0 @@
-import { useEffect, useState } from 'react';
-import { HybridAutoPlay } from '..';
-/**
- * A hook to determine if the CarPlay/Android Auto screen is currently focused (visible).
- *
- * @param moduleName The name of the module to listen to.
- * @returns `true` if the screen is focused, `false` otherwise.
- */
-export function useIsAutoPlayFocused(moduleName) {
-    const [isFocused, setIsFocused] = useState(false);
-    useEffect(() => {
-        const remove = HybridAutoPlay.addListenerRenderState(moduleName, (state) => {
-            setIsFocused(state === 'didAppear');
-        });
-        return () => {
-            remove();
-        };
-    }, [moduleName]);
-    return isFocused;
-}

package/lib/hybrid.d.ts

@@ -1,2 +0,0 @@
-import type { AutoPlay as NitroAutoPlay } from './specs/AutoPlay.nitro';
-export declare const HybridAutoPlay: NitroAutoPlay;

package/lib/hybrid.js

@@ -1,2 +0,0 @@
-import { NitroModules } from 'react-native-nitro-modules';
-export const HybridAutoPlay = NitroModules.createHybridObject('AutoPlay');