Merge pull request #18 from lucacasonato/master

chrisbianca · web-flow · commit ee43cb10f103 · 2019-05-07T17:28:14.000+03:00
Changed error type to FirebaseError
diff --git a/database/index.js.flow b/database/index.js.flow
@@ -1,28 +1,29 @@
 // @flow
+import type { FirebaseError } from 'firebase';
 import type { DataSnapshot, Query } from 'firebase/database';
 
 export type ListHook = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value: DataSnapshot[],
 };
 export type ListKeysHook = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value: string[],
 };
 export type ListValsHook<T> = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value: T[],
 };
 export type ObjectHook = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: DataSnapshot,
 };
 export type ObjectValHook<T> = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: T,
 };
diff --git a/database/useList.ts b/database/useList.ts
@@ -1,9 +1,9 @@
-import { database } from 'firebase';
+import { database, FirebaseError } from 'firebase';
 import { useEffect, useReducer } from 'react';
 import { useIsEqualRef } from '../util';
 
 export type ListHook = {
-  error?: Object;
+  error?: FirebaseError;
   loading: boolean;
   value?: database.DataSnapshot[];
 };
@@ -14,7 +14,7 @@ type KeyValueState = {
 };
 
 type ReducerState = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value: KeyValueState;
 };
@@ -29,7 +29,7 @@ type ChangeAction = {
   snapshot: database.DataSnapshot | null;
 };
 type EmptyAction = { type: 'empty' };
-type ErrorAction = { type: 'error'; error: object };
+type ErrorAction = { type: 'error'; error: FirebaseError };
 type MoveAction = {
   type: 'move';
   previousKey?: string | null;
@@ -160,7 +160,7 @@ export default (query?: database.Query | null): ListHook => {
         () => {
           dispatch({ type: 'value' });
         },
-        (error: object) => {
+        (error: FirebaseError) => {
           dispatch({ type: 'error', error });
         }
       );
diff --git a/database/useListKeys.ts b/database/useListKeys.ts
@@ -1,8 +1,8 @@
-import { database } from 'firebase';
+import { database, FirebaseError } from 'firebase';
 import useList from './useList';
 
 export type ListKeysHook = {
-  error?: Object;
+  error?: FirebaseError;
   loading: boolean;
   value?: string[];
 };
diff --git a/database/useListVals.ts b/database/useListVals.ts
@@ -1,9 +1,9 @@
-import { database } from 'firebase';
+import { database, FirebaseError } from 'firebase';
 import useList from './useList';
 import { snapshotToData } from './helpers';
 
 export type ListValsHook<T> = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: T[];
 };
diff --git a/database/useObject.ts b/database/useObject.ts
@@ -1,9 +1,9 @@
-import { database } from 'firebase';
+import { database, FirebaseError } from 'firebase';
 import { useEffect } from 'react';
 import { useIsEqualRef, useLoadingValue } from '../util';
 
 export type ObjectHook = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: database.DataSnapshot;
 };
diff --git a/database/useObjectVal.ts b/database/useObjectVal.ts
@@ -1,9 +1,9 @@
-import { database } from 'firebase';
+import { database, FirebaseError } from 'firebase';
 import useObject from './useObject';
 import { snapshotToData } from './helpers';
 
 export type ObjectValHook<T> = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: T;
 };
diff --git a/firestore/index.js.flow b/firestore/index.js.flow
@@ -1,4 +1,5 @@
 // @flow
+import type { FirebaseError } from 'firebase';
 import type {
   DocumentReference,
   DocumentSnapshot,
@@ -9,22 +10,22 @@ import type {
 } from 'firebase/firestore';
 
 export type CollectionHook = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: QuerySnapshot,
 };
 export type CollectionDataHook<T> = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: T,
 };
 export type DocumentHook = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: DocumentSnapshot,
 };
 export type DocumentDataHook<T> = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: T,
 };
diff --git a/firestore/useCollection.ts b/firestore/useCollection.ts
@@ -1,9 +1,10 @@
-import { firestore } from 'firebase';
+import { firestore, FirebaseError } from 'firebase';
 import { useEffect } from 'react';
 import { useIsEqualRef, useLoadingValue } from '../util';
+import { transformError } from '../util/transformError';
 
 export type CollectionHook = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: firestore.QuerySnapshot;
 };
@@ -24,8 +25,8 @@ export default (
         return;
       }
       const listener = options
-        ? ref.current.onSnapshot(options, setValue, setError)
-        : ref.current.onSnapshot(setValue, setError);
+        ? ref.current.onSnapshot(options, setValue, (error: Error) => setError(transformError(error)))
+        : ref.current.onSnapshot(setValue, (error: Error) => setError(transformError(error)));
 
       return () => {
         listener();
diff --git a/firestore/useCollectionData.ts b/firestore/useCollectionData.ts
@@ -1,9 +1,9 @@
-import { firestore } from 'firebase';
+import { firestore, FirebaseError } from 'firebase';
 import useCollection from './useCollection';
 import { snapshotToData } from './helpers';
 
 export type CollectionDataHook<T> = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: T[];
 };
diff --git a/firestore/useDocument.ts b/firestore/useDocument.ts
@@ -1,9 +1,10 @@
-import { firestore } from 'firebase';
+import { firestore, FirebaseError } from 'firebase';
 import { useEffect } from 'react';
 import { useIsEqualRef, useLoadingValue } from '../util';
+import { transformError } from '../util/transformError';
 
 export type DocumentHook = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: firestore.DocumentSnapshot;
 };
@@ -24,8 +25,8 @@ export default (
         return;
       }
       const listener = options
-        ? ref.current.onSnapshot(options, setValue, setError)
-        : ref.current.onSnapshot(setValue, setError);
+        ? ref.current.onSnapshot(options, setValue, (error: Error) => setError(transformError(error)))
+        : ref.current.onSnapshot(setValue, (error: Error) => setError(transformError(error)));
 
       return () => {
         listener();
diff --git a/firestore/useDocumentData.ts b/firestore/useDocumentData.ts
@@ -1,9 +1,9 @@
-import { firestore } from 'firebase';
+import { firestore, FirebaseError } from 'firebase';
 import useDocument from './useDocument';
 import { snapshotToData } from './helpers';
 
 export type DocumentDataHook<T> = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: T;
 };
diff --git a/storage/index.js.flow b/storage/index.js.flow
@@ -1,8 +1,9 @@
 // @flow
+import type { FirebaseError } from 'firebase';
 import type { Reference } from 'firebase/storage';
 
 export type DownloadURLHook = {
-  error?: Object,
+  error?: FirebaseError,
   loading: boolean,
   value?: string,
 };
diff --git a/storage/useDownloadURL.ts b/storage/useDownloadURL.ts
@@ -1,9 +1,9 @@
-import { storage } from 'firebase';
+import { storage, FirebaseError } from 'firebase';
 import { useEffect } from 'react';
 import { useComparatorRef, useLoadingValue } from '../util';
 
 export type DownloadURLHook = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: string;
 };
diff --git a/util/transformError.ts b/util/transformError.ts
@@ -0,0 +1,10 @@
+import { FirebaseError } from 'firebase';
+
+export const transformError = (error: Error): FirebaseError => {
+  return {
+    message: error.message,
+    stack: error.stack,
+    name: error.name,
+    code: ''
+  }
+}
diff --git a/util/useLoadingValue.ts b/util/useLoadingValue.ts
@@ -1,21 +1,22 @@
 import { useReducer } from 'react';
+import { FirebaseError } from 'firebase';
 
 export type LoadingValue<T> = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   reset: () => void;
-  setError: (error: object) => void;
+  setError: (error: FirebaseError) => void;
   setValue: (value?: T | null) => void;
   value?: T;
 };
 
 type ReducerState = {
-  error?: object;
+  error?: FirebaseError;
   loading: boolean;
   value?: any;
 };
 
-type ErrorAction = { type: 'error'; error: object };
+type ErrorAction = { type: 'error'; error: FirebaseError };
 type ResetAction = { type: 'reset'; defaultValue?: any };
 type ValueAction = { type: 'value'; value: any };
 type ReducerAction = ErrorAction | ResetAction | ValueAction;
@@ -57,7 +58,7 @@ export default <T>(getDefaultValue?: () => T | null): LoadingValue<T> => {
     dispatch({ type: 'reset', defaultValue });
   };
 
-  const setError = (error: Object) => {
+  const setError = (error: FirebaseError) => {
     dispatch({ type: 'error', error });
   };
 
diff --git a/yarn-error.log b/yarn-error.log
