@capacitor-firebase/functions 6.0.0-dev.59ed099.1719590033

package/CapacitorFirebaseFunctions.podspec

@@ -0,0 +1,19 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorFirebaseFunctions'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.dependency 'FirebaseFunctions', '~> 10.25'
+  s.swift_version = '5.1'
+  s.static_framework = true
+end

package/README.md

@@ -0,0 +1,167 @@
+# @capacitor-firebase/functions
+
+Unofficial Capacitor plugin for [Firebase Cloud Functions](https://firebase.google.com/docs/functions/).[^1]
+
+## Installation
+
+```bash
+npm install @capacitor-firebase/functions
+npx cap sync
+```
+
+Add Firebase to your project if you haven't already ([Android](https://firebase.google.com/docs/android/setup) / [iOS](https://firebase.google.com/docs/ios/setup)).
+
+### Android
+
+#### Variables
+
+This plugin will use the following project variables (defined in your app’s `variables.gradle` file):
+
+- `$firebaseFunctionsVersion` version of `com.google.firebase:firebase-functions` (default: `20.4.0`)
+
+## Configuration
+
+No configuration required for this plugin.
+
+## Demo
+
+A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)
+
+## Usage
+
+```typescript
+import { FirebaseFunctions } from '@capacitor-firebase/functions';
+
+const callByName = async () => {
+    const { data } = await FirebaseFunctions.callByName({
+        name: 'helloWorld',
+        data: {
+            string: 'Hello World!',
+            number: 123,
+            boolean: true,
+            array: [1, 2, 3],
+            object: {
+                key: 'value'
+            }
+        }
+    });
+    return data;
+};
+
+const callByUrl = async () => {
+    const { data } = await FirebaseFunctions.callByUrl({
+        url: 'https://us-central1-YOUR_PROJECT_ID.cloudfunctions.net/helloWorld',
+        data: {
+            string: 'Hello World!',
+            number: 123,
+            boolean: true,
+            array: [1, 2, 3],
+            object: {
+                key: 'value'
+            }
+        }
+    });
+    return data;
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`callByName(...)`](#callbyname)
+* [`callByUrl(...)`](#callbyurl)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### callByName(...)
+
+```typescript
+callByName(options: CallByNameOptions) => Promise<CallByNameResult>
+```
+
+Call a callable function by name.
+
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#callbynameoptions">CallByNameOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#callresult">CallResult</a>&gt;</code>
+
+**Since:** 6.1.0
+
+--------------------
+
+
+### callByUrl(...)
+
+```typescript
+callByUrl(options: CallByUrlOptions) => Promise<CallByUrlResult>
+```
+
+Call a callable function by URL.
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#callbyurloptions">CallByUrlOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#callresult">CallResult</a>&gt;</code>
+
+**Since:** 6.1.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### CallResult
+
+| Prop       | Type             | Description                          | Since |
+| ---------- | ---------------- | ------------------------------------ | ----- |
+| **`data`** | <code>any</code> | The result of the callable function. | 6.1.0 |
+
+
+#### CallByNameOptions
+
+| Prop         | Type                | Description                          | Since |
+| ------------ | ------------------- | ------------------------------------ | ----- |
+| **`name`**   | <code>string</code> | The name of the callable function.   | 6.1.0 |
+| **`region`** | <code>string</code> | The region of the callable function. | 6.1.0 |
+
+
+#### CallByUrlOptions
+
+| Prop      | Type                | Description                       | Since |
+| --------- | ------------------- | --------------------------------- | ----- |
+| **`url`** | <code>string</code> | The URL of the callable function. | 6.1.0 |
+
+
+### Type Aliases
+
+
+#### CallByNameResult
+
+<code><a href="#callresult">CallResult</a></code>
+
+
+#### CallByUrlResult
+
+<code><a href="#callresult">CallResult</a></code>
+
+</docgen-api>
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/CHANGELOG.md).
+
+## License
+
+See [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/functions/LICENSE).
+
+[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.

package/android/build.gradle

@@ -0,0 +1,60 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+    firebaseFunctionsVersion = project.hasProperty('firebaseFunctionsVersion') ? rootProject.ext.firebaseFunctionsVersion : '20.4.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "io.capawesome.capacitorjs.plugins.firebase.functions"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "com.google.firebase:firebase-functions:$firebaseFunctionsVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/FirebaseFunctions.java

@@ -0,0 +1,67 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import io.capawesome.capacitorjs.plugins.firebase.functions.classes.options.CallByNameOptions;
+import io.capawesome.capacitorjs.plugins.firebase.functions.classes.options.CallByUrlOptions;
+import io.capawesome.capacitorjs.plugins.firebase.functions.classes.results.CallResult;
+import io.capawesome.capacitorjs.plugins.firebase.functions.interfaces.NonEmptyResultCallback;
+
+public class FirebaseFunctions {
+
+    private FirebaseFunctionsPlugin plugin;
+
+    public FirebaseFunctions(FirebaseFunctionsPlugin plugin) {
+        this.plugin = plugin;
+    }
+
+    public void callByName(@NonNull CallByNameOptions options, @NonNull NonEmptyResultCallback callback) {
+        String name = options.getName();
+        String region = options.getRegion();
+        Object data = options.getData();
+
+        getFirebaseFunctionsInstance(region)
+            .getHttpsCallable(name)
+            .call(data)
+            .addOnSuccessListener(
+                task -> {
+                    CallResult result = new CallResult(task.getData());
+                    callback.success(result);
+                }
+            )
+            .addOnFailureListener(
+                exception -> {
+                    callback.error(exception);
+                }
+            );
+    }
+
+    public void callByUrl(@NonNull CallByUrlOptions options, @NonNull NonEmptyResultCallback callback) {
+        String url = options.getUrl();
+        Object data = options.getData();
+
+        getFirebaseFunctionsInstance(null)
+            .getHttpsCallable(url)
+            .call(data)
+            .addOnSuccessListener(
+                task -> {
+                    CallResult result = new CallResult(task.getData());
+                    callback.success(result);
+                }
+            )
+            .addOnFailureListener(
+                exception -> {
+                    callback.error(exception);
+                }
+            );
+    }
+
+    private com.google.firebase.functions.FirebaseFunctions getFirebaseFunctionsInstance(@Nullable String regionOrCustomDomain) {
+        if (regionOrCustomDomain == null) {
+            return com.google.firebase.functions.FirebaseFunctions.getInstance();
+        } else {
+            return com.google.firebase.functions.FirebaseFunctions.getInstance(regionOrCustomDomain);
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/FirebaseFunctionsPlugin.java

@@ -0,0 +1,91 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.firebase.functions.classes.options.CallByNameOptions;
+import io.capawesome.capacitorjs.plugins.firebase.functions.classes.options.CallByUrlOptions;
+import io.capawesome.capacitorjs.plugins.firebase.functions.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.firebase.functions.interfaces.Result;
+
+@CapacitorPlugin(name = "FirebaseFunctions")
+public class FirebaseFunctionsPlugin extends Plugin {
+
+    public static final String TAG = "FirebaseFunctions";
+    public static final String ERROR_NAME_MISSING = "name must be provided.";
+    public static final String ERROR_URL_MISSING = "url must be provided.";
+
+    private FirebaseFunctions implementation;
+
+    public void load() {
+        implementation = new FirebaseFunctions(this);
+    }
+
+    @PluginMethod
+    public void callByName(PluginCall call) {
+        try {
+            JSObject json = call.getData();
+            String name = json.getString("name", null);
+            if (name == null) {
+                call.reject(ERROR_NAME_MISSING);
+                return;
+            }
+            String region = json.getString("region", null);
+            Object data = json.opt("data");
+
+            CallByNameOptions options = new CallByNameOptions(name, region, data);
+            NonEmptyResultCallback callback = new NonEmptyResultCallback() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.callByName(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void callByUrl(PluginCall call) {
+        try {
+            JSObject json = call.getData();
+            String url = json.getString("url");
+            if (url == null) {
+                call.reject(ERROR_URL_MISSING);
+                return;
+            }
+            Object data = json.opt("data");
+
+            CallByUrlOptions options = new CallByUrlOptions(url, data);
+            NonEmptyResultCallback callback = new NonEmptyResultCallback() {
+                @Override
+                public void success(Result result) {
+                    call.resolve(result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    Logger.error(TAG, exception.getMessage(), exception);
+                    call.reject(exception.getMessage());
+                }
+            };
+
+            implementation.callByUrl(options, callback);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/classes/options/CallByNameOptions.java

@@ -0,0 +1,29 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CallByNameOptions extends CallOptions {
+
+    @NonNull
+    private String name;
+
+    @Nullable
+    private String region;
+
+    public CallByNameOptions(@NonNull String name, @Nullable String region,  Object data) {
+        super(data);
+        this.name = name;
+        this.region = region;
+    }
+
+    @NonNull
+    public String getName() {
+        return name;
+    }
+
+    @Nullable
+    public String getRegion() {
+        return region;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/classes/options/CallByUrlOptions.java

@@ -0,0 +1,19 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.classes.options;
+
+import androidx.annotation.NonNull;
+
+public class CallByUrlOptions extends CallOptions {
+
+    @NonNull
+    private String url;
+
+    public CallByUrlOptions(@NonNull String url, Object data) {
+        super(data);
+        this.url = url;
+    }
+
+    @NonNull
+    public String getUrl() {
+        return url;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/classes/options/CallOptions.java

@@ -0,0 +1,18 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.classes.options;
+
+import androidx.annotation.Nullable;
+
+public class CallOptions {
+
+    @Nullable
+    private Object data;
+
+    public CallOptions(@Nullable Object data) {
+        this.data = data;
+    }
+
+    @Nullable
+    public Object getData() {
+        return data;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/classes/results/CallResult.java

@@ -0,0 +1,67 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.classes.results;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.firebase.functions.interfaces.Result;
+import java.util.ArrayList;
+import java.util.Map;
+
+public class CallResult implements Result {
+
+    @Nullable
+    private Object data;
+
+    public CallResult(@Nullable Object data) {
+        this.data = data;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        Object dataResult = CallResult.createJSValue(data);
+
+        JSObject result = new JSObject();
+        result.put("data", dataResult);
+        return result;
+    }
+
+    @Nullable
+    private static Object createJSValue(@Nullable Object object) {
+        if (object instanceof Map) {
+            return createJSObjectFromMap((Map<String, Object>) object);
+        } else if (object instanceof ArrayList) {
+            return createJSArrayFromArrayList((ArrayList) object);
+        }
+        return object;
+    }
+
+    @Nullable
+    private static JSObject createJSObjectFromMap(@Nullable Map<String, Object> map) {
+        if (map == null) {
+            return null;
+        }
+        JSObject object = new JSObject();
+        for (String key : map.keySet()) {
+            Object value = map.get(key);
+            if (value instanceof ArrayList) {
+                value = createJSArrayFromArrayList((ArrayList) value);
+            } else if (value instanceof Map) {
+                value = createJSObjectFromMap((Map<String, Object>) value);
+            }
+            object.put(key, value);
+        }
+        return object;
+    }
+
+    private static JSArray createJSArrayFromArrayList(ArrayList arrayList) {
+        JSArray array = new JSArray();
+        for (Object value : arrayList) {
+            if (value instanceof Map) {
+                value = createJSObjectFromMap((Map<String, Object>) value);
+            }
+            array.put(value);
+        }
+        return array;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/interfaces/EmptyResultCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.interfaces;
+
+public interface EmptyResultCallback extends ResultCallback {
+    void success();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends ResultCallback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/functions/interfaces/ResultCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.firebase.functions.interfaces;
+
+public interface ResultCallback {
+    void error(Exception exception);
+}