Son/techn 373 apply template for email notifier

libraries/contracts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhealth/contracts",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "homepage": "https://github.com/dhealthproject/dapps-framework/tree/main/libraries/contracts#readme",
   "description": "Contracts for dApps Development with dHealth Network",
   "author": "dHealth Network <[email protected]>",

libraries/ui-components/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhealth/components",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "homepage": "https://github.com/dhealthproject/dapps-framework/tree/main/libraries/ui-components#readme",
   "description": "Components Library for dApps Development with dHealth Network",
   "author": "dHealth Network <[email protected]>",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhealthdapps/framework",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "homepage": "https://github.com/dhealthproject/dapps-framework#readme",
   "description": "dHealth dApps Framework: Build dApps that scale.",
   "author": "dHealth Network <[email protected]>",

runtime/backend/nest-cli.json

@@ -1,4 +1,13 @@
 {
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src"
-}
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "assets": [
+      {
+        "include": "**/templates/**/*",
+        "outDir": "dist/src",
+        "watchAssets": true
+      }
+    ]
+  }
+}

runtime/backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhealthdapps/backend",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "homepage": "https://github.com/dhealthproject/dapps-framework/tree/main/runtime/backend#readme",
   "description": "dHealth ELEVATE API",
   "author": "dHealth Network <[email protected]>",

runtime/backend/src/AppConfiguration.ts

@@ -15,6 +15,7 @@ import { DynamicModule } from "@nestjs/common";
 import { MailerModule } from "@nestjs-modules/mailer";
 import { Account, Address, PublicAccount } from "@dhealth/sdk";
 import SMTPTransport from "nodemailer/lib/smtp-transport";
+import { HandlebarsAdapter } from "@nestjs-modules/mailer/dist/adapters/handlebars.adapter";
 
 // internal dependencies
 import { ConfigurationError } from "./common/errors/ConfigurationError";
@@ -298,6 +299,44 @@ export class AppConfiguration {
     return dappConfig.dappName;
   }
 
+  /**
+   * This static helper method returns the configuration section value
+   * based on the provided section name.
+   *
+   * @access public
+   * @static
+   * @param {string} section The config section name e.g. `"dapp"`, `"statistics"`.
+   * @returns {object}
+   */
+  public static getConfig(section: string): object {
+    switch (section) {
+      case "assets":
+        return assetsConfigLoader();
+      case "dapp":
+        return dappConfigLoader();
+      case "network":
+        return networkConfigLoader();
+      case "oauth":
+        return oauthConfigLoader();
+      case "payout":
+        return payoutConfigLoader();
+      case "processor":
+        return processorConfigLoader();
+      case "security":
+        return securityConfigLoader();
+      case "statistics":
+        return statisticsConfigLoader();
+      case "social":
+        return socialConfigLoader();
+      case "monitoring":
+        return monitoringConfigLoader();
+      case "transport":
+        return transportConfigLoader();
+      default:
+        throw new Error(`Cannot find relevant config for section: ${section}`);
+    }
+  }
+
   /**
    * This static helper method returns all the configuration loaders. This
    * method *does not* interpret the content of configuration objects.
@@ -431,6 +470,13 @@ export class AppConfiguration {
             defaults: {
               from: mailConfig.from,
             },
+            template: {
+              dir: __dirname + "/notifier/templates/",
+              adapter: new HandlebarsAdapter(), // or new PugAdapter()
+              options: {
+                strict: true,
+              },
+            },
           };
         },
         inject: [ConfigService],

runtime/backend/src/common/Schedulers.ts

@@ -43,6 +43,7 @@ import { UserAggregationCommand } from "../statistics/schedulers/UserAggregation
 import { UserTopActivitiesCommand } from "../statistics/schedulers/UserTopActivities/UserTopActivitiesCommand";
 
 // notifier scope
+import { AlertsModule } from "../notifier/modules/AlertsModule";
 import { ReportNotifierCommand } from "../notifier/schedulers/ReportNotifier/ReportNotifierCommand";
 
 /**
@@ -102,7 +103,7 @@ export const Schedulers: { [key: string]: any[] } = {
     UserAggregationCommand,
     UserTopActivitiesCommand,
   ],
-  notifier: [ReportNotifierCommand.register()],
+  notifier: [AlertsModule, ReportNotifierCommand.register()],
   oauth: [],
   users: [],
 };

runtime/backend/src/common/concerns/Countable.ts

@@ -21,5 +21,5 @@ export interface Countable {
    *
    * @var {number}
    */
-  total: number;
+  total?: number;
 }

runtime/backend/src/common/models/AccountDTO.ts

@@ -22,7 +22,6 @@ import { BaseDTO } from "./BaseDTO";
  * This class shall be used in **HTTP responses** to avoid any additional
  * data about accounts to be revealed.
  *
- * @todo The transaction timestamp in `firstTransactionAt` should probably be a **number** to avoid timezone issues.
  * @since v0.1.0
  */
 export class AccountDTO extends BaseDTO {

runtime/backend/src/common/models/BaseDTO.ts

@@ -16,7 +16,6 @@
  * This class shall be used in **HTTP responses** to avoid any additional
  * data about accounts to be revealed.
  *
- * @todo Currently this is using a "to any"-cast trick that should be avoided.
  * @since v0.3.0
  */
 export class BaseDTO {

runtime/backend/src/common/models/DappConfig.ts

@@ -51,7 +51,6 @@ export type AppConnectionPayload = {
  * This interface is mainly used **internally** to restrict the configuration
  * values provided to some modules or services and methods.
  *
- * @todo Allow for updated discovery sources configuration (must be backwards compatible).
  * @link DappConfig
  * @since v0.1.0
  */

runtime/backend/src/common/models/PaginatedResultDTO.ts

@@ -98,4 +98,21 @@ export class PaginatedResultDTO<TData> {
       (this.pagination.total ?? 0)
     );
   }
+
+  /**
+   * Method to dynamically create and return an instance of this class
+   * with the provided data type, data content and pagination content.
+   *
+   * @access public
+   * @static
+   * @param {TData[]} data The results returned by the query in an array of template type `TData`.
+   * @param {Pageable & Countable} pagination The pagination object, contains properties such as `pageSize`, `pageNumber` and `total`.
+   * @returns {PaginatedResultDTO<TData>}
+   */
+  public static create<TData>(
+    data: TData[],
+    pagination: Pageable & Countable,
+  ): PaginatedResultDTO<TData> {
+    return new PaginatedResultDTO<TData>(data, pagination);
+  }
 }

runtime/backend/src/common/models/StateDTO.ts

@@ -11,7 +11,6 @@
 import { ApiProperty } from "@nestjs/swagger";
 
 // internal dependencies
-import { StateData } from "./StateData";
 import { BaseDTO } from "./BaseDTO";
 
 /**
@@ -47,22 +46,19 @@ export class StateDTO extends BaseDTO {
   public name: string;
 
   /**
-   * Contains the actual state cache data. This field is usually
-   * populated or updated within a service class.
+   * Contains the actual state cache data's hash.
    * <br /><br />
-   * This field can hold **any** type of information as it extends
-   * the `Record<string, any>` type to permit greater flexibility
-   * around state cache entries.
+   * The content is hashed with SHA3-256 to prevent revealing actual
+   * state data to the client.
    *
-   * @todo We probably don't want this data to be as public, instead should be the "cache hash".
    * @access public
    * @var {string}
    */
   @ApiProperty({
-    type: Object,
-    example: { stateKey1: 1, stateKey2: "value2", stateKey3: true },
+    type: "string",
+    example: "",
     description:
-      "Contains the actual state cache data. This field is usually populated or updated within a service class.",
+      "Contains the actual state cache data's hash. The content is hashed with SHA3-256 to prevent revealing actual state data to the client.",
   })
-  public data: StateData;
+  public data: string;
 }

runtime/backend/src/common/models/StateSchema.ts

@@ -10,6 +10,7 @@
 // external dependencies
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
 import { Model } from "mongoose";
+import { sha3_256 } from "js-sha3";
 
 // internal dependencies
 import { Documentable } from "../concerns/Documentable";
@@ -134,7 +135,8 @@ export class State extends Transferable<StateDTO> {
    */
   public static fillDTO(doc: StateDocument, dto: StateDTO): StateDTO {
     dto.name = doc.name;
-    dto.data = doc.data;
+    // hash the actual state data in the dto to prevent its exposure to the client.
+    dto.data = sha3_256(JSON.stringify(doc.data));
     return dto;
   }
 }

runtime/backend/src/common/models/TransactionSchema.ts

@@ -9,8 +9,11 @@
  */
 // external dependencies
 import {
+  Convert,
+  NetworkType,
   Transaction as SdkTransaction,
   TransactionMapping,
+  TransactionType,
 } from "@dhealth/sdk";
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
 import { Model } from "mongoose";
@@ -32,7 +35,6 @@ import { TransactionDTO } from "../../discovery/models/TransactionDTO";
  * Note that this class uses the generic {@link Transferable} trait to
  * enable a `toDTO()` method on the model.
  *
- * @todo Timestamp fields should be **numbers** to avoid timezone issues.
  * @since v0.2.0
  */
 @Schema({
@@ -325,8 +327,37 @@ export class Transaction extends Transferable<TransactionDTO> {
    * @returns {SdkTransaction}  The `SdkTransaction` object with payload set.
    */
   public toSDK(): SdkTransaction {
-    //XXX this assumes "encodedBody" contains the *full* payload.
-    return TransactionMapping.createFromPayload(this.encodedBody, false); // false for `isEmbedded`
+    const sizeBytes = Convert.numberToUint8Array(
+      (this.encodedBody.length + 256) / 2,
+      4,
+    );
+    const verifiableEntityHeader_Reserved4Bytes = Convert.numberToUint8Array(
+      0,
+      4,
+    );
+    const signatureBytes = Convert.hexToUint8(this.signature);
+    const signerPublicKeyBytes = Convert.hexToUint8(this.signerPublicKey);
+    const entityBody_Reserved4Bytes = Convert.numberToUint8Array(0, 4);
+    const versionBytes = Convert.numberToUint8Array(0, 1);
+    const networkBytes = Convert.numberToUint8Array(NetworkType.MAIN_NET, 1);
+    const typeBytes = Convert.numberToUint8Array(TransactionType.TRANSFER, 2);
+    const feeBytes = Convert.numberToUint8Array(0, 8);
+    const deadlineBytes = Convert.numberToUint8Array(0, 8);
+    const headersUint8Array = [
+      ...sizeBytes,
+      ...verifiableEntityHeader_Reserved4Bytes,
+      ...signatureBytes,
+      ...signerPublicKeyBytes,
+      ...entityBody_Reserved4Bytes,
+      ...versionBytes,
+      ...networkBytes,
+      ...typeBytes,
+      ...feeBytes,
+      ...deadlineBytes,
+    ];
+    const fullEncodedBody =
+      Convert.uint8ToHex(headersUint8Array) + this.encodedBody;
+    return TransactionMapping.createFromPayload(fullEncodedBody, false); // false for `isEmbedded`
   }
 
   /**

runtime/backend/src/common/modules/AuthModule.ts

@@ -23,6 +23,7 @@ import { QueryModule } from "../modules/QueryModule";
 import { LogModule } from "../modules/LogModule";
 import { AuthService } from "../services/AuthService";
 import { AuthStrategy } from "../traits/AuthStrategy";
+import { RefreshStrategy } from "../traits/RefreshStrategy";
 import { AuthController } from "../routes/AuthController";
 import { ValidateChallengeScheduler } from "../schedulers/ValidateChallengeScheduler";
 import {
@@ -41,7 +42,6 @@ import { AuthGateway } from "../gateways/AuthGateway";
 
 // configuration resources
 import securityConfigLoader from "../../../config/security";
-import { RefreshStrategy } from "../traits";
 const auth = securityConfigLoader().auth;
 
 /**
@@ -82,6 +82,7 @@ const auth = securityConfigLoader().auth;
     AuthGateway,
     ValidateChallengeScheduler,
     SchedulerRegistry,
+    RefreshStrategy,
   ],
   exports: [AuthService, CipherService],
 })

runtime/backend/src/common/modules/LogModule.ts

@@ -16,9 +16,6 @@ import { QueryModule } from "../modules/QueryModule";
 import { Log, LogSchema } from "../models/LogSchema";
 import { LogService } from "../services/LogService";
 
-// @todo decouple from notifier scope
-import { AlertsModule } from "../../notifier/modules/AlertsModule";
-
 /**
  * @class LogModule
  * @description The main definition for the Log module.
@@ -33,7 +30,6 @@ import { AlertsModule } from "../../notifier/modules/AlertsModule";
         schema: LogSchema,
       }, // requirement from LogModule
     ]),
-    AlertsModule,
     QueryModule, // requirement from LogService
   ],
   providers: [LogService],

runtime/backend/src/common/schedulers/ValidateChallengeScheduler.ts

@@ -18,11 +18,6 @@ import { ConfigService } from "@nestjs/config";
 // internal dependencies
 import { AccessTokenRequest } from "../requests/AccessTokenRequest";
 import { AccountsService } from "../services/AccountsService";
-import {
-  Account,
-  AccountDocument,
-  AccountQuery,
-} from "../models/AccountSchema";
 import { AuthService } from "../services/AuthService";
 import { LogService } from "../services/LogService";
 import { OnAuthCompleted } from "../events/OnAuthCompleted";

runtime/backend/src/common/services/AccountsService.ts

@@ -24,8 +24,8 @@ import {
 } from "../models/AccountSchema";
 
 // configuration resources
-import dappConfigLoader from "../../../config/dapp";
-import networkConfigLoader from "../../../config/network";
+import { DappConfig, NetworkConfig } from "../models";
+import { AppConfiguration } from "../../AppConfiguration";
 
 /**
  * @class AccountsService
@@ -218,7 +218,9 @@ export class AccountsService {
    */
   public static createAddress(publicKeyOrAddress: string): Address {
     // extracts the network type from configuration
-    const { networkIdentifier } = networkConfigLoader().network;
+    const { networkIdentifier } = (
+      AppConfiguration.getConfig("network") as NetworkConfig
+    ).network;
     const networkType = networkIdentifier as NetworkType;
 
     // if we have a public key (64 characters in hexadecimal format)
@@ -238,7 +240,9 @@ export class AccountsService {
 
     // source input is **not** a valid address, return fallback
     if (sourceAddress.length !== 39) {
-      return AccountsService.createAddress(dappConfigLoader().dappPublicKey);
+      return AccountsService.createAddress(
+        (AppConfiguration.getConfig("dapp") as DappConfig).dappPublicKey,
+      );
     }
 
     // source input **is a valid address format**