@digitaldefiance/node-express-suite 1.0.21 → 1.0.23

package/{dist/interfaces/discriminator-collections.d.ts → src/interfaces/discriminator-collections.ts}

@@ -1,7 +1,7 @@
 import { Model } from 'mongoose';
 import { IBaseDocument } from '../documents/base';
+
 export interface IDiscriminatorCollections<T extends IBaseDocument<any>> {
-    byType: Record<string, Model<T>>;
-    array: Array<Model<T>>;
+  byType: Record<string, Model<T>>;
+  array: Array<Model<T>>;
 }
-//# sourceMappingURL=discriminator-collections.d.ts.map

package/src/interfaces/email-service.ts

@@ -0,0 +1,8 @@
+export interface IEmailService {
+  sendEmail(
+    to: string,
+    subject: string,
+    text: string,
+    html: string,
+  ): Promise<void>;
+}

package/src/interfaces/environment-mongo.ts

@@ -0,0 +1,76 @@
+import { ReadConcernLike, WriteConcern } from 'mongodb';
+
+export interface IMongoEnvironment {
+  /**
+   * The URI of the MongoDB database
+   */
+  uri: string;
+  /**
+   * The name of the MongoDB database
+   */
+  dbName: string;
+  /**
+   * The maximum number of connections in the connection pool (default: 10)
+   */
+  maxPoolSize: number;
+  /**
+   * The minimum number of connections in the connection pool (default: 2)
+   */
+  minPoolSize: number;
+  /**
+   * The maximum number of milliseconds that a connection can remain idle in the connection pool (default: 30000)
+   */
+  maxIdleTimeMS: number;
+  /**
+   * The maximum time in milliseconds to wait for a connection to be established (default: 5000)
+   */
+  serverSelectionTimeoutMS: number;
+  /**
+   * The maximum time in milliseconds to wait for a socket to be established (default: 30000)
+   */
+  socketTimeoutMS: number;
+  /**
+   * Whether to retry writes (default: true)
+   */
+  retryWrites: boolean;
+  /**
+   * Whether to retry reads (default: true)
+   */
+  retryReads: boolean;
+  /**
+   * The read concern for the MongoDB database
+   */
+  readConcern: ReadConcernLike;
+  /**
+   * The write concern for the MongoDB database (default: { w: 'majority', j: true })
+   */
+  writeConcern: WriteConcern;
+  /**
+   * Whether the MongoDB server supports the setParameter command (MongoDB 4.4+)
+   */
+  setParameterSupported: boolean;
+  /**
+   * Whether the MongoDB server supports setting transactionLifetimeLimitSeconds (MongoDB 4.2+)
+   */
+  transactionLifetimeLimitSecondsSupported: boolean;
+  /**
+   * Whether the MongoDB server supports setting maxTransactionLockRequestTimeoutMillis (MongoDB 4.4+)
+   */
+  maxTransactionLockRequestTimeoutMillisSupported: boolean;
+  /**
+   * How long for transactions to timeout
+   */
+  transactionTimeout: number;
+  /**
+   * The maximum time to wait for a lock when using transactions (MongoDB 4.4+)
+   */
+  transactionLockRequestTimeout: number;
+  /**
+   * Use transactions
+   */
+  useTransactions: boolean;
+  /**
+   * Base delay in milliseconds for transaction retry backoff
+   */
+  transactionRetryBaseDelay: number;
+}

package/src/interfaces/environment.ts

@@ -0,0 +1,181 @@
+import { SecureBuffer, SecureString } from '@digitaldefiance/ecies-lib';
+import { Timezone } from '@digitaldefiance/i18n-lib';
+import { Types } from 'mongoose';
+import { BackupCode } from '../backup-code';
+import { IMongoEnvironment } from './environment-mongo';
+
+export interface IEnvironment {
+  /**
+   * Whether to use a memory database for local development (eg with MongoMemoryServer)
+   * If set, this will create a new in-memory database instance on application start with the given database name
+   */
+  devDatabase?: string;
+  /**
+   * Whether to print certain console debug messages
+   */
+  debug: boolean;
+  /**
+   * Whether to enable super verbose debug messags
+   */
+  detailedDebug: boolean;
+  /**
+   * The host name of the server
+   */
+  host: string;
+  /**
+   * The port the server is running on
+   */
+  port: number;
+  /**
+   * The base path of the server
+   */
+  basePath: string;
+  /**
+   * The URL of the server
+   */
+  serverUrl: string;
+  /**
+   * The secret used to sign JWTs
+   */
+  jwtSecret: string;
+  /**
+   * The email address to send notifications from
+   */
+  emailSender: string;
+  /**
+   * API distribution directory
+   */
+  apiDistDir: string;
+  /**
+   * react dist dir
+   */
+  reactDistDir: string;
+  /**
+   * The directory and root filename to store HTTPS development certificates
+   */
+  httpsDevCertRoot?: string;
+  /**
+   * The port to use for HTTPS development certificates
+   */
+  httpsDevPort: number;
+  /**
+   * Disable email sending
+   */
+  disableEmailSend: boolean;
+  /**
+   * MongoDB configuration
+   */
+  mongo: IMongoEnvironment;
+  /**
+   * Mnemonic for the admin user
+   */
+  adminMnemonic?: SecureString;
+  /**
+   * The ID of the admin user
+   */
+  adminId?: Types.ObjectId;
+  /**
+   * The creation date of the admin user
+   */
+  adminCreatedAt?: Date;
+  /**
+   * The password of the admin user
+   */
+  adminPassword?: SecureString;
+  /**
+   * The ID of the admin user role object
+   */
+  adminRoleId?: Types.ObjectId;
+  /**
+   * The ID of the admin user's user role object
+   */
+  adminUserRoleId?: Types.ObjectId;
+  /**
+   * Backup codes for the admin user
+   */
+  adminBackupCodes?: BackupCode[];
+  /**
+   * Mnemonic for the member user
+   */
+  memberMnemonic?: SecureString;
+  /**
+   * The ID of the member user
+   */
+  memberId?: Types.ObjectId;
+  /**
+   * The creation date of the member user
+   */
+  memberCreatedAt?: Date;
+  /**
+   * The password of the member user
+   */
+  memberPassword?: SecureString;
+  /**
+   * The ID of the member user role object
+   */
+  memberRoleId?: Types.ObjectId;
+  /**
+   * The ID of the member user's user role object
+   */
+  memberUserRoleId?: Types.ObjectId;
+  /**
+   * Backup codes for the member user
+   */
+  memberBackupCodes?: BackupCode[];
+  /**
+   * Mnemonic for the system user
+   */
+  systemMnemonic?: SecureString;
+  /**
+   * The ID of the system user
+   */
+  systemId?: Types.ObjectId;
+  /**
+   * The creation date of the system user
+   */
+  systemCreatedAt?: Date;
+  /**
+   * The public key of the system user
+   */
+  systemPublicKeyHex?: string;
+  /**
+   * The password of the system user
+   */
+  systemPassword?: SecureString;
+  /**
+   * The ID of the system user role object
+   */
+  systemRoleId?: Types.ObjectId;
+  /**
+   * The ID of the system user's user role object
+   */
+  systemUserRoleId?: Types.ObjectId;
+  /**
+   * Backup codes for the system user
+   */
+  systemBackupCodes?: BackupCode[];
+  /**
+   * HMAC secret for mnemonic encryption
+   */
+  mnemonicHmacSecret: SecureBuffer;
+  /**
+   * Encryption key for mnemonics
+   */
+  mnemonicEncryptionKey: SecureBuffer;
+  /**
+   * The timezone for the server
+   */
+  timezone: Timezone;
+  /**
+   * The default language for the admin interface/CLI
+   */
+  adminLanguage: string;
+  /**
+   * The number of PBKDF2 iterations for key wrapping
+   */
+  pbkdf2Iterations: number;
+  /**
+   * Whether this is a production environment
+   */
+  production: boolean;
+}

package/src/interfaces/failable-result.ts

@@ -0,0 +1,6 @@
+export interface IFailableResult<T> {
+  success: boolean;
+  data?: T;
+  message?: string;
+  error?: string | Error;
+}

package/src/interfaces/fec-consts.ts

@@ -0,0 +1,4 @@
+export interface IFECConsts {
+  /** Maximum size of a single shard */
+  MAX_SHARD_SIZE: number;
+}

package/src/interfaces/handleable-error-options.ts

@@ -0,0 +1,6 @@
+export interface HandleableErrorOptions {
+  cause?: Error;
+  handled?: boolean;
+  statusCode?: number;
+  sourceData?: unknown;
+}

package/{dist/interfaces/index.d.ts → src/interfaces/index.ts}

@@ -27,4 +27,3 @@ export * from './server-init-result';
 export * from './status-code-response';
 export * from './symmetric-encryption-results';
 export * from './token-response';
-//# sourceMappingURL=index.d.ts.map

package/src/interfaces/jwt-consts.ts

@@ -0,0 +1,23 @@
+export interface IJwtConsts {
+  /**
+   * Algorithm to use for JWT
+   */
+  ALGORITHM:
+    | 'HS256'
+    | 'HS384'
+    | 'HS512'
+    | 'RS256'
+    | 'RS384'
+    | 'RS512'
+    | 'ES256'
+    | 'ES384'
+    | 'ES512'
+    | 'PS256'
+    | 'PS384'
+    | 'PS512';
+
+  /**
+   * The expiration time for a JWT token in seconds
+   */
+  EXPIRATION_SEC: number;
+}

package/src/interfaces/jwt-sign-response.ts

@@ -0,0 +1,19 @@
+import {
+  ITokenRole,
+  ITokenRoleDTO,
+  ITokenUser,
+} from '@digitaldefiance/suite-core-lib';
+import { Types } from 'mongoose';
+
+export interface IJwtSignResponse<
+  I = Types.ObjectId,
+  D extends Date = Date,
+  TTokenRole extends ITokenRole<I, D> = ITokenRole<I, D>,
+> {
+  token: string;
+  tokenUser: ITokenUser;
+  roleNames: string[];
+  roleTranslatedNames: string[];
+  roles: TTokenRole[];
+  roleDTOs: ITokenRoleDTO[];
+}

package/src/interfaces/mongo-errors.ts

@@ -0,0 +1,5 @@
+import { Error } from 'mongoose';
+
+export interface IMongoErrors {
+  [key: string]: Error.ValidatorError | Error.CastError;
+}

package/src/interfaces/request-user.ts

@@ -0,0 +1,50 @@
+import { IRoleDTO, IRoleFrontendObject } from '@digitaldefiance/suite-core-lib';
+import { Types } from 'mongoose';
+import { IRoleBackendObject } from './backend-objects/role';
+
+/**
+ * Interface for the user object stored in the request object
+ * This is not used for mongoose but for request handling
+ */
+export interface IRequestUser<
+  I extends Types.ObjectId | string = string,
+  R extends
+    | Array<IRoleDTO>
+    | Array<IRoleFrontendObject>
+    | Array<IRoleBackendObject> = Array<IRoleDTO>,
+  S extends string = string,
+  D extends Date | string = string,
+> {
+  /**
+   * The ID of the user
+   */
+  id: I;
+  /**
+   * The roles associated with the user
+   */
+  roles: R;
+  /**
+   * The username of the user
+   */
+  username: string;
+  /**
+   * The email address of the user
+   */
+  email: string;
+  /**
+   * The timezone of the user
+   */
+  timezone: string;
+  /**
+   * The language of the user
+   */
+  siteLanguage: S;
+  /**
+   * The date the user last logged in
+   */
+  lastLogin?: D;
+  /**
+   * Whether the user has verified their email address
+   */
+  emailVerified: boolean;
+}

package/src/interfaces/required-string-keys.ts

@@ -0,0 +1,26 @@
+/**
+ * Base interface defining the minimum required string keys that must be implemented
+ * by any application using this library
+ */
+export interface RequiredStringKeys {
+  Common_UnexpectedError: string;
+  Error_EngineAlreadySet: string;
+  Error_EngineNotSet: string;
+  Error_LengthExceedsMaximum: string;
+  Error_LengthIsInvalidType: string;
+  // Validation errors
+  ValidationError: string;
+  Validation_MissingValidatedData: string;
+  Validation_MissingValidatedDataForField: string;
+
+  // Admin/system messages
+  Admin_NoMongoDbClientFoundFallingBack: string;
+  Admin_TransactionFailedTransientTemplate: string;
+  Admin_TransactionTimeoutTemplate: string;
+}
+
+/**
+ * Type constraint to ensure user's string key enum extends the required keys
+ */
+export type ExtendedStringKeys<T extends string> =
+  T extends keyof RequiredStringKeys ? T : T | keyof RequiredStringKeys;

package/src/interfaces/schema.ts

@@ -0,0 +1,31 @@
+import { Model, Schema } from 'mongoose';
+import { IBaseDocument } from '../documents/base';
+import { IDiscriminatorCollections } from '../interfaces/discriminator-collections';
+
+/**
+ * Interface for each schema in the schema map
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export interface ISchema<T extends IBaseDocument<any>> {
+  /**
+   * The name of the collection, eg 'models'
+   */
+  collection: string;
+  /**
+   * The model for the schema
+   */
+
+  model: Model<T>;
+  /**
+   * The name of the model, eg 'Model'
+   */
+  modelName: string;
+  /**
+   * The schema for the model
+   */
+  schema: Schema;
+  /**
+   * Discriminators for the model
+   */
+  discriminators?: IDiscriminatorCollections<T>;
+}

package/src/interfaces/server-init-result.ts

@@ -0,0 +1,37 @@
+import { Member } from '@digitaldefiance/node-ecies-lib';
+import { IRoleDocument } from '../documents/role';
+import { IUserDocument } from '../documents/user';
+import { IUserRoleDocument } from '../documents/user-role';
+
+// Re-export essential document types
+export type { IRoleDocument, IUserDocument, IUserRoleDocument };
+
+export interface IServerInitResult {
+  adminRole: IRoleDocument;
+  adminUser: IUserDocument;
+  adminUsername: string;
+  adminEmail: string;
+  adminMnemonic: string;
+  adminPassword: string;
+  adminBackupCodes: Array<string>;
+  adminMember: Member;
+  adminUserRole: IUserRoleDocument;
+  memberRole: IRoleDocument;
+  memberUser: IUserDocument;
+  memberUsername: string;
+  memberEmail: string;
+  memberMnemonic: string;
+  memberPassword: string;
+  memberBackupCodes: Array<string>;
+  memberMember: Member;
+  memberUserRole: IUserRoleDocument;
+  systemRole: IRoleDocument;
+  systemUser: IUserDocument;
+  systemUsername: string;
+  systemEmail: string;
+  systemMnemonic: string;
+  systemPassword: string;
+  systemBackupCodes: Array<string>;
+  systemMember: Member;
+  systemUserRole: IUserRoleDocument;
+}

package/src/interfaces/status-code-response.ts

@@ -0,0 +1,7 @@
+import { ApiResponse } from '../types';
+
+export interface IStatusCodeResponse<T extends ApiResponse> {
+  statusCode: number;
+  response: T;
+  headers?: Record<string, string>;
+}

package/src/interfaces/symmetric-encryption-results.d.ts

@@ -0,0 +1,5 @@
+export interface ISymmetricEncryptionResults {
+  encryptedData: Buffer;
+  key: Buffer;
+}
+//# sourceMappingURL=symmetric-encryption-results.d.ts.map

package/src/interfaces/symmetric-encryption-results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"symmetric-encryption-results.d.ts","sourceRoot":"","sources":["symmetric-encryption-results.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;CACb"}

package/src/interfaces/symmetric-encryption-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"symmetric-encryption-results.js","sourceRoot":"","sources":["symmetric-encryption-results.ts"],"names":[],"mappings":""}

package/src/interfaces/symmetric-encryption-results.ts

@@ -0,0 +1,4 @@
+export interface ISymmetricEncryptionResults {
+  encryptedData: Buffer;
+  key: Buffer;
+}

package/{dist/interfaces/token-response.d.ts → src/interfaces/token-response.ts}

@@ -1,5 +1,5 @@
 import { IApiMessageResponse } from './api-message-response';
+
 export interface IApiTokenResponse extends IApiMessageResponse {
-    token: string;
+  token: string;
 }
-//# sourceMappingURL=token-response.d.ts.map