ixc-orm 1.0.1 → 1.1.1

package/README.md

@@ -34,8 +34,8 @@ class Contrato extends IXCClient {
 ```typescript
 const contrato = new Contrato();
 
-contrato
-  .where('id', 240)
+const contratos = await contrato
+  .where(['id_cliente', 240])
   .where(['data_ativacao', '>=', '2024-09-24 00:45:00'])
   .orderBy('data_ativacao', 'desc')
   .get();
@@ -48,4 +48,7 @@ Para configurar a comunicação da biblioteca com seu servidor IXC, é necessár
 
 `IXC_HOST`
 
-`IXC_TOKEN`
+`IXC_TOKEN`
+
+> **IXC_HOST** deve conter a url do seu servidor IXC, no formato: `https://seudominio.com.br/webservice/v1`
+> **IXC_TOKEN** deve conter um token de API gerado dentro do seu sistema IXCsoft.

package/dist/IXCClient.d.ts

@@ -6,7 +6,7 @@ export default abstract class IXCClient {
     protected options: IXCOptions;
     /**
      *
-     * @param table O nome da tabela dentro do banco de dados do seu servidor IXC
+     * @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);
@@ -14,10 +14,8 @@ export default abstract class IXCClient {
      *
      * @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
+     * Operadores válidos: =, !=, >, <, >=, <=, LIKE
+     * @returns A própria instância
      */
     where(whereClauses: string[]): IXCClient;
     /**
@@ -36,7 +34,7 @@ export default abstract class IXCClient {
     get(pg?: number, rows?: number): Promise<null | IXCResponse | AxiosError>;
     /**
      *
-     * @param body Um objeto no formado "chave/valor" contendo as informações do novo registro
+     * @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>
      */
@@ -46,7 +44,7 @@ export default abstract class IXCClient {
     /**
      *
      * @param id O id do registro que será alterado
-     * @param body Um objeto no formado "chave/valor" contendo as colunas que serão alteradas
+     * @param body Um objeto no formado "chave : valor" contendo as colunas que serão alteradas
      * @returns Promise<null | IXCResponse | AxiosError>
      */
     put(id: number, body?: {

package/dist/IXCClient.js

@@ -22,10 +22,11 @@ var __rest = (this && this.__rest) || function (s, e) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = require("axios");
 const request_1 = require("./request");
+const types_1 = require("./types");
 class IXCClient {
     /**
      *
-     * @param table O nome da tabela dentro do banco de dados do seu servidor IXC
+     * @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) {
@@ -42,15 +43,20 @@ class IXCClient {
      *
      * @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
+     * Operadores válidos: =, !=, >, <, >=, <=, LIKE
+     * @returns A própria instância
      */
     where(whereClauses) {
-        const [column, operatorOrValue, valueOrUndefined] = whereClauses;
+        if (whereClauses.length > 3) {
+            throw new Error(`> O array de cláusulas não pode conter mais de 3 elementos!`);
+        }
+        const [alwaysColumn, operatorOrValue, valueOrUndefined] = whereClauses;
+        const availableOperators = Object.keys(types_1.IXCOperator);
+        if (whereClauses.length > 2 && !availableOperators.includes(operatorOrValue)) {
+            throw new Error(`> O operador ${operatorOrValue}, não faz parte dos operadores válidos: ${availableOperators}`);
+        }
         this.params.push({
-            TB: column,
+            TB: alwaysColumn,
             OP: valueOrUndefined ? operatorOrValue : '=',
             P: valueOrUndefined ? valueOrUndefined : operatorOrValue
         });
@@ -103,7 +109,7 @@ class IXCClient {
     }
     /**
      *
-     * @param body Um objeto no formado "chave/valor" contendo as informações do novo registro
+     * @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>
      */
@@ -129,7 +135,7 @@ class IXCClient {
     /**
      *
      * @param id O id do registro que será alterado
-     * @param body Um objeto no formado "chave/valor" contendo as colunas que serão alteradas
+     * @param body Um objeto no formado "chave : valor" contendo as colunas que serão alteradas
      * @returns Promise<null | IXCResponse | AxiosError>
      */
     put(id, body) {

package/dist/request.d.ts

@@ -3,13 +3,13 @@ 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
+ * @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 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 table Nome da tabela do IXC onde será feita a busca, atualização, inserção ou remoção
+ * @param params Parâmetros da busca (desconciderado quando a ação é 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
  */

package/dist/request.js

@@ -9,14 +9,14 @@ 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
+ * @returns A instância de um objeto do tipo AxiosInstance, pré-configurado 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',
+        baseURL: host !== null && host !== void 0 ? host : 'http://127.0.0.1/webservice/v1',
         headers: {
             'ixcsoft': (method === 'GET') ? 'listar' : '',
             'Content-Type': 'application/json',
@@ -26,8 +26,8 @@ function createAxiosInstance(method = 'GET') {
 }
 /**
  *
- * @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 table Nome da tabela do IXC onde será feita a busca, atualização, inserção ou remoção
+ * @param params Parâmetros da busca (desconciderado quando a ação é 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
  */

package/package.json

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

package/src/IXCClient.ts

@@ -1,6 +1,6 @@
 import { AxiosError } from 'axios';
 import { createAxiosInstance, createRequestPayload } from './request';
-import { IXCOptions, IXCQuery, IXCResponse, IXCSortOrder } from './types';
+import { IXCOperator, IXCOptions, IXCQuery, IXCResponse, IXCSortOrder } from './types';
 
 
 
@@ -14,7 +14,7 @@ export default abstract class IXCClient {
 
   /**
    * 
-   * @param table O nome da tabela dentro do banco de dados do seu servidor IXC
+   * @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) {
@@ -35,26 +35,38 @@ export default abstract class IXCClient {
    * 
    * @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 
+   * Operadores válidos: =, !=, >, <, >=, <=, LIKE
+   * @returns A própria instância
    */
   where(whereClauses: string[]) : IXCClient {
+
+    if (whereClauses.length > 3) {
+      throw new Error(
+        `> O array de cláusulas não pode conter mais de 3 elementos!`
+      );
+    }
     
     const [
-      column,
+      alwaysColumn,
       operatorOrValue,
       valueOrUndefined
     ] = whereClauses;
 
+    const availableOperators = Object.keys(IXCOperator);
+
+    if (whereClauses.length > 2 && !availableOperators.includes(operatorOrValue)) {
+      throw new Error(
+        `> O operador ${ operatorOrValue }, não faz parte dos operadores válidos: ${ availableOperators }`
+      );
+    }
+
     this.params.push({
-      TB: column,
+      TB: alwaysColumn,
       OP: valueOrUndefined ? operatorOrValue : '=',
       P: valueOrUndefined ? valueOrUndefined : operatorOrValue
     });
 
-    return this
+    return this;
   }
 
 
@@ -117,7 +129,7 @@ export default abstract class IXCClient {
 
   /**
    * 
-   * @param body Um objeto no formado "chave/valor" contendo as informações do novo registro
+   * @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> 
    */
@@ -146,7 +158,7 @@ export default abstract class IXCClient {
   /**
    * 
    * @param id O id do registro que será alterado
-   * @param body Um objeto no formado "chave/valor" contendo as colunas que serão alteradas
+   * @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> {

package/src/request.ts

@@ -5,18 +5,16 @@ 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
+ * @returns A instância de um objeto do tipo AxiosInstance, pré-configurado com os cabeçalhos necessários
  */
-export function createAxiosInstance(
-  method: keyof typeof IXCRequestMethods = 'GET'
-) : AxiosInstance {
+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',
+    baseURL: host ?? 'http://127.0.0.1/webservice/v1',
     headers: {
       'ixcsoft': (method === 'GET') ? 'listar' : '',
       'Content-Type': 'application/json',
@@ -28,8 +26,8 @@ export function createAxiosInstance(
 
 /**
  * 
- * @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 table Nome da tabela do IXC onde será feita a busca, atualização, inserção ou remoção
+ * @param params Parâmetros da busca (desconciderado quando a ação é 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 
  */