node-server-engine 1.1.4 → 1.1.6

package/src/utils/getDynamicLink/index.ts

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

package/src/utils/hmac/checkEnv/checkEnv.test.ts

@@ -1,18 +1,18 @@
-import { expect } from 'chai';
-import { assertPayloadSignatureSecret } from './checkEnv';
-
-describe('Utils - HMAC - Check environment', () => {
-  it('should pass if environment variables are set', () => {
-    process.env.PAYLOAD_SIGNATURE_SECRET = 'secret';
-    expect(() => {
-      assertPayloadSignatureSecret();
-    }).to.not.throw();
-  });
-
-  it('should throw an error if the environment vairable is not set', () => {
-    delete process.env.PAYLOAD_SIGNATURE_SECRET;
-    expect(() => {
-      assertPayloadSignatureSecret();
-    }).to.throw();
-  });
-});
+import { expect } from 'chai';
+import { assertPayloadSignatureSecret } from './checkEnv';
+
+describe('Utils - HMAC - Check environment', () => {
+  it('should pass if environment variables are set', () => {
+    process.env.PAYLOAD_SIGNATURE_SECRET = 'secret';
+    expect(() => {
+      assertPayloadSignatureSecret();
+    }).to.not.throw();
+  });
+
+  it('should throw an error if the environment vairable is not set', () => {
+    delete process.env.PAYLOAD_SIGNATURE_SECRET;
+    expect(() => {
+      assertPayloadSignatureSecret();
+    }).to.throw();
+  });
+});

package/src/utils/hmac/checkEnv/checkEnv.ts

@@ -1,9 +1,9 @@
-import { assertEnvironment } from 'utils/checkEnvironment';
-import { envAssert } from 'utils/envAssert';
-
-/**
- * Check that secret used to sign payloads is properly set in the environment
- */
-export function assertPayloadSignatureSecret(): void {
-  assertEnvironment({ PAYLOAD_SIGNATURE_SECRET: envAssert.isString() });
-}
+import { assertEnvironment } from 'utils/checkEnvironment';
+import { envAssert } from 'utils/envAssert';
+
+/**
+ * Check that secret used to sign payloads is properly set in the environment
+ */
+export function assertPayloadSignatureSecret(): void {
+  assertEnvironment({ PAYLOAD_SIGNATURE_SECRET: envAssert.isString() });
+}

package/src/utils/hmac/checkEnv/index.ts

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

package/src/utils/hmac/createHmac/createHmac.ts

@@ -1,33 +1,33 @@
-import crypto from 'crypto';
-import { assertPayloadSignatureSecret } from '../checkEnv';
-import { HmacOptions } from '../index.types';
-import { createSortedObject } from 'utils/createSortedObject';
-
-/** Calculates the HMAC signature for a given payload */
-export function createHmac(
-  payload: unknown,
-  options: HmacOptions = {}
-): Buffer | string {
-  // Check env if no secret is specified
-  if (!options.secret) {
-    assertPayloadSignatureSecret();
-  }
-  // Set default values
-  const settings = {
-    algorithm: options.algorithm ?? 'sha512',
-    sort: options.sort ?? true,
-    encode: options.encode,
-    secret: options.secret ?? (process.env.PAYLOAD_SIGNATURE_SECRET as string)
-  };
-
-  // Stringify the payload
-  const sortedPayload = settings.sort ? createSortedObject(payload) : payload;
-  const stringifiedPayload = JSON.stringify(sortedPayload);
-
-  // Calculate the hash
-  const hmac = crypto
-    .createHmac(settings.algorithm, settings.secret)
-    .update(stringifiedPayload);
-
-  return settings.encode ? hmac.digest(settings.encode) : hmac.digest();
-}
+import crypto from 'crypto';
+import { assertPayloadSignatureSecret } from '../checkEnv';
+import { HmacOptions } from '../index.types';
+import { createSortedObject } from 'utils/createSortedObject';
+
+/** Calculates the HMAC signature for a given payload */
+export function createHmac(
+  payload: unknown,
+  options: HmacOptions = {}
+): Buffer | string {
+  // Check env if no secret is specified
+  if (!options.secret) {
+    assertPayloadSignatureSecret();
+  }
+  // Set default values
+  const settings = {
+    algorithm: options.algorithm ?? 'sha512',
+    sort: options.sort ?? true,
+    encode: options.encode,
+    secret: options.secret ?? (process.env.PAYLOAD_SIGNATURE_SECRET as string)
+  };
+
+  // Stringify the payload
+  const sortedPayload = settings.sort ? createSortedObject(payload) : payload;
+  const stringifiedPayload = JSON.stringify(sortedPayload);
+
+  // Calculate the hash
+  const hmac = crypto
+    .createHmac(settings.algorithm, settings.secret)
+    .update(stringifiedPayload);
+
+  return settings.encode ? hmac.digest(settings.encode) : hmac.digest();
+}

package/src/utils/hmac/createHmac/index.ts

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

package/src/utils/hmac/index.ts

@@ -1,4 +1,4 @@
-export * from './signPayload';
-export * from './verifySignature';
-export * from './createHmac';
-export * from './index.types';
+export * from './signPayload';
+export * from './verifySignature';
+export * from './createHmac';
+export * from './index.types';

package/src/utils/hmac/index.types.ts

@@ -1,13 +1,13 @@
-import { BinaryToTextEncoding } from 'crypto';
-
-/** HMAC calculation options  */
-export interface HmacOptions {
-  /** Secret used to sign the payload */
-  secret?: string;
-  /** Hashing algorithm to use (default: SHA-512) */
-  algorithm?: string;
-  /** Should the object keys be sorted alphabetically (default: true) */
-  sort?: boolean;
-  /** The encoding of the signature (default: base64) */
-  encode?: BinaryToTextEncoding;
-}
+import { BinaryToTextEncoding } from 'crypto';
+
+/** HMAC calculation options  */
+export interface HmacOptions {
+  /** Secret used to sign the payload */
+  secret?: string;
+  /** Hashing algorithm to use (default: SHA-512) */
+  algorithm?: string;
+  /** Should the object keys be sorted alphabetically (default: true) */
+  sort?: boolean;
+  /** The encoding of the signature (default: base64) */
+  encode?: BinaryToTextEncoding;
+}

package/src/utils/hmac/signPayload/index.ts

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

package/src/utils/hmac/signPayload/signPayload.ts

@@ -1,16 +1,16 @@
-import { createHmac } from '../createHmac';
-import { HmacOptions } from '../index.types';
-
-/** Add signature to a payload */
-export function signPayload<T>(
-  payload: T,
-  options: HmacOptions = {}
-): T & {
-  /** HMAC signature of the payload */
-  signature: string;
-} {
-  return {
-    ...payload,
-    signature: createHmac(payload, { ...options, encode: 'base64' }) as string
-  };
-}
+import { createHmac } from '../createHmac';
+import { HmacOptions } from '../index.types';
+
+/** Add signature to a payload */
+export function signPayload<T>(
+  payload: T,
+  options: HmacOptions = {}
+): T & {
+  /** HMAC signature of the payload */
+  signature: string;
+} {
+  return {
+    ...payload,
+    signature: createHmac(payload, { ...options, encode: 'base64' }) as string
+  };
+}

package/src/utils/hmac/verifySignature/index.ts

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

package/src/utils/hmac/verifySignature/verifySignature.ts

@@ -1,24 +1,24 @@
-import crypto from 'crypto';
-import { createHmac } from '../createHmac';
-import { HmacOptions } from '../index.types';
-
-/** Checks the signature of a payload */
-export function verifySignature(
-  payload: Record<string, unknown>,
-  signature: string,
-  options: HmacOptions = {}
-): boolean {
-  if (!payload || !signature) return false;
-  // Obtain a buffer digest
-  const digest = createHmac(payload, {
-    ...options,
-    encode: undefined
-  }) as Buffer;
-  // Transform the signature to buffer
-  const checksum = Buffer.from(signature, options.encode ?? 'base64');
-  // Compare signature with the calculated digest
-  return (
-    checksum.length === digest.length &&
-    crypto.timingSafeEqual(digest, checksum)
-  );
-}
+import crypto from 'crypto';
+import { createHmac } from '../createHmac';
+import { HmacOptions } from '../index.types';
+
+/** Checks the signature of a payload */
+export function verifySignature(
+  payload: Record<string, unknown>,
+  signature: string,
+  options: HmacOptions = {}
+): boolean {
+  if (!payload || !signature) return false;
+  // Obtain a buffer digest
+  const digest = createHmac(payload, {
+    ...options,
+    encode: undefined
+  }) as Buffer;
+  // Transform the signature to buffer
+  const checksum = Buffer.from(signature, options.encode ?? 'base64');
+  // Compare signature with the calculated digest
+  return (
+    checksum.length === digest.length &&
+    crypto.timingSafeEqual(digest, checksum)
+  );
+}

package/src/utils/index.ts

@@ -1,26 +1,26 @@
-// general
-export * from './report';
-export * from './filter';
-export * from './semverCompare';
-export * from './dbMigration';
-
-// env
-export * from './checkEnvironment';
-export * from './envAssert';
-
-// auth
-export * from './createSortedObject';
-export * from './jwt';
-export * from './hmac';
-
-// Networking
-export * from './createHttpServer';
-export * from './request';
-export * from './tlsConfig';
-export * from './tlsRequest';
-export * from './sendPush';
-export * from './getDynamicLink';
-export * from './sendEmail';
-
-// String manipulation
-export * from './trimPathSlash';
+// general
+export * from './report';
+export * from './filter';
+export * from './semverCompare';
+export * from './dbMigration';
+
+// env
+export * from './checkEnvironment';
+export * from './envAssert';
+
+// auth
+export * from './createSortedObject';
+export * from './jwt';
+export * from './hmac';
+
+// Networking
+export * from './createHttpServer';
+export * from './request';
+export * from './tlsConfig';
+export * from './tlsRequest';
+export * from './sendPush';
+export * from './getDynamicLink';
+export * from './sendEmail';
+
+// String manipulation
+export * from './trimPathSlash';

package/src/utils/jwt/index.ts

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

package/src/utils/jwt/jwt.test.ts

@@ -1,41 +1,41 @@
-import { randomUUID } from 'crypto';
-import { generateAccessToken } from 'backend-test-tools';
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { jwtVerify } from './jwt';
-import { TokenIssuer } from 'const';
-
-describe('Utils - JWT', () => {
-  it('should pass a default token', async () => {
-    const id = randomUUID();
-    const token = generateAccessToken(id);
-    const result = await jwtVerify(token);
-    expect(result.sub).to.equal(id);
-  });
-
-  it('should pass a token with one correct audience [Auth-service]', async () => {
-    const id = randomUUID();
-    const token = generateAccessToken(id, {
-      audience: [
-        process.env.ACCESS_TOKEN_AUDIENCE as string,
-        faker.lorem.word()
-      ],
-      issuer: process.env.ACCESS_TOKEN_ISSUER
-    });
-    const result = await jwtVerify(token, TokenIssuer.AUTH_SERVICE);
-    expect(result.sub).to.equal(id);
-  });
-
-  it('should pass a token with one correct audience [Admin-API]', async () => {
-    const id = randomUUID();
-    const token = generateAccessToken(id, {
-      audience: [
-        process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string,
-        faker.lorem.word()
-      ],
-      issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
-    });
-    const result = await jwtVerify(token, TokenIssuer.ADMIN_API);
-    expect(result.sub).to.equal(id);
-  });
-});
+import { randomUUID } from 'crypto';
+import { generateAccessToken } from 'backend-test-tools';
+import { expect } from 'chai';
+import { faker } from '@faker-js/faker';
+import { jwtVerify } from './jwt';
+import { TokenIssuer } from 'const';
+
+describe('Utils - JWT', () => {
+  it('should pass a default token', async () => {
+    const id = randomUUID();
+    const token = generateAccessToken(id);
+    const result = await jwtVerify(token);
+    expect(result.sub).to.equal(id);
+  });
+
+  it('should pass a token with one correct audience [Auth-service]', async () => {
+    const id = randomUUID();
+    const token = generateAccessToken(id, {
+      audience: [
+        process.env.ACCESS_TOKEN_AUDIENCE as string,
+        faker.lorem.word()
+      ],
+      issuer: process.env.ACCESS_TOKEN_ISSUER
+    });
+    const result = await jwtVerify(token, TokenIssuer.AUTH_SERVICE);
+    expect(result.sub).to.equal(id);
+  });
+
+  it('should pass a token with one correct audience [Admin-API]', async () => {
+    const id = randomUUID();
+    const token = generateAccessToken(id, {
+      audience: [
+        process.env.ADMIN_API_ACCESS_TOKEN_AUDIENCE as string,
+        faker.lorem.word()
+      ],
+      issuer: process.env.ADMIN_ACCESS_TOKEN_ISSUER
+    });
+    const result = await jwtVerify(token, TokenIssuer.ADMIN_API);
+    expect(result.sub).to.equal(id);
+  });
+});