creditu-common-library 2.3.7-beta.0 → 2.3.7

package/.eslintrc.js

@@ -0,0 +1,60 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: 'module'
+  },
+  plugins: [
+    '@typescript-eslint',
+    '@typescript-eslint/eslint-plugin'
+  ],
+  extends: ['airbnb-base'],
+  root: true,
+  env: {
+    node: true,
+    es2021: true,
+    jest: true
+  },
+  rules: {
+    '@typescript-eslint/member-delimiter-style': [
+      'error', { multiline: { delimiter: 'semi', requireLast: true } }
+    ],
+    '@typescript-eslint/type-annotation-spacing': ['error', { before: false, after: true }],
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/indent': ['error', 2],
+    '@typescript-eslint/no-unused-vars': ['error'],
+    '@typescript-eslint/space-infix-ops': ['error'],
+    'no-useless-constructor': 'off',
+    'no-empty-function': 'off',
+    'no-shadow': 'off',
+    'import/prefer-default-export': 'off',
+    'import/extensions': ['error', 'never', { ignorePackages: true }],
+    'object-curly-newline': ['error', { consistent: true }],
+    'object-property-newline': ['error', { allowAllPropertiesOnSameLine: true }],
+    'arrow-parens': ['error', 'as-needed'],
+    'array-bracket-spacing': ['error'],
+    'no-trailing-spaces': 'error',
+    'semi-spacing': 'error',
+    'max-len': ['error', { code: 150 }],
+    'space-before-function-paren': [
+      'error', { anonymous: 'never', named: 'never', asyncArrow: 'always' }
+    ],
+    'arrow-spacing': ['error'],
+    'key-spacing': 'error',
+    'space-in-parens': 'error',
+    'no-spaced-func': 'error',
+    'keyword-spacing': 'error',
+    'comma-spacing': ['error', { before: false, after: true }],
+    'comma-dangle': ['error', 'never'],
+    'no-console': ['error'],
+    'no-underscore-dangle': ['error', { allow: ['_value'] }],
+    quotes: ['error', 'single', { avoidEscape: true }],
+    'class-methods-use-this': 'off'
+  },
+  settings: {
+    'import/resolver': {
+      node: { extensions: ['.js', '.ts'] }
+    }
+  }
+};

package/README.md

@@ -0,0 +1,121 @@
+# Creditú CommonLibrary
+
+## Descripción
+Esta librería, contiene los módulos y funciones matemáticas y financerias para el manejo de cálculos en el producto digital.
+
+## Instalar en tu repositorio
+
+```shell
+npm i creditu-common-library
+```
+
+## Uso en tu repositorio
+La librería tiene dos módulos:
+
+- `Math`: expone el service `MathService`, que tiene funciones para realizar operaciones matemáticas básicas:
+  - add: (Suma) `add = (...numbers: number[]): number`
+  - substract: (Resta) `subtract = (...numbers: number[]): number`
+  - multiply: (Multiplicación) `multiply = (...numbers: number[]): number`
+  - divide: (División) `divide = (...numbers: number[]): number`
+  - round: (Redondeo) `round = (num: number, resolution: number): number`
+
+- `Finance`: expone varios servicios orientados a un dominio específico, y cuyas funciones resuelven diversas fórmulas financieras en su ámbito.
+Los services expuestos son:
+  - `ConstantsService`: es un servicio auxiliar, que contiene funciones que calculan constantes que, a su vez, agrupan parametros conocidos para diversos propósitos en cálculos financieros.
+  - `CreditInsuranceService`: este servicio tiene funciones de cálculo para el dominio `Seguros`.
+  - `FinanceService`: este servicio auxiliar tiene funciones genéricas de funciones financieras, como interés anual, mensual, etc.
+  - `PaymentService`: este servicio tiene funciones de cálculo para el dominio `Dividendo`.
+  - `LoanToValueService`: este servicio tiene funciones de cálculo para el dominio `LTV`.
+  - `MaximumLocalService`: este servicio tiene funciones de cálculo para el dominio `Máximos Locales`.
+  - `OfferService`: este servicio tiene funciones de cálculo para el dominio `Oferta`.
+  - `OperationalExpensesService`: este servicio tiene funciones de cálculo para el dominio `Gastos Operacionales`.
+
+Además, existen models que sirven de apoyo para estandarizar los parámetros de algunas funciones.
+
+
+Para más información sobre las funciones, sus usos, parámetros de entrada y salida, puedes revisar cada servicio y su comentario expecífico.
+La mayoría de estas funciones, tienen una definición matemática asociada. Encontrarás un link con esa definición junto con cada función.
+
+## Uso de módulos y servicios en tu repositorio
+
+### Módulo Math:
+```shell
+import { MathService } from 'creditu-common-library/math';
+...
+const mathService = new MathService(true, 10);
+...
+const result = mathService.add(1,2);
+...
+```
+
+### Módulo Finance:
+
+Services:
+```shell
+import { OfferService } from 'creditu-common-library/finance/services';
+```
+
+Models:
+```shell
+import { OfferInputs } from 'creditu-common-library/finance/models';
+```
+
+Functions:
+```shell
+...
+import { OfferService } from 'creditu-common-library/finance/services';
+import { OfferInputs } from 'creditu-common-library/finance/models';
+import { OfferParams } from 'creditu-common-library/finance/models';
+
+...
+private offerService: OfferService;
+
+...
+const offerInputs: OfferInputs = ...
+const offerParams: OfferParams = ...
+const result = this.offerService.calculateCreditAmountToOffer(offerInputs, offerParams);
+
+...
+```
+
+## Desarrollo local
+1. Crea un **symlink** global para una dependencia con `npm link`.
+2. Hazle saber al proyecto donde probarás tu paquete que use el enlace simbólico global con `npm link creditu-common-library`.
+
+### Uso
+Entonces en el directorio del paquete en desarrollo creditu-common-library ejecutaremos.
+
+```shell
+$ npm link  # paso 1
+```
+
+Luego en el directorio del proyecto donde probarás el paquete:
+```shell
+npm link creditu-common-library # paso 2
+```
+### Trouble shouting
+> En caso de problemas, 
+> - Verificar que la version de node debe ser la misma que el enlace creado en el proyecto utilizado.
+> - Para crear el enlace simbólico copiar el archivo `package.json` en el directorio `lib`, y en este ejecutar `npm link`.
+
+Ahora puedes editar, transpilar o ejecutar pruebas en creditu-common-library.
+Todo mientras lo pruebas en un proyecto real. Los enlaces simbólicos son locales y no serás commiteados en git.
+Y cuando estés listo para compartir tu código, puedes publicar los cambios de creditu-common-library en un registry npm.
+
+### De vuelta a la normalidad
+Cuando ya no desees utilizar la versión local de creditu-common-library, elimina el enlace simbólico.
+Pero cuidado, npm unlink es un alias para la desinstalación de npm (npm uninstall),
+no refleja el comportamiento de npm link.
+
+Por eso en el directorio del proyecto donde estabas probando el paquete:
+```shell
+npm unlink --no-save creditu-common-library && npm install
+```
+
+Luego puedes limpiar el enlace global, aunque su presencia no interferirá con nada.
+En el directorio del paquete en desarollo:
+
+```shell
+npm unlink  # elimina el symlink
+```
+

package/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+};

package/jest.config-functional.ts

@@ -0,0 +1,199 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number.
+  // E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: [
+    'js',
+    //   "json",
+    //   "jsx",
+    'ts'
+  //   "tsx",
+  //   "node"
+  ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  restoreMocks: true,
+
+  // The root directory that Jest should scan for tests and modules within
+  rootDir: './test',
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'node',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  testRegex: [
+    '.spec.ts$'
+  ],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest'
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+
+  testTimeout: 10000
+};
+export default config;

package/jest.config.ts

@@ -0,0 +1,210 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80
+    }
+  },
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests.
+  // Can be specified as % or a number.
+  // E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number.
+  // maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: [
+    'js',
+    'json',
+    //   "jsx",
+    'ts'
+    //   "tsx",
+    //   "node"
+  ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  modulePathIgnorePatterns: [
+    'test'
+  ],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  restoreMocks: true,
+
+  // The root directory that Jest should scan for tests and modules within
+  rootDir: '.',
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'node',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  testRegex: [
+    '.spec.ts$'
+  ],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '^.+\\.(t|j)s$': 'ts-jest'
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+
+  testTimeout: 10000
+};
+export default config;

package/offer/services/installment.service.js

@@ -92,10 +92,10 @@ var InstallmentService = /** @class */ (function () {
         var appliedInterest = this.finance.applyCompoundInterest(1, monthlyInterestRate, numberOfPeriods);
         var adjustment = this.math.divide(1, appliedInterest);
         var divisor = this.math.subtract(1, adjustment);
-        var factor = this.math.divide(monthlyInterestRate, divisor);
         if (monthlyInterestRate === 0) {
             return this.math.divide(baseBalance, numberOfPeriods);
         }
+        var factor = this.math.divide(monthlyInterestRate, divisor);
         return this.math.multiply(baseBalance, factor);
     };
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "creditu-common-library",
-  "version": "2.3.7-beta.0",
+  "version": "2.3.7",
   "description": "Common library for Creditu applications",
   "main": "lib/index.js",
   "files": [