feat: padronizar um repositório por linguagem de programação (#21)

.github/workflows/calculate-coverage.yaml

@@ -15,15 +15,12 @@ jobs:
           node-version: 20
 
       - name: Install dependencies
-        working-directory: ./typescript
         run: npm install
 
       - name: Build project
-        working-directory: ./typescript
         run: npm run build
 
       - name: Execute tests
-        working-directory: ./typescript
         run: npm run test:coverage
 
       - name: Send to coveralls

.github/workflows/on-commit-test.yaml

@@ -12,31 +12,10 @@ jobs:
           node-version: 20
 
       - name: Install dependencies
-        working-directory: ./typescript
         run: npm install
 
       - name: Build project
-        working-directory: ./typescript
         run: npm run build
 
       - name: Execute tests
-        working-directory: ./typescript
         run: npm run test
-
-  php-unit-tests:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: "8.2"
-
-      - name: Install dependencies
-        run: composer update
-
-      - name: Dump autoload classes
-        run: composer dump-autoload -o
-
-      - name: Execute tests
-        run: vendor/phpunit/phpunit/phpunit -c php/phpunit.xml

.gitignore

@@ -121,6 +121,3 @@ lib/
 # Ignore all local history of files
 .history
 .ionide
-
-# PHP
-vendor/

README.md

@@ -1,33 +1,128 @@
-# Bling ERP API
+- [Versão em PHP](https://github.com/AlexandreBellas/bling-erp-api-php/README.md)
+- Versão em C# (em breve)
 
-Pacote de integração com a [API v3 do ERP Bling](https://developer.bling.com.br).
-O mais completo existente (e se não é, será).
+# Bling ERP API - Javascript/Typescript
 
-Disponível para:
+[![](https://img.shields.io/npm/v/bling-erp-api.svg)](https://www.npmjs.com/package/bling-erp-api)
+[![install size](https://packagephobia.com/badge?p=bling-erp-api)](https://packagephobia.com/result?p=bling-erp-api)
+[![code coverage](https://coveralls.io/repos/github/AlexandreBellas/bling-erp-api-js/badge.svg?branch=main)](https://coveralls.io/github/AlexandreBellas/bling-erp-api?branch=main)
 
-- [x] JavaScript ([veja a documentação](https://github.com/AlexandreBellas/bling-erp-api/tree/develop/typescript/README.md))
-- [x] TypeScript ([veja a documentação](https://github.com/AlexandreBellas/bling-erp-api/tree/develop/typescript/README.md))
-- [x] PHP ([veja a documentação](https://github.com/AlexandreBellas/bling-erp-api/tree/develop/php/README.md))
-- [ ] C# (em breve)
+Pacote de integração com a [API v3 do ERP Bling](https://developer.bling.com.br)
+para Javascript/TypeScript. O mais completo existente.
 
-## Instalação
+Atualizado com a versão `v291` da API ([veja o registro de alterações](https://developer.bling.com.br/changelogs#2024-01-31)).
+
+**Atenção**: a versão 5.0.0+ do `bling-erp-api` para Javascript/TypeScript
+utiliza a API v3 do Bling. Caso deseja utilizar a API v2 do Bling,
+[utilize a versão 4.0.0](https://github.com/AlexandreBellas/bling-erp-api-js/tree/v4.0.0).
 
-Para instalar, execute o comando de acordo com a linguagem de programação
-desejada.
+## Instalação
 
-### JavaScript / TypeScript
+Para instalar, execute o comando:
 
 ```bash
 npm i bling-erp-api
 ```
 
-### PHP
+## Importação do módulo
+
+### CommonJS
+
+```js
+const Bling = require('bling-erp-api')
+```
+
+### ES6
+
+```ts
+import Bling from 'bling-erp-api'
+```
+
+## Criação de uma nova conexão
+
+Para criar uma conexão ao serviço do Bling, basta instanciar o objeto com a [API key](https://developer.bling.com.br/autenticacao) em seu construtor.
+
+```js
+const apiKey = 'sua_api_key'
+const blingConnection = new Bling(apiKey)
+```
+
+Vale destacar que o fluxo de criação e autorização do aplicativo **não é feito
+pela biblioteca**. Ou seja, a biblioteca somente recebe o `access_token` gerado
+a partir do _endpoint_ `/token`. [Veja a referência](https://developer.bling.com.br/aplicativos#tokens-de-acesso).
+
+Para entender na prática como a autenticação citada acima funciona, [veja o
+projeto de demonstração](https://github.com/AlexandreBellas/bling-erp-api-js/tree/main/demo).
+
+## Entidades disponíveis
+
+Todas as entidades do Bling atualmente são permitidas para interação. São elas:
+
+- [x] Borderos (`.borderos`)
+- [x] Campos customizados (`.camposCustomizados`)
+- [x] Categorias - Lojas (`.categoriasLojas`)
+- [x] Categorias - Produtos (`.categoriasProdutos`)
+- [x] Categorias - Receitas e Despesas (`.categoriasReceitasDespesas`)
+- [x] Contas a Pagar (`.contasPagar`)
+- [x] Contas a Receber (`.contasReceber`)
+- [x] Contas Contábeis (`.contasContabeis`)
+- [x] Contatos (`.contatos`)
+- [x] Contatos - Tipos (`.contatosTipos`)
+- [x] Contratos (`.contratos`)
+- [x] Depósitos (`.depositos`)
+- [x] Empresas (`.empresas`)
+- [x] Estoques (`.estoques`)
+- [x] Formas de pagamento (`.formasDePagamento`)
+- [x] Homologação (`.homologacao`)
+- [x] Logísticas (`.logisticas`)
+- [x] Logísticas - Etiquetas (`.logisticasEtiquetas`)
+- [x] Logísticas - Objetos (`.logisticasObjetos`)
+- [x] Logísticas - Remessas (`.logisticasRemessas`)
+- [x] Logísticas - Serviços (`.logisticasServicos`)
+- [x] Naturezas de Operações (`.naturezasDeOperacoes`)
+- [x] Notas Fiscais de Consumidor Eletrônicas (`.nfces`)
+- [x] Notas Fiscais de Serviço Eletrônicas (`.nfses`)
+- [x] Notas Fiscais Eletrônicas (`.nfes`)
+- [x] Notificações (`.notificacoes`)
+- [x] Pedidos - Compras (`.pedidosCompras`)
+- [x] Pedidos - Vendas (`.pedidosVendas`)
+- [x] Produtos (`.produtos`)
+- [x] Produtos - Estruturas (`.produtosEstruturas`)
+- [x] Produtos - Fornecedores (`.produtosFornecedores`)
+- [x] Produtos - Lojas (`.produtosLojas`)
+- [x] Produtos - Variações (`.produtosVariacoes`)
+- [x] Situações (`.situacoes`)
+- [x] Situações - Módulos (`.situacoesModulos`)
+- [x] Situações - Transições (`.situacoesTransicoes`)
+- [x] Usuários (`.usuarios`)
+- [x] Vendedores (`.vendedores`)
+
+## Exemplo de uso
+
+Para listar seus produtos, basta executar:
+
+```js
+// Também disponível como:
+// import Bling from 'bling-erp-api'
+const Bling = require('bling-erp-api')
+const apiKey = 'sua_api_key'
+
+const blingConnection = new Bling(apiKey)
+
+const products = await blingConnection.produtos.get()
+
+console.log(products)
+```
+
+## Executando os testes do projeto
+
+Faça o clone do projeto, instale as dependências e execute:
 
 ```bash
-composer require alebatistella/bling-erp-api
+npm run test
 ```
 
-## Recursos
+## Contribuindo ao projeto
 
-- [Guia de contribuição](https://github.com/AlexandreBellas/bling-erp-api/blob/v5.0.0/CONTRIBUTING.md)
+- [Guia de contribuição](https://github.com/AlexandreBellas/bling-erp-api-js/blob/v5.0.0/CONTRIBUTING.md)
 - [Apoie o projeto](https://www.paypal.com/donate/?hosted_button_id=G2NJKZ5MUMKBS)

typescript/package.json → package.json

@@ -18,7 +18,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AlexandreBellas/bling-erp-api.git"
+    "url": "git+https://github.com/AlexandreBellas/bling-erp-api-js.git"
   },
   "keywords": [
     "javascript",
@@ -38,9 +38,9 @@
   "author": "AlexandreBellas; vitor-san",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/AlexandreBellas/bling-erp-api/issues"
+    "url": "https://github.com/AlexandreBellas/bling-erp-api-js/issues"
   },
-  "homepage": "https://github.com/AlexandreBellas/bling-erp-api#readme",
+  "homepage": "https://github.com/AlexandreBellas/bling-erp-api-js#readme",
   "dependencies": {
     "axios": "^1.6.2"
   },
@@ -67,4 +67,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}