ixc-orm 1.9.0 → 1.10.2

package/CHANGELOG.md

@@ -1,5 +1,6 @@
 # 🔄 CHANGELOG
-- [v1.9.0 - 90 de outubro de 2025](#v190)
+- [v1.10.2 - 20 de novembro de 2025](#v1102)
+- [v1.9.0 - 09 de outubro de 2025](#v190)
 - [v1.8.0 - 18 de outubro de 2025](#v180)
 - [v1.7.1 - 18 de outubro de 2025](#v171)
 - [v1.7.0 - 10 de outubro de 2025](#v170)
@@ -11,6 +12,9 @@
 
 ## 🚀 Novidades
 
+### v1.10.2
+* **Melhoria:** O recurso `Recurso.getArquivoBoleto()`, que obtém um arquivo PDF de um boleto, passou a utilizar o 'RequestEmitter' da API para executar a requisição. A resposta desse recurso será uma Promise contendo a instância de um objeto do tipo `IxcResponse`.
+
 ### v1.9.0
 * **Melhoria:** Novo recurso para remoção de MAC de um PPPoE, através do recurso `radusuarios_25452`, que é disponibilizado pela própria API do IXC Provedor. Para utilizar o recurso, invocar o método assícrono `Recurso.limparMAC({ id_login: number });`. O método irá retornar a instãncia de um <a href="https://github.com/SousaFelipe/ixc-orm/blob/main/src/IxcResponse.ts">IxcResponse</a>.
 

package/README.md

@@ -33,7 +33,7 @@ yarn add ixc-orm
 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.8.0 `stable`
+> Versão 1.10.2 `stable`
 
 - **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
 - **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
@@ -57,20 +57,10 @@ services:
 ```
 
 
-> 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.8.0 `stable`
+> Versão 1.10.2 `stable`
 
 ```typescript
 import { IxcOrm } from 'ixc-orm';
@@ -82,22 +72,11 @@ class Contrato extends IxcOrm {
 }
 ```
 
-> Versão 1.6.0 ou anterior
-
-```typescript
-import { IXCClient } 'ixc-orm';
-
-class Contrato extends IXCClient {
-  constructor() {
-    super('cliente_contrato');
-  }
-}
-```
 
 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.8.0 `stable`
+> Versão 1.10.2 `stable`
 
 ```typescript
 import { IxcResponse, Sort } from 'ixc-orm';
@@ -113,49 +92,21 @@ IxcResponse response = await contrato
 const contratos = response.registros(); 
 ```
 
-> Versão 1.6.0 ou anterior
-
-```typescript
-const contrato = new Contrato();
-
-const contratos = await contrato
-  .where(['id_cliente', 240])
-  .where(['data_ativacao', '>=', '2024-09-24 00:45:00'])
-  .orderBy('data_ativacao', 'desc')
-  .get()
-```
-
-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();
-
-const id_contrato = 4574;
-
-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.\
-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:
+Existem alguns `endpoints` que a API do IXC Provedor disponibiliza, a fim de "encurtar o caminho" para chegar até algumas informações. Como por exemplo, obter o arquivo PDF de uma fatura. 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';
 
 const id_contrato = 45852;
-
-const response = await Recurso.desbloqueioDeConfianca(id_contrato);
+const response = await Recurso.desbloqueioDeConfianca({ id_contrato });
 ```
 
-> 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 através da sua documentação oficial.
+> Dos recursos disponibilizados pela API do **IXC Provedor**, essa biblioteca já possui as implementações de:\
+> `cliente_contrato_ativar_cliente`, `cliente_contrato_btn_lib_temp_24722`, `desbloqueio_confianca`, `get_boleto` e `radusuarios_25452`.\
+> 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 própria documentação oficial.
 
 
 # Contribuições

package/dist/IxcResponse.d.ts

@@ -47,6 +47,15 @@ export default class IxcResponse {
     registros(): Array<{
         [key: string]: any;
     }>;
+    /**
+     * Obtém o conteúdo bruto de uma resposta da API do IXC Provedor.
+     * Este método substitui o método `registros()`, quando a requisição é feita para um endpoint
+     * específico de recursos do IXC Provedor, mas apenas quando a API devolve uma resposta bruta ao
+     * invés de uma lista de registros, ou uma mensagem.
+     *
+     * @returns Uma string contendo o conteúdo da resposta da API do IXC Provedor.
+     */
+    content(): string;
     private responseTextHasHtml;
     private createDataFromText;
     private createDataFromHtml;

package/dist/IxcResponse.js

@@ -92,6 +92,17 @@ class IxcResponse {
         }
         return this.data.registros;
     }
+    /**
+     * Obtém o conteúdo bruto de uma resposta da API do IXC Provedor.
+     * Este método substitui o método `registros()`, quando a requisição é feita para um endpoint
+     * específico de recursos do IXC Provedor, mas apenas quando a API devolve uma resposta bruta ao
+     * invés de uma lista de registros, ou uma mensagem.
+     *
+     * @returns Uma string contendo o conteúdo da resposta da API do IXC Provedor.
+     */
+    content() {
+        return this.text;
+    }
     responseTextHasHtml() {
         var _a;
         return !(!((_a = this.text) === null || _a === void 0 ? void 0 : _a.length)) && this.text.startsWith('<div style=');
@@ -100,7 +111,12 @@ class IxcResponse {
         if (this.responseTextHasHtml()) {
             return this.createDataFromHtml();
         }
-        return JSON.parse(this.text);
+        try {
+            return JSON.parse(this.text);
+        }
+        catch (error) {
+            return {};
+        }
     }
     createDataFromHtml() {
         const parser = new DOMParser();

package/dist/recursos/get_boleto.d.ts

@@ -1,4 +1,3 @@
-import { IXCRecursoResponse, IXCResponse } from '../types';
 export default function get_boleto(args: {
     id_fatura?: string | number;
-}): Promise<IXCResponse | IXCRecursoResponse>;
+}): Promise<string>;

package/dist/recursos/get_boleto.js

@@ -8,35 +8,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = get_boleto;
-const request_1 = require("../request");
-const response_1 = require("../response");
-const SRC = 'get_boleto';
+const RequestEmitter_1 = __importDefault(require("../api/RequestEmitter"));
+const src = 'get_boleto';
 function get_boleto(args) {
     return __awaiter(this, void 0, void 0, function* () {
-        const axios = (0, request_1.createAxiosInstance)('PUT');
-        try {
-            const { id_fatura } = args;
-            const response = yield axios.get(SRC, {
-                data: {
-                    boletos: id_fatura,
-                    juro: 'S',
-                    multa: 'S',
-                    atualiza_boleto: 'S',
-                    tipo_boleto: 'arquivo',
-                    base64: 'S'
-                }
-            });
-            if (response.status === 200) {
-                return {
-                    data: response.data
-                };
-            }
-        }
-        catch (error) {
-            console.error(`Erro ao executar recurso: ${SRC}\n`, error);
-        }
-        return (0, response_1.createResponse)({ error: true });
+        const { id_fatura } = args;
+        const requestEmitter = new RequestEmitter_1.default(src);
+        requestEmitter.setupQuery({
+            boletos: id_fatura,
+            juro: 'S',
+            multa: 'S',
+            atualiza_boleto: 'S',
+            tipo_boleto: 'arquivo',
+            base64: 'S'
+        });
+        const response = yield requestEmitter.sendRequestToResource();
+        const content = response.content();
+        return contentConvertedToPDF(content);
     });
 }
+function contentConvertedToPDF(content) {
+    const bits = atob(content);
+    if (!bits.length) {
+        return '';
+    }
+    const bytes = new Uint8Array(bits.length);
+    for (let i = 0; i < bits.length; i++) {
+        bytes[i] = bits.charCodeAt(i);
+    }
+    const decoder = new TextDecoder('utf-8');
+    return decoder.decode(bytes);
+}

package/dist/recursos/index.d.ts

@@ -60,5 +60,5 @@ export declare const Recurso: {
  *
  * @deprecated Acesse os recursos através da constante {@link Recurso}
  */
-export default function RecursoIXC<T extends keyof Recursos>(recurso: T, args: Parameters<Recursos[T]>[0]): Promise<import("..").IXCResponse | import("../types").IXCRecursoResponse>;
+export default function RecursoIXC<T extends keyof Recursos>(recurso: T, args: Parameters<Recursos[T]>[0]): Promise<string | import("..").IXCResponse>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ixc-orm",
-  "version": "1.9.0",
+  "version": "1.10.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "url": "https://github.com/SousaFelipe/ixc-orm/issues"
   },
   "dependencies": {
-    "axios": "^1.12.2",
+    "axios": "^1.13.2",
     "dotenv": "^17.2.3"
   },
   "devDependencies": {
@@ -41,11 +41,11 @@
     "@testing-library/jest-dom": "^6.9.1",
     "@types/jest": "^30.0.0",
     "@types/jsdom": "^27.0.0",
-    "@types/node": "^24.8.1",
+    "@types/node": "^24.10.1",
     "babel-jest": "^30.2.0",
     "jest": "^30.2.0",
     "jest-environment-jsdom": "^30.2.0",
-    "nodemon": "^3.1.10",
+    "nodemon": "^3.1.11",
     "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3"