@abyss-project/banking 1.0.0

package/dist/types/interface/models/aggregator-bank.model.d.ts

@@ -0,0 +1,12 @@
+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;
+}

package/dist/types/interface/models/aggregator-bank.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/aggregator-link.model.d.ts

@@ -0,0 +1,12 @@
+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;
+    user?: IUser;
+    bankConnection?: IBankConnection[];
+}

package/dist/types/interface/models/aggregator-link.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/types/interface/models/bank-account-history.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/bank-account-transaction.model.d.ts

@@ -0,0 +1,14 @@
+import { IBankAccount } from './bank-account.model';
+export interface IBankAccountTransaction {
+    id?: string;
+    date: Date;
+    amount: number;
+    currency: string;
+    description: string;
+    comment: string | null;
+    aggregatorTransactionId: string;
+    bankAccountId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    bankAccount?: IBankAccount;
+}

package/dist/types/interface/models/bank-account-transaction.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/bank-account.model.d.ts

@@ -0,0 +1,26 @@
+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;
+    bankConnection?: IBankConnection;
+    accountTransaction?: IAccountTransaction[];
+    bankAccountHistory?: IBankAccountHistory[];
+}

package/dist/types/interface/models/bank-account.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/bank-connection.model.d.ts

@@ -0,0 +1,17 @@
+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;
+    aggregatorLinkId: string;
+    status: BankConnectionStatus;
+    lastRefresh: Date | null;
+    confirmedAt: Date | null;
+    updatedAt?: Date;
+    createdAt?: Date;
+    aggregatorLink?: IAggregatorLink;
+    bankAccount?: IBankAccount[];
+}

package/dist/types/interface/models/bank-connection.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/types/interface/models/categorization-rule-category.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/categorization-rule.model.d.ts

@@ -0,0 +1,44 @@
+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[];
+    userId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    deletedAt?: Date;
+    user?: IUser;
+    transactionCategory?: ITransactionCategory[];
+    category?: ICategory[];
+    categorizationRuleCategory?: ICategorizationRuleCategory[];
+}
+export declare 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;
+        dayOfWeek?: number[] | null;
+        month?: number[] | null;
+        year?: number[] | null;
+    };
+};

package/dist/types/interface/models/categorization-rule.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/category.model.d.ts

@@ -0,0 +1,14 @@
+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;
+    user?: IUser;
+    transactionCategory?: ITransactionCategory[];
+    categorizationRule?: ICategorizationRule[];
+}

package/dist/types/interface/models/category.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/panel.model.d.ts

@@ -0,0 +1,108 @@
+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;
+    user?: IUser;
+}
+export declare type PanelComposition = {
+    shouldIncludeHeaderCards: boolean;
+    config: PanelComponentConfig;
+    elements: {
+        id: string;
+        title?: string;
+        config: PanelComponentConfig;
+        components: PanelComponent[];
+        layout: {
+            width: number;
+        };
+    }[];
+};
+export declare type PanelComponent = {
+    id: string;
+    config: PanelComponentConfig;
+    title?: string;
+    layout: {
+        width: number;
+    };
+} & (AccountBalancePanelComponent | AccountCashPositionPanelComponent | SumPerCategoryPanelComponent | SumPerCategoryPerMonthPanelComponent | TransactionPerAccountPanelComponent | TransactionPerCategoryPanelComponent | TransactionPerDayPanelComponent | TransactionTablePanelComponent | PeriodReportPanelComponent | MonthlyReportPanelComponent);
+export declare 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 declare type AccountBalancePanelComponent = {
+    type: PanelComponentType.ACCOUNT_BALANCE;
+    shouldDisplaySelectCurrency?: boolean;
+    shouldDisplaySelectBankAccounts?: boolean;
+};
+export declare type AccountCashPositionPanelComponent = {
+    type: PanelComponentType.ACCOUNT_CASH_POSITION;
+    shouldDisplayTable?: boolean;
+};
+export declare type SumPerCategoryPanelComponent = {
+    type: PanelComponentType.SUM_PER_CATEGORY;
+    shouldStack?: boolean;
+    shouldDisplayCountTransaction?: boolean;
+};
+export declare type SumPerCategoryPerMonthPanelComponent = {
+    type: PanelComponentType.SUM_PER_CATEGORY_PER_MONTH;
+    shouldStack?: boolean;
+    shouldDisplayTable?: boolean;
+    shouldDisplayCountTransaction?: boolean;
+    shouldGroupByCategoryByDefault?: boolean;
+    shouldDisplaySpeedUpByDefault?: boolean;
+};
+export declare type TransactionPerAccountPanelComponent = {
+    type: PanelComponentType.TRANSACTION_PER_ACCOUNT;
+};
+export declare type TransactionPerCategoryPanelComponent = {
+    type: PanelComponentType.TRANSACTION_PER_CATEGORY;
+    shouldDisplaySumTransaction?: boolean;
+};
+export declare type TransactionPerDayPanelComponent = {
+    type: PanelComponentType.TRANSACTION_PER_DAY;
+};
+export declare type TransactionTablePanelComponent = {
+    type: PanelComponentType.TRANSACTION_TABLE;
+};
+export declare type PeriodReportPanelComponent = {
+    type: PanelComponentType.PERIOD_REPORT;
+    shouldDisplaySelectBankAccounts?: boolean;
+};
+export declare type MonthlyReportPanelComponent = {
+    type: PanelComponentType.MONTHLY_REPORT;
+};

package/dist/types/interface/models/panel.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/transaction-category.model.d.ts

@@ -0,0 +1,14 @@
+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;
+    accountTransaction?: IAccountTransaction;
+    category?: ICategory;
+    categorizationRule?: ICategorizationRule | null;
+}

package/dist/types/interface/models/transaction-category.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/user.model.d.ts

@@ -0,0 +1,13 @@
+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;
+    aggregatorLink?: IAggregatorLink[];
+    panel?: IPanel[];
+    category?: ICategory[];
+}

package/dist/types/interface/models/user.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/error.utils.d.ts

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

package/dist/utils/error.utils.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = exports.ServiceException = void 0;
+class ServiceException extends Error {
+    constructor(params) {
+        super(params.message);
+        this.code = params.code;
+        this.type = params.type;
+    }
+    getCode() {
+        return this.code;
+    }
+    getType() {
+        return this.type;
+    }
+}
+exports.ServiceException = ServiceException;
+const handleError = (error, _params) => {
+    if (error instanceof Error) {
+        return error;
+    }
+    return new ServiceException(error);
+};
+exports.handleError = handleError;

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./error.utils"), exports);

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@abyss-project/banking",
+  "version": "1.0.0",
+  "description": "Core package to interact with Abyss-Banking",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [],
+  "author": "scylla",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitlab.com/abyss-group/abyss-banking"
+  },
+  "homepage": "https://gitlab.com/abyss-group/abyss-banking",
+  "dependencies": {
+    "@googlemaps/google-maps-services-js": "^3.4.0",
+    "axios": "^1.2.2",
+    "axios-retry": "^3.5.0",
+    "core-js": "^3.37.1",
+    "dayjs": "^1.10.8",
+    "form-data": "^4.0.0",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/express-serve-static-core": "^4.17.31",
+    "@types/node": "^17.0.4",
+    "@types/uuid": "^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^4.27.0",
+    "@typescript-eslint/parser": "^4.27.0",
+    "eslint": "^7.28.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-filenames-simple": "^0.7.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "prettier": "2.3.1",
+    "sequelize-cli": "^6.2.0",
+    "typescript": "^4.1.5"
+  },
+  "scripts": {
+    "lint": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --fix",
+    "lint:check": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --max-warnings 0",
+    "tsc": "tsc",
+    "build": "tsc",
+    "prepublish": "tsc"
+  }
+}

package/src/api/abyss.admin.api.ts

@@ -0,0 +1,16 @@
+import {
+  AbyssBankingCore,
+  IActivateUserServiceAbyssAdminBody,
+  IActivateUserServiceAbyssAdminResponse,
+} from '..';
+
+export const activateUserServiceAbyssAdmin = async (
+  body: IActivateUserServiceAbyssAdminBody,
+): Promise<IActivateUserServiceAbyssAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.post<IActivateUserServiceAbyssAdminResponse>(
+      `abyss/admin/user/activate-service`,
+      body,
+    )
+  ).data;
+};

package/src/api/banking.admin.api.ts

@@ -0,0 +1,141 @@
+import {
+  AbyssBankingCore,
+  IConfirmRequisitionBankingAdminParams,
+  IConfirmRequisitionBankingAdminResponse,
+  IListInstitutionBankingAdminResponse,
+  IListInstitutionBankingAdminQuery,
+  IListBankConnectionBankingAdminResponse,
+  IListBankBankingAdminResponse,
+  IGetBankConnectionBankingAdminResponse,
+  IGetBankConnectionBankingAdminParams,
+  IPaginateAccountTransactionBankingAdminQuery,
+  IPaginateAccountTransactionBankingAdminResponse,
+  IGetAccountTransactionBankingAdminParams,
+  IGetAccountTransactionBankingAdminResponse,
+  IUpdateBankAccountBankingAdminParams,
+  IUpdateBankAccountBankingAdminBody,
+  IUpdateBankAccountBankingAdminResponse,
+  ILoadDemoDataBankingAdminResponse,
+  IDeleteDemoDataBankingAdminResponse,
+  IListBankConnectionBankingAdminParams,
+  ILoadDemoDataBankingAdminParams,
+  IDeleteDemoDataBankingAdminParams,
+  IUpdateAccountTransactionBankingAdminParams,
+  IUpdateAccountTransactionBankingAdminBody,
+} from '..';
+
+export const listBankConnectionBankingAdmin = async (
+  params: IListBankConnectionBankingAdminParams,
+): Promise<IListBankConnectionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.get<IListBankConnectionBankingAdminResponse>(
+      `banking/admin/connection/${params.userId}/list`,
+    )
+  ).data;
+};
+
+export const getBankConnectionBankingAdmin = async (
+  params: IGetBankConnectionBankingAdminParams,
+): Promise<IGetBankConnectionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.get<IGetBankConnectionBankingAdminResponse>(
+      `banking/admin/connection/${params.bankConnectionId}`,
+    )
+  ).data;
+};
+
+export const listBankBankingAdmin = async (): Promise<IListBankBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.get<IListBankBankingAdminResponse>(`banking/admin/bank/list`)
+  ).data;
+};
+
+export const listInstitutionBankingAdmin = async (
+  query: IListInstitutionBankingAdminQuery,
+): Promise<IListInstitutionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.get<IListInstitutionBankingAdminResponse>(
+      `banking/admin/institution/list`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const confirmRequisitionBankingAdmin = async (
+  params: IConfirmRequisitionBankingAdminParams,
+): Promise<IConfirmRequisitionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.post<IConfirmRequisitionBankingAdminResponse>(
+      `banking/admin/requisition/confirm/${params.userId}/${params.reference}`,
+    )
+  ).data;
+};
+
+export const paginateAccountTransactionBankingAdmin = async (
+  query: IPaginateAccountTransactionBankingAdminQuery,
+): Promise<IPaginateAccountTransactionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.get<IPaginateAccountTransactionBankingAdminResponse>(
+      `banking/admin/transaction/paginate`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const getAccountTransactionBankingAdmin = async (
+  params: IGetAccountTransactionBankingAdminParams,
+): Promise<IGetAccountTransactionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.get<IGetAccountTransactionBankingAdminResponse>(
+      `banking/admin/transaction/${params.accountTransactionId}`,
+    )
+  ).data;
+};
+
+export const updateAccountTransactionBankingAdmin = async (
+  params: IUpdateAccountTransactionBankingAdminParams,
+  body: IUpdateAccountTransactionBankingAdminBody,
+): Promise<IGetAccountTransactionBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.put<IGetAccountTransactionBankingAdminResponse>(
+      `banking/admin/transaction/${params.accountTransactionId}`,
+      body,
+    )
+  ).data;
+};
+
+export const updateBankAccountBankingAdmin = async (
+  params: IUpdateBankAccountBankingAdminParams,
+  body: IUpdateBankAccountBankingAdminBody,
+): Promise<IUpdateBankAccountBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.put<IUpdateBankAccountBankingAdminResponse>(
+      `banking/admin/account/${params.bankAccountId}`,
+      body,
+    )
+  ).data;
+};
+
+export const loadDemoDataBankingAdmin = async (
+  params: ILoadDemoDataBankingAdminParams,
+): Promise<ILoadDemoDataBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.post<ILoadDemoDataBankingAdminResponse>(
+      `banking/admin/demo-data/${params.userId}`,
+    )
+  ).data;
+};
+
+export const deleteDemoDataBankingAdmin = async (
+  params: IDeleteDemoDataBankingAdminParams,
+): Promise<IDeleteDemoDataBankingAdminResponse> => {
+  return (
+    await AbyssBankingCore.axios.delete<IDeleteDemoDataBankingAdminResponse>(
+      `banking/admin/demo-data/${params.userId}`,
+    )
+  ).data;
+};
+
+export const fetchBankingDataBankingAdmin = async (): Promise<string> => {
+  return (await AbyssBankingCore.axios.post<string>(`banking/admin/fetch-banking-data`)).data;
+};