ixc-orm 1.7.1 → 1.8.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # 🔄 CHANGELOG
+- [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)
 - [v1.6.0 - 16 de agosto de 2025](#v150)
@@ -9,6 +10,10 @@
 
 ## 🚀 Novidades
 
+### 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.
+
 ### v1.7.1
 * **Melhoria:** Adicionado o método `fail()` à classe <a href="https://github.com/SousaFelipe/ixc-orm/blob/main/src/IxcResponse.ts">IxcResponse</a>, para verificar se o IXC Provedor retornou uma resposta com erro.
 

package/README.md

@@ -33,7 +33,7 @@ yarn add ixc-orm
 Para configurar a comunicação da biblioteca com seu servidor IXC Provedor, é necessário adicionar as seguintes variáveis de ambiente a um arquivo `.env`, que esteja localizado no diretório raiz do seu projeto.
 
 > [!NOTE]\
-> Versão 1.7.1 `stable`
+> Versão 1.8.0 `stable`
 
 - **IXC_ACCESS_TOKEN** Um token de API gerado dentro do IXC Provedor.
 - **IXC_SERVER_DOMAIN** O domínio do seu servidor IXC Provedor.
@@ -43,6 +43,19 @@ IXC_ACCESS_TOKEN=conteúdo-do-token-gerado-dentro-do-ixc
 IXC_SERVER_DOMAIN=www.dominio-do-seu-servidor-ixc.com.br
 ```
 
+Você também poderá configurar para que o Docker carregue as variáveis, ao invés de carregá-las diretamente do arquivo `.env`, dessa forma:
+
+```yaml
+services:
+  sua-aplicacao:
+    build: .
+    image: sua-imagem-docker
+    environment:
+      - IXC_ACCESS_TOKEN=${IXC_ACCESS_TOKEN}
+      - IXC_SERVER_DOMAIN=${IXC_SERVER_DOMAIN}
+    # Outras configurações do seu serviço
+```
+
 
 > Versão 1.6.0 ou anterior:
 
@@ -57,7 +70,7 @@ IXC_TOKEN="8:k4n8wk1946j7mimthei869cq1zz2u940f2gqobqg081y2oefl80mzhtq2wud3gqp"
 As classes que representarão os diferentes tipos de registros no seu **IXC Provedor**, deverão herdar da classe `IxcOrm` (nova versão), como no exemplo a seguir:
 
 > [!NOTE]\
-> Versão 1.7.1 `stable`
+> Versão 1.8.0 `stable`
 
 ```typescript
 import { IxcOrm } from 'ixc-orm';
@@ -84,7 +97,7 @@ class Contrato extends IXCClient {
 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.7.1 `stable`
+> Versão 1.8.0 `stable`
 
 ```typescript
 import { IxcResponse, Sort } from 'ixc-orm';

package/babel.config.cjs

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

package/dist/api/Environment.d.ts

@@ -4,8 +4,10 @@ export default class Environment {
     private token;
     static getInstance(): Environment;
     private constructor();
+    private shouldToLoadDotEnvFile;
+    private loadedEnvVars;
+    private setDomain;
+    private setToken;
     getDomain(): string;
     getToken(): string;
-    setDomain(domain?: string): void;
-    setToken(token?: string): void;
 }

package/dist/api/Environment.js

@@ -1,5 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const dotenv_1 = __importDefault(require("dotenv"));
+const utils_1 = __importDefault(require("../utils"));
 class Environment {
     static getInstance() {
         if (!Environment.instance) {
@@ -7,12 +13,31 @@ class Environment {
         }
         return Environment.instance;
     }
-    constructor() { }
-    getDomain() {
-        return this.domain;
+    constructor() {
+        this.shouldToLoadDotEnvFile();
+        this.setToken(process.env.IXC_ACCESS_TOKEN);
+        this.setDomain(process.env.IXC_SERVER_DOMAIN);
     }
-    getToken() {
-        return this.token;
+    shouldToLoadDotEnvFile() {
+        if (this.loadedEnvVars()) {
+            return;
+        }
+        const fileUtil = new utils_1.default.File();
+        const envfile = fileUtil.findFile('.env');
+        const env = dotenv_1.default.config({
+            quiet: true,
+            path: path_1.default.resolve(envfile)
+        });
+        if (env.error) {
+            console.error(env.error);
+            process.exit(1);
+        }
+    }
+    loadedEnvVars() {
+        const allEnvVars = Object.keys(process.env);
+        return allEnvVars.some(envVar => {
+            return envVar.startsWith('IXC_');
+        });
     }
     setDomain(domain) {
         var _a;
@@ -30,5 +55,11 @@ class Environment {
             this.token = token;
         }
     }
+    getDomain() {
+        return this.domain;
+    }
+    getToken() {
+        return this.token;
+    }
 }
 exports.default = Environment;

package/dist/api/Ordering.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sort = void 0;
-const Utils_1 = __importDefault(require("./Utils"));
+const utils_1 = __importDefault(require("../utils"));
 var Sort;
 (function (Sort) {
     Sort["ASC"] = "asc";
@@ -13,13 +13,13 @@ var Sort;
 ;
 class Ordering {
     static ascBy(table, column) {
-        const normalizedTable = Utils_1.default.Text.normalize(table);
-        const normalizedColumn = Utils_1.default.Text.normalize(column);
+        const normalizedTable = utils_1.default.Text.normalize(table);
+        const normalizedColumn = utils_1.default.Text.normalize(column);
         return new Ordering(`${normalizedTable}.${normalizedColumn}`, Sort.ASC);
     }
     static descBy(table, column) {
-        const normalizedTable = Utils_1.default.Text.normalize(table);
-        const normalizedColumn = Utils_1.default.Text.normalize(column);
+        const normalizedTable = utils_1.default.Text.normalize(table);
+        const normalizedColumn = utils_1.default.Text.normalize(column);
         return new Ordering(`${normalizedTable}.${normalizedColumn}`, Sort.DESC);
     }
     constructor(sortName, sortOrder) {

package/dist/api/Parameter.js

@@ -4,16 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Operators_1 = __importDefault(require("./Operators"));
-const Utils_1 = __importDefault(require("./Utils"));
+const utils_1 = __importDefault(require("../utils"));
 class Parameter {
     constructor(table) {
-        this.table = Utils_1.default.Text.normalize(table);
+        this.table = utils_1.default.Text.normalize(table);
         this.operator = Operators_1.default.EQUALS;
         this.type = this.table;
         this.value = '';
     }
     withType(type) {
-        const normalizedType = Utils_1.default.Text.normalize(type);
+        const normalizedType = utils_1.default.Text.normalize(type);
         this.type = `${this.table}.${normalizedType}`;
         return this;
     }

package/dist/api/RequestEmitter.js

@@ -25,7 +25,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Environment_1 = __importDefault(require("./Environment"));
 const IxcResponse_1 = __importDefault(require("../IxcResponse"));
-const Utils_1 = __importDefault(require("./Utils"));
+const utils_1 = __importDefault(require("../utils"));
 class RequestEmitter {
     /**
      * Método construtor da classe.
@@ -33,7 +33,7 @@ class RequestEmitter {
      * @param table Representa o endpoint do IXC Provedor para o qual será enviada a requisição.
      */
     constructor(table) {
-        this.table = Utils_1.default.Text.normalize(table);
+        this.table = utils_1.default.Text.normalize(table);
         this.headers = [];
         this.query = '';
         this.uri = '';

package/dist/index.d.ts

@@ -5,8 +5,9 @@ import IxcOrm from './IxcOrm';
 import IxcResponse from './IxcResponse';
 import Operators from './api/Operators';
 import Ordering from './api/Ordering';
+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, 
+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}

package/dist/index.js

@@ -36,9 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecursoIXC = exports.Ordering = exports.Operators = exports.IxcResponse = exports.IxcOrm = exports.Environment = exports.Recurso = exports.IXCSortOrder = exports.IXCRequestMethods = exports.IXCOperator = exports.IXCClient = void 0;
-const path_1 = __importDefault(require("path"));
-const dotenv_1 = __importDefault(require("dotenv"));
+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"));
@@ -54,20 +52,10 @@ 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 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; } });
-const root = (__dirname.includes('\\node_modules\\'))
-    ? path_1.default.join(__dirname, '../../../.env')
-    : path_1.default.join(__dirname, '../.env');
-const env = dotenv_1.default.config({
-    quiet: true,
-    path: path_1.default.resolve(root)
-});
-if (env.error) {
-    console.error(env.error);
-    process.exit(1);
-}
-Environment_1.default.getInstance().setToken(process.env.IXC_ACCESS_TOKEN);
-Environment_1.default.getInstance().setDomain(process.env.IXC_SERVER_DOMAIN);
+Environment_1.default.getInstance();

package/dist/utils/FileUtils.d.ts

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

package/dist/utils/FileUtils.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileUtils = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class FileUtils {
+    findFile(fileName, currentDir = process.cwd()) {
+        const filePath = path_1.default.join(currentDir, fileName);
+        if (fs_1.default.existsSync(filePath)) {
+            return filePath;
+        }
+        const parentDir = path_1.default.dirname(currentDir);
+        if ((parentDir === currentDir) || this.reachedLoopLimit()) {
+            throw new Error(`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/dist/utils/TextUtils.d.ts

@@ -0,0 +1,3 @@
+export declare class TextUtils {
+    static normalize(text: string): string;
+}

package/dist/{api/Utils.js → utils/TextUtils.js}

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextUtils = void 0;
 class TextUtils {
     static normalize(text) {
         return text.replace(/[^a-z0-9_]/gi, '').trim();
     }
 }
-const Utils = {
-    Text: TextUtils
-};
-exports.default = Utils;
+exports.TextUtils = TextUtils;

package/dist/utils/index.d.ts

@@ -0,0 +1,7 @@
+import { FileUtils } from './FileUtils';
+import { TextUtils } from './TextUtils';
+declare const Utils: {
+    File: typeof FileUtils;
+    Text: typeof TextUtils;
+};
+export default Utils;

package/dist/utils/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const FileUtils_1 = require("./FileUtils");
+const TextUtils_1 = require("./TextUtils");
+const Utils = {
+    File: FileUtils_1.FileUtils,
+    Text: TextUtils_1.TextUtils,
+};
+exports.default = Utils;

package/jest.config.ts

@@ -14,7 +14,7 @@ const config: Config = {
   },
 
   collectCoverageFrom: [
-    "**/*.(t|j)s"
+    "**/src/**/*.(t|j)s"
   ],
 
   setupFiles: [

package/package.json

@@ -1,16 +1,14 @@
 {
   "name": "ixc-orm",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
-  "description": "ORM para consumo de dados da API oficial do IXCsoft",
+  "description": "ORM para consumo de dados da API do sistema IXC Provedor",
   "scripts": {
-    "declare": "tsc --declaration",
-    "build": "tsc --build",
     "dev": "nodemon --watch \"src//\" --exec \"ts-node src/index.ts\" -e ts",
-    "test": "jest",
-    "test:cov": "jest --coverage"
+    "test": "jest --coverage",
+    "build": "tsc --build"
   },
   "repository": {
     "type": "git",
@@ -25,25 +23,26 @@
   "author": {
     "name": "Felipe S. Carmo",
     "email": "fscarmo@proton.me",
-    "url": "https://github.com/SousaFelipe"
+    "url": "https://www.fscarmo.dev.br/"
   },
   "bugs": {
     "url": "https://github.com/SousaFelipe/ixc-orm/issues"
   },
   "dependencies": {
     "axios": "^1.12.2",
-    "dotenv": "^17.2.2",
-    "jsdom": "^27.0.0"
+    "dotenv": "^17.2.3",
+    "jsdom": "^27.0.1"
   },
   "devDependencies": {
+    "@babel/preset-typescript": "^7.27.1",
     "@jest/globals": "^30.2.0",
     "@types/jest": "^30.0.0",
     "@types/jsdom": "^27.0.0",
-    "@types/node": "^24.5.2",
+    "@types/node": "^24.8.1",
     "jest": "^30.2.0",
     "nodemon": "^3.1.10",
     "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   }
 }

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/api/utils.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"}
+{"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"}

package/dist/api/Utils.d.ts

@@ -1,7 +0,0 @@
-declare class TextUtils {
-    static normalize(text: string): string;
-}
-declare const Utils: {
-    Text: typeof TextUtils;
-};
-export default Utils;