@abyss-project/banking 1.0.0

package/src/types/interface/api/responses/banking.response.ts

@@ -0,0 +1,119 @@
+import {
+  BasePaginate,
+  IAccountTransaction,
+  IAggregatorBank,
+  IAggregatorLink,
+  IBankAccount,
+  IBankAccountHistory,
+  IBankConnection,
+  IResponse,
+} from '../..';
+
+export interface IListConnectionBankingData {
+  aggregatorLink: IAggregatorLink[];
+}
+export type IListConnectionBankingResponse = IResponse<IListConnectionBankingData>;
+
+export interface IGetBankConnectionBankingData {
+  bankConnection: IBankConnection;
+}
+export type IGetBankConnectionBankingResponse = IResponse<IGetBankConnectionBankingData>;
+
+export interface IListInstitutionBankingData {
+  institution: {
+    id: string;
+    name: string;
+    countries: string[];
+    logoUrl: string;
+    bic: string;
+    transactionTotalDays: string;
+  }[];
+}
+export type IListInstitutionBankingResponse = IResponse<IListInstitutionBankingData>;
+
+export interface IListBankBankingData {
+  aggregatorBank: IAggregatorBank[];
+}
+export type IListBankBankingResponse = IResponse<IListBankBankingData>;
+
+export interface ICreateRequisitionBankingData {
+  connectionLink: string;
+}
+export type ICreateRequisitionBankingResponse = IResponse<ICreateRequisitionBankingData>;
+
+export interface IRenewRequisitionBankingData {
+  connectionLink: string;
+}
+export type IRenewRequisitionBankingResponse = IResponse<IRenewRequisitionBankingData>;
+
+export interface IConfirmRequisitionBankingData {
+  bankConnection: IBankConnection;
+}
+export type IConfirmRequisitionBankingResponse = IResponse<IConfirmRequisitionBankingData>;
+
+export type IPaginateAccountTransactionBankingResponse = IResponse<
+  BasePaginate<IAccountTransaction>
+>;
+
+export interface IGetAccountTransactionBankingData {
+  accountTransaction: IAccountTransaction;
+}
+export type IGetAccountTransactionBankingResponse = IResponse<IGetAccountTransactionBankingData>;
+
+export interface IUpdateAccountTransactionBankingData {
+  accountTransaction: IAccountTransaction;
+}
+export type IUpdateAccountTransactionBankingResponse =
+  IResponse<IUpdateAccountTransactionBankingData>;
+
+export interface IUpdateBankAccountBankingData {
+  bankAccount: IBankAccount;
+}
+export type IUpdateBankAccountBankingResponse = IResponse<IUpdateBankAccountBankingData>;
+
+export interface ILoadDemoDataBankingData {
+  aggregatorLink: IAggregatorLink;
+}
+export type ILoadDemoDataBankingResponse = IResponse<ILoadDemoDataBankingData>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeleteDemoDataBankingData {}
+export type IDeleteDemoDataBankingResponse = IResponse<IDeleteDemoDataBankingData>;
+
+export interface IGetTransactionPerCategoryBankingData {
+  analytics: {
+    bankAccountId: string;
+    transactionCount: number;
+  }[];
+}
+export type IGetTransactionPerCategoryBankingResponse =
+  IResponse<IGetTransactionPerCategoryBankingData>;
+
+export interface IGetSumTransactionPerBankAccountPerCategoryBankingData {
+  analytics: {
+    bankAccountId: string;
+    categories: {
+      categoryId: string | null;
+      transactionCount: number;
+      transactionSum: number;
+      transactions: {
+        id: string;
+        amount: number;
+        date: Date;
+        description: string;
+        comment: string | null;
+      }[];
+    }[];
+  }[];
+}
+export type IGetSumTransactionPerBankAccountPerCategoryBankingResponse =
+  IResponse<IGetSumTransactionPerBankAccountPerCategoryBankingData>;
+
+export type IPaginateBankAccountHistoryBankingResponse = IResponse<
+  BasePaginate<IBankAccountHistory>
+>;
+
+export interface IListBankAccountHistoryBankingData {
+  bankAccountHistory: IBankAccountHistory[];
+}
+export type IListBankAccountHistoryBankingResponse = IResponse<IListBankAccountHistoryBankingData>;

package/src/types/interface/api/responses/categorization-rule.admin.response.ts

@@ -0,0 +1,28 @@
+import { ICategorizationRule } from '../../models/categorization-rule.model';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export interface IGetCategorizationRuleAdminData {
+  categorizationRule: ICategorizationRule;
+}
+export type IGetCategorizationRuleAdminResponse = IResponse<IGetCategorizationRuleAdminData>;
+
+export type IPaginateCategorizationRuleAdminResponse = IResponse<BasePaginate<ICategorizationRule>>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeleteCategorizationRuleAdminData {}
+export type IDeleteCategorizationRuleAdminResponse = IResponse<IDeleteCategorizationRuleAdminData>;
+
+export interface ICreateCategorizationRuleAdminData {
+  categorizationRule: ICategorizationRule;
+}
+export type ICreateCategorizationRuleAdminResponse = IResponse<ICreateCategorizationRuleAdminData>;
+
+export interface IUpdateCategorizationRuleAdminData {
+  categorizationRule: ICategorizationRule;
+}
+export type IUpdateCategorizationRuleAdminResponse = IResponse<IUpdateCategorizationRuleAdminData>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IApplyCategorizationRuleAdminData {}
+export type IApplyCategorizationRuleAdminResponse = IResponse<IApplyCategorizationRuleAdminData>;

package/src/types/interface/api/responses/categorization-rule.response.ts

@@ -0,0 +1,28 @@
+import { ICategorizationRule } from '../../models/categorization-rule.model';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export interface IGetCategorizationRuleData {
+  categorizationRule: ICategorizationRule;
+}
+export type IGetCategorizationRuleResponse = IResponse<IGetCategorizationRuleData>;
+
+export type IPaginateCategorizationRuleResponse = IResponse<BasePaginate<ICategorizationRule>>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeleteCategorizationRuleData {}
+export type IDeleteCategorizationRuleResponse = IResponse<IDeleteCategorizationRuleData>;
+
+export interface ICreateCategorizationRuleData {
+  categorizationRule: ICategorizationRule;
+}
+export type ICreateCategorizationRuleResponse = IResponse<ICreateCategorizationRuleData>;
+
+export interface IUpdateCategorizationRuleData {
+  categorizationRule: ICategorizationRule;
+}
+export type IUpdateCategorizationRuleResponse = IResponse<IUpdateCategorizationRuleData>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IApplyCategorizationRuleData {}
+export type IApplyCategorizationRuleResponse = IResponse<IApplyCategorizationRuleData>;

package/src/types/interface/api/responses/category.admin.response.ts

@@ -0,0 +1,24 @@
+import { ICategory } from '../../models/category.model';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export interface IGetCategoryAdminData {
+  category: ICategory;
+}
+export type IGetCategoryAdminResponse = IResponse<IGetCategoryAdminData>;
+
+export type IPaginateCategoryAdminResponse = IResponse<BasePaginate<ICategory>>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeleteCategoryAdminData {}
+export type IDeleteCategoryAdminResponse = IResponse<IDeleteCategoryAdminData>;
+
+export interface ICreateCategoryAdminData {
+  category: ICategory;
+}
+export type ICreateCategoryAdminResponse = IResponse<ICreateCategoryAdminData>;
+
+export interface IUpdateCategoryAdminData {
+  category: ICategory;
+}
+export type IUpdateCategoryAdminResponse = IResponse<IUpdateCategoryAdminData>;

package/src/types/interface/api/responses/category.response.ts

@@ -0,0 +1,39 @@
+import { ICategory } from '../../models/category.model';
+import { ITransactionCategory } from '../../models/transaction-category.model';
+import { IResponse } from '../type-message/response';
+
+export interface IListCategoryData {
+  category: ICategory[];
+}
+export type IListCategoryResponse = IResponse<IListCategoryData>;
+
+export interface IListAnalyticsCategoryData {
+  categories: {
+    transactionCount: number;
+    category: ICategory;
+  }[];
+}
+export type IListAnalyticsCategoryResponse = IResponse<IListAnalyticsCategoryData>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IRemoveCategoryData {}
+export type IRemoveCategoryResponse = IResponse<IRemoveCategoryData>;
+
+export interface IAddCategoryData {
+  transactionCategory: ITransactionCategory;
+}
+export type IAddCategoryResponse = IResponse<IAddCategoryData>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeleteCategoryData {}
+export type IDeleteCategoryResponse = IResponse<IDeleteCategoryData>;
+
+export interface ICreateCategoryData {
+  category: ICategory;
+}
+export type ICreateCategoryResponse = IResponse<ICreateCategoryData>;
+
+export interface IUpdateCategoryData {
+  category: ICategory;
+}
+export type IUpdateCategoryResponse = IResponse<IUpdateCategoryData>;

package/src/types/interface/api/responses/monitor.response.ts

@@ -0,0 +1,8 @@
+import { IResponse } from '..';
+
+export interface IUpMonitorData {
+  upTime: number;
+  processId: string;
+  requestId: string;
+}
+export type IUpMonitorResponse = IResponse<IUpMonitorData>;

package/src/types/interface/api/responses/panel.admin.response.ts

@@ -0,0 +1,24 @@
+import { IPanel } from '../../models/panel.model';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export interface IGetPanelAdminData {
+  panel: IPanel;
+}
+export type IGetPanelAdminResponse = IResponse<IGetPanelAdminData>;
+
+export type IPaginatePanelAdminResponse = IResponse<BasePaginate<IPanel>>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeletePanelAdminData {}
+export type IDeletePanelAdminResponse = IResponse<IDeletePanelAdminData>;
+
+export interface ICreatePanelAdminData {
+  panel: IPanel;
+}
+export type ICreatePanelAdminResponse = IResponse<ICreatePanelAdminData>;
+
+export interface IUpdatePanelAdminData {
+  panel: IPanel;
+}
+export type IUpdatePanelAdminResponse = IResponse<IUpdatePanelAdminData>;

package/src/types/interface/api/responses/panel.response.ts

@@ -0,0 +1,24 @@
+import { IPanel } from '../../models/panel.model';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export interface IGetPanelData {
+  panel: IPanel;
+}
+export type IGetPanelResponse = IResponse<IGetPanelData>;
+
+export type IPaginatePanelResponse = IResponse<BasePaginate<IPanel>>;
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface IDeletePanelData {}
+export type IDeletePanelResponse = IResponse<IDeletePanelData>;
+
+export interface ICreatePanelData {
+  panel: IPanel;
+}
+export type ICreatePanelResponse = IResponse<ICreatePanelData>;
+
+export interface IUpdatePanelData {
+  panel: IPanel;
+}
+export type IUpdatePanelResponse = IResponse<IUpdatePanelData>;

package/src/types/interface/api/responses/storage.admin.response.ts

@@ -0,0 +1,4 @@
+import { IResponse } from '../type-message/response';
+
+export type ICheckIntegrityStorageAdminData = Record<string, never>;
+export type ICheckIntegrityStorageAdminResponse = IResponse<ICheckIntegrityStorageAdminData>;

package/src/types/interface/api/responses/user.admin.response.ts

@@ -0,0 +1,18 @@
+import { BasePaginate, IResponse, IUser } from '../..';
+
+export interface IGetUserAdminData {
+  user: IUser;
+}
+export type IGetUserAdminResponse = IResponse<IGetUserAdminData>;
+
+export type IPaginateUserAdminResponse = IResponse<BasePaginate<IUser>>;
+
+export interface IUpdateUserAdminData {
+  user: IUser;
+}
+export type IUpdateUserAdminResponse = IResponse<IUpdateUserAdminData>;
+
+export interface IResetApiKeyUserAdminData {
+  user: IUser;
+}
+export type IResetApiKeyUserAdminResponse = IResponse<IResetApiKeyUserAdminData>;

package/src/types/interface/api/responses/user.response.ts

@@ -0,0 +1,16 @@
+import { IResponse, IUser } from '../..';
+
+export interface IMeUserData {
+  user: IUser;
+}
+export type IMeUserResponse = IResponse<IMeUserData>;
+
+export interface IResetApiKeyUserData {
+  user: IUser;
+}
+export type IResetApiKeyUserResponse = IResponse<IResetApiKeyUserData>;
+
+export interface IUpdateUserData {
+  user: IUser;
+}
+export type IUpdateUserResponse = IResponse<IUpdateUserData>;

package/src/types/interface/api/type-message/api-error.ts

@@ -0,0 +1,9 @@
+import { Code, ErrorType } from '../../../enum';
+
+export interface IApiError {
+  type: ErrorType;
+  code: Code;
+  message: string;
+  params?: string;
+  field?: string;
+}

package/src/types/interface/api/type-message/base-order.ts

@@ -0,0 +1,4 @@
+export interface BaseOrder {
+  orderBy?: string;
+  descending?: boolean;
+}

package/src/types/interface/api/type-message/base-paginate.ts

@@ -0,0 +1,11 @@
+export interface BasePaginate<T> {
+  maxPages: number;
+  currentPage: number;
+  totalItems: number;
+  data: T[];
+}
+
+export interface QueryPaginate {
+  page?: number;
+  limit?: number;
+}

package/src/types/interface/api/type-message/response.ts

@@ -0,0 +1,6 @@
+import { IApiError } from './api-error';
+
+export interface IResponse<T> {
+  data: T;
+  error?: IApiError | Error;
+}

package/src/types/interface/index.ts

@@ -0,0 +1,15 @@
+export * from './models/user.model';
+export * from './models/aggregator-link.model';
+export * from './models/bank-connection.model';
+export * from './models/bank-account.model';
+export * from './models/bank-account-history.model';
+export * from './models/account-transaction.model';
+export * from './models/aggregator-bank.model';
+export * from './models/category.model';
+export * from './models/transaction-category.model';
+export * from './models/categorization-rule.model';
+export * from './models/categorization-rule-category.model';
+export * from './models/panel.model';
+
+// API Request
+export * from './api';

package/src/types/interface/models/account-transaction.model.ts

@@ -0,0 +1,53 @@
+import { IBankAccount } from './bank-account.model';
+import { ITransactionCategory } from './transaction-category.model';
+
+export type AccountTransactionMetadata = {
+  debtorAgent?: string;
+  debtorName?: string;
+  debtorAccount?: unknown;
+
+  additionalDataStructured?: unknown;
+  additionalInformation?: string;
+  additionalInformationStructured?: string;
+  bankTransactionCode?: string;
+  proprietaryBankTransactionCode?: string;
+  currencyExchange?: unknown;
+  ultimateCreditor?: string;
+  ultimateDebtor?: string;
+
+  // Note(Mehdi): Already existing in model but possibly not visible
+  internalTransactionId?: string;
+  transactionId?: string;
+  bookingDate?: string;
+  bookingDateTime?: string;
+  valueDate?: string;
+  valueDateTime?: string;
+  remittanceInformationUnstructured?: string;
+  remittanceInformationUnstructuredArray?: string[];
+  remittanceInformationStructured?: string;
+  remittanceInformationStructuredArray?: string[];
+};
+
+export interface IAccountTransaction {
+  id?: string;
+  date: Date;
+  amount: number;
+  currency: string;
+  description: string;
+  comment: string | null;
+  aggregatorTransactionId: string;
+  bankAccountId: string;
+  mandateId: string | null;
+  merchantCategoryCode: string | null;
+  entryReference: string | null;
+  endToEndId: string | null;
+  purposeCode: string | null;
+  checkId: string | null;
+  metadata: AccountTransactionMetadata;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  bankAccount?: IBankAccount;
+  transactionCategory?: ITransactionCategory[];
+}

package/src/types/interface/models/aggregator-bank.model.ts

@@ -0,0 +1,15 @@
+import { AggregatorType } from '../../enum';
+
+export interface IAggregatorBank {
+  id?: string;
+  aggregatorType: AggregatorType;
+  aggregatorBankId: string;
+  logoUrl: string;
+  name: string;
+  bic: string;
+  countries: string[];
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+}

package/src/types/interface/models/aggregator-link.model.ts

@@ -0,0 +1,15 @@
+import { AggregatorType } from '../../enum';
+import { IBankConnection } from './bank-connection.model';
+import { IUser } from './user.model';
+
+export interface IAggregatorLink {
+  id?: string;
+  type: AggregatorType;
+  userId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  user?: IUser;
+  bankConnection?: IBankConnection[];
+}

package/src/types/interface/models/bank-account-history.model.ts

@@ -0,0 +1,14 @@
+import { IBankAccount } from './bank-account.model';
+
+export interface IBankAccountHistory {
+  id?: string;
+  expectedBalance: number;
+  availableBalance: number;
+  date: Date;
+  bankAccountId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  bankAccount?: IBankAccount;
+}

package/src/types/interface/models/bank-account.model.ts

@@ -0,0 +1,29 @@
+import { CashAccountType } from '../../enum';
+import { IAccountTransaction } from './account-transaction.model';
+import { IBankAccountHistory } from './bank-account-history.model';
+import { IBankConnection } from './bank-connection.model';
+
+export interface IBankAccount {
+  id?: string;
+  name: string;
+  commonName: string | null;
+  ownerName: string | null;
+  currency: string;
+  iban: string;
+  color: string;
+  cashAccountType: CashAccountType;
+  expectedBalance: number;
+  availableBalance: number;
+  aggregatorAccountId: string;
+  aggregatorCreatedAt: Date;
+  bankConnectionId: string;
+  lastRefresh: Date | null;
+  isMasked: boolean;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  bankConnection?: IBankConnection;
+  accountTransaction?: IAccountTransaction[];
+  bankAccountHistory?: IBankAccountHistory[];
+}

package/src/types/interface/models/bank-connection.model.ts

@@ -0,0 +1,20 @@
+import { BankConnectionStatus } from '../../enum';
+import { IAggregatorLink } from './aggregator-link.model';
+import { IBankAccount } from './bank-account.model';
+
+export interface IBankConnection {
+  id?: string;
+  aggregatorConnectionId: string;
+  aggregatorAgreementId: string;
+  aggregatorBankId: string; // Note(Mehdi): InstitutionId
+  aggregatorLinkId: string;
+  status: BankConnectionStatus;
+  lastRefresh: Date | null;
+  confirmedAt: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  aggregatorLink?: IAggregatorLink;
+  bankAccount?: IBankAccount[];
+}

package/src/types/interface/models/categorization-rule-category.model.ts

@@ -0,0 +1,14 @@
+import { ICategorizationRule } from './categorization-rule.model';
+import { ICategory } from './category.model';
+
+export interface ICategorizationRuleCategory {
+  id?: string;
+  categoryId: string;
+  categorizationRuleId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  category?: ICategory;
+  categorizationRule?: ICategorizationRule;
+}

package/src/types/interface/models/categorization-rule.model.ts

@@ -0,0 +1,48 @@
+import { ICategorizationRuleCategory } from './categorization-rule-category.model';
+import { ICategory } from './category.model';
+import { ITransactionCategory } from './transaction-category.model';
+import { IUser } from './user.model';
+
+export interface ICategorizationRule {
+  id?: string;
+  name: string;
+  description: string | null;
+  isActive: boolean;
+  rules: CategorizationRules[]; // Note(Mehdi): Category is assigned if at least one of rules is true
+  userId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+  deletedAt?: Date;
+
+  // Associations
+  user?: IUser;
+  transactionCategory?: ITransactionCategory[];
+  category?: ICategory[];
+  categorizationRuleCategory?: ICategorizationRuleCategory[];
+}
+
+export type CategorizationRules = {
+  label?: {
+    shouldEq?: string;
+    shouldContains?: string[];
+    shouldNotContains?: string[];
+    shouldStartsWith?: string[];
+    shouldNotStartsWith?: string[];
+    shouldEndsWith?: string[];
+    shouldNotEndsWith?: string[];
+  };
+  amount?: {
+    min?: number | null;
+    minOrEq?: number | null;
+    max?: number | null;
+    maxOrEq?: number | null;
+  };
+  date?: {
+    before?: Date | null;
+    after?: Date | null;
+    dayOfMonth?: number[] | null; // Note(Mehdi): One of array
+    dayOfWeek?: number[] | null; // Note(Mehdi): One of array
+    month?: number[] | null; // Note(Mehdi): One of array
+    year?: number[] | null; // Note(Mehdi): One of array
+  };
+};

package/src/types/interface/models/category.model.ts

@@ -0,0 +1,17 @@
+import { ICategorizationRule } from './categorization-rule.model';
+import { ITransactionCategory } from './transaction-category.model';
+import { IUser } from './user.model';
+
+export interface ICategory {
+  id?: string;
+  name: string;
+  color: string;
+  userId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  user?: IUser;
+  transactionCategory?: ITransactionCategory[];
+  categorizationRule?: ICategorizationRule[];
+}