@soltech/fluid-common 1.10.0-sc23269.1 → 1.10.0-sc23269.2

package/lib/index.d.ts

@@ -155,6 +155,16 @@ export interface PaymentMethod {
     finalTransactionResultCheckEnabled?: boolean;
     encryptionSettings?: EncryptionSettings;
     hostedFields?: HostedFieldsSettings;
+    deviceProtection?: DeviceProtectionSettings;
+}
+/**
+ * What the gateway's browser SDK needs to start profiling the payer's device. Its presence is
+ * also how the client decides the gateway behind this method profiles at all — it describes the
+ * gateway rather than the method, so every method of that gateway carries the same values.
+ */
+export interface DeviceProtectionSettings {
+    merchantId: string;
+    env: string;
 }
 export interface EncryptionSettings {
     encryptionType: EncryptionType;
@@ -242,7 +252,15 @@ export interface TransactionParams {
     amount: number;
     paymentMethodId: string;
 }
-export interface CreditcardTransactionParams extends TransactionParams {
+/**
+ * What a gateway's own browser SDK profiled the payer's device with, forwarded as request
+ * headers. It cannot live on `TransactionParams` itself: `DynamicTransactionParams` narrows
+ * every property to `string | number | undefined` with an index signature.
+ */
+export interface GatewayProtectionParams {
+    protectionHeaders?: Record<string, string>;
+}
+export interface CreditcardTransactionParams extends TransactionParams, GatewayProtectionParams {
     cardHolder?: string;
     cardNumber?: string;
     cvc: string;
@@ -250,7 +268,6 @@ export interface CreditcardTransactionParams extends TransactionParams {
     expiryYear?: string;
     expiryDate?: string;
     cardToken?: string;
-    protectionHeaders?: Record<string, string>;
 }
 /**
  * Transaction params for any payment method whose payload is keyed dynamically by
@@ -260,7 +277,7 @@ export interface CreditcardTransactionParams extends TransactionParams {
 export interface DynamicTransactionParams extends TransactionParams {
     [key: string]: string | number | undefined;
 }
-export interface ApplePayTransactionParams extends TransactionParams {
+export interface ApplePayTransactionParams extends TransactionParams, GatewayProtectionParams {
     /** The authorised `ApplePayPaymentToken`, serialised, opaque to everything but the gateway. */
     token: string;
     billingContact?: ApplePayContact;

package/package.json

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

package/src/index.ts

@@ -174,6 +174,17 @@ export interface PaymentMethod {
 	finalTransactionResultCheckEnabled?: boolean;
 	encryptionSettings?: EncryptionSettings;
 	hostedFields?: HostedFieldsSettings;
+	deviceProtection?: DeviceProtectionSettings;
+}
+
+/**
+ * What the gateway's browser SDK needs to start profiling the payer's device. Its presence is
+ * also how the client decides the gateway behind this method profiles at all — it describes the
+ * gateway rather than the method, so every method of that gateway carries the same values.
+ */
+export interface DeviceProtectionSettings {
+	merchantId: string;
+	env: string;
 }
 
 export interface EncryptionSettings {
@@ -282,7 +293,16 @@ export interface TransactionParams {
 	paymentMethodId: string;
 }
 
-export interface CreditcardTransactionParams extends TransactionParams {
+/**
+ * What a gateway's own browser SDK profiled the payer's device with, forwarded as request
+ * headers. It cannot live on `TransactionParams` itself: `DynamicTransactionParams` narrows
+ * every property to `string | number | undefined` with an index signature.
+ */
+export interface GatewayProtectionParams {
+	protectionHeaders?: Record<string, string>;
+}
+
+export interface CreditcardTransactionParams extends TransactionParams, GatewayProtectionParams {
 	cardHolder?: string;
 	cardNumber?: string;
 	cvc: string;
@@ -290,7 +310,6 @@ export interface CreditcardTransactionParams extends TransactionParams {
 	expiryYear?: string;
 	expiryDate?: string;
 	cardToken?: string;
-	protectionHeaders?: Record<string, string>;
 }
 
 /**
@@ -302,7 +321,7 @@ export interface DynamicTransactionParams extends TransactionParams {
 	[key: string]: string | number | undefined;
 }
 
-export interface ApplePayTransactionParams extends TransactionParams {
+export interface ApplePayTransactionParams extends TransactionParams, GatewayProtectionParams {
 	/** The authorised `ApplePayPaymentToken`, serialised, opaque to everything but the gateway. */
 	token: string;
 	billingContact?: ApplePayContact;