@heyframe/composables/src/useProductReviews/useProductReviews.ts

HeyFrame Frontends composables for Vue

import { computed, ref } from "vue";
import type { ComputedRef, Ref } from "vue";
import { useHeyFrameContext } from "#imports";
import type { Schemas, operations } from "#heyframe";

export type UseProductReviewsReturn = {
  /**
   * All reviews added to the product
   */
  productReviews: ComputedRef<Schemas["ProductReview"][]>;
  /**
   * Adds a review to the product
   * @param data `title` - review title, `content` - review content, `points` - review points (range of 1-5)
   * @returns
   */
  addReview(data: {
    title: string;
    content: string;
    points: number;
  }): Promise<void>;
  /**
   * Fetches the reviews list and assigns the result to the `productReviews` property
   * @param parameters {@link Schemas["Criteria"]}
   * @returns
   */
  loadProductReviews(
    parameters?: Schemas["Criteria"],
  ): Promise<
    operations["readProductReviews post /product/{productId}/reviews"]["response"]
  >;
};

/**
 * Composable for listing customer orders.
 * @public
 * @category Product
 */
export function useProductReviews(
  product: Ref<Schemas["Product"]>,
): UseProductReviewsReturn {
  const { apiClient } = useHeyFrameContext();

  const productReviews: Ref<Schemas["ProductReview"][]> = ref([]);

  const loadProductReviews = async (
    parameters: Schemas["Criteria"] = {},
  ): Promise<
    operations["readProductReviews post /product/{productId}/reviews"]["response"]
  > => {
    const fetchedReviews = await apiClient.invoke(
      "readProductReviews post /product/{productId}/reviews",
      {
        pathParams: { productId: product.value.id },
        body: parameters,
      },
    );
    productReviews.value = fetchedReviews.data.elements ?? [];
    return fetchedReviews.data;
  };

  const addReview = async (data: {
    title: string;
    content: string;
    points: number;
  }) => {
    await apiClient.invoke(
      "saveProductReview post /product/{productId}/review",
      {
        pathParams: { productId: product.value.id },
        body: data,
      },
    );
  };

  return {
    productReviews: computed(() => productReviews.value),
    loadProductReviews,
    addReview,
  };
}