@storecraft/sdk-react-hooks/src/use-quick-search.js

Official Storecraft Javascript SDK React Hooks

/**
 * @import { 
 *  QuickSearchResult, ApiQuery 
 * } from '@storecraft/core/api'
 */
import { 
  useCallback, useEffect, useRef, useState 
} from 'react'
import useTrigger from './use-trigger.js'
import { 
  list_from_collection_resource 
} from '@storecraft/sdk/src/utils.api.fetch.js'
import { useStorecraft } from './use-storecraft.js'

/** @type {ApiQuery} */
const q_initial = {
  sortBy: ['updated_at', 'id'],
  order: 'desc',
  limit: 5
}

/**
 * @description Quick search hook for searching across all collections.
 * Will return minimal data for each item.
 */
export const useQuickSearch = (
) => {

  const { sdk } = useStorecraft();
  const _hasEffectRan = useRef(false);

  const [error, setError] = useState(undefined);

  /**@type {ReturnType<typeof useState<QuickSearchResult>>} */
  const [result, setResult] = useState();
  const [loading, setIsLoading] = useState(false);
  const [hasLoaded, setHasLoaded] = useState(false);
  const trigger = useTrigger();
  
  const query = useCallback(
    /**
     * @param {ApiQuery} [q=q_initial] query object
     * @param {boolean} [from_cache] 
     */
    async (q=q_initial, from_cache=true) => {
      q = {
        ...q_initial, 
        ...q
      };

      try {
        /** @type {QuickSearchResult} */
        // @ts-ignore
        const item = await list_from_collection_resource(
          sdk,
          'search', 
          q
        );

        setResult(item);
      } catch (e) {
        setError(e);
      }

    }, []
  );

  useEffect(
    () => {
      query();
    }, []
  );

  return {
    result, 
    loading, 
    hasLoaded,
    error, 
    sdk,
    actions: {
      query,
    },
  }
}