mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
Improve type definitions
Change enums to types. Make the properties on the ApplePayPaymentContact interface optional to make it easier to provide minimal information to an ApplePayPaymentRequest.
This commit is contained in:
martincostello
parent
0d5a690b40
commit
3c79b74f9c
@ -20,73 +20,9 @@ describe("ApplePaySession", () => {
|
||||
break;
|
||||
}
|
||||
});
|
||||
it("the contact fields are defined", () => {
|
||||
const contactFields = [
|
||||
ApplePayJS.ApplePayContactField.email,
|
||||
ApplePayJS.ApplePayContactField.name,
|
||||
ApplePayJS.ApplePayContactField.phone,
|
||||
ApplePayJS.ApplePayContactField.phoneticName,
|
||||
ApplePayJS.ApplePayContactField.postalAddress
|
||||
];
|
||||
});
|
||||
it("the error codes are defined", () => {
|
||||
const errorCodes = [
|
||||
ApplePayJS.ApplePayErrorCode.addressUnserviceable,
|
||||
ApplePayJS.ApplePayErrorCode.billingContactInvalid,
|
||||
ApplePayJS.ApplePayErrorCode.shippingContactInvalid,
|
||||
ApplePayJS.ApplePayErrorCode.unknown
|
||||
];
|
||||
});
|
||||
it("the error contact fields are defined", () => {
|
||||
const errorContacts = [
|
||||
ApplePayJS.ApplePayErrorContactField.addressLines,
|
||||
ApplePayJS.ApplePayErrorContactField.administrativeArea,
|
||||
ApplePayJS.ApplePayErrorContactField.country,
|
||||
ApplePayJS.ApplePayErrorContactField.countryCode,
|
||||
ApplePayJS.ApplePayErrorContactField.emailAddress,
|
||||
ApplePayJS.ApplePayErrorContactField.locality,
|
||||
ApplePayJS.ApplePayErrorContactField.name,
|
||||
ApplePayJS.ApplePayErrorContactField.phoneNumber,
|
||||
ApplePayJS.ApplePayErrorContactField.phoneticName,
|
||||
ApplePayJS.ApplePayErrorContactField.postalAddress,
|
||||
ApplePayJS.ApplePayErrorContactField.postalCode,
|
||||
ApplePayJS.ApplePayErrorContactField.subAdministrativeArea,
|
||||
ApplePayJS.ApplePayErrorContactField.subLocality
|
||||
];
|
||||
});
|
||||
it("the line item types are defined", () => {
|
||||
const lineItemTypes = [
|
||||
ApplePayJS.ApplePayLineItemType.final,
|
||||
ApplePayJS.ApplePayLineItemType.pending
|
||||
];
|
||||
});
|
||||
it("the merchant capabilities are defined", () => {
|
||||
const capabilities = [
|
||||
ApplePayJS.ApplePayMerchantCapability.supports3DS,
|
||||
ApplePayJS.ApplePayMerchantCapability.supportsCredit,
|
||||
ApplePayJS.ApplePayMerchantCapability.supportsDebit,
|
||||
ApplePayJS.ApplePayMerchantCapability.supportsEMV
|
||||
];
|
||||
});
|
||||
it("the payment method types are defined", () => {
|
||||
const paymentMethods = [
|
||||
ApplePayJS.ApplePayPaymentMethodType.credit,
|
||||
ApplePayJS.ApplePayPaymentMethodType.debit,
|
||||
ApplePayJS.ApplePayPaymentMethodType.prepaid,
|
||||
ApplePayJS.ApplePayPaymentMethodType.store
|
||||
];
|
||||
});
|
||||
it("the shipping types are defined", () => {
|
||||
const shippingTypes = [
|
||||
ApplePayJS.ApplePayShippingType.delivery,
|
||||
ApplePayJS.ApplePayShippingType.servicePickup,
|
||||
ApplePayJS.ApplePayShippingType.shipping,
|
||||
ApplePayJS.ApplePayShippingType.storePickup
|
||||
];
|
||||
});
|
||||
it("can create a new instance", () => {
|
||||
const version = 1;
|
||||
const paymentRequest = {
|
||||
const paymentRequest: ApplePayJS.ApplePayPaymentRequest = {
|
||||
countryCode: "US",
|
||||
currencyCode: "USD",
|
||||
supportedNetworks: [
|
||||
@ -122,7 +58,7 @@ describe("ApplePaySession", () => {
|
||||
});
|
||||
it("can call instance methods", () => {
|
||||
const version = 3;
|
||||
const paymentRequest = {
|
||||
const paymentRequest: ApplePayJS.ApplePayPaymentRequest = {
|
||||
countryCode: "US",
|
||||
currencyCode: "USD",
|
||||
supportedNetworks: [
|
||||
@ -131,8 +67,8 @@ describe("ApplePaySession", () => {
|
||||
],
|
||||
merchantCapabilities: [
|
||||
"supports3DS",
|
||||
ApplePayJS.ApplePayMerchantCapability.supportsCredit,
|
||||
ApplePayJS.ApplePayMerchantCapability.supportsDebit
|
||||
"supportsCredit",
|
||||
"supportsDebit"
|
||||
],
|
||||
total: {
|
||||
label: "My Store",
|
||||
@ -149,12 +85,12 @@ describe("ApplePaySession", () => {
|
||||
|
||||
session.completePayment(ApplePaySession.STATUS_SUCCESS);
|
||||
|
||||
const authorizationResult = {
|
||||
const authorizationResult: ApplePayJS.ApplePayPaymentAuthorizationResult = {
|
||||
status: ApplePaySession.STATUS_FAILURE,
|
||||
errors: [
|
||||
{
|
||||
code: ApplePayJS.ApplePayErrorCode.addressUnserviceable,
|
||||
contactField: ApplePayJS.ApplePayErrorContactField.postalCode,
|
||||
code: "addressUnserviceable",
|
||||
contactField: "postalCode",
|
||||
message: "The specified postal code cannot be delivered to."
|
||||
}
|
||||
]
|
||||
@ -162,13 +98,13 @@ describe("ApplePaySession", () => {
|
||||
|
||||
session.completePayment(authorizationResult);
|
||||
|
||||
const total = {
|
||||
const total: ApplePayJS.ApplePayLineItem = {
|
||||
label: "Subtotal",
|
||||
type: "final",
|
||||
amount: "35.00"
|
||||
};
|
||||
|
||||
const lineItems = [
|
||||
const lineItems: ApplePayJS.ApplePayLineItem[] = [
|
||||
{
|
||||
label: "Subtotal",
|
||||
type: "final",
|
||||
@ -177,12 +113,12 @@ describe("ApplePaySession", () => {
|
||||
{
|
||||
label: "Free Shipping",
|
||||
amount: "0.00",
|
||||
type: ApplePayJS.ApplePayLineItemType.final
|
||||
type: "final"
|
||||
},
|
||||
{
|
||||
label: "Estimated Tax",
|
||||
amount: "3.06",
|
||||
type: ApplePayJS.ApplePayLineItemType.pending
|
||||
type: "pending"
|
||||
}
|
||||
];
|
||||
|
||||
@ -274,7 +210,7 @@ describe("ApplePayPaymentRequest", () => {
|
||||
merchantCapabilities: [
|
||||
"supports3DS",
|
||||
"supportsCredit",
|
||||
ApplePayJS.ApplePayMerchantCapability.supportsDebit
|
||||
"supportsDebit"
|
||||
],
|
||||
supportedNetworks: [
|
||||
"amex",
|
||||
@ -296,8 +232,6 @@ describe("ApplePayPaymentRequest", () => {
|
||||
familyName: "Patel",
|
||||
givenName: "Ravi",
|
||||
phoneNumber: "(408) 555-5555",
|
||||
phoneticFamilyName: "Patel",
|
||||
phoneticGivenName: "Ravi",
|
||||
addressLines: [
|
||||
"1 Infinite Loop"
|
||||
],
|
||||
@ -329,14 +263,14 @@ describe("ApplePayPaymentRequest", () => {
|
||||
|
||||
paymentRequest.requiredBillingContactFields = [
|
||||
"postalAddress",
|
||||
ApplePayJS.ApplePayContactField.name
|
||||
"name"
|
||||
];
|
||||
|
||||
paymentRequest.requiredShippingContactFields = [
|
||||
"postalAddress",
|
||||
"name",
|
||||
"phone",
|
||||
ApplePayJS.ApplePayContactField.name
|
||||
"name"
|
||||
];
|
||||
|
||||
paymentRequest.shippingContact = {
|
||||
@ -372,6 +306,6 @@ describe("ApplePayPaymentRequest", () => {
|
||||
];
|
||||
|
||||
paymentRequest.shippingType = "storePickup";
|
||||
paymentRequest.shippingType = ApplePayJS.ApplePayShippingType.delivery;
|
||||
paymentRequest.shippingType = "delivery";
|
||||
});
|
||||
});
|
||||
|
||||
151
types/applepayjs/index.d.ts
vendored
151
types/applepayjs/index.d.ts
vendored
@ -191,13 +191,12 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* Field names used for requesting contact information in a payment request.
|
||||
*/
|
||||
enum ApplePayContactField {
|
||||
email = 'email',
|
||||
name = 'name',
|
||||
phone = 'phone',
|
||||
postalAddress = 'postalAddress',
|
||||
phoneticName = 'phoneticName',
|
||||
}
|
||||
type ApplePayContactField =
|
||||
'email' |
|
||||
'name' |
|
||||
'phone' |
|
||||
'postalAddress' |
|
||||
'phoneticName';
|
||||
|
||||
/**
|
||||
* A customizable error type that you create to indicate problems with the address or contact information on an Apple Pay sheet.
|
||||
@ -222,43 +221,44 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* The error code that indicates whether an error on the payment sheet is for shipping or billing information, or for another kind of error.
|
||||
*/
|
||||
enum ApplePayErrorCode {
|
||||
type ApplePayErrorCode =
|
||||
/**
|
||||
* Shipping address or contact information is invalid or missing.
|
||||
*/
|
||||
shippingContactInvalid = 'shippingContactInvalid',
|
||||
'shippingContactInvalid' |
|
||||
|
||||
/**
|
||||
* Billing address information is invalid or missing.
|
||||
*/
|
||||
billingContactInvalid = 'billingContactInvalid',
|
||||
'billingContactInvalid' |
|
||||
|
||||
/**
|
||||
* The merchant cannot provide service to the shipping address (for example, can't deliver to a P.O. Box).
|
||||
*/
|
||||
addressUnserviceable = 'addressUnserviceable',
|
||||
'addressUnserviceable' |
|
||||
|
||||
/**
|
||||
* An unknown but nonfatal error occurred during payment processing. The user can attempt authorization again.
|
||||
*/
|
||||
unknown = 'unknown',
|
||||
}
|
||||
'unknown';
|
||||
|
||||
/**
|
||||
* Names of the fields in the shipping or billing contact information, used to locate errors in the payment sheet.
|
||||
*/
|
||||
enum ApplePayErrorContactField {
|
||||
phoneNumber = 'phoneNumber',
|
||||
emailAddress = 'emailAddress',
|
||||
name = 'name',
|
||||
phoneticName = 'phoneticName',
|
||||
postalAddress = 'postalAddress',
|
||||
addressLines = 'addressLines',
|
||||
locality = 'locality',
|
||||
subLocality = 'subLocality',
|
||||
postalCode = 'postalCode',
|
||||
administrativeArea = 'administrativeArea',
|
||||
subAdministrativeArea = 'subAdministrativeArea',
|
||||
country = 'country',
|
||||
countryCode = 'countryCode',
|
||||
}
|
||||
type ApplePayErrorContactField =
|
||||
'phoneNumber' |
|
||||
'emailAddress' |
|
||||
'name' |
|
||||
'phoneticName' |
|
||||
'postalAddress' |
|
||||
'addressLines' |
|
||||
'locality' |
|
||||
'subLocality' |
|
||||
'postalCode' |
|
||||
'administrativeArea' |
|
||||
'subAdministrativeArea' |
|
||||
'country' |
|
||||
'countryCode';
|
||||
|
||||
/**
|
||||
* Defines a line item in a payment request - for example, total, tax, discount, or grand total.
|
||||
@ -277,48 +277,46 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* A value that indicates if the line item is final or pending.
|
||||
*/
|
||||
type?: string | ApplePayLineItemType;
|
||||
type?: ApplePayLineItemType;
|
||||
}
|
||||
|
||||
/**
|
||||
* A type that indicates whether a line item is final or pending.
|
||||
*/
|
||||
enum ApplePayLineItemType {
|
||||
type ApplePayLineItemType =
|
||||
/**
|
||||
* A line item representing the known, final cost.
|
||||
*/
|
||||
final = 'final',
|
||||
'final' |
|
||||
|
||||
/**
|
||||
* A line item representing an estimated or unknown cost.
|
||||
*/
|
||||
pending = 'pending',
|
||||
}
|
||||
'pending';
|
||||
|
||||
/**
|
||||
* The payment capabilities supported by the merchant.
|
||||
*/
|
||||
enum ApplePayMerchantCapability {
|
||||
type ApplePayMerchantCapability =
|
||||
/**
|
||||
* Required. This value must be supplied.
|
||||
*/
|
||||
supports3DS = 'supports3DS',
|
||||
'supports3DS' |
|
||||
|
||||
/**
|
||||
* Include this value only if you support China Union Pay transactions.
|
||||
*/
|
||||
supportsEMV = 'supportsEMV',
|
||||
'supportsEMV' |
|
||||
|
||||
/**
|
||||
* Optional. If present, only transactions that are categorized as credit cards are allowed.
|
||||
*/
|
||||
supportsCredit = 'supportsCredit',
|
||||
'supportsCredit' |
|
||||
|
||||
/**
|
||||
* Optional. If present, only transactions that are categorized as debit cards are allowed.
|
||||
*/
|
||||
supportsDebit = 'supportsDebit',
|
||||
}
|
||||
'supportsDebit';
|
||||
|
||||
/**
|
||||
* Represents the result of authorizing a payment request and contains encrypted payment information.
|
||||
@ -372,72 +370,72 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* An email address for the contact.
|
||||
*/
|
||||
emailAddress: string;
|
||||
emailAddress?: string;
|
||||
|
||||
/**
|
||||
* The contact's family name.
|
||||
*/
|
||||
familyName: string;
|
||||
familyName?: string;
|
||||
|
||||
/**
|
||||
* The contact's given name.
|
||||
*/
|
||||
givenName: string;
|
||||
givenName?: string;
|
||||
|
||||
/**
|
||||
* A phone number for the contact.
|
||||
*/
|
||||
phoneNumber: string;
|
||||
phoneNumber?: string;
|
||||
|
||||
/**
|
||||
* The phonetic spelling of the contact's family name.
|
||||
*/
|
||||
phoneticFamilyName: string;
|
||||
phoneticFamilyName?: string;
|
||||
|
||||
/**
|
||||
* The phonetic spelling of the contact's given name.
|
||||
*/
|
||||
phoneticGivenName: string;
|
||||
phoneticGivenName?: string;
|
||||
|
||||
/**
|
||||
* The street portion of the address for the contact.
|
||||
*/
|
||||
addressLines: string[];
|
||||
addressLines?: string[];
|
||||
|
||||
/**
|
||||
* The city for the contact.
|
||||
*/
|
||||
locality: string;
|
||||
locality?: string;
|
||||
|
||||
/**
|
||||
* Additional information associated with the location, typically defined at the city or town level (such as district or neighborhood), in a postal address.
|
||||
*/
|
||||
subLocality: string;
|
||||
subLocality?: string;
|
||||
|
||||
/**
|
||||
* The state for the contact.
|
||||
*/
|
||||
administrativeArea: string;
|
||||
administrativeArea?: string;
|
||||
|
||||
/**
|
||||
* The subadministrative area (such as a county or other region) in a postal address.
|
||||
*/
|
||||
subAdministrativeArea: string;
|
||||
subAdministrativeArea?: string;
|
||||
|
||||
/**
|
||||
* The zip code or postal code, where applicable, for the contact.
|
||||
*/
|
||||
postalCode: string;
|
||||
postalCode?: string;
|
||||
|
||||
/**
|
||||
* The name of the country for the contact.
|
||||
*/
|
||||
country: string;
|
||||
country?: string;
|
||||
|
||||
/**
|
||||
* The contact’s two-letter ISO 3166 country code.
|
||||
*/
|
||||
countryCode: string;
|
||||
countryCode?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -457,7 +455,7 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* A value representing the card's type of payment.
|
||||
*/
|
||||
type: string | ApplePayPaymentMethodType;
|
||||
type: ApplePayPaymentMethodType;
|
||||
|
||||
/**
|
||||
* The payment pass object currently selected to complete the payment.
|
||||
@ -468,12 +466,11 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* A payment card's type of payment.
|
||||
*/
|
||||
enum ApplePayPaymentMethodType {
|
||||
debit = 'debit',
|
||||
credit = 'credit',
|
||||
prepaid = 'prepaid',
|
||||
store = 'store'
|
||||
}
|
||||
type ApplePayPaymentMethodType =
|
||||
'debit' |
|
||||
'credit' |
|
||||
'prepaid' |
|
||||
'store';
|
||||
|
||||
/**
|
||||
* The ApplePayPaymentMethodSelectedEvent class defines the attributes contained by the ApplePaySession.onpaymentmethodselected callback function.
|
||||
@ -527,38 +524,37 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* The activation state of the pass.
|
||||
*/
|
||||
activationState: string | ApplePayPaymentPassActivationState;
|
||||
activationState: ApplePayPaymentPassActivationState;
|
||||
}
|
||||
|
||||
/**
|
||||
* Payment pass activation states.
|
||||
*/
|
||||
enum ApplePayPaymentPassActivationState {
|
||||
type ApplePayPaymentPassActivationState =
|
||||
/**
|
||||
* Active and ready to be used for payment.
|
||||
*/
|
||||
activated = 'activated',
|
||||
'activated' |
|
||||
|
||||
/**
|
||||
* Not active but may be activated by the issuer.
|
||||
*/
|
||||
requiresActivation = 'requiresActivation',
|
||||
'requiresActivation' |
|
||||
|
||||
/**
|
||||
* Not ready for use but activation is in progress.
|
||||
*/
|
||||
activating = 'activating',
|
||||
'activating' |
|
||||
|
||||
/**
|
||||
* Not active and can't be activated.
|
||||
*/
|
||||
suspended = 'suspended',
|
||||
'suspended' |
|
||||
|
||||
/**
|
||||
* Not active because the issuer has disabled the account associated with the device.
|
||||
*/
|
||||
deactivated = 'deactivated',
|
||||
}
|
||||
'deactivated';
|
||||
|
||||
/**
|
||||
* Encapsulates a request for payment, including information about payment processing capabilities, the payment amount, and shipping information.
|
||||
@ -583,7 +579,7 @@ declare namespace ApplePayJS {
|
||||
* The payment capabilities supported by the merchant.
|
||||
* The value must at least contain ApplePayMerchantCapability.supports3DS.
|
||||
*/
|
||||
merchantCapabilities: string[] | ApplePayMerchantCapability[];
|
||||
merchantCapabilities: ApplePayMerchantCapability[];
|
||||
|
||||
/**
|
||||
* The payment networks supported by the merchant.
|
||||
@ -603,12 +599,12 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* The billing information that you require from the user in order to process the transaction.
|
||||
*/
|
||||
requiredBillingContactFields?: string[] | ApplePayContactField[];
|
||||
requiredBillingContactFields?: ApplePayContactField[];
|
||||
|
||||
/**
|
||||
* The shipping information that you require from the user in order to fulfill the order.
|
||||
*/
|
||||
requiredShippingContactFields?: string[] | ApplePayContactField[];
|
||||
requiredShippingContactFields?: ApplePayContactField[];
|
||||
|
||||
/**
|
||||
* Shipping contact information for the user.
|
||||
@ -623,7 +619,7 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* How the items are to be shipped.
|
||||
*/
|
||||
shippingType?: string | ApplePayShippingType;
|
||||
shippingType?: ApplePayShippingType;
|
||||
|
||||
/**
|
||||
* A list of ISO 3166 country codes for limiting payments to cards from specific countries.
|
||||
@ -744,12 +740,11 @@ declare namespace ApplePayJS {
|
||||
/**
|
||||
* A type that indicates how purchased items are to be shipped.
|
||||
*/
|
||||
enum ApplePayShippingType {
|
||||
shipping = 'shipping',
|
||||
delivery = 'delivery',
|
||||
storePickup = 'storePickup',
|
||||
servicePickup = 'servicePickup',
|
||||
}
|
||||
type ApplePayShippingType =
|
||||
'shipping' |
|
||||
'delivery' |
|
||||
'storePickup' |
|
||||
'servicePickup';
|
||||
|
||||
/**
|
||||
* The attributes contained by the onvalidatemerchant callback function.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user