react-native-tpay 1.3.5 → 1.3.7

package/src/model/result/result.ts

@@ -1,32 +1,61 @@
 /**
  * Indicates a result of Tpay UI module action
  */
-export class Result {}
+export abstract class Result {
+  /**
+   * Type identifier for the result
+   */
+  abstract readonly type: string;
+
+  /**
+   * Optional error message or additional information
+   */
+  message?: string;
+
+  /**
+   * Transaction ID when applicable
+   */
+  transactionId?: string | null;
+
+  /**
+   * Payment URL for continuation (used in screenless payments)
+   */
+  paymentUrl?: string;
+}
 
 /**
  * Indicates that credit card tokenization was successful and module was closed
  */
-export class TokenizationCompleted extends Result {}
+export class TokenizationCompleted extends Result {
+  readonly type = 'tokenizationCompleted';
+}
 
 /**
  * Indicates that credit card tokenization failed and module was closed
  */
-export class TokenizationFailure extends Result {}
+export class TokenizationFailure extends Result {
+  readonly type = 'tokenizationFailure';
+}
 
 /**
  * Indicates that configuration was successful
  */
-export class ConfigurationSuccess extends Result {}
+export class ConfigurationSuccess extends Result {
+  readonly type = 'configurationSuccess';
+}
 
 /**
  * Indicates that user closed the module without making a payment/tokenization
  */
-export class ModuleClosed extends Result {}
+export class ModuleClosed extends Result {
+  readonly type = 'moduleClosed';
+}
 
 /**
  * Indicates that some data passed to module is invalid
  */
 export class ValidationError extends Result {
+  readonly type = 'validationError';
   /**
    * Validation error message
    */
@@ -42,6 +71,7 @@ export class ValidationError extends Result {
  * Indicates that payment was successfully created
  */
 export class PaymentCreated extends Result {
+  readonly type = 'paymentCreated';
   /**
    * Transaction id of the created transaction
    */
@@ -57,6 +87,7 @@ export class PaymentCreated extends Result {
  * Indicates that payment was successful and module was closed
  */
 export class PaymentCompleted extends Result {
+  readonly type = 'paymentCompleted';
   /**
    * Transaction id of the completed transaction
    */
@@ -72,6 +103,7 @@ export class PaymentCompleted extends Result {
  * Indicates that payment failed and module was closed
  */
 export class PaymentCancelled extends Result {
+  readonly type = 'paymentCancelled';
   /**
    * If exists, id of the transaction
    */
@@ -87,6 +119,7 @@ export class PaymentCancelled extends Result {
  * Indicates a module error
  */
 export class MethodCallError extends Result {
+  readonly type = 'methodCallError';
   /**
    * Error message
    */

package/src/model/result/screenless_result.ts

@@ -3,12 +3,43 @@ import { AmbiguousAlias } from 'react-native-tpay';
 /**
  * Indicates a result of screenless action
  */
-export class ScreenlessResult {}
+export abstract class ScreenlessResult {
+  /**
+   * Type identifier for the result
+   */
+  abstract readonly type: string;
+
+  /**
+   * Optional error message or additional information
+   */
+  message?: string;
+
+  /**
+   * Transaction ID when applicable
+   */
+  transactionId?: string;
+
+  /**
+   * Payment URL for continuation when applicable
+   */
+  paymentUrl?: string | null;
+
+  /**
+   * Error message when applicable
+   */
+  error?: string | null;
+
+  /**
+   * Ambiguous aliases for BLIK payments when applicable
+   */
+  aliases?: Array<AmbiguousAlias>;
+}
 
 /**
  * Indicates that some data passed to payment is invalid
  */
 export class ScreenlessValidationError extends ScreenlessResult {
+  readonly type = 'validationError';
   /**
    * Validation error message
    */
@@ -24,6 +55,7 @@ export class ScreenlessValidationError extends ScreenlessResult {
  * Indicates a module error
  */
 export class ScreenlessMethodCallError extends ScreenlessResult {
+  readonly type = 'methodCallError';
   /**
    * Error message
    */
@@ -39,6 +71,7 @@ export class ScreenlessMethodCallError extends ScreenlessResult {
  * Indicates that payment was completed successfully
  */
 export class ScreenlessPaid extends ScreenlessResult {
+  readonly type = 'paid';
   /**
    * Transaction id of the completed transaction
    */
@@ -59,6 +92,7 @@ export class ScreenlessPaid extends ScreenlessResult {
  * payment status via transactionId.
  */
 export class ScreenlessPaymentCreated extends ScreenlessResult {
+  readonly type = 'paymentCreated';
   /**
    * Transaction id of the created transaction
    */
@@ -82,6 +116,7 @@ export class ScreenlessPaymentCreated extends ScreenlessResult {
  * - BLIK code or BLIK alias
  */
 export class ScreenlessConfiguredPaymentFailed extends ScreenlessResult {
+  readonly type = 'configuredPaymentFailed';
   /**
    * Transaction id of the created transaction
    */
@@ -105,6 +140,7 @@ export class ScreenlessConfiguredPaymentFailed extends ScreenlessResult {
  * continue the payment.
  */
 export class ScreenlessBlikAmbiguousAlias extends ScreenlessResult {
+  readonly type = 'ambiguousAlias';
   /**
    * Transaction id of the created transaction
    */
@@ -126,6 +162,7 @@ export class ScreenlessBlikAmbiguousAlias extends ScreenlessResult {
  * Indicates that payment was not created because of an error
  */
 export class ScreenlessPaymentError extends ScreenlessResult {
+  readonly type = 'error';
   /**
    * Optional error message
    */

package/src/model/transaction/single_transaction.ts

@@ -12,15 +12,17 @@ export class SingleTransaction extends Transaction {
    * @param payerContext - information about payer and automatic payment methods
    * @param amount - amount of money payer has to pay
    * @param description - description of payment shown to payer
+   * @param hiddenDescription - description of payment shown to merchant
    * @param notifications - payment notification url and email
    */
   constructor(
     payerContext: PayerContext,
     amount: number,
     description: string,
+    hiddenDescription: string | null,
     notifications: Notifications | null
   ) {
-    super(amount, description, notifications);
+    super(amount, description, hiddenDescription, notifications);
     this.payerContext = payerContext;
   }
 }

package/src/model/transaction/token_payment.ts

@@ -14,6 +14,7 @@ export class TokenPayment extends Transaction {
    * @param payer - payer information
    * @param amount - amount of money payer has to pay
    * @param description - description of payment shown to payer
+   * @param hiddenDescription - description of payment shown to merchant
    * @param notifications - payment notification url and email
    */
   constructor(
@@ -21,9 +22,10 @@ export class TokenPayment extends Transaction {
     payer: Payer,
     amount: number,
     description: string,
+    hiddenDescription: string | null,
     notifications: Notifications | null
   ) {
-    super(amount, description, notifications);
+    super(amount, description, hiddenDescription, notifications);
     this.cardToken = cardToken;
     this.payer = payer;
   }

package/src/model/transaction/transaction.ts

@@ -6,20 +6,24 @@ import type { Notifications } from "../screenless/notifications";
 export class Transaction {
   amount: number;
   description: string;
+  hiddenDescription: string | null;
   notifications: Notifications | null;
 
   /**
    * @param amount - amount of money payer has to pay
    * @param description - description of payment shown to payer
+   * @param hiddenDescription - description of payment shown to merchant
    * @param notifications - payment notification url and email
    */
   constructor(
     amount: number,
     description: string,
+    hiddenDescription: string | null,
     notifications: Notifications | null
   ) {
     this.amount = amount;
     this.description = description;
+    this.hiddenDescription = hiddenDescription;
     this.notifications = notifications;
   }
 }