gemcap-be-common 1.0.0

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "gemcap-be-common",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "mongoose": "^6.10.5"
+  },
+  "devDependencies": {
+    "typescript": "^5.1.6"
+  }
+}

package/src/db/inventory-availability.ts

@@ -0,0 +1,9 @@
+import InventoryAvailability, {
+  IInventoryAvailabilityDocument,
+} from '../models/InventoryAvailability.model';
+
+export const getInventoryAvailabilityByBBCDateId = async (bbcDateId: string): Promise<IInventoryAvailabilityDocument> => {
+  return InventoryAvailability
+    .findOne({ bbcDateId })
+    .lean();
+}

package/src/enum/inventory-availability-results.enum.ts

@@ -0,0 +1,5 @@
+export enum EInventoryAvailabilityResults {
+  UNIQ_ITEMS = 'uniqItems',
+  NON_UNIQ_ITEMS = 'nonUniqItems',
+  NOT_MATCHED_ITEMS = 'notMatchedItems'
+}

package/src/interfaces/collaterals.interface.ts

@@ -0,0 +1,32 @@
+import mongoose from 'mongoose';
+
+import { IReceivableItem } from '../models/ReceiavableItem.model';
+import { IInventoryItem } from '../models/InventoryItem.model';
+import { IAccountPayableItem } from '../models/AccountPayableItem.model';
+
+export interface IUploadedItems<T extends IInventoryItem | IReceivableItem | IAccountPayableItem> {
+  _id?: string;
+  bbcDate: Date;
+  borrowerId: string;
+  fileName?: string;
+  sheetName?: string;
+  uploadUser?: string
+  fileHash?: string;
+  comment?: string;
+  items: T[];
+}
+
+export interface ICollateralItem {
+  bbcSheetId: mongoose.Types.ObjectId;
+  order: number;
+}
+
+export interface IPaginatorOptions {
+  pageIndex: number;
+  pageSize: number;
+}
+
+export const DEFAULT_PAGINATOR: IPaginatorOptions = {
+  pageIndex: 0,
+  pageSize: 20,
+}

package/src/models/AccountPayableItem.model.ts

@@ -0,0 +1,78 @@
+import mongoose, { Document } from 'mongoose';
+
+import { ICollateralItem } from '../interfaces/collaterals.interface';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export const ACCOUNT_PAYABLE_FIELDS = [
+  '_id',
+  'apDate',
+  'poNumber',
+  'customerName',
+  'amount',
+  'otherInformation1',
+  'otherInformation2',
+  'otherInformation3',
+];
+
+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 {
+}
+
+const AccountPayableItemSchema = new mongoose.Schema(
+  {
+    bbcSheetId: {
+      type: mongoose.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);
+
+export default mongoose.model<IAccountPayableItemDoc>('AccountPayableItem', AccountPayableItemSchema);

package/src/models/BBCDate.model.ts

@@ -0,0 +1,31 @@
+import mongoose, { Document } from 'mongoose';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export interface IBBCDate {
+  borrowerId: mongoose.Types.ObjectId;
+  bbcDate: Date;
+}
+
+export interface IBBCDateDoc extends IBBCDate, Document {
+}
+
+const BBCDateSchema = new mongoose.Schema(
+  {
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'borrowers',
+      required: true,
+    },
+    bbcDate: {
+      type: Date,
+      required: true,
+    },
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true }
+);
+
+BBCDateSchema.plugin(mongooseLeanId);
+
+export default mongoose.model<IBBCDateDoc>('BBCDate', BBCDateSchema);

package/src/models/BBCSheet.model.ts

@@ -0,0 +1,73 @@
+import mongoose, { Document } from 'mongoose';
+
+import InventoryItemModel from './InventoryItem.model';
+import ReceivableItemModel from './ReceiavableItem.model';
+import AccountPayableItemModel from './AccountPayableItem.model';
+import { IBBCDate } from './BBCDate.model';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+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;
+}
+
+const BBCSheetSchema = new mongoose.Schema(
+  {
+    bbcDateId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'bbcDates',
+      required: true,
+    },
+    dataType: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    uploadUser: {
+      type: mongoose.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) {
+  const bbcSheetId = this.getQuery()['_id'];
+  InventoryItemModel.deleteMany({ bbcSheetId: bbcSheetId }, next);
+  ReceivableItemModel.deleteMany({ bbcSheetId: bbcSheetId }, next);
+  AccountPayableItemModel.deleteMany({ bbcSheetId: bbcSheetId }, next);
+});
+
+export default mongoose.model<IBBCSheetDoc>('BBCSheet', BBCSheetSchema);

package/src/models/InventoryAvailability.model.ts

@@ -0,0 +1,167 @@
+import mongoose from 'mongoose';
+
+import { IInventoryItemDocWithCalculation } from './InventoryItem.model';
+import { EInventoryAvailabilityResults } from '../enum/inventory-availability-results.enum';
+import { IPaginatorOptions } from '../interfaces/collaterals.interface';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+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 {
+}
+
+const InventoryAvailabilityScheme = new mongoose.Schema(
+  {
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'borrowers',
+      required: true,
+    },
+    bbcDateId: {
+      type: mongoose.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.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);
+
+export default mongoose.model<IInventoryAvailabilityDocument>('inventoryAvailability', InventoryAvailabilityScheme);

package/src/models/InventoryItem.model.ts

@@ -0,0 +1,137 @@
+import mongoose, { Document } from 'mongoose';
+
+import { ICollateralItem } from '../interfaces/collaterals.interface';
+import { IBBCSheetDoc } from './BBCSheet.model';
+import { IBBCDateDoc } from './BBCDate.model';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export const INVENTORY_FIELDS = [
+  '_id',
+  'skuDate',
+  'category',
+  'sku',
+  'qty',
+  'value',
+  'expiryDate',
+  'location',
+  'unitCost',
+  'skuDescription1',
+  'skuDescription2',
+  'skuDescription3',
+  'detail1',
+  'detail2',
+  'detail3',
+];
+
+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;
+}
+
+const InventoryItemSchema = new mongoose.Schema(
+  {
+    bbcSheetId: {
+      type: mongoose.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);
+
+export default mongoose.model<IInventoryItemDoc>('InventoryItem', InventoryItemSchema);

package/src/models/ReceiavableItem.model.ts

@@ -0,0 +1,97 @@
+import mongoose, { Document } from 'mongoose';
+
+import { ICollateralItem } from '../interfaces/collaterals.interface';
+import { IBBCDateDoc } from './BBCDate.model';
+import { IBBCSheetDoc } from './BBCSheet.model';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export const RECEIVABLE_FIELDS = [
+  '_id',
+  'invoiceDate',
+  'invoiceNumber',
+  'customerTitle',
+  'dueDate',
+  'invoiceAmount',
+  'originalAmount',
+  'invoiceDetail1',
+  'invoiceDetail2',
+  'invoiceDetail3',
+];
+
+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;
+}
+
+const ReceivableItemSchema = new mongoose.Schema(
+  {
+    bbcSheetId: {
+      type: mongoose.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);
+
+export default mongoose.model<IReceivableItemDoc>('ReceivableItem', ReceivableItemSchema);

package/src/plugins/id.plugin.ts

@@ -0,0 +1,56 @@
+module.exports = function mongooseLeanId(schema) {
+  schema.post('find', attachId);
+  schema.post('findOne', attachId);
+  schema.post('findOneAndUpdate', attachId);
+};
+
+function attachId(res) {
+  if (res === null) {
+    return
+  }
+
+  function replaceId(res) {
+    if (Array.isArray(res)) {
+      res.forEach(v => {
+        if (isObjectId(v)) {
+          return;
+        }
+        if (v._id) {
+          v.id = v._id.toString();
+        }
+        Object.keys(v).map(k => {
+          if (Array.isArray(v[k])) {
+            replaceId(v[k]);
+          }
+        });
+      });
+    } else {
+      if (isObjectId(res)) {
+        return res;
+      }
+      if (res._id) {
+        res.id = res._id.toString();
+      }
+      Object.keys(res).map(k => {
+        if (Array.isArray(res[k])) {
+          replaceId(res[k]);
+        }
+      });
+    }
+  }
+
+  if (this._mongooseOptions.lean) {
+    replaceId(res);
+  }
+}
+
+function isObjectId(v) {
+  if (v == null) {
+    return false;
+  }
+  const proto = Object.getPrototypeOf(v);
+  if (proto == null || proto.constructor == null || proto.constructor.name !== 'ObjectID') {
+    return false;
+  }
+  return v._bsontype === 'ObjectID';
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "outDir": "dist",
+    "declaration": true
+  },
+  "include": ["src"]
+}