Class TransactionHideAdminService

constructor

• new TransactionHideAdminService(
      __namedParameters: {
          cacheBuster: TransactionCacheBuster;
          db: B2bDatabase;
          internalEventPublisher: InternalEventPublisher | null;
          transactionAdminQueryService: TransactionAdminQueryService;
      },
  ): TransactionHideAdminService

  Parameters

  • __namedParameters: {
        cacheBuster: TransactionCacheBuster;
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher | null;
        transactionAdminQueryService: TransactionAdminQueryService;
    }

    • cacheBuster: TransactionCacheBuster

      Busts only: the hide events below stand in for transaction.transaction.updated.

    • db: B2bDatabase

    • internalEventPublisher: InternalEventPublisher | null

      Publishes transaction.transaction.hidden / .unhidden; null publishes nothing (tests).

    • transactionAdminQueryService: TransactionAdminQueryService

      Must read the writer: a lagging replica could validate stale legs.

  Returns TransactionHideAdminService

Staticinstance

get

• get(
      __namedParameters: { customerId: string; transactionId: string },
  ): Promise<
      | {
          groupId: string;
          hiddenAt: Date;
          hiddenBy: string;
          transactionIds: string[];
      }
      | null,
  >

  The hide group a transaction belongs to, or null when it is not hidden.

  Parameters

  • __namedParameters: { customerId: string; transactionId: string }

  Returns Promise<
      | {
          groupId: string;
          hiddenAt: Date;
          hiddenBy: string;
          transactionIds: string[];
      }
      | null,
  >

hide

• hide(
      __namedParameters: {
          customerId: string;
          hiddenBy: string;
          transactionIds: string[];
      },
  ): Promise<
      | { ok: true; value: { groupId: string; transactionIds: string[] } }
      | {
          error:
              | ServiceError<
                  "TRANSACTION_SELECTION_EMPTY"
                  | "TRANSACTION_ALREADY_HIDDEN",
              >
              | HideCheckError;
          ok: false;
      },
  >

  Parameters

  • __namedParameters: { customerId: string; hiddenBy: string; transactionIds: string[] }

  Returns Promise<
      | { ok: true; value: { groupId: string; transactionIds: string[] } }
      | {
          error:
              | ServiceError<
                  "TRANSACTION_SELECTION_EMPTY"
                  | "TRANSACTION_ALREADY_HIDDEN",
              >
              | HideCheckError;
          ok: false;
      },
  >

unhide

• unhide(
      __namedParameters: { groupId: string },
  ): Promise<
      | { ok: true; value: { customerId: string; transactionIds: string[] } }
      | { error: ServiceError; ok: false },
  >

  Releases every transaction hidden in the group.

  Parameters

  • __namedParameters: { groupId: string }

  Returns Promise<
      | { ok: true; value: { customerId: string; transactionIds: string[] } }
      | { error: ServiceError; ok: false },
  >