@yuno-payments/sdk-web-types 2.0.0-beta.1 → 3.0.0

package/README.md

@@ -36,3 +36,27 @@ By including `"types": ["@yuno-payments/sdk-web-types/dist/global"]` in your `ts
 - To use **`Yuno` globally**, include the configuration in `tsconfig.json` to make `Yuno` available throughout your project without importing it.
 
 With this setup, your Yuno SDK integration will be smooth, and TypeScript's type checking and autocompletion will help you ensure correctness in your code.
+
+## 📝 Version History
+
+### SDK v1.1
+In version 1.1, all methods in the `YunoInstance` interface have been updated to return Promises. This change makes the SDK fully asynchronous and allows for better handling of asynchronous operations. The following methods now return `Promise<void>`:
+
+- `startCheckout`
+- `mountCheckout`
+- `mountCheckoutLite`
+- `mountSeamlessCheckoutLite`
+- `updateCheckoutSession`
+- `submitOneTimeTokenForm`
+- `startPayment`
+- `continuePayment`
+- `notifyError`
+- `mountEnrollmentLite`
+- `showLoader`
+- `hideLoader`
+- `mountFraud`
+- `mountStatusPayment`
+
+Additionally, the `secureFields` method now returns `Promise<SecureFieldInstance>`.
+
+These changes enable better async/await support and more consistent error handling across the SDK.

package/dist/global.d.ts

@@ -180,7 +180,7 @@ type ApiClientPaymentReturn = {
     getThreeDSecureChallenge: GetThreeDSecureChallenge;
     generateHeadlessToken: GenerateHeadlessToken;
 };
-type ApiClientPayment = (args: ApiClientPaymentArgs) => ApiClientPaymentReturn;
+type ApiClientPayment = (args: ApiClientPaymentArgs) => Promise<ApiClientPaymentReturn>;
 
 type ApiClientEnrollArgs = {
     customer_session: string;
@@ -204,7 +204,7 @@ type ContinueEnrollmentReturn = {
 type ApiClientEnrollReturn = {
     continueEnrollment: (args: ContinueEnrollmentArgs) => Promise<ContinueEnrollmentReturn>;
 };
-type ApiClientEnroll = (args: ApiClientEnrollArgs) => ApiClientEnrollReturn;
+type ApiClientEnroll = (args: ApiClientEnrollArgs) => Promise<ApiClientEnrollReturn>;
 
 type Status = 'FAIL' | 'REJECT' | 'SUCCEEDED' | 'PROCESSING' | 'READY';
 type EnrollmentStatus = 'CREATED' | 'EXPIRED' | 'REJECTED' | 'READY_TO_ENROLL' | 'ENROLL_IN_PROCESS' | 'UNENROLL_IN_PROCESS' | 'ENROLLED' | 'DECLINED' | 'CANCELED' | 'ERROR' | 'UNENROLLED';
@@ -478,6 +478,10 @@ interface TextsCustom {
         sendOtpButton?: string;
     };
 }
+type Font = {
+    familyName: string;
+    files: FontFile[];
+};
 interface CardConfig {
     styles?: string;
     type?: 'extends' | 'step';
@@ -486,6 +490,21 @@ interface CardConfig {
     texts?: ButtonTextCard;
     documentEnable?: boolean;
     isCreditCardProcessingOnly?: boolean;
+    /**
+     * This property helps to load fonts into the card form, due to the fact that the fields are rendered as iframes.
+     * With this, you can use the fonts in the styles property.
+     *
+     * @example
+     * ```ts
+     * fonts: [
+     *  {
+     *    familyName: 'Arial',
+     *    files: ['https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;700&display=swap']
+     *  }
+     * ]
+     * ```
+     */
+    fonts?: Font[];
 }
 interface FormElementSelector {
     apmForm?: string;
@@ -587,27 +606,27 @@ interface MountStatusPaymentArgs {
     yunoError?: YunoConfig['yunoError'];
 }
 interface YunoInstance {
-    startCheckout(args: StartCheckoutArgs): void;
-    mountCheckout(args: MountCheckoutArgs): void;
-    mountCheckoutLite(args: MountCheckoutLiteArgs): void;
-    mountSeamlessCheckoutLite(args: MountSeamlessCheckoutLiteArgs): void;
-    updateCheckoutSession(checkout: string): void;
-    submitOneTimeTokenForm(): void;
-    startPayment(): void;
+    startCheckout(args: StartCheckoutArgs): Promise<void>;
+    mountCheckout(args: MountCheckoutArgs): Promise<void>;
+    mountCheckoutLite(args: MountCheckoutLiteArgs): Promise<void>;
+    mountSeamlessCheckoutLite(args: MountSeamlessCheckoutLiteArgs): Promise<void>;
+    updateCheckoutSession(checkout: string): Promise<void>;
+    submitOneTimeTokenForm(): Promise<void>;
+    startPayment(): Promise<void>;
     continuePayment(): Promise<void>;
-    notifyError(): void;
-    mountEnrollmentLite(args: MountEnrollmentLiteArgs): void;
-    showLoader(): void;
-    hideLoader(): void;
-    updateCheckoutSession(checkoutSession: string): void;
-    mountFraud(args: mountFraudArgs): void;
-    mountStatusPayment(args: MountStatusPaymentArgs): void;
-    secureFields(args: SecureFieldsArgs): SecureFieldInstance;
+    notifyError(): Promise<void>;
+    mountEnrollmentLite(args: MountEnrollmentLiteArgs): Promise<void>;
+    showLoader(): Promise<void>;
+    hideLoader(): Promise<void>;
+    updateCheckoutSession(checkoutSession: string): Promise<void>;
+    mountFraud(args: mountFraudArgs): Promise<void>;
+    mountStatusPayment(args: MountStatusPaymentArgs): Promise<void>;
+    secureFields(args: SecureFieldsArgs): Promise<SecureFieldInstance>;
     apiClientPayment: ApiClientPayment;
     apiClientEnroll: ApiClientEnroll;
 }
 interface Yuno {
-    initialize(publicApiKey: string): YunoInstance;
+    initialize(publicApiKey: string): Promise<YunoInstance>;
 }
 
 declare const Yuno: Yuno;

package/dist/index.d.ts

@@ -180,7 +180,7 @@ type ApiClientPaymentReturn = {
     getThreeDSecureChallenge: GetThreeDSecureChallenge;
     generateHeadlessToken: GenerateHeadlessToken;
 };
-type ApiClientPayment = (args: ApiClientPaymentArgs) => ApiClientPaymentReturn;
+type ApiClientPayment = (args: ApiClientPaymentArgs) => Promise<ApiClientPaymentReturn>;
 
 type ApiClientEnrollArgs = {
     customer_session: string;
@@ -204,7 +204,7 @@ type ContinueEnrollmentReturn = {
 type ApiClientEnrollReturn = {
     continueEnrollment: (args: ContinueEnrollmentArgs) => Promise<ContinueEnrollmentReturn>;
 };
-type ApiClientEnroll = (args: ApiClientEnrollArgs) => ApiClientEnrollReturn;
+type ApiClientEnroll = (args: ApiClientEnrollArgs) => Promise<ApiClientEnrollReturn>;
 
 type Status = 'FAIL' | 'REJECT' | 'SUCCEEDED' | 'PROCESSING' | 'READY';
 type EnrollmentStatus = 'CREATED' | 'EXPIRED' | 'REJECTED' | 'READY_TO_ENROLL' | 'ENROLL_IN_PROCESS' | 'UNENROLL_IN_PROCESS' | 'ENROLLED' | 'DECLINED' | 'CANCELED' | 'ERROR' | 'UNENROLLED';
@@ -478,6 +478,10 @@ interface TextsCustom {
         sendOtpButton?: string;
     };
 }
+type Font = {
+    familyName: string;
+    files: FontFile[];
+};
 interface CardConfig {
     styles?: string;
     type?: 'extends' | 'step';
@@ -486,6 +490,21 @@ interface CardConfig {
     texts?: ButtonTextCard;
     documentEnable?: boolean;
     isCreditCardProcessingOnly?: boolean;
+    /**
+     * This property helps to load fonts into the card form, due to the fact that the fields are rendered as iframes.
+     * With this, you can use the fonts in the styles property.
+     *
+     * @example
+     * ```ts
+     * fonts: [
+     *  {
+     *    familyName: 'Arial',
+     *    files: ['https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;700&display=swap']
+     *  }
+     * ]
+     * ```
+     */
+    fonts?: Font[];
 }
 interface FormElementSelector {
     apmForm?: string;
@@ -587,27 +606,27 @@ interface MountStatusPaymentArgs {
     yunoError?: YunoConfig['yunoError'];
 }
 interface YunoInstance {
-    startCheckout(args: StartCheckoutArgs): void;
-    mountCheckout(args: MountCheckoutArgs): void;
-    mountCheckoutLite(args: MountCheckoutLiteArgs): void;
-    mountSeamlessCheckoutLite(args: MountSeamlessCheckoutLiteArgs): void;
-    updateCheckoutSession(checkout: string): void;
-    submitOneTimeTokenForm(): void;
-    startPayment(): void;
+    startCheckout(args: StartCheckoutArgs): Promise<void>;
+    mountCheckout(args: MountCheckoutArgs): Promise<void>;
+    mountCheckoutLite(args: MountCheckoutLiteArgs): Promise<void>;
+    mountSeamlessCheckoutLite(args: MountSeamlessCheckoutLiteArgs): Promise<void>;
+    updateCheckoutSession(checkout: string): Promise<void>;
+    submitOneTimeTokenForm(): Promise<void>;
+    startPayment(): Promise<void>;
     continuePayment(): Promise<void>;
-    notifyError(): void;
-    mountEnrollmentLite(args: MountEnrollmentLiteArgs): void;
-    showLoader(): void;
-    hideLoader(): void;
-    updateCheckoutSession(checkoutSession: string): void;
-    mountFraud(args: mountFraudArgs): void;
-    mountStatusPayment(args: MountStatusPaymentArgs): void;
-    secureFields(args: SecureFieldsArgs): SecureFieldInstance;
+    notifyError(): Promise<void>;
+    mountEnrollmentLite(args: MountEnrollmentLiteArgs): Promise<void>;
+    showLoader(): Promise<void>;
+    hideLoader(): Promise<void>;
+    updateCheckoutSession(checkoutSession: string): Promise<void>;
+    mountFraud(args: mountFraudArgs): Promise<void>;
+    mountStatusPayment(args: MountStatusPaymentArgs): Promise<void>;
+    secureFields(args: SecureFieldsArgs): Promise<SecureFieldInstance>;
     apiClientPayment: ApiClientPayment;
     apiClientEnroll: ApiClientEnroll;
 }
 interface Yuno {
-    initialize(publicApiKey: string): YunoInstance;
+    initialize(publicApiKey: string): Promise<YunoInstance>;
 }
 
-export { type ButtonTextCard, type CardConfig, type CreateArgsSF, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type FormElementSelector, type Language, type LoadingType, type MountCheckoutArgs, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };
+export { type ButtonTextCard, type CardConfig, type CreateArgsSF, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type Font, type FormElementSelector, type Language, type LoadingType, type MountCheckoutArgs, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };

package/package.json

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