straumur-web-component 2.0.0-alpha.2 → 2.0.0-alpha.20

package/dist/index.d.cts

@@ -79,6 +79,17 @@ type TranslationKey = keyof (typeof translations)["en-US"] | keyof (typeof trans
 type PublicLocale = "is" | "en";
 
 type PaymentMethod = "card" | "storedcard" | "googlepay" | "applepay";
+/**
+ * A slot in the rendered payment-method list: a standalone method, or "instantpayments" for the
+ * express wallet row. Used to order the options via `orderPaymentMethods`.
+ */
+type PaymentMethodOrder = PaymentMethod | "instantpayments";
+/**
+ * Which payment method to open (expand) on load via `openDefaultPaymentMethod`. "firstStoredCard"
+ * opens the first saved card. Ignored (nothing pre-opened, chooser stays collapsed) when the
+ * requested method isn't available (e.g. a wallet that's in `instantPayments`, or no saved cards).
+ */
+type OpenDefaultPaymentMethod = "card" | "firstStoredCard" | "googlepay" | "applepay";
 
 interface ICreatePaymentBody {
     sessionId: string;
@@ -124,12 +135,43 @@ type StraumurWebBaseConfiguration = {
     onCardValidityChanged?: (isValid: boolean, isActive: boolean) => void;
     allowedPaymentMethods?: PaymentMethod[];
     /**
-     * Color theme for the widget. "system" follows the shopper's OS/browser preference
-     * (`prefers-color-scheme`) and updates live if it changes. Defaults to "light".
+     * Top-to-bottom order of the payment-method options. Tokens: "card", "storedcard", "googlepay",
+     * "applepay", and "instantpayments" (the express wallet row). A wallet listed in `instantPayments`
+     * renders only inside the "instantpayments" slot, never standalone, so its standalone token here is
+     * effectively ignored. Any available method you omit is appended in the default order. Defaults to
+     * ["instantpayments", "storedcard", "card", "googlepay", "applepay"].
      */
-    theme?: Theme;
+    orderPaymentMethods?: PaymentMethodOrder[];
+    /**
+     * Which payment method to open (expand) on load: "card", "firstStoredCard", "googlepay" or
+     * "applepay". If that method isn't available — a wallet that's in `instantPayments`, or
+     * "firstStoredCard" with no saved cards — it's ignored and no method is pre-opened (the chooser
+     * stays collapsed). Omit for the same collapsed default.
+     */
+    openDefaultPaymentMethod?: OpenDefaultPaymentMethod;
+    /**
+     * Color theme for the widget. Accepts a mode ("light" | "dark" | "system"), or a
+     * {@link ThemeConfiguration} object to also override the wallet button styling. "system" follows
+     * the shopper's OS/browser preference (`prefers-color-scheme`) and updates live if it changes.
+     * Defaults to "light".
+     */
+    theme?: Theme | ThemeConfiguration;
 };
 type Theme = "light" | "dark" | "system";
+/** Google Pay button style override: "white" = light button, "dark" = black button. */
+type GooglePayButtonTheme = "dark" | "white";
+/** Apple Pay button style override: "light" = white button, "dark" = black button. */
+type ApplePayButtonTheme = "dark" | "light";
+/**
+ * Object form of `theme`: the widget color mode plus optional per-wallet button overrides.
+ * When an override is omitted the wallet button follows the mode — a light widget gets a
+ * light/white button, a dark widget gets a black one.
+ */
+type ThemeConfiguration = {
+    theme: Theme;
+    googlePayButtonTheme?: GooglePayButtonTheme;
+    applePayButtonTheme?: ApplePayButtonTheme;
+};
 type StraumurWebConfiguration = StraumurWebBaseConfiguration & {
     sessionId: string;
 };
@@ -183,7 +225,11 @@ type StraumurCheckoutConfiguration = {
     hideSubmitButton?: boolean;
     onCardValidityChanged?: (isValid: boolean, isActive: boolean) => void;
     allowedPaymentMethods?: PaymentMethod[];
+    orderPaymentMethods?: PaymentMethodOrder[];
+    openDefaultPaymentMethod?: OpenDefaultPaymentMethod;
     theme: Theme;
+    googlePayButtonTheme?: GooglePayButtonTheme;
+    applePayButtonTheme?: ApplePayButtonTheme;
 };
 type StraumurCheckoutUpdateOptions = Partial<Omit<StraumurCheckoutConfiguration, "mode" | "paymentFlow" | "locale">> & {
     locale?: PublicLocale;
@@ -212,4 +258,4 @@ declare class StraumurCheckout {
     submitCard(): boolean;
 }
 
-export { type PaymentCompletedData, type PaymentFailedData, type Placeholders, type ResultCode, StraumurCheckout, type StraumurWebConfiguration };
+export { type ApplePayButtonTheme, type GooglePayButtonTheme, type OpenDefaultPaymentMethod, type PaymentCompletedData, type PaymentFailedData, type PaymentMethod, type PaymentMethodOrder, type Placeholders, type ResultCode, StraumurCheckout, type StraumurWebConfiguration, type Theme, type ThemeConfiguration };

package/dist/index.d.ts

@@ -79,6 +79,17 @@ type TranslationKey = keyof (typeof translations)["en-US"] | keyof (typeof trans
 type PublicLocale = "is" | "en";
 
 type PaymentMethod = "card" | "storedcard" | "googlepay" | "applepay";
+/**
+ * A slot in the rendered payment-method list: a standalone method, or "instantpayments" for the
+ * express wallet row. Used to order the options via `orderPaymentMethods`.
+ */
+type PaymentMethodOrder = PaymentMethod | "instantpayments";
+/**
+ * Which payment method to open (expand) on load via `openDefaultPaymentMethod`. "firstStoredCard"
+ * opens the first saved card. Ignored (nothing pre-opened, chooser stays collapsed) when the
+ * requested method isn't available (e.g. a wallet that's in `instantPayments`, or no saved cards).
+ */
+type OpenDefaultPaymentMethod = "card" | "firstStoredCard" | "googlepay" | "applepay";
 
 interface ICreatePaymentBody {
     sessionId: string;
@@ -124,12 +135,43 @@ type StraumurWebBaseConfiguration = {
     onCardValidityChanged?: (isValid: boolean, isActive: boolean) => void;
     allowedPaymentMethods?: PaymentMethod[];
     /**
-     * Color theme for the widget. "system" follows the shopper's OS/browser preference
-     * (`prefers-color-scheme`) and updates live if it changes. Defaults to "light".
+     * Top-to-bottom order of the payment-method options. Tokens: "card", "storedcard", "googlepay",
+     * "applepay", and "instantpayments" (the express wallet row). A wallet listed in `instantPayments`
+     * renders only inside the "instantpayments" slot, never standalone, so its standalone token here is
+     * effectively ignored. Any available method you omit is appended in the default order. Defaults to
+     * ["instantpayments", "storedcard", "card", "googlepay", "applepay"].
      */
-    theme?: Theme;
+    orderPaymentMethods?: PaymentMethodOrder[];
+    /**
+     * Which payment method to open (expand) on load: "card", "firstStoredCard", "googlepay" or
+     * "applepay". If that method isn't available — a wallet that's in `instantPayments`, or
+     * "firstStoredCard" with no saved cards — it's ignored and no method is pre-opened (the chooser
+     * stays collapsed). Omit for the same collapsed default.
+     */
+    openDefaultPaymentMethod?: OpenDefaultPaymentMethod;
+    /**
+     * Color theme for the widget. Accepts a mode ("light" | "dark" | "system"), or a
+     * {@link ThemeConfiguration} object to also override the wallet button styling. "system" follows
+     * the shopper's OS/browser preference (`prefers-color-scheme`) and updates live if it changes.
+     * Defaults to "light".
+     */
+    theme?: Theme | ThemeConfiguration;
 };
 type Theme = "light" | "dark" | "system";
+/** Google Pay button style override: "white" = light button, "dark" = black button. */
+type GooglePayButtonTheme = "dark" | "white";
+/** Apple Pay button style override: "light" = white button, "dark" = black button. */
+type ApplePayButtonTheme = "dark" | "light";
+/**
+ * Object form of `theme`: the widget color mode plus optional per-wallet button overrides.
+ * When an override is omitted the wallet button follows the mode — a light widget gets a
+ * light/white button, a dark widget gets a black one.
+ */
+type ThemeConfiguration = {
+    theme: Theme;
+    googlePayButtonTheme?: GooglePayButtonTheme;
+    applePayButtonTheme?: ApplePayButtonTheme;
+};
 type StraumurWebConfiguration = StraumurWebBaseConfiguration & {
     sessionId: string;
 };
@@ -183,7 +225,11 @@ type StraumurCheckoutConfiguration = {
     hideSubmitButton?: boolean;
     onCardValidityChanged?: (isValid: boolean, isActive: boolean) => void;
     allowedPaymentMethods?: PaymentMethod[];
+    orderPaymentMethods?: PaymentMethodOrder[];
+    openDefaultPaymentMethod?: OpenDefaultPaymentMethod;
     theme: Theme;
+    googlePayButtonTheme?: GooglePayButtonTheme;
+    applePayButtonTheme?: ApplePayButtonTheme;
 };
 type StraumurCheckoutUpdateOptions = Partial<Omit<StraumurCheckoutConfiguration, "mode" | "paymentFlow" | "locale">> & {
     locale?: PublicLocale;
@@ -212,4 +258,4 @@ declare class StraumurCheckout {
     submitCard(): boolean;
 }
 
-export { type PaymentCompletedData, type PaymentFailedData, type Placeholders, type ResultCode, StraumurCheckout, type StraumurWebConfiguration };
+export { type ApplePayButtonTheme, type GooglePayButtonTheme, type OpenDefaultPaymentMethod, type PaymentCompletedData, type PaymentFailedData, type PaymentMethod, type PaymentMethodOrder, type Placeholders, type ResultCode, StraumurCheckout, type StraumurWebConfiguration, type Theme, type ThemeConfiguration };