[functions] Add useHttpsCallable hook

Author: chrisbianca

auth/useAuthState.ts

@@ -19,7 +19,7 @@ export default (auth: Auth, options?: AuthStateOptions): AuthStateHook => {
       auth,
       async (user) => {
         if (options?.onUserChanged) {
-          // onUserLoaded function to process custom claims on any other trigger function
+          // onUserChanged function to process custom claims on any other trigger function
           try {
             await options.onUserChanged(user);
           } catch (e) {

firestore/types.ts

@@ -1,6 +1,5 @@
 import {
   DocumentData,
-  DocumentReference,
   DocumentSnapshot,
   FirestoreError,
   QuerySnapshot,

functions/index.ts

@@ -0,0 +1,4 @@
+export {
+  default as useHttpsCallable,
+  HttpsCallableHook,
+} from './useHttpsCallable';

functions/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "react-firebase-hooks/functions",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/functions/index.d.ts"
+}

functions/useHttpsCallable.ts

@@ -0,0 +1,38 @@
+import { HttpsCallable, HttpsCallableResult } from 'firebase/functions';
+import { useMemo, useState } from 'react';
+
+export type HttpsCallableHook<RequestData = unknown, ResponseData = unknown> = [
+  (data?: RequestData) => Promise<HttpsCallableResult<ResponseData> | unknown>,
+  boolean,
+  Error | undefined
+];
+
+export default <RequestData = unknown, ResponseData = unknown>(
+  callable: HttpsCallable<RequestData, ResponseData>
+): HttpsCallableHook<RequestData, ResponseData> => {
+  const [error, setError] = useState<Error>();
+  const [loading, setLoading] = useState<boolean>(false);
+
+  const callCallable = async (
+    data?: RequestData
+  ): Promise<HttpsCallableResult<ResponseData> | undefined> => {
+    setLoading(true);
+    try {
+      return callable(data);
+    } catch (err) {
+      setError(err as Error);
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  const resArray: HttpsCallableHook<RequestData, ResponseData> = [
+    callCallable,
+    loading,
+    error,
+  ];
+  return useMemo<HttpsCallableHook<RequestData, ResponseData>>(
+    () => resArray,
+    resArray
+  );
+};