@riosst100/pwa-marketplace 1.3.0 → 1.3.2

package/src/overwrites/peregrine/lib/talons/Breadcrumbs/useBreadcrumbs.js

@@ -0,0 +1,100 @@
+import { useMemo } from 'react';
+import { useQuery } from '@apollo/client';
+import { useInternalLink } from '@magento/peregrine/lib/hooks/useInternalLink';
+
+import mergeOperations from '@magento/peregrine/lib/util/shallowMerge';
+
+import DEFAULT_OPERATIONS from '@magento/peregrine/lib/talons/Breadcrumbs/breadcrumbs.gql';
+
+// Just incase the data is unsorted, lets sort it.
+
+/* CUSTOM: Fix sorting */
+const sortCrumbs = (a, b) => a.category_level - b.category_level;
+
+// Generates the path for the category.
+const getPath = (path, suffix) => {
+    if (path) {
+        return `/${path}${suffix || ''}`;
+    }
+
+    // If there is no path this is just a dead link.
+    return '#';
+};
+
+/**
+ * Returns props necessary to render a Breadcrumbs component.
+ *
+ * @param {object} props
+ * @param {object} props.query - the breadcrumb query
+ * @param {string} props.categoryId - the id of the category for which to generate breadcrumbs
+ * @return {{
+ *   currentCategory: string,
+ *   currentCategoryPath: string,
+ *   isLoading: boolean,
+ *   normalizedData: array,
+ *   handleClick: function
+ * }}
+ */
+export const useBreadcrumbs = props => {
+    const { categoryId } = props;
+
+    const operations = mergeOperations(DEFAULT_OPERATIONS, props.operations);
+    const { getBreadcrumbsQuery, getStoreConfigQuery } = operations;
+
+    const { data, loading, error } = useQuery(getBreadcrumbsQuery, {
+        variables: { category_id: categoryId },
+        fetchPolicy: 'cache-and-network',
+        nextFetchPolicy: 'cache-first'
+    });
+
+    const { data: storeConfigData } = useQuery(getStoreConfigQuery, {
+        fetchPolicy: 'cache-and-network'
+    });
+
+    const categoryUrlSuffix = useMemo(() => {
+        if (storeConfigData) {
+            return storeConfigData.storeConfig.category_url_suffix;
+        }
+    }, [storeConfigData]);
+
+    // When we have breadcrumb data sort and normalize it for easy rendering.
+    const normalizedData = useMemo(() => {
+        if (!loading && data && data.categories.items.length) {
+            const breadcrumbData = data.categories.items[0].breadcrumbs;
+
+            return (
+                breadcrumbData &&
+                breadcrumbData
+                    .map(category => ({
+                        category_level: category.category_level,
+                        text: category.category_name,
+                        path: getPath(
+                            category.category_url_path,
+                            categoryUrlSuffix
+                        )
+                    }))
+                    .sort(sortCrumbs)
+            );
+        }
+    }, [categoryUrlSuffix, data, loading]);
+
+    const { setShimmerType } = useInternalLink('category');
+
+    return {
+        currentCategory:
+            (data &&
+                data.categories.items.length &&
+                data.categories.items[0].name) ||
+            '',
+        currentCategoryPath:
+            (data &&
+                data.categories.items.length &&
+                `${data.categories.items[0].url_path}${categoryUrlSuffix ||
+                    ''}`) ||
+            '#',
+        isLoading: loading,
+        hasError: !!error,
+        normalizedData: normalizedData || [],
+        handleClick: setShimmerType
+    };
+};

package/src/overwrites/peregrine/lib/talons/MegaMenu/megaMenu.gql.js

@@ -0,0 +1,70 @@
+import { gql } from '@apollo/client';
+export const GET_STORE_CONFIG_DATA = gql`
+    query GetStoreConfigForMegaMenu {
+        # eslint-disable-next-line @graphql-eslint/require-id-when-available
+        storeConfig {
+            store_code
+            category_url_suffix
+        }
+    }
+`;
+
+export const GET_MEGA_MENU = gql`
+    query getMegaMenu {
+        # eslint-disable-next-line @graphql-eslint/require-id-when-available
+        categoryList {
+            uid
+            name
+            # eslint-disable-next-line @graphql-eslint/require-id-when-available
+            children {
+                uid
+                include_in_menu
+                name
+                position
+                url_path
+                shop_by {
+                    name
+                    items {
+                        name
+                        url_path
+                    }
+                }
+                # eslint-disable-next-line @graphql-eslint/require-id-when-available
+                children {
+                    uid
+                    include_in_menu
+                    name
+                    position
+                    url_path
+                    shop_by {
+                        name
+                        items {
+                            name
+                            url_path
+                        }
+                    }
+                    # eslint-disable-next-line @graphql-eslint/require-id-when-available
+                    children {
+                        uid
+                        include_in_menu
+                        name
+                        position
+                        url_path
+                        shop_by {
+                            name
+                            items {
+                                name
+                                url_path
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+`;
+
+export default {
+    getMegaMenuQuery: GET_MEGA_MENU,
+    getStoreConfigQuery: GET_STORE_CONFIG_DATA
+};

package/src/overwrites/peregrine/lib/talons/MegaMenu/useMegaMenu.js

@@ -0,0 +1,199 @@
+import { useMemo, useState, useCallback, useEffect } from 'react';
+import { useLocation } from 'react-router-dom';
+import { useInternalLink } from '../../hooks/useInternalLink';
+
+import { useQuery } from '@apollo/client';
+import { useEventListener } from '../../hooks/useEventListener';
+
+import mergeOperations from '../../util/shallowMerge';
+import DEFAULT_OPERATIONS from './megaMenu.gql';
+
+/**
+ * The useMegaMenu talon complements the MegaMenu component.
+ *
+ * @param {Object} props
+ * @param {*} props.operations GraphQL operations used by talons
+ * @param {React.RefObject} props.mainNavRef Reference to main navigation DOM node
+ *
+ * @return {MegaMenuTalonProps}
+ */
+export const useMegaMenu = (props = {}) => {
+    const operations = mergeOperations(DEFAULT_OPERATIONS, props.operations);
+    const { getMegaMenuQuery, getStoreConfigQuery } = operations;
+
+    const location = useLocation();
+    const [activeCategoryId, setActiveCategoryId] = useState(null);
+    const [subMenuState, setSubMenuState] = useState(false);
+    const [disableFocus, setDisableFocus] = useState(false);
+
+    const { data: storeConfigData } = useQuery(getStoreConfigQuery, {
+        fetchPolicy: 'cache-and-network'
+    });
+
+    const { data } = useQuery(getMegaMenuQuery, {
+        fetchPolicy: 'cache-and-network',
+        nextFetchPolicy: 'cache-first'
+    });
+
+    const categoryUrlSuffix = useMemo(() => {
+        if (storeConfigData) {
+            return storeConfigData.storeConfig.category_url_suffix;
+        }
+    }, [storeConfigData]);
+
+    /**
+     * Check if category should be visible on the storefront.
+     *
+     * @param {MegaMenuCategory} category
+     * @returns {boolean}
+     */
+    const shouldRenderMegaMenuItem = category => {
+        return !!category.include_in_menu;
+    };
+
+    /**
+     * Check if category is the active category based on the current location.
+     *
+     * @param {MegaMenuCategory} category
+     * @returns {boolean}
+     */
+
+    const isActive = useCallback(
+        ({ url_path }) => {
+            if (!url_path) return false;
+
+            const categoryUrlPath = `/${url_path}${categoryUrlSuffix || ''}`;
+
+            return location.pathname === categoryUrlPath;
+        },
+        [location.pathname, categoryUrlSuffix]
+    );
+
+    /**
+     * Recursively map data returned by GraphQL query.
+     *
+     * @param {MegaMenuCategory} category
+     * @param {array} - path from the given category to the first level category
+     * @param {boolean} isRoot - describes is category a root category
+     * @return {MegaMenuCategory}
+     */
+    const processData = useCallback(
+        (category, path = [], isRoot = true) => {
+            if (!category) {
+                return;
+            }
+
+            const megaMenuCategory = Object.assign({}, category);
+
+            if (!isRoot) {
+                megaMenuCategory.path = [...path, category.uid];
+            }
+
+            megaMenuCategory.isActive = isActive(megaMenuCategory);
+
+            if (megaMenuCategory.children) {
+                megaMenuCategory.children = [...megaMenuCategory.children]
+                    .filter(category => shouldRenderMegaMenuItem(category))
+                    .sort((a, b) => (a.position > b.position ? 1 : -1))
+                    .map(child =>
+                        processData(child, megaMenuCategory.path, false)
+                    );
+            }
+
+            return megaMenuCategory;
+        },
+        [isActive]
+    );
+
+    const megaMenuData = useMemo(() => {
+        return data ? processData(data.categoryList[0]) : {};
+    }, [data, processData]);
+
+    const findActiveCategory = useCallback(
+        (pathname, category) => {
+            if (isActive(category)) {
+                return category;
+            }
+
+            if (category.children) {
+                return category.children.find(category =>
+                    findActiveCategory(pathname, category)
+                );
+            }
+        },
+        [isActive]
+    );
+
+    const handleClickOutside = e => {
+        if (!props.mainNavRef.current.contains(e.target)) {
+            setSubMenuState(false);
+            setDisableFocus(true);
+        }
+    };
+
+    useEventListener(globalThis, 'keydown', handleClickOutside);
+
+    const handleSubMenuFocus = useCallback(() => {
+        setSubMenuState(true);
+    }, [setSubMenuState]);
+
+    useEffect(() => {
+        const activeCategory = findActiveCategory(
+            location.pathname,
+            megaMenuData
+        );
+
+        if (activeCategory) {
+            setActiveCategoryId(activeCategory.path[0]);
+        } else {
+            setActiveCategoryId(null);
+        }
+    }, [findActiveCategory, location.pathname, megaMenuData]);
+
+    /**
+     * Sets next root component to show proper loading effect
+     *
+     * @returns {void}
+     */
+    const { setShimmerType } = useInternalLink('category');
+
+    return {
+        megaMenuData,
+        activeCategoryId,
+        categoryUrlSuffix,
+        handleClickOutside,
+        subMenuState,
+        disableFocus,
+        handleSubMenuFocus,
+        handleNavigate: setShimmerType
+    };
+};
+
+/** JSDocs type definitions */
+
+/**
+ * @typedef {Object} MegaMenuTalonProps
+ *
+ * @property {MegaMenuCategory} megaMenuData - The Object with categories contains only categories
+ *                                             with the include_in_menu = 1 flag. The categories are sorted
+ *                                             based on the field position.
+ * @property {String} activeCategoryId returns the currently selected category uid.
+ * @property {String} categoryUrlSuffix  store's category url suffix to construct category URL
+ * @property {Function} handleClickOutside function to handle mouse/key events.
+ * @property {Boolean} subMenuState maintaining sub-menu open/close state
+ * @property {Boolean} disableFocus state to disable focus
+ * @property {Function} handleSubMenuFocus toggle function to handle sub-menu focus
+ * @property {function} handleNavigate - callback to fire on link click
+ */
+
+/**
+ * Object type returned by the {@link useMegaMenu} talon.
+ * @typedef {Object} MegaMenuCategory
+ *
+ * @property {String} uid - uid of the category
+ * @property {int} include_in_menu - describes if category should be included in menu
+ * @property {String} name - name of the category
+ * @property {int} position - value used for sorting
+ * @property {String} url_path - URL path for a category
+ * @property {MegaMenuCategory} children - child category
+ */

package/src/overwrites/peregrine/lib/talons/RootComponents/Category/categoryContent.gql.js

@@ -0,0 +1,70 @@
+import { gql } from '@apollo/client';
+
+export const GET_PRODUCT_FILTERS_BY_CATEGORY = gql`
+    query getProductFiltersByCategory(
+        $categoryIdFilter: FilterEqualTypeInput!
+    ) {
+        products(filter: { category_uid: $categoryIdFilter }) {
+            aggregations {
+                label
+                count
+                attribute_code
+                options {
+                    label
+                    value
+                }
+                position
+            }
+        }
+    }
+`;
+
+export const GET_CATEGORY_CONTENT = gql`
+    query getCategoryData($id: String!) {
+        categories(filters: { category_uid: { in: [$id] } }) {
+            # eslint-disable-next-line @graphql-eslint/require-id-when-available
+            items {
+                uid
+                name
+                description
+                url_key
+                url_path
+                parent {
+                    uid
+                    name
+                    position
+                    url_path
+                    # eslint-disable-next-line @graphql-eslint/require-id-when-available
+                }
+                children {
+                    uid
+                    name
+                    position
+                    url_path
+                    # eslint-disable-next-line @graphql-eslint/require-id-when-available
+                }
+            }
+        }
+    }
+`;
+
+export const GET_CATEGORY_AVAILABLE_SORT_METHODS = gql`
+    query getCategoryAvailableSortMethods(
+        $categoryIdFilter: FilterEqualTypeInput!
+    ) {
+        products(filter: { category_uid: $categoryIdFilter }) {
+            sort_fields {
+                options {
+                    label
+                    value
+                }
+            }
+        }
+    }
+`;
+
+export default {
+    getCategoryContentQuery: GET_CATEGORY_CONTENT,
+    getProductFiltersByCategoryQuery: GET_PRODUCT_FILTERS_BY_CATEGORY,
+    getCategoryAvailableSortMethodsQuery: GET_CATEGORY_AVAILABLE_SORT_METHODS
+};

package/src/overwrites/peregrine/lib/talons/RootComponents/Category/useCategoryContent.js

@@ -0,0 +1,141 @@
+import { useEffect } from 'react';
+import { useLazyQuery, useQuery } from '@apollo/client';
+
+import mergeOperations from '@magento/peregrine/lib/util/shallowMerge';
+import { useEventingContext } from '@magento/peregrine/lib/context/eventing';
+
+import DEFAULT_OPERATIONS from './categoryContent.gql';
+
+/**
+ * Returns props necessary to render the categoryContent component.
+ *
+ * @param {object} props.data - The results of a getCategory GraphQL query.
+ *
+ * @returns {object} result
+ * @returns {string} result.categoryDescription - This category's description.
+ * @returns {string} result.categoryName - This category's name.
+ * @returns {object} result.filters - The filters object.
+ * @returns {object} result.items - The items in this category.
+ * @returns {number} result.totalPagesFromData - The total amount of pages for the query.
+ */
+export const useCategoryContent = props => {
+    const { categoryId, data, pageSize = 6 } = props;
+
+    const operations = mergeOperations(DEFAULT_OPERATIONS, props.operations);
+
+    const {
+        getCategoryContentQuery,
+        getProductFiltersByCategoryQuery,
+        getCategoryAvailableSortMethodsQuery
+    } = operations;
+
+    const placeholderItems = Array.from({ length: pageSize }).fill(null);
+
+    const [getFilters, { data: filterData }] = useLazyQuery(
+        getProductFiltersByCategoryQuery,
+        {
+            fetchPolicy: 'cache-and-network',
+            nextFetchPolicy: 'cache-first'
+        }
+    );
+
+    const [getSortMethods, { data: sortData }] = useLazyQuery(
+        getCategoryAvailableSortMethodsQuery,
+        {
+            fetchPolicy: 'cache-and-network',
+            nextFetchPolicy: 'cache-first'
+        }
+    );
+
+    const { data: categoryData, loading: categoryLoading } = useQuery(
+        getCategoryContentQuery,
+        {
+            fetchPolicy: 'cache-and-network',
+            nextFetchPolicy: 'cache-first',
+            skip: !categoryId,
+            variables: {
+                id: categoryId
+            }
+        }
+    );
+
+    console.log(categoryData)
+
+    const [, { dispatch }] = useEventingContext();
+
+    useEffect(() => {
+        if (categoryId) {
+            getFilters({
+                variables: {
+                    categoryIdFilter: {
+                        eq: categoryId
+                    }
+                }
+            });
+        }
+    }, [categoryId, getFilters]);
+
+    useEffect(() => {
+        if (categoryId) {
+            getSortMethods({
+                variables: {
+                    categoryIdFilter: {
+                        in: categoryId
+                    }
+                }
+            });
+        }
+    }, [categoryId, getSortMethods]);
+
+    const filters = filterData ? filterData.products.aggregations : null;
+    const items = data ? data.products.items : placeholderItems;
+    const children =
+        categoryData && categoryData.categories.items.length
+            ? categoryData.categories.items[0].children
+            : null;
+    const parent =
+    categoryData && categoryData.categories.items.length
+        ? categoryData.categories.items[0].parent
+        : null;
+    const totalPagesFromData = data
+        ? data.products.page_info.total_pages
+        : null;
+    const totalCount = data ? data.products.total_count : null;
+    const categoryName =
+        categoryData && categoryData.categories.items.length
+            ? categoryData.categories.items[0].name
+            : null;
+    const categoryDescription =
+        categoryData && categoryData.categories.items.length
+            ? categoryData.categories.items[0].description
+            : null;
+    const availableSortMethods = sortData
+        ? sortData.products.sort_fields.options
+        : null;
+
+    useEffect(() => {
+        if (!categoryLoading && categoryData.categories.items.length > 0) {
+            dispatch({
+                type: 'CATEGORY_PAGE_VIEW',
+                payload: {
+                    id: categoryData.categories.items[0].uid,
+                    name: categoryData.categories.items[0].name,
+                    url_key: categoryData.categories.items[0].url_key,
+                    url_path: categoryData.categories.items[0].url_path
+                }
+            });
+        }
+    }, [categoryData, dispatch, categoryLoading]);
+
+    return {
+        availableSortMethods,
+        categoryName,
+        categoryDescription,
+        filters,
+        items,
+        totalCount,
+        totalPagesFromData,
+        children,
+        parent
+    };
+};