@yuno-payments/sdk-web-types 5.4.1 → 5.5.0

package/dist/global.d.ts

@@ -473,8 +473,34 @@ type CookieConfig = {
 };
 type CookiesConfig = Record<CookieKey, CookieConfig>;
 type InitializeOptions = {
-    cookies: CookiesConfig | undefined;
+    cookies?: CookiesConfig;
     sdkType?: string;
+    /**
+     * Whitelabel override for every Yuno-hosted runtime URL the SDK reads
+     * from its environment (REST, payment/enrollment WebSockets, 3DS
+     * challenge/setup/event-origin, the SDK web bundle base, the card form,
+     * and the secure-field iframes). Path/query/hash/scheme of each URL are
+     * preserved; only the host (and ws↔wss) is swapped. The merchant-side
+     * gateway must therefore route every Yuno path under this single host.
+     *
+     * If `assetUrl` is unset, this also drives the lazy-chunk public path.
+     *
+     * @example 'https://payments.merchant.example.com'
+     */
+    apiUrl?: string;
+    /**
+     * Override for the lazy-chunk CDN base. When set, the SDK loads its lazy
+     * chunks from `${assetUrl}/v${MAJOR.MINOR}/`. Falls back to `apiUrl` when
+     * unset, so a merchant serving both backend and bundle from the same
+     * origin only needs `apiUrl`.
+     *
+     * The merchant CDN must mirror the `/v<MAJOR.MINOR>/` directory layout and
+     * serve the chunks with permissive CORS. If the value already ends with a
+     * `/v<x.y>` (or `/v<x.y.z>`) segment, it is used as-is.
+     *
+     * @example 'https://cdn.merchant.example.com/sdk'
+     */
+    assetUrl?: string;
 };
 
 type Status = 'FAIL' | 'REJECT' | 'SUCCEEDED' | 'PROCESSING' | 'READY';
@@ -852,7 +878,7 @@ type ExternalProviderId = {
     provider_id: string;
     session_id: string;
 };
-interface YunoConfig {
+interface SdkPaymentsConfig {
     publicApiKey: string;
     checkoutSession: string;
     customerSession: string;
@@ -880,19 +906,29 @@ interface YunoConfig {
     isDynamicViewEnabled?: boolean;
     showOnlyThesePaymentMethods?: string[];
     showPayButton?: boolean;
-    yunoCreatePayment: (oneTimeToken: string, tokenWithInformation: OneTimeToken) => void;
-    yunoPaymentMethodSelected?: (arg: {
+    createPayment?: (oneTimeToken: string, tokenWithInformation: OneTimeToken) => void;
+    /** @deprecated Since SDK v1.9.0. Use `createPayment` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoCreatePayment?: SdkPaymentsConfig["createPayment"];
+    paymentMethodSelected?: (arg: {
         type: string;
         name: string;
     }) => void;
-    yunoPaymentResult?: (status: Status) => void;
-    yunoError?: (message: string, data?: any) => void;
+    /** @deprecated Since SDK v1.9.0. Use `paymentMethodSelected` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoPaymentMethodSelected?: SdkPaymentsConfig["paymentMethodSelected"];
+    paymentResult?: (status: Status, subStatus?: string) => void;
+    /** @deprecated Since SDK v1.9.0. Use `paymentResult` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoPaymentResult?: SdkPaymentsConfig["paymentResult"];
+    error?: (message: string, data?: any) => void;
+    /** @deprecated Since SDK v1.9.0. Use `error` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoError?: SdkPaymentsConfig["error"];
     onRendered?(): void;
     onOneTimeTokenCreationStart?(): void;
-    yunoEnrollmentStatus?(params: {
+    enrollmentStatus?(params: {
         status: EnrollmentStatus;
         vaultedToken?: string;
     }): void;
+    /** @deprecated Since SDK v1.9.0. Use `enrollmentStatus` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoEnrollmentStatus?: SdkPaymentsConfig["enrollmentStatus"];
     /**
      * @deprecated
      */
@@ -908,13 +944,19 @@ interface YunoConfig {
     };
     externalButtons?: ExternalButtonsNameSpace.ExternalButtonsConfig;
 }
-type StartCheckoutArgs = Omit<YunoConfig, "yunoEnrollmentStatus" | "customerSession" | "publicApiKey" | "card"> & {
+/**
+ * @deprecated Since SDK v1.9.0. Use `SdkPaymentsConfig` instead. Kept for
+ * backwards compatibility; will be removed in a future major version.
+ */
+interface YunoConfig extends SdkPaymentsConfig {
+}
+type StartCheckoutArgs = Omit<SdkPaymentsConfig, "enrollmentStatus" | "yunoEnrollmentStatus" | "customerSession" | "publicApiKey" | "card"> & {
     card?: CardConfig & {
         onChange?(args: OnChangeArgs): void;
     };
 };
-type MountEnrollmentLiteArgs = Pick<YunoConfig, "language" | "countryCode" | "renderMode" | "yunoEnrollmentStatus" | "yunoError" | "showLoading" | "onRendered" | "onOneTimeTokenCreationStart" | "onLoading" | "customerSession" | "showPaymentStatus">;
-type mountFraudArgs = Pick<YunoConfig, "yunoCreatePayment" | "yunoError" | "language" | "checkoutSession">;
+type MountEnrollmentLiteArgs = Pick<SdkPaymentsConfig, "language" | "countryCode" | "renderMode" | "enrollmentStatus" | "yunoEnrollmentStatus" | "error" | "yunoError" | "showLoading" | "onRendered" | "onOneTimeTokenCreationStart" | "onLoading" | "customerSession" | "showPaymentStatus">;
+type mountFraudArgs = Pick<SdkPaymentsConfig, "createPayment" | "yunoCreatePayment" | "error" | "yunoError" | "language" | "checkoutSession">;
 interface MountCheckoutLiteArgs {
     paymentMethodType: string;
     vaultedToken?: string;
@@ -937,8 +979,12 @@ interface MountStatusPaymentArgs {
     checkoutSession: string;
     language: Language;
     countryCode: string;
-    yunoPaymentResult?: YunoConfig["yunoPaymentResult"];
-    yunoError?: YunoConfig["yunoError"];
+    paymentResult?: SdkPaymentsConfig["paymentResult"];
+    /** @deprecated Since SDK v1.9.0. Use `paymentResult` instead. */
+    yunoPaymentResult?: SdkPaymentsConfig["paymentResult"];
+    error?: SdkPaymentsConfig["error"];
+    /** @deprecated Since SDK v1.9.0. Use `error` instead. */
+    yunoError?: SdkPaymentsConfig["error"];
 }
 type ContinuePaymentResponse = {
     action: "REDIRECT_URL";
@@ -955,7 +1001,7 @@ type ContinuePaymentArgs = {
      */
     showPaymentStatus?: boolean;
 };
-type StartSeamlessCheckoutArgs = Omit<StartCheckoutArgs, "yunoCreatePayment">;
+type StartSeamlessCheckoutArgs = Omit<StartCheckoutArgs, "createPayment" | "yunoCreatePayment">;
 type ShowLoaderOptions = {
     onRendered?: () => void;
     language?: string;
@@ -966,7 +1012,7 @@ type ExternalButton = {
     checkoutSession?: string;
 };
 type MountSeamlessExternalButtonsArgs = ExternalButton[];
-interface YunoInstance extends ExternalButtonsNameSpace.ExternalButtonMethods {
+interface SdkPaymentsInstance extends ExternalButtonsNameSpace.ExternalButtonMethods {
     startCheckout(args: StartCheckoutArgs): Promise<void>;
     startSeamlessCheckout(args: StartSeamlessCheckoutArgs): Promise<void>;
     mountCheckout(): Promise<void>;
@@ -994,8 +1040,20 @@ interface YunoInstance extends ExternalButtonsNameSpace.ExternalButtonMethods {
     clickToPay: C2PHeadless.ClickToPayFn;
     clearApiCache(): Promise<void>;
 }
-interface Yuno {
-    initialize(publicApiKey: string, applicationSession?: string, options?: InitializeOptions): Promise<YunoInstance>;
+/**
+ * @deprecated Since SDK v1.9.0. Use `SdkPaymentsInstance` instead. Kept for
+ * backwards compatibility; will be removed in a future major version.
+ */
+interface YunoInstance extends SdkPaymentsInstance {
+}
+interface SdkPayments {
+    initialize(publicApiKey: string, applicationSession?: string, options?: InitializeOptions): Promise<SdkPaymentsInstance>;
+}
+/**
+ * @deprecated Since SDK v1.9.0. Use `SdkPayments` instead. Kept for backwards
+ * compatibility with existing integrations (`window.Yuno`); will be removed in a future major version.
+ */
+interface Yuno extends SdkPayments {
 }
 
 declare const Yuno: Yuno;

package/dist/index.d.ts

@@ -473,8 +473,34 @@ type CookieConfig = {
 };
 type CookiesConfig = Record<CookieKey, CookieConfig>;
 type InitializeOptions = {
-    cookies: CookiesConfig | undefined;
+    cookies?: CookiesConfig;
     sdkType?: string;
+    /**
+     * Whitelabel override for every Yuno-hosted runtime URL the SDK reads
+     * from its environment (REST, payment/enrollment WebSockets, 3DS
+     * challenge/setup/event-origin, the SDK web bundle base, the card form,
+     * and the secure-field iframes). Path/query/hash/scheme of each URL are
+     * preserved; only the host (and ws↔wss) is swapped. The merchant-side
+     * gateway must therefore route every Yuno path under this single host.
+     *
+     * If `assetUrl` is unset, this also drives the lazy-chunk public path.
+     *
+     * @example 'https://payments.merchant.example.com'
+     */
+    apiUrl?: string;
+    /**
+     * Override for the lazy-chunk CDN base. When set, the SDK loads its lazy
+     * chunks from `${assetUrl}/v${MAJOR.MINOR}/`. Falls back to `apiUrl` when
+     * unset, so a merchant serving both backend and bundle from the same
+     * origin only needs `apiUrl`.
+     *
+     * The merchant CDN must mirror the `/v<MAJOR.MINOR>/` directory layout and
+     * serve the chunks with permissive CORS. If the value already ends with a
+     * `/v<x.y>` (or `/v<x.y.z>`) segment, it is used as-is.
+     *
+     * @example 'https://cdn.merchant.example.com/sdk'
+     */
+    assetUrl?: string;
 };
 
 type Status = 'FAIL' | 'REJECT' | 'SUCCEEDED' | 'PROCESSING' | 'READY';
@@ -852,7 +878,7 @@ type ExternalProviderId = {
     provider_id: string;
     session_id: string;
 };
-interface YunoConfig {
+interface SdkPaymentsConfig {
     publicApiKey: string;
     checkoutSession: string;
     customerSession: string;
@@ -880,19 +906,29 @@ interface YunoConfig {
     isDynamicViewEnabled?: boolean;
     showOnlyThesePaymentMethods?: string[];
     showPayButton?: boolean;
-    yunoCreatePayment: (oneTimeToken: string, tokenWithInformation: OneTimeToken) => void;
-    yunoPaymentMethodSelected?: (arg: {
+    createPayment?: (oneTimeToken: string, tokenWithInformation: OneTimeToken) => void;
+    /** @deprecated Since SDK v1.9.0. Use `createPayment` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoCreatePayment?: SdkPaymentsConfig["createPayment"];
+    paymentMethodSelected?: (arg: {
         type: string;
         name: string;
     }) => void;
-    yunoPaymentResult?: (status: Status) => void;
-    yunoError?: (message: string, data?: any) => void;
+    /** @deprecated Since SDK v1.9.0. Use `paymentMethodSelected` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoPaymentMethodSelected?: SdkPaymentsConfig["paymentMethodSelected"];
+    paymentResult?: (status: Status, subStatus?: string) => void;
+    /** @deprecated Since SDK v1.9.0. Use `paymentResult` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoPaymentResult?: SdkPaymentsConfig["paymentResult"];
+    error?: (message: string, data?: any) => void;
+    /** @deprecated Since SDK v1.9.0. Use `error` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoError?: SdkPaymentsConfig["error"];
     onRendered?(): void;
     onOneTimeTokenCreationStart?(): void;
-    yunoEnrollmentStatus?(params: {
+    enrollmentStatus?(params: {
         status: EnrollmentStatus;
         vaultedToken?: string;
     }): void;
+    /** @deprecated Since SDK v1.9.0. Use `enrollmentStatus` instead. Kept for backwards compatibility; will be removed in a future major version. */
+    yunoEnrollmentStatus?: SdkPaymentsConfig["enrollmentStatus"];
     /**
      * @deprecated
      */
@@ -908,13 +944,19 @@ interface YunoConfig {
     };
     externalButtons?: ExternalButtonsNameSpace.ExternalButtonsConfig;
 }
-type StartCheckoutArgs = Omit<YunoConfig, "yunoEnrollmentStatus" | "customerSession" | "publicApiKey" | "card"> & {
+/**
+ * @deprecated Since SDK v1.9.0. Use `SdkPaymentsConfig` instead. Kept for
+ * backwards compatibility; will be removed in a future major version.
+ */
+interface YunoConfig extends SdkPaymentsConfig {
+}
+type StartCheckoutArgs = Omit<SdkPaymentsConfig, "enrollmentStatus" | "yunoEnrollmentStatus" | "customerSession" | "publicApiKey" | "card"> & {
     card?: CardConfig & {
         onChange?(args: OnChangeArgs): void;
     };
 };
-type MountEnrollmentLiteArgs = Pick<YunoConfig, "language" | "countryCode" | "renderMode" | "yunoEnrollmentStatus" | "yunoError" | "showLoading" | "onRendered" | "onOneTimeTokenCreationStart" | "onLoading" | "customerSession" | "showPaymentStatus">;
-type mountFraudArgs = Pick<YunoConfig, "yunoCreatePayment" | "yunoError" | "language" | "checkoutSession">;
+type MountEnrollmentLiteArgs = Pick<SdkPaymentsConfig, "language" | "countryCode" | "renderMode" | "enrollmentStatus" | "yunoEnrollmentStatus" | "error" | "yunoError" | "showLoading" | "onRendered" | "onOneTimeTokenCreationStart" | "onLoading" | "customerSession" | "showPaymentStatus">;
+type mountFraudArgs = Pick<SdkPaymentsConfig, "createPayment" | "yunoCreatePayment" | "error" | "yunoError" | "language" | "checkoutSession">;
 interface MountCheckoutLiteArgs {
     paymentMethodType: string;
     vaultedToken?: string;
@@ -937,8 +979,12 @@ interface MountStatusPaymentArgs {
     checkoutSession: string;
     language: Language;
     countryCode: string;
-    yunoPaymentResult?: YunoConfig["yunoPaymentResult"];
-    yunoError?: YunoConfig["yunoError"];
+    paymentResult?: SdkPaymentsConfig["paymentResult"];
+    /** @deprecated Since SDK v1.9.0. Use `paymentResult` instead. */
+    yunoPaymentResult?: SdkPaymentsConfig["paymentResult"];
+    error?: SdkPaymentsConfig["error"];
+    /** @deprecated Since SDK v1.9.0. Use `error` instead. */
+    yunoError?: SdkPaymentsConfig["error"];
 }
 type ContinuePaymentResponse = {
     action: "REDIRECT_URL";
@@ -955,7 +1001,7 @@ type ContinuePaymentArgs = {
      */
     showPaymentStatus?: boolean;
 };
-type StartSeamlessCheckoutArgs = Omit<StartCheckoutArgs, "yunoCreatePayment">;
+type StartSeamlessCheckoutArgs = Omit<StartCheckoutArgs, "createPayment" | "yunoCreatePayment">;
 type ShowLoaderOptions = {
     onRendered?: () => void;
     language?: string;
@@ -966,7 +1012,7 @@ type ExternalButton = {
     checkoutSession?: string;
 };
 type MountSeamlessExternalButtonsArgs = ExternalButton[];
-interface YunoInstance extends ExternalButtonsNameSpace.ExternalButtonMethods {
+interface SdkPaymentsInstance extends ExternalButtonsNameSpace.ExternalButtonMethods {
     startCheckout(args: StartCheckoutArgs): Promise<void>;
     startSeamlessCheckout(args: StartSeamlessCheckoutArgs): Promise<void>;
     mountCheckout(): Promise<void>;
@@ -994,8 +1040,20 @@ interface YunoInstance extends ExternalButtonsNameSpace.ExternalButtonMethods {
     clickToPay: C2PHeadless.ClickToPayFn;
     clearApiCache(): Promise<void>;
 }
-interface Yuno {
-    initialize(publicApiKey: string, applicationSession?: string, options?: InitializeOptions): Promise<YunoInstance>;
+/**
+ * @deprecated Since SDK v1.9.0. Use `SdkPaymentsInstance` instead. Kept for
+ * backwards compatibility; will be removed in a future major version.
+ */
+interface YunoInstance extends SdkPaymentsInstance {
+}
+interface SdkPayments {
+    initialize(publicApiKey: string, applicationSession?: string, options?: InitializeOptions): Promise<SdkPaymentsInstance>;
+}
+/**
+ * @deprecated Since SDK v1.9.0. Use `SdkPayments` instead. Kept for backwards
+ * compatibility with existing integrations (`window.Yuno`); will be removed in a future major version.
+ */
+interface Yuno extends SdkPayments {
 }
 
-export { type ButtonTextCard, C2PHeadless, type CardConfig, type ContinuePaymentArgs, type ContinuePaymentResponse, type CreateArgsSF, type ExternalButton, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type ExternalProviderId, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountSeamlessExternalButtonsArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type StartSeamlessCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };
+export { type ButtonTextCard, C2PHeadless, type CardConfig, type ContinuePaymentArgs, type ContinuePaymentResponse, type CreateArgsSF, type ExternalButton, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type ExternalProviderId, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountSeamlessExternalButtonsArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SdkPayments, type SdkPaymentsConfig, type SdkPaymentsInstance, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type StartSeamlessCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuno-payments/sdk-web-types",
-  "version": "5.4.1",
+  "version": "5.5.0",
   "types": "dist/index.d.ts",
   "type": "module",
   "publishConfig": {