node-server-engine 1.1.1 → 1.1.3

package/src/middleware/authJwt/authJwt.test.ts

@@ -1,54 +1,54 @@
-import { factory, getBearer } from 'backend-test-tools';
-import { expect } from 'chai';
-import { Request, Response } from 'express';
-import { faker } from '@faker-js/faker';
-import { fake } from 'sinon';
-import { authJwt } from './authJwt';
-
-describe('Middleware - Auth JWT', () => {
-  it('should authenticate with a JWT (auth-service)', async () => {
-    const user = factory.build('user');
-    const request = { headers: { authorization: getBearer(user.id) } };
-    const next = fake();
-
-    await authJwt()(request as Request, undefined as unknown as Response, next);
-
-    expect(next).to.have.been.calledOnceWithExactly();
-  });
-
-  it('should populate the user object in the request (auth-service)', async () => {
-    const user = factory.build('user');
-    const request = {
-      headers: { authorization: getBearer(user.id) }
-    } as Request;
-    const next = fake();
-
-    await authJwt()(request, undefined as unknown as Response, next);
-
-    expect(request.user).to.not.be.undefined;
-    expect(request.user?.id).to.equal(user.id);
-  });
-
-  it('should throw an error if there is no token', async () => {
-    const request = { headers: {} };
-    const next = fake();
-
-    await expect(
-      authJwt()(request as Request, undefined as unknown as Response, next)
-    ).to.eventually.rejected;
-  });
-
-  it('should throw an error if the audience is not valid', async () => {
-    const user = factory.build('user');
-    const request = {
-      headers: {
-        authorization: getBearer(user.id, { audience: faker.internet.url() })
-      }
-    };
-    const next = fake();
-
-    await expect(
-      authJwt()(request as Request, undefined as unknown as Response, next)
-    ).to.eventually.rejected;
-  });
-});
+import { factory, getBearer } from 'backend-test-tools';
+import { expect } from 'chai';
+import { Request, Response } from 'express';
+import { faker } from '@faker-js/faker';
+import { fake } from 'sinon';
+import { authJwt } from './authJwt';
+
+describe('Middleware - Auth JWT', () => {
+  it('should authenticate with a JWT (auth-service)', async () => {
+    const user = factory.build('user');
+    const request = { headers: { authorization: getBearer(user.id) } };
+    const next = fake();
+
+    await authJwt()(request as Request, undefined as unknown as Response, next);
+
+    expect(next).to.have.been.calledOnceWithExactly();
+  });
+
+  it('should populate the user object in the request (auth-service)', async () => {
+    const user = factory.build('user');
+    const request = {
+      headers: { authorization: getBearer(user.id) }
+    } as Request;
+    const next = fake();
+
+    await authJwt()(request, undefined as unknown as Response, next);
+
+    expect(request.user).to.not.be.undefined;
+    expect(request.user?.id).to.equal(user.id);
+  });
+
+  it('should throw an error if there is no token', async () => {
+    const request = { headers: {} };
+    const next = fake();
+
+    await expect(
+      authJwt()(request as Request, undefined as unknown as Response, next)
+    ).to.eventually.rejected;
+  });
+
+  it('should throw an error if the audience is not valid', async () => {
+    const user = factory.build('user');
+    const request = {
+      headers: {
+        authorization: getBearer(user.id, { audience: faker.internet.url() })
+      }
+    };
+    const next = fake();
+
+    await expect(
+      authJwt()(request as Request, undefined as unknown as Response, next)
+    ).to.eventually.rejected;
+  });
+});

package/src/middleware/authJwt/authJwt.ts

@@ -1,55 +1,55 @@
-import { Request, Response, NextFunction } from 'express';
-import { TokenIssuer } from 'const';
-import { EngineError } from 'entities/EngineError';
-import { WebError } from 'entities/WebError';
-import { jwtVerify } from 'utils/jwt';
-import { reportDebug } from 'utils/report';
-import {} from './authJwt.types';
-
-const namespace = 'engine:middleware:authJwt';
-
-/** Generate a middleware to authenticate the client connection with a JWT */
-export function authJwt(): (
-  request: Request,
-  response: Response,
-  next: NextFunction
-) => Promise<void> {
-  if (!process.env.ACCESS_TOKEN_AUDIENCE)
-    throw new EngineError({
-      message: 'Env variable ACCESS_TOKEN_AUDIENCE is not defined'
-    });
-
-  return async (
-    request: Request,
-    response: Response,
-    next: NextFunction
-  ): Promise<void> => {
-    const [scheme, credentials] =
-      request.headers?.authorization?.split(' ') ?? [];
-    // No bearer token has been sent
-    if (!credentials || scheme.toLowerCase() !== 'bearer') {
-      throw new WebError({
-        message: 'No bearer token found',
-        errorCode: 'unauthorized',
-        statusCode: 401,
-        data: { authorization: request.headers?.authorization }
-      });
-    }
-    reportDebug({
-      namespace,
-      message: 'Performing JWT authentication',
-      data: { scheme, credentials }
-    });
-    // Verify token and extract its payload
-    const payload = await jwtVerify(credentials, TokenIssuer.AUTH_SERVICE);
-    reportDebug({
-      namespace,
-      message: 'Extracted user data from JWT',
-      data: { payload, credentials }
-    });
-    // The user object on the request is hydrated with data from the token
-    request.user = payload.user;
-
-    next();
-  };
-}
+import { Request, Response, NextFunction } from 'express';
+import { TokenIssuer } from 'const';
+import { EngineError } from 'entities/EngineError';
+import { WebError } from 'entities/WebError';
+import { jwtVerify } from 'utils/jwt';
+import { reportDebug } from 'utils/report';
+import {} from './authJwt.types';
+
+const namespace = 'engine:middleware:authJwt';
+
+/** Generate a middleware to authenticate the client connection with a JWT */
+export function authJwt(): (
+  request: Request,
+  response: Response,
+  next: NextFunction
+) => Promise<void> {
+  if (!process.env.ACCESS_TOKEN_AUDIENCE)
+    throw new EngineError({
+      message: 'Env variable ACCESS_TOKEN_AUDIENCE is not defined'
+    });
+
+  return async (
+    request: Request,
+    response: Response,
+    next: NextFunction
+  ): Promise<void> => {
+    const [scheme, credentials] =
+      request.headers?.authorization?.split(' ') ?? [];
+    // No bearer token has been sent
+    if (!credentials || scheme.toLowerCase() !== 'bearer') {
+      throw new WebError({
+        message: 'No bearer token found',
+        errorCode: 'unauthorized',
+        statusCode: 401,
+        data: { authorization: request.headers?.authorization }
+      });
+    }
+    reportDebug({
+      namespace,
+      message: 'Performing JWT authentication',
+      data: { scheme, credentials }
+    });
+    // Verify token and extract its payload
+    const payload = await jwtVerify(credentials, TokenIssuer.AUTH_SERVICE);
+    reportDebug({
+      namespace,
+      message: 'Extracted user data from JWT',
+      data: { payload, credentials }
+    });
+    // The user object on the request is hydrated with data from the token
+    request.user = payload.user;
+
+    next();
+  };
+}

package/src/middleware/authJwt/authJwt.types.ts

@@ -1,14 +1,14 @@
-export {};
-
-// Override the Express request object to add the files
-declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace Express {
-    /** Express request object */
-    interface Request {
-      /** User that identified using a JWT */
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      user?: Record<string, any>;
-    }
-  }
-}
+export {};
+
+// Override the Express request object to add the files
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Express {
+    /** Express request object */
+    interface Request {
+      /** User that identified using a JWT */
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      user?: Record<string, any>;
+    }
+  }
+}

package/src/middleware/authJwt/index.ts

@@ -1,2 +1,2 @@
-export * from './authJwt';
-export * from './authJwt.types';
+export * from './authJwt';
+export * from './authJwt.types';

package/src/middleware/authStatic/authStatic.test.ts

@@ -1,36 +1,36 @@
-import { expect } from 'chai';
-import { Request, Response } from 'express';
-import { faker } from '@faker-js/faker';
-import { fake } from 'sinon';
-import { authStatic } from './authStatic';
-
-describe('Middleware - Auth Static', () => {
-  beforeEach(() => {
-    process.env.STATIC_TOKEN = faker.lorem.slug();
-  });
-
-  it('should authenticate with static token', () => {
-    const bearer = `Bearer ${process.env.STATIC_TOKEN as string}`;
-    const request = { headers: { authorization: bearer } };
-    const next = fake();
-    authStatic()(request as Request, undefined as unknown as Response, next);
-    expect(next).to.have.been.calledOnceWithExactly();
-  });
-
-  it('should throw an error if the token is invalid', () => {
-    const bearer = 'Bearer ' + faker.lorem.word();
-    const request = { headers: { authorization: bearer } };
-    const next = fake();
-    expect(() => {
-      authStatic()(request as Request, undefined as unknown as Response, next);
-    }).to.throw();
-  });
-
-  it('should throw an error if there is no token', () => {
-    const request = { headers: {} };
-    const next = fake();
-    expect(() => {
-      authStatic()(request as Request, undefined as unknown as Response, next);
-    }).to.throw();
-  });
-});
+import { expect } from 'chai';
+import { Request, Response } from 'express';
+import { faker } from '@faker-js/faker';
+import { fake } from 'sinon';
+import { authStatic } from './authStatic';
+
+describe('Middleware - Auth Static', () => {
+  beforeEach(() => {
+    process.env.STATIC_TOKEN = faker.lorem.slug();
+  });
+
+  it('should authenticate with static token', () => {
+    const bearer = `Bearer ${process.env.STATIC_TOKEN as string}`;
+    const request = { headers: { authorization: bearer } };
+    const next = fake();
+    authStatic()(request as Request, undefined as unknown as Response, next);
+    expect(next).to.have.been.calledOnceWithExactly();
+  });
+
+  it('should throw an error if the token is invalid', () => {
+    const bearer = 'Bearer ' + faker.lorem.word();
+    const request = { headers: { authorization: bearer } };
+    const next = fake();
+    expect(() => {
+      authStatic()(request as Request, undefined as unknown as Response, next);
+    }).to.throw();
+  });
+
+  it('should throw an error if there is no token', () => {
+    const request = { headers: {} };
+    const next = fake();
+    expect(() => {
+      authStatic()(request as Request, undefined as unknown as Response, next);
+    }).to.throw();
+  });
+});

package/src/middleware/authStatic/authStatic.ts

@@ -1,45 +1,45 @@
-import { Request, Response, NextFunction } from 'express';
-import { WebError } from 'entities/WebError';
-import { assertEnvironment, envAssert, reportDebug } from 'utils';
-
-const namespace = 'engine:middleware:authStatic';
-
-/**
- * Generate a middleware to authenticate the client connection with a static token
- * @return {Function}
- */
-export function authStatic(): (
-  req: Request,
-  res: Response,
-  next: NextFunction
-) => void {
-  assertEnvironment({ STATIC_TOKEN: envAssert.isString() });
-
-  return (req: Request, res: Response, next: NextFunction): void => {
-    const [scheme, credentials] = req.headers?.authorization?.split(' ') ?? [];
-    // No bearer token has been sent
-    if (!credentials || scheme.toLowerCase() !== 'bearer') {
-      throw new WebError({
-        statusCode: 401,
-        errorCode: 'unauthorized',
-        message: 'No bearer token found',
-        data: { authorization: req.headers?.authorization }
-      });
-    }
-    reportDebug({
-      namespace,
-      message: 'Performing Static authentication',
-      data: { scheme, credentials }
-    });
-    // Verify token
-    if (credentials !== process.env.STATIC_TOKEN) {
-      throw new WebError({
-        statusCode: 401,
-        errorCode: 'unauthorized',
-        message: 'Invalid token supplied',
-        data: { credentials }
-      });
-    }
-    next();
-  };
-}
+import { Request, Response, NextFunction } from 'express';
+import { WebError } from 'entities/WebError';
+import { assertEnvironment, envAssert, reportDebug } from 'utils';
+
+const namespace = 'engine:middleware:authStatic';
+
+/**
+ * Generate a middleware to authenticate the client connection with a static token
+ * @return {Function}
+ */
+export function authStatic(): (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => void {
+  assertEnvironment({ STATIC_TOKEN: envAssert.isString() });
+
+  return (req: Request, res: Response, next: NextFunction): void => {
+    const [scheme, credentials] = req.headers?.authorization?.split(' ') ?? [];
+    // No bearer token has been sent
+    if (!credentials || scheme.toLowerCase() !== 'bearer') {
+      throw new WebError({
+        statusCode: 401,
+        errorCode: 'unauthorized',
+        message: 'No bearer token found',
+        data: { authorization: req.headers?.authorization }
+      });
+    }
+    reportDebug({
+      namespace,
+      message: 'Performing Static authentication',
+      data: { scheme, credentials }
+    });
+    // Verify token
+    if (credentials !== process.env.STATIC_TOKEN) {
+      throw new WebError({
+        statusCode: 401,
+        errorCode: 'unauthorized',
+        message: 'Invalid token supplied',
+        data: { credentials }
+      });
+    }
+    next();
+  };
+}

package/src/middleware/authStatic/index.ts

@@ -1 +1 @@
-export * from './authStatic';
+export * from './authStatic';