1.1.1 • Published 8 months ago

@easyflow/types-javascript-sdk v1.1.1

Weekly downloads
-
License
ISC
Repository
-
Last release
8 months ago

@easyflow/types-javascript-sdk

Pacote de definições de tipos TypeScript para o SDK JavaScript da Easyflow.

Este pacote permite que aplicações TypeScript utilizem o SDK Easyflow via CDN com tipagem estática, autocompletar e validação durante o desenvolvimento.

Atenção: Este pacote não contém a implementação do SDK. Ele é apenas um type definition para uso com o arquivo JavaScript do SDK carregado via <script> (CDN).


📦 Instalação

Instale o pacote de tipos no seu projeto:

npm install @easyflow/types-javascript-sdk --save-dev

🚀 Como usar

  1. Adicione o SDK via CDN no seu HTML ou no _document.tsx (caso use Next.js):
<script src="https://easyflow-sdk.pages.dev/dist/easyflow-sdk.min.js"></script>
  1. Utilize o SDK normalmente no seu código TypeScript:
const sdk = new window.EasyflowSDK("your-business-id");

const orderId = await sdk.placeOrder("offer-id", {
  buyer: { name: "João", email: "joao@email.com" },
  payments: [
    {
      method: "credit-card",
      creditCard: {
        holderName: "João",
        cardNumber: "4111111111111111",
        cvv: "123",
        month: "12",
        year: "2030",
      },
    },
  ],
});

Graças ao pacote de tipos, o TypeScript vai reconhecer e validar o uso da API do SDK, mesmo que ele esteja carregado dinamicamente via window.


✨ Funcionalidades Tipadas

  • placeOrder(offerId, data, headers?)
  • charge(data, headers?)
  • getOrder(orderId)
  • getPix(orderId)
  • getBankBillet(orderId)

Com suporte a headers opcionais como:

  • x-recaptcha-token
  • ef-signature

🧩 Compatibilidade

  • Suporte total a projetos React, Next.js, Vue, Svelte e outras frameworks com TypeScript.
  • Compatível com bundlers como Vite, Webpack e esbuild.

🛠 Contribuindo

Este pacote é mantido pela equipe da Easyflow. Sugestões, melhorias ou correções são bem-vindas.


📄 Licença

ISC License © Diego Moura

1.1.1

8 months ago

1.1.0

8 months ago

1.0.1

8 months ago

1.0.0

8 months ago