geo-engine-node 1.1.2 → 1.1.3

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/node.js.iml" filepath="$PROJECT_DIR$/.idea/node.js.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/node.js.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/Readme.md

@@ -1,10 +1,21 @@
+# 📦 Geo-Engine Node.js SDK
+
+![NPM Version](https://img.shields.io/npm/v/geo-engine-node?style=flat-square&color=blue)
+![License](https://img.shields.io/npm/l/geo-engine-node?style=flat-square)
+![Types](https://img.shields.io/npm/types/geo-engine-node?style=flat-square)
+![Size](https://img.shields.io/bundlephobia/minzip/geo-engine-node?style=flat-square)
+
+Cliente oficial de alto rendimiento para interactuar con la plataforma **Geo-Engine**.  
+Procesa ubicaciones en tiempo real, detecta cruces de geocercas y dispara webhooks en milisegundos.
 
 ---
 
-# 📦 Geo-Engine Node.js SDK
+## ✨ Características
 
-Cliente oficial para interactuar con la plataforma **Geo-Engine**.
-Permite enviar ubicaciones en tiempo real y gestionar **geocercas** desde tus aplicaciones Node.js.
+- 🚀 **Rendimiento:** Diseñado para manejar alta ingestión de datos.
+- 🛡️ **Type-Safe:** Incluye definiciones TypeScript (`.d.ts`) nativas.
+- 📦 **Híbrido:** Funciona con `require` (CommonJS) y `import` (ES Modules).
+- ⚡ **Ligero:** Cero dependencias pesadas.
 
 ---
 
@@ -12,24 +23,37 @@ Permite enviar ubicaciones en tiempo real y gestionar **geocercas** desde tus ap
 
 ```bash
 npm install geo-engine-node
-```
+````
 
 ---
 
 ## ⚡ Inicio Rápido
 
-Envía la ubicación de un dispositivo en **3 líneas de código**:
+Geo-Engine soporta tanto sintaxis moderna como clásica.
+
+### Opción A: ES Modules (Recomendado)
 
 ```js
-const GeoEngine = require('geo-engine-node');
+import GeoEngine from 'geo-engine-node';
 
-// Inicializa con tu API Key (consíguela en tu Dashboard)
+// Inicializa con tu API Key
 const geo = new GeoEngine('sk_test_12345abcdef');
 
 // Envía una coordenada (ID, Latitud, Longitud)
-geo.sendLocation('camion-01', 19.4326, -99.1332)
-  .then(res => console.log('✅ Ubicación enviada:', res))
-  .catch(err => console.error('❌ Error:', err.message));
+try {
+  const res = await geo.sendLocation('camion-01', 19.4326, -99.1332);
+  console.log('✅ Ubicación procesada:', res);
+} catch (err) {
+  console.error('❌ Error:', err.message);
+}
+```
+
+### Opción B: CommonJS (Legacy)
+
+```js
+const GeoEngine = require('geo-engine-node');
+
+const geo = new GeoEngine('sk_test_...');
 ```
 
 ---
@@ -45,45 +69,34 @@ Crea una nueva instancia del cliente.
 * `apiKey` (`string`): Tu clave secreta de API.
 * `options` (`object`, opcional):
 
-  * `timeout`: Tiempo de espera en ms *(default: 10000)*.
-  * `ingestUrl`: URL personalizada para ingestión (útil para pruebas locales).
-  * `managementUrl`: URL personalizada para gestión.
+  * `timeout`: Tiempo de espera en ms (default: `10000`)
+  * `ingestUrl`: URL personalizada (útil para proxies o testing)
+  * `managementUrl`: URL del servicio de administración
 
 ---
 
 ### `geo.sendLocation(deviceId, lat, lng)`
 
 Envía un punto de rastreo al motor de ingestión.
-El sistema procesará automáticamente si este punto **entra o sale** de alguna geocerca activa.
+El sistema evaluará automáticamente las reglas espaciales.
 
 **Parámetros:**
 
-* `deviceId` (`string`): Identificador único del activo (ej: placa del vehículo, UUID).
-* `lat` (`number`): Latitud decimal.
-* `lng` (`number`): Longitud decimal.
-
-**Retorna:**
-`Promise<Object>` con el estado de la cola (`queued`).
+* `deviceId` (`string`): ID único (placa, UUID, etc).
+* `lat` (`number`): Latitud decimal (Ej: `19.43`)
+* `lng` (`number`): Longitud decimal (Ej: `-99.13`)
 
 ---
 
 ### `geo.createGeofence(name, coordinates, webhookUrl)`
 
-Crea programáticamente una nueva zona de interés (geocerca).
-
-**Parámetros:**
-
-* `name` (`string`): Nombre descriptivo (ej: `"Almacén Central"`).
-* `coordinates` (`Array<Array<number>>`):
-  Lista de puntos que forman el polígono
-  `[[lat, lng], [lat, lng], ...]`
-  *(El SDK se encarga de cerrar el polígono si es necesario).*
-* `webhookUrl` (`string`):
-  URL donde Geo-Engine enviará una petición **POST** cuando un dispositivo entre en esta zona.
+Crea dinámicamente una zona de monitoreo.
+Geo-Engine enviará un `POST` a tu webhook cuando un activo entre o salga.
 
 **Ejemplo:**
 
 ```js
+// Definir polígono: Array de [Lat, Lng]
 const zona = [
   [19.42, -99.16],
   [19.41, -99.16],
@@ -92,35 +105,20 @@ const zona = [
 ];
 
 await geo.createGeofence(
-  'Zona Prohibida 1',
+  'Almacén Central',
   zona,
-  'https://mi-api.com/alertas'
+  'https://mi-api.com/webhooks/geofence-alert'
 );
 ```
 
 ---
 
-## 🛡️ Manejo de Errores
-
-El SDK lanza errores descriptivos que puedes capturar fácilmente:
-
-```js
-try {
-  await geo.sendLocation('x', 0, 0);
-} catch (error) {
-  console.error(error.message);
-  // Ej: "GeoEngine API Error (401): Invalid API Key"
-}
-```
-
----
-
 ## 🧪 Desarrollo Local
 
-Si estás ejecutando **Geo-Engine** en tu máquina local, puedes configurar el cliente para que apunte a `localhost`:
+Ideal para probar con tu propia instancia de Geo-Engine corriendo en Docker o Localhost.
 
 ```js
-const geo = new GeoEngine('mi-clave-local', {
+const geo = new GeoEngine('local-key', {
   ingestUrl: 'http://localhost:8080',
   managementUrl: 'http://localhost:8081'
 });
@@ -132,4 +130,3 @@ const geo = new GeoEngine('mi-clave-local', {
 
 MIT © Geo-Engine Team
 
----

package/index.js

@@ -17,7 +17,7 @@ class GeoEngine {
 
     this.apiKey = apiKey;
     this.config = { ...DEFAULTS, ...options };
-    this.userAgent = 'GeoEngineNode/1.1.2';
+    this.userAgent = 'GeoEngineNode/1.1.3';
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geo-engine-node",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "type": "module",
   "description": "SDK oficial para Geo-Engine...",
   "main": "./dist/index.cjs",

package/dist/index.cjs

@@ -1,115 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// index.js
-var index_exports = {};
-__export(index_exports, {
-  default: () => index_default
-});
-module.exports = __toCommonJS(index_exports);
-var DEFAULTS = {
-  managementUrl: "https://api.geoengine.dev",
-  ingestUrl: "https://ingest.geoengine.dev",
-  timeout: 1e4
-};
-var GeoEngine = class {
-  /**
-   * Inicializa el cliente de Geo-Engine.
-   * @param {string} apiKey - Tu API Key.
-   * @param {Object} [options] - Configuración opcional.
-   */
-  constructor(apiKey, options = {}) {
-    if (!apiKey) {
-      throw new Error("GeoEngine: API Key es requerida.");
-    }
-    this.apiKey = apiKey;
-    this.config = { ...DEFAULTS, ...options };
-    this.userAgent = "GeoEngineNode/1.1.2";
-  }
-  /**
-   * Helper privado para hacer peticiones con timeout
-   */
-  async _request(url, method, body) {
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), this.config.timeout);
-    try {
-      const response = await fetch(url, {
-        method,
-        headers: {
-          "Content-Type": "application/json",
-          "X-API-Key": this.apiKey,
-          "User-Agent": this.userAgent
-        },
-        body: JSON.stringify(body),
-        signal: controller.signal
-      });
-      clearTimeout(id);
-      if (!response.ok) {
-        const errorText = await response.text();
-        throw new Error(`GeoEngine API Error (${response.status}): ${errorText}`);
-      }
-      if (response.status === 204) return null;
-      return await response.json();
-    } catch (error) {
-      clearTimeout(id);
-      if (error.name === "AbortError") {
-        throw new Error(`GeoEngine: La petici\xF3n excedi\xF3 el tiempo l\xEDmite de ${this.config.timeout}ms`);
-      }
-      throw error;
-    }
-  }
-  /**
-   * Envía una ubicación al motor de ingestión.
-   */
-  async sendLocation(deviceId, lat, lng) {
-    if (!deviceId || lat === void 0 || lng === void 0) {
-      throw new Error("GeoEngine: deviceId, lat y lng son obligatorios.");
-    }
-    const payload = {
-      device_id: deviceId,
-      latitude: parseFloat(lat),
-      longitude: parseFloat(lng),
-      timestamp: Math.floor(Date.now() / 1e3)
-    };
-    return this._request(`${this.config.ingestUrl}/ingest`, "POST", payload);
-  }
-  /**
-   * Crea una nueva geocerca.
-   */
-  async createGeofence(name, coordinates, webhookUrl) {
-    if (!name || !coordinates || coordinates.length < 3) {
-      throw new Error("GeoEngine: Se requiere un nombre y al menos 3 coordenadas.");
-    }
-    const polygon = coordinates.map((p) => [p[1], p[0]]);
-    const first = polygon[0];
-    const last = polygon[polygon.length - 1];
-    if (first[0] !== last[0] || first[1] !== last[1]) {
-      polygon.push(first);
-    }
-    const payload = {
-      name,
-      webhook_url: webhookUrl,
-      geojson: {
-        type: "Polygon",
-        coordinates: [polygon]
-      }
-    };
-    return this._request(`${this.config.managementUrl}/geofences`, "POST", payload);
-  }
-};
-var index_default = GeoEngine;

package/dist/index.d.cts

@@ -1,110 +0,0 @@
-const DEFAULTS = {
-  managementUrl: 'https://api.geoengine.dev',
-  ingestUrl: 'https://ingest.geoengine.dev',
-  timeout: 10000
-};
-
-class GeoEngine {
-  /**
-   * Inicializa el cliente de Geo-Engine.
-   * @param {string} apiKey - Tu API Key.
-   * @param {Object} [options] - Configuración opcional.
-   */
-  constructor(apiKey, options = {}) {
-    if (!apiKey) {
-      throw new Error('GeoEngine: API Key es requerida.');
-    }
-
-    this.apiKey = apiKey;
-    this.config = { ...DEFAULTS, ...options };
-    this.userAgent = 'GeoEngineNode/1.1.2';
-  }
-
-  /**
-   * Helper privado para hacer peticiones con timeout
-   */
-  async _request(url, method, body) {
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), this.config.timeout);
-
-    try {
-      const response = await fetch(url, {
-        method: method,
-        headers: {
-          'Content-Type': 'application/json',
-          'X-API-Key': this.apiKey,
-          'User-Agent': this.userAgent
-        },
-        body: JSON.stringify(body),
-        signal: controller.signal
-      });
-
-      clearTimeout(id);
-
-      if (!response.ok) {
-        const errorText = await response.text();
-        throw new Error(`GeoEngine API Error (${response.status}): ${errorText}`);
-      }
-
-      if (response.status === 204) return null;
-
-      return await response.json();
-    } catch (error) {
-      clearTimeout(id);
-      if (error.name === 'AbortError') {
-        throw new Error(`GeoEngine: La petición excedió el tiempo límite de ${this.config.timeout}ms`);
-      }
-      throw error;
-    }
-  }
-
-  /**
-   * Envía una ubicación al motor de ingestión.
-   */
-  async sendLocation(deviceId, lat, lng) {
-    if (!deviceId || lat === undefined || lng === undefined) {
-      throw new Error("GeoEngine: deviceId, lat y lng son obligatorios.");
-    }
-
-    const payload = {
-      device_id: deviceId,
-      latitude: parseFloat(lat),
-      longitude: parseFloat(lng),
-      timestamp: Math.floor(Date.now() / 1000)
-    };
-
-    return this._request(`${this.config.ingestUrl}/ingest`, 'POST', payload);
-  }
-
-  /**
-   * Crea una nueva geocerca.
-   */
-  async createGeofence(name, coordinates, webhookUrl) {
-    if (!name || !coordinates || coordinates.length < 3) {
-      throw new Error("GeoEngine: Se requiere un nombre y al menos 3 coordenadas.");
-    }
-
-    // Convertir formato simple [[lat,lng]] a GeoJSON [Lng, Lat]
-    const polygon = coordinates.map(p => [p[1], p[0]]);
-
-    // Cerrar polígono automáticamente
-    const first = polygon[0];
-    const last = polygon[polygon.length - 1];
-    if (first[0] !== last[0] || first[1] !== last[1]) {
-      polygon.push(first);
-    }
-
-    const payload = {
-      name,
-      webhook_url: webhookUrl,
-      geojson: {
-        type: 'Polygon',
-        coordinates: [polygon]
-      }
-    };
-
-    return this._request(`${this.config.managementUrl}/geofences`, 'POST', payload);
-  }
-}
-
-export { GeoEngine as default };

package/dist/index.d.ts

@@ -1,110 +0,0 @@
-const DEFAULTS = {
-  managementUrl: 'https://api.geoengine.dev',
-  ingestUrl: 'https://ingest.geoengine.dev',
-  timeout: 10000
-};
-
-class GeoEngine {
-  /**
-   * Inicializa el cliente de Geo-Engine.
-   * @param {string} apiKey - Tu API Key.
-   * @param {Object} [options] - Configuración opcional.
-   */
-  constructor(apiKey, options = {}) {
-    if (!apiKey) {
-      throw new Error('GeoEngine: API Key es requerida.');
-    }
-
-    this.apiKey = apiKey;
-    this.config = { ...DEFAULTS, ...options };
-    this.userAgent = 'GeoEngineNode/1.1.2';
-  }
-
-  /**
-   * Helper privado para hacer peticiones con timeout
-   */
-  async _request(url, method, body) {
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), this.config.timeout);
-
-    try {
-      const response = await fetch(url, {
-        method: method,
-        headers: {
-          'Content-Type': 'application/json',
-          'X-API-Key': this.apiKey,
-          'User-Agent': this.userAgent
-        },
-        body: JSON.stringify(body),
-        signal: controller.signal
-      });
-
-      clearTimeout(id);
-
-      if (!response.ok) {
-        const errorText = await response.text();
-        throw new Error(`GeoEngine API Error (${response.status}): ${errorText}`);
-      }
-
-      if (response.status === 204) return null;
-
-      return await response.json();
-    } catch (error) {
-      clearTimeout(id);
-      if (error.name === 'AbortError') {
-        throw new Error(`GeoEngine: La petición excedió el tiempo límite de ${this.config.timeout}ms`);
-      }
-      throw error;
-    }
-  }
-
-  /**
-   * Envía una ubicación al motor de ingestión.
-   */
-  async sendLocation(deviceId, lat, lng) {
-    if (!deviceId || lat === undefined || lng === undefined) {
-      throw new Error("GeoEngine: deviceId, lat y lng son obligatorios.");
-    }
-
-    const payload = {
-      device_id: deviceId,
-      latitude: parseFloat(lat),
-      longitude: parseFloat(lng),
-      timestamp: Math.floor(Date.now() / 1000)
-    };
-
-    return this._request(`${this.config.ingestUrl}/ingest`, 'POST', payload);
-  }
-
-  /**
-   * Crea una nueva geocerca.
-   */
-  async createGeofence(name, coordinates, webhookUrl) {
-    if (!name || !coordinates || coordinates.length < 3) {
-      throw new Error("GeoEngine: Se requiere un nombre y al menos 3 coordenadas.");
-    }
-
-    // Convertir formato simple [[lat,lng]] a GeoJSON [Lng, Lat]
-    const polygon = coordinates.map(p => [p[1], p[0]]);
-
-    // Cerrar polígono automáticamente
-    const first = polygon[0];
-    const last = polygon[polygon.length - 1];
-    if (first[0] !== last[0] || first[1] !== last[1]) {
-      polygon.push(first);
-    }
-
-    const payload = {
-      name,
-      webhook_url: webhookUrl,
-      geojson: {
-        type: 'Polygon',
-        coordinates: [polygon]
-      }
-    };
-
-    return this._request(`${this.config.managementUrl}/geofences`, 'POST', payload);
-  }
-}
-
-export { GeoEngine as default };

package/dist/index.js

@@ -1,95 +0,0 @@
-// index.js
-var DEFAULTS = {
-  managementUrl: "https://api.geoengine.dev",
-  ingestUrl: "https://ingest.geoengine.dev",
-  timeout: 1e4
-};
-var GeoEngine = class {
-  /**
-   * Inicializa el cliente de Geo-Engine.
-   * @param {string} apiKey - Tu API Key.
-   * @param {Object} [options] - Configuración opcional.
-   */
-  constructor(apiKey, options = {}) {
-    if (!apiKey) {
-      throw new Error("GeoEngine: API Key es requerida.");
-    }
-    this.apiKey = apiKey;
-    this.config = { ...DEFAULTS, ...options };
-    this.userAgent = "GeoEngineNode/1.1.2";
-  }
-  /**
-   * Helper privado para hacer peticiones con timeout
-   */
-  async _request(url, method, body) {
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), this.config.timeout);
-    try {
-      const response = await fetch(url, {
-        method,
-        headers: {
-          "Content-Type": "application/json",
-          "X-API-Key": this.apiKey,
-          "User-Agent": this.userAgent
-        },
-        body: JSON.stringify(body),
-        signal: controller.signal
-      });
-      clearTimeout(id);
-      if (!response.ok) {
-        const errorText = await response.text();
-        throw new Error(`GeoEngine API Error (${response.status}): ${errorText}`);
-      }
-      if (response.status === 204) return null;
-      return await response.json();
-    } catch (error) {
-      clearTimeout(id);
-      if (error.name === "AbortError") {
-        throw new Error(`GeoEngine: La petici\xF3n excedi\xF3 el tiempo l\xEDmite de ${this.config.timeout}ms`);
-      }
-      throw error;
-    }
-  }
-  /**
-   * Envía una ubicación al motor de ingestión.
-   */
-  async sendLocation(deviceId, lat, lng) {
-    if (!deviceId || lat === void 0 || lng === void 0) {
-      throw new Error("GeoEngine: deviceId, lat y lng son obligatorios.");
-    }
-    const payload = {
-      device_id: deviceId,
-      latitude: parseFloat(lat),
-      longitude: parseFloat(lng),
-      timestamp: Math.floor(Date.now() / 1e3)
-    };
-    return this._request(`${this.config.ingestUrl}/ingest`, "POST", payload);
-  }
-  /**
-   * Crea una nueva geocerca.
-   */
-  async createGeofence(name, coordinates, webhookUrl) {
-    if (!name || !coordinates || coordinates.length < 3) {
-      throw new Error("GeoEngine: Se requiere un nombre y al menos 3 coordenadas.");
-    }
-    const polygon = coordinates.map((p) => [p[1], p[0]]);
-    const first = polygon[0];
-    const last = polygon[polygon.length - 1];
-    if (first[0] !== last[0] || first[1] !== last[1]) {
-      polygon.push(first);
-    }
-    const payload = {
-      name,
-      webhook_url: webhookUrl,
-      geojson: {
-        type: "Polygon",
-        coordinates: [polygon]
-      }
-    };
-    return this._request(`${this.config.managementUrl}/geofences`, "POST", payload);
-  }
-};
-var index_default = GeoEngine;
-export {
-  index_default as default
-};