Merge pull request #1 from Code-Hex/add/linter

added linter and prettier

Author: Code-Hex

.eslintignore

@@ -0,0 +1 @@
+dist

.eslintrc.js

@@ -0,0 +1,56 @@
+const { defineConfig } = require('eslint-define-config');
+
+module.exports = defineConfig({
+  root: true,
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2021,
+  },
+  plugins: ['@typescript-eslint', 'import'],
+  globals: {
+    fetch: false,
+    Response: false,
+    Request: false,
+    addEventListener: false,
+  },
+  rules: {
+    quotes: ['error', 'single'],
+    semi: ['error', 'never'],
+    'no-debugger': ['error'],
+    'no-empty': ['warn', { allowEmptyCatch: true }],
+    'no-process-exit': 'off',
+    'no-useless-escape': 'off',
+    'prefer-const': [
+      'warn',
+      {
+        destructuring: 'all',
+      },
+    ],
+    '@typescript-eslint/ban-types': [
+      'error',
+      {
+        types: {
+          Function: false,
+        },
+      },
+    ],
+    'sort-imports': 0,
+    'import/order': [2, { alphabetize: { order: 'asc' } }],
+
+    'node/no-missing-import': 'off',
+    'node/no-missing-require': 'off',
+    'node/no-deprecated-api': 'off',
+    'node/no-unpublished-import': 'off',
+    'node/no-unpublished-require': 'off',
+    'node/no-unsupported-features/es-syntax': 'off',
+
+    '@typescript-eslint/no-empty-function': ['error', { allow: ['arrowFunctions'] }],
+    '@typescript-eslint/no-empty-interface': 'off',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/consistent-type-imports': ['error', { prefer: 'type-imports' }],
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+});

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "printWidth": 120,
+  "singleQuote": true,
+  "arrowParens": "avoid"
+}

example/index.ts

@@ -1,53 +1,54 @@
-import { Auth, emulatorHost, EmulatorEnv, WorkersKVStoreSingle } from "../src";
+import type { EmulatorEnv } from '../src';
+import { Auth, emulatorHost, WorkersKVStoreSingle } from '../src';
 
 interface Bindings extends EmulatorEnv {
-  EMAIL_ADDRESS: string
-  PASSWORD: string
-  FIREBASE_AUTH_EMULATOR_HOST: string
-  PUBLIC_JWK_CACHE_KV: KVNamespace
-  PROJECT_ID: string
-  PUBLIC_JWK_CACHE_KEY: string
+  EMAIL_ADDRESS: string;
+  PASSWORD: string;
+  FIREBASE_AUTH_EMULATOR_HOST: string;
+  PUBLIC_JWK_CACHE_KV: KVNamespace;
+  PROJECT_ID: string;
+  PUBLIC_JWK_CACHE_KEY: string;
 }
 
-const signInPath = "/identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=test1234"
+const signInPath = '/identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=test1234';
 
 export async function handleRequest(req: Request, env: Bindings) {
-  const url = new URL(req.url)
-  const firebaseEmuHost = emulatorHost(env)
-  if (url.pathname === "/get-jwt" && !!firebaseEmuHost) {
-    const firebaseEmulatorSignInUrl = "http://" + firebaseEmuHost + signInPath
+  const url = new URL(req.url);
+  const firebaseEmuHost = emulatorHost(env);
+  if (url.pathname === '/get-jwt' && !!firebaseEmuHost) {
+    const firebaseEmulatorSignInUrl = 'http://' + firebaseEmuHost + signInPath;
     const resp = await fetch(firebaseEmulatorSignInUrl, {
-      method: "POST",
+      method: 'POST',
       body: JSON.stringify({
         email: env.EMAIL_ADDRESS,
         password: env.PASSWORD,
         returnSecureToken: true,
       }),
       headers: {
-        "Content-Type": "application/json"
-      }
-    })
-    return resp
+        'Content-Type': 'application/json',
+      },
+    });
+    return resp;
   }
 
-  const authorization = req.headers.get('Authorization')
+  const authorization = req.headers.get('Authorization');
   if (authorization === null) {
     return new Response(null, {
       status: 400,
-    })
+    });
   }
-  const jwt = authorization.replace(/Bearer\s+/i, "")
+  const jwt = authorization.replace(/Bearer\s+/i, '');
   const auth = Auth.getOrInitialize(
     env.PROJECT_ID,
     WorkersKVStoreSingle.getOrInitialize(env.PUBLIC_JWK_CACHE_KEY, env.PUBLIC_JWK_CACHE_KV)
-  )
-  const firebaseToken = await auth.verifyIdToken(jwt, env)
+  );
+  const firebaseToken = await auth.verifyIdToken(jwt, env);
 
   return new Response(JSON.stringify(firebaseToken), {
     headers: {
-      "Content-Type": "application/json"
-    }
-  })
+      'Content-Type': 'application/json',
+    },
+  });
 }
 
-export default { fetch: handleRequest };
+export default { fetch: handleRequest };

package.json

@@ -1,23 +1,47 @@
 {
   "name": "firebase-auth-cloudflare-workers",
   "version": "1.0.0",
-  "description": "firebase auth token verifier for Cloudflare Workers.",
-  "author": "Kei Kamikawa <code-hex@users.noreply.github.com>",
+  "description": "Zero-dependencies firebase auth library for Cloudflare Workers.",
+  "author": "codehex",
   "license": "MIT",
   "scripts": {
     "test": "jest",
     "start-firebase-emulator": "firebase emulators:start --project example-project12345",
-    "start-example": "wrangler dev example/index.ts  --config=example/wrangler.toml --local=true"
+    "start-example": "wrangler dev example/index.ts  --config=example/wrangler.toml --local=true",
+    "prettier": "prettier --write --list-different \"**/*.ts\"",
+    "prettier:check": "prettier --check \"**/*.ts\"",
+    "lint": "eslint --ext .ts .",
+    "lint-fix": "eslint --fix --ext .ts ."
   },
   "dependencies": {},
   "devDependencies": {
     "@cloudflare/workers-types": "^3.14.0",
     "@types/jest": "^28.1.3",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-define-config": "^1.5.1",
+    "eslint-import-resolver-typescript": "^3.2.4",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.26.0",
     "firebase-tools": "^11.2.0",
     "jest": "^28.1.2",
     "jest-environment-miniflare": "^2.5.1",
+    "prettier": "^2.7.1",
     "ts-jest": "^28.0.5",
     "typescript": "^4.7.4",
     "wrangler": "^2.0.16"
+  },
+  "keywords": [
+    "web",
+    "app",
+    "jwt",
+    "firebase",
+    "cloudflare",
+    "workers"
+  ],
+  "bugs": {
+    "url": "https://github.com/Code-Hex/firebase-auth-cloudflare-workers/issues"
   }
 }

src/auth.ts

@@ -1,23 +1,15 @@
-import { EmulatorEnv, useEmulator } from "./emulator";
-import { KeyStorer } from "./key-store";
-import {
-  createIdTokenVerifier,
-  FirebaseIdToken,
-  FirebaseTokenVerifier,
-} from "./token-verifier";
+import type { EmulatorEnv } from './emulator';
+import { useEmulator } from './emulator';
+import type { KeyStorer } from './key-store';
+import type { FirebaseIdToken, FirebaseTokenVerifier } from './token-verifier';
+import { createIdTokenVerifier } from './token-verifier';
 
 export class BaseAuth {
   /** @internal */
   protected readonly idTokenVerifier: FirebaseTokenVerifier;
 
-  constructor(
-    projectId: string,
-    keyStore: KeyStorer,
-  ) {
-    this.idTokenVerifier = createIdTokenVerifier(
-      projectId,
-      keyStore
-    );
+  constructor(projectId: string, keyStore: KeyStorer) {
+    this.idTokenVerifier = createIdTokenVerifier(projectId, keyStore);
   }
 
   /**

src/base64.ts

@@ -1,25 +1,25 @@
 export const decodeBase64Url = (str: string): Uint8Array => {
-  return decodeBase64(str.replace(/_|-/g, (m) => ({ _: "/", "-": "+" }[m]!)))
+  return decodeBase64(str.replace(/_|-/g, m => ({ _: '/', '-': '+' }[m] ?? m)));
 };
 
 export const encodeBase64Url = (buf: ArrayBufferLike): string =>
-  encodeBase64(buf).replace(/\/|\+/g, (m) => ({ "/": "_", "+": "-" }[m]!));
+  encodeBase64(buf).replace(/\/|\+/g, m => ({ '/': '_', '+': '-' }[m] ?? m));
 
 // This approach is written in MDN.
 // btoa does not support utf-8 characters. So we need a little bit hack.
 export const encodeBase64 = (buf: ArrayBufferLike): string => {
-  const binary = String.fromCharCode(...new Uint8Array(buf))
-  return btoa(binary)
-}
+  const binary = String.fromCharCode(...new Uint8Array(buf));
+  return btoa(binary);
+};
 
 // atob does not support utf-8 characters. So we need a little bit hack.
 const decodeBase64 = (str: string): Uint8Array => {
-  const binary = atob(str)
+  const binary = atob(str);
   const bytes = new Uint8Array(new ArrayBuffer(binary.length));
   const half = binary.length / 2;
   for (let i = 0, j = binary.length - 1; i <= half; i++, j--) {
     bytes[i] = binary.charCodeAt(i);
     bytes[j] = binary.charCodeAt(j);
   }
-  return bytes
-}
+  return bytes;
+};

src/emulator.ts

@@ -1,5 +1,5 @@
 export interface EmulatorEnv {
-  FIREBASE_AUTH_EMULATOR_HOST: string | undefined
+  FIREBASE_AUTH_EMULATOR_HOST: string | undefined;
 }
 
 export function emulatorHost(env?: EmulatorEnv): string | undefined {

src/errors.ts

@@ -16,54 +16,53 @@ export class JwtError extends Error {
  * JWT error codes.
  */
 export enum JwtErrorCode {
-  INVALID_ARGUMENT = "invalid-argument",
-  INVALID_CREDENTIAL = "invalid-credential",
-  TOKEN_EXPIRED = "token-expired",
-  INVALID_SIGNATURE = "invalid-token",
-  NO_MATCHING_KID = "no-matching-kid-error",
-  NO_KID_IN_HEADER = "no-kid-error",
-  KEY_FETCH_ERROR = "key-fetch-error",
+  INVALID_ARGUMENT = 'invalid-argument',
+  INVALID_CREDENTIAL = 'invalid-credential',
+  TOKEN_EXPIRED = 'token-expired',
+  INVALID_SIGNATURE = 'invalid-token',
+  NO_MATCHING_KID = 'no-matching-kid-error',
+  NO_KID_IN_HEADER = 'no-kid-error',
+  KEY_FETCH_ERROR = 'key-fetch-error',
 }
 
 /**
  * App client error codes and their default messages.
  */
 export class AppErrorCodes {
-  public static INVALID_CREDENTIAL = "invalid-credential";
+  public static INVALID_CREDENTIAL = 'invalid-credential';
 }
 
 /**
  * Auth client error codes and their default messages.
  */
 export class AuthClientErrorCode {
   public static INVALID_ARGUMENT = {
-    code: "argument-error",
-    message: "Invalid argument provided.",
+    code: 'argument-error',
+    message: 'Invalid argument provided.',
   };
   public static INVALID_CREDENTIAL = {
-    code: "invalid-credential",
-    message: "Invalid credential object provided.",
+    code: 'invalid-credential',
+    message: 'Invalid credential object provided.',
   };
   public static ID_TOKEN_EXPIRED = {
-    code: "id-token-expired",
-    message: "The provided Firebase ID token is expired.",
+    code: 'id-token-expired',
+    message: 'The provided Firebase ID token is expired.',
   };
   public static ID_TOKEN_REVOKED = {
-    code: "id-token-revoked",
-    message: "The Firebase ID token has been revoked.",
+    code: 'id-token-revoked',
+    message: 'The Firebase ID token has been revoked.',
   };
   public static INTERNAL_ERROR = {
-    code: "internal-error",
-    message: "An internal error has occurred.",
+    code: 'internal-error',
+    message: 'An internal error has occurred.',
   };
   public static USER_NOT_FOUND = {
-    code: "user-not-found",
-    message:
-      "There is no user record corresponding to the provided identifier.",
+    code: 'user-not-found',
+    message: 'There is no user record corresponding to the provided identifier.',
   };
   public static USER_DISABLED = {
-    code: "user-disabled",
-    message: "The user record is disabled.",
+    code: 'user-disabled',
+    message: 'The user record is disabled.',
   };
 }
 
@@ -197,7 +196,7 @@ export class PrefixedFirebaseError extends FirebaseError {
 export class FirebaseAuthError extends PrefixedFirebaseError {
   constructor(info: ErrorInfo, message?: string) {
     // Override default message if custom message provided.
-    super("auth", info.code, message || info.message);
+    super('auth', info.code, message || info.message);
 
     /* tslint:disable:max-line-length */
     // Set the prototype explicitly. See the following link for more details: