@rocketlink/crm-model 1.0.0

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

@@ -0,0 +1,224 @@
+import { Transaction } from "../../../model/transaction.model";
+import { BANKS } from "../../../model/gateway.model";
+
+export const NOVALNET_STATUS_DESC = {
+  SUCCESS: 'SUCCESSFUL',
+  PENDING: 'PENDING',
+  FAILED: 'FAILED',
+  CONFIRMED: 'CONFIRMED',
+  CANCELLED: 'CANCELLED',
+  REFUNDED: 'REFUNDED',
+  CHARGEBACK: 'CHARGEBACK',
+  REJECTED: 'REJECTED',
+  DECLINED: 'DECLINED',
+  ON_HOLD: 'ON_HOLD',
+  PROCESSING: 'PROCESSING'
+} as const;
+export type NOVALNET_STATUS_DESC = (typeof NOVALNET_STATUS_DESC)[keyof typeof NOVALNET_STATUS_DESC];
+
+export function isTransactionNovalnet(t: Transaction): t is TransactionNovalNet {
+  return t?.bank === BANKS.Novalnet;
+}
+
+export interface TransactionNovalNet extends Transaction {
+  bank: typeof BANKS.Novalnet;
+  id?: number;
+  date?: string;
+  time?: string;
+  activationDate?: string;
+  activationTime?: string;
+  tid?: string;
+  status?: string;
+  statusDesc?: string;
+  paymentType?: string;
+  invoiceType?: string;
+  invoiceRef?: string;
+  amount?: string;
+  currency?: string;
+  amountEur?: string;
+  cost?: string;
+  tax?: string;
+  costInclTax?: string;
+  fixCommissionAmount?: string;
+  fixCommissionAmountEur?: string;
+  payoutAmount?: string;
+  payoutCurrency?: string;
+  origAmount?: string;
+  origTid?: string;
+  origDate?: string;
+  description?: string;
+  marker?: string;
+  novalcardNumber?: string;
+  customerNumber?: number; //subscriptionId
+  orderNumber?: number; //orderId
+  gender?: string;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  street?: string;
+  houseNumber?: string;
+  zipCode?: string;
+  city?: string;
+  countryCode?: string;
+  birthdate?: string;
+  company?: string;
+  input1?: string;
+  inputVal1?: string;
+  input2?: string;
+  inputVal2?: string;
+  input3?: string;
+  inputVal3?: string;
+  input4?: string;
+  inputVal4?: string;
+  refundAmount?: string;
+  refundTid?: string;
+  refundDate?: string;
+  refundRef?: string;
+  returnAmount?: string;
+  returnTid?: string;
+  returnDate?: string;
+  returnCode?: string;
+  returnReason?: string;
+  creditAmount?: string;
+  creditTid?: string;
+  creditDate?: string;
+  openAmount?: string;
+  paymentInfo1?: string;
+  paymentInfo2?: string;
+  paymentInfo3?: string;
+  paymentInfo4?: string;
+  subscription?: string;
+  startAmount?: string;
+  startTid?: string;
+  startDate?: string;
+  fraudModules?: string;
+  rejectedFraudModule?: string;
+  projectId?: string;
+  projectName?: string;
+  tariffId?: string;
+  tariffName?: string;
+  affiliateId?: string;
+  affiliateName?: string;
+  merchantId?: string;
+  mobile?: string;
+  countryName?: string;
+  paymentName?: string;
+  streetAndHouseNo?: string;
+  dateAndTime?: string;
+  activationDateAndTime?: string;
+  input5?: string;
+  inputVal5?: string;
+  ipCountry?: string;
+  internetServiceProvider?: string;
+  paymentReference?: string;
+  buergelScore?: string;
+  paymentInfo5?: string;
+  paymentInfo6?: string;
+  subscriptionId?: string | number;
+  vatId?: string;
+  paymentInfo7?: string;
+  accountingReference?: string;
+  novalnetEndcustomerInvoiceNumber?: string;
+}
+
+export const novalNetTransactionColumnMapper: Partial<Record<keyof TransactionNovalNet, string>> = {
+  date: "Date",
+  time: "Time",
+  activationDate: "Activation date",
+  activationTime: "Activation time",
+  tid: "TID",
+  status: "Status",
+  statusDesc: "Status desc",
+  paymentType: "Payment type",
+  invoiceType: "Invoice type",
+  invoiceRef: "Invoice ref",
+  amount: "Amount",
+  currency: "Currency",
+  amountEur: "Amount (EUR)",
+  cost: "Cost",
+  tax: "Tax",
+  costInclTax: "Cost incl. Tax",
+  fixCommissionAmount: "Fix commission amount",
+  fixCommissionAmountEur: "Fix commission amount (EUR)",
+  payoutAmount: "Payout amount",
+  payoutCurrency: "Payout currency",
+  origAmount: "Orig amount",
+  origTid: "Orig TID",
+  origDate: "Orig date",
+  description: "Description",
+  marker: "Marker",
+  novalcardNumber: "Novalcard number",
+  customerNumber: "Customer number",
+  orderNumber: "Order number",
+  gender: "Gender",
+  firstName: "First name",
+  lastName: "Last name",
+  email: "Email",
+  street: "Street",
+  houseNumber: "House number",
+  zipCode: "Zip code",
+  city: "City",
+  countryCode: "Country code",
+  birthdate: "Birthdate",
+  company: "Company",
+  input1: "Input1",
+  inputVal1: "Input val1",
+  input2: "Input2",
+  inputVal2: "Input val2",
+  input3: "Input3",
+  inputVal3: "Input val3",
+  input4: "Input4",
+  inputVal4: "Input val4",
+  refundAmount: "Refund amount",
+  refundTid: "Refund TID",
+  refundDate: "Refund date",
+  refundRef: "Refund ref",
+  returnAmount: "Return amount",
+  returnTid: "Return TID",
+  returnDate: "Return date",
+  returnCode: "Return code",
+  returnReason: "Return reason",
+  creditAmount: "Credit amount",
+  creditTid: "Credit TID",
+  creditDate: "Credit date",
+  openAmount: "Open amount",
+  paymentInfo1: "Payment info1",
+  paymentInfo2: "Payment info2",
+  paymentInfo3: "Payment info3",
+  paymentInfo4: "Payment info4",
+  subscription: "Subscription",
+  startAmount: "Start amount",
+  startTid: "Start TID",
+  startDate: "Start date",
+  fraudModules: "Fraud modules",
+  rejectedFraudModule: "Rejected fraud module",
+  projectId: "Project ID",
+  projectName: "Project name",
+  tariffId: "Tariff ID",
+  tariffName: "Tariff name",
+  affiliateId: "Affiliate ID",
+  affiliateName: "Affiliate name",
+  merchantId: "Merchant ID",
+  mobile: "Mobile",
+  countryName: "Country name",
+  paymentName: "Payment name",
+  streetAndHouseNo: "Street and House no",
+  dateAndTime: "Date and Time",
+  activationDateAndTime: "Activation date and time",
+  input5: "Input5",
+  inputVal5: "Input val5",
+  ipCountry: "IP country",
+  internetServiceProvider: "Internet service provider",
+  paymentReference: "Payment reference",
+  buergelScore: "Bürgel score",
+  paymentInfo5: "Payment info5",
+  paymentInfo6: "Payment info6",
+  subscriptionId: "Subscription ID",
+  vatId: "VAT ID",
+  paymentInfo7: "Payment info7",
+  accountingReference: "Accounting reference",
+  novalnetEndcustomerInvoiceNumber: "Novalnet Endcustomer invoice number"
+};
+
+export const novalNetTransactionColumnKeys = Object.keys(novalNetTransactionColumnMapper);
+export const novalNetTransactionColumnValues = Object.values(novalNetTransactionColumnMapper);

package/src/gateways/providers/model/finXpManual.model.ts

@@ -0,0 +1,27 @@
+export interface FinXpSddSaleParams {
+  customerId: string;
+  customerName: string;
+  amount: string;
+  bic: string;
+  currency: string;
+  iban: string;
+  transactionInformation: string;
+  additionalInfo: string;
+  mandateReference: string;
+  mandateDate: string;
+}
+
+export const finXpSDDRequestColumnMapper: Partial<Record<keyof FinXpSddSaleParams, string>> = {
+  customerId: "customer id", //map to CUSTOMER ID
+  customerName: "customer name", //map to CUSTOMER NAME
+  amount: "amount", //map to AMOUNT
+  bic: "BIC",  //map to CUSTOMER BIC
+  currency: "currency", //map to CURRENCY
+  iban: "iban", //map to CUSTOMER IBAN
+  transactionInformation: "transaction information", //map to TRANSACTION INFORMATION
+  additionalInfo: "additional info", //map to ADDITIONAL INFO 1
+  mandateReference: "mandate reference", //map to mandate reference
+  mandateDate: "mandate date" //mandate date needs to be formated as dd.mm.yyyy - map to MANDATE DATE
+};
+export const finXpSDDRequestColumnMapperKeys = Object.keys(finXpSDDRequestColumnMapper);
+export const finXpSDDRequestColumnMapperValues = Object.values(finXpSDDRequestColumnMapper);

package/src/gateways/providers/model/genesis.constants.ts

@@ -0,0 +1,30 @@
+export const GENESIS_TRANSACTION_TYPE_BY_PAYMENT_METHOD = {
+  SEPA_DD: {
+    SDD_SALE: "sdd_sale",
+    SDD_REFUND: "sdd_refund"
+  },
+  CREDIT_CARD: {
+    SALE: "sale",
+    REFUND: "refund",
+    CHARGEBACK: "chargeback",
+  },
+};
+
+export const GENESIS_TRANSACTION_TYPE = {
+  SDD_SALE: "sdd_sale",
+  SDD_REFUND: "sdd_refund"
+};
+export type GENESIS_TRANSACTION_TYPE = (typeof GENESIS_TRANSACTION_TYPE)[keyof typeof GENESIS_TRANSACTION_TYPE];
+
+export const GENESIS_TRANSACTION_STATUS = {
+  APPROVED: "approved",
+  PENDING_ASYNC: "pending_async",
+  ERROR: "error"
+};
+export type GENESIS_TRANSACTION_STATUS = (typeof GENESIS_TRANSACTION_STATUS)[keyof typeof GENESIS_TRANSACTION_STATUS];
+
+export const GENESIS_TRANSACTION_MODE = {
+  LIVE: "live",
+  TEST: "test"
+};
+export type GENESIS_TRANSACTION_MODE = (typeof GENESIS_TRANSACTION_MODE)[keyof typeof GENESIS_TRANSACTION_MODE];

package/src/gateways/providers/model/genesis.model.ts

@@ -0,0 +1,89 @@
+import { GENESIS_TRANSACTION_TYPE } from "./genesis.constants";
+import { GENESIS_TRANSACTION_STATUS } from "./genesis.constants";
+import { GENESIS_TRANSACTION_MODE } from "./genesis.constants";
+
+export interface GenesisConfig {
+  customer: {
+    username?: string;
+    password?: string;
+    token?: string;
+    force_smart_routing?: boolean;
+  };
+  gateway: {
+    protocol?: string;
+    hostname?: string; //endpoint-you-want e-comprocessing.net or emerchantpay.net
+    timeout?: string;
+    testing: boolean;
+  };
+  notifications?: {
+    host: string;
+    port: string;
+    path: string;
+  };
+}
+
+export interface GenesisSddSaleParams {
+  transaction_id: string; //orderId
+  usage: string;
+  remote_ip: string;
+  amount: string;
+  currency: string;
+  iban: string;
+  bic: string;
+  billing_address: {
+    first_name: string;
+    last_name: string;
+    city: string;
+    address1: string;
+    country: string;
+    zip_code: string;
+  };
+}
+
+export interface GenesisResponse {
+  transaction_type?: GENESIS_TRANSACTION_TYPE;
+  status: GENESIS_TRANSACTION_STATUS;
+  unique_id: string;       //EMP transactionId
+  transaction_id?: string; //orderId. When we download CSV from the bank, this value is present in "Merchant Transaction ID"
+  bank_account_number?: string;
+  bank_identifier_code?: string;
+  technical_message?: string;
+  code?: string;
+  message?: string;
+  mode?: GENESIS_TRANSACTION_MODE,
+  timestamp?: string; //"2025-10-27T14:42:27Z"
+  descriptor?: string;
+  amount?: string;
+  currency?: string;
+  sent_to_acquirer?: boolean;
+}
+
+export interface GenesisRiconcileByDateResponse {
+  page: number
+  per_page: number
+  total_count: number;
+  pages_count: number;
+  payment_response: GenesisResponse[];
+}
+
+export interface GenesisRefundParams {
+  transactionId: string;
+}
+
+export interface GenesisChargebackParams {
+  transactionId: string;
+}
+
+export interface GenesisError {
+  status: string;
+  code?: string;
+  message?: string;
+  technical_message?: string;
+  response?: GenesisFieldError[];
+}
+
+export interface GenesisFieldError {
+  type: string;
+  property: string;
+  message: string;
+}

package/src/gateways/providers/model/novalNetManual.model.ts

@@ -0,0 +1,119 @@
+export interface NovalNetSddSaleParams {
+  vendorId: string;
+  vendorAuthcode: string;
+  productId: string;
+  tariffId: string;
+  testMode: string;
+  amount: string;
+  currency: string;
+  tariffPeriod: string;
+  tariffPeriod2: string;
+  tariffPeriod2Amount: string;
+  utf8: string;
+  lang: string;
+  orderNo: string;
+  customerNo: string;
+  gender: string;
+  title: string;
+  firstName: string;
+  lastName: string;
+  street: string;
+  searchInStreet: string;
+  zip: string;
+  city: string;
+  countryCode: string;
+  birthDate: string;
+  tel: string;
+  mobile: string;
+  email: string;
+  paymentType: string;
+  invoiceType: string;
+  dueDate: string;
+  invoiceRef: string;
+  paymentRef: string;
+  tid: string;
+  sepaDueDate: string;
+  mandatePresent: string;
+  mandateSignatureDate: string;
+  mandateId: string;
+  iban: string;
+  bic: string;
+  debitAccountHolder: string;
+  debitReason1: string;
+  debitReason2: string;
+  debitReason3: string;
+  debitReason4: string;
+  debitReason5: string;
+  input1: string;
+  input2: string;
+  input3: string;
+  input4: string;
+  input5: string;
+  input6: string;
+  input7: string;
+  discount: string;
+  mref: string;
+  createPaymentRef: string;
+  noRc: string;
+}
+
+export const novalNetSDDRequestColumnMapper: Partial<Record<keyof NovalNetSddSaleParams, string>> = {
+  vendorId: "vendor_id",
+  vendorAuthcode: "vendor_authcode",
+  productId: "product_id",
+  tariffId: "tariff_id",
+  testMode: "test_mode",
+  amount: "amount",
+  currency: "currency",
+  tariffPeriod: "tariff_period",
+  tariffPeriod2: "tariff_period2",
+  tariffPeriod2Amount: "tariff_period2_amount",
+  utf8: "utf8",
+  lang: "lang",
+  orderNo: "order_no",
+  customerNo: "customer_no",
+  gender: "gender",
+  title: "title",
+  firstName: "first_name",
+  lastName: "last_name",
+  street: "street",
+  searchInStreet: "search_in_street",
+  zip: "zip",
+  city: "city",
+  countryCode: "country_code",
+  birthDate: "birth_date",
+  tel: "tel",
+  mobile: "mobile",
+  email: "email",
+  paymentType: "payment_type",
+  invoiceType: "invoice_type",
+  dueDate: "due_date",
+  invoiceRef: "invoice_ref",
+  paymentRef: "payment_ref",
+  tid: "tid",
+  sepaDueDate: "sepa_due_date",
+  mandatePresent: "mandate_present",
+  mandateSignatureDate: "mandate_signature_date",
+  mandateId: "mandate_id",
+  iban: "iban",
+  bic: "bic",
+  debitAccountHolder: "debit_account_holder",
+  debitReason1: "debit_reason_1",
+  debitReason2: "debit_reason_2",
+  debitReason3: "debit_reason_3",
+  debitReason4: "debit_reason_4",
+  debitReason5: "debit_reason_5",
+  input1: "input1",
+  input2: "input2",
+  input3: "input3",
+  input4: "input4",
+  input5: "input5",
+  input6: "input6",
+  input7: "input7",
+  discount: "discount",
+  mref: "mref",
+  createPaymentRef: "create_payment_ref",
+  noRc: "no_rc",
+};
+export const novalNetSDDRequestColumnMapperKeys = Object.keys(novalNetSDDRequestColumnMapper);
+export const novalNetSDDRequestColumnMapperValues = Object.values(novalNetSDDRequestColumnMapper);

package/src/index.ts

@@ -0,0 +1,72 @@
+// Export constants
+export * from './util/constants';
+export * from './util/dateUtils';
+export { isDateString, dateToString, stringToDate, getCurrentDateCompacted, FORMATS } from './util/dateUtils';
+export * from './util/numberUtils';
+
+// Export all DTOs
+export * from './dtos/common/base.request.dto';
+export * from './dtos/common/paginated.request.dto';
+export * from './dtos/common/paginated.response.dto';
+export * from './dtos/campaign.request.dto';
+export * from './dtos/category.request.dto';
+export * from './dtos/csv.request.dto';
+export * from './dtos/csv.response.dto';
+export * from './dtos/csvRow.request.dto';
+// export * from './dtos/emailTemplate.request.dto'; // Empty file
+export * from './dtos/empTransactions.request.dto';
+export * from './dtos/event.request.dto';
+export * from './dtos/field.request.dto';
+export * from './dtos/hook.request.dto';
+export * from './dtos/hookProfile.request.dto';
+export * from './dtos/hookOutbox.request.dto';
+export * from './dtos/lead.request.dto';
+export * from './dtos/mid.request.dto';
+export * from './dtos/adapter.request.dto';
+export * from './dtos/provider.request.dto';
+export * from './dtos/offer.request.dto';
+export * from './dtos/order.request.dto';
+export * from './dtos/product.request.dto';
+export * from './dtos/subscription.request.dto';
+export * from './dtos/transaction.request.dto';
+export * from './dtos/transactionError.request.dto';
+
+// Export all Models
+export * from './model/campaign.model';
+export * from './model/category.model';
+export * from './model/csv.model';
+// export * from './model/emailTemplate.model'; // Empty file
+export * from './model/empTransactions.model';
+export * from './model/event.model';
+export * from './model/field.model';
+export * from './model/gateway.model';
+export * from './model/hook.model';
+export * from './model/hookOutbox.model';
+export * from './model/hookProfile.model';
+export * from './model/lead.model';
+export * from './model/mid.model';
+export * from './model/offer.model';
+export * from './model/order.model';
+export * from './model/paymentData.model';
+export * from './model/product.model';
+export * from './model/recurringSettingConfig.model';
+export * from './model/subscription.model';
+export * from './model/subscriptionStepdown.model';
+export * from './model/transaction.model';
+export * from './model/transactionError.model';
+
+// Export Gateway Adapters Models
+export * from './gateways/adapters/model/transactionEmp.model';
+export * from './gateways/adapters/model/transactionNovalNet.model';
+export * from './gateways/adapters/model/transactionFinXP.model';
+
+// Export Gateway Adapters DTOs
+export * from './gateways/adapters/dtos/transaction-emp.request.dto';
+export * from './gateways/adapters/dtos/transaction-novalnet.request.dto';
+export * from './gateways/adapters/dtos/transaction-finxp.request.dto';
+
+// Export Gateway Providers Models
+export * from './gateways/providers/model/genesis.constants';
+export * from './gateways/providers/model/genesis.model';
+export * from './gateways/providers/model/novalNetManual.model';
+export * from './gateways/providers/model/finXpManual.model';

package/src/model/campaign.model.ts

@@ -0,0 +1,25 @@
+import { PaymentMethodType } from "./paymentData.model";
+import type { HookProfile } from "./hookProfile.model";
+import type { Offer } from "./offer.model";
+
+export interface Campaign {
+  id: number;
+  name: string;
+  description?: string;
+  categoryId?: number;
+  paymentMethod?: PaymentMethodType;
+  trafficSourceId?: number;
+  offers?: Offer[];
+  hookProfiles?: HookProfile[];
+  hookProfileIds?: number[];
+  createdAt: Date;
+  updatedAt?: Date;
+}
+
+export interface CampaignHookProfile {
+  id: number;
+  campaignId: number;
+  hookProfileId: number;
+  createdAt: Date;
+  updatedAt?: Date;
+}

package/src/model/category.model.ts

@@ -0,0 +1,7 @@
+export interface Category {
+  id?: number;
+  name?: string;
+  description?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/csv.model.ts

@@ -0,0 +1,80 @@
+import { CSV_TYPES, CSVRowStatusTypes, CSVStatusTypes } from "../util/constants";
+
+export interface CSV {
+  id?: number;
+  fileName: string;
+  uploadedFileUrl: string;
+  fileRows?: number;
+  doneRows?: number;
+  failedRows?: number;
+  status: CSVStatusTypes; // UPLOADED | PROCESSING | DONE
+  type?: CSV_TYPES;
+  startProcessingAt?: Date | null,
+  endProcessingAt?: Date | null,
+  jobId?: string,
+  csvRows?: CSVRow[];
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface CSVRow {
+  id?: number;
+  csvId?: number;
+  csv?: CSV;
+  rowIndex?: number;             // 1..N (data row index)
+  payload?: Record<string, any>; // the row content (firstName, email, etc)
+  status?: CSVRowStatusTypes;    // -- QUEUED | DONE | FAILED
+  errorMessage?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+// firstName,lastName,address1,address2,city,state,country,zipCode,phone,email,iban,bic,offerId
+export interface OrderCSVRow {
+  csvId?: number;
+  id?: number;
+  firstName?: string;
+  lastName?: string;
+  address1?: string;
+  address2?: string;
+  city?: string;
+  state?: string;
+  country?: string;
+  zipCode?: string;
+  phone?: string;
+  email?: string;
+  iban?: string;
+  bic?: string;
+  offerId?: number;
+  campaignId?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export const ordersCSVColumnsMapper: Partial<Record<keyof OrderCSVRow, string>> = {
+  firstName: "firstName",
+  lastName: "lastName",
+  address1: "address1",
+  address2: "address2",
+  city: "city",
+  state: "state",
+  country: "country",
+  zipCode: "zipCode",
+  phone: "phone",
+  email: "email",
+  iban: "iban",
+  bic: "bic",
+  offerId: "offerId",
+  campaignId: "campaignId",
+};
+export const ordersCSVColumnKeys = Object.keys(ordersCSVColumnsMapper);
+export const ordersCSVColumnValues = Object.values(ordersCSVColumnsMapper);
+
+export interface SubscriptionIdCSVRow {
+  subscriptionId: number;
+};
+
+export const subscriptionIdCSVColumnMapper: Partial<Record<keyof SubscriptionIdCSVRow, string>> = {
+  subscriptionId: "subscriptionId"
+};
+export const subscriptionIdCSVColumnKeys = Object.keys(subscriptionIdCSVColumnMapper);

package/src/model/empTransactions.model.ts

@@ -0,0 +1,9 @@
+export interface EMPTransaction {
+  id: number;
+  orderId?: number;
+  customerId?: number;
+  amount?: number;
+  currency?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/event.model.ts

@@ -0,0 +1,6 @@
+export interface Event {
+  id?: string;
+  name?: string;
+  createdAt: Date;
+  updatedAt?: Date;
+}