common-types npm local module

Author: Resul Avan

.circleci/config.yml

@@ -6,6 +6,12 @@ jobs:
       - image: circleci/node:10.16.3
     steps:
       - checkout
+      - run:
+          name: Install commons-types dependencies
+          command: npm --prefix functions commons-types
+      - run:
+          name: Build commons-types
+          command: npm --prefix functions run build
       - run:
           name: Add .env
           command: |

.gitignore

@@ -101,8 +101,10 @@ firebase-debug.log
 **/*.log
 node_modules
 
+# modules
+*/lib
+
 # firebase
-functions/lib
 functions/nuxt.config.ts
 public
 firebase-admin-credentials.json

common-types/tsconfig-cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "./lib/cjs"
+  }
+}

common-types/tslint.json

@@ -0,0 +1,115 @@
+{
+  "rules": {
+    // -- Strict errors --
+    // These lint rules are likely always a good idea.
+
+    // Force function overloads to be declared together. This ensures readers understand APIs.
+    "adjacent-overload-signatures": true,
+
+    // Do not allow the subtle/obscure comma operator.
+    "ban-comma-operator": true,
+
+    // Do not allow internal modules or namespaces . These are deprecated in favor of ES6 modules.
+    "no-namespace": true,
+
+    // Do not allow parameters to be reassigned. To avoid bugs, developers should instead assign new values to new vars.
+    "no-parameter-reassignment": true,
+
+    // Force the use of ES6-style imports instead of /// <reference path=> imports.
+    "no-reference": true,
+
+    // Do not allow type assertions that do nothing. This is a big warning that the developer may not understand the
+    // code currently being edited (they may be incorrectly handling a different type case that does not exist).
+    "no-unnecessary-type-assertion": true,
+
+    // Disallow nonsensical label usage.
+    "label-position": true,
+
+    // Disallows the (often typo) syntax if (var1 = var2). Replace with if (var2) { var1 = var2 }.
+    "no-conditional-assignment": true,
+
+    // Disallows constructors for primitive types (e.g. new Number('123'), though Number('123') is still allowed).
+    "no-construct": true,
+
+    // Do not allow super() to be called twice in a constructor.
+    "no-duplicate-super": true,
+
+    // Do not allow the same case to appear more than once in a switch block.
+    "no-duplicate-switch-case": true,
+
+    // Do not allow a variable to be declared more than once in the same block. Consider function parameters in this
+    // rule.
+    "no-duplicate-variable": [true, "check-parameters"],
+
+    // Disallows a variable definition in an inner scope from shadowing a variable in an outer scope. Developers should
+    // instead use a separate variable name.
+    "no-shadowed-variable": true,
+
+    // Empty blocks are almost never needed. Allow the one general exception: empty catch blocks.
+    "no-empty": [true, "allow-empty-catch"],
+
+    // Functions must either be handled directly (e.g. with a catch() handler) or returned to another function.
+    // This is a major source of errors in Cloud Functions and the team strongly recommends leaving this rule on.
+    "no-floating-promises": true,
+
+    // Do not allow any imports for modules that are not in package.json. These will almost certainly fail when
+    // deployed.
+    "no-implicit-dependencies": true,
+
+    // The 'this' keyword can only be used inside of classes.
+    "no-invalid-this": true,
+
+    // Do not allow strings to be thrown because they will not include stack traces. Throw Errors instead.
+    "no-string-throw": true,
+
+    // Disallow control flow statements, such as return, continue, break, and throw in finally blocks.
+    "no-unsafe-finally": true,
+
+    // Expressions must always return a value. Avoids common errors like const myValue = functionReturningVoid();
+    "no-void-expression": [true, "ignore-arrow-function-shorthand"],
+
+    // Disallow duplicate imports in the same file.
+    "no-duplicate-imports": true,
+
+
+    // -- Strong Warnings --
+    // These rules should almost never be needed, but may be included due to legacy code.
+    // They are left as a warning to avoid frustration with blocked deploys when the developer
+    // understand the warning and wants to deploy anyway.
+
+    // Warn when an empty interface is defined. These are generally not useful.
+    "no-empty-interface": {"severity": "warning"},
+
+    // Warn when an import will have side effects.
+    "no-import-side-effect": {"severity": "warning"},
+
+    // Warn when variables are defined with var. Var has subtle meaning that can lead to bugs. Strongly prefer const for
+    // most values and let for values that will change.
+    "no-var-keyword": {"severity": "warning"},
+
+    // Prefer === and !== over == and !=. The latter operators support overloads that are often accidental.
+    "triple-equals": {"severity": "warning"},
+
+    // Warn when using deprecated APIs.
+    "deprecation": {"severity": "warning"},
+
+    // -- Light Warnings --
+    // These rules are intended to help developers use better style. Simpler code has fewer bugs. These would be "info"
+    // if TSLint supported such a level.
+
+    // prefer for( ... of ... ) to an index loop when the index is only used to fetch an object from an array.
+    // (Even better: check out utils like .map if transforming an array!)
+    "prefer-for-of": {"severity": "warning"},
+
+    // Warns if function overloads could be unified into a single function with optional or rest parameters.
+    "unified-signatures": {"severity": "warning"},
+
+    // Prefer const for values that will not change. This better documents code.
+    "prefer-const": {"severity": "warning"},
+
+    // Multi-line object literals and function calls should have a trailing comma. This helps avoid merge conflicts.
+    "trailing-comma": {"severity": "warning"}
+  },
+
+  "defaultSeverity": "error"
+}

functions/package.json

@@ -25,6 +25,7 @@
     "body-parser": "^1.19.0",
     "buefy": "^0.8.20",
     "bulma-helpers": "^0.3.12",
+    "common-types": "file:../common-types",
     "cookie-parser": "^1.4.5",
     "cookie-universal-nuxt": "^2.1.4",
     "cors": "^2.8.5",

functions/src/api/api-handler.ts

@@ -1,7 +1,6 @@
 import { NextFunction, Request, RequestHandler, Response } from 'express'
 import { OK } from 'http-status-codes'
 import admin from 'firebase-admin'
-import { ApiErrorCode } from '../types'
 import {
   extractHeadersFromRequest,
   getTokenFromRequest,
@@ -10,6 +9,7 @@ import {
 } from '../service/request-handler-service';
 import { getDecodedIdToken } from '../service/firebase-admin-service'
 import DecodedIdToken = admin.auth.DecodedIdToken
+import { ApiErrorCode } from 'common-types'
 
 export const extractHeaderHandler: RequestHandler = async (req: Request, res: Response, next: NextFunction) => {
   await extractHeadersFromRequest(req)

functions/src/api/auth-handler.ts

@@ -1,7 +1,7 @@
 import { RequestHandler } from 'express'
 import { NO_CONTENT, OK } from 'http-status-codes'
 import { setCustomClaims, toAuthUser, validateClaimsAndGet } from '../service/firebase-admin-service'
-import { ApiErrorCode, FirebaseClaimKey, FirebaseClaims } from '../types'
+import { ApiErrorCode, FirebaseClaimKey, FirebaseClaims } from 'common-types'
 import {
   getDecodedIdTokenFromRequest,
   handleApiErrors,

functions/src/api/index.ts

@@ -3,7 +3,7 @@ import cookieParser from 'cookie-parser'
 import { json } from 'body-parser'
 import cors from 'cors'
 import { RuntimeOptions, runWith } from 'firebase-functions'
-import { ApiConfig } from '../types';
+import { ApiConfig } from 'common-types';
 import { claimsHandler, verifyHandler } from './auth-handler'
 import { extractHeaderHandler, healthyHandler, tokenHandler } from './api-handler'
 import { notifyHandler } from './notification-handler'

functions/src/api/notification-handler.ts

@@ -7,7 +7,7 @@ import {
   handlerCalledLog,
   handlerLog
 } from '../service/request-handler-service'
-import { ApiErrorCode, UserDevice } from '../types'
+import { ApiErrorCode, UserDevice } from 'common-types'
 import { deleteUserDevice, getPushNotification, getUserDevices } from '../service/firebase-admin-service'
 import DecodedIdToken = admin.auth.DecodedIdToken
 

functions/src/service/firebase-admin-service.ts

@@ -11,7 +11,7 @@ import {
   User,
   UserDevice,
   WhereClause
-} from '../types'
+} from 'common-types'
 import { deleteModel, getModelById, getModelsByWhereClauses } from './firestore-admin-collection-service'
 import DecodedIdToken = admin.auth.DecodedIdToken