release(android-v12.0.1): updated version and RELEASENOTES.md

* chore: rebuild package-lock.json
* chore: remew file starting new-line

RELEASENOTES.md

@@ -20,6 +20,11 @@
 -->
 ## Release Notes for Cordova (Android)
 
+### 12.0.1 (Aug 23, 2023)
+
+* [GH-1632](https://github.com/apache/cordova-android/pull/1632) fix(android): `monochrome` checks
+* [GH-1649](https://github.com/apache/cordova-android/pull/1649) chore: rebuild `package-lock` w/ lint corrections
+
 ### 12.0.0 (May 20, 2023)
 
 **Breaking:**

framework/src/org/apache/cordova/CordovaWebView.java

@@ -31,7 +31,7 @@ import android.webkit.WebChromeClient.CustomViewCallback;
  * are not expected to implement it.
  */
 public interface CordovaWebView {
-    public static final String CORDOVA_VERSION = "12.0.0";
+    public static final String CORDOVA_VERSION = "12.0.1";
 
     void init(CordovaInterface cordova, List<PluginEntry> pluginEntries, CordovaPreferences preferences);
 

lib/config/CordovaGradleConfigParserFactory.js

@@ -1,4 +1,3 @@
-
 /**
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file

lib/prepare.js

@@ -21,6 +21,7 @@ const fs = require('fs-extra');
 const path = require('path');
 const nopt = require('nopt');
 const glob = require('fast-glob');
+const dedent = require('dedent');
 const events = require('cordova-common').events;
 const AndroidManifest = require('./AndroidManifest');
 const xmlHelpers = require('cordova-common').xmlHelpers;
@@ -747,9 +748,24 @@ function updateIconResourceForAdaptive (preparedIcons, resourceMap, platformReso
         foreground = android_icons[density].foreground;
         monochrome = android_icons[density].monochrome;
 
-        const isAdaptiveIcon = background && foreground;
-        const isMonochromeIcon = monochrome && isAdaptiveIcon;
-        if (!isMonochromeIcon || !isAdaptiveIcon) {
+        const hasAdaptiveIcons = !!background && !!foreground;
+        let hasMonochromeIcon = !!monochrome;
+
+        if (hasMonochromeIcon && !hasAdaptiveIcons) {
+            // If we have a monochrome icon, but no adaptive icons,
+            // then warn that in order to use monochrome, the adaptive icons
+            // must be supplied. We will ignore monochrome and proceed with the
+            // icon preparation however.
+            hasMonochromeIcon = false;
+            monochrome = undefined;
+            events.emit('warn', dedent`
+                Monochrome icon found but without adaptive properties.
+                Monochrome icon requires the adaptive background and foreground assets.
+                See https://cordova.apache.org/docs/en/latest/config_ref/images.html fore more information.
+            `);
+        }
+
+        if (!hasAdaptiveIcons) {
             // This icon isn't an adaptive icon, so skip it
             continue;
         }
@@ -780,7 +796,7 @@ function updateIconResourceForAdaptive (preparedIcons, resourceMap, platformReso
             resourceMap[targetPathForeground] = android_icons[density].foreground;
         }
 
-        if (monochrome) {
+        if (hasMonochromeIcon) {
             if (path.extname(path.basename(monochrome)) === '.xml') {
                 // Vector Use Case
                 targetPathMonochrome = getAdaptiveImageResourcePath(platformResourcesDir, 'mipmap', density, 'ic_launcher_monochrome.xml', path.basename(android_icons[density].monochrome));
@@ -794,19 +810,23 @@ function updateIconResourceForAdaptive (preparedIcons, resourceMap, platformReso
 
         // create an XML for DPI and set color
         let icLauncherTemplate = '';
-        if (monochrome) {
-            icLauncherTemplate = `<?xml version="1.0" encoding="utf-8"?>
-<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
-    <background android:drawable="` + backgroundVal + `" />
-    <foreground android:drawable="` + foregroundVal + `" />
-    <monochrome android:drawable="` + monochromeVal + `" />
-</adaptive-icon>`;
+        if (hasMonochromeIcon) {
+            icLauncherTemplate = dedent`
+                <?xml version="1.0" encoding="utf-8"?>
+                <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+                    <background android:drawable="${backgroundVal}" />
+                    <foreground android:drawable="${foregroundVal}" />
+                    <monochrome android:drawable="${monochromeVal}" />
+                </adaptive-icon>
+            `;
         } else {
-            icLauncherTemplate = `<?xml version="1.0" encoding="utf-8"?>
-<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
-    <background android:drawable="` + backgroundVal + `" />
-    <foreground android:drawable="` + foregroundVal + `" />
-</adaptive-icon>`;
+            icLauncherTemplate = dedent`
+                <?xml version="1.0" encoding="utf-8"?>
+                <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+                    <background android:drawable="${backgroundVal}" />
+                    <foreground android:drawable="${foregroundVal}" />
+                </adaptive-icon>
+            `;
         }
 
         const launcherXmlPath = path.join(platformResourcesDir, 'mipmap-' + density + '-v26', 'ic_launcher.xml');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-android",
-  "version": "12.0.0",
+  "version": "12.0.1",
   "description": "cordova-android release",
   "types": "./types/index.d.ts",
   "main": "lib/Api.js",
@@ -27,6 +27,7 @@
   "dependencies": {
     "android-versions": "^1.8.1",
     "cordova-common": "^5.0.0",
+    "dedent": "^1.0.1",
     "execa": "^5.1.1",
     "fast-glob": "^3.2.12",
     "fs-extra": "^11.1.1",

spec/unit/prepare.spec.js

@@ -630,43 +630,106 @@ describe('prepare', () => {
         let preparedIcons;
         let resourceMap;
 
-        beforeEach(function () {
-            // Mocked Data
-            platformResourcesDir = PATH_RESOURCE;
-            preparedIcons = {
-                android_icons: {
-                    mdpi: mockGetIconItem({
-                        density: 'mdpi',
-                        background: 'res/icon/android/mdpi-background.png',
-                        foreground: 'res/icon/android/mdpi-foreground.png',
-                        monochrome: 'res/icon/android/mdpi-monochrome.png'
-                    })
-                },
-                default_icon: undefined
-            };
+        describe('without monochrome', () => {
+            beforeEach(function () {
+                // Mocked Data
+                platformResourcesDir = PATH_RESOURCE;
+                preparedIcons = {
+                    android_icons: {
+                        mdpi: mockGetIconItem({
+                            density: 'mdpi',
+                            background: 'res/icon/android/mdpi-background.png',
+                            foreground: 'res/icon/android/mdpi-foreground.png'
+                        })
+                    },
+                    default_icon: undefined
+                };
 
-            resourceMap = createResourceMap();
+                resourceMap = createResourceMap();
 
-            fsWriteFileSyncSpy = jasmine.createSpy('writeFileSync');
-            prepare.__set__('fs', {
-                writeFileSync: fsWriteFileSyncSpy
+                fsWriteFileSyncSpy = jasmine.createSpy('writeFileSync');
+                prepare.__set__('fs', {
+                    writeFileSync: fsWriteFileSyncSpy
+                });
+            });
+
+            it('Test#001 : Should update resource map with prepared icons.', function () {
+            // Get method for testing
+                const updateIconResourceForAdaptive = prepare.__get__('updateIconResourceForAdaptive');
+
+                // Run Test
+                const expectedModification = {};
+                expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_background.png')] = 'res/icon/android/mdpi-background.png';
+                expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_foreground.png')] = 'res/icon/android/mdpi-foreground.png';
+
+                const expected = Object.assign({}, resourceMap, expectedModification);
+                const actual = updateIconResourceForAdaptive(preparedIcons, resourceMap, platformResourcesDir);
+
+                expect(actual).toEqual(expected);
             });
         });
 
-        it('Test#001 : Should update resource map with prepared icons.', function () {
-        // Get method for testing
-            const updateIconResourceForAdaptive = prepare.__get__('updateIconResourceForAdaptive');
+        describe('with monochrome', () => {
+            beforeEach(function () {
+                // Mocked Data
+                platformResourcesDir = PATH_RESOURCE;
+                preparedIcons = {
+                    android_icons: {
+                        mdpi: mockGetIconItem({
+                            density: 'mdpi',
+                            background: 'res/icon/android/mdpi-background.png',
+                            foreground: 'res/icon/android/mdpi-foreground.png',
+                            monochrome: 'res/icon/android/mdpi-monochrome.png'
+                        })
+                    },
+                    default_icon: undefined
+                };
 
-            // Run Test
-            const expectedModification = {};
-            expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_background.png')] = 'res/icon/android/mdpi-background.png';
-            expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_foreground.png')] = 'res/icon/android/mdpi-foreground.png';
-            expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_monochrome.png')] = 'res/icon/android/mdpi-monochrome.png';
+                resourceMap = createResourceMap();
 
-            const expected = Object.assign({}, resourceMap, expectedModification);
-            const actual = updateIconResourceForAdaptive(preparedIcons, resourceMap, platformResourcesDir);
+                fsWriteFileSyncSpy = jasmine.createSpy('writeFileSync');
+                prepare.__set__('fs', {
+                    writeFileSync: fsWriteFileSyncSpy
+                });
+            });
 
-            expect(actual).toEqual(expected);
+            it('Test#002 : Should update resource map with prepared icons.', function () {
+            // Get method for testing
+                const updateIconResourceForAdaptive = prepare.__get__('updateIconResourceForAdaptive');
+
+                // Run Test
+                const expectedModification = {};
+                expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_background.png')] = 'res/icon/android/mdpi-background.png';
+                expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_foreground.png')] = 'res/icon/android/mdpi-foreground.png';
+                expectedModification[path.join(PATH_RESOURCE, 'mipmap-mdpi-v26', 'ic_launcher_monochrome.png')] = 'res/icon/android/mdpi-monochrome.png';
+
+                const expected = Object.assign({}, resourceMap, expectedModification);
+                const actual = updateIconResourceForAdaptive(preparedIcons, resourceMap, platformResourcesDir);
+
+                expect(actual).toEqual(expected);
+            });
+
+            it('Test#003 : should emit if monochrome is supplied without adaptive background', () => {
+                const updateIconResourceForAdaptive = prepare.__get__('updateIconResourceForAdaptive');
+
+                preparedIcons.android_icons.mdpi.background = undefined;
+                updateIconResourceForAdaptive(preparedIcons, resourceMap, platformResourcesDir);
+
+                const actualEmitArgs = emitSpy.calls.mostRecent().args;
+                expect(actualEmitArgs[0]).toBe('warn');
+                expect(actualEmitArgs[1]).toMatch(/Monochrome icon found but without adaptive properties./g);
+            });
+
+            it('Test#004 : should emit if monochrome is supplied without adaptive foreground', () => {
+                const updateIconResourceForAdaptive = prepare.__get__('updateIconResourceForAdaptive');
+
+                preparedIcons.android_icons.mdpi.foreground = undefined;
+                updateIconResourceForAdaptive(preparedIcons, resourceMap, platformResourcesDir);
+
+                const actualEmitArgs = emitSpy.calls.mostRecent().args;
+                expect(actualEmitArgs[0]).toBe('warn');
+                expect(actualEmitArgs[1]).toMatch(/Monochrome icon found but without adaptive properties./g);
+            });
         });
     });