@digitaldefiance/node-express-suite 3.6.21 → 3.6.24

package/src/services/role.ts

@@ -1,414 +0,0 @@
-import { MemberType } from '@digitaldefiance/ecies-lib';
-import {
-  GlobalActiveContext,
-  I18nEngine,
-  IActiveContext,
-} from '@digitaldefiance/i18n-lib';
-import {
-  ClientSession,
-  Document,
-  Types,
-} from '@digitaldefiance/mongoose-types';
-import {
-  IRoleBase,
-  IRoleDTO,
-  ITokenRole,
-  ITokenRoleDTO,
-  LastAdminError,
-  Role,
-} from '@digitaldefiance/suite-core-lib';
-import { IUserDocument } from '../documents';
-import { IRoleDocument } from '../documents/role';
-import { IUserRoleDocument } from '../documents/user-role';
-import { BaseModelName } from '../enumerations/base-model-name';
-import { IApplication } from '../interfaces/application';
-import { IRoleBackendObject } from '../interfaces/backend-objects/role';
-import { ModelRegistry } from '../model-registry';
-import { convertStringToGenericId } from '../types/id-converters';
-import { omit } from '../utils';
-import { BaseService } from './base';
-
-/**
- * Service for managing roles
- */
-export class RoleService<
-  I extends string | Types.ObjectId = Types.ObjectId,
-  D extends Date = Date,
-  TTokenRole extends ITokenRole<I, D> = ITokenRole<I, D>,
-> extends BaseService {
-  /**
-   * Constructor for the role service
-   * @param application The application object
-   */
-  constructor(application: IApplication) {
-    super(application);
-  }
-
-  public static roleToRoleDTO<
-    I extends string | Types.ObjectId = Types.ObjectId,
-    D extends Date = Date,
-  >(
-    role: ITokenRole<I, D> | IRoleDocument<I> | Partial<IRoleBase<I>>,
-  ): ITokenRoleDTO {
-    const roleObj = role instanceof Document ? role.toObject() : role;
-    return {
-      _id: (role._id instanceof Types.ObjectId
-        ? role._id.toString()
-        : role._id) as string,
-      name: roleObj.name as string,
-      admin: roleObj.admin ?? false,
-      member: roleObj.member ?? false,
-      child: roleObj.child ?? false,
-      system: roleObj.system ?? false,
-      translatedName:
-        'translatedName' in role ? role.translatedName : role.name,
-      createdAt: (roleObj.createdAt instanceof Date
-        ? roleObj.createdAt.toISOString()
-        : roleObj.createdAt) as string,
-      createdBy: (role.createdBy instanceof Types.ObjectId
-        ? role.createdBy.toString()
-        : role.createdBy) as string,
-      updatedAt: (roleObj.updatedAt instanceof Date
-        ? roleObj.updatedAt.toISOString()
-        : roleObj.updatedAt) as string,
-      updatedBy: (role.updatedBy instanceof Types.ObjectId
-        ? role.updatedBy.toString()
-        : role.updatedBy) as string,
-      ...(roleObj.deletedAt
-        ? {
-            deletedAt: (roleObj.deletedAt instanceof Date
-              ? roleObj.deletedAt.toISOString()
-              : roleObj.deletedAt) as string,
-          }
-        : {}),
-      ...(role.deletedBy
-        ? {
-            deletedBy: (role.deletedBy instanceof Types.ObjectId
-              ? role.deletedBy.toString()
-              : role.deletedBy) as string,
-          }
-        : {}),
-    } as ITokenRoleDTO;
-  }
-
-  /**
-   * Given a Role DTO, reconstitute ids and dates
-   * @param role The Role DTO
-   * @returns An IRoleBackendObject
-   */
-  public static hydrateRoleDTOToBackend<
-    I extends string | Types.ObjectId = Types.ObjectId,
-  >(
-    role: ITokenRoleDTO,
-    idConverter?: (id: string) => I,
-  ): IRoleBackendObject<I> {
-    const convert =
-      idConverter ?? ((id: string) => convertStringToGenericId<I>(id));
-    return {
-      ...(omit<ITokenRoleDTO, 'translatedName'>(role, [
-        'translatedName',
-      ]) as IRoleDTO),
-      _id: convert(role._id),
-      name: role.name as Role,
-      createdAt: new Date(role.createdAt),
-      createdBy: convert(role.createdBy),
-      updatedAt: new Date(role.updatedAt),
-      updatedBy: convert(role.updatedBy),
-      ...(role.deletedAt ? { deletedAt: new Date(role.deletedAt) } : {}),
-      ...(role.deletedBy
-        ? {
-            deletedBy: convert(role.deletedBy),
-          }
-        : {}),
-    } as IRoleBackendObject<I>;
-  }
-
-  /**
-   * Gets the role ID by name
-   * @param roleName The name of the role
-   * @returns The role ID or null if not found
-   */
-  public async getRoleIdByName(
-    roleName: Role,
-    session?: ClientSession,
-  ): Promise<I | null> {
-    const RoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.Role,
-    ).model;
-    const role = await RoleModel.findOne({ name: roleName }, undefined, {
-      session,
-    }).select('_id');
-    if (!role) {
-      return null;
-    }
-    return role._id as I;
-  }
-
-  /**
-   * Creates a new role
-   * @param roleData The role data
-   * @param session Optional mongoose session
-   * @returns The created role document
-   */
-  public async createRole(
-    roleData: IRoleBase<I, D, Role>,
-    session?: ClientSession | null,
-  ): Promise<IRoleDocument<I>> {
-    const RoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.Role,
-    ).model;
-    const role = new RoleModel(roleData);
-    const savedRole = await role.save(session ? { session } : {});
-    return savedRole as IRoleDocument<I>;
-  }
-
-  /**
-   * Adds a user to a role
-   * @param roleId - The role id
-   * @param userId - The user id
-   * @param createdBy - The user creating the relationship
-   * @param session Optional mongoose session
-   */
-  public async addUserToRole(
-    roleId: I,
-    userId: I,
-    createdBy: I,
-    session?: ClientSession,
-    overrideId?: I,
-  ): Promise<IUserRoleDocument<I>> {
-    const UserRoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.UserRole,
-    ).model;
-
-    // Check if the user-role relationship already exists (and is not deleted)
-    const existingUserRole = await UserRoleModel.findOne({
-      userId,
-      roleId,
-      deletedAt: { $exists: false },
-    }).session(session ?? null);
-
-    if (existingUserRole) {
-      // Relationship already exists, no need to create it again
-      return existingUserRole;
-    }
-
-    const userRole = new UserRoleModel({
-      ...(overrideId ? { _id: overrideId } : {}),
-      userId,
-      roleId,
-      createdBy,
-      updatedBy: createdBy,
-    });
-    const result = await userRole.save({ session });
-    return result;
-  }
-
-  /**
-   * Removes a user from a role
-   * @param roleId - The role id
-   * @param userId - The user id
-   * @param deletedBy - The user removing the relationship
-   * @param session Optional mongoose session
-   * @throws LastAdminError if attempting to remove the last admin
-   */
-  public async removeUserFromRole(
-    roleId: I,
-    userId: I,
-    deletedBy: I,
-    session?: ClientSession,
-  ): Promise<void> {
-    const RoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.Role,
-    ).model;
-    const UserRoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.UserRole,
-    ).model;
-
-    const role = await RoleModel.findById(roleId).session(session ?? null);
-    if (role?.admin) {
-      const adminCount = await UserRoleModel.countDocuments({
-        roleId,
-        deletedAt: { $exists: false },
-      }).session(session ?? null);
-      if (adminCount <= 1) {
-        throw new LastAdminError();
-      }
-    }
-
-    await UserRoleModel.findOneAndUpdate(
-      { userId, roleId, deletedAt: { $exists: false } },
-      { deletedAt: new Date(), deletedBy },
-      { session },
-    );
-  }
-
-  /**
-   * Deletes a role by ID
-   * @param roleId The role ID
-   * @param deleter The ID of the user deleting the role
-   * @param hardDelete Whether to hard delete the role
-   * @param session Optional mongoose session
-   */
-  public async deleteRole(
-    roleId: I,
-    deleter: I,
-    hardDelete: boolean,
-    session?: ClientSession,
-  ): Promise<void> {
-    const RoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.Role,
-    ).model;
-    if (hardDelete) {
-      await RoleModel.findByIdAndDelete(roleId).session(session ?? null);
-    } else {
-      await RoleModel.findByIdAndUpdate(roleId, {
-        deletedAt: new Date(),
-        deletedBy: deleter,
-      }).session(session ?? null);
-    }
-  }
-
-  /**
-   * Gets all roles for a user
-   * @param userId The user ID
-   * @param session Optional mongoose session
-   * @returns The roles the user is a member of
-   */
-  public async getUserRoles(
-    userId: I,
-    session?: ClientSession,
-  ): Promise<IRoleDocument<I>[]> {
-    const UserRoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.UserRole,
-    ).model;
-    const RoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.Role,
-    ).model;
-    if (!UserRoleModel || !RoleModel) throw new Error('Model not registered');
-
-    // Return full documents
-    const userRoles = await UserRoleModel.find({
-      userId,
-      deletedAt: { $exists: false },
-    })
-      .select('roleId')
-      .session(session ?? null);
-
-    const roleIds = userRoles.map((ur) => ur.roleId);
-    return (await RoleModel.find({
-      _id: { $in: roleIds },
-      deletedAt: { $exists: false },
-    }).session(session ?? null)) as IRoleDocument<I>[];
-  }
-
-  /**
-   * Gets all users for a role
-   * @param roleId The role ID
-   * @param session Optional mongoose session
-   * @returns The user IDs that are members of the role
-   */
-  public async getRoleUsers(roleId: I, session?: ClientSession): Promise<I[]> {
-    const UserRoleModel = ModelRegistry.instance.get<any, any>(
-      BaseModelName.UserRole,
-    ).model;
-
-    // Return full documents
-    const userRoles = await UserRoleModel.find({
-      roleId,
-      deletedAt: { $exists: false },
-    })
-      .select('userId')
-      .session(session ?? null);
-
-    return userRoles.map((ur) => ur.userId);
-  }
-
-  /** Convert roles to translated TokenRoles */
-  public rolesToTokenRoles(
-    roles: Array<IRoleBackendObject<I>>,
-    overrideLanguage?: string,
-  ): Array<TTokenRole> {
-    return roles.map((role) => {
-      const engine = I18nEngine.getInstance('default');
-      const userLang = GlobalActiveContext.getInstance<
-        string,
-        IActiveContext<string>
-      >().userLanguage;
-      const lang = (overrideLanguage || userLang || 'en-US') as string;
-      const roleTranslation = engine.translateEnum(Role, role.name, lang);
-      // Convert Mongoose document to plain object if needed
-      const roleObj = role instanceof Document ? role.toObject() : role;
-      return {
-        ...roleObj,
-        translatedName: roleTranslation,
-      } as TTokenRole;
-    });
-  }
-
-  public async isUserAdmin(
-    userDoc: IUserDocument<string, I>,
-    session?: ClientSession,
-    providedRoles?: Array<IRoleDocument<I>>,
-  ): Promise<boolean> {
-    const roles =
-      providedRoles ?? (await this.getUserRoles(userDoc._id, session));
-    if (roles.filter((r) => r.admin).length > 0) {
-      return true;
-    }
-    return false;
-  }
-
-  public async isUserMember(
-    userDoc: IUserDocument<string, I>,
-    session?: ClientSession,
-    providedRoles?: Array<IRoleDocument<I>>,
-  ): Promise<boolean> {
-    const roles =
-      providedRoles ?? (await this.getUserRoles(userDoc._id, session));
-    if (roles.filter((r) => r.member).length > 0) {
-      return true;
-    }
-    return false;
-  }
-
-  public async isUserChild(
-    userDoc: IUserDocument<string, I>,
-    session?: ClientSession,
-    providedRoles?: Array<IRoleDocument<I>>,
-  ): Promise<boolean> {
-    const roles =
-      providedRoles ?? (await this.getUserRoles(userDoc._id, session));
-    if (roles.filter((r) => r.child).length > 0) {
-      return true;
-    }
-    return false;
-  }
-
-  public async isSystemUser(
-    userDoc: IUserDocument<string, I>,
-    session?: ClientSession,
-    providedRoles?: Array<IRoleDocument<I>>,
-  ): Promise<boolean> {
-    const roles =
-      providedRoles ?? (await this.getUserRoles(userDoc._id, session));
-    return roles.some((r) => r.system);
-  }
-
-  public async getMemberType(
-    userDoc: IUserDocument<string, I>,
-    session?: ClientSession,
-    providedRoles?: Array<IRoleDocument<I>>,
-  ): Promise<MemberType> {
-    const roles =
-      providedRoles ?? (await this.getUserRoles(userDoc._id, session));
-    if (await this.isSystemUser(userDoc, session, roles)) {
-      return MemberType.System;
-    } else if (await this.isUserAdmin(userDoc, session, roles)) {
-      return MemberType.Admin;
-    } else if (await this.isUserMember(userDoc, session, roles)) {
-      return MemberType.User;
-    } else {
-      return MemberType.Anonymous;
-    }
-  }
-}

package/src/services/symmetric.ts

@@ -1,139 +0,0 @@
-import { ECIES, IECIESConstants } from '@digitaldefiance/ecies-lib';
-import { createCipheriv, createDecipheriv, randomBytes } from 'crypto';
-import { SymmetricErrorType } from '../enumerations/symmetric-error-type';
-import { SymmetricError } from '../errors/symmetric';
-import { ISymmetricEncryptionResults } from '../interfaces/symmetric-encryption-results';
-
-function hasToJsonMethod<T>(obj: T): obj is T & { toJson: () => string } {
-  return typeof obj === 'object' && obj !== null && 'toJson' in obj;
-}
-
-/**
- * Service for handling symmetric encryption operations.
- * This service provides functionality for:
- * - AES encryption/decryption of buffers and JSON data
- * - Key and IV generation
- * - Secure cryptographic operations
- */
-export class SymmetricService {
-  public static symmetricKeyBits(
-    eciesConstants: IECIESConstants = ECIES,
-  ): number {
-    return eciesConstants.SYMMETRIC.KEY_BITS;
-  }
-
-  public static symmetricKeyBytes(
-    eciesConstants: IECIESConstants = ECIES,
-  ): number {
-    return eciesConstants.SYMMETRIC.KEY_SIZE;
-  }
-
-  /**
-   * Encrypt data with AES
-   * @param data The data to encrypt
-   * @param encryptionKey Optional encryption key (will be randomly generated if not provided)
-   * @returns Object containing encrypted data and key
-   */
-  public static encryptBuffer(
-    data: Buffer,
-    encryptionKey?: Buffer,
-    eciesConstants: IECIESConstants = ECIES,
-  ): ISymmetricEncryptionResults {
-    if (
-      encryptionKey &&
-      encryptionKey.length != eciesConstants.SYMMETRIC.KEY_SIZE
-    ) {
-      throw new SymmetricError(SymmetricErrorType.InvalidKeyLength);
-    }
-
-    // encrypt the document using AES-256 and the key
-    // Initialization Vector
-    const ivBuffer = randomBytes(eciesConstants.IV_SIZE);
-    const key: Buffer =
-      encryptionKey ?? randomBytes(eciesConstants.SYMMETRIC.KEY_SIZE);
-    const cipher = createCipheriv(
-      eciesConstants.SYMMETRIC_ALGORITHM_CONFIGURATION,
-      key,
-      ivBuffer,
-    );
-
-    const ciphertextBuffer = cipher.update(data);
-    const finalBuffer = cipher.final();
-    const authTag = cipher.getAuthTag();
-
-    const encryptionIvPlusData: Buffer = Buffer.concat([
-      ivBuffer,
-      ciphertextBuffer,
-      finalBuffer,
-      authTag,
-    ]);
-    return {
-      encryptedData: encryptionIvPlusData,
-      key: key,
-    };
-  }
-
-  /**
-   * Decrypt the given buffer with AES
-   * @param encryptedData The encrypted data to decrypt
-   * @param key The key to use for decryption
-   * @returns Decrypted data as a Buffer
-   */
-  public static decryptBuffer(
-    encryptedData: Buffer,
-    key: Buffer,
-    eciesConstants: IECIESConstants = ECIES,
-  ): Buffer {
-    const ivBuffer = encryptedData.subarray(0, eciesConstants.IV_SIZE);
-    const authTagStart = encryptedData.length - eciesConstants.AUTH_TAG_SIZE;
-    const ciphertextBuffer = encryptedData.subarray(
-      eciesConstants.IV_SIZE,
-      authTagStart,
-    );
-    const authTag = encryptedData.subarray(authTagStart);
-
-    const decipher = createDecipheriv(
-      eciesConstants.SYMMETRIC_ALGORITHM_CONFIGURATION,
-      key,
-      ivBuffer,
-    );
-    decipher.setAuthTag(authTag);
-
-    return Buffer.concat([decipher.update(ciphertextBuffer), decipher.final()]);
-  }
-
-  /**
-   * Encrypt JSON data with AES
-   * @param data The data to encrypt
-   * @param encryptionKey Optional encryption key (will be randomly generated if not provided)
-   * @returns Object containing encrypted data and key
-   */
-  public static encryptJson<T>(
-    data: T,
-    encryptionKey?: Buffer,
-  ): ISymmetricEncryptionResults {
-    if (data === null || data === undefined) {
-      throw new SymmetricError(SymmetricErrorType.DataNullOrUndefined);
-    }
-    let dataBuffer: Buffer;
-    if (hasToJsonMethod<T>(data)) {
-      // amazonq-ignore-next-line false positive
-      dataBuffer = Buffer.from(data.toJson(), 'utf8');
-    } else {
-      dataBuffer = Buffer.from(JSON.stringify(data), 'utf8');
-    }
-    return SymmetricService.encryptBuffer(dataBuffer, encryptionKey);
-  }
-
-  /**
-   * Decrypt the given buffer with AES and parse as JSON
-   * @param encryptedData The encrypted data to decrypt
-   * @param key The key to use for decryption
-   * @returns Decrypted data parsed as type T
-   */
-  public static decryptJson<T>(encryptedData: Buffer, key: Buffer): T {
-    return JSON.parse(
-      SymmetricService.decryptBuffer(encryptedData, key).toString('utf8'),
-    ) as T;
-  }
-}

package/src/services/system-user.ts

@@ -1,79 +0,0 @@
-import {
-  EmailString,
-  MemberType,
-  SecureBuffer,
-  SecureString,
-} from '@digitaldefiance/ecies-lib';
-import { Types } from '@digitaldefiance/mongoose-types';
-import {
-  Member as BackendMember,
-  ECIESService,
-} from '@digitaldefiance/node-ecies-lib';
-import {
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-} from '@digitaldefiance/suite-core-lib';
-import { Environment } from '../environment';
-import { IConstants } from '../interfaces/constants';
-
-/**
- * Service to manage the system member's wallet.
- */
-export class SystemUserService {
-  private static systemUser: BackendMember<Buffer> | null = null;
-
-  /**
-   * Initializes and returns the system member's Member instance.
-   * The mnemonic should be stored securely in environment variables.
-   */
-  public static getSystemUser(
-    environment: Environment,
-    constants: IConstants,
-  ): BackendMember<Buffer> {
-    if (!SystemUserService.systemUser) {
-      if (!environment.systemMnemonic) {
-        throw new TranslatableSuiteError(
-          SuiteCoreStringKey.Admin_EnvNotSetTemplate,
-          {
-            NAME: 'SYSTEM_MNEMONIC',
-          },
-        );
-      }
-      const mnemonic: SecureString = environment.systemMnemonic;
-      const eciesService = new ECIESService(undefined, constants.ECIES);
-      const { wallet } = eciesService.walletAndSeedFromMnemonic(mnemonic);
-      const keyPair = eciesService.walletToSimpleKeyPairBuffer(wallet);
-
-      SystemUserService.systemUser = new BackendMember(
-        eciesService,
-        MemberType.System,
-        constants.SystemUser,
-        new EmailString(constants.SystemEmail),
-        keyPair.publicKey,
-        new SecureBuffer(keyPair.privateKey),
-        wallet,
-      );
-      if (
-        SystemUserService.systemUser.publicKey.toString('hex') !==
-        environment.systemPublicKeyHex
-      ) {
-        console.warn('System public key does not match environment variable', {
-          derived: SystemUserService.systemUser.publicKey.toString('hex'),
-          expected: environment.systemPublicKeyHex,
-        });
-      }
-    }
-    return SystemUserService.systemUser;
-  }
-
-  public static setSystemUser<
-    TID extends string | Types.ObjectId | Buffer | Uint8Array = Buffer,
-  >(user: BackendMember<TID>, constants: IConstants): void {
-    if (user.type !== MemberType.System || user.name !== constants.SystemUser) {
-      throw new Error(
-        'setSystemUser can only be called with a MemberType.System user',
-      );
-    }
-    SystemUserService.systemUser = user as BackendMember<Buffer>;
-  }
-}