Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 141 additions & 0 deletions ocpi.bookinglocation.v23.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
import { z } from "zod";
import { ConnectorFormat, EvsePosition, VehicleType } from "./ocpi.location.v23";
import { OcpiInterfaceRole } from "./ocpi.versions.v23";
import { TokenType } from "./ocpi.common.v23";

export const BookableParkingOptions = z.object({
evse_position: EvsePosition.nullish(),
vehicle_types: z.array(VehicleType).nonempty(),
format: ConnectorFormat,
max_vehicle_weight: z.number().nonnegative().nullish(),
max_vehicle_height: z.number().nonnegative().nullish(),
max_vehicle_length: z.number().nonnegative().nullish(),
max_vehicle_width: z.number().nonnegative().nullish(),
parking_space_length: z.number().nonnegative().nullish(),
parking_space_width: z.number().nonnegative().nullish(),
dangerous_goods_allowed: z.boolean().nullish(),
drive_through: z.boolean().nullish(),
restricted_to_type: z.boolean().nullish(),
refrigeration_outlet: z.boolean().nullish(),
});

export const CanceledReason = z.enum([
"POWER_OUTAGE",
"BROKEN_CHARGER",
"FULL",
"BLOCKED",
"TRAFFIC",
"BROKEN_VEHICLE",
"NO_CANCELED",
"UNKNOWN",
]);

export const Cancellation = z.object({
cancellation_reason: CanceledReason,
who_canceled: OcpiInterfaceRole,
});

export const LocationAccess = z.enum([
"OPEN",
"TOKEN",
"LICENSE_PLATE",
"ACCESS_CODE",
"INTERCOM",
"PARKING_TICKET",
]);

export const AccessMethod = z.object({
location_access: LocationAccess,
value: z.string().nullish(),
});

export const ReservationRequestStatus = z.enum([
"PENDING",
"ACCEPTED",
"DECLINED",
"FAILED",
]);

export const BookingToken = z.object({
country_code: z.string().max(2),
party_id: z.string().max(3),
uid: z.string().max(36).nullish(),
type: TokenType,
contract_id: z.string().max(36).nullish(),
});

export const Timeslot = z.object({
start_from: z.date(),
end_from: z.date(),
min_power: z.number().nonnegative().nullish(),
max_power: z.number().nonnegative().nullish(),
green_energy_support: z.boolean().nullish(),
});

export const BookingRequest = z.object({
country_code: z.string().max(2),
party_id: z.string().max(3),
request_id: z.string().max(36),
bookable_parking_option: BookableParkingOptions.nullish(),
location_id: z.string().max(36),
evse_uid: z.string().max(36).nullish(),
connector_id: z.string().max(36).nullish(),
tokens: z.array(BookingToken).nullish(),
period: Timeslot,
authorization_reference: z.string().max(36),
power_required: z.number().int().nullish(),
cancelled: Cancellation.nullish(),
});

export const BookingRequestStatus = z.object({
request_status: ReservationRequestStatus,
booking_request: BookingRequest,
request_received: z.date(),
});

export const Bookable = z.object({
reservation_required: z.boolean(),
ad_hoc: z.number().nonnegative().nullish(),
});

export const BookingTerms = z.object({
RFID_auth_required: z.boolean().nullish(),
token_groups_supported: z.boolean().nullish(),
remote_auth_supported: z.array(LocationAccess).nonempty(),
supported_access_methods: z.number().nonnegative().nullish(),
change_until_minutes: z.number().nonnegative(),
cancel_until_minutes: z.number().nonnegative(),
change_not_allowed: z.boolean().nullish(),
early_start_allowed: z.boolean().nullish(),
early_start_time: z.number().nonnegative().nullish(),
noshow_timeout: z.number().nonnegative().nullish(),
noshow_fee: z.boolean().nullish(),
late_stop_allowed: z.boolean().nullish(),
late_stop_time: z.number().nonnegative().nullish(),
overlapping_bookings_allowed: z.boolean().nullish(),
booking_terms: z.string().url().nullish(),
});

export const Calendar = z.object({
id: z.string().max(36),
begin_from: z.date(),
end_before: z.date(),
step_size: z.number().int().nullish(),
available_timeslots: z.array(Timeslot).nonempty(),
last_updated: z.date(),
});

export const BookingLocation = z.object({
country_code: z.string().max(2),
party_id: z.string().max(3),
id: z.string().max(36),
location_id: z.string().max(36),
evse_uid: z.string().max(36).nullish(),
connector_id: z.string().max(36).nullish(),
bookable_parking_options: z.array(BookableParkingOptions).nullish(),
bookable: Bookable.nullish(),
tariff_id: z.string().max(36).nullish(),
booking_terms: z.array(BookingTerms).nullish(),
calendars: z.array(Calendar).nullish(),
last_updated: z.date(),
});
105 changes: 105 additions & 0 deletions ocpi.cdrs.v23.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import { z } from "zod";

import { Price } from "./ocpi.common.v23";
import { TokenType } from "./ocpi.common.v23";
import { ConnectorFormat, ConnectorType, GeoLocation, PowerType } from "./ocpi.location.v23";
import { Tariff } from "./ocpi.tariff.v221";

export const AuthMethod = z.enum(["AUTH_REQUEST", "COMMAND", "WHITELIST"]);

const CdrDimensionType = z.enum([
"ENERGY",
"MAX_CURRENT",
"MIN_CURRENT",
"MAX_POWER",
"MIN_POWER",
"PARKING_TIME",
"RESERVATION_TIME",
"TIME",
]);

export const CdrDimension = z.object({
type: CdrDimensionType,
volume: z.number(),
});

export const CdrToken = z.object({
uid: z.string().max(36),
type: TokenType.nullish(),
contract_id: z.string().max(36),
country_code: z.string().max(2),
party_id: z.string().max(3),
})

export const CdrLocation = z.object({
id: z.string().max(36),
name: z.string().max(255).nullish(),
address: z.string().max(45),
city: z.string().max(45),
postal_code: z.string().max(10).nullish(),
state: z.string().max(20).nullish(),
country: z.string().length(3),
coordinates: GeoLocation,
evse_uid: z.string().max(36),
evse_id: z.string().max(48).regex(/^(([A-Z]{2}\*?[A-Z0-9]{3}\*?E[A-Z0-9\*]{1,30})|(\+?[0-9]{1,3}\*[0-9]{3}\*[0-9\*]{1,32}))$/),
connector_id: z.string().max(36),
connector_standard: ConnectorType,
connector_format: ConnectorFormat,
connector_power_type: PowerType,
})

export const ChargingPeriod = z.object({
start_date_time: z.date(),
dimensions: z.array(CdrDimension).nonempty(),
tariff_id: z.string().max(36).nullish(),
})

export const SignedValue = z.object({
nature: z.string().max(32),
plain_data: z.string().max(512),
signed_data: z.string().max(5000)
});

export const SignedData = z.object({
encoding_method: z.string().max(36),
encoding_method_version: z.number().int().nullish(),
public_key: z.string().max(512).nullish(),
signed_values: z.array(SignedValue).nonempty(),
url: z.string().max(512).nullish()
});

export const Cdr = z.object({
country_code: z.string().length(2),
party_id: z.string().max(3),
id: z.string().max(39),
start_date_time: z.date(),
end_date_time: z.date(),
booking_id: z.string().max(36).nullish(),
session_id: z.string().max(36).nullish(),
cdr_token: CdrToken,
auth_method: AuthMethod,
authorization_reference: z.string().max(36).nullish(),
cdr_location: CdrLocation,
meter_id: z.string().max(255).nullish(),
currency: z.string().length(3),
tariffs: z.array(Tariff).nullish(),
charging_periods: z.array(ChargingPeriod).nonempty(),
signed_data: SignedData.nullish(),
total_cost: Price,
total_fixed_cost: Price.nullish(),
total_energy: z.number().nonnegative(),
total_energy_cost: Price.nullish(),
total_time: z.number().nonnegative(),
total_time_cost: Price.nullish(),
total_parking_time: z.number().nonnegative().nullish(),
total_parking_cost: Price.nullish(),
total_reservation_cost: Price.nullish(),
remark: z.string().max(255).nullish(),
invoice_reference_id: z.string().max(39).nullish(),
credit: z.boolean().nullish(),
credit_reference_id: z.string().max(39).nullish(),
home_charging_compensation: z.boolean().nullish(),
last_updated: z.date(),
});

export const Cdrs = z.array(Cdr);
64 changes: 64 additions & 0 deletions ocpi.chargingprofiles.v23.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import { z } from "zod";

const ChargingProfileResponseType = z.enum([
"ACCEPTED",
"NOT_SUPPORTED",
"REJECTED",
"TOO_OFTEN",
"UNKNOWN_SESSION"
]);

const ChargingRateUnit = z.enum([
"W",
"A"
]);

const ChargingProfilePeriod = z.object({
start_period: z.number().int().nonnegative(),
limit: z.number().multipleOf(0.1).nonnegative(),
});

export const ChargingProfile = z.object({
start_date_time: z.date().nullish(),
duration: z.number().int().nonnegative().nullish(),
charging_rate_unit: ChargingRateUnit,
min_charging_rate: z.number().multipleOf(0.1).nonnegative().nullish(),
charging_profile_period: z.array(ChargingProfilePeriod).nullish()
});

const ChargingProfileResultType = z.enum([
"ACCEPTED",
"REJECTED",
"UNKNOWN"
]);

export const ActiveChargingProfile = z.object({
start_date_time: z.date(),
charging_profile: ChargingProfile
});

export const SetChargingProfile = z.object({
charging_profile: ChargingProfile,
response_url: z.string().url(),
});

export const ChargingProfileResponse = z.object({
result: ChargingProfileResponseType,
timeout: z.number().int().nonnegative(),
});

export const ActiveChargingProfileResult = z.object({
result: ChargingProfileResultType,
profile: ActiveChargingProfile.nullish(),
});

export const ChargingProfileResult = z.object({
result: ChargingProfileResultType,
});

export const ClearProfileResult = z.object({
result: ChargingProfileResultType,
});



Loading