ixc-orm 1.10.5 → 2.0.0

package/CHANGELOG.md

@@ -1,4 +1,6 @@
 # 🔄 CHANGELOG
+- [v2.0.0 - 24 de dezembro de 2025](#v200)
+- [v1.10.6 - 23 de dezembro de 2025](#v1106)
 - [v1.10.5 - 20 de dezembro de 2025](#v1105)
 - [v1.10.4 - 20 de novembro de 2025](#v1104)
 - [v1.9.0 - 09 de outubro de 2025](#v190)
@@ -14,6 +16,11 @@
 
 ## 🚀 Novidades
 
+### v2.0.0
+* **Melhoria:** Adicionada verificação de erros nas respostas dos recursos. Todas as requisiões passaram a ser realizadas pela classe <a href="https://github.com/SousaFelipe/ixcorm/blob/builders/src/api/RequestEmitter.ts">RequestEmitter</a>, que utiliza a FetchAPI, por este motivo a dependência da biblioteca Axios foi removida completamente do projeto.
+
+### v1.10.6
+* **Correção:** Removido o bug que ocorria ao tentar utilizar o recurso `liberacaoTemporaria({ id_contrato })` sem que as antigas variáveis de ambiente estivessem definidas.
 
 ### v1.10.5
 * **Correção:** Removida a utilização da biblioteca nativa DOMParser, que quebrava ao tentar extrair a mensagem de erro de uma resposta do IXC Provedor.

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  
+
 # IXC-ORM
 
 ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)
@@ -30,13 +30,10 @@ 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.10.5 `stable`
+Para configurar a comunicação da biblioteca com o seu IXC Provedor, será necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
 
 - **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
-- **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
+- **IXC_SERVER_DOMAIN** O domínio do seu IXC Provedor.
 
 ```ini
 IXC_ACCESS_TOKEN=conteúdo-do-token-gerado-dentro-do-ixc
@@ -48,8 +45,10 @@ Você também poderá configurar para que o Docker carregue as variáveis, ao in
 ```yaml
 services:
   sua-aplicacao:
-    build: .
-    image: sua-imagem-docker
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: sua-imagem-docker:0.0.0
     environment:
       - IXC_ACCESS_TOKEN=${IXC_ACCESS_TOKEN}
       - IXC_SERVER_DOMAIN=${IXC_SERVER_DOMAIN}
@@ -57,10 +56,7 @@ services:
 ```
 
 
-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.10.5 `stable`
+As classes que representarão os diferentes tipos de registros no seu **IXC Provedor**, deverão herdar da classe `IxcOrm`, como no exemplo a seguir:
 
 ```typescript
 import { IxcOrm } from 'ixc-orm';
@@ -73,10 +69,7 @@ class Contrato extends IxcOrm {
 ```
 
 
-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.10.5 `stable`
+Após instanciar um objeto com o tipo criado (**Contrato**, como no exemplo a cima), você poderá acessar os métodos de construção da query de busca, da seguinte forma:
 
 ```typescript
 import { IxcResponse, Sort } from 'ixc-orm';
@@ -95,7 +88,7 @@ const contratos = response.registros();
 
 ## Recursos da API do IXC Provedor
 
-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:
+Existem alguns `endpoints` que a API do IXC Provedor disponibiliza, a fim de "encurtar o caminho" para chegar até algumas informações ou executar determinadas açõ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';
@@ -107,7 +100,7 @@ const response = await Recurso.desbloqueioDeConfianca({ id_contrato });
 
 ### Recursos disponíveis:
 
-| Recurso IXC | Método da biblioteca | Descrição
+| Método da biblioteca | Recurso IXC | Descrição
 | :---------- | :--------- | :---------- |
 | ativaContrato({ id_contrato }) | cliente_contrato_ativar_cliente | Ativa um contrato que esteja com o status de `pré-contrato` |
 | desbloqueioDeConfianca({ id_contrato }) | desbloqueio_confianca | Solicita liberação de um cliente que já tenha sido desbloqueado |
@@ -119,7 +112,8 @@ const response = await Recurso.desbloqueioDeConfianca({ id_contrato });
 # Contribuições
 
 Contribuições são sempre bem-vindas!\
-Se você conhece uma maneira melhor de fazer algo, por favor, me avise!
+Se você conhece uma maneira melhor de fazer algo, por favor, me avise!\
+Ou sinta-se a vontade para criar um novo PR!
 
 At.te,\
 <b>Felipe S. Carmo</b>.

package/dist/index.d.ts

@@ -1,15 +1,8 @@
-import IXCClient from './IXCClient';
-import RecursoIXC, { Recurso } from './recursos';
 import Environment from './api/Environment';
 import IxcOrm from './IxcOrm';
 import IxcResponse from './IxcResponse';
 import Operators from './api/Operators';
 import Ordering from './api/Ordering';
+import Recurso from './recursos';
 import Utils from './utils';
-import { IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder } from './types';
-export { IXCClient, IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder, Recurso, Environment, IxcOrm, IxcResponse, Operators, Ordering, Utils, 
-/**
- * @property RecursoIXC
- * @deprecated Acesse os recursos através da constante {@link Recurso}
- */
-RecursoIXC, };
+export { Environment, IxcOrm, IxcResponse, Operators, Ordering, Recurso, Utils };

package/dist/index.js

@@ -1,47 +1,9 @@
 "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 });
-exports.RecursoIXC = exports.Utils = exports.Ordering = exports.Operators = exports.IxcResponse = exports.IxcOrm = exports.Environment = exports.Recurso = exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
-const IXCClient_1 = __importDefault(require("./IXCClient"));
-exports.IXCClient = IXCClient_1.default;
-const recursos_1 = __importStar(require("./recursos"));
-exports.RecursoIXC = recursos_1.default;
-Object.defineProperty(exports, "Recurso", { enumerable: true, get: function () { return recursos_1.Recurso; } });
+exports.Utils = exports.Recurso = exports.Ordering = exports.Operators = exports.IxcResponse = exports.IxcOrm = exports.Environment = void 0;
 const Environment_1 = __importDefault(require("./api/Environment"));
 exports.Environment = Environment_1.default;
 const IxcOrm_1 = __importDefault(require("./IxcOrm"));
@@ -52,10 +14,8 @@ const Operators_1 = __importDefault(require("./api/Operators"));
 exports.Operators = Operators_1.default;
 const Ordering_1 = __importDefault(require("./api/Ordering"));
 exports.Ordering = Ordering_1.default;
+const recursos_1 = __importDefault(require("./recursos"));
+exports.Recurso = recursos_1.default;
 const utils_1 = __importDefault(require("./utils"));
 exports.Utils = utils_1.default;
-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.loadInstance();

package/dist/recursos/cliente_contrato_ativar_cliente.js

@@ -18,6 +18,9 @@ const src = 'cliente_contrato_ativar_cliente';
 function cliente_contrato_ativar_cliente(args) {
     return __awaiter(this, void 0, void 0, function* () {
         const { id_contrato } = args;
+        if (!id_contrato || id_contrato === '0') {
+            throw new Error('O parâmetro "id_contrato" não pode ser null, undefined ou 0.');
+        }
         const requestEmitter = new RequestEmitter_1.default(src);
         requestEmitter.setupQuery({
             qtype: 'cliente_contrato_ativar_cliente.id',

package/dist/recursos/cliente_contrato_btn_lib_temp_24722.d.ts

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

package/dist/recursos/cliente_contrato_btn_lib_temp_24722.js

@@ -12,17 +12,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = cliente_contrato;
-const recurso_1 = __importDefault(require("./recurso"));
+exports.default = cliente_contrato_btn_lib_temp_24722;
+const RequestEmitter_1 = __importDefault(require("../api/RequestEmitter"));
 const src = 'cliente_contrato_btn_lib_temp_24722';
-function cliente_contrato(args) {
+function cliente_contrato_btn_lib_temp_24722(args) {
     return __awaiter(this, void 0, void 0, function* () {
         const { id_contrato } = args;
-        return yield (0, recurso_1.default)({
-            src,
-            data: {
-                id_contrato
-            }
+        if (!id_contrato || id_contrato === '0') {
+            throw new Error('O parâmetro "id_contrato" não pode ser null, undefined ou 0.');
+        }
+        const requestEmitter = new RequestEmitter_1.default(src);
+        requestEmitter.setupQuery({
+            id: id_contrato
         });
+        return yield requestEmitter.sendRequestToResource();
     });
 }

package/dist/recursos/desbloqueio_confianca.d.ts

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

package/dist/recursos/desbloqueio_confianca.js

@@ -13,16 +13,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = desbloqueio_confianca;
-const recurso_1 = __importDefault(require("./recurso"));
+const RequestEmitter_1 = __importDefault(require("../api/RequestEmitter"));
 const src = 'desbloqueio_confianca';
 function desbloqueio_confianca(args) {
     return __awaiter(this, void 0, void 0, function* () {
         const { id_contrato } = args;
-        return yield (0, recurso_1.default)({
-            src,
-            data: {
-                id_contrato
-            }
+        if (!id_contrato || id_contrato === '0') {
+            throw new Error('O parâmetro "id_contrato" não pode ser null, undefined ou 0.');
+        }
+        const requestEmitter = new RequestEmitter_1.default(src);
+        requestEmitter.setupQuery({
+            id: id_contrato
         });
+        return yield requestEmitter.sendRequestToResource();
     });
 }

package/dist/recursos/get_boleto.js

@@ -18,6 +18,9 @@ const src = 'get_boleto';
 function get_boleto(args) {
     return __awaiter(this, void 0, void 0, function* () {
         const { id_fatura } = args;
+        if (!id_fatura || id_fatura === '0') {
+            throw new Error('O parâmetro "id_fatura" não pode ser null, undefined ou 0.');
+        }
         const requestEmitter = new RequestEmitter_1.default(src);
         requestEmitter.setupQuery({
             boletos: id_fatura,

package/dist/recursos/index.d.ts

@@ -3,20 +3,7 @@ import cliente_contrato_btn_lib_temp_24722 from './cliente_contrato_btn_lib_temp
 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}
- */
-declare const recursos: {
-    cliente_contrato: typeof cliente_contrato_btn_lib_temp_24722;
-    desbloqueio_confianca: typeof desbloqueio_confianca;
-    get_boleto: typeof get_boleto;
-};
-type Recursos = typeof recursos;
-/**
- * Disponibiliza, de forma simples e direta, o acesso a todos os recursos da API do IXC\
- * **ATENÇÃO** --- Nem todos os recursos da API do IXC foram implementados por esta biblioteca
- */
-export declare const Recurso: {
+declare const _default: {
     /**
      * Ativa o contrato de um cliente que esteja com o status de "pré-contrato". Este recurso não
      * é capaz de ativar contratos que tenha sido desativados, ou estejam bloqueados.
@@ -26,7 +13,7 @@ export declare const Recurso: {
      * @param id_contrato O ID do contrato que se deseja ativar
      * @returns Um objeto **IxcResponse** contendo a resposta enviada pelo IXC
      */
-    ativaContrato: typeof cliente_contrato_ativar_cliente;
+    readonly ativaContrato: typeof cliente_contrato_ativar_cliente;
     /**
      * Solicita ao IXC que desbloqueie o contrato de um cliente bloqueado, que já solicitou
      * a liberação temporária dentro de um período de 30 dias. Este recurso só funciona, caso
@@ -37,7 +24,7 @@ export declare const Recurso: {
      * @param id_contrato O ID do contrato do cliente que deverá ser desbloqueado
      * @returns Um objeto **IXCResponse** contendo a resposta enviada pelo IXC
      */
-    desbloqueioDeConfianca: typeof desbloqueio_confianca;
+    readonly desbloqueioDeConfianca: typeof desbloqueio_confianca;
     /**
      * Obtém um arquivo PDF codificado em base64 do boleto de uma determinada fatura.
      *
@@ -47,14 +34,14 @@ export declare const Recurso: {
      * @returns Um **IxcResponse**, caso a requisição falhe, ou um **IXCRecursoResponse**
      * contendo o conteúdo do boleto, caso a requisição seja bem-sucedida
      */
-    getArquivoBoleto: typeof get_boleto;
+    readonly 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;
+    readonly 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
@@ -64,12 +51,6 @@ export declare const Recurso: {
      * @param id_contrato O ID do contrato do cliente que deverá ser liberado
      * @returns Um objeto **IXCResponse** contendo a resposta enviada pelo IXC
      */
-    liberacaoTemporaria: typeof cliente_contrato_btn_lib_temp_24722;
+    readonly liberacaoTemporaria: typeof cliente_contrato_btn_lib_temp_24722;
 };
-/**
- * *ATENÇÃO:* Esta função desá descontinuada
- *
- * @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("..").IxcResponse>;
-export {};
+export default _default;

package/dist/recursos/index.js

@@ -1,37 +1,14 @@
 "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.Recurso = void 0;
-exports.default = RecursoIXC;
 const cliente_contrato_ativar_cliente_1 = __importDefault(require("./cliente_contrato_ativar_cliente"));
 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}
- */
-const recursos = {
-    cliente_contrato: cliente_contrato_btn_lib_temp_24722_1.default,
-    desbloqueio_confianca: desbloqueio_confianca_1.default,
-    get_boleto: get_boleto_1.default
-};
-/**
- * Disponibiliza, de forma simples e direta, o acesso a todos os recursos da API do IXC\
- * **ATENÇÃO** --- Nem todos os recursos da API do IXC foram implementados por esta biblioteca
- */
-exports.Recurso = {
+exports.default = {
     /**
      * Ativa o contrato de um cliente que esteja com o status de "pré-contrato". Este recurso não
      * é capaz de ativar contratos que tenha sido desativados, ou estejam bloqueados.
@@ -81,15 +58,3 @@ exports.Recurso = {
      */
     liberacaoTemporaria: cliente_contrato_btn_lib_temp_24722_1.default,
 };
-/**
- * *ATENÇÃO:* Esta função desá descontinuada
- *
- * @deprecated Acesse os recursos através da constante {@link Recurso}
- */
-function RecursoIXC(recurso, args) {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.warn('Esta função será removida na próxima versão! Acesse os recursos através da constante "Recurso".');
-        const handler = recursos[recurso];
-        return yield handler(args);
-    });
-}

package/dist/recursos/radusuarios_25452.js

@@ -18,6 +18,9 @@ const src = 'radusuarios_25452';
 function radusuarios_25452(args) {
     return __awaiter(this, void 0, void 0, function* () {
         const { id_login } = args;
+        if (!id_login || id_login === '0') {
+            throw new Error('O parâmetro "id_login" não pode ser null, undefined ou 0.');
+        }
         const requestEmitter = new RequestEmitter_1.default(src);
         requestEmitter.setupQuery({ get_id: id_login });
         return yield requestEmitter.sendRequestToResource();

package/dist/utils/FileUtils.d.ts

@@ -2,5 +2,4 @@ export declare class FileUtils {
     private static LOOP_LIMIT;
     private currentLoop;
     findFile(fileName: string, currentDir?: string): any;
-    reachedLoopLimit(): boolean;
 }

package/dist/utils/FileUtils.js

@@ -13,15 +13,12 @@ class FileUtils {
             return filePath;
         }
         const parentDir = path_1.default.dirname(currentDir);
-        if ((parentDir === currentDir) || this.reachedLoopLimit()) {
-            throw new Error(`O arquivo '${fileName}' não foi encontrado`);
+        if ((parentDir === currentDir) || this.currentLoop >= FileUtils.LOOP_LIMIT) {
+            throw new Error(`IXC-ORM::ERR > O arquivo '${fileName}' não foi encontrado`);
         }
         this.currentLoop++;
         return this.findFile(fileName, parentDir);
     }
-    reachedLoopLimit() {
-        return this.currentLoop >= FileUtils.LOOP_LIMIT;
-    }
 }
 exports.FileUtils = FileUtils;
 FileUtils.LOOP_LIMIT = 4;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ixc-orm",
-  "version": "1.10.5",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -30,7 +30,6 @@
     "url": "https://github.com/SousaFelipe/ixc-orm/issues"
   },
   "dependencies": {
-    "axios": "^1.13.2",
     "dotenv": "^17.2.3"
   },
   "devDependencies": {

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_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"}
+{"root":["./src/ixcorm.ts","./src/ixcresponse.ts","./src/index.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/utils/fileutils.ts","./src/utils/textutils.ts","./src/utils/index.ts"],"version":"5.9.3"}

package/dist/IXCClient.d.ts

@@ -1,67 +0,0 @@
-import { IXCOptions, IXCQuery, IXCResponse, IXCSortOrder } from './types';
-export default abstract class IXCClient {
-    protected table: string;
-    protected params: IXCQuery[];
-    protected options: IXCOptions;
-    /**
-     * @param table O nome da tabela correspondente ao banco de dados do seu servidor IXC
-     * @see {@link https://wikiapiprovedor.ixcsoft.com.br/index.php}
-     */
-    constructor(table: string);
-    /**
-     * Incrementa o array de parâmetros que serão trasformados no corpo de uma requisição
-     * e passados como filtro grid da API do IXC
-     *
-     * @param whereClauses Um array de strings, no formato [coluna, operador, valor]\
-     * `Obs`: se você passar um array no formato [coluna, valor] o operador será considerado como '='\
-     * Os operadores válidos são: =, !=, >, <, >=, <=, LIKE
-     * @returns A própria instância
-     */
-    where(whereClauses: string[]): IXCClient;
-    /**
-     * Define como a API do IXC ordenará os dados retornados
-     *
-     * @param column A coluna que será usada para ordenar a busca
-     * @param order A ordem da busca ('asc'ou 'desc')
-     * @returns A própria instância
-     */
-    orderBy(column: string, order: keyof typeof IXCSortOrder): IXCClient;
-    /**
-     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`\
-     * A `query` dessa requisição não será enviada para o IXC com o parâmetro `grid_param`\
-     * Ou seja, esta requisição executa uma busca simples, em vez do filtro de grid
-     *
-     * @param id O identificador numérico do registro que será buscado no IXC
-     * @returns Promise<IXCResponse>
-     */
-    find(id: any): Promise<IXCResponse>;
-    /**
-     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`
-     * Preenche o corpo da requisição com os dados passados pela função `where` no formado JSON
-     *
-     * @param pg O número da página que será solicitada ao IXC `padão = 1`
-     * @param rows A quantidade de linhas (registros) por página `padrão = 20`
-     * @returns Promise<IXCResponse>
-     */
-    get(pg?: number, rows?: number): Promise<IXCResponse>;
-    /**
-     * Envia uma requisição do tipo `POST` para a API do IXC, com o header `ixcsoft` vazio
-     *
-     * @param body Um objeto no formado "chave: valor" contendo as informações do novo registro
-     * a ser inserido no banco de dados do seu servidor IXC
-     * @returns Promise<IXCResponse>
-     */
-    post(body?: {
-        [key: string]: any;
-    }): Promise<IXCResponse>;
-    /**
-     * Envia uma requisição do tipo `PUT` para a API do IXC, com o header `ixcsoft` vazio
-     *
-     * @param id O id do registro que será alterado
-     * @param body Um objeto no formado "chave : valor" contendo as colunas que serão alteradas
-     * @returns Promise<IXCResponse>
-     */
-    put(id: number, body?: {
-        [key: string]: any;
-    }): Promise<IXCResponse>;
-}

package/dist/IXCClient.js

@@ -1,238 +0,0 @@
-"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 __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const request_1 = require("./request");
-const types_1 = require("./types");
-const response_1 = require("./response");
-class IXCClient {
-    /**
-     * @param table O nome da tabela correspondente ao banco de dados do seu servidor IXC
-     * @see {@link https://wikiapiprovedor.ixcsoft.com.br/index.php}
-     */
-    constructor(table) {
-        this.table = table;
-        this.params = [];
-        this.options = {
-            page: 1,
-            rowsPerPage: 20,
-            sortName: 'id',
-            sortOrder: 'asc'
-        };
-    }
-    /**
-     * Incrementa o array de parâmetros que serão trasformados no corpo de uma requisição
-     * e passados como filtro grid da API do IXC
-     *
-     * @param whereClauses Um array de strings, no formato [coluna, operador, valor]\
-     * `Obs`: se você passar um array no formato [coluna, valor] o operador será considerado como '='\
-     * Os operadores válidos são: =, !=, >, <, >=, <=, LIKE
-     * @returns A própria instância
-     */
-    where(whereClauses) {
-        if (whereClauses.length > 3) {
-            throw new Error(`> As cláusulas não podem conter mais de 3 elementos.`);
-        }
-        const [alwaysColumn, operatorOrValue, valueOrUndefined] = whereClauses;
-        const availableOperators = Object.keys(types_1.IXCOperator);
-        if (whereClauses.length > 2 && !availableOperators.includes(operatorOrValue)) {
-            throw new Error(`> O operador ${operatorOrValue}, não faz parte dos operadores válidos: ${availableOperators}.`);
-        }
-        this.params.push({
-            TB: alwaysColumn,
-            OP: valueOrUndefined ? operatorOrValue : '=',
-            P: valueOrUndefined ? valueOrUndefined : operatorOrValue
-        });
-        return this;
-    }
-    /**
-     * Define como a API do IXC ordenará os dados retornados
-     *
-     * @param column A coluna que será usada para ordenar a busca
-     * @param order A ordem da busca ('asc'ou 'desc')
-     * @returns A própria instância
-     */
-    orderBy(column, order) {
-        this.options.sortName = column;
-        this.options.sortOrder = order;
-        return this;
-    }
-    /**
-     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`\
-     * A `query` dessa requisição não será enviada para o IXC com o parâmetro `grid_param`\
-     * Ou seja, esta requisição executa uma busca simples, em vez do filtro de grid
-     *
-     * @param id O identificador numérico do registro que será buscado no IXC
-     * @returns Promise<IXCResponse>
-     */
-    find(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const params = {
-                TB: 'id',
-                OP: '=',
-                P: id
-            };
-            const opts = {
-                page: 1,
-                rowsPerPage: 1,
-            };
-            const axios = (0, request_1.createAxiosInstance)('GET');
-            const data = (0, request_1.createRequestPayload)(this.table, params, opts);
-            try {
-                const response = yield axios.get(this.table, { data });
-                if (response.status === 200) {
-                    return response.data;
-                }
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
-                });
-            }
-            catch (error) {
-                console.error(error);
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
-                });
-            }
-            finally {
-                this.params = [];
-                this.options = {
-                    page: 1,
-                    rowsPerPage: 20,
-                    sortName: 'id',
-                    sortOrder: 'asc'
-                };
-            }
-        });
-    }
-    /**
-     * Envia uma requisição GET para a API do IXC, com o header `ixcsoft` definico como `listar`
-     * Preenche o corpo da requisição com os dados passados pela função `where` no formado JSON
-     *
-     * @param pg O número da página que será solicitada ao IXC `padão = 1`
-     * @param rows A quantidade de linhas (registros) por página `padrão = 20`
-     * @returns Promise<IXCResponse>
-     */
-    get(pg, rows) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const _c = this.options, { page, rowsPerPage } = _c, rest = __rest(_c, ["page", "rowsPerPage"]);
-            const opts = Object.assign({ page: pg !== null && pg !== void 0 ? pg : page, rowsPerPage: rows !== null && rows !== void 0 ? rows : rowsPerPage }, rest);
-            const axios = (0, request_1.createAxiosInstance)('GET');
-            const data = (0, request_1.createRequestPayload)(this.table, this.params, opts);
-            try {
-                const response = yield axios.get(this.table, { data });
-                if (response.status === 200) {
-                    return response.data;
-                }
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
-                });
-            }
-            catch (error) {
-                console.error(error);
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
-                });
-            }
-            finally {
-                this.params = [];
-                this.options = {
-                    page: 1,
-                    rowsPerPage: 20,
-                    sortName: 'id',
-                    sortOrder: 'asc'
-                };
-            }
-        });
-    }
-    /**
-     * Envia uma requisição do tipo `POST` para a API do IXC, com o header `ixcsoft` vazio
-     *
-     * @param body Um objeto no formado "chave: valor" contendo as informações do novo registro
-     * a ser inserido no banco de dados do seu servidor IXC
-     * @returns Promise<IXCResponse>
-     */
-    post(body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const axios = (0, request_1.createAxiosInstance)('POST');
-            try {
-                const response = yield axios.post(this.table, { data: body });
-                if (response.status === 200) {
-                    return response.data;
-                }
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
-                });
-            }
-            catch (error) {
-                console.error(error);
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
-                });
-            }
-            finally {
-                this.params = [];
-            }
-        });
-    }
-    /**
-     * Envia uma requisição do tipo `PUT` para a API do IXC, com o header `ixcsoft` vazio
-     *
-     * @param id O id do registro que será alterado
-     * @param body Um objeto no formado "chave : valor" contendo as colunas que serão alteradas
-     * @returns Promise<IXCResponse>
-     */
-    put(id, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const axios = (0, request_1.createAxiosInstance)('PUT');
-            try {
-                const response = yield axios.put(`${this.table}/${id}`, { data: body });
-                if (response.status === 200) {
-                    return response.data;
-                }
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: (_a = response.data) === null || _a === void 0 ? void 0 : _a.message
-                });
-            }
-            catch (error) {
-                console.error(error);
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: ((_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText) || error.message || 'Erro desconhecido'
-                });
-            }
-            finally {
-                this.params = [];
-            }
-        });
-    }
-}
-exports.default = IXCClient;

package/dist/recursos/recurso.d.ts

@@ -1,7 +0,0 @@
-import { IXCResponse } from '../types';
-export default function recurso({ src, data }: {
-    src: string;
-    data: {
-        [key: string]: any;
-    };
-}): Promise<IXCResponse>;

package/dist/recursos/recurso.js

@@ -1,48 +0,0 @@
-"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 __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = recurso;
-const request_1 = require("../request");
-const response_1 = require("../response");
-function recurso(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ src, data }) {
-        const axios = (0, request_1.createAxiosInstance)('PUT');
-        try {
-            const response = yield axios.get(src, { data });
-            if (response.status === 200) {
-                const { data } = response;
-                const { message, mensagem } = data, rest = __rest(data, ["message", "mensagem"]);
-                if (rest.type === 'success' || rest.tipo === 'sucesso') {
-                    return (0, response_1.createResponse)(Object.assign(Object.assign({}, rest), { message: message || mensagem }));
-                }
-                return (0, response_1.createResponse)({
-                    error: true,
-                    message: message || mensagem
-                });
-            }
-        }
-        catch (error) {
-            console.error(`Erro ao executar recurso: ${src}\n`, error);
-        }
-        return (0, response_1.createResponse)({ error: true });
-    });
-}

package/dist/request.d.ts

@@ -1,20 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods } from './types';
-/**
- * Cria uma instância de um objeto AxiosInstance, pré-configurado com os cabeçalhos necessários
- * para executar uma requisição para a API do IXC
- *
- * @param method GET | POST | PUT | DELETE
- * @returns AxiosInstance
- */
-export declare function createAxiosInstance(method?: keyof typeof IXCRequestMethods): AxiosInstance;
-/**
- * Cria um objeto `IXCRequest` configurado para ser utilizado como payload de uma requisição
- * para a API do IXC
- *
- * @param table Nome da tabela do IXC onde será feita a busca, atualização, inserção ou remoção
- * @param params Parâmetros da busca (desconsiderados quando a ação for a de inserir novos registros)
- * @param options Parâmetros de formatação dos dados da responsta (página, ítens por página e ordenação)
- * @returns IXCRequest
- */
-export declare function createRequestPayload(table: string, params: IXCQuery | IXCQuery[], options?: IXCOptions): IXCRequest;

package/dist/request.js

@@ -1,73 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAxiosInstance = createAxiosInstance;
-exports.createRequestPayload = createRequestPayload;
-const axios_1 = __importDefault(require("axios"));
-/**
- * Cria uma instância de um objeto AxiosInstance, pré-configurado com os cabeçalhos necessários
- * para executar uma requisição para a API do IXC
- *
- * @param method GET | POST | PUT | DELETE
- * @returns AxiosInstance
- */
-function createAxiosInstance(method = 'GET') {
-    const host = process.env.IXC_HOST;
-    const token = process.env.IXC_TOKEN;
-    return axios_1.default.create({
-        method: method,
-        baseURL: host !== null && host !== void 0 ? host : 'http://127.0.0.1/webservice/v1',
-        headers: {
-            'ixcsoft': (method === 'GET') ? 'listar' : '',
-            'Content-Type': 'application/json',
-            'Authorization': `Basic ${Buffer.from(token !== null && token !== void 0 ? token : '').toString('base64')}`
-        }
-    });
-}
-/**
- * Cria um objeto `IXCRequest` configurado para ser utilizado como payload de uma requisição
- * para a API do IXC
- *
- * @param table Nome da tabela do IXC onde será feita a busca, atualização, inserção ou remoção
- * @param params Parâmetros da busca (desconsiderados quando a ação for a de inserir novos registros)
- * @param options Parâmetros de formatação dos dados da responsta (página, ítens por página e ordenação)
- * @returns IXCRequest
- */
-function createRequestPayload(table, params, options) {
-    var _a, _b, _c, _d;
-    const page = (_a = options === null || options === void 0 ? void 0 : options.page) !== null && _a !== void 0 ? _a : 1;
-    const rowsPerPage = (_b = options === null || options === void 0 ? void 0 : options.rowsPerPage) !== null && _b !== void 0 ? _b : 20;
-    const sortName = (_c = options === null || options === void 0 ? void 0 : options.sortName) !== null && _c !== void 0 ? _c : 'id';
-    const sortOrder = (_d = options === null || options === void 0 ? void 0 : options.sortOrder) !== null && _d !== void 0 ? _d : 'asc';
-    if (Array.isArray(params)) {
-        let grid_param = [];
-        params.forEach(p => {
-            grid_param.push({
-                TB: `${table}.${p.TB}`,
-                OP: p.OP || '=',
-                P: p.P
-            });
-        });
-        return {
-            qtype: table,
-            query: '',
-            oper: '',
-            page: page,
-            rp: rowsPerPage,
-            sortname: `${table}.${sortName}`,
-            sortorder: sortOrder,
-            grid_param: JSON.stringify(grid_param)
-        };
-    }
-    return {
-        qtype: `${table}.${params.TB}`,
-        query: params.P,
-        oper: params.OP || '=',
-        page: page,
-        rp: rowsPerPage,
-        sortname: `${table}.${sortName}`,
-        sortorder: sortOrder
-    };
-}

package/dist/response.d.ts

@@ -1,4 +0,0 @@
-import { IXCResponse } from './types';
-export declare function createResponse(data: {
-    [key: string]: any;
-}): IXCResponse;

package/dist/response.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createResponse = createResponse;
-function createResponse(data) {
-    var _a, _b, _c, _d;
-    return {
-        error: data.error || false,
-        message: data.message || '',
-        id: (_a = data.id) !== null && _a !== void 0 ? _a : 0,
-        page: (_b = data.page) !== null && _b !== void 0 ? _b : 0,
-        total: (_c = data.total) !== null && _c !== void 0 ? _c : 0,
-        registros: (_d = data.registros) !== null && _d !== void 0 ? _d : []
-    };
-}

package/dist/types.d.ts

@@ -1,56 +0,0 @@
-export declare const IXCOperator: {
-    '=': string;
-    '>': string;
-    '<': string;
-    '>=': string;
-    '<=': string;
-    '!=': string;
-    LIKE: string;
-};
-export declare const IXCSortOrder: {
-    asc: string;
-    desc: string;
-};
-export declare const IXCRequestMethods: {
-    GET: string;
-    POST: string;
-    PUT: string;
-    DELETE: string;
-};
-export interface IXCOptions {
-    page: number;
-    rowsPerPage?: number;
-    sortName?: string;
-    sortOrder?: keyof typeof IXCSortOrder;
-}
-export interface IXCQuery {
-    TB: string;
-    OP?: string;
-    P: string;
-}
-export interface IXCRequest {
-    qtype: string;
-    query: string;
-    oper: string;
-    page: number;
-    rp: number;
-    sortname: string;
-    sortorder: string;
-    grid_param?: string;
-}
-export interface IXCResponse {
-    error?: boolean | object;
-    type?: string;
-    message?: string;
-    id?: string | number;
-    page: number | string;
-    total: number;
-    registros: Array<{
-        [key: string]: any;
-    }>;
-}
-export interface IXCRecursoResponse {
-    data: any;
-    error?: boolean | object;
-    message?: string;
-}

package/dist/types.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IXCRequestMethods = exports.IXCSortOrder = exports.IXCOperator = void 0;
-exports.IXCOperator = {
-    '=': '=',
-    '>': '>',
-    '<': '<',
-    '>=': '>=',
-    '<=': '<=',
-    '!=': '!=',
-    'LIKE': 'L'
-};
-exports.IXCSortOrder = {
-    asc: 'asc',
-    desc: 'desc'
-};
-exports.IXCRequestMethods = {
-    GET: 'GET',
-    POST: 'POST',
-    PUT: 'PUT',
-    DELETE: 'DELETE'
-};
-;
-;
-;
-;
-;