wallet-core/packages/taler-util/src/notifications.ts

/*
 This file is part of GNU Taler
 (C) 2019 GNUnet e.V.

 GNU Taler is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 GNU Taler; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

/**
 * Type and schema definitions for notifications from the wallet to clients
 * of the wallet.
 */

/**
 * Imports.
 */
import { TalerErrorDetails } from "./walletTypes.js";

export enum NotificationType {
  CoinWithdrawn = "coin-withdrawn",
  ProposalAccepted = "proposal-accepted",
  ProposalDownloaded = "proposal-downloaded",
  RefundsSubmitted = "refunds-submitted",
  RecoupStarted = "recoup-started",
  RecoupFinished = "recoup-finished",
  RefreshRevealed = "refresh-revealed",
  RefreshMelted = "refresh-melted",
  RefreshStarted = "refresh-started",
  RefreshUnwarranted = "refresh-unwarranted",
  ReserveUpdated = "reserve-updated",
  ReserveConfirmed = "reserve-confirmed",
  ReserveCreated = "reserve-created",
  WithdrawGroupCreated = "withdraw-group-created",
  WithdrawGroupFinished = "withdraw-group-finished",
  WaitingForRetry = "waiting-for-retry",
  RefundStarted = "refund-started",
  RefundQueried = "refund-queried",
  RefundFinished = "refund-finished",
  ExchangeOperationError = "exchange-operation-error",
  RefreshOperationError = "refresh-operation-error",
  RecoupOperationError = "recoup-operation-error",
  RefundApplyOperationError = "refund-apply-error",
  RefundStatusOperationError = "refund-status-error",
  ProposalOperationError = "proposal-error",
  BackupOperationError = "backup-error",
  TipOperationError = "tip-error",
  PayOperationError = "pay-error",
  PayOperationSuccess = "pay-operation-success",
  WithdrawOperationError = "withdraw-error",
  ReserveNotYetFound = "reserve-not-yet-found",
  ReserveOperationError = "reserve-error",
  InternalError = "internal-error",
  PendingOperationProcessed = "pending-operation-processed",
  ProposalRefused = "proposal-refused",
  ReserveRegisteredWithBank = "reserve-registered-with-bank",
  DepositOperationError = "deposit-operation-error",
}

export interface ProposalAcceptedNotification {
  type: NotificationType.ProposalAccepted;
  proposalId: string;
}

export interface InternalErrorNotification {
  type: NotificationType.InternalError;
  message: string;
  exception: any;
}

export interface ReserveNotYetFoundNotification {
  type: NotificationType.ReserveNotYetFound;
  reservePub: string;
}

export interface CoinWithdrawnNotification {
  type: NotificationType.CoinWithdrawn;
}

export interface RefundStartedNotification {
  type: NotificationType.RefundStarted;
}

export interface RefundQueriedNotification {
  type: NotificationType.RefundQueried;
}

export interface ProposalDownloadedNotification {
  type: NotificationType.ProposalDownloaded;
  proposalId: string;
}

export interface RefundsSubmittedNotification {
  type: NotificationType.RefundsSubmitted;
  proposalId: string;
}

export interface RecoupStartedNotification {
  type: NotificationType.RecoupStarted;
}

export interface RecoupFinishedNotification {
  type: NotificationType.RecoupFinished;
}

export interface RefreshMeltedNotification {
  type: NotificationType.RefreshMelted;
}

export interface RefreshRevealedNotification {
  type: NotificationType.RefreshRevealed;
}

export interface RefreshStartedNotification {
  type: NotificationType.RefreshStarted;
}

export interface RefreshRefusedNotification {
  type: NotificationType.RefreshUnwarranted;
}

export interface ReserveConfirmedNotification {
  type: NotificationType.ReserveConfirmed;
}

export interface WithdrawalGroupCreatedNotification {
  type: NotificationType.WithdrawGroupCreated;
  withdrawalGroupId: string;
}

export interface WithdrawalGroupFinishedNotification {
  type: NotificationType.WithdrawGroupFinished;
  reservePub: string;
}

export interface WaitingForRetryNotification {
  type: NotificationType.WaitingForRetry;
  numPending: number;
  numGivingLiveness: number;
}

export interface RefundFinishedNotification {
  type: NotificationType.RefundFinished;
}

export interface ExchangeOperationErrorNotification {
  type: NotificationType.ExchangeOperationError;
  error: TalerErrorDetails;
}

export interface RefreshOperationErrorNotification {
  type: NotificationType.RefreshOperationError;
  error: TalerErrorDetails;
}

export interface BackupOperationErrorNotification {
  type: NotificationType.BackupOperationError;
  error: TalerErrorDetails;
}

export interface RefundStatusOperationErrorNotification {
  type: NotificationType.RefundStatusOperationError;
  error: TalerErrorDetails;
}

export interface RefundApplyOperationErrorNotification {
  type: NotificationType.RefundApplyOperationError;
  error: TalerErrorDetails;
}

export interface PayOperationErrorNotification {
  type: NotificationType.PayOperationError;
  error: TalerErrorDetails;
}

export interface ProposalOperationErrorNotification {
  type: NotificationType.ProposalOperationError;
  error: TalerErrorDetails;
}

export interface TipOperationErrorNotification {
  type: NotificationType.TipOperationError;
  error: TalerErrorDetails;
}

export interface WithdrawOperationErrorNotification {
  type: NotificationType.WithdrawOperationError;
  error: TalerErrorDetails;
}

export interface RecoupOperationErrorNotification {
  type: NotificationType.RecoupOperationError;
  error: TalerErrorDetails;
}

export interface DepositOperationErrorNotification {
  type: NotificationType.DepositOperationError;
  error: TalerErrorDetails;
}

export interface ReserveOperationErrorNotification {
  type: NotificationType.ReserveOperationError;
  error: TalerErrorDetails;
}

export interface ReserveCreatedNotification {
  type: NotificationType.ReserveCreated;
  reservePub: string;
}

export interface PendingOperationProcessedNotification {
  type: NotificationType.PendingOperationProcessed;
}

export interface ProposalRefusedNotification {
  type: NotificationType.ProposalRefused;
}

export interface ReserveRegisteredWithBankNotification {
  type: NotificationType.ReserveRegisteredWithBank;
}

/**
 * Notification sent when a pay (or pay replay) operation succeeded.
 *
 * We send this notification because the confirmPay request can return
 * a "confirmed" response that indicates that the payment has been confirmed
 * by the user, but we're still waiting for the payment to succeed or fail.
 */
export interface PayOperationSuccessNotification {
  type: NotificationType.PayOperationSuccess;
  proposalId: string;
}

export type WalletNotification =
  | BackupOperationErrorNotification
  | WithdrawOperationErrorNotification
  | ReserveOperationErrorNotification
  | ExchangeOperationErrorNotification
  | RefreshOperationErrorNotification
  | RefundStatusOperationErrorNotification
  | RefundApplyOperationErrorNotification
  | ProposalOperationErrorNotification
  | PayOperationErrorNotification
  | TipOperationErrorNotification
  | ProposalAcceptedNotification
  | ProposalDownloadedNotification
  | RefundsSubmittedNotification
  | RecoupStartedNotification
  | RecoupFinishedNotification
  | RefreshMeltedNotification
  | RefreshRevealedNotification
  | RefreshStartedNotification
  | RefreshRefusedNotification
  | ReserveCreatedNotification
  | ReserveConfirmedNotification
  | WithdrawalGroupFinishedNotification
  | WaitingForRetryNotification
  | RefundStartedNotification
  | RefundFinishedNotification
  | RefundQueriedNotification
  | WithdrawalGroupCreatedNotification
  | CoinWithdrawnNotification
  | RecoupOperationErrorNotification
  | DepositOperationErrorNotification
  | InternalErrorNotification
  | PendingOperationProcessedNotification
  | ProposalRefusedNotification
  | ReserveRegisteredWithBankNotification
  | ReserveNotYetFoundNotification
  | PayOperationSuccessNotification;