List Help Articles

# Featured articles in payments category
curl 'https://api.bio.re/api/v1/public/help/articles?category=payments&featured=true&limit=20'

# Search for "withdraw"
curl 'https://api.bio.re/api/v1/public/help/articles?search=withdraw'

type HelpCategoryEmbed = { name: string; slug: string };

type HelpArticleListItem = {
  slug: string;
  title: string;
  excerpt: string | null;
  icon: string | null;
  readTimeMinutes: number | null;
  isFeatured: boolean;
  publishedAt: string | null;
  category: HelpCategoryEmbed;
};

type HelpArticleListData = {
  items: HelpArticleListItem[];
  total: number;
  page: number;
  limit: number;
  totalPages: number;
};

async function listHelpArticles(filter: {
  page?: number;
  limit?: number;
  category?: string;
  search?: string;
  featured?: boolean;
  locale?: string;
} = {}): Promise<HelpArticleListData> {
  const url = new URL('https://api.bio.re/api/v1/public/help/articles');
  if (filter.page) url.searchParams.set('page', String(filter.page));
  if (filter.limit) url.searchParams.set('limit', String(filter.limit));
  if (filter.category) url.searchParams.set('category', filter.category);
  if (filter.search) url.searchParams.set('search', filter.search);
  if (filter.featured) url.searchParams.set('featured', 'true');
  if (filter.locale) url.searchParams.set('locale', filter.locale);
  const res = await fetch(url);
  const json = await res.json();
  if (!res.ok || !json.success) {
    throw Object.assign(new Error(json?.error?.message ?? 'Help articles fetch failed'), {
      code: json?.error?.code,
    });
  }
  return json.data;
}

import { useQuery, keepPreviousData } from '@tanstack/react-query';

export const contentKeys = {
  helpArticles: (filter: Record<string, unknown>) =>
    ['content', 'help', 'articles', filter] as const,
};

export function useHelpArticles(filter: {
  page?: number;
  limit?: number;
  category?: string;
  search?: string;
  featured?: boolean;
  locale?: string;
} = {}) {
  return useQuery({
    queryKey: contentKeys.helpArticles(filter),
    queryFn: async () => {
      const url = new URL('/api/v1/public/help/articles', window.location.origin);
      if (filter.page) url.searchParams.set('page', String(filter.page));
      if (filter.limit) url.searchParams.set('limit', String(filter.limit));
      if (filter.category) url.searchParams.set('category', filter.category);
      if (filter.search) url.searchParams.set('search', filter.search);
      if (filter.featured) url.searchParams.set('featured', 'true');
      if (filter.locale) url.searchParams.set('locale', filter.locale);
      const res = await fetch(url);
      const json = await res.json();
      if (!res.ok || !json.success) {
        throw Object.assign(new Error(json?.error?.message ?? 'Help articles fetch failed'), {
          code: json?.error?.code,
          i18nKey: json?.error?.i18nKey,
        });
      }
      return json.data as HelpArticleListData;
    },
    placeholderData: keepPreviousData,
    staleTime: 5 * 60_000,
  });
}