@rocketlink/crm-model 1.0.0

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,52 @@
+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;
+  adapters?: Adapter[];
+  adapterIds?: number[];
+  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,14 @@
+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[];
+  fieldIds?: number[];
+  createdAt: Date;
+  updatedAt?: Date;
+}

package/src/model/hookOutbox.model.ts

@@ -0,0 +1,20 @@
+export const HOOK_OUTBOX_STATUS  = {
+  PENDING: 'PENDING',
+  SENT: 'SENT',
+  FAILED: 'FAILED'
+};
+export type HOOK_OUTBOX_STATUS = (typeof HOOK_OUTBOX_STATUS)[keyof typeof HOOK_OUTBOX_STATUS];
+
+export interface HookOutbox {
+  id?: number;
+  hookId?: number;
+  campaignId?: number;
+  triggerId?: string;
+  hookUrl?: string; 
+  payloadJson?: string;
+  status?: HOOK_OUTBOX_STATUS;
+  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?: number;
+  campaignId?: number;
+  campaign?: Campaign;
+  recurringSettingId?: number;
+  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;
+}

package/src/model/paymentData.model.ts

@@ -0,0 +1,59 @@
+import { Lead } from "./lead.model";
+
+export const PAYMENT_METHOD = {
+  SEPA: "SEPA",
+  CREDIT_CARD: "CREDIT_CARD",
+  OPEN_BANKING: "OPEN_BANKING"
+} as const;
+
+export type PaymentMethodType = (typeof PAYMENT_METHOD)[keyof typeof PAYMENT_METHOD];
+
+export interface PaymentData {
+  id?: number;
+  type: PaymentMethodType;
+  leadId?: number;
+  lead?: Lead;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+export type PaymentDataType = SEPAPaymentData | CreditCardPaymentData | OpenBankingPaymentData;
+
+export interface SEPAPaymentData extends PaymentData {
+  type: typeof PAYMENT_METHOD.SEPA;
+  id?: number;
+  iban?: string;
+  bic?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface CreditCardPaymentData extends PaymentData {
+  type: typeof PAYMENT_METHOD.CREDIT_CARD;
+  id?: number;
+  cardNumber: string;
+  cardHolder: string;
+  expireMonth: string;
+  expireYear: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface OpenBankingPaymentData extends PaymentData {
+  type: typeof PAYMENT_METHOD.OPEN_BANKING;
+  id?: number;
+  pb2b_av_id: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export function isSepa(p: PaymentDataType | undefined): p is SEPAPaymentData {
+  return p?.type === PAYMENT_METHOD.SEPA;
+}
+
+export function isCreditCard(p: PaymentDataType): p is CreditCardPaymentData {
+  return p.type === PAYMENT_METHOD.CREDIT_CARD;
+}
+
+export function isOpenBanking(p: PaymentDataType): p is OpenBankingPaymentData {
+  return p.type === PAYMENT_METHOD.OPEN_BANKING;
+}

package/src/model/product.model.ts

@@ -0,0 +1,11 @@
+export interface Product {
+  id?: number;
+  name?: string;
+  description?: string;
+  defaultPrice?: string;
+  image?: string;
+  isShippable?: boolean;
+  categoryId?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/recurringSettingConfig.model.ts

@@ -0,0 +1,18 @@
+export const INTERVAL_UNIT = {
+  DAYS: "DAYS",
+  MONTHS: "MONTHS",
+} as const;
+export type INTERVAL_UNIT = (typeof INTERVAL_UNIT)[keyof typeof INTERVAL_UNIT];
+
+export interface RecurringSettingConfig {
+  id?: number;
+  name?: string;
+  intervalUnit?: INTERVAL_UNIT;
+  intervalPeriod?: number;
+  maxTriesAfterFailure?: number;
+  maxDelayPeriod?: number;
+  dunningIntervalPeriod?: number;
+  dunningMaxRetires?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/subscription.model.ts

@@ -0,0 +1,30 @@
+import { OrderItem } from "./order.model";
+
+export interface Subscription {
+  id?: number;
+  username?: string;
+  password?: string;
+  startDate?: Date;
+  endDate?: Date;
+  nextBillingDate?: Date;
+  status?: string;
+  orderItemId?: number;
+  orderItem?: OrderItem;
+  registrationEmailSent?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  // Normalized/flattened fields from relationships (added by API layer)
+  email?: string;
+  csvId?: number;
+  customerId?: number;
+  paymentId?: number;
+  orderId?: number;
+  offerId?: number;
+  midId?: number;
+  paymentType?: string;
+  leadId?: number;
+  leadName?: string;
+  leadEmail?: string;
+  bankName?: string;
+}

package/src/model/subscriptionStepdown.model.ts

@@ -0,0 +1,10 @@
+export interface SubscriptionStepdown {
+  id?: number;
+  subscriptionId?: number;
+  nextPaymentDate?: Date;
+  executed?: number;
+  completed?: number;
+  timesTried?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/transaction.model.ts

@@ -0,0 +1,40 @@
+import { BANKS } from "./gateway.model";
+
+export const TRANSACTION_STATUS = {
+  PENDING_ASYNC: "PENDING_ASYNC",
+  SUCCESS: "SUCCESS",
+  FAILED: "FAILED",
+  UNKNOWN: "UNKNOWN",
+};
+export type TRANSACTION_STATUS = (typeof TRANSACTION_STATUS)[keyof typeof TRANSACTION_STATUS];
+
+export const APP_TRANSACTION_TYPE = {
+  INITIAL: "INITIAL",
+  RECURRING: "RECURRING",
+  STEPDOWN: "STEPDOWN",
+};
+export type APP_TRANSACTION_TYPE = (typeof APP_TRANSACTION_TYPE)[keyof typeof APP_TRANSACTION_TYPE];
+
+export const PAYMENT_TYPE = {
+  SDD_SALE: "SDD_SALE",
+  REFUND: "REFUND",
+  CHARGEBACK: "CHARGEBACK",
+  DEBIT: "DEBIT"
+};
+export type PAYMENT_TYPE = (typeof PAYMENT_TYPE)[keyof typeof PAYMENT_TYPE];
+
+export interface Transaction {
+  id?: number;
+  bank?: BANKS;
+  amount?: string;
+  currency?: string;
+  midId?: number;
+  orderId?: number;
+  // internalSubscriptionId?: number;
+  internalPaymentType?: PAYMENT_TYPE;
+  internalTransactionType?: APP_TRANSACTION_TYPE;
+  internalTransactionStatus?: TRANSACTION_STATUS;
+  response?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/model/transactionError.model.ts

@@ -0,0 +1,17 @@
+import { BANKS } from "./gateway.model";
+
+export interface TransactionError {
+  id?: number;
+  bank: BANKS;
+  midId?: number;
+  orderId?: number;
+  amount?: string;
+  currency?: string;
+  adapterStatus?: string;
+  adapterCode?: string;
+  message?: string;
+  request?: string;
+  response?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}

package/src/util/constants.ts

@@ -0,0 +1,113 @@
+export const YES_NO = {
+  YES: "Y",
+  NO: "N",
+};
+export type YES_NO = (typeof YES_NO)[keyof typeof YES_NO];
+
+export const MIME_TYPES = {
+  csv: "text/csv",
+};
+export type MIME_TYPES = (typeof MIME_TYPES)[keyof typeof MIME_TYPES];
+
+export const CSV_TYPES = {
+  CREATE_ORDERS: "CREATE_ORDERS",
+  BILL_SUBSCRIPTIONS: "BILL_SUBSCRIPTIONS",
+  IMPORT_TRANSACTIONS_SDD: "IMPORT_TRANSACTIONS_SDD",
+  IMPORT_TRANSACTIONS_CHARGEBACK: "IMPORT_TRANSACTIONS_CHARGEBACK",
+  CANCEL_SUBSCRIPTIONS: "CANCEL_SUBSCRIPTIONS",
+};
+export const CSV_TYPE_VALUES = Object.values(CSV_TYPES);
+export type CSV_TYPES = (typeof CSV_TYPES)[keyof typeof CSV_TYPES];
+
+export const CSV_STATUS = {
+  UPLOADED: "UPLOADED",
+  QUEUED: "QUEUED",
+  PROCESSING: "PROCESSING",
+  COMPLETED: "COMPLETED",
+  COMPLETED_WITH_ERRORS: "COMPLETED_WITH_ERRORS",
+  FAILED: "FAILED",
+  CANCELLED: "CANCELLED"
+};
+export type CSVStatusTypes = (typeof CSV_STATUS)[keyof typeof CSV_STATUS];
+
+export const CSV_ROW_STATUS = {
+  QUEUED: 'QUEUED', 
+  SUCCESS: "SUCCESS",
+  FAILED: "FAILED",
+};
+export type CSVRowStatusTypes = (typeof CSV_ROW_STATUS)[keyof typeof CSV_ROW_STATUS];
+
+export const REGISTRATION_MODE = {
+  LIVE_TRAFFIC: "LIVE_TRAFFIC",
+  CSV: "CSV"
+};
+export type REGISTRATION_MODE = (typeof REGISTRATION_MODE)[keyof typeof REGISTRATION_MODE];
+
+export const OFFER_TYPE = {
+  OFFER: "OFFER",
+  UPSELL: "UPSELL",
+  DOWNSELL: "DOWNSELL"
+};
+export type OFFER_TYPE = (typeof OFFER_TYPE)[keyof typeof OFFER_TYPE];
+
+export const TRANSACTION_TYPE = {
+  sdd_sale: 'sdd_sale',
+  chargeback: 'chargeback',
+  refund: 'refund'
+};
+
+export const ALL = 'all';
+
+export type TRANSACTION_TYPE = (typeof TRANSACTION_TYPE)[keyof typeof TRANSACTION_TYPE];
+export const TRANSACTION_TYPE_VALUES = Object.values(TRANSACTION_TYPE);
+
+export const TRANSACTION_TYPE_CODE = {
+  DB: 'Debit',
+  RF: 'Refund',
+  PA: 'Payment Authorization',
+  CB: 'Chargeback',
+  CP: 'Capture',
+  RV: 'Reversal',
+};
+
+
+
+export const ORDER_STATUS = {
+  INITIATED: "INITIATED",
+  COMPLETED: "COMPLETED",
+  FAILED: "FAILED",
+};
+export type ORDER_STATUS = (typeof ORDER_STATUS)[keyof typeof ORDER_STATUS];
+export const ORDER_STATUS_VALUES = Object.values(CSV_TYPES);
+
+export const SUBSCRIPTION_STATUS = {
+  PAYMENT_PENDING: "PAYMENT_PENDING",
+  PAYMENT_PENDING_CONFIRMATION: "PAYMENT_PENDING_CONFIRMATION",
+  ACTIVE: "ACTIVE",
+  EXPIRED: "EXPIRED",
+  CANCELLED: "CANCELLED",
+  TRIAL: "TRIAL"
+};
+export type SUBSCRIPTION_STATUS = (typeof SUBSCRIPTION_STATUS)[keyof typeof SUBSCRIPTION_STATUS];
+
+export const EVENTS = {
+  ORDER_CREATED: "order.created",
+  ORDER_UPDATED: "order.updated",
+  SUBSCRIPTION_CREATED: "subscription.created",
+  TRANSACTION_SDD_IMPORTED: "transaction.sdd_sale.imported",
+  TRANSACTION_REFUND_IMPORTED: "transaction.refund.imported",
+  TRANSACTION_CHARGEBACK_IMPORTED: "transaction.chargeback.imported",
+  TRANSACTION_REFUND_ISSUED: "transaction.refund.issued",
+  TRANSACTION_ERROR: "transaction.error",
+  SUBSCRIPTION_CANCELLATION_ISSUED: "subscription.cancellation.issued"
+};
+export type EVENTS = (typeof EVENTS)[keyof typeof EVENTS];
+
+export const SAFE_WHILE_LIMIT = 1_000;
+
+export const CURRENCIES = {
+  EUR: "EUR",
+  USD: "USD",
+  GBP: "GBP",
+};
+export type CURRENCIES = (typeof CURRENCIES)[keyof typeof CURRENCIES];

package/src/util/dateUtils.ts

@@ -0,0 +1,98 @@
+import { format, isValid, parseISO, addDays, subDays } from 'date-fns';
+
+export const FORMATS = {
+  ISO_DATE: 'yyyy-MM-dd',                       // "2026-01-07"
+  ISO_DATE_TIME_TZ: "yyyy-MM-dd'T'HH:mm",       // "2026-01-07T14:30"
+  ISO_DATE_TIME_MINUTES: 'yyyy-MM-dd HH:mm',    // "2026-01-07 14:30
+  ISO_DATE_TIME_SECONDS: 'yyyy-MM-dd HH:mm:ss', // "2026-01-07 14:30:23,
+  COMPACT_DATETIME: 'yyyyMMddHHmmss',           // "20260107143000"
+  COMPACT_DATE: 'yyyyMMdd',                     // "20260107"
+} as const;
+// ============================================
+// Date → String formatted conversions
+// ============================================
+export function dateToString(date: Date, formatString: string = FORMATS.ISO_DATE): string {
+  if (!date || !isValid(date)) {
+    throw new Error('Invalid date: ' + date);
+  }
+  return format(date, formatString);
+}
+export function dateToYYYYMMDD(date: Date): string {
+  return dateToString(date, FORMATS.COMPACT_DATETIME);
+}
+export function dateToTZ(date: Date): string {
+  return dateToString(date, FORMATS.ISO_DATE_TIME_TZ);
+}
+export function dateToMinutes(date: Date): string {
+  return dateToString(date, FORMATS.ISO_DATE_TIME_MINUTES);
+}
+export function getCurrentDateCompacted(): string {
+  return dateToYYYYMMDD(new Date()); // "20260107143000"
+}
+
+// Checks if a string matches a date pattern
+export function isDateString(value: string): boolean {
+  const datePattern = /^\d{4}-\d{2}-\d{2}(T|\s)\d{2}:\d{2}:\d{2}/;
+  return datePattern.test(value);
+}
+// ============================================
+// String → Date conversions
+// ============================================
+export function stringToDate(value: string): Date {
+  if (!value) {
+    throw new Error('Date string cannot be empty');
+  }
+  const date = parseISO(value);
+  if (!isValid(date)) {
+    throw new Error('Invalid date string: ' + value);
+  }
+  return date;
+}
+// ============================================
+// String → String formatted conversions
+// ============================================
+export function formatDateString(value: string, formatString: string = FORMATS.ISO_DATE): string {
+  if (!value) {
+    return '';
+  }
+  const date = stringToDate(value);
+  return format(date, formatString);
+}
+export function formatDateAs_yyyymmdd(value: string): string {
+  return formatDateString(value, FORMATS.ISO_DATE);
+}
+export function formatDateAs_tz(value: string): string {
+  return formatDateString(value, FORMATS.ISO_DATE_TIME_TZ);
+}
+export function formatDateAs_minutes(value: string): string {
+  return formatDateString(value, FORMATS.ISO_DATE_TIME_MINUTES);
+}
+export function formatDateAs_seconds(value: string): string {
+  return formatDateString(value, FORMATS.ISO_DATE_TIME_SECONDS);
+}
+
+// ============================================
+// Date manipulation
+// ============================================
+export function addDaysToDate(date: Date, days: number): Date {
+  if (!date || !isValid(date)) {
+    throw new Error('Invalid date: ' + date);
+  }
+  return addDays(date, days);
+}
+export function subtractDaysFromDate(date: Date, days: number): Date {
+  if (!date || !isValid(date)) {
+    throw new Error('Invalid date: ' + date);
+  }
+  return subDays(date, days);
+}
+export function addDaysToDateString(value: string, days: number, formatString: string = FORMATS.ISO_DATE): string {
+  const date = stringToDate(value);
+  const newDate = addDays(date, days);
+  return format(newDate, formatString);
+}
+export function subtractDaysFromDateString(value: string, days: number, formatString: string = FORMATS.ISO_DATE): string {
+  const date = stringToDate(value);
+  const newDate = subDays(date, days);
+  return format(newDate, formatString);
+}

package/src/util/numberUtils.ts

@@ -0,0 +1,5 @@
+export const toPositiveInt = (value: unknown, fallback: number): number => {
+  if (value === undefined || value === null || value === "") return fallback;
+  const parsed = Number(value);
+  return Number.isFinite(parsed) && parsed > 0 ? Math.floor(parsed) : fallback;
+};