ixc-orm 1.7.0 → 1.7.1

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # 🔄 CHANGELOG
+- [v1.7.1 - 18 de outubro de 2025](#v171)
 - [v1.7.0 - 10 de outubro de 2025](#v170)
 - [v1.6.0 - 16 de agosto de 2025](#v150)
 - [v1.5.0 - 16 de agosto de 2025](#v150)
@@ -8,6 +9,9 @@
 
 ## 🚀 Novidades
 
+### v1.7.1
+* **Melhoria:** Adicionado o método `fail()` à classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/main/src/IxcResponse.ts">IxcResponse</a>, para verificar se o IXC Provedor retornou uma resposta com erro.
+
 ### v1.7.0
 * **Atualização:** Novas classes adiconadas, para simplificar a manipulação dos filtros de busca e das respostas da API do **IXC Provedor**.
     * A nova classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/builders/src/IxcOrm.ts">IxcOrm</a> pode substituir a classe `IXCCliente` e fornece uma maneira mais dinâmica de construir a query de busca, através dos métodos `where()`, `like()`, `exactly()`, `lessThan()`, `lessThanEquals()`, `greaterThan()` e `greaterThanEquals()`.

package/README.md

@@ -6,19 +6,23 @@
 [![npm](https://img.shields.io/npm/dt/ixc-orm.svg?style=for-the-badge)](https://www.npmjs.com/package/ixc-orm)
 ![Status](https://img.shields.io/badge/Status-Stable-brightgreen?style=for-the-badge)
 ![NPM Version](https://img.shields.io/npm/v/ixc-orm?style=for-the-badge)
-  
-Esse ORM visa facilitar o consumo de dados da API oficial do [IXC Provedor](https://ixcsoft.com/ixc-provedor).\
+
+Esse ORM foi criado com o intuito de facilitar o consumo de dados da API oficial do [IXC Provedor](https://ixcsoft.com/ixc-provedor).\
 Essa biblioteca não faz parte das bibliotecas oficiais da [IXCsoft](https://ixcsoft.com/) e foi desenvolvida de forma independente e sem fins lucrativos.
 
 </div>
 
 
-## Instalação
+## Download
 
 ```bash
 npm install ixc-orm
 ```
-ou
+
+```bash
+pnpm add ixc-orm
+```
+
 ```bash
 yarn add ixc-orm
 ```
@@ -26,10 +30,34 @@ yarn add ixc-orm
 
 ## Como utilizar
 
-As classes que representarão as tabelas dentro do banco de dados do seu servidor IXC, deverão herdar da classe `IxcOrm` (nova versão), como no exemplo a seguir:
+Para configurar a comunicação da biblioteca com seu servidor IXC Provedor, é necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
+
+> [!NOTE]\
+> Versão 1.7.1 `stable`
+
+- **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
+- **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
+
+```ini
+IXC_ACCESS_TOKEN=conteúdo-do-token-gerado-dentro-do-ixc
+IXC_SERVER_DOMAIN=www.dominio-do-seu-servidor-ixc.com.br
+```
+
+
+> Versão 1.6.0 ou anterior:
+
+- **IXC_HOST** A url do seu servidor IXC Provedor.
+- **IXC_TOKEN** Um token de API gerado dentro do IXC Provedor.
+
+```ini
+IXC_HOST="https://dominiodoservidorixc.com.br/webservice/v1"
+IXC_TOKEN="8:k4n8wk1946j7mimthei869cq1zz2u940f2gqobqg081y2oefl80mzhtq2wud3gqp"
+```
+
+As classes que representarão os diferentes tipos de registros no seu **IXC Provedor**, deverão herdar da classe `IxcOrm` (nova versão), como no exemplo a seguir:
 
 > [!NOTE]\
-> Versão 1.7.0 `stable`
+> Versão 1.7.1 `stable`
 
 ```typescript
 import { IxcOrm } from 'ixc-orm';
@@ -56,7 +84,7 @@ class Contrato extends IXCClient {
 Após instanciar um objeto com o tipo que você criou (`Contrato, como no exemplo a cima`), você poderá acessar os métodos de construção da query de busca.
 
 > [!NOTE]\
-> Versão 1.7.0 `stable`
+> Versão 1.7.1 `stable`
 
 ```typescript
 import { IxcResponse, Sort } from 'ixc-orm';
@@ -101,8 +129,8 @@ const contratos = await contrato.find(id_contrato)
 ## Recursos da API do IXC Provedor
 
 Existem alguns `endpoints` que a API do IXC disponibiliza, a fim de "encurtar o caminho" para chegar até algumas informações. Como por exemplo, obter o arquivo PDF de uma fatura.\
-Você não precisará se preocupar em criar uma classe `Boleto` que herde da classe `IXCClient`, por exemplo,\
-nem encadear chamadas `where`. Basta seguir o exemplo abaixo:
+Para isso, você não precisará se preocupar em criar uma classe `Boleto` que herde da classe `IxcOrm`, por exemplo,\
+nem encadear chamadas de filtros. Basta fazer como no exemplo a seguir:
 
 ```typescript
 import { Recurso } from 'ixc-orm';
@@ -112,36 +140,9 @@ const id_contrato = 45852;
 const response = await Recurso.desbloqueioDeConfianca(id_contrato);
 ```
 
-> Dos recursos disponibilizados pela API do **IXC Provedor**, esta biblioteca já implementou os seguintes recursos:\
+> Dos recursos disponibilizados pela API do **IXC Provedor**, essa biblioteca já implementou:\
 > `get_boleto`, `desbloqueio_confianca` e `cliente_contrato_btn_lib_temp_24722`.\
-> Obs: Os nomes dos recursos estão de acordo com a API do **IXC Provedor** a fim de facilitar o estudo de sua documentação oficial.
-
-
-## Variáveis de Ambiente
-
-Para configurar a comunicação da biblioteca com seu servidor IXC, é necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
-
-> [!NOTE]\
-> Versão 1.7.0 `stable`
-
-- **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
-- **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
-
-```ini
-IXC_ACCESS_TOKEN=conteúdo-do-token-gerado-dentro-do-ixC
-IXC_SERVER_DOMAIN=www.dominio-do-seu-servidor-ixc.com.br
-```
-
-
-> Versão 1.6.0 ou anterior:
-
-- **IXC_HOST** A url do seu servidor **IXC Provedor**.
-- **IXC_TOKEN** Um token de API gerado dentro do **IXC Provedor**.
-
-```ini
-IXC_HOST="https://dominiodoservidorixc.com.br/webservice/v1"
-IXC_TOKEN="8:k4n8wk1946j7mimthei869cq1zz2u940f2gqobqg081y2oefl80mzhtq2wud3gqp"
-```
+> Obs: Os nomes dos recursos estão de acordo com a API do **IXC Provedor** a fim de facilitar o estudo através da sua documentação oficial.
 
 
 # Contribuições

package/dist/IxcResponse.d.ts

@@ -1,18 +1,26 @@
 export default class IxcResponse {
     private data;
+    private text;
     /**
      * Cria um novo objeto no formato de uma resposta padrão do IXC Provedor.
      *
      * @param error Uma exceção capturada por um bloco try-catch.
      * @returns Um objeto de resposta do IXC Provedor.
      */
-    static createPropsWithError(error: any): string;
+    static createResponseTextWithError(error: any): string;
     /**
      * Método construtor da classe.
      *
      * @param text O conteúdo da resposta do IXc Provedor, no formato de texto.
      */
     constructor(text: string);
+    /**
+     * Verifica se o IXC Provedor retornou uma mensagem de erro.
+     *
+     * @returns **true** se o corpo da mensagem estiver dentro de tags HTML e se a mensagem dentro das tags
+     * contiver a palavra "erro". Ou se o objeto da resposta possuir a propriedade { "type": "error", ... }.
+     */
+    fail(): boolean;
     /**
      * Obtém a quantidade total dos registros encontrados no banco de dados, além dos retornados na página atual.
      *
@@ -39,6 +47,7 @@ export default class IxcResponse {
     registros(): Array<{
         [key: string]: any;
     }>;
-    private parseDataFromText;
-    private parseDataFromHTML;
+    private responseTextHasHtml;
+    private createDataFromText;
+    private createDataFromHtml;
 }

package/dist/IxcResponse.js

@@ -8,7 +8,7 @@ class IxcResponse {
      * @param error Uma exceção capturada por um bloco try-catch.
      * @returns Um objeto de resposta do IXC Provedor.
      */
-    static createPropsWithError(error) {
+    static createResponseTextWithError(error) {
         var _a;
         const response = {
             type: 'error',
@@ -25,7 +25,25 @@ class IxcResponse {
      * @param text O conteúdo da resposta do IXc Provedor, no formato de texto.
      */
     constructor(text) {
-        this.data = this.parseDataFromText(text);
+        this.text = text;
+        this.data = this.createDataFromText();
+    }
+    /**
+     * Verifica se o IXC Provedor retornou uma mensagem de erro.
+     *
+     * @returns **true** se o corpo da mensagem estiver dentro de tags HTML e se a mensagem dentro das tags
+     * contiver a palavra "erro". Ou se o objeto da resposta possuir a propriedade { "type": "error", ... }.
+     */
+    fail() {
+        const hasHtml = this.responseTextHasHtml();
+        const hasError = this.message().includes('erro');
+        if (hasHtml && hasError) {
+            return true;
+        }
+        if (this.data && Object.keys(this.data).includes('type')) {
+            return this.data.type === 'error';
+        }
+        return false;
     }
     /**
      * Obtém a quantidade total dos registros encontrados no banco de dados, além dos retornados na página atual.
@@ -75,15 +93,18 @@ class IxcResponse {
         }
         return this.data.registros;
     }
-    parseDataFromText(text) {
-        const isValidHTML = (text === null || text === void 0 ? void 0 : text.length) && text.includes('<div style=');
-        if (isValidHTML) {
-            return this.parseDataFromHTML(text);
+    responseTextHasHtml() {
+        var _a;
+        return !(!((_a = this.text) === null || _a === void 0 ? void 0 : _a.length)) && this.text.startsWith('<div style=');
+    }
+    createDataFromText() {
+        if (this.responseTextHasHtml()) {
+            return this.createDataFromHtml();
         }
-        return JSON.parse(text);
+        return JSON.parse(this.text);
     }
-    parseDataFromHTML(html) {
-        const dom = new jsdom_1.JSDOM(html);
+    createDataFromHtml() {
+        const dom = new jsdom_1.JSDOM(this.text);
         return {
             type: 'error',
             page: 0,

package/dist/api/RequestEmitter.js

@@ -174,7 +174,7 @@ class RequestEmitter {
                 return yield response.text();
             }
             catch (error) {
-                return IxcResponse_1.default.createPropsWithError(error);
+                return IxcResponse_1.default.createResponseTextWithError(error);
             }
         });
     }

package/jest.config.ts

@@ -7,13 +7,14 @@ const config: Config = {
   collectCoverage: true,
   coverageDirectory: 'coverage',
   coverageProvider: 'v8',
+  testEnvironment: "node",
 
   transform: {
     '^.+\\.(ts|tsx)$': 'ts-jest'
   },
 
-  coverageReporters: [
-    'json'
+  collectCoverageFrom: [
+    "**/*.(t|j)s"
   ],
 
   setupFiles: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ixc-orm",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -9,7 +9,8 @@
     "declare": "tsc --declaration",
     "build": "tsc --build",
     "dev": "nodemon --watch \"src//\" --exec \"ts-node src/index.ts\" -e ts",
-    "test": "jest"
+    "test": "jest",
+    "test:cov": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -22,7 +23,7 @@
     "IXC Provedor"
   ],
   "author": {
-    "name": "Felipe Sousa",
+    "name": "Felipe S. Carmo",
     "email": "fscarmo@proton.me",
     "url": "https://github.com/SousaFelipe"
   },