v3.4.0 (#928)

* chore(ci): add package version check stage to prevent failed builds if version is already released
* feat(types): generic types for firestore methods (#920) - @puppybits
* fix(types): use correct import for react in types (#927) - @loginov-rocks
* chore(types): remove unused AppTypes import

Co-authored-by: Bobby <[email protected]>
Co-authored-by: Danila Loginov <[email protected]>

Author: 3 people

.github/workflows/publish.yml

@@ -14,40 +14,45 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Check package version
-        uses: technote-space/package-version-check-action@v1
-        with:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      - name: Check if version has been updated
+        id: check
+        uses: EndBug/version-check@v1
 
       - name: Setup Node 10
+        if: steps.check.outputs.changed == 'true'
         uses: actions/setup-node@v1
         with:
           node-version: 10
           registry-url: https://registry.npmjs.org/
 
       # Setup dependency caching
       - uses: actions/cache@v1
+        if: steps.check.outputs.changed == 'true'
         with:
           path: ~/.npm
           key: ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
 
       - name: Install Dependencies
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
         run: npm ci
 
       - name: Check For Lint
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
         run: npm run lint
 
       - name: Run Unit Tests + Coverage
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
           CODE_CLIMATE: ${{ secrets.CODE_CLIMATE }}
         run: npm run test:cov
 
       - name: Publish
+        if: steps.check.outputs.changed == 'true'
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
           GITHUB_REF: ${{ github.ref }}
@@ -57,18 +62,17 @@ jobs:
           npm publish $PUBLISH_FLAG
 
       - name: Archive Build Artifact
+        if: steps.check.outputs.changed == 'true'
         uses: actions/upload-artifact@master
-        if: success()
         with:
           name: build
           path: lib
 
       - name: Upload Coverage
-        if: success()
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
           CODE_COV: ${{ secrets.CODE_COV }}
         # Upload to Code Cover. Curl used in place of codecov/codecov-action
         # due to long build time. See https://github.com/codecov/codecov-action/issues/21
         run: curl -s https://codecov.io/bash | bash -s -- -t $CODE_COV
-

index.d.ts

@@ -1,9 +1,8 @@
-import React from 'react'
+import * as React from 'react'
 import * as FirestoreTypes from '@firebase/firestore-types'
 import * as DatabaseTypes from '@firebase/database-types'
 import * as StorageTypes from '@firebase/storage-types'
 import * as AuthTypes from '@firebase/auth-types'
-import * as AppTypes from '@firebase/app-types'
 import { Dispatch } from 'redux'
 
 /**
@@ -451,40 +450,43 @@ interface ExtendedFirestoreInstance extends FirestoreTypes.FirebaseFirestore {
    * Get data from firestore.
    * @see https://github.com/prescottprue/redux-firestore#get
    */
-  get: (docPath: string | ReduxFirestoreQuerySetting) => Promise<void>
+  get: <T>(
+    docPath: string | ReduxFirestoreQuerySetting
+  ) => Promise<FirestoreTypes.DocumentSnapshot<Partial<T>>>
 
   /**
    * Set data to firestore.
    * @see https://github.com/prescottprue/redux-firestore#set
    */
-  set: (
+  set: <T>(
     docPath: string | ReduxFirestoreQuerySetting,
-    data: Object
-  ) => Promise<void>
+    data: Partial<T>,
+    options?: FirestoreTypes.SetOptions
+  ) => Promise<FirestoreTypes.DocumentSnapshot<Partial<T>>>
 
   /**
    * Add document to firestore.
    * @see https://github.com/prescottprue/redux-firestore#add
    */
-  add: (
+  add: <T>(
     collectionPath: string | ReduxFirestoreQuerySetting,
-    data: Object
+    data: Partial<T>
   ) => Promise<{ id: string }>
 
   /**
    * Update document within firestore.
    * @see https://github.com/prescottprue/redux-firestore#update
    */
-  update: (
+  update: <T>(
     docPath: string | ReduxFirestoreQuerySetting,
-    data: Object
-  ) => Promise<void>
+    data: Partial<T>
+  ) => Promise<FirestoreTypes.DocumentSnapshot<Partial<T>>>
 
   /**
    * Delete a document within firestore.
    * @see https://github.com/prescottprue/redux-firestore#delete
    */
-  delete: (docPath: string | ReduxFirestoreQuerySetting) => Promise<void>
+  delete: <T>(docPath: string | ReduxFirestoreQuerySetting) => Promise<T>
 
   /**
    * Executes the given updateFunction and then attempts to commit the changes applied within the