@revova/hydrogen 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,398 @@
+import React from 'react';
+
+type ReviewWidgetProps = {
+    proxyUrl: string;
+    productId: string;
+    locale?: string;
+    pageSize?: number;
+    showForm?: boolean;
+    starColor?: string;
+    className?: string;
+};
+declare function ReviewWidget({ proxyUrl, productId, locale, pageSize, showForm, starColor, className, }: ReviewWidgetProps): React.JSX.Element | null;
+
+type ReviewMedia = {
+    url: string;
+    mimeType: string;
+};
+type ReviewFieldAnswer = {
+    fieldId: string;
+    value: unknown;
+    field: {
+        id: string;
+        label: string;
+        type: string;
+        config: unknown;
+    };
+};
+type AdminReply = {
+    body: string;
+    createdAt: string;
+};
+type Review = {
+    id: string;
+    rating: number;
+    title: string | null;
+    body: string | null;
+    email: string | null;
+    isAnonymous: boolean;
+    verifiedBuyer: boolean;
+    isPinned: boolean;
+    helpfulCount: number;
+    sentiment: 'POSITIVE' | 'NEUTRAL' | 'NEGATIVE' | null;
+    createdAt: string;
+    variantTitle: string | null;
+    media: ReviewMedia[];
+    fieldAnswers: ReviewFieldAnswer[];
+    reply: AdminReply | null;
+    translatedTitle?: string | null;
+    translatedBody?: string | null;
+};
+type FormField = {
+    id: string;
+    type: string;
+    label: string | null;
+    position: number;
+    required: boolean;
+    config: unknown;
+};
+type ResolvedForm = {
+    id: string;
+    fields: FormField[];
+};
+type ReviewsPagination = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+};
+type ReviewsResponse = {
+    reviews: Review[];
+    pagination: ReviewsPagination;
+    form: ResolvedForm | null;
+};
+type SubmitReviewPayload = {
+    productId: string;
+    variantId?: string;
+    variantTitle?: string;
+    email: string;
+    isAnonymous?: boolean;
+    formId: string;
+    fieldAnswers: {
+        fieldId: string;
+        value: unknown;
+    }[];
+    mediaIds?: string[];
+};
+type SubmitReviewResponse = {
+    reviewId: string;
+    status: 'PENDING' | 'APPROVED';
+    requiresEmailVerification: boolean;
+    message?: string;
+};
+type AttributeRating = {
+    label: string;
+    value: number;
+};
+type GlobalReview = {
+    id: string;
+    rating: number;
+    title: string | null;
+    body: string | null;
+    authorName: string;
+    verifiedBuyer: boolean;
+    productId: string;
+    createdAt: string;
+    image: string | null;
+    attributeRatings: AttributeRating[];
+};
+type ShopStats = {
+    totalReviews: number;
+    averageRating: string | null;
+};
+type WidgetTheme = {
+    primaryColor: string;
+    starColor: string;
+    textColor: string;
+    subtextColor: string;
+    backgroundColor: string;
+    borderRadius: number;
+    fontFamily: string;
+};
+type WidgetConfig = {
+    popup: {
+        enabled: boolean;
+        intervalSeconds: number;
+        displaySeconds: number;
+        position: string;
+    };
+    floatingTab: {
+        enabled: boolean;
+        position: string;
+        label: string;
+        color: string;
+    };
+    trustBadge: {
+        enabled: boolean;
+        style: string;
+    };
+    ticker: {
+        enabled: boolean;
+        speedSeconds: number;
+        maxItems: number;
+    };
+    floatingButton: {
+        enabled: boolean;
+        text: string;
+        color: string;
+        position: string;
+    };
+    theme: WidgetTheme;
+};
+type WidgetGlobalsResponse = {
+    config: WidgetConfig | null;
+    stats: ShopStats | null;
+    reviews: GlobalReview[];
+};
+type HelpfulVotePayload = {
+    reviewId: string;
+    vote: 'helpful' | 'not_helpful';
+};
+type HelpfulVoteResponse = {
+    helpfulCount: number;
+};
+type SortKey = 'recent' | 'helpful' | 'rating_high' | 'rating_low';
+type UseReviewsOptions = {
+    proxyUrl: string;
+    productId: string;
+    page?: number;
+    limit?: number;
+    sort?: SortKey;
+    locale?: string;
+};
+type UseWidgetGlobalsOptions = {
+    proxyUrl: string;
+    limit?: number;
+};
+type QnAAnswer = {
+    id: string;
+    body: string;
+    displayName: string;
+    isAdminReply: boolean;
+    helpfulCount: number;
+    createdAt: string;
+};
+type ProductQuestion = {
+    id: string;
+    body: string;
+    displayName: string;
+    verifiedBuyer: boolean;
+    answersCount: number;
+    createdAt: string;
+    answers: QnAAnswer[];
+};
+type QnAPagination = {
+    page: number;
+    total: number;
+    totalPages: number;
+};
+type QnAResponse = {
+    questions: ProductQuestion[];
+    pagination: QnAPagination;
+};
+type SubmitQuestionPayload = {
+    intent: 'question';
+    productId: string;
+    email: string;
+    displayName?: string;
+    body: string;
+    isAnonymous?: boolean;
+};
+type SubmitAnswerPayload = {
+    intent: 'answer';
+    questionId: string;
+    email: string;
+    displayName?: string;
+    body: string;
+    isAnonymous?: boolean;
+};
+type UseQnAOptions = {
+    proxyUrl: string;
+    productId: string;
+    page?: number;
+    sort?: 'recent' | 'helpful';
+};
+
+type ReviewFormProps = {
+    proxyUrl: string;
+    productId: string;
+    form: ResolvedForm;
+    onSuccess?: () => void;
+    className?: string;
+};
+declare function ReviewForm({ proxyUrl, productId, form, onSuccess, className }: ReviewFormProps): React.JSX.Element;
+
+type ReviewCountProps = {
+    proxyUrl: string;
+    starColor?: string;
+    starSize?: number;
+    className?: string;
+};
+declare function ReviewCount({ proxyUrl, starColor, starSize, className }: ReviewCountProps): React.JSX.Element | null;
+
+type StarRatingProps = {
+    rating: number;
+    max?: number;
+    size?: number | undefined;
+    color?: string | undefined;
+    className?: string | undefined;
+};
+declare function StarRating({ rating, max, size, color, className }: StarRatingProps): React.JSX.Element;
+
+type ReviewCarouselProps = {
+    proxyUrl: string;
+    limit?: number;
+    autoPlay?: boolean;
+    intervalMs?: number;
+    starColor?: string;
+    className?: string;
+};
+declare function ReviewCarousel({ proxyUrl, limit, autoPlay, intervalMs, starColor, className, }: ReviewCarouselProps): React.JSX.Element | null;
+
+type ReviewGalleryProps = {
+    proxyUrl: string;
+    limit?: number;
+    columns?: number;
+    starColor?: string;
+    className?: string;
+};
+declare function ReviewGallery({ proxyUrl, limit, columns, starColor, className, }: ReviewGalleryProps): React.JSX.Element | null;
+
+type QnAWidgetProps = {
+    proxyUrl: string;
+    productId: string;
+    className?: string;
+};
+declare function QnAWidget({ proxyUrl, productId, className }: QnAWidgetProps): React.JSX.Element | null;
+
+type SocialProofPopupProps = {
+    proxyUrl: string;
+    position?: 'bottom-left' | 'bottom-right';
+    intervalMs?: number;
+    displayMs?: number;
+    starColor?: string;
+    className?: string;
+};
+declare function SocialProofPopup({ proxyUrl, position, intervalMs, displayMs, starColor, className, }: SocialProofPopupProps): React.JSX.Element | null;
+
+type ReviewTickerProps = {
+    proxyUrl: string;
+    limit?: number;
+    speedSeconds?: number;
+    starColor?: string;
+    className?: string;
+};
+declare function ReviewTicker({ proxyUrl, limit, speedSeconds, starColor, className, }: ReviewTickerProps): React.JSX.Element | null;
+
+type FloatingReviewsTabProps = {
+    proxyUrl: string;
+    label?: string;
+    position?: 'left' | 'right';
+    color?: string;
+    limit?: number;
+    starColor?: string;
+    className?: string;
+};
+declare function FloatingReviewsTab({ proxyUrl, label, position, color, limit, starColor, className, }: FloatingReviewsTabProps): React.JSX.Element;
+
+type TrustBadgeProps = {
+    proxyUrl: string;
+    style?: 'inline' | 'pill' | 'card';
+    starColor?: string;
+    className?: string;
+};
+declare function TrustBadge({ proxyUrl, style: badgeStyle, starColor, className }: TrustBadgeProps): React.JSX.Element | null;
+
+type FloatingReviewButtonProps = {
+    proxyUrl: string;
+    productId: string;
+    text?: string;
+    color?: string;
+    position?: 'bottom-left' | 'bottom-right';
+    className?: string;
+};
+declare function FloatingReviewButton({ proxyUrl, productId, text, color, position, className, }: FloatingReviewButtonProps): React.JSX.Element | null;
+
+type State$3 = {
+    data: ReviewsResponse | null;
+    loading: boolean;
+    error: Error | null;
+};
+type UseReviewsReturn = State$3 & {
+    refetch: () => void;
+    setPage: (page: number) => void;
+    setSort: (sort: SortKey) => void;
+    currentPage: number;
+    currentSort: SortKey;
+};
+declare function useReviews({ proxyUrl, productId, page: initialPage, limit, sort: initialSort, locale, }: UseReviewsOptions): UseReviewsReturn;
+
+type State$2 = {
+    data: WidgetGlobalsResponse | null;
+    loading: boolean;
+    error: Error | null;
+};
+declare function useWidgetGlobals({ proxyUrl, limit }: UseWidgetGlobalsOptions): State$2;
+
+type SubmitState$1 = {
+    submitting: boolean;
+    success: boolean;
+    error: string | null;
+    result: SubmitReviewResponse | null;
+};
+type UseSubmitReviewReturn = SubmitState$1 & {
+    submit: (payload: SubmitReviewPayload) => Promise<void>;
+    reset: () => void;
+};
+declare function useSubmitReview(proxyUrl: string): UseSubmitReviewReturn;
+
+type UseHelpfulVoteReturn = {
+    vote: (payload: HelpfulVotePayload) => Promise<void>;
+    loading: boolean;
+    voted: boolean;
+};
+declare function useHelpfulVote(proxyUrl: string): UseHelpfulVoteReturn;
+
+type State$1 = {
+    data: QnAResponse | null;
+    loading: boolean;
+    error: Error | null;
+};
+type SubmitState = {
+    submitting: boolean;
+    success: boolean;
+    error: string | null;
+};
+type UseQnAReturn = State$1 & {
+    setPage: (page: number) => void;
+    currentPage: number;
+    refetch: () => void;
+    submitQuestion: (payload: SubmitQuestionPayload) => Promise<void>;
+    submitAnswer: (payload: SubmitAnswerPayload) => Promise<void>;
+    submitState: SubmitState;
+    resetSubmit: () => void;
+};
+declare function useQnA({ proxyUrl, productId, page: initialPage, sort }: UseQnAOptions): UseQnAReturn;
+
+type State = {
+    form: ResolvedForm | null;
+    loading: boolean;
+    error: Error | null;
+};
+/**
+ * Fetches the resolved form for a product without loading any reviews.
+ * Uses the reviews proxy with limit=1 and extracts only the form field.
+ */
+declare function useForm(proxyUrl: string, productId: string): State;
+
+export { type AdminReply, type AttributeRating, FloatingReviewButton, FloatingReviewsTab, type FormField, type GlobalReview, type HelpfulVotePayload, type HelpfulVoteResponse, type ProductQuestion, type QnAAnswer, type QnAPagination, type QnAResponse, QnAWidget, type ResolvedForm, type Review, ReviewCarousel, ReviewCount, type ReviewFieldAnswer, ReviewForm, ReviewGallery, type ReviewMedia, ReviewTicker, ReviewWidget, type ReviewsPagination, type ReviewsResponse, type ShopStats, SocialProofPopup, type SortKey, StarRating, type SubmitAnswerPayload, type SubmitQuestionPayload, type SubmitReviewPayload, type SubmitReviewResponse, TrustBadge, type UseQnAOptions, type UseReviewsOptions, type UseWidgetGlobalsOptions, type WidgetConfig, type WidgetGlobalsResponse, type WidgetTheme, useForm, useHelpfulVote, useQnA, useReviews, useSubmitReview, useWidgetGlobals };