@crm-rocketlink/crm-model 1.0.0 → 1.0.1

package/appspec.yml

@@ -0,0 +1,19 @@
+version: 0.0
+os: linux
+files:
+  - source: /
+    destination: /home/ubuntu/_APP_DESTINATION_FOLDER_
+
+hooks:
+  BeforeInstall:
+    - location: scripts/1.before_install.sh
+      timeout: 300
+      runas: ubuntu
+  AfterInstall:
+    - location: scripts/2.after_install.sh
+      timeout: 300
+      runas: ubuntu
+  ApplicationStart:
+    - location: scripts/3.application_start.sh
+      timeout: 300
+      runas: ubuntu

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@crm-rocketlink/crm-model",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Shared DTOs and Models for CRM Rocketlink",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist"],
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf dist",

package/scripts/1.before_install.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+sudo rm -rf /home/ubuntu/_APP_DESTINATION_FOLDER_
+mkdir /home/ubuntu/_APP_DESTINATION_FOLDER_

package/scripts/2.after_install.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+cd /home/ubuntu/_APP_DESTINATION_FOLDER_
+sudo chmod 777 -R ./
+npm install

package/scripts/3.application_start.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+echo "application_start.sh NODE_ENV: '_APP_NODE_ENV_', APP_FULL_NAME: _APP_FULL_NAME_, APP_LABEL: _APP_LABEL_"
+
+cd /home/ubuntu/_APP_DESTINATION_FOLDER_
+
+echo "Building app: run _APP_BUILD_"
+npm run _APP_BUILD_

package/src/dtos/campaign.request.dto.ts

@@ -0,0 +1,5 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface CampaignsRequest extends PaginatedRequest {
+  id?: number;
+}

package/src/dtos/category.request.dto.ts

@@ -0,0 +1,8 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface CategoriesRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/common/base.request.dto.ts

@@ -0,0 +1,4 @@
+export interface BaseRequest {
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/common/paginated.request.dto.ts

@@ -0,0 +1,7 @@
+import { BaseRequest } from "./base.request.dto";
+
+export interface PaginatedRequest extends BaseRequest {
+  page?: number | 1;
+  pageSize?: number | 50;
+  orderBy?: string;
+}

package/src/dtos/common/paginated.response.dto.ts

@@ -0,0 +1,11 @@
+export interface PaginatedResponse<M> {
+  results: M[];
+  pagination?: Pagination;
+}
+
+export interface Pagination {
+  page: number;
+  pageSize: number;
+  total: number;
+}
+

package/src/dtos/csv.request.dto.ts

@@ -0,0 +1,9 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+import { CSVStatusTypes } from "../util/constants";
+
+export interface CSVsRequest extends PaginatedRequest {
+  id?: number;
+  status?: CSVStatusTypes;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/csv.response.dto.ts

@@ -0,0 +1,10 @@
+import { PaginatedResponse } from "./common/paginated.response.dto";
+import { CSV } from "../model/csv.model";
+
+export interface CSVsResponse extends PaginatedResponse<CSV> {
+}
+
+export interface CSVProcessResponse {
+  csvId: number;
+  processedSubscriptionIds: number[];
+}

package/src/dtos/csvRow.request.dto.ts

@@ -0,0 +1,14 @@
+import { CSVRowStatusTypes } from "../util/constants";
+import { PaginatedRequest } from "../dtos/common/paginated.request.dto";
+
+export interface CSVRowsRequest extends PaginatedRequest {
+  id?: number;
+  status?: CSVRowStatusTypes;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+
+export interface CsvRowsStatusStats {
+  status: CSVRowStatusTypes;
+  count: number;
+}

package/src/dtos/empTransactions.request.dto.ts

@@ -0,0 +1,5 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface EmpTransactionRequest extends PaginatedRequest {
+}
+

package/src/dtos/event.request.dto.ts

@@ -0,0 +1,9 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface EventsRequest extends PaginatedRequest {
+  id?: string;
+  name?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+

package/src/dtos/fastify.d.ts

@@ -0,0 +1,19 @@
+import { FastifyInstance, FastifyReply, FastifyRequest, RouteGenericInterface } from "fastify";
+import "@fastify/jwt";
+import "@fastify/mysql";
+
+declare module '@fastify/jwt' {
+  interface FastifyJWT {
+    payload: { id: number; email: string };
+    user: { id: number; email: string };
+  }
+}
+
+declare module "fastify" {
+  interface FastifyInstance {
+    authenticate: <T extends RouteGenericInterface = RouteGenericInterface>(
+      request: FastifyRequest<T>,
+      reply: FastifyReply
+    ) => Promise<void>;
+  }
+}

package/src/dtos/field.request.dto.ts

@@ -0,0 +1,4 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface FieldsRequest extends PaginatedRequest {
+}

package/src/dtos/hook.request.dto.ts

@@ -0,0 +1,9 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface HooksRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  event?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/hookProfile.request.dto.ts

@@ -0,0 +1,7 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface HookProfilesRequest extends PaginatedRequest {
+  id?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/lead.request.dto.ts

@@ -0,0 +1,12 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface LeadsRequest extends PaginatedRequest {
+  id?: number;
+  email?: string;
+  visitId?: number;
+  csvRowId?: number;
+  csvId?: number;
+  isCustomer?: boolean;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/offer.request.dto.ts

@@ -0,0 +1,15 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface OffersRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  type?: string;
+  productId?: number;
+  oneTimePayment?: boolean;
+  price?: string;
+  trialPrice?: string;
+  midId?: number;
+  campaignId?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/order.request.dto.ts

@@ -0,0 +1,22 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface OrdersRequest extends PaginatedRequest {
+  id: number;
+  paymentId ?: number;
+  leadId ?: number;
+  leadFirstName?: string
+  leadEmail?: string
+  amount?: string
+  status ?: string;
+  leadName ?:string;
+}
+
+export interface OrderItemsRequest extends PaginatedRequest {
+  id?: number;
+  orderId?: number;
+  offerId?: number;
+  currency?: string;
+  price?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/product.request.dto.ts

@@ -0,0 +1,9 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface ProductsRequest extends PaginatedRequest {
+  id?: number;
+  name?: string;
+  categoryId?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/subscription.request.dto.ts

@@ -0,0 +1,20 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+import { BANKS } from "../model/gateway.model";
+
+export interface SubscriptionsRequest extends PaginatedRequest {
+  id?: number;
+  status?: string;
+  username?: string;
+  bankName?: BANKS;
+  email?: string;
+  orderId?: number;
+  offerId?: number;
+  midId?: number;
+  paymentType?: string;
+  leadId?: number;
+  leadName?: string;
+  leadEmail?: string;
+  csvId?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/transaction.request.dto.ts

@@ -0,0 +1,13 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+import { BANKS } from "../model/gateway.model";
+
+export interface TransactionsRequest extends PaginatedRequest {
+  id?: number;
+  bank?: BANKS;
+  midId?: number;
+  orderId?: number;
+  internalTransactionType?: string;
+  internalTransactionStatus?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/dtos/transactionError.request.dto.ts

@@ -0,0 +1,10 @@
+import { PaginatedRequest } from "./common/paginated.request.dto";
+
+export interface TransactionErrorRequest extends PaginatedRequest {
+  id?: number;
+  bank?: string;
+  midId?: number;
+  orderId?: number;
+  createdFrom?: Date;
+  createdTo?: Date;
+}

package/src/gateways/adapters/dtos/transaction-emp.request.dto.ts

@@ -0,0 +1,21 @@
+import { PaginatedRequest } from "../../../dtos/common/paginated.request.dto";
+import { PaginatedResponse } from "../../../dtos/common/paginated.response.dto";
+import { TransactionEmp } from "../model/transactionEmp.model";
+
+export interface TransactionsEmpRequest extends PaginatedRequest, Omit<Partial<TransactionEmp>, 'transaction_id'> {
+  email?: string;
+  customerEmail?: string;
+  unique_id?: string;
+  transaction_id?: string;
+  iban_account_no?: string;
+  amount?: string;
+  merchant?: string;
+  paymentType?: string;
+  orderId?: number;
+  midId?: number;
+  reportDateFrom?: string;
+  reportDateTo?: string;
+}
+
+export interface TransactionsEmpResponse extends PaginatedResponse<TransactionEmp> {
+}

package/src/gateways/adapters/dtos/transaction-finxp.request.dto.ts

@@ -0,0 +1,9 @@
+import { PaginatedRequest } from "../../../dtos/common/paginated.request.dto";
+import { PaginatedResponse } from "../../../dtos/common/paginated.response.dto";
+import { TransactionFinXP } from "../model/transactionFinXP.model";
+
+export interface TransactionsFinXPRequest extends PaginatedRequest, TransactionFinXP {
+}
+
+export interface TransactionsFinXPResponse extends PaginatedResponse<TransactionFinXP> {
+}

package/src/gateways/adapters/dtos/transaction-novalnet.request.dto.ts

@@ -0,0 +1,21 @@
+import { PaginatedRequest } from "../../../dtos/common/paginated.request.dto";
+import { PaginatedResponse } from "../../../dtos/common/paginated.response.dto";
+import { TransactionNovalNet } from "../model/transactionNovalNet.model";
+
+export interface TransactionsNovalNetRequest extends PaginatedRequest, Omit<Partial<TransactionNovalNet>, 'customerNumber' | 'orderNumber'> {
+  midId?: number;
+  orderId?: number;
+  tid?: string;
+  statusDesc?: string;
+  paymentType?: string;
+  amount?: string;
+  customerNumber?: string;
+  orderNumber?: string;
+  firstName?: string;
+  email?: string;
+  createdFrom?: Date;
+  createdTo?: Date;
+}
+
+export interface TransactionsNovalNetResponse extends PaginatedResponse<TransactionNovalNet> {
+}

package/src/gateways/adapters/model/transactionEmp.model.ts

@@ -0,0 +1,223 @@
+import { Transaction } from "../../../model/transaction.model";
+import { BANKS } from "../../../model/gateway.model";
+
+export const TRANSACTION_EMP_STATUS = {
+  approved: "approved",
+  chargeback: "chargebacked",
+  rejected: "rejected",
+  declined: "declined",
+  pending_async: "pending_async",
+};
+
+export function isTransactionEmp(t: Transaction): t is TransactionEmp {
+  return t?.bank === BANKS.EMP;
+}
+
+export interface TransactionEmp extends Transaction {
+  bank: typeof BANKS.EMP;    //CRM info
+  id?: number;
+  type?: string;             //apiResponse.transaction_type
+  status?: string;
+  unique_id?: string;        //EMP transactionId 
+  transaction_id?: number;   //orderId
+  iban_account_no?: string;  //apiResponse.bank_account_number
+  bic_swift_code?: string;   //apiResponse.bank_identifier_code
+  technical_message?: string;// missing in CSV download
+  message?: string;          // missing in CSV download  
+  mode?: string;             // missing in CSV download
+  datetime_utc?: string;     // apiResponse.timestamp
+  descriptor?: string;
+  amount?: string;
+  currency?: string;
+  sent_to_acquirer?: boolean;// missing in CSV download
+  // the rest are coming only from the CSV download from the bank portal
+  merchant?: string;
+  terminal?: string;
+  paymentType?: string;
+  bankCode?: string;
+  merchantTransactionId?: string;
+  cardHolder?: string;
+  cardBrand?: string;
+  cardNumber?: string;
+  countryBilling?: string;
+  state?: string;
+  errorClass?: string;
+  errorMessage?: string;
+  authCode?: string;
+  rrn?: string;
+  responseCode?: string;
+  avsResponse?: string;
+  cvvResult?: string;
+  arn?: string;
+  customerEmail?: string;
+  binCountry?: string;
+  cardType?: string;
+  cardSubtype?: string;
+  fraud?: string;
+  regionClass?: string;
+  schemeResponseCode?: string;
+  schemeTransactionLinkId?: string;
+  recurringAdviceCode?: string;
+  recurringAdviceText?: string;
+  fxTradingRate?: string;
+  fxConvertedAmount?: string;
+  fxTierId?: string;
+  settlementTransactionCurrency?: string;
+  eci?: string;
+  mpi?: string;
+  preauthorization?: string;
+  captured?: string;
+  transactionDescriptor?: string;
+  customerName?: string;
+  fundsStatus?: string;
+  dateOfFundsStatus?: string;
+  accountHolder?: string;
+  digitableLine?: string;
+  expiryDate?: string;
+  schemeMaximumSettlementDate?: string;
+  schemeAuthenticationDataQuality?: string;
+  externalId?: string;     // what is this?
+  payeeId?: string;
+  payeeUniqueId?: string;
+  payeeName?: string;
+  cb_reportDate?: string;
+  cb_trxDate?: string;
+  cb_merchant?: string;
+  cb_terminal?: string;
+  cb_reportType?: string;
+  cb_transition?: string;
+  cb_reportMessage?: string;
+  cb_reportInfo?: string;
+  cb_status?: string;
+  cb_merchantTransactionId?: string;
+  cb_uniqueId?: string;
+  cb_referenceTransactionId?: string;
+  cb_referenceTransactionType?: string;
+  cb_currency?: string;
+  cb_amountInMinorCurrencyUnit?: string;
+  cb_cardHolder?: string;
+  cb_cardBrand?: string;
+  cb_cardNumber?: string;
+  cb_email?: string;
+  cb_country?: string;
+  cb_remoteIp?: string;
+  createdAt?: Date;         //CRM info  
+  updatedAt?: Date;         //CRM info
+}
+export interface TransactionEmpChargeback extends Transaction {
+  bank: typeof BANKS.EMP;
+  id?: number;
+  reportDate?: string;
+  trxDate?: string;
+  merchant?: string;
+  terminal?: string;
+  reportType?: string;
+  transition?: string;
+  reportMessage?: string;
+  reportInfo?: string;
+  status?: string;
+  merchantTransactionId?: string;
+  unique_id?: string;
+  referenceTransactionId?: string;
+  referenceTransactionType?: string;
+  currency?: string;
+  amountInMinorCurrencyUnit?: string;
+  cardHolder?: string;
+  cardBrand?: string;
+  cardNumber?: string;
+  email?: string;
+  country?: string;
+  remoteIp?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export const empTransactionColumnMapper: Partial<Record<keyof TransactionEmp, string>> = {
+  merchant: "Merchant",
+  terminal: "Terminal",
+  status: "Status",
+  type: "Type",
+  paymentType: "Payment Type",
+  bankCode: "Bank Code",
+  merchantTransactionId: "Merchant Transaction id",
+  transaction_id: "Transaction id", // orderId
+  currency: "Currency",
+  amount: "Amount (with decimal mark per currency exponent)",
+  cardHolder: "Card Holder",
+  cardBrand: "Card Brand",
+  cardNumber: "Card Number",
+  countryBilling: "Country (Billing)",
+  state: "State",
+  datetime_utc: "DateTime (UTC)",
+  errorClass: "ErrorClass",
+  errorMessage: "ErrorMessage",
+  authCode: "Auth Code",
+  rrn: "RRN",
+  responseCode: "Response Code",
+  avsResponse: "AVS Response",
+  cvvResult: "CVV Result",
+  unique_id: "Unique ID", //transactionId
+  arn: "ARN",
+  customerEmail: "Customer email",
+  binCountry: "BIN country",
+  cardType: "Card type",
+  cardSubtype: "Card subtype",
+  fraud: "Fraud",
+  descriptor: "Descriptor",
+  regionClass: "Region class",
+  schemeResponseCode: "Scheme Response Code",
+  schemeTransactionLinkId: "Scheme Transaction Link ID",
+  recurringAdviceCode: "Recurring Advice Code",
+  recurringAdviceText: "Recurring Advice text",
+  fxTradingRate: "FX trading rate",
+  fxConvertedAmount: "FX converted amount",
+  fxTierId: "FX tier ID",
+  settlementTransactionCurrency: "Settlement Transaction Currency",
+  eci: "ECI",
+  mpi: "MPI",
+  preauthorization: "Preauthorization",
+  captured: "Captured",
+  transactionDescriptor: "Transaction descriptor",
+  iban_account_no: "IBAN / Account No",
+  bic_swift_code: "BIC / SWIFT code",
+  customerName: "Customer name",
+  fundsStatus: "Funds status",
+  dateOfFundsStatus: "Date of funds status",
+  accountHolder: "Account holder",
+  digitableLine: "Digitable line",
+  expiryDate: "Expiry Date",
+  schemeMaximumSettlementDate: "Scheme Maximum Settlement Date",
+  schemeAuthenticationDataQuality: "Scheme Authentication Data Quality",
+  externalId: "External ID",
+  payeeId: "Payee ID",
+  payeeUniqueId: "Payee Unique ID",
+  payeeName: "Payee Name",
+};
+export const empTransactionColumnKeys = Object.keys(empTransactionColumnMapper);
+export const empTransactionColumnValues = Object.values(empTransactionColumnMapper);
+
+export const empChargebackColumnMapper: Partial<Record<keyof TransactionEmpChargeback, string>> = {
+  reportDate: "Report Date",
+  trxDate: "Trx Date",
+  merchant: "Merchant",
+  terminal: "Terminal",
+  reportType: "Report Type",
+  transition: "Transition",
+  reportMessage: "Report Message",
+  reportInfo: "Report Info",
+  status: "Status",
+  merchantTransactionId: "Merchant Transaction ID",
+  unique_id: "Unique ID",
+  referenceTransactionId: "Reference Transaction ID",
+  referenceTransactionType: "Reference Transaction Type",
+  currency: "Currency",
+  amountInMinorCurrencyUnit: "Amount (in minor currency unit)",
+  cardHolder: "Card Holder",
+  cardBrand: "Card Brand",
+  cardNumber: "Card Number",
+  email: "Email",
+  country: "Country",
+  remoteIp: "Remote IP"
+};
+export const empChargebackColumnKeys = Object.keys(empChargebackColumnMapper);
+export const empChargebackColumnValues = Object.values(empChargebackColumnMapper);