v1.4.4 (#155)

* fix(types): remove usage of `Function` type (instead provide function signature)
* chore(deps): update dev dependencies including eslint, @typescript-eslint and @firebase/testing
* chore(deps): add dependabot settings for automatic creation of dep update PRs
* chore(core): add github issue and PR templates
* chore(core): add .opensource folder for firebaseopensource.com

Author: prescottprue

.eslintrc.js

@@ -26,6 +26,7 @@ module.exports = {
   },
   rules: {
     '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
     'import/prefer-default-export': 0,
     'no-shadow': 0,
     'consistent-return': 0,

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+**Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+<!--
+1. Go to '...'
+1. Click on '....'
+1. Scroll down to '....'
+1. See error
+-->
+
+**Expected behavior/code**
+A clear and concise description of what you expected to happen (or code).
+
+**Possible Solution**
+
+<!--- Only if you have suggestions on a fix for the bug -->
+
+**Additional Context/Screenshots**
+
+<!-- Add any other context about the problem here. If applicable, add screenshots to help explain. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you'd like**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+### Description
+
+### Screenshots (if appropriate)

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# For for information on config options, visit docs:
+# https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule: 
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.opensource/project.json

@@ -0,0 +1,17 @@
+{
+  "name": "cypress-firebase",
+  "platforms": ["Web"],
+  "content": "README.md",
+  "related": [
+    "firebase/firebase-js-sdk",
+    "firebase/firebase-admin-node",
+    "cypress-io/cypress"
+  ],
+  "tabs": [
+    { "title": "NPM", "href": "https://npmjs.com/package/cypress-firebase" },
+    {
+      "title": "API Reference",
+      "href": "https://github.com/prescottprue/cypress-firebase/blob/master/README.md"
+    }
+  ]
+}

index.d.ts

@@ -335,7 +335,7 @@ declare module "plugin" {
      * @param adminInstance - firebase-admin instance
      * @returns Extended Cypress config
      */
-    export default function pluginWithTasks(cypressOnFunc: Function, cypressConfig: any, adminInstance: any): ExtendedCypressConfig;
+    export default function pluginWithTasks(cypressOnFunc: any, cypressConfig: any, adminInstance: any): ExtendedCypressConfig;
 }
 declare module "index" {
     import attachCustomCommands from "attachCustomCommands";

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-firebase",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "description": "Utilities to help testing Firebase projects with Cypress.",
   "main": "lib/index.js",
   "module": "lib/index.js",
@@ -29,37 +29,37 @@
     "firebase-admin": "^8 || ^9"
   },
   "devDependencies": {
-    "@firebase/testing": "^0.20.9",
+    "@firebase/testing": "^0.20.11",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@size-limit/preset-small-lib": "^4.5.5",
-    "@types/chai": "^4.2.11",
-    "@types/mocha": "^8.0.0",
-    "@types/node": "^14.0.24",
+    "@size-limit/preset-small-lib": "^4.5.6",
+    "@types/chai": "^4.2.12",
+    "@types/mocha": "^8.0.2",
+    "@types/node": "^14.0.27",
     "@types/sinon-chai": "^3.2.4",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/parser": "^2.34.0",
+    "@typescript-eslint/eslint-plugin": "^3.9.0",
+    "@typescript-eslint/parser": "^3.9.0",
     "chai": "^4.2.0",
-    "eslint": "^7.5.0",
+    "eslint": "^7.7.0",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-babel": "^5.3.0",
+    "eslint-plugin-babel": "^5.3.1",
     "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-jsdoc": "^30.0.3",
+    "eslint-plugin-jsdoc": "^30.2.2",
     "eslint-plugin-jsx-a11y": "^6.3.1",
-    "eslint-plugin-prettier": "^3.1.3",
-    "firebase-admin": "^9.0.0",
-    "firebase-tools": "^8.6.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "firebase-admin": "^9.1.0",
+    "firebase-tools": "^8.7.0",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.11",
-    "mocha": "^8.0.1",
+    "mocha": "^8.1.1",
     "nyc": "^15.1.0",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.2",
-    "sinon": "^9.0.2",
+    "sinon": "^9.0.3",
     "sinon-chai": "^3.5.0",
-    "size-limit": "^4.5.5",
+    "size-limit": "^4.5.6",
     "source-map-support": "^0.5.19",
-    "ts-node": "^8.10.1",
+    "ts-node": "^8.10.2",
     "typescript": "^3.9.7"
   },
   "keywords": [

src/attachCustomCommands.ts

@@ -322,7 +322,7 @@ export default function attachCustomCommands(
   Cypress.Commands.add(
     options?.commandNames?.logout || 'logout',
     (): Promise<any> => {
-      return new Promise((resolve: Function, reject: Function): any => {
+      return new Promise((resolve: () => any, reject: () => any): any => {
         firebase.auth().onAuthStateChanged((auth: any) => {
           if (!auth) {
             resolve();

src/firebase-utils.ts

@@ -60,7 +60,7 @@ export function initializeFirebase(adminInstance: any): admin.app.App {
         process.env.GCLOUD_PROJECT ||
         process.env.FIREBASE_PROJECT ||
         process.env.FIREBASE_PROJECT_ID ||
-        serviceAccount?.project_id;
+        serviceAccount?.project_id; // eslint-disable-line camelcase
       const fbConfig: any = {
         projectId,
       };
@@ -101,7 +101,7 @@ export function initializeFirebase(adminInstance: any): admin.app.App {
       // Get service account from local file falling back to environment variables
       const serviceAccount = getServiceAccount();
       const projectId =
-        process.env.GCLOUD_PROJECT || serviceAccount?.project_id;
+        process.env.GCLOUD_PROJECT || serviceAccount?.project_id; // eslint-disable-line camelcase
       if (!isString(projectId)) {
         const missingProjectIdErr =
           'Error GCLOUD_PROJECT environment variable or project_id from service account to initialize Firebase.';
@@ -219,7 +219,7 @@ export function slashPathToFirestoreRef(
 function deleteQueryBatch(
   db: any,
   query: admin.firestore.CollectionReference,
-  resolve: Function,
+  resolve: () => any,
   reject: any,
 ): void {
   query

src/node-utils.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/camelcase */
 import { existsSync, readFileSync } from 'fs';
 
 /**
@@ -97,6 +96,7 @@ function envVarBasedOnCIEnv(varNameRoot: string, envName?: string): any {
   return process.env[combined] || process.env[varNameRoot];
 }
 
+/* eslint-disable camelcase */
 interface ServiceAccount {
   type: string;
   project_id: string;
@@ -109,6 +109,7 @@ interface ServiceAccount {
   auth_provider_x509_cert_url: string;
   client_x509_cert_url: string;
 }
+/* eslint-enable camelcase */
 
 /**
  * Get service account from either local file or environment variables

src/plugin.ts

@@ -11,7 +11,7 @@ import { initializeFirebase } from './firebase-utils';
  * @returns Extended Cypress config
  */
 export default function pluginWithTasks(
-  cypressOnFunc: Function,
+  cypressOnFunc: any,
   cypressConfig: any,
   adminInstance: any,
 ): ExtendedCypressConfig {
@@ -21,7 +21,7 @@ export default function pluginWithTasks(
   }
   // Parse single argument from task into arguments for task methods while
   // also passing the admin instance
-  const tasksWithFirebase: Record<string, Function> = {};
+  const tasksWithFirebase: Record<string, (taskSettings: any) => any> = {};
   Object.keys(tasks).forEach((taskName) => {
     tasksWithFirebase[taskName] = (taskSettings: any): any => {
       if (taskSettings?.uid) {

src/tasks.ts

@@ -68,7 +68,7 @@ function convertValueToTimestampIfPossible(
 function getDataWithTimestamps(
   data: admin.firestore.DocumentData,
   firestoreStatics: typeof admin.firestore,
-): object {
+): Record<string, any> {
   // Exit if no statics are passed
   if (!firestoreStatics) {
     return data;