@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
564 lines (563 loc) • 25.9 kB
TypeScript
import { z } from 'zod';
export declare const MessageInfoSchema: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
databaseId: z.ZodNumber;
ocppConnectionName: z.ZodString;
id: z.ZodNumber;
priority: z.ZodEnum<{
AlwaysFront: "AlwaysFront";
InFront: "InFront";
NormalCycle: "NormalCycle";
}>;
state: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
Charging: "Charging";
Idle: "Idle";
Unavailable: "Unavailable";
Faulted: "Faulted";
}>>>;
startDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
endDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
message: z.ZodObject<{
format: z.ZodEnum<{
ASCII: "ASCII";
HTML: "HTML";
URI: "URI";
UTF8: "UTF8";
}>;
language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
content: z.ZodString;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>;
active: z.ZodBoolean;
display: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
instance: z.ZodOptional<z.ZodNullable<z.ZodString>>;
evse: z.ZodOptional<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
databaseId: z.ZodOptional<z.ZodNumber>;
id: z.ZodNumber;
connectorId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>>;
evseDatabaseId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
instance: z.ZodOptional<z.ZodNullable<z.ZodString>>;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>>>;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>;
displayComponentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>;
export declare const MessageInfoProps: {
id: "id";
ocppConnectionName: "ocppConnectionName";
message: "message";
transactionId: "transactionId";
tenant: "tenant";
priority: "priority";
tenantId: "tenantId";
updatedAt: "updatedAt";
createdAt: "createdAt";
state: "state";
databaseId: "databaseId";
startDateTime: "startDateTime";
endDateTime: "endDateTime";
active: "active";
display: "display";
displayComponentId: "displayComponentId";
};
export type MessageInfoDto = z.infer<typeof MessageInfoSchema>;
export declare const MessageInfoCreateSchema: z.ZodObject<{
id: z.ZodNumber;
ocppConnectionName: z.ZodString;
message: z.ZodObject<{
format: z.ZodEnum<{
ASCII: "ASCII";
HTML: "HTML";
URI: "URI";
UTF8: "UTF8";
}>;
language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
content: z.ZodString;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>;
transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
priority: z.ZodEnum<{
AlwaysFront: "AlwaysFront";
InFront: "InFront";
NormalCycle: "NormalCycle";
}>;
tenantId: z.ZodOptional<z.ZodNumber>;
state: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
Charging: "Charging";
Idle: "Idle";
Unavailable: "Unavailable";
Faulted: "Faulted";
}>>>;
startDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
endDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
active: z.ZodBoolean;
displayComponentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>;
export type MessageInfoCreate = z.infer<typeof MessageInfoCreateSchema>;
export declare const messageInfoSchemas: {
MessageInfo: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
databaseId: z.ZodNumber;
ocppConnectionName: z.ZodString;
id: z.ZodNumber;
priority: z.ZodEnum<{
AlwaysFront: "AlwaysFront";
InFront: "InFront";
NormalCycle: "NormalCycle";
}>;
state: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
Charging: "Charging";
Idle: "Idle";
Unavailable: "Unavailable";
Faulted: "Faulted";
}>>>;
startDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
endDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
message: z.ZodObject<{
format: z.ZodEnum<{
ASCII: "ASCII";
HTML: "HTML";
URI: "URI";
UTF8: "UTF8";
}>;
language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
content: z.ZodString;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>;
active: z.ZodBoolean;
display: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
instance: z.ZodOptional<z.ZodNullable<z.ZodString>>;
evse: z.ZodOptional<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
databaseId: z.ZodOptional<z.ZodNumber>;
id: z.ZodNumber;
connectorId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>>;
evseDatabaseId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
instance: z.ZodOptional<z.ZodNullable<z.ZodString>>;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>>>;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>;
displayComponentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>;
MessageInfoCreate: z.ZodObject<{
id: z.ZodNumber;
ocppConnectionName: z.ZodString;
message: z.ZodObject<{
format: z.ZodEnum<{
ASCII: "ASCII";
HTML: "HTML";
URI: "URI";
UTF8: "UTF8";
}>;
language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
content: z.ZodString;
customData: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, z.core.$strip>;
transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
priority: z.ZodEnum<{
AlwaysFront: "AlwaysFront";
InFront: "InFront";
NormalCycle: "NormalCycle";
}>;
tenantId: z.ZodOptional<z.ZodNumber>;
state: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
Charging: "Charging";
Idle: "Idle";
Unavailable: "Unavailable";
Faulted: "Faulted";
}>>>;
startDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
endDateTime: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
active: z.ZodBoolean;
displayComponentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>;
};