ixc-orm 1.10.3 → 1.10.4

package/dist/IxcResponse.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class IxcResponse {
+    /**
+     * Cria um novo objeto no formato de uma resposta padrão do IXC Provedor.
+     *
+     * @param error Uma exceção capturada por um bloco try-catch.
+     * @returns Um objeto de resposta do IXC Provedor.
+     */
+    static createResponseTextWithError(error) {
+        var _a;
+        const response = {
+            type: 'error',
+            page: 0,
+            total: 0,
+            registros: [],
+            message: ((_a = error.response) === null || _a === void 0 ? void 0 : _a.statusText) || error.message || 'Erro desconhecido'
+        };
+        return JSON.stringify(response);
+    }
+    /**
+     * Método construtor da classe.
+     *
+     * @param text O conteúdo da resposta do IXc Provedor, no formato de texto.
+     */
+    constructor(text) {
+        this.text = text;
+        this.data = this.createDataFromText();
+    }
+    /**
+     * Verifica se o IXC Provedor retornou uma mensagem de erro.
+     *
+     * @returns **true** se o corpo da mensagem estiver dentro de tags HTML e se a mensagem dentro das tags
+     * contiver a palavra "erro". Ou se o objeto da resposta possuir a propriedade { "type": "error", ... }.
+     */
+    fail() {
+        const hasHtml = this.responseTextHasHtml();
+        const hasError = this.message().includes('erro');
+        if (hasHtml && hasError) {
+            return true;
+        }
+        if (this.data && Object.keys(this.data).includes('type')) {
+            return this.data.type === 'error';
+        }
+        return false;
+    }
+    /**
+     * Obtém a quantidade total dos registros encontrados no banco de dados, além dos retornados na página atual.
+     *
+     * @returns O total de registros encontrados.
+     */
+    total() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.total)) {
+            return 0;
+        }
+        return this.data.total;
+    }
+    /**
+     * Obtém o número da página atual dos registros retornados.
+     *
+     * @returns O valor numérico da página.
+     */
+    page() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.page)) {
+            return 0;
+        }
+        return this.data.page;
+    }
+    /**
+     * Obtém uma mensagem retornada pelo IXC quando a requisição falha.
+     *
+     * @returns Uma mensagem de falha.
+     */
+    message() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.message)) {
+            return '';
+        }
+        return this.data.message.replaceAll('<br />', '. ');
+    }
+    /**
+     * Obtém a lista de registros retornados por uma consulta à API do IXC Provedor.
+     *
+     * @returns Uma lista de objetos.
+     */
+    registros() {
+        var _a;
+        if (!((_a = this.data) === null || _a === void 0 ? void 0 : _a.registros)) {
+            return [];
+        }
+        return this.data.registros;
+    }
+    /**
+     * Obtém o conteúdo bruto de uma resposta da API do IXC Provedor.
+     * Este método substitui o método `registros()`, quando a requisição é feita para um endpoint
+     * específico de recursos do IXC Provedor, mas apenas quando a API devolve uma resposta bruta ao
+     * invés de uma lista de registros, ou uma mensagem.
+     *
+     * @returns Uma string contendo o conteúdo da resposta da API do IXC Provedor.
+     */
+    content() {
+        return this.text;
+    }
+    responseTextHasHtml() {
+        var _a;
+        return !(!((_a = this.text) === null || _a === void 0 ? void 0 : _a.length)) && this.text.startsWith('<div style=');
+    }
+    createDataFromText() {
+        if (this.responseTextHasHtml()) {
+            return this.createDataFromHtml();
+        }
+        try {
+            return JSON.parse(this.text);
+        }
+        catch (error) {
+            return {};
+        }
+    }
+    createDataFromHtml() {
+        const parser = new DOMParser();
+        const document = parser.parseFromString(this.text, 'text/html');
+        return {
+            type: 'error',
+            page: 0,
+            total: 0,
+            message: document.body.textContent
+        };
+    }
+}
+exports.default = IxcResponse;

package/dist/api/Environment.d.ts

@@ -0,0 +1,14 @@
+export default class Environment {
+    private static instance;
+    private domain;
+    private token;
+    static loadInstance(): Environment;
+    private constructor();
+    private shouldToLoadDotEnvFile;
+    private envHasBeenLoaded;
+    private loadEnvFromEnvFile;
+    private setDomain;
+    private setToken;
+    getDomain(): string;
+    getToken(): string;
+}

package/dist/api/Environment.js

@@ -0,0 +1,66 @@
+"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 loadInstance() {
+        if (!Environment.instance) {
+            Environment.instance = new Environment();
+        }
+        return Environment.instance;
+    }
+    constructor() {
+        this.shouldToLoadDotEnvFile();
+        this.setToken(process.env.IXC_ACCESS_TOKEN);
+        this.setDomain(process.env.IXC_SERVER_DOMAIN);
+    }
+    shouldToLoadDotEnvFile() {
+        if (this.envHasBeenLoaded()) {
+            return;
+        }
+        this.loadEnvFromEnvFile();
+    }
+    envHasBeenLoaded() {
+        const allEnvVars = Object.keys(process.env);
+        return allEnvVars.some(envVar => envVar.startsWith('IXC_'));
+    }
+    loadEnvFromEnvFile() {
+        const fileUtil = new utils_1.default.File();
+        const envfile = fileUtil.findFile('.env');
+        const env = dotenv_1.default.config({
+            quiet: true,
+            path: path_1.default.resolve(envfile)
+        });
+        if (env.error) {
+            console.error(env.error);
+            process.exit(1);
+        }
+    }
+    setDomain(domain) {
+        var _a;
+        const newDomainIsValid = !(!(domain === null || domain === void 0 ? void 0 : domain.length));
+        const oldDomainIsValid = !((_a = this.domain) === null || _a === void 0 ? void 0 : _a.length);
+        if (newDomainIsValid && oldDomainIsValid) {
+            this.domain = domain;
+        }
+    }
+    setToken(token) {
+        var _a;
+        const newTokenIsValid = !(!(token === null || token === void 0 ? void 0 : token.length));
+        const oldTokenisValid = !((_a = this.token) === null || _a === void 0 ? void 0 : _a.length);
+        if (newTokenIsValid && oldTokenisValid) {
+            this.token = token;
+        }
+    }
+    getDomain() {
+        return this.domain;
+    }
+    getToken() {
+        return this.token;
+    }
+}
+exports.default = Environment;

package/dist/api/Operators.d.ts

@@ -0,0 +1,9 @@
+declare enum Operators {
+    EQUALS = "=",
+    LIKE = "L",
+    LESS_THAN = "<",
+    LESS_THAN_EQUALS = "<=",
+    GREATER_THAN = ">",
+    GREATER_THAN_EQUALS = ">="
+}
+export default Operators;

package/dist/api/Operators.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Operators;
+(function (Operators) {
+    Operators["EQUALS"] = "=";
+    Operators["LIKE"] = "L";
+    Operators["LESS_THAN"] = "<";
+    Operators["LESS_THAN_EQUALS"] = "<=";
+    Operators["GREATER_THAN"] = ">";
+    Operators["GREATER_THAN_EQUALS"] = ">=";
+})(Operators || (Operators = {}));
+;
+exports.default = Operators;

package/dist/api/Ordering.d.ts

@@ -0,0 +1,13 @@
+export declare enum Sort {
+    ASC = "asc",
+    DESC = "desc"
+}
+export default class Ordering {
+    private sortName;
+    private sortOrder;
+    static ascBy(table: string, column: string): Ordering;
+    static descBy(table: string, column: string): Ordering;
+    constructor(sortName: string, sortOrder: Sort);
+    getSortName(): string;
+    getSortOrder(): Sort;
+}

package/dist/api/Ordering.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sort = void 0;
+const utils_1 = __importDefault(require("../utils"));
+var Sort;
+(function (Sort) {
+    Sort["ASC"] = "asc";
+    Sort["DESC"] = "desc";
+})(Sort || (exports.Sort = Sort = {}));
+;
+class Ordering {
+    static ascBy(table, 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);
+        return new Ordering(`${normalizedTable}.${normalizedColumn}`, Sort.DESC);
+    }
+    constructor(sortName, sortOrder) {
+        this.sortName = sortName;
+        this.sortOrder = sortOrder;
+        this.sortName = sortName;
+        this.sortOrder = sortOrder;
+    }
+    getSortName() {
+        var _a;
+        return (_a = this.sortName) !== null && _a !== void 0 ? _a : 'id';
+    }
+    getSortOrder() {
+        var _a;
+        return (_a = this.sortOrder) !== null && _a !== void 0 ? _a : Sort.ASC;
+    }
+}
+exports.default = Ordering;

package/dist/api/Pagination.d.ts

@@ -0,0 +1,8 @@
+export default class Pagination {
+    private page;
+    private rows;
+    static defaults(): Pagination;
+    constructor(page: number, rows: number);
+    getPage(): number;
+    getRows(): number;
+}

package/dist/api/Pagination.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Pagination {
+    static defaults() {
+        return new Pagination(1, 20);
+    }
+    constructor(page, rows) {
+        this.page = page;
+        this.rows = rows;
+        this.page = page;
+        this.rows = rows;
+    }
+    getPage() {
+        var _a;
+        return (_a = this.page) !== null && _a !== void 0 ? _a : 1;
+    }
+    getRows() {
+        var _a;
+        return (_a = this.rows) !== null && _a !== void 0 ? _a : 20;
+    }
+}
+exports.default = Pagination;

package/dist/api/Parameter.d.ts

@@ -0,0 +1,18 @@
+import Operators from './Operators';
+export type ParameterProps = {
+    TB: string;
+    OP: string;
+    P: string | number;
+};
+export default class Parameter {
+    private readonly table;
+    private operator;
+    private type;
+    private value;
+    constructor(table: string);
+    withType(type: string): this;
+    withOperator(operator: Operators): this;
+    withValue(value: string | number): this;
+    toJsonObject(): ParameterProps;
+    toJsonString(): string;
+}

package/dist/api/Parameter.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Operators_1 = __importDefault(require("./Operators"));
+const utils_1 = __importDefault(require("../utils"));
+class Parameter {
+    constructor(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);
+        this.type = `${this.table}.${normalizedType}`;
+        return this;
+    }
+    withOperator(operator) {
+        this.operator = !(!operator) ? operator : Operators_1.default.EQUALS;
+        return this;
+    }
+    withValue(value) {
+        if (value) {
+            this.value = value;
+        }
+        return this;
+    }
+    toJsonObject() {
+        return {
+            TB: this.type,
+            OP: this.operator,
+            P: this.value
+        };
+    }
+    toJsonString() {
+        return JSON.stringify(this.toJsonObject());
+    }
+}
+exports.default = Parameter;

package/dist/api/RequestEmitter.d.ts

@@ -0,0 +1,90 @@
+import IxcResponse from '../IxcResponse';
+export default class RequestEmitter {
+    private readonly table;
+    private headers;
+    private query;
+    private uri;
+    /**
+     * Método construtor da classe.
+     *
+     * @param table Representa o endpoint do IXC Provedor para o qual será enviada a requisição.
+     */
+    constructor(table: string);
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para listar registros, filtrando-os pela query de busca
+     * definida por **setQuery(String query)**.
+     * A requisição é do tipo POST, o que define que ela irá executar uma listagem de registros é a presença do header:
+     * ["ixcsoft": "listar"].
+     *
+     * @returns Uma nova instância de um {@link IxcResponse}.
+     */
+    GET(): Promise<IxcResponse>;
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para inserir um novo registro no banco de dados, na tabela
+     * definida pelo prâmetro **(String table)** no construtor.
+     *
+     * @returns Uma nova instância de um {@link IxcResponse}.
+     */
+    POST(record: any): Promise<IxcResponse>;
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para atualizar um ou mais campos de um registro no banco
+     * de dados, na tabela definida pelo prâmetro **(String table)** no construtor.
+     *
+     * @param record O registro com os campos a serem atualizados no banco de dados.
+     * @return Um objeto {@link IxcResponse} contento o status da requisição e uma mensagem que pode ser de sucesso ou
+     *         de erro, dependendo do status.
+     */
+    PUT(record: any): Promise<IxcResponse>;
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para excluir um determinado registro do banco de dados.
+     *
+     * @param id Um {@link Integer} com o id do registro a ser removido do banco de dados do IXC Provedor.
+     * @return Um objeto {@link IxcResponse}.
+     */
+    DELETE(record: any): Promise<IxcResponse>;
+    /**
+     * Define a query que será enviada no corpo de uma requisição de busca.
+     *
+     * @example
+     * {
+     *     "qtype": "cliente",
+     *     "query": "",
+     *     "oper": "",
+     *     "page": "1",
+     *     "rg": 20,
+     *     "sortname": "asc",
+     *     "sortorder": "cliente.id",
+     *     "grid_param": [
+     *         {
+     *             "TB": "cliente.razao",
+     *             "OP": "L",
+     *             "P": "nome do cliente (nesse caso)"
+     *         }
+     *     ]
+     * }
+     *
+     * @param query Um objeto no formato de uma query da API do IXC Provedor.
+     */
+    setupQuery(query: {
+        [key: string]: any;
+    }): void;
+    /**
+     * Envia requisições para recursos específicos do IXC Provedor.
+     *
+     * @returns Uma nova instância de IxcResponse, contendo os dados retornados pelo recurso do IXC Provedor.
+     */
+    sendRequestToResource(): Promise<IxcResponse>;
+    /**
+     * Obtém o valor da tabela, definida no cosntrutor.
+     *
+     * @returns string
+     */
+    protected getTable(): string;
+    private loadCommonHeaders;
+    private getEncodedTokenFromContext;
+    private setupUri;
+    private enableIxcListingHeader;
+    private disableIxcListingHeader;
+    private sendRequest;
+    private createDefaultHeaders;
+}

package/dist/api/RequestEmitter.js

@@ -0,0 +1,211 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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"));
+class RequestEmitter {
+    /**
+     * Método construtor da classe.
+     *
+     * @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.headers = [];
+        this.query = '';
+        this.uri = '';
+        this.loadCommonHeaders();
+    }
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para listar registros, filtrando-os pela query de busca
+     * definida por **setQuery(String query)**.
+     * A requisição é do tipo POST, o que define que ela irá executar uma listagem de registros é a presença do header:
+     * ["ixcsoft": "listar"].
+     *
+     * @returns Uma nova instância de um {@link IxcResponse}.
+     */
+    GET() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.setupUri();
+            this.enableIxcListingHeader();
+            const responseText = yield this.sendRequest('POST', this.query);
+            return new IxcResponse_1.default(responseText);
+        });
+    }
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para inserir um novo registro no banco de dados, na tabela
+     * definida pelo prâmetro **(String table)** no construtor.
+     *
+     * @returns Uma nova instância de um {@link IxcResponse}.
+     */
+    POST(record) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.setupUri();
+            this.disableIxcListingHeader();
+            const responseText = yield this.sendRequest('POST', record);
+            return new IxcResponse_1.default(responseText);
+        });
+    }
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para atualizar um ou mais campos de um registro no banco
+     * de dados, na tabela definida pelo prâmetro **(String table)** no construtor.
+     *
+     * @param record O registro com os campos a serem atualizados no banco de dados.
+     * @return Um objeto {@link IxcResponse} contento o status da requisição e uma mensagem que pode ser de sucesso ou
+     *         de erro, dependendo do status.
+     */
+    PUT(record) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id } = record, rest = __rest(record, ["id"]);
+            this.setupUri(id);
+            this.disableIxcListingHeader();
+            const responseText = yield this.sendRequest('PUT', rest);
+            return new IxcResponse_1.default(responseText);
+        });
+    }
+    /**
+     * Envia uma requisição HTTP para a API do IXC Provedor, para excluir um determinado registro do banco de dados.
+     *
+     * @param id Um {@link Integer} com o id do registro a ser removido do banco de dados do IXC Provedor.
+     * @return Um objeto {@link IxcResponse}.
+     */
+    DELETE(record) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id } = record, rest = __rest(record, ["id"]);
+            this.setupUri(id);
+            this.disableIxcListingHeader();
+            const responseText = yield this.sendRequest('DELETE', rest);
+            return new IxcResponse_1.default(responseText);
+        });
+    }
+    /**
+     * Define a query que será enviada no corpo de uma requisição de busca.
+     *
+     * @example
+     * {
+     *     "qtype": "cliente",
+     *     "query": "",
+     *     "oper": "",
+     *     "page": "1",
+     *     "rg": 20,
+     *     "sortname": "asc",
+     *     "sortorder": "cliente.id",
+     *     "grid_param": [
+     *         {
+     *             "TB": "cliente.razao",
+     *             "OP": "L",
+     *             "P": "nome do cliente (nesse caso)"
+     *         }
+     *     ]
+     * }
+     *
+     * @param query Um objeto no formato de uma query da API do IXC Provedor.
+     */
+    setupQuery(query) {
+        this.query = query;
+    }
+    /**
+     * Envia requisições para recursos específicos do IXC Provedor.
+     *
+     * @returns Uma nova instância de IxcResponse, contendo os dados retornados pelo recurso do IXC Provedor.
+     */
+    sendRequestToResource() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.setupUri();
+                const responseText = yield this.sendRequest('POST', this.query);
+                return new IxcResponse_1.default(responseText);
+            }
+            catch (error) {
+                const responseTextError = IxcResponse_1.default.createResponseTextWithError(error);
+                return new IxcResponse_1.default(responseTextError);
+            }
+        });
+    }
+    /**
+     * Obtém o valor da tabela, definida no cosntrutor.
+     *
+     * @returns string
+     */
+    getTable() {
+        return this.table;
+    }
+    loadCommonHeaders() {
+        const encodedToken = this.getEncodedTokenFromContext();
+        this.headers.push({ 'Authorization': `Basic ${encodedToken}` });
+        this.headers.push({ 'Content-Type': 'application/json' });
+        this.headers.push({ 'ixcsoft': '' });
+    }
+    getEncodedTokenFromContext() {
+        const token = Environment_1.default.loadInstance().getToken();
+        return Buffer.from(token !== null && token !== void 0 ? token : '').toString('base64');
+    }
+    setupUri(id) {
+        const host = Environment_1.default.loadInstance().getDomain();
+        const pathId = id ? `/${id}` : '';
+        this.uri = `https://${host}/webservice/v1/${this.table}${pathId}`;
+    }
+    enableIxcListingHeader() {
+        const headerIndex = this.headers.findIndex(h => Object.keys(h).includes('ixcsoft'));
+        if (headerIndex > -1) {
+            this.headers[headerIndex]['ixcsoft'] = 'listar';
+        }
+    }
+    disableIxcListingHeader() {
+        const headerIndex = this.headers.findIndex(h => Object.keys(h).includes('ixcsoft'));
+        if (headerIndex > -1) {
+            this.headers[headerIndex]['ixcsoft'] = '';
+        }
+    }
+    sendRequest(method, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const headers = this.createDefaultHeaders();
+            try {
+                const response = yield fetch(this.uri, {
+                    method,
+                    headers,
+                    body: body ? JSON.stringify(body) : undefined
+                });
+                return yield response.text();
+            }
+            catch (error) {
+                return IxcResponse_1.default.createResponseTextWithError(error);
+            }
+        });
+    }
+    createDefaultHeaders() {
+        return this.headers.reduce((accumulator, current) => {
+            Object.keys(current).forEach(currentKey => {
+                if (!Object.keys(accumulator).includes(currentKey)) {
+                    accumulator[currentKey] = '';
+                }
+                accumulator[currentKey] = current[currentKey];
+            });
+            return accumulator;
+        }, {});
+    }
+}
+exports.default = RequestEmitter;