Merge pull request #39 from OutSystems/feat/RMET-4190/capacitor-support

RMET-4190 :: Capacitor support + Prepare release of 2.2.0

Author: OS-pedrogustavobilro

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] - 2025-06-20
+- Feat: Support for Capacitor apps with OutSystems.
+- Chore: Update dependency to KeyStore plugin to use version `2.6.8-OS22`.
+
 ## [2.1.7] - 2025-02-07
 - Chore: Update dependency to KeyStore plugin to use version `2.6.8-OS21`.
 

build-actions/README.md

@@ -0,0 +1,36 @@
+
+# Build Actions
+
+This folder contains a .yaml file for configuring build actions to use in a plugin on ODC with Capacitor. The purpose of these build actions is to provide the same functionality as cordova hooks, but in a Capacitor shell for OutSystems apps.
+
+## Contents
+
+The file [disable_auto_backups.yaml](./disable_auto_backups.yaml) contains 1 build action:
+
+1. Android specific. Disable auto-backup for the Android application, by changing the `AndroidManifest.xml` file.
+
+
+Furthermore, there are changes that can't be accomplished with build actions, and we used [Capacitor hooks](https://capacitorjs.com/docs/cli/hooks) for this. We have one JavaScript file for hooks:
+
+- [update_strings_for_keystore.js](./update_strings_for_keystore.js) - Update the application's `strings.xml` file that are used for the [KeyStore Plugin](https://github.com/OutSystems/cordova-plugin-secure-storage), which is a dependency of this Cordova plugin. 
+
+Reasoning for this hook: The KeyStore plugin has its own build actions to update these strings, which only triggers from OutSystems apps. The dependency exists only at the Cordova-level, not OutSystems level, and the actual strings aren't meant to be configured here, since they won't actually be used in the plugin, it's just required for the KeyStore plugin initialization. Therefore, this hook only adds the strings to `strings.xml` if they don't already exist yet, to avoid modifying custom strings from the KeyStore Plugin (which can happen if users have an OutSystems app with both Ciphered and KeyStore plugins). [The Key Store's build actions](https://github.com/OutSystems/cordova-plugin-secure-storage/blob/outsystems/build-actions/setStringsAndroid.yaml) will run after this hook as well, and they will modify existing strings.
+
+
+## Outsystems' Usage
+
+1. Copy the build action yaml file (which can contain multiple build actions inside) into the ODC Plugin, placing them in "Data" -> "Resources" and set "Deploy Action" to "Deploy to Target Directory", with target directory empty.
+2. Update the Plugin's Extensibility configuration to use the build action.
+
+```json
+{
+    "buildConfigurations": {
+        "buildAction": {
+            "config": $resources.buildActionFileName.yaml,
+            "parameters": {
+                // parameters go here; if there are no parameters then the block can be ommited
+            }
+        }
+    }
+}
+```

build-actions/disable_auto_backups.yaml

@@ -0,0 +1,7 @@
+platforms:
+  android:
+    manifest:
+      - file: AndroidManifest.xml
+        target: manifest/application
+        attrs:
+          android:allowBackup: "false"

build-actions/update_strings_for_keystore.js

@@ -0,0 +1,66 @@
+const path = require('path');
+const fs = require('fs');
+const { DOMParser, XMLSerializer } = require('xmldom');
+
+const parser = new DOMParser();
+const platform = process.env.CAPACITOR_PLATFORM_NAME;
+const projectRoot = process.env.CAPACITOR_ROOT_DIR;
+
+if (platform != 'android') {
+    // hook only needs to run for Android
+    return
+}
+
+console.log("\nCiphered Local Storage Plugin - running hook before update - for " + platform);
+
+const stringsXmlPath = path.join(projectRoot, 'android/app/src/main/res/values/strings.xml');
+if (!fs.existsSync(stringsXmlPath)) {
+   console.error("\t[ERROR] - strings.xml file does not exist, and is required by this hook - " + stringsXmlPath);
+   process.exit(1);
+}
+
+// read and parse files
+const stringsXmlDoc = parser.parseFromString(fs.readFileSync(stringsXmlPath, 'utf-8'), 'text/xml');
+let writtenValuesCount = 0;
+
+// Add  entries only if they are not present
+const valuesToAdd = [
+    { stringsXmlName: 'migration_auth', value: 'false', type: 'bool' },
+    { stringsXmlName: 'biometric_prompt_title', value: 'Authentication required', type: 'string' },
+    { stringsXmlName: 'biometric_prompt_subtitle', value: 'Please authenticate to continue', type: 'string'  },
+    { stringsXmlName: 'biometric_prompt_negative_button', value: 'Cancel', type: 'string'  }
+];
+for (const { stringsXmlName, value, type } of valuesToAdd) {
+    if (!elementExistsInStringsXml(type, stringsXmlName)) {
+        const stringElement = stringsXmlDoc.createElement(type);
+        stringElement.setAttribute('name', stringsXmlName);
+        stringElement.textContent = value;
+        stringsXmlDoc.documentElement.appendChild(stringElement);
+        writtenValuesCount = writtenValuesCount + 1;
+    }
+}
+
+if (writtenValuesCount > 0) {
+    // Serialize and write the updated XML file
+    const serializer = new XMLSerializer();
+    let updatedXmlString = serializer.serializeToString(stringsXmlDoc);
+    // XMLSerializer doesn't properly indent the content, so it is manually done here
+    updatedXmlString = updatedXmlString
+        .replace(/>(\s*)</g, '>\n<') // put each tag on its own line
+        .replace(/<([^?\/][^>]*)>/g, '    <$1>') // indent all opening tags except <?xml ...?>
+        .replace(/ {4}(<\/?resources>)/g, '$1') // remove indentation from initial <resources> tag
+    fs.writeFileSync(stringsXmlPath, updatedXmlString, 'utf-8');
+    console.log("\t[SUCESSS] Added " + writtenValuesCount + " out of expected " + valuesToAdd.length + " values into strings.xml");
+} else {
+    console.log("\t[SKIPPED] Values already exist in strings.xml");
+}
+
+function elementExistsInStringsXml(tagName, nameValue) {
+    const elements = stringsXmlDoc.getElementsByTagName(tagName);
+    for (let i = 0; i < elements.length; i++) {
+        if (elements[i].getAttribute('name') === nameValue) {
+            return true;
+        }
+    }
+    return false;
+}

package.json

@@ -28,6 +28,9 @@
       "version": ">=3.3.0"
     }
   ],
+  "scripts": {
+    "capacitor:update:before": "node build-actions/update_strings_for_keystore.js"
+  },
   "author": "OutSystems",
   "license": "MIT",
   "bugs": {

plugin.xml

@@ -15,7 +15,7 @@
     </js-module>
 
     <dependency id="cordova-sqlcipher-adapter" url="https://github.com/OutSystems/cordova-sqlcipher-adapter.git#0.1.7-OS9" />
-    <dependency id="cordova-plugin-secure-storage" url="https://github.com/OutSystems/cordova-plugin-secure-storage.git#2.6.8-OS21" />
+    <dependency id="cordova-plugin-secure-storage" url="https://github.com/OutSystems/cordova-plugin-secure-storage.git#2.6.8-OS22" />
 
     <dependency id="outsystems-plugin-disable-backup" url="https://github.com/OutSystems/outsystems-plugin-disable-backup.git#1.0.2" />