Update dependencies and applications

.gitignore

@@ -8,3 +8,7 @@ firebase-debug.log
 
 public/admin/firebaseConfig.js
 \.firebase/
+
+
+**/.env.local
+**/*.log

README.md

@@ -48,9 +48,47 @@ with Firebase Auth. All users have the same rights, every authorized user is ess
 
 [API docs](/link-to-wiki)
 
+## Local Development
+If you have already installed firebase CLI, you should be able to use local firebase emulators.
+To use them, you need to setup your environment.
+```dotenv
+# functions/.env.local
+FIREBASE_AUTH_EMULATOR_HOST="localhost:9099"
+FIREBASE_DATABASE_EMULATOR_HOST="localhost:9000"
+FIREBASE_STORAGE_EMULATOR_HOST="localhost:9199"
+```
+This will setup functions emulator to redirect all requests to emulated enpoints.
+```javascript
+// public/admin/firebaseConfig.js
+
+//...
+/**
+ * This will connect to firebase emulators after app is initialized on localhost
+ */
+function enableEmulators(){
+	if(!firebase.app){
+		setTimeout(enableEmulators, 50)
+		return
+	}
+
+	if(location.hostname==="localhost"){
+		firebase.auth().useEmulator("http://localhost:9099");
+		firebase.database().useEmulator("localhost",9000)
+		firebase.functions().useEmulator("localhost", 5001);
+	}
+}
+
+setTimeout(enableEmulators, 50)
+```
+You can use this to connect to emulators on your client. This also means you **need** to create `public/admin/firebaseConfig.js`
+which contains `firebaseConfig`, that contains valid firebase configuration. ([example here](public/admin/firebaseConfig.sample.js))
+
+After everything is set up, you only need to start the emulators with `firebase emulators:start`. <br/>
+You can find more information on using firebase emulators [here](https://firebase.google.com/docs/emulator-suite).
+
 ## Planned features
 
  - [ ] tracking clicks on links (analytics), accessible via API
  - [ ] aliases for shortened urls (`short.url/my-event` -> `short.url/event` -> `some-very-long-url-address.com`)
  - [ ] simple UI for shortening URLs
- - [ ] support tokens (non Firebase Auth) for API authorization
+ - [ ] support tokens (non Firebase Auth) for API authorization

firebase.json

@@ -20,8 +20,7 @@
         ]
       },
       {
-        "source":
-        "**/*.@(jpg|jpeg|gif|png|svg|js|css|eot|otf|ttf|ttc|woff|font.css)",
+        "source": "**/*.@(jpg|jpeg|gif|png|svg|js|css|eot|otf|ttf|ttc|woff|font.css)",
         "headers": [
           {
             "key": "Cache-Control",
@@ -38,10 +37,28 @@
     ],
     "redirects": [
       {
-        "source" : "/",
-        "destination" : "https://techheaven.org",
-        "type" : 301
+        "source": "/",
+        "destination": "https://techheaven.org",
+        "type": 301
       }
     ]
+  },
+  "emulators": {
+    "auth": {
+      "port": 9099
+    },
+    "functions": {
+      "port": 5001
+    },
+    "database": {
+      "port": 9000
+    },
+    "hosting": {
+      "port": 5000
+    },
+    "ui": {
+      "enabled": true,
+      "port": 4000
+    }
   }
 }

functions/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+lib

functions/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+	root: true,
+	parser: "@typescript-eslint/parser",
+	plugins: [
+		"@typescript-eslint"
+	],
+	extends: [
+		"plugin:@typescript-eslint/recommended"
+	],
+	rules:{
+		"@typescript-eslint/ban-ts-comment": "off",
+		"@typescript-eslint/explicit-boundary-types": "off"
+	}
+}

functions/package.json

@@ -2,30 +2,37 @@
   "name": "functions",
   "description": "TypeScript sample Cloud Functions for Firebase",
   "dependencies": {
-    "@types/body-parser": "^1.16.8",
-    "@types/cookie-parser": "^1.4.1",
-    "@types/cors": "^2.8.3",
-    "body-parser": "^1.18.2",
+    "@types/body-parser": "^1.19.2",
+    "@types/cookie-parser": "^1.4.2",
+    "@types/cors": "^2.8.12",
+    "body-parser": "^1.19.1",
     "cookie-parser": "latest",
     "cors": "latest",
-    "express": "^4.16.2",
-    "express-validator": "^5.0.1",
-    "firebase-admin": "~5.5.0",
-    "firebase-functions": "^0.8.1"
+    "dotenv": "^16.0.0",
+    "express": "^4.17.2",
+    "express-validator": "^6.14.0",
+    "firebase-admin": "~10.0.2",
+    "firebase-functions": "^3.16.0"
   },
   "devDependencies": {
-    "@types/express": "^4.0.37",
-    "tslint": "^5.8.0",
-    "typescript": "^2.6.1"
+    "@types/express": "^4.17.13",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "eslint": "^8.8.0",
+    "typescript": "^4.5.5"
   },
   "scripts": {
-    "build": "./node_modules/.bin/tslint -p tslint.json && ./node_modules/.bin/tsc",
+    "lint": "eslint --fix --ext .ts,.js .",
+    "build": "yarn lint && tsc",
     "serve": "yarn run build && firebase serve --only functions",
     "shell": "yarn run build && firebase experimental:functions:shell",
     "start": "yarn run shell",
     "deploy": "yarn run build && firebase deploy --only functions",
     "logs": "firebase functions:log"
   },
   "main": "lib/index.js",
+  "engines": {
+    "node": "16"
+  },
   "private": true
 }

functions/src/RedirectHandler.ts

@@ -1,5 +1,5 @@
-import * as admin from "firebase-admin";
-import * as express from "express";
+import admin from "firebase-admin";
+import express from "express";
 
 class RedirectHandler {
 
@@ -68,4 +68,4 @@ class RedirectHandler {
 
 }
 
-export default RedirectHandler
+export default RedirectHandler

functions/src/api/Api.ts

@@ -1,9 +1,9 @@
-import * as express from 'express'
+import express from 'express'
 import ManagementApi from "./management/ManagementApi";
 import authorizeRequest from "./auth/FirebaseAuth";
 import {respondFailure} from "./util/ApiResponse";
-import * as bodyParser from "body-parser";
-import * as cors from "cors";
+import bodyParser from "body-parser";
+import cors from "cors";
 
 class Api {
 
@@ -45,4 +45,4 @@ class Api {
 
 const ApiInstance = new Api();
 
-export default ApiInstance
+export default ApiInstance

functions/src/api/Endpoint.ts

@@ -1,7 +1,7 @@
-import * as express from 'express'
+import express from 'express'
 
 interface Endpoint {
   register(router: express.Router)
 }
 
-export default Endpoint
+export default Endpoint

functions/src/api/EndpointGroup.ts

@@ -1,7 +1,7 @@
-import * as express from "express";
+import express from "express";
 
 interface EndpointGroup {
   setup(): express.Router
 }
 
-export default EndpointGroup
+export default EndpointGroup

functions/src/api/auth/FirebaseAuth.ts

@@ -1,4 +1,4 @@
-import * as admin from 'firebase-admin'
+import admin from 'firebase-admin'
 import {respondFailure} from "../util/ApiResponse";
 
 function checkIsAdmin(uid: string) {
@@ -49,4 +49,4 @@ const authorizeRequest = (req, res, next) => {
     });
 };
 
-export default authorizeRequest
+export default authorizeRequest

functions/src/api/management/ManagementApi.ts

@@ -1,4 +1,4 @@
-import * as express from 'express'
+import express from 'express'
 import EndpointGroup from "../EndpointGroup";
 import UrlEndpoint from "./UrlEndpoint";
 
@@ -17,4 +17,4 @@ class ManagementApi implements EndpointGroup {
 
 const instance = new ManagementApi();
 
-export default instance
+export default instance

functions/src/api/management/UrlEndpoint.ts

@@ -1,7 +1,7 @@
 import Endpoint from "../Endpoint";
-import * as express from 'express'
-import {checkSchema, validationResult} from "express-validator/check";
-import * as admin from "firebase-admin";
+import express from 'express'
+import {checkSchema, validationResult} from "express-validator";
+import admin from "firebase-admin";
 import {respondFailure, respondWith} from "../util/ApiResponse";
 
 class UrlEndpoint implements Endpoint {
@@ -124,10 +124,10 @@ class UrlEndpoint implements Endpoint {
             })
     }
 
-    private handleGetRequest(req: express.Request, res: express.Response) {
+    private handleGetRequest(_req: express.Request, _res: express.Response) {
         // todo
     }
 
 }
 
-export default UrlEndpoint
+export default UrlEndpoint

functions/src/api/util/ApiResponse.ts

@@ -1,6 +1,6 @@
-import * as express from 'express'
+import express from 'express'
 
-function respondWith(res: express.Response, body: any) {
+function respondWith(res: express.Response, body: unknown) {
     res.status(200);
     res.set('content-type', 'application/json');
     if (body !== undefined && body !== null) {
@@ -10,7 +10,7 @@ function respondWith(res: express.Response, body: any) {
     }
 }
 
-function respondFailure(res: express.Response, status: number, message: string, errors: any = null) {
+function respondFailure(res: express.Response, status: number, message: string, errors: unknown = null) {
     res.status(status);
     res.json({
         status: status,
@@ -19,4 +19,4 @@ function respondFailure(res: express.Response, status: number, message: string,
     });
 }
 
-export {respondWith, respondFailure}
+export {respondWith, respondFailure}

functions/src/index.ts

@@ -1,14 +1,12 @@
-'use strict';
-
 import * as functions from 'firebase-functions'
-import * as express from 'express'
-import * as admin from 'firebase-admin'
+import express from 'express'
+import admin from 'firebase-admin'
 import RedirectHandler from "./RedirectHandler";
 import Api from "./api/Api";
-import * as cookieParser from "cookie-parser";
+import cookieParser from "cookie-parser";
 
 // Initialize Firebase App
-admin.initializeApp(functions.config().firebase);
+admin.initializeApp();
 
 // Routing
 const app = express();
@@ -29,4 +27,4 @@ app.all("*", ((req, res) => {
   res.status(500);
 }));
 
-export const redirect = functions.https.onRequest(app);
+exports.redirect = functions.https.onRequest(app);

functions/tsconfig.json

@@ -1,14 +1,23 @@
 {
   "compilerOptions": {
-    "lib": ["es6"],
+    "lib": ["es6", "es2018", "es2017", "es2016"],
     "module": "commonjs",
     "noImplicitReturns": true,
     "outDir": "lib",
     "sourceMap": true,
-    "target": "es6"
+    "target": "es6",
+	"alwaysStrict": true,
+	"esModuleInterop": true,
+	"allowSyntheticDefaultImports": true,
+	"allowJs": true,
+	"checkJs": false
   },
   "compileOnSave": true,
   "include": [
     "src"
+  ],
+  "exclude": [
+	"node_modules"
   ]
+
 }