fix(type): fix paymentSheet result type

Author: rdlabo

README.md

@@ -43,6 +43,7 @@ npx cap sync
 * [`addListener(PaymentSheetEventsEnum.Canceled, ...)`](#addlistenerpaymentsheeteventsenumcanceled-)
 * [`addListener(PaymentSheetEventsEnum.Failed, ...)`](#addlistenerpaymentsheeteventsenumfailed-)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 * [Enums](#enums)
 
 </docgen-index>
@@ -79,10 +80,10 @@ createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>
 ### presentPaymentSheet()
 
 ```typescript
-presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetEventsEnum; }>
+presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResult; }>
 ```
 
-**Returns:** <code>Promise&lt;{ paymentResult: <a href="#paymentsheeteventsenum">PaymentSheetEventsEnum</a>; }&gt;</code>
+**Returns:** <code>Promise&lt;{ paymentResult: <a href="#paymentsheetresult">PaymentSheetResult</a>; }&gt;</code>
 
 --------------------
 
@@ -201,6 +202,14 @@ addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: () => void)
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
 
+### Type Aliases
+
+
+#### PaymentSheetResult
+
+<code><a href="#paymentsheeteventsenum">PaymentSheetEventsEnum.Completed</a> | <a href="#paymentsheeteventsenum">PaymentSheetEventsEnum.Completed</a> | <a href="#paymentsheeteventsenum">PaymentSheetEventsEnum.Failed</a></code>
+
+
 ### Enums
 
 

demo/angular/src/app/tab1/tab1.page.ts

@@ -1,9 +1,9 @@
-import { Component } from '@angular/core';
-import { ViewWillEnter } from '@ionic/angular';
-import { Stripe } from '@capacitor-community/stripe';
-import { environment } from '../../environments/environment';
-import { HttpClient } from '@angular/common/http';
-import { first } from 'rxjs/operators';
+import {Component} from '@angular/core';
+import {ViewWillEnter} from '@ionic/angular';
+import {PaymentSheetEventsEnum, Stripe} from '@capacitor-community/stripe';
+import {environment} from '../../environments/environment';
+import {HttpClient} from '@angular/common/http';
+import {first} from 'rxjs/operators';
 
 @Component({
   selector: 'app-tab1',
@@ -22,6 +22,11 @@ export class Tab1Page implements ViewWillEnter {
       ephemeralKey: string;
       customer: string;
     }>(environment.api + 'payment-sheet', {}).pipe(first()).toPromise(Promise);
+
+    Stripe.addListener(PaymentSheetEventsEnum.Completed, () => {
+      console.log('PaymentSheetEventsEnum.Completed');
+    });
+
     Stripe.createPaymentSheet({
       paymentIntentClientSecret: paymentIntent,
       customerEphemeralKeySecret: ephemeralKey,

src/paymentsheet/payment-sheet-definitions.interface.ts

@@ -2,12 +2,12 @@ import type { PluginListenerHandle } from '@capacitor/core';
 
 import type { CreatePaymentSheetOption } from '../shared';
 
-import type { PaymentSheetEventsEnum } from './payment-sheet-events.enum';
+import type { PaymentSheetEventsEnum, PaymentSheetResult } from './payment-sheet-events.enum';
 
 export interface PaymentSheetDefinitions {
   createPaymentSheet(options: CreatePaymentSheetOption): Promise<void>;
   presentPaymentSheet(): Promise<{
-    paymentResult: PaymentSheetEventsEnum;
+    paymentResult: PaymentSheetResult;
   }>;
 
   addListener(

src/paymentsheet/payment-sheet-events.enum.ts

@@ -5,3 +5,5 @@ export enum PaymentSheetEventsEnum {
   Canceled = "paymentSheetCanceled",
   Failed = "paymentSheetFailed",
 }
+
+export type PaymentSheetResult = PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Failed;

src/web.ts

@@ -6,7 +6,7 @@ import type {
   StripePlugin,
   CreatePaymentSheetOption,
 } from './definitions';
-import { PaymentSheetEventsEnum } from './definitions';
+import { PaymentSheetEventsEnum, PaymentSheetResult } from './definitions';
 
 export class StripeWeb extends WebPlugin implements StripePlugin {
   private publishableKey: string | undefined;
@@ -44,7 +44,7 @@ export class StripeWeb extends WebPlugin implements StripePlugin {
   }
 
   async presentPaymentSheet(): Promise<{
-    paymentResult: PaymentSheetEventsEnum;
+    paymentResult: PaymentSheetResult;
   }> {
     const paymentSheetDOM = document.createElement('stripe-checkout') as any;
     paymentSheetDOM.publishableKey = this.publishableKey;