@capacitor-firebase/functions 8.3.0 → 8.4.0

package/CapacitorFirebaseFunctions.podspec

@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
-  s.dependency 'FirebaseFunctions', '~> 12.7.0'
+  s.dependency 'FirebaseFunctions', '~> 12.7'
   s.swift_version = '5.1'
   s.static_framework = true
 end

package/README.md

@@ -1,4 +1,4 @@
-# @capacitor-firebase/functions
+# Capacitor Firebase Cloud Functions Plugin
 
 Unofficial Capacitor plugin for [Firebase Cloud Functions](https://firebase.google.com/docs/functions/).[^1]
 
@@ -8,9 +8,14 @@ Unofficial Capacitor plugin for [Firebase Cloud Functions](https://firebase.goog
   </a>
 </div>
 
-## Newsletter
+## Use Cases
 
-Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+The Firebase Cloud Functions plugin is typically used to run backend logic from your Capacitor app without managing your own server, for example:
+
+- **Serverless backend logic**: Call callable Cloud Functions by name to run trusted server-side code from your app.
+- **Structured data exchange**: Pass strings, numbers, booleans, arrays, and objects to a function and process the returned result.
+- **Custom domains and regions**: Call functions that are deployed in a specific region or hosted on a custom domain by their URL.
+- **Local development**: Test your functions against the Cloud Functions emulator before deploying them to production.
 
 ## Compatibility
 
@@ -87,6 +92,12 @@ A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](
 
 ## Usage
 
+The following examples show how to call Cloud Functions by name or by URL and how to connect to the Cloud Functions emulator.
+
+### Call a function by name
+
+Call a callable Cloud Function by its name. You can pass strings, numbers, booleans, arrays, and objects as data and receive the result of the function in the `data` property. Use the `region` option if your function is not deployed in the default region:
+
 ```typescript
 import { FirebaseFunctions } from '@capacitor-firebase/functions';
 
@@ -105,6 +116,14 @@ const callByName = async () => {
     });
     return data;
 };
+```
+
+### Call a function by URL
+
+If your callable function is hosted on a custom domain or you prefer to address it directly, call it by its URL:
+
+```typescript
+import { FirebaseFunctions } from '@capacitor-firebase/functions';
 
 const callByUrl = async () => {
     const { data } = await FirebaseFunctions.callByUrl({
@@ -121,6 +140,14 @@ const callByUrl = async () => {
     });
     return data;
 };
+```
+
+### Use the Cloud Functions emulator
+
+During development, you can instrument your app to talk to the local Cloud Functions emulator. When using an Android emulator device, `10.0.2.2` is the special IP address to connect to the `localhost` of the host computer. Note that on Android, the cleartext traffic must be allowed, which is not intended for use in production:
+
+```typescript
+import { FirebaseFunctions } from '@capacitor-firebase/functions';
 
 const useEmulator = async () => {
   await FirebaseFunctions.useEmulator({
@@ -258,6 +285,38 @@ On Android, the cleartext traffic must be allowed. On the Capacitor configuratio
 
 </docgen-api>
 
+## FAQ
+
+### What is the difference between `callByName` and `callByUrl`?
+
+The `callByName(...)` method calls a callable function by its name and, optionally, its region. The `callByUrl(...)` method calls a callable function by its full URL instead, which is useful if the function is hosted on a custom domain.
+
+### What data types can I pass to a callable function?
+
+You can pass strings, numbers, booleans, arrays, and nested objects as data to a callable function. The result of the function is returned in the `data` property of the call result.
+
+### How do I test my functions locally?
+
+Use the `useEmulator(...)` method to instrument your app to talk to the local Cloud Functions emulator, as shown in the [usage example](#use-the-cloud-functions-emulator) above. When testing on an Android emulator device, use `10.0.2.2` as the host to reach the `localhost` of the host computer. Keep in mind that on Android, the cleartext traffic must be allowed for this, which is not intended for use in production.
+
+### Why do I get a SwiftPM package identity collision on iOS?
+
+This is a known issue when using the plugin with Swift Package Manager. Add the `symlink` package option for `@capacitor-firebase/functions` to your Capacitor configuration as described in the [Installation](#installation) section. Note that SPM `packageOptions` support requires Capacitor CLI 8.4.0 or later.
+
+### Can I use this plugin with Ionic, React, Vue or Angular?
+
+Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.
+
+## Related Plugins
+
+- [Firebase Authentication](https://capawesome.io/docs/sdks/capacitor/firebase/authentication/): Sign in users with Firebase Authentication.
+- [Firebase Cloud Firestore](https://capawesome.io/docs/sdks/capacitor/firebase/cloud-firestore/): Store and sync app data in Cloud Firestore.
+- [Firebase Cloud Storage](https://capawesome.io/docs/sdks/capacitor/firebase/cloud-storage/): Upload and download files with Firebase Cloud Storage.
+
+## Newsletter
+
+Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+
 ## Changelog
 
 See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/CHANGELOG.md).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capacitor-firebase/functions",
-  "version": "8.3.0",
-  "description": "Capacitor plugin for Firebase Cloud Functions.",
+  "version": "8.4.0",
+  "description": "Capacitor plugin for Firebase Cloud Functions on Android, iOS, and Web.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -37,7 +37,14 @@
   "keywords": [
     "capacitor",
     "plugin",
-    "native"
+    "native",
+    "capacitor-plugin",
+    "firebase",
+    "firebase functions",
+    "firebase cloud functions",
+    "cloud functions",
+    "callable functions",
+    "serverless"
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
@@ -59,16 +66,16 @@
   },
   "devDependencies": {
     "@capacitor/android": "8.0.0",
-    "@capacitor/cli": "8.0.0",
+    "@capacitor/cli": "8.4.2",
     "@capacitor/core": "8.0.0",
     "@capacitor/docgen": "0.3.1",
     "@capacitor/ios": "8.0.0",
     "@ionic/eslint-config": "0.4.0",
     "eslint": "8.57.0",
     "firebase": "11.2.0",
-    "prettier-plugin-java": "2.6.7",
+    "prettier-plugin-java": "2.9.7",
     "rimraf": "6.1.2",
-    "rollup": "4.53.3",
+    "rollup": "4.62.3",
     "swiftlint": "2.0.0",
     "typescript": "5.9.3"
   },