node-server-engine 1.1.5 → 1.1.7

package/dist/utils/getDynamicLink/getDynamicLink.validate.d.ts

@@ -1,2 +0,0 @@
-/** Environment variable validator for get dynamic link from LinkService */
-export declare function validateDynamicLinkEnvironment(): void;

package/dist/utils/getDynamicLink/getDynamicLink.validate.js

@@ -1,14 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.validateDynamicLinkEnvironment = validateDynamicLinkEnvironment;
-var _ = require("./..");
-/** Environment variable validator for get dynamic link from LinkService */
-function validateDynamicLinkEnvironment() {
-  (0, _.assertEnvironment)({
-    LINKS_SERVICE_URL: _.envAssert.isURL()
-  });
-}
-//# sourceMappingURL=getDynamicLink.validate.js.map

package/dist/utils/getDynamicLink/getDynamicLink.validate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDynamicLink.validate.js","names":["_","require","validateDynamicLinkEnvironment","assertEnvironment","LINKS_SERVICE_URL","envAssert","isURL"],"sources":["../../../src/utils/getDynamicLink/getDynamicLink.validate.ts"],"sourcesContent":["import { assertEnvironment, envAssert } from 'utils';\n\n/** Environment variable validator for get dynamic link from LinkService */\nexport function validateDynamicLinkEnvironment(): void {\n  assertEnvironment({ LINKS_SERVICE_URL: envAssert.isURL() });\n}\n"],"mappings":";;;;;;AAAA,IAAAA,CAAA,GAAAC,OAAA;AAEA;AACO,SAASC,8BAA8BA,CAAA,EAAS;EACrD,IAAAC,mBAAiB,EAAC;IAAEC,iBAAiB,EAAEC,WAAS,CAACC,KAAK,CAAC;EAAE,CAAC,CAAC;AAC7D","ignoreList":[]}

package/dist/utils/getDynamicLink/index.d.ts

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

package/dist/utils/getDynamicLink/index.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _getDynamicLink = require("./getDynamicLink");
-Object.keys(_getDynamicLink).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _getDynamicLink[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _getDynamicLink[key];
-    }
-  });
-});
-var _getDynamicLink2 = require("./getDynamicLink.types");
-Object.keys(_getDynamicLink2).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _getDynamicLink2[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _getDynamicLink2[key];
-    }
-  });
-});
-//# sourceMappingURL=index.js.map

package/dist/utils/getDynamicLink/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["_getDynamicLink","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_getDynamicLink2"],"sources":["../../../src/utils/getDynamicLink/index.ts"],"sourcesContent":["export * from './getDynamicLink';\nexport * from './getDynamicLink.types';\n"],"mappings":";;;;;AAAA,IAAAA,eAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,eAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,eAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,eAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,gBAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,gBAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,gBAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,gBAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/src/middleware/authAdmin/authAdmin.test.ts

@@ -1,199 +0,0 @@
-import { factory, generateAccessToken, 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 { authAdmin } from './authAdmin';
-import {} from './authAdmin.types';
-
-describe('Middleware - Auth Admin', () => {
-  it('should authenticate with a JWT (auth-service)', async () => {
-    const email = faker.internet.email();
-    const permission = faker.lorem.word();
-    const request = {
-      headers: {
-        authorization: `Bearer ${generateAccessToken(
-          email,
-          {
-            audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
-            issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-          },
-          { per: permission }
-        )}`
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await authAdmin({ permission })(
-      request,
-      undefined as unknown as Response,
-      next
-    );
-
-    expect(next).to.have.been.calledOnceWithExactly();
-  });
-
-  it('should populate the admin object in the request (auth-service)', async () => {
-    const email = faker.internet.email();
-    const permission = faker.lorem.word();
-    const permissions = [permission, faker.lorem.word(), faker.lorem.word()];
-    const request = {
-      headers: {
-        authorization: `Bearer ${generateAccessToken(
-          email,
-          {
-            audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
-            issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-          },
-          { per: permissions }
-        )}`
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await authAdmin({ permission })(
-      request,
-      undefined as unknown as Response,
-      next
-    );
-
-    expect(request.admin?.email).to.equal(email);
-    expect(request.admin?.permissions).to.deep.members(permissions);
-  });
-
-  it('should throw an error if there is no token', async () => {
-    const request = { headers: {} } as unknown as Request;
-    const next = fake();
-
-    await expect(
-      authAdmin({ permission: faker.lorem.word() })(
-        request,
-        undefined as unknown as Response,
-        next
-      )
-    ).to.eventually.be.rejected;
-  });
-
-  it('should throw an error if the audience is not valid', async () => {
-    const user = factory.build('user');
-    const permission = faker.lorem.word();
-    const request = {
-      headers: {
-        authorization: getBearer(
-          user.id,
-          { audience: faker.internet.url() },
-          { per: permission }
-        )
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await expect(
-      authAdmin({ permission })(request, undefined as unknown as Response, next)
-    ).to.eventually.be.rejected;
-  });
-
-  it('should check user has permission', async () => {
-    const email = faker.internet.email();
-    const permissions = [faker.lorem.word(), faker.lorem.word()];
-    const request = {
-      headers: {
-        authorization: `Bearer ${generateAccessToken(
-          email,
-          {
-            audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
-            issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-          },
-          { per: permissions }
-        )}`
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await authAdmin({ permission: permissions[0] })(
-      request,
-      undefined as unknown as Response,
-      next
-    );
-
-    expect(request.admin?.email).to.equal(email);
-    expect(request.admin?.permissions).to.deep.members(permissions);
-  });
-
-  it('should all user has endpoint permission', async () => {
-    const email = faker.internet.email();
-    const permission = faker.lorem.word();
-    const request = {
-      headers: {
-        authorization: `Bearer ${generateAccessToken(
-          email,
-          {
-            audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
-            issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-          },
-          { per: permission }
-        )}`
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await authAdmin({ permission })(
-      request,
-      undefined as unknown as Response,
-      next
-    );
-
-    expect(request.admin?.email).to.equal(email);
-    expect(request.admin?.permissions).to.includes(permission);
-  });
-
-  it('should throw error if user does not have permission', async () => {
-    const email = faker.internet.email();
-    const permissions = [faker.lorem.word(), faker.lorem.word()];
-    const request = {
-      headers: {
-        authorization: `Bearer ${generateAccessToken(
-          email,
-          {
-            audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
-            issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-          },
-          { per: permissions }
-        )}`
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await expect(
-      authAdmin({ permission: faker.lorem.word() })(
-        request,
-        undefined as unknown as Response,
-        next
-      )
-    ).to.eventually.rejected;
-  });
-
-  it('should allow wildcard permissions', async () => {
-    const email = faker.internet.email();
-    const permission = faker.lorem.word();
-    const request = {
-      headers: {
-        authorization: `Bearer ${generateAccessToken(
-          email,
-          {
-            audience: [process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string],
-            issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-          },
-          { per: `${permission}:*` }
-        )}`
-      }
-    } as unknown as Request;
-    const next = fake();
-
-    await authAdmin({ permission: `${permission}:${faker.lorem.word()}` })(
-      request,
-      undefined as unknown as Response,
-      next
-    );
-  });
-});

package/src/middleware/authAdmin/authAdmin.ts

@@ -1,114 +0,0 @@
-import { Request, Response, NextFunction } from 'express';
-import { TokenIssuer } from 'const';
-import { EndpointAuthParams, EndpointAuthType } from 'entities/Endpoint';
-import { EngineError } from 'entities/EngineError';
-import { WebError } from 'entities/WebError';
-import { reportDebug, jwtVerify } from 'utils';
-import {} from './authAdmin.types';
-
-const namespace = 'engine:middleware:authAdmin';
-
-/** Generate a middleware to authenticate the client connection with a Admin api */
-export function authAdmin(
-  options: EndpointAuthParams<EndpointAuthType.ADMIN>
-): (request: Request, response: Response, next: NextFunction) => Promise<void> {
-  if (!options.permission)
-    throw new EngineError({
-      message: 'Endpoint using admin auth type must specify permission'
-    });
-  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({
-        errorCode: 'unauthorized',
-        statusCode: 401,
-        message: 'No bearer token found',
-        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.ADMIN_API);
-    reportDebug({
-      namespace,
-      message: 'Extracted user data from JWT',
-      data: { payload, credentials }
-    });
-
-    if (!payload.per)
-      throw new WebError({
-        errorCode: 'unauthorized',
-        statusCode: 401,
-        message: `User token does not contain any permission claim`
-      });
-
-    // User Permission
-    const permissions = payload.per;
-    const userPermissions =
-      permissions instanceof Array ? permissions : [permissions];
-
-    reportDebug({
-      namespace,
-      message: 'Performing Admin Permission check',
-      data: {
-        permissions,
-        endpointPermission: options.permission,
-        adminPermissions: userPermissions
-      }
-    });
-
-    if (!checkUserPermissions(userPermissions, options.permission)) {
-      throw new WebError({
-        errorCode: 'unauthorized',
-        statusCode: 401,
-        message: `User does not have required permission "${options.permission}"`,
-        data: { userPermissions }
-      });
-    }
-
-    // The user object on the request is hydrated with data from the token
-    request.admin = {
-      ...request.admin,
-      email: payload.sub,
-      permissions: userPermissions
-    };
-
-    next();
-  };
-}
-
-/** */
-function checkUserPermissions(
-  userPermissions: Array<string>,
-  endpointPermission: string
-): boolean {
-  const endpointPermissionParts = endpointPermission.split(':');
-  userPermissionLoop: for (const permission of userPermissions) {
-    const permissionParts = permission.split(':');
-
-    // Ignore if both are not same length
-    if (permissionParts.length !== endpointPermissionParts.length)
-      continue userPermissionLoop;
-
-    for (let i = 0; i < permissionParts.length; i++) {
-      // Wildcards get automatic validation, otherwise it must match with the same part of the endpoint permission
-      if (
-        permissionParts[i] !== '*' &&
-        permissionParts[i] !== endpointPermissionParts[i]
-      )
-        continue userPermissionLoop;
-    }
-    return true;
-  }
-  return false;
-}

package/src/middleware/authAdmin/authAdmin.types.ts

@@ -1,19 +0,0 @@
-// 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 */
-      admin?: RequestAdminProps;
-    }
-  }
-}
-
-/** Admin auth properties of the request */
-export interface RequestAdminProps {
-  /** Email address of the user */
-  email: string;
-  /** List of permissions that the user has */
-  permissions: Array<string>;
-}

package/src/middleware/authAdmin/index.ts

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

package/src/utils/getDynamicLink/getDynamicLink.test.ts

@@ -1,51 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import chai, { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { stub, SinonStub, match } from 'sinon';
-import sinonChai from 'sinon-chai';
-import { getDynamicLink } from './getDynamicLink';
-import { DynamicLinkResponseBody } from './getDynamicLink.types';
-import * as tlsRequest from 'utils/tlsRequest/tlsRequest';
-
-chai.use(sinonChai);
-
-describe('Utils - Get Dynamic Link', () => {
-  let expectedPayload: AxiosRequestConfig;
-  let path: string;
-  let requestStub: SinonStub;
-  let link: string;
-
-  beforeEach(() => {
-    link = faker.internet.url();
-    requestStub = stub(tlsRequest, 'tlsRequest').resolves({
-      data: { link }
-    } as AxiosResponse<DynamicLinkResponseBody>);
-    path = faker.system.directoryPath();
-    expectedPayload = {
-      method: 'get',
-      url: '/link',
-      baseURL: process.env.LINKS_SERVICE_URL,
-      params: {
-        path
-      }
-    };
-  });
-
-  it('should get a dynamic link', async () => {
-    // should return a link from the res
-    const dynamicLink = await getDynamicLink(path);
-    expect(dynamicLink).to.equal(link);
-    expect(requestStub).to.have.been.calledOnceWithExactly(
-      match(expectedPayload)
-    );
-  });
-
-  it('should get a dynamic link with custom settings', async () => {
-    // should return a link from the res
-    const dynamicLink = await getDynamicLink(path, { short: false });
-    expect(dynamicLink).to.equal(link);
-    expect(requestStub).to.have.been.calledOnceWithExactly(
-      match({ ...expectedPayload, params: { path, short: false } })
-    );
-  });
-});

package/src/utils/getDynamicLink/getDynamicLink.ts

@@ -1,28 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import {
-  getDynamicLinksOptions,
-  DynamicLinkResponseBody
-} from './getDynamicLink.types';
-import { validateDynamicLinkEnvironment } from './getDynamicLink.validate';
-import { tlsRequest } from 'utils/tlsRequest';
-
-/** Fetch a dynamic link from the links service */
-export async function getDynamicLink(
-  path: string,
-  options: getDynamicLinksOptions = {}
-): Promise<string> {
-  validateDynamicLinkEnvironment();
-  const option: AxiosRequestConfig = {
-    method: 'get',
-    url: '/link',
-    baseURL: process.env.LINKS_SERVICE_URL,
-    params: {
-      path,
-      short: options.short ?? true
-    }
-  };
-  const {
-    data: { link }
-  } = await tlsRequest<DynamicLinkResponseBody>(option);
-  return link;
-}

package/src/utils/getDynamicLink/getDynamicLink.types.ts

@@ -1,11 +0,0 @@
-/** Options to fetch dynamic links */
-export interface getDynamicLinksOptions {
-  /** Make a shortened link */
-  short?: boolean;
-}
-
-/** Dynamic link query server response */
-export interface DynamicLinkResponseBody {
-  /** The generated dynamic link */
-  link: string;
-}

package/src/utils/getDynamicLink/getDynamicLink.validate.ts

@@ -1,6 +0,0 @@
-import { assertEnvironment, envAssert } from 'utils';
-
-/** Environment variable validator for get dynamic link from LinkService */
-export function validateDynamicLinkEnvironment(): void {
-  assertEnvironment({ LINKS_SERVICE_URL: envAssert.isURL() });
-}

package/src/utils/getDynamicLink/index.ts

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