From 2085e63a22ea103e69ecf35ad31e29ed50c39625 Mon Sep 17 00:00:00 2001 From: Alexander Cerutti Date: Wed, 2 Oct 2024 20:22:45 +0200 Subject: [PATCH] Improved comments --- src/schemas/index.ts | 99 ++++++++++++++++++++++++++++++++------------ 1 file changed, 73 insertions(+), 26 deletions(-) diff --git a/src/schemas/index.ts b/src/schemas/index.ts index 9945b1b..340bc53 100644 --- a/src/schemas/index.ts +++ b/src/schemas/index.ts @@ -102,35 +102,61 @@ export interface PassProps { * New field for iOS 18 * 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; /** - * New field for iOS 18 - * Event Ticket + * 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. */ orderFoodURL?: string; /** - * New field for iOS 18 - * Event Ticket + * 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. */ parkingInformationURL?: string; - /** - * New field for iOS 18 - * Event Ticket - */ - preferredStyleSchemes?: PreferredStyleSchemes; /** - * New field for iOS 18 - * Event Ticket + * 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. */ directionsInformationURL?: string; /** - * New field for iOS 18 - * Event Ticket + * 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. */ contactVenueEmail?: string; } @@ -216,36 +242,57 @@ export const OverridablePassProps = Joi.object({ webServiceURL: Joi.string().regex(URL_REGEX), /** - * New field for iOS 18 - * Event Ticket + * 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: Joi.string().regex(URL_REGEX), /** - * New field for iOS 18 - * Event Ticket + * 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. */ orderFoodURL: Joi.string().regex(URL_REGEX), /** - * New field for iOS 18 - * Event Ticket - * `"eventTicket"` is the legacy style. + * New field for iOS 18 Event Ticket. * - * Passkit will try to render a style based on the order - * of the properties + * To show buttons in the event guide, + * at least two between `bagPolicyURL`, + * `orderFoodURL`, `parkingInformationURL`, + * `directionsInformationURL` and `contactVenueEmail` + * must be used. */ parkingInformationURL: Joi.string().regex(URL_REGEX), /** - * New field for iOS 18 - * Event Ticket + * 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. */ directionsInformationURL: Joi.string(), /** - * New field for iOS 18 - * Event Ticket + * 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. */ contactVenueEmail: Joi.string(), }).with("webServiceURL", "authenticationToken");