node-chargepoint 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,438 @@
+interface ZoomBounds {
+    neLon: number;
+    neLat: number;
+    swLon: number;
+    swLat: number;
+}
+interface Country {
+    id: number;
+    name: string;
+    code: string;
+    callingCode: number;
+    phoneFormat: string;
+    zoomBounds: ZoomBounds;
+}
+interface Currency {
+    code: string;
+    name: string;
+    cardCost: number;
+    symbol: string;
+    initialDeposit: number;
+    replenishmentThreshold: number;
+    maxDecimalPlaces: number;
+}
+interface APIEndpoints {
+    accountsEndpoint: string;
+    internalApiGatewayEndpoint: string;
+    mapcacheEndpoint: string;
+    pandaWebsocketEndpoint: string;
+    paymentJavaEndpoint: string;
+    paymentPhpEndpoint: string;
+    portalDomainEndpoint: string;
+    portalSubdomain: string;
+    ssoEndpoint: string;
+    webservicesEndpoint: string;
+    websocketEndpoint: string;
+    hcpoHcmEndpoint: string;
+}
+interface GlobalConfiguration {
+    region: string;
+    defaultCountry: Country;
+    supportedCountries: Country[];
+    defaultCurrency: Currency;
+    supportedCurrencies: Currency[];
+    endpoints: APIEndpoints;
+}
+interface User {
+    userId: number;
+    email: string;
+    username: string;
+    fullName: string;
+    givenName: string;
+    familyName: string;
+    phone: string;
+    phoneCountryId: number;
+    evatarUrl: string;
+}
+interface AccountBalance {
+    accountNumber: string;
+    accountState: string;
+    balance: {
+        currency: string;
+        amount: string;
+    };
+}
+interface Account {
+    user: User;
+    accountBalance: AccountBalance;
+}
+interface ElectricVehicle {
+    make: string;
+    model: string;
+    year: number;
+    primaryVehicle: boolean;
+    color: string;
+    imageUrl: string;
+    chargingSpeed: number;
+    dcChargingSpeed: number;
+}
+interface PowerUtilityPlan {
+    code: string;
+    id: number;
+    name: string;
+    isEvPlan: boolean;
+}
+interface PowerUtility {
+    id: number;
+    name: string;
+    plans: PowerUtilityPlan[];
+}
+interface HomeChargerStatus {
+    chargerId: number;
+    brand: string;
+    model: string;
+    macAddress: string;
+    chargingStatus: string;
+    isPluggedIn: boolean;
+    isConnected: boolean;
+    isReminderEnabled: boolean;
+    plugInReminderTime: string;
+    amperageLimit: number;
+    possibleAmperageLimits: number[];
+    hasUtilityInfo: boolean;
+    isDuringScheduledTime: boolean;
+}
+interface HomeChargerTechnicalInfo {
+    modelNumber: string;
+    serialNumber: string;
+    wifiMac: string;
+    macAddress: string;
+    softwareVersion: string;
+    lastOtaUpdate: string;
+    lastConnectedAt: string;
+    deviceIp: string;
+    stopChargeSupported: boolean;
+}
+interface LEDBrightness {
+    level: number;
+    inProgress: boolean;
+    supportedLevels: number[];
+    isEnabled: boolean;
+}
+interface HomeChargerConfiguration {
+    serialNumber: string;
+    macAddress: string;
+    stationNickname: string;
+    streetAddress: string;
+    hasUtilityInfo: boolean;
+    utility: PowerUtility | null;
+    indicatorLightEcoMode: boolean;
+    flashlightReset: boolean;
+    worksWithNest: boolean;
+    isPairedWithNest: boolean;
+    isInstalledByInstaller: boolean;
+    ledBrightness: LEDBrightness;
+}
+interface ChargeScheduleWindow {
+    startTime: string;
+    endTime: string;
+    startWeekday?: string;
+    endWeekday?: string;
+}
+interface ChargeSchedule {
+    weekdays: ChargeScheduleWindow;
+    weekends: ChargeScheduleWindow;
+}
+interface HomeChargerSchedule {
+    hasTouPricing: boolean;
+    scheduleEnabled: boolean;
+    hasUtilityInfo: boolean;
+    basedOnUtility: PowerUtility | null;
+    defaultSchedule: ChargeSchedule;
+    userSchedule: ChargeSchedule;
+    utilitySchedule: ChargeSchedule | null;
+}
+interface ChargingSessionUpdate {
+    energyKwh: number;
+    powerKw: number;
+    timestamp: Date;
+}
+interface VehicleInfo {
+    vehicleId: number;
+    batteryCapacity: number;
+    make: string;
+    model: string;
+    year: number;
+    evRange: number;
+    isPrimaryVehicle: boolean;
+}
+interface Station {
+    id: number;
+    name: string;
+    latitude: number;
+    longitude: number;
+}
+interface UserChargingStatus {
+    sessionId: number;
+    startTime: Date;
+    state: string;
+    stations: Station[];
+}
+interface MaxPower {
+    unit: string;
+    max: number;
+}
+interface StationAddress {
+    address1: string;
+    city: string;
+    state: string;
+}
+interface StationConnector {
+    status: string;
+    statusV2: string;
+    displayPlugType: string;
+    plugType: string;
+}
+interface StationPortDetail {
+    outletNumber: number;
+    status: string;
+    statusV2: string;
+    displayLevel: number;
+    level: number;
+    parkingAccessibility: string;
+    powerRange: MaxPower;
+    connectorList: StationConnector[];
+}
+interface StationNetwork {
+    name: string;
+    displayName: string;
+    logoUrl: string;
+}
+interface StationPortsInfo {
+    totalCount: number;
+    availableCount: number;
+    ports: StationPortDetail[];
+}
+interface StationTouEntry {
+    description: string;
+    price: number;
+}
+interface StationPricingFee {
+    amount: number;
+    currency: string;
+}
+interface StationTax {
+    name: string;
+    rate: number;
+}
+interface StationPrice {
+    currencyCode: string;
+    touFees: StationTouEntry[];
+    guestFee: StationPricingFee | null;
+    taxes: StationTax[];
+}
+interface StationInfo {
+    deviceId: number;
+    name: string[];
+    address: StationAddress;
+    description: string;
+    modelNumber: string;
+    network: StationNetwork;
+    portsInfo: StationPortsInfo;
+    stationStatus: string;
+    stationStatusV2: string;
+    latitude: number;
+    longitude: number;
+    hostName: string;
+    openCloseStatus: string;
+    maxPower: MaxPower | null;
+    accessRestriction: string;
+    parkingAccessibility: string;
+    stopChargeSupported: boolean;
+    remoteStartCharge: boolean;
+    sharedPower: boolean;
+    reducedPower: boolean;
+    stationPrice: StationPrice | null;
+    deviceSoftwareVersion: string;
+    lastChargedDate: string;
+}
+interface StationPort {
+    statusV2: string;
+    portType: string;
+    outletNumber: number;
+    parkingAccessibility: string;
+    availablePower: number;
+    status: string;
+}
+interface MapChargingInfo {
+    sessionId: number;
+    startTime: Date;
+    powerKw: number;
+}
+interface MapStation {
+    deviceId: number;
+    lat: number;
+    lon: number;
+    name1: string;
+    name2: string;
+    address1: string;
+    city: string;
+    networkDisplayName: string;
+    networkLogoUrl: string;
+    stationStatus: string;
+    stationStatusV2: string;
+    paymentType: string;
+    parkingAccessibility: string;
+    totalPortCount: number;
+    ports: StationPort[];
+    hasL2: boolean;
+    maxPower: number;
+    currencyIsoCode: string;
+    canRemoteStartCharge: boolean;
+    companyId: number;
+    touStatus: string;
+    displayLevel: number;
+    waitlistAllowed: boolean;
+    accessRestriction: string;
+    isHome: boolean;
+    chargingStatus: string;
+    chargingInfo: MapChargingInfo | null;
+}
+interface MapFilter {
+    disabledParking?: boolean;
+    vanAccessible?: boolean;
+    networkChargepoint?: boolean;
+    networkEvgo?: boolean;
+    networkBlink?: boolean;
+    networkFlo?: boolean;
+    networkIonna?: boolean;
+    networkEvconnect?: boolean;
+    networkEvgateway?: boolean;
+    networkBchydro?: boolean;
+    networkGreenlots?: boolean;
+    networkMercedes?: boolean;
+    networkCircuitelectric?: boolean;
+    connectorL1?: boolean;
+    connectorL2?: boolean;
+    connectorL2Nema1450?: boolean;
+    connectorL2Tesla?: boolean;
+    connectorTesla?: boolean;
+    connectorCombo?: boolean;
+    connectorChademo?: boolean;
+    dcFastCharging?: boolean;
+    statusAvailable?: boolean;
+    priceFree?: boolean;
+}
+
+type RawObj = Record<string, unknown>;
+declare class ChargingSession {
+    sessionId: number;
+    deviceId: number;
+    deviceName: string;
+    chargingState: string;
+    chargingTime: number;
+    energyKwh: number;
+    milesAdded: number;
+    milesAddedPerHour: number;
+    outletNumber: number;
+    portLevel: number;
+    powerKw: number;
+    purpose: string;
+    currencyIsoCode: string;
+    paymentCompleted: boolean;
+    paymentType: string;
+    pricingSpecId: number;
+    totalAmount: number;
+    apiFlag: boolean;
+    enableStopCharging: boolean;
+    hasChargingReceipt: boolean;
+    hasUtilityInfo: boolean;
+    isHomeCharger: boolean;
+    isPurposeFinalized: boolean;
+    stopChargeSupported: boolean;
+    companyId: number;
+    companyName: string;
+    latitude: number;
+    longitude: number;
+    address: string;
+    city: string;
+    stateName: string;
+    country: string;
+    zipcode: string;
+    updatePeriod: number;
+    startTime: Date | null;
+    lastUpdateDataTimestamp: Date | null;
+    updateData: ChargingSessionUpdate[] | null;
+    utility: PowerUtility | null;
+    vehicleInfo: VehicleInfo | null;
+    private _client;
+    constructor(sessionId: number);
+    /** @internal */
+    _setClient(client: ChargePoint): void;
+    /** @internal Apply raw session data from the driver-bff API (snake_case keys). */
+    _apply(data: RawObj): void;
+    refresh(): Promise<void>;
+    stop(): Promise<void>;
+    static start(deviceId: number, client: ChargePoint): Promise<ChargingSession>;
+}
+
+interface ChargePointOptions {
+    coulombToken?: string;
+    region?: string;
+}
+declare class ChargePoint {
+    globalConfig: GlobalConfiguration;
+    private _username;
+    private _coulombToken;
+    private _region;
+    private _userId;
+    /** The current session token. Save this after login to avoid re-authenticating. */
+    get coulombToken(): string | null;
+    private constructor();
+    static create(username: string, options?: ChargePointOptions): Promise<ChargePoint>;
+    private _setToken;
+    /** @internal Used by session.ts and tests. */
+    _request(method: string, url: string, init?: RequestInit): Promise<Response>;
+    loginWithPassword(password: string): Promise<void>;
+    loginWithSsoSession(ssoJwt: string): Promise<void>;
+    logout(): Promise<void>;
+    getAccount(): Promise<Account>;
+    getVehicles(): Promise<ElectricVehicle[]>;
+    getUserChargingStatus(): Promise<UserChargingStatus | null>;
+    private ensureUserId;
+    getHomeChargers(): Promise<number[]>;
+    getHomeChargerStatus(chargerId: number): Promise<HomeChargerStatus>;
+    getHomeChargerTechnicalInfo(chargerId: number): Promise<HomeChargerTechnicalInfo>;
+    getHomeChargerConfig(chargerId: number): Promise<HomeChargerConfiguration>;
+    getHomeChargerSchedule(chargerId: number): Promise<HomeChargerSchedule>;
+    setHomeChargerSchedule(chargerId: number, weekdayStart: string, weekdayEnd: string, weekendStart: string, weekendEnd: string): Promise<HomeChargerSchedule>;
+    disableHomeChargerSchedule(chargerId: number): Promise<void>;
+    setAmperageLimit(chargerId: number, amperageLimit: number): Promise<void>;
+    setLedBrightness(chargerId: number, level: number): Promise<void>;
+    restartHomeCharger(chargerId: number): Promise<void>;
+    getChargingSession(sessionId: number): Promise<ChargingSession>;
+    startChargingSession(deviceId: number): Promise<ChargingSession>;
+    getStation(deviceId: number): Promise<StationInfo>;
+    getNearbyStations(bounds: ZoomBounds, filter?: MapFilter): Promise<MapStation[]>;
+}
+
+declare class APIError extends Error {
+    constructor(message: string);
+}
+declare class CommunicationError extends APIError {
+    readonly statusCode: number;
+    readonly body?: unknown | undefined;
+    constructor(statusCode: number, message: string, body?: unknown | undefined);
+}
+declare class LoginError extends CommunicationError {
+    constructor(statusCode: number, message: string, body?: unknown);
+}
+declare class InvalidSession extends CommunicationError {
+    constructor(statusCode?: number, message?: string, body?: unknown);
+}
+declare class DatadomeCaptcha extends APIError {
+    readonly captchaUrl: string;
+    constructor(captchaUrl: string, message?: string);
+}
+
+export { type APIEndpoints, APIError, type Account, type AccountBalance, ChargePoint, type ChargePointOptions, type ChargeSchedule, type ChargeScheduleWindow, ChargingSession, type ChargingSessionUpdate, CommunicationError, type Country, type Currency, DatadomeCaptcha, type ElectricVehicle, type GlobalConfiguration, type HomeChargerConfiguration, type HomeChargerSchedule, type HomeChargerStatus, type HomeChargerTechnicalInfo, InvalidSession, type LEDBrightness, LoginError, type MapChargingInfo, type MapFilter, type MapStation, type MaxPower, type PowerUtility, type PowerUtilityPlan, type Station, type StationAddress, type StationConnector, type StationInfo, type StationNetwork, type StationPort, type StationPortDetail, type StationPortsInfo, type StationPrice, type StationPricingFee, type StationTax, type StationTouEntry, type User, type UserChargingStatus, type VehicleInfo, type ZoomBounds };