mirror of
https://github.com/marcogll/passkit-generator.git
synced 2026-03-15 19:25:23 +00:00
134 lines
3.4 KiB
TypeScript
134 lines
3.4 KiB
TypeScript
import Joi from "joi";
|
|
import { Semantics } from "./Semantics.js";
|
|
|
|
export type PKDataDetectorType =
|
|
| "PKDataDetectorTypePhoneNumber"
|
|
| "PKDataDetectorTypeLink"
|
|
| "PKDataDetectorTypeAddress"
|
|
| "PKDataDetectorTypeCalendarEvent";
|
|
|
|
export type PKTextAlignmentType =
|
|
| "PKTextAlignmentLeft"
|
|
| "PKTextAlignmentCenter"
|
|
| "PKTextAlignmentRight"
|
|
| "PKTextAlignmentNatural";
|
|
|
|
export type PKDateStyleType =
|
|
| "PKDateStyleNone"
|
|
| "PKDateStyleShort"
|
|
| "PKDateStyleMedium"
|
|
| "PKDateStyleLong"
|
|
| "PKDateStyleFull";
|
|
|
|
export type PKNumberStyleType =
|
|
| "PKNumberStyleDecimal"
|
|
| "PKNumberStylePercent"
|
|
| "PKNumberStyleScientific"
|
|
| "PKNumberStyleSpellOut";
|
|
|
|
/**
|
|
* @see https://developer.apple.com/documentation/walletpasses/passfieldcontent
|
|
*/
|
|
|
|
export interface PassFieldContent {
|
|
attributedValue?: string | number | Date;
|
|
changeMessage?: string;
|
|
dataDetectorTypes?: PKDataDetectorType[];
|
|
label?: string;
|
|
textAlignment?: PKTextAlignmentType;
|
|
key: string;
|
|
value: string | number | Date;
|
|
semantics?: Semantics;
|
|
dateStyle?: PKDateStyleType;
|
|
ignoresTimeZone?: boolean;
|
|
isRelative?: boolean;
|
|
timeStyle?: PKDateStyleType;
|
|
currencyCode?: string;
|
|
numberStyle?: PKNumberStyleType;
|
|
}
|
|
|
|
/**
|
|
* @deprecated Use `PassFieldContent` instead,
|
|
* which is the right Apple name.
|
|
*/
|
|
export type Field = PassFieldContent;
|
|
|
|
export interface PassFieldContentWithRow extends PassFieldContent {
|
|
row?: 0 | 1;
|
|
}
|
|
|
|
/**
|
|
* @deprecated Use `PassFieldContentWithRow` instead,
|
|
* which is the right Apple name.
|
|
*/
|
|
export type FieldWithRow = PassFieldContentWithRow;
|
|
|
|
export const PassFieldContent = Joi.object<PassFieldContent>().keys({
|
|
attributedValue: Joi.alternatives(
|
|
Joi.string().allow(""),
|
|
Joi.number(),
|
|
Joi.date().iso(),
|
|
),
|
|
changeMessage: Joi.string(),
|
|
dataDetectorTypes: Joi.array().items(
|
|
Joi.string().regex(
|
|
/(PKDataDetectorTypePhoneNumber|PKDataDetectorTypeLink|PKDataDetectorTypeAddress|PKDataDetectorTypeCalendarEvent)/,
|
|
"dataDetectorType",
|
|
),
|
|
),
|
|
label: Joi.string().allow(""),
|
|
textAlignment: Joi.string().regex(
|
|
/(PKTextAlignmentLeft|PKTextAlignmentCenter|PKTextAlignmentRight|PKTextAlignmentNatural)/,
|
|
"graphic-alignment",
|
|
),
|
|
key: Joi.string().required(),
|
|
value: Joi.alternatives(
|
|
Joi.string().allow(""),
|
|
Joi.number(),
|
|
Joi.date().iso(),
|
|
).required(),
|
|
semantics: Semantics,
|
|
// date fields formatters, all optionals
|
|
dateStyle: Joi.string().regex(
|
|
/(PKDateStyleNone|PKDateStyleShort|PKDateStyleMedium|PKDateStyleLong|PKDateStyleFull)/,
|
|
"date style",
|
|
),
|
|
ignoresTimeZone: Joi.boolean(),
|
|
isRelative: Joi.boolean(),
|
|
timeStyle: Joi.string().regex(
|
|
/(PKDateStyleNone|PKDateStyleShort|PKDateStyleMedium|PKDateStyleLong|PKDateStyleFull)/,
|
|
"date style",
|
|
),
|
|
// number fields formatters, all optionals
|
|
currencyCode: Joi.string().when("value", {
|
|
is: Joi.number(),
|
|
otherwise: Joi.string().forbidden(),
|
|
}),
|
|
numberStyle: Joi.string()
|
|
.regex(
|
|
/(PKNumberStyleDecimal|PKNumberStylePercent|PKNumberStyleScientific|PKNumberStyleSpellOut)/,
|
|
)
|
|
.when("value", {
|
|
is: Joi.number(),
|
|
otherwise: Joi.string().forbidden(),
|
|
}),
|
|
});
|
|
|
|
/**
|
|
* @deprecated Use `PassFieldContent` instead,
|
|
* which is the right Apple name.
|
|
*/
|
|
export const Field = PassFieldContent;
|
|
|
|
export const PassFieldContentWithRow = PassFieldContent.concat(
|
|
Joi.object<PassFieldContentWithRow>().keys({
|
|
row: Joi.number().min(0).max(1),
|
|
}),
|
|
);
|
|
|
|
/**
|
|
* @deprecated Use `PassFieldContentWithRow` instead,
|
|
* which is the right Apple name.
|
|
*/
|
|
export const FieldWithRow = PassFieldContentWithRow;
|