ixc-orm 1.6.0 → 1.7.1

package/CHANGELOG.md

@@ -1,4 +1,7 @@
 # 🔄 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)
 - [v1.4.4 - 15 de agosto de 2025](#v144)
 - [v1.4.3 - 15 de agosto de 2025](#v143)
@@ -6,6 +9,22 @@
 
 ## 🚀 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()`.
+    * Toda a lógica de manipulação das requisições HTTP foi movida para a nova classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/builders/src/api/RequestEmitter.ts">RequestEmitter</a>, deixando a classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/builders/src/IxcOrm.ts">IxcOrm</a> apenas com a lógica de manipulação da query de busca.
+    * Os dados da resposta recebida da API do IXC Provedor agora estão todos concentrados na classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/builders/src/IxcResponse.ts">IxcResponse</a>, quando instanciada pelos métodos `GET()`, `POST()`, `PUT()` e `DELETE()`, da classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/builders/src/api/RequestEmitter.ts">RequestEmitter</a>.
+    * A classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/builders/src/IxcOrm.ts">IxcOrm</a> é uma subclasse de <a href="https://github.com/SousaFelipe/ixcorm/blob/builders/src/api/RequestEmitter.ts">RequestEmitter</a>.
+
+### v1.6.0
+* **Melhoria**: Métodos específicos para chamadas de recursos da API do **IXC Provedor**
+    * `desbloqueioDeConfianca()`: Envia uma requisição para o recurso de desbloqueio de confiança de um contrato.
+    * `liberacaoTemporaria()`: Envia uma requisição para o recurso de liberação temporária de um contrato.
+    * `getArquivoBoleto()`: Recupera o arquivo de uma fatura, no formato PDF, codificado em <a href="https://en.wikipedia.org/wiki/Base64">Base64</a>.
+
 ### v1.5.0
 * **Melhoria:** A chamada de recursos da API agora pode ser feita de forma mais simplificada, através da função `RecursoIXC`:
     * Basta importar assim: `import { RecursoIXC } from 'ixc-orm'`;
@@ -21,4 +40,4 @@
 * **Correção:** Resolvido o bug de leitura das variáveis de ambiente no arquivo .env da pasta raiz do projeto.
 * **Melhoria:** Foram adicionados 3 dos 44 recursos da API do IXC: `get_boleto`, `liberacao_temporaria` e `desbloqueio_confianca`. (Futuramente novos recursos serão adicionados)
 
-> Consulte todos os recursos disponíveis: [Doc. API IXCSoft](https://wikiapiprovedor.ixcsoft.com.br/)
+> Consulte todos os recursos disponíveis: [Doc. API IXCSoft](https://wikiapiprovedor.ixcsoft.com.br/)

package/README.md

@@ -1,25 +1,75 @@
-# IXC-ORM [![npm](https://img.shields.io/npm/dt/ixc-orm.svg)](https://www.npmjs.com/package/ixc-orm)
+<div align="center">
+  
+# IXC-ORM
 
-Este ORM visa facilitar o consumo de dados da API oficial do [IXC Provedor](https://ixcsoft.com/ixc-provedor).\
-Esta biblioteca não faz parte das bibliotecas oficiais da [IXCsoft](https://ixcsoft.com/) e foi desenvolvida de forma independente e sem fins lucrativos.
+![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
+[![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 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
 ```
 
 
+## Como utilizar
+
+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
+```
+
 
-## Usando a biblioteca
+> Versão 1.6.0 ou anterior:
 
-> As classes que representarão as tabelas dentro do banco de dados do seu servidor IXC, deverão herdar da classe `IXCClient`, como no exemplo a seguir:
+- **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.1 `stable`
+
+```typescript
+import { IxcOrm } from 'ixc-orm';
+
+class Contrato extends IxcOrm {
+  constructor() {
+    super('cliente_contrato');
+  }
+}
+```
+
+> Versão 1.6.0 ou anterior
 
 ```typescript
 import { IXCClient } 'ixc-orm';
@@ -31,7 +81,26 @@ 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 `where`, `orderBy`, `get`, `post` e `put`.
+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.1 `stable`
+
+```typescript
+import { IxcResponse, Sort } from 'ixc-orm';
+
+const contrato = new Contrato();
+
+IxcResponse response = await contrato
+  .where('data_ativacao')
+  .greaterThanEquals('2024-09-24')
+  .orderBy('data_ativacao', Sort.DESC)
+  .GET();
+
+const contratos = response.registros(); 
+```
+
+> Versão 1.6.0 ou anterior
 
 ```typescript
 const contrato = new Contrato();
@@ -45,6 +114,9 @@ const contratos = await contrato
 
 Ou quando você já possui o ID do registro que procura, a opção mais simples será utilizar o método `find()`. Este método também está implementado na classe `IXCClient`
 
+> [!NOTE]
+> Método disponível apenas para as subclasses de `IXCClient`.
+
 ```typescript
 const contrato = new Contrato();
 
@@ -54,12 +126,11 @@ 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';
@@ -69,20 +140,16 @@ 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.
-
+> 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.
 
 
-## Variáveis de Ambiente
+# Contribuições
 
-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.
+Contribuições são sempre bem-vindas!\
+Se você conhece uma maneira melhor de fazer algo, por favor, me avise!
+Caso contrário, é sempre melhor fazer um PR na branch main.
 
-> **IXC_HOST** A url do seu servidor IXC\
-> **IXC_TOKEN** Um token de API gerado dentro do próprio **IXC Provedor**
-
-```ini
-IXC_HOST="https://dominiodoservidorixc.com.br/webservice/v1"
-IXC_TOKEN="8:k4n8wk1946j7mimthei869cq1zz2u940f2gqobqg081y2oefl80mzhtq2wud3gqp"
-```
+At.te,\
+<b>Felipe S. Carmo</b>.

package/dist/IxcOrm.d.ts

@@ -0,0 +1,81 @@
+import { Sort } from './api/Ordering';
+import RequestEmitter from './api/RequestEmitter';
+export default abstract class IxcOrm extends RequestEmitter {
+    private ordering;
+    private pagination;
+    private parameters;
+    private parameterStub;
+    /**
+     * Método construtor da classe.
+     *
+     * @param table Representa o o nome da tabela que será manipulada, no IXC Provedor.
+     */
+    protected constructor(table: string);
+    /**
+     * Inicia um novo objeto de parâmetro de busca do filtro da grid.
+     *
+     * @param column O nome da coluna onde o filtro de busca será executado.
+     * @returns A própria instância.
+     */
+    where(column: string): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**L**) = LIKE.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    like(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**=**) = EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    exactly(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<**) = LESS_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThan(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<=**) = LESS_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThanEquals(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>**) = GREATER_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThan(value: string | number): IxcOrm;
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>=**) = GREATER_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThanEquals(value: string | number): IxcOrm;
+    /**
+     * Define o número da página e a quantidade de registros por página que serão retornados pelo IXc Provedor.
+     *
+     * @param page A página a ser buscada.
+     * @param rows A quantidade de registros por página.
+     * @returns A própria instância.
+     */
+    paginate(page: number, rows: number): this;
+    /**
+     * Define o tipo de ordenação dos registros retornados pela API do IXC Provedor.
+     *
+     * @param sort **ASC** ou **DESC**.
+     * @param column A coluna que será utilizada para ordenar os registros.
+     * @returns A própria instância.
+     */
+    orderBy(column: string, sort: Sort): this;
+    private createQueryObject;
+    private addParamToGridAndResetStub;
+}

package/dist/IxcOrm.js

@@ -0,0 +1,186 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Operators_1 = __importDefault(require("./api/Operators"));
+const Ordering_1 = __importStar(require("./api/Ordering"));
+const Pagination_1 = __importDefault(require("./api/Pagination"));
+const Parameter_1 = __importDefault(require("./api/Parameter"));
+const RequestEmitter_1 = __importDefault(require("./api/RequestEmitter"));
+class IxcOrm extends RequestEmitter_1.default {
+    /**
+     * Método construtor da classe.
+     *
+     * @param table Representa o o nome da tabela que será manipulada, no IXC Provedor.
+     */
+    constructor(table) {
+        super(table);
+        this.ordering = Ordering_1.default.ascBy(table, "id");
+        this.pagination = Pagination_1.default.defaults();
+        this.parameters = [];
+        this.parameterStub = new Parameter_1.default(table);
+    }
+    /**
+     * Inicia um novo objeto de parâmetro de busca do filtro da grid.
+     *
+     * @param column O nome da coluna onde o filtro de busca será executado.
+     * @returns A própria instância.
+     */
+    where(column) {
+        this.parameterStub.withType(column);
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**L**) = LIKE.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    like(value) {
+        this.parameterStub.withOperator(Operators_1.default.LIKE);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**=**) = EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    exactly(value) {
+        this.parameterStub.withOperator(Operators_1.default.EQUALS);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<**) = LESS_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThan(value) {
+        this.parameterStub.withOperator(Operators_1.default.LESS_THAN);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**<=**) = LESS_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    lessThanEquals(value) {
+        this.parameterStub.withOperator(Operators_1.default.LESS_THAN_EQUALS);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>**) = GREATER_THAN.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThan(value) {
+        this.parameterStub.withOperator(Operators_1.default.GREATER_THAN);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Adiciona, ao último objeto de parâmetro iniciado, um valor a ser filtrado com o operador (**>=**) = GREATER_THAN_EQUALS.
+     *
+     * @param value O valor a ser filtrado.
+     * @returns A própria instância.
+     */
+    greaterThanEquals(value) {
+        this.parameterStub.withOperator(Operators_1.default.GREATER_THAN_EQUALS);
+        this.parameterStub.withValue(value);
+        this.addParamToGridAndResetStub();
+        super.setupQuery(this.createQueryObject());
+        return this;
+    }
+    /**
+     * Define o número da página e a quantidade de registros por página que serão retornados pelo IXc Provedor.
+     *
+     * @param page A página a ser buscada.
+     * @param rows A quantidade de registros por página.
+     * @returns A própria instância.
+     */
+    paginate(page, rows) {
+        this.pagination = new Pagination_1.default(page, rows);
+        return this;
+    }
+    /**
+     * Define o tipo de ordenação dos registros retornados pela API do IXC Provedor.
+     *
+     * @param sort **ASC** ou **DESC**.
+     * @param column A coluna que será utilizada para ordenar os registros.
+     * @returns A própria instância.
+     */
+    orderBy(column, sort) {
+        this.ordering = (sort === Ordering_1.Sort.ASC)
+            ? Ordering_1.default.ascBy(super.getTable(), column)
+            : Ordering_1.default.descBy(super.getTable(), column);
+        return this;
+    }
+    createQueryObject() {
+        return {
+            qtype: super.getTable(),
+            query: "",
+            oper: "",
+            page: this.pagination.getPage(),
+            rp: this.pagination.getRows(),
+            sortname: this.ordering.getSortName(),
+            sortorder: this.ordering.getSortOrder().toString(),
+            grid_param: JSON.stringify(this.parameters)
+        };
+    }
+    addParamToGridAndResetStub() {
+        this.parameters.push(this.parameterStub.toJsonObject());
+        this.parameterStub = new Parameter_1.default(super.getTable());
+    }
+}
+exports.default = IxcOrm;

package/dist/IxcResponse.d.ts

@@ -0,0 +1,53 @@
+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 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.
+     *
+     * @returns O total de registros encontrados.
+     */
+    total(): number;
+    /**
+     * Obtém o número da página atual dos registros retornados.
+     *
+     * @returns O valor numérico da página.
+     */
+    page(): number;
+    /**
+     * Obtém uma mensagem retornada pelo IXC quando a requisição falha.
+     *
+     * @returns Uma mensagem de falha.
+     */
+    message(): string;
+    /**
+     * Obtém a lista de registros retornados por uma consulta à API do IXC Provedor.
+     *
+     * @returns Uma lista de objetos.
+     */
+    registros(): Array<{
+        [key: string]: any;
+    }>;
+    private responseTextHasHtml;
+    private createDataFromText;
+    private createDataFromHtml;
+}

package/dist/IxcResponse.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsdom_1 = require("jsdom");
+class IxcResponse {
+    /**
+     * 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 createResponseTextWithError(error) {
+        var _a;
+        const response = {
+            type: 'error',
+            page: 0,
+            total: 0,
+            registros: [],
+            message: ((_a = error.response) === null || _a === void 0 ? void 0 : _a.statusText) || error.message || 'Erro desconhecido'
+        };
+        return JSON.stringify(response);
+    }
+    /**
+     * Método construtor da classe.
+     *
+     * @param text O conteúdo da resposta do IXc Provedor, no formato de texto.
+     */
+    constructor(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.
+     *
+     * @returns O total de registros encontrados.
+     */
+    total() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.total)) {
+            return 0;
+        }
+        return this.data.total;
+    }
+    /**
+     * Obtém o número da página atual dos registros retornados.
+     *
+     * @returns O valor numérico da página.
+     */
+    page() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.page)) {
+            return 0;
+        }
+        return this.data.page;
+    }
+    /**
+     * Obtém uma mensagem retornada pelo IXC quando a requisição falha.
+     *
+     * @returns Uma mensagem de falha.
+     */
+    message() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.message)) {
+            return '';
+        }
+        return this.data.message;
+    }
+    /**
+     * Obtém a lista de registros retornados por uma consulta à API do IXC Provedor.
+     *
+     * @returns Uma lista de objetos.
+     */
+    registros() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.registros)) {
+            return [];
+        }
+        return this.data.registros;
+    }
+    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(this.text);
+    }
+    createDataFromHtml() {
+        const dom = new jsdom_1.JSDOM(this.text);
+        return {
+            type: 'error',
+            page: 0,
+            total: 0,
+            message: dom.window.document.body.textContent
+        };
+    }
+}
+exports.default = IxcResponse;

package/dist/api/Environment.d.ts

@@ -0,0 +1,11 @@
+export default class Environment {
+    private static instance;
+    private domain;
+    private token;
+    static getInstance(): Environment;
+    private constructor();
+    getDomain(): string;
+    getToken(): string;
+    setDomain(domain?: string): void;
+    setToken(token?: string): void;
+}

package/dist/api/Environment.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Environment {
+    static getInstance() {
+        if (!Environment.instance) {
+            Environment.instance = new Environment();
+        }
+        return Environment.instance;
+    }
+    constructor() { }
+    getDomain() {
+        return this.domain;
+    }
+    getToken() {
+        return this.token;
+    }
+    setDomain(domain) {
+        var _a;
+        const newDomainIsValid = !(!(domain === null || domain === void 0 ? void 0 : domain.length));
+        const oldDomainIsValid = !((_a = this.domain) === null || _a === void 0 ? void 0 : _a.length);
+        if (newDomainIsValid && oldDomainIsValid) {
+            this.domain = domain;
+        }
+    }
+    setToken(token) {
+        var _a;
+        const newTokenIsValid = !(!(token === null || token === void 0 ? void 0 : token.length));
+        const oldTokenisValid = !((_a = this.token) === null || _a === void 0 ? void 0 : _a.length);
+        if (newTokenIsValid && oldTokenisValid) {
+            this.token = token;
+        }
+    }
+}
+exports.default = Environment;