@walletpass/pass-js/dist/lib/upcoming-pass-information.d.ts

Apple Wallet Pass generating and pushing updates from Node.js

import type { ApplePass, Field, SemanticTags } from '../interfaces.js';
/** An individual density variant of a remote image. */
export interface ImageURLEntry {
    /** HTTPS URL Wallet downloads at render time. */
    URL: string;
    /** Lowercase-hex SHA-256 of the downloaded bytes. */
    SHA256: string;
    /** 1, 2, or 3. Defaults to 1 when unspecified. */
    scale?: 1 | 2 | 3;
    /** Byte size of the image; must not exceed 2 MiB. */
    size?: number;
}
/** Remote image dictionary with one or more density variants. */
export interface Image {
    URLs: ImageURLEntry[];
    /** When `true`, Wallet may reuse a matching local asset if available. */
    reuseExisting?: boolean;
}
/** Image slots recognized for an upcoming pass information entry. */
export interface Images {
    headerImage?: Image;
    venueMap?: Image;
}
/**
 * URLs embedded in the upcoming entry's event guide. Mirrors the 14
 * pass-level `PassEventTicketKeys` URL fields.
 */
export interface UpcomingURLs {
    accessibilityURL?: string;
    addOnURL?: string;
    bagPolicyURL?: string;
    contactVenueEmail?: string;
    contactVenuePhoneNumber?: string;
    contactVenueWebsite?: string;
    directionsInformationURL?: string;
    merchandiseURL?: string;
    orderFoodURL?: string;
    parkingInformationURL?: string;
    purchaseParkingURL?: string;
    sellURL?: string;
    transferURL?: string;
    transitInformationURL?: string;
}
/** Structured date metadata for an upcoming event. */
export interface DateInformation {
    /** ISO-8601 / W3C string or `Date`. Required. */
    date: string | Date;
    /** IANA time zone name (e.g. `America/New_York`). */
    timeZone?: string;
    /** When `true`, the pass displays only the date, not the time. */
    ignoreTimeComponents?: boolean;
    /** When `true`, the system treats the event as all-day. */
    isAllDay?: boolean;
    /** When `true`, the pass shows "Time TBA". */
    isUnannounced?: boolean;
    /** When `true`, the pass shows the date as undetermined. */
    isUndetermined?: boolean;
}
/**
 * Per-entry semantic tags. Uses the pass-level `SemanticTags` shape plus
 * the MapKit Place ID field unique to upcoming entries.
 */
export type UpcomingEntrySemantics = SemanticTags & {
    venuePlaceID?: string;
};
export type UpcomingPassInformationType = 'event';
/** A single upcoming pass information entry. */
export interface UpcomingPassInformationEntry {
    /** Stable unique identifier; Wallet uses this to chain updates. */
    identifier: string;
    /** Human-readable name of the upcoming event. */
    name: string;
    /** Must equal `'event'` (reserved for future values). */
    type: UpcomingPassInformationType;
    /** Fields shown on the entry's details view. */
    additionalInfoFields?: Field[];
    /**
     * App Store identifiers associated with this specific upcoming entry.
     * The first ID compatible with the device is used.
     */
    auxiliaryStoreIdentifiers?: number[];
    /** Fields shown on the back of the entry's details view. */
    backFields?: Field[];
    /** Start/end timing metadata; if omitted, entry is labeled TBD. */
    dateInformation?: DateInformation;
    /** Remote images to render in the details view. */
    images?: Images;
    /** When `true`, the entry is currently active. Defaults to `false`. */
    isActive?: boolean;
    /** Per-entry semantic tags. */
    semantics?: UpcomingEntrySemantics;
    /** URLs for the event guide of this upcoming entry. */
    URLs?: UpcomingURLs;
}
/**
 * Per-entry shape validation for `upcomingPassInformation`. Runs at
 * setter time and does not look at any other pass field, so it cannot
 * produce order-dependent failures when a caller hydrates a pass from
 * a plain object whose key order puts `upcomingPassInformation`
 * before `preferredStyleSchemes`.
 *
 * Cross-field checks (eventTicket style + `posterEventTicket` scheme)
 * live in `assertUpcomingPassInformationContext` and run at pass-build
 * time, in `Pass.validate()`.
 *
 * Throws `TypeError` on any rule violation; returns the input array
 * unchanged on success.
 */
export declare function validateUpcomingPassInformationEntries(value: UpcomingPassInformationEntry[]): UpcomingPassInformationEntry[];
/**
 * Cross-field context check for `upcomingPassInformation`: the pass
 * must be an `eventTicket` opted into the `posterEventTicket` scheme.
 * No-ops if `upcomingPassInformation` is unset.
 *
 * Intended to run at pass-build time (from `Pass.validate()`), after
 * the caller has finished wiring the pass's fields. Keeping this
 * separate from `validateUpcomingPassInformationEntries` avoids an
 * order-dependency bug when hydrating a pass from a serialized object
 * whose key order is not style-first.
 */
export declare function assertUpcomingPassInformationContext(pass: Partial<ApplePass>): void;
//# sourceMappingURL=upcoming-pass-information.d.ts.map