@react-native-tvos/config-tv 0.0.9 → 0.0.11

package/README.md

@@ -39,6 +39,7 @@ or
           "tvosDeploymentTarget": "13.4",
           "removeFlipperOnAndroid": true,
           "androidTVBanner": "assets/images/tv_banner.png",
+          "androidTVIcon": "assets/images/tv_icon.png",
           "appleTVImages": {
             "icon": "./assets/images/myimage-tvos-1280x768.png",
             "iconSmall": "./assets/images/myimage-tvos-400x240.png",
@@ -68,6 +69,7 @@ _Plugin parameters_:
 - `removeFlipperOnAndroid`: (optional boolean, default true) Used to remove the Flipper dependency from `MainApplication.kt` (or `MainApplication.java`) and `android/app/build.gradle`. This is necessary for React Native TV 0.73 and higher, since Flipper integration is removed from these versions. If this causes issues, set the value to false, run `npx expo prebuild --clean` again, and then remove Flipper from your Android source manually. This change will be made regardless of the setting of the `EXPO_TV` environment variable or the value of the `isTV` plugin parameter, as it is needed for both Android mobile and Android TV.
 - `androidTVRequired`: (optional boolean, default false) If set, the Android manifest will be configured for Android TV only (no Android mobile support). Specifically, the "uses-feature" tag for "android.software.leanback" will be set to "required=true".
 - `androidTVBanner`: (optional string) If set, this should be a path to an existing PNG file appropriate for an Android TV banner image. See https://developer.android.com/design/ui/tv/guides/system/tv-app-icon-guidelines#banner . The Android manifest will be modified to reference this image, and the image will be copied into Android resource drawable directories.
+-  `androidTVIcon`: (optional string) If set, this should be a path to an existing PNG file appropriate for an Android TV icon image. See https://developer.android.com/design/ui/tv/guides/system/tv-app-icon-guidelines#launcher-icon . The Android manifest will be modified to reference this image, and the image will be copied into Android resource drawable and mipmap directories.
 - `appleTVImages`: (optional object) If set, this is an object with the paths to images needed to construct the Apple TV icon and top shelf brand assets. The images will be used to construct a brand asset catalog in the Xcode project Image catalog, and the project updated to use the brand assets as the source for the app icons. If this property is set, all image paths must be defined and the files must exist, or an error will be thrown. The images need to be the exact sizes shown here, in order to avoid errors during Xcode compilation and on submission to the App Store or TestFlight.
   - `icon`: (string) Path to a 1280x760 image
   - `iconSmall`: (string) Path to a 400x240 image

package/build/types.d.ts

@@ -69,6 +69,14 @@ export type ConfigData = {
      * Android resource drawable directories.
      */
     androidTVBanner?: string;
+    /**
+     * If set, this should be a path to an existing PNG file appropriate for an Android TV icon image.
+     * See https://developer.android.com/design/ui/tv/guides/system/tv-app-icon-guidelines#launcher-icon
+     * The icon image will not be resized.
+     * The Android manifest will be modified to reference this image and the image will be copied into
+     * Android resource drawable directories.
+     */
+    androidTVIcon?: string;
     /**
      * If set, this is an object with the paths to images needed to construct the Apple TV icon and
      * top shelf brand assets. The images will be used to construct a brand asset catalog in the Xcode

package/build/utils/config.d.ts

@@ -5,5 +5,6 @@ export declare function tvosDeploymentTarget(params: ConfigData): string;
 export declare function shouldRemoveFlipperOnAndroid(params: ConfigData): boolean;
 export declare function isAndroidTVRequired(params: ConfigData): boolean;
 export declare function androidTVBanner(params: ConfigData): string | undefined;
+export declare function androidTVIcon(params: ConfigData): string | undefined;
 export declare const appleTVImageTypes: string[];
 export declare function appleTVImagePathForType(params: ConfigData, imageType: string): string | undefined;

package/build/utils/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.appleTVImagePathForType = exports.appleTVImageTypes = exports.androidTVBanner = exports.isAndroidTVRequired = exports.shouldRemoveFlipperOnAndroid = exports.tvosDeploymentTarget = exports.isTVEnabled = exports.packageNameAndVersion = void 0;
+exports.appleTVImagePathForType = exports.appleTVImageTypes = exports.androidTVIcon = exports.androidTVBanner = exports.isAndroidTVRequired = exports.shouldRemoveFlipperOnAndroid = exports.tvosDeploymentTarget = exports.isTVEnabled = exports.packageNameAndVersion = void 0;
 const getenv_1 = require("getenv");
 class Env {
     /** Enable prebuild for TV */
@@ -32,6 +32,10 @@ function androidTVBanner(params) {
     return params?.androidTVBanner;
 }
 exports.androidTVBanner = androidTVBanner;
+function androidTVIcon(params) {
+    return params?.androidTVIcon;
+}
+exports.androidTVIcon = androidTVIcon;
 exports.appleTVImageTypes = [
     'icon',
     'iconSmall',

package/build/withTV.js

@@ -9,6 +9,7 @@ const withTVSplashScreen_1 = require("./withTVSplashScreen");
 const withTVXcodeProject_1 = require("./withTVXcodeProject");
 const withTVAndroidRemoveFlipper_1 = require("./withTVAndroidRemoveFlipper");
 const withTVAndroidBannerImage_1 = require("./withTVAndroidBannerImage");
+const withTVAndroidIconImage_1 = require("./withTVAndroidIconImage");
 const utils_1 = require("./utils");
 const withTVNoEffect = (config, params = {}) => {
     (0, utils_1.verboseLog)(`${utils_1.packageNameAndVersion}: isTV == false, TV-specific modifications will not be made.`, {});
@@ -29,6 +30,7 @@ const withTVPlugin = (config, params = {}) => {
     config = (0, withTVInfoPlist_1.withTVInfoPlist)(config, params);
     config = (0, withTVSplashScreen_1.withTVSplashScreen)(config, params);
     config = (0, withTVAndroidBannerImage_1.withTVAndroidBannerImage)(config, params); // This should be done before Android manifest config
+    config = (0, withTVAndroidIconImage_1.withTVAndroidIconImage)(config, params);
     config = (0, withTVAndroidManifest_1.withTVAndroidManifest)(config, params);
     return config;
 };

package/build/withTVAndroidIconImage.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
+/** Copies TV Icon image to the Android resources drawable folders. If image does not exist, throw an exception. */
+export declare const withTVAndroidIconImage: ConfigPlugin<ConfigData>;

package/build/withTVAndroidIconImage.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withTVAndroidIconImage = void 0;
+const config_plugins_1 = require("expo/config-plugins");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+const drawableDirectoryNames = [
+    'drawable',
+    'mipmap',
+    'mipmap-hdpi',
+    'mipmap-mdpi',
+    'mipmap-xhdpi',
+    'mipmap-xxhdpi',
+    'mipmap-xxxhdpi',
+];
+/** Copies TV Icon image to the Android resources drawable folders. If image does not exist, throw an exception. */
+const withTVAndroidIconImage = (c, params = {}) => {
+    const androidTVIconPath = (0, utils_1.androidTVIcon)(params);
+    return (0, config_plugins_1.withDangerousMod)(c, [
+        'android',
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        async (config) => {
+            if (!androidTVIconPath) {
+                return config;
+            }
+            (0, utils_1.verboseLog)(`adding TV Icon image ${androidTVIconPath} to Android resources`, {
+                params,
+                platform: 'android',
+                property: 'manifest',
+            });
+            for (const drawableDirectoryName of drawableDirectoryNames) {
+                const drawableDirectoryPath = path_1.default.join(config.modRequest.platformProjectRoot, 'app', 'src', 'main', 'res', drawableDirectoryName);
+                if (!(0, fs_1.existsSync)(drawableDirectoryPath)) {
+                    await fs_1.promises.mkdir(drawableDirectoryPath);
+                }
+                if (drawableDirectoryName === "drawable") {
+                    await fs_1.promises.copyFile(androidTVIconPath, path_1.default.join(drawableDirectoryPath, 'tv_icon.png'));
+                }
+                else {
+                    await fs_1.promises.copyFile(androidTVIconPath, path_1.default.join(drawableDirectoryPath, 'ic_launcher.png'));
+                    await fs_1.promises.copyFile(androidTVIconPath, path_1.default.join(drawableDirectoryPath, 'ic_launcher_round.png'));
+                }
+            }
+            return config;
+        },
+    ]);
+};
+exports.withTVAndroidIconImage = withTVAndroidIconImage;

package/build/withTVAndroidManifest.d.ts

@@ -5,4 +5,5 @@ export declare const withTVAndroidManifest: ConfigPlugin<ConfigData>;
 export declare function setLeanBackLauncherIntent(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData): AndroidConfig.Manifest.AndroidManifest;
 export declare function removePortraitOrientation(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData): AndroidConfig.Manifest.AndroidManifest;
 export declare function setTVBanner(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData, androidTVBannerPath: string | undefined): AndroidConfig.Manifest.AndroidManifest;
+export declare function setTVIcon(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData, androidTVIconPath: string | undefined): AndroidConfig.Manifest.AndroidManifest;
 export declare function addTouchscreenHardwareFeatureToManifest(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData): AndroidConfig.Manifest.AndroidManifest;

package/build/withTVAndroidManifest.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addTouchscreenHardwareFeatureToManifest = exports.setTVBanner = exports.removePortraitOrientation = exports.setLeanBackLauncherIntent = exports.withTVAndroidManifest = void 0;
+exports.addTouchscreenHardwareFeatureToManifest = exports.setTVIcon = exports.setTVBanner = exports.removePortraitOrientation = exports.setLeanBackLauncherIntent = exports.withTVAndroidManifest = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const utils_1 = require("./utils");
 const { getMainActivity, getMainApplication } = config_plugins_1.AndroidConfig.Manifest;
 const withTVAndroidManifest = (config, params = {}) => {
     const androidTVBannerPath = (0, utils_1.androidTVBanner)(params);
+    const androidTVIconPath = (0, utils_1.androidTVIcon)(params);
     return (0, config_plugins_1.withAndroidManifest)(config, (config) => {
         config.modResults = setLeanBackLauncherIntent(config, config.modResults, params);
         config.modResults = removePortraitOrientation(config, config.modResults, params);
@@ -13,6 +14,9 @@ const withTVAndroidManifest = (config, params = {}) => {
         if (androidTVBannerPath) {
             config.modResults = setTVBanner(config, config.modResults, params, androidTVBannerPath);
         }
+        if (androidTVIconPath) {
+            config.modResults = setTVIcon(config, config.modResults, params, androidTVIconPath);
+        }
         return config;
     });
 };
@@ -91,6 +95,23 @@ function setTVBanner(_config, androidManifest, params, androidTVBannerPath) {
     return androidManifest;
 }
 exports.setTVBanner = setTVBanner;
+function setTVIcon(_config, androidManifest, params, androidTVIconPath) {
+    if (!androidTVIconPath) {
+        return androidManifest;
+    }
+    const mainApplication = getMainApplication(androidManifest);
+    if (mainApplication?.$) {
+        const metadata = mainApplication?.$ ?? {};
+        (0, utils_1.verboseLog)('adding TV icon to AndroidManifest.xml', {
+            params,
+            platform: 'android',
+            property: 'manifest',
+        });
+        metadata['android:icon'] = '@drawable/tv_icon';
+    }
+    return androidManifest;
+}
+exports.setTVIcon = setTVIcon;
 function addTouchscreenHardwareFeatureToManifest(_config, androidManifest, params) {
     // Add `<uses-feature android:name="android.hardware.touchscreen" android:required="false"/>` to the AndroidManifest.xml
     if (!Array.isArray(androidManifest.manifest['uses-feature'])) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-tvos/config-tv",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Config plugin to reconfigure native directories for Apple TV and Android TV development if needed",
   "main": "build/withTV.js",
   "types": "build/withTV.d.ts",
@@ -34,7 +34,7 @@
     "react-native-tvos"
   ],
   "peerDependencies": {
-    "expo": "^50.0.6"
+    "expo": "^51"
   },
   "devDependencies": {
     "@types/getenv": "^1.0.1",