wallet-core/packages/merchant-backoffice-ui/src/hooks/order.ts

/*
 This file is part of GNU Taler
 (C) 2021-2023 Taler Systems S.A.

 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/>
 */
import {
  HttpResponse,
  HttpResponseOk,
  HttpResponsePaginated,
  RequestError,
} from "@gnu-taler/web-util/lib/index.browser";
import { useEffect, useState } from "preact/hooks";
import { MerchantBackend } from "../declaration.js";
import { MAX_RESULT_SIZE, PAGE_SIZE } from "../utils/constants.js";
import { useBackendInstanceRequest, useMatchMutate } from "./backend.js";

// FIX default import https://github.com/microsoft/TypeScript/issues/49189
import _useSWR, { SWRHook } from "swr";
const useSWR = _useSWR as unknown as SWRHook;

export interface OrderAPI {
  //FIXME: add OutOfStockResponse on 410
  createOrder: (
    data: MerchantBackend.Orders.PostOrderRequest,
  ) => Promise<HttpResponseOk<MerchantBackend.Orders.PostOrderResponse>>;
  forgetOrder: (
    id: string,
    data: MerchantBackend.Orders.ForgetRequest,
  ) => Promise<HttpResponseOk<void>>;
  refundOrder: (
    id: string,
    data: MerchantBackend.Orders.RefundRequest,
  ) => Promise<HttpResponseOk<MerchantBackend.Orders.MerchantRefundResponse>>;
  deleteOrder: (id: string) => Promise<HttpResponseOk<void>>;
  getPaymentURL: (id: string) => Promise<HttpResponseOk<string>>;
}

type YesOrNo = "yes" | "no";

export function useOrderAPI(): OrderAPI {
  const mutateAll = useMatchMutate();
  const { request } = useBackendInstanceRequest();

  const createOrder = async (
    data: MerchantBackend.Orders.PostOrderRequest,
  ): Promise<HttpResponseOk<MerchantBackend.Orders.PostOrderResponse>> => {
    const res = await request<MerchantBackend.Orders.PostOrderResponse>(
      `/private/orders`,
      {
        method: "POST",
        data,
      },
    );
    await mutateAll(/.*private\/orders.*/);
    // mutate('')
    return res;
  };
  const refundOrder = async (
    orderId: string,
    data: MerchantBackend.Orders.RefundRequest,
  ): Promise<HttpResponseOk<MerchantBackend.Orders.MerchantRefundResponse>> => {
    mutateAll(/@"\/private\/orders"@/);
    const res = request<MerchantBackend.Orders.MerchantRefundResponse>(
      `/private/orders/${orderId}/refund`,
      {
        method: "POST",
        data,
      },
    );

    // order list returns refundable information, so we must evict everything
    await mutateAll(/.*private\/orders.*/);
    return res;
  };

  const forgetOrder = async (
    orderId: string,
    data: MerchantBackend.Orders.ForgetRequest,
  ): Promise<HttpResponseOk<void>> => {
    mutateAll(/@"\/private\/orders"@/);
    const res = request<void>(`/private/orders/${orderId}/forget`, {
      method: "PATCH",
      data,
    });
    // we may be forgetting some fields that are pare of the listing, so we must evict everything
    await mutateAll(/.*private\/orders.*/);
    return res;
  };
  const deleteOrder = async (
    orderId: string,
  ): Promise<HttpResponseOk<void>> => {
    mutateAll(/@"\/private\/orders"@/);
    const res = request<void>(`/private/orders/${orderId}`, {
      method: "DELETE",
    });
    await mutateAll(/.*private\/orders.*/);
    return res;
  };

  const getPaymentURL = async (
    orderId: string,
  ): Promise<HttpResponseOk<string>> => {
    return request<MerchantBackend.Orders.MerchantOrderStatusResponse>(
      `/private/orders/${orderId}`,
      {
        method: "GET",
      },
    ).then((res) => {
      const url =
        res.data.order_status === "unpaid"
          ? res.data.taler_pay_uri
          : res.data.contract_terms.fulfillment_url;
      const response: HttpResponseOk<string> = res as any;
      response.data = url || "";
      return response;
    });
  };

  return { createOrder, forgetOrder, deleteOrder, refundOrder, getPaymentURL };
}

export function useOrderDetails(
  oderId: string,
): HttpResponse<
  MerchantBackend.Orders.MerchantOrderStatusResponse,
  MerchantBackend.ErrorDetail
> {
  const { fetcher } = useBackendInstanceRequest();

  const { data, error, isValidating } = useSWR<
    HttpResponseOk<MerchantBackend.Orders.MerchantOrderStatusResponse>,
    RequestError<MerchantBackend.ErrorDetail>
  >([`/private/orders/${oderId}`], fetcher, {
    refreshInterval: 0,
    refreshWhenHidden: false,
    revalidateOnFocus: false,
    revalidateOnReconnect: false,
    refreshWhenOffline: false,
  });

  if (isValidating) return { loading: true, data: data?.data };
  if (data) return data;
  if (error) return error.info;
  return { loading: true };
}

export interface InstanceOrderFilter {
  paid?: YesOrNo;
  refunded?: YesOrNo;
  wired?: YesOrNo;
  date?: Date;
}

export function useInstanceOrders(
  args?: InstanceOrderFilter,
  updateFilter?: (d: Date) => void,
): HttpResponsePaginated<
  MerchantBackend.Orders.OrderHistory,
  MerchantBackend.ErrorDetail
> {
  const { orderFetcher } = useBackendInstanceRequest();

  const [pageBefore, setPageBefore] = useState(1);
  const [pageAfter, setPageAfter] = useState(1);

  const totalAfter = pageAfter * PAGE_SIZE;
  const totalBefore = args?.date ? pageBefore * PAGE_SIZE : 0;

  /**
   * FIXME: this can be cleaned up a little
   *
   * the logic of double query should be inside the orderFetch so from the hook perspective and cache
   * is just one query and one error status
   */
  const {
    data: beforeData,
    error: beforeError,
    isValidating: loadingBefore,
  } = useSWR<
    HttpResponseOk<MerchantBackend.Orders.OrderHistory>,
    RequestError<MerchantBackend.ErrorDetail>
  >(
    [
      `/private/orders`,
      args?.paid,
      args?.refunded,
      args?.wired,
      args?.date,
      totalBefore,
    ],
    orderFetcher,
  );
  const {
    data: afterData,
    error: afterError,
    isValidating: loadingAfter,
  } = useSWR<
    HttpResponseOk<MerchantBackend.Orders.OrderHistory>,
    RequestError<MerchantBackend.ErrorDetail>
  >(
    [
      `/private/orders`,
      args?.paid,
      args?.refunded,
      args?.wired,
      args?.date,
      -totalAfter,
    ],
    orderFetcher,
  );

  //this will save last result
  const [lastBefore, setLastBefore] = useState<
    HttpResponse<
      MerchantBackend.Orders.OrderHistory,
      MerchantBackend.ErrorDetail
    >
  >({ loading: true });
  const [lastAfter, setLastAfter] = useState<
    HttpResponse<
      MerchantBackend.Orders.OrderHistory,
      MerchantBackend.ErrorDetail
    >
  >({ loading: true });
  useEffect(() => {
    if (afterData) setLastAfter(afterData);
    if (beforeData) setLastBefore(beforeData);
  }, [afterData, beforeData]);

  if (beforeError) return beforeError.info;
  if (afterError) return afterError.info;

  // if the query returns less that we ask, then we have reach the end or beginning
  const isReachingEnd = afterData && afterData.data.orders.length < totalAfter;
  const isReachingStart =
    args?.date === undefined ||
    (beforeData && beforeData.data.orders.length < totalBefore);

  const pagination = {
    isReachingEnd,
    isReachingStart,
    loadMore: () => {
      if (!afterData || isReachingEnd) return;
      if (afterData.data.orders.length < MAX_RESULT_SIZE) {
        setPageAfter(pageAfter + 1);
      } else {
        const from =
          afterData.data.orders[afterData.data.orders.length - 1].timestamp.t_s;
        if (from && from !== "never" && updateFilter)
          updateFilter(new Date(from * 1000));
      }
    },
    loadMorePrev: () => {
      if (!beforeData || isReachingStart) return;
      if (beforeData.data.orders.length < MAX_RESULT_SIZE) {
        setPageBefore(pageBefore + 1);
      } else if (beforeData) {
        const from =
          beforeData.data.orders[beforeData.data.orders.length - 1].timestamp
            .t_s;
        if (from && from !== "never" && updateFilter)
          updateFilter(new Date(from * 1000));
      }
    },
  };

  const orders =
    !beforeData || !afterData
      ? []
      : (beforeData || lastBefore).data.orders
          .slice()
          .reverse()
          .concat((afterData || lastAfter).data.orders);
  if (loadingAfter || loadingBefore) return { loading: true, data: { orders } };
  if (beforeData && afterData) {
    return { ok: true, data: { orders }, ...pagination };
  }
  return { loading: true };
}