resurgence-data 1.0.20 → 1.0.21

package/dist/authentication/authentication.dto.d.ts

@@ -11,10 +11,8 @@ export declare class LoginRequestDTO {
 export declare class RecoverAccountDTO {
     emailAddress: string;
 }
-export declare class SendInviteDTO {
-    billerId: string;
+export declare class MFARequestDTO {
     emailAddress: string;
-    role: string;
 }
 export declare class ActivationRequestDTO {
     token: string;

package/dist/authentication/authentication.dto.js

@@ -9,10 +9,11 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoginResponseDTO = exports.TwoFactorCreateDTO = exports.TwoFactorAuthRequestDTO = exports.UpdateAuthenticationDTO = exports.ActivationRequestDTO = exports.SendInviteDTO = exports.RecoverAccountDTO = exports.LoginRequestDTO = exports.SignUpDTO = void 0;
+exports.LoginResponseDTO = exports.TwoFactorCreateDTO = exports.TwoFactorAuthRequestDTO = exports.UpdateAuthenticationDTO = exports.ActivationRequestDTO = exports.MFARequestDTO = exports.RecoverAccountDTO = exports.LoginRequestDTO = exports.SignUpDTO = void 0;
 const class_validator_1 = require("class-validator");
 const account_type_1 = require("../types/account.type");
 const custom_validation_1 = require("../validation/custom-validation");
+const swagger_1 = require("@nestjs/swagger");
 class SignUpDTO {
 }
 exports.SignUpDTO = SignUpDTO;
@@ -21,10 +22,12 @@ class LoginRequestDTO {
 exports.LoginRequestDTO = LoginRequestDTO;
 __decorate([
     (0, class_validator_1.IsString)({ message: "Please enter your username / email address" }),
+    (0, swagger_1.ApiProperty)({ description: "The email address for the user" }),
     __metadata("design:type", String)
 ], LoginRequestDTO.prototype, "emailAddress", void 0);
 __decorate([
     (0, class_validator_1.IsString)({ message: "Please enter your password" }),
+    (0, swagger_1.ApiProperty)({ description: "The password for the user" }),
     __metadata("design:type", String)
 ], LoginRequestDTO.prototype, "password", void 0);
 class RecoverAccountDTO {
@@ -32,40 +35,35 @@ class RecoverAccountDTO {
 exports.RecoverAccountDTO = RecoverAccountDTO;
 __decorate([
     (0, class_validator_1.IsString)({ message: "Please enter your email address." }),
+    (0, swagger_1.ApiProperty)({ description: "The email address for the user" }),
     __metadata("design:type", String)
 ], RecoverAccountDTO.prototype, "emailAddress", void 0);
-class SendInviteDTO {
+class MFARequestDTO {
 }
-exports.SendInviteDTO = SendInviteDTO;
+exports.MFARequestDTO = MFARequestDTO;
 __decorate([
-    (0, class_validator_1.IsUUID)(4, { message: "Please provide a valid merchant / biller identifier" }),
-    __metadata("design:type", String)
-], SendInviteDTO.prototype, "billerId", void 0);
-__decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter the email address of your invitee" }),
-    (0, class_validator_1.IsEmail)(undefined, { message: "Please enter a valid email address" }),
-    __metadata("design:type", String)
-], SendInviteDTO.prototype, "emailAddress", void 0);
-__decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter a valid data type" }),
-    (0, class_validator_1.IsIn)(account_type_1.accountTypes, { message: "Please select a valid role type" }),
+    (0, class_validator_1.IsString)({ message: "Please enter your email address." }),
+    (0, swagger_1.ApiProperty)({ description: "The email address for the user" }),
     __metadata("design:type", String)
-], SendInviteDTO.prototype, "role", void 0);
+], MFARequestDTO.prototype, "emailAddress", void 0);
 class ActivationRequestDTO {
 }
 exports.ActivationRequestDTO = ActivationRequestDTO;
 __decorate([
     (0, class_validator_1.IsString)({ message: "Please provide your activation code" }),
+    (0, swagger_1.ApiProperty)({ description: "Token provided in the users email" }),
     __metadata("design:type", String)
 ], ActivationRequestDTO.prototype, "token", void 0);
 __decorate([
     (0, class_validator_1.IsString)({ message: "Please provide your password" }),
+    (0, swagger_1.ApiProperty)({ description: "The password for the user" }),
     __metadata("design:type", String)
 ], ActivationRequestDTO.prototype, "password", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsString)({ message: "Please confirm your password" }),
     (0, custom_validation_1.isSameAs)("password", { message: "Your passwords to not match. Please check" }),
+    (0, swagger_1.ApiProperty)({ description: "Confirmed password from user" }),
     __metadata("design:type", String)
 ], ActivationRequestDTO.prototype, "passwordConfirm", void 0);
 class UpdateAuthenticationDTO {
@@ -92,11 +90,13 @@ exports.TwoFactorAuthRequestDTO = TwoFactorAuthRequestDTO;
 __decorate([
     (0, class_validator_1.IsEmail)(undefined, { message: "Please enter a valid email address" }),
     (0, class_validator_1.IsString)({ message: "Please enter the email address of your invitee" }),
+    (0, swagger_1.ApiProperty)({ description: "Email address of the user" }),
     __metadata("design:type", String)
 ], TwoFactorAuthRequestDTO.prototype, "emailAddress", void 0);
 __decorate([
     (0, class_validator_1.IsString)({ message: "Please provide the 6 character code" }),
     (0, class_validator_1.Length)(6, 6, { message: "Please enter a 6 character code" }),
+    (0, swagger_1.ApiProperty)({ description: "6 digit code provided by the user" }),
     __metadata("design:type", String)
 ], TwoFactorAuthRequestDTO.prototype, "token", void 0);
 class TwoFactorCreateDTO {

package/dist/authentication/invite.dto.js

@@ -12,49 +12,59 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RevokeInviteDTO = exports.AcceptInviteInviteDTO = exports.InviteRequestDTO = void 0;
 const class_validator_1 = require("class-validator");
 const account_type_1 = require("../types/account.type");
+const swagger_1 = require("@nestjs/swagger");
 class InviteRequestDTO {
 }
 exports.InviteRequestDTO = InviteRequestDTO;
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter your invitees first name" }),
+    (0, class_validator_1.IsString)({ message: "Could you provide your invitee's first name?" }),
+    (0, swagger_1.ApiProperty)({ description: "First name of the invitee" }),
     __metadata("design:type", String)
 ], InviteRequestDTO.prototype, "firstName", void 0);
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter your invitees first name" }),
+    (0, class_validator_1.IsString)({ message: "Could you provide your invitee's last name?" }),
+    (0, swagger_1.ApiProperty)({ description: "Last name of the invitee" }),
     __metadata("design:type", String)
 ], InviteRequestDTO.prototype, "lastName", void 0);
 __decorate([
-    (0, class_validator_1.IsEmail)(undefined, { message: "Please enter a valid email address" }),
-    (0, class_validator_1.IsString)({ message: "Please enter your invitees first name" }),
+    (0, class_validator_1.IsEmail)(undefined, { message: "Hmm, that doesn't look like a valid email. Could you double-check it?" }),
+    (0, class_validator_1.IsString)({ message: "We need your invitee's email address. Please provide it." }),
+    (0, swagger_1.ApiProperty)({ description: "Email address of the invitee" }),
     __metadata("design:type", String)
 ], InviteRequestDTO.prototype, "emailAddress", void 0);
 __decorate([
-    (0, class_validator_1.IsIn)(account_type_1.accountTypes, { message: "Please select a valid role tyoe" }),
+    (0, class_validator_1.IsIn)(account_type_1.accountTypes, { message: "Please pick a valid role type from the options." }),
+    (0, swagger_1.ApiProperty)({ description: "Role for the invitee" }),
     __metadata("design:type", String)
 ], InviteRequestDTO.prototype, "role", void 0);
 __decorate([
-    (0, class_validator_1.IsUUID)(4, { message: "Please enter a valid merchant identifier" }),
+    (0, class_validator_1.IsUUID)(4, { message: "The merchant identifier doesn't seem right. Could you check it?" }),
+    (0, swagger_1.ApiProperty)({ description: "Biller id for the merchant sending the invite" }),
     __metadata("design:type", String)
 ], InviteRequestDTO.prototype, "billerId", void 0);
 __decorate([
-    (0, class_validator_1.IsUUID)(4, { message: "Please enter a valid user identifier" }),
+    (0, class_validator_1.IsUUID)(4, { message: "The user identifier doesn't seem right. Could you check it?" }),
+    (0, swagger_1.ApiProperty)({ description: "User id of the inviter" }),
     __metadata("design:type", String)
 ], InviteRequestDTO.prototype, "userId", void 0);
 class AcceptInviteInviteDTO {
 }
 exports.AcceptInviteInviteDTO = AcceptInviteInviteDTO;
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter the valid invite token" }),
+    (0, class_validator_1.IsString)({ message: "Your invite token doesn't seem valid. Could you try again?" }),
+    (0, swagger_1.ApiProperty)({ description: "Token provided by user" }),
     __metadata("design:type", String)
 ], AcceptInviteInviteDTO.prototype, "token", void 0);
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter a valid password" }),
+    (0, class_validator_1.IsString)({ message: "Looks like your password isn't valid. Please provide one." }),
+    (0, swagger_1.ApiProperty)({ description: "Users password" }),
     __metadata("design:type", String)
 ], AcceptInviteInviteDTO.prototype, "password", void 0);
 class RevokeInviteDTO {
 }
 exports.RevokeInviteDTO = RevokeInviteDTO;
 __decorate([
-    (0, class_validator_1.IsUUID)(4, { message: "Please select a valid invite" }),
+    (0, class_validator_1.IsUUID)(4, { message: "Please select a valid invite to revoke." }),
+    (0, swagger_1.ApiProperty)({ description: "Id of the invite" }),
     __metadata("design:type", String)
 ], RevokeInviteDTO.prototype, "id", void 0);

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

@@ -1,2 +1,3 @@
 export declare const accountTypes: string[];
+export declare const inviteAccountTypes: string[];
 export declare const InviteStatuses: string[];

package/dist/types/account.type.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InviteStatuses = exports.accountTypes = void 0;
+exports.InviteStatuses = exports.inviteAccountTypes = exports.accountTypes = void 0;
 exports.accountTypes = ["ADMINISTRATOR", "USER", "SUPPORT", "BILLER", "BILLER_ADMINISTRATOR", "BILLER_USER"];
+exports.inviteAccountTypes = ["BILLER_ADMINISTRATOR", "BILLER_USER"];
 exports.InviteStatuses = ["ACCEPTED", "PENDING", "REVOKED"];

package/dist/user/user.d.ts

@@ -3,10 +3,9 @@ export declare class CreateUserDTO {
     lastName: string;
     emailAddress: string;
     phoneNumber: string;
-    businessName: string;
     avatarUrl?: string;
     corporate?: boolean;
-    accountType: string;
+    role: string;
 }
 export declare class UpdateUserDTO extends CreateUserDTO {
     id: string;

package/dist/user/user.js

@@ -11,45 +11,51 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateUserDTO = exports.CreateUserDTO = void 0;
 const class_validator_1 = require("class-validator");
+const account_type_1 = require("../types/account.type");
+const swagger_1 = require("@nestjs/swagger");
 class CreateUserDTO {
 }
 exports.CreateUserDTO = CreateUserDTO;
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter your first name." }),
+    (0, class_validator_1.IsString)({ message: "First name is required. Please provide it." }),
+    (0, swagger_1.ApiProperty)({ description: "User's first name" }),
     __metadata("design:type", String)
 ], CreateUserDTO.prototype, "firstName", void 0);
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter your last name." }),
+    (0, class_validator_1.IsString)({ message: "Last name is required. Please provide it." }),
+    (0, swagger_1.ApiProperty)({ description: "User's last name" }),
     __metadata("design:type", String)
 ], CreateUserDTO.prototype, "lastName", void 0);
 __decorate([
-    (0, class_validator_1.IsEmail)(undefined, { message: "Please enter a valid email address" }),
-    (0, class_validator_1.IsString)({ message: "Please enter a valid email address." }),
+    (0, class_validator_1.IsEmail)(undefined, { message: "Looks like your email isn't valid. Please double-check it." }),
+    (0, class_validator_1.IsString)({ message: "An email address is required. Please enter one." }),
+    (0, swagger_1.ApiProperty)({ description: "User's email address" }),
     __metadata("design:type", String)
 ], CreateUserDTO.prototype, "emailAddress", void 0);
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter your phone number." }),
+    (0, class_validator_1.IsString)({ message: "Phone number is required. Please enter it." }),
+    (0, swagger_1.ApiProperty)({ description: "User's phone number" }),
     __metadata("design:type", String)
 ], CreateUserDTO.prototype, "phoneNumber", void 0);
-__decorate([
-    (0, class_validator_1.IsString)({ message: "Please enter your business name." }),
-    __metadata("design:type", String)
-], CreateUserDTO.prototype, "businessName", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)() // Allows the property to be optional
     ,
-    (0, class_validator_1.IsString)({ message: "Please provide a valid avatar URL." }),
+    (0, class_validator_1.IsString)({ message: "Please provide a valid link for the avatar (optional)." }),
+    (0, swagger_1.ApiProperty)({ description: "User's profile link" }),
     __metadata("design:type", String)
 ], CreateUserDTO.prototype, "avatarUrl", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
-    (0, class_validator_1.IsBoolean)({ message: "Corporate must be a boolean value." }),
+    (0, class_validator_1.IsBoolean)({ message: "Corporate should be true or false (optional)." }),
+    (0, swagger_1.ApiProperty)({ description: "Corporate or private user" }),
     __metadata("design:type", Boolean)
 ], CreateUserDTO.prototype, "corporate", void 0);
 __decorate([
-    (0, class_validator_1.IsString)({ message: "Please specify the account type." }),
+    (0, class_validator_1.IsString)({ message: "Account type is required. Please specify it." }),
+    (0, class_validator_1.IsIn)(account_type_1.accountTypes, { message: "Please select a valid account type" }),
+    (0, swagger_1.ApiProperty)({ description: "users role" }),
     __metadata("design:type", String)
-], CreateUserDTO.prototype, "accountType", void 0);
+], CreateUserDTO.prototype, "role", void 0);
 class UpdateUserDTO extends CreateUserDTO {
 }
 exports.UpdateUserDTO = UpdateUserDTO;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resurgence-data",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "description": "DTOs and shareable resources",
   "module": "dist/index.js",
   "main": "dist/index.js",
@@ -24,6 +24,7 @@
     "typescript": "^5.7.2"
   },
   "dependencies": {
+    "@nestjs/swagger": "^8.1.1",
     "@types/jest": "^29.5.14",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",

package/src/authentication/authentication.dto.ts

@@ -1,6 +1,7 @@
 import { IsBoolean, IsEmail, IsIn, IsOptional, IsString, IsUUID, Length } from "class-validator";
-import { accountTypes } from "../types/account.type";
+import { accountTypes, inviteAccountTypes } from "../types/account.type";
 import { isSameAs } from "../validation/custom-validation";
+import { ApiProperty } from "@nestjs/swagger";
 
 export class SignUpDTO {
   firstName: string;
@@ -11,35 +12,35 @@ export class SignUpDTO {
 
 export class LoginRequestDTO {
   @IsString({ message: "Please enter your username / email address" })
+  @ApiProperty({ description: "The email address for the user" })
   emailAddress: string;
   @IsString({ message: "Please enter your password" })
+  @ApiProperty({ description: "The password for the user" })
   password: string;
 }
 
 export class RecoverAccountDTO {
   @IsString({ message: "Please enter your email address." })
+  @ApiProperty({ description: "The email address for the user" })
   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" })
+export class MFARequestDTO {
+  @IsString({ message: "Please enter your email address." })
+  @ApiProperty({ description: "The email address for the user" })
   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" })
+  @ApiProperty({ description: "Token provided in the users email" })
   token: string;
   @IsString({ message: "Please provide your password" })
+  @ApiProperty({ description: "The password for the user" })
   password: string;
   @IsOptional()
   @IsString({ message: "Please confirm your password" })
   @isSameAs("password", { message: "Your passwords to not match. Please check" })
+  @ApiProperty({ description: "Confirmed password from user" })
   passwordConfirm?: string;
 }
 
@@ -58,9 +59,11 @@ export class UpdateAuthenticationDTO {
 export class TwoFactorAuthRequestDTO {
   @IsEmail(undefined, { message: "Please enter a valid email address" })
   @IsString({ message: "Please enter the email address of your invitee" })
+  @ApiProperty({ description: "Email address of the user" })
   emailAddress: string;
   @IsString({ message: "Please provide the 6 character code" })
   @Length(6, 6, { message: "Please enter a 6 character code" })
+  @ApiProperty({ description: "6 digit code provided by the user" })
   token: string;
 }
 

package/src/authentication/invite.dto.ts

@@ -1,30 +1,46 @@
 import { IsEmail, IsIn, IsString, IsUUID } from "class-validator";
 import { accountTypes } from "../types/account.type";
+import { ApiProperty } from "@nestjs/swagger";
 
 export class InviteRequestDTO {
-  @IsString({ message: "Please enter your invitees first name" })
+  @IsString({ message: "Could you provide your invitee's first name?" })
+  @ApiProperty({ description: "First name of the invitee" })
   firstName: string;
-  @IsString({ message: "Please enter your invitees first name" })
+
+  @IsString({ message: "Could you provide your invitee's last name?" })
+  @ApiProperty({ description: "Last name of the invitee" })
   lastName: string;
-  @IsEmail(undefined, { message: "Please enter a valid email address" })
-  @IsString({ message: "Please enter your invitees first name" })
+
+  @IsEmail(undefined, { message: "Hmm, that doesn't look like a valid email. Could you double-check it?" })
+  @IsString({ message: "We need your invitee's email address. Please provide it." })
+  @ApiProperty({ description: "Email address of the invitee" })
   emailAddress: string;
-  @IsIn(accountTypes, { message: "Please select a valid role tyoe" })
+
+  @IsIn(accountTypes, { message: "Please pick a valid role type from the options." })
+  @ApiProperty({ description: "Role for the invitee" })
   role: string;
-  @IsUUID(4, { message: "Please enter a valid merchant identifier" })
+
+  @IsUUID(4, { message: "The merchant identifier doesn't seem right. Could you check it?" })
+  @ApiProperty({ description: "Biller id for the merchant sending the invite" })
   billerId: string;
-  @IsUUID(4, { message: "Please enter a valid user identifier" })
+
+  @IsUUID(4, { message: "The user identifier doesn't seem right. Could you check it?" })
+  @ApiProperty({ description: "User id of the inviter" })
   userId: string;
 }
 
 export class AcceptInviteInviteDTO {
-  @IsString({ message: "Please enter the valid invite token" })
+  @IsString({ message: "Your invite token doesn't seem valid. Could you try again?" })
+  @ApiProperty({ description: "Token provided by user" })
   token: string;
-  @IsString({ message: "Please enter a valid password" })
+
+  @IsString({ message: "Looks like your password isn't valid. Please provide one." })
+  @ApiProperty({ description: "Users password" })
   password: string;
 }
 
 export class RevokeInviteDTO {
-  @IsUUID(4, { message: "Please select a valid invite" })
+  @IsUUID(4, { message: "Please select a valid invite to revoke." })
+  @ApiProperty({ description: "Id of the invite" })
   id: string;
 }

package/src/types/account.type.ts

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

package/src/user/user.ts

@@ -1,29 +1,39 @@
-import { IsBoolean, IsEmail, IsOptional, IsString, IsUUID } from "class-validator";
+import { IsBoolean, IsEmail, IsIn, IsOptional, IsString, IsUUID } from "class-validator";
+import { accountTypes } from "../types/account.type";
+import { ApiProperty } from "@nestjs/swagger";
 
 export class CreateUserDTO {
-  @IsString({ message: "Please enter your first name." })
+  @IsString({ message: "First name is required. Please provide it." })
+  @ApiProperty({ description: "User's first name" })
   firstName: string;
 
-  @IsString({ message: "Please enter your last name." })
+  @IsString({ message: "Last name is required. Please provide it." })
+  @ApiProperty({ description: "User's last name" })
   lastName: string;
 
-  @IsEmail(undefined, { message: "Please enter a valid email address" })
-  @IsString({ message: "Please enter a valid email address." })
+  @IsEmail(undefined, { message: "Looks like your email isn't valid. Please double-check it." })
+  @IsString({ message: "An email address is required. Please enter one." })
+  @ApiProperty({ description: "User's email address" })
   emailAddress: string;
 
-  @IsString({ message: "Please enter your phone number." })
+  @IsString({ message: "Phone number is required. Please enter it." })
+  @ApiProperty({ description: "User's 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." })
+  @IsString({ message: "Please provide a valid link for the avatar (optional)." })
+  @ApiProperty({ description: "User's profile link" })
   avatarUrl?: string;
+
   @IsOptional()
-  @IsBoolean({ message: "Corporate must be a boolean value." })
+  @IsBoolean({ message: "Corporate should be true or false (optional)." })
+  @ApiProperty({ description: "Corporate or private user" })
   corporate?: boolean;
 
-  @IsString({ message: "Please specify the account type." })
-  accountType: string;
+  @IsString({ message: "Account type is required. Please specify it." })
+  @IsIn(accountTypes, { message: "Please select a valid account type" })
+  @ApiProperty({ description: "users role" })
+  role: string;
 }
 
 export class UpdateUserDTO extends CreateUserDTO {