typescript-evnex 1.0.0

package/dist/src/api.d.ts

@@ -0,0 +1,67 @@
+import type { EvnexChargePoint, EvnexChargePointDetail, EvnexChargePointLoadSchedule, EvnexChargePointOverrideConfig, EvnexChargePointSolarConfig, EvnexChargeProfileSegment, EvnexChargePointTransaction, EvnexChargePointStatusResponse } from "./schema/charge_points";
+import type { EvnexCommandResponse } from "./schema/commands";
+import type { EvnexOrgInsightEntry, EvnexOrgSummaryStatus } from "./schema/org";
+import type { EvnexUserDetail } from "./schema/user";
+import type { EvnexChargePointDetail as EvnexChargePointDetailV3, EvnexChargePointSession } from "./schema/v3/charge_points";
+import type { EvnexV3APIResponse } from "./schema/v3/generic";
+export interface EvnexConfig {
+    baseUrl?: string;
+    cognitoUserPoolId?: string;
+    cognitoClientId?: string;
+    cognitoRegion?: string;
+    orgId?: string;
+}
+export interface EvnexTokens {
+    idToken: string;
+    accessToken: string;
+    refreshToken: string;
+}
+export declare class Evnex {
+    private client;
+    private tokens;
+    private orgId?;
+    private readonly username;
+    private readonly password;
+    private readonly clientId;
+    private readonly cognito;
+    constructor(username: string, password: string, tokens?: EvnexTokens, config?: EvnexConfig);
+    /**
+     * Authenticate with Cognito and populate tokens.
+     * Call this after constructing if you don't have existing tokens.
+     *
+     * @throws NotAuthorizedException
+     */
+    authenticate(): Promise<void>;
+    /**
+     * Refresh tokens using the stored refresh token.
+     *
+     * @throws NotAuthorizedException
+     */
+    refreshTokens(): Promise<void>;
+    get accessToken(): string;
+    get idToken(): string;
+    get refreshToken(): string;
+    private get commonHeaders();
+    private checkApiResponse;
+    getUserDetail(): Promise<EvnexUserDetail>;
+    getOrgChargePoints(orgId?: string): Promise<EvnexChargePoint[]>;
+    getOrgInsight(days: number, orgId?: string, tzOffset?: number): Promise<EvnexOrgInsightEntry[]>;
+    getOrgSummaryStatus(orgId?: string): Promise<EvnexOrgSummaryStatus>;
+    /** @deprecated Use getChargePointDetailV3 */
+    getChargePointDetail(chargePointId: string): Promise<EvnexChargePointDetail>;
+    getChargePointDetailV3(chargePointId: string): Promise<EvnexV3APIResponse<EvnexChargePointDetailV3>>;
+    getChargePointSolarConfig(chargePointId: string): Promise<EvnexChargePointSolarConfig>;
+    getChargePointOverride(chargePointId: string): Promise<EvnexChargePointOverrideConfig>;
+    setChargePointOverride(chargePointId: string, chargeNow: boolean, connectorId?: number): Promise<true>;
+    getChargePointStatus(chargePointId: string): Promise<EvnexChargePointStatusResponse>;
+    /** @deprecated Use getChargePointSessions */
+    getChargePointTransactions(chargePointId: string): Promise<EvnexChargePointTransaction[]>;
+    getChargePointSessions(chargePointId: string): Promise<EvnexChargePointSession[]>;
+    stopChargePoint(chargePointId: string, orgId?: string, connectorId?: string, timeout?: number): Promise<EvnexCommandResponse>;
+    enableCharger(orgId: string, chargePointId: string, connectorId?: number | string): Promise<EvnexCommandResponse>;
+    disableCharger(orgId: string, chargePointId: string, connectorId?: number | string): Promise<EvnexCommandResponse>;
+    setChargerAvailability(orgId: string, chargePointId: string, available?: boolean, connectorId?: number | string, timeout?: number): Promise<EvnexCommandResponse>;
+    unlockCharger(chargePointId: string, available?: boolean, connectorId?: string, timeout?: number): Promise<EvnexCommandResponse>;
+    setChargerLoadProfile(chargePointId: string, chargingProfilePeriods: EvnexChargeProfileSegment[], enabled?: boolean, duration?: number, units?: string, timeout?: number): Promise<EvnexChargePointLoadSchedule>;
+    setChargePointSchedule(chargePointId: string, chargingProfilePeriods: EvnexChargeProfileSegment[], enabled?: boolean, duration?: number, timeout?: number): Promise<EvnexChargePointLoadSchedule>;
+}

package/dist/src/errors.d.ts

@@ -0,0 +1,3 @@
+export declare class NotAuthorizedException extends Error {
+    constructor(message?: string);
+}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export { Evnex } from "./api";
+export type { EvnexConfig, EvnexTokens } from "./api";

package/dist/src/logger.d.ts

@@ -0,0 +1,9 @@
+export default class Logger {
+    private readonly prefix;
+    constructor(prefix: string);
+    private format;
+    debug(msg: string): void;
+    info(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+}

package/dist/src/models.d.ts

@@ -0,0 +1,10 @@
+export interface EvnexModelInfo {
+    name: string;
+    connector: string;
+    cableLength: string;
+    colour: string;
+    power: string;
+    powerSensor: string;
+    configuration: string;
+}
+export declare function parseModel(modelId: string): EvnexModelInfo;

package/dist/src/schema/charge_points.d.ts

@@ -0,0 +1,183 @@
+import type { EvnexCost } from "./cost";
+export declare enum ChargingLogic {
+    UNAVAILABLE = "Unavailable",
+    NOVEHICLE = "NoVehicle",
+    VEHICLE = "Vehicle",
+    TRANSFER = "Transfer",
+    FAULT = "Fault"
+}
+export declare enum ChargingCurrentControl {
+    FULLPOWER = "FullPower",
+    THERMALLIMITED = "ThermalLimited",
+    LLMLIMITED = "LLMLimited",
+    WAITINGSCHEDULE = "WaitingSchedule",
+    WAITINGSOLAR = "WaitingSolar",
+    SOLARCONTROL = "SolarControl",
+    SCHEDULELIMITED = "ScheduleLimited",
+    SUPPLYLIMITED = "SupplyLimited"
+}
+export declare enum E2LEDState {
+    OFF = "Off",
+    IDLE = "Idle",
+    CHARGING = "Charging",
+    CHARGENOWCHARGING = "ChargeNowCharging",
+    CHARGENOWNOTCHARGING = "ChargeNowNotCharging",
+    FAULT = "Fault",
+    DISABLED = "Disabled",
+    WAITSCHEDULE = "WaitSchedule",
+    WAITSOLAR = "WaitSolar",
+    WAITVEHICLE = "WaitVehicle",
+    SHUTTINGDOWN = "ShuttingDown"
+}
+export declare enum AntiSleepState {
+    DISABLED = "Disabled",
+    ENABLED = "Enabled",
+    ACTIVE = "Active",
+    NA = "NA"
+}
+export interface ChargePointStatus {
+    chargeNow: boolean;
+    chargingLogic: ChargingLogic;
+    chargingCurrentControl: ChargingCurrentControl;
+    LEDState: E2LEDState;
+    AntiSleep: AntiSleepState;
+}
+export interface EvnexChargePointConnectorMeter {
+    powerType: string;
+    updatedDate: Date;
+    power: number;
+    register: number;
+    frequency: number;
+}
+export interface Coordinates {
+    latitude: number;
+    longitude: number;
+}
+export interface EvnexAddress {
+    address1: string;
+    address2?: string | null;
+    city?: string | null;
+    postCode?: string | null;
+    state?: string | null;
+    country: string;
+}
+export interface EvnexLocation {
+    id: string;
+    name: string;
+    createdDate: Date;
+    updatedDate: Date;
+    address?: EvnexAddress | null;
+    coordinates?: Coordinates | null;
+    chargePointCount: number;
+}
+export interface EvnexChargePointConnector {
+    powerType: string;
+    connectorId: string;
+    evseId: string;
+    updatedDate: Date;
+    connectorType: string;
+    amperage: number;
+    voltage: number;
+    connectorFormat: string;
+    ocppStatus: string;
+    status: string;
+    ocppCode: string;
+    meter: EvnexChargePointConnectorMeter;
+}
+export interface EvnexChargePointDetails {
+    model: string;
+    vendor: string;
+    firmware: string;
+    iccid?: string | null;
+}
+export interface EvnexChargePointSolarConfig {
+    solarWithSchedule: boolean;
+    powerSensorInstalled: boolean;
+    solarStartExportPower: number;
+    solarStopImportPower: number;
+}
+export interface EvnexChargePointOverrideConfig {
+    chargeNow: boolean | "NotSupported";
+}
+export interface EvnexChargePointStatus {
+    commandResultStatus: string;
+    chargePointStatus?: ChargePointStatus | null;
+}
+export interface EvnexChargePointStatusResponse {
+    data: EvnexChargePointStatus;
+}
+export interface EvnexChargePointBase {
+    id: string;
+    createdDate: Date;
+    updatedDate: Date;
+    networkStatusUpdatedDate: Date;
+    name: string;
+    ocppChargePointId: string;
+    serial: string;
+    networkStatus: string;
+    location: EvnexLocation;
+}
+export interface EvnexChargePoint extends EvnexChargePointBase {
+    details: EvnexChargePointDetails;
+    connectors?: EvnexChargePointConnector[] | null;
+    lastHeard?: Date | null;
+    maxCurrent: number;
+    tokenRequired: boolean;
+    needsRegistrationInformation: boolean;
+}
+export interface EvnexGetChargePointsItem {
+    items: EvnexChargePoint[];
+}
+export interface EvnexGetChargePointsResponse {
+    data: EvnexGetChargePointsItem;
+}
+export interface EvnexElectricityCostSegment {
+    cost: number;
+    start: number;
+}
+export interface EvnexChargeProfileSegment {
+    limit: number;
+    start: number;
+}
+export interface EvnexElectricityCost {
+    currency: string;
+    duration?: number | null;
+    costs: EvnexElectricityCostSegment[];
+}
+export interface EvnexChargePointConfiguration {
+    maxCurrent: number;
+    plugAndCharge: boolean;
+}
+export interface EvnexChargePointLoadSchedule {
+    duration: number;
+    enabled: boolean;
+    timezone: string;
+    units: string;
+    chargingProfilePeriods: EvnexChargeProfileSegment[];
+}
+export interface EvnexChargePointDetail extends EvnexChargePointBase {
+    configuration: EvnexChargePointConfiguration;
+    electricityCost: EvnexElectricityCost;
+    loadSchedule: EvnexChargePointLoadSchedule;
+    connectors: EvnexChargePointConnector[];
+}
+export interface EvnexGetChargePointDetailResponse {
+    data: EvnexChargePointDetail;
+}
+export interface EvnexChargePointTransaction {
+    id: string;
+    connectorId: string;
+    endDate?: Date | null;
+    evseId: string;
+    powerUsage: number;
+    reason?: string | null;
+    startDate: Date;
+    carbonOffset?: number | null;
+    electricityCost?: EvnexCost | null;
+}
+export interface EvnexChargePointTransactions {
+    items: EvnexChargePointTransaction[];
+}
+export interface EvnexGetChargePointTransactionsResponse {
+    data: EvnexChargePointTransactions;
+}

package/dist/src/schema/commands.d.ts

@@ -0,0 +1,4 @@
+export interface EvnexCommandResponse {
+    message: string;
+    status: string;
+}

package/dist/src/schema/cost.d.ts

@@ -0,0 +1,4 @@
+export interface EvnexCost {
+    currency: string;
+    cost: number;
+}

package/dist/src/schema/org.d.ts

@@ -0,0 +1,38 @@
+import type { EvnexCost } from "./cost";
+export interface EvnexOrgBrief {
+    id: string;
+    isDefault: boolean;
+    role: number;
+    createdDate: Date;
+    name: string;
+    slug: string;
+    tier: number;
+    tierDetails: any | null;
+    updatedDate: Date;
+}
+export interface EvnexOrgInsightEntry {
+    carbonOffset: number;
+    cost: EvnexCost;
+    duration: number;
+    powerUsage: number;
+    sessions: number;
+    startDate: Date;
+}
+export interface EvnexInsightAttributeWrapper {
+    attributes: EvnexOrgInsightEntry;
+}
+export interface EvnexOrgSummaryStatus {
+    charging: number;
+    available: number;
+    disabled: number;
+    faulted: number;
+    occupied: number;
+    offline: number;
+    reserved: number;
+}
+export interface EvnexGetOrgInsights {
+    data: EvnexInsightAttributeWrapper[];
+}
+export interface EvnexGetOrgSummaryStatusResponse {
+    data: EvnexOrgSummaryStatus;
+}

package/dist/src/schema/user.d.ts

@@ -0,0 +1,13 @@
+import type { EvnexOrgBrief } from "./org";
+export interface EvnexUserDetail {
+    id: string;
+    createdDate: Date;
+    updatedDate: Date;
+    name: string;
+    email: string;
+    organisations: EvnexOrgBrief[];
+    type: "User" | "Installer";
+}
+export interface EvnexGetUserResponse {
+    data: EvnexUserDetail;
+}

package/dist/src/schema/v3/charge_points.d.ts

@@ -0,0 +1,99 @@
+import type { EvnexRelationships } from "./relationships";
+import type { EvnexElectricityCost, EvnexElectricityCostTotal } from "./cost";
+export interface EvnexEnergyTransaction {
+    meterStart: number;
+    startDate: Date;
+    meterStop?: number | null;
+    endDate?: Date | null;
+    reason?: string | null;
+}
+export interface EvnexEnergyUsage {
+    total: number;
+    distributionByTariff?: any | null;
+    distributionByEnergySource?: any | null;
+}
+export interface EvnexChargeSchedulePeriod {
+    limit: number;
+    startPeriod: number;
+}
+export interface EvnexChargeSchedule {
+    enabled: boolean;
+    chargingSchedulePeriods: EvnexChargeSchedulePeriod[];
+}
+export interface EvnexChargeProfile {
+    chargeSchedule?: EvnexChargeSchedule | null;
+}
+export interface EvnexChargePointConnectorMeter {
+    currentL1?: number | null;
+    currentL2?: number | null;
+    currentL3?: number | null;
+    frequency: number;
+    power: number;
+    register: number;
+    updatedDate: Date;
+    temperature?: number | null;
+    voltageL1N?: number | null;
+    voltageL2N?: number | null;
+    voltageL3N?: number | null;
+}
+export interface EvnexChargePointConnector {
+    evseId: string;
+    connectorFormat: string;
+    connectorType: string;
+    ocppStatus: string;
+    powerType: string;
+    connectorId: string;
+    ocppCode: string;
+    updatedDate: Date;
+    meter: EvnexChargePointConnectorMeter;
+    maxVoltage: number;
+    maxAmperage: number;
+}
+export interface EvnexChargePointDetail {
+    connectors: EvnexChargePointConnector[];
+    createdDate: Date;
+    electricityCost: EvnexElectricityCost;
+    firmware: string;
+    maxCurrent: number;
+    model: string;
+    name: string;
+    networkStatus: string;
+    networkStatusUpdatedDate: Date;
+    ocppChargePointId: string;
+    profiles: EvnexChargeProfile;
+    serial: string;
+    timeZone: string;
+    tokenRequired: boolean;
+    updatedDate: Date;
+    vendor: string;
+    iccid?: string | null;
+}
+export interface EvnexChargePointSessionAttributes {
+    totalCarbonUsage?: number | null;
+    chargingStarted?: Date | null;
+    chargingStopped?: Date | null;
+    connectorId?: string | null;
+    createdDate?: Date | null;
+    evseId?: string | null;
+    sessionStatus?: string | null;
+    startDate?: Date | null;
+    updatedDate?: Date | null;
+    authorizationMethod?: string | null;
+    electricityCost?: EvnexElectricityCost | null;
+    endDate?: Date | null;
+    totalChargingTime?: number | null;
+    totalDuration?: number | null;
+    totalEnergyUsage?: EvnexEnergyUsage | null;
+    totalCost?: EvnexElectricityCostTotal | null;
+    totalPowerUsage?: number | null;
+    transaction?: EvnexEnergyTransaction | null;
+}
+export interface EvnexChargePointSession {
+    attributes: EvnexChargePointSessionAttributes;
+    id: string;
+    type: string;
+    relationships?: EvnexRelationships | null;
+}
+export interface EvnexGetChargePointSessionsResponse {
+    data: EvnexChargePointSession[];
+}

package/dist/src/schema/v3/commands.d.ts

@@ -0,0 +1,4 @@
+export interface EvnexCommandResponse {
+    message: string;
+    status: string;
+}

package/dist/src/schema/v3/cost.d.ts

@@ -0,0 +1,16 @@
+export interface EvnexElectricityTariff {
+    start: number;
+    rate: number;
+    type: string;
+}
+export interface EvnexElectricityCost {
+    currency: string;
+    tariffs: EvnexElectricityTariff[];
+    tariffType: string;
+    cost?: number | null;
+}
+export interface EvnexElectricityCostTotal {
+    currency: string;
+    amount: number;
+    distribution?: any;
+}

package/dist/src/schema/v3/generic.d.ts

@@ -0,0 +1,16 @@
+import type { EvnexRelationships } from "./relationships";
+export interface EvnexV3Include {
+    id: string;
+    type: string;
+    attributes: Record<string, unknown>;
+}
+export interface EvnexV3Data<T> {
+    id: string;
+    type: string;
+    attributes: T;
+    relationships: EvnexRelationships;
+}
+export interface EvnexV3APIResponse<T> {
+    data: EvnexV3Data<T>;
+    included?: EvnexV3Include[] | null;
+}

package/dist/src/schema/v3/relationships.d.ts

@@ -0,0 +1,12 @@
+export interface EvnexRelationship {
+    id: string;
+    type: string;
+}
+export interface EvnexRelationshipWrapper {
+    data?: EvnexRelationship | null;
+}
+export interface EvnexRelationships {
+    chargePoint?: EvnexRelationshipWrapper | null;
+    location?: EvnexRelationshipWrapper | null;
+    organisation?: EvnexRelationshipWrapper | null;
+}

package/dist/src/status.d.ts

@@ -0,0 +1,13 @@
+export declare enum DeviceStatus {
+    OFFLINE = "OFFLINE",
+    AVAILABLE = "AVAILABLE",
+    PREPARING = "PREPARING",
+    CHARGING = "CHARGING",
+    SUSPENDED_EVSE = "SUSPENDED_EVSE",
+    SUSPENDED_EV = "SUSPENDED_EV",
+    FINISHING = "FINISHING",
+    RESERVED = "RESERVED",
+    UNAVAILABLE = "UNAVAILABLE",
+    FAULTED = "FAULTED"
+}
+export declare const ConnectorOcppStatus: Record<DeviceStatus, string>;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "typescript-evnex",
+  "author": "Ben Lawrence",
+  "description": "A TypeScript library for interacting with the Evnex API",
+  "license": "MIT",
+  "version": "1.0.0",
+  "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": "bun build ./src/index.ts --outdir ./dist --target node --format esm && tsc -p tsconfig.build.json"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@aws-sdk/client-cognito-identity-provider": "^3.1000.0",
+    "axios": "^1.13.6",
+    "zod": "^4.3.6"
+  }
+}