@abyss-project/banking 1.0.0 → 1.0.1

package/src/api/panel.admin.api.ts

@@ -1,57 +0,0 @@
-import {
-  AbyssBankingCore,
-  ICreatePanelAdminBody,
-  ICreatePanelAdminResponse,
-  IDeletePanelAdminParams,
-  IDeletePanelAdminResponse,
-  IGetPanelAdminParams,
-  IGetPanelAdminResponse,
-  IPaginatePanelAdminQuery,
-  IPaginatePanelAdminResponse,
-  IUpdatePanelAdminBody,
-  IUpdatePanelAdminParams,
-  IUpdatePanelAdminResponse,
-} from '..';
-
-export const getPanelAdmin = async (
-  params: IGetPanelAdminParams,
-): Promise<IGetPanelAdminResponse> => {
-  return (await AbyssBankingCore.axios.get<IGetPanelAdminResponse>(`panel/admin/${params.panelId}`))
-    .data;
-};
-
-export const paginatePanelAdmin = async (
-  query: IPaginatePanelAdminQuery,
-): Promise<IPaginatePanelAdminResponse> => {
-  return (
-    await AbyssBankingCore.axios.get<IPaginatePanelAdminResponse>(`panel/admin/paginate`, {
-      params: query,
-    })
-  ).data;
-};
-
-export const deletePanelAdmin = async (
-  params: IDeletePanelAdminParams,
-): Promise<IDeletePanelAdminResponse> => {
-  return (
-    await AbyssBankingCore.axios.delete<IDeletePanelAdminResponse>(`panel/admin/${params.panelId}`)
-  ).data;
-};
-
-export const createPanelAdmin = async (
-  body: ICreatePanelAdminBody,
-): Promise<ICreatePanelAdminResponse> => {
-  return (await AbyssBankingCore.axios.post<ICreatePanelAdminResponse>(`panel/admin`, body)).data;
-};
-
-export const updatePanelAdmin = async (
-  params: IUpdatePanelAdminParams,
-  body: IUpdatePanelAdminBody,
-): Promise<IUpdatePanelAdminResponse> => {
-  return (
-    await AbyssBankingCore.axios.put<IUpdatePanelAdminResponse>(
-      `panel/admin/${params.panelId}`,
-      body,
-    )
-  ).data;
-};

package/src/api/panel.api.ts

@@ -1,45 +0,0 @@
-import {
-  AbyssBankingCore,
-  ICreatePanelBody,
-  ICreatePanelResponse,
-  IDeletePanelParams,
-  IDeletePanelResponse,
-  IGetPanelParams,
-  IGetPanelResponse,
-  IPaginatePanelQuery,
-  IPaginatePanelResponse,
-  IUpdatePanelBody,
-  IUpdatePanelParams,
-  IUpdatePanelResponse,
-} from '..';
-
-export const getPanel = async (params: IGetPanelParams): Promise<IGetPanelResponse> => {
-  return (await AbyssBankingCore.axios.get<IGetPanelResponse>(`panel/${params.panelId}`)).data;
-};
-
-export const paginatePanel = async (
-  query: IPaginatePanelQuery,
-): Promise<IPaginatePanelResponse> => {
-  return (
-    await AbyssBankingCore.axios.get<IPaginatePanelResponse>(`panel/paginate`, {
-      params: query,
-    })
-  ).data;
-};
-
-export const deletePanel = async (params: IDeletePanelParams): Promise<IDeletePanelResponse> => {
-  return (await AbyssBankingCore.axios.delete<IDeletePanelResponse>(`panel/${params.panelId}`))
-    .data;
-};
-
-export const createPanel = async (body: ICreatePanelBody): Promise<ICreatePanelResponse> => {
-  return (await AbyssBankingCore.axios.post<ICreatePanelResponse>(`panel`, body)).data;
-};
-
-export const updatePanel = async (
-  params: IUpdatePanelParams,
-  body: IUpdatePanelBody,
-): Promise<IUpdatePanelResponse> => {
-  return (await AbyssBankingCore.axios.put<IUpdatePanelResponse>(`panel/${params.panelId}`, body))
-    .data;
-};

package/src/api/user.admin.api.ts

@@ -1,44 +0,0 @@
-import {
-  IGetUserAdminParams,
-  IGetUserAdminResponse,
-  IUpdateUserAdminParams,
-  IUpdateUserAdminResponse,
-  IUpdateUserAdminBody,
-  IPaginateUserAdminResponse,
-  IPaginateUserAdminQuery,
-  IResetApiKeyUserAdminResponse,
-  IResetApiKeyUserAdminParams,
-  AbyssBankingCore,
-} from '..';
-
-export const getUserAdmin = async (params: IGetUserAdminParams): Promise<IGetUserAdminResponse> => {
-  return (await AbyssBankingCore.axios.get<IGetUserAdminResponse>(`user/admin/${params.userId}`))
-    .data;
-};
-
-export const resetApiKeyUserAdmin = async (
-  params: IResetApiKeyUserAdminParams,
-): Promise<IResetApiKeyUserAdminResponse> => {
-  return (
-    await AbyssBankingCore.axios.post<IResetApiKeyUserAdminResponse>(`user/admin/${params.userId}`)
-  ).data;
-};
-
-export const paginateUserAdmin = async (
-  query: IPaginateUserAdminQuery,
-): Promise<IPaginateUserAdminResponse> => {
-  return (
-    await AbyssBankingCore.axios.get<IPaginateUserAdminResponse>(`user/admin/paginate`, {
-      params: query,
-    })
-  ).data;
-};
-
-export const updateUserAdmin = async (
-  params: IUpdateUserAdminParams,
-  body: IUpdateUserAdminBody,
-): Promise<IUpdateUserAdminResponse> => {
-  return (
-    await AbyssBankingCore.axios.put<IUpdateUserAdminResponse>(`user/admin/${params.userId}`, body)
-  ).data;
-};

package/src/api/user.api.ts

@@ -1,20 +0,0 @@
-import {
-  IMeUserResponse,
-  IUpdateUserBody,
-  IUpdateUserResponse,
-  IResetApiKeyUserResponse,
-  AbyssBankingCore,
-} from '..';
-
-export const meUser = async (): Promise<IMeUserResponse> => {
-  return (await AbyssBankingCore.axios.get<IMeUserResponse>(`user/me`)).data;
-};
-
-export const updateUser = async (body: IUpdateUserBody): Promise<IUpdateUserResponse> => {
-  return (await AbyssBankingCore.axios.put<IUpdateUserResponse>(`user/me`, body)).data;
-};
-
-export const resetApiKeyUser = async (): Promise<IResetApiKeyUserResponse> => {
-  return (await AbyssBankingCore.axios.post<IResetApiKeyUserResponse>(`user/me/reset-api-key`))
-    .data;
-};

package/src/index.ts

@@ -1,72 +0,0 @@
-import axios from 'axios';
-import axiosRetry, { IAxiosRetryConfig, isNetworkOrIdempotentRequestError } from 'axios-retry';
-
-export * from './types';
-export * from './utils';
-export * from './api';
-
-const DEFAULT_BASE_URL = 'https://banking-api.abyss-project.fr/api/';
-
-export const API_KEY_HEADER = 'abyss-banking-api-key';
-export const ADMIN_TOKEN_HEADER = 'abyss-admin-token';
-
-const NUMBER_RETRY_API = 10;
-const BASE_DELAY_BETWEEN_RETRY = 5000;
-const RETRY_CODES = [
-  502, // Note(Mehdi): Bad Gateway
-  503, // Note(Mehdi): Service Unavailable
-];
-
-type CoreConfig = {
-  token?: string;
-  apiKey?: string;
-  adminToken?: string;
-  baseURL?: string;
-};
-
-export class AbyssBankingCore {
-  private static config = {
-    token: '',
-    apiKey: '',
-    apiKeyApplication: '',
-    applicationId: '',
-    adminToken: '',
-    baseURL: DEFAULT_BASE_URL,
-  };
-  static axios = axios.create({ baseURL: `` });
-
-  public static enableAxiosRetry(axiosRetryConfig?: IAxiosRetryConfig): void {
-    axiosRetry(AbyssBankingCore.axios, {
-      retries: NUMBER_RETRY_API,
-      retryDelay: (retryCount) => retryCount * BASE_DELAY_BETWEEN_RETRY,
-      retryCondition: (error) =>
-        isNetworkOrIdempotentRequestError(error) ||
-        RETRY_CODES.includes(error.response?.status || 502),
-      ...axiosRetryConfig,
-    });
-  }
-
-  public static setConfig(config: CoreConfig): void {
-    AbyssBankingCore.config = { ...AbyssBankingCore.config, ...config };
-
-    if (config.baseURL) {
-      AbyssBankingCore.axios.defaults.baseURL = config.baseURL;
-    }
-
-    if (config.token) {
-      AbyssBankingCore.axios.defaults.headers.common.Authorization = `Bearer ${config.token}`;
-    }
-
-    if (config.apiKey) {
-      AbyssBankingCore.axios.defaults.headers.common[API_KEY_HEADER] = `${config.apiKey}`;
-    }
-
-    if (config.adminToken) {
-      AbyssBankingCore.axios.defaults.headers.common[ADMIN_TOKEN_HEADER] = `${config.adminToken}`;
-    }
-  }
-
-  public static getConfig(): CoreConfig {
-    return AbyssBankingCore.config;
-  }
-}

package/src/types/enum/aggregator-type.enum.ts

@@ -1,4 +0,0 @@
-export enum AggregatorType {
-  GOCARDLESS = 'GOCARDLESS',
-  DEMO_DATA_BANKING = 'DEMO_DATA_BANKING',
-}

package/src/types/enum/api-error.enum.ts

@@ -1,18 +0,0 @@
-export enum ErrorType {
-  apiError = 'api_error',
-  authError = 'authentication_error',
-  resourceError = 'resource_error',
-}
-
-export enum Code {
-  // HTTP Error
-  tokenFailure = 'token_authentication_failure',
-  authenticationFailure = 'authentication_credentials_failure',
-  accessNotAllowed = 'access_not_allowed',
-  notFound = 'not_found',
-  validationError = 'resource_validation_error',
-  constraintError = 'resource_constraint_error',
-  internalServerError = 'internal_server_error',
-  serviceUnavailable = 'service_unavailable',
-  invalidData = 'invalid_data',
-}

package/src/types/enum/bank-connection-status.enum.ts

@@ -1,6 +0,0 @@
-export enum BankConnectionStatus {
-  PENDING = 'PENDING',
-  FAILED = 'FAILED',
-  SUCCESS = 'SUCCESS',
-  EXPIRED = 'EXPIRED',
-}

package/src/types/enum/cash-account-type.enum.ts

@@ -1,54 +0,0 @@
-/**
-  External code sets can be downloaded from www.iso20022.org.
-
-    CACC Account used to post debits and credits when no specific account has been nominated.
-    CARD Account used for credit card payments.
-    CASH Account used for the payment of cash.
-    CHAR Account used for charges if different from the account for payment.
-    CISH Account used for payment of income if different from the current cash account
-    COMM Account used for commission if different from the account for payment.
-    CPAC Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
-    LLSV Account used for savings with special interest and withdrawal terms.  
-    LOAN Account used for loans.
-    MGLD Account used for a marginal lending facility.
-    MOMA Account used for money markets if different from the cash account.
-    NREX Account used for non-resident external.
-    ODFT Account is used for overdrafts.
-    ONDP Account used for overnight deposits.
-    OTHR Account not otherwise specified. 
-    SACC Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
-    SLRY Accounts used for salary payments.
-    SVGS Account used for savings.
-    TAXE Account used for taxes if different from the account for payment.
-    TRAN A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
-    TRAS Account used for trading if different from the current cash account.
-    VACC Account created virtually to facilitate collection and reconciliation.
-    NFCA Non-Resident Individual / Entity Foreign Current held domestically.
- */
-
-export enum CashAccountType {
-  'CACC' = 'CACC',
-  'CARD' = 'CARD',
-  'CASH' = 'CASH',
-  'CHAR' = 'CHAR',
-  'CISH' = 'CISH',
-  'COMM' = 'COMM',
-  'CPAC' = 'CPAC',
-  'LLSV' = 'LLSV',
-  'LOAN' = 'LOAN',
-  'MGLD' = 'MGLD',
-  'MOMA' = 'MOMA',
-  'NREX' = 'NREX',
-  'ODFT' = 'ODFT',
-  'ONDP' = 'ONDP',
-  'OTHR' = 'OTHR',
-  'SACC' = 'SACC',
-  'SLRY' = 'SLRY',
-  'SVGS' = 'SVGS',
-  'TAXE' = 'TAXE',
-  'TRAN' = 'TRAN',
-  'TRAS' = 'TRAS',
-  'VACC' = 'VACC',
-  'NFCA' = 'NFCA',
-  'UNKNOWN' = 'UNKNOWN',
-}

package/src/types/enum/index.ts

@@ -1,7 +0,0 @@
-export * from './api-error.enum';
-
-export * from './aggregator-type.enum';
-export * from './bank-connection-status.enum';
-export * from './cash-account-type.enum';
-export * from './period-configuration.enum';
-export * from './panel-component-type.enum';

package/src/types/enum/panel-component-type.enum.ts

@@ -1,12 +0,0 @@
-export enum PanelComponentType {
-  ACCOUNT_BALANCE = 'ACCOUNT_BALANCE',
-  ACCOUNT_CASH_POSITION = 'ACCOUNT_CASH_POSITION',
-  SUM_PER_CATEGORY = 'SUM_PER_CATEGORY',
-  SUM_PER_CATEGORY_PER_MONTH = 'SUM_PER_CATEGORY_PER_MONTH',
-  TRANSACTION_PER_ACCOUNT = 'TRANSACTION_PER_ACCOUNT',
-  TRANSACTION_PER_CATEGORY = 'TRANSACTION_PER_CATEGORY',
-  TRANSACTION_PER_DAY = 'TRANSACTION_PER_DAY',
-  TRANSACTION_TABLE = 'TRANSACTION_TABLE',
-  PERIOD_REPORT = 'PERIOD_REPORT',
-  MONTHLY_REPORT = 'MONTHLY_REPORT',
-}

package/src/types/enum/period-configuration.enum.ts

@@ -1,7 +0,0 @@
-export enum PeriodConfiguration {
-  LAST_7_DAYS = 'LAST_7_DAYS',
-  LAST_30_DAYS = 'LAST_30_DAYS',
-  LAST_60_DAYS = 'LAST_60_DAYS',
-  SINCE_START_OF_MONTH = 'SINCE_START_OF_MONTH',
-  SINCE_START_OF_YEAR = 'SINCE_START_OF_YEAR',
-}

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export * from './enum';
-export * from './interface';

package/src/types/interface/api/index.ts

@@ -1,29 +0,0 @@
-export * from './type-message/api-error';
-export * from './type-message/response';
-export * from './type-message/base-order';
-export * from './type-message/base-paginate';
-
-export * from './requests/abyss.admin.request';
-export * from './requests/user.admin.request';
-export * from './requests/user.request';
-export * from './requests/banking.request';
-export * from './requests/category.request';
-export * from './requests/category.admin.request';
-export * from './requests/banking.admin.request';
-export * from './requests/categorization-rule.request';
-export * from './requests/categorization-rule.admin.request';
-export * from './requests/panel.request';
-export * from './requests/panel.admin.request';
-
-export * from './responses/abyss.admin.response';
-export * from './responses/monitor.response';
-export * from './responses/user.admin.response';
-export * from './responses/user.response';
-export * from './responses/banking.response';
-export * from './responses/category.response';
-export * from './responses/category.admin.response';
-export * from './responses/banking.admin.response';
-export * from './responses/categorization-rule.response';
-export * from './responses/categorization-rule.admin.response';
-export * from './responses/panel.response';
-export * from './responses/panel.admin.response';

package/src/types/interface/api/requests/abyss.admin.request.ts

@@ -1,3 +0,0 @@
-export interface IActivateUserServiceAbyssAdminBody {
-  userId: string;
-}

package/src/types/interface/api/requests/banking.admin.request.ts

@@ -1,57 +0,0 @@
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export type IListInstitutionBankingAdminQuery = {
-  countryCode: string;
-};
-
-export interface IConfirmRequisitionBankingAdminParams {
-  userId: string;
-  reference: string;
-}
-
-export interface IListBankConnectionBankingAdminParams {
-  userId: string;
-}
-
-export interface IGetBankConnectionBankingAdminParams {
-  bankConnectionId: string;
-}
-
-export interface IGetAccountTransactionBankingAdminParams {
-  accountTransactionId: string;
-}
-
-export interface IUpdateAccountTransactionBankingAdminParams {
-  accountTransactionId: string;
-}
-export interface IUpdateAccountTransactionBankingAdminBody {
-  comment?: string;
-}
-
-export type IPaginateAccountTransactionBankingAdminQuery = {
-  description?: string;
-  currency?: string;
-  bankAccountId: string[];
-  categoryId?: string[];
-  before?: Date;
-  after?: Date;
-  onlyWithoutCategories?: boolean;
-  categorizationRuleId?: string;
-  order?: 'ASC' | 'DESC';
-} & QueryPaginate;
-
-export interface IUpdateBankAccountBankingAdminParams {
-  bankAccountId: string;
-}
-export interface IUpdateBankAccountBankingAdminBody {
-  isMasked?: boolean;
-  color?: string;
-}
-
-export interface ILoadDemoDataBankingAdminParams {
-  userId: string;
-}
-
-export interface IDeleteDemoDataBankingAdminParams {
-  userId: string;
-}

package/src/types/interface/api/requests/banking.request.ts

@@ -1,89 +0,0 @@
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export interface ICreateRequisitionBankingBody {
-  institutionId: string;
-  redirectUrl: string;
-}
-
-export interface IRenewRequisitionBankingParams {
-  bankConnectionId: string;
-}
-export interface IRenewRequisitionBankingBody {
-  redirectUrl: string;
-}
-
-export type IListInstitutionBankingQuery = {
-  countryCode: string;
-};
-
-export interface IConfirmRequisitionBankingParams {
-  reference: string;
-}
-
-export interface IGetBankConnectionBankingParams {
-  bankConnectionId: string;
-}
-
-export interface IGetAccountTransactionBankingParams {
-  accountTransactionId: string;
-}
-
-export interface IUpdateAccountTransactionBankingParams {
-  accountTransactionId: string;
-}
-export interface IUpdateAccountTransactionBankingBody {
-  comment?: string;
-}
-
-export type IPaginateAccountTransactionBankingQuery = {
-  description?: string;
-  currency?: string;
-  bankAccountId?: string[];
-  categoryId?: string[];
-  before?: Date;
-  after?: Date;
-  onlyWithoutCategories?: boolean;
-  categorizationRuleId?: string;
-  order?: 'ASC' | 'DESC';
-} & QueryPaginate;
-
-export interface IUpdateBankAccountBankingParams {
-  bankAccountId: string;
-}
-export interface IUpdateBankAccountBankingBody {
-  isMasked?: boolean;
-  color?: string;
-  commonName?: string | null;
-}
-
-export interface IGetTransactionPerCategoryBankingQuery {
-  bankAccountId?: string[];
-  before?: Date;
-  after?: Date;
-}
-
-export interface IGetSumTransactionPerBankAccountPerCategoryQuery {
-  bankAccountId: string[];
-  before?: Date;
-  after?: Date;
-}
-
-export interface IGetSumTransactionPerBankAccountPerCategoryPerMonthQuery {
-  bankAccountId?: string[];
-  before?: Date;
-  after?: Date;
-}
-
-export type IPaginateBankAccountHistoryBankingQuery = {
-  bankAccountId?: string[];
-  before?: Date;
-  after?: Date;
-  order?: 'ASC' | 'DESC';
-} & QueryPaginate;
-
-export type IListBankAccountHistoryBankingQuery = {
-  bankAccountId?: string[];
-  before?: Date;
-  after?: Date;
-  order?: 'ASC' | 'DESC';
-};

package/src/types/interface/api/requests/categorization-rule.admin.request.ts

@@ -1,40 +0,0 @@
-import { CategorizationRules } from '../../models/categorization-rule.model';
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export type IPaginateCategorizationRuleAdminQuery = {
-  isActive?: boolean;
-  userId?: string;
-  name?: string;
-} & QueryPaginate;
-
-export interface IGetCategorizationRuleAdminParams {
-  categorizationRuleId: string;
-}
-
-export interface IDeleteCategorizationRuleAdminParams {
-  categorizationRuleId: string;
-}
-
-export interface ICreateCategorizationRuleAdminBody {
-  userId: string;
-  name: string;
-  description: string | null;
-  rules: CategorizationRules[];
-  isActive: boolean;
-  categoryIds: string[];
-}
-
-export interface IUpdateCategorizationRuleAdminParams {
-  categorizationRuleId: string;
-}
-export interface IUpdateCategorizationRuleAdminBody {
-  name?: string;
-  description?: string | null;
-  rules?: CategorizationRules[];
-  isActive?: boolean;
-  categoryIds?: string[];
-}
-
-export interface IApplyCategorizationRuleAdminParams {
-  categorizationRuleId: string;
-}

package/src/types/interface/api/requests/categorization-rule.request.ts

@@ -1,38 +0,0 @@
-import { CategorizationRules } from '../../models/categorization-rule.model';
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export type IPaginateCategorizationRuleQuery = {
-  name?: string;
-  isActive?: boolean;
-} & QueryPaginate;
-
-export interface IGetCategorizationRuleParams {
-  categorizationRuleId: string;
-}
-
-export interface IDeleteCategorizationRuleParams {
-  categorizationRuleId: string;
-}
-
-export interface IApplyCategorizationRuleParams {
-  categorizationRuleId: string;
-}
-
-export interface ICreateCategorizationRuleBody {
-  name: string;
-  description: string | null;
-  rules: CategorizationRules[];
-  isActive: boolean;
-  categoryIds: string[];
-}
-
-export interface IUpdateCategorizationRuleParams {
-  categorizationRuleId: string;
-}
-export interface IUpdateCategorizationRuleBody {
-  name?: string;
-  description?: string | null;
-  rules?: CategorizationRules[];
-  isActive?: boolean;
-  categoryIds?: string[];
-}

package/src/types/interface/api/requests/category.admin.request.ts

@@ -1,27 +0,0 @@
-import { QueryPaginate } from '..';
-
-export interface IDeleteCategoryAdminParams {
-  categoryId: string;
-}
-
-export interface ICreateCategoryAdminBody {
-  userId: string;
-  name: string;
-  color: string;
-}
-
-export interface IUpdateCategoryAdminParams {
-  categoryId: string;
-}
-export interface IUpdateCategoryAdminBody {
-  name?: string;
-  color?: string;
-}
-
-export type IPaginateCategoryAdminQuery = {
-  userId?: string;
-} & QueryPaginate;
-
-export interface IGetCategoryAdminParams {
-  categoryId: string;
-}

package/src/types/interface/api/requests/category.request.ts

@@ -1,31 +0,0 @@
-export interface IRemoveCategoryParams {
-  transactionCategoryId: string;
-}
-
-export interface IAddCategoryParams {
-  categoryId: string;
-  accountTransactionId: string;
-}
-
-export interface IDeleteCategoryParams {
-  categoryId: string;
-}
-
-export interface ICreateCategoryBody {
-  name: string;
-  color: string;
-}
-
-export interface IUpdateCategoryParams {
-  categoryId: string;
-}
-export interface IUpdateCategoryBody {
-  name?: string;
-  color?: string;
-}
-
-export interface IListAnalyticsCategoryQuery {
-  bankAccountId?: string[];
-  before?: Date;
-  after?: Date;
-}