@yuno-payments/sdk-web-types 1.23.0 → 2.0.0

package/README.md

@@ -1,11 +1,38 @@
-## Include Type in tsconfig.js
-```bash
-  "types": ["@yuno-payments/sdk-web-types"]
+ Using Yuno SDK Types
+
+This package provides TypeScript types for integrating the Yuno SDK into your application. You can use the types in two ways: **importing them explicitly** or **using them globally**.
+
+## 1. Including Types in `tsconfig.json`
+
+To make the types available globally across your project, include them in your `tsconfig.json` file:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@yuno-payments/sdk-web-types/dist/global"]
+  }
+}
 ```
 
-## how to use types in your code
+## 2. How to Use Types in Your Code
+
+### a) **Importing Specific Types**
+
+If you prefer to import specific types explicitly, you can do so like this:
+
 ```typescript
-    import { YunoInstance } from '@yuno-payments/sdk-web-types/dist/types'
+import { YunoInstance } from '@yuno-payments/sdk-web-types'
 
-    const yunoInstance: YunoInstance = Yuno.initialize('publickAPikey')
+const yunoInstance: YunoInstance = Yuno.initialize('publicApiKey')
 ```
+
+## 3. What Does the `tsconfig.json` Configuration Do?
+
+By including `"types": ["@yuno-payments/sdk-web-types/dist/global"]` in your `tsconfig.json`, **you ensure that global types** (like `Yuno`) are available across your project without the need to import them explicitly.
+
+## 🚀 Summary
+
+- To use **explicit types**, import the specific types you need from `@yuno-payments/sdk-web-types`.
+- 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.

package/dist/{types.ts → global.d.ts}

@@ -610,4 +610,4 @@ interface Yuno {
     initialize(publicApiKey: string): 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 };
+declare const Yuno: Yuno;

package/dist/index.d.ts

@@ -610,4 +610,4 @@ interface Yuno {
     initialize(publicApiKey: string): YunoInstance;
 }
 
-declare const Yuno: Yuno;
+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 };

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@yuno-payments/sdk-web-types",
-  "version": "1.23.0",
+  "version": "2.0.0",
   "types": "dist/index.d.ts",
-  "main": "dist/types.ts",
-  "type": "commonjs",
+  "type": "module",
   "publishConfig": {
     "access": "public"
   },
@@ -11,7 +10,7 @@
     "/dist"
   ],
   "scripts": {
-    "build": "rm -rf ./dist && rollup -c --bundleConfigAsCjs && node ./script.js",
+    "build": "rm -rf ./dist && rollup -c && node ./script.js",
     "prepublishOnly": "npm run build",
     "test": "echo \"Error: no test specified\" && exit 0"
   },
@@ -19,8 +18,8 @@
   "license": "ISC",
   "devDependencies": {
     "@types/node": "^20.6.2",
-    "rollup": "^3.29.2",
-    "rollup-plugin-dts": "^6.0.2",
+    "rollup": "^4.34.8",
+    "rollup-plugin-dts": "^6.1.1",
     "typescript": "^5.2.2"
   }
-}
+}