evnex-sdk 1.0.0 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ben Lawrence
+
+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

@@ -1,13 +1,161 @@
-# Evnex API for TypeScript
+# evnex-sdk
 
-TypeScript client for the Evnex API.
-<br>
-Project is not affiliated with Evnex
+A TypeScript library for interacting with the [Evnex](https://www.evnex.com) EV charger API. Supports authentication, charge point management, session history, load management, and more.
+
+> This project is not affiliated with Evnex. Based upon [python-evnex](https://github.com/hardbyte/python-evnex).
 
 ## Installation
-`bun add evnex-sdk`
+
+```bash
+npm install evnex-sdk
+# or
+bun add evnex-sdk
+```
+
+## Quick Start
+
+```typescript
+import { Evnex } from "evnex-sdk";
+
+const evnex = new Evnex("your@email.com", "yourpassword");
+
+await evnex.authenticate();
+
+// Fetch user details and set the default org
+const user = await evnex.getUserDetail();
+console.log(user.organisations);
+```
+
+## Authentication
+
+The `Evnex` constructor accepts your Evnex account credentials. Call `authenticate()` once to retrieve tokens. Tokens are refreshed automatically on expiry.
+
+```typescript
+const evnex = new Evnex("your@email.com", "yourpassword");
+await evnex.authenticate();
+```
+
+If you already have tokens from a previous session, you can pass them in to skip the initial login:
+
+```typescript
+import type { EvnexTokens } from "evnex-sdk";
+
+const tokens: EvnexTokens = {
+  idToken: "...",
+  accessToken: "...",
+  refreshToken: "...",
+};
+
+const evnex = new Evnex("your@email.com", "yourpassword", tokens);
+```
+
+## API Reference
+
+### User
+
+```typescript
+// Get user details (also sets the default org ID)
+const user = await evnex.getUserDetail();
+```
+
+### Organisation
+
+```typescript
+// List all charge points in an org
+const chargePoints = await evnex.getOrgChargePoints(orgId);
+
+// Get a summary of org charger statuses
+const summary = await evnex.getOrgSummaryStatus(orgId);
+
+// Get daily energy insights for the past N days
+const insights = await evnex.getOrgInsight(7, orgId);
+```
+
+### Charge Points
+
+```typescript
+// Get full charge point details (v3)
+const detail = await evnex.getChargePointDetailV3(chargePointId);
+console.log(detail.data.attributes.networkStatus); // "ONLINE" | "OFFLINE"
+
+// Get current connector status
+const status = await evnex.getChargePointStatus(chargePointId);
+
+// Get session history
+const sessions = await evnex.getChargePointSessions(chargePointId);
+
+// Get solar config
+const solar = await evnex.getChargePointSolarConfig(chargePointId);
+
+// Get override config
+const override = await evnex.getChargePointOverride(chargePointId);
+```
+
+### Commands
+
+```typescript
+// Stop an active charging session
+await evnex.stopChargePoint(chargePointId);
+
+// Enable or disable a charger connector
+await evnex.enableCharger(orgId, chargePointId);
+await evnex.disableCharger(orgId, chargePointId);
+
+// Set charge now override on/off
+await evnex.setChargePointOverride(chargePointId, true);
+
+// Unlock a connector
+await evnex.unlockCharger(chargePointId);
+```
+
+### Load Management
+
+```typescript
+// Apply a load management profile (limits current by time of day)
+await evnex.setChargerLoadProfile(chargePointId, [
+  { start: 0, limit: 6 },      // 12am: 6A
+  { start: 25200, limit: 16 }, // 7am: 16A
+]);
+
+// Apply a charge schedule
+await evnex.setChargePointSchedule(chargePointId, [
+  { start: 0, limit: 0 },      // off overnight
+  { start: 25200, limit: 16 }, // on from 7am
+]);
+```
+
+## Configuration
+
+You can override default API and Cognito settings via the optional `config` parameter:
+
+```typescript
+const evnex = new Evnex("email", "password", undefined, {
+  baseUrl: "https://client-api.evnex.io", // default
+  cognitoRegion: "ap-southeast-2",        // default
+  cognitoUserPoolId: "...",
+  cognitoClientId: "...",
+  orgId: "your-default-org-id",           // skips getUserDetail() for org resolution
+});
+```
+
+## Error Handling
+
+```typescript
+import { NotAuthorizedException } from "evnex-sdk";
+
+try {
+  await evnex.authenticate();
+} catch (err) {
+  if (err instanceof NotAuthorizedException) {
+    console.error("Invalid credentials");
+  }
+}
+```
 
 ## Examples
-`evnex` is intended as a library, but a few example scripts are provided in the `examples` folder
 
-Project is based upon [python-evnex](https://github.com/hardbyte/python-evnex)
+A few example scripts are provided in the `examples/` folder.
+
+## License
+
+MIT

package/package.json

@@ -3,7 +3,7 @@
   "author": "Ben Lawrence",
   "description": "A TypeScript library for interacting with the Evnex API",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/dist/index.d.ts

@@ -1,41 +0,0 @@
-export class Evnex {
-    constructor(username: any, password: any, tokens: any, config?: {});
-    client: any;
-    tokens: any;
-    orgId: any;
-    username: any;
-    password: any;
-    clientId: any;
-    cognito: any;
-    authenticate(): Promise<void>;
-    refreshTokens(): Promise<void>;
-    get accessToken(): any;
-    get idToken(): any;
-    get refreshToken(): any;
-    get commonHeaders(): {
-        Accept: string;
-        "Content-Type": string;
-        Authorization: any;
-        "User-Agent": string;
-    };
-    checkApiResponse(response: any): Promise<any>;
-    getUserDetail(): Promise<any>;
-    getOrgChargePoints(orgId: any): Promise<any>;
-    getOrgInsight(days: any, orgId: any, tzOffset?: number): Promise<any>;
-    getOrgSummaryStatus(orgId: any): Promise<any>;
-    getChargePointDetail(chargePointId: any): Promise<any>;
-    getChargePointDetailV3(chargePointId: any): Promise<any>;
-    getChargePointSolarConfig(chargePointId: any): Promise<any>;
-    getChargePointOverride(chargePointId: any): Promise<any>;
-    setChargePointOverride(chargePointId: any, chargeNow: any, connectorId?: number): Promise<boolean>;
-    getChargePointStatus(chargePointId: any): Promise<any>;
-    getChargePointTransactions(chargePointId: any): Promise<any>;
-    getChargePointSessions(chargePointId: any): Promise<any>;
-    stopChargePoint(chargePointId: any, orgId: any, connectorId?: string, timeout?: number): Promise<any>;
-    enableCharger(orgId: any, chargePointId: any, connectorId?: number): Promise<any>;
-    disableCharger(orgId: any, chargePointId: any, connectorId?: number): Promise<any>;
-    setChargerAvailability(orgId: any, chargePointId: any, available?: boolean, connectorId?: number, timeout?: number): Promise<any>;
-    unlockCharger(chargePointId: any, available?: boolean, connectorId?: string, timeout?: number): Promise<any>;
-    setChargerLoadProfile(chargePointId: any, chargingProfilePeriods: any, enabled?: boolean, duration?: number, units?: string, timeout?: number): Promise<any>;
-    setChargePointSchedule(chargePointId: any, chargingProfilePeriods: any, enabled?: boolean, duration?: number, timeout?: number): Promise<any>;
-}