Improved comments

This commit is contained in:
Alexander Cerutti
2024-10-02 20:22:45 +02:00
parent 75bc722b30
commit 2085e63a22

View File

@@ -102,35 +102,61 @@ export interface PassProps {
* New field for iOS 18 * New field for iOS 18
* Event Ticket * Event Ticket
*/ */
preferredStyleSchemes?: PreferredStyleSchemes;
/**
* New field for iOS 18 Event Ticket.
*
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/
bagPolicyURL?: string; bagPolicyURL?: string;
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
orderFoodURL?: string; orderFoodURL?: string;
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
parkingInformationURL?: string; parkingInformationURL?: string;
/**
* New field for iOS 18
* Event Ticket
*/
preferredStyleSchemes?: PreferredStyleSchemes;
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
directionsInformationURL?: string; directionsInformationURL?: string;
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
contactVenueEmail?: string; contactVenueEmail?: string;
} }
@@ -216,36 +242,57 @@ export const OverridablePassProps = Joi.object<OverridablePassProps>({
webServiceURL: Joi.string().regex(URL_REGEX), webServiceURL: Joi.string().regex(URL_REGEX),
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
bagPolicyURL: Joi.string().regex(URL_REGEX), bagPolicyURL: Joi.string().regex(URL_REGEX),
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
orderFoodURL: Joi.string().regex(URL_REGEX), orderFoodURL: Joi.string().regex(URL_REGEX),
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket
* `"eventTicket"` is the legacy style.
* *
* Passkit will try to render a style based on the order * To show buttons in the event guide,
* of the properties * at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
parkingInformationURL: Joi.string().regex(URL_REGEX), parkingInformationURL: Joi.string().regex(URL_REGEX),
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
directionsInformationURL: Joi.string(), directionsInformationURL: Joi.string(),
/** /**
* New field for iOS 18 * New field for iOS 18 Event Ticket.
* Event Ticket *
* To show buttons in the event guide,
* at least two between `bagPolicyURL`,
* `orderFoodURL`, `parkingInformationURL`,
* `directionsInformationURL` and `contactVenueEmail`
* must be used.
*/ */
contactVenueEmail: Joi.string(), contactVenueEmail: Joi.string(),
}).with("webServiceURL", "authenticationToken"); }).with("webServiceURL", "authenticationToken");