@lenne.tech/nest-server 10.2.6 → 10.2.8

package/src/core/common/interfaces/server-options.interface.ts

@@ -5,11 +5,12 @@ import { JwtSignOptions } from '@nestjs/jwt/dist/interfaces';
 import { MongooseModuleOptions } from '@nestjs/mongoose';
 import { ServeStaticOptions } from '@nestjs/platform-express/interfaces/serve-static-options.interface';
 import { CronExpression } from '@nestjs/schedule';
+import { MongoosePingCheckSettings } from '@nestjs/terminus/dist/health-indicator/database/mongoose.health';
+import { DiskHealthIndicatorOptions } from '@nestjs/terminus/dist/health-indicator/disk/disk-health-options.type';
 import compression from 'compression';
 import { CollationOptions } from 'mongodb';
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport';
-import { MongoosePingCheckSettings } from '@nestjs/terminus/dist/health-indicator/database/mongoose.health';
-import { DiskHealthIndicatorOptions } from '@nestjs/terminus/dist/health-indicator/disk/disk-health-options.type';
+
 import { Falsy } from '../types/falsy.type';
 import { CronJobConfigWithTimeZone } from './cron-job-config-with-time-zone.interface';
 import { CronJobConfigWithUtcOffset } from './cron-job-config-with-utc-offset.interface';
@@ -70,6 +71,31 @@ export interface IServerOptions {
    */
   automaticObjectIdFiltering?: boolean;
 
+  /**
+   * Configuration for Brevo
+   * See: https://developers.brevo.com/
+   */
+  brevo?: {
+    /**
+     * API key for Brevo
+     */
+    apiKey: string;
+
+    /**
+     * Regular expression for excluding (test) users
+     * e.g. /@testuser.com$/i
+     */
+    exclude?: RegExp;
+
+    /**
+     * Default sender for Brevo
+     */
+    sender: {
+      email: string;
+      name: string;
+    };
+  };
+
   /**
    * Whether to use the compression middleware package to enable gzip compression.
    * See: https://docs.nestjs.com/techniques/compression
@@ -86,7 +112,7 @@ export interface IServerOptions {
    * Cron jobs configuration object with the name of the cron job function as key
    * and the cron expression or config as value
    */
-  cronJobs?: Record<string, CronExpression | string | Date | Falsy | CronJobConfigWithTimeZone | CronJobConfigWithUtcOffset>;
+  cronJobs?: Record<string, CronExpression | CronJobConfigWithTimeZone | CronJobConfigWithUtcOffset | Date | Falsy | string>;
 
   /**
    * SMTP and template configuration for sending emails
@@ -182,11 +208,6 @@ export interface IServerOptions {
    */
   healthCheck?: {
 
-    /**
-     * Whether health check is enabled
-     */
-    enabled?: boolean;
-
     /**
      * Configuration of single health checks
      */
@@ -224,14 +245,14 @@ export interface IServerOptions {
         enabled?: boolean;
 
         /**
-         * Key in result JSON
+         * Memory limit in bytes
          */
-        key?: string;
+        heapUsedThreshold?: number;
 
         /**
-         * Memory limit in bytes
+         * Key in result JSON
          */
-        heapUsedThreshold?: number;
+        key?: string;
       };
 
       /**
@@ -276,6 +297,11 @@ export interface IServerOptions {
         options?: DiskHealthIndicatorOptions;
       };
     };
+
+    /**
+     * Whether health check is enabled
+     */
+    enabled?: boolean;
   };
 
   /**
@@ -355,11 +381,6 @@ export interface IServerOptions {
      */
     modelDocumentation?: boolean;
 
-    /**
-     * Mongoose connection string
-     */
-    uri: string;
-
     /**
      * Mongoose module options
      */
@@ -373,6 +394,11 @@ export interface IServerOptions {
      * default: false
      */
     strictQuery?: boolean;
+
+    /**
+     * Mongoose connection string
+     */
+    uri: string;
   };
 
   /**
@@ -381,6 +407,12 @@ export interface IServerOptions {
    */
   port?: number;
 
+  /**
+   * Whether to enable verification and automatic encryption for received passwords that are not in sha256 format
+   * default = false, sha256 format check: /^[a-f0-9]{64}$/i
+   */
+  sha256?: boolean;
+
   /**
    * Configuration for useStaticAssets
    */
@@ -398,12 +430,6 @@ export interface IServerOptions {
     path?: string;
   };
 
-  /**
-   * Whether to enable verification and automatic encryption for received passwords that are not in sha256 format
-   * default = false, sha256 format check: /^[a-f0-9]{64}$/i
-   */
-  sha256?: boolean;
-
   /**
    * Templates
    */

package/src/core/common/interfaces/service-options.interface.ts

@@ -1,11 +1,18 @@
 import { CollationOptions } from 'mongodb';
 import { Model, PopulateOptions } from 'mongoose';
+
 import { FieldSelection } from '../types/field-selection.type';
 import { PrepareInputOptions } from './prepare-input-options.interface';
 import { PrepareOutputOptions } from './prepare-output-options.interface';
 
 /**
  * General service options
+ *
+ * HINT:
+ * If this interface is extended (ServiceOptions & { ... }), then only properties that are not present in
+ * ServiceOptions may be added in order to avoid unwanted side effects. To ensure this (also for future changes to
+ * ServiceOptions), the properties of the extension should be provided with a prefix, e.g. with an underscore
+ * (ServiceOptions & {_myProperty: any}).
  */
 export interface ServiceOptions {
   // All fields are allowed to be compatible as far as possible
@@ -45,38 +52,46 @@ export interface ServiceOptions {
   outputType?: new (...params: any[]) => any;
 
   // Alias for fieldSelection (if both are set fieldSelection is overwritten by populate)
-  populate?: string | PopulateOptions | (PopulateOptions | string)[];
+  populate?: (PopulateOptions | string)[] | PopulateOptions | string;
 
   // Process field selection
   // If {} or not set, then the field selection runs with defaults
-  // If falsy, then the field selection will not be automatically executed
-  processFieldSelection?: {
-    model?: new (...args: any[]) => any;
-    dbModel?: Model<any>;
-    // Ignore selections in fieldSelection and populate
-    // If falsy (default, if not set in env.config): select and populate information in fieldSelection and populate will be respected
-    // If truly: select fields will be ignored and only populate fields in fieldSelection and populate will be respected
-    ignoreSelections?: boolean;
-  };
+  // If falsy, then the prepareInput function is not executed
+  prepareInput?: PrepareInputOptions;
 
   // Prepare input configuration:
   // If {} or not set, then the prepareInput function will run with defaults
   // If falsy, then the prepareInput function is not executed
-  prepareInput?: PrepareInputOptions;
+  prepareOutput?: PrepareOutputOptions;
 
   // Prepare output configuration:
   // If {} or not set, then the prepareInput function will run with defaults
-  // If falsy, then the prepareInput function is not executed
-  prepareOutput?: PrepareOutputOptions;
+  // If falsy, then the field selection will not be automatically executed
+  processFieldSelection?: {
+    dbModel?: Model<any>;
+    // If truly: select fields will be ignored and only populate fields in fieldSelection and populate will be respected
+    ignoreSelections?: boolean;
+    // Ignore selections in fieldSelection and populate
+    // If falsy (default, if not set in env.config): select and populate information in fieldSelection and populate will be respected
+    model?: new (...args: any[]) => any;
+  };
 
   // Whether to publish action via GraphQL subscription
   pubSub?: boolean;
 
+  // Whether to return raw data without preparation via prepareInput or prepareOutput (prepareInput and prepareOutput will be ignored)
+  // Compare raw functions in CrudService
+  raw?: boolean;
+
+  // Roles (as string) to check
+  roles?: string | string[];
+
+  // Select fields via mongoose select
+  // See https://mongoosejs.com/docs/api.html#query_Query-select
+  select?: Record<string, boolean | number | object> | string | string[];
+
   // Add updateBy and/or createBy user ID into input after check
   // If falsy: input data will not be changed
   // If truly (default): updatedBy and/or createdBy (when create mode is activated) will be set if current user is available
   setCreateOrUpdateUserId?: boolean;
-
-  // Roles (as string) to check
-  roles?: string | string[];
 }

package/src/core/common/models/core-persistence.model.ts

@@ -1,6 +1,7 @@
 import { Field, ID, ObjectType } from '@nestjs/graphql';
 import { Prop, Schema } from '@nestjs/mongoose';
 import { Types } from 'mongoose';
+
 import { CoreModel } from './core-model.model';
 
 /**

package/src/core/common/pipes/check-input.pipe.ts

@@ -1,5 +1,6 @@
 import { ArgumentMetadata, Inject, Injectable, PipeTransform } from '@nestjs/common';
 import { CONTEXT } from '@nestjs/graphql';
+
 import { getContextData } from '../helpers/context.helper';
 import { check } from '../helpers/input.helper';
 

package/src/core/common/pipes/map-and-validate.pipe.ts

@@ -1,6 +1,7 @@
 import { ArgumentMetadata, BadRequestException, Injectable, PipeTransform } from '@nestjs/common';
 import { plainToInstance } from 'class-transformer';
 import { validate } from 'class-validator';
+
 import { isBasicType } from '../helpers/input.helper';
 
 @Injectable()

package/src/core/common/plugins/complexity.plugin.ts

@@ -1,8 +1,9 @@
-import { GraphQLSchemaHost } from '@nestjs/graphql';
 import { Plugin } from '@nestjs/apollo';
+import { GraphQLSchemaHost } from '@nestjs/graphql';
 import { ApolloServerPlugin, GraphQLRequestListener } from 'apollo-server-plugin-base';
 import { GraphQLError } from 'graphql';
 import { fieldExtensionsEstimator, getComplexity, simpleEstimator } from 'graphql-query-complexity';
+
 import { ConfigService } from '../services/config.service';
 
 @Plugin()
@@ -14,13 +15,13 @@ export class ComplexityPlugin implements ApolloServerPlugin {
     const { schema } = this.gqlSchemaHost;
 
     return {
-      async didResolveOperation({ request, document }) {
+      async didResolveOperation({ document, request }) {
         const complexity = getComplexity({
-          schema,
+          estimators: [fieldExtensionsEstimator(), simpleEstimator({ defaultComplexity: 1 })],
           operationName: request.operationName,
           query: document,
+          schema,
           variables: request.variables,
-          estimators: [fieldExtensionsEstimator(), simpleEstimator({ defaultComplexity: 1 })],
         });
         if (maxComplexity !== undefined && complexity > maxComplexity) {
           throw new GraphQLError(`Query is too complex: ${complexity}. Maximum allowed complexity: ${maxComplexity}`);

package/src/core/common/scalars/date-timestamp.scalar.ts

@@ -1,4 +1,5 @@
 import { CustomScalar, Scalar } from '@nestjs/graphql';
+
 import { checkAndGetDate, getDateFromGraphQL } from '../helpers/input.helper';
 
 /**

package/src/core/common/scalars/date.scalar.ts

@@ -1,4 +1,5 @@
 import { CustomScalar, Scalar } from '@nestjs/graphql';
+
 import { checkAndGetDate, getDateFromGraphQL } from '../helpers/input.helper';
 
 /**

package/src/core/common/services/brevo.service.ts

@@ -0,0 +1,93 @@
+
+import { Injectable } from '@nestjs/common';
+
+import { ConfigService } from './config.service';
+
+import brevo = require('@getbrevo/brevo');
+
+
+@Injectable()
+export class BrevoService {
+  brevoConfig: ConfigService['configFastButReadOnly']['brevo'];
+
+  constructor(protected configService: ConfigService) {
+    const defaultClient = brevo.ApiClient.instance;
+    const apiKey = defaultClient.authentications['api-key'];
+    this.brevoConfig = configService.configFastButReadOnly.brevo;
+    if (!this.brevoConfig) {
+      throw new Error('Brevo configuration not set!');
+    }
+    apiKey.apiKey = this.brevoConfig.apiKey;
+  }
+
+  /**
+   * Send a transactional email via Brevo
+   */
+  async sendMail(to: string, templateId: number, params?: object): Promise<unknown> {
+    // Check input
+    if (!to || !templateId) {
+      return false;
+    }
+
+    // Exclude (test) users
+    if (this.configService.configFastButReadOnly.brevo?.exclude?.test?.(to)) {
+      return 'TEST_USER!';
+    }
+
+    // Prepare data
+    const apiInstance = new brevo.TransactionalEmailsApi();
+    const sendSmtpEmail = new brevo.SendSmtpEmail();
+    sendSmtpEmail.templateId = templateId;
+    sendSmtpEmail.to = [{ email: to }];
+    sendSmtpEmail.params = params;
+
+    // Send email
+    try {
+      return await apiInstance.sendTransacEmail(sendSmtpEmail);
+    } catch (error) {
+      console.error(error);
+    }
+
+    // Return null if error
+    return null;
+  }
+
+  /**
+   * Send HTML mail
+   */
+  async sendHtmlMail(
+    to: string,
+    subject: string,
+    html: string,
+    options?: { params?: Record<string, string> },
+  ): Promise<unknown> {
+    // Check input
+    if (!to || !subject || !html) {
+      return false;
+    }
+
+    // Exclude (test) users
+    if (this.brevoConfig.exclude?.test?.(to)) {
+      return 'TEST_USER!';
+    }
+
+    // Prepare data
+    const apiInstance = new brevo.TransactionalEmailsApi();
+    const sendSmtpEmail = new brevo.SendSmtpEmail();
+    sendSmtpEmail.htmlContent = html;
+    sendSmtpEmail.params = options?.params;
+    sendSmtpEmail.sender = this.brevoConfig.sender;
+    sendSmtpEmail.subject = subject;
+    sendSmtpEmail.to = [{ email: to }];
+
+    // Send email
+    try {
+      return await apiInstance.sendTransacEmail(sendSmtpEmail);
+    } catch (error) {
+      console.error(error);
+    }
+
+    // Return null if error
+    return null;
+  }
+}

package/src/core/common/services/config.service.ts

@@ -1,11 +1,13 @@
-import _ = require('lodash');
 import { cloneDeep } from 'lodash';
 import { BehaviorSubject, firstValueFrom } from 'rxjs';
 import { filter, map } from 'rxjs/operators';
+
 import { merge } from '../helpers/config.helper';
 import { clone, deepFreeze } from '../helpers/input.helper';
 import { IServerOptions } from '../interfaces/server-options.interface';
 
+import _ = require('lodash');
+
 /**
  * Config service can be used as provider (after initialization in CoreModule.forRoot)
  *

package/src/core/common/services/core-cron-jobs.service.ts

@@ -1,6 +1,7 @@
 import { OnApplicationBootstrap } from '@nestjs/common';
 import { CronExpression, SchedulerRegistry } from '@nestjs/schedule';
 import { CronJob } from 'cron';
+
 import { CronJobConfigWithTimeZone } from '../interfaces/cron-job-config-with-time-zone.interface';
 import { CronJobConfigWithUtcOffset } from '../interfaces/cron-job-config-with-utc-offset.interface';
 import { Falsy } from '../types/falsy.type';
@@ -31,7 +32,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
    */
   protected constructor(
     protected schedulerRegistry: SchedulerRegistry,
-    protected cronJobs: Record<string, CronExpression | string | Date | Falsy | CronJobConfigWithTimeZone | CronJobConfigWithUtcOffset>,
+    protected cronJobs: Record<string, CronExpression | CronJobConfigWithTimeZone | CronJobConfigWithUtcOffset | Date | Falsy | string>,
     options?: { log?: boolean },
   ) {
     this.config = {
@@ -75,7 +76,7 @@ export abstract class CoreCronJobs implements OnApplicationBootstrap {
         = CronExpressionOrConfig as CronJobConfigWithTimeZone | CronJobConfigWithUtcOffset;
       if (typeof CronExpressionOrConfig === 'string' || CronExpressionOrConfig instanceof Date) {
         conf = {
-          cronTime: CronExpressionOrConfig as string | Date,
+          cronTime: CronExpressionOrConfig as Date | string,
         };
       }