reactfire 4.0.0-exp.cb3fede → 4.0.0-exp.eb1428b

package/README.md

@@ -1,11 +1,5 @@
 # ReactFire
 
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
-
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-
 Hooks, Context Providers, and Components that make it easy to interact with
 Firebase.
 
@@ -21,12 +15,12 @@ Firebase.
 
 ```bash
 # npm
-npm install --save reactfire@exp firebase@exp
+npm install --save firebase reactfire
 
 # or
 
 # yarn
-yarn add reactfire@exp firebase@exp
+yarn add firebase reactfire
 ```
 
 Depending on your targeted platforms you may need to install polyfills. The most commonly needed will be [globalThis](https://caniuse.com/#search=globalThis) and [Proxy](https://caniuse.com/#search=Proxy).
@@ -34,9 +28,9 @@ Depending on your targeted platforms you may need to install polyfills. The most
 ## Docs
 
 - [**Quickstart**](./docs/quickstart.md)
-  - Advanced: If you're using Concurrent Mode, check out the [Concurrent Mode quickstart](./docs/quickstart-concurrent-mode.md)
 - [**Common Use Cases**](./docs/use.md)
 - [**API Reference**](./docs/reference)
+- [**v3 -> v4 Upgrade Guide**](./docs/upgrade-guide.md)
 
 ## Example use
 
@@ -89,10 +83,6 @@ render(
 
 ---
 
-> If you're looking for docs for the _deprecated_ ReactFire v1 (the one that
-> uses mixins), click
-> [here](https://github.com/FirebaseExtended/reactfire/tree/v1.0.0)
-
 ## Status
 
 ![Status: Experimental](https://img.shields.io/badge/Status-Experimental-blue)
@@ -101,29 +91,17 @@ This repository is maintained by Googlers but is not a supported Firebase produc
 
 ### Extra Experimental [concurrent mode](https://reactjs.org/docs/concurrent-mode-suspense.html) features
 
+These features are marked as *extra experimental* because they use experimental React features that [will not be stable until sometime after React 18 is released](https://github.com/reactwg/react-18/discussions/47#:~:text=Likely%20after%20React%2018.0%3A%20Suspense%20for%20Data%20Fetching).
+
 - **Loading states handled by `<Suspense>`** - ReactFire's hooks throw promises
-  that Suspense can catch. No more `isLoaded ?...` - let React
-  [handle it for you](https://reactjs.org/docs/concurrent-mode-suspense.html).
+  that Suspense can catch. Let React
+  [handle loading states for you](https://reactjs.org/docs/concurrent-mode-suspense.html).
 - **Automatically instrument your `Suspense` load times** - Need to automatically instrument your `Suspense` load times with [RUM](https://firebase.google.com/docs/perf-mon)? Use `<SuspenseWithPerf />`.
 
-## Contributors ✨
+Enable concurrent mode features by following the [concurrent mode setup guide](https://reactjs.org/docs/concurrent-mode-adoption.html#installation) and then setting the `suspense` prop in `FirebaseAppProvider`:
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="http://www.dfweb.no"><img src="https://avatars1.githubusercontent.com/u/45217974?v=4" width="100px;" alt=""/><br /><sub><b>w3bdesign</b></sub></a><br /><a href="https://github.com/FirebaseExtended/reactfire/commits?author=w3bdesign" title="Code">💻</a></td>
-    <td align="center"><a href="http://prue.io"><img src="https://avatars0.githubusercontent.com/u/2992224?v=4" width="100px;" alt=""/><br /><sub><b>Scott Prue</b></sub></a><br /><a href="https://github.com/FirebaseExtended/reactfire/commits?author=prescottprue" title="Code">💻</a></td>
-    <td align="center"><a href="http://git.io/jhuleatt"><img src="https://avatars0.githubusercontent.com/u/3759507?v=4" width="100px;" alt=""/><br /><sub><b>Jeff</b></sub></a><br /><a href="https://github.com/FirebaseExtended/reactfire/commits?author=jhuleatt" title="Code">💻</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-enable -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+```jsx
+<FirebaseAppProvider firebaseConfig={firebaseConfig} suspense={true}>
+```
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+See concurrent mode code samples in [example/withSuspense](https://github.com/FirebaseExtended/reactfire/tree/main/example/withSuspense)

package/dist/SuspenseSubject.d.ts

@@ -12,7 +12,7 @@ export declare class SuspenseSubject<T> extends Subject<T> {
     private _resolveFirstEmission;
     constructor(innerObservable: Observable<T>, _timeoutWindow: number);
     get hasValue(): boolean;
-    get value(): T | undefined;
+    get value(): T;
     get firstEmission(): Promise<void>;
     private _next;
     private _reset;

package/dist/functions.d.ts

@@ -0,0 +1,12 @@
+import { ReactFireOptions, ObservableStatus } from './';
+import type { HttpsCallableOptions } from 'firebase/functions';
+/**
+ * Calls a callable function.
+ *
+ * @param functionName - The name of the function to call
+ * @param options
+ */
+export declare function useCallableFunctionResponse<RequestData, ResponseData>(functionName: string, options?: ReactFireOptions<ResponseData> & {
+    httpsCallableOptions?: HttpsCallableOptions;
+    data?: RequestData;
+}): ObservableStatus<ResponseData>;

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export * from './auth';
 export * from './database';
 export * from './firebaseApp';
 export * from './firestore';
+export * from './functions';
 export * from './performance';
 export * from './remote-config';
 export * from './storage';