eda-readings 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Décio Fernandes
+
+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,92 @@
+# eda-readings
+
+An NPM package to send EDA (Electricidade dos Açores) power readings.
+
+## Installation
+
+```bash
+npm install eda-readings
+```
+
+## Usage
+
+```ts
+import { createClient, type ReadingResponse, type SendReadingPayload } from 'eda-readings';
+
+const client = createClient('<your-client-number>', '<your-contract-number>');
+
+// Fetch current reading data
+const reading: ReadingResponse = await client.getReading();
+console.log(reading);
+
+// Send meter readings
+const payload: SendReadingPayload = {
+  cil: reading.cil,
+  cilToken: reading.cilToken,
+  cilTokenExpires: reading.cilTokenExpires,
+  serial: reading.serial,
+  material: reading.material,
+  valorContador1: '8900',
+  register1: reading.register1,
+  valorContador2: '5420',
+  register2: reading.register2,
+  valorContador3: '13400',
+  register3: reading.register3,
+};
+await client.sendReading(payload);
+```
+
+## API
+
+### `createClient(clientNumber, contractNumber)`
+
+Creates an EDA readings client.
+
+| Parameter        | Type     | Description                        |
+| ---------------- | -------- | ---------------------------------- |
+| `clientNumber`   | `string` | Your CIL (client identification number) |
+| `contractNumber` | `string` | Your contract number               |
+
+Returns an object with the following methods:
+
+---
+
+#### `client.getReading()`
+
+Fetches the current reading data from the EDA API.
+
+- **Returns:** `Promise<ReadingResponse>` — the reading data object.
+
+---
+
+#### `client.sendReading(readings)`
+
+Sends meter readings to the EDA API.
+
+| Field                | Type     | Required | Description                        |
+| -------------------- | -------- | -------- | ---------------------------------- |
+| `cil`                | `string` | ✅       | CIL identifier                     |
+| `cilToken`           | `string` | ✅       | CIL token                          |
+| `cilTokenExpires`    | `number` | ✅       | CIL token expiry timestamp         |
+| `serial`             | `string` | ✅       | Meter serial number                |
+| `material`           | `string` | ✅       | Material identifier                |
+| `valorContador1`     | `string` | ✅       | Reading for counter 1              |
+| `register1`          | `string` | ✅       | Register identifier for counter 1  |
+| `valorContador2`     | `string` | ❌       | Reading for counter 2              |
+| `register2`          | `string` | ❌       | Register identifier for counter 2  |
+| `valorContador3`     | `string` | ❌       | Reading for counter 3              |
+| `register3`          | `string` | ❌       | Register identifier for counter 3  |
+
+- **Returns:** `Promise<unknown>` — the API response.
+
+## Scripts
+
+| Script            | Description                                         |
+| ----------------- | --------------------------------------------------- |
+| `npm run build`   | Compile TypeScript to `dist/`                       |
+| `npm test`        | Run the test suite                                  |
+| `npm run release` | Run tests, build, and publish to NPM                |
+
+## License
+
+[MIT](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+export interface ReadingResponse {
+    cil: string;
+    cilToken: string;
+    cilTokenExpires: number;
+    serial: string;
+    material: string;
+    contrato: string;
+    data: string;
+    dataAconselhavelEnvio: string;
+    origem: string;
+    tarifa: string;
+    descContador1: string;
+    valorContador1: string;
+    valorMinContador1: string;
+    valorMaxContador1: string;
+    register1: string;
+    descContador2?: string;
+    valorContador2?: string;
+    valorMinContador2?: string;
+    valorMaxContador2?: string;
+    register2?: string;
+    descContador3?: string;
+    valorContador3?: string;
+    valorMinContador3?: string;
+    valorMaxContador3?: string;
+    register3?: string;
+}
+export interface SendReadingPayload {
+    cil: string;
+    cilToken: string;
+    cilTokenExpires: number;
+    serial: string;
+    material: string;
+    valorContador1: string;
+    register1: string;
+    valorContador2?: string;
+    register2?: string;
+    valorContador3?: string;
+    register3?: string;
+}
+export interface EDAClient {
+    getReading(): Promise<ReadingResponse>;
+    sendReading(readings: SendReadingPayload): Promise<unknown>;
+}
+export declare function createClient(clientNumber: string, contractNumber: string): EDAClient;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB,EAAE,MAAM,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7D;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,SAAS,CA4BpF"}

package/dist/index.js

@@ -0,0 +1,28 @@
+const BASE_URL = 'https://smile.eda.pt/api/leitura';
+export function createClient(clientNumber, contractNumber) {
+    if (!clientNumber || !contractNumber) {
+        throw new Error('clientNumber and contractNumber are required');
+    }
+    async function getReading() {
+        const url = `${BASE_URL}?cil=${encodeURIComponent(clientNumber)}&contrato=${encodeURIComponent(contractNumber)}`;
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`Failed to get reading: ${response.status} ${response.statusText}`);
+        }
+        return response.json();
+    }
+    async function sendReading(readings) {
+        const url = `${BASE_URL}?cil=${encodeURIComponent(clientNumber)}`;
+        const response = await fetch(url, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(readings),
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to send reading: ${response.status} ${response.statusText}`);
+        }
+        return response.json();
+    }
+    return { getReading, sendReading };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AAiDpD,MAAM,UAAU,YAAY,CAAC,YAAoB,EAAE,cAAsB;IACvE,IAAI,CAAC,YAAY,IAAI,CAAC,cAAc,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,UAAU,UAAU;QACvB,MAAM,GAAG,GAAG,GAAG,QAAQ,QAAQ,kBAAkB,CAAC,YAAY,CAAC,aAAa,kBAAkB,CAAC,cAAc,CAAC,EAAE,CAAC;QACjH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAA8B,CAAC;IACrD,CAAC;IAED,KAAK,UAAU,WAAW,CAAC,QAA4B;QACrD,MAAM,GAAG,GAAG,GAAG,QAAQ,QAAQ,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QAClE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,2BAA2B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;AACrC,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "eda-readings",
+  "version": "1.0.0",
+  "description": "An NPM package to send EDA power readings",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node --import tsx/esm --test 'test/**/*.test.ts'",
+    "release": "npm test && npm run build && npm publish"
+  },
+  "keywords": [
+    "eda",
+    "readings",
+    "energy",
+    "portugal"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.5.2",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.2"
+  }
+}