@soltech/fluid-common 1.11.1-sc23267.1 → 1.11.1-sc23267.2

package/lib/payment-methods.d.ts

@@ -48,6 +48,12 @@ export interface PaymentMethod {
     finalTransactionResultCheckEnabled?: boolean;
     encryptionSettings?: EncryptionSettings;
     hostedFields?: HostedFieldsSettings;
+    deviceProtection?: DeviceProtectionSettings;
+}
+/** Its presence is also how the client decides the gateway behind this method profiles at all. */
+export interface DeviceProtectionSettings {
+    merchantId: string;
+    env: string;
 }
 export interface EncryptionSettings {
     encryptionType: EncryptionType;

package/lib/transactions.d.ts

@@ -9,7 +9,11 @@ export interface TransactionParams {
     amount: number;
     paymentMethodId: string;
 }
-export interface CreditcardTransactionParams extends TransactionParams {
+/** Not on `TransactionParams`: `DynamicTransactionParams` adds an index signature this fails. */
+export interface GatewayProtectionParams {
+    protectionHeaders?: Record<string, string>;
+}
+export interface CreditcardTransactionParams extends TransactionParams, GatewayProtectionParams {
     cardHolder?: string;
     cardNumber?: string;
     cvc: string;
@@ -17,7 +21,44 @@ export interface CreditcardTransactionParams extends TransactionParams {
     expiryYear?: string;
     expiryDate?: string;
     cardToken?: string;
-    protectionHeaders?: Record<string, string>;
+}
+export interface ApplePayTransactionParams extends TransactionParams, GatewayProtectionParams {
+    /** The authorised `ApplePayPaymentToken`, serialised, opaque to everything but the gateway. */
+    token: string;
+    billingContact?: ApplePayContact;
+    /** Apple returns the payer's email here, not on the billing contact. */
+    shippingContact?: ApplePayContact;
+}
+/**
+ * What the cashier needs to open the sheet. Every field describes the merchant, not the payer —
+ * `countryCode` included, which is what Apple asks for here.
+ */
+export interface ApplePayParams {
+    countryCode: string;
+    companyName: string;
+    supportedNetworks: string[];
+    /** Apple's `ApplePayMerchantCapability` values; a DOM type neither server can name. */
+    merchantCapabilities: string[];
+    merchantIdentifier?: string;
+    requiresContactDetails: boolean;
+}
+/**
+ * Apple's own `ApplePayPaymentContact` shape, carried through unchanged: a gateway that wants
+ * it expects the field names Apple uses. Only present when the method asks the sheet for it.
+ */
+export interface ApplePayContact {
+    addressLines?: string[];
+    administrativeArea?: string;
+    country?: string;
+    countryCode?: string;
+    emailAddress?: string;
+    familyName?: string;
+    givenName?: string;
+    locality?: string;
+    phoneNumber?: string;
+    postalCode?: string;
+    subAdministrativeArea?: string;
+    subLocality?: string;
 }
 /** The request that concludes a deposit the payer had to act on away from the cashier, a 3DS challenge being the case that needs it. */
 export interface DepositContinuationParams {
@@ -36,10 +77,8 @@ export interface DepositContinuationParams {
     accountId?: string;
 }
 /**
- * Transaction params for any payment method whose payload is keyed dynamically:
- * - CMS-defined input fields (bank transfer, crypto, e-wallet, voucher).
- * - Native flows like Apple Pay where the gateway-bound `token` is the only
- *   extra key beyond the base TransactionParams.
+ * Transaction params for any payment method whose payload is keyed dynamically by
+ * CMS-defined input fields (bank transfer, crypto, e-wallet, voucher).
  * Field keys typically come from `PaymentMethod.inputFields[].paramName`.
  */
 export interface DynamicTransactionParams extends TransactionParams {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@soltech/fluid-common",
-	"version": "1.11.1-sc23267.1",
+	"version": "1.11.1-sc23267.2",
 	"type": "module",
 	"description": "Fluid frontend, API and AI common interfaces & enums",
 	"main": "lib/index.js",

package/src/payment-methods.ts

@@ -54,6 +54,13 @@ export interface PaymentMethod {
 	finalTransactionResultCheckEnabled?: boolean;
 	encryptionSettings?: EncryptionSettings;
 	hostedFields?: HostedFieldsSettings;
+	deviceProtection?: DeviceProtectionSettings;
+}
+
+/** Its presence is also how the client decides the gateway behind this method profiles at all. */
+export interface DeviceProtectionSettings {
+	merchantId: string;
+	env: string;
 }
 
 export interface EncryptionSettings {

package/src/transactions.ts

@@ -12,7 +12,12 @@ export interface TransactionParams {
 	paymentMethodId: string;
 }
 
-export interface CreditcardTransactionParams extends TransactionParams {
+/** Not on `TransactionParams`: `DynamicTransactionParams` adds an index signature this fails. */
+export interface GatewayProtectionParams {
+	protectionHeaders?: Record<string, string>;
+}
+
+export interface CreditcardTransactionParams extends TransactionParams, GatewayProtectionParams {
 	cardHolder?: string;
 	cardNumber?: string;
 	cvc: string;
@@ -20,7 +25,47 @@ export interface CreditcardTransactionParams extends TransactionParams {
 	expiryYear?: string;
 	expiryDate?: string;
 	cardToken?: string;
-	protectionHeaders?: Record<string, string>;
+}
+
+export interface ApplePayTransactionParams extends TransactionParams, GatewayProtectionParams {
+	/** The authorised `ApplePayPaymentToken`, serialised, opaque to everything but the gateway. */
+	token: string;
+	billingContact?: ApplePayContact;
+	/** Apple returns the payer's email here, not on the billing contact. */
+	shippingContact?: ApplePayContact;
+}
+
+/**
+ * What the cashier needs to open the sheet. Every field describes the merchant, not the payer —
+ * `countryCode` included, which is what Apple asks for here.
+ */
+export interface ApplePayParams {
+	countryCode: string;
+	companyName: string;
+	supportedNetworks: string[];
+	/** Apple's `ApplePayMerchantCapability` values; a DOM type neither server can name. */
+	merchantCapabilities: string[];
+	merchantIdentifier?: string;
+	requiresContactDetails: boolean;
+}
+
+/**
+ * Apple's own `ApplePayPaymentContact` shape, carried through unchanged: a gateway that wants
+ * it expects the field names Apple uses. Only present when the method asks the sheet for it.
+ */
+export interface ApplePayContact {
+	addressLines?: string[];
+	administrativeArea?: string;
+	country?: string;
+	countryCode?: string;
+	emailAddress?: string;
+	familyName?: string;
+	givenName?: string;
+	locality?: string;
+	phoneNumber?: string;
+	postalCode?: string;
+	subAdministrativeArea?: string;
+	subLocality?: string;
 }
 
 /** The request that concludes a deposit the payer had to act on away from the cashier, a 3DS challenge being the case that needs it. */
@@ -41,10 +86,8 @@ export interface DepositContinuationParams {
 }
 
 /**
- * Transaction params for any payment method whose payload is keyed dynamically:
- * - CMS-defined input fields (bank transfer, crypto, e-wallet, voucher).
- * - Native flows like Apple Pay where the gateway-bound `token` is the only
- *   extra key beyond the base TransactionParams.
+ * Transaction params for any payment method whose payload is keyed dynamically by
+ * CMS-defined input fields (bank transfer, crypto, e-wallet, voucher).
  * Field keys typically come from `PaymentMethod.inputFields[].paramName`.
  */
 export interface DynamicTransactionParams extends TransactionParams {