@alanszp/express 12.0.2 → 13.0.0

package/src/middlewares/createContext.ts

@@ -1,49 +0,0 @@
-import { createId } from "@paralleldrive/cuid2";
-import { NextFunction, Response } from "express";
-import { ILogger } from "@alanszp/logger";
-import { Audit } from "@alanszp/audit";
-import { appIdentifier } from "@alanszp/core";
-import { GenericRequest } from "../types/GenericRequest";
-import { SharedContext } from "@alanszp/shared-context";
-import { compact } from "lodash";
-
-export function createContext(
-  sharedContext: SharedContext,
-  baseLogger: ILogger,
-  audit: Audit
-) {
-  return (req: GenericRequest, res: Response, next: NextFunction): void => {
-    req.context = req.context || {};
-
-    const receivedChain =
-      req.header("x-lifecycle-chain") || req.body?.detail?.lch;
-    const lifecycleChain = compact([receivedChain, appIdentifier()]).join(",");
-
-    const lifecycleId =
-      req.header("x-lifecycle-id") || req.body?.detail?.lid || createId();
-
-    const contextId = createId();
-
-    res.setHeader("x-lifecycle-id", lifecycleId);
-    res.setHeader("x-context-id", contextId);
-
-    sharedContext.run(
-      (context) => {
-        req.context.authenticated = [];
-        req.context.lifecycleId = context.lifecycleId;
-        req.context.lifecycleChain = context.lifecycleChain;
-        req.context.contextId = context.contextId;
-        req.context.log = context.logger;
-        req.context.audit = context.audit;
-        next();
-      },
-      {
-        logger: baseLogger,
-        audit: audit.withState(),
-        lifecycleId,
-        lifecycleChain,
-        contextId,
-      }
-    );
-  };
-}

package/src/middlewares/hasRoles.ts

@@ -1,24 +0,0 @@
-import { NextFunction, Response } from "express";
-import { GenericRequest } from "../types/GenericRequest";
-import { render401Error } from "../helpers/renderErrorJson";
-
-function response401(res: Response): void {
-  res.status(401).json(render401Error(["permissions"]));
-}
-
-export function hasRoles(
-  roles: string | string[]
-): (req: GenericRequest, res: Response, next: NextFunction) => void {
-  return (req: GenericRequest, res: Response, next: NextFunction) => {
-    const { jwtUser } = req.context;
-    if (!jwtUser) {
-      return response401(res);
-    }
-
-    if (jwtUser.hasRoles(roles)) {
-      return next();
-    }
-
-    response401(res);
-  };
-}

package/src/middlewares/jsonBodyParser.ts

@@ -1,22 +0,0 @@
-import { json, OptionsJson } from "body-parser";
-import { NextFunction, Response } from "express";
-import { GenericRequest } from "../types/GenericRequest";
-import { render400Error } from "../helpers/renderErrorJson";
-
-export function jsonBodyParser(options?: OptionsJson) {
-  const bodyParser = json({ limit: "1mb", ...options });
-  return function jsonBodyParserMiddleware(
-    req: GenericRequest,
-    res: Response,
-    next: NextFunction
-  ): void {
-    try {
-      bodyParser(req, res, (error?: unknown) => {
-        if (!error) return next();
-        res.status(400).json(render400Error("Malformed JSON"));
-      });
-    } catch (error: unknown) {
-      res.status(400).json(render400Error("Malformed JSON"));
-    }
-  };
-}

package/src/middlewares/returnInternalServerError.ts

@@ -1,15 +0,0 @@
-import { ErrorRequestHandler, NextFunction, Response } from "express";
-import { InternalServerError } from "@alanszp/errors";
-import { GenericRequest } from "../types/GenericRequest";
-import { ILogger } from "@alanszp/logger";
-
-export type GetInternalServerErrorMiddleware = (
-  getLogger: () => ILogger
-) => ErrorRequestHandler;
-
-export const returnInternalServerError: GetInternalServerErrorMiddleware =
-  (getLogger: () => ILogger) =>
-  (error: unknown, req: GenericRequest, res: Response, _next: NextFunction) => {
-    res.status(500).json(new InternalServerError(error).toView());
-    getLogger().error("error_to_client", { error });
-  };

package/src/middlewares/returnNotFound.ts

@@ -1,11 +0,0 @@
-import { NextFunction, Response } from "express";
-import { GenericRequest } from "../types/GenericRequest";
-import { render404Error } from "../helpers/renderErrorJson";
-
-export function returnNotFound(
-  _req: GenericRequest,
-  res: Response,
-  _next: NextFunction
-): void {
-  res.status(404).json(render404Error());
-}

package/src/test/mocks/authOptionsMocks.ts

@@ -1,35 +0,0 @@
-import {
-  ApiKeyOptions,
-  AuthMethods,
-  BothMethodsOptions,
-  JWTOptions,
-} from "../../middlewares/authenticateUser";
-
-export const jwtAuthOptions = {
-  jwtVerifyOptions: {
-    publicKey: "publicKey",
-    issuer: "issuer",
-    audience: "audience",
-  },
-  types: [AuthMethods.JWT],
-} as any as JWTOptions;
-
-export const verifyOptions = {
-  issuer: "issuer",
-  audience: "audience",
-};
-
-export const apiKeyAuthOptions: ApiKeyOptions = {
-  validApiKeys: ["token", "tooooken"],
-  types: [AuthMethods.API_KEY],
-};
-
-export const bothMethodsAuthOptions: BothMethodsOptions = {
-  jwtVerifyOptions: {
-    publicKey: "publicKey",
-    issuer: "issuer",
-    audience: "audience",
-  },
-  validApiKeys: ["token", "tooooken"],
-  types: [AuthMethods.API_KEY, AuthMethods.JWT],
-};

package/src/test/mocks/expressMocks.ts

@@ -1,33 +0,0 @@
-import { GenericRequest } from "../../types/GenericRequest";
-
-export const mockRequest = (
-  authorization: string,
-  otherHeaders?: Record<string, unknown>
-): GenericRequest => {
-  const headers = { authorization, ...otherHeaders };
-  return {
-    headers,
-    context: { jwtUser: undefined, authenticated: [] },
-    header: (name: string) => headers[name],
-  } as any as GenericRequest;
-};
-
-export const mockRequestWithBody = (
-  authorization: string,
-  otherHeaders?: Record<string, unknown>,
-  body: Record<string, unknown> = {}
-): GenericRequest => {
-  return {
-    ...mockRequest(authorization, otherHeaders),
-    body,
-  } as any as GenericRequest;
-};
-
-export const mockResponse = () => {
-  const res = {} as any;
-  res.status = jest.fn().mockReturnValue(res);
-  res.json = jest.fn().mockReturnValue(res);
-  return res;
-};
-
-export const mockNext = () => jest.fn();

package/src/test/mocks/jwtUserMocks.ts

@@ -1,19 +0,0 @@
-import { JWTUser } from "@alanszp/jwt";
-
-export const userJwtUserMock: JWTUser = new JWTUser({
-  id: "1",
-  employeeReference: "1",
-  organizationReference: "test",
-  roles: [],
-  permissions: "MA==",
-  segmentReference: null,
-});
-
-export const laraJwtUserMock: JWTUser = new JWTUser({
-  id: "0",
-  employeeReference: "0",
-  organizationReference: "lara",
-  roles: [],
-  permissions: "MA==",
-  segmentReference: null,
-});

package/src/test/setup.test.ts

@@ -1,15 +0,0 @@
-import { now } from "../helpers/now";
-
-jest.mock("@/helpers/now");
-
-describe("Timezones", () => {
-  it("should always be UTC", () => {
-    expect(new Date().getTimezoneOffset()).toBe(0);
-  });
-
-  it("now() is mocked", () => {
-    (now as jest.Mock).mockReturnValue(new Date("2021-01-01T12:30:43"));
-
-    expect(now()).toEqual(new Date("2021-01-01T12:30:43"));
-  });
-});

package/src/test/setup.ts

@@ -1,3 +0,0 @@
-import { config } from "dotenv";
-
-config({ path: ".env.test" });

package/src/types/AuthMethod.ts

@@ -1,27 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type DistributiveOmit<T, K extends keyof any> = T extends any
-  ? Omit<T, K>
-  : never;
-
-export type Overwrite<T, U> = DistributiveOmit<T, keyof U> & U;
-
-type GenerateStringUnion<T> = Extract<
-  {
-    [Key in keyof T]: true extends T[Key] ? Key : never;
-  }[keyof T],
-  string
->;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type OverridableStringUnion<
-  T extends string | number,
-  U = {}
-> = GenerateStringUnion<Overwrite<Record<T, true>, U>>;
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface AuthMethodsOverride {}
-
-export type AuthMethod = OverridableStringUnion<
-  "jwt" | "api_key",
-  AuthMethodsOverride
->;

package/src/types/GenericRequest.ts

@@ -1,3 +0,0 @@
-import { Request } from "express";
-
-export type GenericRequest = Request<any, any, any, any>;

package/src/types/custom.d.ts

@@ -1,20 +0,0 @@
-import { ILogger } from "@alanszp/logger";
-import { AuditWithState } from "@alanszp/audit";
-import { JWTUser } from "@alanszp/jwt";
-import { AuthMethod } from "./AuthMethod";
-
-declare global {
-  namespace Express {
-    export interface Request {
-      context: {
-        lifecycleId: string;
-        lifecycleChain: string;
-        contextId: string;
-        authenticated: AuthMethod[];
-        log: ILogger;
-        audit: AuditWithState;
-        jwtUser?: JWTUser;
-      };
-    }
-  }
-}