@dynamatix/gb-schemas 2.0.34 → 2.0.36

package/dist/applications/application-mortgage.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-mortgage.model.d.ts","sourceRoot":"","sources":["../../applications/application-mortgage.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AA0S/C,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA6C,CAAC;AAEjE,eAAe,aAAa,CAAC"}

package/dist/applications/application-mortgage.model.js

@@ -0,0 +1,271 @@
+import mongoose from "mongoose";
+import { Pound } from "../value-objects/pound";
+const mortgageSchema = new mongoose.Schema({
+    applicationId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Application",
+        required: true,
+        description: "Unique identifier for the application",
+    },
+    pageValidFlag: {
+        type: Boolean,
+        default: false,
+        description: "True if all mandatory fields have been completed, otherwise false",
+    },
+    existingMortgageLender: {
+        type: String,
+        maxlength: 35,
+        description: "Name of the existing mortgage lender",
+    },
+    topSlicing: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the mortgage is being paid off using top slicing",
+    },
+    purposeOfMortgage: {
+        type: String,
+        required: true,
+        maxlength: 50,
+        description: "Purpose of the mortgage (e.g., purchase, refinance)",
+    },
+    depositComeFromLids: {
+        type: [mongoose.Schema.Types.ObjectId],
+        ref: "Lookup",
+        required: true,
+        default: null,
+        description: "Where the deposit for the mortgage will come from",
+    },
+    ifOtherDetails: {
+        type: String,
+        maxlength: 50,
+        required: true,
+        description: "Details if the deposit comes from 'Other'",
+    },
+    purchasePrice: {
+        type: Pound,
+        required: true,
+        description: "Purchase price of the property",
+    },
+    repaymentTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        required: true,
+        default: null,
+        description: "Lookup ID representing the type of repayment (e.g., interest-only, repayment)",
+    },
+    exitStrategyLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        required: true,
+        default: null,
+        description: "Lookup ID representing the Exit strategy for the mortgage)",
+    },
+    isCapitalRaise: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if capital raising is part of this finance",
+    },
+    purchaseDate: {
+        type: String,
+        required: true,
+        default: null,
+        description: "Purchase date of the property",
+    },
+    estimatedValue: {
+        type: Pound,
+        required: true,
+        description: "Estimated value of the property",
+    },
+    loanRequired: {
+        type: Pound,
+        required: true,
+        description: "Amount of finance required",
+    },
+    monthlyRentalIncome: {
+        type: Pound,
+        required: true,
+        description: "Monthly rental income from the property",
+    },
+    outstandingBalance: {
+        type: Pound,
+        required: true,
+        description: "Outstanding balance on the existing mortgage",
+    },
+    fundRaisedFor: {
+        type: String,
+        maxlength: 250,
+        required: true,
+        description: "What the funds raised will be used for",
+    },
+    sourceOfFundsLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        required: true,
+        default: null,
+        description: "Lookup ID representing the Main source of income for monthly finance payments",
+    },
+    sourceOfFundDetails: {
+        type: String,
+        maxlength: 50,
+        required: true,
+        description: "Additional details if the source of funds is 'Other'",
+    },
+    propertyValuationDetails: {
+        type: String,
+        maxlength: 35,
+        required: true,
+        description: "Details on who to contact for property valuation",
+    },
+    telephoneNumber: {
+        type: String,
+        maxlength: 15,
+        required: true,
+        description: "Contact number for property valuation",
+    },
+    isDistressedSale: {
+        type: Boolean,
+        default: false,
+        required: true,
+        description: "Indicates if this is a distressed sale",
+    },
+    isPurchasedBelowMarketValue: {
+        type: Boolean,
+        default: false,
+        required: true,
+        description: "Indicates if the property is purchased below market value",
+    },
+    isPurchasedAsSale: {
+        type: Boolean,
+        default: false,
+        required: true,
+        description: "Indicates if the property is purchased as a sale and rent back",
+    },
+    isReadyToSell: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the property is ready to sell or let out",
+    },
+    isGovernmentInitiative: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if this purchase is part of a government initiative",
+    },
+    vendorsName: {
+        type: String,
+        maxlength: 35,
+        description: "Vendor's name in case of property sale",
+    },
+    saleMadeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        description: "Method of sale made",
+    },
+    isTheIntentionToLet: {
+        type: Boolean,
+        default: false,
+        description: "Indicates if the intention is to let out the property",
+    },
+    proposedTenantsLids: {
+        type: [mongoose.Schema.Types.ObjectId],
+        ref: "Lookup",
+        description: "Proposed tenants for the property",
+    },
+    leaseTypeLid: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Lookup",
+        required: true,
+        default: null,
+        description: "Lease type for the property",
+    },
+}, {
+    timestamps: true,
+    toJSON: { virtuals: true },
+    toObject: { virtuals: true },
+});
+// const virtualDepositComeFrom = mortgageSchema.virtual("depositComeFrom", {
+//   ref: "Lookup",
+//   localField: "depositComeFromLid",
+//   foreignField: "_id",
+//   justOne: false,
+// }) as VirtualWithDescription;
+// virtualDepositComeFrom.description =
+//   "Populated lookup values for where the deposit for the mortgage will come from";
+// const virtualRepaymentType = mortgageSchema.virtual("repaymentType", {
+//   ref: "Lookup",
+//   localField: "repaymentTypeLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualRepaymentType.description =
+//   "Populated lookup value representing the type of repayment";
+// const virtualExitStrategy = mortgageSchema.virtual("exitStrategy", {
+//   ref: "Lookup",
+//   localField: "exitStrategyLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualExitStrategy.description = "Populated lookup value for exit strategy";
+// const virtualSourceOfFunds = mortgageSchema.virtual("sourceOfFunds", {
+//   ref: "Lookup",
+//   localField: "sourceOfFundsLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualSourceOfFunds.description =
+//   "Populated lookup value for the main source of income for monthly finance payments";
+// const virtualSaleMade = mortgageSchema.virtual("saleMade", {
+//   ref: "Lookup",
+//   localField: "saleMadeLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualSaleMade.description = "Populated lookup value for method of sale made";
+// const virtualProposedTenants = mortgageSchema.virtual("proposedTenants", {
+//   ref: "Lookup",
+//   localField: "proposedTenantsLid",
+//   foreignField: "_id",
+//   justOne: false,
+// }) as VirtualWithDescription;
+// virtualProposedTenants.description =
+//   "Populated lookup values for proposed tenants of the property";
+// const virtualLeaseType = mortgageSchema.virtual("leaseType", {
+//   ref: "Lookup",
+//   localField: "leaseTypeLid",
+//   foreignField: "_id",
+//   justOne: true,
+// }) as VirtualWithDescription;
+// virtualLeaseType.description = "Populated lookup value for lease type";
+// virtual property 'applicationType'
+mortgageSchema.virtual("applicationType").get(function () {
+    return this.applicationId?.applicationTypeLid instanceof
+        mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.applicationTypeLid?.text || null;
+});
+// virtual property 'lendingType'
+mortgageSchema.virtual("lendingType").get(function () {
+    return this.applicationId?.lendingTypeLid instanceof
+        mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.lendingTypeLid?.text || null;
+});
+// virtual property 'purchaseType'
+mortgageSchema.virtual("purchaseType").get(function () {
+    return this.applicationId?.purchaseTypeLid instanceof
+        mongoose.Types.ObjectId
+        ? null
+        : this.applicationId?.purchaseTypeLid?.text || null;
+});
+// virtual property 'lendingType'
+mortgageSchema.virtual("sourceOfWealth").get(function () {
+    const sourceOfWealthLids = this.applicationId?.sourceOfWealthLids;
+    if (!Array.isArray(sourceOfWealthLids)) {
+        return null;
+    }
+    return sourceOfWealthLids
+        .filter((lid) => !(lid instanceof mongoose.Types.ObjectId))
+        .map((lid) => lid?.text || null)
+        .filter((text) => text !== null);
+});
+const MortgageModel = mongoose.model("Mortgage", mortgageSchema);
+export default MortgageModel;

package/dist/applications/application-note.model.d.ts

@@ -0,0 +1,144 @@
+import mongoose from "mongoose";
+declare const ApplictionNoteModel: mongoose.Model<{
+    comment: string;
+    applicationId: mongoose.Types.ObjectId;
+    createdBy: string;
+    noteId: string;
+    createdOn: string;
+    username: string;
+    subject: string;
+    note: string;
+    reminderDate: string;
+    attachmentDocumentId: string;
+    assignedOperation: string;
+    autoCreated: string;
+    additionalData: any;
+    autoCreatedId: string;
+    assignedTo: string;
+    assignedBy: string;
+    reminderStatus: string;
+    createdByUserId?: mongoose.Types.ObjectId | null | undefined;
+    typeLid?: mongoose.Types.ObjectId | null | undefined;
+    subTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    assignedByUserId?: mongoose.Types.ObjectId | null | undefined;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    comment: string;
+    applicationId: mongoose.Types.ObjectId;
+    createdBy: string;
+    noteId: string;
+    createdOn: string;
+    username: string;
+    subject: string;
+    note: string;
+    reminderDate: string;
+    attachmentDocumentId: string;
+    assignedOperation: string;
+    autoCreated: string;
+    additionalData: any;
+    autoCreatedId: string;
+    assignedTo: string;
+    assignedBy: string;
+    reminderStatus: string;
+    createdByUserId?: mongoose.Types.ObjectId | null | undefined;
+    typeLid?: mongoose.Types.ObjectId | null | undefined;
+    subTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    assignedByUserId?: mongoose.Types.ObjectId | null | undefined;
+}> & {
+    comment: string;
+    applicationId: mongoose.Types.ObjectId;
+    createdBy: string;
+    noteId: string;
+    createdOn: string;
+    username: string;
+    subject: string;
+    note: string;
+    reminderDate: string;
+    attachmentDocumentId: string;
+    assignedOperation: string;
+    autoCreated: string;
+    additionalData: any;
+    autoCreatedId: string;
+    assignedTo: string;
+    assignedBy: string;
+    reminderStatus: string;
+    createdByUserId?: mongoose.Types.ObjectId | null | undefined;
+    typeLid?: mongoose.Types.ObjectId | null | undefined;
+    subTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    assignedByUserId?: mongoose.Types.ObjectId | null | undefined;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
+    comment: string;
+    applicationId: mongoose.Types.ObjectId;
+    createdBy: string;
+    noteId: string;
+    createdOn: string;
+    username: string;
+    subject: string;
+    note: string;
+    reminderDate: string;
+    attachmentDocumentId: string;
+    assignedOperation: string;
+    autoCreated: string;
+    additionalData: any;
+    autoCreatedId: string;
+    assignedTo: string;
+    assignedBy: string;
+    reminderStatus: string;
+    createdByUserId?: mongoose.Types.ObjectId | null | undefined;
+    typeLid?: mongoose.Types.ObjectId | null | undefined;
+    subTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    assignedByUserId?: mongoose.Types.ObjectId | null | undefined;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    comment: string;
+    applicationId: mongoose.Types.ObjectId;
+    createdBy: string;
+    noteId: string;
+    createdOn: string;
+    username: string;
+    subject: string;
+    note: string;
+    reminderDate: string;
+    attachmentDocumentId: string;
+    assignedOperation: string;
+    autoCreated: string;
+    additionalData: any;
+    autoCreatedId: string;
+    assignedTo: string;
+    assignedBy: string;
+    reminderStatus: string;
+    createdByUserId?: mongoose.Types.ObjectId | null | undefined;
+    typeLid?: mongoose.Types.ObjectId | null | undefined;
+    subTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    assignedByUserId?: mongoose.Types.ObjectId | null | undefined;
+}>> & mongoose.FlatRecord<{
+    comment: string;
+    applicationId: mongoose.Types.ObjectId;
+    createdBy: string;
+    noteId: string;
+    createdOn: string;
+    username: string;
+    subject: string;
+    note: string;
+    reminderDate: string;
+    attachmentDocumentId: string;
+    assignedOperation: string;
+    autoCreated: string;
+    additionalData: any;
+    autoCreatedId: string;
+    assignedTo: string;
+    assignedBy: string;
+    reminderStatus: string;
+    createdByUserId?: mongoose.Types.ObjectId | null | undefined;
+    typeLid?: mongoose.Types.ObjectId | null | undefined;
+    subTypeLid?: mongoose.Types.ObjectId | null | undefined;
+    assignedByUserId?: mongoose.Types.ObjectId | null | undefined;
+}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>;
+export default ApplictionNoteModel;
+//# sourceMappingURL=application-note.model.d.ts.map

package/dist/applications/application-note.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-note.model.d.ts","sourceRoot":"","sources":["../../applications/application-note.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AA+EhC,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA+C,CAAC;AACzE,eAAe,mBAAmB,CAAC"}

package/dist/applications/application-note.model.js

@@ -0,0 +1,78 @@
+import mongoose from "mongoose";
+const noteSchema = new mongoose.Schema({
+    applicationId: { type: mongoose.Schema.Types.ObjectId, ref: "Application", required: true },
+    noteId: {
+        type: String,
+        default: null
+    },
+    createdOn: {
+        type: String,
+        default: null
+    },
+    createdBy: {
+        type: String,
+        default: null
+    },
+    username: {
+        type: String,
+        default: null
+    },
+    createdByUserId: {
+        type: mongoose.Schema.Types.ObjectId, ref: "User",
+    },
+    typeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
+    subTypeLid: { type: mongoose.Schema.Types.ObjectId, ref: "Lookup" },
+    subject: {
+        type: String,
+        default: null
+    },
+    note: {
+        type: String,
+        required: true
+    },
+    reminderDate: {
+        type: String,
+        default: null
+    },
+    attachmentDocumentId: {
+        type: String,
+        default: null
+    },
+    assignedOperation: {
+        type: String,
+        default: ''
+    },
+    autoCreated: {
+        type: String,
+        default: false
+    },
+    additionalData: {
+        type: mongoose.Schema.Types.Mixed,
+        default: null
+    },
+    autoCreatedId: {
+        type: String,
+        default: null
+    },
+    assignedTo: {
+        type: String,
+        default: ''
+    },
+    assignedBy: {
+        type: String,
+        default: null
+    },
+    assignedByUserId: {
+        type: mongoose.Schema.Types.ObjectId, ref: "User",
+    },
+    comment: {
+        type: String,
+        default: null
+    },
+    reminderStatus: {
+        type: String,
+        default: 'None'
+    }
+});
+const ApplictionNoteModel = mongoose.model("ApplictionNote", noteSchema);
+export default ApplictionNoteModel;

package/dist/applications/application-offer.model.d.ts

@@ -0,0 +1,24 @@
+import mongoose from "mongoose";
+declare const OfferModel: mongoose.Model<{
+    date?: string | null | undefined;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    date?: string | null | undefined;
+}> & {
+    date?: string | null | undefined;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
+    date?: string | null | undefined;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    date?: string | null | undefined;
+}>> & mongoose.FlatRecord<{
+    date?: string | null | undefined;
+}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>;
+export default OfferModel;
+//# sourceMappingURL=application-offer.model.d.ts.map

package/dist/applications/application-offer.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-offer.model.d.ts","sourceRoot":"","sources":["../../applications/application-offer.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAOhC,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;GAAuC,CAAC;AACxD,eAAe,UAAU,CAAC"}

package/dist/applications/application-offer.model.js

@@ -0,0 +1,6 @@
+import mongoose from "mongoose";
+const offerSchema = new mongoose.Schema({
+    date: { type: String } // The date associated with the offer
+});
+const OfferModel = mongoose.model("Offer", offerSchema);
+export default OfferModel;

package/dist/applications/application-onboarding.model.d.ts

@@ -0,0 +1,42 @@
+import mongoose from "mongoose";
+declare const ApplicationOnboardingModel: mongoose.Model<{
+    errors: string;
+    status: string;
+    warnings: string;
+    statusDate?: string | null | undefined;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    errors: string;
+    status: string;
+    warnings: string;
+    statusDate?: string | null | undefined;
+}> & {
+    errors: string;
+    status: string;
+    warnings: string;
+    statusDate?: string | null | undefined;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
+    errors: string;
+    status: string;
+    warnings: string;
+    statusDate?: string | null | undefined;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    errors: string;
+    status: string;
+    warnings: string;
+    statusDate?: string | null | undefined;
+}>> & mongoose.FlatRecord<{
+    errors: string;
+    status: string;
+    warnings: string;
+    statusDate?: string | null | undefined;
+}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>;
+export default ApplicationOnboardingModel;
+//# sourceMappingURL=application-onboarding.model.d.ts.map

package/dist/applications/application-onboarding.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-onboarding.model.d.ts","sourceRoot":"","sources":["../../applications/application-onboarding.model.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAUhC,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA4D,CAAC;AAC7F,eAAe,0BAA0B,CAAC"}

package/dist/applications/application-onboarding.model.js

@@ -0,0 +1,9 @@
+import mongoose from "mongoose";
+const onboardingSchema = new mongoose.Schema({
+    errors: { type: String, default: "" },
+    status: { type: String, default: "" },
+    statusDate: { type: String },
+    warnings: { type: String, default: "" }
+});
+const ApplicationOnboardingModel = mongoose.model("ApplicationOnboarding", onboardingSchema);
+export default ApplicationOnboardingModel;