RMET-3283 ::: iOS ::: Add Privacy Manifest

CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 The changes documented here do not include those from the original repository.
 
 ## [Unreleased]
+### Chores
+- Update the iOS framework. This adds the Privacy Manifest file (https://outsystemsrd.atlassian.net/browse/RMET-3283).
+- Update cordova hooks with new OutSystems specific errors. (https://outsystemsrd.atlassian.net/browse/RMET-3311)
+
+## [Version 1.1.2]
+
+### 21-12-2023
+- Fix: [Android] Updates dependency to OSCore and OSCordova (https://outsystemsrd.atlassian.net/browse/RMET-2993).
+
+## [Version 1.1.1]
+
+### 03-10-2023
+- Fix: [iOS] Fixes path, removing duplicate string (https://outsystemsrd.atlassian.net/browse/RMET-2855).
+
+### 13-07-2023
+- Feat: Update hook to consider new resources paths (https://outsystemsrd.atlassian.net/browse/RMET-2477).
 
 ## [Version 1.1.0]
 

CODEOWNERS

@@ -0,0 +1,2 @@
+# O11/ODC
+* @OutSystems/rd-mobile-ecosystem

hooks/android/androidCopyPreferences.js

@@ -5,43 +5,49 @@ const fs = require('fs');
 module.exports = function (context) {
 
     const ServiceEnum = Object.freeze({"ApplePay":"1", "GooglePay":"2"})
-    const configFileName = 'www/json-config/PaymentsPluginConfiguration.json';
-
-    var hasGooglePay = false;
-
-    var merchant_name = "";
-    var merchant_country_code = "";
-    var payment_allowed_networks = [];
-    var payment_supported_capabilities = [];
-    var payment_supported_card_countries = [];
-    var shipping_supported_contacts = [];
-    var shipping_country_codes = [];
-    var billing_supported_contacts = [];
-    var gateway = "";
-    var backend_url = "";
+    const configFileName = 'json-config/PaymentsPluginConfiguration.json';
+    let projectRoot = context.opts.cordova.project ? context.opts.cordova.project.root : context.opts.projectRoot;
+
+    let hasGooglePay = false;
+
+    let merchant_name = "";
+    let merchant_country_code = "";
+    let payment_allowed_networks = [];
+    let payment_supported_capabilities = [];
+    let payment_supported_card_countries = [];
+    let shipping_supported_contacts = [];
+    let shipping_country_codes = [];
+    let billing_supported_contacts = [];
+    let gateway = "";
+    let backend_url = "";
     //only for PSPs other than Stripe
-    var gateway_merchant_id = "";
+    let gateway_merchant_id = "";
     //only for stripe
-    var stripe_version = "";
-    var stripe_pub_key = "";
-
-
-    var projectRoot = context.opts.cordova.project ? context.opts.cordova.project.root : context.opts.projectRoot;
+    let stripe_version = "";
+    let stripe_pub_key = "";
+
+    let wwwFolder = "www";
+    let platformPath = path.join(projectRoot, `platforms/android/www`);
+
+    if(!fs.existsSync(platformPath)){
+        platformPath = path.join(projectRoot, wwwFolder);
+    }
 
-    var jsonConfig = "";
+    let jsonConfig = "";
+    let jsonParsed;
     try {
-        jsonConfig = path.join(projectRoot, configFileName);
-        var jsonConfigFile = fs.readFileSync(jsonConfig).toString();
-        var jsonParsed = JSON.parse(jsonConfigFile);
+        jsonConfig = path.join(platformPath, configFileName);
+        let jsonConfigFile = fs.readFileSync(jsonConfig).toString();
+        jsonParsed = JSON.parse(jsonConfigFile);
     }
     catch {
-        throw new Error("Missing configuration file or error trying to obtain the configuration.");
+        throw new Error("OUTSYSTEMS_PLUGIN_ERROR: Missing configuration file or error trying to obtain the configuration.");
     }
 
-    jsonParsed.app_configurations.forEach(function(configItem) {
+    jsonParsed.app_configurations.forEach((configItem) => {
         if (configItem.service_id == ServiceEnum.GooglePay) {
             hasGooglePay = true;
-            var error_list = [];
+            let error_list = [];
 
             if(configItem.merchant_name && configItem.merchant_name !== ""){
                 merchant_name = configItem.merchant_name;
@@ -103,83 +109,83 @@ module.exports = function (context) {
             }
 
             if (error_list.length > 0) {
-                throw new Error("The following fields are either missing or empty in the configuration: " + error_list);
+                console.error("Missing fields: " + error_list);
+                throw new Error("OUTSYSTEMS_PLUGIN_ERROR: Payments configuration is missing some fields. Please check build logs to know more.");
             }
-            return;
         }
     });
 
     if(hasGooglePay){
-        var stringsXmlPath = path.join(projectRoot, 'platforms/android/app/src/main/res/values/strings.xml');
-        var stringsXmlContents = fs.readFileSync(stringsXmlPath).toString();
-        var etreeStrings = et.parse(stringsXmlContents);
+        let stringsXmlPath = path.join(projectRoot, 'platforms/android/app/src/main/res/values/strings.xml');
+        let stringsXmlContents = fs.readFileSync(stringsXmlPath).toString();
+        let etreeStrings = et.parse(stringsXmlContents);
 
-        var merchantNameTags = etreeStrings.findall('./string[@name="merchant_name"]');
-        for (var i = 0; i < merchantNameTags.length; i++) {
+        let merchantNameTags = etreeStrings.findall('./string[@name="merchant_name"]');
+        for (let i = 0; i < merchantNameTags.length; i++) {
             merchantNameTags[i].text = merchant_name;
         }
 
-        var merchantCountryTags = etreeStrings.findall('./string[@name="merchant_country_code"]');
-        for (var i = 0; i < merchantCountryTags.length; i++) {
+        let merchantCountryTags = etreeStrings.findall('./string[@name="merchant_country_code"]');
+        for (let i = 0; i < merchantCountryTags.length; i++) {
             merchantCountryTags[i].text = merchant_country_code;
         }
 
-        var allowedNetworksTags = etreeStrings.findall('./string[@name="payment_allowed_networks"]');
-        for (var i = 0; i < allowedNetworksTags.length; i++) {
+        let allowedNetworksTags = etreeStrings.findall('./string[@name="payment_allowed_networks"]');
+        for (let i = 0; i < allowedNetworksTags.length; i++) {
             allowedNetworksTags[i].text = payment_allowed_networks;
         }
 
-        var supportedCapabilitiesTags = etreeStrings.findall('./string[@name="payment_supported_capabilities"]');
-        for (var i = 0; i < supportedCapabilitiesTags.length; i++) {
+        let supportedCapabilitiesTags = etreeStrings.findall('./string[@name="payment_supported_capabilities"]');
+        for (let i = 0; i < supportedCapabilitiesTags.length; i++) {
             supportedCapabilitiesTags[i].text = payment_supported_capabilities;
         }
 
-        var supportedCardCountriesTags = etreeStrings.findall('./string[@name="payment_supported_card_countries"]');
-        for (var i = 0; i < supportedCardCountriesTags.length; i++) {
+        let supportedCardCountriesTags = etreeStrings.findall('./string[@name="payment_supported_card_countries"]');
+        for (let i = 0; i < supportedCardCountriesTags.length; i++) {
             supportedCardCountriesTags[i].text = payment_supported_card_countries;
         }
 
-        var shippingContactsTags = etreeStrings.findall('./string[@name="shipping_supported_contacts"]');
-        for (var i = 0; i < shippingContactsTags.length; i++) {
+        let shippingContactsTags = etreeStrings.findall('./string[@name="shipping_supported_contacts"]');
+        for (let i = 0; i < shippingContactsTags.length; i++) {
             shippingContactsTags[i].text = shipping_supported_contacts;
         }
 
-        var shippingCountriesTags = etreeStrings.findall('./string[@name="shipping_country_codes"]');
-        for (var i = 0; i < shippingCountriesTags.length; i++) {
+        let shippingCountriesTags = etreeStrings.findall('./string[@name="shipping_country_codes"]');
+        for (let i = 0; i < shippingCountriesTags.length; i++) {
             shippingCountriesTags[i].text = shipping_country_codes;
         }
 
-        var billingContactsTags = etreeStrings.findall('./string[@name="billing_supported_contacts"]');
-        for (var i = 0; i < billingContactsTags.length; i++) {
+        let billingContactsTags = etreeStrings.findall('./string[@name="billing_supported_contacts"]');
+        for (let i = 0; i < billingContactsTags.length; i++) {
             billingContactsTags[i].text = billing_supported_contacts;
         }
 
-        var gatewayTags = etreeStrings.findall('./string[@name="gateway"]');
-        for (var i = 0; i < gatewayTags.length; i++) {
+        let gatewayTags = etreeStrings.findall('./string[@name="gateway"]');
+        for (let i = 0; i < gatewayTags.length; i++) {
             gatewayTags[i].text = gateway;
         }
 
-        var backendUrlTags = etreeStrings.findall('./string[@name="backend_url"]');
-        for (var i = 0; i < backendUrlTags.length; i++) {
+        let backendUrlTags = etreeStrings.findall('./string[@name="backend_url"]');
+        for (let i = 0; i < backendUrlTags.length; i++) {
             backendUrlTags[i].text = backend_url;
         }
 
-        var gatewayMerchantIdTags = etreeStrings.findall('./string[@name="gateway_merchant_id"]');
-        for (var i = 0; i < gatewayMerchantIdTags.length; i++) {
+        let gatewayMerchantIdTags = etreeStrings.findall('./string[@name="gateway_merchant_id"]');
+        for (let i = 0; i < gatewayMerchantIdTags.length; i++) {
             gatewayMerchantIdTags[i].text = gateway_merchant_id;
         }
 
-        var stripeVersionTags = etreeStrings.findall('./string[@name="stripe_version"]');
-        for (var i = 0; i < stripeVersionTags.length; i++) {
+        let stripeVersionTags = etreeStrings.findall('./string[@name="stripe_version"]');
+        for (let i = 0; i < stripeVersionTags.length; i++) {
             stripeVersionTags[i].text = stripe_version;
         }
 
-        var stripePubKeyTags = etreeStrings.findall('./string[@name="stripe_pub_key"]');
-        for (var i = 0; i < stripePubKeyTags.length; i++) {
+        let stripePubKeyTags = etreeStrings.findall('./string[@name="stripe_pub_key"]');
+        for (let i = 0; i < stripePubKeyTags.length; i++) {
             stripePubKeyTags[i].text = stripe_pub_key;
         }
 
-        var resultXmlStrings = etreeStrings.write();
+        let resultXmlStrings = etreeStrings.write();
         fs.writeFileSync(stringsXmlPath, resultXmlStrings);
     }
 

hooks/ios/iOSCopyPreferences.js

@@ -2,46 +2,49 @@ const et = require('elementtree');
 const path = require('path');
 const fs = require('fs');
 const plist = require('plist');
-const child_process = require('child_process');
 const { ConfigParser } = require('cordova-common');
-const { Console } = require('console');
 
 module.exports = function (context) {
 
     const ServiceEnum = Object.freeze({"ApplePay":"1", "GooglePay":"2"})
-    var projectRoot = context.opts.cordova.project ? context.opts.cordova.project.root : context.opts.projectRoot;
-
-    var merchant_id = "";
-    var merchant_name = "";
-    var merchant_country_code = "";
-    var payment_allowed_networks = [];
-    var payment_supported_capabilities = [];
-    var payment_supported_card_countries = [];
-    var shipping_supported_contacts = [];
-    var billing_supported_contacts = [];
-    var payment_gateway = "";
-    var payment_request_url = "";
-    var stripe_publishable_key = "";
-
-    var appNamePath = path.join(projectRoot, 'config.xml');
-    var appNameParser = new ConfigParser(appNamePath);
-    var appName = appNameParser.name();
+    let projectRoot = context.opts.cordova.project ? context.opts.cordova.project.root : context.opts.projectRoot;
+
+    let merchant_id = "";
+    let merchant_name = "";
+    let merchant_country_code = "";
+    let payment_allowed_networks = [];
+    let payment_supported_capabilities = [];
+    let payment_supported_card_countries = [];
+    let shipping_supported_contacts = [];
+    let billing_supported_contacts = [];
+    let payment_gateway = "";
+    let payment_request_url = "";
+    let stripe_publishable_key = "";
+
+    let appNamePath = path.join(projectRoot, 'config.xml');
+    let appNameParser = new ConfigParser(appNamePath);
+    let appName = appNameParser.name();
 
     let platformPath = path.join(projectRoot, 'platforms/ios');
+    let resourcesPath = path.join(projectRoot, `platforms/ios/${appName}/Resources/www`);   
+    if(!fs.existsSync(resourcesPath)){
+        resourcesPath = platformPath + "/www";
+    }
 
     //read json config file
-    var jsonConfig = "";
+    let jsonConfig = "";
+    let jsonParsed;
     try {
-        jsonConfig = path.join(platformPath, 'www/json-config/PaymentsPluginConfiguration.json');
-        var jsonConfigFile = fs.readFileSync(jsonConfig, 'utf8');
-        var jsonParsed = JSON.parse(jsonConfigFile);
+        jsonConfig = path.join(resourcesPath, 'json-config/PaymentsPluginConfiguration.json');
+        let jsonConfigFile = fs.readFileSync(jsonConfig, 'utf8');
+        jsonParsed = JSON.parse(jsonConfigFile);
     } catch {
-        throw new Error("Missing configuration file or error trying to obtain the configuration.");
+        throw new Error("OUTSYSTEMS_PLUGIN_ERROR: Missing configuration file or error trying to obtain the configuration.");
     }
 
-    jsonParsed.app_configurations.forEach(function(configItem) {
+    jsonParsed.app_configurations.forEach((configItem) => {
         if (configItem.service_id == ServiceEnum.ApplePay) {
-            var error_list = [];
+            let error_list = [];
 
             if (configItem.merchant_id != null && configItem.merchant_id !== "") {
                 merchant_id = configItem.merchant_id;
@@ -98,18 +101,17 @@ module.exports = function (context) {
             }                   
 
             if (error_list.length > 0) {
-                throw new Error("Configuration is missing the following fields: " + error_list);
+                console.error("Missing fields: " + error_list);
+                throw new Error("OUTSYSTEMS_PLUGIN_ERROR: Payments configuration is missing some fields. Please check build logs to know more.");
             }
-
-            return;
         }
     });
 
 
     //Change info.plist
-    var infoPlistPath = path.join(platformPath, appName + '/'+ appName +'-info.plist');
-    var infoPlistFile = fs.readFileSync(infoPlistPath, 'utf8');
-    var infoPlist = plist.parse(infoPlistFile);
+    let infoPlistPath = path.join(platformPath, appName + '/'+ appName +'-info.plist');
+    let infoPlistFile = fs.readFileSync(infoPlistPath, 'utf8');
+    let infoPlist = plist.parse(infoPlistFile);
 
     infoPlist['ApplePayMerchantID'] = merchant_id;
     infoPlist['ApplePayMerchantName'] = merchant_name;
@@ -136,17 +138,17 @@ module.exports = function (context) {
     fs.writeFileSync(infoPlistPath, plist.build(infoPlist, { indent: '\t' }));
 
     // Change Entitlements files
-    var debugEntitlementsPath = path.join(platformPath, appName + '/'+ 'Entitlements-Debug.plist');
-    var debugEntitlementsFile = fs.readFileSync(debugEntitlementsPath, 'utf8');
-    var debugEntitlements = plist.parse(debugEntitlementsFile);
+    let debugEntitlementsPath = path.join(platformPath, appName + '/'+ 'Entitlements-Debug.plist');
+    let debugEntitlementsFile = fs.readFileSync(debugEntitlementsPath, 'utf8');
+    let debugEntitlements = plist.parse(debugEntitlementsFile);
 
     debugEntitlements['com.apple.developer.in-app-payments'] = [merchant_id];
 
     fs.writeFileSync(debugEntitlementsPath, plist.build(debugEntitlements, { indent: '\t' }));
 
-    var releaseEntitlementsPath = path.join(platformPath, appName + '/' + 'Entitlements-Release.plist');
-    var releaseEntitlementsFile = fs.readFileSync(releaseEntitlementsPath, 'utf8');
-    var releaseEntitlements = plist.parse(releaseEntitlementsFile);
+    let releaseEntitlementsPath = path.join(platformPath, appName + '/' + 'Entitlements-Release.plist');
+    let releaseEntitlementsFile = fs.readFileSync(releaseEntitlementsPath, 'utf8');
+    let releaseEntitlements = plist.parse(releaseEntitlementsFile);
 
     releaseEntitlements['com.apple.developer.in-app-payments'] = [merchant_id];
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.outsystems.payments",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "OutSystems-owned plugin for mobile payments",
   "keywords": [
     "ecosystem:cordova",

plugin.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<plugin id="com.outsystems.payments" version="1.1.0" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
+<plugin id="com.outsystems.payments" version="1.1.2" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
   <name>OSPayments</name>
   <description>OutSystems-owned plugin for mobile payments</description>
   <author>OutSystems Inc</author>

src/android/com/outsystems/payments/OSPayments.kt

@@ -107,15 +107,17 @@ class OSPayments : CordovaImplementation() {
         }
     }
 
-    override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent) {
+    override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent?) {
         super.onActivityResult(requestCode, resultCode, intent)
-        paymentsController.handleActivityResult(requestCode, resultCode, intent,
-            { paymentResponse ->
-                sendPluginResult(paymentResponse, null)
-            },
-            { error ->
-                sendPluginResult(null, Pair(formatErrorCode(error.code), error.description))
-            })
+        if (intent != null) {
+            paymentsController.handleActivityResult(requestCode, resultCode, intent,
+                { paymentResponse ->
+                    sendPluginResult(paymentResponse, null)
+                },
+                { error ->
+                    sendPluginResult(null, Pair(formatErrorCode(error.code), error.description))
+                })
+        }
     }
 
     override fun onRequestPermissionResult(requestCode: Int,

src/android/com/outsystems/payments/build.gradle

@@ -27,8 +27,8 @@ repositories{
 apply plugin: 'kotlin-kapt'
 
 dependencies {
-    implementation("com.github.outsystems:oscore-android:1.1.0@aar")
-    implementation("com.github.outsystems:oscordova-android:1.1.0@aar")
+    implementation("com.github.outsystems:oscore-android:1.2.0@aar")
+    implementation("com.github.outsystems:oscordova-android:2.0.0@aar")
     implementation("com.github.outsystems:ospayments-android:1.1.0@aar")
 
     implementation 'com.stripe:stripe-android:20.5.0'