Add generics to httpsCallable

Author: hsubox76

common/api-review/functions-exp.api.md

@@ -24,7 +24,7 @@ export function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): F
 export { HttpsCallable }
 
 // @public
-export function httpsCallable(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable;
+export function httpsCallable<RequestParams = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable;
 
 export { HttpsCallableOptions }
 

packages-exp/functions-exp/src/api.ts

@@ -71,8 +71,8 @@ export function getFunctions(
  *
  * Note: this must be called before this instance has been used to do any operations.
  *
- * @param host The emulator host (ex: localhost)
- * @param port The emulator port (ex: 5001)
+ * @param host - The emulator host (ex: localhost)
+ * @param port - The emulator port (ex: 5001)
  * @public
  */
 export function useFunctionsEmulator(
@@ -88,10 +88,14 @@ export function useFunctionsEmulator(
  * @param name - The name of the trigger.
  * @public
  */
-export function httpsCallable(
+export function httpsCallable<RequestParams = unknown, ResponseData = unknown>(
   functionsInstance: Functions,
   name: string,
   options?: HttpsCallableOptions
 ): HttpsCallable {
-  return _httpsCallable(functionsInstance as FunctionsService, name, options);
+  return _httpsCallable<RequestParams, ResponseData>(
+    functionsInstance as FunctionsService,
+    name,
+    options
+  );
 }

packages-exp/functions-exp/src/callable.test.ts

@@ -86,7 +86,10 @@ describe('Firebase Functions > Call', () => {
       null: null
     };
 
-    const func = httpsCallable(functions, 'dataTest');
+    const func = httpsCallable<
+      Record<string, any>,
+      { message: string; code: number; long: number }
+    >(functions, 'dataTest');
     const result = await func(data);
 
     expect(result.data).to.deep.equal({
@@ -98,7 +101,7 @@ describe('Firebase Functions > Call', () => {
 
   it('scalars', async () => {
     const functions = createTestService(app, region);
-    const func = httpsCallable(functions, 'scalarTest');
+    const func = httpsCallable<number, number>(functions, 'scalarTest');
     const result = await func(17);
     expect(result.data).to.equal(76);
   });

packages-exp/functions-exp/src/service.ts

@@ -154,11 +154,11 @@ export function useFunctionsEmulator(
  * @param name - The name of the trigger.
  * @public
  */
-export function httpsCallable(
+export function httpsCallable<RequestParams, ResponseData>(
   functionsInstance: FunctionsService,
   name: string,
   options?: HttpsCallableOptions
-): HttpsCallable {
+): HttpsCallable<RequestParams, ResponseData> {
   return data => {
     return call(functionsInstance, name, data, options || {});
   };

packages-exp/functions-types-exp/index.d.ts

@@ -20,16 +20,16 @@ import { FirebaseError } from '@firebase/util';
 /**
  * An HttpsCallableResult wraps a single result from a function call.
  */
-export interface HttpsCallableResult {
-  readonly data: any;
+export interface HttpsCallableResult<ResponseData = any> {
+  readonly data: ResponseData;
 }
 
 /**
  * An HttpsCallable is a reference to a "callable" http trigger in
  * Google Cloud Functions.
  */
-export interface HttpsCallable {
-  (data?: {} | null): Promise<HttpsCallableResult>;
+export interface HttpsCallable<RequestParams = any, ResponseData = any> {
+  (data?: RequestParams | null): Promise<HttpsCallableResult<ResponseData>>;
 }
 
 /**