@abyss-project/banking 1.0.0 → 1.0.1

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

@@ -1,29 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,48 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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[];
-}

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

@@ -1,135 +0,0 @@
-import { PeriodConfiguration } from '../../enum';
-import { PanelComponentType } from '../../enum/panel-component-type.enum';
-import { IUser } from './user.model';
-
-export interface IPanel {
-  id?: string;
-  name: string;
-  composition: PanelComposition;
-  userId: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  user?: IUser;
-}
-
-export type PanelComposition = {
-  shouldIncludeHeaderCards: boolean;
-  config: PanelComponentConfig;
-  elements: {
-    id: string;
-    title?: string;
-    config: PanelComponentConfig;
-    components: PanelComponent[];
-    layout: {
-      width: number;
-    };
-  }[];
-};
-
-export type PanelComponent = {
-  id: string;
-  config: PanelComponentConfig;
-  title?: string;
-  layout: {
-    width: number;
-  };
-} & (
-  | AccountBalancePanelComponent
-  | AccountCashPositionPanelComponent
-  | SumPerCategoryPanelComponent
-  | SumPerCategoryPerMonthPanelComponent
-  | TransactionPerAccountPanelComponent
-  | TransactionPerCategoryPanelComponent
-  | TransactionPerDayPanelComponent
-  | TransactionTablePanelComponent
-  | PeriodReportPanelComponent
-  | MonthlyReportPanelComponent
-);
-
-export type PanelComponentConfig = {
-  period: {
-    startDate: Date | null;
-    endDate: Date | null;
-    shouldSyncWithRemote: boolean;
-    periodConfiguration: PeriodConfiguration | null;
-  };
-  bankAccount: {
-    selectedIds: string[] | null;
-    shouldSyncWithRemote: boolean;
-  };
-  currency: {
-    singleCurrency: string | null;
-    multipleCurrency: string[] | null;
-    shouldSyncWithRemote: boolean;
-  };
-  transaction: {
-    shouldIncludeUnCategorized: boolean;
-    shouldSyncWithRemote: boolean;
-    categories: {
-      filterCategories: string[] | null;
-      shouldSyncWithRemote: boolean;
-    };
-  };
-  menu: {
-    enableSelectSingleCurrency: boolean;
-    enableSelectMultipleCurrency: boolean;
-    enableSelectDate: boolean;
-    enableSelectCategories: boolean;
-    enableSelectBankAccountIds: boolean;
-    enableSelectUnCategorized: boolean;
-  };
-};
-
-export type AccountBalancePanelComponent = {
-  type: PanelComponentType.ACCOUNT_BALANCE;
-  shouldDisplaySelectCurrency?: boolean;
-  shouldDisplaySelectBankAccounts?: boolean;
-};
-
-export type AccountCashPositionPanelComponent = {
-  type: PanelComponentType.ACCOUNT_CASH_POSITION;
-  shouldDisplayTable?: boolean;
-};
-
-export type SumPerCategoryPanelComponent = {
-  type: PanelComponentType.SUM_PER_CATEGORY;
-  shouldStack?: boolean;
-  shouldDisplayCountTransaction?: boolean;
-};
-
-export type SumPerCategoryPerMonthPanelComponent = {
-  type: PanelComponentType.SUM_PER_CATEGORY_PER_MONTH;
-  shouldStack?: boolean;
-  shouldDisplayTable?: boolean;
-  shouldDisplayCountTransaction?: boolean;
-  shouldGroupByCategoryByDefault?: boolean;
-  shouldDisplaySpeedUpByDefault?: boolean;
-};
-
-export type TransactionPerAccountPanelComponent = {
-  type: PanelComponentType.TRANSACTION_PER_ACCOUNT;
-};
-
-export type TransactionPerCategoryPanelComponent = {
-  type: PanelComponentType.TRANSACTION_PER_CATEGORY;
-  shouldDisplaySumTransaction?: boolean;
-};
-
-export type TransactionPerDayPanelComponent = {
-  type: PanelComponentType.TRANSACTION_PER_DAY;
-};
-
-export type TransactionTablePanelComponent = {
-  type: PanelComponentType.TRANSACTION_TABLE;
-};
-
-export type PeriodReportPanelComponent = {
-  type: PanelComponentType.PERIOD_REPORT;
-  shouldDisplaySelectBankAccounts?: boolean;
-};
-
-export type MonthlyReportPanelComponent = {
-  type: PanelComponentType.MONTHLY_REPORT;
-};

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

@@ -1,17 +0,0 @@
-import { IAccountTransaction } from './account-transaction.model';
-import { ICategorizationRule } from './categorization-rule.model';
-import { ICategory } from './category.model';
-
-export interface ITransactionCategory {
-  id?: string;
-  categoryId: string;
-  accountTransactionId: string;
-  categorizationRuleId: string | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  accountTransaction?: IAccountTransaction;
-  category?: ICategory;
-  categorizationRule?: ICategorizationRule | null;
-}

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

@@ -1,16 +0,0 @@
-import { IAggregatorLink } from './aggregator-link.model';
-import { ICategory } from './category.model';
-import { IPanel } from './panel.model';
-
-export interface IUser {
-  id?: string;
-  isAdmin: boolean;
-  apiKey: string;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Associations
-  aggregatorLink?: IAggregatorLink[];
-  panel?: IPanel[];
-  category?: ICategory[];
-}

package/src/utils/error.utils.ts

@@ -1,30 +0,0 @@
-import { Code, ErrorType } from '../types';
-
-type ErrorParams = { code: Code; type: ErrorType; message?: string };
-
-export class ServiceException extends Error {
-  private readonly code: Code;
-
-  private readonly type: ErrorType;
-
-  getCode(): Code {
-    return this.code;
-  }
-
-  getType(): ErrorType {
-    return this.type;
-  }
-
-  constructor(params: ErrorParams) {
-    super(params.message);
-    this.code = params.code;
-    this.type = params.type;
-  }
-}
-
-export const handleError = (error: Error | ErrorParams, _params?: ErrorParams): Error => {
-  if (error instanceof Error) {
-    return error;
-  }
-  return new ServiceException(error);
-};

package/src/utils/index.ts

@@ -1 +0,0 @@
-export * from './error.utils';