@crm-rocketlink/crm-model 1.0.0 → 1.0.2

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,64 @@
+// Export constants
+export * from './util/constants';
+export * from './util/dateUtils';
+export { isDateString, dateToString, stringToDate, getCurrentDateCompacted, FORMATS } from './util/dateUtils';
+
+// 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/lead.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/subscription.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';

package/src/model/campaign.model.ts

@@ -0,0 +1,16 @@
+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[];
+  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,77 @@
+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;
+  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 SubscriptionCSVRow {
+  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 subscriptionsCSVColumnsMapper: Partial<Record<keyof SubscriptionCSVRow, string>> = {
+  firstName: "first Name",
+  lastName: "last Name",
+  address1: "address1",
+  address2: "address2",
+  city: "city",
+  state: "state",
+  country: "country",
+  zipCode: "zipCode",
+  phone: "phone",
+  email: "email",
+  iban: "iban",
+  bic: "bic",
+  offerId: "offer Id",
+  campaignId: "campaignId",
+};
+export const subscriptionsCSVColumnKeys = Object.keys(subscriptionsCSVColumnsMapper);
+export const subscriptionsCSVColumnValues = Object.values(subscriptionsCSVColumnsMapper);
+
+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;
+}

package/src/model/fastify.d.ts

@@ -0,0 +1,19 @@
+import { 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/model/field.model.ts

@@ -0,0 +1,17 @@
+export interface Field {
+  id?: number;
+  name: string;
+  dbTable: string;
+  dbColumn: string;
+  description?: string;
+  createdAt: Date;
+  updatedAt?: Date;
+}
+
+export interface HookField {
+  id?: number;
+  hookId?: number;
+  fieldId?: number;
+  createdAt: Date;
+  updatedAt?: Date;
+}

package/src/model/gateway.model.ts

@@ -0,0 +1,50 @@
+export const BANKS = {
+  EMP: "emp",     // status pending
+  finXP: "finxp", // manual. status pending. 
+  Paynt: "paynt",
+  Paystrax: "paystrax",
+  PayBank2Bank: "paybank2bank",
+  Novalnet: "novalnet", //manual. all in un place CB
+  UNKNOWN: "unknown",
+  ALL: "all",
+};
+export const BANK_NAME_VALUES = Object.values(BANKS);
+export type BANKS = (typeof BANKS)[keyof typeof BANKS];
+
+export interface Adapter {
+  id?: number;
+  name?: BANKS;
+  description?: string;
+  apiIntegrated?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export const PROVIDERS = {
+  ACI: "aci",
+  IXOPAY: "ixopay",
+  PayBank2Bank: "paybank2bank",
+  Genesis: "genesis",
+};
+export type PROVIDERS = (typeof BANKS)[keyof typeof BANKS];
+
+export interface Provider {
+  id: number;
+  name: PROVIDERS;
+  description: string;
+  webhookUrl?: string;
+  webhookMethod?: string;
+  webhookToken?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface ProviderAdapter {
+  id?: number;
+  adapterId?: number;
+  adapter?: Adapter;
+  providerId?: number;
+  provider?: Provider;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/hook.model.ts

@@ -0,0 +1,13 @@
+import { Event } from "./event.model";
+import { Field } from "./field.model";
+
+export interface Hook {
+  id?: number;
+  name?: string;
+  eventId?: string;
+  url?: string;
+  event?: Event;
+  fields?: Field[];
+  createdAt: Date;
+  updatedAt?: Date;
+}

package/src/model/hookOutbox.model.ts

@@ -0,0 +1,12 @@
+export interface HookOutbox {
+  id?: number;
+  hookId?: number;
+  campaignId?: number;
+  triggerId?: string;
+  payloadJson?: string;
+  status?: string;
+  statusDescription?: string;
+  attempts?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/hookProfile.model.ts

@@ -0,0 +1,19 @@
+import type { Hook } from "./hook.model";
+
+export interface HookProfile {
+  id: number;
+  name: string;
+  type?: string;
+  hooks: Hook[];
+  createdAt: Date;
+  updatedAt?: Date;
+}
+
+export interface HookProfilesHooks {
+  id?: number;
+  hookProfileId?: number;
+  hookId?: number;
+  hook?: Hook;
+  createdAt: Date;
+  updatedAt?: Date;
+}

package/src/model/lead.model.ts

@@ -0,0 +1,28 @@
+import { REGISTRATION_MODE } from "../util/constants";
+import { PaymentDataType } from "./paymentData.model";
+import { CSVRow } from "./csv.model";
+
+export interface Lead {
+  id?: number;
+  isCustomer?: boolean;
+  visitId?: number;
+  csvRowId?: number;
+  csvId?: number;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  phoneNumber?: string;
+  address1?: string;
+  address2?: string;
+  street?: string;
+  city?: string;
+  state?: string;
+  country?: string;
+  zipCode?: string;
+  registrationMode?: REGISTRATION_MODE;
+  // customerId?: number;
+  paymentData?: PaymentDataType;
+  csvRow?: CSVRow;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/mid.model.ts

@@ -0,0 +1,26 @@
+import { ProviderAdapter } from "./gateway.model";
+
+export const MID_STATE = {
+  ACTIVE: 'ACTIVE',
+  TERMINATED: 'TERMINATED'
+};
+export type MID_STATE = (typeof MID_STATE)[keyof typeof MID_STATE];
+
+export interface Mid {
+  id?: number;
+  name?: string;
+  providerAdapterId?: number;
+  providerAdapter?: ProviderAdapter;
+  currency?: string;
+  state?: MID_STATE;
+  descriptor?: string;
+  midAuth?: MidAuth;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface MidAuth {
+  username: string;
+  password: string;
+  token: string;
+}

package/src/model/offer.model.ts

@@ -0,0 +1,26 @@
+import { OFFER_TYPE } from '../util/constants';
+import { Campaign } from './campaign.model';
+import { Mid } from './mid.model';
+import { Product } from './product.model';
+
+export interface Offer {
+  id?: number;
+  name?: string;
+  type?: OFFER_TYPE;
+  productId?: number;
+  product?: Product;
+  oneTimePayment?: boolean;
+  price?: number;
+  currency?: string;
+  trialPrice?: number;
+  trialIntervalUnit?: string;
+  trialPeriod?: string;
+  midId?: number;
+  mid?: Mid;
+  midRouterId?: string;
+  campaignId?: number;
+  campaign?: Campaign;
+  recurringSettingId?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/order.model.ts

@@ -0,0 +1,41 @@
+import { ORDER_STATUS } from '../util/constants';
+import { Offer } from "./offer.model";
+import { PaymentDataType } from "./paymentData.model";
+import { Mid } from "./mid.model";
+import { Campaign } from "./campaign.model";
+import { Transaction } from "./transaction.model";
+
+export interface Order {
+  id?: number;
+  // leadId?: number;
+  // lead?: Lead;
+  campaign?: Campaign;
+  paymentId?: number;
+  paymentData?: PaymentDataType;
+  amount?: number;
+  currency?: string;
+  status?: ORDER_STATUS;
+  notes?: string;
+  orderItems?: OrderItem[];
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface OrderItem {
+  id?: number;
+  quantity?: number;
+  trialPrice?: number;
+  price?: number;
+  currency?: string;
+  oneTimePayment?: boolean;
+  orderId?: number;
+  order?: Order;
+  offerId?: number;
+  offer?: Offer;
+  midId?: number;
+  mid?: Mid;
+  transactionId?: number; // we do not have a direct FK. Populate from Order.
+  transaction?: Transaction;
+  createdAt?: Date;
+  updatedAt?: Date;
+}