cordova-plugin-firebasex-firestore 1.0.0

package/plugin.xml

@@ -0,0 +1,72 @@
+<?xml version='1.0' encoding='utf-8'?>
+<plugin id="cordova-plugin-firebasex-firestore"
+        version="1.0.0"
+        xmlns="http://apache.org/cordova/ns/plugins/1.0"
+        xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <name>Cordova FirebaseX Firestore</name>
+    <description>Firestore module for cordova-plugin-firebasex</description>
+    <license>MIT</license>
+    <keywords>cordova,firebase,firestore</keywords>
+
+    <engines>
+        <engine name="cordova" version=">=12.0.0" />
+        <engine name="cordova-android" version=">=14.0.0" />
+        <engine name="cordova-ios" version=">=7.0.0" />
+    </engines>
+
+    <dependency id="cordova-plugin-firebasex-core" />
+
+    <preference name="IOS_USE_PRECOMPILED_FIRESTORE_POD" default="false" />
+
+    <hook type="after_prepare" src="scripts/post_install.js" />
+
+    <js-module src="www/firebasex-firestore.js" name="FirebasexFirestorePlugin">
+        <merges target="FirebasexFirestore" />
+    </js-module>
+
+    <!-- Android -->
+    <platform name="android">
+        <config-file target="res/xml/config.xml" parent="/*">
+            <feature name="FirebasexFirestorePlugin">
+                <param name="android-package" value="org.apache.cordova.firebasex.FirebasexFirestorePlugin" />
+                <param name="onload" value="true" />
+            </feature>
+        </config-file>
+
+        <preference name="ANDROID_FIREBASE_FIRESTORE_VERSION" default="26.1.0" />
+        <preference name="ANDROID_GRPC_OKHTTP" default="1.75.0" />
+        <preference name="ANDROID_GSON_VERSION" default="2.13.2" />
+
+        <source-file src="src/android/FirebasexFirestorePlugin.java" target-dir="src/org/apache/cordova/firebasex" />
+        <framework src="com.google.firebase:firebase-firestore:$ANDROID_FIREBASE_FIRESTORE_VERSION" />
+        <framework src="io.grpc:grpc-okhttp:$ANDROID_GRPC_OKHTTP" />
+        <framework src="com.google.code.gson:gson:$ANDROID_GSON_VERSION" />
+    </platform>
+
+    <!-- iOS -->
+    <platform name="ios">
+        <config-file target="config.xml" parent="/*">
+            <feature name="FirebasexFirestorePlugin">
+                <param name="ios-package" value="FirebasexFirestorePlugin" />
+                <param name="onload" value="true" />
+            </feature>
+        </config-file>
+
+        <header-file src="src/ios/FirebasexFirestorePlugin.h" />
+        <source-file src="src/ios/FirebasexFirestorePlugin.m" />
+
+        <preference name="IOS_FIREBASE_SDK_VERSION" default="12.9.0" />
+
+        <podspec>
+            <config>
+                <source url="https://cdn.cocoapods.org/"/>
+            </config>
+            <pods use-frameworks="true">
+                <pod name="FirebaseFirestore" tag="12.9.0" git="https://github.com/invertase/firestore-ios-sdk-frameworks.git" />
+            </pods>
+        </podspec>
+
+        <hook type="after_plugin_install" src="scripts/ios/after_plugin_install.js" />
+    </platform>
+</plugin>

package/scripts/ios/after_plugin_install.js

@@ -0,0 +1,137 @@
+/**
+ * @file after_plugin_install.js
+ * @brief Hook script that runs after the firestore plugin is installed on iOS.
+ *
+ * Updates the FirebaseFirestore pod version tag in the Podfile based on the
+ * IOS_FIREBASE_SDK_VERSION plugin variable. FirebaseFirestore uses a git-based
+ * pod declaration with a `:tag` instead of a spec version:
+ *
+ *   pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => 'X.Y.Z'
+ *
+ * Plugin variables are resolved using a 4-layer override strategy:
+ * 1. Defaults from plugin.xml preferences (via hook context).
+ * 2. Overrides from `config.xml` `<plugin><variable>` elements (wrapper and own plugin ID).
+ * 3. Overrides from `package.json` `cordova.plugins` entries (wrapper and own plugin ID).
+ * 4. CLI variables passed at install time (highest priority).
+ */
+var fs = require("fs");
+var path = require("path");
+
+/** @constant {string} The plugin identifier. */
+var PLUGIN_ID = "cordova-plugin-firebasex-firestore";
+/** @constant {string} The wrapper meta-plugin identifier used as a fallback source for plugin variables. */
+var WRAPPER_PLUGIN_ID = "cordova-plugin-firebasex";
+
+/**
+ * Resolves plugin variables using the 4-layer override strategy.
+ *
+ * @param {object} context - The Cordova hook context.
+ * @returns {Object} Resolved plugin variable key/value pairs.
+ */
+function resolvePluginVariables(context) {
+    var pluginVariables = {};
+
+    // 1. Defaults from plugin.xml preferences
+    var plugin = context.opts.plugin;
+    if (plugin && plugin.pluginInfo && plugin.pluginInfo._et && plugin.pluginInfo._et._root && plugin.pluginInfo._et._root._children) {
+        plugin.pluginInfo._et._root._children.forEach(function(child) {
+            if (child.tag === "preference") {
+                pluginVariables[child.attrib.name] = child.attrib.default;
+            }
+        });
+    }
+
+    // 2. Overrides from config.xml
+    try {
+        var configXmlPath = path.join(context.opts.projectRoot, "config.xml");
+        if (fs.existsSync(configXmlPath)) {
+            var configXml = fs.readFileSync(configXmlPath, "utf-8");
+            [WRAPPER_PLUGIN_ID, PLUGIN_ID].forEach(function(pluginId) {
+                var pluginRegex = new RegExp('<plugin[^>]+name="' + pluginId + '"[^>]*>(.*?)</plugin>', "s");
+                var pluginMatch = configXml.match(pluginRegex);
+                if (pluginMatch) {
+                    var varRegex = /<variable\s+name="([^"]+)"\s+value="([^"]+)"\s*\/>/g;
+                    var varMatch;
+                    while ((varMatch = varRegex.exec(pluginMatch[1])) !== null) {
+                        pluginVariables[varMatch[1]] = varMatch[2];
+                    }
+                }
+            });
+        }
+    } catch (e) {
+        console.warn("[FirebasexFirestore] Could not read config.xml for plugin variables: " + e.message);
+    }
+
+    // 3. Overrides from package.json
+    try {
+        var packageJsonPath = path.join(context.opts.projectRoot, "package.json");
+        if (fs.existsSync(packageJsonPath)) {
+            var packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+            if (packageJson.cordova && packageJson.cordova.plugins) {
+                [WRAPPER_PLUGIN_ID, PLUGIN_ID].forEach(function(pluginId) {
+                    if (packageJson.cordova.plugins[pluginId]) {
+                        var pluginVars = packageJson.cordova.plugins[pluginId];
+                        for (var key in pluginVars) {
+                            pluginVariables[key] = pluginVars[key];
+                        }
+                    }
+                });
+            }
+        }
+    } catch (e) {
+        console.warn("[FirebasexFirestore] Could not read package.json for plugin variables: " + e.message);
+    }
+
+    // 4. CLI variable overrides (highest priority)
+    if (context.opts && context.opts.cli_variables) {
+        Object.keys(context.opts.cli_variables).forEach(function(key) {
+            pluginVariables[key] = context.opts.cli_variables[key];
+        });
+    }
+
+    return pluginVariables;
+}
+
+/**
+ * Cordova hook entry point.
+ * Updates the FirebaseFirestore git pod tag in the Podfile.
+ *
+ * @param {object} context - The Cordova hook context.
+ */
+module.exports = function(context) {
+    var pluginVariables = resolvePluginVariables(context);
+    if (!pluginVariables["IOS_FIREBASE_SDK_VERSION"]) return;
+
+    var iosPlatformPath = path.join(context.opts.projectRoot, "platforms", "ios");
+    var podFilePath = path.join(iosPlatformPath, "Podfile");
+    if (!fs.existsSync(podFilePath)) return;
+
+    try {
+        var podFileContents = fs.readFileSync(podFilePath, "utf-8");
+        var sdkVersion = pluginVariables["IOS_FIREBASE_SDK_VERSION"];
+        // FirebaseFirestore uses a git-based pod with :tag instead of a spec version
+        var firestorePodRegEx = /pod 'FirebaseFirestore'[^,]+,:tag\s*=>\s*'(\d+\.\d+\.\d+[^']*)'/g;
+        var tagVersionRegex = /:tag\s*=>\s*'(\d+\.\d+\.\d+[^']*)'/;
+        var matches = podFileContents.match(firestorePodRegEx);
+        if (matches) {
+            var modified = false;
+            matches.forEach(function(match) {
+                var tagMatch = match.match(tagVersionRegex);
+                if (tagMatch) {
+                    var currentVersion = tagMatch[1];
+                    if (currentVersion !== sdkVersion) {
+                        var updatedMatch = match.replace(":tag => '" + currentVersion + "'", ":tag => '" + sdkVersion + "'");
+                        podFileContents = podFileContents.replace(match, updatedMatch);
+                        modified = true;
+                    }
+                }
+            });
+            if (modified) {
+                fs.writeFileSync(podFilePath, podFileContents);
+                console.log("[FirebasexFirestore] Firebase Firestore version set to v" + sdkVersion + " in Podfile");
+            }
+        }
+    } catch(e) {
+        console.warn("[FirebasexFirestore] Error updating Firebase Firestore pod version: " + e.message);
+    }
+};

package/scripts/post_install.js

@@ -0,0 +1,157 @@
+/**
+ * @file post_install.js
+ * @brief Cordova "after_prepare" hook for the cordova-plugin-firebasex-firestore plugin.
+ *
+ * Modifies the plugin's `plugin.xml` to switch between the standard and precompiled
+ * FirebaseFirestore iOS pods based on the `IOS_USE_PRECOMPILED_FIRESTORE_POD` plugin variable.
+ *
+ * When enabled, the standard `FirebaseFirestore` pod (installed from CocoaPods) is replaced
+ * with the precompiled version from the `invertase/firestore-ios-sdk-frameworks` GitHub
+ * repository, which significantly reduces iOS build times.
+ *
+ * When disabled (or not set), restores the standard CocoaPods-based pod if the precompiled
+ * version was previously applied.
+ *
+ * Plugin variables are resolved using a 3-layer override strategy:
+ * 1. Defaults from `plugin.xml` `<preference>` elements.
+ * 2. Overrides from `config.xml` `<plugin><variable>` elements.
+ * 3. Overrides from `package.json` `cordova.plugins` entries (highest priority).
+ *
+ * For layers 2 and 3, variables are checked under both the wrapper meta-plugin ID
+ * (`cordova-plugin-firebasex`) and this plugin's own ID, allowing users who install
+ * via the wrapper to specify variables under the original monolithic plugin name.
+ *
+ * @module scripts/post_install
+ */
+var fs = require("fs");
+var path = require("path");
+
+/** @constant {string} The plugin identifier. */
+var PLUGIN_ID = "cordova-plugin-firebasex-firestore";
+/** @constant {string} The wrapper meta-plugin identifier used as a fallback source for plugin variables. */
+var WRAPPER_PLUGIN_ID = "cordova-plugin-firebasex";
+
+/**
+ * Resolves plugin variables using a 3-layer override strategy:
+ * 1. Default values from `plugin.xml` `<preference>` elements.
+ * 2. Overrides from `config.xml` `<plugin><variable>` elements.
+ * 3. Overrides from `package.json` `cordova.plugins` entries (highest priority).
+ *
+ * @returns {Object} Resolved plugin variable key/value pairs.
+ */
+function getPluginVariables() {
+    var variables = {};
+
+    // Try reading from plugin.xml
+    try {
+        var pluginXmlPath = path.join("plugins", PLUGIN_ID, "plugin.xml");
+        if (fs.existsSync(pluginXmlPath)) {
+            var pluginXml = fs.readFileSync(pluginXmlPath, "utf-8");
+            var prefRegex = /<preference\s+name="([^"]+)"\s+default="([^"]+)"\s*\/>/g;
+            var match;
+            while ((match = prefRegex.exec(pluginXml)) !== null) {
+                variables[match[1]] = match[2];
+            }
+        }
+    } catch (e) {
+        console.warn("Could not read plugin.xml: " + e.message);
+    }
+
+    // Override with values from config.xml (check both wrapper and own plugin ID)
+    try {
+        var configXmlPath = path.join("config.xml");
+        if (fs.existsSync(configXmlPath)) {
+            var configXml = fs.readFileSync(configXmlPath, "utf-8");
+            [WRAPPER_PLUGIN_ID, PLUGIN_ID].forEach(function(pluginId) {
+                var pluginRegex = new RegExp('<plugin[^>]+name="' + pluginId + '"[^>]*>(.*?)</plugin>', "s");
+                var pluginMatch = configXml.match(pluginRegex);
+                if (pluginMatch) {
+                    var varRegex = /<variable\s+name="([^"]+)"\s+value="([^"]+)"\s*\/>/g;
+                    var varMatch;
+                    while ((varMatch = varRegex.exec(pluginMatch[1])) !== null) {
+                        variables[varMatch[1]] = varMatch[2];
+                    }
+                }
+            });
+        }
+    } catch (e) {
+        console.warn("Could not read config.xml: " + e.message);
+    }
+
+    // Override with values from package.json (check wrapper first as base, then own plugin)
+    try {
+        var packageJsonPath = path.join("package.json");
+        if (fs.existsSync(packageJsonPath)) {
+            var packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+            if (packageJson.cordova && packageJson.cordova.plugins) {
+                [WRAPPER_PLUGIN_ID, PLUGIN_ID].forEach(function(pluginId) {
+                    if (packageJson.cordova.plugins[pluginId]) {
+                        var pluginVars = packageJson.cordova.plugins[pluginId];
+                        for (var key in pluginVars) {
+                            variables[key] = pluginVars[key];
+                        }
+                    }
+                });
+            }
+        }
+    } catch (e) {
+        console.warn("Could not read package.json: " + e.message);
+    }
+
+    return variables;
+}
+
+/**
+ * Cordova hook entry point.
+ *
+ * Reads plugin variables, then either replaces the standard FirebaseFirestore pod
+ * with the precompiled version (if `IOS_USE_PRECOMPILED_FIRESTORE_POD` is `true`)
+ * or restores the standard pod (if the precompiled version was previously applied).
+ *
+ * @param {object} context - The Cordova hook context.
+ */
+module.exports = function (context) {
+    var pluginVariables = getPluginVariables();
+    var pluginXmlPath = path.join("plugins", PLUGIN_ID, "plugin.xml");
+
+    if (!fs.existsSync(pluginXmlPath)) {
+        console.warn(PLUGIN_ID + " plugin.xml not found at " + pluginXmlPath);
+        return;
+    }
+
+    var pluginXmlText = fs.readFileSync(pluginXmlPath, "utf-8");
+    var pluginXmlModified = false;
+
+    // Handle IOS_USE_PRECOMPILED_FIRESTORE_POD
+    /** @constant {RegExp} Matches the standard CocoaPods-based FirebaseFirestore pod entry. */
+    var standardPodRegExp = /<pod\s+name="FirebaseFirestore"\s+spec="([^"]+)"\s*\/>/;
+    /** @constant {RegExp} Matches the precompiled FirebaseFirestore pod entry (from invertase git repo). */
+    var precompiledPodRegExp = /<pod\s+name="FirebaseFirestore"\s+tag="([^"]+)"\s+git="[^"]+"\s*\/>/;;
+
+    if (pluginVariables["IOS_USE_PRECOMPILED_FIRESTORE_POD"] === "true") {
+        var match = pluginXmlText.match(standardPodRegExp);
+        if (match) {
+            var replacement = '<pod name="FirebaseFirestore" tag="' + match[1] + '" git="https://github.com/invertase/firestore-ios-sdk-frameworks.git" />';
+            pluginXmlText = pluginXmlText.replace(standardPodRegExp, replacement);
+            pluginXmlModified = true;
+            console.log("Replaced FirebaseFirestore pod with precompiled version (tag " + match[1] + ") in " + PLUGIN_ID + "/plugin.xml");
+        } else if (pluginXmlText.match(precompiledPodRegExp)) {
+            console.log("FirebaseFirestore pod already using precompiled version in " + PLUGIN_ID + "/plugin.xml");
+        } else {
+            console.warn('Failed to find <pod name="FirebaseFirestore"> in ' + PLUGIN_ID + "/plugin.xml");
+        }
+    } else {
+        // Restore standard pod if precompiled was previously applied
+        var preMatch = pluginXmlText.match(precompiledPodRegExp);
+        if (preMatch) {
+            var restored = '<pod name="FirebaseFirestore" spec="' + preMatch[1] + '"/>';
+            pluginXmlText = pluginXmlText.replace(precompiledPodRegExp, restored);
+            pluginXmlModified = true;
+            console.log("Restored standard FirebaseFirestore pod (spec " + preMatch[1] + ") in " + PLUGIN_ID + "/plugin.xml");
+        }
+    }
+
+    if (pluginXmlModified) {
+        fs.writeFileSync(pluginXmlPath, pluginXmlText, "utf-8");
+    }
+};