Update exp docgen script and add functions-exp docs (#3412)

common/api-review/app-types-exp.api.md

@@ -57,7 +57,7 @@ export interface FirebaseOptions {
 export interface _FirebaseService {
   // (undocumented)
   app: FirebaseApp;
-   delete(): Promise<void>;
+  delete(): Promise<void>;
 }
 
 // @public (undocumented)
@@ -66,6 +66,14 @@ export interface PlatformLoggerService {
   getPlatformInfoString(): string;
 }
 
+// @public (undocumented)
+export interface VersionService {
+  // (undocumented)
+  library: string;
+  // (undocumented)
+  version: string;
+}
+
 
 // (No @packageDocumentation comment for this package)
 

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

@@ -0,0 +1,65 @@
+## API Report File for "@firebase/functions-types-exp"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { FirebaseError } from '@firebase/util';
+
+// @public
+export interface Functions {
+  app: FirebaseApp;
+
+  region: string;
+}
+
+// @public (undocumented)
+export interface FunctionsError extends FirebaseError {
+  readonly code: FunctionsErrorCode;
+
+  readonly details?: any;
+}
+
+// @public
+export type FunctionsErrorCode =
+  | 'ok'
+  | 'cancelled'
+  | 'unknown'
+  | 'invalid-argument'
+  | 'deadline-exceeded'
+  | 'not-found'
+  | 'already-exists'
+  | 'permission-denied'
+  | 'resource-exhausted'
+  | 'failed-precondition'
+  | 'aborted'
+  | 'out-of-range'
+  | 'unimplemented'
+  | 'internal'
+  | 'unavailable'
+  | 'data-loss'
+  | 'unauthenticated';
+
+// @public
+export interface HttpsCallable {
+  // (undocumented)
+  (data?: {} | null): Promise<HttpsCallableResult>;
+}
+
+// @public
+export interface HttpsCallableOptions {
+  // (undocumented)
+  timeout?: number; // in millis
+}
+
+// @public
+export interface HttpsCallableResult {
+  // (undocumented)
+  readonly data: any;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```

docs-exp/app-types.firebaseapp.md

@@ -18,7 +18,7 @@ export interface FirebaseApp
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [automaticDataCollectionEnabled](./app-types.firebaseapp.automaticdatacollectionenabled.md) | <code>boolean</code> | The settable config flag for GDPR opt-in/opt-out |
-|  [name](./app-types.firebaseapp.name.md) | <code>string</code> | The (read-only) name for this app.<!-- -->The default app's name is <code>&quot;[DEFAULT]&quot;</code>. |
-|  [options](./app-types.firebaseapp.options.md) | <code>FirebaseOptions</code> | The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.initializeapp.md)<!-- -->. |
+|  [automaticDataCollectionEnabled](./app-types.firebaseapp.automaticdatacollectionenabled.md) | boolean | The settable config flag for GDPR opt-in/opt-out |
+|  [name](./app-types.firebaseapp.name.md) | string | The (read-only) name for this app.<!-- -->The default app's name is <code>&quot;[DEFAULT]&quot;</code>. |
+|  [options](./app-types.firebaseapp.options.md) | [FirebaseOptions](./app-types.firebaseoptions.md) | The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.initializeapp.md)<!-- -->. |
 

docs-exp/app-types.firebaseappconfig.md

@@ -15,6 +15,6 @@ export interface FirebaseAppConfig
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [automaticDataCollectionEnabled](./app-types.firebaseappconfig.automaticdatacollectionenabled.md) | <code>boolean</code> |  |
-|  [name](./app-types.firebaseappconfig.name.md) | <code>string</code> |  |
+|  [automaticDataCollectionEnabled](./app-types.firebaseappconfig.automaticdatacollectionenabled.md) | boolean |  |
+|  [name](./app-types.firebaseappconfig.name.md) | string |  |
 

docs-exp/app-types.firebaseoptions.md

@@ -15,12 +15,12 @@ export interface FirebaseOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [apiKey](./app-types.firebaseoptions.apikey.md) | <code>string</code> |  |
-|  [appId](./app-types.firebaseoptions.appid.md) | <code>string</code> |  |
-|  [authDomain](./app-types.firebaseoptions.authdomain.md) | <code>string</code> |  |
-|  [databaseURL](./app-types.firebaseoptions.databaseurl.md) | <code>string</code> |  |
-|  [measurementId](./app-types.firebaseoptions.measurementid.md) | <code>string</code> |  |
-|  [messagingSenderId](./app-types.firebaseoptions.messagingsenderid.md) | <code>string</code> |  |
-|  [projectId](./app-types.firebaseoptions.projectid.md) | <code>string</code> |  |
-|  [storageBucket](./app-types.firebaseoptions.storagebucket.md) | <code>string</code> |  |
+|  [apiKey](./app-types.firebaseoptions.apikey.md) | string |  |
+|  [appId](./app-types.firebaseoptions.appid.md) | string |  |
+|  [authDomain](./app-types.firebaseoptions.authdomain.md) | string |  |
+|  [databaseURL](./app-types.firebaseoptions.databaseurl.md) | string |  |
+|  [measurementId](./app-types.firebaseoptions.measurementid.md) | string |  |
+|  [messagingSenderId](./app-types.firebaseoptions.messagingsenderid.md) | string |  |
+|  [projectId](./app-types.firebaseoptions.projectid.md) | string |  |
+|  [storageBucket](./app-types.firebaseoptions.storagebucket.md) | string |  |
 

docs-exp/app-types.md

@@ -12,4 +12,5 @@
 |  [FirebaseAppConfig](./app-types.firebaseappconfig.md) |  |
 |  [FirebaseOptions](./app-types.firebaseoptions.md) |  |
 |  [PlatformLoggerService](./app-types.platformloggerservice.md) |  |
+|  [VersionService](./app-types.versionservice.md) |  |
 

docs-exp/app-types.platformloggerservice.getplatforminfostring.md

@@ -11,5 +11,5 @@ getPlatformInfoString(): string;
 ```
 <b>Returns:</b>
 
-`string`
+string
 

docs-exp/app-types.versionservice.library.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [VersionService](./app-types.versionservice.md) &gt; [library](./app-types.versionservice.library.md)
+
+## VersionService.library property
+
+<b>Signature:</b>
+
+```typescript
+library: string;
+```

docs-exp/app-types.versionservice.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [VersionService](./app-types.versionservice.md)
+
+## VersionService interface
+
+<b>Signature:</b>
+
+```typescript
+export interface VersionService 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [library](./app-types.versionservice.library.md) | string |  |
+|  [version](./app-types.versionservice.version.md) | string |  |
+

docs-exp/app-types.versionservice.version.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/app-types](./app-types.md) &gt; [VersionService](./app-types.versionservice.md) &gt; [version](./app-types.versionservice.version.md)
+
+## VersionService.version property
+
+<b>Signature:</b>
+
+```typescript
+version: string;
+```

docs-exp/app.deleteapp.md

@@ -16,11 +16,11 @@ export declare function deleteApp(app: FirebaseApp): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  app | <code>FirebaseApp</code> |  |
+|  app | [FirebaseApp](./app-types.firebaseapp.md) |  |
 
 <b>Returns:</b>
 
-`Promise<void>`
+Promise&lt;void&gt;
 
 ## Example
 

docs-exp/app.getapp.md

@@ -20,11 +20,11 @@ export declare function getApp(name?: string): FirebaseApp;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  name | <code>string</code> | Optional name of the app to return. If no name is provided, the default is <code>&quot;[DEFAULT]&quot;</code>. |
+|  name | string | Optional name of the app to return. If no name is provided, the default is <code>&quot;[DEFAULT]&quot;</code>. |
 
 <b>Returns:</b>
 
-`FirebaseApp`
+[FirebaseApp](./app-types.firebaseapp.md)
 
 The app corresponding to the provided app name. If no app name is provided, the default app is returned.
 

docs-exp/app.getapps.md

@@ -13,5 +13,5 @@ export declare function getApps(): FirebaseApp[];
 ```
 <b>Returns:</b>
 
-`FirebaseApp[]`
+[FirebaseApp](./app-types.firebaseapp.md)<!-- -->\[\]
 

docs-exp/app.initializeapp.md

@@ -18,12 +18,12 @@ export declare function initializeApp(options: FirebaseOptions, name?: string):
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | <code>FirebaseOptions</code> | Options to configure the app's services. |
-|  name | <code>string</code> | Optional name of the app to initialize. If no name is provided, the default is <code>&quot;[DEFAULT]&quot;</code>. |
+|  options | [FirebaseOptions](./app-types.firebaseoptions.md) | Options to configure the app's services. |
+|  name | string | Optional name of the app to initialize. If no name is provided, the default is <code>&quot;[DEFAULT]&quot;</code>. |
 
 <b>Returns:</b>
 
-`FirebaseApp`
+[FirebaseApp](./app-types.firebaseapp.md)
 
 The initialized app.
 

docs-exp/app.initializeapp_1.md

@@ -16,10 +16,10 @@ export declare function initializeApp(options: FirebaseOptions, config?: Firebas
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | <code>FirebaseOptions</code> | Options to configure the app's services. |
-|  config | <code>FirebaseAppConfig</code> | FirebaseApp Configuration |
+|  options | [FirebaseOptions](./app-types.firebaseoptions.md) | Options to configure the app's services. |
+|  config | [FirebaseAppConfig](./app-types.firebaseappconfig.md) | FirebaseApp Configuration |
 
 <b>Returns:</b>
 
-`FirebaseApp`
+[FirebaseApp](./app-types.firebaseapp.md)
 

docs-exp/app.onlog.md

@@ -16,10 +16,10 @@ export declare function onLog(logCallback: LogCallback | null, options?: LogOpti
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  logCallback | <code>LogCallback &#124; null</code> | An optional custom log handler that executes user code whenever the Firebase SDK makes a logging call. |
-|  options | <code>LogOptions</code> |  |
+|  logCallback | LogCallback \| null | An optional custom log handler that executes user code whenever the Firebase SDK makes a logging call. |
+|  options | LogOptions |  |
 
 <b>Returns:</b>
 
-`void`
+void
 

docs-exp/app.registerversion.md

@@ -16,11 +16,11 @@ export declare function registerVersion(libraryKeyOrName: string, version: strin
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  libraryKeyOrName | <code>string</code> |  |
-|  version | <code>string</code> | Current version of that library. |
-|  variant | <code>string</code> | Bundle variant, e.g., node, rn, etc. |
+|  libraryKeyOrName | string |  |
+|  version | string | Current version of that library. |
+|  variant | string | Bundle variant, e.g., node, rn, etc. |
 
 <b>Returns:</b>
 
-`void`
+void
 

docs-exp/app.setloglevel.md

@@ -18,9 +18,9 @@ export declare function setLogLevel(logLevel: LogLevel): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  logLevel | <code>LogLevel</code> |  |
+|  logLevel | LogLevel |  |
 
 <b>Returns:</b>
 
-`void`
+void
 

docs-exp/functions-types.functions.app.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/functions-types](./functions-types.md) &gt; [Functions](./functions-types.functions.md) &gt; [app](./functions-types.functions.app.md)
+
+## Functions.app property
+
+The FirebaseApp this Functions instance is associated with.
+
+<b>Signature:</b>
+
+```typescript
+app: FirebaseApp;
+```

docs-exp/functions-types.functions.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/functions-types](./functions-types.md) &gt; [Functions](./functions-types.functions.md)
+
+## Functions interface
+
+`Functions` represents a Functions instance, and is a required argument for all Functions operations.
+
+<b>Signature:</b>
+
+```typescript
+export interface Functions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [app](./functions-types.functions.app.md) | [FirebaseApp](./app-types.firebaseapp.md) | The FirebaseApp this Functions instance is associated with. |
+|  [region](./functions-types.functions.region.md) | string | The region the callable Cloud Functions are located in. Default is <code>us-central-1</code>. |
+

docs-exp/functions-types.functions.region.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/functions-types](./functions-types.md) &gt; [Functions](./functions-types.functions.md) &gt; [region](./functions-types.functions.region.md)
+
+## Functions.region property
+
+The region the callable Cloud Functions are located in. Default is `us-central-1`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+region: string;
+```

docs-exp/functions-types.functionserror.code.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/functions-types](./functions-types.md) &gt; [FunctionsError](./functions-types.functionserror.md) &gt; [code](./functions-types.functionserror.code.md)
+
+## FunctionsError.code property
+
+A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.
+
+<b>Signature:</b>
+
+```typescript
+readonly code: FunctionsErrorCode;
+```

docs-exp/functions-types.functionserror.details.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/functions-types](./functions-types.md) &gt; [FunctionsError](./functions-types.functionserror.md) &gt; [details](./functions-types.functionserror.details.md)
+
+## FunctionsError.details property
+
+Extra data to be converted to JSON and included in the error response.
+
+<b>Signature:</b>
+
+```typescript
+readonly details?: any;
+```

docs-exp/functions-types.functionserror.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/functions-types](./functions-types.md) &gt; [FunctionsError](./functions-types.functionserror.md)
+
+## FunctionsError interface
+
+<b>Signature:</b>
+
+```typescript
+export interface FunctionsError extends FirebaseError 
+```
+<b>Extends:</b> FirebaseError
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [code](./functions-types.functionserror.code.md) | [FunctionsErrorCode](./functions-types.functionserrorcode.md) | A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto. |
+|  [details](./functions-types.functionserror.details.md) | any | Extra data to be converted to JSON and included in the error response. |
+