marcogll/passkit-generator
1
0
Fork 0
mirror of https://github.com/marcogll/passkit-generator.git synced 2026-03-15 19:25:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Moved preferredStyleSchemes schema and properties to root (fixed Apple WWDC video misinformation)

Browse Source
This commit is contained in:
Alexander Cerutti
2024-10-01 13:07:13 +02:00
parent bbe02b83b4
commit dff2870eec
3 changed files with 59 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/schemas/PassFields.ts
View File

@@ -12,13 +12,6 @@ export const TransitType = Joi.string().regex(
/(PKTransitTypeAir|PKTransitTypeBoat|PKTransitTypeBus|PKTransitTypeGeneric|PKTransitTypeTrain)/,
);
export type PreferredStyleSchemes = ("posterEventTicket" | "eventTicket")[];
export const PreferredStyleSchemes = Joi.array().items(
"posterEventTicket",
"eventTicket",
) satisfies Joi.Schema<PreferredStyleSchemes>;
export interface PassFields {
auxiliaryFields: FieldWithRow[];
backFields: Field[];
@@ -26,7 +19,6 @@ export interface PassFields {
primaryFields: Field[];
secondaryFields: Field[];
transitType?: TransitType;
preferredStyleSchemes?: PreferredStyleSchemes;
}
export const PassFields = Joi.object<PassFields>().keys({

51
src/schemas/index.ts
View File

@@ -15,7 +15,7 @@ import { Barcode } from "./Barcode";
import { Location } from "./Location";
import { Beacon } from "./Beacon";
import { NFC } from "./NFC";
import { PassFields, PreferredStyleSchemes, TransitType } from "./PassFields";
import { PassFields, TransitType } from "./PassFields";
import { Semantics } from "./Semantics";
import { CertificatesSchema } from "./Certificates";
@@ -26,6 +26,13 @@ const RGB_COLOR_REGEX =
const URL_REGEX = /https?:\/\/(?:[a-z0-9]+\.?)+(?::\d{2,})?(?:\/[\S]+)*/;
export type PreferredStyleSchemes = ("posterEventTicket" | "eventTicket")[];
export const PreferredStyleSchemes = Joi.array().items(
"posterEventTicket",
"eventTicket",
) satisfies Joi.Schema<PreferredStyleSchemes>;
export interface FileBuffers {
[key: string]: Buffer;
}
@@ -63,20 +70,7 @@ export interface PassProps {
locations?: Location[];
boardingPass?: PassFields & { transitType: TransitType };
eventTicket?: PassFields & {
/**
* New field coming in iOS 18
* `"eventTicket"` is the legacy style.
*
* If used, passkit will try to render following the old style
* first.
*
* Which means that `primaryFields`, `secondaryFields` and
* so on, are not necessary anymore for the new style,
* as semantics are preferred.
*/
preferredStyleSchemes?: PreferredStyleSchemes;
};
eventTicket?: PassFields;
coupon?: PassFields;
generic?: PassFields;
storeCard?: PassFields;
@@ -98,6 +92,12 @@ export interface PassProps {
* Event Ticket
*/
parkingInformationURL?: string;
/**
* New field for iOS 18
* Event Ticket
*/
preferredStyleSchemes?: PreferredStyleSchemes;
}
/**
@@ -145,22 +145,7 @@ export const PassKindsProps = Joi.object<PassKindsProps>({
coupon: PassFields.disallow("transitType"),
generic: PassFields.disallow("transitType"),
storeCard: PassFields.disallow("transitType"),
eventTicket: PassFields.disallow("transitType").concat(
Joi.object<PassProps["eventTicket"]>().keys({
/**
* New field coming in iOS 18
* `"eventTicket"` is the legacy style.
*
* If used, passkit will try to render following the old style
* first.
*
* Which means that `primaryFields`, `secondaryFields` and
* so on, are not necessary anymore for the new style,
* as semantics are preferred.
*/
preferredStyleSchemes: PreferredStyleSchemes,
}),
),
eventTicket: PassFields.disallow("transitType"),
boardingPass: PassFields,
});
@@ -206,6 +191,10 @@ export const OverridablePassProps = Joi.object<OverridablePassProps>({
/**
* New field for iOS 18
* Event Ticket
* `"eventTicket"` is the legacy style.
*
* Passkit will try to render a style based on the order
* of the properties
*/
parkingInformationURL: Joi.string().regex(URL_REGEX),
}).with("webServiceURL", "authenticationToken");