@doffy-gittix/common 1.0.0 → 1.0.2

package/package.json

@@ -1,13 +1,27 @@
 {
   "name": "@doffy-gittix/common",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
-  "main": "index.js",
+  "main": "./build/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "del-cli build && tsc",
+    "pub": "npm version patch && git add . && git commit -m \"[upd] common\" && git push && npm publish"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "type": "commonjs"
+  "type": "module",
+  "devDependencies": {
+    "del-cli": "^7.0.0",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "@types/express": "^5.0.6",
+    "@types/express-validator": "^2.20.33",
+    "@types/jsonwebtoken": "^9.0.10",
+    "express": "^5.2.1",
+    "express-validator": "^7.3.2",
+    "jsonwebtoken": "^9.0.3",
+    "ts-node": "^10.9.2"
+  }
 }

package/src/config.ts

@@ -0,0 +1,3 @@
+export const COOKIE_NAME = process.env.COOKIE_NAME;
+export const COOKIE_KEY = process.env.COOKIE_KEY;
+export const JWT_KEY = process.env.JWT_KEY;

package/src/errors/bad-request-error.ts

@@ -0,0 +1,14 @@
+import { BaseError } from './base-error.js'
+
+export class BadRequestError extends BaseError {
+  statusCode = 400;
+
+  constructor(message: string) {
+    super(message);
+    Object.setPrototypeOf(this, BadRequestError.prototype);
+  }
+
+  serialize() {
+    return [{ message: this.message }]
+  }
+}

package/src/errors/base-error.ts

@@ -0,0 +1,13 @@
+export abstract class BaseError extends Error {
+  abstract statusCode: number;
+
+  constructor(message: string) {
+    super(message);
+    Object.setPrototypeOf(this, BaseError.prototype);
+  }
+
+  abstract serialize(): {
+    message: string;
+    field?: string;
+  }[]
+}

package/src/errors/database-connection-error.ts

@@ -0,0 +1,14 @@
+import { BaseError } from './base-error.js'
+
+export class DatabaseConnectionError extends BaseError {
+  statusCode = 500;
+
+  constructor() {
+    super('database connection error');
+    Object.setPrototypeOf(this, DatabaseConnectionError.prototype);
+  }
+
+  serialize() {
+    return [{ message: 'database connection error' }]
+  }
+}

package/src/errors/index.ts

@@ -0,0 +1,6 @@
+export * from './base-error.js';
+export * from './request-validation-error.js';
+export * from './database-connection-error.js';
+export * from './notfound-error.js';
+export * from './bad-request-error.js';
+export * from './unauthorized_error.js';

package/src/errors/notfound-error.ts

@@ -0,0 +1,14 @@
+import { BaseError } from './base-error.js'
+
+export class NotFoundError extends BaseError {
+  statusCode = 404;
+
+  constructor() {
+    super('not found');
+    Object.setPrototypeOf(this, NotFoundError.prototype);
+  }
+
+  serialize() {
+    return [{ message: 'not found' }]
+  }
+}

package/src/errors/request-validation-error.ts

@@ -0,0 +1,23 @@
+import type { ValidationError } from 'express-validator';
+import { BaseError } from './base-error.js'
+
+export class RequestValidationError extends BaseError {
+  statusCode = 400;
+  errors: ValidationError[];
+  constructor(errors: ValidationError[]) {
+    super('validation error');
+    this.errors = errors;
+    Object.setPrototypeOf(this, RequestValidationError.prototype);
+  }
+
+  serialize() {
+    return this.errors.map((error) => {
+      return error.type === 'field'
+        ? {
+            message: error.msg as string,
+            field: error.path,
+          }
+        : { message: error.msg as string };
+    });
+  }
+}

package/src/errors/unauthorized_error.ts

@@ -0,0 +1,14 @@
+import { BaseError } from './base-error.js';
+
+export class UnauthorizedError extends BaseError {
+  statusCode = 401;
+
+  constructor() {
+    super('Unauthorized');
+    Object.setPrototypeOf(this, UnauthorizedError.prototype);
+  }
+
+  serialize() {
+    return [{ message: 'Unauthorized' }];
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './errors/index.js';
+export * from './middleware/index.js';

package/src/middleware/error-handler.ts

@@ -0,0 +1,14 @@
+import type { Request, Response, NextFunction } from 'express';
+import { BaseError } from '../errors/index.js';
+
+export const errorHandler = (
+  err: Error,
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => {
+  if (err instanceof BaseError) {
+    return res.status(err.statusCode).send({ errors: err.serialize() });
+  }
+  return res.status(400).send({ errors: [{ message: err.message }] });
+};

package/src/middleware/get-current-user-handler.ts

@@ -0,0 +1,35 @@
+import type { Request, Response, NextFunction } from 'express';
+import jwt from 'jsonwebtoken';
+import { COOKIE_NAME, JWT_KEY } from '../config.js';
+
+interface CurrentUser {
+  id: string;
+  email: string;
+}
+
+declare global {
+  namespace Express {
+    interface Request {
+      currentUser?: CurrentUser | null;
+    }
+  }
+}
+
+export const getCurrentUserHandler = (
+  req: Request & { session?: Record<string, string> },
+  _res: Response,
+  next: NextFunction,
+) => {
+  const token = req.session?.[COOKIE_NAME];
+  if (!token) {
+    req.currentUser = null;
+    return next();
+  }
+  try {
+    const verifiedUser = jwt.verify(token, JWT_KEY!) as CurrentUser;
+    req.currentUser = verifiedUser;
+  } catch (error) {
+    req.currentUser = null;
+  }
+  next();
+};

package/src/middleware/index.ts

@@ -0,0 +1,4 @@
+export * from './error-handler.js';
+export * from './get-current-user-handler.js';
+export * from './require-auth-handler.js';
+export * from './validation-handler.js';

package/src/middleware/require-auth-handler.ts

@@ -0,0 +1,13 @@
+import type { Request, Response, NextFunction } from 'express';
+import { UnauthorizedError } from '../errors/index.js';
+
+export const requireAuthHandler = (
+  req: Request,
+  _res: Response,
+  next: NextFunction,
+) => {
+  if (!req.currentUser) {
+    throw new UnauthorizedError();
+  }
+  next();
+};

package/src/middleware/validation-handler.ts

@@ -0,0 +1,15 @@
+import type { Request, Response, NextFunction } from 'express';
+import { validationResult } from 'express-validator';
+import { RequestValidationError } from '../errors/index.js';
+
+export const validationHandler = (
+  req: Request,
+  _res: Response,
+  next: NextFunction,
+) => {
+  const errors = validationResult(req);
+  if (!errors.isEmpty()) {
+    throw new RequestValidationError(errors.array());
+  }
+  next();
+};

package/tsconfig.json

@@ -0,0 +1,44 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./build",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}