ixc-orm 1.2.0 → 1.3.0

package/README.md

@@ -50,5 +50,5 @@ Para configurar a comunicação da biblioteca com seu servidor IXC, é necessár
 
 `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.
+> **IXC_HOST** A url do seu servidor IXC, no formato: `https://seudominio.com.br/webservice/v1`\
+> **IXC_TOKEN** Um token de API gerado dentro do seu sistema IXCsoft.

package/dist/IXCClient.js

@@ -48,7 +48,7 @@ class IXCClient {
      */
     where(whereClauses) {
         if (whereClauses.length > 3) {
-            throw new Error(`> O array de cláusulas não pode conter mais de 3 elementos.`);
+            throw new Error(`> As cláusulas não podem conter mais de 3 elementos.`);
         }
         const [alwaysColumn, operatorOrValue, valueOrUndefined] = whereClauses;
         const availableOperators = Object.keys(types_1.IXCOperator);

package/dist/request.js

@@ -8,7 +8,7 @@ exports.createRequestPayload = createRequestPayload;
 const axios_1 = __importDefault(require("axios"));
 /**
  *
- * @param method GET | POST | PUT
+ * @param method GET | POST | PUT | DELETE
  * @returns A instância de um objeto do tipo AxiosInstance, pré-configurado com os cabeçalhos necessários
  */
 function createAxiosInstance(method = 'GET') {
@@ -27,7 +27,7 @@ function createAxiosInstance(method = 'GET') {
 /**
  *
  * @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 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
  */

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "ixc-orm",
-  "version": "1.2.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.7",
-    "dotenv": "^16.4.5"
-  },
-  "devDependencies": {
-    "@types/node": "^22.5.5",
-    "nodemon": "^3.1.5",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.6.2"
-  }
-}
+{
+  "name": "ixc-orm",
+  "version": "1.3.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.10.0",
+    "dotenv": "^17.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.12",
+    "nodemon": "^3.1.10",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2"
+  }
+}

package/dist/IXCClient.d.ts

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

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

package/dist/request.d.ts

@@ -1,16 +0,0 @@
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { IXCOptions, IXCQuery, IXCRequest, IXCRequestMethods } from './types';
-/**
- *
- * @param method GET | POST | PUT
- * @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 (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
- */
-export declare function createRequestPayload(table: string, params: IXCQuery | IXCQuery[], options?: IXCOptions): AxiosRequestConfig<IXCRequest>;

package/dist/types.d.ts

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