ixc-orm 1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Felipe Sousa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# 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.
+
+
+## Instalação
+```bash
+npm install ixc-orm
+```
+ou
+```bash
+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`.
+
+```typescript
+import { IXCClient } 'ixc-orm';
+
+class Contrato extends IXCClient {
+  
+  constructor() {
+    super('cliente_contrato');
+  }
+}
+```
+
+> Após instanciar um objeto com o tipo que você criou (`Contrato, como no exemplo a cima`), você poderá acessar os métodos `where`, `orderBy`, `get`, `post` e `put`.
+
+```typescript
+const contrato = new Contrato();
+
+contrato
+  .where('id', 240)
+  .where(['data_ativacao', '>=', '2024-09-24 00:45:00'])
+  .orderBy('data_ativacao', 'desc')
+  .get();
+```
+
+
+## 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`

package/dist/IXCClient.d.ts

@@ -0,0 +1,55 @@
+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 dentro do 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: =, !=, >, <, >=, <=, LIKE
+     *
+     * @returns
+     */
+    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/IXCClient.js

@@ -0,0 +1,155 @@
+"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 axios_1 = require("axios");
+const request_1 = require("./request");
+class IXCClient {
+    /**
+     *
+     * @param table O nome da tabela dentro do 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'
+        };
+    }
+    /**
+     *
+     * @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: =, !=, >, <, >=, <=, LIKE
+     *
+     * @returns
+     */
+    where(whereClauses) {
+        const [column, operatorOrValue, valueOrUndefined] = whereClauses;
+        this.params.push({
+            TB: column,
+            OP: valueOrUndefined ? operatorOrValue : '=',
+            P: valueOrUndefined ? valueOrUndefined : operatorOrValue
+        });
+        return this;
+    }
+    /**
+     *
+     * @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;
+    }
+    /**
+     *
+     * @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, rows) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _a = this.options, { page, rowsPerPage } = _a, rest = __rest(_a, ["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 payload = (0, request_1.createRequestPayload)(this.table, this.params, opts);
+            try {
+                const response = yield axios.get(this.table, { data: payload });
+                return response.data;
+            }
+            catch (error) {
+                console.error(error);
+                if (error instanceof axios_1.AxiosError) {
+                    return error;
+                }
+                return null;
+            }
+            finally {
+                this.params = [];
+                this.options = {
+                    page: 1,
+                    rowsPerPage: 20,
+                    sortName: 'id',
+                    sortOrder: 'asc'
+                };
+            }
+        });
+    }
+    /**
+     *
+     * @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) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const axios = (0, request_1.createAxiosInstance)('POST');
+            try {
+                const response = yield axios.post(this.table, { data: body });
+                return response.data;
+            }
+            catch (error) {
+                console.error(error);
+                if (error instanceof axios_1.AxiosError) {
+                    return error;
+                }
+                return null;
+            }
+            finally {
+                this.params = [];
+            }
+        });
+    }
+    /**
+     *
+     * @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, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const axios = (0, request_1.createAxiosInstance)('PUT');
+            try {
+                const response = yield axios.put(`${this.table}/${id}`, { data: body });
+                return response.data;
+            }
+            catch (error) {
+                console.error(error);
+                if (error instanceof axios_1.AxiosError) {
+                    return error;
+                }
+                return null;
+            }
+            finally {
+                this.params = [];
+            }
+        });
+    }
+}
+exports.default = IXCClient;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import IXCClient from './IXCClient';
+declare const _default: {
+    readonly IXCClient: typeof IXCClient;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,18 @@
+"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 IXCClient_1 = __importDefault(require("./IXCClient"));
+const env = dotenv_1.default.config({
+    path: path_1.default.join(__dirname, `../.env`)
+});
+if (env.error) {
+    console.error(env.error);
+    process.exit(-1);
+}
+exports.default = {
+    IXCClient: IXCClient_1.default
+};

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
+ * @returns A instânxia de um objeto do tipo AxiosInstance, pre-confugurado com os cabeçalhos necessários
+ */
+export declare function createAxiosInstance(method?: keyof typeof IXCRequestMethods): AxiosInstance;
+/**
+ *
+ * @param table Nome da tabelado IXC onde será feita a busca, atualização, inserção ou remoção
+ * @param params Parâmetros da busca (desconciderado em cadastros de 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/request.js

@@ -0,0 +1,69 @@
+"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"));
+/**
+ *
+ * @param method GET | POST | PUT
+ * @returns A instânxia de um objeto do tipo AxiosInstance, pre-confugurado com os cabeçalhos necessários
+ */
+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:3000/webservice/v1',
+        headers: {
+            'ixcsoft': (method === 'GET') ? 'listar' : '',
+            'Content-Type': 'application/json',
+            'Authorization': `Basic ${Buffer.from(token !== null && token !== void 0 ? token : '').toString('base64')}`
+        }
+    });
+}
+/**
+ *
+ * @param table Nome da tabelado IXC onde será feita a busca, atualização, inserção ou remoção
+ * @param params Parâmetros da busca (desconciderado em cadastros de novos registros)
+ * @param options Parâmetros de formatação dos dados da responsta (página, ítens por página e ordenação)
+ * @returns
+ */
+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 { data: {
+                qtype: table,
+                query: '',
+                oper: '',
+                page: page,
+                rp: rowsPerPage,
+                sortname: `${table}.${sortName}`,
+                sortorder: sortOrder,
+                grid_param: JSON.stringify(grid_param)
+            } };
+    }
+    return { data: {
+            qtype: `${table}.${params.TB}`,
+            query: params.P,
+            oper: params.OP || '=',
+            page: page,
+            rp: rowsPerPage,
+            sortname: `${table}.${sortName}`,
+            sortorder: sortOrder
+        } };
+}

package/dist/types.d.ts

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

package/dist/types.js

@@ -0,0 +1,22 @@
+"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'
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "ixc-orm",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "description": "ORM para consumo de dados da API oficial do IXCsoft",
+  "scripts": {
+    "declare": "tsc --declaration",
+    "build": "tsc --build",
+    "dev": "nodemon --watch \"src//\" --exec \"ts-node src/index.ts\" -e ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SousaFelipe/ixc-orm.git"
+  },
+  "keywords": [
+    "IXCSoft API",
+    "IXCsoft",
+    "IXC API"
+  ],
+  "author": {
+    "name": "Felipe Sousa",
+    "email": "flpssdocarmo@gmail.com",
+    "url": "https://github.com/SousaFelipe"
+  },
+  "bugs": {
+    "url": "https://github.com/SousaFelipe/ixc-orm/issues"
+  },
+  "dependencies": {
+    "axios": "^1.7.5",
+    "dotenv": "^16.4.5"
+  },
+  "devDependencies": {
+    "@types/node": "^22.5.0",
+    "nodemon": "^3.1.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4"
+  }
+}

package/src/IXCClient.ts

@@ -0,0 +1,172 @@
+import { AxiosError } from 'axios';
+import { createAxiosInstance, createRequestPayload } from './request';
+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 dentro do banco de dados do seu servidor IXC
+   * @see {@link https://wikiapiprovedor.ixcsoft.com.br/index.php}
+   */
+  constructor(table: string) {
+
+    this.table = table;
+    this.params = [];
+
+    this.options = {
+      page: 1,
+      rowsPerPage: 20,
+      sortName: 'id',
+      sortOrder: 'asc'
+    };
+  }
+
+
+  /**
+   * 
+   * @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: =, !=, >, <, >=, <=, LIKE
+   * 
+   * @returns 
+   */
+  where(whereClauses: string[]) : IXCClient {
+    
+    const [
+      column,
+      operatorOrValue,
+      valueOrUndefined
+    ] = whereClauses;
+
+    this.params.push({
+      TB: column,
+      OP: valueOrUndefined ? operatorOrValue : '=',
+      P: valueOrUndefined ? valueOrUndefined : operatorOrValue
+    });
+
+    return this
+  }
+
+
+  /**
+   * 
+   * @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 {
+    this.options.sortName = column;
+    this.options.sortOrder = order;
+    return this;
+  }
+
+
+  /**
+   * 
+   * @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>
+   */
+  async get(pg?: number, rows?: number) : Promise<null | IXCResponse | AxiosError> {
+
+    const { page, rowsPerPage, ...rest } = this.options;
+
+    const opts = {
+      page: pg ?? page,
+      rowsPerPage: rows ?? rowsPerPage,
+      ...rest
+    };
+
+    const axios = createAxiosInstance('GET');
+    const payload = createRequestPayload(this.table, this.params, opts);
+    
+    try {
+      const response = await axios.get<IXCResponse>(this.table, { data: payload });
+      return response.data;
+    }
+    catch (error: any) {
+      console.error(error);
+
+      if (error instanceof AxiosError) {
+        return error;
+      }
+
+      return null;
+    }
+    finally {
+      this.params = [];
+      this.options = {
+        page: 1,
+        rowsPerPage: 20,
+        sortName: 'id',
+        sortOrder: 'asc'
+      };
+    }
+  }
+
+
+  /**
+   * 
+   * @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> 
+   */
+  async post(body?: { [key: string]: any }) : Promise<null | IXCResponse | AxiosError> {
+    const axios = createAxiosInstance('POST');
+    
+    try {
+      const response = await axios.post<IXCResponse>(this.table, { data: body });
+      return response.data;
+    }
+    catch (error: any) {
+      console.error(error);
+
+      if (error instanceof AxiosError) {
+        return error;
+      }
+
+      return null;
+    }
+    finally {
+      this.params = [];
+    }
+  }
+
+
+  /**
+   * 
+   * @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>
+   */
+  async put(id: number, body?: { [key: string]: any }) : Promise<null | IXCResponse | AxiosError> {
+    const axios = createAxiosInstance('PUT');
+
+    try {
+      const response = await axios.put<IXCResponse>(`${ this.table }/${ id }`, { data: body });
+      return response.data;
+    }
+    catch (error: any) {
+      console.error(error);
+
+      if (error instanceof AxiosError) {
+        return error;
+      }
+
+      return null;
+    }
+    finally {
+      this.params = [];
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,23 @@
+import path from 'path';
+import dotenv from 'dotenv';
+
+import IXCClient from './IXCClient';
+
+
+
+const env = dotenv.config({
+  path: path.join(__dirname, `../.env`)
+});
+
+if (env.error) {
+  console.error(env.error);
+  process.exit(-1);
+}
+
+
+
+export default {
+
+  IXCClient
+
+} as const;

package/src/request.ts

@@ -0,0 +1,79 @@
+import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods } from './types';
+
+
+/**
+ * 
+ * @param method GET | POST | PUT
+ * @returns A instânxia de um objeto do tipo AxiosInstance, pre-confugurado com os cabeçalhos necessários
+ */
+export function createAxiosInstance(
+  method: keyof typeof IXCRequestMethods = 'GET'
+) : AxiosInstance {
+
+  const host = process.env.IXC_HOST;
+  const token = process.env.IXC_TOKEN;
+
+  return axios.create({
+    method: method,
+    baseURL: host ?? 'http://127.0.0.1:3000/webservice/v1',
+    headers: {
+      'ixcsoft': (method === 'GET') ? 'listar' : '',
+      'Content-Type': 'application/json',
+      'Authorization': `Basic ${ Buffer.from(token ?? '').toString('base64') }`
+    }
+  });
+}
+
+
+/**
+ * 
+ * @param table Nome da tabelado IXC onde será feita a busca, atualização, inserção ou remoção
+ * @param params Parâmetros da busca (desconciderado em cadastros de novos registros)
+ * @param options Parâmetros de formatação dos dados da responsta (página, ítens por página e ordenação)
+ * @returns 
+ */
+export function createRequestPayload(
+  table: string,
+  params: IXCQuery | IXCQuery[],
+  options?: IXCOptions
+) : AxiosRequestConfig<IXCRequest> {
+
+  const page = options?.page ?? 1;
+  const rowsPerPage = options?.rowsPerPage ?? 20;
+  const sortName = options?.sortName ?? 'id';
+  const sortOrder = options?.sortOrder ?? 'asc';
+
+  if (Array.isArray(params)) {
+    let grid_param: object[] = [];
+
+    params.forEach(p => {
+      grid_param.push({
+        TB: `${table}.${p.TB}`,
+        OP: p.OP || '=',
+        P: p.P
+      });
+    });
+
+    return { data: {
+      qtype: table,
+      query: '',
+      oper: '',
+      page: page,
+      rp: rowsPerPage,
+      sortname: `${table}.${sortName}`,
+      sortorder: sortOrder,
+      grid_param: JSON.stringify(grid_param)
+    }};
+  }
+
+  return { data: {
+    qtype: `${table}.${params.TB}`,
+    query: params.P,
+    oper: params.OP || '=',
+    page: page,
+    rp: rowsPerPage,
+    sortname: `${table}.${sortName}`,
+    sortorder: sortOrder
+  }};
+}

package/src/types.ts

@@ -0,0 +1,61 @@
+
+
+
+export const IXCOperator = {
+  '=':    '=',
+  '>':    '>',
+  '<':    '<',
+  '>=':   '>=',
+  '<=':   '<=',
+  '!=':   '!=',
+  'LIKE': 'L'
+}
+
+export const IXCSortOrder = {
+  asc: 'asc',
+  desc: 'desc'
+}
+
+export const IXCRequestMethods = {
+  GET: 'GET',
+  POST: 'POST',
+  PUT: 'PUT',
+  DELETE: 'DELETE'
+}
+
+
+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 }>
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "esModuleInterop": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.test.ts"]
+}