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

package/src/index.ts

@@ -1,7 +1,493 @@
-export * from './wallet.js';
-export * from './wallet-config-keys.js';
-export * from './payment-methods.js';
-export * from './transactions.js';
-export * from './user.js';
-export * from './bonus.js';
-export * from './tracking.js';
+export enum Integration {
+	LEFT = 'LEFT',
+	CENTER = 'CENTER',
+	RIGHT = 'RIGHT',
+	INLINE = 'INLINE'
+}
+
+export enum ContentType {
+	PLAIN_TEXT = 'PLAIN_TEXT',
+	HTML = 'HTML'
+}
+
+export enum TraitType {
+	COLOR = 'COLOR',
+	IMAGE = 'IMAGE',
+	TEXT = 'TEXT',
+	SOUND = 'SOUND'
+}
+
+export enum PaymentType {
+	APPLE_PAY = 'ApplePay',
+	BANK_TRANSFER = 'BankTransfer',
+	CREDIT_CARD = 'CreditCard',
+	CRYPTO = 'Crypto',
+	EWALLET = 'EWallet',
+	VOUCHER = 'Voucher'
+}
+
+export enum WindowRedirectType {
+	POPUP_WINDOW = 'popupWindow',
+	BROWSER_TAB  = 'browserTab',
+	NONE         = 'none'
+}
+
+export interface WalletRequestBody {
+	payload?: object | string;
+	payloadOptions?: TransactionOptions;
+}
+
+export interface WalletInitParams {
+	country: string;
+	ipAddress: string;
+	locale: string;
+	currency: string,
+	operatorId: number;
+	sessionId: string;
+	userId: string | number;
+	/** @deprecated Use browserInfo.userAgent instead */
+	userAgent: string;
+	/** @deprecated Use browserInfo.viewport instead */
+	viewport: Viewport;
+	browserInfo?: BrowserInfo;
+	userData?: UserData;
+	timestamp: string;
+	buildDate: string;
+	hostSiteUrl: string;
+	virtual: boolean;
+}
+
+export interface Viewport {
+	innerWidth: number;
+	innerHeight: number;
+}
+
+export interface ScreenDimensions {
+	height: number;
+	width: number;
+}
+
+export interface BrowserInfo {
+	userAgent: string;
+	acceptHeader: string;
+	javaEnabled: boolean;
+	colorDepth: number;
+	screen: ScreenDimensions;
+	viewport: Viewport;
+	timezoneOffset: number;
+}
+
+export interface WalletConfig {
+	allowCustomAmount: boolean;
+	autofillCreditCardName: boolean;
+	balanceDisplayed: boolean;
+	banner?: Banner;
+	bonusOutlined: boolean;
+	campaign?: Campaign;
+	cardHolderNameRegex: string | null;
+	contactSupportEnabled: boolean;
+	contactSupportLink: string;
+	contentText: Record<string, string>;
+	expressFlowEnabled: boolean;
+	defaultDepositAmount: number;
+	fullListOfDepositMethodsDisplayed: boolean;
+	hideMinMaxEnabled: boolean;
+	integration: Integration;
+	kycDepositLimit: number | null;
+	manualBonusCodesEnabled?: boolean;
+	pendingWithdrawalsReminder: {
+		threshold: number;
+		userResponseRequired: boolean;
+	};
+	successScreen: {
+		promotion: Promotion | null;
+	};
+	suggestedDepositAmounts: number[];
+	theme: Record<string, string>;
+	transactionToggleDisplayed: boolean;
+	withdrawalInFiatCurrency: boolean;
+
+}
+
+export interface Promotion {
+	title: string;
+	description: string;
+	tag: string;
+	ctaLinkLabel: string;
+	ctaLinkUrl: string;
+	thumbnail: string;
+}
+
+export interface WalletConfigParams {
+	contentText: Record<string, ContentType>,
+	theme: Record<string, TraitType>
+}
+
+export interface DepositAmountsSettings {
+	id?: string;
+	defaultDepositAmount: number;
+	suggestedDepositAmounts: number[];
+}
+
+export type TransactionStatusSource = 'gateway' | 'fluid';
+
+export interface TransactionStatusCheck {
+	url: string;
+	intervalSeconds: number;
+	source?: TransactionStatusSource;
+}
+
+export interface AllPaymentMethods {
+	recentPaymentMethods: RecentMethod[];
+	paymentMethods: PaymentMethod[];
+}
+
+export interface AllPaymentMethodsByTransactionType {
+	deposit: AllPaymentMethods,
+	withdrawal: AllPaymentMethods
+}
+
+export interface PaymentMethod {
+	id: string;
+	name: string;
+	paymentGatewayId: string;
+	description: string;
+	termsAndConditions: string;
+	logo: PaymentMethodLogo;
+	logoLight?: PaymentMethodLogo;
+	minAmount: number;
+	maxAmount: number;
+	info: string;
+	paymentType: PaymentType;
+	inputFields?: InputField[];
+	storedMethodInputFields?: InputField[];
+	bonusCodes?: string[];
+	instructions?: string;
+	withdrawalInstructions?: string;
+	fees?: PaymentMethodFees;
+	windowRedirectType?: WindowRedirectType;
+	voucherAmounts?: number[];
+	depositHandledByHostSite?: boolean;
+	withdrawalHandledByHostSite?: boolean;
+	withdrawalInputsShownWhenMethodIsStored: boolean;
+	transactionStatusCheck?: TransactionStatusCheck;
+	finalTransactionResultCheckEnabled?: boolean;
+	encryptionSettings?: EncryptionSettings;
+	hostedFields?: HostedFieldsSettings;
+}
+
+export interface EncryptionSettings {
+	encryptionType: EncryptionType;
+	expiryDateEncryptionMode: ExpiryDateEncryptionMode;
+	encryptCardholderName: boolean;
+}
+
+export type HostedFieldsSettings = CardValuesSettings | CardTokenSettings;
+
+interface HostedFieldsBase {
+	// Its presence is also how the client decides a method uses hosted fields at all.
+	url: string;
+}
+
+export interface CardValuesSettings extends HostedFieldsBase {
+	// Absent selects this protocol, so responses composed before the field existed keep working.
+	protocol?: HostedFieldsProtocol.CARD_VALUES;
+}
+
+export interface CardTokenSettings extends HostedFieldsBase {
+	protocol: HostedFieldsProtocol.CARD_TOKEN;
+	params: CardTokenParams;
+}
+
+export interface CardTokenParams {
+	merchantId: string;
+	env: string;
+}
+
+// Which message contract the client must speak to the hosted fields, not which gateway
+// is behind them — the gateway's identity stays server-side.
+export enum HostedFieldsProtocol {
+	CARD_VALUES = 'CardValues',
+	CARD_TOKEN = 'CardToken'
+}
+
+export enum EncryptionType {
+	NO_ENCRYPTION = 'NO_ENCRYPTION',
+	RSA_PKCS1 = 'RSA_PKCS1', // RSA with PKCS#1 v1.5 padding (jsencrypt default)
+	RSA_OAEP = 'RSA_OAEP',   // RSA with OAEP padding (crypto/Web Crypto)
+	SHA384_SIGNATURE = 'SHA384_SIGNATURE' // SHA-384-based signature (headers)
+}
+
+export enum ExpiryDateEncryptionMode {
+	NONE = 'NONE',
+	SEPARATE_FIELDS = 'SEPARATE_FIELDS',
+	SINGLE_FIELD = 'SINGLE_FIELD'
+}
+
+export type PaymentMethodFees = {
+	fixed?: number;
+	percentage?: number;
+	applyToRange?: {
+		min?: number;
+		max?: number;
+	}
+}[];
+
+export interface PaymentMethodLogo {
+	height: number;
+	url: string;
+	width: number;
+}
+
+export interface InputField {
+	paramName: string;
+	format: string;
+	text: string;
+	placeholderText: string;
+	errorText: string;
+	optional: boolean;
+	options: InputFieldOption[];
+	prefillKey?: string;
+	removePrefixPlusSign?: boolean;
+	relatesTo?: string;
+	showForValues?: string[];
+	isPassword?: boolean;
+}
+
+export interface InputFieldOption {
+	label: string;
+	code: string;
+	relatesTo?: string;
+	showForValues?: string[];
+}
+
+export enum RecentMethodMaskedAccountFormat {
+	DEFAULT = 'Default',
+	LAST_8_DIGITS = 'Last8Digits',
+	FULL_VALUE = 'FullValue',
+	NOTHING = 'Nothing'
+}
+
+export interface RecentMethod extends PaymentMethod {
+	accountId: string;
+	maskedAccount: string;
+	lastSuccess?: string;
+	expiryDate?: string;
+	maskedAccountFormat?: RecentMethodMaskedAccountFormat;
+}
+
+export interface TransactionParams {
+	accountId?: string;
+	amount: number;
+	paymentMethodId: string;
+}
+
+export interface CreditcardTransactionParams extends TransactionParams {
+	cardHolder?: string;
+	cardNumber?: string;
+	cvc: string;
+	expiryMonth?: string;
+	expiryYear?: string;
+	expiryDate?: string;
+	cardToken?: string;
+	protectionHeaders?: Record<string, string>;
+}
+
+/**
+ * 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 {
+	[key: string]: string | number | undefined;
+}
+
+export interface ApplePayTransactionParams extends TransactionParams {
+	/** 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;
+}
+
+/**
+ * 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;
+}
+
+export interface TransactionOptions {
+	bonusCode?: string;
+	activityId?: string;
+	originalActivityId?: string;
+	userData?: UserData;
+	trackingData?: object;
+	transactionAttributes?: Record<string, string>;
+}
+
+export interface TransactionResult {
+	error?: ProviderTransactionError;
+	redirectOutput?: RedirectOutput;
+	state: TransactionState;
+	statusCode: string;
+	transactionId: string;
+	pspStatusCode?: string;
+	details?: Record<string, unknown>;
+}
+
+export interface RedirectOutput {
+	container: RedirectContainer;
+	height?: number;
+	html?: string;
+	method?: HttpVerb;
+	parameters?: Record<string, string>;
+	sizeUnit?: string;
+	url: string;
+	width?: number;
+}
+
+export type RedirectContainer = 'iframe' | 'window' | 'redirect';
+
+export enum TransactionState {
+	SUCCESS = 'SUCCESS',
+	FAIL = 'FAIL',
+	PROCESSING = 'PROCESSING',
+	WAITING_APPROVAL = 'WAITING_APPROVAL',
+	WAITING_INPUT = 'WAITING_INPUT',
+	CANCELLED = 'CANCELLED'
+}
+
+export interface ProviderTransactionError {
+	action: Action;
+	code: string;
+	providerCode: string;
+	text: string;
+	textTitle: string;
+	iconSelection: string;
+}
+
+export enum HttpVerb {
+	DELETE = 'DELETE',
+	GET = 'GET',
+	POST = 'POST',
+	PUT = 'PUT'
+}
+
+export enum Action {
+	RESTART_PRESERVING_DETAILS = 'RESTART_PRESERVING_DETAILS',
+	RESTART_CLEARING_DETAILS = 'RESTART_CLEARING_DETAILS',
+	SHOW_DETAILS_STEP_PRESERVING_DETAILS = 'SHOW_DETAILS_STEP_PRESERVING_DETAILS',
+	SHOW_DETAILS_STEP_CLEARING_DETAILS = 'SHOW_DETAILS_STEP_CLEARING_DETAILS',
+	SHOW_CVC_EDIT = 'SHOW_CVC_EDIT',
+	DISMISS = 'DISMISS'
+}
+
+export interface PendingWithdrawal {
+	amount: string;
+	creationDate: string;
+	state: WithdrawalState;
+	transactionId: string;
+	paymentGatewayId: string;
+}
+
+export enum WithdrawalState {
+	REQUESTED = 'REQUESTED',
+	PROCESSING = 'PROCESSING'
+}
+
+export interface AvailableBonusWithPaymentMethods {
+	code: string;
+	paymentMethodFilter?: {
+		applyTo?: BonusPaymentMethod[];
+		excludeFrom?: BonusPaymentMethod[];
+	}
+}
+
+export interface BonusPaymentMethod {
+	providerType: string;
+	service?: string;
+}
+
+export interface TrackingEvent {
+	eventId: string;
+	data: object;
+}
+
+export enum KycStatus {
+	VERIFIED = 'verified',
+	UNVERIFIED = 'unverified',
+	PROCESSING = 'processing'
+}
+
+export interface UserData {
+	fullName?: string;
+	age?: number;
+	dayOfMonth?: number;
+	dayOfWeek?: string;
+	depositLimit?: number;
+	minimumDeposit?: number;
+	maximumDeposit?: number;
+	previousDeposit?: number;
+	timeOfDay?: string;
+	lifetimeDeposit?: number;
+	depositCount?: number;
+	daysSinceRegistration?: number;
+	kycStatus?: KycStatus;
+	affiliateId?: string;
+	tags?: string[];
+}
+
+export interface TrackingEventData {
+	id: string;
+	event: string;
+	operatorId?: string;
+	timestamp?: string | number | Date;
+	activityId?: string;
+	originalActivityId?: string;
+	bonusesOffered?: boolean;
+	country?: string;
+	sessionId?: string;
+	userAgent?: string;
+	userId?: string;
+
+	[key: string]: unknown;
+}
+
+export type TrackingEventDataEnvelope = {
+	id: string;
+	environment: 'production' | 'staging' | 'demo';
+	body: TrackingEventData;
+};
+
+export interface Banner {
+	title: string;
+	body: string;
+	ctaLabel: string;
+	iconUrl: string;
+}
+
+export interface CampaignChatIcons {
+	amount?: string;
+	bonus?: string;
+	paymentMethod?: string;
+	paymentDetails?: string;
+	securePayment?: string;
+}
+
+export interface Campaign {
+	enableSuccessAnimation: boolean;
+	customChatIcons?: CampaignChatIcons;
+}

package/.claude/settings.local.json

@@ -1,12 +0,0 @@
-{
-  "enabledMcpjsonServers": [
-    "handbook",
-    "webstorm",
-    "shortcut",
-    "chrome-devtools",
-    "mcp-clickhouse",
-    "notion",
-    "datocms",
-    "sentry"
-  ]
-}

package/lib/bonus.d.ts

@@ -1,11 +0,0 @@
-export interface AvailableBonusWithPaymentMethods {
-    code: string;
-    paymentMethodFilter?: {
-        applyTo?: BonusPaymentMethod[];
-        excludeFrom?: BonusPaymentMethod[];
-    };
-}
-export interface BonusPaymentMethod {
-    providerType: string;
-    service?: string;
-}

package/lib/bonus.js

@@ -1 +0,0 @@
-export {};

package/lib/payment-methods.d.ts

@@ -1,114 +0,0 @@
-import type { WindowRedirectType } from './transactions.js';
-export declare enum PaymentType {
-    APPLE_PAY = "ApplePay",
-    BANK_TRANSFER = "BankTransfer",
-    CREDIT_CARD = "CreditCard",
-    CRYPTO = "Crypto",
-    EWALLET = "EWallet",
-    VOUCHER = "Voucher"
-}
-export interface TransactionStatusCheck {
-    url: string;
-    intervalSeconds: number;
-}
-export interface AllPaymentMethods {
-    recentPaymentMethods: RecentMethod[];
-    paymentMethods: PaymentMethod[];
-}
-export interface AllPaymentMethodsByTransactionType {
-    deposit: AllPaymentMethods;
-    withdrawal: AllPaymentMethods;
-}
-export interface PaymentMethod {
-    id: string;
-    name: string;
-    paymentGatewayId: string;
-    description: string;
-    termsAndConditions: string;
-    logo: PaymentMethodLogo;
-    logoLight?: PaymentMethodLogo;
-    minAmount: number;
-    maxAmount: number;
-    info: string;
-    paymentType: PaymentType;
-    inputFields?: InputField[];
-    storedMethodInputFields?: InputField[];
-    bonusCodes?: string[];
-    instructions?: string;
-    withdrawalInstructions?: string;
-    fees?: PaymentMethodFees;
-    windowRedirectType?: WindowRedirectType;
-    voucherAmounts?: number[];
-    depositHandledByHostSite?: boolean;
-    withdrawalHandledByHostSite?: boolean;
-    withdrawalInputsShownWhenMethodIsStored: boolean;
-    transactionStatusCheck?: TransactionStatusCheck;
-    finalTransactionResultCheckEnabled?: boolean;
-    encryptionSettings?: EncryptionSettings;
-    hostedFields?: HostedFieldsSettings;
-}
-export interface EncryptionSettings {
-    encryptionType: EncryptionType;
-    expiryDateEncryptionMode: ExpiryDateEncryptionMode;
-    encryptCardholderName: boolean;
-}
-export interface HostedFieldsSettings {
-    url: string;
-}
-export declare enum EncryptionType {
-    NO_ENCRYPTION = "NO_ENCRYPTION",
-    RSA_PKCS1 = "RSA_PKCS1",// RSA with PKCS#1 v1.5 padding (jsencrypt default)
-    RSA_OAEP = "RSA_OAEP",// RSA with OAEP padding (crypto/Web Crypto)
-    SHA384_SIGNATURE = "SHA384_SIGNATURE"
-}
-export declare enum ExpiryDateEncryptionMode {
-    NONE = "NONE",
-    SEPARATE_FIELDS = "SEPARATE_FIELDS",
-    SINGLE_FIELD = "SINGLE_FIELD"
-}
-export type PaymentMethodFees = {
-    fixed?: number;
-    percentage?: number;
-    applyToRange?: {
-        min?: number;
-        max?: number;
-    };
-}[];
-export interface PaymentMethodLogo {
-    height: number;
-    url: string;
-    width: number;
-}
-export interface InputField {
-    paramName: string;
-    format: string;
-    text: string;
-    placeholderText: string;
-    errorText: string;
-    optional: boolean;
-    options: InputFieldOption[];
-    prefillKey?: string;
-    removePrefixPlusSign?: boolean;
-    relatesTo?: string;
-    showForValues?: string[];
-    isPassword?: boolean;
-}
-export interface InputFieldOption {
-    label: string;
-    code: string;
-    relatesTo?: string;
-    showForValues?: string[];
-}
-export declare enum RecentMethodMaskedAccountFormat {
-    DEFAULT = "Default",
-    LAST_8_DIGITS = "Last8Digits",
-    FULL_VALUE = "FullValue",
-    NOTHING = "Nothing"
-}
-export interface RecentMethod extends PaymentMethod {
-    accountId: string;
-    maskedAccount: string;
-    lastSuccess?: string;
-    expiryDate?: string;
-    maskedAccountFormat?: RecentMethodMaskedAccountFormat;
-}

package/lib/payment-methods.js

@@ -1,29 +0,0 @@
-export var PaymentType;
-(function (PaymentType) {
-    PaymentType["APPLE_PAY"] = "ApplePay";
-    PaymentType["BANK_TRANSFER"] = "BankTransfer";
-    PaymentType["CREDIT_CARD"] = "CreditCard";
-    PaymentType["CRYPTO"] = "Crypto";
-    PaymentType["EWALLET"] = "EWallet";
-    PaymentType["VOUCHER"] = "Voucher";
-})(PaymentType || (PaymentType = {}));
-export var EncryptionType;
-(function (EncryptionType) {
-    EncryptionType["NO_ENCRYPTION"] = "NO_ENCRYPTION";
-    EncryptionType["RSA_PKCS1"] = "RSA_PKCS1";
-    EncryptionType["RSA_OAEP"] = "RSA_OAEP";
-    EncryptionType["SHA384_SIGNATURE"] = "SHA384_SIGNATURE"; // SHA-384-based signature (headers)
-})(EncryptionType || (EncryptionType = {}));
-export var ExpiryDateEncryptionMode;
-(function (ExpiryDateEncryptionMode) {
-    ExpiryDateEncryptionMode["NONE"] = "NONE";
-    ExpiryDateEncryptionMode["SEPARATE_FIELDS"] = "SEPARATE_FIELDS";
-    ExpiryDateEncryptionMode["SINGLE_FIELD"] = "SINGLE_FIELD";
-})(ExpiryDateEncryptionMode || (ExpiryDateEncryptionMode = {}));
-export var RecentMethodMaskedAccountFormat;
-(function (RecentMethodMaskedAccountFormat) {
-    RecentMethodMaskedAccountFormat["DEFAULT"] = "Default";
-    RecentMethodMaskedAccountFormat["LAST_8_DIGITS"] = "Last8Digits";
-    RecentMethodMaskedAccountFormat["FULL_VALUE"] = "FullValue";
-    RecentMethodMaskedAccountFormat["NOTHING"] = "Nothing";
-})(RecentMethodMaskedAccountFormat || (RecentMethodMaskedAccountFormat = {}));

package/lib/tracking.d.ts

@@ -1,23 +0,0 @@
-export interface TrackingEvent {
-    eventId: string;
-    data: object;
-}
-export interface TrackingEventData {
-    id: string;
-    event: string;
-    operatorId?: string;
-    timestamp?: string | number | Date;
-    activityId?: string;
-    originalActivityId?: string;
-    bonusesOffered?: boolean;
-    country?: string;
-    sessionId?: string;
-    userAgent?: string;
-    userId?: string;
-    [key: string]: unknown;
-}
-export type TrackingEventDataEnvelope = {
-    id: string;
-    environment: 'production' | 'staging' | 'demo';
-    body: TrackingEventData;
-};

package/lib/tracking.js

@@ -1 +0,0 @@
-export {};