gemcap-be-common 1.4.157 → 1.4.159

package/models/Scorecard.model.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import mongoose, { Model } from 'mongoose';
+export interface IScorecard {
+    name: string;
+}
+export interface IScorecardDoc extends IScorecard, Document {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardLean extends IScorecard {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardPlain extends IScorecard {
+    _id: string;
+}
+export type TScorecardModel = Model<IScorecard>;
+export declare const ScorecardSchema: mongoose.Schema<IScorecard, TScorecardModel, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IScorecard, mongoose.Document<unknown, {}, mongoose.FlatRecord<IScorecard>> & mongoose.FlatRecord<IScorecard> & {
+    _id: mongoose.Types.ObjectId;
+}>;
+export declare const Scorecard: TScorecardModel;

package/models/Scorecard.model.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scorecard = exports.ScorecardSchema = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+exports.ScorecardSchema = new mongoose_1.default.Schema({
+    name: {
+        type: String,
+        required: true,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+});
+exports.Scorecard = mongoose_1.default.model(_models_1.MODEL_NAMES.scorecard, exports.ScorecardSchema);

package/models/Scorecard.model.ts

@@ -0,0 +1,40 @@
+import mongoose, { Model } from 'mongoose';
+
+import { MODEL_NAMES } from './_models';
+
+export interface IScorecard {
+  name: string;
+}
+
+export interface IScorecardDoc extends IScorecard, Document {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IScorecardLean extends IScorecard {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IScorecardPlain extends IScorecard {
+  _id: string;
+}
+
+export type TScorecardModel = Model<IScorecard>;
+
+export const ScorecardSchema = new mongoose.Schema<IScorecard, TScorecardModel>(
+  {
+    name: {
+      type: String,
+      required: true,
+    },
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+  },
+);
+
+export const Scorecard = mongoose.model<IScorecard, TScorecardModel>(MODEL_NAMES.scorecard, ScorecardSchema);

package/models/ScorecardAnswer.model.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import mongoose, { Model } from 'mongoose';
+export type ScorecardAnswerValue = boolean | number | string;
+export interface IScorecardAnswer {
+    submissionId: mongoose.Types.ObjectId;
+    criterionKey: string;
+    value: ScorecardAnswerValue;
+    calculatedScore: number;
+}
+export interface IScorecardAnswerDoc extends IScorecardAnswer, Document {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardAnswerLean extends IScorecardAnswer {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardAnswerPlain extends Omit<IScorecardAnswer, 'submissionId'> {
+    _id: string;
+    submissionId: string;
+}
+export type TScorecardAnswerModel = Model<IScorecardAnswer>;
+export declare const ScorecardAnswerSchema: mongoose.Schema<IScorecardAnswer, TScorecardAnswerModel, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IScorecardAnswer, mongoose.Document<unknown, {}, mongoose.FlatRecord<IScorecardAnswer>> & mongoose.FlatRecord<IScorecardAnswer> & {
+    _id: mongoose.Types.ObjectId;
+}>;
+export declare const ScorecardAnswer: TScorecardAnswerModel;

package/models/ScorecardAnswer.model.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScorecardAnswer = exports.ScorecardAnswerSchema = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+exports.ScorecardAnswerSchema = new mongoose_1.default.Schema({
+    submissionId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.scorecardSubmission,
+        required: true,
+    },
+    criterionKey: {
+        type: String,
+        required: true,
+    },
+    value: {
+        type: mongoose_1.default.Schema.Types.Mixed,
+        required: true,
+    },
+    calculatedScore: {
+        type: Number,
+        required: true,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+});
+exports.ScorecardAnswer = mongoose_1.default.model(_models_1.MODEL_NAMES.scorecardAnswer, exports.ScorecardAnswerSchema);
+exports.ScorecardAnswerSchema.index({ submissionId: 1, criterionKey: 1 }, { unique: true });

package/models/ScorecardAnswer.model.ts

@@ -0,0 +1,67 @@
+import mongoose, { Model } from 'mongoose';
+
+import { MODEL_NAMES } from './_models';
+
+export type ScorecardAnswerValue =
+  | boolean
+  | number
+  | string;
+
+export interface IScorecardAnswer {
+  submissionId: mongoose.Types.ObjectId;
+  criterionKey: string;
+  value: ScorecardAnswerValue;
+  calculatedScore: number;
+}
+
+export interface IScorecardAnswerDoc extends IScorecardAnswer, Document {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IScorecardAnswerLean extends IScorecardAnswer {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IScorecardAnswerPlain extends Omit<IScorecardAnswer, 'submissionId'> {
+  _id: string;
+  submissionId: string;
+}
+
+export type TScorecardAnswerModel = Model<IScorecardAnswer>;
+
+export const ScorecardAnswerSchema = new mongoose.Schema<IScorecardAnswer, TScorecardAnswerModel>(
+  {
+    submissionId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.scorecardSubmission,
+      required: true,
+    },
+    criterionKey: {
+      type: String,
+      required: true,
+    },
+    value: {
+      type: mongoose.Schema.Types.Mixed,
+      required: true,
+    },
+    calculatedScore: {
+      type: Number,
+      required: true,
+    },
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+  },
+);
+
+export const ScorecardAnswer = mongoose.model<IScorecardAnswer, TScorecardAnswerModel>(MODEL_NAMES.scorecardAnswer, ScorecardAnswerSchema);
+
+ScorecardAnswerSchema.index(
+  { submissionId: 1, criterionKey: 1 },
+  { unique: true }
+);

package/models/ScorecardSubmission.model.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import mongoose, { Model } from 'mongoose';
+export interface IStorecardSubmission {
+    borrowerId: mongoose.Types.ObjectId;
+    scorecardId: mongoose.Types.ObjectId;
+    scorecardVersionId: mongoose.Types.ObjectId;
+    period: string;
+    totalScore?: number;
+    status: 'draft' | 'final';
+    lockedAt: Date;
+}
+export interface IStorecardSubmissionDoc extends IStorecardSubmission, Document {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IStorecardSubmissionLean extends IStorecardSubmission {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardSubmissionPlain extends Omit<IStorecardSubmission, 'borrowerId' | 'scorecardId' | 'scorecardVersionId'> {
+    _id: string;
+    borrowerId: string;
+    scorecardId: string;
+    scorecardVersionId: string;
+}
+export type TStorecardSubmissionModel = Model<IStorecardSubmission>;
+export declare const StorecardSubmissionSchema: mongoose.Schema<IStorecardSubmission, TStorecardSubmissionModel, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IStorecardSubmission, mongoose.Document<unknown, {}, mongoose.FlatRecord<IStorecardSubmission>> & mongoose.FlatRecord<IStorecardSubmission> & {
+    _id: mongoose.Types.ObjectId;
+}>;
+export declare const StorecardSubmission: TStorecardSubmissionModel;

package/models/ScorecardSubmission.model.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorecardSubmission = exports.StorecardSubmissionSchema = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+exports.StorecardSubmissionSchema = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.borrowers,
+        required: true,
+    },
+    scorecardId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.scorecard,
+        required: true,
+    },
+    scorecardVersionId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.scorecardVersion,
+        required: true,
+    },
+    period: {
+        type: String,
+        required: true,
+    },
+    totalScore: {
+        type: Number,
+    },
+    status: {
+        type: String,
+        enum: ['draft', 'final'],
+        required: true,
+    },
+    lockedAt: {
+        type: Date,
+        required: false,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+});
+exports.StorecardSubmission = mongoose_1.default.model(_models_1.MODEL_NAMES.scorecardSubmission, exports.StorecardSubmissionSchema);
+exports.StorecardSubmissionSchema.index({ borrowerId: 1, scorecardId: 1, period: 1 }, { unique: true });

package/models/ScorecardSubmission.model.ts

@@ -0,0 +1,81 @@
+import mongoose, { Model } from 'mongoose';
+
+import { MODEL_NAMES } from './_models';
+
+export interface IStorecardSubmission {
+  borrowerId: mongoose.Types.ObjectId;
+  scorecardId: mongoose.Types.ObjectId;
+  scorecardVersionId: mongoose.Types.ObjectId;
+  period: string;
+  totalScore?: number;
+  status: 'draft' | 'final';
+  lockedAt: Date;
+}
+
+export interface IStorecardSubmissionDoc extends IStorecardSubmission, Document {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IStorecardSubmissionLean extends IStorecardSubmission {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IScorecardSubmissionPlain extends Omit<IStorecardSubmission, 'borrowerId' | 'scorecardId' | 'scorecardVersionId'> {
+  _id: string;
+  borrowerId: string;
+  scorecardId: string;
+  scorecardVersionId: string;
+}
+
+export type TStorecardSubmissionModel = Model<IStorecardSubmission>;
+
+export const StorecardSubmissionSchema = new mongoose.Schema<IStorecardSubmission, TStorecardSubmissionModel>(
+  {
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.borrowers,
+      required: true,
+    },
+    scorecardId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.scorecard,
+      required: true,
+    },
+    scorecardVersionId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.scorecardVersion,
+      required: true,
+    },
+    period: {
+      type: String,
+      required: true,
+    },
+    totalScore: {
+      type: Number,
+    },
+    status: {
+      type: String,
+      enum: ['draft', 'final'],
+      required: true,
+    },
+    lockedAt: {
+      type: Date,
+      required: false,
+    },
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+  },
+);
+
+export const StorecardSubmission = mongoose.model<IStorecardSubmission, TStorecardSubmissionModel>(MODEL_NAMES.scorecardSubmission, StorecardSubmissionSchema);
+
+StorecardSubmissionSchema.index(
+  { borrowerId: 1, scorecardId: 1, period: 1 },
+  { unique: true }
+);

package/models/ScorecardVersion.model.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import Joi from 'joi';
+import mongoose, { Model } from 'mongoose';
+export interface IScorecardVersion {
+    scorecardId: mongoose.Types.ObjectId;
+    version: string;
+    validFrom: Date;
+    validTo?: Date;
+    type: unknown;
+}
+export interface IScorecardVersionDoc extends IScorecardVersion, Document {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardVersionLean extends IScorecardVersion {
+    _id: mongoose.Types.ObjectId;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IScorecardVersionPlain extends IScorecardVersion {
+    _id: string;
+}
+export type TScorecardVersionModel = Model<IScorecardVersion>;
+export declare const CRITERION_TYPES: readonly ["boolean", "enum", "number", "range", "rating"];
+export declare const ScorecardDefinitionJoiSchema: Joi.ObjectSchema<any>;
+export declare const ScorecardVersionSchema: mongoose.Schema<IScorecardVersion, TScorecardVersionModel, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IScorecardVersion, mongoose.Document<unknown, {}, mongoose.FlatRecord<IScorecardVersion>> & mongoose.FlatRecord<IScorecardVersion> & {
+    _id: mongoose.Types.ObjectId;
+}>;
+export declare const ScorecardVersion: TScorecardVersionModel;

package/models/ScorecardVersion.model.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScorecardVersion = exports.ScorecardVersionSchema = exports.ScorecardDefinitionJoiSchema = exports.CRITERION_TYPES = void 0;
+const joi_1 = __importDefault(require("joi"));
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("./_models");
+exports.CRITERION_TYPES = [
+    'boolean',
+    'enum',
+    'number',
+    'range',
+    'rating',
+];
+const scoringRuleSchema = joi_1.default.object({
+    score: joi_1.default.number().required(),
+    // mutually exclusive conditions
+    equals: joi_1.default.alternatives(joi_1.default.string(), joi_1.default.number(), joi_1.default.boolean()),
+    lt: joi_1.default.number(),
+    lte: joi_1.default.number(),
+    gt: joi_1.default.number(),
+    gte: joi_1.default.number(),
+    between: joi_1.default.array().items(joi_1.default.number()).length(2),
+})
+    .xor('equals', 'lt', 'lte', 'gt', 'gte', 'between')
+    .required();
+const criterionSchema = joi_1.default.object({
+    key: joi_1.default.string()
+        .regex(/^[a-z][a-zA-Z0-9]*$/)
+        .required(),
+    label: joi_1.default.string().required(),
+    type: joi_1.default.string()
+        .valid(...exports.CRITERION_TYPES)
+        .required(),
+    options: joi_1.default.when('type', {
+        is: 'enum',
+        then: joi_1.default.array().items(joi_1.default.string()).min(1).required(),
+        otherwise: joi_1.default.forbidden(),
+    }),
+    min: joi_1.default.when('type', {
+        is: 'rating',
+        then: joi_1.default.number().required(),
+        otherwise: joi_1.default.forbidden(),
+    }),
+    max: joi_1.default.when('type', {
+        is: 'rating',
+        then: joi_1.default.number().required(),
+        otherwise: joi_1.default.forbidden(),
+    }),
+    rules: joi_1.default.array()
+        .items(scoringRuleSchema)
+        .min(1)
+        .required(),
+});
+const sectionSchema = joi_1.default.object({
+    key: joi_1.default.string()
+        .regex(/^[a-z][a-zA-Z0-9]*$/)
+        .required(),
+    label: joi_1.default.string().required(),
+    order: joi_1.default.number().integer().min(1).required(),
+    maxScore: joi_1.default.number().required(),
+    criteria: joi_1.default.array()
+        .items(criterionSchema)
+        .min(1)
+        .required(),
+});
+exports.ScorecardDefinitionJoiSchema = joi_1.default.object({
+    sections: joi_1.default.array()
+        .items(sectionSchema)
+        .min(1)
+        .required(),
+}).required();
+exports.ScorecardVersionSchema = new mongoose_1.default.Schema({
+    scorecardId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.scorecard,
+        required: true,
+    },
+    version: {
+        type: String,
+        required: true,
+    },
+    validFrom: {
+        type: Date,
+        required: true,
+    },
+    validTo: {
+        type: Date,
+    },
+    type: {
+        type: String,
+        required: true,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+});
+exports.ScorecardVersion = mongoose_1.default.model(_models_1.MODEL_NAMES.scorecardVersion, exports.ScorecardVersionSchema);
+exports.ScorecardVersionSchema.pre('save', function (next) {
+    if (!this.isNew && this.isModified('definitionJson')) {
+        return next(new Error('ScorecardVersion is immutable'));
+    }
+    next();
+});