ixc-orm 1.3.0 → 1.4.2

package/README.md

@@ -1,9 +1,19 @@
 # IXC-ORM
 
-Este ORM simples, visa facilitar o consumo de dados da API oficial do IXCsoft.\
+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.
 
 
+## 🚀 Novidades
+
+### 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

package/dist/IXCClient.d.ts

@@ -0,0 +1,53 @@
+import { AxiosError } from 'axios';
+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);
+    /**
+     *
+     * @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 '='
+     * Operadores válidos: =, !=, >, <, >=, <=, LIKE
+     * @returns A própria instância
+     */
+    where(whereClauses: string[]): IXCClient;
+    /**
+     *
+     * @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;
+    /**
+     *
+     * @param pg O número da página que será solicitada ao IXC
+     * @param rows A quantidade de linhas (registros) por página
+     * @returns Promise<null | IXCResponse | AxiosError>
+     */
+    get(pg?: number, rows?: number): Promise<null | IXCResponse | AxiosError>;
+    /**
+     *
+     * @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<null | IXCResponse | AxiosError>
+     */
+    post(body?: {
+        [key: string]: any;
+    }): Promise<null | IXCResponse | AxiosError>;
+    /**
+     *
+     * @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<null | IXCResponse | AxiosError>
+     */
+    put(id: number, body?: {
+        [key: string]: any;
+    }): Promise<null | IXCResponse | AxiosError>;
+}

package/dist/index.d.ts

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

package/dist/index.js

@@ -3,18 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
+exports.recursos = 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;
 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 env = dotenv_1.default.config({
-    path: path_1.default.join(__dirname, `../.env`)
-});
+const root = (__dirname.includes('\\node_modules\\'))
+    ? 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);
     process.exit(-1);

package/dist/recursos/cliente_contrato_btn_lib_temp_24722.d.ts

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

package/dist/recursos/cliente_contrato_btn_lib_temp_24722.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 });
+const recurso_1 = __importDefault(require("./recurso"));
+const src = 'cliente_contrato_btn_lib_temp_24722';
+function execute(id_contrato) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield (0, recurso_1.default)({
+            src,
+            data: { id_contrato }
+        });
+    });
+}
+exports.default = { execute };

package/dist/recursos/desbloqueio_confianca.d.ts

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

package/dist/recursos/desbloqueio_confianca.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 });
+const recurso_1 = __importDefault(require("./recurso"));
+const src = 'desbloqueio_confianca';
+function execute(id_contrato) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return yield (0, recurso_1.default)({
+            src,
+            data: { id_contrato }
+        });
+    });
+}
+exports.default = { execute };

package/dist/recursos/get_boleto.d.ts

@@ -0,0 +1,6 @@
+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;

package/dist/recursos/get_boleto.js

@@ -0,0 +1,41 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../request");
+const response_1 = require("../response");
+const SRC = 'get_boleto';
+function execute(id_fatura) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const axios = (0, request_1.createAxiosInstance)('PUT');
+        try {
+            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 });
+    });
+}
+exports.default = { execute };

package/dist/recursos/index.d.ts

@@ -0,0 +1,12 @@
+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>;
+    };
+};
+export default _default;

package/dist/recursos/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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 = {
+    desbloqueio_confianca: desbloqueio_confianca_1.default,
+    get_boleto: get_boleto_1.default,
+    liberacao_temporaria: cliente_contrato_btn_lib_temp_24722_1.default,
+};

package/dist/recursos/recurso.d.ts

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

package/dist/recursos/recurso.js

@@ -0,0 +1,38 @@
+"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());
+    });
+};
+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;
+                if ((data === null || data === void 0 ? void 0 : data.type) === 'success' || (data === null || data === void 0 ? void 0 : data.tipo) === 'sucesso') {
+                    return (0, response_1.createResponse)({
+                        message: data.message || data.mensagem,
+                    });
+                }
+                return (0, response_1.createResponse)({
+                    error: true,
+                    message: data.message || data.mensagem
+                });
+            }
+        }
+        catch (error) {
+            console.error(`Erro ao executar recurso: ${src}\n`, error);
+        }
+        return (0, response_1.createResponse)({ error: true });
+    });
+}

package/dist/recursos/types.d.ts

@@ -0,0 +1,26 @@
+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

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

package/dist/request.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods } from './types';
+/**
+ *
+ * @param method GET | POST | PUT | DELETE
+ * @returns A instância de um objeto do tipo AxiosInstance, pré-configurado com os cabeçalhos necessários
+ */
+export declare function createAxiosInstance(method?: keyof typeof IXCRequestMethods): AxiosInstance;
+/**
+ *
+ * @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
+ */
+export declare function createRequestPayload(table: string, params: IXCQuery | IXCQuery[], options?: IXCOptions): AxiosRequestConfig<IXCRequest>;

package/dist/response.d.ts

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

package/dist/response.js

@@ -0,0 +1,14 @@
+"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/tsconfig.tsbuildinfo

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

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+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;
+    message?: string | null;
+    id?: string | number;
+    page: number | string;
+    total: number;
+    registros: Array<{
+        [key: string]: any;
+    }>;
+}
+export interface IXCRecursoResponse {
+    error?: boolean | object;
+    data: any;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ixc-orm",
-  "version": "1.3.0",
+  "version": "1.4.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",

package/tsconfig.json

@@ -4,6 +4,7 @@
     "module": "commonjs",
     "outDir": "./dist",
     "strict": true,
+    "declaration": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noImplicitReturns": true,