node-server-engine 1.4.9 → 1.5.1

package/src/utils/secretManager/secretLoader.ts

@@ -1,62 +0,0 @@
-import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
-import { EngineError } from 'entities/EngineError';
-
-// Cache to store preloaded secrets
-export const secretCache: { [key: string]: string } = {};
-let secretClient: SecretManagerServiceClient;
-
-/**
- * Initialize the Secret Manager client and preload secrets.
- * @param secretEnvVars List of env var names that contain secret paths
- */
-export const initializeSecrets = async (
-  secretEnvVars: string[]
-): Promise<void> => {
-  if (process.env.NODE_ENV !== 'production') {
-    console.log('Development mode → using local files for secrets');
-    return; // No need to preload anything
-  }
-
-  try {
-    // Default creds (for GCP runtime)
-    secretClient = new SecretManagerServiceClient();
-
-    const secretNames = secretEnvVars.filter((name) => process.env[name]);
-    if (secretNames.length === 0) {
-      throw new EngineError({
-        message: 'No secret names defined in environment variables'
-      });
-    }
-
-    // Fetch all secrets from GCP Secret Manager
-    for (const name of secretNames) {
-      const secretPath = process.env[name];
-      if (!secretPath) {
-        throw new EngineError({
-          message: `Secret path for ${name} is not defined`
-        });
-      }
-
-      try {
-        const [version] = await secretClient.accessSecretVersion({
-          name: secretPath
-        });
-        const payload = version.payload?.data?.toString('utf-8');
-        if (!payload) {
-          throw new EngineError({
-            message: `Secret ${name} not found or empty`
-          });
-        }
-        secretCache[name] = payload;
-      } catch (err) {
-        throw new EngineError({
-          message: `Error accessing secret ${name}: ${(err as Error).message}`
-        });
-      }
-    }
-  } catch (err) {
-    throw new EngineError({
-      message: `Failed to initialize secrets: ${(err as Error).message}`
-    });
-  }
-};

package/src/utils/secretManager/secretResolver.ts

@@ -1,35 +0,0 @@
-import fs from 'fs';
-import { EngineError } from 'entities/EngineError';
-import { secretCache } from './secretLoader';
-
-/**
- * Retrieve a secret value (production) or file content (development).
- * @param name The env var name that contains either the secret path (prod) or local file path (dev)
- */
-export const getSecretOrFile = (name: string): string => {
-  if (process.env.NODE_ENV === 'production') {
-    const secretValue = secretCache[name];
-
-    if (!secretValue) {
-      throw new EngineError({
-        message: `Secret value for ${name} not found in cache`
-      });
-    }
-    return secretValue;
-  } else {
-    const localPath = process.env[name];
-    if (!localPath) {
-      throw new EngineError({
-        message: `Local path for ${name} is not defined`
-      });
-    }
-
-    try {
-      return fs.readFileSync(localPath, 'utf-8');
-    } catch (err) {
-      throw new EngineError({
-        message: `Error reading local file for ${name}: ${(err as Error).message}`
-      });
-    }
-  }
-};

package/src/utils/semverCompare/index.ts

@@ -1 +0,0 @@
-export * from './semverCompare';

package/src/utils/semverCompare/semverCompare.test.ts

@@ -1,49 +0,0 @@
-import { expect } from 'chai';
-import { semverCompare } from './semverCompare';
-import { EngineError } from 'entities/EngineError';
-
-describe('Utils - SemVer Compare', function () {
-  it('Should throw an error if given a wrong formatted item', () => {
-    expect(() => semverCompare('1.0.0', 'test')).to.throw(EngineError);
-    expect(() => semverCompare('wrong', '1.0.0')).to.throw(EngineError);
-  });
-
-  it('Should compare majors', () => {
-    expect(semverCompare('1.0.0', '2.0.0')).to.equal(-1);
-    expect(semverCompare('2.0.0', '1.0.0')).to.equal(1);
-  });
-
-  it('Should compare minors', () => {
-    expect(semverCompare('1.1.0', '1.2.0')).to.equal(-1);
-    expect(semverCompare('2.5.0', '2.3.0')).to.equal(1);
-  });
-
-  it('Should compare patches', () => {
-    expect(semverCompare('1.1.1', '1.1.2')).to.equal(-1);
-    expect(semverCompare('2.5.6', '2.5.0')).to.equal(1);
-  });
-
-  it('Should compare patches', () => {
-    expect(semverCompare('1.1.1', '1.1.2')).to.equal(-1);
-    expect(semverCompare('2.5.6', '2.5.0')).to.equal(1);
-  });
-
-  it('Should compare releases types', () => {
-    expect(semverCompare('1.1.1-rc.1', '1.1.1')).to.equal(-1);
-    expect(semverCompare('1.1.1-beta.1', '1.1.1-rc.1')).to.equal(-1);
-    expect(semverCompare('1.1.1-alpha.1', '1.1.1-beta.1')).to.equal(-1);
-    expect(semverCompare('2.5.5', '2.5.5-rc.1')).to.equal(1);
-    expect(semverCompare('2.5.5-rc.1', '2.5.5-beta.1')).to.equal(1);
-    expect(semverCompare('2.5.5-beta.1', '2.5.5-alpha.1')).to.equal(1);
-  });
-
-  it('Should compare pre-release versions', () => {
-    expect(semverCompare('1.1.1-alpha.1', '1.1.1-alpha.2')).to.equal(-1);
-    expect(semverCompare('2.5.6-rc.5', '2.5.6-rc.3')).to.equal(1);
-  });
-
-  it('Should handle equality', () => {
-    expect(semverCompare('1.1.1', '1.1.1')).to.equal(0);
-    expect(semverCompare('2.5.6-rc.5', '2.5.6-rc.5')).to.equal(0);
-  });
-});

package/src/utils/semverCompare/semverCompare.ts

@@ -1,60 +0,0 @@
-import validator from 'validator';
-import { EngineError } from 'entities/EngineError';
-
-// Regex to validate our SemVer style and capture the different parts
-const SEMVER_REGEX =
-  /^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-(?:(alpha|beta|rc)(?:\.(0|[1-9]\d*))))?$/;
-
-/**
- * Comparison function for our SemVer strings, includes support ofr pre-releases
- * @param {string} v1
- * @param {string} v2
- * @return {number} - -1 if v1 < v2, 0 if v1 = v2, +1 if v1 > v2
- */
-export function semverCompare(v1: string, v2: string): 1 | -1 | 0 {
-  const [match1, match2] = [v1, v2].map((v) => v.match(SEMVER_REGEX));
-  if (!match1 || !match2)
-    throw new EngineError({
-      message: 'Provided invalid SemVer string, can not compare',
-      data: { v1, v2 }
-    });
-  const [
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    [_1, major1, minor1, patch1, preType1, preVersion1],
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    [_2, major2, minor2, patch2, preType2, preVersion2]
-  ] = [match1, match2].map((group) =>
-    // We parse to int the parts that can be
-    group.map((item) => (item && validator.isInt(item) ? parseInt(item) : item))
-  );
-
-  // Compare majors first
-  if (major1 < major2) return -1;
-  if (major1 > major2) return 1;
-
-  // Compare minors second
-  if (minor1 < minor2) return -1;
-  if (minor1 > minor2) return 1;
-
-  // Compare patch third
-  if (patch1 < patch2) return -1;
-  if (patch1 > patch2) return 1;
-
-  // Compare pre-release type
-  // Release > pre-release
-  if (!preType1 && !preType2) return 0;
-  if (preType1 && !preType2) return -1;
-  if (!preType1 && preType2) return 1;
-
-  // RC > Beta > Alpha
-  if (preType1 !== 'rc' && preType2 === 'rc') return -1;
-  if (preType1 === 'rc' && preType2 !== 'rc') return 1;
-  if (preType1 !== 'beta' && preType2 === 'beta') return -1;
-  if (preType1 === 'beta' && preType2 !== 'beta') return 1;
-
-  // Finally compare the pre-release versions
-  if (preVersion1 < preVersion2) return -1;
-  if (preVersion1 > preVersion2) return 1;
-
-  return 0;
-}

package/src/utils/sendEmail/index.ts

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

package/src/utils/sendEmail/sendEmail.ts

@@ -1,61 +0,0 @@
-import { EmailOptions, EmailResult, EmailStatus } from './sendEmail.types';
-import nodemailer, {
-  Transporter,
-  SendMailOptions,
-  SentMessageInfo
-} from 'nodemailer';
-
-/**
- * Sends an email using Nodemailer.
- * @param emailOptions - Configuration options for sending the email.
- * @returns A Promise that resolves with an EmailResult indicating success or failure.
- */
-export const sendEmail = async (
-  emailOptions: EmailOptions
-): Promise<EmailResult> => {
-  try {
-    // Create a transport with SMTP configuration
-    const transporter: Transporter = nodemailer.createTransport({
-      host: process.env.SMTP_HOST,
-      port: parseInt(process.env.SMTP_PORT || '587', 10),
-      secure: process.env.SMTP_PORT === '465' ? true : false,
-      auth: {
-        user: process.env.SMTP_USER,
-        pass: process.env.SMTP_PASS
-      },
-      tls: {
-        rejectUnauthorized: process.env.SMTP_PORT === '465' ? true : false
-      }
-    });
-
-    // Construct email options
-    const mailOptions: SendMailOptions = {
-      from: emailOptions.from,
-      to: emailOptions.to,
-      cc: emailOptions.cc,
-      bcc: emailOptions.bcc,
-      subject: emailOptions.subject,
-      text: emailOptions.text,
-      html: emailOptions.html,
-      attachments: emailOptions.attachments,
-      replyTo: emailOptions.replyTo,
-      headers: emailOptions.headers,
-      priority: emailOptions.priority
-    };
-
-    // Send email
-    const info: SentMessageInfo = await transporter.sendMail(mailOptions);
-
-    // Determine email status
-    let status: EmailStatus = 'sent';
-    if (info.response.includes('queued')) {
-      status = 'queued';
-    } else if (info.response.includes('delivered')) {
-      status = 'delivered';
-    }
-
-    return { status, messageId: info.messageId };
-  } catch (error) {
-    return { status: 'failed', error: (error as Error).message };
-  }
-};

package/src/utils/sendEmail/sendEmail.types.ts

@@ -1,61 +0,0 @@
-/** Structure representing email options for sending an email */
-export interface EmailOptions {
-  /** Sender's email address (optional, defaults to the authenticated user) */
-  from?: string;
-
-  /** Recipient(s) of the email - can be a string or an array of strings */
-  to: string | string[];
-
-  /** Carbon Copy (CC) recipients (optional) */
-  cc?: string | string[];
-
-  /** Blind Carbon Copy (BCC) recipients (optional) */
-  bcc?: string | string[];
-
-  /** Subject of the email */
-  subject: string;
-
-  /** Plain text version of the email body (optional) */
-  text?: string;
-
-  /** HTML version of the email body (optional) */
-  html?: string;
-
-  /** Attachments to include in the email (optional) */
-  attachments?: {
-    /** Name of the attached file */
-    filename: string;
-    /** Content of the attachment (Buffer or string) */
-    content?: string | Buffer;
-    /** File path of the attachment (alternative to `content`) */
-    path?: string;
-    /** MIME type of the attachment */
-    contentType?: string;
-    /** Encoding of the attachment (e.g., base64, utf-8) */
-    encoding?: string;
-    /** Content ID for inline images (optional) */
-    cid?: string;
-  }[];
-
-  /** Email address for replies (optional) */
-  replyTo?: string;
-
-  /** Custom headers for the email (optional) */
-  headers?: { [key: string]: string };
-
-  /** Email priority level (optional) */
-  priority?: 'high' | 'normal' | 'low';
-}
-
-/** Possible statuses for email delivery */
-export type EmailStatus = 'sent' | 'delivered' | 'queued' | 'failed';
-
-/** Structure representing the result of an email sending operation */
-export interface EmailResult {
-  /** Status of the email operation */
-  status: EmailStatus;
-  /** Message ID returned by the mail server (if available) */
-  messageId?: string;
-  /** Error message in case of failure (if any) */
-  error?: string;
-}

package/src/utils/sendPush/index.ts

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

package/src/utils/sendPush/sendPush.ts

@@ -1,20 +0,0 @@
-import { SendPushNotification } from './sendPush.types';
-import { tlsRequest } from 'utils/tlsRequest';
-
-/**
- * Send a push notification through the push service
- * @param userId - ID of the user that should receive the notification
- * @param notification - Notification that should be sent
- * @return Push service response
- */
-export async function sendPush(
-  userId: string,
-  notification: SendPushNotification
-): Promise<unknown> {
-  return tlsRequest({
-    method: 'post',
-    url: '/push',
-    baseURL: process.env.PUSH_SERVICE_URL,
-    data: { userId, ...notification }
-  });
-}

package/src/utils/sendPush/sendPush.types.ts

@@ -1,25 +0,0 @@
-/** Stricture representing a push notification to send */
-export interface SendPushNotification {
-  /** Title of the notification */
-  title?: string;
-  /** Body of the notification */
-  body?: string;
-  /** Data payload of the notification */
-  payload?: unknown;
-  /** Indicates that the notification is a VOIP notification */
-  voip?: boolean;
-  /** Indicate that it is a background notification (data only, low priority) */
-  background?: boolean;
-  /** Push token can be specified here is we want to send to a given user */
-  token?: string;
-  /** Indicates that the data content can be mutated by the client (iOS) */
-  mutable?: boolean;
-  /** Indicates that the notification requires some client side processing to be displayed (iOS) */
-  contentAvailable?: boolean;
-  /** Time to live of the notification in seconds. After this the notification will not be distributed */
-  ttl?: number;
-  /** Indicate that it is a high priority notification */
-  priority?: boolean;
-  /** Notifications with the same string here will be collapsed in the system tray */
-  collapseId?: string;
-}

package/src/utils/tlsConfig/index.ts

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

package/src/utils/tlsConfig/tlsConfig.test.ts

@@ -1,32 +0,0 @@
-import path from 'path';
-import { expect } from 'chai';
-import { validateTlsConfig } from './tlsConfig.validate';
-
-describe('utils - TLS Config', () => {
-  beforeEach(() => {
-    delete process.env.TLS_REQUEST_KEY;
-    delete process.env.TLS_REQUEST_CERT;
-    delete process.env.TLS_REQUEST_CA;
-    delete process.env.TLS_SERVER_KEY;
-    delete process.env.TLS_SERVER_CERT;
-    delete process.env.TLS_CA;
-  });
-
-  it('should accept Request TLS environment variables', () => {
-    process.env.TLS_REQUEST_KEY = path.resolve('certs/client.key');
-    process.env.TLS_REQUEST_CERT = path.resolve('certs/client.crt');
-    process.env.TLS_REQUEST_CA = path.resolve('certs/ca.crt');
-    expect(validateTlsConfig).to.throw;
-  });
-
-  it('should accept Server TLS environment variables', () => {
-    process.env.TLS_SERVER_KEY = path.resolve('certs/server.key');
-    process.env.TLS_SERVER_CERT = path.resolve('certs/server.crt');
-    process.env.TLS_CA = path.resolve('certs/ca.crt');
-    expect(validateTlsConfig).to.throw;
-  });
-
-  it('should throw an EngineError if no environment setting', () => {
-    expect(validateTlsConfig).to.throw;
-  });
-});

package/src/utils/tlsConfig/tlsConfig.ts

@@ -1,47 +0,0 @@
-import fs from 'fs';
-import https, { Agent } from 'https';
-import { TlsConfig } from './tlsConfig.types';
-import { validateTlsConfig } from './tlsConfig.validate';
-import { EngineError } from 'entities/EngineError';
-
-export let tlsConfig: undefined | TlsConfig;
-export let httpsAgent: undefined | Agent;
-
-/**
- * Load TLS config by its Environment setting.
- */
-export function loadTlsConfig(): void {
-  // Check that environment variables are correctly set
-  validateTlsConfig();
-  tlsConfig = undefined;
-
-  if (process.env.TLS_REQUEST_KEY || process.env.TLS_SERVER_KEY) {
-    tlsConfig = {
-      key: fs.readFileSync(
-        (process.env.TLS_REQUEST_KEY ?? process.env.TLS_SERVER_KEY) as string,
-        'utf-8'
-      ),
-      cert: fs.readFileSync(
-        (process.env.TLS_REQUEST_CERT ?? process.env.TLS_SERVER_CERT) as string,
-        'utf-8'
-      ),
-      ca: fs.readFileSync(
-        (process.env.TLS_REQUEST_CA ?? process.env.TLS_CA) as string,
-        'utf-8'
-      ),
-      passphrase: (process.env.TLS_REQUEST_KEY_PASSPHRASE ??
-        process.env.TLS_SERVER_KEY_PASSPHRASE) as string
-    } as TlsConfig;
-    httpsAgent = new https.Agent({
-      key: tlsConfig.key,
-      cert: tlsConfig.cert,
-      ca: tlsConfig.ca,
-      passphrase: tlsConfig.passphrase
-    });
-  }
-  if (!tlsConfig || !(tlsConfig.ca && tlsConfig.cert && tlsConfig.key)) {
-    throw new EngineError({
-      message: 'TLS environment variables are not set correctly'
-    });
-  }
-}

package/src/utils/tlsConfig/tlsConfig.types.ts

@@ -1,11 +0,0 @@
-/** TLS properties */
-export interface TlsConfig {
-  /** Path to the private key file */
-  key: string;
-  /** Path to the certificate file */
-  cert: string;
-  /** Path to the CA certificate file */
-  ca: string;
-  /** Passphrase to use to unwrap the private key */
-  passphrase?: string;
-}

package/src/utils/tlsConfig/tlsConfig.validate.ts

@@ -1,25 +0,0 @@
-import { assertEnvironment, envAssert } from 'utils';
-/**
- * Verify that the environment variables
- */
-export function validateTlsConfig(): void {
-  // We only check if there is at least the host specified
-  if (process.env.TLS_REQUEST_CERT) {
-    assertEnvironment({ TLS_REQUEST_KEY: envAssert.isPath() });
-    assertEnvironment({ TLS_REQUEST_CERT: envAssert.isPath() });
-    assertEnvironment({ TLS_REQUEST_CA: envAssert.isPath() });
-    // Optional variables
-    if (process.env.TLS_REQUEST_KEY_PASSPHRASE) {
-      assertEnvironment({ TLS_REQUEST_KEY_PASSPHRASE: envAssert.isString() });
-    }
-  } else if (process.env.TLS_SERVER_CERT) {
-    // if no TLS Request setting, TLS Server setting is essential.
-    assertEnvironment({ TLS_SERVER_KEY: envAssert.isPath() });
-    assertEnvironment({ TLS_SERVER_CERT: envAssert.isPath() });
-    assertEnvironment({ TLS_CA: envAssert.isPath() });
-    // Optional variables
-    if (process.env.TLS_SERVER_KEY_PASSPHRASE) {
-      assertEnvironment({ TLS_SERVER_KEY_PASSPHRASE: envAssert.isString() });
-    }
-  }
-}

package/src/utils/tlsRequest/index.ts

@@ -1 +0,0 @@
-export * from './tlsRequest';

package/src/utils/tlsRequest/tlsRequest.test.ts

@@ -1,63 +0,0 @@
-import path from 'path';
-import { AxiosRequestConfig } from 'axios';
-import { expect } from 'chai';
-import { tlsRequest } from './tlsRequest';
-import { Endpoint, EndpointAuthType, EndpointMethod } from 'entities/Endpoint';
-import { Server } from 'entities/Server';
-import { stubPubSub } from 'test';
-import { loadTlsConfig } from 'utils/tlsConfig';
-
-describe('utils - TLS Request', () => {
-  let server: Server;
-  const testPath = '/test';
-  const success = { success: true };
-  let option: AxiosRequestConfig;
-
-  before(async () => {
-    process.env.TLS_SERVER_KEY = path.resolve('certs/server.key');
-    process.env.TLS_SERVER_CERT = path.resolve('certs/server.crt');
-    process.env.TLS_CA = path.resolve('certs/ca.crt');
-
-    const endpoint = new Endpoint({
-      path: testPath,
-      method: EndpointMethod.GET,
-      authType: EndpointAuthType.TLS,
-      handler: (request, response): void => {
-        response.json(success);
-      },
-      validator: {}
-    });
-    server = new Server({ endpoints: [endpoint] });
-
-    await server.init();
-  });
-
-  beforeEach(() => {
-    delete process.env.TLS_REQUEST_KEY;
-    delete process.env.TLS_REQUEST_CERT;
-    delete process.env.TLS_REQUEST_CA;
-    delete process.env.TLS_SERVER_KEY;
-    delete process.env.TLS_SERVER_CERT;
-    delete process.env.TLS_CA;
-    option = {
-      url: testPath,
-      baseURL: `https://localhost:${process.env.PORT as string}`
-    };
-    stubPubSub();
-  });
-
-  after(async () => {
-    await server.shutdown();
-  });
-
-  it('should successfully establish a TLS connection', async () => {
-    process.env.TLS_REQUEST_KEY = path.resolve('certs/client.key');
-    process.env.TLS_REQUEST_CERT = path.resolve('certs/client.crt');
-    process.env.TLS_REQUEST_CA = path.resolve('certs/ca.crt');
-
-    loadTlsConfig();
-
-    const { data } = await tlsRequest(option);
-    expect(data).to.deep.equal(success);
-  });
-});

package/src/utils/tlsRequest/tlsRequest.ts

@@ -1,12 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { request } from 'utils/request';
-import { httpsAgent, loadTlsConfig } from 'utils/tlsConfig';
-
-/** Make a network request using TLS, this exposes the server client certificates to the destination */
-export async function tlsRequest<T = unknown>(
-  options: AxiosRequestConfig
-): Promise<AxiosResponse<T>> {
-  // if the config is not initial, will do that.
-  if (!httpsAgent) loadTlsConfig();
-  return request<T>({ httpsAgent, ...options });
-}

package/src/utils/trimPathSlash/index.ts

@@ -1 +0,0 @@
-export * from './trimPathSlash';

package/src/utils/trimPathSlash/trimPathSlash.test.ts

@@ -1,26 +0,0 @@
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { trimPathSlash } from './trimPathSlash';
-
-describe('Trim Path Slash', function () {
-  it('should remove starting slash', function () {
-    const result = trimPathSlash(`/${faker.lorem.word()}`);
-    expect(result[0]).to.not.equal('/');
-  });
-
-  it('should remove ending slash', function () {
-    const result = trimPathSlash(`${faker.lorem.word()}/`);
-    expect(result[result.length]).to.not.equal('/');
-  });
-
-  it('should remove both slash', function () {
-    const result = trimPathSlash(`/${faker.lorem.word()}/`);
-    expect(result[0]).to.not.equal('/');
-    expect(result[result.length]).to.not.equal('/');
-  });
-
-  it('should preserve slash in the string', function () {
-    const result = trimPathSlash(`${faker.lorem.word()}/${faker.lorem.word()}`);
-    expect(result).to.include('/');
-  });
-});

package/src/utils/trimPathSlash/trimPathSlash.ts

@@ -1,8 +0,0 @@
-/**
- * Remove slashes if they are the first or last chars of a string
- * @param url - URL to which slashes should be stripped
- * @return Cleaned-up string
- */
-export function trimPathSlash(url: string): string {
-  return url.replace(/\/$/, '').replace(/^\//, '');
-}