ixc-orm 1.4.4 → 1.5.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 🔄 CHANGELOG
+- [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)
+- [v1.4.1 - 14 de agosto de 2025](#v141)
+
+## 🚀 Novidades
+
+### 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 })`.
+
+### 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.
+
+### v1.4.3
+* **Melhoria:** Os métodos `get()`, `post()` e `put()` da classe `IXCClient`, a partir de agora sempre retornarão um objeto `IXCResponse`, indepedente da requisição falhar ou não.
+
+### v1.4.1
+* **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/)

package/README.md

@@ -1,25 +1,12 @@
 # IXC-ORM [![npm](https://img.shields.io/npm/dt/ixc-orm.svg)](https://www.npmjs.com/package/ixc-orm)
 
-Este ORM simples visa facilitar o consumo de dados da API oficial do IXCsoft.\
-Esta biblioteca não faz parte das bibliotecas oficiais da IXCsoft e foi desenvolvida de forma independente e sem fins lucrativos.
+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.
 
 
-## 🚀 Novidades
-
-### v1.4.4 - 15 de agosto de 2025
-* **Melhorado:** Foi adicionado um método `find()` a classe `IXCClient`, para encontrar um registro pelo seu `id` de uma forma mais simples.
-
-### v1.4.3 - 15 de agosto de 2025
-* **Melhorado:** Os métodos `get()`, `post()` e `put()` da classe `IXCClient`, a partir de agora sempre retornarão um objeto `IXCResponse`, indepedente da requisição falhar ou não.
-
-### v1.4.1 - 14 de agosto de 2025
-* **Corrigido:** Resolvido o bug de leitura das variáveis de ambiente no arquivo .env na pasta raiz.
-* **Novo:** 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/)
-
 
 ## Instalação
+
 ```bash
 npm install ixc-orm
 ```
@@ -29,15 +16,15 @@ yarn add ixc-orm
 ```
 
 
+
 ## Usando a biblioteca
 
-> As classes que representarão as tabelas dentro do banco de dados do seu servidor IXC, deverão herdar da classe `IXCClient`.
+> 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:
 
 ```typescript
 import { IXCClient } 'ixc-orm';
 
 class Contrato extends IXCClient {
-  
   constructor() {
     super('cliente_contrato');
   }
@@ -53,17 +40,49 @@ const contratos = await contrato
   .where(['id_cliente', 240])
   .where(['data_ativacao', '>=', '2024-09-24 00:45:00'])
   .orderBy('data_ativacao', 'desc')
-  .get();
+  .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`
+
+```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.\
+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:
+
+```typescript
+import { RecursoIXC } from 'ixc-orm';
+
+const id_fatura = 45852;
+
+const response = await RecursoIXC('get_boleto', { id_fatura })
+```
+
+> Dos recursos disponibilizados pela API do **IXC Provedor**, esta biblioteca já implementou os seguintes recursos:\
+> `get_boleto`, `desbloqueio_confianca` e `cliente_contrato_btn_lib_temp_24722`.\
+> Obs: Os nomes dos recursos estão de acordo com a API do **IXC Provedor** a fim de facilitar o estudo de sua documentação oficial.
+
+
+
 ## Variáveis de Ambiente
 
 Para configurar a comunicação da biblioteca com seu servidor IXC, é necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
 
-`IXC_HOST`
-
-`IXC_TOKEN`
+> **IXC_HOST** A url do seu servidor IXC\
+> **IXC_TOKEN** Um token de API gerado dentro do próprio **IXC Provedor**
 
-> **IXC_HOST** A url do seu servidor IXC, no formato: `https://seudominio.com.br/webservice/v1`\
-> **IXC_TOKEN** Um token de API gerado dentro do seu sistema IXCsoft.
+```ini
+IXC_HOST="https://dominiodoservidorixc.com.br/webservice/v1"
+IXC_TOKEN="8:k4n8wk1946j7mimthei869cq1zz2u940f2gqobqg081y2oefl80mzhtq2wud3gqp"
+```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import IXCClient from './IXCClient';
-import recursos from './recursos';
+import RecursoIXC from './recursos';
 import { IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder } from './types';
-export { IXCClient, IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder, recursos };
+export { IXCClient, IXCOperator, IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods, IXCResponse, IXCSortOrder, RecursoIXC };

package/dist/index.js

@@ -3,20 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.recursos = exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
+exports.RecursoIXC = exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
 const path_1 = __importDefault(require("path"));
 const dotenv_1 = __importDefault(require("dotenv"));
 const IXCClient_1 = __importDefault(require("./IXCClient"));
 exports.IXCClient = IXCClient_1.default;
 const recursos_1 = __importDefault(require("./recursos"));
-exports.recursos = recursos_1.default;
+exports.RecursoIXC = recursos_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; } });
 const root = (__dirname.includes('\\node_modules\\'))
-    ? path_1.default.join(__dirname, `../../../.env`)
-    : path_1.default.join(__dirname, `../../.env`);
+    ? path_1.default.join(__dirname, '../../../.env')
+    : path_1.default.join(__dirname, '../../.env');
 const env = dotenv_1.default.config({ path: root });
 if (env.error) {
     console.error(env.error);

package/dist/recursos/cliente_contrato_btn_lib_temp_24722.d.ts

@@ -1,6 +1,4 @@
 import { IXCResponse } from '../types';
-declare function execute(id_contrato: string | number): Promise<IXCResponse>;
-declare const _default: {
-    readonly execute: typeof execute;
-};
-export default _default;
+export default function cliente_contrato(args: {
+    id_contrato?: string | number;
+}): Promise<IXCResponse>;

package/dist/recursos/cliente_contrato_btn_lib_temp_24722.js

@@ -12,14 +12,17 @@ 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"));
 const src = 'cliente_contrato_btn_lib_temp_24722';
-function execute(id_contrato) {
+function cliente_contrato(args) {
     return __awaiter(this, void 0, void 0, function* () {
+        const { id_contrato } = args;
         return yield (0, recurso_1.default)({
             src,
-            data: { id_contrato }
+            data: {
+                id_contrato
+            }
         });
     });
 }
-exports.default = { execute };

package/dist/recursos/desbloqueio_confianca.d.ts

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

package/dist/recursos/desbloqueio_confianca.js

@@ -12,14 +12,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = desbloqueio_confianca;
 const recurso_1 = __importDefault(require("./recurso"));
 const src = 'desbloqueio_confianca';
-function execute(id_contrato) {
+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 }
+            data: {
+                id_contrato
+            }
         });
     });
 }
-exports.default = { execute };

package/dist/recursos/get_boleto.d.ts

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

package/dist/recursos/get_boleto.js

@@ -9,13 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = get_boleto;
 const request_1 = require("../request");
 const response_1 = require("../response");
 const SRC = 'get_boleto';
-function execute(id_fatura) {
+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,
@@ -38,4 +40,3 @@ function execute(id_fatura) {
         return (0, response_1.createResponse)({ error: true });
     });
 }
-exports.default = { execute };

package/dist/recursos/index.d.ts

@@ -1,12 +1,19 @@
-declare const _default: {
-    readonly desbloqueio_confianca: {
-        readonly execute: (id_contrato: string | number) => Promise<import("..").IXCResponse>;
-    };
-    readonly get_boleto: {
-        readonly execute: (id_fatura: string | number) => Promise<import("..").IXCResponse | import("../types").IXCRecursoResponse>;
-    };
-    readonly liberacao_temporaria: {
-        readonly execute: (id_contrato: string | number) => Promise<import("..").IXCResponse>;
-    };
+import cliente_contrato from './cliente_contrato_btn_lib_temp_24722';
+import desbloqueio_confianca from './desbloqueio_confianca';
+import get_boleto from './get_boleto';
+declare const recursos: {
+    cliente_contrato: typeof cliente_contrato;
+    desbloqueio_confianca: typeof desbloqueio_confianca;
+    get_boleto: typeof get_boleto;
 };
-export default _default;
+type Recursos = typeof recursos;
+/**
+ * Uma função que simplifica a execução de recursos específicos da API do IXC\
+ * Para encontrar todos os recursos, acesse: {@link https://wikiapiprovedor.ixcsoft.com.br/}
+ *
+ * @param recurso O nome do recurso a ser executado
+ * @param args Os argumentos que devem ser passado para o manipulador do recurso
+ * @returns Promise<IXCResponse | IXCRecursoResponse>
+ */
+export default function RecursoIXC<T extends keyof Recursos>(recurso: T, args: Parameters<Recursos[T]>[0]): Promise<import("..").IXCResponse | import("../types").IXCRecursoResponse>;
+export {};

package/dist/recursos/index.js

@@ -1,13 +1,37 @@
 "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 = 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"));
-exports.default = {
+const recursos = {
+    cliente_contrato: cliente_contrato_btn_lib_temp_24722_1.default,
     desbloqueio_confianca: desbloqueio_confianca_1.default,
-    get_boleto: get_boleto_1.default,
-    liberacao_temporaria: cliente_contrato_btn_lib_temp_24722_1.default,
+    get_boleto: get_boleto_1.default
 };
+/**
+ * Uma função que simplifica a execução de recursos específicos da API do IXC\
+ * Para encontrar todos os recursos, acesse: {@link https://wikiapiprovedor.ixcsoft.com.br/}
+ *
+ * @param recurso O nome do recurso a ser executado
+ * @param args Os argumentos que devem ser passado para o manipulador do recurso
+ * @returns Promise<IXCResponse | IXCRecursoResponse>
+ */
+function RecursoIXC(recurso, args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const handler = recursos[recurso];
+        return yield handler(args);
+    });
+}

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/ixcclient.ts","../src/index.ts","../src/request.ts","../src/response.ts","../src/types.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/recursos/types.ts"],"version":"5.6.2"}
+{"root":["../src/ixcclient.ts","../src/index.ts","../src/request.ts","../src/response.ts","../src/types.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"],"version":"5.9.2"}

package/dist/types.d.ts

@@ -49,6 +49,7 @@ export interface IXCResponse {
     }>;
 }
 export interface IXCRecursoResponse {
-    error?: boolean | object;
     data: any;
+    error?: boolean | object;
+    message?: string;
 }

package/dist/types.js

@@ -20,3 +20,8 @@ exports.IXCRequestMethods = {
     PUT: 'PUT',
     DELETE: 'DELETE'
 };
+;
+;
+;
+;
+;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ixc-orm",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -28,13 +28,13 @@
     "url": "https://github.com/SousaFelipe/ixc-orm/issues"
   },
   "dependencies": {
-    "axios": "^1.10.0",
-    "dotenv": "^17.1.0"
+    "axios": "^1.11.0",
+    "dotenv": "^17.2.1"
   },
   "devDependencies": {
-    "@types/node": "^24.0.12",
+    "@types/node": "^24.3.0",
     "nodemon": "^3.1.10",
     "ts-node": "^10.9.2",
-    "typescript": "^5.6.2"
+    "typescript": "^5.9.2"
   }
 }

package/dist/recursos/types.d.ts

@@ -1,26 +0,0 @@
-export interface Boleto {
-    /**
-     * @property id da fatura
-     */
-    boletos: string | number;
-    /**
-     * @property // 'S'->SIM e 'N'->NÃO para cálculo de júro
-     */
-    juro: 'S' | 'N';
-    /**
-     * @property // 'S'->SIM e 'N'->NÃO para cálculo de multa
-     */
-    multa: 'S' | 'N';
-    /**
-     * @property // 'S'->SIM e 'N'->NÃO para atualizar o boleto
-     */
-    atualiza_boleto: 'S' | 'N';
-    /**
-     * @property // tipo de método que será executado
-     */
-    tipo_boleto: 'arquivo';
-    /**
-     * @property // 'S'->SIM e 'N'->NÃO para retornar o boleto em base64
-     */
-    base64: 'S' | 'N';
-}

package/dist/recursos/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });