@digitaldefiance/node-express-suite 3.6.14 → 3.6.15

package/src/services/direct-login-token.ts

@@ -1,62 +0,0 @@
-import {
-  DirectTokenUsedError,
-  FailedToUseDirectTokenError,
-  IUsedDirectLoginTokenBase,
-} from '@digitaldefiance/suite-core-lib';
-import { ClientSession, Types } from '@digitaldefiance/mongoose-types';
-import { IBaseDocument } from '../documents';
-import { IUsedDirectLoginTokenDocument } from '../documents/used-direct-login-token';
-import { BaseModelName } from '../enumerations/base-model-name';
-import { Environment } from '../environment';
-import { IConstants } from '../interfaces';
-import { IApplication } from '../interfaces/application';
-import { ModelRegistry } from '../model-registry';
-import { withTransaction } from '../utils';
-export abstract class DirectLoginTokenService {
-  public static async useToken<I extends string | Types.ObjectId = Types.ObjectId>(
-    app: IApplication,
-    userId: I,
-    token: string,
-    session?: ClientSession,
-  ): Promise<void> {
-    return withTransaction(
-      app.db.connection,
-      app.environment.mongo.useTransactions,
-      session,
-      async (sess) => {
-        const UsedDirectLoginTokenModel = ModelRegistry.instance.get<
-          IUsedDirectLoginTokenBase<I>,
-          any
-        >(BaseModelName.UsedDirectLoginToken).model;
-        const tokenExists = await UsedDirectLoginTokenModel.exists({
-          userId,
-          token,
-        }).session(sess ?? null);
-        if (tokenExists) {
-          throw new DirectTokenUsedError();
-        }
-        try {
-          const newTokens = await UsedDirectLoginTokenModel.create(
-            [{ userId, token }],
-            {
-              session: sess,
-            },
-          );
-          if (newTokens.length !== 1) {
-            throw new FailedToUseDirectTokenError();
-          }
-        } catch (err) {
-          // re-throw FailedToUseDirectTokenError
-          if (err instanceof FailedToUseDirectTokenError) {
-            throw err;
-          }
-          // throw FailedToUseDirectTokenError on duplicate key error or other errors
-          throw new FailedToUseDirectTokenError();
-        }
-      },
-      {
-        timeoutMs: app.environment.mongo.transactionTimeout,
-      },
-    );
-  }
-}

package/src/services/dummy-email-service.ts

@@ -1,20 +0,0 @@
-import { IApplication, IEmailService } from '../interfaces';
-
-/**
- * Dummy email service that does nothing.
- * Primarily for testing
- */
-export class DummyEmailService<TApplication extends IApplication = IApplication>
-  implements IEmailService
-{
-  constructor(application: TApplication) {}
-  public async sendEmail(
-    to: string,
-    subject: string,
-    text: string,
-    html: string,
-  ): Promise<void> {
-    // Do nothing
-    return;
-  }
-}

package/src/services/fec-usage-example.ts

@@ -1,102 +0,0 @@
-import { FecService } from './fec';
-
-/**
- * Example usage of the adapted FEC service for filesystem/S3 objects
- */
-export class FecUsageExample {
-  private fecService = new FecService();
-
-  /**
-   * Example: Create parity data for a file and store it separately
-   */
-  async createFileWithParity(fileData: Buffer, parityCount: number = 2) {
-    // Create parity data
-    const parityData = await this.fecService.createParityData(
-      fileData,
-      parityCount,
-    );
-
-    // In a real implementation, you would:
-    // 1. Store the original file (e.g., to S3 as "file.dat")
-    // 2. Store each parity data separately (e.g., "file.dat.parity.0", "file.dat.parity.1")
-    // 3. Store metadata about the original file size
-
-    return {
-      originalData: fileData,
-      parityData,
-      originalSize: fileData.length,
-    };
-  }
-
-  /**
-   * Example: Recover a corrupted file using parity data
-   */
-  async recoverCorruptedFile(
-    parityData: Array<{ data: Buffer; index: number }>,
-    originalSize: number,
-  ) {
-    // Attempt recovery (pass null for corrupted data)
-    const result = await this.fecService.recoverFileData(
-      null, // corrupted data
-      parityData,
-      originalSize,
-    );
-
-    if (result.recovered) {
-      console.log('File successfully recovered!');
-      return result.data;
-    } else {
-      throw new Error('File recovery failed');
-    }
-  }
-
-  /**
-   * Example: Verify file integrity using parity data
-   */
-  async verifyFile(
-    fileData: Buffer,
-    parityData: Array<{ data: Buffer; index: number }>,
-  ): Promise<boolean> {
-    return await this.fecService.verifyFileIntegrity(fileData, parityData);
-  }
-
-  /**
-   * Complete example workflow
-   */
-  async demonstrateWorkflow() {
-    // Original file data
-    const originalFile = Buffer.from(
-      'This is important file data that needs protection!',
-    );
-
-    // Step 1: Create parity data
-    console.log('Creating parity data...');
-    const { parityData, originalSize } = await this.createFileWithParity(
-      originalFile,
-      2,
-    );
-
-    // Step 2: Verify integrity
-    console.log('Verifying file integrity...');
-    const isValid = await this.verifyFile(originalFile, parityData);
-    console.log('File integrity check:', isValid ? 'PASSED' : 'FAILED');
-
-    // Step 3: Simulate file corruption and recovery
-    console.log('Simulating file corruption and recovery...');
-    const recoveredFile = await this.recoverCorruptedFile(
-      parityData,
-      originalSize,
-    );
-
-    // Step 4: Verify recovery
-    const recoverySuccessful = originalFile.equals(recoveredFile);
-    console.log('Recovery successful:', recoverySuccessful ? 'YES' : 'NO');
-
-    return {
-      originalFile,
-      recoveredFile,
-      parityData,
-      recoverySuccessful,
-    };
-  }
-}

package/src/services/fec.ts

@@ -1,355 +0,0 @@
-import { FecError, FecErrorType } from '@digitaldefiance/suite-core-lib';
-import { ReedSolomonErasure } from '@subspace/reed-solomon-erasure.wasm';
-import { FEC } from '../constants';
-import { IFECConsts } from '../interfaces';
-
-/**
- * FecService provides Forward Error Correction (FEC) functionality for filesystem/S3 objects.
- * This service is used to:
- * 1. Create parity data for file recovery
- * 2. Recover corrupted files using parity data
- * 3. Ensure data integrity across distributed storage
- *
- * This implementation uses Reed-Solomon erasure coding to:
- * 1. Split file data into shards
- * 2. Create parity shards
- * 3. Recover lost shards using parity
- */
-
-export interface ParityData {
-  data: Buffer;
-  index: number;
-}
-
-export interface RecoveryResult {
-  data: Buffer;
-  recovered: boolean;
-}
-export class FecService {
-  /**
-   * Given a data buffer, encode it using Reed-Solomon erasure coding.
-   * This will produce a buffer of size (shardSize * (dataShards + parityShards)) or (shardSize * parityShards) if fecOnly is true.
-   */
-  public async encode(
-    data: Buffer,
-    shardSize: number,
-    dataShards: number,
-    parityShards: number,
-    fecOnly: boolean,
-    fecConstants: IFECConsts = FEC,
-  ): Promise<Buffer> {
-    // Validate parameters
-    if (!data || data.length === 0) {
-      throw new FecError(FecErrorType.DataRequired);
-    }
-
-    if (data.length !== shardSize * dataShards) {
-      throw new FecError(FecErrorType.InvalidDataLength, undefined, {
-        LENGTH: data.length.toString(),
-        EXPECTED: (shardSize * dataShards).toString(),
-      });
-    }
-
-    if (shardSize > fecConstants.MAX_SHARD_SIZE) {
-      throw new FecError(FecErrorType.ShardSizeExceedsMaximum, undefined, {
-        SIZE: shardSize.toString(),
-        MAXIMUM: fecConstants.MAX_SHARD_SIZE.toString(),
-      });
-    }
-
-    if (dataShards <= 0 || parityShards <= 0) {
-      throw new FecError(FecErrorType.InvalidShardCounts);
-    }
-
-    try {
-      const shards = new Uint8Array(shardSize * (dataShards + parityShards));
-      shards.set(new Uint8Array(data));
-
-      // Encoding
-      const reedSolomonErasure =
-        await ReedSolomonErasure.fromCurrentDirectory();
-      reedSolomonErasure.encode(shards, dataShards, parityShards);
-
-      return fecOnly
-        ? Buffer.from(shards.subarray(shardSize * dataShards))
-        : Buffer.from(shards);
-    } catch (error) {
-      throw new FecError(FecErrorType.FecEncodingFailed, undefined, {
-        ERROR: error instanceof Error ? error.message : 'Unknown error',
-      });
-    }
-  }
-
-  /**
-   * Given a data buffer, reconstruct/repair it using Reed-Solomon erasure coding.
-   * This will produce a buffer of size (shardSize * dataShards).
-   */
-  public async decode(
-    data: Buffer,
-    shardSize: number,
-    dataShards: number,
-    parityShards: number,
-    shardsAvailable: boolean[],
-  ): Promise<Buffer> {
-    // Validate parameters
-    if (!data || data.length === 0) {
-      throw new FecError(FecErrorType.DataRequired);
-    }
-
-    if (data.length !== shardSize * (dataShards + parityShards)) {
-      throw new FecError(FecErrorType.InvalidDataLength, undefined, {
-        LENGTH: data.length.toString(),
-        EXPECTED: (shardSize * (dataShards + parityShards)).toString(),
-      });
-    }
-
-    if (
-      !shardsAvailable ||
-      shardsAvailable.length !== dataShards + parityShards
-    ) {
-      throw new FecError(FecErrorType.InvalidShardsAvailableArray);
-    }
-
-    const availableCount = shardsAvailable.filter((x) => x).length;
-    if (availableCount < dataShards) {
-      throw new FecError(FecErrorType.NotEnoughShardsAvailable, undefined, {
-        AVAILABLE: availableCount.toString(),
-        REQUIRED: dataShards.toString(),
-      });
-    }
-
-    try {
-      const uint8Data = new Uint8Array(data);
-      const reedSolomonErasure =
-        await ReedSolomonErasure.fromCurrentDirectory();
-      reedSolomonErasure.reconstruct(
-        uint8Data,
-        dataShards,
-        parityShards,
-        shardsAvailable,
-      );
-      return Buffer.from(uint8Data.subarray(0, shardSize * dataShards));
-    } catch (error) {
-      throw new FecError(FecErrorType.FecDecodingFailed, undefined, {
-        ERROR: error instanceof Error ? error.message : 'Unknown error',
-      });
-    }
-  }
-
-  /**
-   * Create parity data for a file buffer.
-   */
-  public async createParityData(
-    fileData: Buffer,
-    parityCount: number,
-    fecConstants: IFECConsts = FEC,
-  ): Promise<ParityData[]> {
-    if (!fileData || fileData.length === 0) {
-      throw new FecError(FecErrorType.DataRequired);
-    }
-
-    if (parityCount <= 0) {
-      throw new FecError(FecErrorType.ParityDataCountMustBePositive);
-    }
-
-    const shardSize = Math.min(fileData.length, fecConstants.MAX_SHARD_SIZE);
-    const requiredShards = Math.ceil(fileData.length / shardSize);
-
-    try {
-      const resultParityData: Buffer[] = Array(parityCount)
-        .fill(null)
-        .map(() => Buffer.alloc(0));
-
-      // Process each chunk
-      for (let i = 0; i < requiredShards; i++) {
-        const start = i * shardSize;
-        const end = Math.min(start + shardSize, fileData.length);
-        const chunk = fileData.subarray(start, end);
-
-        // Pad chunk if necessary
-        const paddedChunk = Buffer.alloc(shardSize);
-        paddedChunk.set(chunk.subarray(0, shardSize));
-
-        const chunkParity = await this.encode(
-          paddedChunk,
-          shardSize,
-          1,
-          parityCount,
-          true,
-          fecConstants,
-        );
-
-        // Distribute parity data
-        for (let j = 0; j < parityCount; j++) {
-          const parityChunk = chunkParity.subarray(
-            j * shardSize,
-            (j + 1) * shardSize,
-          );
-          const combined = Buffer.alloc(
-            resultParityData[j].length + parityChunk.length,
-          );
-          combined.set(resultParityData[j], 0);
-          combined.set(parityChunk, resultParityData[j].length);
-          resultParityData[j] = combined;
-        }
-      }
-
-      return resultParityData.map((data, index) => ({
-        data,
-        index,
-      }));
-    } catch (error) {
-      throw new FecError(FecErrorType.FecEncodingFailed, undefined, {
-        ERROR: error instanceof Error ? error.message : 'Unknown error',
-      });
-    }
-  }
-
-  /**
-   * Recover file data using parity data. Pass null for corrupted data.
-   */
-  public async recoverFileData(
-    corruptedData: Buffer | null,
-    parityData: ParityData[],
-    originalSize: number,
-    fecConstants: IFECConsts = FEC,
-  ): Promise<RecoveryResult> {
-    if (!parityData || parityData.length === 0) {
-      throw new FecError(FecErrorType.ParityDataRequired);
-    }
-
-    if (originalSize <= 0) {
-      throw new FecError(FecErrorType.InvalidDataLength);
-    }
-
-    try {
-      const shardSize = Math.min(originalSize, fecConstants.MAX_SHARD_SIZE);
-      const requiredShards = Math.ceil(originalSize / shardSize);
-      let recoveredData = Buffer.alloc(0);
-      let parityUsed = false;
-
-      // Recover each shard
-      for (let i = 0; i < requiredShards; i++) {
-        const start = i * shardSize;
-        const end = Math.min(start + shardSize, originalSize);
-        const chunkSize = end - start;
-
-        // Use corrupted data if available, otherwise create placeholder
-        const corruptedShard = corruptedData
-          ? corruptedData.subarray(start, Math.min(end, corruptedData.length))
-          : Buffer.alloc(0);
-
-        const parityChunks = parityData.map((parity) =>
-          parity.data.subarray(i * shardSize, (i + 1) * shardSize),
-        );
-
-        const hasDataShard = corruptedShard.length > 0;
-        const paddedCorruptedShard = Buffer.alloc(shardSize);
-        if (hasDataShard) {
-          paddedCorruptedShard.set(
-            corruptedShard.subarray(
-              0,
-              Math.min(shardSize, corruptedShard.length),
-            ),
-          );
-        }
-
-        let shardIsHealthy = false;
-        if (hasDataShard) {
-          const regeneratedParity = await this.encode(
-            paddedCorruptedShard,
-            shardSize,
-            1,
-            parityData.length,
-            true,
-            fecConstants,
-          );
-
-          shardIsHealthy = parityChunks.every((parityChunk, index) =>
-            parityChunk.equals(
-              Uint8Array.from(
-                regeneratedParity.subarray(
-                  index * shardSize,
-                  (index + 1) * shardSize,
-                ),
-              ),
-            ),
-          );
-        }
-
-        if (shardIsHealthy) {
-          const actualShard = Buffer.from(
-            paddedCorruptedShard.subarray(0, chunkSize),
-          );
-          const combinedRecovered = Buffer.alloc(
-            recoveredData.length + actualShard.length,
-          );
-          combinedRecovered.set(recoveredData, 0);
-          combinedRecovered.set(actualShard, recoveredData.length);
-          recoveredData = combinedRecovered;
-          continue;
-        }
-
-        // Mark data shard as missing and attempt recovery using parity
-        parityUsed = true;
-        const shardData = Buffer.alloc((1 + parityData.length) * shardSize);
-        shardData.set(paddedCorruptedShard, 0);
-        parityChunks.forEach((chunk, index) => {
-          shardData.set(chunk, (index + 1) * shardSize);
-        });
-
-        const availableShards = [false, ...Array(parityData.length).fill(true)];
-
-        const recoveredShard = await this.decode(
-          shardData,
-          shardSize,
-          1,
-          parityData.length,
-          availableShards,
-        );
-
-        const actualShard = recoveredShard.subarray(0, chunkSize);
-        const combinedRecovered = Buffer.alloc(
-          recoveredData.length + actualShard.length,
-        );
-        combinedRecovered.set(recoveredData, 0);
-        combinedRecovered.set(actualShard, recoveredData.length);
-        recoveredData = combinedRecovered;
-      }
-
-      return {
-        data: recoveredData,
-        recovered: parityUsed || corruptedData === null,
-      };
-    } catch (error) {
-      throw new FecError(FecErrorType.FecDecodingFailed, undefined, {
-        ERROR: error instanceof Error ? error.message : 'Unknown error',
-      });
-    }
-  }
-
-  /**
-   * Verify file integrity using parity data.
-   */
-  public async verifyFileIntegrity(
-    fileData: Buffer,
-    parityData: ParityData[],
-  ): Promise<boolean> {
-    try {
-      const regeneratedParity = await this.createParityData(
-        fileData,
-        parityData.length,
-      );
-
-      return parityData.every(
-        (original, index) =>
-          Buffer.compare(
-            new Uint8Array(original.data),
-            new Uint8Array(regeneratedParity[index].data),
-          ) === 0,
-      );
-    } catch {
-      return false;
-    }
-  }
-}

package/src/services/jwt.ts

@@ -1,133 +0,0 @@
-import {
-  ITokenRole,
-  ITokenRoleDTO,
-  ITokenUser,
-} from '@digitaldefiance/suite-core-lib';
-import {
-  JsonWebTokenError,
-  JwtPayload,
-  TokenExpiredError as JwtTokenExpiredError,
-  sign,
-  verify,
-  VerifyOptions,
-} from 'jsonwebtoken';
-import { Types } from '@digitaldefiance/mongoose-types';
-import { promisify } from 'util';
-import { IBaseDocument } from '../documents';
-import { IUserDocument } from '../documents/user';
-import { Environment } from '../environment';
-import { InvalidJwtTokenError } from '../errors/invalid-jwt-token';
-import { TokenExpiredError } from '../errors/token-expired';
-import { IConstants } from '../interfaces';
-import { IApplication } from '../interfaces/application';
-import { IJwtSignResponse } from '../interfaces/jwt-sign-response';
-import { BaseService } from './base';
-import { RoleService } from './role';
-
-const verifyAsync = promisify<
-  string,
-  string | Buffer,
-  VerifyOptions,
-  JwtPayload | string
->(verify);
-
-export class JwtService<
-  I extends string | Types.ObjectId = Types.ObjectId,
-  D extends Date = Date,
-  TTokenRole extends ITokenRole<I, D> = ITokenRole<I, D>,
-  TTokenUser extends ITokenUser = ITokenUser,
-  TApplication extends IApplication = IApplication,
-> extends BaseService {
-  private readonly roleService: RoleService<I, D, TTokenRole>;
-
-  /**
-   * Constructor for the JWT service
-   * @param application The application object
-   */
-  constructor(application: TApplication) {
-    super(application);
-    this.roleService = new RoleService<I, D, TTokenRole>(application);
-  }
-
-  /**
-   * Sign a JWT token for a user
-   * @param userDoc The user document to sign the token for
-   * @param jwtSecret The secret to sign the token with
-   * @param overrideLanguage Optional language to use for role translations
-   * @returns The signed token
-   */
-  public async signToken(
-    userDoc: IUserDocument<string, I>,
-    jwtSecret: string,
-    overrideLanguage?: string,
-  ): Promise<IJwtSignResponse<I, D, TTokenRole>> {
-    // look for roles the user is a member of (the role contains the user id in the user's roles array)
-    const roles = await this.roleService.getUserRoles(userDoc._id);
-    const tokenRoles: Array<TTokenRole> = this.roleService.rolesToTokenRoles(
-      roles,
-      overrideLanguage,
-    );
-    const tokenRoleDTOs = tokenRoles.map((role) =>
-      RoleService.roleToRoleDTO<I, D>(role),
-    );
-    const roleTranslatedNames = tokenRoles.map((role) => role.translatedName);
-    const roleNames = tokenRoles.map((role) => role.name);
-    const tokenUser = {
-      userId: userDoc._id.toString(),
-      roles: tokenRoleDTOs,
-    } as TTokenUser;
-    // amazonq-ignore-next-line false positive
-    const token = sign(tokenUser, jwtSecret, {
-      algorithm: this.application.constants.JWT.ALGORITHM,
-      allowInsecureKeySizes: false,
-      expiresIn: this.application.constants.JWT.EXPIRATION_SEC,
-    });
-    return {
-      token,
-      tokenUser,
-      roleNames,
-      roleTranslatedNames,
-      roles: tokenRoles,
-      roleDTOs: tokenRoleDTOs,
-    };
-  }
-
-  /**
-   * Verify a JWT token and return the user data
-   * @param token The token to verify
-   * @returns The user data
-   * @throws InvalidTokenError
-   */
-  public async verifyToken(token: string): Promise<TTokenUser | null> {
-    try {
-      const decoded = (await verifyAsync(
-        token,
-        this.application.environment.jwtSecret,
-        {
-          algorithms: [this.application.constants.JWT.ALGORITHM],
-        },
-      )) as JwtPayload;
-
-      if (
-        typeof decoded === 'object' &&
-        decoded !== null &&
-        'userId' in decoded &&
-        'roles' in decoded
-      ) {
-        return {
-          userId: decoded['userId'] as string,
-          roles: decoded['roles'] as ITokenRoleDTO[],
-        } as TTokenUser;
-      } else {
-        return null;
-      }
-    } catch (err) {
-      if (err instanceof JwtTokenExpiredError) {
-        throw new TokenExpiredError();
-      } else if (err instanceof JsonWebTokenError) {
-        throw err;
-      }
-      throw new InvalidJwtTokenError();
-    }
-  }
-}