@corabank/shared-lib

v1.24.0

Published

Shared lib for Cora Web Apps

Downloads

923

Readme

Cora Logo

Shared Lib

NPM JavaScript Style Guide

Shared Lib for Cora Web Apps

Install

npm install --save @corabank/shared-lib

Iniciar Projeto

Instalar dependências

npm i

Iniciar projeto para desenvolvimento

npm start

Obs: Utilize npm link para testes locais

Lib (Helpers)

money-formatter

Formatação de centavos ou float/currency em moeda brasileira

Utiliza por baixo dos panos o format-currency

import { moneyFormatter } from "@cora/shared-modules";

moneyFormatter("9999", {
  isCents: false,
  brSymbol: true,
  ...formatCurrencyConfig,
});
// output: R$ 99,99

Obs: isCents por padrão é true e brSymbol (R$ ...) é false, o resto são as proprias configurações do format-currency

auth-fetch [DEPRECATED]

Esse helper está depreciado e é recomendado começar a usar o axios

axios

  • Fornece o próprio Axios e um create para gerar uma instância e usa-lo quando estiver logado. Com isso ele já adiciona algumas headers e tratamento quando receber um 401

Exemplo:

axiosConfig não é obrigatório, nesse caso não precisa passar nada

import { axios } from "@cora/shared-modules";

const axiosConfig = {};
const axiosAuth = axios.createAuthInstance(axiosConfig);

Caso precise passar a versão da API é só fornecer o apiVersion, assim:

axiosAuth.get($URL, {
  apiVersion: {
    id: $UUI,
    version 2
  }
});

Você também pode usar o axios puro, sem os benefícios fornecidos pelo createAuthInstance:

import { axios } from "@cora/shared-modules";

axios.get($URL);

Obs: Com ou sem o createAuthInstance ele irá funcionar normalmente como o axios, se tiver dúvida é só dar uma olhada no documentação aqui

authenticated-active

  • Fornece um get e um set para o usuário logado e ativo no momento.

get vai ter fornecer um objeto com os dados do usuário, segue exemplo:

authenticatedActive.get();

Output:

{
  "access_token": "$TOKEN",
  "refresh_token": "$TOKEN",
  "business_id": "$BID",
  "active": true
}

set vai fazer o switch do usuário que está ativo a partir do business id, segue exemplo:

authenticatedActive.set(BUSINESS_ID);

get-all-authenticateds

Retorna um array com as contas acessíveis, segue exemplo:

getAllAuthenticateds();

Retorna a seguinte type:

{
  "access_token": string,
  "refresh_token": string,
  "business_id": string,
  "active": boolean,
}[]

get-is-authenticated

Verifica se existe alguem logado e retorna um boolean, segue exemplo:

const isAuthenticated = getIsAuthenticated();

License

MIT © corabank