ixc-orm 1.8.0 → 1.9.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # 🔄 CHANGELOG
+- [v1.9.0 - 90 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)
@@ -10,6 +11,9 @@
 
 ## 🚀 Novidades
 
+### 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>.
+
 ### v1.8.0
 * **Melhoria:** O processo de carregamento do ambiente consegue detectar se as variáveis já foram carregas por um container Docker e interrompe o carregamento através do `.env`, evitando que a aplicação encerre o processo com erro..
 * **Correção:** Corrigida incompatibilidade com o cache do `pnpm`. Ao tentar carregar as variáveis diretamente do arquivo `.env`, o ambiente buscará o arquivo de forma recursiva, para conseguir encontrá-lo mesmo quando a biblioteca interpretar a pasta `node_modules` como root. (ocorre em alguns cenários muito específicos, apenas com o `pnpm`), evitando que o processo seja encerrado com erro.
@@ -19,21 +23,21 @@
 
 ### 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>.
+* 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>.
+* `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'`;
-    * E chamar assim: `await RecursoIXC('get_boleto', { id_fatura: 25484 })`.
+* Basta importar assim: `import { RecursoIXC } from 'ixc-orm'`;
+* E chamar assim: `await RecursoIXC('get_boleto', { id_fatura: 25484 })`.
 
 ### v1.4.4
 * **Melhoria:** Foi adicionado um método `find()` a classe `IXCClient`, para encontrar um registro pelo seu `id` de uma forma mais simplificada.

package/dist/IxcResponse.js

@@ -1,6 +1,5 @@
 "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.
@@ -79,7 +78,7 @@ class IxcResponse {
         if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.message)) {
             return '';
         }
-        return this.data.message;
+        return this.data.message.replaceAll('<br />', '. ');
     }
     /**
      * Obtém a lista de registros retornados por uma consulta à API do IXC Provedor.
@@ -104,12 +103,13 @@ class IxcResponse {
         return JSON.parse(this.text);
     }
     createDataFromHtml() {
-        const dom = new jsdom_1.JSDOM(this.text);
+        const parser = new DOMParser();
+        const document = parser.parseFromString(this.text, 'text/html');
         return {
             type: 'error',
             page: 0,
             total: 0,
-            message: dom.window.document.body.textContent
+            message: document.body.textContent
         };
     }
 }

package/dist/api/Environment.d.ts

@@ -2,10 +2,11 @@ export default class Environment {
     private static instance;
     private domain;
     private token;
-    static getInstance(): Environment;
+    static loadInstance(): Environment;
     private constructor();
     private shouldToLoadDotEnvFile;
-    private loadedEnvVars;
+    private envHasBeenLoaded;
+    private loadEnvFromEnvFile;
     private setDomain;
     private setToken;
     getDomain(): string;

package/dist/api/Environment.js

@@ -7,7 +7,7 @@ const path_1 = __importDefault(require("path"));
 const dotenv_1 = __importDefault(require("dotenv"));
 const utils_1 = __importDefault(require("../utils"));
 class Environment {
-    static getInstance() {
+    static loadInstance() {
         if (!Environment.instance) {
             Environment.instance = new Environment();
         }
@@ -19,9 +19,16 @@ class Environment {
         this.setDomain(process.env.IXC_SERVER_DOMAIN);
     }
     shouldToLoadDotEnvFile() {
-        if (this.loadedEnvVars()) {
+        if (this.envHasBeenLoaded()) {
             return;
         }
+        this.loadEnvFromEnvFile();
+    }
+    envHasBeenLoaded() {
+        const allEnvVars = Object.keys(process.env);
+        return allEnvVars.some(envVar => envVar.startsWith('IXC_'));
+    }
+    loadEnvFromEnvFile() {
         const fileUtil = new utils_1.default.File();
         const envfile = fileUtil.findFile('.env');
         const env = dotenv_1.default.config({
@@ -33,12 +40,6 @@ class Environment {
             process.exit(1);
         }
     }
-    loadedEnvVars() {
-        const allEnvVars = Object.keys(process.env);
-        return allEnvVars.some(envVar => {
-            return envVar.startsWith('IXC_');
-        });
-    }
     setDomain(domain) {
         var _a;
         const newDomainIsValid = !(!(domain === null || domain === void 0 ? void 0 : domain.length));

package/dist/api/RequestEmitter.d.ts

@@ -9,7 +9,7 @@ export default class RequestEmitter {
      *
      * @param table Representa o endpoint do IXC Provedor para o qual será enviada a requisição.
      */
-    protected constructor(table: string);
+    constructor(table: string);
     /**
      * Envia uma requisição HTTP para a API do IXC Provedor, para listar registros, filtrando-os pela query de busca
      * definida por **setQuery(String query)**.
@@ -42,12 +42,6 @@ export default class RequestEmitter {
      * @return Um objeto {@link IxcResponse}.
      */
     DELETE(record: any): Promise<IxcResponse>;
-    /**
-     * Obtém o valor da tabela, definida no cosntrutor.
-     *
-     * @returns string
-     */
-    protected getTable(): string;
     /**
      * Define a query que será enviada no corpo de uma requisição de busca.
      *
@@ -71,9 +65,21 @@ export default class RequestEmitter {
      *
      * @param query Um objeto no formato de uma query da API do IXC Provedor.
      */
-    protected setupQuery(query: {
+    setupQuery(query: {
         [key: string]: any;
     }): void;
+    /**
+     * Envia requisições para recursos específicos do IXC Provedor.
+     *
+     * @returns Uma nova instância de IxcResponse, contendo os dados retornados pelo recurso do IXC Provedor.
+     */
+    sendRequestToResource(): Promise<IxcResponse>;
+    /**
+     * Obtém o valor da tabela, definida no cosntrutor.
+     *
+     * @returns string
+     */
+    protected getTable(): string;
     private loadCommonHeaders;
     private getEncodedTokenFromContext;
     private setupUri;

package/dist/api/RequestEmitter.js

@@ -101,14 +101,6 @@ class RequestEmitter {
             return new IxcResponse_1.default(responseText);
         });
     }
-    /**
-     * Obtém o valor da tabela, definida no cosntrutor.
-     *
-     * @returns string
-     */
-    getTable() {
-        return this.table;
-    }
     /**
      * Define a query que será enviada no corpo de uma requisição de busca.
      *
@@ -135,6 +127,32 @@ class RequestEmitter {
     setupQuery(query) {
         this.query = query;
     }
+    /**
+     * Envia requisições para recursos específicos do IXC Provedor.
+     *
+     * @returns Uma nova instância de IxcResponse, contendo os dados retornados pelo recurso do IXC Provedor.
+     */
+    sendRequestToResource() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.setupUri();
+                const responseText = yield this.sendRequest('POST', this.query);
+                return new IxcResponse_1.default(responseText);
+            }
+            catch (error) {
+                const responseTextError = IxcResponse_1.default.createResponseTextWithError(error);
+                return new IxcResponse_1.default(responseTextError);
+            }
+        });
+    }
+    /**
+     * Obtém o valor da tabela, definida no cosntrutor.
+     *
+     * @returns string
+     */
+    getTable() {
+        return this.table;
+    }
     loadCommonHeaders() {
         const encodedToken = this.getEncodedTokenFromContext();
         this.headers.push({ 'Authorization': `Basic ${encodedToken}` });
@@ -142,11 +160,11 @@ class RequestEmitter {
         this.headers.push({ 'ixcsoft': '' });
     }
     getEncodedTokenFromContext() {
-        const token = Environment_1.default.getInstance().getToken();
+        const token = Environment_1.default.loadInstance().getToken();
         return Buffer.from(token !== null && token !== void 0 ? token : '').toString('base64');
     }
     setupUri(id) {
-        const host = Environment_1.default.getInstance().getDomain();
+        const host = Environment_1.default.loadInstance().getDomain();
         const pathId = id ? `/${id}` : '';
         this.uri = `https://${host}/webservice/v1/${this.table}${pathId}`;
     }

package/dist/index.js

@@ -58,4 +58,4 @@ const types_1 = require("./types");
 Object.defineProperty(exports, "IXCOperator", { enumerable: true, get: function () { return types_1.IXCOperator; } });
 Object.defineProperty(exports, "IXCRequestMethods", { enumerable: true, get: function () { return types_1.IXCRequestMethods; } });
 Object.defineProperty(exports, "IXCSortOrder", { enumerable: true, get: function () { return types_1.IXCSortOrder; } });
-Environment_1.default.getInstance();
+Environment_1.default.loadInstance();

package/dist/recursos/cliente_contrato_ativar_cliente.d.ts

@@ -0,0 +1,4 @@
+import IxcResponse from '../IxcResponse';
+export default function cliente_contrato_ativar_cliente(args: {
+    id_contrato?: string | number;
+}): Promise<IxcResponse>;

package/dist/recursos/cliente_contrato_ativar_cliente.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        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 = cliente_contrato_ativar_cliente;
+const RequestEmitter_1 = __importDefault(require("../api/RequestEmitter"));
+const src = 'cliente_contrato_ativar_cliente';
+function cliente_contrato_ativar_cliente(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { id_contrato } = args;
+        const requestEmitter = new RequestEmitter_1.default(src);
+        requestEmitter.setupQuery({
+            qtype: 'cliente_contrato_ativar_cliente.id',
+            id_contrato
+        });
+        return yield requestEmitter.sendRequestToResource();
+    });
+}

package/dist/recursos/index.d.ts

@@ -1,6 +1,7 @@
 import cliente_contrato_btn_lib_temp_24722 from './cliente_contrato_btn_lib_temp_24722';
 import desbloqueio_confianca from './desbloqueio_confianca';
 import get_boleto from './get_boleto';
+import radusuarios_25452 from './radusuarios_25452';
 /**
  * @deprecated Acesse os recursos através da constante {@link Recurso}
  */
@@ -36,6 +37,13 @@ export declare const Recurso: {
      * contendo o conteúdo do boleto, caso a requisição seja bem-sucedida
      */
     getArquivoBoleto: typeof get_boleto;
+    /**
+     * Envia uma requisição à API do IXC Provedor, para que o endereço de MAC seja removido do cadastro de um determinado PPPoE.
+     *
+     * @param id_login O ID do PPPoE que se deseja remover o endereço de MAC.
+     * @returns A instância de um **IxcResponse**.
+     */
+    limparMAC: typeof radusuarios_25452;
     /**
      * Solicita ao IXC que libere, por 72 horas, o contrato de um cliente bloqueado, que não tenha
      * solicitado outra liberação temporária dentro de um período de 30 dias

package/dist/recursos/index.js

@@ -17,6 +17,7 @@ exports.default = RecursoIXC;
 const cliente_contrato_btn_lib_temp_24722_1 = __importDefault(require("./cliente_contrato_btn_lib_temp_24722"));
 const desbloqueio_confianca_1 = __importDefault(require("./desbloqueio_confianca"));
 const get_boleto_1 = __importDefault(require("./get_boleto"));
+const radusuarios_25452_1 = __importDefault(require("./radusuarios_25452"));
 /**
  * @deprecated Acesse os recursos através da constante {@link Recurso}
  */
@@ -51,6 +52,13 @@ exports.Recurso = {
      * contendo o conteúdo do boleto, caso a requisição seja bem-sucedida
      */
     getArquivoBoleto: get_boleto_1.default,
+    /**
+     * Envia uma requisição à API do IXC Provedor, para que o endereço de MAC seja removido do cadastro de um determinado PPPoE.
+     *
+     * @param id_login O ID do PPPoE que se deseja remover o endereço de MAC.
+     * @returns A instância de um **IxcResponse**.
+     */
+    limparMAC: radusuarios_25452_1.default,
     /**
      * Solicita ao IXC que libere, por 72 horas, o contrato de um cliente bloqueado, que não tenha
      * solicitado outra liberação temporária dentro de um período de 30 dias

package/dist/recursos/radusuarios_25452.d.ts

@@ -0,0 +1,4 @@
+import IxcResponse from '../IxcResponse';
+export default function radusuarios_25452(args: {
+    id_login?: string | number;
+}): Promise<IxcResponse>;

package/dist/recursos/radusuarios_25452.js

@@ -0,0 +1,25 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        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 = radusuarios_25452;
+const RequestEmitter_1 = __importDefault(require("../api/RequestEmitter"));
+const src = 'radusuarios_25452';
+function radusuarios_25452(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { id_login } = args;
+        const requestEmitter = new RequestEmitter_1.default(src);
+        requestEmitter.setupQuery({ get_id: id_login });
+        return yield requestEmitter.sendRequestToResource();
+    });
+}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "ixc-orm",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "description": "ORM para consumo de dados da API do sistema IXC Provedor",
   "scripts": {
     "dev": "nodemon --watch \"src//\" --exec \"ts-node src/index.ts\" -e ts",
-    "test": "jest --coverage",
+    "test": "jest",
+    "test:cov": "jest --coverage",
     "build": "tsc --build"
   },
   "repository": {
@@ -30,16 +31,20 @@
   },
   "dependencies": {
     "axios": "^1.12.2",
-    "dotenv": "^17.2.3",
-    "jsdom": "^27.0.1"
+    "dotenv": "^17.2.3"
   },
   "devDependencies": {
-    "@babel/preset-typescript": "^7.27.1",
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
     "@jest/globals": "^30.2.0",
+    "@testing-library/jest-dom": "^6.9.1",
     "@types/jest": "^30.0.0",
     "@types/jsdom": "^27.0.0",
     "@types/node": "^24.8.1",
+    "babel-jest": "^30.2.0",
     "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
     "nodemon": "^3.1.10",
     "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/ixcclient.ts","./src/ixcorm.ts","./src/ixcresponse.ts","./src/index.ts","./src/request.ts","./src/response.ts","./src/types.ts","./src/api/environment.ts","./src/api/operators.ts","./src/api/ordering.ts","./src/api/pagination.ts","./src/api/parameter.ts","./src/api/requestemitter.ts","./src/recursos/cliente_contrato_btn_lib_temp_24722.ts","./src/recursos/desbloqueio_confianca.ts","./src/recursos/get_boleto.ts","./src/recursos/index.ts","./src/recursos/recurso.ts","./src/utils/fileutils.ts","./src/utils/textutils.ts","./src/utils/index.ts"],"version":"5.9.3"}
+{"root":["./src/ixcclient.ts","./src/ixcorm.ts","./src/ixcresponse.ts","./src/index.ts","./src/request.ts","./src/response.ts","./src/types.ts","./src/api/environment.ts","./src/api/operators.ts","./src/api/ordering.ts","./src/api/pagination.ts","./src/api/parameter.ts","./src/api/requestemitter.ts","./src/recursos/cliente_contrato_ativar_cliente.ts","./src/recursos/cliente_contrato_btn_lib_temp_24722.ts","./src/recursos/desbloqueio_confianca.ts","./src/recursos/get_boleto.ts","./src/recursos/index.ts","./src/recursos/radusuarios_25452.ts","./src/recursos/recurso.ts","./src/utils/fileutils.ts","./src/utils/textutils.ts","./src/utils/index.ts"],"version":"5.9.3"}

package/babel.config.cjs

@@ -1,6 +0,0 @@
-module.exports = {
-  presets: [
-    ['@babel/preset-env', {targets: {node: 'current'}}],
-    '@babel/preset-typescript',
-  ],
-};

package/jest.config.ts

@@ -1,34 +0,0 @@
-import type {Config} from 'jest';
-
-
-const config: Config = {
-
-  clearMocks: true,
-  collectCoverage: true,
-  coverageDirectory: 'coverage',
-  coverageProvider: 'v8',
-  testEnvironment: "node",
-
-  transform: {
-    '^.+\\.(ts|tsx)$': 'ts-jest'
-  },
-
-  collectCoverageFrom: [
-    "**/src/**/*.(t|j)s"
-  ],
-
-  setupFiles: [
-    "dotenv/config"
-  ],
-
-  setupFilesAfterEnv: [
-    './tests/jest.setup.ts'
-  ],
-
-  testMatch: [
-    '<rootDir>/tests/**/*.test.ts'
-  ]
-};
-
-
-export default config;