gemcap-be-common 1.0.8 → 1.0.9

package/src/interfaces/upload-data.interface.d.ts

@@ -0,0 +1,14 @@
+import { IPaginatorOptions } from './collaterals.interface';
+export interface IUploadData {
+    borrowerId: string;
+    bbcDate: Date;
+    uploadUser: string;
+    fileHash: string;
+    fileName: string;
+    sheetName: string;
+}
+export interface IUploadedDataView {
+    totalItems: number;
+    items: {}[];
+    paginatorOptions: IPaginatorOptions;
+}

package/src/interfaces/upload-data.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/models/AccountPayableItem.model.d.ts

@@ -0,0 +1,17 @@
+import mongoose, { Document } from 'mongoose';
+import { ICollateralItem } from '../interfaces/collaterals.interface';
+export declare const ACCOUNT_PAYABLE_FIELDS: string[];
+export interface IAccountPayableItem extends ICollateralItem {
+    bbcDate: Date;
+    apDate: Date;
+    poNumber: string;
+    customerName: string;
+    amount: number;
+    otherInformation1: string;
+    otherInformation2: string;
+    otherInformation3: string;
+}
+export interface IAccountPayableItemDoc extends Document, IAccountPayableItem {
+}
+declare const _default: mongoose.Model<IAccountPayableItemDoc, {}, {}, {}, any>;
+export default _default;

package/src/models/AccountPayableItem.model.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACCOUNT_PAYABLE_FIELDS = void 0;
+var mongoose_1 = __importDefault(require("mongoose"));
+var mongooseLeanId = require('../plugins/id.plugin');
+exports.ACCOUNT_PAYABLE_FIELDS = [
+    '_id',
+    'apDate',
+    'poNumber',
+    'customerName',
+    'amount',
+    'otherInformation1',
+    'otherInformation2',
+    'otherInformation3',
+];
+var AccountPayableItemSchema = new mongoose_1.default.Schema({
+    bbcSheetId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'BBCSheets',
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+    apDate: {
+        type: Date,
+        required: true,
+    },
+    poNumber: {
+        type: String,
+        trim: true,
+    },
+    customerName: {
+        type: String,
+        trim: true,
+    },
+    amount: {
+        type: Number,
+        required: true,
+    },
+    otherInformation1: {
+        type: String,
+        trim: true,
+    },
+    otherInformation2: {
+        type: String,
+        trim: true,
+    },
+    otherInformation3: {
+        type: String,
+        trim: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+AccountPayableItemSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model('AccountPayableItem', AccountPayableItemSchema);

package/src/models/BBCDate.model.d.ts

@@ -0,0 +1,9 @@
+import mongoose, { Document } from 'mongoose';
+export interface IBBCDate {
+    borrowerId: mongoose.Types.ObjectId;
+    bbcDate: Date;
+}
+export interface IBBCDateDoc extends IBBCDate, Document {
+}
+declare const _default: mongoose.Model<IBBCDateDoc, {}, {}, {}, any>;
+export default _default;

package/src/models/BBCDate.model.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var mongoose_1 = __importDefault(require("mongoose"));
+var mongooseLeanId = require('../plugins/id.plugin');
+var BBCDateSchema = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'borrowers',
+        required: true,
+    },
+    bbcDate: {
+        type: Date,
+        required: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+BBCDateSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model('BBCDate', BBCDateSchema);

package/src/models/BBCSheet.model.d.ts

@@ -0,0 +1,18 @@
+import mongoose, { Document } from 'mongoose';
+import { IBBCDate } from './BBCDate.model';
+export interface IBBCSheet {
+    bbcDateId: mongoose.Types.ObjectId;
+    dataType: string;
+    uploadUser: mongoose.Types.ObjectId;
+    fileHash: string;
+    fileName: string;
+    sheetName: string;
+    comment: string;
+}
+export interface IBBCSheetDoc extends IBBCSheet, Document {
+}
+export interface IBBCSheetWithBBCDate extends IBBCSheetDoc {
+    bbcDate: IBBCDate;
+}
+declare const _default: mongoose.Model<IBBCSheetDoc, {}, {}, {}, any>;
+export default _default;

package/src/models/BBCSheet.model.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var mongoose_1 = __importDefault(require("mongoose"));
+var InventoryItem_model_1 = __importDefault(require("./InventoryItem.model"));
+var ReceiavableItem_model_1 = __importDefault(require("./ReceiavableItem.model"));
+var AccountPayableItem_model_1 = __importDefault(require("./AccountPayableItem.model"));
+var mongooseLeanId = require('../plugins/id.plugin');
+var BBCSheetSchema = new mongoose_1.default.Schema({
+    bbcDateId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'bbcDates',
+        required: true,
+    },
+    dataType: {
+        type: String,
+        required: true,
+        trim: true,
+    },
+    uploadUser: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'users',
+    },
+    fileHash: {
+        type: String,
+        trim: true,
+    },
+    fileName: {
+        type: String,
+        trim: true,
+    },
+    sheetName: {
+        type: String,
+        trim: true,
+    },
+    comment: {
+        type: String,
+        trim: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+BBCSheetSchema.plugin(mongooseLeanId);
+BBCSheetSchema.pre('findOneAndDelete', function (next) {
+    var bbcSheetId = this.getQuery()['_id'];
+    InventoryItem_model_1.default.deleteMany({ bbcSheetId: bbcSheetId }, next);
+    ReceiavableItem_model_1.default.deleteMany({ bbcSheetId: bbcSheetId }, next);
+    AccountPayableItem_model_1.default.deleteMany({ bbcSheetId: bbcSheetId }, next);
+});
+exports.default = mongoose_1.default.model('BBCSheet', BBCSheetSchema);

package/src/models/ComplianceItem.model.d.ts

@@ -0,0 +1,43 @@
+import mongoose, { Document } from 'mongoose';
+export interface IEmailRecipient {
+    email: string;
+    title?: string;
+    isActive: boolean;
+}
+export interface IEmailRecipientDocument extends IEmailRecipient, Document {
+}
+export interface IComplianceItem {
+    name: string;
+    importanceScore: number;
+    notificationDays: number;
+    multiplier: number;
+}
+export interface IBorrowerItem {
+    item: IComplianceItemDocument;
+    startDate: Date;
+    frequency: string;
+    instances: IBorrowerItemInstanceDocument[];
+    emailAddresses: IEmailRecipientDocument[];
+}
+export interface IComplianceFile {
+    _id?: string;
+    fileId: string;
+    name: string;
+    isFileNew?: boolean;
+    uploadedAt?: Date;
+    uploadedBy?: string;
+}
+export interface IBorrowerItemInstance {
+    nextDate: Date;
+    submittedDate: Date;
+    status: string;
+    files?: IComplianceFile[];
+}
+export interface IBorrowerItemInstanceDocument extends IBorrowerItemInstance, Document {
+}
+export interface IComplianceItemDocument extends IComplianceItem, Document {
+}
+export interface IBorrowerItemDocument extends IBorrowerItem, Document {
+}
+declare const _default: mongoose.Model<IComplianceItemDocument, {}, {}, {}, any>;
+export default _default;

package/src/models/ComplianceItem.model.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var mongoose_1 = __importDefault(require("mongoose"));
+var mongooseLeanId = require('../plugins/id.plugin');
+var ComplianceItemSchema = new mongoose_1.default.Schema({
+    name: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    importanceScore: {
+        type: Number,
+        required: true,
+    },
+    notificationDays: {
+        type: Number,
+        required: true,
+    },
+    multiplier: {
+        type: Number,
+        required: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+ComplianceItemSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model('complianceItems', ComplianceItemSchema);

package/src/models/InventoryAvailability.model.d.ts

@@ -0,0 +1,53 @@
+import mongoose from 'mongoose';
+import { IInventoryItemDocWithCalculation } from './InventoryItem.model';
+import { EInventoryAvailabilityResults } from '../enums/inventory-availability-results.enum';
+import { IPaginatorOptions } from '../interfaces/collaterals.interface';
+export interface IInventoryQuery {
+    conjunction: string;
+    field: string;
+    filter: string;
+    filterValue: string | number | Date;
+}
+export interface IInventoryFilter {
+    active: boolean;
+    inventoryName: string;
+    advanceRate: number;
+    queries: IInventoryQuery[];
+    valid: boolean;
+}
+export interface IInventoryAvailabilitySummary {
+    order: number;
+    isGroup: boolean;
+    inventoryName: string;
+    totalQty: number;
+    totalValue: number;
+    advanceRate: number;
+    availability: number;
+}
+export interface IInventoryAvailabilityResultsView {
+    items: IInventoryItemDocWithCalculation[];
+    totalItems: number;
+    paginatorOptions?: IPaginatorOptions;
+}
+export type InventoryAvailabilityPaginators = {
+    [key in EInventoryAvailabilityResults]: IPaginatorOptions;
+};
+export interface IInventoryAvailabilityResults {
+    [EInventoryAvailabilityResults.UNIQ_ITEMS]: IInventoryAvailabilityResultsView;
+    [EInventoryAvailabilityResults.NON_UNIQ_ITEMS]: IInventoryAvailabilityResultsView;
+    [EInventoryAvailabilityResults.NOT_MATCHED_ITEMS]: IInventoryAvailabilityResultsView;
+}
+export interface IInventoryAvailability {
+    bbcDateId: mongoose.Types.ObjectId;
+    borrowerId: mongoose.Types.ObjectId;
+    options: {
+        maxAdvanceRatePriority: boolean;
+    };
+    filters: IInventoryFilter[];
+    summary: IInventoryAvailabilitySummary[];
+    results?: IInventoryAvailabilityResults;
+}
+export interface IInventoryAvailabilityDocument extends IInventoryAvailability, mongoose.Document {
+}
+declare const _default: mongoose.Model<IInventoryAvailabilityDocument, {}, {}, {}, any>;
+export default _default;

package/src/models/InventoryAvailability.model.js

@@ -0,0 +1,107 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var mongoose_1 = __importDefault(require("mongoose"));
+var inventory_availability_results_enum_1 = require("../enums/inventory-availability-results.enum");
+var mongooseLeanId = require('../plugins/id.plugin');
+var InventoryAvailabilityScheme = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'borrowers',
+        required: true,
+    },
+    bbcDateId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'inventories',
+        required: true,
+    },
+    options: {
+        maxAdvanceRatePriority: {
+            type: Boolean,
+            required: true,
+        },
+    },
+    filters: [
+        {
+            active: {
+                type: Boolean,
+                required: true,
+                default: true,
+            },
+            inventoryName: {
+                type: String,
+                required: true,
+                trim: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+            valid: {
+                type: Boolean,
+                required: true,
+            },
+            queries: [
+                {
+                    conjunction: {
+                        type: String,
+                        required: true,
+                        trim: true,
+                    },
+                    field: {
+                        type: String,
+                        required: true,
+                        trim: true,
+                    },
+                    filter: {
+                        type: String,
+                        required: true,
+                        trim: true,
+                    },
+                    filterValue: {
+                        type: mongoose_1.default.Schema.Types.Mixed,
+                        required: true,
+                        trim: true,
+                    },
+                }
+            ],
+        },
+    ],
+    summary: [
+        {
+            order: {
+                type: Number,
+                required: true,
+            },
+            isGroup: {
+                type: Boolean,
+                required: true,
+            },
+            inventoryName: {
+                type: String,
+                required: true,
+            },
+            totalQty: {
+                type: Number,
+                required: true,
+            },
+            totalValue: {
+                type: Number,
+                required: true,
+            },
+            advanceRate: {
+                type: Number,
+                required: true,
+            },
+            availability: {
+                type: Number,
+                required: true,
+            },
+        }
+    ],
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+InventoryAvailabilityScheme.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model('inventoryAvailability', InventoryAvailabilityScheme);

package/src/models/InventoryItem.model.d.ts

@@ -0,0 +1,35 @@
+import mongoose, { Document } from 'mongoose';
+import { ICollateralItem } from '../interfaces/collaterals.interface';
+import { IBBCSheetDoc } from './BBCSheet.model';
+import { IBBCDateDoc } from './BBCDate.model';
+export declare const INVENTORY_FIELDS: string[];
+export interface IInventoryItem extends ICollateralItem {
+    skuDate: Date;
+    category: string;
+    sku: string;
+    qty: number;
+    value: number;
+    expiryDate: Date;
+    location: string;
+    unitCost: number;
+    skuDescription1: string;
+    skuDescription2: string;
+    skuDescription3: string;
+    detail1: string;
+    detail2: string;
+    detail3: string;
+}
+export interface IInventoryItemDoc extends Document, IInventoryItem {
+}
+export interface IInventoryItemDocWithCalculation extends IInventoryItemDoc {
+    bbcSheet: IBBCSheetDoc;
+    bbc: IBBCDateDoc;
+    expireDays: number;
+    skuDays: number;
+    sheetName: string;
+    inventoryName: string;
+    advanceRate: number;
+    availability: number;
+}
+declare const _default: mongoose.Model<IInventoryItemDoc, {}, {}, {}, any>;
+export default _default;

package/src/models/InventoryItem.model.js

@@ -0,0 +1,100 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INVENTORY_FIELDS = void 0;
+var mongoose_1 = __importDefault(require("mongoose"));
+var mongooseLeanId = require('../plugins/id.plugin');
+exports.INVENTORY_FIELDS = [
+    '_id',
+    'skuDate',
+    'category',
+    'sku',
+    'qty',
+    'value',
+    'expiryDate',
+    'location',
+    'unitCost',
+    'skuDescription1',
+    'skuDescription2',
+    'skuDescription3',
+    'detail1',
+    'detail2',
+    'detail3',
+];
+var InventoryItemSchema = new mongoose_1.default.Schema({
+    bbcSheetId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'BBCSheets',
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+    skuDate: {
+        type: Date,
+        required: true,
+    },
+    category: {
+        type: String,
+        trim: true,
+        default: 'NO CATEGORY',
+    },
+    sku: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    lotNumber: {
+        type: String,
+        trim: true,
+        required: false,
+    },
+    qty: {
+        type: Number,
+        required: true,
+    },
+    value: {
+        type: Number,
+        required: true,
+    },
+    expiryDate: {
+        type: Date,
+    },
+    location: {
+        type: String,
+        trim: true,
+    },
+    unitCost: {
+        type: Number,
+    },
+    skuDescription1: {
+        type: String,
+        trim: true,
+    },
+    skuDescription2: {
+        type: String,
+        trim: true,
+    },
+    skuDescription3: {
+        type: String,
+        trim: true,
+    },
+    detail1: {
+        type: String,
+        trim: true,
+    },
+    detail2: {
+        type: String,
+        trim: true,
+    },
+    detail3: {
+        type: String,
+        trim: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+InventoryItemSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model('InventoryItem', InventoryItemSchema);

package/src/models/ReceiavableItem.model.d.ts

@@ -0,0 +1,24 @@
+import mongoose, { Document } from 'mongoose';
+import { ICollateralItem } from '../interfaces/collaterals.interface';
+import { IBBCDateDoc } from './BBCDate.model';
+import { IBBCSheetDoc } from './BBCSheet.model';
+export declare const RECEIVABLE_FIELDS: string[];
+export interface IReceivableItem extends ICollateralItem {
+    invoiceDate: Date;
+    invoiceNumber: string;
+    customerTitle: string;
+    dueDate: number;
+    invoiceAmount: number;
+    originalAmount: number;
+    invoiceDetail1: string;
+    invoiceDetail2: string;
+    invoiceDetail3: string;
+}
+export interface IReceivableItemDoc extends IReceivableItem, Document {
+}
+export interface IReceivableItemDocPopulated extends IReceivableItemDoc {
+    bbc: IBBCDateDoc;
+    bbcSheet: IBBCSheetDoc;
+}
+declare const _default: mongoose.Model<IReceivableItemDoc, {}, {}, {}, any>;
+export default _default;

package/src/models/ReceiavableItem.model.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RECEIVABLE_FIELDS = void 0;
+var mongoose_1 = __importDefault(require("mongoose"));
+var mongooseLeanId = require('../plugins/id.plugin');
+exports.RECEIVABLE_FIELDS = [
+    '_id',
+    'invoiceDate',
+    'invoiceNumber',
+    'customerTitle',
+    'dueDate',
+    'invoiceAmount',
+    'originalAmount',
+    'invoiceDetail1',
+    'invoiceDetail2',
+    'invoiceDetail3',
+];
+var ReceivableItemSchema = new mongoose_1.default.Schema({
+    bbcSheetId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: 'BBCSheets',
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+    invoiceNumber: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    invoiceDate: {
+        type: Date,
+        required: true,
+    },
+    customerTitle: {
+        type: String,
+        trim: true,
+        default: 'No Title',
+    },
+    invoiceAmount: {
+        type: Number,
+        required: true,
+    },
+    originalAmount: {
+        type: Number,
+        required: false,
+    },
+    dueDate: {
+        type: Date,
+    },
+    invoiceDetail1: {
+        type: String,
+        trim: true,
+    },
+    invoiceDetail2: {
+        type: String,
+        trim: true,
+    },
+    invoiceDetail3: {
+        type: String,
+        trim: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+ReceivableItemSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model('ReceivableItem', ReceivableItemSchema);

package/src/plugins/id.plugin.d.ts

@@ -0,0 +1,2 @@
+declare function attachId(res: any): void;
+declare function isObjectId(v: any): boolean;