@delopay/sdk 0.74.0 → 0.75.0

package/dist/index.d.cts

@@ -5724,6 +5724,20 @@ interface CustomFieldOption {
     label: string;
     labelTranslations: CustomFieldTranslations;
 }
+type CustomFieldConditionSource = 'metadata' | 'currency' | 'amount';
+type CustomFieldOperator = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'in' | 'not_in' | 'exists' | 'not_exists' | 'gt' | 'gte' | 'lt' | 'lte';
+interface CustomFieldCondition {
+    id: string;
+    source: CustomFieldConditionSource;
+    key: string;
+    operator: CustomFieldOperator;
+    value: string;
+}
+interface CustomFieldVisibility {
+    mode: 'always' | 'match';
+    match: 'all' | 'any';
+    conditions: CustomFieldCondition[];
+}
 interface CheckoutCustomField {
     id: string;
     key: string;
@@ -5740,6 +5754,7 @@ interface CheckoutCustomField {
     maxLength: number | null;
     defaultValue: string;
     options: CustomFieldOption[];
+    visibility: CustomFieldVisibility;
 }
 interface CheckoutBranding {
     displayName: string;
@@ -5834,9 +5849,44 @@ declare function encodeBadges(badges: TrustBadge[]): string;
 declare const CUSTOM_FIELDS_MAX = 20;
 declare const CUSTOM_FIELD_KEY_PATTERN: RegExp;
 declare const ALL_CUSTOM_FIELD_TYPES: readonly CustomFieldType[];
+declare const CUSTOM_FIELD_CONDITIONS_MAX = 10;
+declare const ALL_CUSTOM_FIELD_CONDITION_SOURCES: readonly CustomFieldConditionSource[];
+declare const ALL_CUSTOM_FIELD_OPERATORS: readonly CustomFieldOperator[];
+declare const CUSTOM_FIELD_OPERATORS_BY_SOURCE: Record<CustomFieldConditionSource, readonly CustomFieldOperator[]>;
+declare const CUSTOM_FIELD_VALUELESS_OPERATORS: readonly CustomFieldOperator[];
+declare function customFieldOperatorTakesValue(operator: CustomFieldOperator): boolean;
+declare function defaultOperatorForSource(source: CustomFieldConditionSource): CustomFieldOperator;
+declare function defaultCustomFieldVisibility(): CustomFieldVisibility;
 declare function parseCustomFieldsLoose(raw: unknown): CheckoutCustomField[] | null;
 declare function decodeCustomFields(raw: string | undefined): CheckoutCustomField[] | null;
 declare function encodeCustomFields(fields: CheckoutCustomField[]): string;
+/** Facts a rule can read. `amount` is in the currency's minor unit (what
+ *  the payment intent stores); `metadata` values are already flattened to
+ *  strings by `customFieldContextFromMetadata`. */
+interface CustomFieldContext {
+    amount: number;
+    currency: string;
+    metadata: Record<string, string>;
+}
+/** Flatten a payment's raw `metadata` object into the string map a rule
+ *  compares against. Arrays join on `,` so a list-shaped value stays usable
+ *  with `contains` / `in`; objects fall back to JSON. Mirrors the Rust
+ *  side's `flatten_metadata`. */
+declare function customFieldContextFromMetadata(raw: unknown): Record<string, string>;
+declare function evaluateCustomFieldCondition(condition: CustomFieldCondition, ctx: CustomFieldContext): boolean;
+/**
+ * Whether a field's rule matches the payment.
+ *
+ * Fail-open in two spots, deliberately: `mode: 'always'` and a `match` rule
+ * with no conditions both resolve to visible. A half-authored rule should
+ * never silently swallow a field the merchant needs collected — the
+ * control-center flags the empty rule as a validation issue instead.
+ */
+declare function evaluateCustomFieldVisibility(field: CheckoutCustomField, ctx: CustomFieldContext): boolean;
+/** Filter a field list to what the buyer should see for this payment.
+ *  Disabled fields are dropped here too — the two reasons a field doesn't
+ *  render are the same to every consumer. */
+declare function visibleCustomFields(fields: CheckoutCustomField[], ctx: CustomFieldContext): CheckoutCustomField[];
 declare function customFieldText(field: CheckoutCustomField, part: 'label' | 'placeholder' | 'helpText', locale?: string): string;
 declare function customFieldOptionLabel(option: CustomFieldOption, locale?: string): string;
 declare function decodeBranding(source: BrandingSource | null | undefined): CheckoutBranding;
@@ -5869,4 +5919,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
 declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
 declare function shadowFor(style: SurfaceStyle): string;
 
-export { ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_KEY_PATTERN, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutCustomField, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, defaultBranding, encodeBadges, encodeBranding, encodeCustomFields, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
+export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutCustomField, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, customFieldContextFromMetadata, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, defaultBranding, defaultCustomFieldVisibility, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };

package/dist/index.d.ts

@@ -5724,6 +5724,20 @@ interface CustomFieldOption {
     label: string;
     labelTranslations: CustomFieldTranslations;
 }
+type CustomFieldConditionSource = 'metadata' | 'currency' | 'amount';
+type CustomFieldOperator = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'in' | 'not_in' | 'exists' | 'not_exists' | 'gt' | 'gte' | 'lt' | 'lte';
+interface CustomFieldCondition {
+    id: string;
+    source: CustomFieldConditionSource;
+    key: string;
+    operator: CustomFieldOperator;
+    value: string;
+}
+interface CustomFieldVisibility {
+    mode: 'always' | 'match';
+    match: 'all' | 'any';
+    conditions: CustomFieldCondition[];
+}
 interface CheckoutCustomField {
     id: string;
     key: string;
@@ -5740,6 +5754,7 @@ interface CheckoutCustomField {
     maxLength: number | null;
     defaultValue: string;
     options: CustomFieldOption[];
+    visibility: CustomFieldVisibility;
 }
 interface CheckoutBranding {
     displayName: string;
@@ -5834,9 +5849,44 @@ declare function encodeBadges(badges: TrustBadge[]): string;
 declare const CUSTOM_FIELDS_MAX = 20;
 declare const CUSTOM_FIELD_KEY_PATTERN: RegExp;
 declare const ALL_CUSTOM_FIELD_TYPES: readonly CustomFieldType[];
+declare const CUSTOM_FIELD_CONDITIONS_MAX = 10;
+declare const ALL_CUSTOM_FIELD_CONDITION_SOURCES: readonly CustomFieldConditionSource[];
+declare const ALL_CUSTOM_FIELD_OPERATORS: readonly CustomFieldOperator[];
+declare const CUSTOM_FIELD_OPERATORS_BY_SOURCE: Record<CustomFieldConditionSource, readonly CustomFieldOperator[]>;
+declare const CUSTOM_FIELD_VALUELESS_OPERATORS: readonly CustomFieldOperator[];
+declare function customFieldOperatorTakesValue(operator: CustomFieldOperator): boolean;
+declare function defaultOperatorForSource(source: CustomFieldConditionSource): CustomFieldOperator;
+declare function defaultCustomFieldVisibility(): CustomFieldVisibility;
 declare function parseCustomFieldsLoose(raw: unknown): CheckoutCustomField[] | null;
 declare function decodeCustomFields(raw: string | undefined): CheckoutCustomField[] | null;
 declare function encodeCustomFields(fields: CheckoutCustomField[]): string;
+/** Facts a rule can read. `amount` is in the currency's minor unit (what
+ *  the payment intent stores); `metadata` values are already flattened to
+ *  strings by `customFieldContextFromMetadata`. */
+interface CustomFieldContext {
+    amount: number;
+    currency: string;
+    metadata: Record<string, string>;
+}
+/** Flatten a payment's raw `metadata` object into the string map a rule
+ *  compares against. Arrays join on `,` so a list-shaped value stays usable
+ *  with `contains` / `in`; objects fall back to JSON. Mirrors the Rust
+ *  side's `flatten_metadata`. */
+declare function customFieldContextFromMetadata(raw: unknown): Record<string, string>;
+declare function evaluateCustomFieldCondition(condition: CustomFieldCondition, ctx: CustomFieldContext): boolean;
+/**
+ * Whether a field's rule matches the payment.
+ *
+ * Fail-open in two spots, deliberately: `mode: 'always'` and a `match` rule
+ * with no conditions both resolve to visible. A half-authored rule should
+ * never silently swallow a field the merchant needs collected — the
+ * control-center flags the empty rule as a validation issue instead.
+ */
+declare function evaluateCustomFieldVisibility(field: CheckoutCustomField, ctx: CustomFieldContext): boolean;
+/** Filter a field list to what the buyer should see for this payment.
+ *  Disabled fields are dropped here too — the two reasons a field doesn't
+ *  render are the same to every consumer. */
+declare function visibleCustomFields(fields: CheckoutCustomField[], ctx: CustomFieldContext): CheckoutCustomField[];
 declare function customFieldText(field: CheckoutCustomField, part: 'label' | 'placeholder' | 'helpText', locale?: string): string;
 declare function customFieldOptionLabel(option: CustomFieldOption, locale?: string): string;
 declare function decodeBranding(source: BrandingSource | null | undefined): CheckoutBranding;
@@ -5869,4 +5919,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
 declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
 declare function shadowFor(style: SurfaceStyle): string;
 
-export { ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_KEY_PATTERN, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutCustomField, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, defaultBranding, encodeBadges, encodeBranding, encodeCustomFields, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
+export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutCustomField, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, type NonPillRadius, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, customFieldContextFromMetadata, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, defaultBranding, defaultCustomFieldVisibility, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, leaf, logoDimensions, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };

package/dist/index.js

@@ -1,4 +1,6 @@
 import {
+  ALL_CUSTOM_FIELD_CONDITION_SOURCES,
+  ALL_CUSTOM_FIELD_OPERATORS,
   ALL_CUSTOM_FIELD_TYPES,
   Analytics,
   AnalyticsDashboard,
@@ -7,7 +9,10 @@ import {
   BRANDING_EXPORT_VERSION,
   CUSTOM_CSS_MAX_LENGTH,
   CUSTOM_FIELDS_MAX,
+  CUSTOM_FIELD_CONDITIONS_MAX,
   CUSTOM_FIELD_KEY_PATTERN,
+  CUSTOM_FIELD_OPERATORS_BY_SOURCE,
+  CUSTOM_FIELD_VALUELESS_OPERATORS,
   Cards,
   DEFAULT_BADGES,
   DEFAULT_BADGES_DARK,
@@ -32,15 +37,21 @@ import {
   buttonPadValue,
   cloneBranding,
   cloneCustomField,
+  customFieldContextFromMetadata,
+  customFieldOperatorTakesValue,
   customFieldOptionLabel,
   customFieldText,
   decodeBadges,
   decodeBranding,
   decodeCustomFields,
   defaultBranding,
+  defaultCustomFieldVisibility,
+  defaultOperatorForSource,
   encodeBadges,
   encodeBranding,
   encodeCustomFields,
+  evaluateCustomFieldCondition,
+  evaluateCustomFieldVisibility,
   feeProgram,
   fontStack,
   fontWeightValue,
@@ -57,9 +68,12 @@ import {
   sanitizeCustomCss,
   shadowFor,
   surfacePadValue,
-  verticalGapValue
-} from "./chunk-5FA2IFIU.js";
+  verticalGapValue,
+  visibleCustomFields
+} from "./chunk-5J763YMV.js";
 export {
+  ALL_CUSTOM_FIELD_CONDITION_SOURCES,
+  ALL_CUSTOM_FIELD_OPERATORS,
   ALL_CUSTOM_FIELD_TYPES,
   Analytics,
   AnalyticsDashboard,
@@ -68,7 +82,10 @@ export {
   BRANDING_EXPORT_VERSION,
   CUSTOM_CSS_MAX_LENGTH,
   CUSTOM_FIELDS_MAX,
+  CUSTOM_FIELD_CONDITIONS_MAX,
   CUSTOM_FIELD_KEY_PATTERN,
+  CUSTOM_FIELD_OPERATORS_BY_SOURCE,
+  CUSTOM_FIELD_VALUELESS_OPERATORS,
   Cards,
   DEFAULT_BADGES,
   DEFAULT_BADGES_DARK,
@@ -93,15 +110,21 @@ export {
   buttonPadValue,
   cloneBranding,
   cloneCustomField,
+  customFieldContextFromMetadata,
+  customFieldOperatorTakesValue,
   customFieldOptionLabel,
   customFieldText,
   decodeBadges,
   decodeBranding,
   decodeCustomFields,
   defaultBranding,
+  defaultCustomFieldVisibility,
+  defaultOperatorForSource,
   encodeBadges,
   encodeBranding,
   encodeCustomFields,
+  evaluateCustomFieldCondition,
+  evaluateCustomFieldVisibility,
   feeProgram,
   fontStack,
   fontWeightValue,
@@ -118,6 +141,7 @@ export {
   sanitizeCustomCss,
   shadowFor,
   surfacePadValue,
-  verticalGapValue
+  verticalGapValue,
+  visibleCustomFields
 };
 //# sourceMappingURL=index.js.map

package/dist/internal.cjs

@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/internal.ts
 var internal_exports = {};
 __export(internal_exports, {
+  ALL_CUSTOM_FIELD_CONDITION_SOURCES: () => ALL_CUSTOM_FIELD_CONDITION_SOURCES,
+  ALL_CUSTOM_FIELD_OPERATORS: () => ALL_CUSTOM_FIELD_OPERATORS,
   ALL_CUSTOM_FIELD_TYPES: () => ALL_CUSTOM_FIELD_TYPES,
   Admin: () => Admin,
   AdminPortal: () => AdminPortal,
@@ -31,7 +33,10 @@ __export(internal_exports, {
   BRANDING_EXPORT_VERSION: () => BRANDING_EXPORT_VERSION,
   CUSTOM_CSS_MAX_LENGTH: () => CUSTOM_CSS_MAX_LENGTH,
   CUSTOM_FIELDS_MAX: () => CUSTOM_FIELDS_MAX,
+  CUSTOM_FIELD_CONDITIONS_MAX: () => CUSTOM_FIELD_CONDITIONS_MAX,
   CUSTOM_FIELD_KEY_PATTERN: () => CUSTOM_FIELD_KEY_PATTERN,
+  CUSTOM_FIELD_OPERATORS_BY_SOURCE: () => CUSTOM_FIELD_OPERATORS_BY_SOURCE,
+  CUSTOM_FIELD_VALUELESS_OPERATORS: () => CUSTOM_FIELD_VALUELESS_OPERATORS,
   Cache: () => Cache,
   CardIssuers: () => CardIssuers,
   Cards: () => Cards,
@@ -65,15 +70,21 @@ __export(internal_exports, {
   buttonPadValue: () => buttonPadValue,
   cloneBranding: () => cloneBranding,
   cloneCustomField: () => cloneCustomField,
+  customFieldContextFromMetadata: () => customFieldContextFromMetadata,
+  customFieldOperatorTakesValue: () => customFieldOperatorTakesValue,
   customFieldOptionLabel: () => customFieldOptionLabel,
   customFieldText: () => customFieldText,
   decodeBadges: () => decodeBadges,
   decodeBranding: () => decodeBranding,
   decodeCustomFields: () => decodeCustomFields,
   defaultBranding: () => defaultBranding,
+  defaultCustomFieldVisibility: () => defaultCustomFieldVisibility,
+  defaultOperatorForSource: () => defaultOperatorForSource,
   encodeBadges: () => encodeBadges,
   encodeBranding: () => encodeBranding,
   encodeCustomFields: () => encodeCustomFields,
+  evaluateCustomFieldCondition: () => evaluateCustomFieldCondition,
+  evaluateCustomFieldVisibility: () => evaluateCustomFieldVisibility,
   feeProgram: () => feeProgram,
   fontStack: () => fontStack,
   fontWeightValue: () => fontWeightValue,
@@ -90,7 +101,8 @@ __export(internal_exports, {
   sanitizeCustomCss: () => sanitizeCustomCss,
   shadowFor: () => shadowFor,
   surfacePadValue: () => surfacePadValue,
-  verticalGapValue: () => verticalGapValue
+  verticalGapValue: () => verticalGapValue,
+  visibleCustomFields: () => visibleCustomFields
 });
 module.exports = __toCommonJS(internal_exports);
 
@@ -4007,7 +4019,11 @@ function cloneCustomField(f) {
     labelTranslations: { ...f.labelTranslations },
     placeholderTranslations: { ...f.placeholderTranslations },
     helpTextTranslations: { ...f.helpTextTranslations },
-    options: f.options.map((o) => ({ ...o, labelTranslations: { ...o.labelTranslations } }))
+    options: f.options.map((o) => ({ ...o, labelTranslations: { ...o.labelTranslations } })),
+    visibility: {
+      ...f.visibility,
+      conditions: f.visibility.conditions.map((c) => ({ ...c }))
+    }
   };
 }
 var CUSTOM_CSS_MAX_LENGTH = 5e4;
@@ -4095,6 +4111,46 @@ var ALL_CUSTOM_FIELD_TYPES = [
   "email",
   "select"
 ];
+var CUSTOM_FIELD_CONDITIONS_MAX = 10;
+var ALL_CUSTOM_FIELD_CONDITION_SOURCES = [
+  "metadata",
+  "currency",
+  "amount"
+];
+var ALL_CUSTOM_FIELD_OPERATORS = [
+  "equals",
+  "not_equals",
+  "contains",
+  "not_contains",
+  "starts_with",
+  "ends_with",
+  "in",
+  "not_in",
+  "exists",
+  "not_exists",
+  "gt",
+  "gte",
+  "lt",
+  "lte"
+];
+var CUSTOM_FIELD_OPERATORS_BY_SOURCE = {
+  metadata: ALL_CUSTOM_FIELD_OPERATORS,
+  currency: ["equals", "not_equals", "in", "not_in"],
+  amount: ["equals", "not_equals", "gt", "gte", "lt", "lte"]
+};
+var CUSTOM_FIELD_VALUELESS_OPERATORS = [
+  "exists",
+  "not_exists"
+];
+function customFieldOperatorTakesValue(operator) {
+  return !CUSTOM_FIELD_VALUELESS_OPERATORS.includes(operator);
+}
+function defaultOperatorForSource(source) {
+  return CUSTOM_FIELD_OPERATORS_BY_SOURCE[source][0] ?? "equals";
+}
+function defaultCustomFieldVisibility() {
+  return { mode: "always", match: "all", conditions: [] };
+}
 function parseTranslations(raw) {
   if (!raw || typeof raw !== "object" || Array.isArray(raw)) return {};
   const out = {};
@@ -4103,6 +4159,41 @@ function parseTranslations(raw) {
   }
   return out;
 }
+function normalizeCondition(raw, index) {
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return null;
+  const c = raw;
+  const source = pickEnum(
+    c["source"],
+    ALL_CUSTOM_FIELD_CONDITION_SOURCES,
+    "metadata"
+  );
+  const allowed = CUSTOM_FIELD_OPERATORS_BY_SOURCE[source];
+  const operator = pickEnum(
+    c["operator"],
+    allowed,
+    defaultOperatorForSource(source)
+  );
+  const rawValue = c["value"];
+  return {
+    id: typeof c["id"] === "string" && c["id"] ? c["id"] : `cond-${index}`,
+    source,
+    // Only metadata conditions carry a key; drop anything else so the
+    // encoded form stays canonical.
+    key: source === "metadata" && typeof c["key"] === "string" ? c["key"].trim() : "",
+    operator,
+    value: typeof rawValue === "string" ? rawValue : typeof rawValue === "number" || typeof rawValue === "boolean" ? String(rawValue) : ""
+  };
+}
+function normalizeVisibility(raw) {
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return defaultCustomFieldVisibility();
+  const v = raw;
+  const conditions = Array.isArray(v["conditions"]) ? v["conditions"].slice(0, CUSTOM_FIELD_CONDITIONS_MAX).map(normalizeCondition).filter((c) => c !== null) : [];
+  return {
+    mode: pickEnum(v["mode"], ["always", "match"], "always"),
+    match: pickEnum(v["match"], ["all", "any"], "all"),
+    conditions
+  };
+}
 function parseBoundedInt(raw) {
   const n = typeof raw === "number" ? raw : typeof raw === "string" ? Number(raw) : NaN;
   if (!Number.isInteger(n) || n < 0) return null;
@@ -4140,7 +4231,8 @@ function normalizeCustomField(raw, index) {
     // Guard inverted bounds at decode so consumers never see min > max.
     maxLength: maxLength !== null && minLength !== null && maxLength < minLength ? null : maxLength,
     defaultValue: typeof f["defaultValue"] === "string" ? f["defaultValue"] : "",
-    options
+    options,
+    visibility: normalizeVisibility(f["visibility"])
   };
 }
 function parseCustomFieldsLoose(raw) {
@@ -4184,10 +4276,118 @@ function encodeCustomFields(fields) {
       ...f.minLength !== null ? { minLength: f.minLength } : {},
       ...f.maxLength !== null ? { maxLength: f.maxLength } : {},
       ...f.defaultValue ? { defaultValue: f.defaultValue } : {},
-      ...f.type === "select" ? { options: f.options } : {}
+      ...f.type === "select" ? { options: f.options } : {},
+      // Omitted for unconditional fields so the stored blob (and every
+      // pre-feature payload) stays byte-identical to what it was.
+      ...f.visibility.mode === "match" ? { visibility: encodeVisibility(f.visibility) } : {}
     }))
   );
 }
+function encodeVisibility(v) {
+  return {
+    mode: v.mode,
+    match: v.match,
+    conditions: v.conditions.map((c) => ({
+      id: c.id,
+      source: c.source,
+      ...c.source === "metadata" && c.key ? { key: c.key } : {},
+      operator: c.operator,
+      ...customFieldOperatorTakesValue(c.operator) && c.value ? { value: c.value } : {}
+    }))
+  };
+}
+function customFieldContextFromMetadata(raw) {
+  const out = {};
+  if (!raw || typeof raw !== "object" || Array.isArray(raw)) return out;
+  for (const [key, value] of Object.entries(raw)) {
+    const flat = flattenMetadataValue(value);
+    if (flat !== null) out[key] = flat;
+  }
+  return out;
+}
+function flattenMetadataValue(value) {
+  if (typeof value === "string") return value;
+  if (typeof value === "number" || typeof value === "boolean") return String(value);
+  if (value === null || value === void 0) return null;
+  if (Array.isArray(value)) {
+    return value.map((v) => flattenMetadataValue(v)).filter((v) => v !== null).join(",");
+  }
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return null;
+  }
+}
+function norm(value) {
+  return value.trim().toLowerCase();
+}
+var DECIMAL_NUMBER_PATTERN = /^[+-]?(?:\d+\.?\d*|\.\d+)(?:[eE][+-]?\d+)?$/;
+function numeric(value) {
+  const trimmed = value.trim();
+  if (!DECIMAL_NUMBER_PATTERN.test(trimmed)) return null;
+  const n = Number(trimmed);
+  return Number.isFinite(n) ? n : null;
+}
+function splitList(value) {
+  return value.split(",").map((part) => norm(part)).filter((part) => part.length > 0);
+}
+function operandFor(condition, ctx) {
+  switch (condition.source) {
+    case "currency":
+      return ctx.currency;
+    case "amount":
+      return String(ctx.amount);
+    case "metadata":
+      return Object.prototype.hasOwnProperty.call(ctx.metadata, condition.key) ? ctx.metadata[condition.key] : void 0;
+  }
+}
+function evaluateCustomFieldCondition(condition, ctx) {
+  const raw = operandFor(condition, ctx);
+  const actual = raw ?? "";
+  const expected = condition.value;
+  switch (condition.operator) {
+    case "exists":
+      return raw !== void 0 && raw.trim().length > 0;
+    case "not_exists":
+      return raw === void 0 || raw.trim().length === 0;
+    case "equals":
+      return norm(actual) === norm(expected);
+    case "not_equals":
+      return norm(actual) !== norm(expected);
+    case "contains":
+      return norm(actual).includes(norm(expected));
+    case "not_contains":
+      return !norm(actual).includes(norm(expected));
+    case "starts_with":
+      return norm(actual).startsWith(norm(expected));
+    case "ends_with":
+      return norm(actual).endsWith(norm(expected));
+    case "in":
+      return splitList(expected).includes(norm(actual));
+    case "not_in":
+      return !splitList(expected).includes(norm(actual));
+    case "gt":
+    case "gte":
+    case "lt":
+    case "lte": {
+      const a = numeric(actual);
+      const b = numeric(expected);
+      if (a === null || b === null) return false;
+      if (condition.operator === "gt") return a > b;
+      if (condition.operator === "gte") return a >= b;
+      if (condition.operator === "lt") return a < b;
+      return a <= b;
+    }
+  }
+}
+function evaluateCustomFieldVisibility(field, ctx) {
+  const { mode, match, conditions } = field.visibility;
+  if (mode !== "match" || conditions.length === 0) return true;
+  return match === "any" ? conditions.some((c) => evaluateCustomFieldCondition(c, ctx)) : conditions.every((c) => evaluateCustomFieldCondition(c, ctx));
+}
+function visibleCustomFields(fields, ctx) {
+  return fields.filter((f) => f.enabled && evaluateCustomFieldVisibility(f, ctx));
+}
 function translationFor(map, locale) {
   if (!locale) return null;
   const own = (k) => {
@@ -5128,6 +5328,8 @@ var DelopayInternal = class extends Delopay {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ALL_CUSTOM_FIELD_CONDITION_SOURCES,
+  ALL_CUSTOM_FIELD_OPERATORS,
   ALL_CUSTOM_FIELD_TYPES,
   Admin,
   AdminPortal,
@@ -5139,7 +5341,10 @@ var DelopayInternal = class extends Delopay {
   BRANDING_EXPORT_VERSION,
   CUSTOM_CSS_MAX_LENGTH,
   CUSTOM_FIELDS_MAX,
+  CUSTOM_FIELD_CONDITIONS_MAX,
   CUSTOM_FIELD_KEY_PATTERN,
+  CUSTOM_FIELD_OPERATORS_BY_SOURCE,
+  CUSTOM_FIELD_VALUELESS_OPERATORS,
   Cache,
   CardIssuers,
   Cards,
@@ -5173,15 +5378,21 @@ var DelopayInternal = class extends Delopay {
   buttonPadValue,
   cloneBranding,
   cloneCustomField,
+  customFieldContextFromMetadata,
+  customFieldOperatorTakesValue,
   customFieldOptionLabel,
   customFieldText,
   decodeBadges,
   decodeBranding,
   decodeCustomFields,
   defaultBranding,
+  defaultCustomFieldVisibility,
+  defaultOperatorForSource,
   encodeBadges,
   encodeBranding,
   encodeCustomFields,
+  evaluateCustomFieldCondition,
+  evaluateCustomFieldVisibility,
   feeProgram,
   fontStack,
   fontWeightValue,
@@ -5198,6 +5409,7 @@ var DelopayInternal = class extends Delopay {
   sanitizeCustomCss,
   shadowFor,
   surfacePadValue,
-  verticalGapValue
+  verticalGapValue,
+  visibleCustomFields
 });
 //# sourceMappingURL=internal.cjs.map