Add flow types

Author: chrisbianca

auth/index.js.flow

@@ -0,0 +1,7 @@
+// @flow
+import type { Auth, User } from 'firebase';
+export type AuthStateHook = {
+  user?: User;
+  initialising: boolean;
+};
+declare export function useAuthState(auth: Auth): AuthStateHook;

database/index.js.flow

@@ -0,0 +1,16 @@
+// @flow
+import type { DataSnapshot, Query } from 'firebase/database';
+
+export type ListHook = {
+  error?: Object;
+  list: DataSnapshot[];
+  loading: boolean;
+};
+export type ObjectHook = {
+  error?: object;
+  loading: boolean;
+  value?: DataSnapshot;
+};
+
+declare export function useList(query: Query): ListHook;
+declare export function useObject(query: Query): ObjectHook;

firestore/index.js.flow

@@ -0,0 +1,22 @@
+// @flow
+import type {
+  DocumentReference,
+  DocumentSnapshot,
+  Query,
+  QuerySnapshot,
+  SnapshotListenOptions,
+} from 'firebase/firestore';
+
+export type CollectionHook = {
+  error?: object;
+  loading: boolean;
+  value?: firestore.QuerySnapshot;
+};
+export type DocumentHook = {
+  error?: object;
+  loading: boolean;
+  value?: firestore.DocumentSnapshot;
+};
+
+declare export function useCollection(query: Query, options?: SnapshotListenOptions): CollectionHook;
+declare export function useDocument(ref: firestore.DocumentReference, options?: SnapshotListenOptions): DocumentHook;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-firebase-hooks",
-  "version": "0.3.0-alpha.1",
+  "version": "0.3.0-alpha.10",
   "description": "React Hooks for Firebase",
   "author": "CS Frequency Limited (https://csfrequency.com)",
   "license": "Apache-2.0",
@@ -14,17 +14,21 @@
   "files": [
     "auth/dist/*.js",
     "auth/dist/auth",
+    "auth/dist/*.js.flow",
     "auth/package.json",
     "database/dist/*.js",
     "database/dist/database",
+    "database/dist/*.js.flow",
     "database/package.json",
     "dist/*.js",
     "dist/*.js.map",
     "firestore/dist/*.js",
     "firestore/dist/firestore",
+    "firestore/dist/*.js.flow",
     "firestore/package.json",
     "storage/dist/*.js",
     "storage/dist/storage",
+    "storage/dist/*.js.flow",
     "storage/package.json"
   ],
   "repository": {
@@ -33,9 +37,9 @@
   },
   "scripts": {
     "build": "npm run clean && rollup -c",
-    "clean": "rimraf dist auth/dist auth/*.d.ts database/dist database/*.d.ts firestore/dist firestore/*.d.ts storage/dist storage/*.d.ts util/*.d.ts",
+    "clean": "rimraf ./dist ./auth/dist ./auth/*.d.ts ./database/dist ./database/*.d.ts ./firestore/dist ./firestore/*.d.ts ./storage/dist ./storage/*.d.ts ./util/*.d.ts",
     "dev": "npm run clean && rollup -c -w",
-    "prepare": "npm run build"
+    "prepublish": "npm run build"
   },
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -47,6 +51,7 @@
     "rimraf": "^2.6.2",
     "rollup": "0.57.1",
     "rollup-plugin-commonjs": "9.1.0",
+    "rollup-plugin-copy": "^0.2.3",
     "rollup-plugin-node-resolve": "3.3.0",
     "rollup-plugin-typescript2": "0.12.0",
     "rollup-plugin-uglify": "3.0.0",

rollup.config.js

@@ -1,5 +1,6 @@
 import { resolve } from 'path';
 import commonjs from 'rollup-plugin-commonjs';
+import copy from 'rollup-plugin-copy';
 import resolveModule from 'rollup-plugin-node-resolve';
 import typescript from 'rollup-plugin-typescript2';
 import uglify from 'rollup-plugin-uglify';
@@ -54,7 +55,17 @@ export default components
             react: 'react',
           },
         },
-        plugins: [...plugins, uglify()],
+        plugins: [
+          ...plugins,
+          uglify(),
+          // Copy flow files
+          copy({
+            [`${component}/index.js.flow`]: `${component}/dist/index.cjs.js.flow`,
+          }),
+          copy({
+            [`${component}/index.js.flow`]: `${component}/dist/index.esm.js.flow`,
+          }),
+        ],
         external,
       },
     ];

storage/index.js.flow

@@ -0,0 +1,9 @@
+// @flow
+import type { Reference } from 'firebase/storage';
+
+export type DownloadURLHook = {
+  error?: object;
+  loading: boolean;
+  url?: string;
+};
+declare export function useDownloadURL(ref: Reference): DownloadURLHook;

yarn.lock

@@ -229,6 +229,10 @@ code-point-at@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77"
 
+colors@^1.1.2:
+  version "1.3.2"
+  resolved "https://registry.yarnpkg.com/colors/-/colors-1.3.2.tgz#2df8ff573dfbf255af562f8ce7181d6b971a359b"
+
 colour@~0.7.1:
   version "0.7.1"
   resolved "https://registry.yarnpkg.com/colour/-/colour-0.7.1.tgz#9cb169917ec5d12c0736d3e8685746df1cadf778"
@@ -356,6 +360,14 @@ for-own@^0.1.4:
   dependencies:
     for-in "^1.0.1"
 
+fs-extra@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-3.0.1.tgz#3794f378c58b342ea7dbbb23095109c4b3b62291"
+  dependencies:
+    graceful-fs "^4.1.2"
+    jsonfile "^3.0.0"
+    universalify "^0.1.0"
+
 fs-extra@^5.0.0:
   version "5.0.0"
   resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-5.0.0.tgz#414d0110cdd06705734d055652c5411260c31abd"
@@ -554,6 +566,12 @@ isomorphic-fetch@2.2.1:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499"
 
+jsonfile@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-3.0.1.tgz#a5ecc6f65f53f662c4415c7675a0331d0992ec66"
+  optionalDependencies:
+    graceful-fs "^4.1.6"
+
 jsonfile@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
@@ -919,6 +937,13 @@ rollup-plugin-commonjs@9.1.0:
     resolve "^1.5.0"
     rollup-pluginutils "^2.0.1"
 
+rollup-plugin-copy@^0.2.3:
+  version "0.2.3"
+  resolved "https://registry.yarnpkg.com/rollup-plugin-copy/-/rollup-plugin-copy-0.2.3.tgz#dac1ab81d1f220baeb98e5c4c0108252e1edbb98"
+  dependencies:
+    colors "^1.1.2"
+    fs-extra "^3.0.0"
+
 rollup-plugin-node-resolve@3.3.0:
   version "3.3.0"
   resolved "http://registry.npmjs.org/rollup-plugin-node-resolve/-/rollup-plugin-node-resolve-3.3.0.tgz#c26d110a36812cbefa7ce117cadcd3439aa1c713"