resurgence-data 1.0.18 → 1.0.20

package/dist/exception/authentication.exception.d.ts

@@ -1,7 +1,7 @@
-import { Exception } from './exception';
-export declare class InvalidCredentialsException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class InvalidCredentialsException extends ResurgenceException {
 }
-export declare class InvalidUserException extends Exception {
+export declare class InvalidUserException extends ResurgenceException {
 }
-export declare class InactiveUserException extends Exception {
+export declare class InactiveUserException extends ResurgenceException {
 }

package/dist/exception/authentication.exception.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InactiveUserException = exports.InvalidUserException = exports.InvalidCredentialsException = void 0;
 const exception_1 = require("./exception");
-class InvalidCredentialsException extends exception_1.Exception {
+class InvalidCredentialsException extends exception_1.ResurgenceException {
 }
 exports.InvalidCredentialsException = InvalidCredentialsException;
-class InvalidUserException extends exception_1.Exception {
+class InvalidUserException extends exception_1.ResurgenceException {
 }
 exports.InvalidUserException = InvalidUserException;
-class InactiveUserException extends exception_1.Exception {
+class InactiveUserException extends exception_1.ResurgenceException {
 }
 exports.InactiveUserException = InactiveUserException;

package/dist/exception/authorization.exception.d.ts

@@ -1,5 +1,5 @@
-import { Exception } from './exception';
-export declare class InvalidAuthorizationException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class InvalidAuthorizationException extends ResurgenceException {
 }
-export declare class ExpiredAuthorizationException extends Exception {
+export declare class ExpiredAuthorizationException extends ResurgenceException {
 }

package/dist/exception/authorization.exception.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpiredAuthorizationException = exports.InvalidAuthorizationException = void 0;
 const exception_1 = require("./exception");
-class InvalidAuthorizationException extends exception_1.Exception {
+class InvalidAuthorizationException extends exception_1.ResurgenceException {
 }
 exports.InvalidAuthorizationException = InvalidAuthorizationException;
-class ExpiredAuthorizationException extends exception_1.Exception {
+class ExpiredAuthorizationException extends exception_1.ResurgenceException {
 }
 exports.ExpiredAuthorizationException = ExpiredAuthorizationException;

package/dist/exception/data.exception.d.ts

@@ -1,3 +1,3 @@
-import { Exception } from "./exception";
-export declare class InvalidPayloadException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class InvalidPayloadException extends ResurgenceException {
 }

package/dist/exception/data.exception.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidPayloadException = void 0;
 const exception_1 = require("./exception");
-class InvalidPayloadException extends exception_1.Exception {
+class InvalidPayloadException extends exception_1.ResurgenceException {
 }
 exports.InvalidPayloadException = InvalidPayloadException;

package/dist/exception/database.exception.d.ts

@@ -1,3 +1,3 @@
-import { Exception } from "./exception";
-export declare class DatabaseProcessException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class DatabaseProcessException extends ResurgenceException {
 }

package/dist/exception/database.exception.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatabaseProcessException = void 0;
 const exception_1 = require("./exception");
-class DatabaseProcessException extends exception_1.Exception {
+class DatabaseProcessException extends exception_1.ResurgenceException {
 }
 exports.DatabaseProcessException = DatabaseProcessException;

package/dist/exception/exception.d.ts

@@ -1,6 +1,8 @@
 import { ErrorContent } from "../types/error.type";
-export declare class Exception extends Error {
+export declare class ResurgenceException extends Error {
     description?: string;
     status: number | 500;
+    context: string;
+    data: any;
     constructor(errorContent?: ErrorContent);
 }

package/dist/exception/exception.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Exception = void 0;
-class Exception extends Error {
+exports.ResurgenceException = void 0;
+class ResurgenceException extends Error {
     constructor(errorContent) {
         super();
         if (errorContent) {
@@ -10,7 +10,13 @@ class Exception extends Error {
             if (errorContent.status) {
                 this.status = errorContent.status;
             }
+            if (errorContent.context) {
+                this.context = errorContent.context;
+            }
+            if (errorContent.data) {
+                this.data = errorContent.data;
+            }
         }
     }
 }
-exports.Exception = Exception;
+exports.ResurgenceException = ResurgenceException;

package/dist/exception/integration.exception.d.ts

@@ -1,5 +1,5 @@
-import { Exception } from "./exception";
-export declare class MessagingException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class MessagingException extends ResurgenceException {
 }
-export declare class ThirdPartyIntegrationException extends Exception {
+export declare class ThirdPartyIntegrationException extends ResurgenceException {
 }

package/dist/exception/integration.exception.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThirdPartyIntegrationException = exports.MessagingException = void 0;
 const exception_1 = require("./exception");
-class MessagingException extends exception_1.Exception {
+class MessagingException extends exception_1.ResurgenceException {
 }
 exports.MessagingException = MessagingException;
-class ThirdPartyIntegrationException extends exception_1.Exception {
+class ThirdPartyIntegrationException extends exception_1.ResurgenceException {
 }
 exports.ThirdPartyIntegrationException = ThirdPartyIntegrationException;

package/dist/exception/process.exception.d.ts

@@ -1,3 +1,3 @@
-import { Exception } from "./exception";
-export declare class IncompleteProcessException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class IncompleteProcessException extends ResurgenceException {
 }

package/dist/exception/process.exception.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IncompleteProcessException = void 0;
 const exception_1 = require("./exception");
-class IncompleteProcessException extends exception_1.Exception {
+class IncompleteProcessException extends exception_1.ResurgenceException {
 }
 exports.IncompleteProcessException = IncompleteProcessException;

package/dist/exception/resource.exception.d.ts

@@ -1,9 +1,9 @@
-import { Exception } from "./exception";
-export declare class ResourceNotFoundException extends Exception {
+import { ResurgenceException } from "./exception";
+export declare class ResourceNotFoundException extends ResurgenceException {
 }
-export declare class ResourceExistsException extends Exception {
+export declare class ResourceExistsException extends ResurgenceException {
 }
-export declare class UnauthorizedResourceActionException extends Exception {
+export declare class UnauthorizedResourceActionException extends ResurgenceException {
 }
-export declare class ExpiredResourceException extends Exception {
+export declare class ExpiredResourceException extends ResurgenceException {
 }

package/dist/exception/resource.exception.js

@@ -2,15 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpiredResourceException = exports.UnauthorizedResourceActionException = exports.ResourceExistsException = exports.ResourceNotFoundException = void 0;
 const exception_1 = require("./exception");
-class ResourceNotFoundException extends exception_1.Exception {
+class ResourceNotFoundException extends exception_1.ResurgenceException {
 }
 exports.ResourceNotFoundException = ResourceNotFoundException;
-class ResourceExistsException extends exception_1.Exception {
+class ResourceExistsException extends exception_1.ResurgenceException {
 }
 exports.ResourceExistsException = ResourceExistsException;
-class UnauthorizedResourceActionException extends exception_1.Exception {
+class UnauthorizedResourceActionException extends exception_1.ResurgenceException {
 }
 exports.UnauthorizedResourceActionException = UnauthorizedResourceActionException;
-class ExpiredResourceException extends exception_1.Exception {
+class ExpiredResourceException extends exception_1.ResurgenceException {
 }
 exports.ExpiredResourceException = ExpiredResourceException;

package/dist/types/error.type.d.ts

@@ -3,4 +3,5 @@ export interface ErrorContent {
     status?: number;
     description: string;
     context?: string;
+    data?: string;
 }

package/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  testEnvironment: "node",
+  transform: {
+    "^.+.tsx?$": ["ts-jest",{}],
+  },
+};

package/package.json

@@ -1,17 +1,15 @@
 {
   "name": "resurgence-data",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "description": "DTOs and shareable resources",
   "module": "dist/index.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
   "exports": {
     ".": {
       "import": "./dist/index.js",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     }
   },
   "scripts": {

package/src/authentication/authentication.data.ts

@@ -0,0 +1,33 @@
+export interface AuthenticationBillerRole {
+  authenticationId: string;
+  billerId: string;
+  role: string;
+}
+
+export interface LoggedInUser {
+  id: string;
+  firstName: string;
+  lastName: string;
+  emailAddress: string;
+  phoneNumber: string;
+  merchantRoles: AuthenticationBillerRole[];
+}
+
+export interface ResetPasswordEmailRequest {
+  firstName: string;
+  emailAddress: string;
+  actionUrl: string;
+}
+
+export interface NewUserEmailRequest extends ResetPasswordEmailRequest {}
+
+export interface UpdateAuthenticationModel {
+  id: string;
+  userId?: string;
+  password?: string | null;
+  token?: string | null;
+  tokenExpiry?: Date | null;
+  active?: boolean;
+  twoFactorEnabled?: boolean;
+  role?: string;
+}

package/src/authentication/authentication.dto.ts

@@ -0,0 +1,108 @@
+import { IsBoolean, IsEmail, IsIn, IsOptional, IsString, IsUUID, Length } from "class-validator";
+import { accountTypes } from "../types/account.type";
+import { isSameAs } from "../validation/custom-validation";
+
+export class SignUpDTO {
+  firstName: string;
+  lastName: string;
+  emailAddress: string;
+  phoneNumber: string;
+}
+
+export class LoginRequestDTO {
+  @IsString({ message: "Please enter your username / email address" })
+  emailAddress: string;
+  @IsString({ message: "Please enter your password" })
+  password: string;
+}
+
+export class RecoverAccountDTO {
+  @IsString({ message: "Please enter your email address." })
+  emailAddress: string;
+}
+
+export class SendInviteDTO {
+  @IsUUID(4, { message: "Please provide a valid merchant / biller identifier" })
+  billerId: string;
+  @IsString({ message: "Please enter the email address of your invitee" })
+  @IsEmail(undefined, { message: "Please enter a valid email address" })
+  emailAddress: string;
+  @IsString({ message: "Please enter a valid data type" })
+  @IsIn(accountTypes, { message: "Please select a valid role type" })
+  role: string;
+}
+
+export class ActivationRequestDTO {
+  @IsString({ message: "Please provide your activation code" })
+  token: string;
+  @IsString({ message: "Please provide your password" })
+  password: string;
+  @IsOptional()
+  @IsString({ message: "Please confirm your password" })
+  @isSameAs("password", { message: "Your passwords to not match. Please check" })
+  passwordConfirm?: string;
+}
+
+export class UpdateAuthenticationDTO {
+  @IsUUID()
+  userId: string;
+  @IsOptional()
+  @IsBoolean()
+  active?: boolean;
+  @IsOptional()
+  @IsString({ message: "Please enter a valid data type" })
+  @IsIn(accountTypes, { message: "Please select a valid role type" })
+  role?: string;
+}
+
+export class TwoFactorAuthRequestDTO {
+  @IsEmail(undefined, { message: "Please enter a valid email address" })
+  @IsString({ message: "Please enter the email address of your invitee" })
+  emailAddress: string;
+  @IsString({ message: "Please provide the 6 character code" })
+  @Length(6, 6, { message: "Please enter a 6 character code" })
+  token: string;
+}
+
+export class TwoFactorCreateDTO {
+  emailAddress: string;
+  token: string;
+  authenticationId: string;
+  tokenExpiry?: Date;
+}
+
+export class LoginResponseDTO {
+  twoFactorEnabled: boolean;
+  message?: string;
+  token?: string;
+}
+
+export interface UserAuthenticationBillerRole {
+  id: string;
+  firstName?: string;
+  lastName?: string;
+  emailAddress: string;
+  phoneNumber?: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  authentication: {
+    id: string;
+    userId?: string;
+    password?: string | null;
+    token?: string | null;
+    tokenExpiry?: Date | null;
+    active: boolean;
+    twoFactorEnabled: boolean;
+    role: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    authenticationBillerRole: {
+      id: string;
+      billerId: string;
+      authenticationId: string;
+      role: string;
+      createdAt?: Date;
+      updatedAt?: Date;
+    }[];
+  };
+}

package/src/authentication/index.ts

@@ -0,0 +1,4 @@
+export * from "./authentication.data";
+export * from "./authentication.dto";
+export * from "./invite.dto";
+export * from "./invite.data";

package/src/authentication/invite.data.ts

@@ -0,0 +1,14 @@
+export interface InviteCreateModel {
+  userId: string;
+  emailAddress: string;
+  firstName: string;
+  lastName: string;
+  billerId: string;
+  token: string;
+  status?: string;
+  role: string;
+  tokenExpiry?: Date;
+}
+export interface InviteUpdateModel extends InviteCreateModel {
+  id: string;
+}

package/src/authentication/invite.dto.ts

@@ -0,0 +1,30 @@
+import { IsEmail, IsIn, IsString, IsUUID } from "class-validator";
+import { accountTypes } from "../types/account.type";
+
+export class InviteRequestDTO {
+  @IsString({ message: "Please enter your invitees first name" })
+  firstName: string;
+  @IsString({ message: "Please enter your invitees first name" })
+  lastName: string;
+  @IsEmail(undefined, { message: "Please enter a valid email address" })
+  @IsString({ message: "Please enter your invitees first name" })
+  emailAddress: string;
+  @IsIn(accountTypes, { message: "Please select a valid role tyoe" })
+  role: string;
+  @IsUUID(4, { message: "Please enter a valid merchant identifier" })
+  billerId: string;
+  @IsUUID(4, { message: "Please enter a valid user identifier" })
+  userId: string;
+}
+
+export class AcceptInviteInviteDTO {
+  @IsString({ message: "Please enter the valid invite token" })
+  token: string;
+  @IsString({ message: "Please enter a valid password" })
+  password: string;
+}
+
+export class RevokeInviteDTO {
+  @IsUUID(4, { message: "Please select a valid invite" })
+  id: string;
+}

package/src/exception/authentication.exception.ts

@@ -0,0 +1,7 @@
+import { ResurgenceException } from "./exception";
+
+export class InvalidCredentialsException extends ResurgenceException {}
+
+export class InvalidUserException extends ResurgenceException {}
+
+export class InactiveUserException extends ResurgenceException {}

package/src/exception/authorization.exception.ts

@@ -0,0 +1,5 @@
+import { ResurgenceException } from "./exception";
+
+export class InvalidAuthorizationException extends ResurgenceException {}
+
+export class ExpiredAuthorizationException extends ResurgenceException {}

package/src/exception/data.exception.ts

@@ -0,0 +1,3 @@
+import { ResurgenceException } from "./exception";
+
+export class InvalidPayloadException extends ResurgenceException {}

package/src/exception/database.exception.ts

@@ -0,0 +1,3 @@
+import { ResurgenceException } from "./exception";
+
+export class DatabaseProcessException extends ResurgenceException {}

package/src/exception/exception.ts

@@ -0,0 +1,24 @@
+import { ErrorContent } from "../types/error.type";
+
+export class ResurgenceException extends Error {
+  description?: string;
+  status!: number | 500;
+  context!: string;
+  data!: any;
+  constructor(errorContent?: ErrorContent) {
+    super();
+    if (errorContent) {
+      this.message = errorContent.message;
+      this.description = errorContent.description;
+      if (errorContent.status) {
+        this.status = errorContent.status;
+      }
+      if (errorContent.context) {
+        this.context = errorContent.context;
+      }
+      if (errorContent.data) {
+        this.data = errorContent.data;
+      }
+    }
+  }
+}

package/src/exception/index.ts

@@ -0,0 +1,7 @@
+export * from "./resource.exception";
+export * from "./exception";
+export * from "./authentication.exception";
+export * from "./authorization.exception";
+export * from "./database.exception";
+export * from "./integration.exception";
+export * from "./process.exception";

package/src/exception/integration.exception.ts

@@ -0,0 +1,5 @@
+import { ResurgenceException } from "./exception";
+
+export class MessagingException extends ResurgenceException {}
+
+export class ThirdPartyIntegrationException extends ResurgenceException {}

package/src/exception/process.exception.ts

@@ -0,0 +1,3 @@
+import { ResurgenceException } from "./exception";
+
+export class IncompleteProcessException extends ResurgenceException {}

package/src/exception/resource.exception.ts

@@ -0,0 +1,9 @@
+import { ResurgenceException } from "./exception";
+
+export class ResourceNotFoundException extends ResurgenceException {}
+
+export class ResourceExistsException extends ResurgenceException {}
+
+export class UnauthorizedResourceActionException extends ResurgenceException {}
+
+export class ExpiredResourceException extends ResurgenceException {}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from "./authentication";
+export * from "./response";
+export * from "./exception";
+export * from "./user";
+export * from "./messaging";

package/src/messaging/index.ts

@@ -0,0 +1 @@
+export * from "./message.dto";

package/src/messaging/message.dto.ts

@@ -0,0 +1,5 @@
+export interface QueueMessageContent {
+  message: any;
+  queueName: string;
+  action: string;
+}

package/src/response/index.ts

@@ -0,0 +1 @@
+export * from "./response.dto";

package/src/response/response.dto.ts

@@ -0,0 +1,7 @@
+export interface GeneralResponseDTO {
+  message: string;
+}
+
+export interface LoginResponse {
+  token: string;
+}

package/src/types/account.type.ts

@@ -0,0 +1,3 @@
+export const accountTypes = ["ADMINISTRATOR", "USER", "SUPPORT", "BILLER", "BILLER_ADMINISTRATOR", "BILLER_USER"];
+
+export const InviteStatuses = ["ACCEPTED", "PENDING", "REVOKED"];

package/src/types/error.type.ts

@@ -0,0 +1,7 @@
+export interface ErrorContent {
+  message: string;
+  status?: number;
+  description: string;
+  context?: string;
+  data?: string;
+}

package/src/user/index.ts

@@ -0,0 +1 @@
+export * from "./user";

package/src/user/user.ts

@@ -0,0 +1,32 @@
+import { IsBoolean, IsEmail, IsOptional, IsString, IsUUID } from "class-validator";
+
+export class CreateUserDTO {
+  @IsString({ message: "Please enter your first name." })
+  firstName: string;
+
+  @IsString({ message: "Please enter your last name." })
+  lastName: string;
+
+  @IsEmail(undefined, { message: "Please enter a valid email address" })
+  @IsString({ message: "Please enter a valid email address." })
+  emailAddress: string;
+
+  @IsString({ message: "Please enter your phone number." })
+  phoneNumber: string;
+  @IsString({ message: "Please enter your business name." })
+  businessName: string;
+  @IsOptional() // Allows the property to be optional
+  @IsString({ message: "Please provide a valid avatar URL." })
+  avatarUrl?: string;
+  @IsOptional()
+  @IsBoolean({ message: "Corporate must be a boolean value." })
+  corporate?: boolean;
+
+  @IsString({ message: "Please specify the account type." })
+  accountType: string;
+}
+
+export class UpdateUserDTO extends CreateUserDTO {
+  @IsUUID(4, { message: "Please enter a valid user id format" })
+  id: string;
+}

package/src/validation/custom-validation.ts

@@ -0,0 +1,20 @@
+import { registerDecorator, ValidationArguments, ValidationOptions } from "class-validator";
+
+export function isSameAs(property: string, validationOptions: ValidationOptions) {
+  return function (object: Object, propertyName: string) {
+    registerDecorator({
+      name: "isSameAs",
+      target: object.constructor,
+      propertyName: propertyName,
+      constraints: [property],
+      options: validationOptions,
+      validator: {
+        validate(value: any, args: ValidationArguments) {
+          const [relatedPropertyName] = args.constraints;
+          const relatedValue = (args.object as any)[relatedPropertyName];
+          return value === relatedValue;
+        },
+      },
+    });
+  };
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "CommonJS",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "moduleResolution": "node",
+    "strictPropertyInitialization": false,
+    "forceConsistentCasingInFileNames": true,
+    "experimentalDecorators": true /* Enable experimental support for legacy experimental decorators. */,
+    "emitDecoratorMetadata": true,
+    "esModuleInterop": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.test.ts"]
+}