@odus/checkout 0.6.1 → 0.7.0

package/README.md

@@ -82,6 +82,29 @@ function CheckoutPage() {
 
 > **Important**: Always import the styles using `import '@odus/checkout/styles'` to ensure the checkout UI renders correctly. Without the styles, the checkout component will not display properly.
 
+### TypeScript Support
+
+For TypeScript users, we export type definitions to enhance your development experience with proper type checking and autocompletion:
+
+```typescript
+// Import the main class and TypeScript types
+import { OdusCheckout, CheckoutConfig, CheckoutInstance, Locale } from '@odus/checkout';
+
+// Now you can use these types in your code
+const config: CheckoutConfig = {
+  apiKey: 'your_api_key',
+  profileId: 'your_profile_id',
+  paymentId: 'your_payment_id',
+  checkoutKey: 'your_unique_checkout_key',
+  returnUrl: 'https://your-website.com/payment-complete',
+  environment: 'test',
+  locale: 'en', // Type-safe locale values
+};
+
+// The checkout instance is properly typed
+const checkout: CheckoutInstance = new OdusCheckout(config);
+```
+
 ## Getting Started
 
 ### Basic Implementation
@@ -138,18 +161,18 @@ Make sure you have a container element in your HTML:
 
 When initializing the Odus Checkout, you can configure various options:
 
-| Option                 | Type    | Required | Description                                                                                              |
-| ---------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------- |
-| `apiKey`               | string  | ✅       | Your Odus API key obtained from the dashboard                                                            |
-| `profileId`            | string  | ✅       | Your Odus checkout profile ID                                                                            |
-| `checkoutKey`          | string  | ✅       | Unique checkout key for this payment session                                                             |
-| `paymentId`            | string  | ✅       | The ID of the payment being processed                                                                    |
-| `environment`          | string  | ✅       | API environment to use - either 'test' or 'live'                                                         |
-| `returnUrl`            | string  | ✅       | The URL where the customer will be redirected after 3DS authentication or other redirect flows           |
-| `locale`               | string  |          | Language code for checkout localization (defaults to browser language if supported)                      |
-| `disableErrorMessages` | boolean |          | Set to `true` to disable built-in error messages (defaults to `false`)                                   |
-| `manualActionHandling` | boolean |          | Set to `true` to manually handle 3DS redirects via the `onActionRequired` callback (defaults to `false`) |
-| `callbacks`            | object  |          | Event callback functions (see [Callbacks](#callbacks-and-event-handling))                                |
+| Option                 | Type    | Required | Description                                                                                                                                                                                 |
+| ---------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `apiKey`               | string  | ✅       | Your Odus API key obtained from the dashboard's API Keys page                                                                                                                               |
+| `profileId`            | string  | ✅       | Your Odus checkout profile ID obtained from the dashboard's Checkout Builder page                                                                                                           |
+| `checkoutKey`          | string  | ✅       | Unique checkout key for this payment session                                                                                                                                                |
+| `paymentId`            | string  | ✅       | The ID of the payment being processed                                                                                                                                                       |
+| `environment`          | string  | ✅       | API environment to use - either 'test' or 'live'                                                                                                                                            |
+| `returnUrl`            | string  | ✅       | The URL where the customer will be redirected after 3DS authentication or other redirect flows                                                                                              |
+| `locale`               | Locale  |          | Language code for checkout localization. If not set, automatically defaults to the customer's browser language when supported. If browser language is not supported, falls back to English. |
+| `disableErrorMessages` | boolean |          | Set to `true` to disable built-in error messages (defaults to `false`)                                                                                                                      |
+| `manualActionHandling` | boolean |          | Set to `true` to manually handle 3DS redirects via the `onActionRequired` callback (defaults to `false`)                                                                                    |
+| `callbacks`            | object  |          | Event callback functions (see [Callbacks](#callbacks-and-event-handling))                                                                                                                   |
 
 ## Payment Methods
 
@@ -307,10 +330,23 @@ type CheckoutConfig = {
     onActionRequired?: (redirectUrl: string) => void;
     onLoadingStateChange?: (isLoading: boolean) => void;
   };
-  locale?: 'en' | 'de' | 'es' | 'fr' | 'pl' | 'pt' | 'it' | 'tr' | null;
+  locale?: Locale;
   disableErrorMessages?: boolean;
   manualActionHandling?: boolean;
 };
+
+// Where Locale is a type representing supported languages
+type Locale = 'en' | 'de' | 'es' | 'fr' | 'pl' | 'pt' | 'it' | 'tr';
+```
+
+### CheckoutInstance Type
+
+```typescript
+// This represents the checkout instance returned when you create a new OdusCheckout
+interface CheckoutInstance {
+  mount(containerId: string): this;
+  unmount(): void;
+}
 ```
 
 ## Troubleshooting

package/dist/checkout.d.ts

@@ -13,7 +13,7 @@ export declare type CheckoutConfig = {
     paymentId: string;
     environment: Environment;
     callbacks?: CheckoutCallbacks;
-    locale?: Locale | null;
+    locale?: Locale;
     disableErrorMessages?: boolean;
     manualActionHandling?: boolean;
 };
@@ -155,7 +155,7 @@ export declare const itLocale: {
     }
 };
 
-declare type Locale = 'en' | 'de' | 'es' | 'fr' | 'pl' | 'pt' | 'it' | 'tr';
+export declare type Locale = 'en' | 'de' | 'es' | 'fr' | 'pl' | 'pt' | 'it' | 'tr';
 
 export declare class OdusCheckout {
     private config;